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 CompareWithInt ("bsize", 131072)])],
1624 "get file system statistics",
1626 Returns file system statistics for any mounted file system.
1627 C<path> should be a file or directory in the mounted file system
1628 (typically it is the mount point itself, but it doesn't need to be).
1630 This is the same as the C<statvfs(2)> system call.");
1632 ("tune2fs_l", (RHashtable "superblock", [String "device"]), 55, [],
1634 "get ext2/ext3/ext4 superblock details",
1636 This returns the contents of the ext2, ext3 or ext4 filesystem
1637 superblock on C<device>.
1639 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1640 manpage for more details. The list of fields returned isn't
1641 clearly defined, and depends on both the version of C<tune2fs>
1642 that libguestfs was built against, and the filesystem itself.");
1644 ("blockdev_setro", (RErr, [String "device"]), 56, [],
1645 [InitEmpty, Always, TestOutputTrue (
1646 [["blockdev_setro"; "/dev/sda"];
1647 ["blockdev_getro"; "/dev/sda"]])],
1648 "set block device to read-only",
1650 Sets the block device named C<device> to read-only.
1652 This uses the L<blockdev(8)> command.");
1654 ("blockdev_setrw", (RErr, [String "device"]), 57, [],
1655 [InitEmpty, Always, TestOutputFalse (
1656 [["blockdev_setrw"; "/dev/sda"];
1657 ["blockdev_getro"; "/dev/sda"]])],
1658 "set block device to read-write",
1660 Sets the block device named C<device> to read-write.
1662 This uses the L<blockdev(8)> command.");
1664 ("blockdev_getro", (RBool "ro", [String "device"]), 58, [],
1665 [InitEmpty, Always, TestOutputTrue (
1666 [["blockdev_setro"; "/dev/sda"];
1667 ["blockdev_getro"; "/dev/sda"]])],
1668 "is block device set to read-only",
1670 Returns a boolean indicating if the block device is read-only
1671 (true if read-only, false if not).
1673 This uses the L<blockdev(8)> command.");
1675 ("blockdev_getss", (RInt "sectorsize", [String "device"]), 59, [],
1676 [InitEmpty, Always, TestOutputInt (
1677 [["blockdev_getss"; "/dev/sda"]], 512)],
1678 "get sectorsize of block device",
1680 This returns the size of sectors on a block device.
1681 Usually 512, but can be larger for modern devices.
1683 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1686 This uses the L<blockdev(8)> command.");
1688 ("blockdev_getbsz", (RInt "blocksize", [String "device"]), 60, [],
1689 [InitEmpty, Always, TestOutputInt (
1690 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1691 "get blocksize of block device",
1693 This returns the block size of a device.
1695 (Note this is different from both I<size in blocks> and
1696 I<filesystem block size>).
1698 This uses the L<blockdev(8)> command.");
1700 ("blockdev_setbsz", (RErr, [String "device"; Int "blocksize"]), 61, [],
1702 "set blocksize of block device",
1704 This sets the block size of a device.
1706 (Note this is different from both I<size in blocks> and
1707 I<filesystem block size>).
1709 This uses the L<blockdev(8)> command.");
1711 ("blockdev_getsz", (RInt64 "sizeinsectors", [String "device"]), 62, [],
1712 [InitEmpty, Always, TestOutputInt (
1713 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1714 "get total size of device in 512-byte sectors",
1716 This returns the size of the device in units of 512-byte sectors
1717 (even if the sectorsize isn't 512 bytes ... weird).
1719 See also C<guestfs_blockdev_getss> for the real sector size of
1720 the device, and C<guestfs_blockdev_getsize64> for the more
1721 useful I<size in bytes>.
1723 This uses the L<blockdev(8)> command.");
1725 ("blockdev_getsize64", (RInt64 "sizeinbytes", [String "device"]), 63, [],
1726 [InitEmpty, Always, TestOutputInt (
1727 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1728 "get total size of device in bytes",
1730 This returns the size of the device in bytes.
1732 See also C<guestfs_blockdev_getsz>.
1734 This uses the L<blockdev(8)> command.");
1736 ("blockdev_flushbufs", (RErr, [String "device"]), 64, [],
1737 [InitEmpty, Always, TestRun
1738 [["blockdev_flushbufs"; "/dev/sda"]]],
1739 "flush device buffers",
1741 This tells the kernel to flush internal buffers associated
1744 This uses the L<blockdev(8)> command.");
1746 ("blockdev_rereadpt", (RErr, [String "device"]), 65, [],
1747 [InitEmpty, Always, TestRun
1748 [["blockdev_rereadpt"; "/dev/sda"]]],
1749 "reread partition table",
1751 Reread the partition table on C<device>.
1753 This uses the L<blockdev(8)> command.");
1755 ("upload", (RErr, [FileIn "filename"; String "remotefilename"]), 66, [],
1756 [InitBasicFS, Always, TestOutput (
1757 (* Pick a file from cwd which isn't likely to change. *)
1758 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1759 ["checksum"; "md5"; "/COPYING.LIB"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
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"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1776 "download a file to the local machine",
1778 Download file C<remotefilename> and save it as C<filename>
1779 on the local machine.
1781 C<filename> can also be a named pipe.
1783 See also C<guestfs_upload>, C<guestfs_cat>.");
1785 ("checksum", (RString "checksum", [String "csumtype"; String "path"]), 68, [],
1786 [InitSquashFS, Always, TestOutput (
1787 [["checksum"; "crc"; "/known-3"]], "2891671662");
1788 InitSquashFS, Always, TestLastFail (
1789 [["checksum"; "crc"; "/notexists"]]);
1790 InitSquashFS, Always, TestOutput (
1791 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
1792 InitSquashFS, Always, TestOutput (
1793 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
1794 InitSquashFS, Always, TestOutput (
1795 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
1796 InitSquashFS, Always, TestOutput (
1797 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
1798 InitSquashFS, Always, TestOutput (
1799 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
1800 InitSquashFS, Always, TestOutput (
1801 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6")],
1802 "compute MD5, SHAx or CRC checksum of file",
1804 This call computes the MD5, SHAx or CRC checksum of the
1807 The type of checksum to compute is given by the C<csumtype>
1808 parameter which must have one of the following values:
1814 Compute the cyclic redundancy check (CRC) specified by POSIX
1815 for the C<cksum> command.
1819 Compute the MD5 hash (using the C<md5sum> program).
1823 Compute the SHA1 hash (using the C<sha1sum> program).
1827 Compute the SHA224 hash (using the C<sha224sum> program).
1831 Compute the SHA256 hash (using the C<sha256sum> program).
1835 Compute the SHA384 hash (using the C<sha384sum> program).
1839 Compute the SHA512 hash (using the C<sha512sum> program).
1843 The checksum is returned as a printable string.");
1845 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1846 [InitBasicFS, Always, TestOutput (
1847 [["tar_in"; "../images/helloworld.tar"; "/"];
1848 ["cat"; "/hello"]], "hello\n")],
1849 "unpack tarfile to directory",
1851 This command uploads and unpacks local file C<tarfile> (an
1852 I<uncompressed> tar file) into C<directory>.
1854 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1856 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1858 "pack directory into tarfile",
1860 This command packs the contents of C<directory> and downloads
1861 it to local file C<tarfile>.
1863 To download a compressed tarball, use C<guestfs_tgz_out>.");
1865 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1866 [InitBasicFS, Always, TestOutput (
1867 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
1868 ["cat"; "/hello"]], "hello\n")],
1869 "unpack compressed tarball to directory",
1871 This command uploads and unpacks local file C<tarball> (a
1872 I<gzip compressed> tar file) into C<directory>.
1874 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1876 ("tgz_out", (RErr, [String "directory"; FileOut "tarball"]), 72, [],
1878 "pack directory into compressed tarball",
1880 This command packs the contents of C<directory> and downloads
1881 it to local file C<tarball>.
1883 To download an uncompressed tarball, use C<guestfs_tar_out>.");
1885 ("mount_ro", (RErr, [String "device"; String "mountpoint"]), 73, [],
1886 [InitBasicFS, Always, TestLastFail (
1888 ["mount_ro"; "/dev/sda1"; "/"];
1889 ["touch"; "/new"]]);
1890 InitBasicFS, Always, TestOutput (
1891 [["write_file"; "/new"; "data"; "0"];
1893 ["mount_ro"; "/dev/sda1"; "/"];
1894 ["cat"; "/new"]], "data")],
1895 "mount a guest disk, read-only",
1897 This is the same as the C<guestfs_mount> command, but it
1898 mounts the filesystem with the read-only (I<-o ro>) flag.");
1900 ("mount_options", (RErr, [String "options"; String "device"; String "mountpoint"]), 74, [],
1902 "mount a guest disk with mount options",
1904 This is the same as the C<guestfs_mount> command, but it
1905 allows you to set the mount options as for the
1906 L<mount(8)> I<-o> flag.");
1908 ("mount_vfs", (RErr, [String "options"; String "vfstype"; String "device"; String "mountpoint"]), 75, [],
1910 "mount a guest disk with mount options and vfstype",
1912 This is the same as the C<guestfs_mount> command, but it
1913 allows you to set both the mount options and the vfstype
1914 as for the L<mount(8)> I<-o> and I<-t> flags.");
1916 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
1918 "debugging and internals",
1920 The C<guestfs_debug> command exposes some internals of
1921 C<guestfsd> (the guestfs daemon) that runs inside the
1924 There is no comprehensive help for this command. You have
1925 to look at the file C<daemon/debug.c> in the libguestfs source
1926 to find out what you can do.");
1928 ("lvremove", (RErr, [String "device"]), 77, [],
1929 [InitEmpty, Always, TestOutputList (
1930 [["sfdiskM"; "/dev/sda"; ","];
1931 ["pvcreate"; "/dev/sda1"];
1932 ["vgcreate"; "VG"; "/dev/sda1"];
1933 ["lvcreate"; "LV1"; "VG"; "50"];
1934 ["lvcreate"; "LV2"; "VG"; "50"];
1935 ["lvremove"; "/dev/VG/LV1"];
1936 ["lvs"]], ["/dev/VG/LV2"]);
1937 InitEmpty, Always, TestOutputList (
1938 [["sfdiskM"; "/dev/sda"; ","];
1939 ["pvcreate"; "/dev/sda1"];
1940 ["vgcreate"; "VG"; "/dev/sda1"];
1941 ["lvcreate"; "LV1"; "VG"; "50"];
1942 ["lvcreate"; "LV2"; "VG"; "50"];
1943 ["lvremove"; "/dev/VG"];
1945 InitEmpty, Always, TestOutputList (
1946 [["sfdiskM"; "/dev/sda"; ","];
1947 ["pvcreate"; "/dev/sda1"];
1948 ["vgcreate"; "VG"; "/dev/sda1"];
1949 ["lvcreate"; "LV1"; "VG"; "50"];
1950 ["lvcreate"; "LV2"; "VG"; "50"];
1951 ["lvremove"; "/dev/VG"];
1953 "remove an LVM logical volume",
1955 Remove an LVM logical volume C<device>, where C<device> is
1956 the path to the LV, such as C</dev/VG/LV>.
1958 You can also remove all LVs in a volume group by specifying
1959 the VG name, C</dev/VG>.");
1961 ("vgremove", (RErr, [String "vgname"]), 78, [],
1962 [InitEmpty, Always, TestOutputList (
1963 [["sfdiskM"; "/dev/sda"; ","];
1964 ["pvcreate"; "/dev/sda1"];
1965 ["vgcreate"; "VG"; "/dev/sda1"];
1966 ["lvcreate"; "LV1"; "VG"; "50"];
1967 ["lvcreate"; "LV2"; "VG"; "50"];
1970 InitEmpty, Always, TestOutputList (
1971 [["sfdiskM"; "/dev/sda"; ","];
1972 ["pvcreate"; "/dev/sda1"];
1973 ["vgcreate"; "VG"; "/dev/sda1"];
1974 ["lvcreate"; "LV1"; "VG"; "50"];
1975 ["lvcreate"; "LV2"; "VG"; "50"];
1978 "remove an LVM volume group",
1980 Remove an LVM volume group C<vgname>, (for example C<VG>).
1982 This also forcibly removes all logical volumes in the volume
1985 ("pvremove", (RErr, [String "device"]), 79, [],
1986 [InitEmpty, Always, TestOutputListOfDevices (
1987 [["sfdiskM"; "/dev/sda"; ","];
1988 ["pvcreate"; "/dev/sda1"];
1989 ["vgcreate"; "VG"; "/dev/sda1"];
1990 ["lvcreate"; "LV1"; "VG"; "50"];
1991 ["lvcreate"; "LV2"; "VG"; "50"];
1993 ["pvremove"; "/dev/sda1"];
1995 InitEmpty, Always, TestOutputListOfDevices (
1996 [["sfdiskM"; "/dev/sda"; ","];
1997 ["pvcreate"; "/dev/sda1"];
1998 ["vgcreate"; "VG"; "/dev/sda1"];
1999 ["lvcreate"; "LV1"; "VG"; "50"];
2000 ["lvcreate"; "LV2"; "VG"; "50"];
2002 ["pvremove"; "/dev/sda1"];
2004 InitEmpty, Always, TestOutputListOfDevices (
2005 [["sfdiskM"; "/dev/sda"; ","];
2006 ["pvcreate"; "/dev/sda1"];
2007 ["vgcreate"; "VG"; "/dev/sda1"];
2008 ["lvcreate"; "LV1"; "VG"; "50"];
2009 ["lvcreate"; "LV2"; "VG"; "50"];
2011 ["pvremove"; "/dev/sda1"];
2013 "remove an LVM physical volume",
2015 This wipes a physical volume C<device> so that LVM will no longer
2018 The implementation uses the C<pvremove> command which refuses to
2019 wipe physical volumes that contain any volume groups, so you have
2020 to remove those first.");
2022 ("set_e2label", (RErr, [String "device"; String "label"]), 80, [],
2023 [InitBasicFS, Always, TestOutput (
2024 [["set_e2label"; "/dev/sda1"; "testlabel"];
2025 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2026 "set the ext2/3/4 filesystem label",
2028 This sets the ext2/3/4 filesystem label of the filesystem on
2029 C<device> to C<label>. Filesystem labels are limited to
2032 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2033 to return the existing label on a filesystem.");
2035 ("get_e2label", (RString "label", [String "device"]), 81, [],
2037 "get the ext2/3/4 filesystem label",
2039 This returns the ext2/3/4 filesystem label of the filesystem on
2042 ("set_e2uuid", (RErr, [String "device"; String "uuid"]), 82, [],
2043 [InitBasicFS, Always, TestOutput (
2044 [["set_e2uuid"; "/dev/sda1"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"];
2045 ["get_e2uuid"; "/dev/sda1"]], "a3a61220-882b-4f61-89f4-cf24dcc7297d");
2046 InitBasicFS, Always, TestOutput (
2047 [["set_e2uuid"; "/dev/sda1"; "clear"];
2048 ["get_e2uuid"; "/dev/sda1"]], "");
2049 (* We can't predict what UUIDs will be, so just check the commands run. *)
2050 InitBasicFS, Always, TestRun (
2051 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2052 InitBasicFS, Always, TestRun (
2053 [["set_e2uuid"; "/dev/sda1"; "time"]])],
2054 "set the ext2/3/4 filesystem UUID",
2056 This sets the ext2/3/4 filesystem UUID of the filesystem on
2057 C<device> to C<uuid>. The format of the UUID and alternatives
2058 such as C<clear>, C<random> and C<time> are described in the
2059 L<tune2fs(8)> manpage.
2061 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2062 to return the existing UUID of a filesystem.");
2064 ("get_e2uuid", (RString "uuid", [String "device"]), 83, [],
2066 "get the ext2/3/4 filesystem UUID",
2068 This returns the ext2/3/4 filesystem UUID of the filesystem on
2071 ("fsck", (RInt "status", [String "fstype"; String "device"]), 84, [],
2072 [InitBasicFS, Always, TestOutputInt (
2073 [["umount"; "/dev/sda1"];
2074 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2075 InitBasicFS, Always, TestOutputInt (
2076 [["umount"; "/dev/sda1"];
2077 ["zero"; "/dev/sda1"];
2078 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2079 "run the filesystem checker",
2081 This runs the filesystem checker (fsck) on C<device> which
2082 should have filesystem type C<fstype>.
2084 The returned integer is the status. See L<fsck(8)> for the
2085 list of status codes from C<fsck>.
2093 Multiple status codes can be summed together.
2097 A non-zero return code can mean \"success\", for example if
2098 errors have been corrected on the filesystem.
2102 Checking or repairing NTFS volumes is not supported
2107 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2109 ("zero", (RErr, [String "device"]), 85, [],
2110 [InitBasicFS, Always, TestOutput (
2111 [["umount"; "/dev/sda1"];
2112 ["zero"; "/dev/sda1"];
2113 ["file"; "/dev/sda1"]], "data")],
2114 "write zeroes to the device",
2116 This command writes zeroes over the first few blocks of C<device>.
2118 How many blocks are zeroed isn't specified (but it's I<not> enough
2119 to securely wipe the device). It should be sufficient to remove
2120 any partition tables, filesystem superblocks and so on.
2122 See also: C<guestfs_scrub_device>.");
2124 ("grub_install", (RErr, [String "root"; String "device"]), 86, [],
2125 (* Test disabled because grub-install incompatible with virtio-blk driver.
2126 * See also: https://bugzilla.redhat.com/show_bug.cgi?id=479760
2128 [InitBasicFS, Disabled, TestOutputTrue (
2129 [["grub_install"; "/"; "/dev/sda1"];
2130 ["is_dir"; "/boot"]])],
2133 This command installs GRUB (the Grand Unified Bootloader) on
2134 C<device>, with the root directory being C<root>.");
2136 ("cp", (RErr, [String "src"; String "dest"]), 87, [],
2137 [InitBasicFS, Always, TestOutput (
2138 [["write_file"; "/old"; "file content"; "0"];
2139 ["cp"; "/old"; "/new"];
2140 ["cat"; "/new"]], "file content");
2141 InitBasicFS, Always, TestOutputTrue (
2142 [["write_file"; "/old"; "file content"; "0"];
2143 ["cp"; "/old"; "/new"];
2144 ["is_file"; "/old"]]);
2145 InitBasicFS, Always, TestOutput (
2146 [["write_file"; "/old"; "file content"; "0"];
2148 ["cp"; "/old"; "/dir/new"];
2149 ["cat"; "/dir/new"]], "file content")],
2152 This copies a file from C<src> to C<dest> where C<dest> is
2153 either a destination filename or destination directory.");
2155 ("cp_a", (RErr, [String "src"; String "dest"]), 88, [],
2156 [InitBasicFS, Always, TestOutput (
2157 [["mkdir"; "/olddir"];
2158 ["mkdir"; "/newdir"];
2159 ["write_file"; "/olddir/file"; "file content"; "0"];
2160 ["cp_a"; "/olddir"; "/newdir"];
2161 ["cat"; "/newdir/olddir/file"]], "file content")],
2162 "copy a file or directory recursively",
2164 This copies a file or directory from C<src> to C<dest>
2165 recursively using the C<cp -a> command.");
2167 ("mv", (RErr, [String "src"; String "dest"]), 89, [],
2168 [InitBasicFS, Always, TestOutput (
2169 [["write_file"; "/old"; "file content"; "0"];
2170 ["mv"; "/old"; "/new"];
2171 ["cat"; "/new"]], "file content");
2172 InitBasicFS, Always, TestOutputFalse (
2173 [["write_file"; "/old"; "file content"; "0"];
2174 ["mv"; "/old"; "/new"];
2175 ["is_file"; "/old"]])],
2178 This moves a file from C<src> to C<dest> where C<dest> is
2179 either a destination filename or destination directory.");
2181 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2182 [InitEmpty, Always, TestRun (
2183 [["drop_caches"; "3"]])],
2184 "drop kernel page cache, dentries and inodes",
2186 This instructs the guest kernel to drop its page cache,
2187 and/or dentries and inode caches. The parameter C<whattodrop>
2188 tells the kernel what precisely to drop, see
2189 L<http://linux-mm.org/Drop_Caches>
2191 Setting C<whattodrop> to 3 should drop everything.
2193 This automatically calls L<sync(2)> before the operation,
2194 so that the maximum guest memory is freed.");
2196 ("dmesg", (RString "kmsgs", []), 91, [],
2197 [InitEmpty, Always, TestRun (
2199 "return kernel messages",
2201 This returns the kernel messages (C<dmesg> output) from
2202 the guest kernel. This is sometimes useful for extended
2203 debugging of problems.
2205 Another way to get the same information is to enable
2206 verbose messages with C<guestfs_set_verbose> or by setting
2207 the environment variable C<LIBGUESTFS_DEBUG=1> before
2208 running the program.");
2210 ("ping_daemon", (RErr, []), 92, [],
2211 [InitEmpty, Always, TestRun (
2212 [["ping_daemon"]])],
2213 "ping the guest daemon",
2215 This is a test probe into the guestfs daemon running inside
2216 the qemu subprocess. Calling this function checks that the
2217 daemon responds to the ping message, without affecting the daemon
2218 or attached block device(s) in any other way.");
2220 ("equal", (RBool "equality", [String "file1"; String "file2"]), 93, [],
2221 [InitBasicFS, Always, TestOutputTrue (
2222 [["write_file"; "/file1"; "contents of a file"; "0"];
2223 ["cp"; "/file1"; "/file2"];
2224 ["equal"; "/file1"; "/file2"]]);
2225 InitBasicFS, Always, TestOutputFalse (
2226 [["write_file"; "/file1"; "contents of a file"; "0"];
2227 ["write_file"; "/file2"; "contents of another file"; "0"];
2228 ["equal"; "/file1"; "/file2"]]);
2229 InitBasicFS, Always, TestLastFail (
2230 [["equal"; "/file1"; "/file2"]])],
2231 "test if two files have equal contents",
2233 This compares the two files C<file1> and C<file2> and returns
2234 true if their content is exactly equal, or false otherwise.
2236 The external L<cmp(1)> program is used for the comparison.");
2238 ("strings", (RStringList "stringsout", [String "path"]), 94, [ProtocolLimitWarning],
2239 [InitSquashFS, Always, TestOutputList (
2240 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2241 InitSquashFS, Always, TestOutputList (
2242 [["strings"; "/empty"]], [])],
2243 "print the printable strings in a file",
2245 This runs the L<strings(1)> command on a file and returns
2246 the list of printable strings found.");
2248 ("strings_e", (RStringList "stringsout", [String "encoding"; String "path"]), 95, [ProtocolLimitWarning],
2249 [InitSquashFS, Always, TestOutputList (
2250 [["strings_e"; "b"; "/known-5"]], []);
2251 InitBasicFS, Disabled, TestOutputList (
2252 [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2253 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2254 "print the printable strings in a file",
2256 This is like the C<guestfs_strings> command, but allows you to
2257 specify the encoding.
2259 See the L<strings(1)> manpage for the full list of encodings.
2261 Commonly useful encodings are C<l> (lower case L) which will
2262 show strings inside Windows/x86 files.
2264 The returned strings are transcoded to UTF-8.");
2266 ("hexdump", (RString "dump", [String "path"]), 96, [ProtocolLimitWarning],
2267 [InitSquashFS, Always, TestOutput (
2268 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2269 (* Test for RHBZ#501888c2 regression which caused large hexdump
2270 * commands to segfault.
2272 InitSquashFS, Always, TestRun (
2273 [["hexdump"; "/100krandom"]])],
2274 "dump a file in hexadecimal",
2276 This runs C<hexdump -C> on the given C<path>. The result is
2277 the human-readable, canonical hex dump of the file.");
2279 ("zerofree", (RErr, [String "device"]), 97, [],
2280 [InitNone, Always, TestOutput (
2281 [["sfdiskM"; "/dev/sda"; ","];
2282 ["mkfs"; "ext3"; "/dev/sda1"];
2283 ["mount"; "/dev/sda1"; "/"];
2284 ["write_file"; "/new"; "test file"; "0"];
2285 ["umount"; "/dev/sda1"];
2286 ["zerofree"; "/dev/sda1"];
2287 ["mount"; "/dev/sda1"; "/"];
2288 ["cat"; "/new"]], "test file")],
2289 "zero unused inodes and disk blocks on ext2/3 filesystem",
2291 This runs the I<zerofree> program on C<device>. This program
2292 claims to zero unused inodes and disk blocks on an ext2/3
2293 filesystem, thus making it possible to compress the filesystem
2296 You should B<not> run this program if the filesystem is
2299 It is possible that using this program can damage the filesystem
2300 or data on the filesystem.");
2302 ("pvresize", (RErr, [String "device"]), 98, [],
2304 "resize an LVM physical volume",
2306 This resizes (expands or shrinks) an existing LVM physical
2307 volume to match the new size of the underlying device.");
2309 ("sfdisk_N", (RErr, [String "device"; Int "partnum";
2310 Int "cyls"; Int "heads"; Int "sectors";
2311 String "line"]), 99, [DangerWillRobinson],
2313 "modify a single partition on a block device",
2315 This runs L<sfdisk(8)> option to modify just the single
2316 partition C<n> (note: C<n> counts from 1).
2318 For other parameters, see C<guestfs_sfdisk>. You should usually
2319 pass C<0> for the cyls/heads/sectors parameters.");
2321 ("sfdisk_l", (RString "partitions", [String "device"]), 100, [],
2323 "display the partition table",
2325 This displays the partition table on C<device>, in the
2326 human-readable output of the L<sfdisk(8)> command. It is
2327 not intended to be parsed.");
2329 ("sfdisk_kernel_geometry", (RString "partitions", [String "device"]), 101, [],
2331 "display the kernel geometry",
2333 This displays the kernel's idea of the geometry of C<device>.
2335 The result is in human-readable format, and not designed to
2338 ("sfdisk_disk_geometry", (RString "partitions", [String "device"]), 102, [],
2340 "display the disk geometry from the partition table",
2342 This displays the disk geometry of C<device> read from the
2343 partition table. Especially in the case where the underlying
2344 block device has been resized, this can be different from the
2345 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2347 The result is in human-readable format, and not designed to
2350 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [],
2352 "activate or deactivate all volume groups",
2354 This command activates or (if C<activate> is false) deactivates
2355 all logical volumes in all volume groups.
2356 If activated, then they are made known to the
2357 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2358 then those devices disappear.
2360 This command is the same as running C<vgchange -a y|n>");
2362 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [],
2364 "activate or deactivate some volume groups",
2366 This command activates or (if C<activate> is false) deactivates
2367 all logical volumes in the listed volume groups C<volgroups>.
2368 If activated, then they are made known to the
2369 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2370 then those devices disappear.
2372 This command is the same as running C<vgchange -a y|n volgroups...>
2374 Note that if C<volgroups> is an empty list then B<all> volume groups
2375 are activated or deactivated.");
2377 ("lvresize", (RErr, [String "device"; Int "mbytes"]), 105, [],
2378 [InitNone, Always, TestOutput (
2379 [["sfdiskM"; "/dev/sda"; ","];
2380 ["pvcreate"; "/dev/sda1"];
2381 ["vgcreate"; "VG"; "/dev/sda1"];
2382 ["lvcreate"; "LV"; "VG"; "10"];
2383 ["mkfs"; "ext2"; "/dev/VG/LV"];
2384 ["mount"; "/dev/VG/LV"; "/"];
2385 ["write_file"; "/new"; "test content"; "0"];
2387 ["lvresize"; "/dev/VG/LV"; "20"];
2388 ["e2fsck_f"; "/dev/VG/LV"];
2389 ["resize2fs"; "/dev/VG/LV"];
2390 ["mount"; "/dev/VG/LV"; "/"];
2391 ["cat"; "/new"]], "test content")],
2392 "resize an LVM logical volume",
2394 This resizes (expands or shrinks) an existing LVM logical
2395 volume to C<mbytes>. When reducing, data in the reduced part
2398 ("resize2fs", (RErr, [String "device"]), 106, [],
2399 [], (* lvresize tests this *)
2400 "resize an ext2/ext3 filesystem",
2402 This resizes an ext2 or ext3 filesystem to match the size of
2403 the underlying device.
2405 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2406 on the C<device> before calling this command. For unknown reasons
2407 C<resize2fs> sometimes gives an error about this and sometimes not.
2408 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2409 calling this function.");
2411 ("find", (RStringList "names", [String "directory"]), 107, [],
2412 [InitBasicFS, Always, TestOutputList (
2413 [["find"; "/"]], ["lost+found"]);
2414 InitBasicFS, Always, TestOutputList (
2418 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2419 InitBasicFS, Always, TestOutputList (
2420 [["mkdir_p"; "/a/b/c"];
2421 ["touch"; "/a/b/c/d"];
2422 ["find"; "/a/b/"]], ["c"; "c/d"])],
2423 "find all files and directories",
2425 This command lists out all files and directories, recursively,
2426 starting at C<directory>. It is essentially equivalent to
2427 running the shell command C<find directory -print> but some
2428 post-processing happens on the output, described below.
2430 This returns a list of strings I<without any prefix>. Thus
2431 if the directory structure was:
2437 then the returned list from C<guestfs_find> C</tmp> would be
2445 If C<directory> is not a directory, then this command returns
2448 The returned list is sorted.");
2450 ("e2fsck_f", (RErr, [String "device"]), 108, [],
2451 [], (* lvresize tests this *)
2452 "check an ext2/ext3 filesystem",
2454 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2455 filesystem checker on C<device>, noninteractively (C<-p>),
2456 even if the filesystem appears to be clean (C<-f>).
2458 This command is only needed because of C<guestfs_resize2fs>
2459 (q.v.). Normally you should use C<guestfs_fsck>.");
2461 ("sleep", (RErr, [Int "secs"]), 109, [],
2462 [InitNone, Always, TestRun (
2464 "sleep for some seconds",
2466 Sleep for C<secs> seconds.");
2468 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; String "device"]), 110, [],
2469 [InitNone, Always, TestOutputInt (
2470 [["sfdiskM"; "/dev/sda"; ","];
2471 ["mkfs"; "ntfs"; "/dev/sda1"];
2472 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2473 InitNone, Always, TestOutputInt (
2474 [["sfdiskM"; "/dev/sda"; ","];
2475 ["mkfs"; "ext2"; "/dev/sda1"];
2476 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2477 "probe NTFS volume",
2479 This command runs the L<ntfs-3g.probe(8)> command which probes
2480 an NTFS C<device> for mountability. (Not all NTFS volumes can
2481 be mounted read-write, and some cannot be mounted at all).
2483 C<rw> is a boolean flag. Set it to true if you want to test
2484 if the volume can be mounted read-write. Set it to false if
2485 you want to test if the volume can be mounted read-only.
2487 The return value is an integer which C<0> if the operation
2488 would succeed, or some non-zero value documented in the
2489 L<ntfs-3g.probe(8)> manual page.");
2491 ("sh", (RString "output", [String "command"]), 111, [],
2492 [], (* XXX needs tests *)
2493 "run a command via the shell",
2495 This call runs a command from the guest filesystem via the
2498 This is like C<guestfs_command>, but passes the command to:
2500 /bin/sh -c \"command\"
2502 Depending on the guest's shell, this usually results in
2503 wildcards being expanded, shell expressions being interpolated
2506 All the provisos about C<guestfs_command> apply to this call.");
2508 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2509 [], (* XXX needs tests *)
2510 "run a command via the shell returning lines",
2512 This is the same as C<guestfs_sh>, but splits the result
2513 into a list of lines.
2515 See also: C<guestfs_command_lines>");
2517 ("glob_expand", (RStringList "paths", [String "pattern"]), 113, [],
2518 [InitBasicFS, Always, TestOutputList (
2519 [["mkdir_p"; "/a/b/c"];
2520 ["touch"; "/a/b/c/d"];
2521 ["touch"; "/a/b/c/e"];
2522 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2523 InitBasicFS, Always, TestOutputList (
2524 [["mkdir_p"; "/a/b/c"];
2525 ["touch"; "/a/b/c/d"];
2526 ["touch"; "/a/b/c/e"];
2527 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2528 InitBasicFS, Always, TestOutputList (
2529 [["mkdir_p"; "/a/b/c"];
2530 ["touch"; "/a/b/c/d"];
2531 ["touch"; "/a/b/c/e"];
2532 ["glob_expand"; "/a/*/x/*"]], [])],
2533 "expand a wildcard path",
2535 This command searches for all the pathnames matching
2536 C<pattern> according to the wildcard expansion rules
2539 If no paths match, then this returns an empty list
2540 (note: not an error).
2542 It is just a wrapper around the C L<glob(3)> function
2543 with flags C<GLOB_MARK|GLOB_BRACE>.
2544 See that manual page for more details.");
2546 ("scrub_device", (RErr, [String "device"]), 114, [DangerWillRobinson],
2547 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2548 [["scrub_device"; "/dev/sdc"]])],
2549 "scrub (securely wipe) a device",
2551 This command writes patterns over C<device> to make data retrieval
2554 It is an interface to the L<scrub(1)> program. See that
2555 manual page for more details.");
2557 ("scrub_file", (RErr, [String "file"]), 115, [],
2558 [InitBasicFS, Always, TestRun (
2559 [["write_file"; "/file"; "content"; "0"];
2560 ["scrub_file"; "/file"]])],
2561 "scrub (securely wipe) a file",
2563 This command writes patterns over a file to make data retrieval
2566 The file is I<removed> after scrubbing.
2568 It is an interface to the L<scrub(1)> program. See that
2569 manual page for more details.");
2571 ("scrub_freespace", (RErr, [String "dir"]), 116, [],
2572 [], (* XXX needs testing *)
2573 "scrub (securely wipe) free space",
2575 This command creates the directory C<dir> and then fills it
2576 with files until the filesystem is full, and scrubs the files
2577 as for C<guestfs_scrub_file>, and deletes them.
2578 The intention is to scrub any free space on the partition
2581 It is an interface to the L<scrub(1)> program. See that
2582 manual page for more details.");
2584 ("mkdtemp", (RString "dir", [String "template"]), 117, [],
2585 [InitBasicFS, Always, TestRun (
2587 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2588 "create a temporary directory",
2590 This command creates a temporary directory. The
2591 C<template> parameter should be a full pathname for the
2592 temporary directory name with the final six characters being
2595 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2596 the second one being suitable for Windows filesystems.
2598 The name of the temporary directory that was created
2601 The temporary directory is created with mode 0700
2602 and is owned by root.
2604 The caller is responsible for deleting the temporary
2605 directory and its contents after use.
2607 See also: L<mkdtemp(3)>");
2609 ("wc_l", (RInt "lines", [String "path"]), 118, [],
2610 [InitSquashFS, Always, TestOutputInt (
2611 [["wc_l"; "/10klines"]], 10000)],
2612 "count lines in a file",
2614 This command counts the lines in a file, using the
2615 C<wc -l> external command.");
2617 ("wc_w", (RInt "words", [String "path"]), 119, [],
2618 [InitSquashFS, Always, TestOutputInt (
2619 [["wc_w"; "/10klines"]], 10000)],
2620 "count words in a file",
2622 This command counts the words in a file, using the
2623 C<wc -w> external command.");
2625 ("wc_c", (RInt "chars", [String "path"]), 120, [],
2626 [InitSquashFS, Always, TestOutputInt (
2627 [["wc_c"; "/100kallspaces"]], 102400)],
2628 "count characters in a file",
2630 This command counts the characters in a file, using the
2631 C<wc -c> external command.");
2633 ("head", (RStringList "lines", [String "path"]), 121, [ProtocolLimitWarning],
2634 [InitSquashFS, Always, TestOutputList (
2635 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2636 "return first 10 lines of a file",
2638 This command returns up to the first 10 lines of a file as
2639 a list of strings.");
2641 ("head_n", (RStringList "lines", [Int "nrlines"; String "path"]), 122, [ProtocolLimitWarning],
2642 [InitSquashFS, Always, TestOutputList (
2643 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2644 InitSquashFS, Always, TestOutputList (
2645 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2646 InitSquashFS, Always, TestOutputList (
2647 [["head_n"; "0"; "/10klines"]], [])],
2648 "return first N lines of a file",
2650 If the parameter C<nrlines> is a positive number, this returns the first
2651 C<nrlines> lines of the file C<path>.
2653 If the parameter C<nrlines> is a negative number, this returns lines
2654 from the file C<path>, excluding the last C<nrlines> lines.
2656 If the parameter C<nrlines> is zero, this returns an empty list.");
2658 ("tail", (RStringList "lines", [String "path"]), 123, [ProtocolLimitWarning],
2659 [InitSquashFS, Always, TestOutputList (
2660 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2661 "return last 10 lines of a file",
2663 This command returns up to the last 10 lines of a file as
2664 a list of strings.");
2666 ("tail_n", (RStringList "lines", [Int "nrlines"; String "path"]), 124, [ProtocolLimitWarning],
2667 [InitSquashFS, Always, TestOutputList (
2668 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2669 InitSquashFS, Always, TestOutputList (
2670 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2671 InitSquashFS, Always, TestOutputList (
2672 [["tail_n"; "0"; "/10klines"]], [])],
2673 "return last N lines of a file",
2675 If the parameter C<nrlines> is a positive number, this returns the last
2676 C<nrlines> lines of the file C<path>.
2678 If the parameter C<nrlines> is a negative number, this returns lines
2679 from the file C<path>, starting with the C<-nrlines>th line.
2681 If the parameter C<nrlines> is zero, this returns an empty list.");
2683 ("df", (RString "output", []), 125, [],
2684 [], (* XXX Tricky to test because it depends on the exact format
2685 * of the 'df' command and other imponderables.
2687 "report file system disk space usage",
2689 This command runs the C<df> command to report disk space used.
2691 This command is mostly useful for interactive sessions. It
2692 is I<not> intended that you try to parse the output string.
2693 Use C<statvfs> from programs.");
2695 ("df_h", (RString "output", []), 126, [],
2696 [], (* XXX Tricky to test because it depends on the exact format
2697 * of the 'df' command and other imponderables.
2699 "report file system disk space usage (human readable)",
2701 This command runs the C<df -h> command to report disk space used
2702 in human-readable format.
2704 This command is mostly useful for interactive sessions. It
2705 is I<not> intended that you try to parse the output string.
2706 Use C<statvfs> from programs.");
2708 ("du", (RInt64 "sizekb", [String "path"]), 127, [],
2709 [InitSquashFS, Always, TestOutputInt (
2710 [["du"; "/directory"]], 0 (* squashfs doesn't have blocks *))],
2711 "estimate file space usage",
2713 This command runs the C<du -s> command to estimate file space
2716 C<path> can be a file or a directory. If C<path> is a directory
2717 then the estimate includes the contents of the directory and all
2718 subdirectories (recursively).
2720 The result is the estimated size in I<kilobytes>
2721 (ie. units of 1024 bytes).");
2723 ("initrd_list", (RStringList "filenames", [String "path"]), 128, [],
2724 [InitSquashFS, Always, TestOutputList (
2725 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
2726 "list files in an initrd",
2728 This command lists out files contained in an initrd.
2730 The files are listed without any initial C</> character. The
2731 files are listed in the order they appear (not necessarily
2732 alphabetical). Directory names are listed as separate items.
2734 Old Linux kernels (2.4 and earlier) used a compressed ext2
2735 filesystem as initrd. We I<only> support the newer initramfs
2736 format (compressed cpio files).");
2738 ("mount_loop", (RErr, [String "file"; String "mountpoint"]), 129, [],
2740 "mount a file using the loop device",
2742 This command lets you mount C<file> (a filesystem image
2743 in a file) on a mount point. It is entirely equivalent to
2744 the command C<mount -o loop file mountpoint>.");
2746 ("mkswap", (RErr, [String "device"]), 130, [],
2747 [InitEmpty, Always, TestRun (
2748 [["sfdiskM"; "/dev/sda"; ","];
2749 ["mkswap"; "/dev/sda1"]])],
2750 "create a swap partition",
2752 Create a swap partition on C<device>.");
2754 ("mkswap_L", (RErr, [String "label"; String "device"]), 131, [],
2755 [InitEmpty, Always, TestRun (
2756 [["sfdiskM"; "/dev/sda"; ","];
2757 ["mkswap_L"; "hello"; "/dev/sda1"]])],
2758 "create a swap partition with a label",
2760 Create a swap partition on C<device> with label C<label>.
2762 Note that you cannot attach a swap label to a block device
2763 (eg. C</dev/sda>), just to a partition. This appears to be
2764 a limitation of the kernel or swap tools.");
2766 ("mkswap_U", (RErr, [String "uuid"; String "device"]), 132, [],
2767 [InitEmpty, Always, TestRun (
2768 [["sfdiskM"; "/dev/sda"; ","];
2769 ["mkswap_U"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"; "/dev/sda1"]])],
2770 "create a swap partition with an explicit UUID",
2772 Create a swap partition on C<device> with UUID C<uuid>.");
2774 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 133, [],
2775 [InitBasicFS, Always, TestOutputStruct (
2776 [["mknod"; "0o10777"; "0"; "0"; "/node"];
2777 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
2778 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
2779 InitBasicFS, Always, TestOutputStruct (
2780 [["mknod"; "0o60777"; "66"; "99"; "/node"];
2781 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2782 "make block, character or FIFO devices",
2784 This call creates block or character special devices, or
2785 named pipes (FIFOs).
2787 The C<mode> parameter should be the mode, using the standard
2788 constants. C<devmajor> and C<devminor> are the
2789 device major and minor numbers, only used when creating block
2790 and character special devices.");
2792 ("mkfifo", (RErr, [Int "mode"; String "path"]), 134, [],
2793 [InitBasicFS, Always, TestOutputStruct (
2794 [["mkfifo"; "0o777"; "/node"];
2795 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
2796 "make FIFO (named pipe)",
2798 This call creates a FIFO (named pipe) called C<path> with
2799 mode C<mode>. It is just a convenient wrapper around
2800 C<guestfs_mknod>.");
2802 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 135, [],
2803 [InitBasicFS, Always, TestOutputStruct (
2804 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
2805 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2806 "make block device node",
2808 This call creates a block device node called C<path> with
2809 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2810 It is just a convenient wrapper around C<guestfs_mknod>.");
2812 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 136, [],
2813 [InitBasicFS, Always, TestOutputStruct (
2814 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
2815 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
2816 "make char device node",
2818 This call creates a char device node called C<path> with
2819 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2820 It is just a convenient wrapper around C<guestfs_mknod>.");
2822 ("umask", (RInt "oldmask", [Int "mask"]), 137, [],
2823 [], (* XXX umask is one of those stateful things that we should
2824 * reset between each test.
2826 "set file mode creation mask (umask)",
2828 This function sets the mask used for creating new files and
2829 device nodes to C<mask & 0777>.
2831 Typical umask values would be C<022> which creates new files
2832 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
2833 C<002> which creates new files with permissions like
2834 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
2836 The default umask is C<022>. This is important because it
2837 means that directories and device nodes will be created with
2838 C<0644> or C<0755> mode even if you specify C<0777>.
2840 See also L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
2842 This call returns the previous umask.");
2844 ("readdir", (RStructList ("entries", "dirent"), [String "dir"]), 138, [],
2846 "read directories entries",
2848 This returns the list of directory entries in directory C<dir>.
2850 All entries in the directory are returned, including C<.> and
2851 C<..>. The entries are I<not> sorted, but returned in the same
2852 order as the underlying filesystem.
2854 Also this call returns basic file type information about each
2855 file. The C<ftyp> field will contain one of the following characters:
2893 The L<readdir(3)> returned a C<d_type> field with an
2898 This function is primarily intended for use by programs. To
2899 get a simple list of names, use C<guestfs_ls>. To get a printable
2900 directory for human consumption, use C<guestfs_ll>.");
2902 ("sfdiskM", (RErr, [String "device"; StringList "lines"]), 139, [DangerWillRobinson],
2904 "create partitions on a block device",
2906 This is a simplified interface to the C<guestfs_sfdisk>
2907 command, where partition sizes are specified in megabytes
2908 only (rounded to the nearest cylinder) and you don't need
2909 to specify the cyls, heads and sectors parameters which
2910 were rarely if ever used anyway.
2912 See also C<guestfs_sfdisk> and the L<sfdisk(8)> manpage.");
2914 ("zfile", (RString "description", [String "method"; String "path"]), 140, [DeprecatedBy "file"],
2916 "determine file type inside a compressed file",
2918 This command runs C<file> after first decompressing C<path>
2921 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
2923 Since 1.0.63, use C<guestfs_file> instead which can now
2924 process compressed files.");
2926 ("getxattrs", (RStructList ("xattrs", "xattr"), [String "path"]), 141, [],
2928 "list extended attributes of a file or directory",
2930 This call lists the extended attributes of the file or directory
2933 At the system call level, this is a combination of the
2934 L<listxattr(2)> and L<getxattr(2)> calls.
2936 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
2938 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [String "path"]), 142, [],
2940 "list extended attributes of a file or directory",
2942 This is the same as C<guestfs_getxattrs>, but if C<path>
2943 is a symbolic link, then it returns the extended attributes
2944 of the link itself.");
2946 ("setxattr", (RErr, [String "xattr";
2947 String "val"; Int "vallen"; (* will be BufferIn *)
2948 String "path"]), 143, [],
2950 "set extended attribute of a file or directory",
2952 This call sets the extended attribute named C<xattr>
2953 of the file C<path> to the value C<val> (of length C<vallen>).
2954 The value is arbitrary 8 bit data.
2956 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
2958 ("lsetxattr", (RErr, [String "xattr";
2959 String "val"; Int "vallen"; (* will be BufferIn *)
2960 String "path"]), 144, [],
2962 "set extended attribute of a file or directory",
2964 This is the same as C<guestfs_setxattr>, but if C<path>
2965 is a symbolic link, then it sets an extended attribute
2966 of the link itself.");
2968 ("removexattr", (RErr, [String "xattr"; String "path"]), 145, [],
2970 "remove extended attribute of a file or directory",
2972 This call removes the extended attribute named C<xattr>
2973 of the file C<path>.
2975 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
2977 ("lremovexattr", (RErr, [String "xattr"; String "path"]), 146, [],
2979 "remove extended attribute of a file or directory",
2981 This is the same as C<guestfs_removexattr>, but if C<path>
2982 is a symbolic link, then it removes an extended attribute
2983 of the link itself.");
2985 ("mountpoints", (RHashtable "mps", []), 147, [],
2989 This call is similar to C<guestfs_mounts>. That call returns
2990 a list of devices. This one returns a hash table (map) of
2991 device name to directory where the device is mounted.");
2993 ("mkmountpoint", (RErr, [String "path"]), 148, [],
2995 "create a mountpoint",
2997 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
2998 specialized calls that can be used to create extra mountpoints
2999 before mounting the first filesystem.
3001 These calls are I<only> necessary in some very limited circumstances,
3002 mainly the case where you want to mount a mix of unrelated and/or
3003 read-only filesystems together.
3005 For example, live CDs often contain a \"Russian doll\" nest of
3006 filesystems, an ISO outer layer, with a squashfs image inside, with
3007 an ext2/3 image inside that. You can unpack this as follows
3010 add-ro Fedora-11-i686-Live.iso
3013 mkmountpoint /squash
3016 mount-loop /cd/LiveOS/squashfs.img /squash
3017 mount-loop /squash/LiveOS/ext3fs.img /ext3
3019 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3021 ("rmmountpoint", (RErr, [String "path"]), 149, [],
3023 "remove a mountpoint",
3025 This calls removes a mountpoint that was previously created
3026 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3027 for full details.");
3029 ("read_file", (RBufferOut "content", [String "path"]), 150, [ProtocolLimitWarning],
3030 [InitSquashFS, Always, TestOutputBuffer (
3031 [["read_file"; "/known-4"]], "abc\ndef\nghi")],
3034 This calls returns the contents of the file C<path> as a
3037 Unlike C<guestfs_cat>, this function can correctly
3038 handle files that contain embedded ASCII NUL characters.
3039 However unlike C<guestfs_download>, this function is limited
3040 in the total size of file that can be handled.");
3042 ("grep", (RStringList "lines", [String "regex"; String "path"]), 151, [ProtocolLimitWarning],
3043 [InitSquashFS, Always, TestOutputList (
3044 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3045 InitSquashFS, Always, TestOutputList (
3046 [["grep"; "nomatch"; "/test-grep.txt"]], [])],
3047 "return lines matching a pattern",
3049 This calls the external C<grep> program and returns the
3052 ("egrep", (RStringList "lines", [String "regex"; String "path"]), 152, [ProtocolLimitWarning],
3053 [InitSquashFS, Always, TestOutputList (
3054 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3055 "return lines matching a pattern",
3057 This calls the external C<egrep> program and returns the
3060 ("fgrep", (RStringList "lines", [String "pattern"; String "path"]), 153, [ProtocolLimitWarning],
3061 [InitSquashFS, Always, TestOutputList (
3062 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3063 "return lines matching a pattern",
3065 This calls the external C<fgrep> program and returns the
3068 ("grepi", (RStringList "lines", [String "regex"; String "path"]), 154, [ProtocolLimitWarning],
3069 [InitSquashFS, Always, TestOutputList (
3070 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3071 "return lines matching a pattern",
3073 This calls the external C<grep -i> program and returns the
3076 ("egrepi", (RStringList "lines", [String "regex"; String "path"]), 155, [ProtocolLimitWarning],
3077 [InitSquashFS, Always, TestOutputList (
3078 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3079 "return lines matching a pattern",
3081 This calls the external C<egrep -i> program and returns the
3084 ("fgrepi", (RStringList "lines", [String "pattern"; String "path"]), 156, [ProtocolLimitWarning],
3085 [InitSquashFS, Always, TestOutputList (
3086 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3087 "return lines matching a pattern",
3089 This calls the external C<fgrep -i> program and returns the
3092 ("zgrep", (RStringList "lines", [String "regex"; String "path"]), 157, [ProtocolLimitWarning],
3093 [InitSquashFS, Always, TestOutputList (
3094 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3095 "return lines matching a pattern",
3097 This calls the external C<zgrep> program and returns the
3100 ("zegrep", (RStringList "lines", [String "regex"; String "path"]), 158, [ProtocolLimitWarning],
3101 [InitSquashFS, Always, TestOutputList (
3102 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3103 "return lines matching a pattern",
3105 This calls the external C<zegrep> program and returns the
3108 ("zfgrep", (RStringList "lines", [String "pattern"; String "path"]), 159, [ProtocolLimitWarning],
3109 [InitSquashFS, Always, TestOutputList (
3110 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3111 "return lines matching a pattern",
3113 This calls the external C<zfgrep> program and returns the
3116 ("zgrepi", (RStringList "lines", [String "regex"; String "path"]), 160, [ProtocolLimitWarning],
3117 [InitSquashFS, Always, TestOutputList (
3118 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3119 "return lines matching a pattern",
3121 This calls the external C<zgrep -i> program and returns the
3124 ("zegrepi", (RStringList "lines", [String "regex"; String "path"]), 161, [ProtocolLimitWarning],
3125 [InitSquashFS, Always, TestOutputList (
3126 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3127 "return lines matching a pattern",
3129 This calls the external C<zegrep -i> program and returns the
3132 ("zfgrepi", (RStringList "lines", [String "pattern"; String "path"]), 162, [ProtocolLimitWarning],
3133 [InitSquashFS, Always, TestOutputList (
3134 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3135 "return lines matching a pattern",
3137 This calls the external C<zfgrep -i> program and returns the
3140 ("realpath", (RString "rpath", [String "path"]), 163, [],
3141 [InitSquashFS, Always, TestOutput (
3142 [["realpath"; "/../directory"]], "/directory")],
3143 "canonicalized absolute pathname",
3145 Return the canonicalized absolute pathname of C<path>. The
3146 returned path has no C<.>, C<..> or symbolic link path elements.");
3148 ("ln", (RErr, [String "target"; String "linkname"]), 164, [],
3149 [InitBasicFS, Always, TestOutputStruct (
3152 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3153 "create a hard link",
3155 This command creates a hard link using the C<ln> command.");
3157 ("ln_f", (RErr, [String "target"; String "linkname"]), 165, [],
3158 [InitBasicFS, Always, TestOutputStruct (
3161 ["ln_f"; "/a"; "/b"];
3162 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3163 "create a hard link",
3165 This command creates a hard link using the C<ln -f> command.
3166 The C<-f> option removes the link (C<linkname>) if it exists already.");
3168 ("ln_s", (RErr, [String "target"; String "linkname"]), 166, [],
3169 [InitBasicFS, Always, TestOutputStruct (
3171 ["ln_s"; "a"; "/b"];
3172 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3173 "create a symbolic link",
3175 This command creates a symbolic link using the C<ln -s> command.");
3177 ("ln_sf", (RErr, [String "target"; String "linkname"]), 167, [],
3178 [InitBasicFS, Always, TestOutput (
3179 [["mkdir_p"; "/a/b"];
3180 ["touch"; "/a/b/c"];
3181 ["ln_sf"; "../d"; "/a/b/c"];
3182 ["readlink"; "/a/b/c"]], "../d")],
3183 "create a symbolic link",
3185 This command creates a symbolic link using the C<ln -sf> command,
3186 The C<-f> option removes the link (C<linkname>) if it exists already.");
3188 ("readlink", (RString "link", [String "path"]), 168, [],
3189 [] (* XXX tested above *),
3190 "read the target of a symbolic link",
3192 This command reads the target of a symbolic link.");
3194 ("fallocate", (RErr, [String "path"; Int "len"]), 169, [],
3195 [InitBasicFS, Always, TestOutputStruct (
3196 [["fallocate"; "/a"; "1000000"];
3197 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3198 "preallocate a file in the guest filesystem",
3200 This command preallocates a file (containing zero bytes) named
3201 C<path> of size C<len> bytes. If the file exists already, it
3204 Do not confuse this with the guestfish-specific
3205 C<alloc> command which allocates a file in the host and
3206 attaches it as a device.");
3208 ("swapon_device", (RErr, [String "device"]), 170, [],
3209 [InitNone, Always, TestRun (
3210 [["mkswap"; "/dev/sdb"];
3211 ["swapon_device"; "/dev/sdb"];
3212 ["swapoff_device"; "/dev/sdb"]])],
3213 "enable swap on device",
3215 This command enables the libguestfs appliance to use the
3216 swap device or partition named C<device>. The increased
3217 memory is made available for all commands, for example
3218 those run using C<guestfs_command> or C<guestfs_sh>.
3220 Note that you should not swap to existing guest swap
3221 partitions unless you know what you are doing. They may
3222 contain hibernation information, or other information that
3223 the guest doesn't want you to trash. You also risk leaking
3224 information about the host to the guest this way. Instead,
3225 attach a new host device to the guest and swap on that.");
3227 ("swapoff_device", (RErr, [String "device"]), 171, [],
3228 [], (* XXX tested by swapon_device *)
3229 "disable swap on device",
3231 This command disables the libguestfs appliance swap
3232 device or partition named C<device>.
3233 See C<guestfs_swapon_device>.");
3235 ("swapon_file", (RErr, [String "file"]), 172, [],
3236 [InitBasicFS, Always, TestRun (
3237 [["fallocate"; "/swap"; "8388608"];
3238 ["mkswap_file"; "/swap"];
3239 ["swapon_file"; "/swap"];
3240 ["swapoff_file"; "/swap"]])],
3241 "enable swap on file",
3243 This command enables swap to a file.
3244 See C<guestfs_swapon_device> for other notes.");
3246 ("swapoff_file", (RErr, [String "file"]), 173, [],
3247 [], (* XXX tested by swapon_file *)
3248 "disable swap on file",
3250 This command disables the libguestfs appliance swap on file.");
3252 ("swapon_label", (RErr, [String "label"]), 174, [],
3253 [InitEmpty, Always, TestRun (
3254 [["sfdiskM"; "/dev/sdb"; ","];
3255 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3256 ["swapon_label"; "swapit"];
3257 ["swapoff_label"; "swapit"]])],
3258 "enable swap on labelled swap partition",
3260 This command enables swap to a labelled swap partition.
3261 See C<guestfs_swapon_device> for other notes.");
3263 ("swapoff_label", (RErr, [String "label"]), 175, [],
3264 [], (* XXX tested by swapon_label *)
3265 "disable swap on labelled swap partition",
3267 This command disables the libguestfs appliance swap on
3268 labelled swap partition.");
3270 ("swapon_uuid", (RErr, [String "uuid"]), 176, [],
3271 [InitEmpty, Always, TestRun (
3272 [["mkswap_U"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"; "/dev/sdb"];
3273 ["swapon_uuid"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"];
3274 ["swapoff_uuid"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"]])],
3275 "enable swap on swap partition by UUID",
3277 This command enables swap to a swap partition with the given UUID.
3278 See C<guestfs_swapon_device> for other notes.");
3280 ("swapoff_uuid", (RErr, [String "uuid"]), 177, [],
3281 [], (* XXX tested by swapon_uuid *)
3282 "disable swap on swap partition by UUID",
3284 This command disables the libguestfs appliance swap partition
3285 with the given UUID.");
3287 ("mkswap_file", (RErr, [String "path"]), 178, [],
3288 [InitBasicFS, Always, TestRun (
3289 [["fallocate"; "/swap"; "8388608"];
3290 ["mkswap_file"; "/swap"]])],
3291 "create a swap file",
3295 This command just writes a swap file signature to an existing
3296 file. To create the file itself, use something like C<guestfs_fallocate>.");
3298 ("inotify_init", (RErr, [Int "maxevents"]), 179, [],
3299 [InitSquashFS, Always, TestRun (
3300 [["inotify_init"; "0"]])],
3301 "create an inotify handle",
3303 This command creates a new inotify handle.
3304 The inotify subsystem can be used to notify events which happen to
3305 objects in the guest filesystem.
3307 C<maxevents> is the maximum number of events which will be
3308 queued up between calls to C<guestfs_inotify_read> or
3309 C<guestfs_inotify_files>.
3310 If this is passed as C<0>, then the kernel (or previously set)
3311 default is used. For Linux 2.6.29 the default was 16384 events.
3312 Beyond this limit, the kernel throws away events, but records
3313 the fact that it threw them away by setting a flag
3314 C<IN_Q_OVERFLOW> in the returned structure list (see
3315 C<guestfs_inotify_read>).
3317 Before any events are generated, you have to add some
3318 watches to the internal watch list. See:
3319 C<guestfs_inotify_add_watch>,
3320 C<guestfs_inotify_rm_watch> and
3321 C<guestfs_inotify_watch_all>.
3323 Queued up events should be read periodically by calling
3324 C<guestfs_inotify_read>
3325 (or C<guestfs_inotify_files> which is just a helpful
3326 wrapper around C<guestfs_inotify_read>). If you don't
3327 read the events out often enough then you risk the internal
3330 The handle should be closed after use by calling
3331 C<guestfs_inotify_close>. This also removes any
3332 watches automatically.
3334 See also L<inotify(7)> for an overview of the inotify interface
3335 as exposed by the Linux kernel, which is roughly what we expose
3336 via libguestfs. Note that there is one global inotify handle
3337 per libguestfs instance.");
3339 ("inotify_add_watch", (RInt64 "wd", [String "path"; Int "mask"]), 180, [],
3340 [InitBasicFS, Always, TestOutputList (
3341 [["inotify_init"; "0"];
3342 ["inotify_add_watch"; "/"; "1073741823"];
3345 ["inotify_files"]], ["a"; "b"])],
3346 "add an inotify watch",
3348 Watch C<path> for the events listed in C<mask>.
3350 Note that if C<path> is a directory then events within that
3351 directory are watched, but this does I<not> happen recursively
3352 (in subdirectories).
3354 Note for non-C or non-Linux callers: the inotify events are
3355 defined by the Linux kernel ABI and are listed in
3356 C</usr/include/sys/inotify.h>.");
3358 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [],
3360 "remove an inotify watch",
3362 Remove a previously defined inotify watch.
3363 See C<guestfs_inotify_add_watch>.");
3365 ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [],
3367 "return list of inotify events",
3369 Return the complete queue of events that have happened
3370 since the previous read call.
3372 If no events have happened, this returns an empty list.
3374 I<Note>: In order to make sure that all events have been
3375 read, you must call this function repeatedly until it
3376 returns an empty list. The reason is that the call will
3377 read events up to the maximum appliance-to-host message
3378 size and leave remaining events in the queue.");
3380 ("inotify_files", (RStringList "paths", []), 183, [],
3382 "return list of watched files that had events",
3384 This function is a helpful wrapper around C<guestfs_inotify_read>
3385 which just returns a list of pathnames of objects that were
3386 touched. The returned pathnames are sorted and deduplicated.");
3388 ("inotify_close", (RErr, []), 184, [],
3390 "close the inotify handle",
3392 This closes the inotify handle which was previously
3393 opened by inotify_init. It removes all watches, throws
3394 away any pending events, and deallocates all resources.");
3398 let all_functions = non_daemon_functions @ daemon_functions
3400 (* In some places we want the functions to be displayed sorted
3401 * alphabetically, so this is useful:
3403 let all_functions_sorted =
3404 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
3405 compare n1 n2) all_functions
3407 (* Field types for structures. *)
3409 | FChar (* C 'char' (really, a 7 bit byte). *)
3410 | FString (* nul-terminated ASCII string, NOT NULL. *)
3411 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
3416 | FBytes (* Any int measure that counts bytes. *)
3417 | FUUID (* 32 bytes long, NOT nul-terminated. *)
3418 | FOptPercent (* [0..100], or -1 meaning "not present". *)
3420 (* Because we generate extra parsing code for LVM command line tools,
3421 * we have to pull out the LVM columns separately here.
3431 "pv_attr", FString (* XXX *);
3432 "pv_pe_count", FInt64;
3433 "pv_pe_alloc_count", FInt64;
3436 "pv_mda_count", FInt64;
3437 "pv_mda_free", FBytes;
3438 (* Not in Fedora 10:
3439 "pv_mda_size", FBytes;
3446 "vg_attr", FString (* XXX *);
3449 "vg_sysid", FString;
3450 "vg_extent_size", FBytes;
3451 "vg_extent_count", FInt64;
3452 "vg_free_count", FInt64;
3457 "snap_count", FInt64;
3460 "vg_mda_count", FInt64;
3461 "vg_mda_free", FBytes;
3462 (* Not in Fedora 10:
3463 "vg_mda_size", FBytes;
3469 "lv_attr", FString (* XXX *);
3472 "lv_kernel_major", FInt64;
3473 "lv_kernel_minor", FInt64;
3475 "seg_count", FInt64;
3477 "snap_percent", FOptPercent;
3478 "copy_percent", FOptPercent;
3481 "mirror_log", FString;
3485 (* Names and fields in all structures (in RStruct and RStructList)
3489 (* The old RIntBool return type, only ever used for aug_defnode. Do
3490 * not use this struct in any new code.
3493 "i", FInt32; (* for historical compatibility *)
3494 "b", FInt32; (* for historical compatibility *)
3497 (* LVM PVs, VGs, LVs. *)
3498 "lvm_pv", lvm_pv_cols;
3499 "lvm_vg", lvm_vg_cols;
3500 "lvm_lv", lvm_lv_cols;
3502 (* Column names and types from stat structures.
3503 * NB. Can't use things like 'st_atime' because glibc header files
3504 * define some of these as macros. Ugh.
3535 (* Column names in dirent structure. *)
3538 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
3543 (* Version numbers. *)
3551 (* Extended attribute. *)
3553 "attrname", FString;
3557 (* Inotify events. *)
3561 "in_cookie", FUInt32;
3564 ] (* end of structs *)
3566 (* Ugh, Java has to be different ..
3567 * These names are also used by the Haskell bindings.
3569 let java_structs = [
3570 "int_bool", "IntBool";
3575 "statvfs", "StatVFS";
3577 "version", "Version";
3579 "inotify_event", "INotifyEvent";
3582 (* Used for testing language bindings. *)
3584 | CallString of string
3585 | CallOptString of string option
3586 | CallStringList of string list
3590 (* Used to memoize the result of pod2text. *)
3591 let pod2text_memo_filename = "src/.pod2text.data"
3592 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
3594 let chan = open_in pod2text_memo_filename in
3595 let v = input_value chan in
3599 _ -> Hashtbl.create 13
3601 (* Useful functions.
3602 * Note we don't want to use any external OCaml libraries which
3603 * makes this a bit harder than it should be.
3605 let failwithf fs = ksprintf failwith fs
3607 let replace_char s c1 c2 =
3608 let s2 = String.copy s in
3609 let r = ref false in
3610 for i = 0 to String.length s2 - 1 do
3611 if String.unsafe_get s2 i = c1 then (
3612 String.unsafe_set s2 i c2;
3616 if not !r then s else s2
3620 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
3622 let triml ?(test = isspace) str =
3624 let n = ref (String.length str) in
3625 while !n > 0 && test str.[!i]; do
3630 else String.sub str !i !n
3632 let trimr ?(test = isspace) str =
3633 let n = ref (String.length str) in
3634 while !n > 0 && test str.[!n-1]; do
3637 if !n = String.length str then str
3638 else String.sub str 0 !n
3640 let trim ?(test = isspace) str =
3641 trimr ~test (triml ~test str)
3643 let rec find s sub =
3644 let len = String.length s in
3645 let sublen = String.length sub in
3647 if i <= len-sublen then (
3649 if j < sublen then (
3650 if s.[i+j] = sub.[j] then loop2 (j+1)
3656 if r = -1 then loop (i+1) else r
3662 let rec replace_str s s1 s2 =
3663 let len = String.length s in
3664 let sublen = String.length s1 in
3665 let i = find s s1 in
3668 let s' = String.sub s 0 i in
3669 let s'' = String.sub s (i+sublen) (len-i-sublen) in
3670 s' ^ s2 ^ replace_str s'' s1 s2
3673 let rec string_split sep str =
3674 let len = String.length str in
3675 let seplen = String.length sep in
3676 let i = find str sep in
3677 if i = -1 then [str]
3679 let s' = String.sub str 0 i in
3680 let s'' = String.sub str (i+seplen) (len-i-seplen) in
3681 s' :: string_split sep s''
3684 let files_equal n1 n2 =
3685 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
3686 match Sys.command cmd with
3689 | i -> failwithf "%s: failed with error code %d" cmd i
3691 let rec filter_map f = function
3695 | Some y -> y :: filter_map f xs
3696 | None -> filter_map f xs
3698 let rec find_map f = function
3699 | [] -> raise Not_found
3703 | None -> find_map f xs
3706 let rec loop i = function
3708 | x :: xs -> f i x; loop (i+1) xs
3713 let rec loop i = function
3715 | x :: xs -> let r = f i x in r :: loop (i+1) xs
3719 let name_of_argt = function
3720 | String n | OptString n | StringList n | Bool n | Int n
3721 | FileIn n | FileOut n -> n
3723 let java_name_of_struct typ =
3724 try List.assoc typ java_structs
3727 "java_name_of_struct: no java_structs entry corresponding to %s" typ
3729 let cols_of_struct typ =
3730 try List.assoc typ structs
3732 failwithf "cols_of_struct: unknown struct %s" typ
3734 let seq_of_test = function
3735 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
3736 | TestOutputListOfDevices (s, _)
3737 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
3738 | TestOutputTrue s | TestOutputFalse s
3739 | TestOutputLength (s, _) | TestOutputBuffer (s, _)
3740 | TestOutputStruct (s, _)
3741 | TestLastFail s -> s
3743 (* Handling for function flags. *)
3744 let protocol_limit_warning =
3745 "Because of the message protocol, there is a transfer limit
3746 of somewhere between 2MB and 4MB. To transfer large files you should use
3749 let danger_will_robinson =
3750 "B<This command is dangerous. Without careful use you
3751 can easily destroy all your data>."
3753 let deprecation_notice flags =
3756 find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
3758 sprintf "This function is deprecated.
3759 In new code, use the C<%s> call instead.
3761 Deprecated functions will not be removed from the API, but the
3762 fact that they are deprecated indicates that there are problems
3763 with correct use of these functions." alt in
3768 (* Check function names etc. for consistency. *)
3769 let check_functions () =
3770 let contains_uppercase str =
3771 let len = String.length str in
3773 if i >= len then false
3776 if c >= 'A' && c <= 'Z' then true
3783 (* Check function names. *)
3785 fun (name, _, _, _, _, _, _) ->
3786 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
3787 failwithf "function name %s does not need 'guestfs' prefix" name;
3789 failwithf "function name is empty";
3790 if name.[0] < 'a' || name.[0] > 'z' then
3791 failwithf "function name %s must start with lowercase a-z" name;
3792 if String.contains name '-' then
3793 failwithf "function name %s should not contain '-', use '_' instead."
3797 (* Check function parameter/return names. *)
3799 fun (name, style, _, _, _, _, _) ->
3800 let check_arg_ret_name n =
3801 if contains_uppercase n then
3802 failwithf "%s param/ret %s should not contain uppercase chars"
3804 if String.contains n '-' || String.contains n '_' then
3805 failwithf "%s param/ret %s should not contain '-' or '_'"
3808 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;
3809 if n = "int" || n = "char" || n = "short" || n = "long" then
3810 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
3811 if n = "i" || n = "n" then
3812 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
3813 if n = "argv" || n = "args" then
3814 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name
3817 (match fst style with
3819 | RInt n | RInt64 n | RBool n
3820 | RConstString n | RConstOptString n | RString n
3821 | RStringList n | RStruct (n, _) | RStructList (n, _)
3822 | RHashtable n | RBufferOut n ->
3823 check_arg_ret_name n
3825 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
3828 (* Check short descriptions. *)
3830 fun (name, _, _, _, _, shortdesc, _) ->
3831 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
3832 failwithf "short description of %s should begin with lowercase." name;
3833 let c = shortdesc.[String.length shortdesc-1] in
3834 if c = '\n' || c = '.' then
3835 failwithf "short description of %s should not end with . or \\n." name
3838 (* Check long dscriptions. *)
3840 fun (name, _, _, _, _, _, longdesc) ->
3841 if longdesc.[String.length longdesc-1] = '\n' then
3842 failwithf "long description of %s should not end with \\n." name
3845 (* Check proc_nrs. *)
3847 fun (name, _, proc_nr, _, _, _, _) ->
3848 if proc_nr <= 0 then
3849 failwithf "daemon function %s should have proc_nr > 0" name
3853 fun (name, _, proc_nr, _, _, _, _) ->
3854 if proc_nr <> -1 then
3855 failwithf "non-daemon function %s should have proc_nr -1" name
3856 ) non_daemon_functions;
3859 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
3862 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
3863 let rec loop = function
3866 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
3868 | (name1,nr1) :: (name2,nr2) :: _ ->
3869 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
3877 (* Ignore functions that have no tests. We generate a
3878 * warning when the user does 'make check' instead.
3880 | name, _, _, _, [], _, _ -> ()
3881 | name, _, _, _, tests, _, _ ->
3885 match seq_of_test test with
3887 failwithf "%s has a test containing an empty sequence" name
3888 | cmds -> List.map List.hd cmds
3890 let funcs = List.flatten funcs in
3892 let tested = List.mem name funcs in
3895 failwithf "function %s has tests but does not test itself" name
3898 (* 'pr' prints to the current output file. *)
3899 let chan = ref stdout
3900 let pr fs = ksprintf (output_string !chan) fs
3902 (* Generate a header block in a number of standard styles. *)
3903 type comment_style = CStyle | HashStyle | OCamlStyle | HaskellStyle
3904 type license = GPLv2 | LGPLv2
3906 let generate_header comment license =
3907 let c = match comment with
3908 | CStyle -> pr "/* "; " *"
3909 | HashStyle -> pr "# "; "#"
3910 | OCamlStyle -> pr "(* "; " *"
3911 | HaskellStyle -> pr "{- "; " " in
3912 pr "libguestfs generated file\n";
3913 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
3914 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
3916 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
3920 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
3921 pr "%s it under the terms of the GNU General Public License as published by\n" c;
3922 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
3923 pr "%s (at your option) any later version.\n" c;
3925 pr "%s This program is distributed in the hope that it will be useful,\n" c;
3926 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
3927 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
3928 pr "%s GNU General Public License for more details.\n" c;
3930 pr "%s You should have received a copy of the GNU General Public License along\n" c;
3931 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
3932 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
3935 pr "%s This library is free software; you can redistribute it and/or\n" c;
3936 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
3937 pr "%s License as published by the Free Software Foundation; either\n" c;
3938 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
3940 pr "%s This library is distributed in the hope that it will be useful,\n" c;
3941 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
3942 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
3943 pr "%s Lesser General Public License for more details.\n" c;
3945 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
3946 pr "%s License along with this library; if not, write to the Free Software\n" c;
3947 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
3950 | CStyle -> pr " */\n"
3952 | OCamlStyle -> pr " *)\n"
3953 | HaskellStyle -> pr "-}\n"
3957 (* Start of main code generation functions below this line. *)
3959 (* Generate the pod documentation for the C API. *)
3960 let rec generate_actions_pod () =
3962 fun (shortname, style, _, flags, _, _, longdesc) ->
3963 if not (List.mem NotInDocs flags) then (
3964 let name = "guestfs_" ^ shortname in
3965 pr "=head2 %s\n\n" name;
3967 generate_prototype ~extern:false ~handle:"handle" name style;
3969 pr "%s\n\n" longdesc;
3970 (match fst style with
3972 pr "This function returns 0 on success or -1 on error.\n\n"
3974 pr "On error this function returns -1.\n\n"
3976 pr "On error this function returns -1.\n\n"
3978 pr "This function returns a C truth value on success or -1 on error.\n\n"
3980 pr "This function returns a string, or NULL on error.
3981 The string is owned by the guest handle and must I<not> be freed.\n\n"
3982 | RConstOptString _ ->
3983 pr "This function returns a string which may be NULL.
3984 There is way to return an error from this function.
3985 The string is owned by the guest handle and must I<not> be freed.\n\n"
3987 pr "This function returns a string, or NULL on error.
3988 I<The caller must free the returned string after use>.\n\n"
3990 pr "This function returns a NULL-terminated array of strings
3991 (like L<environ(3)>), or NULL if there was an error.
3992 I<The caller must free the strings and the array after use>.\n\n"
3993 | RStruct (_, typ) ->
3994 pr "This function returns a C<struct guestfs_%s *>,
3995 or NULL if there was an error.
3996 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
3997 | RStructList (_, typ) ->
3998 pr "This function returns a C<struct guestfs_%s_list *>
3999 (see E<lt>guestfs-structs.hE<gt>),
4000 or NULL if there was an error.
4001 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
4003 pr "This function returns a NULL-terminated array of
4004 strings, or NULL if there was an error.
4005 The array of strings will always have length C<2n+1>, where
4006 C<n> keys and values alternate, followed by the trailing NULL entry.
4007 I<The caller must free the strings and the array after use>.\n\n"
4009 pr "This function returns a buffer, or NULL on error.
4010 The size of the returned buffer is written to C<*size_r>.
4011 I<The caller must free the returned buffer after use>.\n\n"
4013 if List.mem ProtocolLimitWarning flags then
4014 pr "%s\n\n" protocol_limit_warning;
4015 if List.mem DangerWillRobinson flags then
4016 pr "%s\n\n" danger_will_robinson;
4017 match deprecation_notice flags with
4019 | Some txt -> pr "%s\n\n" txt
4021 ) all_functions_sorted
4023 and generate_structs_pod () =
4024 (* Structs documentation. *)
4027 pr "=head2 guestfs_%s\n" typ;
4029 pr " struct guestfs_%s {\n" typ;
4032 | name, FChar -> pr " char %s;\n" name
4033 | name, FUInt32 -> pr " uint32_t %s;\n" name
4034 | name, FInt32 -> pr " int32_t %s;\n" name
4035 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
4036 | name, FInt64 -> pr " int64_t %s;\n" name
4037 | name, FString -> pr " char *%s;\n" name
4039 pr " /* The next two fields describe a byte array. */\n";
4040 pr " uint32_t %s_len;\n" name;
4041 pr " char *%s;\n" name
4043 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
4044 pr " char %s[32];\n" name
4045 | name, FOptPercent ->
4046 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
4047 pr " float %s;\n" name
4051 pr " struct guestfs_%s_list {\n" typ;
4052 pr " uint32_t len; /* Number of elements in list. */\n";
4053 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
4056 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
4057 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
4062 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
4063 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
4065 * We have to use an underscore instead of a dash because otherwise
4066 * rpcgen generates incorrect code.
4068 * This header is NOT exported to clients, but see also generate_structs_h.
4070 and generate_xdr () =
4071 generate_header CStyle LGPLv2;
4073 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
4074 pr "typedef string str<>;\n";
4077 (* Internal structures. *)
4081 pr "struct guestfs_int_%s {\n" typ;
4083 | name, FChar -> pr " char %s;\n" name
4084 | name, FString -> pr " string %s<>;\n" name
4085 | name, FBuffer -> pr " opaque %s<>;\n" name
4086 | name, FUUID -> pr " opaque %s[32];\n" name
4087 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
4088 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
4089 | name, FOptPercent -> pr " float %s;\n" name
4093 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
4098 fun (shortname, style, _, _, _, _, _) ->
4099 let name = "guestfs_" ^ shortname in
4101 (match snd style with
4104 pr "struct %s_args {\n" name;
4107 | String n -> pr " string %s<>;\n" n
4108 | OptString n -> pr " str *%s;\n" n
4109 | StringList n -> pr " str %s<>;\n" n
4110 | Bool n -> pr " bool %s;\n" n
4111 | Int n -> pr " int %s;\n" n
4112 | FileIn _ | FileOut _ -> ()
4116 (match fst style with
4119 pr "struct %s_ret {\n" name;
4123 pr "struct %s_ret {\n" name;
4124 pr " hyper %s;\n" n;
4127 pr "struct %s_ret {\n" name;
4130 | RConstString _ | RConstOptString _ ->
4131 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4133 pr "struct %s_ret {\n" name;
4134 pr " string %s<>;\n" n;
4137 pr "struct %s_ret {\n" name;
4138 pr " str %s<>;\n" n;
4140 | RStruct (n, typ) ->
4141 pr "struct %s_ret {\n" name;
4142 pr " guestfs_int_%s %s;\n" typ n;
4144 | RStructList (n, typ) ->
4145 pr "struct %s_ret {\n" name;
4146 pr " guestfs_int_%s_list %s;\n" typ n;
4149 pr "struct %s_ret {\n" name;
4150 pr " str %s<>;\n" n;
4153 pr "struct %s_ret {\n" name;
4154 pr " opaque %s<>;\n" n;
4159 (* Table of procedure numbers. *)
4160 pr "enum guestfs_procedure {\n";
4162 fun (shortname, _, proc_nr, _, _, _, _) ->
4163 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
4165 pr " GUESTFS_PROC_NR_PROCS\n";
4169 (* Having to choose a maximum message size is annoying for several
4170 * reasons (it limits what we can do in the API), but it (a) makes
4171 * the protocol a lot simpler, and (b) provides a bound on the size
4172 * of the daemon which operates in limited memory space. For large
4173 * file transfers you should use FTP.
4175 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
4178 (* Message header, etc. *)
4180 /* The communication protocol is now documented in the guestfs(3)
4184 const GUESTFS_PROGRAM = 0x2000F5F5;
4185 const GUESTFS_PROTOCOL_VERSION = 1;
4187 /* These constants must be larger than any possible message length. */
4188 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
4189 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
4191 enum guestfs_message_direction {
4192 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
4193 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
4196 enum guestfs_message_status {
4197 GUESTFS_STATUS_OK = 0,
4198 GUESTFS_STATUS_ERROR = 1
4201 const GUESTFS_ERROR_LEN = 256;
4203 struct guestfs_message_error {
4204 string error_message<GUESTFS_ERROR_LEN>;
4207 struct guestfs_message_header {
4208 unsigned prog; /* GUESTFS_PROGRAM */
4209 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
4210 guestfs_procedure proc; /* GUESTFS_PROC_x */
4211 guestfs_message_direction direction;
4212 unsigned serial; /* message serial number */
4213 guestfs_message_status status;
4216 const GUESTFS_MAX_CHUNK_SIZE = 8192;
4218 struct guestfs_chunk {
4219 int cancel; /* if non-zero, transfer is cancelled */
4220 /* data size is 0 bytes if the transfer has finished successfully */
4221 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
4225 (* Generate the guestfs-structs.h file. *)
4226 and generate_structs_h () =
4227 generate_header CStyle LGPLv2;
4229 (* This is a public exported header file containing various
4230 * structures. The structures are carefully written to have
4231 * exactly the same in-memory format as the XDR structures that
4232 * we use on the wire to the daemon. The reason for creating
4233 * copies of these structures here is just so we don't have to
4234 * export the whole of guestfs_protocol.h (which includes much
4235 * unrelated and XDR-dependent stuff that we don't want to be
4236 * public, or required by clients).
4238 * To reiterate, we will pass these structures to and from the
4239 * client with a simple assignment or memcpy, so the format
4240 * must be identical to what rpcgen / the RFC defines.
4243 (* Public structures. *)
4246 pr "struct guestfs_%s {\n" typ;
4249 | name, FChar -> pr " char %s;\n" name
4250 | name, FString -> pr " char *%s;\n" name
4252 pr " uint32_t %s_len;\n" name;
4253 pr " char *%s;\n" name
4254 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
4255 | name, FUInt32 -> pr " uint32_t %s;\n" name
4256 | name, FInt32 -> pr " int32_t %s;\n" name
4257 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
4258 | name, FInt64 -> pr " int64_t %s;\n" name
4259 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
4263 pr "struct guestfs_%s_list {\n" typ;
4264 pr " uint32_t len;\n";
4265 pr " struct guestfs_%s *val;\n" typ;
4268 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
4269 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
4273 (* Generate the guestfs-actions.h file. *)
4274 and generate_actions_h () =
4275 generate_header CStyle LGPLv2;
4277 fun (shortname, style, _, _, _, _, _) ->
4278 let name = "guestfs_" ^ shortname in
4279 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
4283 (* Generate the client-side dispatch stubs. *)
4284 and generate_client_actions () =
4285 generate_header CStyle LGPLv2;
4291 #include \"guestfs.h\"
4292 #include \"guestfs_protocol.h\"
4294 #define error guestfs_error
4295 #define perrorf guestfs_perrorf
4296 #define safe_malloc guestfs_safe_malloc
4297 #define safe_realloc guestfs_safe_realloc
4298 #define safe_strdup guestfs_safe_strdup
4299 #define safe_memdup guestfs_safe_memdup
4301 /* Check the return message from a call for validity. */
4303 check_reply_header (guestfs_h *g,
4304 const struct guestfs_message_header *hdr,
4305 int proc_nr, int serial)
4307 if (hdr->prog != GUESTFS_PROGRAM) {
4308 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
4311 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
4312 error (g, \"wrong protocol version (%%d/%%d)\",
4313 hdr->vers, GUESTFS_PROTOCOL_VERSION);
4316 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
4317 error (g, \"unexpected message direction (%%d/%%d)\",
4318 hdr->direction, GUESTFS_DIRECTION_REPLY);
4321 if (hdr->proc != proc_nr) {
4322 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
4325 if (hdr->serial != serial) {
4326 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
4333 /* Check we are in the right state to run a high-level action. */
4335 check_state (guestfs_h *g, const char *caller)
4337 if (!guestfs_is_ready (g)) {
4338 if (guestfs_is_config (g))
4339 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
4341 else if (guestfs_is_launching (g))
4342 error (g, \"%%s: call wait_ready() before using this function\",
4345 error (g, \"%%s called from the wrong state, %%d != READY\",
4346 caller, guestfs_get_state (g));
4354 (* Client-side stubs for each function. *)
4356 fun (shortname, style, _, _, _, _, _) ->
4357 let name = "guestfs_" ^ shortname in
4359 (* Generate the context struct which stores the high-level
4360 * state between callback functions.
4362 pr "struct %s_ctx {\n" shortname;
4363 pr " /* This flag is set by the callbacks, so we know we've done\n";
4364 pr " * the callbacks as expected, and in the right sequence.\n";
4365 pr " * 0 = not called, 1 = reply_cb called.\n";
4367 pr " int cb_sequence;\n";
4368 pr " struct guestfs_message_header hdr;\n";
4369 pr " struct guestfs_message_error err;\n";
4370 (match fst style with
4372 | RConstString _ | RConstOptString _ ->
4373 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4375 | RBool _ | RString _ | RStringList _
4376 | RStruct _ | RStructList _
4377 | RHashtable _ | RBufferOut _ ->
4378 pr " struct %s_ret ret;\n" name
4383 (* Generate the reply callback function. *)
4384 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
4386 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
4387 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
4389 pr " /* This should definitely not happen. */\n";
4390 pr " if (ctx->cb_sequence != 0) {\n";
4391 pr " ctx->cb_sequence = 9999;\n";
4392 pr " error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
4396 pr " ml->main_loop_quit (ml, g);\n";
4398 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
4399 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
4402 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
4403 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
4404 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
4411 (match fst style with
4413 | RConstString _ | RConstOptString _ ->
4414 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4416 | RBool _ | RString _ | RStringList _
4417 | RStruct _ | RStructList _
4418 | RHashtable _ | RBufferOut _ ->
4419 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
4420 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
4426 pr " ctx->cb_sequence = 1;\n";
4429 (* Generate the action stub. *)
4430 generate_prototype ~extern:false ~semicolon:false ~newline:true
4431 ~handle:"g" name style;
4434 match fst style with
4435 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
4436 | RConstString _ | RConstOptString _ ->
4437 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4438 | RString _ | RStringList _
4439 | RStruct _ | RStructList _
4440 | RHashtable _ | RBufferOut _ ->
4445 (match snd style with
4447 | _ -> pr " struct %s_args args;\n" name
4450 pr " struct %s_ctx ctx;\n" shortname;
4451 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
4452 pr " int serial;\n";
4454 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
4455 pr " guestfs_set_busy (g);\n";
4457 pr " memset (&ctx, 0, sizeof ctx);\n";
4460 (* Send the main header and arguments. *)
4461 (match snd style with
4463 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
4464 (String.uppercase shortname)
4469 pr " args.%s = (char *) %s;\n" n n
4471 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
4473 pr " args.%s.%s_val = (char **) %s;\n" n n n;
4474 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
4476 pr " args.%s = %s;\n" n n
4478 pr " args.%s = %s;\n" n n
4479 | FileIn _ | FileOut _ -> ()
4481 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
4482 (String.uppercase shortname);
4483 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
4486 pr " if (serial == -1) {\n";
4487 pr " guestfs_end_busy (g);\n";
4488 pr " return %s;\n" error_code;
4492 (* Send any additional files (FileIn) requested. *)
4493 let need_read_reply_label = ref false in
4500 pr " r = guestfs__send_file_sync (g, %s);\n" n;
4501 pr " if (r == -1) {\n";
4502 pr " guestfs_end_busy (g);\n";
4503 pr " return %s;\n" error_code;
4505 pr " if (r == -2) /* daemon cancelled */\n";
4506 pr " goto read_reply;\n";
4507 need_read_reply_label := true;
4513 (* Wait for the reply from the remote end. *)
4514 if !need_read_reply_label then pr " read_reply:\n";
4515 pr " guestfs__switch_to_receiving (g);\n";
4516 pr " ctx.cb_sequence = 0;\n";
4517 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
4518 pr " (void) ml->main_loop_run (ml, g);\n";
4519 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
4520 pr " if (ctx.cb_sequence != 1) {\n";
4521 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
4522 pr " guestfs_end_busy (g);\n";
4523 pr " return %s;\n" error_code;
4527 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
4528 (String.uppercase shortname);
4529 pr " guestfs_end_busy (g);\n";
4530 pr " return %s;\n" error_code;
4534 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
4535 pr " error (g, \"%%s\", ctx.err.error_message);\n";
4536 pr " free (ctx.err.error_message);\n";
4537 pr " guestfs_end_busy (g);\n";
4538 pr " return %s;\n" error_code;
4542 (* Expecting to receive further files (FileOut)? *)
4546 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
4547 pr " guestfs_end_busy (g);\n";
4548 pr " return %s;\n" error_code;
4554 pr " guestfs_end_busy (g);\n";
4556 (match fst style with
4557 | RErr -> pr " return 0;\n"
4558 | RInt n | RInt64 n | RBool n ->
4559 pr " return ctx.ret.%s;\n" n
4560 | RConstString _ | RConstOptString _ ->
4561 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4563 pr " return ctx.ret.%s; /* caller will free */\n" n
4564 | RStringList n | RHashtable n ->
4565 pr " /* caller will free this, but we need to add a NULL entry */\n";
4566 pr " ctx.ret.%s.%s_val =\n" n n;
4567 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
4568 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
4570 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
4571 pr " return ctx.ret.%s.%s_val;\n" n n
4573 pr " /* caller will free this */\n";
4574 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
4575 | RStructList (n, _) ->
4576 pr " /* caller will free this */\n";
4577 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
4579 pr " *size_r = ctx.ret.%s.%s_len;\n" n n;
4580 pr " return ctx.ret.%s.%s_val; /* caller will free */\n" n n
4586 (* Functions to free structures. *)
4587 pr "/* Structure-freeing functions. These rely on the fact that the\n";
4588 pr " * structure format is identical to the XDR format. See note in\n";
4589 pr " * generator.ml.\n";
4596 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
4598 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
4604 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
4606 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
4613 (* Generate daemon/actions.h. *)
4614 and generate_daemon_actions_h () =
4615 generate_header CStyle GPLv2;
4617 pr "#include \"../src/guestfs_protocol.h\"\n";
4621 fun (name, style, _, _, _, _, _) ->
4623 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
4627 (* Generate the server-side stubs. *)
4628 and generate_daemon_actions () =
4629 generate_header CStyle GPLv2;
4631 pr "#include <config.h>\n";
4633 pr "#include <stdio.h>\n";
4634 pr "#include <stdlib.h>\n";
4635 pr "#include <string.h>\n";
4636 pr "#include <inttypes.h>\n";
4637 pr "#include <ctype.h>\n";
4638 pr "#include <rpc/types.h>\n";
4639 pr "#include <rpc/xdr.h>\n";
4641 pr "#include \"daemon.h\"\n";
4642 pr "#include \"../src/guestfs_protocol.h\"\n";
4643 pr "#include \"actions.h\"\n";
4647 fun (name, style, _, _, _, _, _) ->
4648 (* Generate server-side stubs. *)
4649 pr "static void %s_stub (XDR *xdr_in)\n" name;
4652 match fst style with
4653 | RErr | RInt _ -> pr " int r;\n"; "-1"
4654 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4655 | RBool _ -> pr " int r;\n"; "-1"
4656 | RConstString _ | RConstOptString _ ->
4657 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4658 | RString _ -> pr " char *r;\n"; "NULL"
4659 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
4660 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
4661 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
4663 pr " size_t size;\n";
4667 (match snd style with
4670 pr " struct guestfs_%s_args args;\n" name;
4673 (* Note we allow the string to be writable, in order to
4674 * allow device name translation. This is safe because
4675 * we can modify the string (passed from RPC).
4678 | OptString n -> pr " char *%s;\n" n
4679 | StringList n -> pr " char **%s;\n" n
4680 | Bool n -> pr " int %s;\n" n
4681 | Int n -> pr " int %s;\n" n
4682 | FileIn _ | FileOut _ -> ()
4687 (match snd style with
4690 pr " memset (&args, 0, sizeof args);\n";
4692 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
4693 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
4698 | String n -> pr " %s = args.%s;\n" n n
4699 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
4701 pr " %s = realloc (args.%s.%s_val,\n" n n n;
4702 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
4703 pr " if (%s == NULL) {\n" n;
4704 pr " reply_with_perror (\"realloc\");\n";
4707 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
4708 pr " args.%s.%s_val = %s;\n" n n n;
4709 | Bool n -> pr " %s = args.%s;\n" n n
4710 | Int n -> pr " %s = args.%s;\n" n n
4711 | FileIn _ | FileOut _ -> ()
4716 (* Don't want to call the impl with any FileIn or FileOut
4717 * parameters, since these go "outside" the RPC protocol.
4720 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
4722 pr " r = do_%s " name;
4723 generate_c_call_args (fst style, args');
4726 pr " if (r == %s)\n" error_code;
4727 pr " /* do_%s has already called reply_with_error */\n" name;
4731 (* If there are any FileOut parameters, then the impl must
4732 * send its own reply.
4735 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
4737 pr " /* do_%s has already sent a reply */\n" name
4739 match fst style with
4740 | RErr -> pr " reply (NULL, NULL);\n"
4741 | RInt n | RInt64 n | RBool n ->
4742 pr " struct guestfs_%s_ret ret;\n" name;
4743 pr " ret.%s = r;\n" n;
4744 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4746 | RConstString _ | RConstOptString _ ->
4747 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4749 pr " struct guestfs_%s_ret ret;\n" name;
4750 pr " ret.%s = r;\n" n;
4751 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4754 | RStringList n | RHashtable n ->
4755 pr " struct guestfs_%s_ret ret;\n" name;
4756 pr " ret.%s.%s_len = count_strings (r);\n" n n;
4757 pr " ret.%s.%s_val = r;\n" n n;
4758 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4760 pr " free_strings (r);\n"
4762 pr " struct guestfs_%s_ret ret;\n" name;
4763 pr " ret.%s = *r;\n" n;
4764 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4766 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4768 | RStructList (n, _) ->
4769 pr " struct guestfs_%s_ret ret;\n" name;
4770 pr " ret.%s = *r;\n" n;
4771 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4773 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4776 pr " struct guestfs_%s_ret ret;\n" name;
4777 pr " ret.%s.%s_val = r;\n" n n;
4778 pr " ret.%s.%s_len = size;\n" n n;
4779 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4784 (* Free the args. *)
4785 (match snd style with
4790 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
4797 (* Dispatch function. *)
4798 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
4800 pr " switch (proc_nr) {\n";
4803 fun (name, style, _, _, _, _, _) ->
4804 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
4805 pr " %s_stub (xdr_in);\n" name;
4810 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";
4815 (* LVM columns and tokenization functions. *)
4816 (* XXX This generates crap code. We should rethink how we
4822 pr "static const char *lvm_%s_cols = \"%s\";\n"
4823 typ (String.concat "," (List.map fst cols));
4826 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
4828 pr " char *tok, *p, *next;\n";
4832 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
4835 pr " if (!str) {\n";
4836 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
4839 pr " if (!*str || isspace (*str)) {\n";
4840 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
4845 fun (name, coltype) ->
4846 pr " if (!tok) {\n";
4847 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
4850 pr " p = strchrnul (tok, ',');\n";
4851 pr " if (*p) next = p+1; else next = NULL;\n";
4852 pr " *p = '\\0';\n";
4855 pr " r->%s = strdup (tok);\n" name;
4856 pr " if (r->%s == NULL) {\n" name;
4857 pr " perror (\"strdup\");\n";
4861 pr " for (i = j = 0; i < 32; ++j) {\n";
4862 pr " if (tok[j] == '\\0') {\n";
4863 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
4865 pr " } else if (tok[j] != '-')\n";
4866 pr " r->%s[i++] = tok[j];\n" name;
4869 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
4870 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4874 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
4875 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4879 pr " if (tok[0] == '\\0')\n";
4880 pr " r->%s = -1;\n" name;
4881 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
4882 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4885 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
4886 assert false (* can never be an LVM column *)
4888 pr " tok = next;\n";
4891 pr " if (tok != NULL) {\n";
4892 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
4899 pr "guestfs_int_lvm_%s_list *\n" typ;
4900 pr "parse_command_line_%ss (void)\n" typ;
4902 pr " char *out, *err;\n";
4903 pr " char *p, *pend;\n";
4905 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
4906 pr " void *newp;\n";
4908 pr " ret = malloc (sizeof *ret);\n";
4909 pr " if (!ret) {\n";
4910 pr " reply_with_perror (\"malloc\");\n";
4911 pr " return NULL;\n";
4914 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
4915 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
4917 pr " r = command (&out, &err,\n";
4918 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
4919 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
4920 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
4921 pr " if (r == -1) {\n";
4922 pr " reply_with_error (\"%%s\", err);\n";
4923 pr " free (out);\n";
4924 pr " free (err);\n";
4925 pr " free (ret);\n";
4926 pr " return NULL;\n";
4929 pr " free (err);\n";
4931 pr " /* Tokenize each line of the output. */\n";
4934 pr " while (p) {\n";
4935 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
4936 pr " if (pend) {\n";
4937 pr " *pend = '\\0';\n";
4941 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
4944 pr " if (!*p) { /* Empty line? Skip it. */\n";
4949 pr " /* Allocate some space to store this next entry. */\n";
4950 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
4951 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
4952 pr " if (newp == NULL) {\n";
4953 pr " reply_with_perror (\"realloc\");\n";
4954 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
4955 pr " free (ret);\n";
4956 pr " free (out);\n";
4957 pr " return NULL;\n";
4959 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
4961 pr " /* Tokenize the next entry. */\n";
4962 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
4963 pr " if (r == -1) {\n";
4964 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
4965 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
4966 pr " free (ret);\n";
4967 pr " free (out);\n";
4968 pr " return NULL;\n";
4975 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
4977 pr " free (out);\n";
4978 pr " return ret;\n";
4981 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
4983 (* Generate a list of function names, for debugging in the daemon.. *)
4984 and generate_daemon_names () =
4985 generate_header CStyle GPLv2;
4987 pr "#include <config.h>\n";
4989 pr "#include \"daemon.h\"\n";
4992 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
4993 pr "const char *function_names[] = {\n";
4995 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
4999 (* Generate the tests. *)
5000 and generate_tests () =
5001 generate_header CStyle GPLv2;
5008 #include <sys/types.h>
5011 #include \"guestfs.h\"
5013 static guestfs_h *g;
5014 static int suppress_error = 0;
5016 static void print_error (guestfs_h *g, void *data, const char *msg)
5018 if (!suppress_error)
5019 fprintf (stderr, \"%%s\\n\", msg);
5022 static void print_strings (char * const * const argv)
5026 for (argc = 0; argv[argc] != NULL; ++argc)
5027 printf (\"\\t%%s\\n\", argv[argc]);
5031 static void print_table (char * const * const argv)
5035 for (i = 0; argv[i] != NULL; i += 2)
5036 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
5042 (* Generate a list of commands which are not tested anywhere. *)
5043 pr "static void no_test_warnings (void)\n";
5046 let hash : (string, bool) Hashtbl.t = Hashtbl.create 13 in
5048 fun (_, _, _, _, tests, _, _) ->
5049 let tests = filter_map (
5051 | (_, (Always|If _|Unless _), test) -> Some test
5052 | (_, Disabled, _) -> None
5054 let seq = List.concat (List.map seq_of_test tests) in
5055 let cmds_tested = List.map List.hd seq in
5056 List.iter (fun cmd -> Hashtbl.replace hash cmd true) cmds_tested
5060 fun (name, _, _, _, _, _, _) ->
5061 if not (Hashtbl.mem hash name) then
5062 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
5068 (* Generate the actual tests. Note that we generate the tests
5069 * in reverse order, deliberately, so that (in general) the
5070 * newest tests run first. This makes it quicker and easier to
5075 fun (name, _, _, _, tests, _, _) ->
5076 mapi (generate_one_test name) tests
5077 ) (List.rev all_functions) in
5078 let test_names = List.concat test_names in
5079 let nr_tests = List.length test_names in
5082 int main (int argc, char *argv[])
5086 const char *filename;
5088 int nr_tests, test_num = 0;
5090 setbuf (stdout, NULL);
5092 no_test_warnings ();
5094 g = guestfs_create ();
5096 printf (\"guestfs_create FAILED\\n\");
5100 guestfs_set_error_handler (g, print_error, NULL);
5102 guestfs_set_path (g, \"../appliance\");
5104 filename = \"test1.img\";
5105 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
5110 if (lseek (fd, %d, SEEK_SET) == -1) {
5116 if (write (fd, &c, 1) == -1) {
5122 if (close (fd) == -1) {
5127 if (guestfs_add_drive (g, filename) == -1) {
5128 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
5132 filename = \"test2.img\";
5133 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
5138 if (lseek (fd, %d, SEEK_SET) == -1) {
5144 if (write (fd, &c, 1) == -1) {
5150 if (close (fd) == -1) {
5155 if (guestfs_add_drive (g, filename) == -1) {
5156 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
5160 filename = \"test3.img\";
5161 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
5166 if (lseek (fd, %d, SEEK_SET) == -1) {
5172 if (write (fd, &c, 1) == -1) {
5178 if (close (fd) == -1) {
5183 if (guestfs_add_drive (g, filename) == -1) {
5184 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
5188 if (guestfs_add_drive_ro (g, \"../images/test.sqsh\") == -1) {
5189 printf (\"guestfs_add_drive_ro ../images/test.sqsh FAILED\\n\");
5193 if (guestfs_launch (g) == -1) {
5194 printf (\"guestfs_launch FAILED\\n\");
5198 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
5201 if (guestfs_wait_ready (g) == -1) {
5202 printf (\"guestfs_wait_ready FAILED\\n\");
5206 /* Cancel previous alarm. */
5211 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
5215 pr " test_num++;\n";
5216 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
5217 pr " if (%s () == -1) {\n" test_name;
5218 pr " printf (\"%s FAILED\\n\");\n" test_name;
5224 pr " guestfs_close (g);\n";
5225 pr " unlink (\"test1.img\");\n";
5226 pr " unlink (\"test2.img\");\n";
5227 pr " unlink (\"test3.img\");\n";
5230 pr " if (failed > 0) {\n";
5231 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
5239 and generate_one_test name i (init, prereq, test) =
5240 let test_name = sprintf "test_%s_%d" name i in
5243 static int %s_skip (void)
5247 str = getenv (\"TEST_ONLY\");
5249 return strstr (str, \"%s\") == NULL;
5250 str = getenv (\"SKIP_%s\");
5251 if (str && strcmp (str, \"1\") == 0) return 1;
5252 str = getenv (\"SKIP_TEST_%s\");
5253 if (str && strcmp (str, \"1\") == 0) return 1;
5257 " test_name name (String.uppercase test_name) (String.uppercase name);
5260 | Disabled | Always -> ()
5261 | If code | Unless code ->
5262 pr "static int %s_prereq (void)\n" test_name;
5270 static int %s (void)
5273 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
5277 " test_name test_name test_name;
5281 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
5283 pr " if (! %s_prereq ()) {\n" test_name;
5284 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
5288 generate_one_test_body name i test_name init test;
5290 pr " if (%s_prereq ()) {\n" test_name;
5291 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
5295 generate_one_test_body name i test_name init test;
5297 generate_one_test_body name i test_name init test
5305 and generate_one_test_body name i test_name init test =
5307 | InitNone (* XXX at some point, InitNone and InitEmpty became
5308 * folded together as the same thing. Really we should
5309 * make InitNone do nothing at all, but the tests may
5310 * need to be checked to make sure this is OK.
5313 pr " /* InitNone|InitEmpty for %s */\n" test_name;
5314 List.iter (generate_test_command_call test_name)
5315 [["blockdev_setrw"; "/dev/sda"];
5319 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
5320 List.iter (generate_test_command_call test_name)
5321 [["blockdev_setrw"; "/dev/sda"];
5324 ["sfdiskM"; "/dev/sda"; ","];
5325 ["mkfs"; "ext2"; "/dev/sda1"];
5326 ["mount"; "/dev/sda1"; "/"]]
5327 | InitBasicFSonLVM ->
5328 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
5330 List.iter (generate_test_command_call test_name)
5331 [["blockdev_setrw"; "/dev/sda"];
5334 ["sfdiskM"; "/dev/sda"; ","];
5335 ["pvcreate"; "/dev/sda1"];
5336 ["vgcreate"; "VG"; "/dev/sda1"];
5337 ["lvcreate"; "LV"; "VG"; "8"];
5338 ["mkfs"; "ext2"; "/dev/VG/LV"];
5339 ["mount"; "/dev/VG/LV"; "/"]]
5341 pr " /* InitSquashFS for %s */\n" test_name;
5342 List.iter (generate_test_command_call test_name)
5343 [["blockdev_setrw"; "/dev/sda"];
5346 ["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"]]
5349 let get_seq_last = function
5351 failwithf "%s: you cannot use [] (empty list) when expecting a command"
5354 let seq = List.rev seq in
5355 List.rev (List.tl seq), List.hd seq
5360 pr " /* TestRun for %s (%d) */\n" name i;
5361 List.iter (generate_test_command_call test_name) seq
5362 | TestOutput (seq, expected) ->
5363 pr " /* TestOutput for %s (%d) */\n" name i;
5364 pr " const char *expected = \"%s\";\n" (c_quote expected);
5365 let seq, last = get_seq_last seq in
5367 pr " if (strcmp (r, expected) != 0) {\n";
5368 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
5372 List.iter (generate_test_command_call test_name) seq;
5373 generate_test_command_call ~test test_name last
5374 | TestOutputList (seq, expected) ->
5375 pr " /* TestOutputList for %s (%d) */\n" name i;
5376 let seq, last = get_seq_last seq in
5380 pr " if (!r[%d]) {\n" i;
5381 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
5382 pr " print_strings (r);\n";
5386 pr " const char *expected = \"%s\";\n" (c_quote str);
5387 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
5388 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
5393 pr " if (r[%d] != NULL) {\n" (List.length expected);
5394 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
5396 pr " print_strings (r);\n";
5400 List.iter (generate_test_command_call test_name) seq;
5401 generate_test_command_call ~test test_name last
5402 | TestOutputListOfDevices (seq, expected) ->
5403 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
5404 let seq, last = get_seq_last seq in
5408 pr " if (!r[%d]) {\n" i;
5409 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
5410 pr " print_strings (r);\n";
5414 pr " const char *expected = \"%s\";\n" (c_quote str);
5415 pr " r[%d][5] = 's';\n" i;
5416 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
5417 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
5422 pr " if (r[%d] != NULL) {\n" (List.length expected);
5423 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
5425 pr " print_strings (r);\n";
5429 List.iter (generate_test_command_call test_name) seq;
5430 generate_test_command_call ~test test_name last
5431 | TestOutputInt (seq, expected) ->
5432 pr " /* TestOutputInt for %s (%d) */\n" name i;
5433 let seq, last = get_seq_last seq in
5435 pr " if (r != %d) {\n" expected;
5436 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
5442 List.iter (generate_test_command_call test_name) seq;
5443 generate_test_command_call ~test test_name last
5444 | TestOutputIntOp (seq, op, expected) ->
5445 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
5446 let seq, last = get_seq_last seq in
5448 pr " if (! (r %s %d)) {\n" op expected;
5449 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
5450 test_name op expected;
5455 List.iter (generate_test_command_call test_name) seq;
5456 generate_test_command_call ~test test_name last
5457 | TestOutputTrue seq ->
5458 pr " /* TestOutputTrue for %s (%d) */\n" name i;
5459 let seq, last = get_seq_last seq in
5462 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
5467 List.iter (generate_test_command_call test_name) seq;
5468 generate_test_command_call ~test test_name last
5469 | TestOutputFalse seq ->
5470 pr " /* TestOutputFalse for %s (%d) */\n" name i;
5471 let seq, last = get_seq_last seq in
5474 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
5479 List.iter (generate_test_command_call test_name) seq;
5480 generate_test_command_call ~test test_name last
5481 | TestOutputLength (seq, expected) ->
5482 pr " /* TestOutputLength for %s (%d) */\n" name i;
5483 let seq, last = get_seq_last seq in
5486 pr " for (j = 0; j < %d; ++j)\n" expected;
5487 pr " if (r[j] == NULL) {\n";
5488 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
5490 pr " print_strings (r);\n";
5493 pr " if (r[j] != NULL) {\n";
5494 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
5496 pr " print_strings (r);\n";
5500 List.iter (generate_test_command_call test_name) seq;
5501 generate_test_command_call ~test test_name last
5502 | TestOutputBuffer (seq, expected) ->
5503 pr " /* TestOutputBuffer for %s (%d) */\n" name i;
5504 pr " const char *expected = \"%s\";\n" (c_quote expected);
5505 let seq, last = get_seq_last seq in
5506 let len = String.length expected in
5508 pr " if (size != %d) {\n" len;
5509 pr " fprintf (stderr, \"%s: returned size of buffer wrong, expected %d but got %%zu\\n\", size);\n" test_name len;
5512 pr " if (strncmp (r, expected, size) != 0) {\n";
5513 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
5517 List.iter (generate_test_command_call test_name) seq;
5518 generate_test_command_call ~test test_name last
5519 | TestOutputStruct (seq, checks) ->
5520 pr " /* TestOutputStruct for %s (%d) */\n" name i;
5521 let seq, last = get_seq_last seq in
5525 | CompareWithInt (field, expected) ->
5526 pr " if (r->%s != %d) {\n" field expected;
5527 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
5528 test_name field expected;
5529 pr " (int) r->%s);\n" field;
5532 | CompareWithIntOp (field, op, expected) ->
5533 pr " if (!(r->%s %s %d)) {\n" field op expected;
5534 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
5535 test_name field op expected;
5536 pr " (int) r->%s);\n" field;
5539 | CompareWithString (field, expected) ->
5540 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
5541 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
5542 test_name field expected;
5543 pr " r->%s);\n" field;
5546 | CompareFieldsIntEq (field1, field2) ->
5547 pr " if (r->%s != r->%s) {\n" field1 field2;
5548 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
5549 test_name field1 field2;
5550 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
5553 | CompareFieldsStrEq (field1, field2) ->
5554 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
5555 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
5556 test_name field1 field2;
5557 pr " r->%s, r->%s);\n" field1 field2;
5562 List.iter (generate_test_command_call test_name) seq;
5563 generate_test_command_call ~test test_name last
5564 | TestLastFail seq ->
5565 pr " /* TestLastFail for %s (%d) */\n" name i;
5566 let seq, last = get_seq_last seq in
5567 List.iter (generate_test_command_call test_name) seq;
5568 generate_test_command_call test_name ~expect_error:true last
5570 (* Generate the code to run a command, leaving the result in 'r'.
5571 * If you expect to get an error then you should set expect_error:true.
5573 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
5575 | [] -> assert false
5577 (* Look up the command to find out what args/ret it has. *)
5580 let _, style, _, _, _, _, _ =
5581 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
5584 failwithf "%s: in test, command %s was not found" test_name name in
5586 if List.length (snd style) <> List.length args then
5587 failwithf "%s: in test, wrong number of args given to %s"
5594 | OptString n, "NULL" -> ()
5596 | OptString n, arg ->
5597 pr " const char *%s = \"%s\";\n" n (c_quote arg);
5600 | FileIn _, _ | FileOut _, _ -> ()
5601 | StringList n, arg ->
5602 let strs = string_split " " arg in
5605 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
5607 pr " const char *%s[] = {\n" n;
5609 fun i _ -> pr " %s_%d,\n" n i
5613 ) (List.combine (snd style) args);
5616 match fst style with
5617 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5618 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5619 | RConstString _ | RConstOptString _ ->
5620 pr " const char *r;\n"; "NULL"
5621 | RString _ -> pr " char *r;\n"; "NULL"
5622 | RStringList _ | RHashtable _ ->
5626 | RStruct (_, typ) ->
5627 pr " struct guestfs_%s *r;\n" typ; "NULL"
5628 | RStructList (_, typ) ->
5629 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
5632 pr " size_t size;\n";
5635 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
5636 pr " r = guestfs_%s (g" name;
5638 (* Generate the parameters. *)
5641 | OptString _, "NULL" -> pr ", NULL"
5645 | FileIn _, arg | FileOut _, arg ->
5646 pr ", \"%s\"" (c_quote arg)
5647 | StringList n, _ ->
5651 try int_of_string arg
5652 with Failure "int_of_string" ->
5653 failwithf "%s: expecting an int, but got '%s'" test_name arg in
5656 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
5657 ) (List.combine (snd style) args);
5659 (match fst style with
5660 | RBufferOut _ -> pr ", &size"
5666 if not expect_error then
5667 pr " if (r == %s)\n" error_code
5669 pr " if (r != %s)\n" error_code;
5672 (* Insert the test code. *)
5678 (match fst style with
5679 | RErr | RInt _ | RInt64 _ | RBool _
5680 | RConstString _ | RConstOptString _ -> ()
5681 | RString _ | RBufferOut _ -> pr " free (r);\n"
5682 | RStringList _ | RHashtable _ ->
5683 pr " for (i = 0; r[i] != NULL; ++i)\n";
5684 pr " free (r[i]);\n";
5686 | RStruct (_, typ) ->
5687 pr " guestfs_free_%s (r);\n" typ
5688 | RStructList (_, typ) ->
5689 pr " guestfs_free_%s_list (r);\n" typ
5695 let str = replace_str str "\r" "\\r" in
5696 let str = replace_str str "\n" "\\n" in
5697 let str = replace_str str "\t" "\\t" in
5698 let str = replace_str str "\000" "\\0" in
5701 (* Generate a lot of different functions for guestfish. *)
5702 and generate_fish_cmds () =
5703 generate_header CStyle GPLv2;
5707 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5709 let all_functions_sorted =
5711 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5712 ) all_functions_sorted in
5714 pr "#include <stdio.h>\n";
5715 pr "#include <stdlib.h>\n";
5716 pr "#include <string.h>\n";
5717 pr "#include <inttypes.h>\n";
5718 pr "#include <ctype.h>\n";
5720 pr "#include <guestfs.h>\n";
5721 pr "#include \"fish.h\"\n";
5724 (* list_commands function, which implements guestfish -h *)
5725 pr "void list_commands (void)\n";
5727 pr " printf (\" %%-16s %%s\\n\", _(\"Command\"), _(\"Description\"));\n";
5728 pr " list_builtin_commands ();\n";
5730 fun (name, _, _, flags, _, shortdesc, _) ->
5731 let name = replace_char name '_' '-' in
5732 pr " printf (\"%%-20s %%s\\n\", \"%s\", _(\"%s\"));\n"
5734 ) all_functions_sorted;
5735 pr " printf (\" %%s\\n\",";
5736 pr " _(\"Use -h <cmd> / help <cmd> to show detailed help for a command.\"));\n";
5740 (* display_command function, which implements guestfish -h cmd *)
5741 pr "void display_command (const char *cmd)\n";
5744 fun (name, style, _, flags, _, shortdesc, longdesc) ->
5745 let name2 = replace_char name '_' '-' in
5747 try find_map (function FishAlias n -> Some n | _ -> None) flags
5748 with Not_found -> name in
5749 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
5751 match snd style with
5755 name2 (String.concat "> <" (List.map name_of_argt args)) in
5758 if List.mem ProtocolLimitWarning flags then
5759 ("\n\n" ^ protocol_limit_warning)
5762 (* For DangerWillRobinson commands, we should probably have
5763 * guestfish prompt before allowing you to use them (especially
5764 * in interactive mode). XXX
5768 if List.mem DangerWillRobinson flags then
5769 ("\n\n" ^ danger_will_robinson)
5774 match deprecation_notice flags with
5776 | Some txt -> "\n\n" ^ txt in
5778 let describe_alias =
5779 if name <> alias then
5780 sprintf "\n\nYou can use '%s' as an alias for this command." alias
5784 pr "strcasecmp (cmd, \"%s\") == 0" name;
5785 if name <> name2 then
5786 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
5787 if name <> alias then
5788 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
5790 pr " pod2text (\"%s\", _(\"%s\"), %S);\n"
5792 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
5795 pr " display_builtin_command (cmd);\n";
5799 (* print_* functions *)
5803 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
5805 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
5814 pr " printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
5816 pr " printf (\"%s: \");\n" name;
5817 pr " for (i = 0; i < 32; ++i)\n";
5818 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
5819 pr " printf (\"\\n\");\n"
5821 pr " printf (\"%s: \");\n" name;
5822 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
5823 pr " if (isprint (%s->%s[i]))\n" typ name;
5824 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
5826 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
5827 pr " printf (\"\\n\");\n"
5828 | name, (FUInt64|FBytes) ->
5829 pr " printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
5831 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
5833 pr " printf (\"%s: %%\" PRIu32 \"\\n\", %s->%s);\n" name typ name
5835 pr " printf (\"%s: %%\" PRIi32 \"\\n\", %s->%s);\n" name typ name
5837 pr " printf (\"%s: %%c\\n\", %s->%s);\n" name typ name
5838 | name, FOptPercent ->
5839 pr " if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
5840 typ name name typ name;
5841 pr " else printf (\"%s: \\n\");\n" name
5845 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
5850 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
5851 pr " print_%s (&%ss->val[i]);\n" typ typ;
5856 (* run_<action> actions *)
5858 fun (name, style, _, flags, _, _, _) ->
5859 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
5861 (match fst style with
5864 | RBool _ -> pr " int r;\n"
5865 | RInt64 _ -> pr " int64_t r;\n"
5866 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
5867 | RString _ -> pr " char *r;\n"
5868 | RStringList _ | RHashtable _ -> pr " char **r;\n"
5869 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
5870 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
5873 pr " size_t size;\n";
5880 | FileOut n -> pr " const char *%s;\n" n
5881 | StringList n -> pr " char **%s;\n" n
5882 | Bool n -> pr " int %s;\n" n
5883 | Int n -> pr " int %s;\n" n
5886 (* Check and convert parameters. *)
5887 let argc_expected = List.length (snd style) in
5888 pr " if (argc != %d) {\n" argc_expected;
5889 pr " fprintf (stderr, _(\"%%s should have %%d parameter(s)\\n\"), cmd, %d);\n"
5891 pr " fprintf (stderr, _(\"type 'help %%s' for help on %%s\\n\"), cmd, cmd);\n";
5897 | String name -> pr " %s = argv[%d];\n" name i
5899 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
5902 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
5905 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
5907 | StringList name ->
5908 pr " %s = parse_string_list (argv[%d]);\n" name i
5910 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
5912 pr " %s = atoi (argv[%d]);\n" name i
5915 (* Call C API function. *)
5917 try find_map (function FishAction n -> Some n | _ -> None) flags
5918 with Not_found -> sprintf "guestfs_%s" name in
5920 generate_c_call_args ~handle:"g" style;
5923 (* Check return value for errors and display command results. *)
5924 (match fst style with
5925 | RErr -> pr " return r;\n"
5927 pr " if (r == -1) return -1;\n";
5928 pr " printf (\"%%d\\n\", r);\n";
5931 pr " if (r == -1) return -1;\n";
5932 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
5935 pr " if (r == -1) return -1;\n";
5936 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
5939 pr " if (r == NULL) return -1;\n";
5940 pr " printf (\"%%s\\n\", r);\n";
5942 | RConstOptString _ ->
5943 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
5946 pr " if (r == NULL) return -1;\n";
5947 pr " printf (\"%%s\\n\", r);\n";
5951 pr " if (r == NULL) return -1;\n";
5952 pr " print_strings (r);\n";
5953 pr " free_strings (r);\n";
5955 | RStruct (_, typ) ->
5956 pr " if (r == NULL) return -1;\n";
5957 pr " print_%s (r);\n" typ;
5958 pr " guestfs_free_%s (r);\n" typ;
5960 | RStructList (_, typ) ->
5961 pr " if (r == NULL) return -1;\n";
5962 pr " print_%s_list (r);\n" typ;
5963 pr " guestfs_free_%s_list (r);\n" typ;
5966 pr " if (r == NULL) return -1;\n";
5967 pr " print_table (r);\n";
5968 pr " free_strings (r);\n";
5971 pr " if (r == NULL) return -1;\n";
5972 pr " fwrite (r, size, 1, stdout);\n";
5980 (* run_action function *)
5981 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
5984 fun (name, _, _, flags, _, _, _) ->
5985 let name2 = replace_char name '_' '-' in
5987 try find_map (function FishAlias n -> Some n | _ -> None) flags
5988 with Not_found -> name in
5990 pr "strcasecmp (cmd, \"%s\") == 0" name;
5991 if name <> name2 then
5992 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
5993 if name <> alias then
5994 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
5996 pr " return run_%s (cmd, argc, argv);\n" name;
6000 pr " fprintf (stderr, _(\"%%s: unknown command\\n\"), cmd);\n";
6007 (* Readline completion for guestfish. *)
6008 and generate_fish_completion () =
6009 generate_header CStyle GPLv2;
6013 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
6023 #ifdef HAVE_LIBREADLINE
6024 #include <readline/readline.h>
6029 #ifdef HAVE_LIBREADLINE
6031 static const char *const commands[] = {
6032 BUILTIN_COMMANDS_FOR_COMPLETION,
6035 (* Get the commands, including the aliases. They don't need to be
6036 * sorted - the generator() function just does a dumb linear search.
6040 fun (name, _, _, flags, _, _, _) ->
6041 let name2 = replace_char name '_' '-' in
6043 try find_map (function FishAlias n -> Some n | _ -> None) flags
6044 with Not_found -> name in
6046 if name <> alias then [name2; alias] else [name2]
6048 let commands = List.flatten commands in
6050 List.iter (pr " \"%s\",\n") commands;
6056 generator (const char *text, int state)
6058 static int index, len;
6063 len = strlen (text);
6066 rl_attempted_completion_over = 1;
6068 while ((name = commands[index]) != NULL) {
6070 if (strncasecmp (name, text, len) == 0)
6071 return strdup (name);
6077 #endif /* HAVE_LIBREADLINE */
6079 char **do_completion (const char *text, int start, int end)
6081 char **matches = NULL;
6083 #ifdef HAVE_LIBREADLINE
6084 rl_completion_append_character = ' ';
6087 matches = rl_completion_matches (text, generator);
6088 else if (complete_dest_paths)
6089 matches = rl_completion_matches (text, complete_dest_paths_generator);
6096 (* Generate the POD documentation for guestfish. *)
6097 and generate_fish_actions_pod () =
6098 let all_functions_sorted =
6100 fun (_, _, _, flags, _, _, _) ->
6101 not (List.mem NotInFish flags || List.mem NotInDocs flags)
6102 ) all_functions_sorted in
6104 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
6107 fun (name, style, _, flags, _, _, longdesc) ->
6109 Str.global_substitute rex (
6112 try Str.matched_group 1 s
6114 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
6115 "C<" ^ replace_char sub '_' '-' ^ ">"
6117 let name = replace_char name '_' '-' in
6119 try find_map (function FishAlias n -> Some n | _ -> None) flags
6120 with Not_found -> name in
6122 pr "=head2 %s" name;
6123 if name <> alias then
6130 | String n -> pr " %s" n
6131 | OptString n -> pr " %s" n
6132 | StringList n -> pr " '%s ...'" n
6133 | Bool _ -> pr " true|false"
6134 | Int n -> pr " %s" n
6135 | FileIn n | FileOut n -> pr " (%s|-)" n
6139 pr "%s\n\n" longdesc;
6141 if List.exists (function FileIn _ | FileOut _ -> true
6142 | _ -> false) (snd style) then
6143 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
6145 if List.mem ProtocolLimitWarning flags then
6146 pr "%s\n\n" protocol_limit_warning;
6148 if List.mem DangerWillRobinson flags then
6149 pr "%s\n\n" danger_will_robinson;
6151 match deprecation_notice flags with
6153 | Some txt -> pr "%s\n\n" txt
6154 ) all_functions_sorted
6156 (* Generate a C function prototype. *)
6157 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
6158 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
6160 ?handle name style =
6161 if extern then pr "extern ";
6162 if static then pr "static ";
6163 (match fst style with
6165 | RInt _ -> pr "int "
6166 | RInt64 _ -> pr "int64_t "
6167 | RBool _ -> pr "int "
6168 | RConstString _ | RConstOptString _ -> pr "const char *"
6169 | RString _ | RBufferOut _ -> pr "char *"
6170 | RStringList _ | RHashtable _ -> pr "char **"
6171 | RStruct (_, typ) ->
6172 if not in_daemon then pr "struct guestfs_%s *" typ
6173 else pr "guestfs_int_%s *" typ
6174 | RStructList (_, typ) ->
6175 if not in_daemon then pr "struct guestfs_%s_list *" typ
6176 else pr "guestfs_int_%s_list *" typ
6178 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
6179 pr "%s%s (" prefix name;
6180 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
6183 let comma = ref false in
6186 | Some handle -> pr "guestfs_h *%s" handle; comma := true
6190 if single_line then pr ", " else pr ",\n\t\t"
6199 if not in_daemon then pr "const char *%s" n
6200 else pr "char *%s" n
6203 if not in_daemon then pr "char * const* const %s" n
6204 else pr "char **%s" n
6205 | Bool n -> next (); pr "int %s" n
6206 | Int n -> next (); pr "int %s" n
6209 if not in_daemon then (next (); pr "const char *%s" n)
6211 if is_RBufferOut then (next (); pr "size_t *size_r");
6214 if semicolon then pr ";";
6215 if newline then pr "\n"
6217 (* Generate C call arguments, eg "(handle, foo, bar)" *)
6218 and generate_c_call_args ?handle ?(decl = false) style =
6220 let comma = ref false in
6222 if !comma then pr ", ";
6227 | Some handle -> pr "%s" handle; comma := true
6232 pr "%s" (name_of_argt arg)
6234 (* For RBufferOut calls, add implicit &size parameter. *)
6236 match fst style with
6244 (* Generate the OCaml bindings interface. *)
6245 and generate_ocaml_mli () =
6246 generate_header OCamlStyle LGPLv2;
6249 (** For API documentation you should refer to the C API
6250 in the guestfs(3) manual page. The OCaml API uses almost
6251 exactly the same calls. *)
6254 (** A [guestfs_h] handle. *)
6256 exception Error of string
6257 (** This exception is raised when there is an error. *)
6259 val create : unit -> t
6261 val close : t -> unit
6262 (** Handles are closed by the garbage collector when they become
6263 unreferenced, but callers can also call this in order to
6264 provide predictable cleanup. *)
6267 generate_ocaml_structure_decls ();
6271 fun (name, style, _, _, _, shortdesc, _) ->
6272 generate_ocaml_prototype name style;
6273 pr "(** %s *)\n" shortdesc;
6277 (* Generate the OCaml bindings implementation. *)
6278 and generate_ocaml_ml () =
6279 generate_header OCamlStyle LGPLv2;
6283 exception Error of string
6284 external create : unit -> t = \"ocaml_guestfs_create\"
6285 external close : t -> unit = \"ocaml_guestfs_close\"
6288 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
6292 generate_ocaml_structure_decls ();
6296 fun (name, style, _, _, _, shortdesc, _) ->
6297 generate_ocaml_prototype ~is_external:true name style;
6300 (* Generate the OCaml bindings C implementation. *)
6301 and generate_ocaml_c () =
6302 generate_header CStyle LGPLv2;
6309 #include <caml/config.h>
6310 #include <caml/alloc.h>
6311 #include <caml/callback.h>
6312 #include <caml/fail.h>
6313 #include <caml/memory.h>
6314 #include <caml/mlvalues.h>
6315 #include <caml/signals.h>
6317 #include <guestfs.h>
6319 #include \"guestfs_c.h\"
6321 /* Copy a hashtable of string pairs into an assoc-list. We return
6322 * the list in reverse order, but hashtables aren't supposed to be
6325 static CAMLprim value
6326 copy_table (char * const * argv)
6329 CAMLlocal5 (rv, pairv, kv, vv, cons);
6333 for (i = 0; argv[i] != NULL; i += 2) {
6334 kv = caml_copy_string (argv[i]);
6335 vv = caml_copy_string (argv[i+1]);
6336 pairv = caml_alloc (2, 0);
6337 Store_field (pairv, 0, kv);
6338 Store_field (pairv, 1, vv);
6339 cons = caml_alloc (2, 0);
6340 Store_field (cons, 1, rv);
6342 Store_field (cons, 0, pairv);
6350 (* Struct copy functions. *)
6353 let has_optpercent_col =
6354 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
6356 pr "static CAMLprim value\n";
6357 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
6359 pr " CAMLparam0 ();\n";
6360 if has_optpercent_col then
6361 pr " CAMLlocal3 (rv, v, v2);\n"
6363 pr " CAMLlocal2 (rv, v);\n";
6365 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
6370 pr " v = caml_copy_string (%s->%s);\n" typ name
6372 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
6373 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
6376 pr " v = caml_alloc_string (32);\n";
6377 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
6378 | name, (FBytes|FInt64|FUInt64) ->
6379 pr " v = caml_copy_int64 (%s->%s);\n" typ name
6380 | name, (FInt32|FUInt32) ->
6381 pr " v = caml_copy_int32 (%s->%s);\n" typ name
6382 | name, FOptPercent ->
6383 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
6384 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
6385 pr " v = caml_alloc (1, 0);\n";
6386 pr " Store_field (v, 0, v2);\n";
6387 pr " } else /* None */\n";
6388 pr " v = Val_int (0);\n";
6390 pr " v = Val_int (%s->%s);\n" typ name
6392 pr " Store_field (rv, %d, v);\n" i
6394 pr " CAMLreturn (rv);\n";
6398 pr "static CAMLprim value\n";
6399 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n"
6402 pr " CAMLparam0 ();\n";
6403 pr " CAMLlocal2 (rv, v);\n";
6406 pr " if (%ss->len == 0)\n" typ;
6407 pr " CAMLreturn (Atom (0));\n";
6409 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
6410 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
6411 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
6412 pr " caml_modify (&Field (rv, i), v);\n";
6414 pr " CAMLreturn (rv);\n";
6422 fun (name, style, _, _, _, _, _) ->
6424 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
6426 let needs_extra_vs =
6427 match fst style with RConstOptString _ -> true | _ -> false in
6429 pr "CAMLprim value\n";
6430 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
6431 List.iter (pr ", value %s") (List.tl params);
6436 | [p1; p2; p3; p4; p5] ->
6437 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
6438 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
6439 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
6440 pr " CAMLxparam%d (%s);\n"
6441 (List.length rest) (String.concat ", " rest)
6443 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
6445 if not needs_extra_vs then
6446 pr " CAMLlocal1 (rv);\n"
6448 pr " CAMLlocal3 (rv, v, v2);\n";
6451 pr " guestfs_h *g = Guestfs_val (gv);\n";
6452 pr " if (g == NULL)\n";
6453 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
6461 pr " const char *%s = String_val (%sv);\n" n n
6463 pr " const char *%s =\n" n;
6464 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
6467 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
6469 pr " int %s = Bool_val (%sv);\n" n n
6471 pr " int %s = Int_val (%sv);\n" n n
6474 match fst style with
6475 | RErr -> pr " int r;\n"; "-1"
6476 | RInt _ -> pr " int r;\n"; "-1"
6477 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6478 | RBool _ -> pr " int r;\n"; "-1"
6479 | RConstString _ | RConstOptString _ ->
6480 pr " const char *r;\n"; "NULL"
6481 | RString _ -> pr " char *r;\n"; "NULL"
6486 | RStruct (_, typ) ->
6487 pr " struct guestfs_%s *r;\n" typ; "NULL"
6488 | RStructList (_, typ) ->
6489 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
6496 pr " size_t size;\n";
6500 pr " caml_enter_blocking_section ();\n";
6501 pr " r = guestfs_%s " name;
6502 generate_c_call_args ~handle:"g" style;
6504 pr " caml_leave_blocking_section ();\n";
6509 pr " ocaml_guestfs_free_strings (%s);\n" n;
6510 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
6513 pr " if (r == %s)\n" error_code;
6514 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
6517 (match fst style with
6518 | RErr -> pr " rv = Val_unit;\n"
6519 | RInt _ -> pr " rv = Val_int (r);\n"
6521 pr " rv = caml_copy_int64 (r);\n"
6522 | RBool _ -> pr " rv = Val_bool (r);\n"
6524 pr " rv = caml_copy_string (r);\n"
6525 | RConstOptString _ ->
6526 pr " if (r) { /* Some string */\n";
6527 pr " v = caml_alloc (1, 0);\n";
6528 pr " v2 = caml_copy_string (r);\n";
6529 pr " Store_field (v, 0, v2);\n";
6530 pr " } else /* None */\n";
6531 pr " v = Val_int (0);\n";
6533 pr " rv = caml_copy_string (r);\n";
6536 pr " rv = caml_copy_string_array ((const char **) r);\n";
6537 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
6539 | RStruct (_, typ) ->
6540 pr " rv = copy_%s (r);\n" typ;
6541 pr " guestfs_free_%s (r);\n" typ;
6542 | RStructList (_, typ) ->
6543 pr " rv = copy_%s_list (r);\n" typ;
6544 pr " guestfs_free_%s_list (r);\n" typ;
6546 pr " rv = copy_table (r);\n";
6547 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
6550 pr " rv = caml_alloc_string (size);\n";
6551 pr " memcpy (String_val (rv), r, size);\n";
6554 pr " CAMLreturn (rv);\n";
6558 if List.length params > 5 then (
6559 pr "CAMLprim value\n";
6560 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
6562 pr " return ocaml_guestfs_%s (argv[0]" name;
6563 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
6570 and generate_ocaml_structure_decls () =
6573 pr "type %s = {\n" typ;
6576 | name, FString -> pr " %s : string;\n" name
6577 | name, FBuffer -> pr " %s : string;\n" name
6578 | name, FUUID -> pr " %s : string;\n" name
6579 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
6580 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
6581 | name, FChar -> pr " %s : char;\n" name
6582 | name, FOptPercent -> pr " %s : float option;\n" name
6588 and generate_ocaml_prototype ?(is_external = false) name style =
6589 if is_external then pr "external " else pr "val ";
6590 pr "%s : t -> " name;
6593 | String _ | FileIn _ | FileOut _ -> pr "string -> "
6594 | OptString _ -> pr "string option -> "
6595 | StringList _ -> pr "string array -> "
6596 | Bool _ -> pr "bool -> "
6597 | Int _ -> pr "int -> "
6599 (match fst style with
6600 | RErr -> pr "unit" (* all errors are turned into exceptions *)
6601 | RInt _ -> pr "int"
6602 | RInt64 _ -> pr "int64"
6603 | RBool _ -> pr "bool"
6604 | RConstString _ -> pr "string"
6605 | RConstOptString _ -> pr "string option"
6606 | RString _ | RBufferOut _ -> pr "string"
6607 | RStringList _ -> pr "string array"
6608 | RStruct (_, typ) -> pr "%s" typ
6609 | RStructList (_, typ) -> pr "%s array" typ
6610 | RHashtable _ -> pr "(string * string) list"
6612 if is_external then (
6614 if List.length (snd style) + 1 > 5 then
6615 pr "\"ocaml_guestfs_%s_byte\" " name;
6616 pr "\"ocaml_guestfs_%s\"" name
6620 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
6621 and generate_perl_xs () =
6622 generate_header CStyle LGPLv2;
6625 #include \"EXTERN.h\"
6629 #include <guestfs.h>
6632 #define PRId64 \"lld\"
6636 my_newSVll(long long val) {
6637 #ifdef USE_64_BIT_ALL
6638 return newSViv(val);
6642 len = snprintf(buf, 100, \"%%\" PRId64, val);
6643 return newSVpv(buf, len);
6648 #define PRIu64 \"llu\"
6652 my_newSVull(unsigned long long val) {
6653 #ifdef USE_64_BIT_ALL
6654 return newSVuv(val);
6658 len = snprintf(buf, 100, \"%%\" PRIu64, val);
6659 return newSVpv(buf, len);
6663 /* http://www.perlmonks.org/?node_id=680842 */
6665 XS_unpack_charPtrPtr (SV *arg) {
6670 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
6671 croak (\"array reference expected\");
6673 av = (AV *)SvRV (arg);
6674 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
6676 croak (\"malloc failed\");
6678 for (i = 0; i <= av_len (av); i++) {
6679 SV **elem = av_fetch (av, i, 0);
6681 if (!elem || !*elem)
6682 croak (\"missing element in list\");
6684 ret[i] = SvPV_nolen (*elem);
6692 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
6699 RETVAL = guestfs_create ();
6701 croak (\"could not create guestfs handle\");
6702 guestfs_set_error_handler (RETVAL, NULL, NULL);
6715 fun (name, style, _, _, _, _, _) ->
6716 (match fst style with
6717 | RErr -> pr "void\n"
6718 | RInt _ -> pr "SV *\n"
6719 | RInt64 _ -> pr "SV *\n"
6720 | RBool _ -> pr "SV *\n"
6721 | RConstString _ -> pr "SV *\n"
6722 | RConstOptString _ -> pr "SV *\n"
6723 | RString _ -> pr "SV *\n"
6724 | RBufferOut _ -> pr "SV *\n"
6726 | RStruct _ | RStructList _
6728 pr "void\n" (* all lists returned implictly on the stack *)
6730 (* Call and arguments. *)
6732 generate_c_call_args ~handle:"g" ~decl:true style;
6734 pr " guestfs_h *g;\n";
6738 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
6740 (* http://www.perlmonks.org/?node_id=554277
6741 * Note that the implicit handle argument means we have
6742 * to add 1 to the ST(x) operator.
6744 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
6745 | StringList n -> pr " char **%s;\n" n
6746 | Bool n -> pr " int %s;\n" n
6747 | Int n -> pr " int %s;\n" n
6750 let do_cleanups () =
6753 | String _ | OptString _ | Bool _ | Int _
6754 | FileIn _ | FileOut _ -> ()
6755 | StringList n -> pr " free (%s);\n" n
6760 (match fst style with
6765 pr " r = guestfs_%s " name;
6766 generate_c_call_args ~handle:"g" style;
6769 pr " if (r == -1)\n";
6770 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6776 pr " %s = guestfs_%s " n name;
6777 generate_c_call_args ~handle:"g" style;
6780 pr " if (%s == -1)\n" n;
6781 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6782 pr " RETVAL = newSViv (%s);\n" n;
6787 pr " int64_t %s;\n" n;
6789 pr " %s = guestfs_%s " n name;
6790 generate_c_call_args ~handle:"g" style;
6793 pr " if (%s == -1)\n" n;
6794 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6795 pr " RETVAL = my_newSVll (%s);\n" n;
6800 pr " const char *%s;\n" n;
6802 pr " %s = guestfs_%s " n name;
6803 generate_c_call_args ~handle:"g" style;
6806 pr " if (%s == NULL)\n" n;
6807 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6808 pr " RETVAL = newSVpv (%s, 0);\n" n;
6811 | RConstOptString n ->
6813 pr " const char *%s;\n" n;
6815 pr " %s = guestfs_%s " n name;
6816 generate_c_call_args ~handle:"g" style;
6819 pr " if (%s == NULL)\n" n;
6820 pr " RETVAL = &PL_sv_undef;\n";
6822 pr " RETVAL = newSVpv (%s, 0);\n" n;
6827 pr " char *%s;\n" n;
6829 pr " %s = guestfs_%s " n name;
6830 generate_c_call_args ~handle:"g" style;
6833 pr " if (%s == NULL)\n" n;
6834 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6835 pr " RETVAL = newSVpv (%s, 0);\n" n;
6836 pr " free (%s);\n" n;
6839 | RStringList n | RHashtable n ->
6841 pr " char **%s;\n" n;
6844 pr " %s = guestfs_%s " n name;
6845 generate_c_call_args ~handle:"g" style;
6848 pr " if (%s == NULL)\n" n;
6849 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6850 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
6851 pr " EXTEND (SP, n);\n";
6852 pr " for (i = 0; i < n; ++i) {\n";
6853 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
6854 pr " free (%s[i]);\n" n;
6856 pr " free (%s);\n" n;
6857 | RStruct (n, typ) ->
6858 let cols = cols_of_struct typ in
6859 generate_perl_struct_code typ cols name style n do_cleanups
6860 | RStructList (n, typ) ->
6861 let cols = cols_of_struct typ in
6862 generate_perl_struct_list_code typ cols name style n do_cleanups
6865 pr " char *%s;\n" n;
6866 pr " size_t size;\n";
6868 pr " %s = guestfs_%s " n name;
6869 generate_c_call_args ~handle:"g" style;
6872 pr " if (%s == NULL)\n" n;
6873 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6874 pr " RETVAL = newSVpv (%s, size);\n" n;
6875 pr " free (%s);\n" n;
6883 and generate_perl_struct_list_code typ cols name style n do_cleanups =
6885 pr " struct guestfs_%s_list *%s;\n" typ n;
6889 pr " %s = guestfs_%s " n name;
6890 generate_c_call_args ~handle:"g" style;
6893 pr " if (%s == NULL)\n" n;
6894 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6895 pr " EXTEND (SP, %s->len);\n" n;
6896 pr " for (i = 0; i < %s->len; ++i) {\n" n;
6897 pr " hv = newHV ();\n";
6901 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
6902 name (String.length name) n name
6904 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
6905 name (String.length name) n name
6907 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
6908 name (String.length name) n name n name
6909 | name, (FBytes|FUInt64) ->
6910 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
6911 name (String.length name) n name
6913 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
6914 name (String.length name) n name
6915 | name, (FInt32|FUInt32) ->
6916 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
6917 name (String.length name) n name
6919 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
6920 name (String.length name) n name
6921 | name, FOptPercent ->
6922 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
6923 name (String.length name) n name
6925 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
6927 pr " guestfs_free_%s_list (%s);\n" typ n
6929 and generate_perl_struct_code typ cols name style n do_cleanups =
6931 pr " struct guestfs_%s *%s;\n" typ n;
6933 pr " %s = guestfs_%s " n name;
6934 generate_c_call_args ~handle:"g" style;
6937 pr " if (%s == NULL)\n" n;
6938 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6939 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
6941 fun ((name, _) as col) ->
6942 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
6946 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
6949 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, %s->%s_len)));\n"
6952 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
6954 | name, (FBytes|FUInt64) ->
6955 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
6958 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
6960 | name, (FInt32|FUInt32) ->
6961 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
6964 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
6966 | name, FOptPercent ->
6967 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
6970 pr " free (%s);\n" n
6972 (* Generate Sys/Guestfs.pm. *)
6973 and generate_perl_pm () =
6974 generate_header HashStyle LGPLv2;
6981 Sys::Guestfs - Perl bindings for libguestfs
6987 my $h = Sys::Guestfs->new ();
6988 $h->add_drive ('guest.img');
6991 $h->mount ('/dev/sda1', '/');
6992 $h->touch ('/hello');
6997 The C<Sys::Guestfs> module provides a Perl XS binding to the
6998 libguestfs API for examining and modifying virtual machine
7001 Amongst the things this is good for: making batch configuration
7002 changes to guests, getting disk used/free statistics (see also:
7003 virt-df), migrating between virtualization systems (see also:
7004 virt-p2v), performing partial backups, performing partial guest
7005 clones, cloning guests and changing registry/UUID/hostname info, and
7008 Libguestfs uses Linux kernel and qemu code, and can access any type of
7009 guest filesystem that Linux and qemu can, including but not limited
7010 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
7011 schemes, qcow, qcow2, vmdk.
7013 Libguestfs provides ways to enumerate guest storage (eg. partitions,
7014 LVs, what filesystem is in each LV, etc.). It can also run commands
7015 in the context of the guest. Also you can access filesystems over FTP.
7017 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
7018 functions for using libguestfs from Perl, including integration
7023 All errors turn into calls to C<croak> (see L<Carp(3)>).
7031 package Sys::Guestfs;
7037 XSLoader::load ('Sys::Guestfs');
7039 =item $h = Sys::Guestfs->new ();
7041 Create a new guestfs handle.
7047 my $class = ref ($proto) || $proto;
7049 my $self = Sys::Guestfs::_create ();
7050 bless $self, $class;
7056 (* Actions. We only need to print documentation for these as
7057 * they are pulled in from the XS code automatically.
7060 fun (name, style, _, flags, _, _, longdesc) ->
7061 if not (List.mem NotInDocs flags) then (
7062 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
7064 generate_perl_prototype name style;
7066 pr "%s\n\n" longdesc;
7067 if List.mem ProtocolLimitWarning flags then
7068 pr "%s\n\n" protocol_limit_warning;
7069 if List.mem DangerWillRobinson flags then
7070 pr "%s\n\n" danger_will_robinson;
7071 match deprecation_notice flags with
7073 | Some txt -> pr "%s\n\n" txt
7075 ) all_functions_sorted;
7087 Copyright (C) 2009 Red Hat Inc.
7091 Please see the file COPYING.LIB for the full license.
7097 L<http://libguestfs.org>,
7098 L<Sys::Guestfs::Lib(3)>.
7103 and generate_perl_prototype name style =
7104 (match fst style with
7112 | RBufferOut n -> pr "$%s = " n
7114 | RHashtable n -> pr "%%%s = " n
7116 | RStructList (n,_) -> pr "@%s = " n
7119 let comma = ref false in
7122 if !comma then pr ", ";
7125 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
7132 (* Generate Python C module. *)
7133 and generate_python_c () =
7134 generate_header CStyle LGPLv2;
7143 #include \"guestfs.h\"
7151 get_handle (PyObject *obj)
7154 assert (obj != Py_None);
7155 return ((Pyguestfs_Object *) obj)->g;
7159 put_handle (guestfs_h *g)
7163 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
7166 /* This list should be freed (but not the strings) after use. */
7167 static const char **
7168 get_string_list (PyObject *obj)
7175 if (!PyList_Check (obj)) {
7176 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
7180 len = PyList_Size (obj);
7181 r = malloc (sizeof (char *) * (len+1));
7183 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
7187 for (i = 0; i < len; ++i)
7188 r[i] = PyString_AsString (PyList_GetItem (obj, i));
7195 put_string_list (char * const * const argv)
7200 for (argc = 0; argv[argc] != NULL; ++argc)
7203 list = PyList_New (argc);
7204 for (i = 0; i < argc; ++i)
7205 PyList_SetItem (list, i, PyString_FromString (argv[i]));
7211 put_table (char * const * const argv)
7213 PyObject *list, *item;
7216 for (argc = 0; argv[argc] != NULL; ++argc)
7219 list = PyList_New (argc >> 1);
7220 for (i = 0; i < argc; i += 2) {
7221 item = PyTuple_New (2);
7222 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
7223 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
7224 PyList_SetItem (list, i >> 1, item);
7231 free_strings (char **argv)
7235 for (argc = 0; argv[argc] != NULL; ++argc)
7241 py_guestfs_create (PyObject *self, PyObject *args)
7245 g = guestfs_create ();
7247 PyErr_SetString (PyExc_RuntimeError,
7248 \"guestfs.create: failed to allocate handle\");
7251 guestfs_set_error_handler (g, NULL, NULL);
7252 return put_handle (g);
7256 py_guestfs_close (PyObject *self, PyObject *args)
7261 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
7263 g = get_handle (py_g);
7267 Py_INCREF (Py_None);
7273 (* Structures, turned into Python dictionaries. *)
7276 pr "static PyObject *\n";
7277 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
7279 pr " PyObject *dict;\n";
7281 pr " dict = PyDict_New ();\n";
7285 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7286 pr " PyString_FromString (%s->%s));\n"
7289 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7290 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
7293 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7294 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
7296 | name, (FBytes|FUInt64) ->
7297 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7298 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
7301 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7302 pr " PyLong_FromLongLong (%s->%s));\n"
7305 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7306 pr " PyLong_FromUnsignedLong (%s->%s));\n"
7309 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7310 pr " PyLong_FromLong (%s->%s));\n"
7312 | name, FOptPercent ->
7313 pr " if (%s->%s >= 0)\n" typ name;
7314 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7315 pr " PyFloat_FromDouble ((double) %s->%s));\n"
7318 pr " Py_INCREF (Py_None);\n";
7319 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
7322 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7323 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
7325 pr " return dict;\n";
7329 pr "static PyObject *\n";
7330 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
7332 pr " PyObject *list;\n";
7335 pr " list = PyList_New (%ss->len);\n" typ;
7336 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
7337 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
7338 pr " return list;\n";
7343 (* Python wrapper functions. *)
7345 fun (name, style, _, _, _, _, _) ->
7346 pr "static PyObject *\n";
7347 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
7350 pr " PyObject *py_g;\n";
7351 pr " guestfs_h *g;\n";
7352 pr " PyObject *py_r;\n";
7355 match fst style with
7356 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7357 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7358 | RConstString _ | RConstOptString _ ->
7359 pr " const char *r;\n"; "NULL"
7360 | RString _ -> pr " char *r;\n"; "NULL"
7361 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
7362 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
7363 | RStructList (_, typ) ->
7364 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7367 pr " size_t size;\n";
7372 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
7373 | OptString n -> pr " const char *%s;\n" n
7375 pr " PyObject *py_%s;\n" n;
7376 pr " const char **%s;\n" n
7377 | Bool n -> pr " int %s;\n" n
7378 | Int n -> pr " int %s;\n" n
7383 (* Convert the parameters. *)
7384 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
7387 | String _ | FileIn _ | FileOut _ -> pr "s"
7388 | OptString _ -> pr "z"
7389 | StringList _ -> pr "O"
7390 | Bool _ -> pr "i" (* XXX Python has booleans? *)
7393 pr ":guestfs_%s\",\n" name;
7397 | String n | FileIn n | FileOut n -> pr ", &%s" n
7398 | OptString n -> pr ", &%s" n
7399 | StringList n -> pr ", &py_%s" n
7400 | Bool n -> pr ", &%s" n
7401 | Int n -> pr ", &%s" n
7405 pr " return NULL;\n";
7407 pr " g = get_handle (py_g);\n";
7410 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
7412 pr " %s = get_string_list (py_%s);\n" n n;
7413 pr " if (!%s) return NULL;\n" n
7418 pr " r = guestfs_%s " name;
7419 generate_c_call_args ~handle:"g" style;
7424 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
7426 pr " free (%s);\n" n
7429 pr " if (r == %s) {\n" error_code;
7430 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
7431 pr " return NULL;\n";
7435 (match fst style with
7437 pr " Py_INCREF (Py_None);\n";
7438 pr " py_r = Py_None;\n"
7440 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
7441 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
7442 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
7443 | RConstOptString _ ->
7445 pr " py_r = PyString_FromString (r);\n";
7447 pr " Py_INCREF (Py_None);\n";
7448 pr " py_r = Py_None;\n";
7451 pr " py_r = PyString_FromString (r);\n";
7454 pr " py_r = put_string_list (r);\n";
7455 pr " free_strings (r);\n"
7456 | RStruct (_, typ) ->
7457 pr " py_r = put_%s (r);\n" typ;
7458 pr " guestfs_free_%s (r);\n" typ
7459 | RStructList (_, typ) ->
7460 pr " py_r = put_%s_list (r);\n" typ;
7461 pr " guestfs_free_%s_list (r);\n" typ
7463 pr " py_r = put_table (r);\n";
7464 pr " free_strings (r);\n"
7466 pr " py_r = PyString_FromStringAndSize (r, size);\n";
7470 pr " return py_r;\n";
7475 (* Table of functions. *)
7476 pr "static PyMethodDef methods[] = {\n";
7477 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
7478 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
7480 fun (name, _, _, _, _, _, _) ->
7481 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
7484 pr " { NULL, NULL, 0, NULL }\n";
7488 (* Init function. *)
7491 initlibguestfsmod (void)
7493 static int initialized = 0;
7495 if (initialized) return;
7496 Py_InitModule ((char *) \"libguestfsmod\", methods);
7501 (* Generate Python module. *)
7502 and generate_python_py () =
7503 generate_header HashStyle LGPLv2;
7506 u\"\"\"Python bindings for libguestfs
7509 g = guestfs.GuestFS ()
7510 g.add_drive (\"guest.img\")
7513 parts = g.list_partitions ()
7515 The guestfs module provides a Python binding to the libguestfs API
7516 for examining and modifying virtual machine disk images.
7518 Amongst the things this is good for: making batch configuration
7519 changes to guests, getting disk used/free statistics (see also:
7520 virt-df), migrating between virtualization systems (see also:
7521 virt-p2v), performing partial backups, performing partial guest
7522 clones, cloning guests and changing registry/UUID/hostname info, and
7525 Libguestfs uses Linux kernel and qemu code, and can access any type of
7526 guest filesystem that Linux and qemu can, including but not limited
7527 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
7528 schemes, qcow, qcow2, vmdk.
7530 Libguestfs provides ways to enumerate guest storage (eg. partitions,
7531 LVs, what filesystem is in each LV, etc.). It can also run commands
7532 in the context of the guest. Also you can access filesystems over FTP.
7534 Errors which happen while using the API are turned into Python
7535 RuntimeError exceptions.
7537 To create a guestfs handle you usually have to perform the following
7540 # Create the handle, call add_drive at least once, and possibly
7541 # several times if the guest has multiple block devices:
7542 g = guestfs.GuestFS ()
7543 g.add_drive (\"guest.img\")
7545 # Launch the qemu subprocess and wait for it to become ready:
7549 # Now you can issue commands, for example:
7554 import libguestfsmod
7557 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
7559 def __init__ (self):
7560 \"\"\"Create a new libguestfs handle.\"\"\"
7561 self._o = libguestfsmod.create ()
7564 libguestfsmod.close (self._o)
7569 fun (name, style, _, flags, _, _, longdesc) ->
7571 generate_py_call_args ~handle:"self" (snd style);
7574 if not (List.mem NotInDocs flags) then (
7575 let doc = replace_str longdesc "C<guestfs_" "C<g." in
7577 match fst style with
7578 | RErr | RInt _ | RInt64 _ | RBool _
7579 | RConstOptString _ | RConstString _
7580 | RString _ | RBufferOut _ -> doc
7582 doc ^ "\n\nThis function returns a list of strings."
7583 | RStruct (_, typ) ->
7584 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
7585 | RStructList (_, typ) ->
7586 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
7588 doc ^ "\n\nThis function returns a dictionary." in
7590 if List.mem ProtocolLimitWarning flags then
7591 doc ^ "\n\n" ^ protocol_limit_warning
7594 if List.mem DangerWillRobinson flags then
7595 doc ^ "\n\n" ^ danger_will_robinson
7598 match deprecation_notice flags with
7600 | Some txt -> doc ^ "\n\n" ^ txt in
7601 let doc = pod2text ~width:60 name doc in
7602 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
7603 let doc = String.concat "\n " doc in
7604 pr " u\"\"\"%s\"\"\"\n" doc;
7606 pr " return libguestfsmod.%s " name;
7607 generate_py_call_args ~handle:"self._o" (snd style);
7612 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
7613 and generate_py_call_args ~handle args =
7615 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
7618 (* Useful if you need the longdesc POD text as plain text. Returns a
7621 * Because this is very slow (the slowest part of autogeneration),
7622 * we memoize the results.
7624 and pod2text ~width name longdesc =
7625 let key = width, name, longdesc in
7626 try Hashtbl.find pod2text_memo key
7628 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
7629 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
7631 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
7632 let chan = Unix.open_process_in cmd in
7633 let lines = ref [] in
7635 let line = input_line chan in
7636 if i = 1 then (* discard the first line of output *)
7639 let line = triml line in
7640 lines := line :: !lines;
7643 let lines = try loop 1 with End_of_file -> List.rev !lines in
7644 Unix.unlink filename;
7645 (match Unix.close_process_in chan with
7646 | Unix.WEXITED 0 -> ()
7648 failwithf "pod2text: process exited with non-zero status (%d)" i
7649 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
7650 failwithf "pod2text: process signalled or stopped by signal %d" i
7652 Hashtbl.add pod2text_memo key lines;
7653 let chan = open_out pod2text_memo_filename in
7654 output_value chan pod2text_memo;
7658 (* Generate ruby bindings. *)
7659 and generate_ruby_c () =
7660 generate_header CStyle LGPLv2;
7668 #include \"guestfs.h\"
7670 #include \"extconf.h\"
7672 /* For Ruby < 1.9 */
7674 #define RARRAY_LEN(r) (RARRAY((r))->len)
7677 static VALUE m_guestfs; /* guestfs module */
7678 static VALUE c_guestfs; /* guestfs_h handle */
7679 static VALUE e_Error; /* used for all errors */
7681 static void ruby_guestfs_free (void *p)
7684 guestfs_close ((guestfs_h *) p);
7687 static VALUE ruby_guestfs_create (VALUE m)
7691 g = guestfs_create ();
7693 rb_raise (e_Error, \"failed to create guestfs handle\");
7695 /* Don't print error messages to stderr by default. */
7696 guestfs_set_error_handler (g, NULL, NULL);
7698 /* Wrap it, and make sure the close function is called when the
7701 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
7704 static VALUE ruby_guestfs_close (VALUE gv)
7707 Data_Get_Struct (gv, guestfs_h, g);
7709 ruby_guestfs_free (g);
7710 DATA_PTR (gv) = NULL;
7718 fun (name, style, _, _, _, _, _) ->
7719 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
7720 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
7723 pr " guestfs_h *g;\n";
7724 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
7726 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
7732 | String n | FileIn n | FileOut n ->
7733 pr " Check_Type (%sv, T_STRING);\n" n;
7734 pr " const char *%s = StringValueCStr (%sv);\n" n n;
7736 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
7737 pr " \"%s\", \"%s\");\n" n name
7739 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
7741 pr " char **%s;\n" n;
7742 pr " Check_Type (%sv, T_ARRAY);\n" n;
7744 pr " int i, len;\n";
7745 pr " len = RARRAY_LEN (%sv);\n" n;
7746 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
7748 pr " for (i = 0; i < len; ++i) {\n";
7749 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
7750 pr " %s[i] = StringValueCStr (v);\n" n;
7752 pr " %s[len] = NULL;\n" n;
7755 pr " int %s = RTEST (%sv);\n" n n
7757 pr " int %s = NUM2INT (%sv);\n" n n
7762 match fst style with
7763 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7764 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7765 | RConstString _ | RConstOptString _ ->
7766 pr " const char *r;\n"; "NULL"
7767 | RString _ -> pr " char *r;\n"; "NULL"
7768 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
7769 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
7770 | RStructList (_, typ) ->
7771 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7774 pr " size_t size;\n";
7778 pr " r = guestfs_%s " name;
7779 generate_c_call_args ~handle:"g" style;
7784 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
7786 pr " free (%s);\n" n
7789 pr " if (r == %s)\n" error_code;
7790 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
7793 (match fst style with
7795 pr " return Qnil;\n"
7796 | RInt _ | RBool _ ->
7797 pr " return INT2NUM (r);\n"
7799 pr " return ULL2NUM (r);\n"
7801 pr " return rb_str_new2 (r);\n";
7802 | RConstOptString _ ->
7804 pr " return rb_str_new2 (r);\n";
7806 pr " return Qnil;\n";
7808 pr " VALUE rv = rb_str_new2 (r);\n";
7812 pr " int i, len = 0;\n";
7813 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
7814 pr " VALUE rv = rb_ary_new2 (len);\n";
7815 pr " for (i = 0; r[i] != NULL; ++i) {\n";
7816 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
7817 pr " free (r[i]);\n";
7821 | RStruct (_, typ) ->
7822 let cols = cols_of_struct typ in
7823 generate_ruby_struct_code typ cols
7824 | RStructList (_, typ) ->
7825 let cols = cols_of_struct typ in
7826 generate_ruby_struct_list_code typ cols
7828 pr " VALUE rv = rb_hash_new ();\n";
7830 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
7831 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
7832 pr " free (r[i]);\n";
7833 pr " free (r[i+1]);\n";
7838 pr " VALUE rv = rb_str_new (r, size);\n";
7848 /* Initialize the module. */
7849 void Init__guestfs ()
7851 m_guestfs = rb_define_module (\"Guestfs\");
7852 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
7853 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
7855 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
7856 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
7859 (* Define the rest of the methods. *)
7861 fun (name, style, _, _, _, _, _) ->
7862 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
7863 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
7868 (* Ruby code to return a struct. *)
7869 and generate_ruby_struct_code typ cols =
7870 pr " VALUE rv = rb_hash_new ();\n";
7874 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
7876 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
7878 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
7879 | name, (FBytes|FUInt64) ->
7880 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
7882 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
7884 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
7886 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
7887 | name, FOptPercent ->
7888 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
7889 | name, FChar -> (* XXX wrong? *)
7890 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
7892 pr " guestfs_free_%s (r);\n" typ;
7895 (* Ruby code to return a struct list. *)
7896 and generate_ruby_struct_list_code typ cols =
7897 pr " VALUE rv = rb_ary_new2 (r->len);\n";
7899 pr " for (i = 0; i < r->len; ++i) {\n";
7900 pr " VALUE hv = rb_hash_new ();\n";
7904 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
7906 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
7908 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
7909 | name, (FBytes|FUInt64) ->
7910 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
7912 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
7914 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
7916 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
7917 | name, FOptPercent ->
7918 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
7919 | name, FChar -> (* XXX wrong? *)
7920 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
7922 pr " rb_ary_push (rv, hv);\n";
7924 pr " guestfs_free_%s_list (r);\n" typ;
7927 (* Generate Java bindings GuestFS.java file. *)
7928 and generate_java_java () =
7929 generate_header CStyle LGPLv2;
7932 package com.redhat.et.libguestfs;
7934 import java.util.HashMap;
7935 import com.redhat.et.libguestfs.LibGuestFSException;
7936 import com.redhat.et.libguestfs.PV;
7937 import com.redhat.et.libguestfs.VG;
7938 import com.redhat.et.libguestfs.LV;
7939 import com.redhat.et.libguestfs.Stat;
7940 import com.redhat.et.libguestfs.StatVFS;
7941 import com.redhat.et.libguestfs.IntBool;
7942 import com.redhat.et.libguestfs.Dirent;
7945 * The GuestFS object is a libguestfs handle.
7949 public class GuestFS {
7950 // Load the native code.
7952 System.loadLibrary (\"guestfs_jni\");
7956 * The native guestfs_h pointer.
7961 * Create a libguestfs handle.
7963 * @throws LibGuestFSException
7965 public GuestFS () throws LibGuestFSException
7969 private native long _create () throws LibGuestFSException;
7972 * Close a libguestfs handle.
7974 * You can also leave handles to be collected by the garbage
7975 * collector, but this method ensures that the resources used
7976 * by the handle are freed up immediately. If you call any
7977 * other methods after closing the handle, you will get an
7980 * @throws LibGuestFSException
7982 public void close () throws LibGuestFSException
7988 private native void _close (long g) throws LibGuestFSException;
7990 public void finalize () throws LibGuestFSException
7998 fun (name, style, _, flags, _, shortdesc, longdesc) ->
7999 if not (List.mem NotInDocs flags); then (
8000 let doc = replace_str longdesc "C<guestfs_" "C<g." in
8002 if List.mem ProtocolLimitWarning flags then
8003 doc ^ "\n\n" ^ protocol_limit_warning
8006 if List.mem DangerWillRobinson flags then
8007 doc ^ "\n\n" ^ danger_will_robinson
8010 match deprecation_notice flags with
8012 | Some txt -> doc ^ "\n\n" ^ txt in
8013 let doc = pod2text ~width:60 name doc in
8014 let doc = List.map ( (* RHBZ#501883 *)
8017 | nonempty -> nonempty
8019 let doc = String.concat "\n * " doc in
8022 pr " * %s\n" shortdesc;
8025 pr " * @throws LibGuestFSException\n";
8029 generate_java_prototype ~public:true ~semicolon:false name style;
8032 pr " if (g == 0)\n";
8033 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
8036 if fst style <> RErr then pr "return ";
8038 generate_java_call_args ~handle:"g" (snd style);
8042 generate_java_prototype ~privat:true ~native:true name style;
8049 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
8050 and generate_java_call_args ~handle args =
8052 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
8055 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
8056 ?(semicolon=true) name style =
8057 if privat then pr "private ";
8058 if public then pr "public ";
8059 if native then pr "native ";
8062 (match fst style with
8063 | RErr -> pr "void ";
8064 | RInt _ -> pr "int ";
8065 | RInt64 _ -> pr "long ";
8066 | RBool _ -> pr "boolean ";
8067 | RConstString _ | RConstOptString _ | RString _
8068 | RBufferOut _ -> pr "String ";
8069 | RStringList _ -> pr "String[] ";
8070 | RStruct (_, typ) ->
8071 let name = java_name_of_struct typ in
8073 | RStructList (_, typ) ->
8074 let name = java_name_of_struct typ in
8076 | RHashtable _ -> pr "HashMap<String,String> ";
8079 if native then pr "_%s " name else pr "%s " name;
8081 let needs_comma = ref false in
8090 if !needs_comma then pr ", ";
8091 needs_comma := true;
8108 pr " throws LibGuestFSException";
8109 if semicolon then pr ";"
8111 and generate_java_struct jtyp cols =
8112 generate_header CStyle LGPLv2;
8115 package com.redhat.et.libguestfs;
8118 * Libguestfs %s structure.
8130 | name, FBuffer -> pr " public String %s;\n" name
8131 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
8132 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
8133 | name, FChar -> pr " public char %s;\n" name
8134 | name, FOptPercent ->
8135 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
8136 pr " public float %s;\n" name
8141 and generate_java_c () =
8142 generate_header CStyle LGPLv2;
8149 #include \"com_redhat_et_libguestfs_GuestFS.h\"
8150 #include \"guestfs.h\"
8152 /* Note that this function returns. The exception is not thrown
8153 * until after the wrapper function returns.
8156 throw_exception (JNIEnv *env, const char *msg)
8159 cl = (*env)->FindClass (env,
8160 \"com/redhat/et/libguestfs/LibGuestFSException\");
8161 (*env)->ThrowNew (env, cl, msg);
8164 JNIEXPORT jlong JNICALL
8165 Java_com_redhat_et_libguestfs_GuestFS__1create
8166 (JNIEnv *env, jobject obj)
8170 g = guestfs_create ();
8172 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
8175 guestfs_set_error_handler (g, NULL, NULL);
8176 return (jlong) (long) g;
8179 JNIEXPORT void JNICALL
8180 Java_com_redhat_et_libguestfs_GuestFS__1close
8181 (JNIEnv *env, jobject obj, jlong jg)
8183 guestfs_h *g = (guestfs_h *) (long) jg;
8190 fun (name, style, _, _, _, _, _) ->
8192 (match fst style with
8193 | RErr -> pr "void ";
8194 | RInt _ -> pr "jint ";
8195 | RInt64 _ -> pr "jlong ";
8196 | RBool _ -> pr "jboolean ";
8197 | RConstString _ | RConstOptString _ | RString _
8198 | RBufferOut _ -> pr "jstring ";
8199 | RStruct _ | RHashtable _ ->
8201 | RStringList _ | RStructList _ ->
8205 pr "Java_com_redhat_et_libguestfs_GuestFS_";
8206 pr "%s" (replace_str ("_" ^ name) "_" "_1");
8208 pr " (JNIEnv *env, jobject obj, jlong jg";
8215 pr ", jstring j%s" n
8217 pr ", jobjectArray j%s" n
8219 pr ", jboolean j%s" n
8225 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
8226 let error_code, no_ret =
8227 match fst style with
8228 | RErr -> pr " int r;\n"; "-1", ""
8230 | RInt _ -> pr " int r;\n"; "-1", "0"
8231 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
8232 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
8233 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
8235 pr " jstring jr;\n";
8236 pr " char *r;\n"; "NULL", "NULL"
8238 pr " jobjectArray jr;\n";
8241 pr " jstring jstr;\n";
8242 pr " char **r;\n"; "NULL", "NULL"
8243 | RStruct (_, typ) ->
8244 pr " jobject jr;\n";
8246 pr " jfieldID fl;\n";
8247 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
8248 | RStructList (_, typ) ->
8249 pr " jobjectArray jr;\n";
8251 pr " jfieldID fl;\n";
8252 pr " jobject jfl;\n";
8253 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
8254 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
8256 pr " jstring jr;\n";
8258 pr " size_t size;\n";
8266 pr " const char *%s;\n" n
8268 pr " int %s_len;\n" n;
8269 pr " const char **%s;\n" n
8276 (match fst style with
8277 | RStringList _ | RStructList _ -> true
8278 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
8280 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
8281 List.exists (function StringList _ -> true | _ -> false) (snd style) in
8287 (* Get the parameters. *)
8293 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
8295 (* This is completely undocumented, but Java null becomes
8298 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
8300 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
8301 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
8302 pr " for (i = 0; i < %s_len; ++i) {\n" n;
8303 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
8305 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
8307 pr " %s[%s_len] = NULL;\n" n n;
8310 pr " %s = j%s;\n" n n
8313 (* Make the call. *)
8314 pr " r = guestfs_%s " name;
8315 generate_c_call_args ~handle:"g" style;
8318 (* Release the parameters. *)
8324 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
8327 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
8329 pr " for (i = 0; i < %s_len; ++i) {\n" n;
8330 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
8332 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
8334 pr " free (%s);\n" n
8339 (* Check for errors. *)
8340 pr " if (r == %s) {\n" error_code;
8341 pr " throw_exception (env, guestfs_last_error (g));\n";
8342 pr " return %s;\n" no_ret;
8346 (match fst style with
8348 | RInt _ -> pr " return (jint) r;\n"
8349 | RBool _ -> pr " return (jboolean) r;\n"
8350 | RInt64 _ -> pr " return (jlong) r;\n"
8351 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
8352 | RConstOptString _ ->
8353 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
8355 pr " jr = (*env)->NewStringUTF (env, r);\n";
8359 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
8360 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
8361 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
8362 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
8363 pr " for (i = 0; i < r_len; ++i) {\n";
8364 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
8365 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
8366 pr " free (r[i]);\n";
8370 | RStruct (_, typ) ->
8371 let jtyp = java_name_of_struct typ in
8372 let cols = cols_of_struct typ in
8373 generate_java_struct_return typ jtyp cols
8374 | RStructList (_, typ) ->
8375 let jtyp = java_name_of_struct typ in
8376 let cols = cols_of_struct typ in
8377 generate_java_struct_list_return typ jtyp cols
8380 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
8381 pr " return NULL;\n"
8383 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
8392 and generate_java_struct_return typ jtyp cols =
8393 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
8394 pr " jr = (*env)->AllocObject (env, cl);\n";
8398 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8399 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
8402 pr " char s[33];\n";
8403 pr " memcpy (s, r->%s, 32);\n" name;
8405 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8406 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
8410 pr " int len = r->%s_len;\n" name;
8411 pr " char s[len+1];\n";
8412 pr " memcpy (s, r->%s, len);\n" name;
8413 pr " s[len] = 0;\n";
8414 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8415 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
8417 | name, (FBytes|FUInt64|FInt64) ->
8418 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
8419 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
8420 | name, (FUInt32|FInt32) ->
8421 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
8422 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
8423 | name, FOptPercent ->
8424 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
8425 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
8427 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
8428 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
8433 and generate_java_struct_list_return typ jtyp cols =
8434 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
8435 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
8436 pr " for (i = 0; i < r->len; ++i) {\n";
8437 pr " jfl = (*env)->AllocObject (env, cl);\n";
8441 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8442 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
8445 pr " char s[33];\n";
8446 pr " memcpy (s, r->val[i].%s, 32);\n" name;
8448 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8449 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
8453 pr " int len = r->val[i].%s_len;\n" name;
8454 pr " char s[len+1];\n";
8455 pr " memcpy (s, r->val[i].%s, len);\n" name;
8456 pr " s[len] = 0;\n";
8457 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8458 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
8460 | name, (FBytes|FUInt64|FInt64) ->
8461 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
8462 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
8463 | name, (FUInt32|FInt32) ->
8464 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
8465 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
8466 | name, FOptPercent ->
8467 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
8468 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
8470 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
8471 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
8473 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
8475 pr " guestfs_free_%s_list (r);\n" typ;
8478 and generate_haskell_hs () =
8479 generate_header HaskellStyle LGPLv2;
8481 (* XXX We only know how to generate partial FFI for Haskell
8482 * at the moment. Please help out!
8484 let can_generate style =
8488 | RInt64 _, _ -> true
8491 | RConstOptString _, _
8497 | RBufferOut _, _ -> false in
8500 {-# INCLUDE <guestfs.h> #-}
8501 {-# LANGUAGE ForeignFunctionInterface #-}
8506 (* List out the names of the actions we want to export. *)
8508 fun (name, style, _, _, _, _, _) ->
8509 if can_generate style then pr ",\n %s" name
8516 import Foreign.C.Types
8518 import Control.Exception
8519 import Data.Typeable
8521 data GuestfsS = GuestfsS -- represents the opaque C struct
8522 type GuestfsP = Ptr GuestfsS -- guestfs_h *
8523 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
8525 -- XXX define properly later XXX
8529 data IntBool = IntBool
8531 data StatVFS = StatVFS
8532 data Hashtable = Hashtable
8534 foreign import ccall unsafe \"guestfs_create\" c_create
8536 foreign import ccall unsafe \"&guestfs_close\" c_close
8537 :: FunPtr (GuestfsP -> IO ())
8538 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
8539 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
8541 create :: IO GuestfsH
8544 c_set_error_handler p nullPtr nullPtr
8545 h <- newForeignPtr c_close p
8548 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
8549 :: GuestfsP -> IO CString
8551 -- last_error :: GuestfsH -> IO (Maybe String)
8552 -- last_error h = do
8553 -- str <- withForeignPtr h (\\p -> c_last_error p)
8554 -- maybePeek peekCString str
8556 last_error :: GuestfsH -> IO (String)
8558 str <- withForeignPtr h (\\p -> c_last_error p)
8560 then return \"no error\"
8561 else peekCString str
8565 (* Generate wrappers for each foreign function. *)
8567 fun (name, style, _, _, _, _, _) ->
8568 if can_generate style then (
8569 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
8571 generate_haskell_prototype ~handle:"GuestfsP" style;
8575 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
8577 pr "%s %s = do\n" name
8578 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
8580 (* Convert pointer arguments using with* functions. *)
8585 | String n -> pr "withCString %s $ \\%s -> " n n
8586 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
8587 | StringList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
8588 | Bool _ | Int _ -> ()
8590 (* Convert integer arguments. *)
8594 | Bool n -> sprintf "(fromBool %s)" n
8595 | Int n -> sprintf "(fromIntegral %s)" n
8596 | FileIn n | FileOut n | String n | OptString n | StringList n -> n
8598 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
8599 (String.concat " " ("p" :: args));
8600 (match fst style with
8601 | RErr | RInt _ | RInt64 _ | RBool _ ->
8602 pr " if (r == -1)\n";
8604 pr " err <- last_error h\n";
8606 | RConstString _ | RConstOptString _ | RString _
8607 | RStringList _ | RStruct _
8608 | RStructList _ | RHashtable _ | RBufferOut _ ->
8609 pr " if (r == nullPtr)\n";
8611 pr " err <- last_error h\n";
8614 (match fst style with
8616 pr " else return ()\n"
8618 pr " else return (fromIntegral r)\n"
8620 pr " else return (fromIntegral r)\n"
8622 pr " else return (toBool r)\n"
8631 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
8637 and generate_haskell_prototype ~handle ?(hs = false) style =
8639 let string = if hs then "String" else "CString" in
8640 let int = if hs then "Int" else "CInt" in
8641 let bool = if hs then "Bool" else "CInt" in
8642 let int64 = if hs then "Integer" else "Int64" in
8646 | String _ -> pr "%s" string
8647 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
8648 | StringList _ -> if hs then pr "[String]" else pr "Ptr CString"
8649 | Bool _ -> pr "%s" bool
8650 | Int _ -> pr "%s" int
8651 | FileIn _ -> pr "%s" string
8652 | FileOut _ -> pr "%s" string
8657 (match fst style with
8658 | RErr -> if not hs then pr "CInt"
8659 | RInt _ -> pr "%s" int
8660 | RInt64 _ -> pr "%s" int64
8661 | RBool _ -> pr "%s" bool
8662 | RConstString _ -> pr "%s" string
8663 | RConstOptString _ -> pr "Maybe %s" string
8664 | RString _ -> pr "%s" string
8665 | RStringList _ -> pr "[%s]" string
8666 | RStruct (_, typ) ->
8667 let name = java_name_of_struct typ in
8669 | RStructList (_, typ) ->
8670 let name = java_name_of_struct typ in
8672 | RHashtable _ -> pr "Hashtable"
8673 | RBufferOut _ -> pr "%s" string
8677 and generate_bindtests () =
8678 generate_header CStyle LGPLv2;
8683 #include <inttypes.h>
8686 #include \"guestfs.h\"
8687 #include \"guestfs_protocol.h\"
8689 #define error guestfs_error
8690 #define safe_calloc guestfs_safe_calloc
8691 #define safe_malloc guestfs_safe_malloc
8694 print_strings (char * const* const argv)
8699 for (argc = 0; argv[argc] != NULL; ++argc) {
8700 if (argc > 0) printf (\", \");
8701 printf (\"\\\"%%s\\\"\", argv[argc]);
8706 /* The test0 function prints its parameters to stdout. */
8710 match test_functions with
8711 | [] -> assert false
8712 | test0 :: tests -> test0, tests in
8715 let (name, style, _, _, _, _, _) = test0 in
8716 generate_prototype ~extern:false ~semicolon:false ~newline:true
8717 ~handle:"g" ~prefix:"guestfs_" name style;
8723 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
8724 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
8725 | StringList n -> pr " print_strings (%s);\n" n
8726 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
8727 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
8729 pr " /* Java changes stdout line buffering so we need this: */\n";
8730 pr " fflush (stdout);\n";
8736 fun (name, style, _, _, _, _, _) ->
8737 if String.sub name (String.length name - 3) 3 <> "err" then (
8738 pr "/* Test normal return. */\n";
8739 generate_prototype ~extern:false ~semicolon:false ~newline:true
8740 ~handle:"g" ~prefix:"guestfs_" name style;
8742 (match fst style with
8747 pr " sscanf (val, \"%%d\", &r);\n";
8751 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
8754 pr " return strcmp (val, \"true\") == 0;\n"
8756 | RConstOptString _ ->
8757 (* Can't return the input string here. Return a static
8758 * string so we ensure we get a segfault if the caller
8761 pr " return \"static string\";\n"
8763 pr " return strdup (val);\n"
8765 pr " char **strs;\n";
8767 pr " sscanf (val, \"%%d\", &n);\n";
8768 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
8769 pr " for (i = 0; i < n; ++i) {\n";
8770 pr " strs[i] = safe_malloc (g, 16);\n";
8771 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
8773 pr " strs[n] = NULL;\n";
8774 pr " return strs;\n"
8775 | RStruct (_, typ) ->
8776 pr " struct guestfs_%s *r;\n" typ;
8777 pr " r = safe_calloc (g, sizeof *r, 1);\n";
8779 | RStructList (_, typ) ->
8780 pr " struct guestfs_%s_list *r;\n" typ;
8781 pr " r = safe_calloc (g, sizeof *r, 1);\n";
8782 pr " sscanf (val, \"%%d\", &r->len);\n";
8783 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
8786 pr " char **strs;\n";
8788 pr " sscanf (val, \"%%d\", &n);\n";
8789 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
8790 pr " for (i = 0; i < n; ++i) {\n";
8791 pr " strs[i*2] = safe_malloc (g, 16);\n";
8792 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
8793 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
8794 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
8796 pr " strs[n*2] = NULL;\n";
8797 pr " return strs;\n"
8799 pr " return strdup (val);\n"
8804 pr "/* Test error return. */\n";
8805 generate_prototype ~extern:false ~semicolon:false ~newline:true
8806 ~handle:"g" ~prefix:"guestfs_" name style;
8808 pr " error (g, \"error\");\n";
8809 (match fst style with
8810 | RErr | RInt _ | RInt64 _ | RBool _ ->
8812 | RConstString _ | RConstOptString _
8813 | RString _ | RStringList _ | RStruct _
8817 pr " return NULL;\n"
8824 and generate_ocaml_bindtests () =
8825 generate_header OCamlStyle GPLv2;
8829 let g = Guestfs.create () in
8836 | CallString s -> "\"" ^ s ^ "\""
8837 | CallOptString None -> "None"
8838 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
8839 | CallStringList xs ->
8840 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
8841 | CallInt i when i >= 0 -> string_of_int i
8842 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
8843 | CallBool b -> string_of_bool b
8848 generate_lang_bindtests (
8849 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
8852 pr "print_endline \"EOF\"\n"
8854 and generate_perl_bindtests () =
8855 pr "#!/usr/bin/perl -w\n";
8856 generate_header HashStyle GPLv2;
8863 my $g = Sys::Guestfs->new ();
8867 String.concat ", " (
8870 | CallString s -> "\"" ^ s ^ "\""
8871 | CallOptString None -> "undef"
8872 | CallOptString (Some s) -> sprintf "\"%s\"" s
8873 | CallStringList xs ->
8874 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8875 | CallInt i -> string_of_int i
8876 | CallBool b -> if b then "1" else "0"
8881 generate_lang_bindtests (
8882 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
8885 pr "print \"EOF\\n\"\n"
8887 and generate_python_bindtests () =
8888 generate_header HashStyle GPLv2;
8893 g = guestfs.GuestFS ()
8897 String.concat ", " (
8900 | CallString s -> "\"" ^ s ^ "\""
8901 | CallOptString None -> "None"
8902 | CallOptString (Some s) -> sprintf "\"%s\"" s
8903 | CallStringList xs ->
8904 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8905 | CallInt i -> string_of_int i
8906 | CallBool b -> if b then "1" else "0"
8911 generate_lang_bindtests (
8912 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
8915 pr "print \"EOF\"\n"
8917 and generate_ruby_bindtests () =
8918 generate_header HashStyle GPLv2;
8923 g = Guestfs::create()
8927 String.concat ", " (
8930 | CallString s -> "\"" ^ s ^ "\""
8931 | CallOptString None -> "nil"
8932 | CallOptString (Some s) -> sprintf "\"%s\"" s
8933 | CallStringList xs ->
8934 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8935 | CallInt i -> string_of_int i
8936 | CallBool b -> string_of_bool b
8941 generate_lang_bindtests (
8942 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
8945 pr "print \"EOF\\n\"\n"
8947 and generate_java_bindtests () =
8948 generate_header CStyle GPLv2;
8951 import com.redhat.et.libguestfs.*;
8953 public class Bindtests {
8954 public static void main (String[] argv)
8957 GuestFS g = new GuestFS ();
8961 String.concat ", " (
8964 | CallString s -> "\"" ^ s ^ "\""
8965 | CallOptString None -> "null"
8966 | CallOptString (Some s) -> sprintf "\"%s\"" s
8967 | CallStringList xs ->
8969 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
8970 | CallInt i -> string_of_int i
8971 | CallBool b -> string_of_bool b
8976 generate_lang_bindtests (
8977 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
8981 System.out.println (\"EOF\");
8983 catch (Exception exn) {
8984 System.err.println (exn);
8991 and generate_haskell_bindtests () =
8992 generate_header HaskellStyle GPLv2;
8995 module Bindtests where
8996 import qualified Guestfs
9006 | CallString s -> "\"" ^ s ^ "\""
9007 | CallOptString None -> "Nothing"
9008 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
9009 | CallStringList xs ->
9010 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
9011 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
9012 | CallInt i -> string_of_int i
9013 | CallBool true -> "True"
9014 | CallBool false -> "False"
9019 generate_lang_bindtests (
9020 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
9023 pr " putStrLn \"EOF\"\n"
9025 (* Language-independent bindings tests - we do it this way to
9026 * ensure there is parity in testing bindings across all languages.
9028 and generate_lang_bindtests call =
9029 call "test0" [CallString "abc"; CallOptString (Some "def");
9030 CallStringList []; CallBool false;
9031 CallInt 0; CallString "123"; CallString "456"];
9032 call "test0" [CallString "abc"; CallOptString None;
9033 CallStringList []; CallBool false;
9034 CallInt 0; CallString "123"; CallString "456"];
9035 call "test0" [CallString ""; CallOptString (Some "def");
9036 CallStringList []; CallBool false;
9037 CallInt 0; CallString "123"; CallString "456"];
9038 call "test0" [CallString ""; CallOptString (Some "");
9039 CallStringList []; CallBool false;
9040 CallInt 0; CallString "123"; CallString "456"];
9041 call "test0" [CallString "abc"; CallOptString (Some "def");
9042 CallStringList ["1"]; CallBool false;
9043 CallInt 0; CallString "123"; CallString "456"];
9044 call "test0" [CallString "abc"; CallOptString (Some "def");
9045 CallStringList ["1"; "2"]; CallBool false;
9046 CallInt 0; CallString "123"; CallString "456"];
9047 call "test0" [CallString "abc"; CallOptString (Some "def");
9048 CallStringList ["1"]; CallBool true;
9049 CallInt 0; CallString "123"; CallString "456"];
9050 call "test0" [CallString "abc"; CallOptString (Some "def");
9051 CallStringList ["1"]; CallBool false;
9052 CallInt (-1); CallString "123"; CallString "456"];
9053 call "test0" [CallString "abc"; CallOptString (Some "def");
9054 CallStringList ["1"]; CallBool false;
9055 CallInt (-2); CallString "123"; CallString "456"];
9056 call "test0" [CallString "abc"; CallOptString (Some "def");
9057 CallStringList ["1"]; CallBool false;
9058 CallInt 1; CallString "123"; CallString "456"];
9059 call "test0" [CallString "abc"; CallOptString (Some "def");
9060 CallStringList ["1"]; CallBool false;
9061 CallInt 2; CallString "123"; CallString "456"];
9062 call "test0" [CallString "abc"; CallOptString (Some "def");
9063 CallStringList ["1"]; CallBool false;
9064 CallInt 4095; CallString "123"; CallString "456"];
9065 call "test0" [CallString "abc"; CallOptString (Some "def");
9066 CallStringList ["1"]; CallBool false;
9067 CallInt 0; CallString ""; CallString ""]
9069 (* XXX Add here tests of the return and error functions. *)
9071 (* This is used to generate the src/MAX_PROC_NR file which
9072 * contains the maximum procedure number, a surrogate for the
9073 * ABI version number. See src/Makefile.am for the details.
9075 and generate_max_proc_nr () =
9076 let proc_nrs = List.map (
9077 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
9078 ) daemon_functions in
9080 let max_proc_nr = List.fold_left max 0 proc_nrs in
9082 pr "%d\n" max_proc_nr
9084 let output_to filename =
9085 let filename_new = filename ^ ".new" in
9086 chan := open_out filename_new;
9091 (* Is the new file different from the current file? *)
9092 if Sys.file_exists filename && files_equal filename filename_new then
9093 Unix.unlink filename_new (* same, so skip it *)
9095 (* different, overwrite old one *)
9096 (try Unix.chmod filename 0o644 with Unix.Unix_error _ -> ());
9097 Unix.rename filename_new filename;
9098 Unix.chmod filename 0o444;
9099 printf "written %s\n%!" filename;
9108 if not (Sys.file_exists "HACKING") then (
9110 You are probably running this from the wrong directory.
9111 Run it from the top source directory using the command
9117 let close = output_to "src/guestfs_protocol.x" in
9121 let close = output_to "src/guestfs-structs.h" in
9122 generate_structs_h ();
9125 let close = output_to "src/guestfs-actions.h" in
9126 generate_actions_h ();
9129 let close = output_to "src/guestfs-actions.c" in
9130 generate_client_actions ();
9133 let close = output_to "daemon/actions.h" in
9134 generate_daemon_actions_h ();
9137 let close = output_to "daemon/stubs.c" in
9138 generate_daemon_actions ();
9141 let close = output_to "daemon/names.c" in
9142 generate_daemon_names ();
9145 let close = output_to "capitests/tests.c" in
9149 let close = output_to "src/guestfs-bindtests.c" in
9150 generate_bindtests ();
9153 let close = output_to "fish/cmds.c" in
9154 generate_fish_cmds ();
9157 let close = output_to "fish/completion.c" in
9158 generate_fish_completion ();
9161 let close = output_to "guestfs-structs.pod" in
9162 generate_structs_pod ();
9165 let close = output_to "guestfs-actions.pod" in
9166 generate_actions_pod ();
9169 let close = output_to "guestfish-actions.pod" in
9170 generate_fish_actions_pod ();
9173 let close = output_to "ocaml/guestfs.mli" in
9174 generate_ocaml_mli ();
9177 let close = output_to "ocaml/guestfs.ml" in
9178 generate_ocaml_ml ();
9181 let close = output_to "ocaml/guestfs_c_actions.c" in
9182 generate_ocaml_c ();
9185 let close = output_to "ocaml/bindtests.ml" in
9186 generate_ocaml_bindtests ();
9189 let close = output_to "perl/Guestfs.xs" in
9190 generate_perl_xs ();
9193 let close = output_to "perl/lib/Sys/Guestfs.pm" in
9194 generate_perl_pm ();
9197 let close = output_to "perl/bindtests.pl" in
9198 generate_perl_bindtests ();
9201 let close = output_to "python/guestfs-py.c" in
9202 generate_python_c ();
9205 let close = output_to "python/guestfs.py" in
9206 generate_python_py ();
9209 let close = output_to "python/bindtests.py" in
9210 generate_python_bindtests ();
9213 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
9217 let close = output_to "ruby/bindtests.rb" in
9218 generate_ruby_bindtests ();
9221 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
9222 generate_java_java ();
9227 let cols = cols_of_struct typ in
9228 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
9229 let close = output_to filename in
9230 generate_java_struct jtyp cols;
9234 let close = output_to "java/Makefile.inc" in
9235 pr "java_built_sources =";
9238 pr " com/redhat/et/libguestfs/%s.java" jtyp;
9240 pr " com/redhat/et/libguestfs/GuestFS.java\n";
9243 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in
9247 let close = output_to "java/Bindtests.java" in
9248 generate_java_bindtests ();
9251 let close = output_to "haskell/Guestfs.hs" in
9252 generate_haskell_hs ();
9255 let close = output_to "haskell/Bindtests.hs" in
9256 generate_haskell_bindtests ();
9259 let close = output_to "src/MAX_PROC_NR" in
9260 generate_max_proc_nr ();
9263 (* Always generate this file last, and unconditionally. It's used
9264 * by the Makefile to know when we must re-run the generator.
9266 let chan = open_out "src/stamp-generator" in