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>.");
3300 let all_functions = non_daemon_functions @ daemon_functions
3302 (* In some places we want the functions to be displayed sorted
3303 * alphabetically, so this is useful:
3305 let all_functions_sorted =
3306 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
3307 compare n1 n2) all_functions
3309 (* Field types for structures. *)
3311 | FChar (* C 'char' (really, a 7 bit byte). *)
3312 | FString (* nul-terminated ASCII string. *)
3313 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
3318 | FBytes (* Any int measure that counts bytes. *)
3319 | FUUID (* 32 bytes long, NOT nul-terminated. *)
3320 | FOptPercent (* [0..100], or -1 meaning "not present". *)
3322 (* Because we generate extra parsing code for LVM command line tools,
3323 * we have to pull out the LVM columns separately here.
3333 "pv_attr", FString (* XXX *);
3334 "pv_pe_count", FInt64;
3335 "pv_pe_alloc_count", FInt64;
3338 "pv_mda_count", FInt64;
3339 "pv_mda_free", FBytes;
3340 (* Not in Fedora 10:
3341 "pv_mda_size", FBytes;
3348 "vg_attr", FString (* XXX *);
3351 "vg_sysid", FString;
3352 "vg_extent_size", FBytes;
3353 "vg_extent_count", FInt64;
3354 "vg_free_count", FInt64;
3359 "snap_count", FInt64;
3362 "vg_mda_count", FInt64;
3363 "vg_mda_free", FBytes;
3364 (* Not in Fedora 10:
3365 "vg_mda_size", FBytes;
3371 "lv_attr", FString (* XXX *);
3374 "lv_kernel_major", FInt64;
3375 "lv_kernel_minor", FInt64;
3377 "seg_count", FInt64;
3379 "snap_percent", FOptPercent;
3380 "copy_percent", FOptPercent;
3383 "mirror_log", FString;
3387 (* Names and fields in all structures (in RStruct and RStructList)
3391 (* The old RIntBool return type, only ever used for aug_defnode. Do
3392 * not use this struct in any new code.
3395 "i", FInt32; (* for historical compatibility *)
3396 "b", FInt32; (* for historical compatibility *)
3399 (* LVM PVs, VGs, LVs. *)
3400 "lvm_pv", lvm_pv_cols;
3401 "lvm_vg", lvm_vg_cols;
3402 "lvm_lv", lvm_lv_cols;
3404 (* Column names and types from stat structures.
3405 * NB. Can't use things like 'st_atime' because glibc header files
3406 * define some of these as macros. Ugh.
3437 (* Column names in dirent structure. *)
3440 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
3445 (* Version numbers. *)
3453 (* Extended attribute. *)
3455 "attrname", FString;
3458 ] (* end of structs *)
3460 (* Ugh, Java has to be different ..
3461 * These names are also used by the Haskell bindings.
3463 let java_structs = [
3464 "int_bool", "IntBool";
3469 "statvfs", "StatVFS";
3471 "version", "Version";
3475 (* Used for testing language bindings. *)
3477 | CallString of string
3478 | CallOptString of string option
3479 | CallStringList of string list
3483 (* Used to memoize the result of pod2text. *)
3484 let pod2text_memo_filename = "src/.pod2text.data"
3485 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
3487 let chan = open_in pod2text_memo_filename in
3488 let v = input_value chan in
3492 _ -> Hashtbl.create 13
3494 (* Useful functions.
3495 * Note we don't want to use any external OCaml libraries which
3496 * makes this a bit harder than it should be.
3498 let failwithf fs = ksprintf failwith fs
3500 let replace_char s c1 c2 =
3501 let s2 = String.copy s in
3502 let r = ref false in
3503 for i = 0 to String.length s2 - 1 do
3504 if String.unsafe_get s2 i = c1 then (
3505 String.unsafe_set s2 i c2;
3509 if not !r then s else s2
3513 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
3515 let triml ?(test = isspace) str =
3517 let n = ref (String.length str) in
3518 while !n > 0 && test str.[!i]; do
3523 else String.sub str !i !n
3525 let trimr ?(test = isspace) str =
3526 let n = ref (String.length str) in
3527 while !n > 0 && test str.[!n-1]; do
3530 if !n = String.length str then str
3531 else String.sub str 0 !n
3533 let trim ?(test = isspace) str =
3534 trimr ~test (triml ~test str)
3536 let rec find s sub =
3537 let len = String.length s in
3538 let sublen = String.length sub in
3540 if i <= len-sublen then (
3542 if j < sublen then (
3543 if s.[i+j] = sub.[j] then loop2 (j+1)
3549 if r = -1 then loop (i+1) else r
3555 let rec replace_str s s1 s2 =
3556 let len = String.length s in
3557 let sublen = String.length s1 in
3558 let i = find s s1 in
3561 let s' = String.sub s 0 i in
3562 let s'' = String.sub s (i+sublen) (len-i-sublen) in
3563 s' ^ s2 ^ replace_str s'' s1 s2
3566 let rec string_split sep str =
3567 let len = String.length str in
3568 let seplen = String.length sep in
3569 let i = find str sep in
3570 if i = -1 then [str]
3572 let s' = String.sub str 0 i in
3573 let s'' = String.sub str (i+seplen) (len-i-seplen) in
3574 s' :: string_split sep s''
3577 let files_equal n1 n2 =
3578 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
3579 match Sys.command cmd with
3582 | i -> failwithf "%s: failed with error code %d" cmd i
3584 let rec find_map f = function
3585 | [] -> raise Not_found
3589 | None -> find_map f xs
3592 let rec loop i = function
3594 | x :: xs -> f i x; loop (i+1) xs
3599 let rec loop i = function
3601 | x :: xs -> let r = f i x in r :: loop (i+1) xs
3605 let name_of_argt = function
3606 | String n | OptString n | StringList n | Bool n | Int n
3607 | FileIn n | FileOut n -> n
3609 let java_name_of_struct typ =
3610 try List.assoc typ java_structs
3613 "java_name_of_struct: no java_structs entry corresponding to %s" typ
3615 let cols_of_struct typ =
3616 try List.assoc typ structs
3618 failwithf "cols_of_struct: unknown struct %s" typ
3620 let seq_of_test = function
3621 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
3622 | TestOutputListOfDevices (s, _)
3623 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
3624 | TestOutputTrue s | TestOutputFalse s
3625 | TestOutputLength (s, _) | TestOutputBuffer (s, _)
3626 | TestOutputStruct (s, _)
3627 | TestLastFail s -> s
3629 (* Handling for function flags. *)
3630 let protocol_limit_warning =
3631 "Because of the message protocol, there is a transfer limit
3632 of somewhere between 2MB and 4MB. To transfer large files you should use
3635 let danger_will_robinson =
3636 "B<This command is dangerous. Without careful use you
3637 can easily destroy all your data>."
3639 let deprecation_notice flags =
3642 find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
3644 sprintf "This function is deprecated.
3645 In new code, use the C<%s> call instead.
3647 Deprecated functions will not be removed from the API, but the
3648 fact that they are deprecated indicates that there are problems
3649 with correct use of these functions." alt in
3654 (* Check function names etc. for consistency. *)
3655 let check_functions () =
3656 let contains_uppercase str =
3657 let len = String.length str in
3659 if i >= len then false
3662 if c >= 'A' && c <= 'Z' then true
3669 (* Check function names. *)
3671 fun (name, _, _, _, _, _, _) ->
3672 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
3673 failwithf "function name %s does not need 'guestfs' prefix" name;
3675 failwithf "function name is empty";
3676 if name.[0] < 'a' || name.[0] > 'z' then
3677 failwithf "function name %s must start with lowercase a-z" name;
3678 if String.contains name '-' then
3679 failwithf "function name %s should not contain '-', use '_' instead."
3683 (* Check function parameter/return names. *)
3685 fun (name, style, _, _, _, _, _) ->
3686 let check_arg_ret_name n =
3687 if contains_uppercase n then
3688 failwithf "%s param/ret %s should not contain uppercase chars"
3690 if String.contains n '-' || String.contains n '_' then
3691 failwithf "%s param/ret %s should not contain '-' or '_'"
3694 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;
3695 if n = "int" || n = "char" || n = "short" || n = "long" then
3696 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
3697 if n = "i" || n = "n" then
3698 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
3699 if n = "argv" || n = "args" then
3700 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name
3703 (match fst style with
3705 | RInt n | RInt64 n | RBool n
3706 | RConstString n | RConstOptString n | RString n
3707 | RStringList n | RStruct (n, _) | RStructList (n, _)
3708 | RHashtable n | RBufferOut n ->
3709 check_arg_ret_name n
3711 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
3714 (* Check short descriptions. *)
3716 fun (name, _, _, _, _, shortdesc, _) ->
3717 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
3718 failwithf "short description of %s should begin with lowercase." name;
3719 let c = shortdesc.[String.length shortdesc-1] in
3720 if c = '\n' || c = '.' then
3721 failwithf "short description of %s should not end with . or \\n." name
3724 (* Check long dscriptions. *)
3726 fun (name, _, _, _, _, _, longdesc) ->
3727 if longdesc.[String.length longdesc-1] = '\n' then
3728 failwithf "long description of %s should not end with \\n." name
3731 (* Check proc_nrs. *)
3733 fun (name, _, proc_nr, _, _, _, _) ->
3734 if proc_nr <= 0 then
3735 failwithf "daemon function %s should have proc_nr > 0" name
3739 fun (name, _, proc_nr, _, _, _, _) ->
3740 if proc_nr <> -1 then
3741 failwithf "non-daemon function %s should have proc_nr -1" name
3742 ) non_daemon_functions;
3745 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
3748 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
3749 let rec loop = function
3752 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
3754 | (name1,nr1) :: (name2,nr2) :: _ ->
3755 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
3763 (* Ignore functions that have no tests. We generate a
3764 * warning when the user does 'make check' instead.
3766 | name, _, _, _, [], _, _ -> ()
3767 | name, _, _, _, tests, _, _ ->
3771 match seq_of_test test with
3773 failwithf "%s has a test containing an empty sequence" name
3774 | cmds -> List.map List.hd cmds
3776 let funcs = List.flatten funcs in
3778 let tested = List.mem name funcs in
3781 failwithf "function %s has tests but does not test itself" name
3784 (* 'pr' prints to the current output file. *)
3785 let chan = ref stdout
3786 let pr fs = ksprintf (output_string !chan) fs
3788 (* Generate a header block in a number of standard styles. *)
3789 type comment_style = CStyle | HashStyle | OCamlStyle | HaskellStyle
3790 type license = GPLv2 | LGPLv2
3792 let generate_header comment license =
3793 let c = match comment with
3794 | CStyle -> pr "/* "; " *"
3795 | HashStyle -> pr "# "; "#"
3796 | OCamlStyle -> pr "(* "; " *"
3797 | HaskellStyle -> pr "{- "; " " in
3798 pr "libguestfs generated file\n";
3799 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
3800 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
3802 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
3806 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
3807 pr "%s it under the terms of the GNU General Public License as published by\n" c;
3808 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
3809 pr "%s (at your option) any later version.\n" c;
3811 pr "%s This program is distributed in the hope that it will be useful,\n" c;
3812 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
3813 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
3814 pr "%s GNU General Public License for more details.\n" c;
3816 pr "%s You should have received a copy of the GNU General Public License along\n" c;
3817 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
3818 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
3821 pr "%s This library is free software; you can redistribute it and/or\n" c;
3822 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
3823 pr "%s License as published by the Free Software Foundation; either\n" c;
3824 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
3826 pr "%s This library is distributed in the hope that it will be useful,\n" c;
3827 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
3828 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
3829 pr "%s Lesser General Public License for more details.\n" c;
3831 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
3832 pr "%s License along with this library; if not, write to the Free Software\n" c;
3833 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
3836 | CStyle -> pr " */\n"
3838 | OCamlStyle -> pr " *)\n"
3839 | HaskellStyle -> pr "-}\n"
3843 (* Start of main code generation functions below this line. *)
3845 (* Generate the pod documentation for the C API. *)
3846 let rec generate_actions_pod () =
3848 fun (shortname, style, _, flags, _, _, longdesc) ->
3849 if not (List.mem NotInDocs flags) then (
3850 let name = "guestfs_" ^ shortname in
3851 pr "=head2 %s\n\n" name;
3853 generate_prototype ~extern:false ~handle:"handle" name style;
3855 pr "%s\n\n" longdesc;
3856 (match fst style with
3858 pr "This function returns 0 on success or -1 on error.\n\n"
3860 pr "On error this function returns -1.\n\n"
3862 pr "On error this function returns -1.\n\n"
3864 pr "This function returns a C truth value on success or -1 on error.\n\n"
3866 pr "This function returns a string, or NULL on error.
3867 The string is owned by the guest handle and must I<not> be freed.\n\n"
3868 | RConstOptString _ ->
3869 pr "This function returns a string which may be NULL.
3870 There is way to return an error from this function.
3871 The string is owned by the guest handle and must I<not> be freed.\n\n"
3873 pr "This function returns a string, or NULL on error.
3874 I<The caller must free the returned string after use>.\n\n"
3876 pr "This function returns a NULL-terminated array of strings
3877 (like L<environ(3)>), or NULL if there was an error.
3878 I<The caller must free the strings and the array after use>.\n\n"
3879 | RStruct (_, typ) ->
3880 pr "This function returns a C<struct guestfs_%s *>,
3881 or NULL if there was an error.
3882 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
3883 | RStructList (_, typ) ->
3884 pr "This function returns a C<struct guestfs_%s_list *>
3885 (see E<lt>guestfs-structs.hE<gt>),
3886 or NULL if there was an error.
3887 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
3889 pr "This function returns a NULL-terminated array of
3890 strings, or NULL if there was an error.
3891 The array of strings will always have length C<2n+1>, where
3892 C<n> keys and values alternate, followed by the trailing NULL entry.
3893 I<The caller must free the strings and the array after use>.\n\n"
3895 pr "This function returns a buffer, or NULL on error.
3896 The size of the returned buffer is written to C<*size_r>.
3897 I<The caller must free the returned buffer after use>.\n\n"
3899 if List.mem ProtocolLimitWarning flags then
3900 pr "%s\n\n" protocol_limit_warning;
3901 if List.mem DangerWillRobinson flags then
3902 pr "%s\n\n" danger_will_robinson;
3903 match deprecation_notice flags with
3905 | Some txt -> pr "%s\n\n" txt
3907 ) all_functions_sorted
3909 and generate_structs_pod () =
3910 (* Structs documentation. *)
3913 pr "=head2 guestfs_%s\n" typ;
3915 pr " struct guestfs_%s {\n" typ;
3918 | name, FChar -> pr " char %s;\n" name
3919 | name, FUInt32 -> pr " uint32_t %s;\n" name
3920 | name, FInt32 -> pr " int32_t %s;\n" name
3921 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
3922 | name, FInt64 -> pr " int64_t %s;\n" name
3923 | name, FString -> pr " char *%s;\n" name
3925 pr " /* The next two fields describe a byte array. */\n";
3926 pr " uint32_t %s_len;\n" name;
3927 pr " char *%s;\n" name
3929 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
3930 pr " char %s[32];\n" name
3931 | name, FOptPercent ->
3932 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
3933 pr " float %s;\n" name
3937 pr " struct guestfs_%s_list {\n" typ;
3938 pr " uint32_t len; /* Number of elements in list. */\n";
3939 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
3942 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
3943 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
3948 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
3949 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
3951 * We have to use an underscore instead of a dash because otherwise
3952 * rpcgen generates incorrect code.
3954 * This header is NOT exported to clients, but see also generate_structs_h.
3956 and generate_xdr () =
3957 generate_header CStyle LGPLv2;
3959 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
3960 pr "typedef string str<>;\n";
3963 (* Internal structures. *)
3967 pr "struct guestfs_int_%s {\n" typ;
3969 | name, FChar -> pr " char %s;\n" name
3970 | name, FString -> pr " string %s<>;\n" name
3971 | name, FBuffer -> pr " opaque %s<>;\n" name
3972 | name, FUUID -> pr " opaque %s[32];\n" name
3973 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
3974 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
3975 | name, FOptPercent -> pr " float %s;\n" name
3979 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
3984 fun (shortname, style, _, _, _, _, _) ->
3985 let name = "guestfs_" ^ shortname in
3987 (match snd style with
3990 pr "struct %s_args {\n" name;
3993 | String n -> pr " string %s<>;\n" n
3994 | OptString n -> pr " str *%s;\n" n
3995 | StringList n -> pr " str %s<>;\n" n
3996 | Bool n -> pr " bool %s;\n" n
3997 | Int n -> pr " int %s;\n" n
3998 | FileIn _ | FileOut _ -> ()
4002 (match fst style with
4005 pr "struct %s_ret {\n" name;
4009 pr "struct %s_ret {\n" name;
4010 pr " hyper %s;\n" n;
4013 pr "struct %s_ret {\n" name;
4016 | RConstString _ | RConstOptString _ ->
4017 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4019 pr "struct %s_ret {\n" name;
4020 pr " string %s<>;\n" n;
4023 pr "struct %s_ret {\n" name;
4024 pr " str %s<>;\n" n;
4026 | RStruct (n, typ) ->
4027 pr "struct %s_ret {\n" name;
4028 pr " guestfs_int_%s %s;\n" typ n;
4030 | RStructList (n, typ) ->
4031 pr "struct %s_ret {\n" name;
4032 pr " guestfs_int_%s_list %s;\n" typ n;
4035 pr "struct %s_ret {\n" name;
4036 pr " str %s<>;\n" n;
4039 pr "struct %s_ret {\n" name;
4040 pr " opaque %s<>;\n" n;
4045 (* Table of procedure numbers. *)
4046 pr "enum guestfs_procedure {\n";
4048 fun (shortname, _, proc_nr, _, _, _, _) ->
4049 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
4051 pr " GUESTFS_PROC_NR_PROCS\n";
4055 (* Having to choose a maximum message size is annoying for several
4056 * reasons (it limits what we can do in the API), but it (a) makes
4057 * the protocol a lot simpler, and (b) provides a bound on the size
4058 * of the daemon which operates in limited memory space. For large
4059 * file transfers you should use FTP.
4061 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
4064 (* Message header, etc. *)
4066 /* The communication protocol is now documented in the guestfs(3)
4070 const GUESTFS_PROGRAM = 0x2000F5F5;
4071 const GUESTFS_PROTOCOL_VERSION = 1;
4073 /* These constants must be larger than any possible message length. */
4074 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
4075 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
4077 enum guestfs_message_direction {
4078 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
4079 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
4082 enum guestfs_message_status {
4083 GUESTFS_STATUS_OK = 0,
4084 GUESTFS_STATUS_ERROR = 1
4087 const GUESTFS_ERROR_LEN = 256;
4089 struct guestfs_message_error {
4090 string error_message<GUESTFS_ERROR_LEN>;
4093 struct guestfs_message_header {
4094 unsigned prog; /* GUESTFS_PROGRAM */
4095 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
4096 guestfs_procedure proc; /* GUESTFS_PROC_x */
4097 guestfs_message_direction direction;
4098 unsigned serial; /* message serial number */
4099 guestfs_message_status status;
4102 const GUESTFS_MAX_CHUNK_SIZE = 8192;
4104 struct guestfs_chunk {
4105 int cancel; /* if non-zero, transfer is cancelled */
4106 /* data size is 0 bytes if the transfer has finished successfully */
4107 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
4111 (* Generate the guestfs-structs.h file. *)
4112 and generate_structs_h () =
4113 generate_header CStyle LGPLv2;
4115 (* This is a public exported header file containing various
4116 * structures. The structures are carefully written to have
4117 * exactly the same in-memory format as the XDR structures that
4118 * we use on the wire to the daemon. The reason for creating
4119 * copies of these structures here is just so we don't have to
4120 * export the whole of guestfs_protocol.h (which includes much
4121 * unrelated and XDR-dependent stuff that we don't want to be
4122 * public, or required by clients).
4124 * To reiterate, we will pass these structures to and from the
4125 * client with a simple assignment or memcpy, so the format
4126 * must be identical to what rpcgen / the RFC defines.
4129 (* Public structures. *)
4132 pr "struct guestfs_%s {\n" typ;
4135 | name, FChar -> pr " char %s;\n" name
4136 | name, FString -> pr " char *%s;\n" name
4138 pr " uint32_t %s_len;\n" name;
4139 pr " char *%s;\n" name
4140 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
4141 | name, FUInt32 -> pr " uint32_t %s;\n" name
4142 | name, FInt32 -> pr " int32_t %s;\n" name
4143 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
4144 | name, FInt64 -> pr " int64_t %s;\n" name
4145 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
4149 pr "struct guestfs_%s_list {\n" typ;
4150 pr " uint32_t len;\n";
4151 pr " struct guestfs_%s *val;\n" typ;
4154 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
4155 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
4159 (* Generate the guestfs-actions.h file. *)
4160 and generate_actions_h () =
4161 generate_header CStyle LGPLv2;
4163 fun (shortname, style, _, _, _, _, _) ->
4164 let name = "guestfs_" ^ shortname in
4165 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
4169 (* Generate the client-side dispatch stubs. *)
4170 and generate_client_actions () =
4171 generate_header CStyle LGPLv2;
4177 #include \"guestfs.h\"
4178 #include \"guestfs_protocol.h\"
4180 #define error guestfs_error
4181 #define perrorf guestfs_perrorf
4182 #define safe_malloc guestfs_safe_malloc
4183 #define safe_realloc guestfs_safe_realloc
4184 #define safe_strdup guestfs_safe_strdup
4185 #define safe_memdup guestfs_safe_memdup
4187 /* Check the return message from a call for validity. */
4189 check_reply_header (guestfs_h *g,
4190 const struct guestfs_message_header *hdr,
4191 int proc_nr, int serial)
4193 if (hdr->prog != GUESTFS_PROGRAM) {
4194 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
4197 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
4198 error (g, \"wrong protocol version (%%d/%%d)\",
4199 hdr->vers, GUESTFS_PROTOCOL_VERSION);
4202 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
4203 error (g, \"unexpected message direction (%%d/%%d)\",
4204 hdr->direction, GUESTFS_DIRECTION_REPLY);
4207 if (hdr->proc != proc_nr) {
4208 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
4211 if (hdr->serial != serial) {
4212 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
4219 /* Check we are in the right state to run a high-level action. */
4221 check_state (guestfs_h *g, const char *caller)
4223 if (!guestfs_is_ready (g)) {
4224 if (guestfs_is_config (g))
4225 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
4227 else if (guestfs_is_launching (g))
4228 error (g, \"%%s: call wait_ready() before using this function\",
4231 error (g, \"%%s called from the wrong state, %%d != READY\",
4232 caller, guestfs_get_state (g));
4240 (* Client-side stubs for each function. *)
4242 fun (shortname, style, _, _, _, _, _) ->
4243 let name = "guestfs_" ^ shortname in
4245 (* Generate the context struct which stores the high-level
4246 * state between callback functions.
4248 pr "struct %s_ctx {\n" shortname;
4249 pr " /* This flag is set by the callbacks, so we know we've done\n";
4250 pr " * the callbacks as expected, and in the right sequence.\n";
4251 pr " * 0 = not called, 1 = reply_cb called.\n";
4253 pr " int cb_sequence;\n";
4254 pr " struct guestfs_message_header hdr;\n";
4255 pr " struct guestfs_message_error err;\n";
4256 (match fst style with
4258 | RConstString _ | RConstOptString _ ->
4259 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4261 | RBool _ | RString _ | RStringList _
4262 | RStruct _ | RStructList _
4263 | RHashtable _ | RBufferOut _ ->
4264 pr " struct %s_ret ret;\n" name
4269 (* Generate the reply callback function. *)
4270 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
4272 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
4273 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
4275 pr " /* This should definitely not happen. */\n";
4276 pr " if (ctx->cb_sequence != 0) {\n";
4277 pr " ctx->cb_sequence = 9999;\n";
4278 pr " error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
4282 pr " ml->main_loop_quit (ml, g);\n";
4284 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
4285 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
4288 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
4289 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
4290 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
4297 (match fst style with
4299 | RConstString _ | RConstOptString _ ->
4300 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4302 | RBool _ | RString _ | RStringList _
4303 | RStruct _ | RStructList _
4304 | RHashtable _ | RBufferOut _ ->
4305 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
4306 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
4312 pr " ctx->cb_sequence = 1;\n";
4315 (* Generate the action stub. *)
4316 generate_prototype ~extern:false ~semicolon:false ~newline:true
4317 ~handle:"g" name style;
4320 match fst style with
4321 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
4322 | RConstString _ | RConstOptString _ ->
4323 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4324 | RString _ | RStringList _
4325 | RStruct _ | RStructList _
4326 | RHashtable _ | RBufferOut _ ->
4331 (match snd style with
4333 | _ -> pr " struct %s_args args;\n" name
4336 pr " struct %s_ctx ctx;\n" shortname;
4337 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
4338 pr " int serial;\n";
4340 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
4341 pr " guestfs_set_busy (g);\n";
4343 pr " memset (&ctx, 0, sizeof ctx);\n";
4346 (* Send the main header and arguments. *)
4347 (match snd style with
4349 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
4350 (String.uppercase shortname)
4355 pr " args.%s = (char *) %s;\n" n n
4357 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
4359 pr " args.%s.%s_val = (char **) %s;\n" n n n;
4360 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
4362 pr " args.%s = %s;\n" n n
4364 pr " args.%s = %s;\n" n n
4365 | FileIn _ | FileOut _ -> ()
4367 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
4368 (String.uppercase shortname);
4369 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
4372 pr " if (serial == -1) {\n";
4373 pr " guestfs_end_busy (g);\n";
4374 pr " return %s;\n" error_code;
4378 (* Send any additional files (FileIn) requested. *)
4379 let need_read_reply_label = ref false in
4386 pr " r = guestfs__send_file_sync (g, %s);\n" n;
4387 pr " if (r == -1) {\n";
4388 pr " guestfs_end_busy (g);\n";
4389 pr " return %s;\n" error_code;
4391 pr " if (r == -2) /* daemon cancelled */\n";
4392 pr " goto read_reply;\n";
4393 need_read_reply_label := true;
4399 (* Wait for the reply from the remote end. *)
4400 if !need_read_reply_label then pr " read_reply:\n";
4401 pr " guestfs__switch_to_receiving (g);\n";
4402 pr " ctx.cb_sequence = 0;\n";
4403 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
4404 pr " (void) ml->main_loop_run (ml, g);\n";
4405 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
4406 pr " if (ctx.cb_sequence != 1) {\n";
4407 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
4408 pr " guestfs_end_busy (g);\n";
4409 pr " return %s;\n" error_code;
4413 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
4414 (String.uppercase shortname);
4415 pr " guestfs_end_busy (g);\n";
4416 pr " return %s;\n" error_code;
4420 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
4421 pr " error (g, \"%%s\", ctx.err.error_message);\n";
4422 pr " free (ctx.err.error_message);\n";
4423 pr " guestfs_end_busy (g);\n";
4424 pr " return %s;\n" error_code;
4428 (* Expecting to receive further files (FileOut)? *)
4432 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
4433 pr " guestfs_end_busy (g);\n";
4434 pr " return %s;\n" error_code;
4440 pr " guestfs_end_busy (g);\n";
4442 (match fst style with
4443 | RErr -> pr " return 0;\n"
4444 | RInt n | RInt64 n | RBool n ->
4445 pr " return ctx.ret.%s;\n" n
4446 | RConstString _ | RConstOptString _ ->
4447 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4449 pr " return ctx.ret.%s; /* caller will free */\n" n
4450 | RStringList n | RHashtable n ->
4451 pr " /* caller will free this, but we need to add a NULL entry */\n";
4452 pr " ctx.ret.%s.%s_val =\n" n n;
4453 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
4454 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
4456 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
4457 pr " return ctx.ret.%s.%s_val;\n" n n
4459 pr " /* caller will free this */\n";
4460 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
4461 | RStructList (n, _) ->
4462 pr " /* caller will free this */\n";
4463 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
4465 pr " *size_r = ctx.ret.%s.%s_len;\n" n n;
4466 pr " return ctx.ret.%s.%s_val; /* caller will free */\n" n n
4472 (* Functions to free structures. *)
4473 pr "/* Structure-freeing functions. These rely on the fact that the\n";
4474 pr " * structure format is identical to the XDR format. See note in\n";
4475 pr " * generator.ml.\n";
4482 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
4484 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
4490 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
4492 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
4499 (* Generate daemon/actions.h. *)
4500 and generate_daemon_actions_h () =
4501 generate_header CStyle GPLv2;
4503 pr "#include \"../src/guestfs_protocol.h\"\n";
4507 fun (name, style, _, _, _, _, _) ->
4509 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
4513 (* Generate the server-side stubs. *)
4514 and generate_daemon_actions () =
4515 generate_header CStyle GPLv2;
4517 pr "#include <config.h>\n";
4519 pr "#include <stdio.h>\n";
4520 pr "#include <stdlib.h>\n";
4521 pr "#include <string.h>\n";
4522 pr "#include <inttypes.h>\n";
4523 pr "#include <ctype.h>\n";
4524 pr "#include <rpc/types.h>\n";
4525 pr "#include <rpc/xdr.h>\n";
4527 pr "#include \"daemon.h\"\n";
4528 pr "#include \"../src/guestfs_protocol.h\"\n";
4529 pr "#include \"actions.h\"\n";
4533 fun (name, style, _, _, _, _, _) ->
4534 (* Generate server-side stubs. *)
4535 pr "static void %s_stub (XDR *xdr_in)\n" name;
4538 match fst style with
4539 | RErr | RInt _ -> pr " int r;\n"; "-1"
4540 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4541 | RBool _ -> pr " int r;\n"; "-1"
4542 | RConstString _ | RConstOptString _ ->
4543 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4544 | RString _ -> pr " char *r;\n"; "NULL"
4545 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
4546 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
4547 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
4549 pr " size_t size;\n";
4553 (match snd style with
4556 pr " struct guestfs_%s_args args;\n" name;
4559 (* Note we allow the string to be writable, in order to
4560 * allow device name translation. This is safe because
4561 * we can modify the string (passed from RPC).
4564 | OptString n -> pr " char *%s;\n" n
4565 | StringList n -> pr " char **%s;\n" n
4566 | Bool n -> pr " int %s;\n" n
4567 | Int n -> pr " int %s;\n" n
4568 | FileIn _ | FileOut _ -> ()
4573 (match snd style with
4576 pr " memset (&args, 0, sizeof args);\n";
4578 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
4579 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
4584 | String n -> pr " %s = args.%s;\n" n n
4585 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
4587 pr " %s = realloc (args.%s.%s_val,\n" n n n;
4588 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
4589 pr " if (%s == NULL) {\n" n;
4590 pr " reply_with_perror (\"realloc\");\n";
4593 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
4594 pr " args.%s.%s_val = %s;\n" n n n;
4595 | Bool n -> pr " %s = args.%s;\n" n n
4596 | Int n -> pr " %s = args.%s;\n" n n
4597 | FileIn _ | FileOut _ -> ()
4602 (* Don't want to call the impl with any FileIn or FileOut
4603 * parameters, since these go "outside" the RPC protocol.
4606 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
4608 pr " r = do_%s " name;
4609 generate_c_call_args (fst style, args');
4612 pr " if (r == %s)\n" error_code;
4613 pr " /* do_%s has already called reply_with_error */\n" name;
4617 (* If there are any FileOut parameters, then the impl must
4618 * send its own reply.
4621 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
4623 pr " /* do_%s has already sent a reply */\n" name
4625 match fst style with
4626 | RErr -> pr " reply (NULL, NULL);\n"
4627 | RInt n | RInt64 n | RBool n ->
4628 pr " struct guestfs_%s_ret ret;\n" name;
4629 pr " ret.%s = r;\n" n;
4630 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4632 | RConstString _ | RConstOptString _ ->
4633 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4635 pr " struct guestfs_%s_ret ret;\n" name;
4636 pr " ret.%s = r;\n" n;
4637 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4640 | RStringList n | RHashtable n ->
4641 pr " struct guestfs_%s_ret ret;\n" name;
4642 pr " ret.%s.%s_len = count_strings (r);\n" n n;
4643 pr " ret.%s.%s_val = r;\n" n n;
4644 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4646 pr " free_strings (r);\n"
4648 pr " struct guestfs_%s_ret ret;\n" name;
4649 pr " ret.%s = *r;\n" n;
4650 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4652 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4654 | RStructList (n, _) ->
4655 pr " struct guestfs_%s_ret ret;\n" name;
4656 pr " ret.%s = *r;\n" n;
4657 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4659 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4662 pr " struct guestfs_%s_ret ret;\n" name;
4663 pr " ret.%s.%s_val = r;\n" n n;
4664 pr " ret.%s.%s_len = size;\n" n n;
4665 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4670 (* Free the args. *)
4671 (match snd style with
4676 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
4683 (* Dispatch function. *)
4684 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
4686 pr " switch (proc_nr) {\n";
4689 fun (name, style, _, _, _, _, _) ->
4690 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
4691 pr " %s_stub (xdr_in);\n" name;
4696 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";
4701 (* LVM columns and tokenization functions. *)
4702 (* XXX This generates crap code. We should rethink how we
4708 pr "static const char *lvm_%s_cols = \"%s\";\n"
4709 typ (String.concat "," (List.map fst cols));
4712 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
4714 pr " char *tok, *p, *next;\n";
4718 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
4721 pr " if (!str) {\n";
4722 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
4725 pr " if (!*str || isspace (*str)) {\n";
4726 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
4731 fun (name, coltype) ->
4732 pr " if (!tok) {\n";
4733 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
4736 pr " p = strchrnul (tok, ',');\n";
4737 pr " if (*p) next = p+1; else next = NULL;\n";
4738 pr " *p = '\\0';\n";
4741 pr " r->%s = strdup (tok);\n" name;
4742 pr " if (r->%s == NULL) {\n" name;
4743 pr " perror (\"strdup\");\n";
4747 pr " for (i = j = 0; i < 32; ++j) {\n";
4748 pr " if (tok[j] == '\\0') {\n";
4749 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
4751 pr " } else if (tok[j] != '-')\n";
4752 pr " r->%s[i++] = tok[j];\n" name;
4755 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
4756 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4760 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
4761 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4765 pr " if (tok[0] == '\\0')\n";
4766 pr " r->%s = -1;\n" name;
4767 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
4768 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4771 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
4772 assert false (* can never be an LVM column *)
4774 pr " tok = next;\n";
4777 pr " if (tok != NULL) {\n";
4778 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
4785 pr "guestfs_int_lvm_%s_list *\n" typ;
4786 pr "parse_command_line_%ss (void)\n" typ;
4788 pr " char *out, *err;\n";
4789 pr " char *p, *pend;\n";
4791 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
4792 pr " void *newp;\n";
4794 pr " ret = malloc (sizeof *ret);\n";
4795 pr " if (!ret) {\n";
4796 pr " reply_with_perror (\"malloc\");\n";
4797 pr " return NULL;\n";
4800 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
4801 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
4803 pr " r = command (&out, &err,\n";
4804 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
4805 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
4806 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
4807 pr " if (r == -1) {\n";
4808 pr " reply_with_error (\"%%s\", err);\n";
4809 pr " free (out);\n";
4810 pr " free (err);\n";
4811 pr " free (ret);\n";
4812 pr " return NULL;\n";
4815 pr " free (err);\n";
4817 pr " /* Tokenize each line of the output. */\n";
4820 pr " while (p) {\n";
4821 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
4822 pr " if (pend) {\n";
4823 pr " *pend = '\\0';\n";
4827 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
4830 pr " if (!*p) { /* Empty line? Skip it. */\n";
4835 pr " /* Allocate some space to store this next entry. */\n";
4836 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
4837 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
4838 pr " if (newp == NULL) {\n";
4839 pr " reply_with_perror (\"realloc\");\n";
4840 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
4841 pr " free (ret);\n";
4842 pr " free (out);\n";
4843 pr " return NULL;\n";
4845 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
4847 pr " /* Tokenize the next entry. */\n";
4848 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
4849 pr " if (r == -1) {\n";
4850 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
4851 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
4852 pr " free (ret);\n";
4853 pr " free (out);\n";
4854 pr " return NULL;\n";
4861 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
4863 pr " free (out);\n";
4864 pr " return ret;\n";
4867 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
4869 (* Generate a list of function names, for debugging in the daemon.. *)
4870 and generate_daemon_names () =
4871 generate_header CStyle GPLv2;
4873 pr "#include <config.h>\n";
4875 pr "#include \"daemon.h\"\n";
4878 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
4879 pr "const char *function_names[] = {\n";
4881 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
4885 (* Generate the tests. *)
4886 and generate_tests () =
4887 generate_header CStyle GPLv2;
4894 #include <sys/types.h>
4897 #include \"guestfs.h\"
4899 static guestfs_h *g;
4900 static int suppress_error = 0;
4902 static void print_error (guestfs_h *g, void *data, const char *msg)
4904 if (!suppress_error)
4905 fprintf (stderr, \"%%s\\n\", msg);
4908 static void print_strings (char * const * const argv)
4912 for (argc = 0; argv[argc] != NULL; ++argc)
4913 printf (\"\\t%%s\\n\", argv[argc]);
4917 static void print_table (char * const * const argv)
4921 for (i = 0; argv[i] != NULL; i += 2)
4922 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
4926 static void no_test_warnings (void)
4932 | name, _, _, _, [], _, _ ->
4933 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
4934 | name, _, _, _, tests, _, _ -> ()
4940 (* Generate the actual tests. Note that we generate the tests
4941 * in reverse order, deliberately, so that (in general) the
4942 * newest tests run first. This makes it quicker and easier to
4947 fun (name, _, _, _, tests, _, _) ->
4948 mapi (generate_one_test name) tests
4949 ) (List.rev all_functions) in
4950 let test_names = List.concat test_names in
4951 let nr_tests = List.length test_names in
4954 int main (int argc, char *argv[])
4958 const char *filename;
4960 int nr_tests, test_num = 0;
4962 setbuf (stdout, NULL);
4964 no_test_warnings ();
4966 g = guestfs_create ();
4968 printf (\"guestfs_create FAILED\\n\");
4972 guestfs_set_error_handler (g, print_error, NULL);
4974 guestfs_set_path (g, \"../appliance\");
4976 filename = \"test1.img\";
4977 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
4982 if (lseek (fd, %d, SEEK_SET) == -1) {
4988 if (write (fd, &c, 1) == -1) {
4994 if (close (fd) == -1) {
4999 if (guestfs_add_drive (g, filename) == -1) {
5000 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
5004 filename = \"test2.img\";
5005 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
5010 if (lseek (fd, %d, SEEK_SET) == -1) {
5016 if (write (fd, &c, 1) == -1) {
5022 if (close (fd) == -1) {
5027 if (guestfs_add_drive (g, filename) == -1) {
5028 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
5032 filename = \"test3.img\";
5033 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
5038 if (lseek (fd, %d, SEEK_SET) == -1) {
5044 if (write (fd, &c, 1) == -1) {
5050 if (close (fd) == -1) {
5055 if (guestfs_add_drive (g, filename) == -1) {
5056 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
5060 if (guestfs_add_drive_ro (g, \"../images/test.sqsh\") == -1) {
5061 printf (\"guestfs_add_drive_ro ../images/test.sqsh FAILED\\n\");
5065 if (guestfs_launch (g) == -1) {
5066 printf (\"guestfs_launch FAILED\\n\");
5070 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
5073 if (guestfs_wait_ready (g) == -1) {
5074 printf (\"guestfs_wait_ready FAILED\\n\");
5078 /* Cancel previous alarm. */
5083 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
5087 pr " test_num++;\n";
5088 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
5089 pr " if (%s () == -1) {\n" test_name;
5090 pr " printf (\"%s FAILED\\n\");\n" test_name;
5096 pr " guestfs_close (g);\n";
5097 pr " unlink (\"test1.img\");\n";
5098 pr " unlink (\"test2.img\");\n";
5099 pr " unlink (\"test3.img\");\n";
5102 pr " if (failed > 0) {\n";
5103 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
5111 and generate_one_test name i (init, prereq, test) =
5112 let test_name = sprintf "test_%s_%d" name i in
5115 static int %s_skip (void)
5119 str = getenv (\"TEST_ONLY\");
5121 return strstr (str, \"%s\") == NULL;
5122 str = getenv (\"SKIP_%s\");
5123 if (str && strcmp (str, \"1\") == 0) return 1;
5124 str = getenv (\"SKIP_TEST_%s\");
5125 if (str && strcmp (str, \"1\") == 0) return 1;
5129 " test_name name (String.uppercase test_name) (String.uppercase name);
5132 | Disabled | Always -> ()
5133 | If code | Unless code ->
5134 pr "static int %s_prereq (void)\n" test_name;
5142 static int %s (void)
5145 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
5149 " test_name test_name test_name;
5153 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
5155 pr " if (! %s_prereq ()) {\n" test_name;
5156 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
5160 generate_one_test_body name i test_name init test;
5162 pr " if (%s_prereq ()) {\n" test_name;
5163 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
5167 generate_one_test_body name i test_name init test;
5169 generate_one_test_body name i test_name init test
5177 and generate_one_test_body name i test_name init test =
5179 | InitNone (* XXX at some point, InitNone and InitEmpty became
5180 * folded together as the same thing. Really we should
5181 * make InitNone do nothing at all, but the tests may
5182 * need to be checked to make sure this is OK.
5185 pr " /* InitNone|InitEmpty for %s */\n" test_name;
5186 List.iter (generate_test_command_call test_name)
5187 [["blockdev_setrw"; "/dev/sda"];
5191 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
5192 List.iter (generate_test_command_call test_name)
5193 [["blockdev_setrw"; "/dev/sda"];
5196 ["sfdiskM"; "/dev/sda"; ","];
5197 ["mkfs"; "ext2"; "/dev/sda1"];
5198 ["mount"; "/dev/sda1"; "/"]]
5199 | InitBasicFSonLVM ->
5200 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
5202 List.iter (generate_test_command_call test_name)
5203 [["blockdev_setrw"; "/dev/sda"];
5206 ["sfdiskM"; "/dev/sda"; ","];
5207 ["pvcreate"; "/dev/sda1"];
5208 ["vgcreate"; "VG"; "/dev/sda1"];
5209 ["lvcreate"; "LV"; "VG"; "8"];
5210 ["mkfs"; "ext2"; "/dev/VG/LV"];
5211 ["mount"; "/dev/VG/LV"; "/"]]
5213 pr " /* InitSquashFS for %s */\n" test_name;
5214 List.iter (generate_test_command_call test_name)
5215 [["blockdev_setrw"; "/dev/sda"];
5218 ["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"]]
5221 let get_seq_last = function
5223 failwithf "%s: you cannot use [] (empty list) when expecting a command"
5226 let seq = List.rev seq in
5227 List.rev (List.tl seq), List.hd seq
5232 pr " /* TestRun for %s (%d) */\n" name i;
5233 List.iter (generate_test_command_call test_name) seq
5234 | TestOutput (seq, expected) ->
5235 pr " /* TestOutput for %s (%d) */\n" name i;
5236 pr " const char *expected = \"%s\";\n" (c_quote expected);
5237 let seq, last = get_seq_last seq in
5239 pr " if (strcmp (r, expected) != 0) {\n";
5240 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
5244 List.iter (generate_test_command_call test_name) seq;
5245 generate_test_command_call ~test test_name last
5246 | TestOutputList (seq, expected) ->
5247 pr " /* TestOutputList for %s (%d) */\n" name i;
5248 let seq, last = get_seq_last seq in
5252 pr " if (!r[%d]) {\n" i;
5253 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
5254 pr " print_strings (r);\n";
5258 pr " const char *expected = \"%s\";\n" (c_quote str);
5259 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
5260 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
5265 pr " if (r[%d] != NULL) {\n" (List.length expected);
5266 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
5268 pr " print_strings (r);\n";
5272 List.iter (generate_test_command_call test_name) seq;
5273 generate_test_command_call ~test test_name last
5274 | TestOutputListOfDevices (seq, expected) ->
5275 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
5276 let seq, last = get_seq_last seq in
5280 pr " if (!r[%d]) {\n" i;
5281 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
5282 pr " print_strings (r);\n";
5286 pr " const char *expected = \"%s\";\n" (c_quote str);
5287 pr " r[%d][5] = 's';\n" i;
5288 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
5289 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
5294 pr " if (r[%d] != NULL) {\n" (List.length expected);
5295 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
5297 pr " print_strings (r);\n";
5301 List.iter (generate_test_command_call test_name) seq;
5302 generate_test_command_call ~test test_name last
5303 | TestOutputInt (seq, expected) ->
5304 pr " /* TestOutputInt for %s (%d) */\n" name i;
5305 let seq, last = get_seq_last seq in
5307 pr " if (r != %d) {\n" expected;
5308 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
5314 List.iter (generate_test_command_call test_name) seq;
5315 generate_test_command_call ~test test_name last
5316 | TestOutputIntOp (seq, op, expected) ->
5317 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
5318 let seq, last = get_seq_last seq in
5320 pr " if (! (r %s %d)) {\n" op expected;
5321 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
5322 test_name op expected;
5327 List.iter (generate_test_command_call test_name) seq;
5328 generate_test_command_call ~test test_name last
5329 | TestOutputTrue seq ->
5330 pr " /* TestOutputTrue for %s (%d) */\n" name i;
5331 let seq, last = get_seq_last seq in
5334 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
5339 List.iter (generate_test_command_call test_name) seq;
5340 generate_test_command_call ~test test_name last
5341 | TestOutputFalse seq ->
5342 pr " /* TestOutputFalse for %s (%d) */\n" name i;
5343 let seq, last = get_seq_last seq in
5346 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
5351 List.iter (generate_test_command_call test_name) seq;
5352 generate_test_command_call ~test test_name last
5353 | TestOutputLength (seq, expected) ->
5354 pr " /* TestOutputLength for %s (%d) */\n" name i;
5355 let seq, last = get_seq_last seq in
5358 pr " for (j = 0; j < %d; ++j)\n" expected;
5359 pr " if (r[j] == NULL) {\n";
5360 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
5362 pr " print_strings (r);\n";
5365 pr " if (r[j] != NULL) {\n";
5366 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
5368 pr " print_strings (r);\n";
5372 List.iter (generate_test_command_call test_name) seq;
5373 generate_test_command_call ~test test_name last
5374 | TestOutputBuffer (seq, expected) ->
5375 pr " /* TestOutputBuffer for %s (%d) */\n" name i;
5376 pr " const char *expected = \"%s\";\n" (c_quote expected);
5377 let seq, last = get_seq_last seq in
5378 let len = String.length expected in
5380 pr " if (size != %d) {\n" len;
5381 pr " fprintf (stderr, \"%s: returned size of buffer wrong, expected %d but got %%zu\\n\", size);\n" test_name len;
5384 pr " if (strncmp (r, expected, size) != 0) {\n";
5385 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
5389 List.iter (generate_test_command_call test_name) seq;
5390 generate_test_command_call ~test test_name last
5391 | TestOutputStruct (seq, checks) ->
5392 pr " /* TestOutputStruct for %s (%d) */\n" name i;
5393 let seq, last = get_seq_last seq in
5397 | CompareWithInt (field, expected) ->
5398 pr " if (r->%s != %d) {\n" field expected;
5399 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
5400 test_name field expected;
5401 pr " (int) r->%s);\n" field;
5404 | CompareWithIntOp (field, op, expected) ->
5405 pr " if (!(r->%s %s %d)) {\n" field op expected;
5406 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
5407 test_name field op expected;
5408 pr " (int) r->%s);\n" field;
5411 | CompareWithString (field, expected) ->
5412 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
5413 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
5414 test_name field expected;
5415 pr " r->%s);\n" field;
5418 | CompareFieldsIntEq (field1, field2) ->
5419 pr " if (r->%s != r->%s) {\n" field1 field2;
5420 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
5421 test_name field1 field2;
5422 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
5425 | CompareFieldsStrEq (field1, field2) ->
5426 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
5427 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
5428 test_name field1 field2;
5429 pr " r->%s, r->%s);\n" field1 field2;
5434 List.iter (generate_test_command_call test_name) seq;
5435 generate_test_command_call ~test test_name last
5436 | TestLastFail seq ->
5437 pr " /* TestLastFail for %s (%d) */\n" name i;
5438 let seq, last = get_seq_last seq in
5439 List.iter (generate_test_command_call test_name) seq;
5440 generate_test_command_call test_name ~expect_error:true last
5442 (* Generate the code to run a command, leaving the result in 'r'.
5443 * If you expect to get an error then you should set expect_error:true.
5445 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
5447 | [] -> assert false
5449 (* Look up the command to find out what args/ret it has. *)
5452 let _, style, _, _, _, _, _ =
5453 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
5456 failwithf "%s: in test, command %s was not found" test_name name in
5458 if List.length (snd style) <> List.length args then
5459 failwithf "%s: in test, wrong number of args given to %s"
5466 | OptString n, "NULL" -> ()
5468 | OptString n, arg ->
5469 pr " const char *%s = \"%s\";\n" n (c_quote arg);
5472 | FileIn _, _ | FileOut _, _ -> ()
5473 | StringList n, arg ->
5474 let strs = string_split " " arg in
5477 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
5479 pr " const char *%s[] = {\n" n;
5481 fun i _ -> pr " %s_%d,\n" n i
5485 ) (List.combine (snd style) args);
5488 match fst style with
5489 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5490 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5491 | RConstString _ | RConstOptString _ ->
5492 pr " const char *r;\n"; "NULL"
5493 | RString _ -> pr " char *r;\n"; "NULL"
5494 | RStringList _ | RHashtable _ ->
5498 | RStruct (_, typ) ->
5499 pr " struct guestfs_%s *r;\n" typ; "NULL"
5500 | RStructList (_, typ) ->
5501 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
5504 pr " size_t size;\n";
5507 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
5508 pr " r = guestfs_%s (g" name;
5510 (* Generate the parameters. *)
5513 | OptString _, "NULL" -> pr ", NULL"
5517 | FileIn _, arg | FileOut _, arg ->
5518 pr ", \"%s\"" (c_quote arg)
5519 | StringList n, _ ->
5523 try int_of_string arg
5524 with Failure "int_of_string" ->
5525 failwithf "%s: expecting an int, but got '%s'" test_name arg in
5528 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
5529 ) (List.combine (snd style) args);
5531 (match fst style with
5532 | RBufferOut _ -> pr ", &size"
5538 if not expect_error then
5539 pr " if (r == %s)\n" error_code
5541 pr " if (r != %s)\n" error_code;
5544 (* Insert the test code. *)
5550 (match fst style with
5551 | RErr | RInt _ | RInt64 _ | RBool _
5552 | RConstString _ | RConstOptString _ -> ()
5553 | RString _ | RBufferOut _ -> pr " free (r);\n"
5554 | RStringList _ | RHashtable _ ->
5555 pr " for (i = 0; r[i] != NULL; ++i)\n";
5556 pr " free (r[i]);\n";
5558 | RStruct (_, typ) ->
5559 pr " guestfs_free_%s (r);\n" typ
5560 | RStructList (_, typ) ->
5561 pr " guestfs_free_%s_list (r);\n" typ
5567 let str = replace_str str "\r" "\\r" in
5568 let str = replace_str str "\n" "\\n" in
5569 let str = replace_str str "\t" "\\t" in
5570 let str = replace_str str "\000" "\\0" in
5573 (* Generate a lot of different functions for guestfish. *)
5574 and generate_fish_cmds () =
5575 generate_header CStyle GPLv2;
5579 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5581 let all_functions_sorted =
5583 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5584 ) all_functions_sorted in
5586 pr "#include <stdio.h>\n";
5587 pr "#include <stdlib.h>\n";
5588 pr "#include <string.h>\n";
5589 pr "#include <inttypes.h>\n";
5590 pr "#include <ctype.h>\n";
5592 pr "#include <guestfs.h>\n";
5593 pr "#include \"fish.h\"\n";
5596 (* list_commands function, which implements guestfish -h *)
5597 pr "void list_commands (void)\n";
5599 pr " printf (\" %%-16s %%s\\n\", _(\"Command\"), _(\"Description\"));\n";
5600 pr " list_builtin_commands ();\n";
5602 fun (name, _, _, flags, _, shortdesc, _) ->
5603 let name = replace_char name '_' '-' in
5604 pr " printf (\"%%-20s %%s\\n\", \"%s\", _(\"%s\"));\n"
5606 ) all_functions_sorted;
5607 pr " printf (\" %%s\\n\",";
5608 pr " _(\"Use -h <cmd> / help <cmd> to show detailed help for a command.\"));\n";
5612 (* display_command function, which implements guestfish -h cmd *)
5613 pr "void display_command (const char *cmd)\n";
5616 fun (name, style, _, flags, _, shortdesc, longdesc) ->
5617 let name2 = replace_char name '_' '-' in
5619 try find_map (function FishAlias n -> Some n | _ -> None) flags
5620 with Not_found -> name in
5621 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
5623 match snd style with
5627 name2 (String.concat "> <" (List.map name_of_argt args)) in
5630 if List.mem ProtocolLimitWarning flags then
5631 ("\n\n" ^ protocol_limit_warning)
5634 (* For DangerWillRobinson commands, we should probably have
5635 * guestfish prompt before allowing you to use them (especially
5636 * in interactive mode). XXX
5640 if List.mem DangerWillRobinson flags then
5641 ("\n\n" ^ danger_will_robinson)
5646 match deprecation_notice flags with
5648 | Some txt -> "\n\n" ^ txt in
5650 let describe_alias =
5651 if name <> alias then
5652 sprintf "\n\nYou can use '%s' as an alias for this command." alias
5656 pr "strcasecmp (cmd, \"%s\") == 0" name;
5657 if name <> name2 then
5658 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
5659 if name <> alias then
5660 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
5662 pr " pod2text (\"%s\", _(\"%s\"), %S);\n"
5664 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
5667 pr " display_builtin_command (cmd);\n";
5671 (* print_* functions *)
5675 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
5677 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
5686 pr " printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
5688 pr " printf (\"%s: \");\n" name;
5689 pr " for (i = 0; i < 32; ++i)\n";
5690 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
5691 pr " printf (\"\\n\");\n"
5693 pr " printf (\"%s: \");\n" name;
5694 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
5695 pr " if (isprint (%s->%s[i]))\n" typ name;
5696 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
5698 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
5699 pr " printf (\"\\n\");\n"
5700 | name, (FUInt64|FBytes) ->
5701 pr " printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
5703 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
5705 pr " printf (\"%s: %%\" PRIu32 \"\\n\", %s->%s);\n" name typ name
5707 pr " printf (\"%s: %%\" PRIi32 \"\\n\", %s->%s);\n" name typ name
5709 pr " printf (\"%s: %%c\\n\", %s->%s);\n" name typ name
5710 | name, FOptPercent ->
5711 pr " if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
5712 typ name name typ name;
5713 pr " else printf (\"%s: \\n\");\n" name
5717 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
5722 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
5723 pr " print_%s (&%ss->val[i]);\n" typ typ;
5728 (* run_<action> actions *)
5730 fun (name, style, _, flags, _, _, _) ->
5731 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
5733 (match fst style with
5736 | RBool _ -> pr " int r;\n"
5737 | RInt64 _ -> pr " int64_t r;\n"
5738 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
5739 | RString _ -> pr " char *r;\n"
5740 | RStringList _ | RHashtable _ -> pr " char **r;\n"
5741 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
5742 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
5745 pr " size_t size;\n";
5752 | FileOut n -> pr " const char *%s;\n" n
5753 | StringList n -> pr " char **%s;\n" n
5754 | Bool n -> pr " int %s;\n" n
5755 | Int n -> pr " int %s;\n" n
5758 (* Check and convert parameters. *)
5759 let argc_expected = List.length (snd style) in
5760 pr " if (argc != %d) {\n" argc_expected;
5761 pr " fprintf (stderr, _(\"%%s should have %%d parameter(s)\\n\"), cmd, %d);\n"
5763 pr " fprintf (stderr, _(\"type 'help %%s' for help on %%s\\n\"), cmd, cmd);\n";
5769 | String name -> pr " %s = argv[%d];\n" name i
5771 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
5774 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
5777 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
5779 | StringList name ->
5780 pr " %s = parse_string_list (argv[%d]);\n" name i
5782 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
5784 pr " %s = atoi (argv[%d]);\n" name i
5787 (* Call C API function. *)
5789 try find_map (function FishAction n -> Some n | _ -> None) flags
5790 with Not_found -> sprintf "guestfs_%s" name in
5792 generate_c_call_args ~handle:"g" style;
5795 (* Check return value for errors and display command results. *)
5796 (match fst style with
5797 | RErr -> pr " return r;\n"
5799 pr " if (r == -1) return -1;\n";
5800 pr " printf (\"%%d\\n\", r);\n";
5803 pr " if (r == -1) return -1;\n";
5804 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
5807 pr " if (r == -1) return -1;\n";
5808 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
5811 pr " if (r == NULL) return -1;\n";
5812 pr " printf (\"%%s\\n\", r);\n";
5814 | RConstOptString _ ->
5815 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
5818 pr " if (r == NULL) return -1;\n";
5819 pr " printf (\"%%s\\n\", r);\n";
5823 pr " if (r == NULL) return -1;\n";
5824 pr " print_strings (r);\n";
5825 pr " free_strings (r);\n";
5827 | RStruct (_, typ) ->
5828 pr " if (r == NULL) return -1;\n";
5829 pr " print_%s (r);\n" typ;
5830 pr " guestfs_free_%s (r);\n" typ;
5832 | RStructList (_, typ) ->
5833 pr " if (r == NULL) return -1;\n";
5834 pr " print_%s_list (r);\n" typ;
5835 pr " guestfs_free_%s_list (r);\n" typ;
5838 pr " if (r == NULL) return -1;\n";
5839 pr " print_table (r);\n";
5840 pr " free_strings (r);\n";
5843 pr " if (r == NULL) return -1;\n";
5844 pr " fwrite (r, size, 1, stdout);\n";
5852 (* run_action function *)
5853 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
5856 fun (name, _, _, flags, _, _, _) ->
5857 let name2 = replace_char name '_' '-' in
5859 try find_map (function FishAlias n -> Some n | _ -> None) flags
5860 with Not_found -> name in
5862 pr "strcasecmp (cmd, \"%s\") == 0" name;
5863 if name <> name2 then
5864 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
5865 if name <> alias then
5866 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
5868 pr " return run_%s (cmd, argc, argv);\n" name;
5872 pr " fprintf (stderr, _(\"%%s: unknown command\\n\"), cmd);\n";
5879 (* Readline completion for guestfish. *)
5880 and generate_fish_completion () =
5881 generate_header CStyle GPLv2;
5885 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5895 #ifdef HAVE_LIBREADLINE
5896 #include <readline/readline.h>
5901 #ifdef HAVE_LIBREADLINE
5903 static const char *const commands[] = {
5904 BUILTIN_COMMANDS_FOR_COMPLETION,
5907 (* Get the commands, including the aliases. They don't need to be
5908 * sorted - the generator() function just does a dumb linear search.
5912 fun (name, _, _, flags, _, _, _) ->
5913 let name2 = replace_char name '_' '-' in
5915 try find_map (function FishAlias n -> Some n | _ -> None) flags
5916 with Not_found -> name in
5918 if name <> alias then [name2; alias] else [name2]
5920 let commands = List.flatten commands in
5922 List.iter (pr " \"%s\",\n") commands;
5928 generator (const char *text, int state)
5930 static int index, len;
5935 len = strlen (text);
5938 rl_attempted_completion_over = 1;
5940 while ((name = commands[index]) != NULL) {
5942 if (strncasecmp (name, text, len) == 0)
5943 return strdup (name);
5949 #endif /* HAVE_LIBREADLINE */
5951 char **do_completion (const char *text, int start, int end)
5953 char **matches = NULL;
5955 #ifdef HAVE_LIBREADLINE
5956 rl_completion_append_character = ' ';
5959 matches = rl_completion_matches (text, generator);
5960 else if (complete_dest_paths)
5961 matches = rl_completion_matches (text, complete_dest_paths_generator);
5968 (* Generate the POD documentation for guestfish. *)
5969 and generate_fish_actions_pod () =
5970 let all_functions_sorted =
5972 fun (_, _, _, flags, _, _, _) ->
5973 not (List.mem NotInFish flags || List.mem NotInDocs flags)
5974 ) all_functions_sorted in
5976 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
5979 fun (name, style, _, flags, _, _, longdesc) ->
5981 Str.global_substitute rex (
5984 try Str.matched_group 1 s
5986 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
5987 "C<" ^ replace_char sub '_' '-' ^ ">"
5989 let name = replace_char name '_' '-' in
5991 try find_map (function FishAlias n -> Some n | _ -> None) flags
5992 with Not_found -> name in
5994 pr "=head2 %s" name;
5995 if name <> alias then
6002 | String n -> pr " %s" n
6003 | OptString n -> pr " %s" n
6004 | StringList n -> pr " '%s ...'" n
6005 | Bool _ -> pr " true|false"
6006 | Int n -> pr " %s" n
6007 | FileIn n | FileOut n -> pr " (%s|-)" n
6011 pr "%s\n\n" longdesc;
6013 if List.exists (function FileIn _ | FileOut _ -> true
6014 | _ -> false) (snd style) then
6015 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
6017 if List.mem ProtocolLimitWarning flags then
6018 pr "%s\n\n" protocol_limit_warning;
6020 if List.mem DangerWillRobinson flags then
6021 pr "%s\n\n" danger_will_robinson;
6023 match deprecation_notice flags with
6025 | Some txt -> pr "%s\n\n" txt
6026 ) all_functions_sorted
6028 (* Generate a C function prototype. *)
6029 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
6030 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
6032 ?handle name style =
6033 if extern then pr "extern ";
6034 if static then pr "static ";
6035 (match fst style with
6037 | RInt _ -> pr "int "
6038 | RInt64 _ -> pr "int64_t "
6039 | RBool _ -> pr "int "
6040 | RConstString _ | RConstOptString _ -> pr "const char *"
6041 | RString _ | RBufferOut _ -> pr "char *"
6042 | RStringList _ | RHashtable _ -> pr "char **"
6043 | RStruct (_, typ) ->
6044 if not in_daemon then pr "struct guestfs_%s *" typ
6045 else pr "guestfs_int_%s *" typ
6046 | RStructList (_, typ) ->
6047 if not in_daemon then pr "struct guestfs_%s_list *" typ
6048 else pr "guestfs_int_%s_list *" typ
6050 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
6051 pr "%s%s (" prefix name;
6052 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
6055 let comma = ref false in
6058 | Some handle -> pr "guestfs_h *%s" handle; comma := true
6062 if single_line then pr ", " else pr ",\n\t\t"
6071 if not in_daemon then pr "const char *%s" n
6072 else pr "char *%s" n
6075 if not in_daemon then pr "char * const* const %s" n
6076 else pr "char **%s" n
6077 | Bool n -> next (); pr "int %s" n
6078 | Int n -> next (); pr "int %s" n
6081 if not in_daemon then (next (); pr "const char *%s" n)
6083 if is_RBufferOut then (next (); pr "size_t *size_r");
6086 if semicolon then pr ";";
6087 if newline then pr "\n"
6089 (* Generate C call arguments, eg "(handle, foo, bar)" *)
6090 and generate_c_call_args ?handle ?(decl = false) style =
6092 let comma = ref false in
6094 if !comma then pr ", ";
6099 | Some handle -> pr "%s" handle; comma := true
6104 pr "%s" (name_of_argt arg)
6106 (* For RBufferOut calls, add implicit &size parameter. *)
6108 match fst style with
6116 (* Generate the OCaml bindings interface. *)
6117 and generate_ocaml_mli () =
6118 generate_header OCamlStyle LGPLv2;
6121 (** For API documentation you should refer to the C API
6122 in the guestfs(3) manual page. The OCaml API uses almost
6123 exactly the same calls. *)
6126 (** A [guestfs_h] handle. *)
6128 exception Error of string
6129 (** This exception is raised when there is an error. *)
6131 val create : unit -> t
6133 val close : t -> unit
6134 (** Handles are closed by the garbage collector when they become
6135 unreferenced, but callers can also call this in order to
6136 provide predictable cleanup. *)
6139 generate_ocaml_structure_decls ();
6143 fun (name, style, _, _, _, shortdesc, _) ->
6144 generate_ocaml_prototype name style;
6145 pr "(** %s *)\n" shortdesc;
6149 (* Generate the OCaml bindings implementation. *)
6150 and generate_ocaml_ml () =
6151 generate_header OCamlStyle LGPLv2;
6155 exception Error of string
6156 external create : unit -> t = \"ocaml_guestfs_create\"
6157 external close : t -> unit = \"ocaml_guestfs_close\"
6160 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
6164 generate_ocaml_structure_decls ();
6168 fun (name, style, _, _, _, shortdesc, _) ->
6169 generate_ocaml_prototype ~is_external:true name style;
6172 (* Generate the OCaml bindings C implementation. *)
6173 and generate_ocaml_c () =
6174 generate_header CStyle LGPLv2;
6181 #include <caml/config.h>
6182 #include <caml/alloc.h>
6183 #include <caml/callback.h>
6184 #include <caml/fail.h>
6185 #include <caml/memory.h>
6186 #include <caml/mlvalues.h>
6187 #include <caml/signals.h>
6189 #include <guestfs.h>
6191 #include \"guestfs_c.h\"
6193 /* Copy a hashtable of string pairs into an assoc-list. We return
6194 * the list in reverse order, but hashtables aren't supposed to be
6197 static CAMLprim value
6198 copy_table (char * const * argv)
6201 CAMLlocal5 (rv, pairv, kv, vv, cons);
6205 for (i = 0; argv[i] != NULL; i += 2) {
6206 kv = caml_copy_string (argv[i]);
6207 vv = caml_copy_string (argv[i+1]);
6208 pairv = caml_alloc (2, 0);
6209 Store_field (pairv, 0, kv);
6210 Store_field (pairv, 1, vv);
6211 cons = caml_alloc (2, 0);
6212 Store_field (cons, 1, rv);
6214 Store_field (cons, 0, pairv);
6222 (* Struct copy functions. *)
6225 let has_optpercent_col =
6226 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
6228 pr "static CAMLprim value\n";
6229 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
6231 pr " CAMLparam0 ();\n";
6232 if has_optpercent_col then
6233 pr " CAMLlocal3 (rv, v, v2);\n"
6235 pr " CAMLlocal2 (rv, v);\n";
6237 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
6242 pr " v = caml_copy_string (%s->%s);\n" typ name
6244 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
6245 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
6248 pr " v = caml_alloc_string (32);\n";
6249 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
6250 | name, (FBytes|FInt64|FUInt64) ->
6251 pr " v = caml_copy_int64 (%s->%s);\n" typ name
6252 | name, (FInt32|FUInt32) ->
6253 pr " v = caml_copy_int32 (%s->%s);\n" typ name
6254 | name, FOptPercent ->
6255 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
6256 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
6257 pr " v = caml_alloc (1, 0);\n";
6258 pr " Store_field (v, 0, v2);\n";
6259 pr " } else /* None */\n";
6260 pr " v = Val_int (0);\n";
6262 pr " v = Val_int (%s->%s);\n" typ name
6264 pr " Store_field (rv, %d, v);\n" i
6266 pr " CAMLreturn (rv);\n";
6270 pr "static CAMLprim value\n";
6271 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n"
6274 pr " CAMLparam0 ();\n";
6275 pr " CAMLlocal2 (rv, v);\n";
6278 pr " if (%ss->len == 0)\n" typ;
6279 pr " CAMLreturn (Atom (0));\n";
6281 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
6282 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
6283 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
6284 pr " caml_modify (&Field (rv, i), v);\n";
6286 pr " CAMLreturn (rv);\n";
6294 fun (name, style, _, _, _, _, _) ->
6296 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
6298 let needs_extra_vs =
6299 match fst style with RConstOptString _ -> true | _ -> false in
6301 pr "CAMLprim value\n";
6302 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
6303 List.iter (pr ", value %s") (List.tl params);
6308 | [p1; p2; p3; p4; p5] ->
6309 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
6310 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
6311 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
6312 pr " CAMLxparam%d (%s);\n"
6313 (List.length rest) (String.concat ", " rest)
6315 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
6317 if not needs_extra_vs then
6318 pr " CAMLlocal1 (rv);\n"
6320 pr " CAMLlocal3 (rv, v, v2);\n";
6323 pr " guestfs_h *g = Guestfs_val (gv);\n";
6324 pr " if (g == NULL)\n";
6325 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
6333 pr " const char *%s = String_val (%sv);\n" n n
6335 pr " const char *%s =\n" n;
6336 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
6339 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
6341 pr " int %s = Bool_val (%sv);\n" n n
6343 pr " int %s = Int_val (%sv);\n" n n
6346 match fst style with
6347 | RErr -> pr " int r;\n"; "-1"
6348 | RInt _ -> pr " int r;\n"; "-1"
6349 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6350 | RBool _ -> pr " int r;\n"; "-1"
6351 | RConstString _ | RConstOptString _ ->
6352 pr " const char *r;\n"; "NULL"
6353 | RString _ -> pr " char *r;\n"; "NULL"
6358 | RStruct (_, typ) ->
6359 pr " struct guestfs_%s *r;\n" typ; "NULL"
6360 | RStructList (_, typ) ->
6361 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
6368 pr " size_t size;\n";
6372 pr " caml_enter_blocking_section ();\n";
6373 pr " r = guestfs_%s " name;
6374 generate_c_call_args ~handle:"g" style;
6376 pr " caml_leave_blocking_section ();\n";
6381 pr " ocaml_guestfs_free_strings (%s);\n" n;
6382 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
6385 pr " if (r == %s)\n" error_code;
6386 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
6389 (match fst style with
6390 | RErr -> pr " rv = Val_unit;\n"
6391 | RInt _ -> pr " rv = Val_int (r);\n"
6393 pr " rv = caml_copy_int64 (r);\n"
6394 | RBool _ -> pr " rv = Val_bool (r);\n"
6396 pr " rv = caml_copy_string (r);\n"
6397 | RConstOptString _ ->
6398 pr " if (r) { /* Some string */\n";
6399 pr " v = caml_alloc (1, 0);\n";
6400 pr " v2 = caml_copy_string (r);\n";
6401 pr " Store_field (v, 0, v2);\n";
6402 pr " } else /* None */\n";
6403 pr " v = Val_int (0);\n";
6405 pr " rv = caml_copy_string (r);\n";
6408 pr " rv = caml_copy_string_array ((const char **) r);\n";
6409 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
6411 | RStruct (_, typ) ->
6412 pr " rv = copy_%s (r);\n" typ;
6413 pr " guestfs_free_%s (r);\n" typ;
6414 | RStructList (_, typ) ->
6415 pr " rv = copy_%s_list (r);\n" typ;
6416 pr " guestfs_free_%s_list (r);\n" typ;
6418 pr " rv = copy_table (r);\n";
6419 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
6422 pr " rv = caml_alloc_string (size);\n";
6423 pr " memcpy (String_val (rv), r, size);\n";
6426 pr " CAMLreturn (rv);\n";
6430 if List.length params > 5 then (
6431 pr "CAMLprim value\n";
6432 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
6434 pr " return ocaml_guestfs_%s (argv[0]" name;
6435 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
6442 and generate_ocaml_structure_decls () =
6445 pr "type %s = {\n" typ;
6448 | name, FString -> pr " %s : string;\n" name
6449 | name, FBuffer -> pr " %s : string;\n" name
6450 | name, FUUID -> pr " %s : string;\n" name
6451 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
6452 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
6453 | name, FChar -> pr " %s : char;\n" name
6454 | name, FOptPercent -> pr " %s : float option;\n" name
6460 and generate_ocaml_prototype ?(is_external = false) name style =
6461 if is_external then pr "external " else pr "val ";
6462 pr "%s : t -> " name;
6465 | String _ | FileIn _ | FileOut _ -> pr "string -> "
6466 | OptString _ -> pr "string option -> "
6467 | StringList _ -> pr "string array -> "
6468 | Bool _ -> pr "bool -> "
6469 | Int _ -> pr "int -> "
6471 (match fst style with
6472 | RErr -> pr "unit" (* all errors are turned into exceptions *)
6473 | RInt _ -> pr "int"
6474 | RInt64 _ -> pr "int64"
6475 | RBool _ -> pr "bool"
6476 | RConstString _ -> pr "string"
6477 | RConstOptString _ -> pr "string option"
6478 | RString _ | RBufferOut _ -> pr "string"
6479 | RStringList _ -> pr "string array"
6480 | RStruct (_, typ) -> pr "%s" typ
6481 | RStructList (_, typ) -> pr "%s array" typ
6482 | RHashtable _ -> pr "(string * string) list"
6484 if is_external then (
6486 if List.length (snd style) + 1 > 5 then
6487 pr "\"ocaml_guestfs_%s_byte\" " name;
6488 pr "\"ocaml_guestfs_%s\"" name
6492 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
6493 and generate_perl_xs () =
6494 generate_header CStyle LGPLv2;
6497 #include \"EXTERN.h\"
6501 #include <guestfs.h>
6504 #define PRId64 \"lld\"
6508 my_newSVll(long long val) {
6509 #ifdef USE_64_BIT_ALL
6510 return newSViv(val);
6514 len = snprintf(buf, 100, \"%%\" PRId64, val);
6515 return newSVpv(buf, len);
6520 #define PRIu64 \"llu\"
6524 my_newSVull(unsigned long long val) {
6525 #ifdef USE_64_BIT_ALL
6526 return newSVuv(val);
6530 len = snprintf(buf, 100, \"%%\" PRIu64, val);
6531 return newSVpv(buf, len);
6535 /* http://www.perlmonks.org/?node_id=680842 */
6537 XS_unpack_charPtrPtr (SV *arg) {
6542 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
6543 croak (\"array reference expected\");
6545 av = (AV *)SvRV (arg);
6546 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
6548 croak (\"malloc failed\");
6550 for (i = 0; i <= av_len (av); i++) {
6551 SV **elem = av_fetch (av, i, 0);
6553 if (!elem || !*elem)
6554 croak (\"missing element in list\");
6556 ret[i] = SvPV_nolen (*elem);
6564 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
6571 RETVAL = guestfs_create ();
6573 croak (\"could not create guestfs handle\");
6574 guestfs_set_error_handler (RETVAL, NULL, NULL);
6587 fun (name, style, _, _, _, _, _) ->
6588 (match fst style with
6589 | RErr -> pr "void\n"
6590 | RInt _ -> pr "SV *\n"
6591 | RInt64 _ -> pr "SV *\n"
6592 | RBool _ -> pr "SV *\n"
6593 | RConstString _ -> pr "SV *\n"
6594 | RConstOptString _ -> pr "SV *\n"
6595 | RString _ -> pr "SV *\n"
6596 | RBufferOut _ -> pr "SV *\n"
6598 | RStruct _ | RStructList _
6600 pr "void\n" (* all lists returned implictly on the stack *)
6602 (* Call and arguments. *)
6604 generate_c_call_args ~handle:"g" ~decl:true style;
6606 pr " guestfs_h *g;\n";
6610 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
6612 (* http://www.perlmonks.org/?node_id=554277
6613 * Note that the implicit handle argument means we have
6614 * to add 1 to the ST(x) operator.
6616 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
6617 | StringList n -> pr " char **%s;\n" n
6618 | Bool n -> pr " int %s;\n" n
6619 | Int n -> pr " int %s;\n" n
6622 let do_cleanups () =
6625 | String _ | OptString _ | Bool _ | Int _
6626 | FileIn _ | FileOut _ -> ()
6627 | StringList n -> pr " free (%s);\n" n
6632 (match fst style with
6637 pr " r = guestfs_%s " name;
6638 generate_c_call_args ~handle:"g" style;
6641 pr " if (r == -1)\n";
6642 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6648 pr " %s = guestfs_%s " n name;
6649 generate_c_call_args ~handle:"g" style;
6652 pr " if (%s == -1)\n" n;
6653 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6654 pr " RETVAL = newSViv (%s);\n" n;
6659 pr " int64_t %s;\n" n;
6661 pr " %s = guestfs_%s " n name;
6662 generate_c_call_args ~handle:"g" style;
6665 pr " if (%s == -1)\n" n;
6666 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6667 pr " RETVAL = my_newSVll (%s);\n" n;
6672 pr " const char *%s;\n" n;
6674 pr " %s = guestfs_%s " n name;
6675 generate_c_call_args ~handle:"g" style;
6678 pr " if (%s == NULL)\n" n;
6679 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6680 pr " RETVAL = newSVpv (%s, 0);\n" n;
6683 | RConstOptString n ->
6685 pr " const char *%s;\n" n;
6687 pr " %s = guestfs_%s " n name;
6688 generate_c_call_args ~handle:"g" style;
6691 pr " if (%s == NULL)\n" n;
6692 pr " RETVAL = &PL_sv_undef;\n";
6694 pr " RETVAL = newSVpv (%s, 0);\n" n;
6699 pr " char *%s;\n" n;
6701 pr " %s = guestfs_%s " n name;
6702 generate_c_call_args ~handle:"g" style;
6705 pr " if (%s == NULL)\n" n;
6706 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6707 pr " RETVAL = newSVpv (%s, 0);\n" n;
6708 pr " free (%s);\n" n;
6711 | RStringList n | RHashtable n ->
6713 pr " char **%s;\n" n;
6716 pr " %s = guestfs_%s " n name;
6717 generate_c_call_args ~handle:"g" style;
6720 pr " if (%s == NULL)\n" n;
6721 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6722 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
6723 pr " EXTEND (SP, n);\n";
6724 pr " for (i = 0; i < n; ++i) {\n";
6725 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
6726 pr " free (%s[i]);\n" n;
6728 pr " free (%s);\n" n;
6729 | RStruct (n, typ) ->
6730 let cols = cols_of_struct typ in
6731 generate_perl_struct_code typ cols name style n do_cleanups
6732 | RStructList (n, typ) ->
6733 let cols = cols_of_struct typ in
6734 generate_perl_struct_list_code typ cols name style n do_cleanups
6737 pr " char *%s;\n" n;
6738 pr " size_t size;\n";
6740 pr " %s = guestfs_%s " n name;
6741 generate_c_call_args ~handle:"g" style;
6744 pr " if (%s == NULL)\n" n;
6745 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6746 pr " RETVAL = newSVpv (%s, size);\n" n;
6747 pr " free (%s);\n" n;
6755 and generate_perl_struct_list_code typ cols name style n do_cleanups =
6757 pr " struct guestfs_%s_list *%s;\n" typ n;
6761 pr " %s = guestfs_%s " n name;
6762 generate_c_call_args ~handle:"g" style;
6765 pr " if (%s == NULL)\n" n;
6766 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6767 pr " EXTEND (SP, %s->len);\n" n;
6768 pr " for (i = 0; i < %s->len; ++i) {\n" n;
6769 pr " hv = newHV ();\n";
6773 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
6774 name (String.length name) n name
6776 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
6777 name (String.length name) n name
6779 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
6780 name (String.length name) n name n name
6781 | name, (FBytes|FUInt64) ->
6782 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
6783 name (String.length name) n name
6785 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
6786 name (String.length name) n name
6787 | name, (FInt32|FUInt32) ->
6788 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
6789 name (String.length name) n name
6791 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
6792 name (String.length name) n name
6793 | name, FOptPercent ->
6794 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
6795 name (String.length name) n name
6797 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
6799 pr " guestfs_free_%s_list (%s);\n" typ n
6801 and generate_perl_struct_code typ cols name style n do_cleanups =
6803 pr " struct guestfs_%s *%s;\n" typ n;
6805 pr " %s = guestfs_%s " n name;
6806 generate_c_call_args ~handle:"g" style;
6809 pr " if (%s == NULL)\n" n;
6810 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6811 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
6813 fun ((name, _) as col) ->
6814 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
6818 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
6821 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, %s->%s_len)));\n"
6824 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
6826 | name, (FBytes|FUInt64) ->
6827 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
6830 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
6832 | name, (FInt32|FUInt32) ->
6833 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
6836 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
6838 | name, FOptPercent ->
6839 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
6842 pr " free (%s);\n" n
6844 (* Generate Sys/Guestfs.pm. *)
6845 and generate_perl_pm () =
6846 generate_header HashStyle LGPLv2;
6853 Sys::Guestfs - Perl bindings for libguestfs
6859 my $h = Sys::Guestfs->new ();
6860 $h->add_drive ('guest.img');
6863 $h->mount ('/dev/sda1', '/');
6864 $h->touch ('/hello');
6869 The C<Sys::Guestfs> module provides a Perl XS binding to the
6870 libguestfs API for examining and modifying virtual machine
6873 Amongst the things this is good for: making batch configuration
6874 changes to guests, getting disk used/free statistics (see also:
6875 virt-df), migrating between virtualization systems (see also:
6876 virt-p2v), performing partial backups, performing partial guest
6877 clones, cloning guests and changing registry/UUID/hostname info, and
6880 Libguestfs uses Linux kernel and qemu code, and can access any type of
6881 guest filesystem that Linux and qemu can, including but not limited
6882 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
6883 schemes, qcow, qcow2, vmdk.
6885 Libguestfs provides ways to enumerate guest storage (eg. partitions,
6886 LVs, what filesystem is in each LV, etc.). It can also run commands
6887 in the context of the guest. Also you can access filesystems over FTP.
6889 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
6890 functions for using libguestfs from Perl, including integration
6895 All errors turn into calls to C<croak> (see L<Carp(3)>).
6903 package Sys::Guestfs;
6909 XSLoader::load ('Sys::Guestfs');
6911 =item $h = Sys::Guestfs->new ();
6913 Create a new guestfs handle.
6919 my $class = ref ($proto) || $proto;
6921 my $self = Sys::Guestfs::_create ();
6922 bless $self, $class;
6928 (* Actions. We only need to print documentation for these as
6929 * they are pulled in from the XS code automatically.
6932 fun (name, style, _, flags, _, _, longdesc) ->
6933 if not (List.mem NotInDocs flags) then (
6934 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
6936 generate_perl_prototype name style;
6938 pr "%s\n\n" longdesc;
6939 if List.mem ProtocolLimitWarning flags then
6940 pr "%s\n\n" protocol_limit_warning;
6941 if List.mem DangerWillRobinson flags then
6942 pr "%s\n\n" danger_will_robinson;
6943 match deprecation_notice flags with
6945 | Some txt -> pr "%s\n\n" txt
6947 ) all_functions_sorted;
6959 Copyright (C) 2009 Red Hat Inc.
6963 Please see the file COPYING.LIB for the full license.
6969 L<http://libguestfs.org>,
6970 L<Sys::Guestfs::Lib(3)>.
6975 and generate_perl_prototype name style =
6976 (match fst style with
6984 | RBufferOut n -> pr "$%s = " n
6986 | RHashtable n -> pr "%%%s = " n
6988 | RStructList (n,_) -> pr "@%s = " n
6991 let comma = ref false in
6994 if !comma then pr ", ";
6997 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
7004 (* Generate Python C module. *)
7005 and generate_python_c () =
7006 generate_header CStyle LGPLv2;
7015 #include \"guestfs.h\"
7023 get_handle (PyObject *obj)
7026 assert (obj != Py_None);
7027 return ((Pyguestfs_Object *) obj)->g;
7031 put_handle (guestfs_h *g)
7035 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
7038 /* This list should be freed (but not the strings) after use. */
7039 static const char **
7040 get_string_list (PyObject *obj)
7047 if (!PyList_Check (obj)) {
7048 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
7052 len = PyList_Size (obj);
7053 r = malloc (sizeof (char *) * (len+1));
7055 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
7059 for (i = 0; i < len; ++i)
7060 r[i] = PyString_AsString (PyList_GetItem (obj, i));
7067 put_string_list (char * const * const argv)
7072 for (argc = 0; argv[argc] != NULL; ++argc)
7075 list = PyList_New (argc);
7076 for (i = 0; i < argc; ++i)
7077 PyList_SetItem (list, i, PyString_FromString (argv[i]));
7083 put_table (char * const * const argv)
7085 PyObject *list, *item;
7088 for (argc = 0; argv[argc] != NULL; ++argc)
7091 list = PyList_New (argc >> 1);
7092 for (i = 0; i < argc; i += 2) {
7093 item = PyTuple_New (2);
7094 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
7095 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
7096 PyList_SetItem (list, i >> 1, item);
7103 free_strings (char **argv)
7107 for (argc = 0; argv[argc] != NULL; ++argc)
7113 py_guestfs_create (PyObject *self, PyObject *args)
7117 g = guestfs_create ();
7119 PyErr_SetString (PyExc_RuntimeError,
7120 \"guestfs.create: failed to allocate handle\");
7123 guestfs_set_error_handler (g, NULL, NULL);
7124 return put_handle (g);
7128 py_guestfs_close (PyObject *self, PyObject *args)
7133 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
7135 g = get_handle (py_g);
7139 Py_INCREF (Py_None);
7145 (* Structures, turned into Python dictionaries. *)
7148 pr "static PyObject *\n";
7149 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
7151 pr " PyObject *dict;\n";
7153 pr " dict = PyDict_New ();\n";
7157 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7158 pr " PyString_FromString (%s->%s));\n"
7161 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7162 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
7165 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7166 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
7168 | name, (FBytes|FUInt64) ->
7169 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7170 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
7173 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7174 pr " PyLong_FromLongLong (%s->%s));\n"
7177 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7178 pr " PyLong_FromUnsignedLong (%s->%s));\n"
7181 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7182 pr " PyLong_FromLong (%s->%s));\n"
7184 | name, FOptPercent ->
7185 pr " if (%s->%s >= 0)\n" typ name;
7186 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7187 pr " PyFloat_FromDouble ((double) %s->%s));\n"
7190 pr " Py_INCREF (Py_None);\n";
7191 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
7194 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7195 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
7197 pr " return dict;\n";
7201 pr "static PyObject *\n";
7202 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
7204 pr " PyObject *list;\n";
7207 pr " list = PyList_New (%ss->len);\n" typ;
7208 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
7209 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
7210 pr " return list;\n";
7215 (* Python wrapper functions. *)
7217 fun (name, style, _, _, _, _, _) ->
7218 pr "static PyObject *\n";
7219 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
7222 pr " PyObject *py_g;\n";
7223 pr " guestfs_h *g;\n";
7224 pr " PyObject *py_r;\n";
7227 match fst style with
7228 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7229 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7230 | RConstString _ | RConstOptString _ ->
7231 pr " const char *r;\n"; "NULL"
7232 | RString _ -> pr " char *r;\n"; "NULL"
7233 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
7234 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
7235 | RStructList (_, typ) ->
7236 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7239 pr " size_t size;\n";
7244 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
7245 | OptString n -> pr " const char *%s;\n" n
7247 pr " PyObject *py_%s;\n" n;
7248 pr " const char **%s;\n" n
7249 | Bool n -> pr " int %s;\n" n
7250 | Int n -> pr " int %s;\n" n
7255 (* Convert the parameters. *)
7256 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
7259 | String _ | FileIn _ | FileOut _ -> pr "s"
7260 | OptString _ -> pr "z"
7261 | StringList _ -> pr "O"
7262 | Bool _ -> pr "i" (* XXX Python has booleans? *)
7265 pr ":guestfs_%s\",\n" name;
7269 | String n | FileIn n | FileOut n -> pr ", &%s" n
7270 | OptString n -> pr ", &%s" n
7271 | StringList n -> pr ", &py_%s" n
7272 | Bool n -> pr ", &%s" n
7273 | Int n -> pr ", &%s" n
7277 pr " return NULL;\n";
7279 pr " g = get_handle (py_g);\n";
7282 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
7284 pr " %s = get_string_list (py_%s);\n" n n;
7285 pr " if (!%s) return NULL;\n" n
7290 pr " r = guestfs_%s " name;
7291 generate_c_call_args ~handle:"g" style;
7296 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
7298 pr " free (%s);\n" n
7301 pr " if (r == %s) {\n" error_code;
7302 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
7303 pr " return NULL;\n";
7307 (match fst style with
7309 pr " Py_INCREF (Py_None);\n";
7310 pr " py_r = Py_None;\n"
7312 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
7313 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
7314 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
7315 | RConstOptString _ ->
7317 pr " py_r = PyString_FromString (r);\n";
7319 pr " Py_INCREF (Py_None);\n";
7320 pr " py_r = Py_None;\n";
7323 pr " py_r = PyString_FromString (r);\n";
7326 pr " py_r = put_string_list (r);\n";
7327 pr " free_strings (r);\n"
7328 | RStruct (_, typ) ->
7329 pr " py_r = put_%s (r);\n" typ;
7330 pr " guestfs_free_%s (r);\n" typ
7331 | RStructList (_, typ) ->
7332 pr " py_r = put_%s_list (r);\n" typ;
7333 pr " guestfs_free_%s_list (r);\n" typ
7335 pr " py_r = put_table (r);\n";
7336 pr " free_strings (r);\n"
7338 pr " py_r = PyString_FromStringAndSize (r, size);\n";
7342 pr " return py_r;\n";
7347 (* Table of functions. *)
7348 pr "static PyMethodDef methods[] = {\n";
7349 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
7350 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
7352 fun (name, _, _, _, _, _, _) ->
7353 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
7356 pr " { NULL, NULL, 0, NULL }\n";
7360 (* Init function. *)
7363 initlibguestfsmod (void)
7365 static int initialized = 0;
7367 if (initialized) return;
7368 Py_InitModule ((char *) \"libguestfsmod\", methods);
7373 (* Generate Python module. *)
7374 and generate_python_py () =
7375 generate_header HashStyle LGPLv2;
7378 u\"\"\"Python bindings for libguestfs
7381 g = guestfs.GuestFS ()
7382 g.add_drive (\"guest.img\")
7385 parts = g.list_partitions ()
7387 The guestfs module provides a Python binding to the libguestfs API
7388 for examining and modifying virtual machine disk images.
7390 Amongst the things this is good for: making batch configuration
7391 changes to guests, getting disk used/free statistics (see also:
7392 virt-df), migrating between virtualization systems (see also:
7393 virt-p2v), performing partial backups, performing partial guest
7394 clones, cloning guests and changing registry/UUID/hostname info, and
7397 Libguestfs uses Linux kernel and qemu code, and can access any type of
7398 guest filesystem that Linux and qemu can, including but not limited
7399 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
7400 schemes, qcow, qcow2, vmdk.
7402 Libguestfs provides ways to enumerate guest storage (eg. partitions,
7403 LVs, what filesystem is in each LV, etc.). It can also run commands
7404 in the context of the guest. Also you can access filesystems over FTP.
7406 Errors which happen while using the API are turned into Python
7407 RuntimeError exceptions.
7409 To create a guestfs handle you usually have to perform the following
7412 # Create the handle, call add_drive at least once, and possibly
7413 # several times if the guest has multiple block devices:
7414 g = guestfs.GuestFS ()
7415 g.add_drive (\"guest.img\")
7417 # Launch the qemu subprocess and wait for it to become ready:
7421 # Now you can issue commands, for example:
7426 import libguestfsmod
7429 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
7431 def __init__ (self):
7432 \"\"\"Create a new libguestfs handle.\"\"\"
7433 self._o = libguestfsmod.create ()
7436 libguestfsmod.close (self._o)
7441 fun (name, style, _, flags, _, _, longdesc) ->
7443 generate_py_call_args ~handle:"self" (snd style);
7446 if not (List.mem NotInDocs flags) then (
7447 let doc = replace_str longdesc "C<guestfs_" "C<g." in
7449 match fst style with
7450 | RErr | RInt _ | RInt64 _ | RBool _
7451 | RConstOptString _ | RConstString _
7452 | RString _ | RBufferOut _ -> doc
7454 doc ^ "\n\nThis function returns a list of strings."
7455 | RStruct (_, typ) ->
7456 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
7457 | RStructList (_, typ) ->
7458 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
7460 doc ^ "\n\nThis function returns a dictionary." in
7462 if List.mem ProtocolLimitWarning flags then
7463 doc ^ "\n\n" ^ protocol_limit_warning
7466 if List.mem DangerWillRobinson flags then
7467 doc ^ "\n\n" ^ danger_will_robinson
7470 match deprecation_notice flags with
7472 | Some txt -> doc ^ "\n\n" ^ txt in
7473 let doc = pod2text ~width:60 name doc in
7474 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
7475 let doc = String.concat "\n " doc in
7476 pr " u\"\"\"%s\"\"\"\n" doc;
7478 pr " return libguestfsmod.%s " name;
7479 generate_py_call_args ~handle:"self._o" (snd style);
7484 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
7485 and generate_py_call_args ~handle args =
7487 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
7490 (* Useful if you need the longdesc POD text as plain text. Returns a
7493 * Because this is very slow (the slowest part of autogeneration),
7494 * we memoize the results.
7496 and pod2text ~width name longdesc =
7497 let key = width, name, longdesc in
7498 try Hashtbl.find pod2text_memo key
7500 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
7501 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
7503 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
7504 let chan = Unix.open_process_in cmd in
7505 let lines = ref [] in
7507 let line = input_line chan in
7508 if i = 1 then (* discard the first line of output *)
7511 let line = triml line in
7512 lines := line :: !lines;
7515 let lines = try loop 1 with End_of_file -> List.rev !lines in
7516 Unix.unlink filename;
7517 (match Unix.close_process_in chan with
7518 | Unix.WEXITED 0 -> ()
7520 failwithf "pod2text: process exited with non-zero status (%d)" i
7521 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
7522 failwithf "pod2text: process signalled or stopped by signal %d" i
7524 Hashtbl.add pod2text_memo key lines;
7525 let chan = open_out pod2text_memo_filename in
7526 output_value chan pod2text_memo;
7530 (* Generate ruby bindings. *)
7531 and generate_ruby_c () =
7532 generate_header CStyle LGPLv2;
7540 #include \"guestfs.h\"
7542 #include \"extconf.h\"
7544 /* For Ruby < 1.9 */
7546 #define RARRAY_LEN(r) (RARRAY((r))->len)
7549 static VALUE m_guestfs; /* guestfs module */
7550 static VALUE c_guestfs; /* guestfs_h handle */
7551 static VALUE e_Error; /* used for all errors */
7553 static void ruby_guestfs_free (void *p)
7556 guestfs_close ((guestfs_h *) p);
7559 static VALUE ruby_guestfs_create (VALUE m)
7563 g = guestfs_create ();
7565 rb_raise (e_Error, \"failed to create guestfs handle\");
7567 /* Don't print error messages to stderr by default. */
7568 guestfs_set_error_handler (g, NULL, NULL);
7570 /* Wrap it, and make sure the close function is called when the
7573 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
7576 static VALUE ruby_guestfs_close (VALUE gv)
7579 Data_Get_Struct (gv, guestfs_h, g);
7581 ruby_guestfs_free (g);
7582 DATA_PTR (gv) = NULL;
7590 fun (name, style, _, _, _, _, _) ->
7591 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
7592 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
7595 pr " guestfs_h *g;\n";
7596 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
7598 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
7604 | String n | FileIn n | FileOut n ->
7605 pr " Check_Type (%sv, T_STRING);\n" n;
7606 pr " const char *%s = StringValueCStr (%sv);\n" n n;
7608 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
7609 pr " \"%s\", \"%s\");\n" n name
7611 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
7613 pr " char **%s;\n" n;
7614 pr " Check_Type (%sv, T_ARRAY);\n" n;
7616 pr " int i, len;\n";
7617 pr " len = RARRAY_LEN (%sv);\n" n;
7618 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
7620 pr " for (i = 0; i < len; ++i) {\n";
7621 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
7622 pr " %s[i] = StringValueCStr (v);\n" n;
7624 pr " %s[len] = NULL;\n" n;
7627 pr " int %s = RTEST (%sv);\n" n n
7629 pr " int %s = NUM2INT (%sv);\n" n n
7634 match fst style with
7635 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7636 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7637 | RConstString _ | RConstOptString _ ->
7638 pr " const char *r;\n"; "NULL"
7639 | RString _ -> pr " char *r;\n"; "NULL"
7640 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
7641 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
7642 | RStructList (_, typ) ->
7643 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7646 pr " size_t size;\n";
7650 pr " r = guestfs_%s " name;
7651 generate_c_call_args ~handle:"g" style;
7656 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
7658 pr " free (%s);\n" n
7661 pr " if (r == %s)\n" error_code;
7662 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
7665 (match fst style with
7667 pr " return Qnil;\n"
7668 | RInt _ | RBool _ ->
7669 pr " return INT2NUM (r);\n"
7671 pr " return ULL2NUM (r);\n"
7673 pr " return rb_str_new2 (r);\n";
7674 | RConstOptString _ ->
7676 pr " return rb_str_new2 (r);\n";
7678 pr " return Qnil;\n";
7680 pr " VALUE rv = rb_str_new2 (r);\n";
7684 pr " int i, len = 0;\n";
7685 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
7686 pr " VALUE rv = rb_ary_new2 (len);\n";
7687 pr " for (i = 0; r[i] != NULL; ++i) {\n";
7688 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
7689 pr " free (r[i]);\n";
7693 | RStruct (_, typ) ->
7694 let cols = cols_of_struct typ in
7695 generate_ruby_struct_code typ cols
7696 | RStructList (_, typ) ->
7697 let cols = cols_of_struct typ in
7698 generate_ruby_struct_list_code typ cols
7700 pr " VALUE rv = rb_hash_new ();\n";
7702 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
7703 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
7704 pr " free (r[i]);\n";
7705 pr " free (r[i+1]);\n";
7710 pr " VALUE rv = rb_str_new (r, size);\n";
7720 /* Initialize the module. */
7721 void Init__guestfs ()
7723 m_guestfs = rb_define_module (\"Guestfs\");
7724 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
7725 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
7727 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
7728 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
7731 (* Define the rest of the methods. *)
7733 fun (name, style, _, _, _, _, _) ->
7734 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
7735 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
7740 (* Ruby code to return a struct. *)
7741 and generate_ruby_struct_code typ cols =
7742 pr " VALUE rv = rb_hash_new ();\n";
7746 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
7748 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
7750 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
7751 | name, (FBytes|FUInt64) ->
7752 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
7754 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
7756 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
7758 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
7759 | name, FOptPercent ->
7760 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
7761 | name, FChar -> (* XXX wrong? *)
7762 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
7764 pr " guestfs_free_%s (r);\n" typ;
7767 (* Ruby code to return a struct list. *)
7768 and generate_ruby_struct_list_code typ cols =
7769 pr " VALUE rv = rb_ary_new2 (r->len);\n";
7771 pr " for (i = 0; i < r->len; ++i) {\n";
7772 pr " VALUE hv = rb_hash_new ();\n";
7776 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
7778 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
7780 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
7781 | name, (FBytes|FUInt64) ->
7782 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
7784 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
7786 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
7788 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
7789 | name, FOptPercent ->
7790 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
7791 | name, FChar -> (* XXX wrong? *)
7792 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
7794 pr " rb_ary_push (rv, hv);\n";
7796 pr " guestfs_free_%s_list (r);\n" typ;
7799 (* Generate Java bindings GuestFS.java file. *)
7800 and generate_java_java () =
7801 generate_header CStyle LGPLv2;
7804 package com.redhat.et.libguestfs;
7806 import java.util.HashMap;
7807 import com.redhat.et.libguestfs.LibGuestFSException;
7808 import com.redhat.et.libguestfs.PV;
7809 import com.redhat.et.libguestfs.VG;
7810 import com.redhat.et.libguestfs.LV;
7811 import com.redhat.et.libguestfs.Stat;
7812 import com.redhat.et.libguestfs.StatVFS;
7813 import com.redhat.et.libguestfs.IntBool;
7814 import com.redhat.et.libguestfs.Dirent;
7817 * The GuestFS object is a libguestfs handle.
7821 public class GuestFS {
7822 // Load the native code.
7824 System.loadLibrary (\"guestfs_jni\");
7828 * The native guestfs_h pointer.
7833 * Create a libguestfs handle.
7835 * @throws LibGuestFSException
7837 public GuestFS () throws LibGuestFSException
7841 private native long _create () throws LibGuestFSException;
7844 * Close a libguestfs handle.
7846 * You can also leave handles to be collected by the garbage
7847 * collector, but this method ensures that the resources used
7848 * by the handle are freed up immediately. If you call any
7849 * other methods after closing the handle, you will get an
7852 * @throws LibGuestFSException
7854 public void close () throws LibGuestFSException
7860 private native void _close (long g) throws LibGuestFSException;
7862 public void finalize () throws LibGuestFSException
7870 fun (name, style, _, flags, _, shortdesc, longdesc) ->
7871 if not (List.mem NotInDocs flags); then (
7872 let doc = replace_str longdesc "C<guestfs_" "C<g." in
7874 if List.mem ProtocolLimitWarning flags then
7875 doc ^ "\n\n" ^ protocol_limit_warning
7878 if List.mem DangerWillRobinson flags then
7879 doc ^ "\n\n" ^ danger_will_robinson
7882 match deprecation_notice flags with
7884 | Some txt -> doc ^ "\n\n" ^ txt in
7885 let doc = pod2text ~width:60 name doc in
7886 let doc = List.map ( (* RHBZ#501883 *)
7889 | nonempty -> nonempty
7891 let doc = String.concat "\n * " doc in
7894 pr " * %s\n" shortdesc;
7897 pr " * @throws LibGuestFSException\n";
7901 generate_java_prototype ~public:true ~semicolon:false name style;
7904 pr " if (g == 0)\n";
7905 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
7908 if fst style <> RErr then pr "return ";
7910 generate_java_call_args ~handle:"g" (snd style);
7914 generate_java_prototype ~privat:true ~native:true name style;
7921 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
7922 and generate_java_call_args ~handle args =
7924 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
7927 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
7928 ?(semicolon=true) name style =
7929 if privat then pr "private ";
7930 if public then pr "public ";
7931 if native then pr "native ";
7934 (match fst style with
7935 | RErr -> pr "void ";
7936 | RInt _ -> pr "int ";
7937 | RInt64 _ -> pr "long ";
7938 | RBool _ -> pr "boolean ";
7939 | RConstString _ | RConstOptString _ | RString _
7940 | RBufferOut _ -> pr "String ";
7941 | RStringList _ -> pr "String[] ";
7942 | RStruct (_, typ) ->
7943 let name = java_name_of_struct typ in
7945 | RStructList (_, typ) ->
7946 let name = java_name_of_struct typ in
7948 | RHashtable _ -> pr "HashMap<String,String> ";
7951 if native then pr "_%s " name else pr "%s " name;
7953 let needs_comma = ref false in
7962 if !needs_comma then pr ", ";
7963 needs_comma := true;
7980 pr " throws LibGuestFSException";
7981 if semicolon then pr ";"
7983 and generate_java_struct jtyp cols =
7984 generate_header CStyle LGPLv2;
7987 package com.redhat.et.libguestfs;
7990 * Libguestfs %s structure.
8002 | name, FBuffer -> pr " public String %s;\n" name
8003 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
8004 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
8005 | name, FChar -> pr " public char %s;\n" name
8006 | name, FOptPercent ->
8007 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
8008 pr " public float %s;\n" name
8013 and generate_java_c () =
8014 generate_header CStyle LGPLv2;
8021 #include \"com_redhat_et_libguestfs_GuestFS.h\"
8022 #include \"guestfs.h\"
8024 /* Note that this function returns. The exception is not thrown
8025 * until after the wrapper function returns.
8028 throw_exception (JNIEnv *env, const char *msg)
8031 cl = (*env)->FindClass (env,
8032 \"com/redhat/et/libguestfs/LibGuestFSException\");
8033 (*env)->ThrowNew (env, cl, msg);
8036 JNIEXPORT jlong JNICALL
8037 Java_com_redhat_et_libguestfs_GuestFS__1create
8038 (JNIEnv *env, jobject obj)
8042 g = guestfs_create ();
8044 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
8047 guestfs_set_error_handler (g, NULL, NULL);
8048 return (jlong) (long) g;
8051 JNIEXPORT void JNICALL
8052 Java_com_redhat_et_libguestfs_GuestFS__1close
8053 (JNIEnv *env, jobject obj, jlong jg)
8055 guestfs_h *g = (guestfs_h *) (long) jg;
8062 fun (name, style, _, _, _, _, _) ->
8064 (match fst style with
8065 | RErr -> pr "void ";
8066 | RInt _ -> pr "jint ";
8067 | RInt64 _ -> pr "jlong ";
8068 | RBool _ -> pr "jboolean ";
8069 | RConstString _ | RConstOptString _ | RString _
8070 | RBufferOut _ -> pr "jstring ";
8071 | RStruct _ | RHashtable _ ->
8073 | RStringList _ | RStructList _ ->
8077 pr "Java_com_redhat_et_libguestfs_GuestFS_";
8078 pr "%s" (replace_str ("_" ^ name) "_" "_1");
8080 pr " (JNIEnv *env, jobject obj, jlong jg";
8087 pr ", jstring j%s" n
8089 pr ", jobjectArray j%s" n
8091 pr ", jboolean j%s" n
8097 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
8098 let error_code, no_ret =
8099 match fst style with
8100 | RErr -> pr " int r;\n"; "-1", ""
8102 | RInt _ -> pr " int r;\n"; "-1", "0"
8103 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
8104 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
8105 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
8107 pr " jstring jr;\n";
8108 pr " char *r;\n"; "NULL", "NULL"
8110 pr " jobjectArray jr;\n";
8113 pr " jstring jstr;\n";
8114 pr " char **r;\n"; "NULL", "NULL"
8115 | RStruct (_, typ) ->
8116 pr " jobject jr;\n";
8118 pr " jfieldID fl;\n";
8119 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
8120 | RStructList (_, typ) ->
8121 pr " jobjectArray jr;\n";
8123 pr " jfieldID fl;\n";
8124 pr " jobject jfl;\n";
8125 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
8126 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
8128 pr " jstring jr;\n";
8130 pr " size_t size;\n";
8138 pr " const char *%s;\n" n
8140 pr " int %s_len;\n" n;
8141 pr " const char **%s;\n" n
8148 (match fst style with
8149 | RStringList _ | RStructList _ -> true
8150 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
8152 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
8153 List.exists (function StringList _ -> true | _ -> false) (snd style) in
8159 (* Get the parameters. *)
8165 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
8167 (* This is completely undocumented, but Java null becomes
8170 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
8172 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
8173 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
8174 pr " for (i = 0; i < %s_len; ++i) {\n" n;
8175 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
8177 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
8179 pr " %s[%s_len] = NULL;\n" n n;
8182 pr " %s = j%s;\n" n n
8185 (* Make the call. *)
8186 pr " r = guestfs_%s " name;
8187 generate_c_call_args ~handle:"g" style;
8190 (* Release the parameters. *)
8196 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
8199 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
8201 pr " for (i = 0; i < %s_len; ++i) {\n" n;
8202 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
8204 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
8206 pr " free (%s);\n" n
8211 (* Check for errors. *)
8212 pr " if (r == %s) {\n" error_code;
8213 pr " throw_exception (env, guestfs_last_error (g));\n";
8214 pr " return %s;\n" no_ret;
8218 (match fst style with
8220 | RInt _ -> pr " return (jint) r;\n"
8221 | RBool _ -> pr " return (jboolean) r;\n"
8222 | RInt64 _ -> pr " return (jlong) r;\n"
8223 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
8224 | RConstOptString _ ->
8225 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
8227 pr " jr = (*env)->NewStringUTF (env, r);\n";
8231 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
8232 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
8233 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
8234 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
8235 pr " for (i = 0; i < r_len; ++i) {\n";
8236 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
8237 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
8238 pr " free (r[i]);\n";
8242 | RStruct (_, typ) ->
8243 let jtyp = java_name_of_struct typ in
8244 let cols = cols_of_struct typ in
8245 generate_java_struct_return typ jtyp cols
8246 | RStructList (_, typ) ->
8247 let jtyp = java_name_of_struct typ in
8248 let cols = cols_of_struct typ in
8249 generate_java_struct_list_return typ jtyp cols
8252 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
8253 pr " return NULL;\n"
8255 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
8264 and generate_java_struct_return typ jtyp cols =
8265 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
8266 pr " jr = (*env)->AllocObject (env, cl);\n";
8270 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8271 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
8274 pr " char s[33];\n";
8275 pr " memcpy (s, r->%s, 32);\n" name;
8277 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8278 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
8282 pr " int len = r->%s_len;\n" name;
8283 pr " char s[len+1];\n";
8284 pr " memcpy (s, r->%s, len);\n" name;
8285 pr " s[len] = 0;\n";
8286 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8287 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
8289 | name, (FBytes|FUInt64|FInt64) ->
8290 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
8291 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
8292 | name, (FUInt32|FInt32) ->
8293 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
8294 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
8295 | name, FOptPercent ->
8296 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
8297 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
8299 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
8300 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
8305 and generate_java_struct_list_return typ jtyp cols =
8306 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
8307 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
8308 pr " for (i = 0; i < r->len; ++i) {\n";
8309 pr " jfl = (*env)->AllocObject (env, cl);\n";
8313 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8314 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
8317 pr " char s[33];\n";
8318 pr " memcpy (s, r->val[i].%s, 32);\n" name;
8320 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8321 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
8325 pr " int len = r->val[i].%s_len;\n" name;
8326 pr " char s[len+1];\n";
8327 pr " memcpy (s, r->val[i].%s, len);\n" name;
8328 pr " s[len] = 0;\n";
8329 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8330 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
8332 | name, (FBytes|FUInt64|FInt64) ->
8333 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
8334 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
8335 | name, (FUInt32|FInt32) ->
8336 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
8337 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
8338 | name, FOptPercent ->
8339 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
8340 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
8342 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
8343 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
8345 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
8347 pr " guestfs_free_%s_list (r);\n" typ;
8350 and generate_haskell_hs () =
8351 generate_header HaskellStyle LGPLv2;
8353 (* XXX We only know how to generate partial FFI for Haskell
8354 * at the moment. Please help out!
8356 let can_generate style =
8360 | RInt64 _, _ -> true
8363 | RConstOptString _, _
8369 | RBufferOut _, _ -> false in
8372 {-# INCLUDE <guestfs.h> #-}
8373 {-# LANGUAGE ForeignFunctionInterface #-}
8378 (* List out the names of the actions we want to export. *)
8380 fun (name, style, _, _, _, _, _) ->
8381 if can_generate style then pr ",\n %s" name
8388 import Foreign.C.Types
8390 import Control.Exception
8391 import Data.Typeable
8393 data GuestfsS = GuestfsS -- represents the opaque C struct
8394 type GuestfsP = Ptr GuestfsS -- guestfs_h *
8395 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
8397 -- XXX define properly later XXX
8401 data IntBool = IntBool
8403 data StatVFS = StatVFS
8404 data Hashtable = Hashtable
8406 foreign import ccall unsafe \"guestfs_create\" c_create
8408 foreign import ccall unsafe \"&guestfs_close\" c_close
8409 :: FunPtr (GuestfsP -> IO ())
8410 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
8411 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
8413 create :: IO GuestfsH
8416 c_set_error_handler p nullPtr nullPtr
8417 h <- newForeignPtr c_close p
8420 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
8421 :: GuestfsP -> IO CString
8423 -- last_error :: GuestfsH -> IO (Maybe String)
8424 -- last_error h = do
8425 -- str <- withForeignPtr h (\\p -> c_last_error p)
8426 -- maybePeek peekCString str
8428 last_error :: GuestfsH -> IO (String)
8430 str <- withForeignPtr h (\\p -> c_last_error p)
8432 then return \"no error\"
8433 else peekCString str
8437 (* Generate wrappers for each foreign function. *)
8439 fun (name, style, _, _, _, _, _) ->
8440 if can_generate style then (
8441 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
8443 generate_haskell_prototype ~handle:"GuestfsP" style;
8447 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
8449 pr "%s %s = do\n" name
8450 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
8452 (* Convert pointer arguments using with* functions. *)
8457 | String n -> pr "withCString %s $ \\%s -> " n n
8458 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
8459 | StringList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
8460 | Bool _ | Int _ -> ()
8462 (* Convert integer arguments. *)
8466 | Bool n -> sprintf "(fromBool %s)" n
8467 | Int n -> sprintf "(fromIntegral %s)" n
8468 | FileIn n | FileOut n | String n | OptString n | StringList n -> n
8470 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
8471 (String.concat " " ("p" :: args));
8472 (match fst style with
8473 | RErr | RInt _ | RInt64 _ | RBool _ ->
8474 pr " if (r == -1)\n";
8476 pr " err <- last_error h\n";
8478 | RConstString _ | RConstOptString _ | RString _
8479 | RStringList _ | RStruct _
8480 | RStructList _ | RHashtable _ | RBufferOut _ ->
8481 pr " if (r == nullPtr)\n";
8483 pr " err <- last_error h\n";
8486 (match fst style with
8488 pr " else return ()\n"
8490 pr " else return (fromIntegral r)\n"
8492 pr " else return (fromIntegral r)\n"
8494 pr " else return (toBool r)\n"
8503 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
8509 and generate_haskell_prototype ~handle ?(hs = false) style =
8511 let string = if hs then "String" else "CString" in
8512 let int = if hs then "Int" else "CInt" in
8513 let bool = if hs then "Bool" else "CInt" in
8514 let int64 = if hs then "Integer" else "Int64" in
8518 | String _ -> pr "%s" string
8519 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
8520 | StringList _ -> if hs then pr "[String]" else pr "Ptr CString"
8521 | Bool _ -> pr "%s" bool
8522 | Int _ -> pr "%s" int
8523 | FileIn _ -> pr "%s" string
8524 | FileOut _ -> pr "%s" string
8529 (match fst style with
8530 | RErr -> if not hs then pr "CInt"
8531 | RInt _ -> pr "%s" int
8532 | RInt64 _ -> pr "%s" int64
8533 | RBool _ -> pr "%s" bool
8534 | RConstString _ -> pr "%s" string
8535 | RConstOptString _ -> pr "Maybe %s" string
8536 | RString _ -> pr "%s" string
8537 | RStringList _ -> pr "[%s]" string
8538 | RStruct (_, typ) ->
8539 let name = java_name_of_struct typ in
8541 | RStructList (_, typ) ->
8542 let name = java_name_of_struct typ in
8544 | RHashtable _ -> pr "Hashtable"
8545 | RBufferOut _ -> pr "%s" string
8549 and generate_bindtests () =
8550 generate_header CStyle LGPLv2;
8555 #include <inttypes.h>
8558 #include \"guestfs.h\"
8559 #include \"guestfs_protocol.h\"
8561 #define error guestfs_error
8562 #define safe_calloc guestfs_safe_calloc
8563 #define safe_malloc guestfs_safe_malloc
8566 print_strings (char * const* const argv)
8571 for (argc = 0; argv[argc] != NULL; ++argc) {
8572 if (argc > 0) printf (\", \");
8573 printf (\"\\\"%%s\\\"\", argv[argc]);
8578 /* The test0 function prints its parameters to stdout. */
8582 match test_functions with
8583 | [] -> assert false
8584 | test0 :: tests -> test0, tests in
8587 let (name, style, _, _, _, _, _) = test0 in
8588 generate_prototype ~extern:false ~semicolon:false ~newline:true
8589 ~handle:"g" ~prefix:"guestfs_" name style;
8595 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
8596 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
8597 | StringList n -> pr " print_strings (%s);\n" n
8598 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
8599 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
8601 pr " /* Java changes stdout line buffering so we need this: */\n";
8602 pr " fflush (stdout);\n";
8608 fun (name, style, _, _, _, _, _) ->
8609 if String.sub name (String.length name - 3) 3 <> "err" then (
8610 pr "/* Test normal return. */\n";
8611 generate_prototype ~extern:false ~semicolon:false ~newline:true
8612 ~handle:"g" ~prefix:"guestfs_" name style;
8614 (match fst style with
8619 pr " sscanf (val, \"%%d\", &r);\n";
8623 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
8626 pr " return strcmp (val, \"true\") == 0;\n"
8628 | RConstOptString _ ->
8629 (* Can't return the input string here. Return a static
8630 * string so we ensure we get a segfault if the caller
8633 pr " return \"static string\";\n"
8635 pr " return strdup (val);\n"
8637 pr " char **strs;\n";
8639 pr " sscanf (val, \"%%d\", &n);\n";
8640 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
8641 pr " for (i = 0; i < n; ++i) {\n";
8642 pr " strs[i] = safe_malloc (g, 16);\n";
8643 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
8645 pr " strs[n] = NULL;\n";
8646 pr " return strs;\n"
8647 | RStruct (_, typ) ->
8648 pr " struct guestfs_%s *r;\n" typ;
8649 pr " r = safe_calloc (g, sizeof *r, 1);\n";
8651 | RStructList (_, typ) ->
8652 pr " struct guestfs_%s_list *r;\n" typ;
8653 pr " r = safe_calloc (g, sizeof *r, 1);\n";
8654 pr " sscanf (val, \"%%d\", &r->len);\n";
8655 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
8658 pr " char **strs;\n";
8660 pr " sscanf (val, \"%%d\", &n);\n";
8661 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
8662 pr " for (i = 0; i < n; ++i) {\n";
8663 pr " strs[i*2] = safe_malloc (g, 16);\n";
8664 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
8665 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
8666 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
8668 pr " strs[n*2] = NULL;\n";
8669 pr " return strs;\n"
8671 pr " return strdup (val);\n"
8676 pr "/* Test error return. */\n";
8677 generate_prototype ~extern:false ~semicolon:false ~newline:true
8678 ~handle:"g" ~prefix:"guestfs_" name style;
8680 pr " error (g, \"error\");\n";
8681 (match fst style with
8682 | RErr | RInt _ | RInt64 _ | RBool _ ->
8684 | RConstString _ | RConstOptString _
8685 | RString _ | RStringList _ | RStruct _
8689 pr " return NULL;\n"
8696 and generate_ocaml_bindtests () =
8697 generate_header OCamlStyle GPLv2;
8701 let g = Guestfs.create () in
8708 | CallString s -> "\"" ^ s ^ "\""
8709 | CallOptString None -> "None"
8710 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
8711 | CallStringList xs ->
8712 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
8713 | CallInt i when i >= 0 -> string_of_int i
8714 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
8715 | CallBool b -> string_of_bool b
8720 generate_lang_bindtests (
8721 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
8724 pr "print_endline \"EOF\"\n"
8726 and generate_perl_bindtests () =
8727 pr "#!/usr/bin/perl -w\n";
8728 generate_header HashStyle GPLv2;
8735 my $g = Sys::Guestfs->new ();
8739 String.concat ", " (
8742 | CallString s -> "\"" ^ s ^ "\""
8743 | CallOptString None -> "undef"
8744 | CallOptString (Some s) -> sprintf "\"%s\"" s
8745 | CallStringList xs ->
8746 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8747 | CallInt i -> string_of_int i
8748 | CallBool b -> if b then "1" else "0"
8753 generate_lang_bindtests (
8754 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
8757 pr "print \"EOF\\n\"\n"
8759 and generate_python_bindtests () =
8760 generate_header HashStyle GPLv2;
8765 g = guestfs.GuestFS ()
8769 String.concat ", " (
8772 | CallString s -> "\"" ^ s ^ "\""
8773 | CallOptString None -> "None"
8774 | CallOptString (Some s) -> sprintf "\"%s\"" s
8775 | CallStringList xs ->
8776 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8777 | CallInt i -> string_of_int i
8778 | CallBool b -> if b then "1" else "0"
8783 generate_lang_bindtests (
8784 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
8787 pr "print \"EOF\"\n"
8789 and generate_ruby_bindtests () =
8790 generate_header HashStyle GPLv2;
8795 g = Guestfs::create()
8799 String.concat ", " (
8802 | CallString s -> "\"" ^ s ^ "\""
8803 | CallOptString None -> "nil"
8804 | CallOptString (Some s) -> sprintf "\"%s\"" s
8805 | CallStringList xs ->
8806 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8807 | CallInt i -> string_of_int i
8808 | CallBool b -> string_of_bool b
8813 generate_lang_bindtests (
8814 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
8817 pr "print \"EOF\\n\"\n"
8819 and generate_java_bindtests () =
8820 generate_header CStyle GPLv2;
8823 import com.redhat.et.libguestfs.*;
8825 public class Bindtests {
8826 public static void main (String[] argv)
8829 GuestFS g = new GuestFS ();
8833 String.concat ", " (
8836 | CallString s -> "\"" ^ s ^ "\""
8837 | CallOptString None -> "null"
8838 | CallOptString (Some s) -> sprintf "\"%s\"" s
8839 | CallStringList xs ->
8841 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
8842 | CallInt i -> string_of_int i
8843 | CallBool b -> string_of_bool b
8848 generate_lang_bindtests (
8849 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
8853 System.out.println (\"EOF\");
8855 catch (Exception exn) {
8856 System.err.println (exn);
8863 and generate_haskell_bindtests () =
8864 generate_header HaskellStyle GPLv2;
8867 module Bindtests where
8868 import qualified Guestfs
8878 | CallString s -> "\"" ^ s ^ "\""
8879 | CallOptString None -> "Nothing"
8880 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
8881 | CallStringList xs ->
8882 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8883 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
8884 | CallInt i -> string_of_int i
8885 | CallBool true -> "True"
8886 | CallBool false -> "False"
8891 generate_lang_bindtests (
8892 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
8895 pr " putStrLn \"EOF\"\n"
8897 (* Language-independent bindings tests - we do it this way to
8898 * ensure there is parity in testing bindings across all languages.
8900 and generate_lang_bindtests call =
8901 call "test0" [CallString "abc"; CallOptString (Some "def");
8902 CallStringList []; CallBool false;
8903 CallInt 0; CallString "123"; CallString "456"];
8904 call "test0" [CallString "abc"; CallOptString None;
8905 CallStringList []; CallBool false;
8906 CallInt 0; CallString "123"; CallString "456"];
8907 call "test0" [CallString ""; CallOptString (Some "def");
8908 CallStringList []; CallBool false;
8909 CallInt 0; CallString "123"; CallString "456"];
8910 call "test0" [CallString ""; CallOptString (Some "");
8911 CallStringList []; CallBool false;
8912 CallInt 0; CallString "123"; CallString "456"];
8913 call "test0" [CallString "abc"; CallOptString (Some "def");
8914 CallStringList ["1"]; CallBool false;
8915 CallInt 0; CallString "123"; CallString "456"];
8916 call "test0" [CallString "abc"; CallOptString (Some "def");
8917 CallStringList ["1"; "2"]; CallBool false;
8918 CallInt 0; CallString "123"; CallString "456"];
8919 call "test0" [CallString "abc"; CallOptString (Some "def");
8920 CallStringList ["1"]; CallBool true;
8921 CallInt 0; CallString "123"; CallString "456"];
8922 call "test0" [CallString "abc"; CallOptString (Some "def");
8923 CallStringList ["1"]; CallBool false;
8924 CallInt (-1); CallString "123"; CallString "456"];
8925 call "test0" [CallString "abc"; CallOptString (Some "def");
8926 CallStringList ["1"]; CallBool false;
8927 CallInt (-2); CallString "123"; CallString "456"];
8928 call "test0" [CallString "abc"; CallOptString (Some "def");
8929 CallStringList ["1"]; CallBool false;
8930 CallInt 1; CallString "123"; CallString "456"];
8931 call "test0" [CallString "abc"; CallOptString (Some "def");
8932 CallStringList ["1"]; CallBool false;
8933 CallInt 2; CallString "123"; CallString "456"];
8934 call "test0" [CallString "abc"; CallOptString (Some "def");
8935 CallStringList ["1"]; CallBool false;
8936 CallInt 4095; CallString "123"; CallString "456"];
8937 call "test0" [CallString "abc"; CallOptString (Some "def");
8938 CallStringList ["1"]; CallBool false;
8939 CallInt 0; CallString ""; CallString ""]
8941 (* XXX Add here tests of the return and error functions. *)
8943 (* This is used to generate the src/MAX_PROC_NR file which
8944 * contains the maximum procedure number, a surrogate for the
8945 * ABI version number. See src/Makefile.am for the details.
8947 and generate_max_proc_nr () =
8948 let proc_nrs = List.map (
8949 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
8950 ) daemon_functions in
8952 let max_proc_nr = List.fold_left max 0 proc_nrs in
8954 pr "%d\n" max_proc_nr
8956 let output_to filename =
8957 let filename_new = filename ^ ".new" in
8958 chan := open_out filename_new;
8963 (* Is the new file different from the current file? *)
8964 if Sys.file_exists filename && files_equal filename filename_new then
8965 Unix.unlink filename_new (* same, so skip it *)
8967 (* different, overwrite old one *)
8968 (try Unix.chmod filename 0o644 with Unix.Unix_error _ -> ());
8969 Unix.rename filename_new filename;
8970 Unix.chmod filename 0o444;
8971 printf "written %s\n%!" filename;
8980 if not (Sys.file_exists "HACKING") then (
8982 You are probably running this from the wrong directory.
8983 Run it from the top source directory using the command
8989 let close = output_to "src/guestfs_protocol.x" in
8993 let close = output_to "src/guestfs-structs.h" in
8994 generate_structs_h ();
8997 let close = output_to "src/guestfs-actions.h" in
8998 generate_actions_h ();
9001 let close = output_to "src/guestfs-actions.c" in
9002 generate_client_actions ();
9005 let close = output_to "daemon/actions.h" in
9006 generate_daemon_actions_h ();
9009 let close = output_to "daemon/stubs.c" in
9010 generate_daemon_actions ();
9013 let close = output_to "daemon/names.c" in
9014 generate_daemon_names ();
9017 let close = output_to "capitests/tests.c" in
9021 let close = output_to "src/guestfs-bindtests.c" in
9022 generate_bindtests ();
9025 let close = output_to "fish/cmds.c" in
9026 generate_fish_cmds ();
9029 let close = output_to "fish/completion.c" in
9030 generate_fish_completion ();
9033 let close = output_to "guestfs-structs.pod" in
9034 generate_structs_pod ();
9037 let close = output_to "guestfs-actions.pod" in
9038 generate_actions_pod ();
9041 let close = output_to "guestfish-actions.pod" in
9042 generate_fish_actions_pod ();
9045 let close = output_to "ocaml/guestfs.mli" in
9046 generate_ocaml_mli ();
9049 let close = output_to "ocaml/guestfs.ml" in
9050 generate_ocaml_ml ();
9053 let close = output_to "ocaml/guestfs_c_actions.c" in
9054 generate_ocaml_c ();
9057 let close = output_to "ocaml/bindtests.ml" in
9058 generate_ocaml_bindtests ();
9061 let close = output_to "perl/Guestfs.xs" in
9062 generate_perl_xs ();
9065 let close = output_to "perl/lib/Sys/Guestfs.pm" in
9066 generate_perl_pm ();
9069 let close = output_to "perl/bindtests.pl" in
9070 generate_perl_bindtests ();
9073 let close = output_to "python/guestfs-py.c" in
9074 generate_python_c ();
9077 let close = output_to "python/guestfs.py" in
9078 generate_python_py ();
9081 let close = output_to "python/bindtests.py" in
9082 generate_python_bindtests ();
9085 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
9089 let close = output_to "ruby/bindtests.rb" in
9090 generate_ruby_bindtests ();
9093 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
9094 generate_java_java ();
9099 let cols = cols_of_struct typ in
9100 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
9101 let close = output_to filename in
9102 generate_java_struct jtyp cols;
9106 let close = output_to "java/Makefile.inc" in
9107 pr "java_built_sources =";
9110 pr " com/redhat/et/libguestfs/%s.java" jtyp;
9112 pr " com/redhat/et/libguestfs/GuestFS.java\n";
9115 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in
9119 let close = output_to "java/Bindtests.java" in
9120 generate_java_bindtests ();
9123 let close = output_to "haskell/Guestfs.hs" in
9124 generate_haskell_hs ();
9127 let close = output_to "haskell/Bindtests.hs" in
9128 generate_haskell_bindtests ();
9131 let close = output_to "src/MAX_PROC_NR" in
9132 generate_max_proc_nr ();
9135 (* Always generate this file last, and unconditionally. It's used
9136 * by the Makefile to know when we must re-run the generator.
9138 let chan = open_out "src/stamp-generator" in