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 must
29 * run generator.ml from your top level build directory. You must also have run
30 * configure before generator.ml will run.
32 * IMPORTANT: This script should NOT print any warnings. If it prints
33 * warnings, you should treat them as errors.
34 * [Need to add -warn-error to ocaml command line]
42 type style = ret * args
44 (* "RErr" as a return value means an int used as a simple error
45 * indication, ie. 0 or -1.
48 (* "RInt" as a return value means an int which is -1 for error
49 * or any value >= 0 on success. Only use this for smallish
50 * 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).
58 (* "RBool" is a bool return value which can be true/false or
62 (* "RConstString" is a string that refers to a constant value.
63 * Try to avoid using this. In particular you cannot use this
64 * for values returned from the daemon, because there is no
65 * thread-safe way to return them in the C API.
67 | RConstString of string
68 (* "RString" and "RStringList" are caller-frees. *)
70 | RStringList of string
71 (* "RStruct" is a function which returns a single named structure
72 * or an error indication (in C, a struct, and in other languages
73 * with varying representations, but usually very efficient). See
74 * after the function list below for the structures.
76 | RStruct of string * string (* name of retval, name of struct *)
77 (* "RStructList" is a function which returns either a list/array
78 * of structures (could be zero-length), or an error indication.
80 | RStructList of string * string (* name of retval, name of struct *)
81 (* Key-value pairs of untyped strings. Turns into a hashtable or
82 * dictionary in languages which support it. DON'T use this as a
83 * general "bucket" for results. Prefer a stronger typed return
84 * value if one is available, or write a custom struct. Don't use
85 * this if the list could potentially be very long, since it is
86 * inefficient. Keys should be unique. NULLs are not permitted.
88 | RHashtable of string
90 (* "RBufferOut" is handled almost exactly like RString, but
91 * it allows the string to contain arbitrary 8 bit data including
92 * ASCII NUL. In the C API this causes an implicit extra parameter
93 * to be added of type <size_t *size_r>. Other programming languages
94 * support strings with arbitrary 8 bit data. At the RPC layer
95 * we have to use the opaque<> type instead of string<>.
97 | RBufferOut of string
100 and args = argt list (* Function parameters, guestfs handle is implicit. *)
102 (* Note in future we should allow a "variable args" parameter as
103 * the final parameter, to allow commands like
104 * chmod mode file [file(s)...]
105 * This is not implemented yet, but many commands (such as chmod)
106 * are currently defined with the argument order keeping this future
107 * possibility in mind.
110 | String of string (* const char *name, cannot be NULL *)
111 | OptString of string (* const char *name, may be NULL *)
112 | StringList of string(* list of strings (each string cannot be NULL) *)
113 | Bool of string (* boolean *)
114 | Int of string (* int (smallish ints, signed, <= 31 bits) *)
115 (* These are treated as filenames (simple string parameters) in
116 * the C API and bindings. But in the RPC protocol, we transfer
117 * the actual file content up to or down from the daemon.
118 * FileIn: local machine -> daemon (in request)
119 * FileOut: daemon -> local machine (in reply)
120 * In guestfish (only), the special name "-" means read from
121 * stdin or write to stdout.
126 (* Opaque buffer which can contain arbitrary 8 bit data.
127 * In the C API, this is expressed as <char *, int> pair.
128 * Most other languages have a string type which can contain
129 * ASCII NUL. We use whatever type is appropriate for each
131 * Buffers are limited by the total message size. To transfer
132 * large blocks of data, use FileIn/FileOut parameters instead.
133 * To return an arbitrary buffer, use RBufferOut.
139 | ProtocolLimitWarning (* display warning about protocol size limits *)
140 | DangerWillRobinson (* flags particularly dangerous commands *)
141 | FishAlias of string (* provide an alias for this cmd in guestfish *)
142 | FishAction of string (* call this function in guestfish *)
143 | NotInFish (* do not export via guestfish *)
144 | NotInDocs (* do not add this function to documentation *)
146 let protocol_limit_warning =
147 "Because of the message protocol, there is a transfer limit
148 of somewhere between 2MB and 4MB. To transfer large files you should use
151 let danger_will_robinson =
152 "B<This command is dangerous. Without careful use you
153 can easily destroy all your data>."
155 (* You can supply zero or as many tests as you want per API call.
157 * Note that the test environment has 3 block devices, of size 500MB,
158 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
159 * a fourth squashfs block device with some known files on it (/dev/sdd).
161 * Note for partitioning purposes, the 500MB device has 1015 cylinders.
162 * Number of cylinders was 63 for IDE emulated disks with precisely
163 * the same size. How exactly this is calculated is a mystery.
165 * The squashfs block device (/dev/sdd) comes from images/test.sqsh.
167 * To be able to run the tests in a reasonable amount of time,
168 * the virtual machine and block devices are reused between tests.
169 * So don't try testing kill_subprocess :-x
171 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
173 * Don't assume anything about the previous contents of the block
174 * devices. Use 'Init*' to create some initial scenarios.
176 * You can add a prerequisite clause to any individual test. This
177 * is a run-time check, which, if it fails, causes the test to be
178 * skipped. Useful if testing a command which might not work on
179 * all variations of libguestfs builds. A test that has prerequisite
180 * of 'Always' is run unconditionally.
182 * In addition, packagers can skip individual tests by setting the
183 * environment variables: eg:
184 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
185 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
187 type tests = (test_init * test_prereq * test) list
189 (* Run the command sequence and just expect nothing to fail. *)
191 (* Run the command sequence and expect the output of the final
192 * command to be the string.
194 | TestOutput of seq * string
195 (* Run the command sequence and expect the output of the final
196 * command to be the list of strings.
198 | TestOutputList of seq * string list
199 (* Run the command sequence and expect the output of the final
200 * command to be the list of block devices (could be either
201 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
202 * character of each string).
204 | TestOutputListOfDevices of seq * string list
205 (* Run the command sequence and expect the output of the final
206 * command to be the integer.
208 | TestOutputInt of seq * int
209 (* Run the command sequence and expect the output of the final
210 * command to be <op> <int>, eg. ">=", "1".
212 | TestOutputIntOp of seq * string * int
213 (* Run the command sequence and expect the output of the final
214 * command to be a true value (!= 0 or != NULL).
216 | TestOutputTrue of seq
217 (* Run the command sequence and expect the output of the final
218 * command to be a false value (== 0 or == NULL, but not an error).
220 | TestOutputFalse of seq
221 (* Run the command sequence and expect the output of the final
222 * command to be a list of the given length (but don't care about
225 | TestOutputLength of seq * int
226 (* Run the command sequence and expect the output of the final
227 * command to be a structure.
229 | TestOutputStruct of seq * test_field_compare list
230 (* Run the command sequence and expect the final command (only)
233 | TestLastFail of seq
235 and test_field_compare =
236 | CompareWithInt of string * int
237 | CompareWithIntOp of string * string * int
238 | CompareWithString of string * string
239 | CompareFieldsIntEq of string * string
240 | CompareFieldsStrEq of string * string
242 (* Test prerequisites. *)
244 (* Test always runs. *)
246 (* Test is currently disabled - eg. it fails, or it tests some
247 * unimplemented feature.
250 (* 'string' is some C code (a function body) that should return
251 * true or false. The test will run if the code returns true.
254 (* As for 'If' but the test runs _unless_ the code returns true. *)
257 (* Some initial scenarios for testing. *)
259 (* Do nothing, block devices could contain random stuff including
260 * LVM PVs, and some filesystems might be mounted. This is usually
264 (* Block devices are empty and no filesystems are mounted. *)
266 (* /dev/sda contains a single partition /dev/sda1, which is formatted
267 * as ext2, empty [except for lost+found] and mounted on /.
268 * /dev/sdb and /dev/sdc may have random content.
273 * /dev/sda1 (is a PV):
274 * /dev/VG/LV (size 8MB):
275 * formatted as ext2, empty [except for lost+found], mounted on /
276 * /dev/sdb and /dev/sdc may have random content.
280 (* Sequence of commands for testing. *)
282 and cmd = string list
284 (* Note about long descriptions: When referring to another
285 * action, use the format C<guestfs_other> (ie. the full name of
286 * the C function). This will be replaced as appropriate in other
289 * Apart from that, long descriptions are just perldoc paragraphs.
292 (* These test functions are used in the language binding tests. *)
294 let test_all_args = [
297 StringList "strlist";
304 let test_all_rets = [
305 (* except for RErr, which is tested thoroughly elsewhere *)
306 "test0rint", RInt "valout";
307 "test0rint64", RInt64 "valout";
308 "test0rbool", RBool "valout";
309 "test0rconststring", RConstString "valout";
310 "test0rstring", RString "valout";
311 "test0rstringlist", RStringList "valout";
312 "test0rstruct", RStruct ("valout", "lvm_pv");
313 "test0rstructlist", RStructList ("valout", "lvm_pv");
314 "test0rhashtable", RHashtable "valout";
317 let test_functions = [
318 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
320 "internal test function - do not use",
322 This is an internal test function which is used to test whether
323 the automatically generated bindings can handle every possible
324 parameter type correctly.
326 It echos the contents of each parameter to stdout.
328 You probably don't want to call this function.");
332 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
334 "internal test function - do not use",
336 This is an internal test function which is used to test whether
337 the automatically generated bindings can handle every possible
338 return type correctly.
340 It converts string C<val> to the return type.
342 You probably don't want to call this function.");
343 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
345 "internal test function - do not use",
347 This is an internal test function which is used to test whether
348 the automatically generated bindings can handle every possible
349 return type correctly.
351 This function always returns an error.
353 You probably don't want to call this function.")]
357 (* non_daemon_functions are any functions which don't get processed
358 * in the daemon, eg. functions for setting and getting local
359 * configuration values.
362 let non_daemon_functions = test_functions @ [
363 ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
365 "launch the qemu subprocess",
367 Internally libguestfs is implemented by running a virtual machine
370 You should call this after configuring the handle
371 (eg. adding drives) but before performing any actions.");
373 ("wait_ready", (RErr, []), -1, [NotInFish],
375 "wait until the qemu subprocess launches",
377 Internally libguestfs is implemented by running a virtual machine
380 You should call this after C<guestfs_launch> to wait for the launch
383 ("kill_subprocess", (RErr, []), -1, [],
385 "kill the qemu subprocess",
387 This kills the qemu subprocess. You should never need to call this.");
389 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
391 "add an image to examine or modify",
393 This function adds a virtual machine disk image C<filename> to the
394 guest. The first time you call this function, the disk appears as IDE
395 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
398 You don't necessarily need to be root when using libguestfs. However
399 you obviously do need sufficient permissions to access the filename
400 for whatever operations you want to perform (ie. read access if you
401 just want to read the image or write access if you want to modify the
404 This is equivalent to the qemu parameter
405 C<-drive file=filename,cache=off,if=...>.
407 Note that this call checks for the existence of C<filename>. This
408 stops you from specifying other types of drive which are supported
409 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
410 the general C<guestfs_config> call instead.");
412 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
414 "add a CD-ROM disk image to examine",
416 This function adds a virtual CD-ROM disk image to the guest.
418 This is equivalent to the qemu parameter C<-cdrom filename>.
420 Note that this call checks for the existence of C<filename>. This
421 stops you from specifying other types of drive which are supported
422 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
423 the general C<guestfs_config> call instead.");
425 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
427 "add a drive in snapshot mode (read-only)",
429 This adds a drive in snapshot mode, making it effectively
432 Note that writes to the device are allowed, and will be seen for
433 the duration of the guestfs handle, but they are written
434 to a temporary file which is discarded as soon as the guestfs
435 handle is closed. We don't currently have any method to enable
436 changes to be committed, although qemu can support this.
438 This is equivalent to the qemu parameter
439 C<-drive file=filename,snapshot=on,if=...>.
441 Note that this call checks for the existence of C<filename>. This
442 stops you from specifying other types of drive which are supported
443 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
444 the general C<guestfs_config> call instead.");
446 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
448 "add qemu parameters",
450 This can be used to add arbitrary qemu command line parameters
451 of the form C<-param value>. Actually it's not quite arbitrary - we
452 prevent you from setting some parameters which would interfere with
453 parameters that we use.
455 The first character of C<param> string must be a C<-> (dash).
457 C<value> can be NULL.");
459 ("set_qemu", (RErr, [String "qemu"]), -1, [FishAlias "qemu"],
461 "set the qemu binary",
463 Set the qemu binary that we will use.
465 The default is chosen when the library was compiled by the
468 You can also override this by setting the C<LIBGUESTFS_QEMU>
469 environment variable.
471 Setting C<qemu> to C<NULL> restores the default qemu binary.");
473 ("get_qemu", (RConstString "qemu", []), -1, [],
474 [InitNone, Always, TestRun (
476 "get the qemu binary",
478 Return the current qemu binary.
480 This is always non-NULL. If it wasn't set already, then this will
481 return the default qemu binary name.");
483 ("set_path", (RErr, [String "path"]), -1, [FishAlias "path"],
485 "set the search path",
487 Set the path that libguestfs searches for kernel and initrd.img.
489 The default is C<$libdir/guestfs> unless overridden by setting
490 C<LIBGUESTFS_PATH> environment variable.
492 Setting C<path> to C<NULL> restores the default path.");
494 ("get_path", (RConstString "path", []), -1, [],
495 [InitNone, Always, TestRun (
497 "get the search path",
499 Return the current search path.
501 This is always non-NULL. If it wasn't set already, then this will
502 return the default path.");
504 ("set_append", (RErr, [String "append"]), -1, [FishAlias "append"],
506 "add options to kernel command line",
508 This function is used to add additional options to the
509 guest kernel command line.
511 The default is C<NULL> unless overridden by setting
512 C<LIBGUESTFS_APPEND> environment variable.
514 Setting C<append> to C<NULL> means I<no> additional options
515 are passed (libguestfs always adds a few of its own).");
517 ("get_append", (RConstString "append", []), -1, [],
518 (* This cannot be tested with the current framework. The
519 * function can return NULL in normal operations, which the
520 * test framework interprets as an error.
523 "get the additional kernel options",
525 Return the additional kernel options which are added to the
526 guest kernel command line.
528 If C<NULL> then no options are added.");
530 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
534 If C<autosync> is true, this enables autosync. Libguestfs will make a
535 best effort attempt to run C<guestfs_umount_all> followed by
536 C<guestfs_sync> when the handle is closed
537 (also if the program exits without closing handles).
539 This is disabled by default (except in guestfish where it is
540 enabled by default).");
542 ("get_autosync", (RBool "autosync", []), -1, [],
543 [InitNone, Always, TestRun (
544 [["get_autosync"]])],
547 Get the autosync flag.");
549 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
553 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
555 Verbose messages are disabled unless the environment variable
556 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
558 ("get_verbose", (RBool "verbose", []), -1, [],
562 This returns the verbose messages flag.");
564 ("is_ready", (RBool "ready", []), -1, [],
565 [InitNone, Always, TestOutputTrue (
567 "is ready to accept commands",
569 This returns true iff this handle is ready to accept commands
570 (in the C<READY> state).
572 For more information on states, see L<guestfs(3)>.");
574 ("is_config", (RBool "config", []), -1, [],
575 [InitNone, Always, TestOutputFalse (
577 "is in configuration state",
579 This returns true iff this handle is being configured
580 (in the C<CONFIG> state).
582 For more information on states, see L<guestfs(3)>.");
584 ("is_launching", (RBool "launching", []), -1, [],
585 [InitNone, Always, TestOutputFalse (
586 [["is_launching"]])],
587 "is launching subprocess",
589 This returns true iff this handle is launching the subprocess
590 (in the C<LAUNCHING> state).
592 For more information on states, see L<guestfs(3)>.");
594 ("is_busy", (RBool "busy", []), -1, [],
595 [InitNone, Always, TestOutputFalse (
597 "is busy processing a command",
599 This returns true iff this handle is busy processing a command
600 (in the C<BUSY> state).
602 For more information on states, see L<guestfs(3)>.");
604 ("get_state", (RInt "state", []), -1, [],
606 "get the current state",
608 This returns the current state as an opaque integer. This is
609 only useful for printing debug and internal error messages.
611 For more information on states, see L<guestfs(3)>.");
613 ("set_busy", (RErr, []), -1, [NotInFish],
617 This sets the state to C<BUSY>. This is only used when implementing
618 actions using the low-level API.
620 For more information on states, see L<guestfs(3)>.");
622 ("set_ready", (RErr, []), -1, [NotInFish],
624 "set state to ready",
626 This sets the state to C<READY>. This is only used when implementing
627 actions using the low-level API.
629 For more information on states, see L<guestfs(3)>.");
631 ("end_busy", (RErr, []), -1, [NotInFish],
633 "leave the busy state",
635 This sets the state to C<READY>, or if in C<CONFIG> then it leaves the
636 state as is. This is only used when implementing
637 actions using the low-level API.
639 For more information on states, see L<guestfs(3)>.");
641 ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
642 [InitNone, Always, TestOutputInt (
643 [["set_memsize"; "500"];
644 ["get_memsize"]], 500)],
645 "set memory allocated to the qemu subprocess",
647 This sets the memory size in megabytes allocated to the
648 qemu subprocess. This only has any effect if called before
651 You can also change this by setting the environment
652 variable C<LIBGUESTFS_MEMSIZE> before the handle is
655 For more information on the architecture of libguestfs,
656 see L<guestfs(3)>.");
658 ("get_memsize", (RInt "memsize", []), -1, [],
659 [InitNone, Always, TestOutputIntOp (
660 [["get_memsize"]], ">=", 256)],
661 "get memory allocated to the qemu subprocess",
663 This gets the memory size in megabytes allocated to the
666 If C<guestfs_set_memsize> was not called
667 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
668 then this returns the compiled-in default value for memsize.
670 For more information on the architecture of libguestfs,
671 see L<guestfs(3)>.");
673 ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
674 [InitNone, Always, TestOutputIntOp (
675 [["get_pid"]], ">=", 1)],
676 "get PID of qemu subprocess",
678 Return the process ID of the qemu subprocess. If there is no
679 qemu subprocess, then this will return an error.
681 This is an internal call used for debugging and testing.");
683 ("version", (RStruct ("version", "version"), []), -1, [],
684 [InitNone, Always, TestOutputStruct (
685 [["version"]], [CompareWithInt ("major", 1)])],
686 "get the library version number",
688 Return the libguestfs version number that the program is linked
691 Note that because of dynamic linking this is not necessarily
692 the version of libguestfs that you compiled against. You can
693 compile the program, and then at runtime dynamically link
694 against a completely different C<libguestfs.so> library.
696 This call was added in version C<1.0.58>. In previous
697 versions of libguestfs there was no way to get the version
698 number. From C code you can use ELF weak linking tricks to find out if
699 this symbol exists (if it doesn't, then it's an earlier version).
701 The call returns a structure with four elements. The first
702 three (C<major>, C<minor> and C<release>) are numbers and
703 correspond to the usual version triplet. The fourth element
704 (C<extra>) is a string and is normally empty, but may be
705 used for distro-specific information.
707 To construct the original version string:
708 C<$major.$minor.$release$extra>
710 I<Note:> Don't use this call to test for availability
711 of features. Distro backports makes this unreliable.");
715 (* daemon_functions are any functions which cause some action
716 * to take place in the daemon.
719 let daemon_functions = [
720 ("mount", (RErr, [String "device"; String "mountpoint"]), 1, [],
721 [InitEmpty, Always, TestOutput (
722 [["sfdiskM"; "/dev/sda"; ","];
723 ["mkfs"; "ext2"; "/dev/sda1"];
724 ["mount"; "/dev/sda1"; "/"];
725 ["write_file"; "/new"; "new file contents"; "0"];
726 ["cat"; "/new"]], "new file contents")],
727 "mount a guest disk at a position in the filesystem",
729 Mount a guest disk at a position in the filesystem. Block devices
730 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
731 the guest. If those block devices contain partitions, they will have
732 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
735 The rules are the same as for L<mount(2)>: A filesystem must
736 first be mounted on C</> before others can be mounted. Other
737 filesystems can only be mounted on directories which already
740 The mounted filesystem is writable, if we have sufficient permissions
741 on the underlying device.
743 The filesystem options C<sync> and C<noatime> are set with this
744 call, in order to improve reliability.");
746 ("sync", (RErr, []), 2, [],
747 [ InitEmpty, Always, TestRun [["sync"]]],
748 "sync disks, writes are flushed through to the disk image",
750 This syncs the disk, so that any writes are flushed through to the
751 underlying disk image.
753 You should always call this if you have modified a disk image, before
754 closing the handle.");
756 ("touch", (RErr, [String "path"]), 3, [],
757 [InitBasicFS, Always, TestOutputTrue (
759 ["exists"; "/new"]])],
760 "update file timestamps or create a new file",
762 Touch acts like the L<touch(1)> command. It can be used to
763 update the timestamps on a file, or, if the file does not exist,
764 to create a new zero-length file.");
766 ("cat", (RString "content", [String "path"]), 4, [ProtocolLimitWarning],
767 [InitBasicFS, Always, TestOutput (
768 [["write_file"; "/new"; "new file contents"; "0"];
769 ["cat"; "/new"]], "new file contents")],
770 "list the contents of a file",
772 Return the contents of the file named C<path>.
774 Note that this function cannot correctly handle binary files
775 (specifically, files containing C<\\0> character which is treated
776 as end of string). For those you need to use the C<guestfs_download>
777 function which has a more complex interface.");
779 ("ll", (RString "listing", [String "directory"]), 5, [],
780 [], (* XXX Tricky to test because it depends on the exact format
781 * of the 'ls -l' command, which changes between F10 and F11.
783 "list the files in a directory (long format)",
785 List the files in C<directory> (relative to the root directory,
786 there is no cwd) in the format of 'ls -la'.
788 This command is mostly useful for interactive sessions. It
789 is I<not> intended that you try to parse the output string.");
791 ("ls", (RStringList "listing", [String "directory"]), 6, [],
792 [InitBasicFS, Always, TestOutputList (
795 ["touch"; "/newest"];
796 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
797 "list the files in a directory",
799 List the files in C<directory> (relative to the root directory,
800 there is no cwd). The '.' and '..' entries are not returned, but
801 hidden files are shown.
803 This command is mostly useful for interactive sessions. Programs
804 should probably use C<guestfs_readdir> instead.");
806 ("list_devices", (RStringList "devices", []), 7, [],
807 [InitEmpty, Always, TestOutputListOfDevices (
808 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
809 "list the block devices",
811 List all the block devices.
813 The full block device names are returned, eg. C</dev/sda>");
815 ("list_partitions", (RStringList "partitions", []), 8, [],
816 [InitBasicFS, Always, TestOutputListOfDevices (
817 [["list_partitions"]], ["/dev/sda1"]);
818 InitEmpty, Always, TestOutputListOfDevices (
819 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
820 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
821 "list the partitions",
823 List all the partitions detected on all block devices.
825 The full partition device names are returned, eg. C</dev/sda1>
827 This does not return logical volumes. For that you will need to
828 call C<guestfs_lvs>.");
830 ("pvs", (RStringList "physvols", []), 9, [],
831 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
832 [["pvs"]], ["/dev/sda1"]);
833 InitEmpty, Always, TestOutputListOfDevices (
834 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
835 ["pvcreate"; "/dev/sda1"];
836 ["pvcreate"; "/dev/sda2"];
837 ["pvcreate"; "/dev/sda3"];
838 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
839 "list the LVM physical volumes (PVs)",
841 List all the physical volumes detected. This is the equivalent
842 of the L<pvs(8)> command.
844 This returns a list of just the device names that contain
845 PVs (eg. C</dev/sda2>).
847 See also C<guestfs_pvs_full>.");
849 ("vgs", (RStringList "volgroups", []), 10, [],
850 [InitBasicFSonLVM, Always, TestOutputList (
852 InitEmpty, Always, TestOutputList (
853 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
854 ["pvcreate"; "/dev/sda1"];
855 ["pvcreate"; "/dev/sda2"];
856 ["pvcreate"; "/dev/sda3"];
857 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
858 ["vgcreate"; "VG2"; "/dev/sda3"];
859 ["vgs"]], ["VG1"; "VG2"])],
860 "list the LVM volume groups (VGs)",
862 List all the volumes groups detected. This is the equivalent
863 of the L<vgs(8)> command.
865 This returns a list of just the volume group names that were
866 detected (eg. C<VolGroup00>).
868 See also C<guestfs_vgs_full>.");
870 ("lvs", (RStringList "logvols", []), 11, [],
871 [InitBasicFSonLVM, Always, TestOutputList (
872 [["lvs"]], ["/dev/VG/LV"]);
873 InitEmpty, Always, TestOutputList (
874 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
875 ["pvcreate"; "/dev/sda1"];
876 ["pvcreate"; "/dev/sda2"];
877 ["pvcreate"; "/dev/sda3"];
878 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
879 ["vgcreate"; "VG2"; "/dev/sda3"];
880 ["lvcreate"; "LV1"; "VG1"; "50"];
881 ["lvcreate"; "LV2"; "VG1"; "50"];
882 ["lvcreate"; "LV3"; "VG2"; "50"];
883 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
884 "list the LVM logical volumes (LVs)",
886 List all the logical volumes detected. This is the equivalent
887 of the L<lvs(8)> command.
889 This returns a list of the logical volume device names
890 (eg. C</dev/VolGroup00/LogVol00>).
892 See also C<guestfs_lvs_full>.");
894 ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [],
895 [], (* XXX how to test? *)
896 "list the LVM physical volumes (PVs)",
898 List all the physical volumes detected. This is the equivalent
899 of the L<pvs(8)> command. The \"full\" version includes all fields.");
901 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [],
902 [], (* XXX how to test? *)
903 "list the LVM volume groups (VGs)",
905 List all the volumes groups detected. This is the equivalent
906 of the L<vgs(8)> command. The \"full\" version includes all fields.");
908 ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [],
909 [], (* XXX how to test? *)
910 "list the LVM logical volumes (LVs)",
912 List all the logical volumes detected. This is the equivalent
913 of the L<lvs(8)> command. The \"full\" version includes all fields.");
915 ("read_lines", (RStringList "lines", [String "path"]), 15, [],
916 [InitBasicFS, Always, TestOutputList (
917 [["write_file"; "/new"; "line1\r\nline2\nline3"; "0"];
918 ["read_lines"; "/new"]], ["line1"; "line2"; "line3"]);
919 InitBasicFS, Always, TestOutputList (
920 [["write_file"; "/new"; ""; "0"];
921 ["read_lines"; "/new"]], [])],
922 "read file as lines",
924 Return the contents of the file named C<path>.
926 The file contents are returned as a list of lines. Trailing
927 C<LF> and C<CRLF> character sequences are I<not> returned.
929 Note that this function cannot correctly handle binary files
930 (specifically, files containing C<\\0> character which is treated
931 as end of line). For those you need to use the C<guestfs_read_file>
932 function which has a more complex interface.");
934 ("aug_init", (RErr, [String "root"; Int "flags"]), 16, [],
935 [], (* XXX Augeas code needs tests. *)
936 "create a new Augeas handle",
938 Create a new Augeas handle for editing configuration files.
939 If there was any previous Augeas handle associated with this
940 guestfs session, then it is closed.
942 You must call this before using any other C<guestfs_aug_*>
945 C<root> is the filesystem root. C<root> must not be NULL,
948 The flags are the same as the flags defined in
949 E<lt>augeas.hE<gt>, the logical I<or> of the following
954 =item C<AUG_SAVE_BACKUP> = 1
956 Keep the original file with a C<.augsave> extension.
958 =item C<AUG_SAVE_NEWFILE> = 2
960 Save changes into a file with extension C<.augnew>, and
961 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
963 =item C<AUG_TYPE_CHECK> = 4
965 Typecheck lenses (can be expensive).
967 =item C<AUG_NO_STDINC> = 8
969 Do not use standard load path for modules.
971 =item C<AUG_SAVE_NOOP> = 16
973 Make save a no-op, just record what would have been changed.
975 =item C<AUG_NO_LOAD> = 32
977 Do not load the tree in C<guestfs_aug_init>.
981 To close the handle, you can call C<guestfs_aug_close>.
983 To find out more about Augeas, see L<http://augeas.net/>.");
985 ("aug_close", (RErr, []), 26, [],
986 [], (* XXX Augeas code needs tests. *)
987 "close the current Augeas handle",
989 Close the current Augeas handle and free up any resources
990 used by it. After calling this, you have to call
991 C<guestfs_aug_init> again before you can use any other
994 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [],
995 [], (* XXX Augeas code needs tests. *)
996 "define an Augeas variable",
998 Defines an Augeas variable C<name> whose value is the result
999 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1002 On success this returns the number of nodes in C<expr>, or
1003 C<0> if C<expr> evaluates to something which is not a nodeset.");
1005 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [],
1006 [], (* XXX Augeas code needs tests. *)
1007 "define an Augeas node",
1009 Defines a variable C<name> whose value is the result of
1012 If C<expr> evaluates to an empty nodeset, a node is created,
1013 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1014 C<name> will be the nodeset containing that single node.
1016 On success this returns a pair containing the
1017 number of nodes in the nodeset, and a boolean flag
1018 if a node was created.");
1020 ("aug_get", (RString "val", [String "path"]), 19, [],
1021 [], (* XXX Augeas code needs tests. *)
1022 "look up the value of an Augeas path",
1024 Look up the value associated with C<path>. If C<path>
1025 matches exactly one node, the C<value> is returned.");
1027 ("aug_set", (RErr, [String "path"; String "val"]), 20, [],
1028 [], (* XXX Augeas code needs tests. *)
1029 "set Augeas path to value",
1031 Set the value associated with C<path> to C<value>.");
1033 ("aug_insert", (RErr, [String "path"; String "label"; Bool "before"]), 21, [],
1034 [], (* XXX Augeas code needs tests. *)
1035 "insert a sibling Augeas node",
1037 Create a new sibling C<label> for C<path>, inserting it into
1038 the tree before or after C<path> (depending on the boolean
1041 C<path> must match exactly one existing node in the tree, and
1042 C<label> must be a label, ie. not contain C</>, C<*> or end
1043 with a bracketed index C<[N]>.");
1045 ("aug_rm", (RInt "nrnodes", [String "path"]), 22, [],
1046 [], (* XXX Augeas code needs tests. *)
1047 "remove an Augeas path",
1049 Remove C<path> and all of its children.
1051 On success this returns the number of entries which were removed.");
1053 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [],
1054 [], (* XXX Augeas code needs tests. *)
1057 Move the node C<src> to C<dest>. C<src> must match exactly
1058 one node. C<dest> is overwritten if it exists.");
1060 ("aug_match", (RStringList "matches", [String "path"]), 24, [],
1061 [], (* XXX Augeas code needs tests. *)
1062 "return Augeas nodes which match path",
1064 Returns a list of paths which match the path expression C<path>.
1065 The returned paths are sufficiently qualified so that they match
1066 exactly one node in the current tree.");
1068 ("aug_save", (RErr, []), 25, [],
1069 [], (* XXX Augeas code needs tests. *)
1070 "write all pending Augeas changes to disk",
1072 This writes all pending changes to disk.
1074 The flags which were passed to C<guestfs_aug_init> affect exactly
1075 how files are saved.");
1077 ("aug_load", (RErr, []), 27, [],
1078 [], (* XXX Augeas code needs tests. *)
1079 "load files into the tree",
1081 Load files into the tree.
1083 See C<aug_load> in the Augeas documentation for the full gory
1086 ("aug_ls", (RStringList "matches", [String "path"]), 28, [],
1087 [], (* XXX Augeas code needs tests. *)
1088 "list Augeas nodes under a path",
1090 This is just a shortcut for listing C<guestfs_aug_match>
1091 C<path/*> and sorting the resulting nodes into alphabetical order.");
1093 ("rm", (RErr, [String "path"]), 29, [],
1094 [InitBasicFS, Always, TestRun
1097 InitBasicFS, Always, TestLastFail
1099 InitBasicFS, Always, TestLastFail
1104 Remove the single file C<path>.");
1106 ("rmdir", (RErr, [String "path"]), 30, [],
1107 [InitBasicFS, Always, TestRun
1110 InitBasicFS, Always, TestLastFail
1111 [["rmdir"; "/new"]];
1112 InitBasicFS, Always, TestLastFail
1114 ["rmdir"; "/new"]]],
1115 "remove a directory",
1117 Remove the single directory C<path>.");
1119 ("rm_rf", (RErr, [String "path"]), 31, [],
1120 [InitBasicFS, Always, TestOutputFalse
1122 ["mkdir"; "/new/foo"];
1123 ["touch"; "/new/foo/bar"];
1125 ["exists"; "/new"]]],
1126 "remove a file or directory recursively",
1128 Remove the file or directory C<path>, recursively removing the
1129 contents if its a directory. This is like the C<rm -rf> shell
1132 ("mkdir", (RErr, [String "path"]), 32, [],
1133 [InitBasicFS, Always, TestOutputTrue
1135 ["is_dir"; "/new"]];
1136 InitBasicFS, Always, TestLastFail
1137 [["mkdir"; "/new/foo/bar"]]],
1138 "create a directory",
1140 Create a directory named C<path>.");
1142 ("mkdir_p", (RErr, [String "path"]), 33, [],
1143 [InitBasicFS, Always, TestOutputTrue
1144 [["mkdir_p"; "/new/foo/bar"];
1145 ["is_dir"; "/new/foo/bar"]];
1146 InitBasicFS, Always, TestOutputTrue
1147 [["mkdir_p"; "/new/foo/bar"];
1148 ["is_dir"; "/new/foo"]];
1149 InitBasicFS, Always, TestOutputTrue
1150 [["mkdir_p"; "/new/foo/bar"];
1151 ["is_dir"; "/new"]];
1152 (* Regression tests for RHBZ#503133: *)
1153 InitBasicFS, Always, TestRun
1155 ["mkdir_p"; "/new"]];
1156 InitBasicFS, Always, TestLastFail
1158 ["mkdir_p"; "/new"]]],
1159 "create a directory and parents",
1161 Create a directory named C<path>, creating any parent directories
1162 as necessary. This is like the C<mkdir -p> shell command.");
1164 ("chmod", (RErr, [Int "mode"; String "path"]), 34, [],
1165 [], (* XXX Need stat command to test *)
1168 Change the mode (permissions) of C<path> to C<mode>. Only
1169 numeric modes are supported.");
1171 ("chown", (RErr, [Int "owner"; Int "group"; String "path"]), 35, [],
1172 [], (* XXX Need stat command to test *)
1173 "change file owner and group",
1175 Change the file owner to C<owner> and group to C<group>.
1177 Only numeric uid and gid are supported. If you want to use
1178 names, you will need to locate and parse the password file
1179 yourself (Augeas support makes this relatively easy).");
1181 ("exists", (RBool "existsflag", [String "path"]), 36, [],
1182 [InitBasicFS, Always, TestOutputTrue (
1184 ["exists"; "/new"]]);
1185 InitBasicFS, Always, TestOutputTrue (
1187 ["exists"; "/new"]])],
1188 "test if file or directory exists",
1190 This returns C<true> if and only if there is a file, directory
1191 (or anything) with the given C<path> name.
1193 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1195 ("is_file", (RBool "fileflag", [String "path"]), 37, [],
1196 [InitBasicFS, Always, TestOutputTrue (
1198 ["is_file"; "/new"]]);
1199 InitBasicFS, Always, TestOutputFalse (
1201 ["is_file"; "/new"]])],
1202 "test if file exists",
1204 This returns C<true> if and only if there is a file
1205 with the given C<path> name. Note that it returns false for
1206 other objects like directories.
1208 See also C<guestfs_stat>.");
1210 ("is_dir", (RBool "dirflag", [String "path"]), 38, [],
1211 [InitBasicFS, Always, TestOutputFalse (
1213 ["is_dir"; "/new"]]);
1214 InitBasicFS, Always, TestOutputTrue (
1216 ["is_dir"; "/new"]])],
1217 "test if file exists",
1219 This returns C<true> if and only if there is a directory
1220 with the given C<path> name. Note that it returns false for
1221 other objects like files.
1223 See also C<guestfs_stat>.");
1225 ("pvcreate", (RErr, [String "device"]), 39, [],
1226 [InitEmpty, Always, TestOutputListOfDevices (
1227 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1228 ["pvcreate"; "/dev/sda1"];
1229 ["pvcreate"; "/dev/sda2"];
1230 ["pvcreate"; "/dev/sda3"];
1231 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1232 "create an LVM physical volume",
1234 This creates an LVM physical volume on the named C<device>,
1235 where C<device> should usually be a partition name such
1238 ("vgcreate", (RErr, [String "volgroup"; StringList "physvols"]), 40, [],
1239 [InitEmpty, Always, TestOutputList (
1240 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1241 ["pvcreate"; "/dev/sda1"];
1242 ["pvcreate"; "/dev/sda2"];
1243 ["pvcreate"; "/dev/sda3"];
1244 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1245 ["vgcreate"; "VG2"; "/dev/sda3"];
1246 ["vgs"]], ["VG1"; "VG2"])],
1247 "create an LVM volume group",
1249 This creates an LVM volume group called C<volgroup>
1250 from the non-empty list of physical volumes C<physvols>.");
1252 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [],
1253 [InitEmpty, Always, TestOutputList (
1254 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1255 ["pvcreate"; "/dev/sda1"];
1256 ["pvcreate"; "/dev/sda2"];
1257 ["pvcreate"; "/dev/sda3"];
1258 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1259 ["vgcreate"; "VG2"; "/dev/sda3"];
1260 ["lvcreate"; "LV1"; "VG1"; "50"];
1261 ["lvcreate"; "LV2"; "VG1"; "50"];
1262 ["lvcreate"; "LV3"; "VG2"; "50"];
1263 ["lvcreate"; "LV4"; "VG2"; "50"];
1264 ["lvcreate"; "LV5"; "VG2"; "50"];
1266 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1267 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1268 "create an LVM volume group",
1270 This creates an LVM volume group called C<logvol>
1271 on the volume group C<volgroup>, with C<size> megabytes.");
1273 ("mkfs", (RErr, [String "fstype"; String "device"]), 42, [],
1274 [InitEmpty, Always, TestOutput (
1275 [["sfdiskM"; "/dev/sda"; ","];
1276 ["mkfs"; "ext2"; "/dev/sda1"];
1277 ["mount"; "/dev/sda1"; "/"];
1278 ["write_file"; "/new"; "new file contents"; "0"];
1279 ["cat"; "/new"]], "new file contents")],
1280 "make a filesystem",
1282 This creates a filesystem on C<device> (usually a partition
1283 or LVM logical volume). The filesystem type is C<fstype>, for
1286 ("sfdisk", (RErr, [String "device";
1287 Int "cyls"; Int "heads"; Int "sectors";
1288 StringList "lines"]), 43, [DangerWillRobinson],
1290 "create partitions on a block device",
1292 This is a direct interface to the L<sfdisk(8)> program for creating
1293 partitions on block devices.
1295 C<device> should be a block device, for example C</dev/sda>.
1297 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1298 and sectors on the device, which are passed directly to sfdisk as
1299 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1300 of these, then the corresponding parameter is omitted. Usually for
1301 'large' disks, you can just pass C<0> for these, but for small
1302 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1303 out the right geometry and you will need to tell it.
1305 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1306 information refer to the L<sfdisk(8)> manpage.
1308 To create a single partition occupying the whole disk, you would
1309 pass C<lines> as a single element list, when the single element being
1310 the string C<,> (comma).
1312 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>");
1314 ("write_file", (RErr, [String "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1315 [InitBasicFS, Always, TestOutput (
1316 [["write_file"; "/new"; "new file contents"; "0"];
1317 ["cat"; "/new"]], "new file contents");
1318 InitBasicFS, Always, TestOutput (
1319 [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1320 ["cat"; "/new"]], "\nnew file contents\n");
1321 InitBasicFS, Always, TestOutput (
1322 [["write_file"; "/new"; "\n\n"; "0"];
1323 ["cat"; "/new"]], "\n\n");
1324 InitBasicFS, Always, TestOutput (
1325 [["write_file"; "/new"; ""; "0"];
1326 ["cat"; "/new"]], "");
1327 InitBasicFS, Always, TestOutput (
1328 [["write_file"; "/new"; "\n\n\n"; "0"];
1329 ["cat"; "/new"]], "\n\n\n");
1330 InitBasicFS, Always, TestOutput (
1331 [["write_file"; "/new"; "\n"; "0"];
1332 ["cat"; "/new"]], "\n")],
1335 This call creates a file called C<path>. The contents of the
1336 file is the string C<content> (which can contain any 8 bit data),
1337 with length C<size>.
1339 As a special case, if C<size> is C<0>
1340 then the length is calculated using C<strlen> (so in this case
1341 the content cannot contain embedded ASCII NULs).
1343 I<NB.> Owing to a bug, writing content containing ASCII NUL
1344 characters does I<not> work, even if the length is specified.
1345 We hope to resolve this bug in a future version. In the meantime
1346 use C<guestfs_upload>.");
1348 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1349 [InitEmpty, Always, TestOutputListOfDevices (
1350 [["sfdiskM"; "/dev/sda"; ","];
1351 ["mkfs"; "ext2"; "/dev/sda1"];
1352 ["mount"; "/dev/sda1"; "/"];
1353 ["mounts"]], ["/dev/sda1"]);
1354 InitEmpty, Always, TestOutputList (
1355 [["sfdiskM"; "/dev/sda"; ","];
1356 ["mkfs"; "ext2"; "/dev/sda1"];
1357 ["mount"; "/dev/sda1"; "/"];
1360 "unmount a filesystem",
1362 This unmounts the given filesystem. The filesystem may be
1363 specified either by its mountpoint (path) or the device which
1364 contains the filesystem.");
1366 ("mounts", (RStringList "devices", []), 46, [],
1367 [InitBasicFS, Always, TestOutputListOfDevices (
1368 [["mounts"]], ["/dev/sda1"])],
1369 "show mounted filesystems",
1371 This returns the list of currently mounted filesystems. It returns
1372 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1374 Some internal mounts are not shown.
1376 See also: C<guestfs_mountpoints>");
1378 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1379 [InitBasicFS, Always, TestOutputList (
1382 (* check that umount_all can unmount nested mounts correctly: *)
1383 InitEmpty, Always, TestOutputList (
1384 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1385 ["mkfs"; "ext2"; "/dev/sda1"];
1386 ["mkfs"; "ext2"; "/dev/sda2"];
1387 ["mkfs"; "ext2"; "/dev/sda3"];
1388 ["mount"; "/dev/sda1"; "/"];
1390 ["mount"; "/dev/sda2"; "/mp1"];
1391 ["mkdir"; "/mp1/mp2"];
1392 ["mount"; "/dev/sda3"; "/mp1/mp2"];
1393 ["mkdir"; "/mp1/mp2/mp3"];
1396 "unmount all filesystems",
1398 This unmounts all mounted filesystems.
1400 Some internal mounts are not unmounted by this call.");
1402 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson],
1404 "remove all LVM LVs, VGs and PVs",
1406 This command removes all LVM logical volumes, volume groups
1407 and physical volumes.");
1409 ("file", (RString "description", [String "path"]), 49, [],
1410 [InitBasicFS, Always, TestOutput (
1412 ["file"; "/new"]], "empty");
1413 InitBasicFS, Always, TestOutput (
1414 [["write_file"; "/new"; "some content\n"; "0"];
1415 ["file"; "/new"]], "ASCII text");
1416 InitBasicFS, Always, TestLastFail (
1417 [["file"; "/nofile"]])],
1418 "determine file type",
1420 This call uses the standard L<file(1)> command to determine
1421 the type or contents of the file. This also works on devices,
1422 for example to find out whether a partition contains a filesystem.
1424 The exact command which runs is C<file -bsL path>. Note in
1425 particular that the filename is not prepended to the output
1426 (the C<-b> option).");
1428 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1429 [InitBasicFS, Always, TestOutput (
1430 [["upload"; "test-command"; "/test-command"];
1431 ["chmod"; "0o755"; "/test-command"];
1432 ["command"; "/test-command 1"]], "Result1");
1433 InitBasicFS, Always, TestOutput (
1434 [["upload"; "test-command"; "/test-command"];
1435 ["chmod"; "0o755"; "/test-command"];
1436 ["command"; "/test-command 2"]], "Result2\n");
1437 InitBasicFS, Always, TestOutput (
1438 [["upload"; "test-command"; "/test-command"];
1439 ["chmod"; "0o755"; "/test-command"];
1440 ["command"; "/test-command 3"]], "\nResult3");
1441 InitBasicFS, Always, TestOutput (
1442 [["upload"; "test-command"; "/test-command"];
1443 ["chmod"; "0o755"; "/test-command"];
1444 ["command"; "/test-command 4"]], "\nResult4\n");
1445 InitBasicFS, Always, TestOutput (
1446 [["upload"; "test-command"; "/test-command"];
1447 ["chmod"; "0o755"; "/test-command"];
1448 ["command"; "/test-command 5"]], "\nResult5\n\n");
1449 InitBasicFS, Always, TestOutput (
1450 [["upload"; "test-command"; "/test-command"];
1451 ["chmod"; "0o755"; "/test-command"];
1452 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1453 InitBasicFS, Always, TestOutput (
1454 [["upload"; "test-command"; "/test-command"];
1455 ["chmod"; "0o755"; "/test-command"];
1456 ["command"; "/test-command 7"]], "");
1457 InitBasicFS, Always, TestOutput (
1458 [["upload"; "test-command"; "/test-command"];
1459 ["chmod"; "0o755"; "/test-command"];
1460 ["command"; "/test-command 8"]], "\n");
1461 InitBasicFS, Always, TestOutput (
1462 [["upload"; "test-command"; "/test-command"];
1463 ["chmod"; "0o755"; "/test-command"];
1464 ["command"; "/test-command 9"]], "\n\n");
1465 InitBasicFS, Always, TestOutput (
1466 [["upload"; "test-command"; "/test-command"];
1467 ["chmod"; "0o755"; "/test-command"];
1468 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1469 InitBasicFS, Always, TestOutput (
1470 [["upload"; "test-command"; "/test-command"];
1471 ["chmod"; "0o755"; "/test-command"];
1472 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1473 InitBasicFS, Always, TestLastFail (
1474 [["upload"; "test-command"; "/test-command"];
1475 ["chmod"; "0o755"; "/test-command"];
1476 ["command"; "/test-command"]])],
1477 "run a command from the guest filesystem",
1479 This call runs a command from the guest filesystem. The
1480 filesystem must be mounted, and must contain a compatible
1481 operating system (ie. something Linux, with the same
1482 or compatible processor architecture).
1484 The single parameter is an argv-style list of arguments.
1485 The first element is the name of the program to run.
1486 Subsequent elements are parameters. The list must be
1487 non-empty (ie. must contain a program name). Note that
1488 the command runs directly, and is I<not> invoked via
1489 the shell (see C<guestfs_sh>).
1491 The return value is anything printed to I<stdout> by
1494 If the command returns a non-zero exit status, then
1495 this function returns an error message. The error message
1496 string is the content of I<stderr> from the command.
1498 The C<$PATH> environment variable will contain at least
1499 C</usr/bin> and C</bin>. If you require a program from
1500 another location, you should provide the full path in the
1503 Shared libraries and data files required by the program
1504 must be available on filesystems which are mounted in the
1505 correct places. It is the caller's responsibility to ensure
1506 all filesystems that are needed are mounted at the right
1509 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1510 [InitBasicFS, Always, TestOutputList (
1511 [["upload"; "test-command"; "/test-command"];
1512 ["chmod"; "0o755"; "/test-command"];
1513 ["command_lines"; "/test-command 1"]], ["Result1"]);
1514 InitBasicFS, Always, TestOutputList (
1515 [["upload"; "test-command"; "/test-command"];
1516 ["chmod"; "0o755"; "/test-command"];
1517 ["command_lines"; "/test-command 2"]], ["Result2"]);
1518 InitBasicFS, Always, TestOutputList (
1519 [["upload"; "test-command"; "/test-command"];
1520 ["chmod"; "0o755"; "/test-command"];
1521 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1522 InitBasicFS, Always, TestOutputList (
1523 [["upload"; "test-command"; "/test-command"];
1524 ["chmod"; "0o755"; "/test-command"];
1525 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1526 InitBasicFS, Always, TestOutputList (
1527 [["upload"; "test-command"; "/test-command"];
1528 ["chmod"; "0o755"; "/test-command"];
1529 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1530 InitBasicFS, Always, TestOutputList (
1531 [["upload"; "test-command"; "/test-command"];
1532 ["chmod"; "0o755"; "/test-command"];
1533 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1534 InitBasicFS, Always, TestOutputList (
1535 [["upload"; "test-command"; "/test-command"];
1536 ["chmod"; "0o755"; "/test-command"];
1537 ["command_lines"; "/test-command 7"]], []);
1538 InitBasicFS, Always, TestOutputList (
1539 [["upload"; "test-command"; "/test-command"];
1540 ["chmod"; "0o755"; "/test-command"];
1541 ["command_lines"; "/test-command 8"]], [""]);
1542 InitBasicFS, Always, TestOutputList (
1543 [["upload"; "test-command"; "/test-command"];
1544 ["chmod"; "0o755"; "/test-command"];
1545 ["command_lines"; "/test-command 9"]], ["";""]);
1546 InitBasicFS, Always, TestOutputList (
1547 [["upload"; "test-command"; "/test-command"];
1548 ["chmod"; "0o755"; "/test-command"];
1549 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1550 InitBasicFS, Always, TestOutputList (
1551 [["upload"; "test-command"; "/test-command"];
1552 ["chmod"; "0o755"; "/test-command"];
1553 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1554 "run a command, returning lines",
1556 This is the same as C<guestfs_command>, but splits the
1557 result into a list of lines.
1559 See also: C<guestfs_sh_lines>");
1561 ("stat", (RStruct ("statbuf", "stat"), [String "path"]), 52, [],
1562 [InitBasicFS, Always, TestOutputStruct (
1564 ["stat"; "/new"]], [CompareWithInt ("size", 0)])],
1565 "get file information",
1567 Returns file information for the given C<path>.
1569 This is the same as the C<stat(2)> system call.");
1571 ("lstat", (RStruct ("statbuf", "stat"), [String "path"]), 53, [],
1572 [InitBasicFS, Always, TestOutputStruct (
1574 ["lstat"; "/new"]], [CompareWithInt ("size", 0)])],
1575 "get file information for a symbolic link",
1577 Returns file information for the given C<path>.
1579 This is the same as C<guestfs_stat> except that if C<path>
1580 is a symbolic link, then the link is stat-ed, not the file it
1583 This is the same as the C<lstat(2)> system call.");
1585 ("statvfs", (RStruct ("statbuf", "statvfs"), [String "path"]), 54, [],
1586 [InitBasicFS, Always, TestOutputStruct (
1587 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255);
1588 CompareWithInt ("bsize", 1024)])],
1589 "get file system statistics",
1591 Returns file system statistics for any mounted file system.
1592 C<path> should be a file or directory in the mounted file system
1593 (typically it is the mount point itself, but it doesn't need to be).
1595 This is the same as the C<statvfs(2)> system call.");
1597 ("tune2fs_l", (RHashtable "superblock", [String "device"]), 55, [],
1599 "get ext2/ext3/ext4 superblock details",
1601 This returns the contents of the ext2, ext3 or ext4 filesystem
1602 superblock on C<device>.
1604 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1605 manpage for more details. The list of fields returned isn't
1606 clearly defined, and depends on both the version of C<tune2fs>
1607 that libguestfs was built against, and the filesystem itself.");
1609 ("blockdev_setro", (RErr, [String "device"]), 56, [],
1610 [InitEmpty, Always, TestOutputTrue (
1611 [["blockdev_setro"; "/dev/sda"];
1612 ["blockdev_getro"; "/dev/sda"]])],
1613 "set block device to read-only",
1615 Sets the block device named C<device> to read-only.
1617 This uses the L<blockdev(8)> command.");
1619 ("blockdev_setrw", (RErr, [String "device"]), 57, [],
1620 [InitEmpty, Always, TestOutputFalse (
1621 [["blockdev_setrw"; "/dev/sda"];
1622 ["blockdev_getro"; "/dev/sda"]])],
1623 "set block device to read-write",
1625 Sets the block device named C<device> to read-write.
1627 This uses the L<blockdev(8)> command.");
1629 ("blockdev_getro", (RBool "ro", [String "device"]), 58, [],
1630 [InitEmpty, Always, TestOutputTrue (
1631 [["blockdev_setro"; "/dev/sda"];
1632 ["blockdev_getro"; "/dev/sda"]])],
1633 "is block device set to read-only",
1635 Returns a boolean indicating if the block device is read-only
1636 (true if read-only, false if not).
1638 This uses the L<blockdev(8)> command.");
1640 ("blockdev_getss", (RInt "sectorsize", [String "device"]), 59, [],
1641 [InitEmpty, Always, TestOutputInt (
1642 [["blockdev_getss"; "/dev/sda"]], 512)],
1643 "get sectorsize of block device",
1645 This returns the size of sectors on a block device.
1646 Usually 512, but can be larger for modern devices.
1648 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1651 This uses the L<blockdev(8)> command.");
1653 ("blockdev_getbsz", (RInt "blocksize", [String "device"]), 60, [],
1654 [InitEmpty, Always, TestOutputInt (
1655 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1656 "get blocksize of block device",
1658 This returns the block size of a device.
1660 (Note this is different from both I<size in blocks> and
1661 I<filesystem block size>).
1663 This uses the L<blockdev(8)> command.");
1665 ("blockdev_setbsz", (RErr, [String "device"; Int "blocksize"]), 61, [],
1667 "set blocksize of block device",
1669 This sets the block size of a device.
1671 (Note this is different from both I<size in blocks> and
1672 I<filesystem block size>).
1674 This uses the L<blockdev(8)> command.");
1676 ("blockdev_getsz", (RInt64 "sizeinsectors", [String "device"]), 62, [],
1677 [InitEmpty, Always, TestOutputInt (
1678 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1679 "get total size of device in 512-byte sectors",
1681 This returns the size of the device in units of 512-byte sectors
1682 (even if the sectorsize isn't 512 bytes ... weird).
1684 See also C<guestfs_blockdev_getss> for the real sector size of
1685 the device, and C<guestfs_blockdev_getsize64> for the more
1686 useful I<size in bytes>.
1688 This uses the L<blockdev(8)> command.");
1690 ("blockdev_getsize64", (RInt64 "sizeinbytes", [String "device"]), 63, [],
1691 [InitEmpty, Always, TestOutputInt (
1692 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1693 "get total size of device in bytes",
1695 This returns the size of the device in bytes.
1697 See also C<guestfs_blockdev_getsz>.
1699 This uses the L<blockdev(8)> command.");
1701 ("blockdev_flushbufs", (RErr, [String "device"]), 64, [],
1702 [InitEmpty, Always, TestRun
1703 [["blockdev_flushbufs"; "/dev/sda"]]],
1704 "flush device buffers",
1706 This tells the kernel to flush internal buffers associated
1709 This uses the L<blockdev(8)> command.");
1711 ("blockdev_rereadpt", (RErr, [String "device"]), 65, [],
1712 [InitEmpty, Always, TestRun
1713 [["blockdev_rereadpt"; "/dev/sda"]]],
1714 "reread partition table",
1716 Reread the partition table on C<device>.
1718 This uses the L<blockdev(8)> command.");
1720 ("upload", (RErr, [FileIn "filename"; String "remotefilename"]), 66, [],
1721 [InitBasicFS, Always, TestOutput (
1722 (* Pick a file from cwd which isn't likely to change. *)
1723 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1724 ["checksum"; "md5"; "/COPYING.LIB"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1725 "upload a file from the local machine",
1727 Upload local file C<filename> to C<remotefilename> on the
1730 C<filename> can also be a named pipe.
1732 See also C<guestfs_download>.");
1734 ("download", (RErr, [String "remotefilename"; FileOut "filename"]), 67, [],
1735 [InitBasicFS, Always, TestOutput (
1736 (* Pick a file from cwd which isn't likely to change. *)
1737 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1738 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1739 ["upload"; "testdownload.tmp"; "/upload"];
1740 ["checksum"; "md5"; "/upload"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1741 "download a file to the local machine",
1743 Download file C<remotefilename> and save it as C<filename>
1744 on the local machine.
1746 C<filename> can also be a named pipe.
1748 See also C<guestfs_upload>, C<guestfs_cat>.");
1750 ("checksum", (RString "checksum", [String "csumtype"; String "path"]), 68, [],
1751 [InitBasicFS, Always, TestOutput (
1752 [["write_file"; "/new"; "test\n"; "0"];
1753 ["checksum"; "crc"; "/new"]], "935282863");
1754 InitBasicFS, Always, TestLastFail (
1755 [["checksum"; "crc"; "/new"]]);
1756 InitBasicFS, Always, TestOutput (
1757 [["write_file"; "/new"; "test\n"; "0"];
1758 ["checksum"; "md5"; "/new"]], "d8e8fca2dc0f896fd7cb4cb0031ba249");
1759 InitBasicFS, Always, TestOutput (
1760 [["write_file"; "/new"; "test\n"; "0"];
1761 ["checksum"; "sha1"; "/new"]], "4e1243bd22c66e76c2ba9eddc1f91394e57f9f83");
1762 InitBasicFS, Always, TestOutput (
1763 [["write_file"; "/new"; "test\n"; "0"];
1764 ["checksum"; "sha224"; "/new"]], "52f1bf093f4b7588726035c176c0cdb4376cfea53819f1395ac9e6ec");
1765 InitBasicFS, Always, TestOutput (
1766 [["write_file"; "/new"; "test\n"; "0"];
1767 ["checksum"; "sha256"; "/new"]], "f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2");
1768 InitBasicFS, Always, TestOutput (
1769 [["write_file"; "/new"; "test\n"; "0"];
1770 ["checksum"; "sha384"; "/new"]], "109bb6b5b6d5547c1ce03c7a8bd7d8f80c1cb0957f50c4f7fda04692079917e4f9cad52b878f3d8234e1a170b154b72d");
1771 InitBasicFS, Always, TestOutput (
1772 [["write_file"; "/new"; "test\n"; "0"];
1773 ["checksum"; "sha512"; "/new"]], "0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123");
1774 InitBasicFS, Always, TestOutput (
1775 (* RHEL 5 thinks this is an HFS+ filesystem unless we give
1776 * the type explicitly.
1778 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
1779 ["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c")],
1780 "compute MD5, SHAx or CRC checksum of file",
1782 This call computes the MD5, SHAx or CRC checksum of the
1785 The type of checksum to compute is given by the C<csumtype>
1786 parameter which must have one of the following values:
1792 Compute the cyclic redundancy check (CRC) specified by POSIX
1793 for the C<cksum> command.
1797 Compute the MD5 hash (using the C<md5sum> program).
1801 Compute the SHA1 hash (using the C<sha1sum> program).
1805 Compute the SHA224 hash (using the C<sha224sum> program).
1809 Compute the SHA256 hash (using the C<sha256sum> program).
1813 Compute the SHA384 hash (using the C<sha384sum> program).
1817 Compute the SHA512 hash (using the C<sha512sum> program).
1821 The checksum is returned as a printable string.");
1823 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1824 [InitBasicFS, Always, TestOutput (
1825 [["tar_in"; "../images/helloworld.tar"; "/"];
1826 ["cat"; "/hello"]], "hello\n")],
1827 "unpack tarfile to directory",
1829 This command uploads and unpacks local file C<tarfile> (an
1830 I<uncompressed> tar file) into C<directory>.
1832 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1834 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1836 "pack directory into tarfile",
1838 This command packs the contents of C<directory> and downloads
1839 it to local file C<tarfile>.
1841 To download a compressed tarball, use C<guestfs_tgz_out>.");
1843 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1844 [InitBasicFS, Always, TestOutput (
1845 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
1846 ["cat"; "/hello"]], "hello\n")],
1847 "unpack compressed tarball to directory",
1849 This command uploads and unpacks local file C<tarball> (a
1850 I<gzip compressed> tar file) into C<directory>.
1852 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1854 ("tgz_out", (RErr, [String "directory"; FileOut "tarball"]), 72, [],
1856 "pack directory into compressed tarball",
1858 This command packs the contents of C<directory> and downloads
1859 it to local file C<tarball>.
1861 To download an uncompressed tarball, use C<guestfs_tar_out>.");
1863 ("mount_ro", (RErr, [String "device"; String "mountpoint"]), 73, [],
1864 [InitBasicFS, Always, TestLastFail (
1866 ["mount_ro"; "/dev/sda1"; "/"];
1867 ["touch"; "/new"]]);
1868 InitBasicFS, Always, TestOutput (
1869 [["write_file"; "/new"; "data"; "0"];
1871 ["mount_ro"; "/dev/sda1"; "/"];
1872 ["cat"; "/new"]], "data")],
1873 "mount a guest disk, read-only",
1875 This is the same as the C<guestfs_mount> command, but it
1876 mounts the filesystem with the read-only (I<-o ro>) flag.");
1878 ("mount_options", (RErr, [String "options"; String "device"; String "mountpoint"]), 74, [],
1880 "mount a guest disk with mount options",
1882 This is the same as the C<guestfs_mount> command, but it
1883 allows you to set the mount options as for the
1884 L<mount(8)> I<-o> flag.");
1886 ("mount_vfs", (RErr, [String "options"; String "vfstype"; String "device"; String "mountpoint"]), 75, [],
1888 "mount a guest disk with mount options and vfstype",
1890 This is the same as the C<guestfs_mount> command, but it
1891 allows you to set both the mount options and the vfstype
1892 as for the L<mount(8)> I<-o> and I<-t> flags.");
1894 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
1896 "debugging and internals",
1898 The C<guestfs_debug> command exposes some internals of
1899 C<guestfsd> (the guestfs daemon) that runs inside the
1902 There is no comprehensive help for this command. You have
1903 to look at the file C<daemon/debug.c> in the libguestfs source
1904 to find out what you can do.");
1906 ("lvremove", (RErr, [String "device"]), 77, [],
1907 [InitEmpty, Always, TestOutputList (
1908 [["sfdiskM"; "/dev/sda"; ","];
1909 ["pvcreate"; "/dev/sda1"];
1910 ["vgcreate"; "VG"; "/dev/sda1"];
1911 ["lvcreate"; "LV1"; "VG"; "50"];
1912 ["lvcreate"; "LV2"; "VG"; "50"];
1913 ["lvremove"; "/dev/VG/LV1"];
1914 ["lvs"]], ["/dev/VG/LV2"]);
1915 InitEmpty, Always, TestOutputList (
1916 [["sfdiskM"; "/dev/sda"; ","];
1917 ["pvcreate"; "/dev/sda1"];
1918 ["vgcreate"; "VG"; "/dev/sda1"];
1919 ["lvcreate"; "LV1"; "VG"; "50"];
1920 ["lvcreate"; "LV2"; "VG"; "50"];
1921 ["lvremove"; "/dev/VG"];
1923 InitEmpty, Always, TestOutputList (
1924 [["sfdiskM"; "/dev/sda"; ","];
1925 ["pvcreate"; "/dev/sda1"];
1926 ["vgcreate"; "VG"; "/dev/sda1"];
1927 ["lvcreate"; "LV1"; "VG"; "50"];
1928 ["lvcreate"; "LV2"; "VG"; "50"];
1929 ["lvremove"; "/dev/VG"];
1931 "remove an LVM logical volume",
1933 Remove an LVM logical volume C<device>, where C<device> is
1934 the path to the LV, such as C</dev/VG/LV>.
1936 You can also remove all LVs in a volume group by specifying
1937 the VG name, C</dev/VG>.");
1939 ("vgremove", (RErr, [String "vgname"]), 78, [],
1940 [InitEmpty, Always, TestOutputList (
1941 [["sfdiskM"; "/dev/sda"; ","];
1942 ["pvcreate"; "/dev/sda1"];
1943 ["vgcreate"; "VG"; "/dev/sda1"];
1944 ["lvcreate"; "LV1"; "VG"; "50"];
1945 ["lvcreate"; "LV2"; "VG"; "50"];
1948 InitEmpty, Always, TestOutputList (
1949 [["sfdiskM"; "/dev/sda"; ","];
1950 ["pvcreate"; "/dev/sda1"];
1951 ["vgcreate"; "VG"; "/dev/sda1"];
1952 ["lvcreate"; "LV1"; "VG"; "50"];
1953 ["lvcreate"; "LV2"; "VG"; "50"];
1956 "remove an LVM volume group",
1958 Remove an LVM volume group C<vgname>, (for example C<VG>).
1960 This also forcibly removes all logical volumes in the volume
1963 ("pvremove", (RErr, [String "device"]), 79, [],
1964 [InitEmpty, Always, TestOutputListOfDevices (
1965 [["sfdiskM"; "/dev/sda"; ","];
1966 ["pvcreate"; "/dev/sda1"];
1967 ["vgcreate"; "VG"; "/dev/sda1"];
1968 ["lvcreate"; "LV1"; "VG"; "50"];
1969 ["lvcreate"; "LV2"; "VG"; "50"];
1971 ["pvremove"; "/dev/sda1"];
1973 InitEmpty, Always, TestOutputListOfDevices (
1974 [["sfdiskM"; "/dev/sda"; ","];
1975 ["pvcreate"; "/dev/sda1"];
1976 ["vgcreate"; "VG"; "/dev/sda1"];
1977 ["lvcreate"; "LV1"; "VG"; "50"];
1978 ["lvcreate"; "LV2"; "VG"; "50"];
1980 ["pvremove"; "/dev/sda1"];
1982 InitEmpty, Always, TestOutputListOfDevices (
1983 [["sfdiskM"; "/dev/sda"; ","];
1984 ["pvcreate"; "/dev/sda1"];
1985 ["vgcreate"; "VG"; "/dev/sda1"];
1986 ["lvcreate"; "LV1"; "VG"; "50"];
1987 ["lvcreate"; "LV2"; "VG"; "50"];
1989 ["pvremove"; "/dev/sda1"];
1991 "remove an LVM physical volume",
1993 This wipes a physical volume C<device> so that LVM will no longer
1996 The implementation uses the C<pvremove> command which refuses to
1997 wipe physical volumes that contain any volume groups, so you have
1998 to remove those first.");
2000 ("set_e2label", (RErr, [String "device"; String "label"]), 80, [],
2001 [InitBasicFS, Always, TestOutput (
2002 [["set_e2label"; "/dev/sda1"; "testlabel"];
2003 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2004 "set the ext2/3/4 filesystem label",
2006 This sets the ext2/3/4 filesystem label of the filesystem on
2007 C<device> to C<label>. Filesystem labels are limited to
2010 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2011 to return the existing label on a filesystem.");
2013 ("get_e2label", (RString "label", [String "device"]), 81, [],
2015 "get the ext2/3/4 filesystem label",
2017 This returns the ext2/3/4 filesystem label of the filesystem on
2020 ("set_e2uuid", (RErr, [String "device"; String "uuid"]), 82, [],
2021 [InitBasicFS, Always, TestOutput (
2022 [["set_e2uuid"; "/dev/sda1"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"];
2023 ["get_e2uuid"; "/dev/sda1"]], "a3a61220-882b-4f61-89f4-cf24dcc7297d");
2024 InitBasicFS, Always, TestOutput (
2025 [["set_e2uuid"; "/dev/sda1"; "clear"];
2026 ["get_e2uuid"; "/dev/sda1"]], "");
2027 (* We can't predict what UUIDs will be, so just check the commands run. *)
2028 InitBasicFS, Always, TestRun (
2029 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2030 InitBasicFS, Always, TestRun (
2031 [["set_e2uuid"; "/dev/sda1"; "time"]])],
2032 "set the ext2/3/4 filesystem UUID",
2034 This sets the ext2/3/4 filesystem UUID of the filesystem on
2035 C<device> to C<uuid>. The format of the UUID and alternatives
2036 such as C<clear>, C<random> and C<time> are described in the
2037 L<tune2fs(8)> manpage.
2039 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2040 to return the existing UUID of a filesystem.");
2042 ("get_e2uuid", (RString "uuid", [String "device"]), 83, [],
2044 "get the ext2/3/4 filesystem UUID",
2046 This returns the ext2/3/4 filesystem UUID of the filesystem on
2049 ("fsck", (RInt "status", [String "fstype"; String "device"]), 84, [],
2050 [InitBasicFS, Always, TestOutputInt (
2051 [["umount"; "/dev/sda1"];
2052 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2053 InitBasicFS, Always, TestOutputInt (
2054 [["umount"; "/dev/sda1"];
2055 ["zero"; "/dev/sda1"];
2056 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2057 "run the filesystem checker",
2059 This runs the filesystem checker (fsck) on C<device> which
2060 should have filesystem type C<fstype>.
2062 The returned integer is the status. See L<fsck(8)> for the
2063 list of status codes from C<fsck>.
2071 Multiple status codes can be summed together.
2075 A non-zero return code can mean \"success\", for example if
2076 errors have been corrected on the filesystem.
2080 Checking or repairing NTFS volumes is not supported
2085 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2087 ("zero", (RErr, [String "device"]), 85, [],
2088 [InitBasicFS, Always, TestOutput (
2089 [["umount"; "/dev/sda1"];
2090 ["zero"; "/dev/sda1"];
2091 ["file"; "/dev/sda1"]], "data")],
2092 "write zeroes to the device",
2094 This command writes zeroes over the first few blocks of C<device>.
2096 How many blocks are zeroed isn't specified (but it's I<not> enough
2097 to securely wipe the device). It should be sufficient to remove
2098 any partition tables, filesystem superblocks and so on.
2100 See also: C<guestfs_scrub_device>.");
2102 ("grub_install", (RErr, [String "root"; String "device"]), 86, [],
2103 (* Test disabled because grub-install incompatible with virtio-blk driver.
2104 * See also: https://bugzilla.redhat.com/show_bug.cgi?id=479760
2106 [InitBasicFS, Disabled, TestOutputTrue (
2107 [["grub_install"; "/"; "/dev/sda1"];
2108 ["is_dir"; "/boot"]])],
2111 This command installs GRUB (the Grand Unified Bootloader) on
2112 C<device>, with the root directory being C<root>.");
2114 ("cp", (RErr, [String "src"; String "dest"]), 87, [],
2115 [InitBasicFS, Always, TestOutput (
2116 [["write_file"; "/old"; "file content"; "0"];
2117 ["cp"; "/old"; "/new"];
2118 ["cat"; "/new"]], "file content");
2119 InitBasicFS, Always, TestOutputTrue (
2120 [["write_file"; "/old"; "file content"; "0"];
2121 ["cp"; "/old"; "/new"];
2122 ["is_file"; "/old"]]);
2123 InitBasicFS, Always, TestOutput (
2124 [["write_file"; "/old"; "file content"; "0"];
2126 ["cp"; "/old"; "/dir/new"];
2127 ["cat"; "/dir/new"]], "file content")],
2130 This copies a file from C<src> to C<dest> where C<dest> is
2131 either a destination filename or destination directory.");
2133 ("cp_a", (RErr, [String "src"; String "dest"]), 88, [],
2134 [InitBasicFS, Always, TestOutput (
2135 [["mkdir"; "/olddir"];
2136 ["mkdir"; "/newdir"];
2137 ["write_file"; "/olddir/file"; "file content"; "0"];
2138 ["cp_a"; "/olddir"; "/newdir"];
2139 ["cat"; "/newdir/olddir/file"]], "file content")],
2140 "copy a file or directory recursively",
2142 This copies a file or directory from C<src> to C<dest>
2143 recursively using the C<cp -a> command.");
2145 ("mv", (RErr, [String "src"; String "dest"]), 89, [],
2146 [InitBasicFS, Always, TestOutput (
2147 [["write_file"; "/old"; "file content"; "0"];
2148 ["mv"; "/old"; "/new"];
2149 ["cat"; "/new"]], "file content");
2150 InitBasicFS, Always, TestOutputFalse (
2151 [["write_file"; "/old"; "file content"; "0"];
2152 ["mv"; "/old"; "/new"];
2153 ["is_file"; "/old"]])],
2156 This moves a file from C<src> to C<dest> where C<dest> is
2157 either a destination filename or destination directory.");
2159 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2160 [InitEmpty, Always, TestRun (
2161 [["drop_caches"; "3"]])],
2162 "drop kernel page cache, dentries and inodes",
2164 This instructs the guest kernel to drop its page cache,
2165 and/or dentries and inode caches. The parameter C<whattodrop>
2166 tells the kernel what precisely to drop, see
2167 L<http://linux-mm.org/Drop_Caches>
2169 Setting C<whattodrop> to 3 should drop everything.
2171 This automatically calls L<sync(2)> before the operation,
2172 so that the maximum guest memory is freed.");
2174 ("dmesg", (RString "kmsgs", []), 91, [],
2175 [InitEmpty, Always, TestRun (
2177 "return kernel messages",
2179 This returns the kernel messages (C<dmesg> output) from
2180 the guest kernel. This is sometimes useful for extended
2181 debugging of problems.
2183 Another way to get the same information is to enable
2184 verbose messages with C<guestfs_set_verbose> or by setting
2185 the environment variable C<LIBGUESTFS_DEBUG=1> before
2186 running the program.");
2188 ("ping_daemon", (RErr, []), 92, [],
2189 [InitEmpty, Always, TestRun (
2190 [["ping_daemon"]])],
2191 "ping the guest daemon",
2193 This is a test probe into the guestfs daemon running inside
2194 the qemu subprocess. Calling this function checks that the
2195 daemon responds to the ping message, without affecting the daemon
2196 or attached block device(s) in any other way.");
2198 ("equal", (RBool "equality", [String "file1"; String "file2"]), 93, [],
2199 [InitBasicFS, Always, TestOutputTrue (
2200 [["write_file"; "/file1"; "contents of a file"; "0"];
2201 ["cp"; "/file1"; "/file2"];
2202 ["equal"; "/file1"; "/file2"]]);
2203 InitBasicFS, Always, TestOutputFalse (
2204 [["write_file"; "/file1"; "contents of a file"; "0"];
2205 ["write_file"; "/file2"; "contents of another file"; "0"];
2206 ["equal"; "/file1"; "/file2"]]);
2207 InitBasicFS, Always, TestLastFail (
2208 [["equal"; "/file1"; "/file2"]])],
2209 "test if two files have equal contents",
2211 This compares the two files C<file1> and C<file2> and returns
2212 true if their content is exactly equal, or false otherwise.
2214 The external L<cmp(1)> program is used for the comparison.");
2216 ("strings", (RStringList "stringsout", [String "path"]), 94, [ProtocolLimitWarning],
2217 [InitBasicFS, Always, TestOutputList (
2218 [["write_file"; "/new"; "hello\nworld\n"; "0"];
2219 ["strings"; "/new"]], ["hello"; "world"]);
2220 InitBasicFS, Always, TestOutputList (
2222 ["strings"; "/new"]], [])],
2223 "print the printable strings in a file",
2225 This runs the L<strings(1)> command on a file and returns
2226 the list of printable strings found.");
2228 ("strings_e", (RStringList "stringsout", [String "encoding"; String "path"]), 95, [ProtocolLimitWarning],
2229 [InitBasicFS, Always, TestOutputList (
2230 [["write_file"; "/new"; "hello\nworld\n"; "0"];
2231 ["strings_e"; "b"; "/new"]], []);
2232 InitBasicFS, Disabled, TestOutputList (
2233 [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2234 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2235 "print the printable strings in a file",
2237 This is like the C<guestfs_strings> command, but allows you to
2238 specify the encoding.
2240 See the L<strings(1)> manpage for the full list of encodings.
2242 Commonly useful encodings are C<l> (lower case L) which will
2243 show strings inside Windows/x86 files.
2245 The returned strings are transcoded to UTF-8.");
2247 ("hexdump", (RString "dump", [String "path"]), 96, [ProtocolLimitWarning],
2248 [InitBasicFS, Always, TestOutput (
2249 [["write_file"; "/new"; "hello\nworld\n"; "12"];
2250 ["hexdump"; "/new"]], "00000000 68 65 6c 6c 6f 0a 77 6f 72 6c 64 0a |hello.world.|\n0000000c\n");
2251 (* Test for RHBZ#501888c2 regression which caused large hexdump
2252 * commands to segfault.
2254 InitBasicFS, Always, TestRun (
2255 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2256 ["hexdump"; "/100krandom"]])],
2257 "dump a file in hexadecimal",
2259 This runs C<hexdump -C> on the given C<path>. The result is
2260 the human-readable, canonical hex dump of the file.");
2262 ("zerofree", (RErr, [String "device"]), 97, [],
2263 [InitNone, Always, TestOutput (
2264 [["sfdiskM"; "/dev/sda"; ","];
2265 ["mkfs"; "ext3"; "/dev/sda1"];
2266 ["mount"; "/dev/sda1"; "/"];
2267 ["write_file"; "/new"; "test file"; "0"];
2268 ["umount"; "/dev/sda1"];
2269 ["zerofree"; "/dev/sda1"];
2270 ["mount"; "/dev/sda1"; "/"];
2271 ["cat"; "/new"]], "test file")],
2272 "zero unused inodes and disk blocks on ext2/3 filesystem",
2274 This runs the I<zerofree> program on C<device>. This program
2275 claims to zero unused inodes and disk blocks on an ext2/3
2276 filesystem, thus making it possible to compress the filesystem
2279 You should B<not> run this program if the filesystem is
2282 It is possible that using this program can damage the filesystem
2283 or data on the filesystem.");
2285 ("pvresize", (RErr, [String "device"]), 98, [],
2287 "resize an LVM physical volume",
2289 This resizes (expands or shrinks) an existing LVM physical
2290 volume to match the new size of the underlying device.");
2292 ("sfdisk_N", (RErr, [String "device"; Int "partnum";
2293 Int "cyls"; Int "heads"; Int "sectors";
2294 String "line"]), 99, [DangerWillRobinson],
2296 "modify a single partition on a block device",
2298 This runs L<sfdisk(8)> option to modify just the single
2299 partition C<n> (note: C<n> counts from 1).
2301 For other parameters, see C<guestfs_sfdisk>. You should usually
2302 pass C<0> for the cyls/heads/sectors parameters.");
2304 ("sfdisk_l", (RString "partitions", [String "device"]), 100, [],
2306 "display the partition table",
2308 This displays the partition table on C<device>, in the
2309 human-readable output of the L<sfdisk(8)> command. It is
2310 not intended to be parsed.");
2312 ("sfdisk_kernel_geometry", (RString "partitions", [String "device"]), 101, [],
2314 "display the kernel geometry",
2316 This displays the kernel's idea of the geometry of C<device>.
2318 The result is in human-readable format, and not designed to
2321 ("sfdisk_disk_geometry", (RString "partitions", [String "device"]), 102, [],
2323 "display the disk geometry from the partition table",
2325 This displays the disk geometry of C<device> read from the
2326 partition table. Especially in the case where the underlying
2327 block device has been resized, this can be different from the
2328 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2330 The result is in human-readable format, and not designed to
2333 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [],
2335 "activate or deactivate all volume groups",
2337 This command activates or (if C<activate> is false) deactivates
2338 all logical volumes in all volume groups.
2339 If activated, then they are made known to the
2340 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2341 then those devices disappear.
2343 This command is the same as running C<vgchange -a y|n>");
2345 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [],
2347 "activate or deactivate some volume groups",
2349 This command activates or (if C<activate> is false) deactivates
2350 all logical volumes in the listed volume groups C<volgroups>.
2351 If activated, then they are made known to the
2352 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2353 then those devices disappear.
2355 This command is the same as running C<vgchange -a y|n volgroups...>
2357 Note that if C<volgroups> is an empty list then B<all> volume groups
2358 are activated or deactivated.");
2360 ("lvresize", (RErr, [String "device"; Int "mbytes"]), 105, [],
2361 [InitNone, Always, TestOutput (
2362 [["sfdiskM"; "/dev/sda"; ","];
2363 ["pvcreate"; "/dev/sda1"];
2364 ["vgcreate"; "VG"; "/dev/sda1"];
2365 ["lvcreate"; "LV"; "VG"; "10"];
2366 ["mkfs"; "ext2"; "/dev/VG/LV"];
2367 ["mount"; "/dev/VG/LV"; "/"];
2368 ["write_file"; "/new"; "test content"; "0"];
2370 ["lvresize"; "/dev/VG/LV"; "20"];
2371 ["e2fsck_f"; "/dev/VG/LV"];
2372 ["resize2fs"; "/dev/VG/LV"];
2373 ["mount"; "/dev/VG/LV"; "/"];
2374 ["cat"; "/new"]], "test content")],
2375 "resize an LVM logical volume",
2377 This resizes (expands or shrinks) an existing LVM logical
2378 volume to C<mbytes>. When reducing, data in the reduced part
2381 ("resize2fs", (RErr, [String "device"]), 106, [],
2382 [], (* lvresize tests this *)
2383 "resize an ext2/ext3 filesystem",
2385 This resizes an ext2 or ext3 filesystem to match the size of
2386 the underlying device.
2388 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2389 on the C<device> before calling this command. For unknown reasons
2390 C<resize2fs> sometimes gives an error about this and sometimes not.
2391 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2392 calling this function.");
2394 ("find", (RStringList "names", [String "directory"]), 107, [],
2395 [InitBasicFS, Always, TestOutputList (
2396 [["find"; "/"]], ["lost+found"]);
2397 InitBasicFS, Always, TestOutputList (
2401 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2402 InitBasicFS, Always, TestOutputList (
2403 [["mkdir_p"; "/a/b/c"];
2404 ["touch"; "/a/b/c/d"];
2405 ["find"; "/a/b/"]], ["c"; "c/d"])],
2406 "find all files and directories",
2408 This command lists out all files and directories, recursively,
2409 starting at C<directory>. It is essentially equivalent to
2410 running the shell command C<find directory -print> but some
2411 post-processing happens on the output, described below.
2413 This returns a list of strings I<without any prefix>. Thus
2414 if the directory structure was:
2420 then the returned list from C<guestfs_find> C</tmp> would be
2428 If C<directory> is not a directory, then this command returns
2431 The returned list is sorted.");
2433 ("e2fsck_f", (RErr, [String "device"]), 108, [],
2434 [], (* lvresize tests this *)
2435 "check an ext2/ext3 filesystem",
2437 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2438 filesystem checker on C<device>, noninteractively (C<-p>),
2439 even if the filesystem appears to be clean (C<-f>).
2441 This command is only needed because of C<guestfs_resize2fs>
2442 (q.v.). Normally you should use C<guestfs_fsck>.");
2444 ("sleep", (RErr, [Int "secs"]), 109, [],
2445 [InitNone, Always, TestRun (
2447 "sleep for some seconds",
2449 Sleep for C<secs> seconds.");
2451 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; String "device"]), 110, [],
2452 [InitNone, Always, TestOutputInt (
2453 [["sfdiskM"; "/dev/sda"; ","];
2454 ["mkfs"; "ntfs"; "/dev/sda1"];
2455 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2456 InitNone, Always, TestOutputInt (
2457 [["sfdiskM"; "/dev/sda"; ","];
2458 ["mkfs"; "ext2"; "/dev/sda1"];
2459 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2460 "probe NTFS volume",
2462 This command runs the L<ntfs-3g.probe(8)> command which probes
2463 an NTFS C<device> for mountability. (Not all NTFS volumes can
2464 be mounted read-write, and some cannot be mounted at all).
2466 C<rw> is a boolean flag. Set it to true if you want to test
2467 if the volume can be mounted read-write. Set it to false if
2468 you want to test if the volume can be mounted read-only.
2470 The return value is an integer which C<0> if the operation
2471 would succeed, or some non-zero value documented in the
2472 L<ntfs-3g.probe(8)> manual page.");
2474 ("sh", (RString "output", [String "command"]), 111, [],
2475 [], (* XXX needs tests *)
2476 "run a command via the shell",
2478 This call runs a command from the guest filesystem via the
2481 This is like C<guestfs_command>, but passes the command to:
2483 /bin/sh -c \"command\"
2485 Depending on the guest's shell, this usually results in
2486 wildcards being expanded, shell expressions being interpolated
2489 All the provisos about C<guestfs_command> apply to this call.");
2491 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2492 [], (* XXX needs tests *)
2493 "run a command via the shell returning lines",
2495 This is the same as C<guestfs_sh>, but splits the result
2496 into a list of lines.
2498 See also: C<guestfs_command_lines>");
2500 ("glob_expand", (RStringList "paths", [String "pattern"]), 113, [],
2501 [InitBasicFS, Always, TestOutputList (
2502 [["mkdir_p"; "/a/b/c"];
2503 ["touch"; "/a/b/c/d"];
2504 ["touch"; "/a/b/c/e"];
2505 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2506 InitBasicFS, Always, TestOutputList (
2507 [["mkdir_p"; "/a/b/c"];
2508 ["touch"; "/a/b/c/d"];
2509 ["touch"; "/a/b/c/e"];
2510 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2511 InitBasicFS, Always, TestOutputList (
2512 [["mkdir_p"; "/a/b/c"];
2513 ["touch"; "/a/b/c/d"];
2514 ["touch"; "/a/b/c/e"];
2515 ["glob_expand"; "/a/*/x/*"]], [])],
2516 "expand a wildcard path",
2518 This command searches for all the pathnames matching
2519 C<pattern> according to the wildcard expansion rules
2522 If no paths match, then this returns an empty list
2523 (note: not an error).
2525 It is just a wrapper around the C L<glob(3)> function
2526 with flags C<GLOB_MARK|GLOB_BRACE>.
2527 See that manual page for more details.");
2529 ("scrub_device", (RErr, [String "device"]), 114, [DangerWillRobinson],
2530 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2531 [["scrub_device"; "/dev/sdc"]])],
2532 "scrub (securely wipe) a device",
2534 This command writes patterns over C<device> to make data retrieval
2537 It is an interface to the L<scrub(1)> program. See that
2538 manual page for more details.");
2540 ("scrub_file", (RErr, [String "file"]), 115, [],
2541 [InitBasicFS, Always, TestRun (
2542 [["write_file"; "/file"; "content"; "0"];
2543 ["scrub_file"; "/file"]])],
2544 "scrub (securely wipe) a file",
2546 This command writes patterns over a file to make data retrieval
2549 The file is I<removed> after scrubbing.
2551 It is an interface to the L<scrub(1)> program. See that
2552 manual page for more details.");
2554 ("scrub_freespace", (RErr, [String "dir"]), 116, [],
2555 [], (* XXX needs testing *)
2556 "scrub (securely wipe) free space",
2558 This command creates the directory C<dir> and then fills it
2559 with files until the filesystem is full, and scrubs the files
2560 as for C<guestfs_scrub_file>, and deletes them.
2561 The intention is to scrub any free space on the partition
2564 It is an interface to the L<scrub(1)> program. See that
2565 manual page for more details.");
2567 ("mkdtemp", (RString "dir", [String "template"]), 117, [],
2568 [InitBasicFS, Always, TestRun (
2570 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2571 "create a temporary directory",
2573 This command creates a temporary directory. The
2574 C<template> parameter should be a full pathname for the
2575 temporary directory name with the final six characters being
2578 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2579 the second one being suitable for Windows filesystems.
2581 The name of the temporary directory that was created
2584 The temporary directory is created with mode 0700
2585 and is owned by root.
2587 The caller is responsible for deleting the temporary
2588 directory and its contents after use.
2590 See also: L<mkdtemp(3)>");
2592 ("wc_l", (RInt "lines", [String "path"]), 118, [],
2593 [InitBasicFS, Always, TestOutputInt (
2594 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2595 ["wc_l"; "/10klines"]], 10000)],
2596 "count lines in a file",
2598 This command counts the lines in a file, using the
2599 C<wc -l> external command.");
2601 ("wc_w", (RInt "words", [String "path"]), 119, [],
2602 [InitBasicFS, Always, TestOutputInt (
2603 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2604 ["wc_w"; "/10klines"]], 10000)],
2605 "count words in a file",
2607 This command counts the words in a file, using the
2608 C<wc -w> external command.");
2610 ("wc_c", (RInt "chars", [String "path"]), 120, [],
2611 [InitBasicFS, Always, TestOutputInt (
2612 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2613 ["wc_c"; "/100kallspaces"]], 102400)],
2614 "count characters in a file",
2616 This command counts the characters in a file, using the
2617 C<wc -c> external command.");
2619 ("head", (RStringList "lines", [String "path"]), 121, [ProtocolLimitWarning],
2620 [InitBasicFS, Always, TestOutputList (
2621 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2622 ["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2623 "return first 10 lines of a file",
2625 This command returns up to the first 10 lines of a file as
2626 a list of strings.");
2628 ("head_n", (RStringList "lines", [Int "nrlines"; String "path"]), 122, [ProtocolLimitWarning],
2629 [InitBasicFS, Always, TestOutputList (
2630 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2631 ["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2632 InitBasicFS, Always, TestOutputList (
2633 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2634 ["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2635 InitBasicFS, Always, TestOutputList (
2636 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2637 ["head_n"; "0"; "/10klines"]], [])],
2638 "return first N lines of a file",
2640 If the parameter C<nrlines> is a positive number, this returns the first
2641 C<nrlines> lines of the file C<path>.
2643 If the parameter C<nrlines> is a negative number, this returns lines
2644 from the file C<path>, excluding the last C<nrlines> lines.
2646 If the parameter C<nrlines> is zero, this returns an empty list.");
2648 ("tail", (RStringList "lines", [String "path"]), 123, [ProtocolLimitWarning],
2649 [InitBasicFS, Always, TestOutputList (
2650 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2651 ["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2652 "return last 10 lines of a file",
2654 This command returns up to the last 10 lines of a file as
2655 a list of strings.");
2657 ("tail_n", (RStringList "lines", [Int "nrlines"; String "path"]), 124, [ProtocolLimitWarning],
2658 [InitBasicFS, Always, TestOutputList (
2659 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2660 ["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2661 InitBasicFS, Always, TestOutputList (
2662 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2663 ["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2664 InitBasicFS, Always, TestOutputList (
2665 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2666 ["tail_n"; "0"; "/10klines"]], [])],
2667 "return last N lines of a file",
2669 If the parameter C<nrlines> is a positive number, this returns the last
2670 C<nrlines> lines of the file C<path>.
2672 If the parameter C<nrlines> is a negative number, this returns lines
2673 from the file C<path>, starting with the C<-nrlines>th line.
2675 If the parameter C<nrlines> is zero, this returns an empty list.");
2677 ("df", (RString "output", []), 125, [],
2678 [], (* XXX Tricky to test because it depends on the exact format
2679 * of the 'df' command and other imponderables.
2681 "report file system disk space usage",
2683 This command runs the C<df> command to report disk space used.
2685 This command is mostly useful for interactive sessions. It
2686 is I<not> intended that you try to parse the output string.
2687 Use C<statvfs> from programs.");
2689 ("df_h", (RString "output", []), 126, [],
2690 [], (* XXX Tricky to test because it depends on the exact format
2691 * of the 'df' command and other imponderables.
2693 "report file system disk space usage (human readable)",
2695 This command runs the C<df -h> command to report disk space used
2696 in human-readable format.
2698 This command is mostly useful for interactive sessions. It
2699 is I<not> intended that you try to parse the output string.
2700 Use C<statvfs> from programs.");
2702 ("du", (RInt64 "sizekb", [String "path"]), 127, [],
2703 [InitBasicFS, Always, TestOutputInt (
2705 ["du"; "/p"]], 1 (* ie. 1 block, so depends on ext3 blocksize *))],
2706 "estimate file space usage",
2708 This command runs the C<du -s> command to estimate file space
2711 C<path> can be a file or a directory. If C<path> is a directory
2712 then the estimate includes the contents of the directory and all
2713 subdirectories (recursively).
2715 The result is the estimated size in I<kilobytes>
2716 (ie. units of 1024 bytes).");
2718 ("initrd_list", (RStringList "filenames", [String "path"]), 128, [],
2719 [InitBasicFS, Always, TestOutputList (
2720 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2721 ["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3"])],
2722 "list files in an initrd",
2724 This command lists out files contained in an initrd.
2726 The files are listed without any initial C</> character. The
2727 files are listed in the order they appear (not necessarily
2728 alphabetical). Directory names are listed as separate items.
2730 Old Linux kernels (2.4 and earlier) used a compressed ext2
2731 filesystem as initrd. We I<only> support the newer initramfs
2732 format (compressed cpio files).");
2734 ("mount_loop", (RErr, [String "file"; String "mountpoint"]), 129, [],
2736 "mount a file using the loop device",
2738 This command lets you mount C<file> (a filesystem image
2739 in a file) on a mount point. It is entirely equivalent to
2740 the command C<mount -o loop file mountpoint>.");
2742 ("mkswap", (RErr, [String "device"]), 130, [],
2743 [InitEmpty, Always, TestRun (
2744 [["sfdiskM"; "/dev/sda"; ","];
2745 ["mkswap"; "/dev/sda1"]])],
2746 "create a swap partition",
2748 Create a swap partition on C<device>.");
2750 ("mkswap_L", (RErr, [String "label"; String "device"]), 131, [],
2751 [InitEmpty, Always, TestRun (
2752 [["sfdiskM"; "/dev/sda"; ","];
2753 ["mkswap_L"; "hello"; "/dev/sda1"]])],
2754 "create a swap partition with a label",
2756 Create a swap partition on C<device> with label C<label>.");
2758 ("mkswap_U", (RErr, [String "uuid"; String "device"]), 132, [],
2759 [InitEmpty, Always, TestRun (
2760 [["sfdiskM"; "/dev/sda"; ","];
2761 ["mkswap_U"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"; "/dev/sda1"]])],
2762 "create a swap partition with an explicit UUID",
2764 Create a swap partition on C<device> with UUID C<uuid>.");
2766 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 133, [],
2767 [InitBasicFS, Always, TestOutputStruct (
2768 [["mknod"; "0o10777"; "0"; "0"; "/node"];
2769 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
2770 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
2771 InitBasicFS, Always, TestOutputStruct (
2772 [["mknod"; "0o60777"; "66"; "99"; "/node"];
2773 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2774 "make block, character or FIFO devices",
2776 This call creates block or character special devices, or
2777 named pipes (FIFOs).
2779 The C<mode> parameter should be the mode, using the standard
2780 constants. C<devmajor> and C<devminor> are the
2781 device major and minor numbers, only used when creating block
2782 and character special devices.");
2784 ("mkfifo", (RErr, [Int "mode"; String "path"]), 134, [],
2785 [InitBasicFS, Always, TestOutputStruct (
2786 [["mkfifo"; "0o777"; "/node"];
2787 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
2788 "make FIFO (named pipe)",
2790 This call creates a FIFO (named pipe) called C<path> with
2791 mode C<mode>. It is just a convenient wrapper around
2792 C<guestfs_mknod>.");
2794 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 135, [],
2795 [InitBasicFS, Always, TestOutputStruct (
2796 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
2797 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2798 "make block device node",
2800 This call creates a block device node called C<path> with
2801 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2802 It is just a convenient wrapper around C<guestfs_mknod>.");
2804 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 136, [],
2805 [InitBasicFS, Always, TestOutputStruct (
2806 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
2807 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
2808 "make char device node",
2810 This call creates a char device node called C<path> with
2811 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2812 It is just a convenient wrapper around C<guestfs_mknod>.");
2814 ("umask", (RInt "oldmask", [Int "mask"]), 137, [],
2815 [], (* XXX umask is one of those stateful things that we should
2816 * reset between each test.
2818 "set file mode creation mask (umask)",
2820 This function sets the mask used for creating new files and
2821 device nodes to C<mask & 0777>.
2823 Typical umask values would be C<022> which creates new files
2824 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
2825 C<002> which creates new files with permissions like
2826 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
2828 The default umask is C<022>. This is important because it
2829 means that directories and device nodes will be created with
2830 C<0644> or C<0755> mode even if you specify C<0777>.
2832 See also L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
2834 This call returns the previous umask.");
2836 ("readdir", (RStructList ("entries", "dirent"), [String "dir"]), 138, [],
2838 "read directories entries",
2840 This returns the list of directory entries in directory C<dir>.
2842 All entries in the directory are returned, including C<.> and
2843 C<..>. The entries are I<not> sorted, but returned in the same
2844 order as the underlying filesystem.
2846 This function is primarily intended for use by programs. To
2847 get a simple list of names, use C<guestfs_ls>. To get a printable
2848 directory for human consumption, use C<guestfs_ll>.");
2850 ("sfdiskM", (RErr, [String "device"; StringList "lines"]), 139, [DangerWillRobinson],
2852 "create partitions on a block device",
2854 This is a simplified interface to the C<guestfs_sfdisk>
2855 command, where partition sizes are specified in megabytes
2856 only (rounded to the nearest cylinder) and you don't need
2857 to specify the cyls, heads and sectors parameters which
2858 were rarely if ever used anyway.
2860 See also C<guestfs_sfdisk> and the L<sfdisk(8)> manpage.");
2862 ("zfile", (RString "description", [String "method"; String "path"]), 140, [],
2864 "determine file type inside a compressed file",
2866 This command runs C<file> after first decompressing C<path>
2869 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
2871 See also: C<guestfs_file>");
2873 ("getxattrs", (RStructList ("xattrs", "xattr"), [String "path"]), 141, [],
2875 "list extended attributes of a file or directory",
2877 This call lists the extended attributes of the file or directory
2880 At the system call level, this is a combination of the
2881 L<listxattr(2)> and L<getxattr(2)> calls.
2883 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
2885 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [String "path"]), 142, [],
2887 "list extended attributes of a file or directory",
2889 This is the same as C<guestfs_getxattrs>, but if C<path>
2890 is a symbolic link, then it returns the extended attributes
2891 of the link itself.");
2893 ("setxattr", (RErr, [String "xattr";
2894 String "val"; Int "vallen"; (* will be BufferIn *)
2895 String "path"]), 143, [],
2897 "set extended attribute of a file or directory",
2899 This call sets the extended attribute named C<xattr>
2900 of the file C<path> to the value C<val> (of length C<vallen>).
2901 The value is arbitrary 8 bit data.
2903 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
2905 ("lsetxattr", (RErr, [String "xattr";
2906 String "val"; Int "vallen"; (* will be BufferIn *)
2907 String "path"]), 144, [],
2909 "set extended attribute of a file or directory",
2911 This is the same as C<guestfs_setxattr>, but if C<path>
2912 is a symbolic link, then it sets an extended attribute
2913 of the link itself.");
2915 ("removexattr", (RErr, [String "xattr"; String "path"]), 145, [],
2917 "remove extended attribute of a file or directory",
2919 This call removes the extended attribute named C<xattr>
2920 of the file C<path>.
2922 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
2924 ("lremovexattr", (RErr, [String "xattr"; String "path"]), 146, [],
2926 "remove extended attribute of a file or directory",
2928 This is the same as C<guestfs_removexattr>, but if C<path>
2929 is a symbolic link, then it removes an extended attribute
2930 of the link itself.");
2932 ("mountpoints", (RHashtable "mps", []), 147, [],
2936 This call is similar to C<guestfs_mounts>. That call returns
2937 a list of devices. This one returns a hash table (map) of
2938 device name to directory where the device is mounted.");
2940 ("mkmountpoint", (RErr, [String "path"]), 148, [],
2942 "create a mountpoint",
2944 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
2945 specialized calls that can be used to create extra mountpoints
2946 before mounting the first filesystem.
2948 These calls are I<only> necessary in some very limited circumstances,
2949 mainly the case where you want to mount a mix of unrelated and/or
2950 read-only filesystems together.
2952 For example, live CDs often contain a \"Russian doll\" nest of
2953 filesystems, an ISO outer layer, with a squashfs image inside, with
2954 an ext2/3 image inside that. You can unpack this as follows
2957 add-ro Fedora-11-i686-Live.iso
2960 mkmountpoint /squash
2963 mount-loop /cd/LiveOS/squashfs.img /squash
2964 mount-loop /squash/LiveOS/ext3fs.img /ext3
2966 The inner filesystem is now unpacked under the /ext3 mountpoint.");
2968 ("rmmountpoint", (RErr, [String "path"]), 149, [],
2970 "remove a mountpoint",
2972 This calls removes a mountpoint that was previously created
2973 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
2974 for full details.");
2978 let all_functions = non_daemon_functions @ daemon_functions
2980 (* In some places we want the functions to be displayed sorted
2981 * alphabetically, so this is useful:
2983 let all_functions_sorted =
2984 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
2985 compare n1 n2) all_functions
2987 (* Field types for structures. *)
2989 | FChar (* C 'char' (really, a 7 bit byte). *)
2990 | FString (* nul-terminated ASCII string. *)
2991 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
2996 | FBytes (* Any int measure that counts bytes. *)
2997 | FUUID (* 32 bytes long, NOT nul-terminated. *)
2998 | FOptPercent (* [0..100], or -1 meaning "not present". *)
3000 (* Because we generate extra parsing code for LVM command line tools,
3001 * we have to pull out the LVM columns separately here.
3011 "pv_attr", FString (* XXX *);
3012 "pv_pe_count", FInt64;
3013 "pv_pe_alloc_count", FInt64;
3016 "pv_mda_count", FInt64;
3017 "pv_mda_free", FBytes;
3018 (* Not in Fedora 10:
3019 "pv_mda_size", FBytes;
3026 "vg_attr", FString (* XXX *);
3029 "vg_sysid", FString;
3030 "vg_extent_size", FBytes;
3031 "vg_extent_count", FInt64;
3032 "vg_free_count", FInt64;
3037 "snap_count", FInt64;
3040 "vg_mda_count", FInt64;
3041 "vg_mda_free", FBytes;
3042 (* Not in Fedora 10:
3043 "vg_mda_size", FBytes;
3049 "lv_attr", FString (* XXX *);
3052 "lv_kernel_major", FInt64;
3053 "lv_kernel_minor", FInt64;
3055 "seg_count", FInt64;
3057 "snap_percent", FOptPercent;
3058 "copy_percent", FOptPercent;
3061 "mirror_log", FString;
3065 (* Names and fields in all structures (in RStruct and RStructList)
3069 (* The old RIntBool return type, only ever used for aug_defnode. Do
3070 * not use this struct in any new code.
3073 "i", FInt32; (* for historical compatibility *)
3074 "b", FInt32; (* for historical compatibility *)
3077 (* LVM PVs, VGs, LVs. *)
3078 "lvm_pv", lvm_pv_cols;
3079 "lvm_vg", lvm_vg_cols;
3080 "lvm_lv", lvm_lv_cols;
3082 (* Column names and types from stat structures.
3083 * NB. Can't use things like 'st_atime' because glibc header files
3084 * define some of these as macros. Ugh.
3115 (* Column names in dirent structure. *)
3118 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
3123 (* Version numbers. *)
3131 (* Extended attribute. *)
3133 "attrname", FString;
3136 ] (* end of structs *)
3138 (* Ugh, Java has to be different ..
3139 * These names are also used by the Haskell bindings.
3141 let java_structs = [
3142 "int_bool", "IntBool";
3147 "statvfs", "StatVFS";
3149 "version", "Version";
3153 (* Used for testing language bindings. *)
3155 | CallString of string
3156 | CallOptString of string option
3157 | CallStringList of string list
3161 (* Used to memoize the result of pod2text. *)
3162 let pod2text_memo_filename = "src/.pod2text.data"
3163 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
3165 let chan = open_in pod2text_memo_filename in
3166 let v = input_value chan in
3170 _ -> Hashtbl.create 13
3172 (* Useful functions.
3173 * Note we don't want to use any external OCaml libraries which
3174 * makes this a bit harder than it should be.
3176 let failwithf fs = ksprintf failwith fs
3178 let replace_char s c1 c2 =
3179 let s2 = String.copy s in
3180 let r = ref false in
3181 for i = 0 to String.length s2 - 1 do
3182 if String.unsafe_get s2 i = c1 then (
3183 String.unsafe_set s2 i c2;
3187 if not !r then s else s2
3191 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
3193 let triml ?(test = isspace) str =
3195 let n = ref (String.length str) in
3196 while !n > 0 && test str.[!i]; do
3201 else String.sub str !i !n
3203 let trimr ?(test = isspace) str =
3204 let n = ref (String.length str) in
3205 while !n > 0 && test str.[!n-1]; do
3208 if !n = String.length str then str
3209 else String.sub str 0 !n
3211 let trim ?(test = isspace) str =
3212 trimr ~test (triml ~test str)
3214 let rec find s sub =
3215 let len = String.length s in
3216 let sublen = String.length sub in
3218 if i <= len-sublen then (
3220 if j < sublen then (
3221 if s.[i+j] = sub.[j] then loop2 (j+1)
3227 if r = -1 then loop (i+1) else r
3233 let rec replace_str s s1 s2 =
3234 let len = String.length s in
3235 let sublen = String.length s1 in
3236 let i = find s s1 in
3239 let s' = String.sub s 0 i in
3240 let s'' = String.sub s (i+sublen) (len-i-sublen) in
3241 s' ^ s2 ^ replace_str s'' s1 s2
3244 let rec string_split sep str =
3245 let len = String.length str in
3246 let seplen = String.length sep in
3247 let i = find str sep in
3248 if i = -1 then [str]
3250 let s' = String.sub str 0 i in
3251 let s'' = String.sub str (i+seplen) (len-i-seplen) in
3252 s' :: string_split sep s''
3255 let files_equal n1 n2 =
3256 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
3257 match Sys.command cmd with
3260 | i -> failwithf "%s: failed with error code %d" cmd i
3262 let rec find_map f = function
3263 | [] -> raise Not_found
3267 | None -> find_map f xs
3270 let rec loop i = function
3272 | x :: xs -> f i x; loop (i+1) xs
3277 let rec loop i = function
3279 | x :: xs -> let r = f i x in r :: loop (i+1) xs
3283 let name_of_argt = function
3284 | String n | OptString n | StringList n | Bool n | Int n
3285 | FileIn n | FileOut n -> n
3287 let java_name_of_struct typ =
3288 try List.assoc typ java_structs
3291 "java_name_of_struct: no java_structs entry corresponding to %s" typ
3293 let cols_of_struct typ =
3294 try List.assoc typ structs
3296 failwithf "cols_of_struct: unknown struct %s" typ
3298 let seq_of_test = function
3299 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
3300 | TestOutputListOfDevices (s, _)
3301 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
3302 | TestOutputTrue s | TestOutputFalse s
3303 | TestOutputLength (s, _) | TestOutputStruct (s, _)
3304 | TestLastFail s -> s
3306 (* Check function names etc. for consistency. *)
3307 let check_functions () =
3308 let contains_uppercase str =
3309 let len = String.length str in
3311 if i >= len then false
3314 if c >= 'A' && c <= 'Z' then true
3321 (* Check function names. *)
3323 fun (name, _, _, _, _, _, _) ->
3324 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
3325 failwithf "function name %s does not need 'guestfs' prefix" name;
3327 failwithf "function name is empty";
3328 if name.[0] < 'a' || name.[0] > 'z' then
3329 failwithf "function name %s must start with lowercase a-z" name;
3330 if String.contains name '-' then
3331 failwithf "function name %s should not contain '-', use '_' instead."
3335 (* Check function parameter/return names. *)
3337 fun (name, style, _, _, _, _, _) ->
3338 let check_arg_ret_name n =
3339 if contains_uppercase n then
3340 failwithf "%s param/ret %s should not contain uppercase chars"
3342 if String.contains n '-' || String.contains n '_' then
3343 failwithf "%s param/ret %s should not contain '-' or '_'"
3346 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;
3347 if n = "int" || n = "char" || n = "short" || n = "long" then
3348 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
3349 if n = "i" || n = "n" then
3350 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
3351 if n = "argv" || n = "args" then
3352 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name
3355 (match fst style with
3357 | RInt n | RInt64 n | RBool n | RConstString n | RString n
3358 | RStringList n | RStruct (n, _) | RStructList (n, _)
3360 check_arg_ret_name n
3362 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
3365 (* Check short descriptions. *)
3367 fun (name, _, _, _, _, shortdesc, _) ->
3368 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
3369 failwithf "short description of %s should begin with lowercase." name;
3370 let c = shortdesc.[String.length shortdesc-1] in
3371 if c = '\n' || c = '.' then
3372 failwithf "short description of %s should not end with . or \\n." name
3375 (* Check long dscriptions. *)
3377 fun (name, _, _, _, _, _, longdesc) ->
3378 if longdesc.[String.length longdesc-1] = '\n' then
3379 failwithf "long description of %s should not end with \\n." name
3382 (* Check proc_nrs. *)
3384 fun (name, _, proc_nr, _, _, _, _) ->
3385 if proc_nr <= 0 then
3386 failwithf "daemon function %s should have proc_nr > 0" name
3390 fun (name, _, proc_nr, _, _, _, _) ->
3391 if proc_nr <> -1 then
3392 failwithf "non-daemon function %s should have proc_nr -1" name
3393 ) non_daemon_functions;
3396 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
3399 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
3400 let rec loop = function
3403 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
3405 | (name1,nr1) :: (name2,nr2) :: _ ->
3406 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
3414 (* Ignore functions that have no tests. We generate a
3415 * warning when the user does 'make check' instead.
3417 | name, _, _, _, [], _, _ -> ()
3418 | name, _, _, _, tests, _, _ ->
3422 match seq_of_test test with
3424 failwithf "%s has a test containing an empty sequence" name
3425 | cmds -> List.map List.hd cmds
3427 let funcs = List.flatten funcs in
3429 let tested = List.mem name funcs in
3432 failwithf "function %s has tests but does not test itself" name
3435 (* 'pr' prints to the current output file. *)
3436 let chan = ref stdout
3437 let pr fs = ksprintf (output_string !chan) fs
3439 (* Generate a header block in a number of standard styles. *)
3440 type comment_style = CStyle | HashStyle | OCamlStyle | HaskellStyle
3441 type license = GPLv2 | LGPLv2
3443 let generate_header comment license =
3444 let c = match comment with
3445 | CStyle -> pr "/* "; " *"
3446 | HashStyle -> pr "# "; "#"
3447 | OCamlStyle -> pr "(* "; " *"
3448 | HaskellStyle -> pr "{- "; " " in
3449 pr "libguestfs generated file\n";
3450 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
3451 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
3453 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
3457 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
3458 pr "%s it under the terms of the GNU General Public License as published by\n" c;
3459 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
3460 pr "%s (at your option) any later version.\n" c;
3462 pr "%s This program is distributed in the hope that it will be useful,\n" c;
3463 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
3464 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
3465 pr "%s GNU General Public License for more details.\n" c;
3467 pr "%s You should have received a copy of the GNU General Public License along\n" c;
3468 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
3469 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
3472 pr "%s This library is free software; you can redistribute it and/or\n" c;
3473 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
3474 pr "%s License as published by the Free Software Foundation; either\n" c;
3475 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
3477 pr "%s This library is distributed in the hope that it will be useful,\n" c;
3478 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
3479 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
3480 pr "%s Lesser General Public License for more details.\n" c;
3482 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
3483 pr "%s License along with this library; if not, write to the Free Software\n" c;
3484 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
3487 | CStyle -> pr " */\n"
3489 | OCamlStyle -> pr " *)\n"
3490 | HaskellStyle -> pr "-}\n"
3494 (* Start of main code generation functions below this line. *)
3496 (* Generate the pod documentation for the C API. *)
3497 let rec generate_actions_pod () =
3499 fun (shortname, style, _, flags, _, _, longdesc) ->
3500 if not (List.mem NotInDocs flags) then (
3501 let name = "guestfs_" ^ shortname in
3502 pr "=head2 %s\n\n" name;
3504 generate_prototype ~extern:false ~handle:"handle" name style;
3506 pr "%s\n\n" longdesc;
3507 (match fst style with
3509 pr "This function returns 0 on success or -1 on error.\n\n"
3511 pr "On error this function returns -1.\n\n"
3513 pr "On error this function returns -1.\n\n"
3515 pr "This function returns a C truth value on success or -1 on error.\n\n"
3517 pr "This function returns a string, or NULL on error.
3518 The string is owned by the guest handle and must I<not> be freed.\n\n"
3520 pr "This function returns a string, or NULL on error.
3521 I<The caller must free the returned string after use>.\n\n"
3523 pr "This function returns a NULL-terminated array of strings
3524 (like L<environ(3)>), or NULL if there was an error.
3525 I<The caller must free the strings and the array after use>.\n\n"
3526 | RStruct (_, typ) ->
3527 pr "This function returns a C<struct guestfs_%s *>,
3528 or NULL if there was an error.
3529 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
3530 | RStructList (_, typ) ->
3531 pr "This function returns a C<struct guestfs_%s_list *>
3532 (see E<lt>guestfs-structs.hE<gt>),
3533 or NULL if there was an error.
3534 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
3536 pr "This function returns a NULL-terminated array of
3537 strings, or NULL if there was an error.
3538 The array of strings will always have length C<2n+1>, where
3539 C<n> keys and values alternate, followed by the trailing NULL entry.
3540 I<The caller must free the strings and the array after use>.\n\n"
3542 if List.mem ProtocolLimitWarning flags then
3543 pr "%s\n\n" protocol_limit_warning;
3544 if List.mem DangerWillRobinson flags then
3545 pr "%s\n\n" danger_will_robinson
3547 ) all_functions_sorted
3549 and generate_structs_pod () =
3550 (* Structs documentation. *)
3553 pr "=head2 guestfs_%s\n" typ;
3555 pr " struct guestfs_%s {\n" typ;
3558 | name, FChar -> pr " char %s;\n" name
3559 | name, FUInt32 -> pr " uint32_t %s;\n" name
3560 | name, FInt32 -> pr " int32_t %s;\n" name
3561 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
3562 | name, FInt64 -> pr " int64_t %s;\n" name
3563 | name, FString -> pr " char *%s;\n" name
3565 pr " /* The next two fields describe a byte array. */\n";
3566 pr " uint32_t %s_len;\n" name;
3567 pr " char *%s;\n" name
3569 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
3570 pr " char %s[32];\n" name
3571 | name, FOptPercent ->
3572 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
3573 pr " float %s;\n" name
3577 pr " struct guestfs_%s_list {\n" typ;
3578 pr " uint32_t len; /* Number of elements in list. */\n";
3579 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
3582 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
3583 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
3588 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
3589 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
3591 * We have to use an underscore instead of a dash because otherwise
3592 * rpcgen generates incorrect code.
3594 * This header is NOT exported to clients, but see also generate_structs_h.
3596 and generate_xdr () =
3597 generate_header CStyle LGPLv2;
3599 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
3600 pr "typedef string str<>;\n";
3603 (* Internal structures. *)
3607 pr "struct guestfs_int_%s {\n" typ;
3609 | name, FChar -> pr " char %s;\n" name
3610 | name, FString -> pr " string %s<>;\n" name
3611 | name, FBuffer -> pr " opaque %s<>;\n" name
3612 | name, FUUID -> pr " opaque %s[32];\n" name
3613 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
3614 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
3615 | name, FOptPercent -> pr " float %s;\n" name
3619 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
3624 fun (shortname, style, _, _, _, _, _) ->
3625 let name = "guestfs_" ^ shortname in
3627 (match snd style with
3630 pr "struct %s_args {\n" name;
3633 | String n -> pr " string %s<>;\n" n
3634 | OptString n -> pr " str *%s;\n" n
3635 | StringList n -> pr " str %s<>;\n" n
3636 | Bool n -> pr " bool %s;\n" n
3637 | Int n -> pr " int %s;\n" n
3638 | FileIn _ | FileOut _ -> ()
3642 (match fst style with
3645 pr "struct %s_ret {\n" name;
3649 pr "struct %s_ret {\n" name;
3650 pr " hyper %s;\n" n;
3653 pr "struct %s_ret {\n" name;
3657 failwithf "RConstString cannot be returned from a daemon function"
3659 pr "struct %s_ret {\n" name;
3660 pr " string %s<>;\n" n;
3663 pr "struct %s_ret {\n" name;
3664 pr " str %s<>;\n" n;
3666 | RStruct (n, typ) ->
3667 pr "struct %s_ret {\n" name;
3668 pr " guestfs_int_%s %s;\n" typ n;
3670 | RStructList (n, typ) ->
3671 pr "struct %s_ret {\n" name;
3672 pr " guestfs_int_%s_list %s;\n" typ n;
3675 pr "struct %s_ret {\n" name;
3676 pr " str %s<>;\n" n;
3681 (* Table of procedure numbers. *)
3682 pr "enum guestfs_procedure {\n";
3684 fun (shortname, _, proc_nr, _, _, _, _) ->
3685 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
3687 pr " GUESTFS_PROC_NR_PROCS\n";
3691 (* Having to choose a maximum message size is annoying for several
3692 * reasons (it limits what we can do in the API), but it (a) makes
3693 * the protocol a lot simpler, and (b) provides a bound on the size
3694 * of the daemon which operates in limited memory space. For large
3695 * file transfers you should use FTP.
3697 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
3700 (* Message header, etc. *)
3702 /* The communication protocol is now documented in the guestfs(3)
3706 const GUESTFS_PROGRAM = 0x2000F5F5;
3707 const GUESTFS_PROTOCOL_VERSION = 1;
3709 /* These constants must be larger than any possible message length. */
3710 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
3711 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
3713 enum guestfs_message_direction {
3714 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
3715 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
3718 enum guestfs_message_status {
3719 GUESTFS_STATUS_OK = 0,
3720 GUESTFS_STATUS_ERROR = 1
3723 const GUESTFS_ERROR_LEN = 256;
3725 struct guestfs_message_error {
3726 string error_message<GUESTFS_ERROR_LEN>;
3729 struct guestfs_message_header {
3730 unsigned prog; /* GUESTFS_PROGRAM */
3731 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
3732 guestfs_procedure proc; /* GUESTFS_PROC_x */
3733 guestfs_message_direction direction;
3734 unsigned serial; /* message serial number */
3735 guestfs_message_status status;
3738 const GUESTFS_MAX_CHUNK_SIZE = 8192;
3740 struct guestfs_chunk {
3741 int cancel; /* if non-zero, transfer is cancelled */
3742 /* data size is 0 bytes if the transfer has finished successfully */
3743 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
3747 (* Generate the guestfs-structs.h file. *)
3748 and generate_structs_h () =
3749 generate_header CStyle LGPLv2;
3751 (* This is a public exported header file containing various
3752 * structures. The structures are carefully written to have
3753 * exactly the same in-memory format as the XDR structures that
3754 * we use on the wire to the daemon. The reason for creating
3755 * copies of these structures here is just so we don't have to
3756 * export the whole of guestfs_protocol.h (which includes much
3757 * unrelated and XDR-dependent stuff that we don't want to be
3758 * public, or required by clients).
3760 * To reiterate, we will pass these structures to and from the
3761 * client with a simple assignment or memcpy, so the format
3762 * must be identical to what rpcgen / the RFC defines.
3765 (* Public structures. *)
3768 pr "struct guestfs_%s {\n" typ;
3771 | name, FChar -> pr " char %s;\n" name
3772 | name, FString -> pr " char *%s;\n" name
3774 pr " uint32_t %s_len;\n" name;
3775 pr " char *%s;\n" name
3776 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
3777 | name, FUInt32 -> pr " uint32_t %s;\n" name
3778 | name, FInt32 -> pr " int32_t %s;\n" name
3779 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
3780 | name, FInt64 -> pr " int64_t %s;\n" name
3781 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
3785 pr "struct guestfs_%s_list {\n" typ;
3786 pr " uint32_t len;\n";
3787 pr " struct guestfs_%s *val;\n" typ;
3790 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
3791 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
3795 (* Generate the guestfs-actions.h file. *)
3796 and generate_actions_h () =
3797 generate_header CStyle LGPLv2;
3799 fun (shortname, style, _, _, _, _, _) ->
3800 let name = "guestfs_" ^ shortname in
3801 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
3805 (* Generate the client-side dispatch stubs. *)
3806 and generate_client_actions () =
3807 generate_header CStyle LGPLv2;
3813 #include \"guestfs.h\"
3814 #include \"guestfs_protocol.h\"
3816 #define error guestfs_error
3817 #define perrorf guestfs_perrorf
3818 #define safe_malloc guestfs_safe_malloc
3819 #define safe_realloc guestfs_safe_realloc
3820 #define safe_strdup guestfs_safe_strdup
3821 #define safe_memdup guestfs_safe_memdup
3823 /* Check the return message from a call for validity. */
3825 check_reply_header (guestfs_h *g,
3826 const struct guestfs_message_header *hdr,
3827 int proc_nr, int serial)
3829 if (hdr->prog != GUESTFS_PROGRAM) {
3830 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
3833 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
3834 error (g, \"wrong protocol version (%%d/%%d)\",
3835 hdr->vers, GUESTFS_PROTOCOL_VERSION);
3838 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
3839 error (g, \"unexpected message direction (%%d/%%d)\",
3840 hdr->direction, GUESTFS_DIRECTION_REPLY);
3843 if (hdr->proc != proc_nr) {
3844 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
3847 if (hdr->serial != serial) {
3848 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
3855 /* Check we are in the right state to run a high-level action. */
3857 check_state (guestfs_h *g, const char *caller)
3859 if (!guestfs_is_ready (g)) {
3860 if (guestfs_is_config (g))
3861 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
3863 else if (guestfs_is_launching (g))
3864 error (g, \"%%s: call wait_ready() before using this function\",
3867 error (g, \"%%s called from the wrong state, %%d != READY\",
3868 caller, guestfs_get_state (g));
3876 (* Client-side stubs for each function. *)
3878 fun (shortname, style, _, _, _, _, _) ->
3879 let name = "guestfs_" ^ shortname in
3881 (* Generate the context struct which stores the high-level
3882 * state between callback functions.
3884 pr "struct %s_ctx {\n" shortname;
3885 pr " /* This flag is set by the callbacks, so we know we've done\n";
3886 pr " * the callbacks as expected, and in the right sequence.\n";
3887 pr " * 0 = not called, 1 = reply_cb called.\n";
3889 pr " int cb_sequence;\n";
3890 pr " struct guestfs_message_header hdr;\n";
3891 pr " struct guestfs_message_error err;\n";
3892 (match fst style with
3895 failwithf "RConstString cannot be returned from a daemon function"
3897 | RBool _ | RString _ | RStringList _
3898 | RStruct _ | RStructList _
3900 pr " struct %s_ret ret;\n" name
3905 (* Generate the reply callback function. *)
3906 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
3908 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
3909 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
3911 pr " /* This should definitely not happen. */\n";
3912 pr " if (ctx->cb_sequence != 0) {\n";
3913 pr " ctx->cb_sequence = 9999;\n";
3914 pr " error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
3918 pr " ml->main_loop_quit (ml, g);\n";
3920 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
3921 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
3924 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
3925 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
3926 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
3933 (match fst style with
3936 failwithf "RConstString cannot be returned from a daemon function"
3938 | RBool _ | RString _ | RStringList _
3939 | RStruct _ | RStructList _
3941 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
3942 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
3948 pr " ctx->cb_sequence = 1;\n";
3951 (* Generate the action stub. *)
3952 generate_prototype ~extern:false ~semicolon:false ~newline:true
3953 ~handle:"g" name style;
3956 match fst style with
3957 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
3959 failwithf "RConstString cannot be returned from a daemon function"
3960 | RString _ | RStringList _
3961 | RStruct _ | RStructList _
3967 (match snd style with
3969 | _ -> pr " struct %s_args args;\n" name
3972 pr " struct %s_ctx ctx;\n" shortname;
3973 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
3974 pr " int serial;\n";
3976 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
3977 pr " guestfs_set_busy (g);\n";
3979 pr " memset (&ctx, 0, sizeof ctx);\n";
3982 (* Send the main header and arguments. *)
3983 (match snd style with
3985 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
3986 (String.uppercase shortname)
3991 pr " args.%s = (char *) %s;\n" n n
3993 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
3995 pr " args.%s.%s_val = (char **) %s;\n" n n n;
3996 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
3998 pr " args.%s = %s;\n" n n
4000 pr " args.%s = %s;\n" n n
4001 | FileIn _ | FileOut _ -> ()
4003 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
4004 (String.uppercase shortname);
4005 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
4008 pr " if (serial == -1) {\n";
4009 pr " guestfs_end_busy (g);\n";
4010 pr " return %s;\n" error_code;
4014 (* Send any additional files (FileIn) requested. *)
4015 let need_read_reply_label = ref false in
4022 pr " r = guestfs__send_file_sync (g, %s);\n" n;
4023 pr " if (r == -1) {\n";
4024 pr " guestfs_end_busy (g);\n";
4025 pr " return %s;\n" error_code;
4027 pr " if (r == -2) /* daemon cancelled */\n";
4028 pr " goto read_reply;\n";
4029 need_read_reply_label := true;
4035 (* Wait for the reply from the remote end. *)
4036 if !need_read_reply_label then pr " read_reply:\n";
4037 pr " guestfs__switch_to_receiving (g);\n";
4038 pr " ctx.cb_sequence = 0;\n";
4039 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
4040 pr " (void) ml->main_loop_run (ml, g);\n";
4041 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
4042 pr " if (ctx.cb_sequence != 1) {\n";
4043 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
4044 pr " guestfs_end_busy (g);\n";
4045 pr " return %s;\n" error_code;
4049 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
4050 (String.uppercase shortname);
4051 pr " guestfs_end_busy (g);\n";
4052 pr " return %s;\n" error_code;
4056 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
4057 pr " error (g, \"%%s\", ctx.err.error_message);\n";
4058 pr " free (ctx.err.error_message);\n";
4059 pr " guestfs_end_busy (g);\n";
4060 pr " return %s;\n" error_code;
4064 (* Expecting to receive further files (FileOut)? *)
4068 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
4069 pr " guestfs_end_busy (g);\n";
4070 pr " return %s;\n" error_code;
4076 pr " guestfs_end_busy (g);\n";
4078 (match fst style with
4079 | RErr -> pr " return 0;\n"
4080 | RInt n | RInt64 n | RBool n ->
4081 pr " return ctx.ret.%s;\n" n
4083 failwithf "RConstString cannot be returned from a daemon function"
4085 pr " return ctx.ret.%s; /* caller will free */\n" n
4086 | RStringList n | RHashtable n ->
4087 pr " /* caller will free this, but we need to add a NULL entry */\n";
4088 pr " ctx.ret.%s.%s_val =\n" n n;
4089 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
4090 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
4092 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
4093 pr " return ctx.ret.%s.%s_val;\n" n n
4095 pr " /* caller will free this */\n";
4096 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
4097 | RStructList (n, _) ->
4098 pr " /* caller will free this */\n";
4099 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
4105 (* Functions to free structures. *)
4106 pr "/* Structure-freeing functions. These rely on the fact that the\n";
4107 pr " * structure format is identical to the XDR format. See note in\n";
4108 pr " * generator.ml.\n";
4115 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
4117 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
4123 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
4125 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
4132 (* Generate daemon/actions.h. *)
4133 and generate_daemon_actions_h () =
4134 generate_header CStyle GPLv2;
4136 pr "#include \"../src/guestfs_protocol.h\"\n";
4140 fun (name, style, _, _, _, _, _) ->
4142 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
4146 (* Generate the server-side stubs. *)
4147 and generate_daemon_actions () =
4148 generate_header CStyle GPLv2;
4150 pr "#include <config.h>\n";
4152 pr "#include <stdio.h>\n";
4153 pr "#include <stdlib.h>\n";
4154 pr "#include <string.h>\n";
4155 pr "#include <inttypes.h>\n";
4156 pr "#include <ctype.h>\n";
4157 pr "#include <rpc/types.h>\n";
4158 pr "#include <rpc/xdr.h>\n";
4160 pr "#include \"daemon.h\"\n";
4161 pr "#include \"../src/guestfs_protocol.h\"\n";
4162 pr "#include \"actions.h\"\n";
4166 fun (name, style, _, _, _, _, _) ->
4167 (* Generate server-side stubs. *)
4168 pr "static void %s_stub (XDR *xdr_in)\n" name;
4171 match fst style with
4172 | RErr | RInt _ -> pr " int r;\n"; "-1"
4173 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4174 | RBool _ -> pr " int r;\n"; "-1"
4176 failwithf "RConstString cannot be returned from a daemon function"
4177 | RString _ -> pr " char *r;\n"; "NULL"
4178 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
4179 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
4180 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL" in
4182 (match snd style with
4185 pr " struct guestfs_%s_args args;\n" name;
4188 (* Note we allow the string to be writable, in order to
4189 * allow device name translation. This is safe because
4190 * we can modify the string (passed from RPC).
4193 | OptString n -> pr " char *%s;\n" n
4194 | StringList n -> pr " char **%s;\n" n
4195 | Bool n -> pr " int %s;\n" n
4196 | Int n -> pr " int %s;\n" n
4197 | FileIn _ | FileOut _ -> ()
4202 (match snd style with
4205 pr " memset (&args, 0, sizeof args);\n";
4207 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
4208 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
4213 | String n -> pr " %s = args.%s;\n" n n
4214 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
4216 pr " %s = realloc (args.%s.%s_val,\n" n n n;
4217 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
4218 pr " if (%s == NULL) {\n" n;
4219 pr " reply_with_perror (\"realloc\");\n";
4222 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
4223 pr " args.%s.%s_val = %s;\n" n n n;
4224 | Bool n -> pr " %s = args.%s;\n" n n
4225 | Int n -> pr " %s = args.%s;\n" n n
4226 | FileIn _ | FileOut _ -> ()
4231 (* Don't want to call the impl with any FileIn or FileOut
4232 * parameters, since these go "outside" the RPC protocol.
4235 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
4237 pr " r = do_%s " name;
4238 generate_call_args argsnofile;
4241 pr " if (r == %s)\n" error_code;
4242 pr " /* do_%s has already called reply_with_error */\n" name;
4246 (* If there are any FileOut parameters, then the impl must
4247 * send its own reply.
4250 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
4252 pr " /* do_%s has already sent a reply */\n" name
4254 match fst style with
4255 | RErr -> pr " reply (NULL, NULL);\n"
4256 | RInt n | RInt64 n | RBool n ->
4257 pr " struct guestfs_%s_ret ret;\n" name;
4258 pr " ret.%s = r;\n" n;
4259 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4262 failwithf "RConstString cannot be returned from a daemon function"
4264 pr " struct guestfs_%s_ret ret;\n" name;
4265 pr " ret.%s = r;\n" n;
4266 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4269 | RStringList n | RHashtable n ->
4270 pr " struct guestfs_%s_ret ret;\n" name;
4271 pr " ret.%s.%s_len = count_strings (r);\n" n n;
4272 pr " ret.%s.%s_val = r;\n" n n;
4273 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4275 pr " free_strings (r);\n"
4277 pr " struct guestfs_%s_ret ret;\n" name;
4278 pr " ret.%s = *r;\n" n;
4279 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4281 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4283 | RStructList (n, _) ->
4284 pr " struct guestfs_%s_ret ret;\n" name;
4285 pr " ret.%s = *r;\n" n;
4286 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4288 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4292 (* Free the args. *)
4293 (match snd style with
4298 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
4305 (* Dispatch function. *)
4306 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
4308 pr " switch (proc_nr) {\n";
4311 fun (name, style, _, _, _, _, _) ->
4312 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
4313 pr " %s_stub (xdr_in);\n" name;
4318 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";
4323 (* LVM columns and tokenization functions. *)
4324 (* XXX This generates crap code. We should rethink how we
4330 pr "static const char *lvm_%s_cols = \"%s\";\n"
4331 typ (String.concat "," (List.map fst cols));
4334 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
4336 pr " char *tok, *p, *next;\n";
4340 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
4343 pr " if (!str) {\n";
4344 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
4347 pr " if (!*str || isspace (*str)) {\n";
4348 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
4353 fun (name, coltype) ->
4354 pr " if (!tok) {\n";
4355 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
4358 pr " p = strchrnul (tok, ',');\n";
4359 pr " if (*p) next = p+1; else next = NULL;\n";
4360 pr " *p = '\\0';\n";
4363 pr " r->%s = strdup (tok);\n" name;
4364 pr " if (r->%s == NULL) {\n" name;
4365 pr " perror (\"strdup\");\n";
4369 pr " for (i = j = 0; i < 32; ++j) {\n";
4370 pr " if (tok[j] == '\\0') {\n";
4371 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
4373 pr " } else if (tok[j] != '-')\n";
4374 pr " r->%s[i++] = tok[j];\n" name;
4377 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
4378 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4382 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
4383 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4387 pr " if (tok[0] == '\\0')\n";
4388 pr " r->%s = -1;\n" name;
4389 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
4390 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4393 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
4394 assert false (* can never be an LVM column *)
4396 pr " tok = next;\n";
4399 pr " if (tok != NULL) {\n";
4400 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
4407 pr "guestfs_int_lvm_%s_list *\n" typ;
4408 pr "parse_command_line_%ss (void)\n" typ;
4410 pr " char *out, *err;\n";
4411 pr " char *p, *pend;\n";
4413 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
4414 pr " void *newp;\n";
4416 pr " ret = malloc (sizeof *ret);\n";
4417 pr " if (!ret) {\n";
4418 pr " reply_with_perror (\"malloc\");\n";
4419 pr " return NULL;\n";
4422 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
4423 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
4425 pr " r = command (&out, &err,\n";
4426 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
4427 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
4428 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
4429 pr " if (r == -1) {\n";
4430 pr " reply_with_error (\"%%s\", err);\n";
4431 pr " free (out);\n";
4432 pr " free (err);\n";
4433 pr " free (ret);\n";
4434 pr " return NULL;\n";
4437 pr " free (err);\n";
4439 pr " /* Tokenize each line of the output. */\n";
4442 pr " while (p) {\n";
4443 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
4444 pr " if (pend) {\n";
4445 pr " *pend = '\\0';\n";
4449 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
4452 pr " if (!*p) { /* Empty line? Skip it. */\n";
4457 pr " /* Allocate some space to store this next entry. */\n";
4458 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
4459 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
4460 pr " if (newp == NULL) {\n";
4461 pr " reply_with_perror (\"realloc\");\n";
4462 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
4463 pr " free (ret);\n";
4464 pr " free (out);\n";
4465 pr " return NULL;\n";
4467 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
4469 pr " /* Tokenize the next entry. */\n";
4470 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
4471 pr " if (r == -1) {\n";
4472 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
4473 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
4474 pr " free (ret);\n";
4475 pr " free (out);\n";
4476 pr " return NULL;\n";
4483 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
4485 pr " free (out);\n";
4486 pr " return ret;\n";
4489 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
4491 (* Generate a list of function names, for debugging in the daemon.. *)
4492 and generate_daemon_names () =
4493 generate_header CStyle GPLv2;
4495 pr "#include <config.h>\n";
4497 pr "#include \"daemon.h\"\n";
4500 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
4501 pr "const char *function_names[] = {\n";
4503 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
4507 (* Generate the tests. *)
4508 and generate_tests () =
4509 generate_header CStyle GPLv2;
4516 #include <sys/types.h>
4519 #include \"guestfs.h\"
4521 static guestfs_h *g;
4522 static int suppress_error = 0;
4524 static void print_error (guestfs_h *g, void *data, const char *msg)
4526 if (!suppress_error)
4527 fprintf (stderr, \"%%s\\n\", msg);
4530 static void print_strings (char * const * const argv)
4534 for (argc = 0; argv[argc] != NULL; ++argc)
4535 printf (\"\\t%%s\\n\", argv[argc]);
4539 static void print_table (char * const * const argv)
4543 for (i = 0; argv[i] != NULL; i += 2)
4544 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
4548 static void no_test_warnings (void)
4554 | name, _, _, _, [], _, _ ->
4555 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
4556 | name, _, _, _, tests, _, _ -> ()
4562 (* Generate the actual tests. Note that we generate the tests
4563 * in reverse order, deliberately, so that (in general) the
4564 * newest tests run first. This makes it quicker and easier to
4569 fun (name, _, _, _, tests, _, _) ->
4570 mapi (generate_one_test name) tests
4571 ) (List.rev all_functions) in
4572 let test_names = List.concat test_names in
4573 let nr_tests = List.length test_names in
4576 int main (int argc, char *argv[])
4580 const char *filename;
4582 int nr_tests, test_num = 0;
4584 setbuf (stdout, NULL);
4586 no_test_warnings ();
4588 g = guestfs_create ();
4590 printf (\"guestfs_create FAILED\\n\");
4594 guestfs_set_error_handler (g, print_error, NULL);
4596 guestfs_set_path (g, \"../appliance\");
4598 filename = \"test1.img\";
4599 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
4604 if (lseek (fd, %d, SEEK_SET) == -1) {
4610 if (write (fd, &c, 1) == -1) {
4616 if (close (fd) == -1) {
4621 if (guestfs_add_drive (g, filename) == -1) {
4622 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
4626 filename = \"test2.img\";
4627 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
4632 if (lseek (fd, %d, SEEK_SET) == -1) {
4638 if (write (fd, &c, 1) == -1) {
4644 if (close (fd) == -1) {
4649 if (guestfs_add_drive (g, filename) == -1) {
4650 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
4654 filename = \"test3.img\";
4655 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
4660 if (lseek (fd, %d, SEEK_SET) == -1) {
4666 if (write (fd, &c, 1) == -1) {
4672 if (close (fd) == -1) {
4677 if (guestfs_add_drive (g, filename) == -1) {
4678 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
4682 if (guestfs_add_drive_ro (g, \"../images/test.sqsh\") == -1) {
4683 printf (\"guestfs_add_drive_ro ../images/test.sqsh FAILED\\n\");
4687 if (guestfs_launch (g) == -1) {
4688 printf (\"guestfs_launch FAILED\\n\");
4692 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
4695 if (guestfs_wait_ready (g) == -1) {
4696 printf (\"guestfs_wait_ready FAILED\\n\");
4700 /* Cancel previous alarm. */
4705 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
4709 pr " test_num++;\n";
4710 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
4711 pr " if (%s () == -1) {\n" test_name;
4712 pr " printf (\"%s FAILED\\n\");\n" test_name;
4718 pr " guestfs_close (g);\n";
4719 pr " unlink (\"test1.img\");\n";
4720 pr " unlink (\"test2.img\");\n";
4721 pr " unlink (\"test3.img\");\n";
4724 pr " if (failed > 0) {\n";
4725 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
4733 and generate_one_test name i (init, prereq, test) =
4734 let test_name = sprintf "test_%s_%d" name i in
4737 static int %s_skip (void)
4741 str = getenv (\"TEST_ONLY\");
4743 return strstr (str, \"%s\") == NULL;
4744 str = getenv (\"SKIP_%s\");
4745 if (str && strcmp (str, \"1\") == 0) return 1;
4746 str = getenv (\"SKIP_TEST_%s\");
4747 if (str && strcmp (str, \"1\") == 0) return 1;
4751 " test_name name (String.uppercase test_name) (String.uppercase name);
4754 | Disabled | Always -> ()
4755 | If code | Unless code ->
4756 pr "static int %s_prereq (void)\n" test_name;
4764 static int %s (void)
4767 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
4771 " test_name test_name test_name;
4775 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
4777 pr " if (! %s_prereq ()) {\n" test_name;
4778 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
4782 generate_one_test_body name i test_name init test;
4784 pr " if (%s_prereq ()) {\n" test_name;
4785 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
4789 generate_one_test_body name i test_name init test;
4791 generate_one_test_body name i test_name init test
4799 and generate_one_test_body name i test_name init test =
4801 | InitNone (* XXX at some point, InitNone and InitEmpty became
4802 * folded together as the same thing. Really we should
4803 * make InitNone do nothing at all, but the tests may
4804 * need to be checked to make sure this is OK.
4807 pr " /* InitNone|InitEmpty for %s */\n" test_name;
4808 List.iter (generate_test_command_call test_name)
4809 [["blockdev_setrw"; "/dev/sda"];
4813 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
4814 List.iter (generate_test_command_call test_name)
4815 [["blockdev_setrw"; "/dev/sda"];
4818 ["sfdiskM"; "/dev/sda"; ","];
4819 ["mkfs"; "ext2"; "/dev/sda1"];
4820 ["mount"; "/dev/sda1"; "/"]]
4821 | InitBasicFSonLVM ->
4822 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
4824 List.iter (generate_test_command_call test_name)
4825 [["blockdev_setrw"; "/dev/sda"];
4828 ["sfdiskM"; "/dev/sda"; ","];
4829 ["pvcreate"; "/dev/sda1"];
4830 ["vgcreate"; "VG"; "/dev/sda1"];
4831 ["lvcreate"; "LV"; "VG"; "8"];
4832 ["mkfs"; "ext2"; "/dev/VG/LV"];
4833 ["mount"; "/dev/VG/LV"; "/"]]
4836 let get_seq_last = function
4838 failwithf "%s: you cannot use [] (empty list) when expecting a command"
4841 let seq = List.rev seq in
4842 List.rev (List.tl seq), List.hd seq
4847 pr " /* TestRun for %s (%d) */\n" name i;
4848 List.iter (generate_test_command_call test_name) seq
4849 | TestOutput (seq, expected) ->
4850 pr " /* TestOutput for %s (%d) */\n" name i;
4851 pr " const char *expected = \"%s\";\n" (c_quote expected);
4852 let seq, last = get_seq_last seq in
4854 pr " if (strcmp (r, expected) != 0) {\n";
4855 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
4859 List.iter (generate_test_command_call test_name) seq;
4860 generate_test_command_call ~test test_name last
4861 | TestOutputList (seq, expected) ->
4862 pr " /* TestOutputList for %s (%d) */\n" name i;
4863 let seq, last = get_seq_last seq in
4867 pr " if (!r[%d]) {\n" i;
4868 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
4869 pr " print_strings (r);\n";
4873 pr " const char *expected = \"%s\";\n" (c_quote str);
4874 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
4875 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
4880 pr " if (r[%d] != NULL) {\n" (List.length expected);
4881 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
4883 pr " print_strings (r);\n";
4887 List.iter (generate_test_command_call test_name) seq;
4888 generate_test_command_call ~test test_name last
4889 | TestOutputListOfDevices (seq, expected) ->
4890 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
4891 let seq, last = get_seq_last seq in
4895 pr " if (!r[%d]) {\n" i;
4896 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
4897 pr " print_strings (r);\n";
4901 pr " const char *expected = \"%s\";\n" (c_quote str);
4902 pr " r[%d][5] = 's';\n" i;
4903 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
4904 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
4909 pr " if (r[%d] != NULL) {\n" (List.length expected);
4910 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
4912 pr " print_strings (r);\n";
4916 List.iter (generate_test_command_call test_name) seq;
4917 generate_test_command_call ~test test_name last
4918 | TestOutputInt (seq, expected) ->
4919 pr " /* TestOutputInt for %s (%d) */\n" name i;
4920 let seq, last = get_seq_last seq in
4922 pr " if (r != %d) {\n" expected;
4923 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
4929 List.iter (generate_test_command_call test_name) seq;
4930 generate_test_command_call ~test test_name last
4931 | TestOutputIntOp (seq, op, expected) ->
4932 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
4933 let seq, last = get_seq_last seq in
4935 pr " if (! (r %s %d)) {\n" op expected;
4936 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
4937 test_name op expected;
4942 List.iter (generate_test_command_call test_name) seq;
4943 generate_test_command_call ~test test_name last
4944 | TestOutputTrue seq ->
4945 pr " /* TestOutputTrue for %s (%d) */\n" name i;
4946 let seq, last = get_seq_last seq in
4949 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
4954 List.iter (generate_test_command_call test_name) seq;
4955 generate_test_command_call ~test test_name last
4956 | TestOutputFalse seq ->
4957 pr " /* TestOutputFalse for %s (%d) */\n" name i;
4958 let seq, last = get_seq_last seq in
4961 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
4966 List.iter (generate_test_command_call test_name) seq;
4967 generate_test_command_call ~test test_name last
4968 | TestOutputLength (seq, expected) ->
4969 pr " /* TestOutputLength for %s (%d) */\n" name i;
4970 let seq, last = get_seq_last seq in
4973 pr " for (j = 0; j < %d; ++j)\n" expected;
4974 pr " if (r[j] == NULL) {\n";
4975 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
4977 pr " print_strings (r);\n";
4980 pr " if (r[j] != NULL) {\n";
4981 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
4983 pr " print_strings (r);\n";
4987 List.iter (generate_test_command_call test_name) seq;
4988 generate_test_command_call ~test test_name last
4989 | TestOutputStruct (seq, checks) ->
4990 pr " /* TestOutputStruct for %s (%d) */\n" name i;
4991 let seq, last = get_seq_last seq in
4995 | CompareWithInt (field, expected) ->
4996 pr " if (r->%s != %d) {\n" field expected;
4997 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
4998 test_name field expected;
4999 pr " (int) r->%s);\n" field;
5002 | CompareWithIntOp (field, op, expected) ->
5003 pr " if (!(r->%s %s %d)) {\n" field op expected;
5004 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
5005 test_name field op expected;
5006 pr " (int) r->%s);\n" field;
5009 | CompareWithString (field, expected) ->
5010 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
5011 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
5012 test_name field expected;
5013 pr " r->%s);\n" field;
5016 | CompareFieldsIntEq (field1, field2) ->
5017 pr " if (r->%s != r->%s) {\n" field1 field2;
5018 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
5019 test_name field1 field2;
5020 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
5023 | CompareFieldsStrEq (field1, field2) ->
5024 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
5025 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
5026 test_name field1 field2;
5027 pr " r->%s, r->%s);\n" field1 field2;
5032 List.iter (generate_test_command_call test_name) seq;
5033 generate_test_command_call ~test test_name last
5034 | TestLastFail seq ->
5035 pr " /* TestLastFail for %s (%d) */\n" name i;
5036 let seq, last = get_seq_last seq in
5037 List.iter (generate_test_command_call test_name) seq;
5038 generate_test_command_call test_name ~expect_error:true last
5040 (* Generate the code to run a command, leaving the result in 'r'.
5041 * If you expect to get an error then you should set expect_error:true.
5043 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
5045 | [] -> assert false
5047 (* Look up the command to find out what args/ret it has. *)
5050 let _, style, _, _, _, _, _ =
5051 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
5054 failwithf "%s: in test, command %s was not found" test_name name in
5056 if List.length (snd style) <> List.length args then
5057 failwithf "%s: in test, wrong number of args given to %s"
5064 | OptString n, "NULL" -> ()
5066 | OptString n, arg ->
5067 pr " const char *%s = \"%s\";\n" n (c_quote arg);
5070 | FileIn _, _ | FileOut _, _ -> ()
5071 | StringList n, arg ->
5072 let strs = string_split " " arg in
5075 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
5077 pr " const char *%s[] = {\n" n;
5079 fun i _ -> pr " %s_%d,\n" n i
5083 ) (List.combine (snd style) args);
5086 match fst style with
5087 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5088 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5089 | RConstString _ -> pr " const char *r;\n"; "NULL"
5090 | RString _ -> pr " char *r;\n"; "NULL"
5091 | RStringList _ | RHashtable _ ->
5095 | RStruct (_, typ) ->
5096 pr " struct guestfs_%s *r;\n" typ; "NULL"
5097 | RStructList (_, typ) ->
5098 pr " struct guestfs_%s_list *r;\n" typ; "NULL" in
5100 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
5101 pr " r = guestfs_%s (g" name;
5103 (* Generate the parameters. *)
5106 | OptString _, "NULL" -> pr ", NULL"
5110 | FileIn _, arg | FileOut _, arg ->
5111 pr ", \"%s\"" (c_quote arg)
5112 | StringList n, _ ->
5116 try int_of_string arg
5117 with Failure "int_of_string" ->
5118 failwithf "%s: expecting an int, but got '%s'" test_name arg in
5121 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
5122 ) (List.combine (snd style) args);
5125 if not expect_error then
5126 pr " if (r == %s)\n" error_code
5128 pr " if (r != %s)\n" error_code;
5131 (* Insert the test code. *)
5137 (match fst style with
5138 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _ -> ()
5139 | RString _ -> pr " free (r);\n"
5140 | RStringList _ | RHashtable _ ->
5141 pr " for (i = 0; r[i] != NULL; ++i)\n";
5142 pr " free (r[i]);\n";
5144 | RStruct (_, typ) ->
5145 pr " guestfs_free_%s (r);\n" typ
5146 | RStructList (_, typ) ->
5147 pr " guestfs_free_%s_list (r);\n" typ
5153 let str = replace_str str "\r" "\\r" in
5154 let str = replace_str str "\n" "\\n" in
5155 let str = replace_str str "\t" "\\t" in
5156 let str = replace_str str "\000" "\\0" in
5159 (* Generate a lot of different functions for guestfish. *)
5160 and generate_fish_cmds () =
5161 generate_header CStyle GPLv2;
5165 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5167 let all_functions_sorted =
5169 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5170 ) all_functions_sorted in
5172 pr "#include <stdio.h>\n";
5173 pr "#include <stdlib.h>\n";
5174 pr "#include <string.h>\n";
5175 pr "#include <inttypes.h>\n";
5176 pr "#include <ctype.h>\n";
5178 pr "#include <guestfs.h>\n";
5179 pr "#include \"fish.h\"\n";
5182 (* list_commands function, which implements guestfish -h *)
5183 pr "void list_commands (void)\n";
5185 pr " printf (\" %%-16s %%s\\n\", \"Command\", \"Description\");\n";
5186 pr " list_builtin_commands ();\n";
5188 fun (name, _, _, flags, _, shortdesc, _) ->
5189 let name = replace_char name '_' '-' in
5190 pr " printf (\"%%-20s %%s\\n\", \"%s\", \"%s\");\n"
5192 ) all_functions_sorted;
5193 pr " printf (\" Use -h <cmd> / help <cmd> to show detailed help for a command.\\n\");\n";
5197 (* display_command function, which implements guestfish -h cmd *)
5198 pr "void display_command (const char *cmd)\n";
5201 fun (name, style, _, flags, _, shortdesc, longdesc) ->
5202 let name2 = replace_char name '_' '-' in
5204 try find_map (function FishAlias n -> Some n | _ -> None) flags
5205 with Not_found -> name in
5206 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
5208 match snd style with
5212 name2 (String.concat "> <" (List.map name_of_argt args)) in
5215 if List.mem ProtocolLimitWarning flags then
5216 ("\n\n" ^ protocol_limit_warning)
5219 (* For DangerWillRobinson commands, we should probably have
5220 * guestfish prompt before allowing you to use them (especially
5221 * in interactive mode). XXX
5225 if List.mem DangerWillRobinson flags then
5226 ("\n\n" ^ danger_will_robinson)
5229 let describe_alias =
5230 if name <> alias then
5231 sprintf "\n\nYou can use '%s' as an alias for this command." alias
5235 pr "strcasecmp (cmd, \"%s\") == 0" name;
5236 if name <> name2 then
5237 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
5238 if name <> alias then
5239 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
5241 pr " pod2text (\"%s - %s\", %S);\n"
5243 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
5246 pr " display_builtin_command (cmd);\n";
5250 (* print_* functions *)
5254 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
5256 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
5265 pr " printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
5267 pr " printf (\"%s: \");\n" name;
5268 pr " for (i = 0; i < 32; ++i)\n";
5269 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
5270 pr " printf (\"\\n\");\n"
5272 pr " printf (\"%s: \");\n" name;
5273 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
5274 pr " if (isprint (%s->%s[i]))\n" typ name;
5275 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
5277 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
5278 pr " printf (\"\\n\");\n"
5279 | name, (FUInt64|FBytes) ->
5280 pr " printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
5282 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
5284 pr " printf (\"%s: %%\" PRIu32 \"\\n\", %s->%s);\n" name typ name
5286 pr " printf (\"%s: %%\" PRIi32 \"\\n\", %s->%s);\n" name typ name
5288 pr " printf (\"%s: %%c\\n\", %s->%s);\n" name typ name
5289 | name, FOptPercent ->
5290 pr " if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
5291 typ name name typ name;
5292 pr " else printf (\"%s: \\n\");\n" name
5296 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
5301 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
5302 pr " print_%s (&%ss->val[i]);\n" typ typ;
5307 (* run_<action> actions *)
5309 fun (name, style, _, flags, _, _, _) ->
5310 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
5312 (match fst style with
5315 | RBool _ -> pr " int r;\n"
5316 | RInt64 _ -> pr " int64_t r;\n"
5317 | RConstString _ -> pr " const char *r;\n"
5318 | RString _ -> pr " char *r;\n"
5319 | RStringList _ | RHashtable _ -> pr " char **r;\n"
5320 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
5321 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
5328 | FileOut n -> pr " const char *%s;\n" n
5329 | StringList n -> pr " char **%s;\n" n
5330 | Bool n -> pr " int %s;\n" n
5331 | Int n -> pr " int %s;\n" n
5334 (* Check and convert parameters. *)
5335 let argc_expected = List.length (snd style) in
5336 pr " if (argc != %d) {\n" argc_expected;
5337 pr " fprintf (stderr, \"%%s should have %d parameter(s)\\n\", cmd);\n"
5339 pr " fprintf (stderr, \"type 'help %%s' for help on %%s\\n\", cmd, cmd);\n";
5345 | String name -> pr " %s = argv[%d];\n" name i
5347 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
5350 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
5353 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
5355 | StringList name ->
5356 pr " %s = parse_string_list (argv[%d]);\n" name i
5358 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
5360 pr " %s = atoi (argv[%d]);\n" name i
5363 (* Call C API function. *)
5365 try find_map (function FishAction n -> Some n | _ -> None) flags
5366 with Not_found -> sprintf "guestfs_%s" name in
5368 generate_call_args ~handle:"g" (snd style);
5371 (* Check return value for errors and display command results. *)
5372 (match fst style with
5373 | RErr -> pr " return r;\n"
5375 pr " if (r == -1) return -1;\n";
5376 pr " printf (\"%%d\\n\", r);\n";
5379 pr " if (r == -1) return -1;\n";
5380 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
5383 pr " if (r == -1) return -1;\n";
5384 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
5387 pr " if (r == NULL) return -1;\n";
5388 pr " printf (\"%%s\\n\", r);\n";
5391 pr " if (r == NULL) return -1;\n";
5392 pr " printf (\"%%s\\n\", r);\n";
5396 pr " if (r == NULL) return -1;\n";
5397 pr " print_strings (r);\n";
5398 pr " free_strings (r);\n";
5400 | RStruct (_, typ) ->
5401 pr " if (r == NULL) return -1;\n";
5402 pr " print_%s (r);\n" typ;
5403 pr " guestfs_free_%s (r);\n" typ;
5405 | RStructList (_, typ) ->
5406 pr " if (r == NULL) return -1;\n";
5407 pr " print_%s_list (r);\n" typ;
5408 pr " guestfs_free_%s_list (r);\n" typ;
5411 pr " if (r == NULL) return -1;\n";
5412 pr " print_table (r);\n";
5413 pr " free_strings (r);\n";
5420 (* run_action function *)
5421 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
5424 fun (name, _, _, flags, _, _, _) ->
5425 let name2 = replace_char name '_' '-' in
5427 try find_map (function FishAlias n -> Some n | _ -> None) flags
5428 with Not_found -> name in
5430 pr "strcasecmp (cmd, \"%s\") == 0" name;
5431 if name <> name2 then
5432 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
5433 if name <> alias then
5434 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
5436 pr " return run_%s (cmd, argc, argv);\n" name;
5440 pr " fprintf (stderr, \"%%s: unknown command\\n\", cmd);\n";
5447 (* Readline completion for guestfish. *)
5448 and generate_fish_completion () =
5449 generate_header CStyle GPLv2;
5453 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5463 #ifdef HAVE_LIBREADLINE
5464 #include <readline/readline.h>
5469 #ifdef HAVE_LIBREADLINE
5471 static const char *const commands[] = {
5472 BUILTIN_COMMANDS_FOR_COMPLETION,
5475 (* Get the commands, including the aliases. They don't need to be
5476 * sorted - the generator() function just does a dumb linear search.
5480 fun (name, _, _, flags, _, _, _) ->
5481 let name2 = replace_char name '_' '-' in
5483 try find_map (function FishAlias n -> Some n | _ -> None) flags
5484 with Not_found -> name in
5486 if name <> alias then [name2; alias] else [name2]
5488 let commands = List.flatten commands in
5490 List.iter (pr " \"%s\",\n") commands;
5496 generator (const char *text, int state)
5498 static int index, len;
5503 len = strlen (text);
5506 rl_attempted_completion_over = 1;
5508 while ((name = commands[index]) != NULL) {
5510 if (strncasecmp (name, text, len) == 0)
5511 return strdup (name);
5517 #endif /* HAVE_LIBREADLINE */
5519 char **do_completion (const char *text, int start, int end)
5521 char **matches = NULL;
5523 #ifdef HAVE_LIBREADLINE
5524 rl_completion_append_character = ' ';
5527 matches = rl_completion_matches (text, generator);
5528 else if (complete_dest_paths)
5529 matches = rl_completion_matches (text, complete_dest_paths_generator);
5536 (* Generate the POD documentation for guestfish. *)
5537 and generate_fish_actions_pod () =
5538 let all_functions_sorted =
5540 fun (_, _, _, flags, _, _, _) ->
5541 not (List.mem NotInFish flags || List.mem NotInDocs flags)
5542 ) all_functions_sorted in
5544 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
5547 fun (name, style, _, flags, _, _, longdesc) ->
5549 Str.global_substitute rex (
5552 try Str.matched_group 1 s
5554 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
5555 "C<" ^ replace_char sub '_' '-' ^ ">"
5557 let name = replace_char name '_' '-' in
5559 try find_map (function FishAlias n -> Some n | _ -> None) flags
5560 with Not_found -> name in
5562 pr "=head2 %s" name;
5563 if name <> alias then
5570 | String n -> pr " %s" n
5571 | OptString n -> pr " %s" n
5572 | StringList n -> pr " '%s ...'" n
5573 | Bool _ -> pr " true|false"
5574 | Int n -> pr " %s" n
5575 | FileIn n | FileOut n -> pr " (%s|-)" n
5579 pr "%s\n\n" longdesc;
5581 if List.exists (function FileIn _ | FileOut _ -> true
5582 | _ -> false) (snd style) then
5583 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
5585 if List.mem ProtocolLimitWarning flags then
5586 pr "%s\n\n" protocol_limit_warning;
5588 if List.mem DangerWillRobinson flags then
5589 pr "%s\n\n" danger_will_robinson
5590 ) all_functions_sorted
5592 (* Generate a C function prototype. *)
5593 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
5594 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
5596 ?handle name style =
5597 if extern then pr "extern ";
5598 if static then pr "static ";
5599 (match fst style with
5601 | RInt _ -> pr "int "
5602 | RInt64 _ -> pr "int64_t "
5603 | RBool _ -> pr "int "
5604 | RConstString _ -> pr "const char *"
5605 | RString _ -> pr "char *"
5606 | RStringList _ | RHashtable _ -> pr "char **"
5607 | RStruct (_, typ) ->
5608 if not in_daemon then pr "struct guestfs_%s *" typ
5609 else pr "guestfs_int_%s *" typ
5610 | RStructList (_, typ) ->
5611 if not in_daemon then pr "struct guestfs_%s_list *" typ
5612 else pr "guestfs_int_%s_list *" typ
5614 pr "%s%s (" prefix name;
5615 if handle = None && List.length (snd style) = 0 then
5618 let comma = ref false in
5621 | Some handle -> pr "guestfs_h *%s" handle; comma := true
5625 if single_line then pr ", " else pr ",\n\t\t"
5634 if not in_daemon then pr "const char *%s" n
5635 else pr "char *%s" n
5638 if not in_daemon then pr "char * const* const %s" n
5639 else pr "char **%s" n
5640 | Bool n -> next (); pr "int %s" n
5641 | Int n -> next (); pr "int %s" n
5644 if not in_daemon then (next (); pr "const char *%s" n)
5648 if semicolon then pr ";";
5649 if newline then pr "\n"
5651 (* Generate C call arguments, eg "(handle, foo, bar)" *)
5652 and generate_call_args ?handle args =
5654 let comma = ref false in
5657 | Some handle -> pr "%s" handle; comma := true
5661 if !comma then pr ", ";
5663 pr "%s" (name_of_argt arg)
5667 (* Generate the OCaml bindings interface. *)
5668 and generate_ocaml_mli () =
5669 generate_header OCamlStyle LGPLv2;
5672 (** For API documentation you should refer to the C API
5673 in the guestfs(3) manual page. The OCaml API uses almost
5674 exactly the same calls. *)
5677 (** A [guestfs_h] handle. *)
5679 exception Error of string
5680 (** This exception is raised when there is an error. *)
5682 val create : unit -> t
5684 val close : t -> unit
5685 (** Handles are closed by the garbage collector when they become
5686 unreferenced, but callers can also call this in order to
5687 provide predictable cleanup. *)
5690 generate_ocaml_structure_decls ();
5694 fun (name, style, _, _, _, shortdesc, _) ->
5695 generate_ocaml_prototype name style;
5696 pr "(** %s *)\n" shortdesc;
5700 (* Generate the OCaml bindings implementation. *)
5701 and generate_ocaml_ml () =
5702 generate_header OCamlStyle LGPLv2;
5706 exception Error of string
5707 external create : unit -> t = \"ocaml_guestfs_create\"
5708 external close : t -> unit = \"ocaml_guestfs_close\"
5711 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
5715 generate_ocaml_structure_decls ();
5719 fun (name, style, _, _, _, shortdesc, _) ->
5720 generate_ocaml_prototype ~is_external:true name style;
5723 (* Generate the OCaml bindings C implementation. *)
5724 and generate_ocaml_c () =
5725 generate_header CStyle LGPLv2;
5732 #include <caml/config.h>
5733 #include <caml/alloc.h>
5734 #include <caml/callback.h>
5735 #include <caml/fail.h>
5736 #include <caml/memory.h>
5737 #include <caml/mlvalues.h>
5738 #include <caml/signals.h>
5740 #include <guestfs.h>
5742 #include \"guestfs_c.h\"
5744 /* Copy a hashtable of string pairs into an assoc-list. We return
5745 * the list in reverse order, but hashtables aren't supposed to be
5748 static CAMLprim value
5749 copy_table (char * const * argv)
5752 CAMLlocal5 (rv, pairv, kv, vv, cons);
5756 for (i = 0; argv[i] != NULL; i += 2) {
5757 kv = caml_copy_string (argv[i]);
5758 vv = caml_copy_string (argv[i+1]);
5759 pairv = caml_alloc (2, 0);
5760 Store_field (pairv, 0, kv);
5761 Store_field (pairv, 1, vv);
5762 cons = caml_alloc (2, 0);
5763 Store_field (cons, 1, rv);
5765 Store_field (cons, 0, pairv);
5773 (* Struct copy functions. *)
5776 let has_optpercent_col =
5777 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
5779 pr "static CAMLprim value\n";
5780 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
5782 pr " CAMLparam0 ();\n";
5783 if has_optpercent_col then
5784 pr " CAMLlocal3 (rv, v, v2);\n"
5786 pr " CAMLlocal2 (rv, v);\n";
5788 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
5793 pr " v = caml_copy_string (%s->%s);\n" typ name
5795 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
5796 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
5799 pr " v = caml_alloc_string (32);\n";
5800 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
5801 | name, (FBytes|FInt64|FUInt64) ->
5802 pr " v = caml_copy_int64 (%s->%s);\n" typ name
5803 | name, (FInt32|FUInt32) ->
5804 pr " v = caml_copy_int32 (%s->%s);\n" typ name
5805 | name, FOptPercent ->
5806 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
5807 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
5808 pr " v = caml_alloc (1, 0);\n";
5809 pr " Store_field (v, 0, v2);\n";
5810 pr " } else /* None */\n";
5811 pr " v = Val_int (0);\n";
5813 pr " v = Val_int (%s->%s);\n" typ name
5815 pr " Store_field (rv, %d, v);\n" i
5817 pr " CAMLreturn (rv);\n";
5821 pr "static CAMLprim value\n";
5822 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n"
5825 pr " CAMLparam0 ();\n";
5826 pr " CAMLlocal2 (rv, v);\n";
5829 pr " if (%ss->len == 0)\n" typ;
5830 pr " CAMLreturn (Atom (0));\n";
5832 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
5833 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
5834 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
5835 pr " caml_modify (&Field (rv, i), v);\n";
5837 pr " CAMLreturn (rv);\n";
5845 fun (name, style, _, _, _, _, _) ->
5847 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
5849 pr "CAMLprim value\n";
5850 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
5851 List.iter (pr ", value %s") (List.tl params);
5856 | [p1; p2; p3; p4; p5] ->
5857 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
5858 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
5859 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
5860 pr " CAMLxparam%d (%s);\n"
5861 (List.length rest) (String.concat ", " rest)
5863 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
5865 pr " CAMLlocal1 (rv);\n";
5868 pr " guestfs_h *g = Guestfs_val (gv);\n";
5869 pr " if (g == NULL)\n";
5870 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
5878 pr " const char *%s = String_val (%sv);\n" n n
5880 pr " const char *%s =\n" n;
5881 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
5884 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
5886 pr " int %s = Bool_val (%sv);\n" n n
5888 pr " int %s = Int_val (%sv);\n" n n
5891 match fst style with
5892 | RErr -> pr " int r;\n"; "-1"
5893 | RInt _ -> pr " int r;\n"; "-1"
5894 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5895 | RBool _ -> pr " int r;\n"; "-1"
5896 | RConstString _ -> pr " const char *r;\n"; "NULL"
5897 | RString _ -> pr " char *r;\n"; "NULL"
5902 | RStruct (_, typ) ->
5903 pr " struct guestfs_%s *r;\n" typ; "NULL"
5904 | RStructList (_, typ) ->
5905 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
5912 pr " caml_enter_blocking_section ();\n";
5913 pr " r = guestfs_%s " name;
5914 generate_call_args ~handle:"g" (snd style);
5916 pr " caml_leave_blocking_section ();\n";
5921 pr " ocaml_guestfs_free_strings (%s);\n" n;
5922 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
5925 pr " if (r == %s)\n" error_code;
5926 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
5929 (match fst style with
5930 | RErr -> pr " rv = Val_unit;\n"
5931 | RInt _ -> pr " rv = Val_int (r);\n"
5933 pr " rv = caml_copy_int64 (r);\n"
5934 | RBool _ -> pr " rv = Val_bool (r);\n"
5935 | RConstString _ -> pr " rv = caml_copy_string (r);\n"
5937 pr " rv = caml_copy_string (r);\n";
5940 pr " rv = caml_copy_string_array ((const char **) r);\n";
5941 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
5943 | RStruct (_, typ) ->
5944 pr " rv = copy_%s (r);\n" typ;
5945 pr " guestfs_free_%s (r);\n" typ;
5946 | RStructList (_, typ) ->
5947 pr " rv = copy_%s_list (r);\n" typ;
5948 pr " guestfs_free_%s_list (r);\n" typ;
5950 pr " rv = copy_table (r);\n";
5951 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
5955 pr " CAMLreturn (rv);\n";
5959 if List.length params > 5 then (
5960 pr "CAMLprim value\n";
5961 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
5963 pr " return ocaml_guestfs_%s (argv[0]" name;
5964 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
5971 and generate_ocaml_structure_decls () =
5974 pr "type %s = {\n" typ;
5977 | name, FString -> pr " %s : string;\n" name
5978 | name, FBuffer -> pr " %s : string;\n" name
5979 | name, FUUID -> pr " %s : string;\n" name
5980 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
5981 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
5982 | name, FChar -> pr " %s : char;\n" name
5983 | name, FOptPercent -> pr " %s : float option;\n" name
5989 and generate_ocaml_prototype ?(is_external = false) name style =
5990 if is_external then pr "external " else pr "val ";
5991 pr "%s : t -> " name;
5994 | String _ | FileIn _ | FileOut _ -> pr "string -> "
5995 | OptString _ -> pr "string option -> "
5996 | StringList _ -> pr "string array -> "
5997 | Bool _ -> pr "bool -> "
5998 | Int _ -> pr "int -> "
6000 (match fst style with
6001 | RErr -> pr "unit" (* all errors are turned into exceptions *)
6002 | RInt _ -> pr "int"
6003 | RInt64 _ -> pr "int64"
6004 | RBool _ -> pr "bool"
6005 | RConstString _ -> pr "string"
6006 | RString _ -> pr "string"
6007 | RStringList _ -> pr "string array"
6008 | RStruct (_, typ) -> pr "%s" typ
6009 | RStructList (_, typ) -> pr "%s array" typ
6010 | RHashtable _ -> pr "(string * string) list"
6012 if is_external then (
6014 if List.length (snd style) + 1 > 5 then
6015 pr "\"ocaml_guestfs_%s_byte\" " name;
6016 pr "\"ocaml_guestfs_%s\"" name
6020 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
6021 and generate_perl_xs () =
6022 generate_header CStyle LGPLv2;
6025 #include \"EXTERN.h\"
6029 #include <guestfs.h>
6032 #define PRId64 \"lld\"
6036 my_newSVll(long long val) {
6037 #ifdef USE_64_BIT_ALL
6038 return newSViv(val);
6042 len = snprintf(buf, 100, \"%%\" PRId64, val);
6043 return newSVpv(buf, len);
6048 #define PRIu64 \"llu\"
6052 my_newSVull(unsigned long long val) {
6053 #ifdef USE_64_BIT_ALL
6054 return newSVuv(val);
6058 len = snprintf(buf, 100, \"%%\" PRIu64, val);
6059 return newSVpv(buf, len);
6063 /* http://www.perlmonks.org/?node_id=680842 */
6065 XS_unpack_charPtrPtr (SV *arg) {
6070 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
6071 croak (\"array reference expected\");
6073 av = (AV *)SvRV (arg);
6074 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
6076 croak (\"malloc failed\");
6078 for (i = 0; i <= av_len (av); i++) {
6079 SV **elem = av_fetch (av, i, 0);
6081 if (!elem || !*elem)
6082 croak (\"missing element in list\");
6084 ret[i] = SvPV_nolen (*elem);
6092 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
6099 RETVAL = guestfs_create ();
6101 croak (\"could not create guestfs handle\");
6102 guestfs_set_error_handler (RETVAL, NULL, NULL);
6115 fun (name, style, _, _, _, _, _) ->
6116 (match fst style with
6117 | RErr -> pr "void\n"
6118 | RInt _ -> pr "SV *\n"
6119 | RInt64 _ -> pr "SV *\n"
6120 | RBool _ -> pr "SV *\n"
6121 | RConstString _ -> pr "SV *\n"
6122 | RString _ -> pr "SV *\n"
6124 | RStruct _ | RStructList _
6126 pr "void\n" (* all lists returned implictly on the stack *)
6128 (* Call and arguments. *)
6130 generate_call_args ~handle:"g" (snd style);
6132 pr " guestfs_h *g;\n";
6136 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
6138 (* http://www.perlmonks.org/?node_id=554277
6139 * Note that the implicit handle argument means we have
6140 * to add 1 to the ST(x) operator.
6142 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
6143 | StringList n -> pr " char **%s;\n" n
6144 | Bool n -> pr " int %s;\n" n
6145 | Int n -> pr " int %s;\n" n
6148 let do_cleanups () =
6151 | String _ | OptString _ | Bool _ | Int _
6152 | FileIn _ | FileOut _ -> ()
6153 | StringList n -> pr " free (%s);\n" n
6158 (match fst style with
6163 pr " r = guestfs_%s " name;
6164 generate_call_args ~handle:"g" (snd style);
6167 pr " if (r == -1)\n";
6168 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6174 pr " %s = guestfs_%s " n name;
6175 generate_call_args ~handle:"g" (snd style);
6178 pr " if (%s == -1)\n" n;
6179 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6180 pr " RETVAL = newSViv (%s);\n" n;
6185 pr " int64_t %s;\n" n;
6187 pr " %s = guestfs_%s " n name;
6188 generate_call_args ~handle:"g" (snd style);
6191 pr " if (%s == -1)\n" n;
6192 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6193 pr " RETVAL = my_newSVll (%s);\n" n;
6198 pr " const char *%s;\n" n;
6200 pr " %s = guestfs_%s " n name;
6201 generate_call_args ~handle:"g" (snd style);
6204 pr " if (%s == NULL)\n" n;
6205 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6206 pr " RETVAL = newSVpv (%s, 0);\n" n;
6211 pr " char *%s;\n" n;
6213 pr " %s = guestfs_%s " n name;
6214 generate_call_args ~handle:"g" (snd style);
6217 pr " if (%s == NULL)\n" n;
6218 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6219 pr " RETVAL = newSVpv (%s, 0);\n" n;
6220 pr " free (%s);\n" n;
6223 | RStringList n | RHashtable n ->
6225 pr " char **%s;\n" n;
6228 pr " %s = guestfs_%s " n name;
6229 generate_call_args ~handle:"g" (snd style);
6232 pr " if (%s == NULL)\n" n;
6233 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6234 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
6235 pr " EXTEND (SP, n);\n";
6236 pr " for (i = 0; i < n; ++i) {\n";
6237 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
6238 pr " free (%s[i]);\n" n;
6240 pr " free (%s);\n" n;
6241 | RStruct (n, typ) ->
6242 let cols = cols_of_struct typ in
6243 generate_perl_struct_code typ cols name style n do_cleanups
6244 | RStructList (n, typ) ->
6245 let cols = cols_of_struct typ in
6246 generate_perl_struct_list_code typ cols name style n do_cleanups
6252 and generate_perl_struct_list_code typ cols name style n do_cleanups =
6254 pr " struct guestfs_%s_list *%s;\n" typ n;
6258 pr " %s = guestfs_%s " n name;
6259 generate_call_args ~handle:"g" (snd style);
6262 pr " if (%s == NULL)\n" n;
6263 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6264 pr " EXTEND (SP, %s->len);\n" n;
6265 pr " for (i = 0; i < %s->len; ++i) {\n" n;
6266 pr " hv = newHV ();\n";
6270 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
6271 name (String.length name) n name
6273 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
6274 name (String.length name) n name
6276 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
6277 name (String.length name) n name n name
6278 | name, (FBytes|FUInt64) ->
6279 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
6280 name (String.length name) n name
6282 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
6283 name (String.length name) n name
6284 | name, (FInt32|FUInt32) ->
6285 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
6286 name (String.length name) n name
6288 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
6289 name (String.length name) n name
6290 | name, FOptPercent ->
6291 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
6292 name (String.length name) n name
6294 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
6296 pr " guestfs_free_%s_list (%s);\n" typ n
6298 and generate_perl_struct_code typ cols name style n do_cleanups =
6300 pr " struct guestfs_%s *%s;\n" typ n;
6302 pr " %s = guestfs_%s " n name;
6303 generate_call_args ~handle:"g" (snd style);
6306 pr " if (%s == NULL)\n" n;
6307 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6308 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
6310 fun ((name, _) as col) ->
6311 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
6315 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
6318 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, %s->%s_len)));\n"
6321 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
6323 | name, (FBytes|FUInt64) ->
6324 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
6327 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
6329 | name, (FInt32|FUInt32) ->
6330 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
6333 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
6335 | name, FOptPercent ->
6336 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
6339 pr " free (%s);\n" n
6341 (* Generate Sys/Guestfs.pm. *)
6342 and generate_perl_pm () =
6343 generate_header HashStyle LGPLv2;
6350 Sys::Guestfs - Perl bindings for libguestfs
6356 my $h = Sys::Guestfs->new ();
6357 $h->add_drive ('guest.img');
6360 $h->mount ('/dev/sda1', '/');
6361 $h->touch ('/hello');
6366 The C<Sys::Guestfs> module provides a Perl XS binding to the
6367 libguestfs API for examining and modifying virtual machine
6370 Amongst the things this is good for: making batch configuration
6371 changes to guests, getting disk used/free statistics (see also:
6372 virt-df), migrating between virtualization systems (see also:
6373 virt-p2v), performing partial backups, performing partial guest
6374 clones, cloning guests and changing registry/UUID/hostname info, and
6377 Libguestfs uses Linux kernel and qemu code, and can access any type of
6378 guest filesystem that Linux and qemu can, including but not limited
6379 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
6380 schemes, qcow, qcow2, vmdk.
6382 Libguestfs provides ways to enumerate guest storage (eg. partitions,
6383 LVs, what filesystem is in each LV, etc.). It can also run commands
6384 in the context of the guest. Also you can access filesystems over FTP.
6386 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
6387 functions for using libguestfs from Perl, including integration
6392 All errors turn into calls to C<croak> (see L<Carp(3)>).
6400 package Sys::Guestfs;
6406 XSLoader::load ('Sys::Guestfs');
6408 =item $h = Sys::Guestfs->new ();
6410 Create a new guestfs handle.
6416 my $class = ref ($proto) || $proto;
6418 my $self = Sys::Guestfs::_create ();
6419 bless $self, $class;
6425 (* Actions. We only need to print documentation for these as
6426 * they are pulled in from the XS code automatically.
6429 fun (name, style, _, flags, _, _, longdesc) ->
6430 if not (List.mem NotInDocs flags) then (
6431 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
6433 generate_perl_prototype name style;
6435 pr "%s\n\n" longdesc;
6436 if List.mem ProtocolLimitWarning flags then
6437 pr "%s\n\n" protocol_limit_warning;
6438 if List.mem DangerWillRobinson flags then
6439 pr "%s\n\n" danger_will_robinson
6441 ) all_functions_sorted;
6453 Copyright (C) 2009 Red Hat Inc.
6457 Please see the file COPYING.LIB for the full license.
6463 L<http://libguestfs.org>,
6464 L<Sys::Guestfs::Lib(3)>.
6469 and generate_perl_prototype name style =
6470 (match fst style with
6476 | RString n -> pr "$%s = " n
6478 | RHashtable n -> pr "%%%s = " n
6480 | RStructList (n,_) -> pr "@%s = " n
6483 let comma = ref false in
6486 if !comma then pr ", ";
6489 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
6496 (* Generate Python C module. *)
6497 and generate_python_c () =
6498 generate_header CStyle LGPLv2;
6507 #include \"guestfs.h\"
6515 get_handle (PyObject *obj)
6518 assert (obj != Py_None);
6519 return ((Pyguestfs_Object *) obj)->g;
6523 put_handle (guestfs_h *g)
6527 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
6530 /* This list should be freed (but not the strings) after use. */
6531 static const char **
6532 get_string_list (PyObject *obj)
6539 if (!PyList_Check (obj)) {
6540 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
6544 len = PyList_Size (obj);
6545 r = malloc (sizeof (char *) * (len+1));
6547 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
6551 for (i = 0; i < len; ++i)
6552 r[i] = PyString_AsString (PyList_GetItem (obj, i));
6559 put_string_list (char * const * const argv)
6564 for (argc = 0; argv[argc] != NULL; ++argc)
6567 list = PyList_New (argc);
6568 for (i = 0; i < argc; ++i)
6569 PyList_SetItem (list, i, PyString_FromString (argv[i]));
6575 put_table (char * const * const argv)
6577 PyObject *list, *item;
6580 for (argc = 0; argv[argc] != NULL; ++argc)
6583 list = PyList_New (argc >> 1);
6584 for (i = 0; i < argc; i += 2) {
6585 item = PyTuple_New (2);
6586 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
6587 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
6588 PyList_SetItem (list, i >> 1, item);
6595 free_strings (char **argv)
6599 for (argc = 0; argv[argc] != NULL; ++argc)
6605 py_guestfs_create (PyObject *self, PyObject *args)
6609 g = guestfs_create ();
6611 PyErr_SetString (PyExc_RuntimeError,
6612 \"guestfs.create: failed to allocate handle\");
6615 guestfs_set_error_handler (g, NULL, NULL);
6616 return put_handle (g);
6620 py_guestfs_close (PyObject *self, PyObject *args)
6625 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
6627 g = get_handle (py_g);
6631 Py_INCREF (Py_None);
6637 (* Structures, turned into Python dictionaries. *)
6640 pr "static PyObject *\n";
6641 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
6643 pr " PyObject *dict;\n";
6645 pr " dict = PyDict_New ();\n";
6649 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6650 pr " PyString_FromString (%s->%s));\n"
6653 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6654 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
6657 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6658 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
6660 | name, (FBytes|FUInt64) ->
6661 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6662 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
6665 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6666 pr " PyLong_FromLongLong (%s->%s));\n"
6669 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6670 pr " PyLong_FromUnsignedLong (%s->%s));\n"
6673 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6674 pr " PyLong_FromLong (%s->%s));\n"
6676 | name, FOptPercent ->
6677 pr " if (%s->%s >= 0)\n" typ name;
6678 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6679 pr " PyFloat_FromDouble ((double) %s->%s));\n"
6682 pr " Py_INCREF (Py_None);\n";
6683 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
6686 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6687 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
6689 pr " return dict;\n";
6693 pr "static PyObject *\n";
6694 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
6696 pr " PyObject *list;\n";
6699 pr " list = PyList_New (%ss->len);\n" typ;
6700 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
6701 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
6702 pr " return list;\n";
6707 (* Python wrapper functions. *)
6709 fun (name, style, _, _, _, _, _) ->
6710 pr "static PyObject *\n";
6711 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
6714 pr " PyObject *py_g;\n";
6715 pr " guestfs_h *g;\n";
6716 pr " PyObject *py_r;\n";
6719 match fst style with
6720 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
6721 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6722 | RConstString _ -> pr " const char *r;\n"; "NULL"
6723 | RString _ -> pr " char *r;\n"; "NULL"
6724 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6725 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
6726 | RStructList (_, typ) ->
6727 pr " struct guestfs_%s_list *r;\n" typ; "NULL" in
6731 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
6732 | OptString n -> pr " const char *%s;\n" n
6734 pr " PyObject *py_%s;\n" n;
6735 pr " const char **%s;\n" n
6736 | Bool n -> pr " int %s;\n" n
6737 | Int n -> pr " int %s;\n" n
6742 (* Convert the parameters. *)
6743 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
6746 | String _ | FileIn _ | FileOut _ -> pr "s"
6747 | OptString _ -> pr "z"
6748 | StringList _ -> pr "O"
6749 | Bool _ -> pr "i" (* XXX Python has booleans? *)
6752 pr ":guestfs_%s\",\n" name;
6756 | String n | FileIn n | FileOut n -> pr ", &%s" n
6757 | OptString n -> pr ", &%s" n
6758 | StringList n -> pr ", &py_%s" n
6759 | Bool n -> pr ", &%s" n
6760 | Int n -> pr ", &%s" n
6764 pr " return NULL;\n";
6766 pr " g = get_handle (py_g);\n";
6769 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6771 pr " %s = get_string_list (py_%s);\n" n n;
6772 pr " if (!%s) return NULL;\n" n
6777 pr " r = guestfs_%s " name;
6778 generate_call_args ~handle:"g" (snd style);
6783 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6785 pr " free (%s);\n" n
6788 pr " if (r == %s) {\n" error_code;
6789 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
6790 pr " return NULL;\n";
6794 (match fst style with
6796 pr " Py_INCREF (Py_None);\n";
6797 pr " py_r = Py_None;\n"
6799 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
6800 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
6801 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
6803 pr " py_r = PyString_FromString (r);\n";
6806 pr " py_r = put_string_list (r);\n";
6807 pr " free_strings (r);\n"
6808 | RStruct (_, typ) ->
6809 pr " py_r = put_%s (r);\n" typ;
6810 pr " guestfs_free_%s (r);\n" typ
6811 | RStructList (_, typ) ->
6812 pr " py_r = put_%s_list (r);\n" typ;
6813 pr " guestfs_free_%s_list (r);\n" typ
6815 pr " py_r = put_table (r);\n";
6816 pr " free_strings (r);\n"
6819 pr " return py_r;\n";
6824 (* Table of functions. *)
6825 pr "static PyMethodDef methods[] = {\n";
6826 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
6827 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
6829 fun (name, _, _, _, _, _, _) ->
6830 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
6833 pr " { NULL, NULL, 0, NULL }\n";
6837 (* Init function. *)
6840 initlibguestfsmod (void)
6842 static int initialized = 0;
6844 if (initialized) return;
6845 Py_InitModule ((char *) \"libguestfsmod\", methods);
6850 (* Generate Python module. *)
6851 and generate_python_py () =
6852 generate_header HashStyle LGPLv2;
6855 u\"\"\"Python bindings for libguestfs
6858 g = guestfs.GuestFS ()
6859 g.add_drive (\"guest.img\")
6862 parts = g.list_partitions ()
6864 The guestfs module provides a Python binding to the libguestfs API
6865 for examining and modifying virtual machine disk images.
6867 Amongst the things this is good for: making batch configuration
6868 changes to guests, getting disk used/free statistics (see also:
6869 virt-df), migrating between virtualization systems (see also:
6870 virt-p2v), performing partial backups, performing partial guest
6871 clones, cloning guests and changing registry/UUID/hostname info, and
6874 Libguestfs uses Linux kernel and qemu code, and can access any type of
6875 guest filesystem that Linux and qemu can, including but not limited
6876 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
6877 schemes, qcow, qcow2, vmdk.
6879 Libguestfs provides ways to enumerate guest storage (eg. partitions,
6880 LVs, what filesystem is in each LV, etc.). It can also run commands
6881 in the context of the guest. Also you can access filesystems over FTP.
6883 Errors which happen while using the API are turned into Python
6884 RuntimeError exceptions.
6886 To create a guestfs handle you usually have to perform the following
6889 # Create the handle, call add_drive at least once, and possibly
6890 # several times if the guest has multiple block devices:
6891 g = guestfs.GuestFS ()
6892 g.add_drive (\"guest.img\")
6894 # Launch the qemu subprocess and wait for it to become ready:
6898 # Now you can issue commands, for example:
6903 import libguestfsmod
6906 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
6908 def __init__ (self):
6909 \"\"\"Create a new libguestfs handle.\"\"\"
6910 self._o = libguestfsmod.create ()
6913 libguestfsmod.close (self._o)
6918 fun (name, style, _, flags, _, _, longdesc) ->
6920 generate_call_args ~handle:"self" (snd style);
6923 if not (List.mem NotInDocs flags) then (
6924 let doc = replace_str longdesc "C<guestfs_" "C<g." in
6926 match fst style with
6927 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _
6930 doc ^ "\n\nThis function returns a list of strings."
6931 | RStruct (_, typ) ->
6932 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
6933 | RStructList (_, typ) ->
6934 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
6936 doc ^ "\n\nThis function returns a dictionary." in
6938 if List.mem ProtocolLimitWarning flags then
6939 doc ^ "\n\n" ^ protocol_limit_warning
6942 if List.mem DangerWillRobinson flags then
6943 doc ^ "\n\n" ^ danger_will_robinson
6945 let doc = pod2text ~width:60 name doc in
6946 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
6947 let doc = String.concat "\n " doc in
6948 pr " u\"\"\"%s\"\"\"\n" doc;
6950 pr " return libguestfsmod.%s " name;
6951 generate_call_args ~handle:"self._o" (snd style);
6956 (* Useful if you need the longdesc POD text as plain text. Returns a
6959 * Because this is very slow (the slowest part of autogeneration),
6960 * we memoize the results.
6962 and pod2text ~width name longdesc =
6963 let key = width, name, longdesc in
6964 try Hashtbl.find pod2text_memo key
6966 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
6967 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
6969 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
6970 let chan = Unix.open_process_in cmd in
6971 let lines = ref [] in
6973 let line = input_line chan in
6974 if i = 1 then (* discard the first line of output *)
6977 let line = triml line in
6978 lines := line :: !lines;
6981 let lines = try loop 1 with End_of_file -> List.rev !lines in
6982 Unix.unlink filename;
6983 (match Unix.close_process_in chan with
6984 | Unix.WEXITED 0 -> ()
6986 failwithf "pod2text: process exited with non-zero status (%d)" i
6987 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
6988 failwithf "pod2text: process signalled or stopped by signal %d" i
6990 Hashtbl.add pod2text_memo key lines;
6991 let chan = open_out pod2text_memo_filename in
6992 output_value chan pod2text_memo;
6996 (* Generate ruby bindings. *)
6997 and generate_ruby_c () =
6998 generate_header CStyle LGPLv2;
7006 #include \"guestfs.h\"
7008 #include \"extconf.h\"
7010 /* For Ruby < 1.9 */
7012 #define RARRAY_LEN(r) (RARRAY((r))->len)
7015 static VALUE m_guestfs; /* guestfs module */
7016 static VALUE c_guestfs; /* guestfs_h handle */
7017 static VALUE e_Error; /* used for all errors */
7019 static void ruby_guestfs_free (void *p)
7022 guestfs_close ((guestfs_h *) p);
7025 static VALUE ruby_guestfs_create (VALUE m)
7029 g = guestfs_create ();
7031 rb_raise (e_Error, \"failed to create guestfs handle\");
7033 /* Don't print error messages to stderr by default. */
7034 guestfs_set_error_handler (g, NULL, NULL);
7036 /* Wrap it, and make sure the close function is called when the
7039 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
7042 static VALUE ruby_guestfs_close (VALUE gv)
7045 Data_Get_Struct (gv, guestfs_h, g);
7047 ruby_guestfs_free (g);
7048 DATA_PTR (gv) = NULL;
7056 fun (name, style, _, _, _, _, _) ->
7057 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
7058 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
7061 pr " guestfs_h *g;\n";
7062 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
7064 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
7070 | String n | FileIn n | FileOut n ->
7071 pr " Check_Type (%sv, T_STRING);\n" n;
7072 pr " const char *%s = StringValueCStr (%sv);\n" n n;
7074 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
7075 pr " \"%s\", \"%s\");\n" n name
7077 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
7079 pr " char **%s;\n" n;
7080 pr " Check_Type (%sv, T_ARRAY);\n" n;
7082 pr " int i, len;\n";
7083 pr " len = RARRAY_LEN (%sv);\n" n;
7084 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
7086 pr " for (i = 0; i < len; ++i) {\n";
7087 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
7088 pr " %s[i] = StringValueCStr (v);\n" n;
7090 pr " %s[len] = NULL;\n" n;
7093 pr " int %s = RTEST (%sv);\n" n n
7095 pr " int %s = NUM2INT (%sv);\n" n n
7100 match fst style with
7101 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7102 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7103 | RConstString _ -> pr " const char *r;\n"; "NULL"
7104 | RString _ -> pr " char *r;\n"; "NULL"
7105 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
7106 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
7107 | RStructList (_, typ) ->
7108 pr " struct guestfs_%s_list *r;\n" typ; "NULL" in
7111 pr " r = guestfs_%s " name;
7112 generate_call_args ~handle:"g" (snd style);
7117 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
7119 pr " free (%s);\n" n
7122 pr " if (r == %s)\n" error_code;
7123 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
7126 (match fst style with
7128 pr " return Qnil;\n"
7129 | RInt _ | RBool _ ->
7130 pr " return INT2NUM (r);\n"
7132 pr " return ULL2NUM (r);\n"
7134 pr " return rb_str_new2 (r);\n";
7136 pr " VALUE rv = rb_str_new2 (r);\n";
7140 pr " int i, len = 0;\n";
7141 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
7142 pr " VALUE rv = rb_ary_new2 (len);\n";
7143 pr " for (i = 0; r[i] != NULL; ++i) {\n";
7144 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
7145 pr " free (r[i]);\n";
7149 | RStruct (_, typ) ->
7150 let cols = cols_of_struct typ in
7151 generate_ruby_struct_code typ cols
7152 | RStructList (_, typ) ->
7153 let cols = cols_of_struct typ in
7154 generate_ruby_struct_list_code typ cols
7156 pr " VALUE rv = rb_hash_new ();\n";
7158 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
7159 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
7160 pr " free (r[i]);\n";
7161 pr " free (r[i+1]);\n";
7172 /* Initialize the module. */
7173 void Init__guestfs ()
7175 m_guestfs = rb_define_module (\"Guestfs\");
7176 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
7177 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
7179 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
7180 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
7183 (* Define the rest of the methods. *)
7185 fun (name, style, _, _, _, _, _) ->
7186 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
7187 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
7192 (* Ruby code to return a struct. *)
7193 and generate_ruby_struct_code typ cols =
7194 pr " VALUE rv = rb_hash_new ();\n";
7198 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
7200 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
7202 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
7203 | name, (FBytes|FUInt64) ->
7204 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
7206 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
7208 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
7210 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
7211 | name, FOptPercent ->
7212 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
7213 | name, FChar -> (* XXX wrong? *)
7214 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
7216 pr " guestfs_free_%s (r);\n" typ;
7219 (* Ruby code to return a struct list. *)
7220 and generate_ruby_struct_list_code typ cols =
7221 pr " VALUE rv = rb_ary_new2 (r->len);\n";
7223 pr " for (i = 0; i < r->len; ++i) {\n";
7224 pr " VALUE hv = rb_hash_new ();\n";
7228 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
7230 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
7232 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
7233 | name, (FBytes|FUInt64) ->
7234 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
7236 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
7238 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
7240 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
7241 | name, FOptPercent ->
7242 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
7243 | name, FChar -> (* XXX wrong? *)
7244 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
7246 pr " rb_ary_push (rv, hv);\n";
7248 pr " guestfs_free_%s_list (r);\n" typ;
7251 (* Generate Java bindings GuestFS.java file. *)
7252 and generate_java_java () =
7253 generate_header CStyle LGPLv2;
7256 package com.redhat.et.libguestfs;
7258 import java.util.HashMap;
7259 import com.redhat.et.libguestfs.LibGuestFSException;
7260 import com.redhat.et.libguestfs.PV;
7261 import com.redhat.et.libguestfs.VG;
7262 import com.redhat.et.libguestfs.LV;
7263 import com.redhat.et.libguestfs.Stat;
7264 import com.redhat.et.libguestfs.StatVFS;
7265 import com.redhat.et.libguestfs.IntBool;
7266 import com.redhat.et.libguestfs.Dirent;
7269 * The GuestFS object is a libguestfs handle.
7273 public class GuestFS {
7274 // Load the native code.
7276 System.loadLibrary (\"guestfs_jni\");
7280 * The native guestfs_h pointer.
7285 * Create a libguestfs handle.
7287 * @throws LibGuestFSException
7289 public GuestFS () throws LibGuestFSException
7293 private native long _create () throws LibGuestFSException;
7296 * Close a libguestfs handle.
7298 * You can also leave handles to be collected by the garbage
7299 * collector, but this method ensures that the resources used
7300 * by the handle are freed up immediately. If you call any
7301 * other methods after closing the handle, you will get an
7304 * @throws LibGuestFSException
7306 public void close () throws LibGuestFSException
7312 private native void _close (long g) throws LibGuestFSException;
7314 public void finalize () throws LibGuestFSException
7322 fun (name, style, _, flags, _, shortdesc, longdesc) ->
7323 if not (List.mem NotInDocs flags); then (
7324 let doc = replace_str longdesc "C<guestfs_" "C<g." in
7326 if List.mem ProtocolLimitWarning flags then
7327 doc ^ "\n\n" ^ protocol_limit_warning
7330 if List.mem DangerWillRobinson flags then
7331 doc ^ "\n\n" ^ danger_will_robinson
7333 let doc = pod2text ~width:60 name doc in
7334 let doc = List.map ( (* RHBZ#501883 *)
7337 | nonempty -> nonempty
7339 let doc = String.concat "\n * " doc in
7342 pr " * %s\n" shortdesc;
7345 pr " * @throws LibGuestFSException\n";
7349 generate_java_prototype ~public:true ~semicolon:false name style;
7352 pr " if (g == 0)\n";
7353 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
7356 if fst style <> RErr then pr "return ";
7358 generate_call_args ~handle:"g" (snd style);
7362 generate_java_prototype ~privat:true ~native:true name style;
7369 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
7370 ?(semicolon=true) name style =
7371 if privat then pr "private ";
7372 if public then pr "public ";
7373 if native then pr "native ";
7376 (match fst style with
7377 | RErr -> pr "void ";
7378 | RInt _ -> pr "int ";
7379 | RInt64 _ -> pr "long ";
7380 | RBool _ -> pr "boolean ";
7381 | RConstString _ | RString _ -> pr "String ";
7382 | RStringList _ -> pr "String[] ";
7383 | RStruct (_, typ) ->
7384 let name = java_name_of_struct typ in
7386 | RStructList (_, typ) ->
7387 let name = java_name_of_struct typ in
7389 | RHashtable _ -> pr "HashMap<String,String> ";
7392 if native then pr "_%s " name else pr "%s " name;
7394 let needs_comma = ref false in
7403 if !needs_comma then pr ", ";
7404 needs_comma := true;
7421 pr " throws LibGuestFSException";
7422 if semicolon then pr ";"
7424 and generate_java_struct jtyp cols =
7425 generate_header CStyle LGPLv2;
7428 package com.redhat.et.libguestfs;
7431 * Libguestfs %s structure.
7443 | name, FBuffer -> pr " public String %s;\n" name
7444 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
7445 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
7446 | name, FChar -> pr " public char %s;\n" name
7447 | name, FOptPercent ->
7448 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
7449 pr " public float %s;\n" name
7454 and generate_java_c () =
7455 generate_header CStyle LGPLv2;
7462 #include \"com_redhat_et_libguestfs_GuestFS.h\"
7463 #include \"guestfs.h\"
7465 /* Note that this function returns. The exception is not thrown
7466 * until after the wrapper function returns.
7469 throw_exception (JNIEnv *env, const char *msg)
7472 cl = (*env)->FindClass (env,
7473 \"com/redhat/et/libguestfs/LibGuestFSException\");
7474 (*env)->ThrowNew (env, cl, msg);
7477 JNIEXPORT jlong JNICALL
7478 Java_com_redhat_et_libguestfs_GuestFS__1create
7479 (JNIEnv *env, jobject obj)
7483 g = guestfs_create ();
7485 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
7488 guestfs_set_error_handler (g, NULL, NULL);
7489 return (jlong) (long) g;
7492 JNIEXPORT void JNICALL
7493 Java_com_redhat_et_libguestfs_GuestFS__1close
7494 (JNIEnv *env, jobject obj, jlong jg)
7496 guestfs_h *g = (guestfs_h *) (long) jg;
7503 fun (name, style, _, _, _, _, _) ->
7505 (match fst style with
7506 | RErr -> pr "void ";
7507 | RInt _ -> pr "jint ";
7508 | RInt64 _ -> pr "jlong ";
7509 | RBool _ -> pr "jboolean ";
7510 | RConstString _ | RString _ -> pr "jstring ";
7511 | RStruct _ | RHashtable _ ->
7513 | RStringList _ | RStructList _ ->
7517 pr "Java_com_redhat_et_libguestfs_GuestFS_";
7518 pr "%s" (replace_str ("_" ^ name) "_" "_1");
7520 pr " (JNIEnv *env, jobject obj, jlong jg";
7527 pr ", jstring j%s" n
7529 pr ", jobjectArray j%s" n
7531 pr ", jboolean j%s" n
7537 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
7538 let error_code, no_ret =
7539 match fst style with
7540 | RErr -> pr " int r;\n"; "-1", ""
7542 | RInt _ -> pr " int r;\n"; "-1", "0"
7543 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
7544 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
7546 pr " jstring jr;\n";
7547 pr " char *r;\n"; "NULL", "NULL"
7549 pr " jobjectArray jr;\n";
7552 pr " jstring jstr;\n";
7553 pr " char **r;\n"; "NULL", "NULL"
7554 | RStruct (_, typ) ->
7555 pr " jobject jr;\n";
7557 pr " jfieldID fl;\n";
7558 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
7559 | RStructList (_, typ) ->
7560 pr " jobjectArray jr;\n";
7562 pr " jfieldID fl;\n";
7563 pr " jobject jfl;\n";
7564 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
7565 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL" in
7572 pr " const char *%s;\n" n
7574 pr " int %s_len;\n" n;
7575 pr " const char **%s;\n" n
7582 (match fst style with
7583 | RStringList _ | RStructList _ -> true
7584 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
7585 | RString _ | RStruct _ | RHashtable _ -> false) ||
7586 List.exists (function StringList _ -> true | _ -> false) (snd style) in
7592 (* Get the parameters. *)
7598 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
7600 (* This is completely undocumented, but Java null becomes
7603 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
7605 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
7606 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
7607 pr " for (i = 0; i < %s_len; ++i) {\n" n;
7608 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
7610 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
7612 pr " %s[%s_len] = NULL;\n" n n;
7615 pr " %s = j%s;\n" n n
7618 (* Make the call. *)
7619 pr " r = guestfs_%s " name;
7620 generate_call_args ~handle:"g" (snd style);
7623 (* Release the parameters. *)
7629 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
7632 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
7634 pr " for (i = 0; i < %s_len; ++i) {\n" n;
7635 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
7637 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
7639 pr " free (%s);\n" n
7644 (* Check for errors. *)
7645 pr " if (r == %s) {\n" error_code;
7646 pr " throw_exception (env, guestfs_last_error (g));\n";
7647 pr " return %s;\n" no_ret;
7651 (match fst style with
7653 | RInt _ -> pr " return (jint) r;\n"
7654 | RBool _ -> pr " return (jboolean) r;\n"
7655 | RInt64 _ -> pr " return (jlong) r;\n"
7656 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
7658 pr " jr = (*env)->NewStringUTF (env, r);\n";
7662 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
7663 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
7664 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
7665 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
7666 pr " for (i = 0; i < r_len; ++i) {\n";
7667 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
7668 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
7669 pr " free (r[i]);\n";
7673 | RStruct (_, typ) ->
7674 let jtyp = java_name_of_struct typ in
7675 let cols = cols_of_struct typ in
7676 generate_java_struct_return typ jtyp cols
7677 | RStructList (_, typ) ->
7678 let jtyp = java_name_of_struct typ in
7679 let cols = cols_of_struct typ in
7680 generate_java_struct_list_return typ jtyp cols
7683 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
7684 pr " return NULL;\n"
7691 and generate_java_struct_return typ jtyp cols =
7692 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
7693 pr " jr = (*env)->AllocObject (env, cl);\n";
7697 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7698 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
7701 pr " char s[33];\n";
7702 pr " memcpy (s, r->%s, 32);\n" name;
7704 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7705 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
7709 pr " int len = r->%s_len;\n" name;
7710 pr " char s[len+1];\n";
7711 pr " memcpy (s, r->%s, len);\n" name;
7712 pr " s[len] = 0;\n";
7713 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7714 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
7716 | name, (FBytes|FUInt64|FInt64) ->
7717 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
7718 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
7719 | name, (FUInt32|FInt32) ->
7720 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
7721 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
7722 | name, FOptPercent ->
7723 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
7724 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
7726 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
7727 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
7732 and generate_java_struct_list_return typ jtyp cols =
7733 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
7734 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
7735 pr " for (i = 0; i < r->len; ++i) {\n";
7736 pr " jfl = (*env)->AllocObject (env, cl);\n";
7740 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7741 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
7744 pr " char s[33];\n";
7745 pr " memcpy (s, r->val[i].%s, 32);\n" name;
7747 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7748 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
7752 pr " int len = r->val[i].%s_len;\n" name;
7753 pr " char s[len+1];\n";
7754 pr " memcpy (s, r->val[i].%s, len);\n" name;
7755 pr " s[len] = 0;\n";
7756 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7757 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
7759 | name, (FBytes|FUInt64|FInt64) ->
7760 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
7761 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
7762 | name, (FUInt32|FInt32) ->
7763 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
7764 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
7765 | name, FOptPercent ->
7766 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
7767 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
7769 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
7770 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
7772 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
7774 pr " guestfs_free_%s_list (r);\n" typ;
7777 and generate_haskell_hs () =
7778 generate_header HaskellStyle LGPLv2;
7780 (* XXX We only know how to generate partial FFI for Haskell
7781 * at the moment. Please help out!
7783 let can_generate style =
7787 | RInt64 _, _ -> true
7794 | RHashtable _, _ -> false in
7797 {-# INCLUDE <guestfs.h> #-}
7798 {-# LANGUAGE ForeignFunctionInterface #-}
7803 (* List out the names of the actions we want to export. *)
7805 fun (name, style, _, _, _, _, _) ->
7806 if can_generate style then pr ",\n %s" name
7813 import Foreign.C.Types
7815 import Control.Exception
7816 import Data.Typeable
7818 data GuestfsS = GuestfsS -- represents the opaque C struct
7819 type GuestfsP = Ptr GuestfsS -- guestfs_h *
7820 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
7822 -- XXX define properly later XXX
7826 data IntBool = IntBool
7828 data StatVFS = StatVFS
7829 data Hashtable = Hashtable
7831 foreign import ccall unsafe \"guestfs_create\" c_create
7833 foreign import ccall unsafe \"&guestfs_close\" c_close
7834 :: FunPtr (GuestfsP -> IO ())
7835 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
7836 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
7838 create :: IO GuestfsH
7841 c_set_error_handler p nullPtr nullPtr
7842 h <- newForeignPtr c_close p
7845 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
7846 :: GuestfsP -> IO CString
7848 -- last_error :: GuestfsH -> IO (Maybe String)
7849 -- last_error h = do
7850 -- str <- withForeignPtr h (\\p -> c_last_error p)
7851 -- maybePeek peekCString str
7853 last_error :: GuestfsH -> IO (String)
7855 str <- withForeignPtr h (\\p -> c_last_error p)
7857 then return \"no error\"
7858 else peekCString str
7862 (* Generate wrappers for each foreign function. *)
7864 fun (name, style, _, _, _, _, _) ->
7865 if can_generate style then (
7866 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
7868 generate_haskell_prototype ~handle:"GuestfsP" style;
7872 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
7874 pr "%s %s = do\n" name
7875 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
7877 (* Convert pointer arguments using with* functions. *)
7882 | String n -> pr "withCString %s $ \\%s -> " n n
7883 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
7884 | StringList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
7885 | Bool _ | Int _ -> ()
7887 (* Convert integer arguments. *)
7891 | Bool n -> sprintf "(fromBool %s)" n
7892 | Int n -> sprintf "(fromIntegral %s)" n
7893 | FileIn n | FileOut n | String n | OptString n | StringList n -> n
7895 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
7896 (String.concat " " ("p" :: args));
7897 (match fst style with
7898 | RErr | RInt _ | RInt64 _ | RBool _ ->
7899 pr " if (r == -1)\n";
7901 pr " err <- last_error h\n";
7903 | RConstString _ | RString _ | RStringList _ | RStruct _
7904 | RStructList _ | RHashtable _ ->
7905 pr " if (r == nullPtr)\n";
7907 pr " err <- last_error h\n";
7910 (match fst style with
7912 pr " else return ()\n"
7914 pr " else return (fromIntegral r)\n"
7916 pr " else return (fromIntegral r)\n"
7918 pr " else return (toBool r)\n"
7925 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
7931 and generate_haskell_prototype ~handle ?(hs = false) style =
7933 let string = if hs then "String" else "CString" in
7934 let int = if hs then "Int" else "CInt" in
7935 let bool = if hs then "Bool" else "CInt" in
7936 let int64 = if hs then "Integer" else "Int64" in
7940 | String _ -> pr "%s" string
7941 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
7942 | StringList _ -> if hs then pr "[String]" else pr "Ptr CString"
7943 | Bool _ -> pr "%s" bool
7944 | Int _ -> pr "%s" int
7945 | FileIn _ -> pr "%s" string
7946 | FileOut _ -> pr "%s" string
7951 (match fst style with
7952 | RErr -> if not hs then pr "CInt"
7953 | RInt _ -> pr "%s" int
7954 | RInt64 _ -> pr "%s" int64
7955 | RBool _ -> pr "%s" bool
7956 | RConstString _ -> pr "%s" string
7957 | RString _ -> pr "%s" string
7958 | RStringList _ -> pr "[%s]" string
7959 | RStruct (_, typ) ->
7960 let name = java_name_of_struct typ in
7962 | RStructList (_, typ) ->
7963 let name = java_name_of_struct typ in
7965 | RHashtable _ -> pr "Hashtable"
7969 and generate_bindtests () =
7970 generate_header CStyle LGPLv2;
7975 #include <inttypes.h>
7978 #include \"guestfs.h\"
7979 #include \"guestfs_protocol.h\"
7981 #define error guestfs_error
7982 #define safe_calloc guestfs_safe_calloc
7983 #define safe_malloc guestfs_safe_malloc
7986 print_strings (char * const* const argv)
7991 for (argc = 0; argv[argc] != NULL; ++argc) {
7992 if (argc > 0) printf (\", \");
7993 printf (\"\\\"%%s\\\"\", argv[argc]);
7998 /* The test0 function prints its parameters to stdout. */
8002 match test_functions with
8003 | [] -> assert false
8004 | test0 :: tests -> test0, tests in
8007 let (name, style, _, _, _, _, _) = test0 in
8008 generate_prototype ~extern:false ~semicolon:false ~newline:true
8009 ~handle:"g" ~prefix:"guestfs_" name style;
8015 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
8016 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
8017 | StringList n -> pr " print_strings (%s);\n" n
8018 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
8019 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
8021 pr " /* Java changes stdout line buffering so we need this: */\n";
8022 pr " fflush (stdout);\n";
8028 fun (name, style, _, _, _, _, _) ->
8029 if String.sub name (String.length name - 3) 3 <> "err" then (
8030 pr "/* Test normal return. */\n";
8031 generate_prototype ~extern:false ~semicolon:false ~newline:true
8032 ~handle:"g" ~prefix:"guestfs_" name style;
8034 (match fst style with
8039 pr " sscanf (val, \"%%d\", &r);\n";
8043 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
8046 pr " return strcmp (val, \"true\") == 0;\n"
8048 (* Can't return the input string here. Return a static
8049 * string so we ensure we get a segfault if the caller
8052 pr " return \"static string\";\n"
8054 pr " return strdup (val);\n"
8056 pr " char **strs;\n";
8058 pr " sscanf (val, \"%%d\", &n);\n";
8059 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
8060 pr " for (i = 0; i < n; ++i) {\n";
8061 pr " strs[i] = safe_malloc (g, 16);\n";
8062 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
8064 pr " strs[n] = NULL;\n";
8065 pr " return strs;\n"
8066 | RStruct (_, typ) ->
8067 pr " struct guestfs_%s *r;\n" typ;
8068 pr " r = safe_calloc (g, sizeof *r, 1);\n";
8070 | RStructList (_, typ) ->
8071 pr " struct guestfs_%s_list *r;\n" typ;
8072 pr " r = safe_calloc (g, sizeof *r, 1);\n";
8073 pr " sscanf (val, \"%%d\", &r->len);\n";
8074 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
8077 pr " char **strs;\n";
8079 pr " sscanf (val, \"%%d\", &n);\n";
8080 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
8081 pr " for (i = 0; i < n; ++i) {\n";
8082 pr " strs[i*2] = safe_malloc (g, 16);\n";
8083 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
8084 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
8085 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
8087 pr " strs[n*2] = NULL;\n";
8088 pr " return strs;\n"
8093 pr "/* Test error return. */\n";
8094 generate_prototype ~extern:false ~semicolon:false ~newline:true
8095 ~handle:"g" ~prefix:"guestfs_" name style;
8097 pr " error (g, \"error\");\n";
8098 (match fst style with
8099 | RErr | RInt _ | RInt64 _ | RBool _ ->
8102 | RString _ | RStringList _ | RStruct _
8105 pr " return NULL;\n"
8112 and generate_ocaml_bindtests () =
8113 generate_header OCamlStyle GPLv2;
8117 let g = Guestfs.create () in
8124 | CallString s -> "\"" ^ s ^ "\""
8125 | CallOptString None -> "None"
8126 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
8127 | CallStringList xs ->
8128 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
8129 | CallInt i when i >= 0 -> string_of_int i
8130 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
8131 | CallBool b -> string_of_bool b
8136 generate_lang_bindtests (
8137 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
8140 pr "print_endline \"EOF\"\n"
8142 and generate_perl_bindtests () =
8143 pr "#!/usr/bin/perl -w\n";
8144 generate_header HashStyle GPLv2;
8151 my $g = Sys::Guestfs->new ();
8155 String.concat ", " (
8158 | CallString s -> "\"" ^ s ^ "\""
8159 | CallOptString None -> "undef"
8160 | CallOptString (Some s) -> sprintf "\"%s\"" s
8161 | CallStringList xs ->
8162 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8163 | CallInt i -> string_of_int i
8164 | CallBool b -> if b then "1" else "0"
8169 generate_lang_bindtests (
8170 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
8173 pr "print \"EOF\\n\"\n"
8175 and generate_python_bindtests () =
8176 generate_header HashStyle GPLv2;
8181 g = guestfs.GuestFS ()
8185 String.concat ", " (
8188 | CallString s -> "\"" ^ s ^ "\""
8189 | CallOptString None -> "None"
8190 | CallOptString (Some s) -> sprintf "\"%s\"" s
8191 | CallStringList xs ->
8192 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8193 | CallInt i -> string_of_int i
8194 | CallBool b -> if b then "1" else "0"
8199 generate_lang_bindtests (
8200 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
8203 pr "print \"EOF\"\n"
8205 and generate_ruby_bindtests () =
8206 generate_header HashStyle GPLv2;
8211 g = Guestfs::create()
8215 String.concat ", " (
8218 | CallString s -> "\"" ^ s ^ "\""
8219 | CallOptString None -> "nil"
8220 | CallOptString (Some s) -> sprintf "\"%s\"" s
8221 | CallStringList xs ->
8222 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8223 | CallInt i -> string_of_int i
8224 | CallBool b -> string_of_bool b
8229 generate_lang_bindtests (
8230 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
8233 pr "print \"EOF\\n\"\n"
8235 and generate_java_bindtests () =
8236 generate_header CStyle GPLv2;
8239 import com.redhat.et.libguestfs.*;
8241 public class Bindtests {
8242 public static void main (String[] argv)
8245 GuestFS g = new GuestFS ();
8249 String.concat ", " (
8252 | CallString s -> "\"" ^ s ^ "\""
8253 | CallOptString None -> "null"
8254 | CallOptString (Some s) -> sprintf "\"%s\"" s
8255 | CallStringList xs ->
8257 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
8258 | CallInt i -> string_of_int i
8259 | CallBool b -> string_of_bool b
8264 generate_lang_bindtests (
8265 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
8269 System.out.println (\"EOF\");
8271 catch (Exception exn) {
8272 System.err.println (exn);
8279 and generate_haskell_bindtests () =
8280 generate_header HaskellStyle GPLv2;
8283 module Bindtests where
8284 import qualified Guestfs
8294 | CallString s -> "\"" ^ s ^ "\""
8295 | CallOptString None -> "Nothing"
8296 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
8297 | CallStringList xs ->
8298 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8299 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
8300 | CallInt i -> string_of_int i
8301 | CallBool true -> "True"
8302 | CallBool false -> "False"
8307 generate_lang_bindtests (
8308 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
8311 pr " putStrLn \"EOF\"\n"
8313 (* Language-independent bindings tests - we do it this way to
8314 * ensure there is parity in testing bindings across all languages.
8316 and generate_lang_bindtests call =
8317 call "test0" [CallString "abc"; CallOptString (Some "def");
8318 CallStringList []; CallBool false;
8319 CallInt 0; CallString "123"; CallString "456"];
8320 call "test0" [CallString "abc"; CallOptString None;
8321 CallStringList []; CallBool false;
8322 CallInt 0; CallString "123"; CallString "456"];
8323 call "test0" [CallString ""; CallOptString (Some "def");
8324 CallStringList []; CallBool false;
8325 CallInt 0; CallString "123"; CallString "456"];
8326 call "test0" [CallString ""; CallOptString (Some "");
8327 CallStringList []; CallBool false;
8328 CallInt 0; CallString "123"; CallString "456"];
8329 call "test0" [CallString "abc"; CallOptString (Some "def");
8330 CallStringList ["1"]; CallBool false;
8331 CallInt 0; CallString "123"; CallString "456"];
8332 call "test0" [CallString "abc"; CallOptString (Some "def");
8333 CallStringList ["1"; "2"]; CallBool false;
8334 CallInt 0; CallString "123"; CallString "456"];
8335 call "test0" [CallString "abc"; CallOptString (Some "def");
8336 CallStringList ["1"]; CallBool true;
8337 CallInt 0; CallString "123"; CallString "456"];
8338 call "test0" [CallString "abc"; CallOptString (Some "def");
8339 CallStringList ["1"]; CallBool false;
8340 CallInt (-1); CallString "123"; CallString "456"];
8341 call "test0" [CallString "abc"; CallOptString (Some "def");
8342 CallStringList ["1"]; CallBool false;
8343 CallInt (-2); CallString "123"; CallString "456"];
8344 call "test0" [CallString "abc"; CallOptString (Some "def");
8345 CallStringList ["1"]; CallBool false;
8346 CallInt 1; CallString "123"; CallString "456"];
8347 call "test0" [CallString "abc"; CallOptString (Some "def");
8348 CallStringList ["1"]; CallBool false;
8349 CallInt 2; CallString "123"; CallString "456"];
8350 call "test0" [CallString "abc"; CallOptString (Some "def");
8351 CallStringList ["1"]; CallBool false;
8352 CallInt 4095; CallString "123"; CallString "456"];
8353 call "test0" [CallString "abc"; CallOptString (Some "def");
8354 CallStringList ["1"]; CallBool false;
8355 CallInt 0; CallString ""; CallString ""]
8357 (* XXX Add here tests of the return and error functions. *)
8359 (* This is used to generate the src/MAX_PROC_NR file which
8360 * contains the maximum procedure number, a surrogate for the
8361 * ABI version number. See src/Makefile.am for the details.
8363 and generate_max_proc_nr () =
8364 let proc_nrs = List.map (
8365 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
8366 ) daemon_functions in
8368 let max_proc_nr = List.fold_left max 0 proc_nrs in
8370 pr "%d\n" max_proc_nr
8372 let output_to filename =
8373 let filename_new = filename ^ ".new" in
8374 chan := open_out filename_new;
8379 (* Is the new file different from the current file? *)
8380 if Sys.file_exists filename && files_equal filename filename_new then
8381 Unix.unlink filename_new (* same, so skip it *)
8383 (* different, overwrite old one *)
8384 (try Unix.chmod filename 0o644 with Unix.Unix_error _ -> ());
8385 Unix.rename filename_new filename;
8386 Unix.chmod filename 0o444;
8387 printf "written %s\n%!" filename;
8396 if not (Sys.file_exists "HACKING") then (
8398 You are probably running this from the wrong directory.
8399 Run it from the top source directory using the command
8405 let close = output_to "src/guestfs_protocol.x" in
8409 let close = output_to "src/guestfs-structs.h" in
8410 generate_structs_h ();
8413 let close = output_to "src/guestfs-actions.h" in
8414 generate_actions_h ();
8417 let close = output_to "src/guestfs-actions.c" in
8418 generate_client_actions ();
8421 let close = output_to "daemon/actions.h" in
8422 generate_daemon_actions_h ();
8425 let close = output_to "daemon/stubs.c" in
8426 generate_daemon_actions ();
8429 let close = output_to "daemon/names.c" in
8430 generate_daemon_names ();
8433 let close = output_to "capitests/tests.c" in
8437 let close = output_to "src/guestfs-bindtests.c" in
8438 generate_bindtests ();
8441 let close = output_to "fish/cmds.c" in
8442 generate_fish_cmds ();
8445 let close = output_to "fish/completion.c" in
8446 generate_fish_completion ();
8449 let close = output_to "guestfs-structs.pod" in
8450 generate_structs_pod ();
8453 let close = output_to "guestfs-actions.pod" in
8454 generate_actions_pod ();
8457 let close = output_to "guestfish-actions.pod" in
8458 generate_fish_actions_pod ();
8461 let close = output_to "ocaml/guestfs.mli" in
8462 generate_ocaml_mli ();
8465 let close = output_to "ocaml/guestfs.ml" in
8466 generate_ocaml_ml ();
8469 let close = output_to "ocaml/guestfs_c_actions.c" in
8470 generate_ocaml_c ();
8473 let close = output_to "ocaml/bindtests.ml" in
8474 generate_ocaml_bindtests ();
8477 let close = output_to "perl/Guestfs.xs" in
8478 generate_perl_xs ();
8481 let close = output_to "perl/lib/Sys/Guestfs.pm" in
8482 generate_perl_pm ();
8485 let close = output_to "perl/bindtests.pl" in
8486 generate_perl_bindtests ();
8489 let close = output_to "python/guestfs-py.c" in
8490 generate_python_c ();
8493 let close = output_to "python/guestfs.py" in
8494 generate_python_py ();
8497 let close = output_to "python/bindtests.py" in
8498 generate_python_bindtests ();
8501 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
8505 let close = output_to "ruby/bindtests.rb" in
8506 generate_ruby_bindtests ();
8509 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
8510 generate_java_java ();
8515 let cols = cols_of_struct typ in
8516 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
8517 let close = output_to filename in
8518 generate_java_struct jtyp cols;
8522 let close = output_to "java/Makefile.inc" in
8523 pr "java_built_sources =";
8526 pr " com/redhat/et/libguestfs/%s.java" jtyp;
8528 pr " com/redhat/et/libguestfs/GuestFS.java\n";
8531 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in
8535 let close = output_to "java/Bindtests.java" in
8536 generate_java_bindtests ();
8539 let close = output_to "haskell/Guestfs.hs" in
8540 generate_haskell_hs ();
8543 let close = output_to "haskell/Bindtests.hs" in
8544 generate_haskell_bindtests ();
8547 let close = output_to "src/MAX_PROC_NR" in
8548 generate_max_proc_nr ();
8551 (* Always generate this file last, and unconditionally. It's used
8552 * by the Makefile to know when we must re-run the generator.
8554 let chan = open_out "src/stamp-generator" in