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
28 * all the output files.
30 * IMPORTANT: This script should NOT print any warnings. If it prints
31 * warnings, you should treat them as errors.
32 * [Need to add -warn-error to ocaml command line]
40 type style = ret * args
42 (* "RErr" as a return value means an int used as a simple error
43 * indication, ie. 0 or -1.
46 (* "RInt" as a return value means an int which is -1 for error
47 * or any value >= 0 on success. Only use this for smallish
48 * positive ints (0 <= i < 2^30).
51 (* "RInt64" is the same as RInt, but is guaranteed to be able
52 * to return a full 64 bit value, _except_ that -1 means error
53 * (so -1 cannot be a valid, non-error return value).
56 (* "RBool" is a bool return value which can be true/false or
60 (* "RConstString" is a string that refers to a constant value.
61 * Try to avoid using this. In particular you cannot use this
62 * for values returned from the daemon, because there is no
63 * thread-safe way to return them in the C API.
65 | RConstString of string
66 (* "RString" and "RStringList" are caller-frees. *)
68 | RStringList of string
69 (* Some limited tuples are possible: *)
70 | RIntBool of string * string
71 (* LVM PVs, VGs and LVs. *)
78 (* Key-value pairs of untyped strings. Turns into a hashtable or
79 * dictionary in languages which support it. DON'T use this as a
80 * general "bucket" for results. Prefer a stronger typed return
81 * value if one is available, or write a custom struct. Don't use
82 * this if the list could potentially be very long, since it is
83 * inefficient. Keys should be unique. NULLs are not permitted.
85 | RHashtable of string
87 and args = argt list (* Function parameters, guestfs handle is implicit. *)
89 (* Note in future we should allow a "variable args" parameter as
90 * the final parameter, to allow commands like
91 * chmod mode file [file(s)...]
92 * This is not implemented yet, but many commands (such as chmod)
93 * are currently defined with the argument order keeping this future
94 * possibility in mind.
97 | String of string (* const char *name, cannot be NULL *)
98 | OptString of string (* const char *name, may be NULL *)
99 | StringList of string(* list of strings (each string cannot be NULL) *)
100 | Bool of string (* boolean *)
101 | Int of string (* int (smallish ints, signed, <= 31 bits) *)
102 (* These are treated as filenames (simple string parameters) in
103 * the C API and bindings. But in the RPC protocol, we transfer
104 * the actual file content up to or down from the daemon.
105 * FileIn: local machine -> daemon (in request)
106 * FileOut: daemon -> local machine (in reply)
107 * In guestfish (only), the special name "-" means read from
108 * stdin or write to stdout.
114 | ProtocolLimitWarning (* display warning about protocol size limits *)
115 | DangerWillRobinson (* flags particularly dangerous commands *)
116 | FishAlias of string (* provide an alias for this cmd in guestfish *)
117 | FishAction of string (* call this function in guestfish *)
118 | NotInFish (* do not export via guestfish *)
120 let protocol_limit_warning =
121 "Because of the message protocol, there is a transfer limit
122 of somewhere between 2MB and 4MB. To transfer large files you should use
125 let danger_will_robinson =
126 "B<This command is dangerous. Without careful use you
127 can easily destroy all your data>."
129 (* You can supply zero or as many tests as you want per API call.
131 * Note that the test environment has 3 block devices, of size 500MB,
132 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc).
133 * Note for partitioning purposes, the 500MB device has 63 cylinders.
135 * To be able to run the tests in a reasonable amount of time,
136 * the virtual machine and block devices are reused between tests.
137 * So don't try testing kill_subprocess :-x
139 * Between each test we blockdev-setrw, umount-all, lvm-remove-all
142 * If the appliance is running an older Linux kernel (eg. RHEL 5) then
143 * devices are named /dev/hda etc. To cope with this, the test suite
144 * adds some hairly logic to detect this case, and then automagically
145 * replaces all strings which match "/dev/sd.*" with "/dev/hd.*".
146 * When writing test cases you shouldn't have to worry about this
149 * Don't assume anything about the previous contents of the block
150 * devices. Use 'Init*' to create some initial scenarios.
152 * You can add a prerequisite clause to any individual test. This
153 * is a run-time check, which, if it fails, causes the test to be
154 * skipped. Useful if testing a command which might not work on
155 * all variations of libguestfs builds. A test that has prerequisite
156 * of 'Always' is run unconditionally.
158 type tests = (test_init * test_prereq * test) list
160 (* Run the command sequence and just expect nothing to fail. *)
162 (* Run the command sequence and expect the output of the final
163 * command to be the string.
165 | TestOutput of seq * string
166 (* Run the command sequence and expect the output of the final
167 * command to be the list of strings.
169 | TestOutputList of seq * string list
170 (* Run the command sequence and expect the output of the final
171 * command to be the integer.
173 | TestOutputInt of seq * int
174 (* Run the command sequence and expect the output of the final
175 * command to be a true value (!= 0 or != NULL).
177 | TestOutputTrue of seq
178 (* Run the command sequence and expect the output of the final
179 * command to be a false value (== 0 or == NULL, but not an error).
181 | TestOutputFalse of seq
182 (* Run the command sequence and expect the output of the final
183 * command to be a list of the given length (but don't care about
186 | TestOutputLength of seq * int
187 (* Run the command sequence and expect the output of the final
188 * command to be a structure.
190 | TestOutputStruct of seq * test_field_compare list
191 (* Run the command sequence and expect the final command (only)
194 | TestLastFail of seq
196 and test_field_compare =
197 | CompareWithInt of string * int
198 | CompareWithString of string * string
199 | CompareFieldsIntEq of string * string
200 | CompareFieldsStrEq of string * string
202 (* Test prerequisites. *)
204 (* Test always runs. *)
206 (* Test is currently disabled - eg. it fails, or it tests some
207 * unimplemented feature.
210 (* 'string' is some C code (a function body) that should return
211 * true or false. The test will run if the code returns true.
214 (* As for 'If' but the test runs _unless_ the code returns true. *)
217 (* Some initial scenarios for testing. *)
219 (* Do nothing, block devices could contain random stuff including
220 * LVM PVs, and some filesystems might be mounted. This is usually
224 (* Block devices are empty and no filesystems are mounted. *)
226 (* /dev/sda contains a single partition /dev/sda1, which is formatted
227 * as ext2, empty [except for lost+found] and mounted on /.
228 * /dev/sdb and /dev/sdc may have random content.
233 * /dev/sda1 (is a PV):
234 * /dev/VG/LV (size 8MB):
235 * formatted as ext2, empty [except for lost+found], mounted on /
236 * /dev/sdb and /dev/sdc may have random content.
240 (* Sequence of commands for testing. *)
242 and cmd = string list
244 (* Canned test prerequisites. *)
245 let env_is_true env =
246 sprintf "const char *str = getenv (\"%s\");
247 return str && strcmp (str, \"1\") == 0;" env
249 (* Note about long descriptions: When referring to another
250 * action, use the format C<guestfs_other> (ie. the full name of
251 * the C function). This will be replaced as appropriate in other
254 * Apart from that, long descriptions are just perldoc paragraphs.
257 let non_daemon_functions = [
258 ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
260 "launch the qemu subprocess",
262 Internally libguestfs is implemented by running a virtual machine
265 You should call this after configuring the handle
266 (eg. adding drives) but before performing any actions.");
268 ("wait_ready", (RErr, []), -1, [NotInFish],
270 "wait until the qemu subprocess launches",
272 Internally libguestfs is implemented by running a virtual machine
275 You should call this after C<guestfs_launch> to wait for the launch
278 ("kill_subprocess", (RErr, []), -1, [],
280 "kill the qemu subprocess",
282 This kills the qemu subprocess. You should never need to call this.");
284 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
286 "add an image to examine or modify",
288 This function adds a virtual machine disk image C<filename> to the
289 guest. The first time you call this function, the disk appears as IDE
290 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
293 You don't necessarily need to be root when using libguestfs. However
294 you obviously do need sufficient permissions to access the filename
295 for whatever operations you want to perform (ie. read access if you
296 just want to read the image or write access if you want to modify the
299 This is equivalent to the qemu parameter C<-drive file=filename>.");
301 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
303 "add a CD-ROM disk image to examine",
305 This function adds a virtual CD-ROM disk image to the guest.
307 This is equivalent to the qemu parameter C<-cdrom filename>.");
309 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
311 "add qemu parameters",
313 This can be used to add arbitrary qemu command line parameters
314 of the form C<-param value>. Actually it's not quite arbitrary - we
315 prevent you from setting some parameters which would interfere with
316 parameters that we use.
318 The first character of C<param> string must be a C<-> (dash).
320 C<value> can be NULL.");
322 ("set_qemu", (RErr, [String "qemu"]), -1, [FishAlias "qemu"],
324 "set the qemu binary",
326 Set the qemu binary that we will use.
328 The default is chosen when the library was compiled by the
331 You can also override this by setting the C<LIBGUESTFS_QEMU>
332 environment variable.
334 Setting C<qemu> to C<NULL> restores the default qemu binary.");
336 ("get_qemu", (RConstString "qemu", []), -1, [],
338 "get the qemu binary",
340 Return the current qemu binary.
342 This is always non-NULL. If it wasn't set already, then this will
343 return the default qemu binary name.");
345 ("set_path", (RErr, [String "path"]), -1, [FishAlias "path"],
347 "set the search path",
349 Set the path that libguestfs searches for kernel and initrd.img.
351 The default is C<$libdir/guestfs> unless overridden by setting
352 C<LIBGUESTFS_PATH> environment variable.
354 Setting C<path> to C<NULL> restores the default path.");
356 ("get_path", (RConstString "path", []), -1, [],
358 "get the search path",
360 Return the current search path.
362 This is always non-NULL. If it wasn't set already, then this will
363 return the default path.");
365 ("set_append", (RErr, [String "append"]), -1, [FishAlias "append"],
367 "add options to kernel command line",
369 This function is used to add additional options to the
370 guest kernel command line.
372 The default is C<NULL> unless overridden by setting
373 C<LIBGUESTFS_APPEND> environment variable.
375 Setting C<append> to C<NULL> means I<no> additional options
376 are passed (libguestfs always adds a few of its own).");
378 ("get_append", (RConstString "append", []), -1, [],
380 "get the additional kernel options",
382 Return the additional kernel options which are added to the
383 guest kernel command line.
385 If C<NULL> then no options are added.");
387 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
391 If C<autosync> is true, this enables autosync. Libguestfs will make a
392 best effort attempt to run C<guestfs_umount_all> followed by
393 C<guestfs_sync> when the handle is closed
394 (also if the program exits without closing handles).
396 This is disabled by default (except in guestfish where it is
397 enabled by default).");
399 ("get_autosync", (RBool "autosync", []), -1, [],
403 Get the autosync flag.");
405 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
409 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
411 Verbose messages are disabled unless the environment variable
412 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
414 ("get_verbose", (RBool "verbose", []), -1, [],
418 This returns the verbose messages flag.");
420 ("is_ready", (RBool "ready", []), -1, [],
422 "is ready to accept commands",
424 This returns true iff this handle is ready to accept commands
425 (in the C<READY> state).
427 For more information on states, see L<guestfs(3)>.");
429 ("is_config", (RBool "config", []), -1, [],
431 "is in configuration state",
433 This returns true iff this handle is being configured
434 (in the C<CONFIG> state).
436 For more information on states, see L<guestfs(3)>.");
438 ("is_launching", (RBool "launching", []), -1, [],
440 "is launching subprocess",
442 This returns true iff this handle is launching the subprocess
443 (in the C<LAUNCHING> state).
445 For more information on states, see L<guestfs(3)>.");
447 ("is_busy", (RBool "busy", []), -1, [],
449 "is busy processing a command",
451 This returns true iff this handle is busy processing a command
452 (in the C<BUSY> state).
454 For more information on states, see L<guestfs(3)>.");
456 ("get_state", (RInt "state", []), -1, [],
458 "get the current state",
460 This returns the current state as an opaque integer. This is
461 only useful for printing debug and internal error messages.
463 For more information on states, see L<guestfs(3)>.");
465 ("set_busy", (RErr, []), -1, [NotInFish],
469 This sets the state to C<BUSY>. This is only used when implementing
470 actions using the low-level API.
472 For more information on states, see L<guestfs(3)>.");
474 ("set_ready", (RErr, []), -1, [NotInFish],
476 "set state to ready",
478 This sets the state to C<READY>. This is only used when implementing
479 actions using the low-level API.
481 For more information on states, see L<guestfs(3)>.");
483 ("end_busy", (RErr, []), -1, [NotInFish],
485 "leave the busy state",
487 This sets the state to C<READY>, or if in C<CONFIG> then it leaves the
488 state as is. This is only used when implementing
489 actions using the low-level API.
491 For more information on states, see L<guestfs(3)>.");
495 let daemon_functions = [
496 ("mount", (RErr, [String "device"; String "mountpoint"]), 1, [],
497 [InitEmpty, Always, TestOutput (
498 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
499 ["mkfs"; "ext2"; "/dev/sda1"];
500 ["mount"; "/dev/sda1"; "/"];
501 ["write_file"; "/new"; "new file contents"; "0"];
502 ["cat"; "/new"]], "new file contents")],
503 "mount a guest disk at a position in the filesystem",
505 Mount a guest disk at a position in the filesystem. Block devices
506 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
507 the guest. If those block devices contain partitions, they will have
508 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
511 The rules are the same as for L<mount(2)>: A filesystem must
512 first be mounted on C</> before others can be mounted. Other
513 filesystems can only be mounted on directories which already
516 The mounted filesystem is writable, if we have sufficient permissions
517 on the underlying device.
519 The filesystem options C<sync> and C<noatime> are set with this
520 call, in order to improve reliability.");
522 ("sync", (RErr, []), 2, [],
523 [ InitEmpty, Always, TestRun [["sync"]]],
524 "sync disks, writes are flushed through to the disk image",
526 This syncs the disk, so that any writes are flushed through to the
527 underlying disk image.
529 You should always call this if you have modified a disk image, before
530 closing the handle.");
532 ("touch", (RErr, [String "path"]), 3, [],
533 [InitBasicFS, Always, TestOutputTrue (
535 ["exists"; "/new"]])],
536 "update file timestamps or create a new file",
538 Touch acts like the L<touch(1)> command. It can be used to
539 update the timestamps on a file, or, if the file does not exist,
540 to create a new zero-length file.");
542 ("cat", (RString "content", [String "path"]), 4, [ProtocolLimitWarning],
543 [InitBasicFS, Always, TestOutput (
544 [["write_file"; "/new"; "new file contents"; "0"];
545 ["cat"; "/new"]], "new file contents")],
546 "list the contents of a file",
548 Return the contents of the file named C<path>.
550 Note that this function cannot correctly handle binary files
551 (specifically, files containing C<\\0> character which is treated
552 as end of string). For those you need to use the C<guestfs_download>
553 function which has a more complex interface.");
555 ("ll", (RString "listing", [String "directory"]), 5, [],
556 [], (* XXX Tricky to test because it depends on the exact format
557 * of the 'ls -l' command, which changes between F10 and F11.
559 "list the files in a directory (long format)",
561 List the files in C<directory> (relative to the root directory,
562 there is no cwd) in the format of 'ls -la'.
564 This command is mostly useful for interactive sessions. It
565 is I<not> intended that you try to parse the output string.");
567 ("ls", (RStringList "listing", [String "directory"]), 6, [],
568 [InitBasicFS, Always, TestOutputList (
571 ["touch"; "/newest"];
572 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
573 "list the files in a directory",
575 List the files in C<directory> (relative to the root directory,
576 there is no cwd). The '.' and '..' entries are not returned, but
577 hidden files are shown.
579 This command is mostly useful for interactive sessions. Programs
580 should probably use C<guestfs_readdir> instead.");
582 ("list_devices", (RStringList "devices", []), 7, [],
583 [InitEmpty, Always, TestOutputList (
584 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"])],
585 "list the block devices",
587 List all the block devices.
589 The full block device names are returned, eg. C</dev/sda>");
591 ("list_partitions", (RStringList "partitions", []), 8, [],
592 [InitBasicFS, Always, TestOutputList (
593 [["list_partitions"]], ["/dev/sda1"]);
594 InitEmpty, Always, TestOutputList (
595 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
596 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
597 "list the partitions",
599 List all the partitions detected on all block devices.
601 The full partition device names are returned, eg. C</dev/sda1>
603 This does not return logical volumes. For that you will need to
604 call C<guestfs_lvs>.");
606 ("pvs", (RStringList "physvols", []), 9, [],
607 [InitBasicFSonLVM, Always, TestOutputList (
608 [["pvs"]], ["/dev/sda1"]);
609 InitEmpty, Always, TestOutputList (
610 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
611 ["pvcreate"; "/dev/sda1"];
612 ["pvcreate"; "/dev/sda2"];
613 ["pvcreate"; "/dev/sda3"];
614 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
615 "list the LVM physical volumes (PVs)",
617 List all the physical volumes detected. This is the equivalent
618 of the L<pvs(8)> command.
620 This returns a list of just the device names that contain
621 PVs (eg. C</dev/sda2>).
623 See also C<guestfs_pvs_full>.");
625 ("vgs", (RStringList "volgroups", []), 10, [],
626 [InitBasicFSonLVM, Always, TestOutputList (
628 InitEmpty, Always, TestOutputList (
629 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
630 ["pvcreate"; "/dev/sda1"];
631 ["pvcreate"; "/dev/sda2"];
632 ["pvcreate"; "/dev/sda3"];
633 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
634 ["vgcreate"; "VG2"; "/dev/sda3"];
635 ["vgs"]], ["VG1"; "VG2"])],
636 "list the LVM volume groups (VGs)",
638 List all the volumes groups detected. This is the equivalent
639 of the L<vgs(8)> command.
641 This returns a list of just the volume group names that were
642 detected (eg. C<VolGroup00>).
644 See also C<guestfs_vgs_full>.");
646 ("lvs", (RStringList "logvols", []), 11, [],
647 [InitBasicFSonLVM, Always, TestOutputList (
648 [["lvs"]], ["/dev/VG/LV"]);
649 InitEmpty, Always, TestOutputList (
650 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
651 ["pvcreate"; "/dev/sda1"];
652 ["pvcreate"; "/dev/sda2"];
653 ["pvcreate"; "/dev/sda3"];
654 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
655 ["vgcreate"; "VG2"; "/dev/sda3"];
656 ["lvcreate"; "LV1"; "VG1"; "50"];
657 ["lvcreate"; "LV2"; "VG1"; "50"];
658 ["lvcreate"; "LV3"; "VG2"; "50"];
659 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
660 "list the LVM logical volumes (LVs)",
662 List all the logical volumes detected. This is the equivalent
663 of the L<lvs(8)> command.
665 This returns a list of the logical volume device names
666 (eg. C</dev/VolGroup00/LogVol00>).
668 See also C<guestfs_lvs_full>.");
670 ("pvs_full", (RPVList "physvols", []), 12, [],
671 [], (* XXX how to test? *)
672 "list the LVM physical volumes (PVs)",
674 List all the physical volumes detected. This is the equivalent
675 of the L<pvs(8)> command. The \"full\" version includes all fields.");
677 ("vgs_full", (RVGList "volgroups", []), 13, [],
678 [], (* XXX how to test? *)
679 "list the LVM volume groups (VGs)",
681 List all the volumes groups detected. This is the equivalent
682 of the L<vgs(8)> command. The \"full\" version includes all fields.");
684 ("lvs_full", (RLVList "logvols", []), 14, [],
685 [], (* XXX how to test? *)
686 "list the LVM logical volumes (LVs)",
688 List all the logical volumes detected. This is the equivalent
689 of the L<lvs(8)> command. The \"full\" version includes all fields.");
691 ("read_lines", (RStringList "lines", [String "path"]), 15, [],
692 [InitBasicFS, Always, TestOutputList (
693 [["write_file"; "/new"; "line1\r\nline2\nline3"; "0"];
694 ["read_lines"; "/new"]], ["line1"; "line2"; "line3"]);
695 InitBasicFS, Always, TestOutputList (
696 [["write_file"; "/new"; ""; "0"];
697 ["read_lines"; "/new"]], [])],
698 "read file as lines",
700 Return the contents of the file named C<path>.
702 The file contents are returned as a list of lines. Trailing
703 C<LF> and C<CRLF> character sequences are I<not> returned.
705 Note that this function cannot correctly handle binary files
706 (specifically, files containing C<\\0> character which is treated
707 as end of line). For those you need to use the C<guestfs_read_file>
708 function which has a more complex interface.");
710 ("aug_init", (RErr, [String "root"; Int "flags"]), 16, [],
711 [], (* XXX Augeas code needs tests. *)
712 "create a new Augeas handle",
714 Create a new Augeas handle for editing configuration files.
715 If there was any previous Augeas handle associated with this
716 guestfs session, then it is closed.
718 You must call this before using any other C<guestfs_aug_*>
721 C<root> is the filesystem root. C<root> must not be NULL,
724 The flags are the same as the flags defined in
725 E<lt>augeas.hE<gt>, the logical I<or> of the following
730 =item C<AUG_SAVE_BACKUP> = 1
732 Keep the original file with a C<.augsave> extension.
734 =item C<AUG_SAVE_NEWFILE> = 2
736 Save changes into a file with extension C<.augnew>, and
737 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
739 =item C<AUG_TYPE_CHECK> = 4
741 Typecheck lenses (can be expensive).
743 =item C<AUG_NO_STDINC> = 8
745 Do not use standard load path for modules.
747 =item C<AUG_SAVE_NOOP> = 16
749 Make save a no-op, just record what would have been changed.
751 =item C<AUG_NO_LOAD> = 32
753 Do not load the tree in C<guestfs_aug_init>.
757 To close the handle, you can call C<guestfs_aug_close>.
759 To find out more about Augeas, see L<http://augeas.net/>.");
761 ("aug_close", (RErr, []), 26, [],
762 [], (* XXX Augeas code needs tests. *)
763 "close the current Augeas handle",
765 Close the current Augeas handle and free up any resources
766 used by it. After calling this, you have to call
767 C<guestfs_aug_init> again before you can use any other
770 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [],
771 [], (* XXX Augeas code needs tests. *)
772 "define an Augeas variable",
774 Defines an Augeas variable C<name> whose value is the result
775 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
778 On success this returns the number of nodes in C<expr>, or
779 C<0> if C<expr> evaluates to something which is not a nodeset.");
781 ("aug_defnode", (RIntBool ("nrnodes", "created"), [String "name"; String "expr"; String "val"]), 18, [],
782 [], (* XXX Augeas code needs tests. *)
783 "define an Augeas node",
785 Defines a variable C<name> whose value is the result of
788 If C<expr> evaluates to an empty nodeset, a node is created,
789 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
790 C<name> will be the nodeset containing that single node.
792 On success this returns a pair containing the
793 number of nodes in the nodeset, and a boolean flag
794 if a node was created.");
796 ("aug_get", (RString "val", [String "path"]), 19, [],
797 [], (* XXX Augeas code needs tests. *)
798 "look up the value of an Augeas path",
800 Look up the value associated with C<path>. If C<path>
801 matches exactly one node, the C<value> is returned.");
803 ("aug_set", (RErr, [String "path"; String "val"]), 20, [],
804 [], (* XXX Augeas code needs tests. *)
805 "set Augeas path to value",
807 Set the value associated with C<path> to C<value>.");
809 ("aug_insert", (RErr, [String "path"; String "label"; Bool "before"]), 21, [],
810 [], (* XXX Augeas code needs tests. *)
811 "insert a sibling Augeas node",
813 Create a new sibling C<label> for C<path>, inserting it into
814 the tree before or after C<path> (depending on the boolean
817 C<path> must match exactly one existing node in the tree, and
818 C<label> must be a label, ie. not contain C</>, C<*> or end
819 with a bracketed index C<[N]>.");
821 ("aug_rm", (RInt "nrnodes", [String "path"]), 22, [],
822 [], (* XXX Augeas code needs tests. *)
823 "remove an Augeas path",
825 Remove C<path> and all of its children.
827 On success this returns the number of entries which were removed.");
829 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [],
830 [], (* XXX Augeas code needs tests. *)
833 Move the node C<src> to C<dest>. C<src> must match exactly
834 one node. C<dest> is overwritten if it exists.");
836 ("aug_match", (RStringList "matches", [String "path"]), 24, [],
837 [], (* XXX Augeas code needs tests. *)
838 "return Augeas nodes which match path",
840 Returns a list of paths which match the path expression C<path>.
841 The returned paths are sufficiently qualified so that they match
842 exactly one node in the current tree.");
844 ("aug_save", (RErr, []), 25, [],
845 [], (* XXX Augeas code needs tests. *)
846 "write all pending Augeas changes to disk",
848 This writes all pending changes to disk.
850 The flags which were passed to C<guestfs_aug_init> affect exactly
851 how files are saved.");
853 ("aug_load", (RErr, []), 27, [],
854 [], (* XXX Augeas code needs tests. *)
855 "load files into the tree",
857 Load files into the tree.
859 See C<aug_load> in the Augeas documentation for the full gory
862 ("aug_ls", (RStringList "matches", [String "path"]), 28, [],
863 [], (* XXX Augeas code needs tests. *)
864 "list Augeas nodes under a path",
866 This is just a shortcut for listing C<guestfs_aug_match>
867 C<path/*> and sorting the resulting nodes into alphabetical order.");
869 ("rm", (RErr, [String "path"]), 29, [],
870 [InitBasicFS, Always, TestRun
873 InitBasicFS, Always, TestLastFail
875 InitBasicFS, Always, TestLastFail
880 Remove the single file C<path>.");
882 ("rmdir", (RErr, [String "path"]), 30, [],
883 [InitBasicFS, Always, TestRun
886 InitBasicFS, Always, TestLastFail
888 InitBasicFS, Always, TestLastFail
891 "remove a directory",
893 Remove the single directory C<path>.");
895 ("rm_rf", (RErr, [String "path"]), 31, [],
896 [InitBasicFS, Always, TestOutputFalse
898 ["mkdir"; "/new/foo"];
899 ["touch"; "/new/foo/bar"];
901 ["exists"; "/new"]]],
902 "remove a file or directory recursively",
904 Remove the file or directory C<path>, recursively removing the
905 contents if its a directory. This is like the C<rm -rf> shell
908 ("mkdir", (RErr, [String "path"]), 32, [],
909 [InitBasicFS, Always, TestOutputTrue
912 InitBasicFS, Always, TestLastFail
913 [["mkdir"; "/new/foo/bar"]]],
914 "create a directory",
916 Create a directory named C<path>.");
918 ("mkdir_p", (RErr, [String "path"]), 33, [],
919 [InitBasicFS, Always, TestOutputTrue
920 [["mkdir_p"; "/new/foo/bar"];
921 ["is_dir"; "/new/foo/bar"]];
922 InitBasicFS, Always, TestOutputTrue
923 [["mkdir_p"; "/new/foo/bar"];
924 ["is_dir"; "/new/foo"]];
925 InitBasicFS, Always, TestOutputTrue
926 [["mkdir_p"; "/new/foo/bar"];
927 ["is_dir"; "/new"]]],
928 "create a directory and parents",
930 Create a directory named C<path>, creating any parent directories
931 as necessary. This is like the C<mkdir -p> shell command.");
933 ("chmod", (RErr, [Int "mode"; String "path"]), 34, [],
934 [], (* XXX Need stat command to test *)
937 Change the mode (permissions) of C<path> to C<mode>. Only
938 numeric modes are supported.");
940 ("chown", (RErr, [Int "owner"; Int "group"; String "path"]), 35, [],
941 [], (* XXX Need stat command to test *)
942 "change file owner and group",
944 Change the file owner to C<owner> and group to C<group>.
946 Only numeric uid and gid are supported. If you want to use
947 names, you will need to locate and parse the password file
948 yourself (Augeas support makes this relatively easy).");
950 ("exists", (RBool "existsflag", [String "path"]), 36, [],
951 [InitBasicFS, Always, TestOutputTrue (
953 ["exists"; "/new"]]);
954 InitBasicFS, Always, TestOutputTrue (
956 ["exists"; "/new"]])],
957 "test if file or directory exists",
959 This returns C<true> if and only if there is a file, directory
960 (or anything) with the given C<path> name.
962 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
964 ("is_file", (RBool "fileflag", [String "path"]), 37, [],
965 [InitBasicFS, Always, TestOutputTrue (
967 ["is_file"; "/new"]]);
968 InitBasicFS, Always, TestOutputFalse (
970 ["is_file"; "/new"]])],
971 "test if file exists",
973 This returns C<true> if and only if there is a file
974 with the given C<path> name. Note that it returns false for
975 other objects like directories.
977 See also C<guestfs_stat>.");
979 ("is_dir", (RBool "dirflag", [String "path"]), 38, [],
980 [InitBasicFS, Always, TestOutputFalse (
982 ["is_dir"; "/new"]]);
983 InitBasicFS, Always, TestOutputTrue (
985 ["is_dir"; "/new"]])],
986 "test if file exists",
988 This returns C<true> if and only if there is a directory
989 with the given C<path> name. Note that it returns false for
990 other objects like files.
992 See also C<guestfs_stat>.");
994 ("pvcreate", (RErr, [String "device"]), 39, [],
995 [InitEmpty, Always, TestOutputList (
996 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
997 ["pvcreate"; "/dev/sda1"];
998 ["pvcreate"; "/dev/sda2"];
999 ["pvcreate"; "/dev/sda3"];
1000 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1001 "create an LVM physical volume",
1003 This creates an LVM physical volume on the named C<device>,
1004 where C<device> should usually be a partition name such
1007 ("vgcreate", (RErr, [String "volgroup"; StringList "physvols"]), 40, [],
1008 [InitEmpty, Always, TestOutputList (
1009 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1010 ["pvcreate"; "/dev/sda1"];
1011 ["pvcreate"; "/dev/sda2"];
1012 ["pvcreate"; "/dev/sda3"];
1013 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1014 ["vgcreate"; "VG2"; "/dev/sda3"];
1015 ["vgs"]], ["VG1"; "VG2"])],
1016 "create an LVM volume group",
1018 This creates an LVM volume group called C<volgroup>
1019 from the non-empty list of physical volumes C<physvols>.");
1021 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [],
1022 [InitEmpty, Always, TestOutputList (
1023 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1024 ["pvcreate"; "/dev/sda1"];
1025 ["pvcreate"; "/dev/sda2"];
1026 ["pvcreate"; "/dev/sda3"];
1027 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1028 ["vgcreate"; "VG2"; "/dev/sda3"];
1029 ["lvcreate"; "LV1"; "VG1"; "50"];
1030 ["lvcreate"; "LV2"; "VG1"; "50"];
1031 ["lvcreate"; "LV3"; "VG2"; "50"];
1032 ["lvcreate"; "LV4"; "VG2"; "50"];
1033 ["lvcreate"; "LV5"; "VG2"; "50"];
1035 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1036 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1037 "create an LVM volume group",
1039 This creates an LVM volume group called C<logvol>
1040 on the volume group C<volgroup>, with C<size> megabytes.");
1042 ("mkfs", (RErr, [String "fstype"; String "device"]), 42, [],
1043 [InitEmpty, Always, TestOutput (
1044 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1045 ["mkfs"; "ext2"; "/dev/sda1"];
1046 ["mount"; "/dev/sda1"; "/"];
1047 ["write_file"; "/new"; "new file contents"; "0"];
1048 ["cat"; "/new"]], "new file contents")],
1049 "make a filesystem",
1051 This creates a filesystem on C<device> (usually a partition
1052 or LVM logical volume). The filesystem type is C<fstype>, for
1055 ("sfdisk", (RErr, [String "device";
1056 Int "cyls"; Int "heads"; Int "sectors";
1057 StringList "lines"]), 43, [DangerWillRobinson],
1059 "create partitions on a block device",
1061 This is a direct interface to the L<sfdisk(8)> program for creating
1062 partitions on block devices.
1064 C<device> should be a block device, for example C</dev/sda>.
1066 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1067 and sectors on the device, which are passed directly to sfdisk as
1068 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1069 of these, then the corresponding parameter is omitted. Usually for
1070 'large' disks, you can just pass C<0> for these, but for small
1071 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1072 out the right geometry and you will need to tell it.
1074 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1075 information refer to the L<sfdisk(8)> manpage.
1077 To create a single partition occupying the whole disk, you would
1078 pass C<lines> as a single element list, when the single element being
1079 the string C<,> (comma).");
1081 ("write_file", (RErr, [String "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1082 [InitBasicFS, Always, TestOutput (
1083 [["write_file"; "/new"; "new file contents"; "0"];
1084 ["cat"; "/new"]], "new file contents");
1085 InitBasicFS, Always, TestOutput (
1086 [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1087 ["cat"; "/new"]], "\nnew file contents\n");
1088 InitBasicFS, Always, TestOutput (
1089 [["write_file"; "/new"; "\n\n"; "0"];
1090 ["cat"; "/new"]], "\n\n");
1091 InitBasicFS, Always, TestOutput (
1092 [["write_file"; "/new"; ""; "0"];
1093 ["cat"; "/new"]], "");
1094 InitBasicFS, Always, TestOutput (
1095 [["write_file"; "/new"; "\n\n\n"; "0"];
1096 ["cat"; "/new"]], "\n\n\n");
1097 InitBasicFS, Always, TestOutput (
1098 [["write_file"; "/new"; "\n"; "0"];
1099 ["cat"; "/new"]], "\n")],
1102 This call creates a file called C<path>. The contents of the
1103 file is the string C<content> (which can contain any 8 bit data),
1104 with length C<size>.
1106 As a special case, if C<size> is C<0>
1107 then the length is calculated using C<strlen> (so in this case
1108 the content cannot contain embedded ASCII NULs).
1110 I<NB.> Owing to a bug, writing content containing ASCII NUL
1111 characters does I<not> work, even if the length is specified.
1112 We hope to resolve this bug in a future version. In the meantime
1113 use C<guestfs_upload>.");
1115 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1116 [InitEmpty, Always, TestOutputList (
1117 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1118 ["mkfs"; "ext2"; "/dev/sda1"];
1119 ["mount"; "/dev/sda1"; "/"];
1120 ["mounts"]], ["/dev/sda1"]);
1121 InitEmpty, Always, TestOutputList (
1122 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1123 ["mkfs"; "ext2"; "/dev/sda1"];
1124 ["mount"; "/dev/sda1"; "/"];
1127 "unmount a filesystem",
1129 This unmounts the given filesystem. The filesystem may be
1130 specified either by its mountpoint (path) or the device which
1131 contains the filesystem.");
1133 ("mounts", (RStringList "devices", []), 46, [],
1134 [InitBasicFS, Always, TestOutputList (
1135 [["mounts"]], ["/dev/sda1"])],
1136 "show mounted filesystems",
1138 This returns the list of currently mounted filesystems. It returns
1139 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1141 Some internal mounts are not shown.");
1143 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1144 [InitBasicFS, Always, TestOutputList (
1147 (* check that umount_all can unmount nested mounts correctly: *)
1148 InitEmpty, Always, TestOutputList (
1149 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1150 ["mkfs"; "ext2"; "/dev/sda1"];
1151 ["mkfs"; "ext2"; "/dev/sda2"];
1152 ["mkfs"; "ext2"; "/dev/sda3"];
1153 ["mount"; "/dev/sda1"; "/"];
1155 ["mount"; "/dev/sda2"; "/mp1"];
1156 ["mkdir"; "/mp1/mp2"];
1157 ["mount"; "/dev/sda3"; "/mp1/mp2"];
1158 ["mkdir"; "/mp1/mp2/mp3"];
1161 "unmount all filesystems",
1163 This unmounts all mounted filesystems.
1165 Some internal mounts are not unmounted by this call.");
1167 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson],
1169 "remove all LVM LVs, VGs and PVs",
1171 This command removes all LVM logical volumes, volume groups
1172 and physical volumes.");
1174 ("file", (RString "description", [String "path"]), 49, [],
1175 [InitBasicFS, Always, TestOutput (
1177 ["file"; "/new"]], "empty");
1178 InitBasicFS, Always, TestOutput (
1179 [["write_file"; "/new"; "some content\n"; "0"];
1180 ["file"; "/new"]], "ASCII text");
1181 InitBasicFS, Always, TestLastFail (
1182 [["file"; "/nofile"]])],
1183 "determine file type",
1185 This call uses the standard L<file(1)> command to determine
1186 the type or contents of the file. This also works on devices,
1187 for example to find out whether a partition contains a filesystem.
1189 The exact command which runs is C<file -bsL path>. Note in
1190 particular that the filename is not prepended to the output
1191 (the C<-b> option).");
1193 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1194 [InitBasicFS, Unless (env_is_true "SKIP_TEST_COMMAND"), TestOutput (
1195 [["upload"; "test-command"; "/test-command"];
1196 ["chmod"; "493"; "/test-command"];
1197 ["command"; "/test-command 1"]], "Result1");
1198 InitBasicFS, Unless (env_is_true "SKIP_TEST_COMMAND"), TestOutput (
1199 [["upload"; "test-command"; "/test-command"];
1200 ["chmod"; "493"; "/test-command"];
1201 ["command"; "/test-command 2"]], "Result2\n");
1202 InitBasicFS, Unless (env_is_true "SKIP_TEST_COMMAND"), TestOutput (
1203 [["upload"; "test-command"; "/test-command"];
1204 ["chmod"; "493"; "/test-command"];
1205 ["command"; "/test-command 3"]], "\nResult3");
1206 InitBasicFS, Unless (env_is_true "SKIP_TEST_COMMAND"), TestOutput (
1207 [["upload"; "test-command"; "/test-command"];
1208 ["chmod"; "493"; "/test-command"];
1209 ["command"; "/test-command 4"]], "\nResult4\n");
1210 InitBasicFS, Unless (env_is_true "SKIP_TEST_COMMAND"), TestOutput (
1211 [["upload"; "test-command"; "/test-command"];
1212 ["chmod"; "493"; "/test-command"];
1213 ["command"; "/test-command 5"]], "\nResult5\n\n");
1214 InitBasicFS, Unless (env_is_true "SKIP_TEST_COMMAND"), TestOutput (
1215 [["upload"; "test-command"; "/test-command"];
1216 ["chmod"; "493"; "/test-command"];
1217 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1218 InitBasicFS, Unless (env_is_true "SKIP_TEST_COMMAND"), TestOutput (
1219 [["upload"; "test-command"; "/test-command"];
1220 ["chmod"; "493"; "/test-command"];
1221 ["command"; "/test-command 7"]], "");
1222 InitBasicFS, Unless (env_is_true "SKIP_TEST_COMMAND"), TestOutput (
1223 [["upload"; "test-command"; "/test-command"];
1224 ["chmod"; "493"; "/test-command"];
1225 ["command"; "/test-command 8"]], "\n");
1226 InitBasicFS, Unless (env_is_true "SKIP_TEST_COMMAND"), TestOutput (
1227 [["upload"; "test-command"; "/test-command"];
1228 ["chmod"; "493"; "/test-command"];
1229 ["command"; "/test-command 9"]], "\n\n");
1230 InitBasicFS, Unless (env_is_true "SKIP_TEST_COMMAND"), TestOutput (
1231 [["upload"; "test-command"; "/test-command"];
1232 ["chmod"; "493"; "/test-command"];
1233 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1234 InitBasicFS, Unless (env_is_true "SKIP_TEST_COMMAND"), TestOutput (
1235 [["upload"; "test-command"; "/test-command"];
1236 ["chmod"; "493"; "/test-command"];
1237 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1238 InitBasicFS, Unless (env_is_true "SKIP_TEST_COMMAND"), TestLastFail (
1239 [["upload"; "test-command"; "/test-command"];
1240 ["chmod"; "493"; "/test-command"];
1241 ["command"; "/test-command"]])],
1242 "run a command from the guest filesystem",
1244 This call runs a command from the guest filesystem. The
1245 filesystem must be mounted, and must contain a compatible
1246 operating system (ie. something Linux, with the same
1247 or compatible processor architecture).
1249 The single parameter is an argv-style list of arguments.
1250 The first element is the name of the program to run.
1251 Subsequent elements are parameters. The list must be
1252 non-empty (ie. must contain a program name).
1254 The return value is anything printed to I<stdout> by
1257 If the command returns a non-zero exit status, then
1258 this function returns an error message. The error message
1259 string is the content of I<stderr> from the command.
1261 The C<$PATH> environment variable will contain at least
1262 C</usr/bin> and C</bin>. If you require a program from
1263 another location, you should provide the full path in the
1266 Shared libraries and data files required by the program
1267 must be available on filesystems which are mounted in the
1268 correct places. It is the caller's responsibility to ensure
1269 all filesystems that are needed are mounted at the right
1272 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1273 [InitBasicFS, Unless (env_is_true "SKIP_TEST_COMMAND"), TestOutputList (
1274 [["upload"; "test-command"; "/test-command"];
1275 ["chmod"; "493"; "/test-command"];
1276 ["command_lines"; "/test-command 1"]], ["Result1"]);
1277 InitBasicFS, Unless (env_is_true "SKIP_TEST_COMMAND"), TestOutputList (
1278 [["upload"; "test-command"; "/test-command"];
1279 ["chmod"; "493"; "/test-command"];
1280 ["command_lines"; "/test-command 2"]], ["Result2"]);
1281 InitBasicFS, Unless (env_is_true "SKIP_TEST_COMMAND"), TestOutputList (
1282 [["upload"; "test-command"; "/test-command"];
1283 ["chmod"; "493"; "/test-command"];
1284 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1285 InitBasicFS, Unless (env_is_true "SKIP_TEST_COMMAND"), TestOutputList (
1286 [["upload"; "test-command"; "/test-command"];
1287 ["chmod"; "493"; "/test-command"];
1288 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1289 InitBasicFS, Unless (env_is_true "SKIP_TEST_COMMAND"), TestOutputList (
1290 [["upload"; "test-command"; "/test-command"];
1291 ["chmod"; "493"; "/test-command"];
1292 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1293 InitBasicFS, Unless (env_is_true "SKIP_TEST_COMMAND"), TestOutputList (
1294 [["upload"; "test-command"; "/test-command"];
1295 ["chmod"; "493"; "/test-command"];
1296 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1297 InitBasicFS, Unless (env_is_true "SKIP_TEST_COMMAND"), TestOutputList (
1298 [["upload"; "test-command"; "/test-command"];
1299 ["chmod"; "493"; "/test-command"];
1300 ["command_lines"; "/test-command 7"]], []);
1301 InitBasicFS, Unless (env_is_true "SKIP_TEST_COMMAND"), TestOutputList (
1302 [["upload"; "test-command"; "/test-command"];
1303 ["chmod"; "493"; "/test-command"];
1304 ["command_lines"; "/test-command 8"]], [""]);
1305 InitBasicFS, Unless (env_is_true "SKIP_TEST_COMMAND"), TestOutputList (
1306 [["upload"; "test-command"; "/test-command"];
1307 ["chmod"; "493"; "/test-command"];
1308 ["command_lines"; "/test-command 9"]], ["";""]);
1309 InitBasicFS, Unless (env_is_true "SKIP_TEST_COMMAND"), TestOutputList (
1310 [["upload"; "test-command"; "/test-command"];
1311 ["chmod"; "493"; "/test-command"];
1312 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1313 InitBasicFS, Unless (env_is_true "SKIP_TEST_COMMAND"), TestOutputList (
1314 [["upload"; "test-command"; "/test-command"];
1315 ["chmod"; "493"; "/test-command"];
1316 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1317 "run a command, returning lines",
1319 This is the same as C<guestfs_command>, but splits the
1320 result into a list of lines.");
1322 ("stat", (RStat "statbuf", [String "path"]), 52, [],
1323 [InitBasicFS, Always, TestOutputStruct (
1325 ["stat"; "/new"]], [CompareWithInt ("size", 0)])],
1326 "get file information",
1328 Returns file information for the given C<path>.
1330 This is the same as the C<stat(2)> system call.");
1332 ("lstat", (RStat "statbuf", [String "path"]), 53, [],
1333 [InitBasicFS, Always, TestOutputStruct (
1335 ["lstat"; "/new"]], [CompareWithInt ("size", 0)])],
1336 "get file information for a symbolic link",
1338 Returns file information for the given C<path>.
1340 This is the same as C<guestfs_stat> except that if C<path>
1341 is a symbolic link, then the link is stat-ed, not the file it
1344 This is the same as the C<lstat(2)> system call.");
1346 ("statvfs", (RStatVFS "statbuf", [String "path"]), 54, [],
1347 [InitBasicFS, Always, TestOutputStruct (
1348 [["statvfs"; "/"]], [CompareWithInt ("bfree", 487702);
1349 CompareWithInt ("blocks", 490020);
1350 CompareWithInt ("bsize", 1024)])],
1351 "get file system statistics",
1353 Returns file system statistics for any mounted file system.
1354 C<path> should be a file or directory in the mounted file system
1355 (typically it is the mount point itself, but it doesn't need to be).
1357 This is the same as the C<statvfs(2)> system call.");
1359 ("tune2fs_l", (RHashtable "superblock", [String "device"]), 55, [],
1361 "get ext2/ext3/ext4 superblock details",
1363 This returns the contents of the ext2, ext3 or ext4 filesystem
1364 superblock on C<device>.
1366 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1367 manpage for more details. The list of fields returned isn't
1368 clearly defined, and depends on both the version of C<tune2fs>
1369 that libguestfs was built against, and the filesystem itself.");
1371 ("blockdev_setro", (RErr, [String "device"]), 56, [],
1372 [InitEmpty, Always, TestOutputTrue (
1373 [["blockdev_setro"; "/dev/sda"];
1374 ["blockdev_getro"; "/dev/sda"]])],
1375 "set block device to read-only",
1377 Sets the block device named C<device> to read-only.
1379 This uses the L<blockdev(8)> command.");
1381 ("blockdev_setrw", (RErr, [String "device"]), 57, [],
1382 [InitEmpty, Always, TestOutputFalse (
1383 [["blockdev_setrw"; "/dev/sda"];
1384 ["blockdev_getro"; "/dev/sda"]])],
1385 "set block device to read-write",
1387 Sets the block device named C<device> to read-write.
1389 This uses the L<blockdev(8)> command.");
1391 ("blockdev_getro", (RBool "ro", [String "device"]), 58, [],
1392 [InitEmpty, Always, TestOutputTrue (
1393 [["blockdev_setro"; "/dev/sda"];
1394 ["blockdev_getro"; "/dev/sda"]])],
1395 "is block device set to read-only",
1397 Returns a boolean indicating if the block device is read-only
1398 (true if read-only, false if not).
1400 This uses the L<blockdev(8)> command.");
1402 ("blockdev_getss", (RInt "sectorsize", [String "device"]), 59, [],
1403 [InitEmpty, Always, TestOutputInt (
1404 [["blockdev_getss"; "/dev/sda"]], 512)],
1405 "get sectorsize of block device",
1407 This returns the size of sectors on a block device.
1408 Usually 512, but can be larger for modern devices.
1410 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1413 This uses the L<blockdev(8)> command.");
1415 ("blockdev_getbsz", (RInt "blocksize", [String "device"]), 60, [],
1416 [InitEmpty, Always, TestOutputInt (
1417 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1418 "get blocksize of block device",
1420 This returns the block size of a device.
1422 (Note this is different from both I<size in blocks> and
1423 I<filesystem block size>).
1425 This uses the L<blockdev(8)> command.");
1427 ("blockdev_setbsz", (RErr, [String "device"; Int "blocksize"]), 61, [],
1429 "set blocksize of block device",
1431 This sets the block size of a device.
1433 (Note this is different from both I<size in blocks> and
1434 I<filesystem block size>).
1436 This uses the L<blockdev(8)> command.");
1438 ("blockdev_getsz", (RInt64 "sizeinsectors", [String "device"]), 62, [],
1439 [InitEmpty, Always, TestOutputInt (
1440 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1441 "get total size of device in 512-byte sectors",
1443 This returns the size of the device in units of 512-byte sectors
1444 (even if the sectorsize isn't 512 bytes ... weird).
1446 See also C<guestfs_blockdev_getss> for the real sector size of
1447 the device, and C<guestfs_blockdev_getsize64> for the more
1448 useful I<size in bytes>.
1450 This uses the L<blockdev(8)> command.");
1452 ("blockdev_getsize64", (RInt64 "sizeinbytes", [String "device"]), 63, [],
1453 [InitEmpty, Always, TestOutputInt (
1454 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1455 "get total size of device in bytes",
1457 This returns the size of the device in bytes.
1459 See also C<guestfs_blockdev_getsz>.
1461 This uses the L<blockdev(8)> command.");
1463 ("blockdev_flushbufs", (RErr, [String "device"]), 64, [],
1464 [InitEmpty, Always, TestRun
1465 [["blockdev_flushbufs"; "/dev/sda"]]],
1466 "flush device buffers",
1468 This tells the kernel to flush internal buffers associated
1471 This uses the L<blockdev(8)> command.");
1473 ("blockdev_rereadpt", (RErr, [String "device"]), 65, [],
1474 [InitEmpty, Always, TestRun
1475 [["blockdev_rereadpt"; "/dev/sda"]]],
1476 "reread partition table",
1478 Reread the partition table on C<device>.
1480 This uses the L<blockdev(8)> command.");
1482 ("upload", (RErr, [FileIn "filename"; String "remotefilename"]), 66, [],
1483 [InitBasicFS, Always, TestOutput (
1484 (* Pick a file from cwd which isn't likely to change. *)
1485 [["upload"; "COPYING.LIB"; "/COPYING.LIB"];
1486 ["checksum"; "md5"; "/COPYING.LIB"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1487 "upload a file from the local machine",
1489 Upload local file C<filename> to C<remotefilename> on the
1492 C<filename> can also be a named pipe.
1494 See also C<guestfs_download>.");
1496 ("download", (RErr, [String "remotefilename"; FileOut "filename"]), 67, [],
1497 [InitBasicFS, Always, TestOutput (
1498 (* Pick a file from cwd which isn't likely to change. *)
1499 [["upload"; "COPYING.LIB"; "/COPYING.LIB"];
1500 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1501 ["upload"; "testdownload.tmp"; "/upload"];
1502 ["checksum"; "md5"; "/upload"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1503 "download a file to the local machine",
1505 Download file C<remotefilename> and save it as C<filename>
1506 on the local machine.
1508 C<filename> can also be a named pipe.
1510 See also C<guestfs_upload>, C<guestfs_cat>.");
1512 ("checksum", (RString "checksum", [String "csumtype"; String "path"]), 68, [],
1513 [InitBasicFS, Always, TestOutput (
1514 [["write_file"; "/new"; "test\n"; "0"];
1515 ["checksum"; "crc"; "/new"]], "935282863");
1516 InitBasicFS, Always, TestLastFail (
1517 [["checksum"; "crc"; "/new"]]);
1518 InitBasicFS, Always, TestOutput (
1519 [["write_file"; "/new"; "test\n"; "0"];
1520 ["checksum"; "md5"; "/new"]], "d8e8fca2dc0f896fd7cb4cb0031ba249");
1521 InitBasicFS, Always, TestOutput (
1522 [["write_file"; "/new"; "test\n"; "0"];
1523 ["checksum"; "sha1"; "/new"]], "4e1243bd22c66e76c2ba9eddc1f91394e57f9f83");
1524 InitBasicFS, Always, TestOutput (
1525 [["write_file"; "/new"; "test\n"; "0"];
1526 ["checksum"; "sha224"; "/new"]], "52f1bf093f4b7588726035c176c0cdb4376cfea53819f1395ac9e6ec");
1527 InitBasicFS, Always, TestOutput (
1528 [["write_file"; "/new"; "test\n"; "0"];
1529 ["checksum"; "sha256"; "/new"]], "f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2");
1530 InitBasicFS, Always, TestOutput (
1531 [["write_file"; "/new"; "test\n"; "0"];
1532 ["checksum"; "sha384"; "/new"]], "109bb6b5b6d5547c1ce03c7a8bd7d8f80c1cb0957f50c4f7fda04692079917e4f9cad52b878f3d8234e1a170b154b72d");
1533 InitBasicFS, Always, TestOutput (
1534 [["write_file"; "/new"; "test\n"; "0"];
1535 ["checksum"; "sha512"; "/new"]], "0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123")],
1536 "compute MD5, SHAx or CRC checksum of file",
1538 This call computes the MD5, SHAx or CRC checksum of the
1541 The type of checksum to compute is given by the C<csumtype>
1542 parameter which must have one of the following values:
1548 Compute the cyclic redundancy check (CRC) specified by POSIX
1549 for the C<cksum> command.
1553 Compute the MD5 hash (using the C<md5sum> program).
1557 Compute the SHA1 hash (using the C<sha1sum> program).
1561 Compute the SHA224 hash (using the C<sha224sum> program).
1565 Compute the SHA256 hash (using the C<sha256sum> program).
1569 Compute the SHA384 hash (using the C<sha384sum> program).
1573 Compute the SHA512 hash (using the C<sha512sum> program).
1577 The checksum is returned as a printable string.");
1579 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1580 [InitBasicFS, Always, TestOutput (
1581 [["tar_in"; "images/helloworld.tar"; "/"];
1582 ["cat"; "/hello"]], "hello\n")],
1583 "unpack tarfile to directory",
1585 This command uploads and unpacks local file C<tarfile> (an
1586 I<uncompressed> tar file) into C<directory>.
1588 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1590 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1592 "pack directory into tarfile",
1594 This command packs the contents of C<directory> and downloads
1595 it to local file C<tarfile>.
1597 To download a compressed tarball, use C<guestfs_tgz_out>.");
1599 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1600 [InitBasicFS, Always, TestOutput (
1601 [["tgz_in"; "images/helloworld.tar.gz"; "/"];
1602 ["cat"; "/hello"]], "hello\n")],
1603 "unpack compressed tarball to directory",
1605 This command uploads and unpacks local file C<tarball> (a
1606 I<gzip compressed> tar file) into C<directory>.
1608 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1610 ("tgz_out", (RErr, [String "directory"; FileOut "tarball"]), 72, [],
1612 "pack directory into compressed tarball",
1614 This command packs the contents of C<directory> and downloads
1615 it to local file C<tarball>.
1617 To download an uncompressed tarball, use C<guestfs_tar_out>.");
1619 ("mount_ro", (RErr, [String "device"; String "mountpoint"]), 73, [],
1620 [InitBasicFS, Always, TestLastFail (
1622 ["mount_ro"; "/dev/sda1"; "/"];
1623 ["touch"; "/new"]]);
1624 InitBasicFS, Always, TestOutput (
1625 [["write_file"; "/new"; "data"; "0"];
1627 ["mount_ro"; "/dev/sda1"; "/"];
1628 ["cat"; "/new"]], "data")],
1629 "mount a guest disk, read-only",
1631 This is the same as the C<guestfs_mount> command, but it
1632 mounts the filesystem with the read-only (I<-o ro>) flag.");
1634 ("mount_options", (RErr, [String "options"; String "device"; String "mountpoint"]), 74, [],
1636 "mount a guest disk with mount options",
1638 This is the same as the C<guestfs_mount> command, but it
1639 allows you to set the mount options as for the
1640 L<mount(8)> I<-o> flag.");
1642 ("mount_vfs", (RErr, [String "options"; String "vfstype"; String "device"; String "mountpoint"]), 75, [],
1644 "mount a guest disk with mount options and vfstype",
1646 This is the same as the C<guestfs_mount> command, but it
1647 allows you to set both the mount options and the vfstype
1648 as for the L<mount(8)> I<-o> and I<-t> flags.");
1650 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
1652 "debugging and internals",
1654 The C<guestfs_debug> command exposes some internals of
1655 C<guestfsd> (the guestfs daemon) that runs inside the
1658 There is no comprehensive help for this command. You have
1659 to look at the file C<daemon/debug.c> in the libguestfs source
1660 to find out what you can do.");
1662 ("lvremove", (RErr, [String "device"]), 77, [],
1663 [InitEmpty, Always, TestOutputList (
1664 [["pvcreate"; "/dev/sda"];
1665 ["vgcreate"; "VG"; "/dev/sda"];
1666 ["lvcreate"; "LV1"; "VG"; "50"];
1667 ["lvcreate"; "LV2"; "VG"; "50"];
1668 ["lvremove"; "/dev/VG/LV1"];
1669 ["lvs"]], ["/dev/VG/LV2"]);
1670 InitEmpty, Always, TestOutputList (
1671 [["pvcreate"; "/dev/sda"];
1672 ["vgcreate"; "VG"; "/dev/sda"];
1673 ["lvcreate"; "LV1"; "VG"; "50"];
1674 ["lvcreate"; "LV2"; "VG"; "50"];
1675 ["lvremove"; "/dev/VG"];
1677 InitEmpty, Always, TestOutputList (
1678 [["pvcreate"; "/dev/sda"];
1679 ["vgcreate"; "VG"; "/dev/sda"];
1680 ["lvcreate"; "LV1"; "VG"; "50"];
1681 ["lvcreate"; "LV2"; "VG"; "50"];
1682 ["lvremove"; "/dev/VG"];
1684 "remove an LVM logical volume",
1686 Remove an LVM logical volume C<device>, where C<device> is
1687 the path to the LV, such as C</dev/VG/LV>.
1689 You can also remove all LVs in a volume group by specifying
1690 the VG name, C</dev/VG>.");
1692 ("vgremove", (RErr, [String "vgname"]), 78, [],
1693 [InitEmpty, Always, TestOutputList (
1694 [["pvcreate"; "/dev/sda"];
1695 ["vgcreate"; "VG"; "/dev/sda"];
1696 ["lvcreate"; "LV1"; "VG"; "50"];
1697 ["lvcreate"; "LV2"; "VG"; "50"];
1700 InitEmpty, Always, TestOutputList (
1701 [["pvcreate"; "/dev/sda"];
1702 ["vgcreate"; "VG"; "/dev/sda"];
1703 ["lvcreate"; "LV1"; "VG"; "50"];
1704 ["lvcreate"; "LV2"; "VG"; "50"];
1707 "remove an LVM volume group",
1709 Remove an LVM volume group C<vgname>, (for example C<VG>).
1711 This also forcibly removes all logical volumes in the volume
1714 ("pvremove", (RErr, [String "device"]), 79, [],
1715 [InitEmpty, Always, TestOutputList (
1716 [["pvcreate"; "/dev/sda"];
1717 ["vgcreate"; "VG"; "/dev/sda"];
1718 ["lvcreate"; "LV1"; "VG"; "50"];
1719 ["lvcreate"; "LV2"; "VG"; "50"];
1721 ["pvremove"; "/dev/sda"];
1723 InitEmpty, Always, TestOutputList (
1724 [["pvcreate"; "/dev/sda"];
1725 ["vgcreate"; "VG"; "/dev/sda"];
1726 ["lvcreate"; "LV1"; "VG"; "50"];
1727 ["lvcreate"; "LV2"; "VG"; "50"];
1729 ["pvremove"; "/dev/sda"];
1731 InitEmpty, Always, TestOutputList (
1732 [["pvcreate"; "/dev/sda"];
1733 ["vgcreate"; "VG"; "/dev/sda"];
1734 ["lvcreate"; "LV1"; "VG"; "50"];
1735 ["lvcreate"; "LV2"; "VG"; "50"];
1737 ["pvremove"; "/dev/sda"];
1739 "remove an LVM physical volume",
1741 This wipes a physical volume C<device> so that LVM will no longer
1744 The implementation uses the C<pvremove> command which refuses to
1745 wipe physical volumes that contain any volume groups, so you have
1746 to remove those first.");
1748 ("set_e2label", (RErr, [String "device"; String "label"]), 80, [],
1749 [InitBasicFS, Always, TestOutput (
1750 [["set_e2label"; "/dev/sda1"; "testlabel"];
1751 ["get_e2label"; "/dev/sda1"]], "testlabel")],
1752 "set the ext2/3/4 filesystem label",
1754 This sets the ext2/3/4 filesystem label of the filesystem on
1755 C<device> to C<label>. Filesystem labels are limited to
1758 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
1759 to return the existing label on a filesystem.");
1761 ("get_e2label", (RString "label", [String "device"]), 81, [],
1763 "get the ext2/3/4 filesystem label",
1765 This returns the ext2/3/4 filesystem label of the filesystem on
1768 ("set_e2uuid", (RErr, [String "device"; String "uuid"]), 82, [],
1769 [InitBasicFS, Always, TestOutput (
1770 [["set_e2uuid"; "/dev/sda1"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"];
1771 ["get_e2uuid"; "/dev/sda1"]], "a3a61220-882b-4f61-89f4-cf24dcc7297d");
1772 InitBasicFS, Always, TestOutput (
1773 [["set_e2uuid"; "/dev/sda1"; "clear"];
1774 ["get_e2uuid"; "/dev/sda1"]], "");
1775 (* We can't predict what UUIDs will be, so just check the commands run. *)
1776 InitBasicFS, Always, TestRun (
1777 [["set_e2uuid"; "/dev/sda1"; "random"]]);
1778 InitBasicFS, Always, TestRun (
1779 [["set_e2uuid"; "/dev/sda1"; "time"]])],
1780 "set the ext2/3/4 filesystem UUID",
1782 This sets the ext2/3/4 filesystem UUID of the filesystem on
1783 C<device> to C<uuid>. The format of the UUID and alternatives
1784 such as C<clear>, C<random> and C<time> are described in the
1785 L<tune2fs(8)> manpage.
1787 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
1788 to return the existing UUID of a filesystem.");
1790 ("get_e2uuid", (RString "uuid", [String "device"]), 83, [],
1792 "get the ext2/3/4 filesystem UUID",
1794 This returns the ext2/3/4 filesystem UUID of the filesystem on
1797 ("fsck", (RInt "status", [String "fstype"; String "device"]), 84, [],
1798 [InitBasicFS, Always, TestOutputInt (
1799 [["umount"; "/dev/sda1"];
1800 ["fsck"; "ext2"; "/dev/sda1"]], 0);
1801 InitBasicFS, Always, TestOutputInt (
1802 [["umount"; "/dev/sda1"];
1803 ["zero"; "/dev/sda1"];
1804 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
1805 "run the filesystem checker",
1807 This runs the filesystem checker (fsck) on C<device> which
1808 should have filesystem type C<fstype>.
1810 The returned integer is the status. See L<fsck(8)> for the
1811 list of status codes from C<fsck>.
1819 Multiple status codes can be summed together.
1823 A non-zero return code can mean \"success\", for example if
1824 errors have been corrected on the filesystem.
1828 Checking or repairing NTFS volumes is not supported
1833 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
1835 ("zero", (RErr, [String "device"]), 85, [],
1836 [InitBasicFS, Always, TestOutput (
1837 [["umount"; "/dev/sda1"];
1838 ["zero"; "/dev/sda1"];
1839 ["file"; "/dev/sda1"]], "data")],
1840 "write zeroes to the device",
1842 This command writes zeroes over the first few blocks of C<device>.
1844 How many blocks are zeroed isn't specified (but it's I<not> enough
1845 to securely wipe the device). It should be sufficient to remove
1846 any partition tables, filesystem superblocks and so on.");
1848 ("grub_install", (RErr, [String "root"; String "device"]), 86, [],
1849 [InitBasicFS, Always, TestOutputTrue (
1850 [["grub_install"; "/"; "/dev/sda1"];
1851 ["is_dir"; "/boot"]])],
1854 This command installs GRUB (the Grand Unified Bootloader) on
1855 C<device>, with the root directory being C<root>.");
1857 ("cp", (RErr, [String "src"; String "dest"]), 87, [],
1858 [InitBasicFS, Always, TestOutput (
1859 [["write_file"; "/old"; "file content"; "0"];
1860 ["cp"; "/old"; "/new"];
1861 ["cat"; "/new"]], "file content");
1862 InitBasicFS, Always, TestOutputTrue (
1863 [["write_file"; "/old"; "file content"; "0"];
1864 ["cp"; "/old"; "/new"];
1865 ["is_file"; "/old"]]);
1866 InitBasicFS, Always, TestOutput (
1867 [["write_file"; "/old"; "file content"; "0"];
1869 ["cp"; "/old"; "/dir/new"];
1870 ["cat"; "/dir/new"]], "file content")],
1873 This copies a file from C<src> to C<dest> where C<dest> is
1874 either a destination filename or destination directory.");
1876 ("cp_a", (RErr, [String "src"; String "dest"]), 88, [],
1877 [InitBasicFS, Always, TestOutput (
1878 [["mkdir"; "/olddir"];
1879 ["mkdir"; "/newdir"];
1880 ["write_file"; "/olddir/file"; "file content"; "0"];
1881 ["cp_a"; "/olddir"; "/newdir"];
1882 ["cat"; "/newdir/olddir/file"]], "file content")],
1883 "copy a file or directory recursively",
1885 This copies a file or directory from C<src> to C<dest>
1886 recursively using the C<cp -a> command.");
1888 ("mv", (RErr, [String "src"; String "dest"]), 89, [],
1889 [InitBasicFS, Always, TestOutput (
1890 [["write_file"; "/old"; "file content"; "0"];
1891 ["mv"; "/old"; "/new"];
1892 ["cat"; "/new"]], "file content");
1893 InitBasicFS, Always, TestOutputFalse (
1894 [["write_file"; "/old"; "file content"; "0"];
1895 ["mv"; "/old"; "/new"];
1896 ["is_file"; "/old"]])],
1899 This moves a file from C<src> to C<dest> where C<dest> is
1900 either a destination filename or destination directory.");
1902 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
1903 [InitEmpty, Always, TestRun (
1904 [["drop_caches"; "3"]])],
1905 "drop kernel page cache, dentries and inodes",
1907 This instructs the guest kernel to drop its page cache,
1908 and/or dentries and inode caches. The parameter C<whattodrop>
1909 tells the kernel what precisely to drop, see
1910 L<http://linux-mm.org/Drop_Caches>
1912 Setting C<whattodrop> to 3 should drop everything.
1914 This automatically calls L<sync(2)> before the operation,
1915 so that the maximum guest memory is freed.");
1917 ("dmesg", (RString "kmsgs", []), 91, [],
1918 [InitEmpty, Always, TestRun (
1920 "return kernel messages",
1922 This returns the kernel messages (C<dmesg> output) from
1923 the guest kernel. This is sometimes useful for extended
1924 debugging of problems.
1926 Another way to get the same information is to enable
1927 verbose messages with C<guestfs_set_verbose> or by setting
1928 the environment variable C<LIBGUESTFS_DEBUG=1> before
1929 running the program.");
1931 ("ping_daemon", (RErr, []), 92, [],
1932 [InitEmpty, Always, TestRun (
1933 [["ping_daemon"]])],
1934 "ping the guest daemon",
1936 This is a test probe into the guestfs daemon running inside
1937 the qemu subprocess. Calling this function checks that the
1938 daemon responds to the ping message, without affecting the daemon
1939 or attached block device(s) in any other way.");
1941 ("equal", (RBool "equality", [String "file1"; String "file2"]), 93, [],
1942 [InitBasicFS, Always, TestOutputTrue (
1943 [["write_file"; "/file1"; "contents of a file"; "0"];
1944 ["cp"; "/file1"; "/file2"];
1945 ["equal"; "/file1"; "/file2"]]);
1946 InitBasicFS, Always, TestOutputFalse (
1947 [["write_file"; "/file1"; "contents of a file"; "0"];
1948 ["write_file"; "/file2"; "contents of another file"; "0"];
1949 ["equal"; "/file1"; "/file2"]]);
1950 InitBasicFS, Always, TestLastFail (
1951 [["equal"; "/file1"; "/file2"]])],
1952 "test if two files have equal contents",
1954 This compares the two files C<file1> and C<file2> and returns
1955 true if their content is exactly equal, or false otherwise.
1957 The external L<cmp(1)> program is used for the comparison.");
1959 ("strings", (RStringList "stringsout", [String "path"]), 94, [ProtocolLimitWarning],
1960 [InitBasicFS, Always, TestOutputList (
1961 [["write_file"; "/new"; "hello\nworld\n"; "0"];
1962 ["strings"; "/new"]], ["hello"; "world"]);
1963 InitBasicFS, Always, TestOutputList (
1965 ["strings"; "/new"]], [])],
1966 "print the printable strings in a file",
1968 This runs the L<strings(1)> command on a file and returns
1969 the list of printable strings found.");
1971 ("strings_e", (RStringList "stringsout", [String "encoding"; String "path"]), 95, [ProtocolLimitWarning],
1972 [InitBasicFS, Always, TestOutputList (
1973 [["write_file"; "/new"; "hello\nworld\n"; "0"];
1974 ["strings_e"; "b"; "/new"]], []);
1975 InitBasicFS, Disabled, TestOutputList (
1976 [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
1977 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
1978 "print the printable strings in a file",
1980 This is like the C<guestfs_strings> command, but allows you to
1981 specify the encoding.
1983 See the L<strings(1)> manpage for the full list of encodings.
1985 Commonly useful encodings are C<l> (lower case L) which will
1986 show strings inside Windows/x86 files.
1988 The returned strings are transcoded to UTF-8.");
1990 ("hexdump", (RString "dump", [String "path"]), 96, [ProtocolLimitWarning],
1991 [InitBasicFS, Always, TestOutput (
1992 [["write_file"; "/new"; "hello\nworld\n"; "12"];
1993 ["hexdump"; "/new"]], "00000000 68 65 6c 6c 6f 0a 77 6f 72 6c 64 0a |hello.world.|\n0000000c\n")],
1994 "dump a file in hexadecimal",
1996 This runs C<hexdump -C> on the given C<path>. The result is
1997 the human-readable, canonical hex dump of the file.");
1999 ("zerofree", (RErr, [String "device"]), 97, [],
2000 [InitNone, Always, TestOutput (
2001 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
2002 ["mkfs"; "ext3"; "/dev/sda1"];
2003 ["mount"; "/dev/sda1"; "/"];
2004 ["write_file"; "/new"; "test file"; "0"];
2005 ["umount"; "/dev/sda1"];
2006 ["zerofree"; "/dev/sda1"];
2007 ["mount"; "/dev/sda1"; "/"];
2008 ["cat"; "/new"]], "test file")],
2009 "zero unused inodes and disk blocks on ext2/3 filesystem",
2011 This runs the I<zerofree> program on C<device>. This program
2012 claims to zero unused inodes and disk blocks on an ext2/3
2013 filesystem, thus making it possible to compress the filesystem
2016 You should B<not> run this program if the filesystem is
2019 It is possible that using this program can damage the filesystem
2020 or data on the filesystem.");
2024 let all_functions = non_daemon_functions @ daemon_functions
2026 (* In some places we want the functions to be displayed sorted
2027 * alphabetically, so this is useful:
2029 let all_functions_sorted =
2030 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
2031 compare n1 n2) all_functions
2033 (* Column names and types from LVM PVs/VGs/LVs. *)
2042 "pv_attr", `String (* XXX *);
2043 "pv_pe_count", `Int;
2044 "pv_pe_alloc_count", `Int;
2047 "pv_mda_count", `Int;
2048 "pv_mda_free", `Bytes;
2049 (* Not in Fedora 10:
2050 "pv_mda_size", `Bytes;
2057 "vg_attr", `String (* XXX *);
2060 "vg_sysid", `String;
2061 "vg_extent_size", `Bytes;
2062 "vg_extent_count", `Int;
2063 "vg_free_count", `Int;
2071 "vg_mda_count", `Int;
2072 "vg_mda_free", `Bytes;
2073 (* Not in Fedora 10:
2074 "vg_mda_size", `Bytes;
2080 "lv_attr", `String (* XXX *);
2083 "lv_kernel_major", `Int;
2084 "lv_kernel_minor", `Int;
2088 "snap_percent", `OptPercent;
2089 "copy_percent", `OptPercent;
2092 "mirror_log", `String;
2096 (* Column names and types from stat structures.
2097 * NB. Can't use things like 'st_atime' because glibc header files
2098 * define some of these as macros. Ugh.
2115 let statvfs_cols = [
2129 (* Useful functions.
2130 * Note we don't want to use any external OCaml libraries which
2131 * makes this a bit harder than it should be.
2133 let failwithf fs = ksprintf failwith fs
2135 let replace_char s c1 c2 =
2136 let s2 = String.copy s in
2137 let r = ref false in
2138 for i = 0 to String.length s2 - 1 do
2139 if String.unsafe_get s2 i = c1 then (
2140 String.unsafe_set s2 i c2;
2144 if not !r then s else s2
2148 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
2150 let triml ?(test = isspace) str =
2152 let n = ref (String.length str) in
2153 while !n > 0 && test str.[!i]; do
2158 else String.sub str !i !n
2160 let trimr ?(test = isspace) str =
2161 let n = ref (String.length str) in
2162 while !n > 0 && test str.[!n-1]; do
2165 if !n = String.length str then str
2166 else String.sub str 0 !n
2168 let trim ?(test = isspace) str =
2169 trimr ~test (triml ~test str)
2171 let rec find s sub =
2172 let len = String.length s in
2173 let sublen = String.length sub in
2175 if i <= len-sublen then (
2177 if j < sublen then (
2178 if s.[i+j] = sub.[j] then loop2 (j+1)
2184 if r = -1 then loop (i+1) else r
2190 let rec replace_str s s1 s2 =
2191 let len = String.length s in
2192 let sublen = String.length s1 in
2193 let i = find s s1 in
2196 let s' = String.sub s 0 i in
2197 let s'' = String.sub s (i+sublen) (len-i-sublen) in
2198 s' ^ s2 ^ replace_str s'' s1 s2
2201 let rec string_split sep str =
2202 let len = String.length str in
2203 let seplen = String.length sep in
2204 let i = find str sep in
2205 if i = -1 then [str]
2207 let s' = String.sub str 0 i in
2208 let s'' = String.sub str (i+seplen) (len-i-seplen) in
2209 s' :: string_split sep s''
2212 let files_equal n1 n2 =
2213 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
2214 match Sys.command cmd with
2217 | i -> failwithf "%s: failed with error code %d" cmd i
2219 let rec find_map f = function
2220 | [] -> raise Not_found
2224 | None -> find_map f xs
2227 let rec loop i = function
2229 | x :: xs -> f i x; loop (i+1) xs
2234 let rec loop i = function
2236 | x :: xs -> let r = f i x in r :: loop (i+1) xs
2240 let name_of_argt = function
2241 | String n | OptString n | StringList n | Bool n | Int n
2242 | FileIn n | FileOut n -> n
2244 let seq_of_test = function
2245 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
2246 | TestOutputInt (s, _) | TestOutputTrue s | TestOutputFalse s
2247 | TestOutputLength (s, _) | TestOutputStruct (s, _)
2248 | TestLastFail s -> s
2250 (* Check function names etc. for consistency. *)
2251 let check_functions () =
2252 let contains_uppercase str =
2253 let len = String.length str in
2255 if i >= len then false
2258 if c >= 'A' && c <= 'Z' then true
2265 (* Check function names. *)
2267 fun (name, _, _, _, _, _, _) ->
2268 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
2269 failwithf "function name %s does not need 'guestfs' prefix" name;
2270 if contains_uppercase name then
2271 failwithf "function name %s should not contain uppercase chars" name;
2272 if String.contains name '-' then
2273 failwithf "function name %s should not contain '-', use '_' instead."
2277 (* Check function parameter/return names. *)
2279 fun (name, style, _, _, _, _, _) ->
2280 let check_arg_ret_name n =
2281 if contains_uppercase n then
2282 failwithf "%s param/ret %s should not contain uppercase chars"
2284 if String.contains n '-' || String.contains n '_' then
2285 failwithf "%s param/ret %s should not contain '-' or '_'"
2288 failwithf "%s has a param/ret called 'value', which causes conflicts in the OCaml bindings, use something like 'val' or a more descriptive name" n;
2289 if n = "argv" || n = "args" then
2290 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" n
2293 (match fst style with
2295 | RInt n | RInt64 n | RBool n | RConstString n | RString n
2296 | RStringList n | RPVList n | RVGList n | RLVList n
2297 | RStat n | RStatVFS n
2299 check_arg_ret_name n
2301 check_arg_ret_name n;
2302 check_arg_ret_name m
2304 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
2307 (* Check short descriptions. *)
2309 fun (name, _, _, _, _, shortdesc, _) ->
2310 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
2311 failwithf "short description of %s should begin with lowercase." name;
2312 let c = shortdesc.[String.length shortdesc-1] in
2313 if c = '\n' || c = '.' then
2314 failwithf "short description of %s should not end with . or \\n." name
2317 (* Check long dscriptions. *)
2319 fun (name, _, _, _, _, _, longdesc) ->
2320 if longdesc.[String.length longdesc-1] = '\n' then
2321 failwithf "long description of %s should not end with \\n." name
2324 (* Check proc_nrs. *)
2326 fun (name, _, proc_nr, _, _, _, _) ->
2327 if proc_nr <= 0 then
2328 failwithf "daemon function %s should have proc_nr > 0" name
2332 fun (name, _, proc_nr, _, _, _, _) ->
2333 if proc_nr <> -1 then
2334 failwithf "non-daemon function %s should have proc_nr -1" name
2335 ) non_daemon_functions;
2338 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
2341 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
2342 let rec loop = function
2345 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
2347 | (name1,nr1) :: (name2,nr2) :: _ ->
2348 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
2356 (* Ignore functions that have no tests. We generate a
2357 * warning when the user does 'make check' instead.
2359 | name, _, _, _, [], _, _ -> ()
2360 | name, _, _, _, tests, _, _ ->
2364 match seq_of_test test with
2366 failwithf "%s has a test containing an empty sequence" name
2367 | cmds -> List.map List.hd cmds
2369 let funcs = List.flatten funcs in
2371 let tested = List.mem name funcs in
2374 failwithf "function %s has tests but does not test itself" name
2377 (* 'pr' prints to the current output file. *)
2378 let chan = ref stdout
2379 let pr fs = ksprintf (output_string !chan) fs
2381 (* Generate a header block in a number of standard styles. *)
2382 type comment_style = CStyle | HashStyle | OCamlStyle | HaskellStyle
2383 type license = GPLv2 | LGPLv2
2385 let generate_header comment license =
2386 let c = match comment with
2387 | CStyle -> pr "/* "; " *"
2388 | HashStyle -> pr "# "; "#"
2389 | OCamlStyle -> pr "(* "; " *"
2390 | HaskellStyle -> pr "{- "; " " in
2391 pr "libguestfs generated file\n";
2392 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
2393 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
2395 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
2399 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
2400 pr "%s it under the terms of the GNU General Public License as published by\n" c;
2401 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
2402 pr "%s (at your option) any later version.\n" c;
2404 pr "%s This program is distributed in the hope that it will be useful,\n" c;
2405 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2406 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
2407 pr "%s GNU General Public License for more details.\n" c;
2409 pr "%s You should have received a copy of the GNU General Public License along\n" c;
2410 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
2411 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
2414 pr "%s This library is free software; you can redistribute it and/or\n" c;
2415 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
2416 pr "%s License as published by the Free Software Foundation; either\n" c;
2417 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
2419 pr "%s This library is distributed in the hope that it will be useful,\n" c;
2420 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2421 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
2422 pr "%s Lesser General Public License for more details.\n" c;
2424 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
2425 pr "%s License along with this library; if not, write to the Free Software\n" c;
2426 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
2429 | CStyle -> pr " */\n"
2431 | OCamlStyle -> pr " *)\n"
2432 | HaskellStyle -> pr "-}\n"
2436 (* Start of main code generation functions below this line. *)
2438 (* Generate the pod documentation for the C API. *)
2439 let rec generate_actions_pod () =
2441 fun (shortname, style, _, flags, _, _, longdesc) ->
2442 let name = "guestfs_" ^ shortname in
2443 pr "=head2 %s\n\n" name;
2445 generate_prototype ~extern:false ~handle:"handle" name style;
2447 pr "%s\n\n" longdesc;
2448 (match fst style with
2450 pr "This function returns 0 on success or -1 on error.\n\n"
2452 pr "On error this function returns -1.\n\n"
2454 pr "On error this function returns -1.\n\n"
2456 pr "This function returns a C truth value on success or -1 on error.\n\n"
2458 pr "This function returns a string, or NULL on error.
2459 The string is owned by the guest handle and must I<not> be freed.\n\n"
2461 pr "This function returns a string, or NULL on error.
2462 I<The caller must free the returned string after use>.\n\n"
2464 pr "This function returns a NULL-terminated array of strings
2465 (like L<environ(3)>), or NULL if there was an error.
2466 I<The caller must free the strings and the array after use>.\n\n"
2468 pr "This function returns a C<struct guestfs_int_bool *>,
2469 or NULL if there was an error.
2470 I<The caller must call C<guestfs_free_int_bool> after use>.\n\n"
2472 pr "This function returns a C<struct guestfs_lvm_pv_list *>
2473 (see E<lt>guestfs-structs.hE<gt>),
2474 or NULL if there was an error.
2475 I<The caller must call C<guestfs_free_lvm_pv_list> after use>.\n\n"
2477 pr "This function returns a C<struct guestfs_lvm_vg_list *>
2478 (see E<lt>guestfs-structs.hE<gt>),
2479 or NULL if there was an error.
2480 I<The caller must call C<guestfs_free_lvm_vg_list> after use>.\n\n"
2482 pr "This function returns a C<struct guestfs_lvm_lv_list *>
2483 (see E<lt>guestfs-structs.hE<gt>),
2484 or NULL if there was an error.
2485 I<The caller must call C<guestfs_free_lvm_lv_list> after use>.\n\n"
2487 pr "This function returns a C<struct guestfs_stat *>
2488 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
2489 or NULL if there was an error.
2490 I<The caller must call C<free> after use>.\n\n"
2492 pr "This function returns a C<struct guestfs_statvfs *>
2493 (see L<statvfs(2)> and E<lt>guestfs-structs.hE<gt>),
2494 or NULL if there was an error.
2495 I<The caller must call C<free> after use>.\n\n"
2497 pr "This function returns a NULL-terminated array of
2498 strings, or NULL if there was an error.
2499 The array of strings will always have length C<2n+1>, where
2500 C<n> keys and values alternate, followed by the trailing NULL entry.
2501 I<The caller must free the strings and the array after use>.\n\n"
2503 if List.mem ProtocolLimitWarning flags then
2504 pr "%s\n\n" protocol_limit_warning;
2505 if List.mem DangerWillRobinson flags then
2506 pr "%s\n\n" danger_will_robinson;
2507 ) all_functions_sorted
2509 and generate_structs_pod () =
2510 (* LVM structs documentation. *)
2513 pr "=head2 guestfs_lvm_%s\n" typ;
2515 pr " struct guestfs_lvm_%s {\n" typ;
2518 | name, `String -> pr " char *%s;\n" name
2520 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
2521 pr " char %s[32];\n" name
2522 | name, `Bytes -> pr " uint64_t %s;\n" name
2523 | name, `Int -> pr " int64_t %s;\n" name
2524 | name, `OptPercent ->
2525 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
2526 pr " float %s;\n" name
2529 pr " struct guestfs_lvm_%s_list {\n" typ;
2530 pr " uint32_t len; /* Number of elements in list. */\n";
2531 pr " struct guestfs_lvm_%s *val; /* Elements. */\n" typ;
2534 pr " void guestfs_free_lvm_%s_list (struct guestfs_free_lvm_%s_list *);\n"
2537 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
2539 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
2540 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
2542 * We have to use an underscore instead of a dash because otherwise
2543 * rpcgen generates incorrect code.
2545 * This header is NOT exported to clients, but see also generate_structs_h.
2547 and generate_xdr () =
2548 generate_header CStyle LGPLv2;
2550 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
2551 pr "typedef string str<>;\n";
2554 (* LVM internal structures. *)
2558 pr "struct guestfs_lvm_int_%s {\n" typ;
2560 | name, `String -> pr " string %s<>;\n" name
2561 | name, `UUID -> pr " opaque %s[32];\n" name
2562 | name, `Bytes -> pr " hyper %s;\n" name
2563 | name, `Int -> pr " hyper %s;\n" name
2564 | name, `OptPercent -> pr " float %s;\n" name
2568 pr "typedef struct guestfs_lvm_int_%s guestfs_lvm_int_%s_list<>;\n" typ typ;
2570 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2572 (* Stat internal structures. *)
2576 pr "struct guestfs_int_%s {\n" typ;
2578 | name, `Int -> pr " hyper %s;\n" name
2582 ) ["stat", stat_cols; "statvfs", statvfs_cols];
2585 fun (shortname, style, _, _, _, _, _) ->
2586 let name = "guestfs_" ^ shortname in
2588 (match snd style with
2591 pr "struct %s_args {\n" name;
2594 | String n -> pr " string %s<>;\n" n
2595 | OptString n -> pr " str *%s;\n" n
2596 | StringList n -> pr " str %s<>;\n" n
2597 | Bool n -> pr " bool %s;\n" n
2598 | Int n -> pr " int %s;\n" n
2599 | FileIn _ | FileOut _ -> ()
2603 (match fst style with
2606 pr "struct %s_ret {\n" name;
2610 pr "struct %s_ret {\n" name;
2611 pr " hyper %s;\n" n;
2614 pr "struct %s_ret {\n" name;
2618 failwithf "RConstString cannot be returned from a daemon function"
2620 pr "struct %s_ret {\n" name;
2621 pr " string %s<>;\n" n;
2624 pr "struct %s_ret {\n" name;
2625 pr " str %s<>;\n" n;
2628 pr "struct %s_ret {\n" name;
2633 pr "struct %s_ret {\n" name;
2634 pr " guestfs_lvm_int_pv_list %s;\n" n;
2637 pr "struct %s_ret {\n" name;
2638 pr " guestfs_lvm_int_vg_list %s;\n" n;
2641 pr "struct %s_ret {\n" name;
2642 pr " guestfs_lvm_int_lv_list %s;\n" n;
2645 pr "struct %s_ret {\n" name;
2646 pr " guestfs_int_stat %s;\n" n;
2649 pr "struct %s_ret {\n" name;
2650 pr " guestfs_int_statvfs %s;\n" n;
2653 pr "struct %s_ret {\n" name;
2654 pr " str %s<>;\n" n;
2659 (* Table of procedure numbers. *)
2660 pr "enum guestfs_procedure {\n";
2662 fun (shortname, _, proc_nr, _, _, _, _) ->
2663 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
2665 pr " GUESTFS_PROC_NR_PROCS\n";
2669 (* Having to choose a maximum message size is annoying for several
2670 * reasons (it limits what we can do in the API), but it (a) makes
2671 * the protocol a lot simpler, and (b) provides a bound on the size
2672 * of the daemon which operates in limited memory space. For large
2673 * file transfers you should use FTP.
2675 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
2678 (* Message header, etc. *)
2680 /* The communication protocol is now documented in the guestfs(3)
2684 const GUESTFS_PROGRAM = 0x2000F5F5;
2685 const GUESTFS_PROTOCOL_VERSION = 1;
2687 /* These constants must be larger than any possible message length. */
2688 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
2689 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
2691 enum guestfs_message_direction {
2692 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
2693 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
2696 enum guestfs_message_status {
2697 GUESTFS_STATUS_OK = 0,
2698 GUESTFS_STATUS_ERROR = 1
2701 const GUESTFS_ERROR_LEN = 256;
2703 struct guestfs_message_error {
2704 string error_message<GUESTFS_ERROR_LEN>;
2707 struct guestfs_message_header {
2708 unsigned prog; /* GUESTFS_PROGRAM */
2709 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
2710 guestfs_procedure proc; /* GUESTFS_PROC_x */
2711 guestfs_message_direction direction;
2712 unsigned serial; /* message serial number */
2713 guestfs_message_status status;
2716 const GUESTFS_MAX_CHUNK_SIZE = 8192;
2718 struct guestfs_chunk {
2719 int cancel; /* if non-zero, transfer is cancelled */
2720 /* data size is 0 bytes if the transfer has finished successfully */
2721 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
2725 (* Generate the guestfs-structs.h file. *)
2726 and generate_structs_h () =
2727 generate_header CStyle LGPLv2;
2729 (* This is a public exported header file containing various
2730 * structures. The structures are carefully written to have
2731 * exactly the same in-memory format as the XDR structures that
2732 * we use on the wire to the daemon. The reason for creating
2733 * copies of these structures here is just so we don't have to
2734 * export the whole of guestfs_protocol.h (which includes much
2735 * unrelated and XDR-dependent stuff that we don't want to be
2736 * public, or required by clients).
2738 * To reiterate, we will pass these structures to and from the
2739 * client with a simple assignment or memcpy, so the format
2740 * must be identical to what rpcgen / the RFC defines.
2743 (* guestfs_int_bool structure. *)
2744 pr "struct guestfs_int_bool {\n";
2750 (* LVM public structures. *)
2754 pr "struct guestfs_lvm_%s {\n" typ;
2757 | name, `String -> pr " char *%s;\n" name
2758 | name, `UUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
2759 | name, `Bytes -> pr " uint64_t %s;\n" name
2760 | name, `Int -> pr " int64_t %s;\n" name
2761 | name, `OptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
2765 pr "struct guestfs_lvm_%s_list {\n" typ;
2766 pr " uint32_t len;\n";
2767 pr " struct guestfs_lvm_%s *val;\n" typ;
2770 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2772 (* Stat structures. *)
2776 pr "struct guestfs_%s {\n" typ;
2779 | name, `Int -> pr " int64_t %s;\n" name
2783 ) ["stat", stat_cols; "statvfs", statvfs_cols]
2785 (* Generate the guestfs-actions.h file. *)
2786 and generate_actions_h () =
2787 generate_header CStyle LGPLv2;
2789 fun (shortname, style, _, _, _, _, _) ->
2790 let name = "guestfs_" ^ shortname in
2791 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
2795 (* Generate the client-side dispatch stubs. *)
2796 and generate_client_actions () =
2797 generate_header CStyle LGPLv2;
2803 #include \"guestfs.h\"
2804 #include \"guestfs_protocol.h\"
2806 #define error guestfs_error
2807 #define perrorf guestfs_perrorf
2808 #define safe_malloc guestfs_safe_malloc
2809 #define safe_realloc guestfs_safe_realloc
2810 #define safe_strdup guestfs_safe_strdup
2811 #define safe_memdup guestfs_safe_memdup
2813 /* Check the return message from a call for validity. */
2815 check_reply_header (guestfs_h *g,
2816 const struct guestfs_message_header *hdr,
2817 int proc_nr, int serial)
2819 if (hdr->prog != GUESTFS_PROGRAM) {
2820 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
2823 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
2824 error (g, \"wrong protocol version (%%d/%%d)\",
2825 hdr->vers, GUESTFS_PROTOCOL_VERSION);
2828 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
2829 error (g, \"unexpected message direction (%%d/%%d)\",
2830 hdr->direction, GUESTFS_DIRECTION_REPLY);
2833 if (hdr->proc != proc_nr) {
2834 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
2837 if (hdr->serial != serial) {
2838 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
2845 /* Check we are in the right state to run a high-level action. */
2847 check_state (guestfs_h *g, const char *caller)
2849 if (!guestfs_is_ready (g)) {
2850 if (guestfs_is_config (g))
2851 error (g, \"%%s: call launch() before using this function\",
2853 else if (guestfs_is_launching (g))
2854 error (g, \"%%s: call wait_ready() before using this function\",
2857 error (g, \"%%s called from the wrong state, %%d != READY\",
2858 caller, guestfs_get_state (g));
2866 (* Client-side stubs for each function. *)
2868 fun (shortname, style, _, _, _, _, _) ->
2869 let name = "guestfs_" ^ shortname in
2871 (* Generate the context struct which stores the high-level
2872 * state between callback functions.
2874 pr "struct %s_ctx {\n" shortname;
2875 pr " /* This flag is set by the callbacks, so we know we've done\n";
2876 pr " * the callbacks as expected, and in the right sequence.\n";
2877 pr " * 0 = not called, 1 = reply_cb called.\n";
2879 pr " int cb_sequence;\n";
2880 pr " struct guestfs_message_header hdr;\n";
2881 pr " struct guestfs_message_error err;\n";
2882 (match fst style with
2885 failwithf "RConstString cannot be returned from a daemon function"
2887 | RBool _ | RString _ | RStringList _
2889 | RPVList _ | RVGList _ | RLVList _
2890 | RStat _ | RStatVFS _
2892 pr " struct %s_ret ret;\n" name
2897 (* Generate the reply callback function. *)
2898 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
2900 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
2901 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
2903 pr " /* This should definitely not happen. */\n";
2904 pr " if (ctx->cb_sequence != 0) {\n";
2905 pr " ctx->cb_sequence = 9999;\n";
2906 pr " error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
2910 pr " ml->main_loop_quit (ml, g);\n";
2912 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
2913 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
2916 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
2917 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
2918 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
2925 (match fst style with
2928 failwithf "RConstString cannot be returned from a daemon function"
2930 | RBool _ | RString _ | RStringList _
2932 | RPVList _ | RVGList _ | RLVList _
2933 | RStat _ | RStatVFS _
2935 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
2936 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
2942 pr " ctx->cb_sequence = 1;\n";
2945 (* Generate the action stub. *)
2946 generate_prototype ~extern:false ~semicolon:false ~newline:true
2947 ~handle:"g" name style;
2950 match fst style with
2951 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
2953 failwithf "RConstString cannot be returned from a daemon function"
2954 | RString _ | RStringList _ | RIntBool _
2955 | RPVList _ | RVGList _ | RLVList _
2956 | RStat _ | RStatVFS _
2962 (match snd style with
2964 | _ -> pr " struct %s_args args;\n" name
2967 pr " struct %s_ctx ctx;\n" shortname;
2968 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
2969 pr " int serial;\n";
2971 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
2972 pr " guestfs_set_busy (g);\n";
2974 pr " memset (&ctx, 0, sizeof ctx);\n";
2977 (* Send the main header and arguments. *)
2978 (match snd style with
2980 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
2981 (String.uppercase shortname)
2986 pr " args.%s = (char *) %s;\n" n n
2988 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
2990 pr " args.%s.%s_val = (char **) %s;\n" n n n;
2991 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
2993 pr " args.%s = %s;\n" n n
2995 pr " args.%s = %s;\n" n n
2996 | FileIn _ | FileOut _ -> ()
2998 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
2999 (String.uppercase shortname);
3000 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
3003 pr " if (serial == -1) {\n";
3004 pr " guestfs_end_busy (g);\n";
3005 pr " return %s;\n" error_code;
3009 (* Send any additional files (FileIn) requested. *)
3010 let need_read_reply_label = ref false in
3017 pr " r = guestfs__send_file_sync (g, %s);\n" n;
3018 pr " if (r == -1) {\n";
3019 pr " guestfs_end_busy (g);\n";
3020 pr " return %s;\n" error_code;
3022 pr " if (r == -2) /* daemon cancelled */\n";
3023 pr " goto read_reply;\n";
3024 need_read_reply_label := true;
3030 (* Wait for the reply from the remote end. *)
3031 if !need_read_reply_label then pr " read_reply:\n";
3032 pr " guestfs__switch_to_receiving (g);\n";
3033 pr " ctx.cb_sequence = 0;\n";
3034 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
3035 pr " (void) ml->main_loop_run (ml, g);\n";
3036 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
3037 pr " if (ctx.cb_sequence != 1) {\n";
3038 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
3039 pr " guestfs_end_busy (g);\n";
3040 pr " return %s;\n" error_code;
3044 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
3045 (String.uppercase shortname);
3046 pr " guestfs_end_busy (g);\n";
3047 pr " return %s;\n" error_code;
3051 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
3052 pr " error (g, \"%%s\", ctx.err.error_message);\n";
3053 pr " free (ctx.err.error_message);\n";
3054 pr " guestfs_end_busy (g);\n";
3055 pr " return %s;\n" error_code;
3059 (* Expecting to receive further files (FileOut)? *)
3063 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
3064 pr " guestfs_end_busy (g);\n";
3065 pr " return %s;\n" error_code;
3071 pr " guestfs_end_busy (g);\n";
3073 (match fst style with
3074 | RErr -> pr " return 0;\n"
3075 | RInt n | RInt64 n | RBool n ->
3076 pr " return ctx.ret.%s;\n" n
3078 failwithf "RConstString cannot be returned from a daemon function"
3080 pr " return ctx.ret.%s; /* caller will free */\n" n
3081 | RStringList n | RHashtable n ->
3082 pr " /* caller will free this, but we need to add a NULL entry */\n";
3083 pr " ctx.ret.%s.%s_val =\n" n n;
3084 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
3085 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
3087 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
3088 pr " return ctx.ret.%s.%s_val;\n" n n
3090 pr " /* caller with free this */\n";
3091 pr " return safe_memdup (g, &ctx.ret, sizeof (ctx.ret));\n"
3092 | RPVList n | RVGList n | RLVList n
3093 | RStat n | RStatVFS n ->
3094 pr " /* caller will free this */\n";
3095 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
3101 (* Generate daemon/actions.h. *)
3102 and generate_daemon_actions_h () =
3103 generate_header CStyle GPLv2;
3105 pr "#include \"../src/guestfs_protocol.h\"\n";
3109 fun (name, style, _, _, _, _, _) ->
3111 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
3115 (* Generate the server-side stubs. *)
3116 and generate_daemon_actions () =
3117 generate_header CStyle GPLv2;
3119 pr "#include <config.h>\n";
3121 pr "#include <stdio.h>\n";
3122 pr "#include <stdlib.h>\n";
3123 pr "#include <string.h>\n";
3124 pr "#include <inttypes.h>\n";
3125 pr "#include <ctype.h>\n";
3126 pr "#include <rpc/types.h>\n";
3127 pr "#include <rpc/xdr.h>\n";
3129 pr "#include \"daemon.h\"\n";
3130 pr "#include \"../src/guestfs_protocol.h\"\n";
3131 pr "#include \"actions.h\"\n";
3135 fun (name, style, _, _, _, _, _) ->
3136 (* Generate server-side stubs. *)
3137 pr "static void %s_stub (XDR *xdr_in)\n" name;
3140 match fst style with
3141 | RErr | RInt _ -> pr " int r;\n"; "-1"
3142 | RInt64 _ -> pr " int64_t r;\n"; "-1"
3143 | RBool _ -> pr " int r;\n"; "-1"
3145 failwithf "RConstString cannot be returned from a daemon function"
3146 | RString _ -> pr " char *r;\n"; "NULL"
3147 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
3148 | RIntBool _ -> pr " guestfs_%s_ret *r;\n" name; "NULL"
3149 | RPVList _ -> pr " guestfs_lvm_int_pv_list *r;\n"; "NULL"
3150 | RVGList _ -> pr " guestfs_lvm_int_vg_list *r;\n"; "NULL"
3151 | RLVList _ -> pr " guestfs_lvm_int_lv_list *r;\n"; "NULL"
3152 | RStat _ -> pr " guestfs_int_stat *r;\n"; "NULL"
3153 | RStatVFS _ -> pr " guestfs_int_statvfs *r;\n"; "NULL" in
3155 (match snd style with
3158 pr " struct guestfs_%s_args args;\n" name;
3162 | OptString n -> pr " const char *%s;\n" n
3163 | StringList n -> pr " char **%s;\n" n
3164 | Bool n -> pr " int %s;\n" n
3165 | Int n -> pr " int %s;\n" n
3166 | FileIn _ | FileOut _ -> ()
3171 (match snd style with
3174 pr " memset (&args, 0, sizeof args);\n";
3176 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
3177 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
3182 | String n -> pr " %s = args.%s;\n" n n
3183 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
3185 pr " %s = realloc (args.%s.%s_val,\n" n n n;
3186 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
3187 pr " if (%s == NULL) {\n" n;
3188 pr " reply_with_perror (\"realloc\");\n";
3191 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
3192 pr " args.%s.%s_val = %s;\n" n n n;
3193 | Bool n -> pr " %s = args.%s;\n" n n
3194 | Int n -> pr " %s = args.%s;\n" n n
3195 | FileIn _ | FileOut _ -> ()
3200 (* Don't want to call the impl with any FileIn or FileOut
3201 * parameters, since these go "outside" the RPC protocol.
3204 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
3206 pr " r = do_%s " name;
3207 generate_call_args argsnofile;
3210 pr " if (r == %s)\n" error_code;
3211 pr " /* do_%s has already called reply_with_error */\n" name;
3215 (* If there are any FileOut parameters, then the impl must
3216 * send its own reply.
3219 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
3221 pr " /* do_%s has already sent a reply */\n" name
3223 match fst style with
3224 | RErr -> pr " reply (NULL, NULL);\n"
3225 | RInt n | RInt64 n | RBool n ->
3226 pr " struct guestfs_%s_ret ret;\n" name;
3227 pr " ret.%s = r;\n" n;
3228 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3231 failwithf "RConstString cannot be returned from a daemon function"
3233 pr " struct guestfs_%s_ret ret;\n" name;
3234 pr " ret.%s = r;\n" n;
3235 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3238 | RStringList n | RHashtable n ->
3239 pr " struct guestfs_%s_ret ret;\n" name;
3240 pr " ret.%s.%s_len = count_strings (r);\n" n n;
3241 pr " ret.%s.%s_val = r;\n" n n;
3242 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3244 pr " free_strings (r);\n"
3246 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n"
3248 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n" name
3249 | RPVList n | RVGList n | RLVList n
3250 | RStat n | RStatVFS n ->
3251 pr " struct guestfs_%s_ret ret;\n" name;
3252 pr " ret.%s = *r;\n" n;
3253 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
3255 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
3259 (* Free the args. *)
3260 (match snd style with
3265 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
3272 (* Dispatch function. *)
3273 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
3275 pr " switch (proc_nr) {\n";
3278 fun (name, style, _, _, _, _, _) ->
3279 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
3280 pr " %s_stub (xdr_in);\n" name;
3285 pr " reply_with_error (\"dispatch_incoming_message: unknown procedure number %%d\", proc_nr);\n";
3290 (* LVM columns and tokenization functions. *)
3291 (* XXX This generates crap code. We should rethink how we
3297 pr "static const char *lvm_%s_cols = \"%s\";\n"
3298 typ (String.concat "," (List.map fst cols));
3301 pr "static int lvm_tokenize_%s (char *str, struct guestfs_lvm_int_%s *r)\n" typ typ;
3303 pr " char *tok, *p, *next;\n";
3307 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
3310 pr " if (!str) {\n";
3311 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
3314 pr " if (!*str || isspace (*str)) {\n";
3315 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
3320 fun (name, coltype) ->
3321 pr " if (!tok) {\n";
3322 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
3325 pr " p = strchrnul (tok, ',');\n";
3326 pr " if (*p) next = p+1; else next = NULL;\n";
3327 pr " *p = '\\0';\n";
3330 pr " r->%s = strdup (tok);\n" name;
3331 pr " if (r->%s == NULL) {\n" name;
3332 pr " perror (\"strdup\");\n";
3336 pr " for (i = j = 0; i < 32; ++j) {\n";
3337 pr " if (tok[j] == '\\0') {\n";
3338 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
3340 pr " } else if (tok[j] != '-')\n";
3341 pr " r->%s[i++] = tok[j];\n" name;
3344 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
3345 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3349 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
3350 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3354 pr " if (tok[0] == '\\0')\n";
3355 pr " r->%s = -1;\n" name;
3356 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
3357 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3361 pr " tok = next;\n";
3364 pr " if (tok != NULL) {\n";
3365 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
3372 pr "guestfs_lvm_int_%s_list *\n" typ;
3373 pr "parse_command_line_%ss (void)\n" typ;
3375 pr " char *out, *err;\n";
3376 pr " char *p, *pend;\n";
3378 pr " guestfs_lvm_int_%s_list *ret;\n" typ;
3379 pr " void *newp;\n";
3381 pr " ret = malloc (sizeof *ret);\n";
3382 pr " if (!ret) {\n";
3383 pr " reply_with_perror (\"malloc\");\n";
3384 pr " return NULL;\n";
3387 pr " ret->guestfs_lvm_int_%s_list_len = 0;\n" typ;
3388 pr " ret->guestfs_lvm_int_%s_list_val = NULL;\n" typ;
3390 pr " r = command (&out, &err,\n";
3391 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
3392 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
3393 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
3394 pr " if (r == -1) {\n";
3395 pr " reply_with_error (\"%%s\", err);\n";
3396 pr " free (out);\n";
3397 pr " free (err);\n";
3398 pr " free (ret);\n";
3399 pr " return NULL;\n";
3402 pr " free (err);\n";
3404 pr " /* Tokenize each line of the output. */\n";
3407 pr " while (p) {\n";
3408 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
3409 pr " if (pend) {\n";
3410 pr " *pend = '\\0';\n";
3414 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
3417 pr " if (!*p) { /* Empty line? Skip it. */\n";
3422 pr " /* Allocate some space to store this next entry. */\n";
3423 pr " newp = realloc (ret->guestfs_lvm_int_%s_list_val,\n" typ;
3424 pr " sizeof (guestfs_lvm_int_%s) * (i+1));\n" typ;
3425 pr " if (newp == NULL) {\n";
3426 pr " reply_with_perror (\"realloc\");\n";
3427 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3428 pr " free (ret);\n";
3429 pr " free (out);\n";
3430 pr " return NULL;\n";
3432 pr " ret->guestfs_lvm_int_%s_list_val = newp;\n" typ;
3434 pr " /* Tokenize the next entry. */\n";
3435 pr " r = lvm_tokenize_%s (p, &ret->guestfs_lvm_int_%s_list_val[i]);\n" typ typ;
3436 pr " if (r == -1) {\n";
3437 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
3438 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3439 pr " free (ret);\n";
3440 pr " free (out);\n";
3441 pr " return NULL;\n";
3448 pr " ret->guestfs_lvm_int_%s_list_len = i;\n" typ;
3450 pr " free (out);\n";
3451 pr " return ret;\n";
3454 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
3456 (* Generate the tests. *)
3457 and generate_tests () =
3458 generate_header CStyle GPLv2;
3465 #include <sys/types.h>
3468 #include \"guestfs.h\"
3470 static guestfs_h *g;
3471 static int suppress_error = 0;
3473 /* This will be 's' or 'h' depending on whether the guest kernel
3474 * names IDE devices /dev/sd* or /dev/hd*.
3476 static char devchar = 's';
3478 static void print_error (guestfs_h *g, void *data, const char *msg)
3480 if (!suppress_error)
3481 fprintf (stderr, \"%%s\\n\", msg);
3484 static void print_strings (char * const * const argv)
3488 for (argc = 0; argv[argc] != NULL; ++argc)
3489 printf (\"\\t%%s\\n\", argv[argc]);
3493 static void print_table (char * const * const argv)
3497 for (i = 0; argv[i] != NULL; i += 2)
3498 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
3502 static void no_test_warnings (void)
3508 | name, _, _, _, [], _, _ ->
3509 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
3510 | name, _, _, _, tests, _, _ -> ()
3516 (* Generate the actual tests. Note that we generate the tests
3517 * in reverse order, deliberately, so that (in general) the
3518 * newest tests run first. This makes it quicker and easier to
3523 fun (name, _, _, _, tests, _, _) ->
3524 mapi (generate_one_test name) tests
3525 ) (List.rev all_functions) in
3526 let test_names = List.concat test_names in
3527 let nr_tests = List.length test_names in
3530 int main (int argc, char *argv[])
3535 const char *filename;
3537 int nr_tests, test_num = 0;
3540 no_test_warnings ();
3542 g = guestfs_create ();
3544 printf (\"guestfs_create FAILED\\n\");
3548 guestfs_set_error_handler (g, print_error, NULL);
3550 srcdir = getenv (\"srcdir\");
3551 if (!srcdir) srcdir = \".\";
3553 guestfs_set_path (g, \".\");
3555 filename = \"test1.img\";
3556 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3561 if (lseek (fd, %d, SEEK_SET) == -1) {
3567 if (write (fd, &c, 1) == -1) {
3573 if (close (fd) == -1) {
3578 if (guestfs_add_drive (g, filename) == -1) {
3579 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3583 filename = \"test2.img\";
3584 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3589 if (lseek (fd, %d, SEEK_SET) == -1) {
3595 if (write (fd, &c, 1) == -1) {
3601 if (close (fd) == -1) {
3606 if (guestfs_add_drive (g, filename) == -1) {
3607 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3611 filename = \"test3.img\";
3612 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3617 if (lseek (fd, %d, SEEK_SET) == -1) {
3623 if (write (fd, &c, 1) == -1) {
3629 if (close (fd) == -1) {
3634 if (guestfs_add_drive (g, filename) == -1) {
3635 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3639 if (guestfs_launch (g) == -1) {
3640 printf (\"guestfs_launch FAILED\\n\");
3643 if (guestfs_wait_ready (g) == -1) {
3644 printf (\"guestfs_wait_ready FAILED\\n\");
3648 /* Detect if the appliance uses /dev/sd* or /dev/hd* in device
3649 * names. This changed between RHEL 5 and RHEL 6 so we have to
3652 devs = guestfs_list_devices (g);
3653 if (devs == NULL || devs[0] == NULL) {
3654 printf (\"guestfs_list_devices FAILED\\n\");
3657 if (strncmp (devs[0], \"/dev/sd\", 7) == 0)
3659 else if (strncmp (devs[0], \"/dev/hd\", 7) == 0)
3662 printf (\"guestfs_list_devices returned unexpected string '%%s'\\n\",
3666 for (i = 0; devs[i] != NULL; ++i)
3672 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
3676 pr " test_num++;\n";
3677 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
3678 pr " if (%s () == -1) {\n" test_name;
3679 pr " printf (\"%s FAILED\\n\");\n" test_name;
3685 pr " guestfs_close (g);\n";
3686 pr " unlink (\"test1.img\");\n";
3687 pr " unlink (\"test2.img\");\n";
3688 pr " unlink (\"test3.img\");\n";
3691 pr " if (failed > 0) {\n";
3692 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
3700 and generate_one_test name i (init, prereq, test) =
3701 let test_name = sprintf "test_%s_%d" name i in
3704 | Disabled | Always -> ()
3705 | If code | Unless code ->
3706 pr "static int %s_prereq (void)\n" test_name;
3713 pr "static int %s (void)\n" test_name;
3718 pr " printf (\"%%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
3720 pr " if (%s_prereq ()) {\n" test_name;
3721 generate_one_test_body name i test_name init test;
3723 pr " printf (\"%%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name
3725 pr " if (! %s_prereq ()) {\n" test_name;
3726 generate_one_test_body name i test_name init test;
3728 pr " printf (\"%%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name
3730 generate_one_test_body name i test_name init test
3738 and generate_one_test_body name i test_name init test =
3742 pr " /* InitEmpty for %s (%d) */\n" name i;
3743 List.iter (generate_test_command_call test_name)
3744 [["blockdev_setrw"; "/dev/sda"];
3748 pr " /* InitBasicFS for %s (%d): create ext2 on /dev/sda1 */\n" name i;
3749 List.iter (generate_test_command_call test_name)
3750 [["blockdev_setrw"; "/dev/sda"];
3753 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
3754 ["mkfs"; "ext2"; "/dev/sda1"];
3755 ["mount"; "/dev/sda1"; "/"]]
3756 | InitBasicFSonLVM ->
3757 pr " /* InitBasicFSonLVM for %s (%d): create ext2 on /dev/VG/LV */\n"
3759 List.iter (generate_test_command_call test_name)
3760 [["blockdev_setrw"; "/dev/sda"];
3763 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
3764 ["pvcreate"; "/dev/sda1"];
3765 ["vgcreate"; "VG"; "/dev/sda1"];
3766 ["lvcreate"; "LV"; "VG"; "8"];
3767 ["mkfs"; "ext2"; "/dev/VG/LV"];
3768 ["mount"; "/dev/VG/LV"; "/"]]
3771 let get_seq_last = function
3773 failwithf "%s: you cannot use [] (empty list) when expecting a command"
3776 let seq = List.rev seq in
3777 List.rev (List.tl seq), List.hd seq
3782 pr " /* TestRun for %s (%d) */\n" name i;
3783 List.iter (generate_test_command_call test_name) seq
3784 | TestOutput (seq, expected) ->
3785 pr " /* TestOutput for %s (%d) */\n" name i;
3786 pr " char expected[] = \"%s\";\n" (c_quote expected);
3787 if String.length expected > 7 &&
3788 String.sub expected 0 7 = "/dev/sd" then
3789 pr " expected[5] = devchar;\n";
3790 let seq, last = get_seq_last seq in
3792 pr " if (strcmp (r, expected) != 0) {\n";
3793 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
3797 List.iter (generate_test_command_call test_name) seq;
3798 generate_test_command_call ~test test_name last
3799 | TestOutputList (seq, expected) ->
3800 pr " /* TestOutputList for %s (%d) */\n" name i;
3801 let seq, last = get_seq_last seq in
3805 pr " if (!r[%d]) {\n" i;
3806 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
3807 pr " print_strings (r);\n";
3811 pr " char expected[] = \"%s\";\n" (c_quote str);
3812 if String.length str > 7 && String.sub str 0 7 = "/dev/sd" then
3813 pr " expected[5] = devchar;\n";
3814 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
3815 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
3820 pr " if (r[%d] != NULL) {\n" (List.length expected);
3821 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
3823 pr " print_strings (r);\n";
3827 List.iter (generate_test_command_call test_name) seq;
3828 generate_test_command_call ~test test_name last
3829 | TestOutputInt (seq, expected) ->
3830 pr " /* TestOutputInt for %s (%d) */\n" name i;
3831 let seq, last = get_seq_last seq in
3833 pr " if (r != %d) {\n" expected;
3834 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
3840 List.iter (generate_test_command_call test_name) seq;
3841 generate_test_command_call ~test test_name last
3842 | TestOutputTrue seq ->
3843 pr " /* TestOutputTrue for %s (%d) */\n" name i;
3844 let seq, last = get_seq_last seq in
3847 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
3852 List.iter (generate_test_command_call test_name) seq;
3853 generate_test_command_call ~test test_name last
3854 | TestOutputFalse seq ->
3855 pr " /* TestOutputFalse for %s (%d) */\n" name i;
3856 let seq, last = get_seq_last seq in
3859 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
3864 List.iter (generate_test_command_call test_name) seq;
3865 generate_test_command_call ~test test_name last
3866 | TestOutputLength (seq, expected) ->
3867 pr " /* TestOutputLength for %s (%d) */\n" name i;
3868 let seq, last = get_seq_last seq in
3871 pr " for (j = 0; j < %d; ++j)\n" expected;
3872 pr " if (r[j] == NULL) {\n";
3873 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
3875 pr " print_strings (r);\n";
3878 pr " if (r[j] != NULL) {\n";
3879 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
3881 pr " print_strings (r);\n";
3885 List.iter (generate_test_command_call test_name) seq;
3886 generate_test_command_call ~test test_name last
3887 | TestOutputStruct (seq, checks) ->
3888 pr " /* TestOutputStruct for %s (%d) */\n" name i;
3889 let seq, last = get_seq_last seq in
3893 | CompareWithInt (field, expected) ->
3894 pr " if (r->%s != %d) {\n" field expected;
3895 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
3896 test_name field expected;
3897 pr " (int) r->%s);\n" field;
3900 | CompareWithString (field, expected) ->
3901 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
3902 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
3903 test_name field expected;
3904 pr " r->%s);\n" field;
3907 | CompareFieldsIntEq (field1, field2) ->
3908 pr " if (r->%s != r->%s) {\n" field1 field2;
3909 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
3910 test_name field1 field2;
3911 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
3914 | CompareFieldsStrEq (field1, field2) ->
3915 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
3916 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
3917 test_name field1 field2;
3918 pr " r->%s, r->%s);\n" field1 field2;
3923 List.iter (generate_test_command_call test_name) seq;
3924 generate_test_command_call ~test test_name last
3925 | TestLastFail seq ->
3926 pr " /* TestLastFail for %s (%d) */\n" name i;
3927 let seq, last = get_seq_last seq in
3928 List.iter (generate_test_command_call test_name) seq;
3929 generate_test_command_call test_name ~expect_error:true last
3931 (* Generate the code to run a command, leaving the result in 'r'.
3932 * If you expect to get an error then you should set expect_error:true.
3934 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
3936 | [] -> assert false
3938 (* Look up the command to find out what args/ret it has. *)
3941 let _, style, _, _, _, _, _ =
3942 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
3945 failwithf "%s: in test, command %s was not found" test_name name in
3947 if List.length (snd style) <> List.length args then
3948 failwithf "%s: in test, wrong number of args given to %s"
3955 | OptString n, "NULL" -> ()
3957 | OptString n, arg ->
3958 pr " char %s[] = \"%s\";\n" n (c_quote arg);
3959 if String.length arg > 7 && String.sub arg 0 7 = "/dev/sd" then
3960 pr " %s[5] = devchar;\n" n
3963 | FileIn _, _ | FileOut _, _ -> ()
3964 | StringList n, arg ->
3965 let strs = string_split " " arg in
3968 pr " char %s_%d[] = \"%s\";\n" n i (c_quote str);
3969 if String.length str > 7 && String.sub str 0 7 = "/dev/sd" then
3970 pr " %s_%d[5] = devchar;\n" n i
3972 pr " char *%s[] = {\n" n;
3974 fun i _ -> pr " %s_%d,\n" n i
3978 ) (List.combine (snd style) args);
3981 match fst style with
3982 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
3983 | RInt64 _ -> pr " int64_t r;\n"; "-1"
3984 | RConstString _ -> pr " const char *r;\n"; "NULL"
3985 | RString _ -> pr " char *r;\n"; "NULL"
3986 | RStringList _ | RHashtable _ ->
3991 pr " struct guestfs_int_bool *r;\n"; "NULL"
3993 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
3995 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
3997 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
3999 pr " struct guestfs_stat *r;\n"; "NULL"
4001 pr " struct guestfs_statvfs *r;\n"; "NULL" in
4003 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
4004 pr " r = guestfs_%s (g" name;
4006 (* Generate the parameters. *)
4009 | OptString _, "NULL" -> pr ", NULL"
4013 | FileIn _, arg | FileOut _, arg ->
4014 pr ", \"%s\"" (c_quote arg)
4015 | StringList n, _ ->
4019 try int_of_string arg
4020 with Failure "int_of_string" ->
4021 failwithf "%s: expecting an int, but got '%s'" test_name arg in
4024 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
4025 ) (List.combine (snd style) args);
4028 if not expect_error then
4029 pr " if (r == %s)\n" error_code
4031 pr " if (r != %s)\n" error_code;
4034 (* Insert the test code. *)
4040 (match fst style with
4041 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _ -> ()
4042 | RString _ -> pr " free (r);\n"
4043 | RStringList _ | RHashtable _ ->
4044 pr " for (i = 0; r[i] != NULL; ++i)\n";
4045 pr " free (r[i]);\n";
4048 pr " guestfs_free_int_bool (r);\n"
4050 pr " guestfs_free_lvm_pv_list (r);\n"
4052 pr " guestfs_free_lvm_vg_list (r);\n"
4054 pr " guestfs_free_lvm_lv_list (r);\n"
4055 | RStat _ | RStatVFS _ ->
4062 let str = replace_str str "\r" "\\r" in
4063 let str = replace_str str "\n" "\\n" in
4064 let str = replace_str str "\t" "\\t" in
4065 let str = replace_str str "\000" "\\0" in
4068 (* Generate a lot of different functions for guestfish. *)
4069 and generate_fish_cmds () =
4070 generate_header CStyle GPLv2;
4074 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4076 let all_functions_sorted =
4078 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4079 ) all_functions_sorted in
4081 pr "#include <stdio.h>\n";
4082 pr "#include <stdlib.h>\n";
4083 pr "#include <string.h>\n";
4084 pr "#include <inttypes.h>\n";
4086 pr "#include <guestfs.h>\n";
4087 pr "#include \"fish.h\"\n";
4090 (* list_commands function, which implements guestfish -h *)
4091 pr "void list_commands (void)\n";
4093 pr " printf (\" %%-16s %%s\\n\", \"Command\", \"Description\");\n";
4094 pr " list_builtin_commands ();\n";
4096 fun (name, _, _, flags, _, shortdesc, _) ->
4097 let name = replace_char name '_' '-' in
4098 pr " printf (\"%%-20s %%s\\n\", \"%s\", \"%s\");\n"
4100 ) all_functions_sorted;
4101 pr " printf (\" Use -h <cmd> / help <cmd> to show detailed help for a command.\\n\");\n";
4105 (* display_command function, which implements guestfish -h cmd *)
4106 pr "void display_command (const char *cmd)\n";
4109 fun (name, style, _, flags, _, shortdesc, longdesc) ->
4110 let name2 = replace_char name '_' '-' in
4112 try find_map (function FishAlias n -> Some n | _ -> None) flags
4113 with Not_found -> name in
4114 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
4116 match snd style with
4120 name2 (String.concat "> <" (List.map name_of_argt args)) in
4123 if List.mem ProtocolLimitWarning flags then
4124 ("\n\n" ^ protocol_limit_warning)
4127 (* For DangerWillRobinson commands, we should probably have
4128 * guestfish prompt before allowing you to use them (especially
4129 * in interactive mode). XXX
4133 if List.mem DangerWillRobinson flags then
4134 ("\n\n" ^ danger_will_robinson)
4137 let describe_alias =
4138 if name <> alias then
4139 sprintf "\n\nYou can use '%s' as an alias for this command." alias
4143 pr "strcasecmp (cmd, \"%s\") == 0" name;
4144 if name <> name2 then
4145 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
4146 if name <> alias then
4147 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
4149 pr " pod2text (\"%s - %s\", %S);\n"
4151 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
4154 pr " display_builtin_command (cmd);\n";
4158 (* print_{pv,vg,lv}_list functions *)
4162 pr "static void print_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
4169 pr " printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
4171 pr " printf (\"%s: \");\n" name;
4172 pr " for (i = 0; i < 32; ++i)\n";
4173 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
4174 pr " printf (\"\\n\");\n"
4176 pr " printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
4178 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
4179 | name, `OptPercent ->
4180 pr " if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
4181 typ name name typ name;
4182 pr " else printf (\"%s: \\n\");\n" name
4186 pr "static void print_%s_list (struct guestfs_lvm_%s_list *%ss)\n"
4191 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
4192 pr " print_%s (&%ss->val[i]);\n" typ typ;
4195 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
4197 (* print_{stat,statvfs} functions *)
4201 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
4206 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
4210 ) ["stat", stat_cols; "statvfs", statvfs_cols];
4212 (* run_<action> actions *)
4214 fun (name, style, _, flags, _, _, _) ->
4215 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
4217 (match fst style with
4220 | RBool _ -> pr " int r;\n"
4221 | RInt64 _ -> pr " int64_t r;\n"
4222 | RConstString _ -> pr " const char *r;\n"
4223 | RString _ -> pr " char *r;\n"
4224 | RStringList _ | RHashtable _ -> pr " char **r;\n"
4225 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"
4226 | RPVList _ -> pr " struct guestfs_lvm_pv_list *r;\n"
4227 | RVGList _ -> pr " struct guestfs_lvm_vg_list *r;\n"
4228 | RLVList _ -> pr " struct guestfs_lvm_lv_list *r;\n"
4229 | RStat _ -> pr " struct guestfs_stat *r;\n"
4230 | RStatVFS _ -> pr " struct guestfs_statvfs *r;\n"
4237 | FileOut n -> pr " const char *%s;\n" n
4238 | StringList n -> pr " char **%s;\n" n
4239 | Bool n -> pr " int %s;\n" n
4240 | Int n -> pr " int %s;\n" n
4243 (* Check and convert parameters. *)
4244 let argc_expected = List.length (snd style) in
4245 pr " if (argc != %d) {\n" argc_expected;
4246 pr " fprintf (stderr, \"%%s should have %d parameter(s)\\n\", cmd);\n"
4248 pr " fprintf (stderr, \"type 'help %%s' for help on %%s\\n\", cmd, cmd);\n";
4254 | String name -> pr " %s = argv[%d];\n" name i
4256 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
4259 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
4262 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
4264 | StringList name ->
4265 pr " %s = parse_string_list (argv[%d]);\n" name i
4267 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
4269 pr " %s = atoi (argv[%d]);\n" name i
4272 (* Call C API function. *)
4274 try find_map (function FishAction n -> Some n | _ -> None) flags
4275 with Not_found -> sprintf "guestfs_%s" name in
4277 generate_call_args ~handle:"g" (snd style);
4280 (* Check return value for errors and display command results. *)
4281 (match fst style with
4282 | RErr -> pr " return r;\n"
4284 pr " if (r == -1) return -1;\n";
4285 pr " printf (\"%%d\\n\", r);\n";
4288 pr " if (r == -1) return -1;\n";
4289 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
4292 pr " if (r == -1) return -1;\n";
4293 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
4296 pr " if (r == NULL) return -1;\n";
4297 pr " printf (\"%%s\\n\", r);\n";
4300 pr " if (r == NULL) return -1;\n";
4301 pr " printf (\"%%s\\n\", r);\n";
4305 pr " if (r == NULL) return -1;\n";
4306 pr " print_strings (r);\n";
4307 pr " free_strings (r);\n";
4310 pr " if (r == NULL) return -1;\n";
4311 pr " printf (\"%%d, %%s\\n\", r->i,\n";
4312 pr " r->b ? \"true\" : \"false\");\n";
4313 pr " guestfs_free_int_bool (r);\n";
4316 pr " if (r == NULL) return -1;\n";
4317 pr " print_pv_list (r);\n";
4318 pr " guestfs_free_lvm_pv_list (r);\n";
4321 pr " if (r == NULL) return -1;\n";
4322 pr " print_vg_list (r);\n";
4323 pr " guestfs_free_lvm_vg_list (r);\n";
4326 pr " if (r == NULL) return -1;\n";
4327 pr " print_lv_list (r);\n";
4328 pr " guestfs_free_lvm_lv_list (r);\n";
4331 pr " if (r == NULL) return -1;\n";
4332 pr " print_stat (r);\n";
4336 pr " if (r == NULL) return -1;\n";
4337 pr " print_statvfs (r);\n";
4341 pr " if (r == NULL) return -1;\n";
4342 pr " print_table (r);\n";
4343 pr " free_strings (r);\n";
4350 (* run_action function *)
4351 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
4354 fun (name, _, _, flags, _, _, _) ->
4355 let name2 = replace_char name '_' '-' in
4357 try find_map (function FishAlias n -> Some n | _ -> None) flags
4358 with Not_found -> name in
4360 pr "strcasecmp (cmd, \"%s\") == 0" name;
4361 if name <> name2 then
4362 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
4363 if name <> alias then
4364 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
4366 pr " return run_%s (cmd, argc, argv);\n" name;
4370 pr " fprintf (stderr, \"%%s: unknown command\\n\", cmd);\n";
4377 (* Readline completion for guestfish. *)
4378 and generate_fish_completion () =
4379 generate_header CStyle GPLv2;
4383 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4393 #ifdef HAVE_LIBREADLINE
4394 #include <readline/readline.h>
4399 #ifdef HAVE_LIBREADLINE
4401 static const char *const commands[] = {
4404 (* Get the commands and sort them, including the aliases. *)
4407 fun (name, _, _, flags, _, _, _) ->
4408 let name2 = replace_char name '_' '-' in
4410 try find_map (function FishAlias n -> Some n | _ -> None) flags
4411 with Not_found -> name in
4413 if name <> alias then [name2; alias] else [name2]
4415 let commands = List.flatten commands in
4416 let commands = List.sort compare commands in
4418 List.iter (pr " \"%s\",\n") commands;
4424 generator (const char *text, int state)
4426 static int index, len;
4431 len = strlen (text);
4434 while ((name = commands[index]) != NULL) {
4436 if (strncasecmp (name, text, len) == 0)
4437 return strdup (name);
4443 #endif /* HAVE_LIBREADLINE */
4445 char **do_completion (const char *text, int start, int end)
4447 char **matches = NULL;
4449 #ifdef HAVE_LIBREADLINE
4451 matches = rl_completion_matches (text, generator);
4458 (* Generate the POD documentation for guestfish. *)
4459 and generate_fish_actions_pod () =
4460 let all_functions_sorted =
4462 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4463 ) all_functions_sorted in
4465 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
4468 fun (name, style, _, flags, _, _, longdesc) ->
4470 Str.global_substitute rex (
4473 try Str.matched_group 1 s
4475 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
4476 "C<" ^ replace_char sub '_' '-' ^ ">"
4478 let name = replace_char name '_' '-' in
4480 try find_map (function FishAlias n -> Some n | _ -> None) flags
4481 with Not_found -> name in
4483 pr "=head2 %s" name;
4484 if name <> alias then
4491 | String n -> pr " %s" n
4492 | OptString n -> pr " %s" n
4493 | StringList n -> pr " '%s ...'" n
4494 | Bool _ -> pr " true|false"
4495 | Int n -> pr " %s" n
4496 | FileIn n | FileOut n -> pr " (%s|-)" n
4500 pr "%s\n\n" longdesc;
4502 if List.exists (function FileIn _ | FileOut _ -> true
4503 | _ -> false) (snd style) then
4504 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
4506 if List.mem ProtocolLimitWarning flags then
4507 pr "%s\n\n" protocol_limit_warning;
4509 if List.mem DangerWillRobinson flags then
4510 pr "%s\n\n" danger_will_robinson
4511 ) all_functions_sorted
4513 (* Generate a C function prototype. *)
4514 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
4515 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
4517 ?handle name style =
4518 if extern then pr "extern ";
4519 if static then pr "static ";
4520 (match fst style with
4522 | RInt _ -> pr "int "
4523 | RInt64 _ -> pr "int64_t "
4524 | RBool _ -> pr "int "
4525 | RConstString _ -> pr "const char *"
4526 | RString _ -> pr "char *"
4527 | RStringList _ | RHashtable _ -> pr "char **"
4529 if not in_daemon then pr "struct guestfs_int_bool *"
4530 else pr "guestfs_%s_ret *" name
4532 if not in_daemon then pr "struct guestfs_lvm_pv_list *"
4533 else pr "guestfs_lvm_int_pv_list *"
4535 if not in_daemon then pr "struct guestfs_lvm_vg_list *"
4536 else pr "guestfs_lvm_int_vg_list *"
4538 if not in_daemon then pr "struct guestfs_lvm_lv_list *"
4539 else pr "guestfs_lvm_int_lv_list *"
4541 if not in_daemon then pr "struct guestfs_stat *"
4542 else pr "guestfs_int_stat *"
4544 if not in_daemon then pr "struct guestfs_statvfs *"
4545 else pr "guestfs_int_statvfs *"
4547 pr "%s%s (" prefix name;
4548 if handle = None && List.length (snd style) = 0 then
4551 let comma = ref false in
4554 | Some handle -> pr "guestfs_h *%s" handle; comma := true
4558 if single_line then pr ", " else pr ",\n\t\t"
4565 | OptString n -> next (); pr "const char *%s" n
4566 | StringList n -> next (); pr "char * const* const %s" n
4567 | Bool n -> next (); pr "int %s" n
4568 | Int n -> next (); pr "int %s" n
4571 if not in_daemon then (next (); pr "const char *%s" n)
4575 if semicolon then pr ";";
4576 if newline then pr "\n"
4578 (* Generate C call arguments, eg "(handle, foo, bar)" *)
4579 and generate_call_args ?handle args =
4581 let comma = ref false in
4584 | Some handle -> pr "%s" handle; comma := true
4588 if !comma then pr ", ";
4590 pr "%s" (name_of_argt arg)
4594 (* Generate the OCaml bindings interface. *)
4595 and generate_ocaml_mli () =
4596 generate_header OCamlStyle LGPLv2;
4599 (** For API documentation you should refer to the C API
4600 in the guestfs(3) manual page. The OCaml API uses almost
4601 exactly the same calls. *)
4604 (** A [guestfs_h] handle. *)
4606 exception Error of string
4607 (** This exception is raised when there is an error. *)
4609 val create : unit -> t
4611 val close : t -> unit
4612 (** Handles are closed by the garbage collector when they become
4613 unreferenced, but callers can also call this in order to
4614 provide predictable cleanup. *)
4617 generate_ocaml_lvm_structure_decls ();
4619 generate_ocaml_stat_structure_decls ();
4623 fun (name, style, _, _, _, shortdesc, _) ->
4624 generate_ocaml_prototype name style;
4625 pr "(** %s *)\n" shortdesc;
4629 (* Generate the OCaml bindings implementation. *)
4630 and generate_ocaml_ml () =
4631 generate_header OCamlStyle LGPLv2;
4635 exception Error of string
4636 external create : unit -> t = \"ocaml_guestfs_create\"
4637 external close : t -> unit = \"ocaml_guestfs_close\"
4640 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
4644 generate_ocaml_lvm_structure_decls ();
4646 generate_ocaml_stat_structure_decls ();
4650 fun (name, style, _, _, _, shortdesc, _) ->
4651 generate_ocaml_prototype ~is_external:true name style;
4654 (* Generate the OCaml bindings C implementation. *)
4655 and generate_ocaml_c () =
4656 generate_header CStyle LGPLv2;
4663 #include <caml/config.h>
4664 #include <caml/alloc.h>
4665 #include <caml/callback.h>
4666 #include <caml/fail.h>
4667 #include <caml/memory.h>
4668 #include <caml/mlvalues.h>
4669 #include <caml/signals.h>
4671 #include <guestfs.h>
4673 #include \"guestfs_c.h\"
4675 /* Copy a hashtable of string pairs into an assoc-list. We return
4676 * the list in reverse order, but hashtables aren't supposed to be
4679 static CAMLprim value
4680 copy_table (char * const * argv)
4683 CAMLlocal5 (rv, pairv, kv, vv, cons);
4687 for (i = 0; argv[i] != NULL; i += 2) {
4688 kv = caml_copy_string (argv[i]);
4689 vv = caml_copy_string (argv[i+1]);
4690 pairv = caml_alloc (2, 0);
4691 Store_field (pairv, 0, kv);
4692 Store_field (pairv, 1, vv);
4693 cons = caml_alloc (2, 0);
4694 Store_field (cons, 1, rv);
4696 Store_field (cons, 0, pairv);
4704 (* LVM struct copy functions. *)
4707 let has_optpercent_col =
4708 List.exists (function (_, `OptPercent) -> true | _ -> false) cols in
4710 pr "static CAMLprim value\n";
4711 pr "copy_lvm_%s (const struct guestfs_lvm_%s *%s)\n" typ typ typ;
4713 pr " CAMLparam0 ();\n";
4714 if has_optpercent_col then
4715 pr " CAMLlocal3 (rv, v, v2);\n"
4717 pr " CAMLlocal2 (rv, v);\n";
4719 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
4724 pr " v = caml_copy_string (%s->%s);\n" typ name
4726 pr " v = caml_alloc_string (32);\n";
4727 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
4730 pr " v = caml_copy_int64 (%s->%s);\n" typ name
4731 | name, `OptPercent ->
4732 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
4733 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
4734 pr " v = caml_alloc (1, 0);\n";
4735 pr " Store_field (v, 0, v2);\n";
4736 pr " } else /* None */\n";
4737 pr " v = Val_int (0);\n";
4739 pr " Store_field (rv, %d, v);\n" i
4741 pr " CAMLreturn (rv);\n";
4745 pr "static CAMLprim value\n";
4746 pr "copy_lvm_%s_list (const struct guestfs_lvm_%s_list *%ss)\n"
4749 pr " CAMLparam0 ();\n";
4750 pr " CAMLlocal2 (rv, v);\n";
4753 pr " if (%ss->len == 0)\n" typ;
4754 pr " CAMLreturn (Atom (0));\n";
4756 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
4757 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
4758 pr " v = copy_lvm_%s (&%ss->val[i]);\n" typ typ;
4759 pr " caml_modify (&Field (rv, i), v);\n";
4761 pr " CAMLreturn (rv);\n";
4765 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
4767 (* Stat copy functions. *)
4770 pr "static CAMLprim value\n";
4771 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
4773 pr " CAMLparam0 ();\n";
4774 pr " CAMLlocal2 (rv, v);\n";
4776 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
4781 pr " v = caml_copy_int64 (%s->%s);\n" typ name
4783 pr " Store_field (rv, %d, v);\n" i
4785 pr " CAMLreturn (rv);\n";
4788 ) ["stat", stat_cols; "statvfs", statvfs_cols];
4792 fun (name, style, _, _, _, _, _) ->
4794 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
4796 pr "CAMLprim value\n";
4797 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
4798 List.iter (pr ", value %s") (List.tl params);
4803 | [p1; p2; p3; p4; p5] ->
4804 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
4805 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
4806 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
4807 pr " CAMLxparam%d (%s);\n"
4808 (List.length rest) (String.concat ", " rest)
4810 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
4812 pr " CAMLlocal1 (rv);\n";
4815 pr " guestfs_h *g = Guestfs_val (gv);\n";
4816 pr " if (g == NULL)\n";
4817 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
4825 pr " const char *%s = String_val (%sv);\n" n n
4827 pr " const char *%s =\n" n;
4828 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
4831 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
4833 pr " int %s = Bool_val (%sv);\n" n n
4835 pr " int %s = Int_val (%sv);\n" n n
4838 match fst style with
4839 | RErr -> pr " int r;\n"; "-1"
4840 | RInt _ -> pr " int r;\n"; "-1"
4841 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4842 | RBool _ -> pr " int r;\n"; "-1"
4843 | RConstString _ -> pr " const char *r;\n"; "NULL"
4844 | RString _ -> pr " char *r;\n"; "NULL"
4850 pr " struct guestfs_int_bool *r;\n"; "NULL"
4852 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
4854 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
4856 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
4858 pr " struct guestfs_stat *r;\n"; "NULL"
4860 pr " struct guestfs_statvfs *r;\n"; "NULL"
4867 pr " caml_enter_blocking_section ();\n";
4868 pr " r = guestfs_%s " name;
4869 generate_call_args ~handle:"g" (snd style);
4871 pr " caml_leave_blocking_section ();\n";
4876 pr " ocaml_guestfs_free_strings (%s);\n" n;
4877 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
4880 pr " if (r == %s)\n" error_code;
4881 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
4884 (match fst style with
4885 | RErr -> pr " rv = Val_unit;\n"
4886 | RInt _ -> pr " rv = Val_int (r);\n"
4888 pr " rv = caml_copy_int64 (r);\n"
4889 | RBool _ -> pr " rv = Val_bool (r);\n"
4890 | RConstString _ -> pr " rv = caml_copy_string (r);\n"
4892 pr " rv = caml_copy_string (r);\n";
4895 pr " rv = caml_copy_string_array ((const char **) r);\n";
4896 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
4899 pr " rv = caml_alloc (2, 0);\n";
4900 pr " Store_field (rv, 0, Val_int (r->i));\n";
4901 pr " Store_field (rv, 1, Val_bool (r->b));\n";
4902 pr " guestfs_free_int_bool (r);\n";
4904 pr " rv = copy_lvm_pv_list (r);\n";
4905 pr " guestfs_free_lvm_pv_list (r);\n";
4907 pr " rv = copy_lvm_vg_list (r);\n";
4908 pr " guestfs_free_lvm_vg_list (r);\n";
4910 pr " rv = copy_lvm_lv_list (r);\n";
4911 pr " guestfs_free_lvm_lv_list (r);\n";
4913 pr " rv = copy_stat (r);\n";
4916 pr " rv = copy_statvfs (r);\n";
4919 pr " rv = copy_table (r);\n";
4920 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
4924 pr " CAMLreturn (rv);\n";
4928 if List.length params > 5 then (
4929 pr "CAMLprim value\n";
4930 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
4932 pr " return ocaml_guestfs_%s (argv[0]" name;
4933 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
4940 and generate_ocaml_lvm_structure_decls () =
4943 pr "type lvm_%s = {\n" typ;
4946 | name, `String -> pr " %s : string;\n" name
4947 | name, `UUID -> pr " %s : string;\n" name
4948 | name, `Bytes -> pr " %s : int64;\n" name
4949 | name, `Int -> pr " %s : int64;\n" name
4950 | name, `OptPercent -> pr " %s : float option;\n" name
4954 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
4956 and generate_ocaml_stat_structure_decls () =
4959 pr "type %s = {\n" typ;
4962 | name, `Int -> pr " %s : int64;\n" name
4966 ) ["stat", stat_cols; "statvfs", statvfs_cols]
4968 and generate_ocaml_prototype ?(is_external = false) name style =
4969 if is_external then pr "external " else pr "val ";
4970 pr "%s : t -> " name;
4973 | String _ | FileIn _ | FileOut _ -> pr "string -> "
4974 | OptString _ -> pr "string option -> "
4975 | StringList _ -> pr "string array -> "
4976 | Bool _ -> pr "bool -> "
4977 | Int _ -> pr "int -> "
4979 (match fst style with
4980 | RErr -> pr "unit" (* all errors are turned into exceptions *)
4981 | RInt _ -> pr "int"
4982 | RInt64 _ -> pr "int64"
4983 | RBool _ -> pr "bool"
4984 | RConstString _ -> pr "string"
4985 | RString _ -> pr "string"
4986 | RStringList _ -> pr "string array"
4987 | RIntBool _ -> pr "int * bool"
4988 | RPVList _ -> pr "lvm_pv array"
4989 | RVGList _ -> pr "lvm_vg array"
4990 | RLVList _ -> pr "lvm_lv array"
4991 | RStat _ -> pr "stat"
4992 | RStatVFS _ -> pr "statvfs"
4993 | RHashtable _ -> pr "(string * string) list"
4995 if is_external then (
4997 if List.length (snd style) + 1 > 5 then
4998 pr "\"ocaml_guestfs_%s_byte\" " name;
4999 pr "\"ocaml_guestfs_%s\"" name
5003 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
5004 and generate_perl_xs () =
5005 generate_header CStyle LGPLv2;
5008 #include \"EXTERN.h\"
5012 #include <guestfs.h>
5015 #define PRId64 \"lld\"
5019 my_newSVll(long long val) {
5020 #ifdef USE_64_BIT_ALL
5021 return newSViv(val);
5025 len = snprintf(buf, 100, \"%%\" PRId64, val);
5026 return newSVpv(buf, len);
5031 #define PRIu64 \"llu\"
5035 my_newSVull(unsigned long long val) {
5036 #ifdef USE_64_BIT_ALL
5037 return newSVuv(val);
5041 len = snprintf(buf, 100, \"%%\" PRIu64, val);
5042 return newSVpv(buf, len);
5046 /* http://www.perlmonks.org/?node_id=680842 */
5048 XS_unpack_charPtrPtr (SV *arg) {
5053 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
5054 croak (\"array reference expected\");
5056 av = (AV *)SvRV (arg);
5057 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
5059 croak (\"malloc failed\");
5061 for (i = 0; i <= av_len (av); i++) {
5062 SV **elem = av_fetch (av, i, 0);
5064 if (!elem || !*elem)
5065 croak (\"missing element in list\");
5067 ret[i] = SvPV_nolen (*elem);
5075 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
5082 RETVAL = guestfs_create ();
5084 croak (\"could not create guestfs handle\");
5085 guestfs_set_error_handler (RETVAL, NULL, NULL);
5098 fun (name, style, _, _, _, _, _) ->
5099 (match fst style with
5100 | RErr -> pr "void\n"
5101 | RInt _ -> pr "SV *\n"
5102 | RInt64 _ -> pr "SV *\n"
5103 | RBool _ -> pr "SV *\n"
5104 | RConstString _ -> pr "SV *\n"
5105 | RString _ -> pr "SV *\n"
5108 | RPVList _ | RVGList _ | RLVList _
5109 | RStat _ | RStatVFS _
5111 pr "void\n" (* all lists returned implictly on the stack *)
5113 (* Call and arguments. *)
5115 generate_call_args ~handle:"g" (snd style);
5117 pr " guestfs_h *g;\n";
5120 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
5121 | OptString n -> pr " char *%s;\n" n
5122 | StringList n -> pr " char **%s;\n" n
5123 | Bool n -> pr " int %s;\n" n
5124 | Int n -> pr " int %s;\n" n
5127 let do_cleanups () =
5130 | String _ | OptString _ | Bool _ | Int _
5131 | FileIn _ | FileOut _ -> ()
5132 | StringList n -> pr " free (%s);\n" n
5137 (match fst style with
5142 pr " r = guestfs_%s " name;
5143 generate_call_args ~handle:"g" (snd style);
5146 pr " if (r == -1)\n";
5147 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5153 pr " %s = guestfs_%s " n name;
5154 generate_call_args ~handle:"g" (snd style);
5157 pr " if (%s == -1)\n" n;
5158 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5159 pr " RETVAL = newSViv (%s);\n" n;
5164 pr " int64_t %s;\n" n;
5166 pr " %s = guestfs_%s " n name;
5167 generate_call_args ~handle:"g" (snd style);
5170 pr " if (%s == -1)\n" n;
5171 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5172 pr " RETVAL = my_newSVll (%s);\n" n;
5177 pr " const char *%s;\n" n;
5179 pr " %s = guestfs_%s " n name;
5180 generate_call_args ~handle:"g" (snd style);
5183 pr " if (%s == NULL)\n" n;
5184 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5185 pr " RETVAL = newSVpv (%s, 0);\n" n;
5190 pr " char *%s;\n" n;
5192 pr " %s = guestfs_%s " n name;
5193 generate_call_args ~handle:"g" (snd style);
5196 pr " if (%s == NULL)\n" n;
5197 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5198 pr " RETVAL = newSVpv (%s, 0);\n" n;
5199 pr " free (%s);\n" n;
5202 | RStringList n | RHashtable n ->
5204 pr " char **%s;\n" n;
5207 pr " %s = guestfs_%s " n name;
5208 generate_call_args ~handle:"g" (snd style);
5211 pr " if (%s == NULL)\n" n;
5212 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5213 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
5214 pr " EXTEND (SP, n);\n";
5215 pr " for (i = 0; i < n; ++i) {\n";
5216 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
5217 pr " free (%s[i]);\n" n;
5219 pr " free (%s);\n" n;
5222 pr " struct guestfs_int_bool *r;\n";
5224 pr " r = guestfs_%s " name;
5225 generate_call_args ~handle:"g" (snd style);
5228 pr " if (r == NULL)\n";
5229 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5230 pr " EXTEND (SP, 2);\n";
5231 pr " PUSHs (sv_2mortal (newSViv (r->i)));\n";
5232 pr " PUSHs (sv_2mortal (newSViv (r->b)));\n";
5233 pr " guestfs_free_int_bool (r);\n";
5235 generate_perl_lvm_code "pv" pv_cols name style n do_cleanups
5237 generate_perl_lvm_code "vg" vg_cols name style n do_cleanups
5239 generate_perl_lvm_code "lv" lv_cols name style n do_cleanups
5241 generate_perl_stat_code "stat" stat_cols name style n do_cleanups
5243 generate_perl_stat_code
5244 "statvfs" statvfs_cols name style n do_cleanups
5250 and generate_perl_lvm_code typ cols name style n do_cleanups =
5252 pr " struct guestfs_lvm_%s_list *%s;\n" typ n;
5256 pr " %s = guestfs_%s " n name;
5257 generate_call_args ~handle:"g" (snd style);
5260 pr " if (%s == NULL)\n" n;
5261 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5262 pr " EXTEND (SP, %s->len);\n" n;
5263 pr " for (i = 0; i < %s->len; ++i) {\n" n;
5264 pr " hv = newHV ();\n";
5268 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
5269 name (String.length name) n name
5271 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
5272 name (String.length name) n name
5274 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
5275 name (String.length name) n name
5277 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
5278 name (String.length name) n name
5279 | name, `OptPercent ->
5280 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
5281 name (String.length name) n name
5283 pr " PUSHs (sv_2mortal ((SV *) hv));\n";
5285 pr " guestfs_free_lvm_%s_list (%s);\n" typ n
5287 and generate_perl_stat_code typ cols name style n do_cleanups =
5289 pr " struct guestfs_%s *%s;\n" typ n;
5291 pr " %s = guestfs_%s " n name;
5292 generate_call_args ~handle:"g" (snd style);
5295 pr " if (%s == NULL)\n" n;
5296 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5297 pr " EXTEND (SP, %d);\n" (List.length cols);
5301 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n" n name
5303 pr " free (%s);\n" n
5305 (* Generate Sys/Guestfs.pm. *)
5306 and generate_perl_pm () =
5307 generate_header HashStyle LGPLv2;
5314 Sys::Guestfs - Perl bindings for libguestfs
5320 my $h = Sys::Guestfs->new ();
5321 $h->add_drive ('guest.img');
5324 $h->mount ('/dev/sda1', '/');
5325 $h->touch ('/hello');
5330 The C<Sys::Guestfs> module provides a Perl XS binding to the
5331 libguestfs API for examining and modifying virtual machine
5334 Amongst the things this is good for: making batch configuration
5335 changes to guests, getting disk used/free statistics (see also:
5336 virt-df), migrating between virtualization systems (see also:
5337 virt-p2v), performing partial backups, performing partial guest
5338 clones, cloning guests and changing registry/UUID/hostname info, and
5341 Libguestfs uses Linux kernel and qemu code, and can access any type of
5342 guest filesystem that Linux and qemu can, including but not limited
5343 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
5344 schemes, qcow, qcow2, vmdk.
5346 Libguestfs provides ways to enumerate guest storage (eg. partitions,
5347 LVs, what filesystem is in each LV, etc.). It can also run commands
5348 in the context of the guest. Also you can access filesystems over FTP.
5352 All errors turn into calls to C<croak> (see L<Carp(3)>).
5360 package Sys::Guestfs;
5366 XSLoader::load ('Sys::Guestfs');
5368 =item $h = Sys::Guestfs->new ();
5370 Create a new guestfs handle.
5376 my $class = ref ($proto) || $proto;
5378 my $self = Sys::Guestfs::_create ();
5379 bless $self, $class;
5385 (* Actions. We only need to print documentation for these as
5386 * they are pulled in from the XS code automatically.
5389 fun (name, style, _, flags, _, _, longdesc) ->
5390 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
5392 generate_perl_prototype name style;
5394 pr "%s\n\n" longdesc;
5395 if List.mem ProtocolLimitWarning flags then
5396 pr "%s\n\n" protocol_limit_warning;
5397 if List.mem DangerWillRobinson flags then
5398 pr "%s\n\n" danger_will_robinson
5399 ) all_functions_sorted;
5411 Copyright (C) 2009 Red Hat Inc.
5415 Please see the file COPYING.LIB for the full license.
5419 L<guestfs(3)>, L<guestfish(1)>.
5424 and generate_perl_prototype name style =
5425 (match fst style with
5431 | RString n -> pr "$%s = " n
5432 | RIntBool (n, m) -> pr "($%s, $%s) = " n m
5436 | RLVList n -> pr "@%s = " n
5439 | RHashtable n -> pr "%%%s = " n
5442 let comma = ref false in
5445 if !comma then pr ", ";
5448 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
5455 (* Generate Python C module. *)
5456 and generate_python_c () =
5457 generate_header CStyle LGPLv2;
5466 #include \"guestfs.h\"
5474 get_handle (PyObject *obj)
5477 assert (obj != Py_None);
5478 return ((Pyguestfs_Object *) obj)->g;
5482 put_handle (guestfs_h *g)
5486 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
5489 /* This list should be freed (but not the strings) after use. */
5490 static const char **
5491 get_string_list (PyObject *obj)
5498 if (!PyList_Check (obj)) {
5499 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
5503 len = PyList_Size (obj);
5504 r = malloc (sizeof (char *) * (len+1));
5506 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
5510 for (i = 0; i < len; ++i)
5511 r[i] = PyString_AsString (PyList_GetItem (obj, i));
5518 put_string_list (char * const * const argv)
5523 for (argc = 0; argv[argc] != NULL; ++argc)
5526 list = PyList_New (argc);
5527 for (i = 0; i < argc; ++i)
5528 PyList_SetItem (list, i, PyString_FromString (argv[i]));
5534 put_table (char * const * const argv)
5536 PyObject *list, *item;
5539 for (argc = 0; argv[argc] != NULL; ++argc)
5542 list = PyList_New (argc >> 1);
5543 for (i = 0; i < argc; i += 2) {
5544 item = PyTuple_New (2);
5545 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
5546 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
5547 PyList_SetItem (list, i >> 1, item);
5554 free_strings (char **argv)
5558 for (argc = 0; argv[argc] != NULL; ++argc)
5564 py_guestfs_create (PyObject *self, PyObject *args)
5568 g = guestfs_create ();
5570 PyErr_SetString (PyExc_RuntimeError,
5571 \"guestfs.create: failed to allocate handle\");
5574 guestfs_set_error_handler (g, NULL, NULL);
5575 return put_handle (g);
5579 py_guestfs_close (PyObject *self, PyObject *args)
5584 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
5586 g = get_handle (py_g);
5590 Py_INCREF (Py_None);
5596 (* LVM structures, turned into Python dictionaries. *)
5599 pr "static PyObject *\n";
5600 pr "put_lvm_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
5602 pr " PyObject *dict;\n";
5604 pr " dict = PyDict_New ();\n";
5608 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5609 pr " PyString_FromString (%s->%s));\n"
5612 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5613 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
5616 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5617 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
5620 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5621 pr " PyLong_FromLongLong (%s->%s));\n"
5623 | name, `OptPercent ->
5624 pr " if (%s->%s >= 0)\n" typ name;
5625 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5626 pr " PyFloat_FromDouble ((double) %s->%s));\n"
5629 pr " Py_INCREF (Py_None);\n";
5630 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
5633 pr " return dict;\n";
5637 pr "static PyObject *\n";
5638 pr "put_lvm_%s_list (struct guestfs_lvm_%s_list *%ss)\n" typ typ typ;
5640 pr " PyObject *list;\n";
5643 pr " list = PyList_New (%ss->len);\n" typ;
5644 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
5645 pr " PyList_SetItem (list, i, put_lvm_%s (&%ss->val[i]));\n" typ typ;
5646 pr " return list;\n";
5649 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
5651 (* Stat structures, turned into Python dictionaries. *)
5654 pr "static PyObject *\n";
5655 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
5657 pr " PyObject *dict;\n";
5659 pr " dict = PyDict_New ();\n";
5663 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5664 pr " PyLong_FromLongLong (%s->%s));\n"
5667 pr " return dict;\n";
5670 ) ["stat", stat_cols; "statvfs", statvfs_cols];
5672 (* Python wrapper functions. *)
5674 fun (name, style, _, _, _, _, _) ->
5675 pr "static PyObject *\n";
5676 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
5679 pr " PyObject *py_g;\n";
5680 pr " guestfs_h *g;\n";
5681 pr " PyObject *py_r;\n";
5684 match fst style with
5685 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5686 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5687 | RConstString _ -> pr " const char *r;\n"; "NULL"
5688 | RString _ -> pr " char *r;\n"; "NULL"
5689 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5690 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
5691 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5692 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5693 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5694 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
5695 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
5699 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
5700 | OptString n -> pr " const char *%s;\n" n
5702 pr " PyObject *py_%s;\n" n;
5703 pr " const char **%s;\n" n
5704 | Bool n -> pr " int %s;\n" n
5705 | Int n -> pr " int %s;\n" n
5710 (* Convert the parameters. *)
5711 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
5714 | String _ | FileIn _ | FileOut _ -> pr "s"
5715 | OptString _ -> pr "z"
5716 | StringList _ -> pr "O"
5717 | Bool _ -> pr "i" (* XXX Python has booleans? *)
5720 pr ":guestfs_%s\",\n" name;
5724 | String n | FileIn n | FileOut n -> pr ", &%s" n
5725 | OptString n -> pr ", &%s" n
5726 | StringList n -> pr ", &py_%s" n
5727 | Bool n -> pr ", &%s" n
5728 | Int n -> pr ", &%s" n
5732 pr " return NULL;\n";
5734 pr " g = get_handle (py_g);\n";
5737 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5739 pr " %s = get_string_list (py_%s);\n" n n;
5740 pr " if (!%s) return NULL;\n" n
5745 pr " r = guestfs_%s " name;
5746 generate_call_args ~handle:"g" (snd style);
5751 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5753 pr " free (%s);\n" n
5756 pr " if (r == %s) {\n" error_code;
5757 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
5758 pr " return NULL;\n";
5762 (match fst style with
5764 pr " Py_INCREF (Py_None);\n";
5765 pr " py_r = Py_None;\n"
5767 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
5768 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
5769 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
5771 pr " py_r = PyString_FromString (r);\n";
5774 pr " py_r = put_string_list (r);\n";
5775 pr " free_strings (r);\n"
5777 pr " py_r = PyTuple_New (2);\n";
5778 pr " PyTuple_SetItem (py_r, 0, PyInt_FromLong ((long) r->i));\n";
5779 pr " PyTuple_SetItem (py_r, 1, PyInt_FromLong ((long) r->b));\n";
5780 pr " guestfs_free_int_bool (r);\n"
5782 pr " py_r = put_lvm_pv_list (r);\n";
5783 pr " guestfs_free_lvm_pv_list (r);\n"
5785 pr " py_r = put_lvm_vg_list (r);\n";
5786 pr " guestfs_free_lvm_vg_list (r);\n"
5788 pr " py_r = put_lvm_lv_list (r);\n";
5789 pr " guestfs_free_lvm_lv_list (r);\n"
5791 pr " py_r = put_stat (r);\n";
5794 pr " py_r = put_statvfs (r);\n";
5797 pr " py_r = put_table (r);\n";
5798 pr " free_strings (r);\n"
5801 pr " return py_r;\n";
5806 (* Table of functions. *)
5807 pr "static PyMethodDef methods[] = {\n";
5808 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
5809 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
5811 fun (name, _, _, _, _, _, _) ->
5812 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
5815 pr " { NULL, NULL, 0, NULL }\n";
5819 (* Init function. *)
5822 initlibguestfsmod (void)
5824 static int initialized = 0;
5826 if (initialized) return;
5827 Py_InitModule ((char *) \"libguestfsmod\", methods);
5832 (* Generate Python module. *)
5833 and generate_python_py () =
5834 generate_header HashStyle LGPLv2;
5837 u\"\"\"Python bindings for libguestfs
5840 g = guestfs.GuestFS ()
5841 g.add_drive (\"guest.img\")
5844 parts = g.list_partitions ()
5846 The guestfs module provides a Python binding to the libguestfs API
5847 for examining and modifying virtual machine disk images.
5849 Amongst the things this is good for: making batch configuration
5850 changes to guests, getting disk used/free statistics (see also:
5851 virt-df), migrating between virtualization systems (see also:
5852 virt-p2v), performing partial backups, performing partial guest
5853 clones, cloning guests and changing registry/UUID/hostname info, and
5856 Libguestfs uses Linux kernel and qemu code, and can access any type of
5857 guest filesystem that Linux and qemu can, including but not limited
5858 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
5859 schemes, qcow, qcow2, vmdk.
5861 Libguestfs provides ways to enumerate guest storage (eg. partitions,
5862 LVs, what filesystem is in each LV, etc.). It can also run commands
5863 in the context of the guest. Also you can access filesystems over FTP.
5865 Errors which happen while using the API are turned into Python
5866 RuntimeError exceptions.
5868 To create a guestfs handle you usually have to perform the following
5871 # Create the handle, call add_drive at least once, and possibly
5872 # several times if the guest has multiple block devices:
5873 g = guestfs.GuestFS ()
5874 g.add_drive (\"guest.img\")
5876 # Launch the qemu subprocess and wait for it to become ready:
5880 # Now you can issue commands, for example:
5885 import libguestfsmod
5888 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
5890 def __init__ (self):
5891 \"\"\"Create a new libguestfs handle.\"\"\"
5892 self._o = libguestfsmod.create ()
5895 libguestfsmod.close (self._o)
5900 fun (name, style, _, flags, _, _, longdesc) ->
5901 let doc = replace_str longdesc "C<guestfs_" "C<g." in
5903 match fst style with
5904 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _
5907 doc ^ "\n\nThis function returns a list of strings."
5909 doc ^ "\n\nThis function returns a tuple (int, bool).\n"
5911 doc ^ "\n\nThis function returns a list of PVs. Each PV is represented as a dictionary."
5913 doc ^ "\n\nThis function returns a list of VGs. Each VG is represented as a dictionary."
5915 doc ^ "\n\nThis function returns a list of LVs. Each LV is represented as a dictionary."
5917 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the stat structure."
5919 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the statvfs structure."
5921 doc ^ "\n\nThis function returns a dictionary." in
5923 if List.mem ProtocolLimitWarning flags then
5924 doc ^ "\n\n" ^ protocol_limit_warning
5927 if List.mem DangerWillRobinson flags then
5928 doc ^ "\n\n" ^ danger_will_robinson
5930 let doc = pod2text ~width:60 name doc in
5931 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
5932 let doc = String.concat "\n " doc in
5935 generate_call_args ~handle:"self" (snd style);
5937 pr " u\"\"\"%s\"\"\"\n" doc;
5938 pr " return libguestfsmod.%s " name;
5939 generate_call_args ~handle:"self._o" (snd style);
5944 (* Useful if you need the longdesc POD text as plain text. Returns a
5947 * This is the slowest thing about autogeneration.
5949 and pod2text ~width name longdesc =
5950 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
5951 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
5953 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
5954 let chan = Unix.open_process_in cmd in
5955 let lines = ref [] in
5957 let line = input_line chan in
5958 if i = 1 then (* discard the first line of output *)
5961 let line = triml line in
5962 lines := line :: !lines;
5965 let lines = try loop 1 with End_of_file -> List.rev !lines in
5966 Unix.unlink filename;
5967 match Unix.close_process_in chan with
5968 | Unix.WEXITED 0 -> lines
5970 failwithf "pod2text: process exited with non-zero status (%d)" i
5971 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
5972 failwithf "pod2text: process signalled or stopped by signal %d" i
5974 (* Generate ruby bindings. *)
5975 and generate_ruby_c () =
5976 generate_header CStyle LGPLv2;
5984 #include \"guestfs.h\"
5986 #include \"extconf.h\"
5988 /* For Ruby < 1.9 */
5990 #define RARRAY_LEN(r) (RARRAY((r))->len)
5993 static VALUE m_guestfs; /* guestfs module */
5994 static VALUE c_guestfs; /* guestfs_h handle */
5995 static VALUE e_Error; /* used for all errors */
5997 static void ruby_guestfs_free (void *p)
6000 guestfs_close ((guestfs_h *) p);
6003 static VALUE ruby_guestfs_create (VALUE m)
6007 g = guestfs_create ();
6009 rb_raise (e_Error, \"failed to create guestfs handle\");
6011 /* Don't print error messages to stderr by default. */
6012 guestfs_set_error_handler (g, NULL, NULL);
6014 /* Wrap it, and make sure the close function is called when the
6017 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
6020 static VALUE ruby_guestfs_close (VALUE gv)
6023 Data_Get_Struct (gv, guestfs_h, g);
6025 ruby_guestfs_free (g);
6026 DATA_PTR (gv) = NULL;
6034 fun (name, style, _, _, _, _, _) ->
6035 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
6036 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
6039 pr " guestfs_h *g;\n";
6040 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
6042 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
6048 | String n | FileIn n | FileOut n ->
6049 pr " const char *%s = StringValueCStr (%sv);\n" n n;
6051 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
6052 pr " \"%s\", \"%s\");\n" n name
6054 pr " const char *%s = StringValueCStr (%sv);\n" n n
6058 pr " int i, len;\n";
6059 pr " len = RARRAY_LEN (%sv);\n" n;
6060 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
6062 pr " for (i = 0; i < len; ++i) {\n";
6063 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
6064 pr " %s[i] = StringValueCStr (v);\n" n;
6066 pr " %s[len] = NULL;\n" n;
6070 pr " int %s = NUM2INT (%sv);\n" n n
6075 match fst style with
6076 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
6077 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6078 | RConstString _ -> pr " const char *r;\n"; "NULL"
6079 | RString _ -> pr " char *r;\n"; "NULL"
6080 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6081 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
6082 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
6083 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
6084 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
6085 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
6086 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
6089 pr " r = guestfs_%s " name;
6090 generate_call_args ~handle:"g" (snd style);
6095 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6097 pr " free (%s);\n" n
6100 pr " if (r == %s)\n" error_code;
6101 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
6104 (match fst style with
6106 pr " return Qnil;\n"
6107 | RInt _ | RBool _ ->
6108 pr " return INT2NUM (r);\n"
6110 pr " return ULL2NUM (r);\n"
6112 pr " return rb_str_new2 (r);\n";
6114 pr " VALUE rv = rb_str_new2 (r);\n";
6118 pr " int i, len = 0;\n";
6119 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
6120 pr " VALUE rv = rb_ary_new2 (len);\n";
6121 pr " for (i = 0; r[i] != NULL; ++i) {\n";
6122 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
6123 pr " free (r[i]);\n";
6128 pr " VALUE rv = rb_ary_new2 (2);\n";
6129 pr " rb_ary_push (rv, INT2NUM (r->i));\n";
6130 pr " rb_ary_push (rv, INT2NUM (r->b));\n";
6131 pr " guestfs_free_int_bool (r);\n";
6134 generate_ruby_lvm_code "pv" pv_cols
6136 generate_ruby_lvm_code "vg" vg_cols
6138 generate_ruby_lvm_code "lv" lv_cols
6140 pr " VALUE rv = rb_hash_new ();\n";
6144 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
6149 pr " VALUE rv = rb_hash_new ();\n";
6153 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
6158 pr " VALUE rv = rb_hash_new ();\n";
6160 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
6161 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
6162 pr " free (r[i]);\n";
6163 pr " free (r[i+1]);\n";
6174 /* Initialize the module. */
6175 void Init__guestfs ()
6177 m_guestfs = rb_define_module (\"Guestfs\");
6178 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
6179 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
6181 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
6182 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
6185 (* Define the rest of the methods. *)
6187 fun (name, style, _, _, _, _, _) ->
6188 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
6189 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
6194 (* Ruby code to return an LVM struct list. *)
6195 and generate_ruby_lvm_code typ cols =
6196 pr " VALUE rv = rb_ary_new2 (r->len);\n";
6198 pr " for (i = 0; i < r->len; ++i) {\n";
6199 pr " VALUE hv = rb_hash_new ();\n";
6203 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
6205 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
6208 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
6209 | name, `OptPercent ->
6210 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
6212 pr " rb_ary_push (rv, hv);\n";
6214 pr " guestfs_free_lvm_%s_list (r);\n" typ;
6217 (* Generate Java bindings GuestFS.java file. *)
6218 and generate_java_java () =
6219 generate_header CStyle LGPLv2;
6222 package com.redhat.et.libguestfs;
6224 import java.util.HashMap;
6225 import com.redhat.et.libguestfs.LibGuestFSException;
6226 import com.redhat.et.libguestfs.PV;
6227 import com.redhat.et.libguestfs.VG;
6228 import com.redhat.et.libguestfs.LV;
6229 import com.redhat.et.libguestfs.Stat;
6230 import com.redhat.et.libguestfs.StatVFS;
6231 import com.redhat.et.libguestfs.IntBool;
6234 * The GuestFS object is a libguestfs handle.
6238 public class GuestFS {
6239 // Load the native code.
6241 System.loadLibrary (\"guestfs_jni\");
6245 * The native guestfs_h pointer.
6250 * Create a libguestfs handle.
6252 * @throws LibGuestFSException
6254 public GuestFS () throws LibGuestFSException
6258 private native long _create () throws LibGuestFSException;
6261 * Close a libguestfs handle.
6263 * You can also leave handles to be collected by the garbage
6264 * collector, but this method ensures that the resources used
6265 * by the handle are freed up immediately. If you call any
6266 * other methods after closing the handle, you will get an
6269 * @throws LibGuestFSException
6271 public void close () throws LibGuestFSException
6277 private native void _close (long g) throws LibGuestFSException;
6279 public void finalize () throws LibGuestFSException
6287 fun (name, style, _, flags, _, shortdesc, longdesc) ->
6288 let doc = replace_str longdesc "C<guestfs_" "C<g." in
6290 if List.mem ProtocolLimitWarning flags then
6291 doc ^ "\n\n" ^ protocol_limit_warning
6294 if List.mem DangerWillRobinson flags then
6295 doc ^ "\n\n" ^ danger_will_robinson
6297 let doc = pod2text ~width:60 name doc in
6298 let doc = String.concat "\n * " doc in
6301 pr " * %s\n" shortdesc;
6304 pr " * @throws LibGuestFSException\n";
6307 generate_java_prototype ~public:true ~semicolon:false name style;
6310 pr " if (g == 0)\n";
6311 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
6314 if fst style <> RErr then pr "return ";
6316 generate_call_args ~handle:"g" (snd style);
6320 generate_java_prototype ~privat:true ~native:true name style;
6327 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
6328 ?(semicolon=true) name style =
6329 if privat then pr "private ";
6330 if public then pr "public ";
6331 if native then pr "native ";
6334 (match fst style with
6335 | RErr -> pr "void ";
6336 | RInt _ -> pr "int ";
6337 | RInt64 _ -> pr "long ";
6338 | RBool _ -> pr "boolean ";
6339 | RConstString _ | RString _ -> pr "String ";
6340 | RStringList _ -> pr "String[] ";
6341 | RIntBool _ -> pr "IntBool ";
6342 | RPVList _ -> pr "PV[] ";
6343 | RVGList _ -> pr "VG[] ";
6344 | RLVList _ -> pr "LV[] ";
6345 | RStat _ -> pr "Stat ";
6346 | RStatVFS _ -> pr "StatVFS ";
6347 | RHashtable _ -> pr "HashMap<String,String> ";
6350 if native then pr "_%s " name else pr "%s " name;
6352 let needs_comma = ref false in
6361 if !needs_comma then pr ", ";
6362 needs_comma := true;
6379 pr " throws LibGuestFSException";
6380 if semicolon then pr ";"
6382 and generate_java_struct typ cols =
6383 generate_header CStyle LGPLv2;
6386 package com.redhat.et.libguestfs;
6389 * Libguestfs %s structure.
6400 | name, `UUID -> pr " public String %s;\n" name
6402 | name, `Int -> pr " public long %s;\n" name
6403 | name, `OptPercent ->
6404 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
6405 pr " public float %s;\n" name
6410 and generate_java_c () =
6411 generate_header CStyle LGPLv2;
6418 #include \"com_redhat_et_libguestfs_GuestFS.h\"
6419 #include \"guestfs.h\"
6421 /* Note that this function returns. The exception is not thrown
6422 * until after the wrapper function returns.
6425 throw_exception (JNIEnv *env, const char *msg)
6428 cl = (*env)->FindClass (env,
6429 \"com/redhat/et/libguestfs/LibGuestFSException\");
6430 (*env)->ThrowNew (env, cl, msg);
6433 JNIEXPORT jlong JNICALL
6434 Java_com_redhat_et_libguestfs_GuestFS__1create
6435 (JNIEnv *env, jobject obj)
6439 g = guestfs_create ();
6441 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
6444 guestfs_set_error_handler (g, NULL, NULL);
6445 return (jlong) (long) g;
6448 JNIEXPORT void JNICALL
6449 Java_com_redhat_et_libguestfs_GuestFS__1close
6450 (JNIEnv *env, jobject obj, jlong jg)
6452 guestfs_h *g = (guestfs_h *) (long) jg;
6459 fun (name, style, _, _, _, _, _) ->
6461 (match fst style with
6462 | RErr -> pr "void ";
6463 | RInt _ -> pr "jint ";
6464 | RInt64 _ -> pr "jlong ";
6465 | RBool _ -> pr "jboolean ";
6466 | RConstString _ | RString _ -> pr "jstring ";
6467 | RIntBool _ | RStat _ | RStatVFS _ | RHashtable _ ->
6469 | RStringList _ | RPVList _ | RVGList _ | RLVList _ ->
6473 pr "Java_com_redhat_et_libguestfs_GuestFS_";
6474 pr "%s" (replace_str ("_" ^ name) "_" "_1");
6476 pr " (JNIEnv *env, jobject obj, jlong jg";
6483 pr ", jstring j%s" n
6485 pr ", jobjectArray j%s" n
6487 pr ", jboolean j%s" n
6493 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
6494 let error_code, no_ret =
6495 match fst style with
6496 | RErr -> pr " int r;\n"; "-1", ""
6498 | RInt _ -> pr " int r;\n"; "-1", "0"
6499 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
6500 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
6502 pr " jstring jr;\n";
6503 pr " char *r;\n"; "NULL", "NULL"
6505 pr " jobjectArray jr;\n";
6508 pr " jstring jstr;\n";
6509 pr " char **r;\n"; "NULL", "NULL"
6511 pr " jobject jr;\n";
6513 pr " jfieldID fl;\n";
6514 pr " struct guestfs_int_bool *r;\n"; "NULL", "NULL"
6516 pr " jobject jr;\n";
6518 pr " jfieldID fl;\n";
6519 pr " struct guestfs_stat *r;\n"; "NULL", "NULL"
6521 pr " jobject jr;\n";
6523 pr " jfieldID fl;\n";
6524 pr " struct guestfs_statvfs *r;\n"; "NULL", "NULL"
6526 pr " jobjectArray jr;\n";
6528 pr " jfieldID fl;\n";
6529 pr " jobject jfl;\n";
6530 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL", "NULL"
6532 pr " jobjectArray jr;\n";
6534 pr " jfieldID fl;\n";
6535 pr " jobject jfl;\n";
6536 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL", "NULL"
6538 pr " jobjectArray jr;\n";
6540 pr " jfieldID fl;\n";
6541 pr " jobject jfl;\n";
6542 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL", "NULL"
6543 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL" in
6550 pr " const char *%s;\n" n
6552 pr " int %s_len;\n" n;
6553 pr " const char **%s;\n" n
6560 (match fst style with
6561 | RStringList _ | RPVList _ | RVGList _ | RLVList _ -> true
6562 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
6563 | RString _ | RIntBool _ | RStat _ | RStatVFS _
6564 | RHashtable _ -> false) ||
6565 List.exists (function StringList _ -> true | _ -> false) (snd style) in
6571 (* Get the parameters. *)
6578 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
6580 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
6581 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
6582 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6583 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6585 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
6587 pr " %s[%s_len] = NULL;\n" n n;
6590 pr " %s = j%s;\n" n n
6593 (* Make the call. *)
6594 pr " r = guestfs_%s " name;
6595 generate_call_args ~handle:"g" (snd style);
6598 (* Release the parameters. *)
6605 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
6607 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6608 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6610 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
6612 pr " free (%s);\n" n
6617 (* Check for errors. *)
6618 pr " if (r == %s) {\n" error_code;
6619 pr " throw_exception (env, guestfs_last_error (g));\n";
6620 pr " return %s;\n" no_ret;
6624 (match fst style with
6626 | RInt _ -> pr " return (jint) r;\n"
6627 | RBool _ -> pr " return (jboolean) r;\n"
6628 | RInt64 _ -> pr " return (jlong) r;\n"
6629 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
6631 pr " jr = (*env)->NewStringUTF (env, r);\n";
6635 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
6636 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
6637 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
6638 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
6639 pr " for (i = 0; i < r_len; ++i) {\n";
6640 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
6641 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
6642 pr " free (r[i]);\n";
6647 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/IntBool\");\n";
6648 pr " jr = (*env)->AllocObject (env, cl);\n";
6649 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"I\");\n";
6650 pr " (*env)->SetIntField (env, jr, fl, r->i);\n";
6651 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"Z\");\n";
6652 pr " (*env)->SetBooleanField (env, jr, fl, r->b);\n";
6653 pr " guestfs_free_int_bool (r);\n";
6656 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/Stat\");\n";
6657 pr " jr = (*env)->AllocObject (env, cl);\n";
6661 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
6663 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
6668 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/StatVFS\");\n";
6669 pr " jr = (*env)->AllocObject (env, cl);\n";
6673 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
6675 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
6680 generate_java_lvm_return "pv" "PV" pv_cols
6682 generate_java_lvm_return "vg" "VG" vg_cols
6684 generate_java_lvm_return "lv" "LV" lv_cols
6687 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
6688 pr " return NULL;\n"
6695 and generate_java_lvm_return typ jtyp cols =
6696 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
6697 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
6698 pr " for (i = 0; i < r->len; ++i) {\n";
6699 pr " jfl = (*env)->AllocObject (env, cl);\n";
6703 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
6704 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
6707 pr " char s[33];\n";
6708 pr " memcpy (s, r->val[i].%s, 32);\n" name;
6710 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
6711 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
6713 | name, (`Bytes|`Int) ->
6714 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
6715 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
6716 | name, `OptPercent ->
6717 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
6718 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
6720 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
6722 pr " guestfs_free_lvm_%s_list (r);\n" typ;
6725 and generate_haskell_hs () =
6726 generate_header HaskellStyle LGPLv2;
6728 (* XXX We only know how to generate partial FFI for Haskell
6729 * at the moment. Please help out!
6731 let can_generate style =
6732 let check_no_bad_args =
6733 List.for_all (function Bool _ | Int _ -> false | _ -> true)
6736 | RErr, args -> check_no_bad_args args
6749 | RHashtable _, _ -> false in
6752 {-# INCLUDE <guestfs.h> #-}
6753 {-# LANGUAGE ForeignFunctionInterface #-}
6758 (* List out the names of the actions we want to export. *)
6760 fun (name, style, _, _, _, _, _) ->
6761 if can_generate style then pr ",\n %s" name
6769 import Control.Exception
6770 import Data.Typeable
6772 data GuestfsS = GuestfsS -- represents the opaque C struct
6773 type GuestfsP = Ptr GuestfsS -- guestfs_h *
6774 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
6776 -- XXX define properly later XXX
6780 data IntBool = IntBool
6782 data StatVFS = StatVFS
6783 data Hashtable = Hashtable
6785 foreign import ccall unsafe \"guestfs_create\" c_create
6787 foreign import ccall unsafe \"&guestfs_close\" c_close
6788 :: FunPtr (GuestfsP -> IO ())
6789 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
6790 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
6792 create :: IO GuestfsH
6795 c_set_error_handler p nullPtr nullPtr
6796 h <- newForeignPtr c_close p
6799 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
6800 :: GuestfsP -> IO CString
6802 -- last_error :: GuestfsH -> IO (Maybe String)
6803 -- last_error h = do
6804 -- str <- withForeignPtr h (\\p -> c_last_error p)
6805 -- maybePeek peekCString str
6807 last_error :: GuestfsH -> IO (String)
6809 str <- withForeignPtr h (\\p -> c_last_error p)
6811 then return \"no error\"
6812 else peekCString str
6816 (* Generate wrappers for each foreign function. *)
6818 fun (name, style, _, _, _, _, _) ->
6819 if can_generate style then (
6820 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
6822 generate_haskell_prototype ~handle:"GuestfsP" style;
6826 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
6828 pr "%s %s = do\n" name
6829 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
6835 | String n -> pr "withCString %s $ \\%s -> " n n
6836 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
6837 | StringList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
6839 (* XXX this doesn't work *)
6841 pr " %s = case %s of\n" n n;
6844 pr " in fromIntegral %s $ \\%s ->\n" n n
6845 | Int n -> pr "fromIntegral %s $ \\%s -> " n n
6847 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
6848 (String.concat " " ("p" :: List.map name_of_argt (snd style)));
6849 (match fst style with
6850 | RErr | RInt _ | RInt64 _ | RBool _ ->
6851 pr " if (r == -1)\n";
6853 pr " err <- last_error h\n";
6855 | RConstString _ | RString _ | RStringList _ | RIntBool _
6856 | RPVList _ | RVGList _ | RLVList _ | RStat _ | RStatVFS _
6858 pr " if (r == nullPtr)\n";
6860 pr " err <- last_error h\n";
6863 (match fst style with
6865 pr " else return ()\n"
6867 pr " else return (fromIntegral r)\n"
6869 pr " else return (fromIntegral r)\n"
6871 pr " else return (toBool r)\n"
6882 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
6888 and generate_haskell_prototype ~handle ?(hs = false) style =
6890 let string = if hs then "String" else "CString" in
6891 let int = if hs then "Int" else "CInt" in
6892 let bool = if hs then "Bool" else "CInt" in
6893 let int64 = if hs then "Integer" else "Int64" in
6897 | String _ -> pr "%s" string
6898 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
6899 | StringList _ -> if hs then pr "[String]" else pr "Ptr CString"
6900 | Bool _ -> pr "%s" bool
6901 | Int _ -> pr "%s" int
6902 | FileIn _ -> pr "%s" string
6903 | FileOut _ -> pr "%s" string
6908 (match fst style with
6909 | RErr -> if not hs then pr "CInt"
6910 | RInt _ -> pr "%s" int
6911 | RInt64 _ -> pr "%s" int64
6912 | RBool _ -> pr "%s" bool
6913 | RConstString _ -> pr "%s" string
6914 | RString _ -> pr "%s" string
6915 | RStringList _ -> pr "[%s]" string
6916 | RIntBool _ -> pr "IntBool"
6917 | RPVList _ -> pr "[PV]"
6918 | RVGList _ -> pr "[VG]"
6919 | RLVList _ -> pr "[LV]"
6920 | RStat _ -> pr "Stat"
6921 | RStatVFS _ -> pr "StatVFS"
6922 | RHashtable _ -> pr "Hashtable"
6926 let output_to filename =
6927 let filename_new = filename ^ ".new" in
6928 chan := open_out filename_new;
6933 (* Is the new file different from the current file? *)
6934 if Sys.file_exists filename && files_equal filename filename_new then
6935 Unix.unlink filename_new (* same, so skip it *)
6937 (* different, overwrite old one *)
6938 (try Unix.chmod filename 0o644 with Unix.Unix_error _ -> ());
6939 Unix.rename filename_new filename;
6940 Unix.chmod filename 0o444;
6941 printf "written %s\n%!" filename;
6950 if not (Sys.file_exists "configure.ac") then (
6952 You are probably running this from the wrong directory.
6953 Run it from the top source directory using the command
6959 let close = output_to "src/guestfs_protocol.x" in
6963 let close = output_to "src/guestfs-structs.h" in
6964 generate_structs_h ();
6967 let close = output_to "src/guestfs-actions.h" in
6968 generate_actions_h ();
6971 let close = output_to "src/guestfs-actions.c" in
6972 generate_client_actions ();
6975 let close = output_to "daemon/actions.h" in
6976 generate_daemon_actions_h ();
6979 let close = output_to "daemon/stubs.c" in
6980 generate_daemon_actions ();
6983 let close = output_to "tests.c" in
6987 let close = output_to "fish/cmds.c" in
6988 generate_fish_cmds ();
6991 let close = output_to "fish/completion.c" in
6992 generate_fish_completion ();
6995 let close = output_to "guestfs-structs.pod" in
6996 generate_structs_pod ();
6999 let close = output_to "guestfs-actions.pod" in
7000 generate_actions_pod ();
7003 let close = output_to "guestfish-actions.pod" in
7004 generate_fish_actions_pod ();
7007 let close = output_to "ocaml/guestfs.mli" in
7008 generate_ocaml_mli ();
7011 let close = output_to "ocaml/guestfs.ml" in
7012 generate_ocaml_ml ();
7015 let close = output_to "ocaml/guestfs_c_actions.c" in
7016 generate_ocaml_c ();
7019 let close = output_to "perl/Guestfs.xs" in
7020 generate_perl_xs ();
7023 let close = output_to "perl/lib/Sys/Guestfs.pm" in
7024 generate_perl_pm ();
7027 let close = output_to "python/guestfs-py.c" in
7028 generate_python_c ();
7031 let close = output_to "python/guestfs.py" in
7032 generate_python_py ();
7035 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
7039 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
7040 generate_java_java ();
7043 let close = output_to "java/com/redhat/et/libguestfs/PV.java" in
7044 generate_java_struct "PV" pv_cols;
7047 let close = output_to "java/com/redhat/et/libguestfs/VG.java" in
7048 generate_java_struct "VG" vg_cols;
7051 let close = output_to "java/com/redhat/et/libguestfs/LV.java" in
7052 generate_java_struct "LV" lv_cols;
7055 let close = output_to "java/com/redhat/et/libguestfs/Stat.java" in
7056 generate_java_struct "Stat" stat_cols;
7059 let close = output_to "java/com/redhat/et/libguestfs/StatVFS.java" in
7060 generate_java_struct "StatVFS" statvfs_cols;
7063 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in
7067 let close = output_to "haskell/Guestfs.hs" in
7068 generate_haskell_hs ();