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 umount-all and lvm-remove-all (except InitNone).
141 * Don't assume anything about the previous contents of the block
142 * devices. Use 'Init*' to create some initial scenarios.
144 type tests = (test_init * test) list
146 (* Run the command sequence and just expect nothing to fail. *)
148 (* Run the command sequence and expect the output of the final
149 * command to be the string.
151 | TestOutput of seq * string
152 (* Run the command sequence and expect the output of the final
153 * command to be the list of strings.
155 | TestOutputList of seq * string list
156 (* Run the command sequence and expect the output of the final
157 * command to be the integer.
159 | TestOutputInt of seq * int
160 (* Run the command sequence and expect the output of the final
161 * command to be a true value (!= 0 or != NULL).
163 | TestOutputTrue of seq
164 (* Run the command sequence and expect the output of the final
165 * command to be a false value (== 0 or == NULL, but not an error).
167 | TestOutputFalse of seq
168 (* Run the command sequence and expect the output of the final
169 * command to be a list of the given length (but don't care about
172 | TestOutputLength of seq * int
173 (* Run the command sequence and expect the output of the final
174 * command to be a structure.
176 | TestOutputStruct of seq * test_field_compare list
177 (* Run the command sequence and expect the final command (only)
180 | TestLastFail of seq
182 and test_field_compare =
183 | CompareWithInt of string * int
184 | CompareWithString of string * string
185 | CompareFieldsIntEq of string * string
186 | CompareFieldsStrEq of string * string
188 (* Some initial scenarios for testing. *)
190 (* Do nothing, block devices could contain random stuff including
191 * LVM PVs, and some filesystems might be mounted. This is usually
195 (* Block devices are empty and no filesystems are mounted. *)
197 (* /dev/sda contains a single partition /dev/sda1, which is formatted
198 * as ext2, empty [except for lost+found] and mounted on /.
199 * /dev/sdb and /dev/sdc may have random content.
204 * /dev/sda1 (is a PV):
205 * /dev/VG/LV (size 8MB):
206 * formatted as ext2, empty [except for lost+found], mounted on /
207 * /dev/sdb and /dev/sdc may have random content.
211 (* Sequence of commands for testing. *)
213 and cmd = string list
215 (* Note about long descriptions: When referring to another
216 * action, use the format C<guestfs_other> (ie. the full name of
217 * the C function). This will be replaced as appropriate in other
220 * Apart from that, long descriptions are just perldoc paragraphs.
223 let non_daemon_functions = [
224 ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
226 "launch the qemu subprocess",
228 Internally libguestfs is implemented by running a virtual machine
231 You should call this after configuring the handle
232 (eg. adding drives) but before performing any actions.");
234 ("wait_ready", (RErr, []), -1, [NotInFish],
236 "wait until the qemu subprocess launches",
238 Internally libguestfs is implemented by running a virtual machine
241 You should call this after C<guestfs_launch> to wait for the launch
244 ("kill_subprocess", (RErr, []), -1, [],
246 "kill the qemu subprocess",
248 This kills the qemu subprocess. You should never need to call this.");
250 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
252 "add an image to examine or modify",
254 This function adds a virtual machine disk image C<filename> to the
255 guest. The first time you call this function, the disk appears as IDE
256 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
259 You don't necessarily need to be root when using libguestfs. However
260 you obviously do need sufficient permissions to access the filename
261 for whatever operations you want to perform (ie. read access if you
262 just want to read the image or write access if you want to modify the
265 This is equivalent to the qemu parameter C<-drive file=filename>.");
267 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
269 "add a CD-ROM disk image to examine",
271 This function adds a virtual CD-ROM disk image to the guest.
273 This is equivalent to the qemu parameter C<-cdrom filename>.");
275 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
277 "add qemu parameters",
279 This can be used to add arbitrary qemu command line parameters
280 of the form C<-param value>. Actually it's not quite arbitrary - we
281 prevent you from setting some parameters which would interfere with
282 parameters that we use.
284 The first character of C<param> string must be a C<-> (dash).
286 C<value> can be NULL.");
288 ("set_qemu", (RErr, [String "qemu"]), -1, [FishAlias "qemu"],
290 "set the qemu binary",
292 Set the qemu binary that we will use.
294 The default is chosen when the library was compiled by the
297 You can also override this by setting the C<LIBGUESTFS_QEMU>
298 environment variable.
300 The string C<qemu> is stashed in the libguestfs handle, so the caller
301 must make sure it remains valid for the lifetime of the handle.
303 Setting C<qemu> to C<NULL> restores the default qemu binary.");
305 ("get_qemu", (RConstString "qemu", []), -1, [],
307 "get the qemu binary",
309 Return the current qemu binary.
311 This is always non-NULL. If it wasn't set already, then this will
312 return the default qemu binary name.");
314 ("set_path", (RErr, [String "path"]), -1, [FishAlias "path"],
316 "set the search path",
318 Set the path that libguestfs searches for kernel and initrd.img.
320 The default is C<$libdir/guestfs> unless overridden by setting
321 C<LIBGUESTFS_PATH> environment variable.
323 The string C<path> is stashed in the libguestfs handle, so the caller
324 must make sure it remains valid for the lifetime of the handle.
326 Setting C<path> to C<NULL> restores the default path.");
328 ("get_path", (RConstString "path", []), -1, [],
330 "get the search path",
332 Return the current search path.
334 This is always non-NULL. If it wasn't set already, then this will
335 return the default path.");
337 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
341 If C<autosync> is true, this enables autosync. Libguestfs will make a
342 best effort attempt to run C<guestfs_umount_all> followed by
343 C<guestfs_sync> when the handle is closed
344 (also if the program exits without closing handles).
346 This is disabled by default (except in guestfish where it is
347 enabled by default).");
349 ("get_autosync", (RBool "autosync", []), -1, [],
353 Get the autosync flag.");
355 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
359 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
361 Verbose messages are disabled unless the environment variable
362 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
364 ("get_verbose", (RBool "verbose", []), -1, [],
368 This returns the verbose messages flag.");
370 ("is_ready", (RBool "ready", []), -1, [],
372 "is ready to accept commands",
374 This returns true iff this handle is ready to accept commands
375 (in the C<READY> state).
377 For more information on states, see L<guestfs(3)>.");
379 ("is_config", (RBool "config", []), -1, [],
381 "is in configuration state",
383 This returns true iff this handle is being configured
384 (in the C<CONFIG> state).
386 For more information on states, see L<guestfs(3)>.");
388 ("is_launching", (RBool "launching", []), -1, [],
390 "is launching subprocess",
392 This returns true iff this handle is launching the subprocess
393 (in the C<LAUNCHING> state).
395 For more information on states, see L<guestfs(3)>.");
397 ("is_busy", (RBool "busy", []), -1, [],
399 "is busy processing a command",
401 This returns true iff this handle is busy processing a command
402 (in the C<BUSY> state).
404 For more information on states, see L<guestfs(3)>.");
406 ("get_state", (RInt "state", []), -1, [],
408 "get the current state",
410 This returns the current state as an opaque integer. This is
411 only useful for printing debug and internal error messages.
413 For more information on states, see L<guestfs(3)>.");
415 ("set_busy", (RErr, []), -1, [NotInFish],
419 This sets the state to C<BUSY>. This is only used when implementing
420 actions using the low-level API.
422 For more information on states, see L<guestfs(3)>.");
424 ("set_ready", (RErr, []), -1, [NotInFish],
426 "set state to ready",
428 This sets the state to C<READY>. This is only used when implementing
429 actions using the low-level API.
431 For more information on states, see L<guestfs(3)>.");
435 let daemon_functions = [
436 ("mount", (RErr, [String "device"; String "mountpoint"]), 1, [],
437 [InitEmpty, TestOutput (
438 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
439 ["mkfs"; "ext2"; "/dev/sda1"];
440 ["mount"; "/dev/sda1"; "/"];
441 ["write_file"; "/new"; "new file contents"; "0"];
442 ["cat"; "/new"]], "new file contents")],
443 "mount a guest disk at a position in the filesystem",
445 Mount a guest disk at a position in the filesystem. Block devices
446 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
447 the guest. If those block devices contain partitions, they will have
448 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
451 The rules are the same as for L<mount(2)>: A filesystem must
452 first be mounted on C</> before others can be mounted. Other
453 filesystems can only be mounted on directories which already
456 The mounted filesystem is writable, if we have sufficient permissions
457 on the underlying device.
459 The filesystem options C<sync> and C<noatime> are set with this
460 call, in order to improve reliability.");
462 ("sync", (RErr, []), 2, [],
463 [ InitEmpty, TestRun [["sync"]]],
464 "sync disks, writes are flushed through to the disk image",
466 This syncs the disk, so that any writes are flushed through to the
467 underlying disk image.
469 You should always call this if you have modified a disk image, before
470 closing the handle.");
472 ("touch", (RErr, [String "path"]), 3, [],
473 [InitBasicFS, TestOutputTrue (
475 ["exists"; "/new"]])],
476 "update file timestamps or create a new file",
478 Touch acts like the L<touch(1)> command. It can be used to
479 update the timestamps on a file, or, if the file does not exist,
480 to create a new zero-length file.");
482 ("cat", (RString "content", [String "path"]), 4, [ProtocolLimitWarning],
483 [InitBasicFS, TestOutput (
484 [["write_file"; "/new"; "new file contents"; "0"];
485 ["cat"; "/new"]], "new file contents")],
486 "list the contents of a file",
488 Return the contents of the file named C<path>.
490 Note that this function cannot correctly handle binary files
491 (specifically, files containing C<\\0> character which is treated
492 as end of string). For those you need to use the C<guestfs_download>
493 function which has a more complex interface.");
495 ("ll", (RString "listing", [String "directory"]), 5, [],
496 [], (* XXX Tricky to test because it depends on the exact format
497 * of the 'ls -l' command, which changes between F10 and F11.
499 "list the files in a directory (long format)",
501 List the files in C<directory> (relative to the root directory,
502 there is no cwd) in the format of 'ls -la'.
504 This command is mostly useful for interactive sessions. It
505 is I<not> intended that you try to parse the output string.");
507 ("ls", (RStringList "listing", [String "directory"]), 6, [],
508 [InitBasicFS, TestOutputList (
511 ["touch"; "/newest"];
512 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
513 "list the files in a directory",
515 List the files in C<directory> (relative to the root directory,
516 there is no cwd). The '.' and '..' entries are not returned, but
517 hidden files are shown.
519 This command is mostly useful for interactive sessions. Programs
520 should probably use C<guestfs_readdir> instead.");
522 ("list_devices", (RStringList "devices", []), 7, [],
523 [InitEmpty, TestOutputList (
524 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"])],
525 "list the block devices",
527 List all the block devices.
529 The full block device names are returned, eg. C</dev/sda>");
531 ("list_partitions", (RStringList "partitions", []), 8, [],
532 [InitBasicFS, TestOutputList (
533 [["list_partitions"]], ["/dev/sda1"]);
534 InitEmpty, TestOutputList (
535 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
536 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
537 "list the partitions",
539 List all the partitions detected on all block devices.
541 The full partition device names are returned, eg. C</dev/sda1>
543 This does not return logical volumes. For that you will need to
544 call C<guestfs_lvs>.");
546 ("pvs", (RStringList "physvols", []), 9, [],
547 [InitBasicFSonLVM, TestOutputList (
548 [["pvs"]], ["/dev/sda1"]);
549 InitEmpty, TestOutputList (
550 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
551 ["pvcreate"; "/dev/sda1"];
552 ["pvcreate"; "/dev/sda2"];
553 ["pvcreate"; "/dev/sda3"];
554 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
555 "list the LVM physical volumes (PVs)",
557 List all the physical volumes detected. This is the equivalent
558 of the L<pvs(8)> command.
560 This returns a list of just the device names that contain
561 PVs (eg. C</dev/sda2>).
563 See also C<guestfs_pvs_full>.");
565 ("vgs", (RStringList "volgroups", []), 10, [],
566 [InitBasicFSonLVM, TestOutputList (
568 InitEmpty, TestOutputList (
569 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
570 ["pvcreate"; "/dev/sda1"];
571 ["pvcreate"; "/dev/sda2"];
572 ["pvcreate"; "/dev/sda3"];
573 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
574 ["vgcreate"; "VG2"; "/dev/sda3"];
575 ["vgs"]], ["VG1"; "VG2"])],
576 "list the LVM volume groups (VGs)",
578 List all the volumes groups detected. This is the equivalent
579 of the L<vgs(8)> command.
581 This returns a list of just the volume group names that were
582 detected (eg. C<VolGroup00>).
584 See also C<guestfs_vgs_full>.");
586 ("lvs", (RStringList "logvols", []), 11, [],
587 [InitBasicFSonLVM, TestOutputList (
588 [["lvs"]], ["/dev/VG/LV"]);
589 InitEmpty, TestOutputList (
590 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
591 ["pvcreate"; "/dev/sda1"];
592 ["pvcreate"; "/dev/sda2"];
593 ["pvcreate"; "/dev/sda3"];
594 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
595 ["vgcreate"; "VG2"; "/dev/sda3"];
596 ["lvcreate"; "LV1"; "VG1"; "50"];
597 ["lvcreate"; "LV2"; "VG1"; "50"];
598 ["lvcreate"; "LV3"; "VG2"; "50"];
599 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
600 "list the LVM logical volumes (LVs)",
602 List all the logical volumes detected. This is the equivalent
603 of the L<lvs(8)> command.
605 This returns a list of the logical volume device names
606 (eg. C</dev/VolGroup00/LogVol00>).
608 See also C<guestfs_lvs_full>.");
610 ("pvs_full", (RPVList "physvols", []), 12, [],
611 [], (* XXX how to test? *)
612 "list the LVM physical volumes (PVs)",
614 List all the physical volumes detected. This is the equivalent
615 of the L<pvs(8)> command. The \"full\" version includes all fields.");
617 ("vgs_full", (RVGList "volgroups", []), 13, [],
618 [], (* XXX how to test? *)
619 "list the LVM volume groups (VGs)",
621 List all the volumes groups detected. This is the equivalent
622 of the L<vgs(8)> command. The \"full\" version includes all fields.");
624 ("lvs_full", (RLVList "logvols", []), 14, [],
625 [], (* XXX how to test? *)
626 "list the LVM logical volumes (LVs)",
628 List all the logical volumes detected. This is the equivalent
629 of the L<lvs(8)> command. The \"full\" version includes all fields.");
631 ("read_lines", (RStringList "lines", [String "path"]), 15, [],
632 [InitBasicFS, TestOutputList (
633 [["write_file"; "/new"; "line1\r\nline2\nline3"; "0"];
634 ["read_lines"; "/new"]], ["line1"; "line2"; "line3"]);
635 InitBasicFS, TestOutputList (
636 [["write_file"; "/new"; ""; "0"];
637 ["read_lines"; "/new"]], [])],
638 "read file as lines",
640 Return the contents of the file named C<path>.
642 The file contents are returned as a list of lines. Trailing
643 C<LF> and C<CRLF> character sequences are I<not> returned.
645 Note that this function cannot correctly handle binary files
646 (specifically, files containing C<\\0> character which is treated
647 as end of line). For those you need to use the C<guestfs_read_file>
648 function which has a more complex interface.");
650 ("aug_init", (RErr, [String "root"; Int "flags"]), 16, [],
651 [], (* XXX Augeas code needs tests. *)
652 "create a new Augeas handle",
654 Create a new Augeas handle for editing configuration files.
655 If there was any previous Augeas handle associated with this
656 guestfs session, then it is closed.
658 You must call this before using any other C<guestfs_aug_*>
661 C<root> is the filesystem root. C<root> must not be NULL,
664 The flags are the same as the flags defined in
665 E<lt>augeas.hE<gt>, the logical I<or> of the following
670 =item C<AUG_SAVE_BACKUP> = 1
672 Keep the original file with a C<.augsave> extension.
674 =item C<AUG_SAVE_NEWFILE> = 2
676 Save changes into a file with extension C<.augnew>, and
677 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
679 =item C<AUG_TYPE_CHECK> = 4
681 Typecheck lenses (can be expensive).
683 =item C<AUG_NO_STDINC> = 8
685 Do not use standard load path for modules.
687 =item C<AUG_SAVE_NOOP> = 16
689 Make save a no-op, just record what would have been changed.
691 =item C<AUG_NO_LOAD> = 32
693 Do not load the tree in C<guestfs_aug_init>.
697 To close the handle, you can call C<guestfs_aug_close>.
699 To find out more about Augeas, see L<http://augeas.net/>.");
701 ("aug_close", (RErr, []), 26, [],
702 [], (* XXX Augeas code needs tests. *)
703 "close the current Augeas handle",
705 Close the current Augeas handle and free up any resources
706 used by it. After calling this, you have to call
707 C<guestfs_aug_init> again before you can use any other
710 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [],
711 [], (* XXX Augeas code needs tests. *)
712 "define an Augeas variable",
714 Defines an Augeas variable C<name> whose value is the result
715 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
718 On success this returns the number of nodes in C<expr>, or
719 C<0> if C<expr> evaluates to something which is not a nodeset.");
721 ("aug_defnode", (RIntBool ("nrnodes", "created"), [String "name"; String "expr"; String "val"]), 18, [],
722 [], (* XXX Augeas code needs tests. *)
723 "define an Augeas node",
725 Defines a variable C<name> whose value is the result of
728 If C<expr> evaluates to an empty nodeset, a node is created,
729 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
730 C<name> will be the nodeset containing that single node.
732 On success this returns a pair containing the
733 number of nodes in the nodeset, and a boolean flag
734 if a node was created.");
736 ("aug_get", (RString "val", [String "path"]), 19, [],
737 [], (* XXX Augeas code needs tests. *)
738 "look up the value of an Augeas path",
740 Look up the value associated with C<path>. If C<path>
741 matches exactly one node, the C<value> is returned.");
743 ("aug_set", (RErr, [String "path"; String "val"]), 20, [],
744 [], (* XXX Augeas code needs tests. *)
745 "set Augeas path to value",
747 Set the value associated with C<path> to C<value>.");
749 ("aug_insert", (RErr, [String "path"; String "label"; Bool "before"]), 21, [],
750 [], (* XXX Augeas code needs tests. *)
751 "insert a sibling Augeas node",
753 Create a new sibling C<label> for C<path>, inserting it into
754 the tree before or after C<path> (depending on the boolean
757 C<path> must match exactly one existing node in the tree, and
758 C<label> must be a label, ie. not contain C</>, C<*> or end
759 with a bracketed index C<[N]>.");
761 ("aug_rm", (RInt "nrnodes", [String "path"]), 22, [],
762 [], (* XXX Augeas code needs tests. *)
763 "remove an Augeas path",
765 Remove C<path> and all of its children.
767 On success this returns the number of entries which were removed.");
769 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [],
770 [], (* XXX Augeas code needs tests. *)
773 Move the node C<src> to C<dest>. C<src> must match exactly
774 one node. C<dest> is overwritten if it exists.");
776 ("aug_match", (RStringList "matches", [String "path"]), 24, [],
777 [], (* XXX Augeas code needs tests. *)
778 "return Augeas nodes which match path",
780 Returns a list of paths which match the path expression C<path>.
781 The returned paths are sufficiently qualified so that they match
782 exactly one node in the current tree.");
784 ("aug_save", (RErr, []), 25, [],
785 [], (* XXX Augeas code needs tests. *)
786 "write all pending Augeas changes to disk",
788 This writes all pending changes to disk.
790 The flags which were passed to C<guestfs_aug_init> affect exactly
791 how files are saved.");
793 ("aug_load", (RErr, []), 27, [],
794 [], (* XXX Augeas code needs tests. *)
795 "load files into the tree",
797 Load files into the tree.
799 See C<aug_load> in the Augeas documentation for the full gory
802 ("aug_ls", (RStringList "matches", [String "path"]), 28, [],
803 [], (* XXX Augeas code needs tests. *)
804 "list Augeas nodes under a path",
806 This is just a shortcut for listing C<guestfs_aug_match>
807 C<path/*> and sorting the resulting nodes into alphabetical order.");
809 ("rm", (RErr, [String "path"]), 29, [],
810 [InitBasicFS, TestRun
813 InitBasicFS, TestLastFail
815 InitBasicFS, TestLastFail
820 Remove the single file C<path>.");
822 ("rmdir", (RErr, [String "path"]), 30, [],
823 [InitBasicFS, TestRun
826 InitBasicFS, TestLastFail
828 InitBasicFS, TestLastFail
831 "remove a directory",
833 Remove the single directory C<path>.");
835 ("rm_rf", (RErr, [String "path"]), 31, [],
836 [InitBasicFS, TestOutputFalse
838 ["mkdir"; "/new/foo"];
839 ["touch"; "/new/foo/bar"];
841 ["exists"; "/new"]]],
842 "remove a file or directory recursively",
844 Remove the file or directory C<path>, recursively removing the
845 contents if its a directory. This is like the C<rm -rf> shell
848 ("mkdir", (RErr, [String "path"]), 32, [],
849 [InitBasicFS, TestOutputTrue
852 InitBasicFS, TestLastFail
853 [["mkdir"; "/new/foo/bar"]]],
854 "create a directory",
856 Create a directory named C<path>.");
858 ("mkdir_p", (RErr, [String "path"]), 33, [],
859 [InitBasicFS, TestOutputTrue
860 [["mkdir_p"; "/new/foo/bar"];
861 ["is_dir"; "/new/foo/bar"]];
862 InitBasicFS, TestOutputTrue
863 [["mkdir_p"; "/new/foo/bar"];
864 ["is_dir"; "/new/foo"]];
865 InitBasicFS, TestOutputTrue
866 [["mkdir_p"; "/new/foo/bar"];
867 ["is_dir"; "/new"]]],
868 "create a directory and parents",
870 Create a directory named C<path>, creating any parent directories
871 as necessary. This is like the C<mkdir -p> shell command.");
873 ("chmod", (RErr, [Int "mode"; String "path"]), 34, [],
874 [], (* XXX Need stat command to test *)
877 Change the mode (permissions) of C<path> to C<mode>. Only
878 numeric modes are supported.");
880 ("chown", (RErr, [Int "owner"; Int "group"; String "path"]), 35, [],
881 [], (* XXX Need stat command to test *)
882 "change file owner and group",
884 Change the file owner to C<owner> and group to C<group>.
886 Only numeric uid and gid are supported. If you want to use
887 names, you will need to locate and parse the password file
888 yourself (Augeas support makes this relatively easy).");
890 ("exists", (RBool "existsflag", [String "path"]), 36, [],
891 [InitBasicFS, TestOutputTrue (
893 ["exists"; "/new"]]);
894 InitBasicFS, TestOutputTrue (
896 ["exists"; "/new"]])],
897 "test if file or directory exists",
899 This returns C<true> if and only if there is a file, directory
900 (or anything) with the given C<path> name.
902 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
904 ("is_file", (RBool "fileflag", [String "path"]), 37, [],
905 [InitBasicFS, TestOutputTrue (
907 ["is_file"; "/new"]]);
908 InitBasicFS, TestOutputFalse (
910 ["is_file"; "/new"]])],
911 "test if file exists",
913 This returns C<true> if and only if there is a file
914 with the given C<path> name. Note that it returns false for
915 other objects like directories.
917 See also C<guestfs_stat>.");
919 ("is_dir", (RBool "dirflag", [String "path"]), 38, [],
920 [InitBasicFS, TestOutputFalse (
922 ["is_dir"; "/new"]]);
923 InitBasicFS, TestOutputTrue (
925 ["is_dir"; "/new"]])],
926 "test if file exists",
928 This returns C<true> if and only if there is a directory
929 with the given C<path> name. Note that it returns false for
930 other objects like files.
932 See also C<guestfs_stat>.");
934 ("pvcreate", (RErr, [String "device"]), 39, [],
935 [InitEmpty, TestOutputList (
936 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
937 ["pvcreate"; "/dev/sda1"];
938 ["pvcreate"; "/dev/sda2"];
939 ["pvcreate"; "/dev/sda3"];
940 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
941 "create an LVM physical volume",
943 This creates an LVM physical volume on the named C<device>,
944 where C<device> should usually be a partition name such
947 ("vgcreate", (RErr, [String "volgroup"; StringList "physvols"]), 40, [],
948 [InitEmpty, TestOutputList (
949 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
950 ["pvcreate"; "/dev/sda1"];
951 ["pvcreate"; "/dev/sda2"];
952 ["pvcreate"; "/dev/sda3"];
953 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
954 ["vgcreate"; "VG2"; "/dev/sda3"];
955 ["vgs"]], ["VG1"; "VG2"])],
956 "create an LVM volume group",
958 This creates an LVM volume group called C<volgroup>
959 from the non-empty list of physical volumes C<physvols>.");
961 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [],
962 [InitEmpty, TestOutputList (
963 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
964 ["pvcreate"; "/dev/sda1"];
965 ["pvcreate"; "/dev/sda2"];
966 ["pvcreate"; "/dev/sda3"];
967 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
968 ["vgcreate"; "VG2"; "/dev/sda3"];
969 ["lvcreate"; "LV1"; "VG1"; "50"];
970 ["lvcreate"; "LV2"; "VG1"; "50"];
971 ["lvcreate"; "LV3"; "VG2"; "50"];
972 ["lvcreate"; "LV4"; "VG2"; "50"];
973 ["lvcreate"; "LV5"; "VG2"; "50"];
975 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
976 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
977 "create an LVM volume group",
979 This creates an LVM volume group called C<logvol>
980 on the volume group C<volgroup>, with C<size> megabytes.");
982 ("mkfs", (RErr, [String "fstype"; String "device"]), 42, [],
983 [InitEmpty, TestOutput (
984 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
985 ["mkfs"; "ext2"; "/dev/sda1"];
986 ["mount"; "/dev/sda1"; "/"];
987 ["write_file"; "/new"; "new file contents"; "0"];
988 ["cat"; "/new"]], "new file contents")],
991 This creates a filesystem on C<device> (usually a partition
992 of LVM logical volume). The filesystem type is C<fstype>, for
995 ("sfdisk", (RErr, [String "device";
996 Int "cyls"; Int "heads"; Int "sectors";
997 StringList "lines"]), 43, [DangerWillRobinson],
999 "create partitions on a block device",
1001 This is a direct interface to the L<sfdisk(8)> program for creating
1002 partitions on block devices.
1004 C<device> should be a block device, for example C</dev/sda>.
1006 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1007 and sectors on the device, which are passed directly to sfdisk as
1008 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1009 of these, then the corresponding parameter is omitted. Usually for
1010 'large' disks, you can just pass C<0> for these, but for small
1011 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1012 out the right geometry and you will need to tell it.
1014 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1015 information refer to the L<sfdisk(8)> manpage.
1017 To create a single partition occupying the whole disk, you would
1018 pass C<lines> as a single element list, when the single element being
1019 the string C<,> (comma).");
1021 ("write_file", (RErr, [String "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1022 [InitBasicFS, TestOutput (
1023 [["write_file"; "/new"; "new file contents"; "0"];
1024 ["cat"; "/new"]], "new file contents");
1025 InitBasicFS, TestOutput (
1026 [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1027 ["cat"; "/new"]], "\nnew file contents\n");
1028 InitBasicFS, TestOutput (
1029 [["write_file"; "/new"; "\n\n"; "0"];
1030 ["cat"; "/new"]], "\n\n");
1031 InitBasicFS, TestOutput (
1032 [["write_file"; "/new"; ""; "0"];
1033 ["cat"; "/new"]], "");
1034 InitBasicFS, TestOutput (
1035 [["write_file"; "/new"; "\n\n\n"; "0"];
1036 ["cat"; "/new"]], "\n\n\n");
1037 InitBasicFS, TestOutput (
1038 [["write_file"; "/new"; "\n"; "0"];
1039 ["cat"; "/new"]], "\n")],
1042 This call creates a file called C<path>. The contents of the
1043 file is the string C<content> (which can contain any 8 bit data),
1044 with length C<size>.
1046 As a special case, if C<size> is C<0>
1047 then the length is calculated using C<strlen> (so in this case
1048 the content cannot contain embedded ASCII NULs).");
1050 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1051 [InitEmpty, TestOutputList (
1052 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1053 ["mkfs"; "ext2"; "/dev/sda1"];
1054 ["mount"; "/dev/sda1"; "/"];
1055 ["mounts"]], ["/dev/sda1"]);
1056 InitEmpty, TestOutputList (
1057 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1058 ["mkfs"; "ext2"; "/dev/sda1"];
1059 ["mount"; "/dev/sda1"; "/"];
1062 "unmount a filesystem",
1064 This unmounts the given filesystem. The filesystem may be
1065 specified either by its mountpoint (path) or the device which
1066 contains the filesystem.");
1068 ("mounts", (RStringList "devices", []), 46, [],
1069 [InitBasicFS, TestOutputList (
1070 [["mounts"]], ["/dev/sda1"])],
1071 "show mounted filesystems",
1073 This returns the list of currently mounted filesystems. It returns
1074 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1076 Some internal mounts are not shown.");
1078 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1079 [InitBasicFS, TestOutputList (
1082 (* check that umount_all can unmount nested mounts correctly: *)
1083 InitEmpty, TestOutputList (
1084 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1085 ["mkfs"; "ext2"; "/dev/sda1"];
1086 ["mkfs"; "ext2"; "/dev/sda2"];
1087 ["mkfs"; "ext2"; "/dev/sda3"];
1088 ["mount"; "/dev/sda1"; "/"];
1090 ["mount"; "/dev/sda2"; "/mp1"];
1091 ["mkdir"; "/mp1/mp2"];
1092 ["mount"; "/dev/sda3"; "/mp1/mp2"];
1093 ["mkdir"; "/mp1/mp2/mp3"];
1096 "unmount all filesystems",
1098 This unmounts all mounted filesystems.
1100 Some internal mounts are not unmounted by this call.");
1102 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson],
1104 "remove all LVM LVs, VGs and PVs",
1106 This command removes all LVM logical volumes, volume groups
1107 and physical volumes.");
1109 ("file", (RString "description", [String "path"]), 49, [],
1110 [InitBasicFS, TestOutput (
1112 ["file"; "/new"]], "empty");
1113 InitBasicFS, TestOutput (
1114 [["write_file"; "/new"; "some content\n"; "0"];
1115 ["file"; "/new"]], "ASCII text");
1116 InitBasicFS, TestLastFail (
1117 [["file"; "/nofile"]])],
1118 "determine file type",
1120 This call uses the standard L<file(1)> command to determine
1121 the type or contents of the file. This also works on devices,
1122 for example to find out whether a partition contains a filesystem.
1124 The exact command which runs is C<file -bsL path>. Note in
1125 particular that the filename is not prepended to the output
1126 (the C<-b> option).");
1128 ("command", (RString "output", [StringList "arguments"]), 50, [],
1129 [], (* XXX how to test? *)
1130 "run a command from the guest filesystem",
1132 This call runs a command from the guest filesystem. The
1133 filesystem must be mounted, and must contain a compatible
1134 operating system (ie. something Linux, with the same
1135 or compatible processor architecture).
1137 The single parameter is an argv-style list of arguments.
1138 The first element is the name of the program to run.
1139 Subsequent elements are parameters. The list must be
1140 non-empty (ie. must contain a program name).
1142 The C<$PATH> environment variable will contain at least
1143 C</usr/bin> and C</bin>. If you require a program from
1144 another location, you should provide the full path in the
1147 Shared libraries and data files required by the program
1148 must be available on filesystems which are mounted in the
1149 correct places. It is the caller's responsibility to ensure
1150 all filesystems that are needed are mounted at the right
1153 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [],
1154 [], (* XXX how to test? *)
1155 "run a command, returning lines",
1157 This is the same as C<guestfs_command>, but splits the
1158 result into a list of lines.");
1160 ("stat", (RStat "statbuf", [String "path"]), 52, [],
1161 [InitBasicFS, TestOutputStruct (
1163 ["stat"; "/new"]], [CompareWithInt ("size", 0)])],
1164 "get file information",
1166 Returns file information for the given C<path>.
1168 This is the same as the C<stat(2)> system call.");
1170 ("lstat", (RStat "statbuf", [String "path"]), 53, [],
1171 [InitBasicFS, TestOutputStruct (
1173 ["lstat"; "/new"]], [CompareWithInt ("size", 0)])],
1174 "get file information for a symbolic link",
1176 Returns file information for the given C<path>.
1178 This is the same as C<guestfs_stat> except that if C<path>
1179 is a symbolic link, then the link is stat-ed, not the file it
1182 This is the same as the C<lstat(2)> system call.");
1184 ("statvfs", (RStatVFS "statbuf", [String "path"]), 54, [],
1185 [InitBasicFS, TestOutputStruct (
1186 [["statvfs"; "/"]], [CompareWithInt ("bfree", 487702);
1187 CompareWithInt ("blocks", 490020);
1188 CompareWithInt ("bsize", 1024)])],
1189 "get file system statistics",
1191 Returns file system statistics for any mounted file system.
1192 C<path> should be a file or directory in the mounted file system
1193 (typically it is the mount point itself, but it doesn't need to be).
1195 This is the same as the C<statvfs(2)> system call.");
1197 ("tune2fs_l", (RHashtable "superblock", [String "device"]), 55, [],
1199 "get ext2/ext3/ext4 superblock details",
1201 This returns the contents of the ext2, ext3 or ext4 filesystem
1202 superblock on C<device>.
1204 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1205 manpage for more details. The list of fields returned isn't
1206 clearly defined, and depends on both the version of C<tune2fs>
1207 that libguestfs was built against, and the filesystem itself.");
1209 ("blockdev_setro", (RErr, [String "device"]), 56, [],
1210 [InitEmpty, TestOutputTrue (
1211 [["blockdev_setro"; "/dev/sda"];
1212 ["blockdev_getro"; "/dev/sda"]])],
1213 "set block device to read-only",
1215 Sets the block device named C<device> to read-only.
1217 This uses the L<blockdev(8)> command.");
1219 ("blockdev_setrw", (RErr, [String "device"]), 57, [],
1220 [InitEmpty, TestOutputFalse (
1221 [["blockdev_setrw"; "/dev/sda"];
1222 ["blockdev_getro"; "/dev/sda"]])],
1223 "set block device to read-write",
1225 Sets the block device named C<device> to read-write.
1227 This uses the L<blockdev(8)> command.");
1229 ("blockdev_getro", (RBool "ro", [String "device"]), 58, [],
1230 [InitEmpty, TestOutputTrue (
1231 [["blockdev_setro"; "/dev/sda"];
1232 ["blockdev_getro"; "/dev/sda"]])],
1233 "is block device set to read-only",
1235 Returns a boolean indicating if the block device is read-only
1236 (true if read-only, false if not).
1238 This uses the L<blockdev(8)> command.");
1240 ("blockdev_getss", (RInt "sectorsize", [String "device"]), 59, [],
1241 [InitEmpty, TestOutputInt (
1242 [["blockdev_getss"; "/dev/sda"]], 512)],
1243 "get sectorsize of block device",
1245 This returns the size of sectors on a block device.
1246 Usually 512, but can be larger for modern devices.
1248 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1251 This uses the L<blockdev(8)> command.");
1253 ("blockdev_getbsz", (RInt "blocksize", [String "device"]), 60, [],
1254 [InitEmpty, TestOutputInt (
1255 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1256 "get blocksize of block device",
1258 This returns the block size of a device.
1260 (Note this is different from both I<size in blocks> and
1261 I<filesystem block size>).
1263 This uses the L<blockdev(8)> command.");
1265 ("blockdev_setbsz", (RErr, [String "device"; Int "blocksize"]), 61, [],
1267 "set blocksize of block device",
1269 This sets the block size of a device.
1271 (Note this is different from both I<size in blocks> and
1272 I<filesystem block size>).
1274 This uses the L<blockdev(8)> command.");
1276 ("blockdev_getsz", (RInt64 "sizeinsectors", [String "device"]), 62, [],
1277 [InitEmpty, TestOutputInt (
1278 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1279 "get total size of device in 512-byte sectors",
1281 This returns the size of the device in units of 512-byte sectors
1282 (even if the sectorsize isn't 512 bytes ... weird).
1284 See also C<guestfs_blockdev_getss> for the real sector size of
1285 the device, and C<guestfs_blockdev_getsize64> for the more
1286 useful I<size in bytes>.
1288 This uses the L<blockdev(8)> command.");
1290 ("blockdev_getsize64", (RInt64 "sizeinbytes", [String "device"]), 63, [],
1291 [InitEmpty, TestOutputInt (
1292 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1293 "get total size of device in bytes",
1295 This returns the size of the device in bytes.
1297 See also C<guestfs_blockdev_getsz>.
1299 This uses the L<blockdev(8)> command.");
1301 ("blockdev_flushbufs", (RErr, [String "device"]), 64, [],
1303 [["blockdev_flushbufs"; "/dev/sda"]]],
1304 "flush device buffers",
1306 This tells the kernel to flush internal buffers associated
1309 This uses the L<blockdev(8)> command.");
1311 ("blockdev_rereadpt", (RErr, [String "device"]), 65, [],
1313 [["blockdev_rereadpt"; "/dev/sda"]]],
1314 "reread partition table",
1316 Reread the partition table on C<device>.
1318 This uses the L<blockdev(8)> command.");
1320 ("upload", (RErr, [FileIn "filename"; String "remotefilename"]), 66, [],
1321 [InitBasicFS, TestOutput (
1322 (* Pick a file from cwd which isn't likely to change. *)
1323 [["upload"; "COPYING.LIB"; "/COPYING.LIB"];
1324 ["checksum"; "md5"; "/COPYING.LIB"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1325 "upload a file from the local machine",
1327 Upload local file C<filename> to C<remotefilename> on the
1330 C<filename> can also be a named pipe.
1332 See also C<guestfs_download>.");
1334 ("download", (RErr, [String "remotefilename"; FileOut "filename"]), 67, [],
1335 [InitBasicFS, TestOutput (
1336 (* Pick a file from cwd which isn't likely to change. *)
1337 [["upload"; "COPYING.LIB"; "/COPYING.LIB"];
1338 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1339 ["upload"; "testdownload.tmp"; "/upload"];
1340 ["checksum"; "md5"; "/upload"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1341 "download a file to the local machine",
1343 Download file C<remotefilename> and save it as C<filename>
1344 on the local machine.
1346 C<filename> can also be a named pipe.
1348 See also C<guestfs_upload>, C<guestfs_cat>.");
1350 ("checksum", (RString "checksum", [String "csumtype"; String "path"]), 68, [],
1351 [InitBasicFS, TestOutput (
1352 [["write_file"; "/new"; "test\n"; "0"];
1353 ["checksum"; "crc"; "/new"]], "935282863");
1354 InitBasicFS, TestLastFail (
1355 [["checksum"; "crc"; "/new"]]);
1356 InitBasicFS, TestOutput (
1357 [["write_file"; "/new"; "test\n"; "0"];
1358 ["checksum"; "md5"; "/new"]], "d8e8fca2dc0f896fd7cb4cb0031ba249");
1359 InitBasicFS, TestOutput (
1360 [["write_file"; "/new"; "test\n"; "0"];
1361 ["checksum"; "sha1"; "/new"]], "4e1243bd22c66e76c2ba9eddc1f91394e57f9f83");
1362 InitBasicFS, TestOutput (
1363 [["write_file"; "/new"; "test\n"; "0"];
1364 ["checksum"; "sha224"; "/new"]], "52f1bf093f4b7588726035c176c0cdb4376cfea53819f1395ac9e6ec");
1365 InitBasicFS, TestOutput (
1366 [["write_file"; "/new"; "test\n"; "0"];
1367 ["checksum"; "sha256"; "/new"]], "f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2");
1368 InitBasicFS, TestOutput (
1369 [["write_file"; "/new"; "test\n"; "0"];
1370 ["checksum"; "sha384"; "/new"]], "109bb6b5b6d5547c1ce03c7a8bd7d8f80c1cb0957f50c4f7fda04692079917e4f9cad52b878f3d8234e1a170b154b72d");
1371 InitBasicFS, TestOutput (
1372 [["write_file"; "/new"; "test\n"; "0"];
1373 ["checksum"; "sha512"; "/new"]], "0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123")],
1374 "compute MD5, SHAx or CRC checksum of file",
1376 This call computes the MD5, SHAx or CRC checksum of the
1379 The type of checksum to compute is given by the C<csumtype>
1380 parameter which must have one of the following values:
1386 Compute the cyclic redundancy check (CRC) specified by POSIX
1387 for the C<cksum> command.
1391 Compute the MD5 hash (using the C<md5sum> program).
1395 Compute the SHA1 hash (using the C<sha1sum> program).
1399 Compute the SHA224 hash (using the C<sha224sum> program).
1403 Compute the SHA256 hash (using the C<sha256sum> program).
1407 Compute the SHA384 hash (using the C<sha384sum> program).
1411 Compute the SHA512 hash (using the C<sha512sum> program).
1415 The checksum is returned as a printable string.");
1417 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1418 [InitBasicFS, TestOutput (
1419 [["tar_in"; "images/helloworld.tar"; "/"];
1420 ["cat"; "/hello"]], "hello\n")],
1421 "unpack tarfile to directory",
1423 This command uploads and unpacks local file C<tarfile> (an
1424 I<uncompressed> tar file) into C<directory>.
1426 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1428 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1430 "pack directory into tarfile",
1432 This command packs the contents of C<directory> and downloads
1433 it to local file C<tarfile>.
1435 To download a compressed tarball, use C<guestfs_tgz_out>.");
1437 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1438 [InitBasicFS, TestOutput (
1439 [["tgz_in"; "images/helloworld.tar.gz"; "/"];
1440 ["cat"; "/hello"]], "hello\n")],
1441 "unpack compressed tarball to directory",
1443 This command uploads and unpacks local file C<tarball> (a
1444 I<gzip compressed> tar file) into C<directory>.
1446 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1448 ("tgz_out", (RErr, [String "directory"; FileOut "tarball"]), 72, [],
1450 "pack directory into compressed tarball",
1452 This command packs the contents of C<directory> and downloads
1453 it to local file C<tarball>.
1455 To download an uncompressed tarball, use C<guestfs_tar_out>.");
1457 ("mount_ro", (RErr, [String "device"; String "mountpoint"]), 73, [],
1458 [InitBasicFS, TestLastFail (
1460 ["mount_ro"; "/dev/sda1"; "/"];
1461 ["touch"; "/new"]]);
1462 InitBasicFS, TestOutput (
1463 [["write_file"; "/new"; "data"; "0"];
1465 ["mount_ro"; "/dev/sda1"; "/"];
1466 ["cat"; "/new"]], "data")],
1467 "mount a guest disk, read-only",
1469 This is the same as the C<guestfs_mount> command, but it
1470 mounts the filesystem with the read-only (I<-o ro>) flag.");
1472 ("mount_options", (RErr, [String "options"; String "device"; String "mountpoint"]), 74, [],
1474 "mount a guest disk with mount options",
1476 This is the same as the C<guestfs_mount> command, but it
1477 allows you to set the mount options as for the
1478 L<mount(8)> I<-o> flag.");
1480 ("mount_vfs", (RErr, [String "options"; String "vfstype"; String "device"; String "mountpoint"]), 75, [],
1482 "mount a guest disk with mount options and vfstype",
1484 This is the same as the C<guestfs_mount> command, but it
1485 allows you to set both the mount options and the vfstype
1486 as for the L<mount(8)> I<-o> and I<-t> flags.");
1488 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
1490 "debugging and internals",
1492 The C<guestfs_debug> command exposes some internals of
1493 C<guestfsd> (the guestfs daemon) that runs inside the
1496 There is no comprehensive help for this command. You have
1497 to look at the file C<daemon/debug.c> in the libguestfs source
1498 to find out what you can do.");
1500 ("lvremove", (RErr, [String "device"]), 77, [],
1501 [InitEmpty, TestOutputList (
1502 [["pvcreate"; "/dev/sda"];
1503 ["vgcreate"; "VG"; "/dev/sda"];
1504 ["lvcreate"; "LV1"; "VG"; "50"];
1505 ["lvcreate"; "LV2"; "VG"; "50"];
1506 ["lvremove"; "/dev/VG/LV1"];
1507 ["lvs"]], ["/dev/VG/LV2"]);
1508 InitEmpty, TestOutputList (
1509 [["pvcreate"; "/dev/sda"];
1510 ["vgcreate"; "VG"; "/dev/sda"];
1511 ["lvcreate"; "LV1"; "VG"; "50"];
1512 ["lvcreate"; "LV2"; "VG"; "50"];
1513 ["lvremove"; "/dev/VG"];
1515 InitEmpty, TestOutputList (
1516 [["pvcreate"; "/dev/sda"];
1517 ["vgcreate"; "VG"; "/dev/sda"];
1518 ["lvcreate"; "LV1"; "VG"; "50"];
1519 ["lvcreate"; "LV2"; "VG"; "50"];
1520 ["lvremove"; "/dev/VG"];
1522 "remove an LVM logical volume",
1524 Remove an LVM logical volume C<device>, where C<device> is
1525 the path to the LV, such as C</dev/VG/LV>.
1527 You can also remove all LVs in a volume group by specifying
1528 the VG name, C</dev/VG>.");
1530 ("vgremove", (RErr, [String "vgname"]), 78, [],
1531 [InitEmpty, TestOutputList (
1532 [["pvcreate"; "/dev/sda"];
1533 ["vgcreate"; "VG"; "/dev/sda"];
1534 ["lvcreate"; "LV1"; "VG"; "50"];
1535 ["lvcreate"; "LV2"; "VG"; "50"];
1538 InitEmpty, TestOutputList (
1539 [["pvcreate"; "/dev/sda"];
1540 ["vgcreate"; "VG"; "/dev/sda"];
1541 ["lvcreate"; "LV1"; "VG"; "50"];
1542 ["lvcreate"; "LV2"; "VG"; "50"];
1545 "remove an LVM volume group",
1547 Remove an LVM volume group C<vgname>, (for example C<VG>).
1549 This also forcibly removes all logical volumes in the volume
1552 ("pvremove", (RErr, [String "device"]), 79, [],
1553 [InitEmpty, TestOutputList (
1554 [["pvcreate"; "/dev/sda"];
1555 ["vgcreate"; "VG"; "/dev/sda"];
1556 ["lvcreate"; "LV1"; "VG"; "50"];
1557 ["lvcreate"; "LV2"; "VG"; "50"];
1559 ["pvremove"; "/dev/sda"];
1561 InitEmpty, TestOutputList (
1562 [["pvcreate"; "/dev/sda"];
1563 ["vgcreate"; "VG"; "/dev/sda"];
1564 ["lvcreate"; "LV1"; "VG"; "50"];
1565 ["lvcreate"; "LV2"; "VG"; "50"];
1567 ["pvremove"; "/dev/sda"];
1569 InitEmpty, TestOutputList (
1570 [["pvcreate"; "/dev/sda"];
1571 ["vgcreate"; "VG"; "/dev/sda"];
1572 ["lvcreate"; "LV1"; "VG"; "50"];
1573 ["lvcreate"; "LV2"; "VG"; "50"];
1575 ["pvremove"; "/dev/sda"];
1577 "remove an LVM physical volume",
1579 This wipes a physical volume C<device> so that LVM will no longer
1582 The implementation uses the C<pvremove> command which refuses to
1583 wipe physical volumes that contain any volume groups, so you have
1584 to remove those first.");
1586 ("set_e2label", (RErr, [String "device"; String "label"]), 80, [],
1587 [InitBasicFS, TestOutput (
1588 [["set_e2label"; "/dev/sda1"; "testlabel"];
1589 ["get_e2label"; "/dev/sda1"]], "testlabel")],
1590 "set the ext2/3/4 filesystem label",
1592 This sets the ext2/3/4 filesystem label of the filesystem on
1593 C<device> to C<label>. Filesystem labels are limited to
1596 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
1597 to return the existing label on a filesystem.");
1599 ("get_e2label", (RString "label", [String "device"]), 81, [],
1601 "get the ext2/3/4 filesystem label",
1603 This returns the ext2/3/4 filesystem label of the filesystem on
1606 ("set_e2uuid", (RErr, [String "device"; String "uuid"]), 82, [],
1607 [InitBasicFS, TestOutput (
1608 [["set_e2uuid"; "/dev/sda1"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"];
1609 ["get_e2uuid"; "/dev/sda1"]], "a3a61220-882b-4f61-89f4-cf24dcc7297d");
1610 InitBasicFS, TestOutput (
1611 [["set_e2uuid"; "/dev/sda1"; "clear"];
1612 ["get_e2uuid"; "/dev/sda1"]], "");
1613 (* We can't predict what UUIDs will be, so just check the commands run. *)
1614 InitBasicFS, TestRun (
1615 [["set_e2uuid"; "/dev/sda1"; "random"]]);
1616 InitBasicFS, TestRun (
1617 [["set_e2uuid"; "/dev/sda1"; "time"]])],
1618 "set the ext2/3/4 filesystem UUID",
1620 This sets the ext2/3/4 filesystem UUID of the filesystem on
1621 C<device> to C<uuid>. The format of the UUID and alternatives
1622 such as C<clear>, C<random> and C<time> are described in the
1623 L<tune2fs(8)> manpage.
1625 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
1626 to return the existing UUID of a filesystem.");
1628 ("get_e2uuid", (RString "uuid", [String "device"]), 83, [],
1630 "get the ext2/3/4 filesystem UUID",
1632 This returns the ext2/3/4 filesystem UUID of the filesystem on
1637 let all_functions = non_daemon_functions @ daemon_functions
1639 (* In some places we want the functions to be displayed sorted
1640 * alphabetically, so this is useful:
1642 let all_functions_sorted =
1643 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
1644 compare n1 n2) all_functions
1646 (* Column names and types from LVM PVs/VGs/LVs. *)
1655 "pv_attr", `String (* XXX *);
1656 "pv_pe_count", `Int;
1657 "pv_pe_alloc_count", `Int;
1660 "pv_mda_count", `Int;
1661 "pv_mda_free", `Bytes;
1662 (* Not in Fedora 10:
1663 "pv_mda_size", `Bytes;
1670 "vg_attr", `String (* XXX *);
1673 "vg_sysid", `String;
1674 "vg_extent_size", `Bytes;
1675 "vg_extent_count", `Int;
1676 "vg_free_count", `Int;
1684 "vg_mda_count", `Int;
1685 "vg_mda_free", `Bytes;
1686 (* Not in Fedora 10:
1687 "vg_mda_size", `Bytes;
1693 "lv_attr", `String (* XXX *);
1696 "lv_kernel_major", `Int;
1697 "lv_kernel_minor", `Int;
1701 "snap_percent", `OptPercent;
1702 "copy_percent", `OptPercent;
1705 "mirror_log", `String;
1709 (* Column names and types from stat structures.
1710 * NB. Can't use things like 'st_atime' because glibc header files
1711 * define some of these as macros. Ugh.
1728 let statvfs_cols = [
1742 (* Useful functions.
1743 * Note we don't want to use any external OCaml libraries which
1744 * makes this a bit harder than it should be.
1746 let failwithf fs = ksprintf failwith fs
1748 let replace_char s c1 c2 =
1749 let s2 = String.copy s in
1750 let r = ref false in
1751 for i = 0 to String.length s2 - 1 do
1752 if String.unsafe_get s2 i = c1 then (
1753 String.unsafe_set s2 i c2;
1757 if not !r then s else s2
1761 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
1763 let triml ?(test = isspace) str =
1765 let n = ref (String.length str) in
1766 while !n > 0 && test str.[!i]; do
1771 else String.sub str !i !n
1773 let trimr ?(test = isspace) str =
1774 let n = ref (String.length str) in
1775 while !n > 0 && test str.[!n-1]; do
1778 if !n = String.length str then str
1779 else String.sub str 0 !n
1781 let trim ?(test = isspace) str =
1782 trimr ~test (triml ~test str)
1784 let rec find s sub =
1785 let len = String.length s in
1786 let sublen = String.length sub in
1788 if i <= len-sublen then (
1790 if j < sublen then (
1791 if s.[i+j] = sub.[j] then loop2 (j+1)
1797 if r = -1 then loop (i+1) else r
1803 let rec replace_str s s1 s2 =
1804 let len = String.length s in
1805 let sublen = String.length s1 in
1806 let i = find s s1 in
1809 let s' = String.sub s 0 i in
1810 let s'' = String.sub s (i+sublen) (len-i-sublen) in
1811 s' ^ s2 ^ replace_str s'' s1 s2
1814 let rec string_split sep str =
1815 let len = String.length str in
1816 let seplen = String.length sep in
1817 let i = find str sep in
1818 if i = -1 then [str]
1820 let s' = String.sub str 0 i in
1821 let s'' = String.sub str (i+seplen) (len-i-seplen) in
1822 s' :: string_split sep s''
1825 let files_equal n1 n2 =
1826 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
1827 match Sys.command cmd with
1830 | i -> failwithf "%s: failed with error code %d" cmd i
1832 let rec find_map f = function
1833 | [] -> raise Not_found
1837 | None -> find_map f xs
1840 let rec loop i = function
1842 | x :: xs -> f i x; loop (i+1) xs
1847 let rec loop i = function
1849 | x :: xs -> let r = f i x in r :: loop (i+1) xs
1853 let name_of_argt = function
1854 | String n | OptString n | StringList n | Bool n | Int n
1855 | FileIn n | FileOut n -> n
1857 let seq_of_test = function
1858 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
1859 | TestOutputInt (s, _) | TestOutputTrue s | TestOutputFalse s
1860 | TestOutputLength (s, _) | TestOutputStruct (s, _)
1861 | TestLastFail s -> s
1863 (* Check function names etc. for consistency. *)
1864 let check_functions () =
1865 let contains_uppercase str =
1866 let len = String.length str in
1868 if i >= len then false
1871 if c >= 'A' && c <= 'Z' then true
1878 (* Check function names. *)
1880 fun (name, _, _, _, _, _, _) ->
1881 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
1882 failwithf "function name %s does not need 'guestfs' prefix" name;
1883 if contains_uppercase name then
1884 failwithf "function name %s should not contain uppercase chars" name;
1885 if String.contains name '-' then
1886 failwithf "function name %s should not contain '-', use '_' instead."
1890 (* Check function parameter/return names. *)
1892 fun (name, style, _, _, _, _, _) ->
1893 let check_arg_ret_name n =
1894 if contains_uppercase n then
1895 failwithf "%s param/ret %s should not contain uppercase chars"
1897 if String.contains n '-' || String.contains n '_' then
1898 failwithf "%s param/ret %s should not contain '-' or '_'"
1901 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;
1902 if n = "argv" || n = "args" then
1903 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" n
1906 (match fst style with
1908 | RInt n | RInt64 n | RBool n | RConstString n | RString n
1909 | RStringList n | RPVList n | RVGList n | RLVList n
1910 | RStat n | RStatVFS n
1912 check_arg_ret_name n
1914 check_arg_ret_name n;
1915 check_arg_ret_name m
1917 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
1920 (* Check short descriptions. *)
1922 fun (name, _, _, _, _, shortdesc, _) ->
1923 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
1924 failwithf "short description of %s should begin with lowercase." name;
1925 let c = shortdesc.[String.length shortdesc-1] in
1926 if c = '\n' || c = '.' then
1927 failwithf "short description of %s should not end with . or \\n." name
1930 (* Check long dscriptions. *)
1932 fun (name, _, _, _, _, _, longdesc) ->
1933 if longdesc.[String.length longdesc-1] = '\n' then
1934 failwithf "long description of %s should not end with \\n." name
1937 (* Check proc_nrs. *)
1939 fun (name, _, proc_nr, _, _, _, _) ->
1940 if proc_nr <= 0 then
1941 failwithf "daemon function %s should have proc_nr > 0" name
1945 fun (name, _, proc_nr, _, _, _, _) ->
1946 if proc_nr <> -1 then
1947 failwithf "non-daemon function %s should have proc_nr -1" name
1948 ) non_daemon_functions;
1951 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
1954 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
1955 let rec loop = function
1958 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
1960 | (name1,nr1) :: (name2,nr2) :: _ ->
1961 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
1969 (* Ignore functions that have no tests. We generate a
1970 * warning when the user does 'make check' instead.
1972 | name, _, _, _, [], _, _ -> ()
1973 | name, _, _, _, tests, _, _ ->
1977 match seq_of_test test with
1979 failwithf "%s has a test containing an empty sequence" name
1980 | cmds -> List.map List.hd cmds
1982 let funcs = List.flatten funcs in
1984 let tested = List.mem name funcs in
1987 failwithf "function %s has tests but does not test itself" name
1990 (* 'pr' prints to the current output file. *)
1991 let chan = ref stdout
1992 let pr fs = ksprintf (output_string !chan) fs
1994 (* Generate a header block in a number of standard styles. *)
1995 type comment_style = CStyle | HashStyle | OCamlStyle
1996 type license = GPLv2 | LGPLv2
1998 let generate_header comment license =
1999 let c = match comment with
2000 | CStyle -> pr "/* "; " *"
2001 | HashStyle -> pr "# "; "#"
2002 | OCamlStyle -> pr "(* "; " *" in
2003 pr "libguestfs generated file\n";
2004 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
2005 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
2007 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
2011 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
2012 pr "%s it under the terms of the GNU General Public License as published by\n" c;
2013 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
2014 pr "%s (at your option) any later version.\n" c;
2016 pr "%s This program is distributed in the hope that it will be useful,\n" c;
2017 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2018 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
2019 pr "%s GNU General Public License for more details.\n" c;
2021 pr "%s You should have received a copy of the GNU General Public License along\n" c;
2022 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
2023 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
2026 pr "%s This library is free software; you can redistribute it and/or\n" c;
2027 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
2028 pr "%s License as published by the Free Software Foundation; either\n" c;
2029 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
2031 pr "%s This library is distributed in the hope that it will be useful,\n" c;
2032 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2033 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
2034 pr "%s Lesser General Public License for more details.\n" c;
2036 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
2037 pr "%s License along with this library; if not, write to the Free Software\n" c;
2038 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
2041 | CStyle -> pr " */\n"
2043 | OCamlStyle -> pr " *)\n"
2047 (* Start of main code generation functions below this line. *)
2049 (* Generate the pod documentation for the C API. *)
2050 let rec generate_actions_pod () =
2052 fun (shortname, style, _, flags, _, _, longdesc) ->
2053 let name = "guestfs_" ^ shortname in
2054 pr "=head2 %s\n\n" name;
2056 generate_prototype ~extern:false ~handle:"handle" name style;
2058 pr "%s\n\n" longdesc;
2059 (match fst style with
2061 pr "This function returns 0 on success or -1 on error.\n\n"
2063 pr "On error this function returns -1.\n\n"
2065 pr "On error this function returns -1.\n\n"
2067 pr "This function returns a C truth value on success or -1 on error.\n\n"
2069 pr "This function returns a string, or NULL on error.
2070 The string is owned by the guest handle and must I<not> be freed.\n\n"
2072 pr "This function returns a string, or NULL on error.
2073 I<The caller must free the returned string after use>.\n\n"
2075 pr "This function returns a NULL-terminated array of strings
2076 (like L<environ(3)>), or NULL if there was an error.
2077 I<The caller must free the strings and the array after use>.\n\n"
2079 pr "This function returns a C<struct guestfs_int_bool *>,
2080 or NULL if there was an error.
2081 I<The caller must call C<guestfs_free_int_bool> after use>.\n\n"
2083 pr "This function returns a C<struct guestfs_lvm_pv_list *>
2084 (see E<lt>guestfs-structs.hE<gt>),
2085 or NULL if there was an error.
2086 I<The caller must call C<guestfs_free_lvm_pv_list> after use>.\n\n"
2088 pr "This function returns a C<struct guestfs_lvm_vg_list *>
2089 (see E<lt>guestfs-structs.hE<gt>),
2090 or NULL if there was an error.
2091 I<The caller must call C<guestfs_free_lvm_vg_list> after use>.\n\n"
2093 pr "This function returns a C<struct guestfs_lvm_lv_list *>
2094 (see E<lt>guestfs-structs.hE<gt>),
2095 or NULL if there was an error.
2096 I<The caller must call C<guestfs_free_lvm_lv_list> after use>.\n\n"
2098 pr "This function returns a C<struct guestfs_stat *>
2099 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
2100 or NULL if there was an error.
2101 I<The caller must call C<free> after use>.\n\n"
2103 pr "This function returns a C<struct guestfs_statvfs *>
2104 (see L<statvfs(2)> and E<lt>guestfs-structs.hE<gt>),
2105 or NULL if there was an error.
2106 I<The caller must call C<free> after use>.\n\n"
2108 pr "This function returns a NULL-terminated array of
2109 strings, or NULL if there was an error.
2110 The array of strings will always have length C<2n+1>, where
2111 C<n> keys and values alternate, followed by the trailing NULL entry.
2112 I<The caller must free the strings and the array after use>.\n\n"
2114 if List.mem ProtocolLimitWarning flags then
2115 pr "%s\n\n" protocol_limit_warning;
2116 if List.mem DangerWillRobinson flags then
2117 pr "%s\n\n" danger_will_robinson;
2118 ) all_functions_sorted
2120 and generate_structs_pod () =
2121 (* LVM structs documentation. *)
2124 pr "=head2 guestfs_lvm_%s\n" typ;
2126 pr " struct guestfs_lvm_%s {\n" typ;
2129 | name, `String -> pr " char *%s;\n" name
2131 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
2132 pr " char %s[32];\n" name
2133 | name, `Bytes -> pr " uint64_t %s;\n" name
2134 | name, `Int -> pr " int64_t %s;\n" name
2135 | name, `OptPercent ->
2136 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
2137 pr " float %s;\n" name
2140 pr " struct guestfs_lvm_%s_list {\n" typ;
2141 pr " uint32_t len; /* Number of elements in list. */\n";
2142 pr " struct guestfs_lvm_%s *val; /* Elements. */\n" typ;
2145 pr " void guestfs_free_lvm_%s_list (struct guestfs_free_lvm_%s_list *);\n"
2148 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
2150 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
2151 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
2153 * We have to use an underscore instead of a dash because otherwise
2154 * rpcgen generates incorrect code.
2156 * This header is NOT exported to clients, but see also generate_structs_h.
2158 and generate_xdr () =
2159 generate_header CStyle LGPLv2;
2161 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
2162 pr "typedef string str<>;\n";
2165 (* LVM internal structures. *)
2169 pr "struct guestfs_lvm_int_%s {\n" typ;
2171 | name, `String -> pr " string %s<>;\n" name
2172 | name, `UUID -> pr " opaque %s[32];\n" name
2173 | name, `Bytes -> pr " hyper %s;\n" name
2174 | name, `Int -> pr " hyper %s;\n" name
2175 | name, `OptPercent -> pr " float %s;\n" name
2179 pr "typedef struct guestfs_lvm_int_%s guestfs_lvm_int_%s_list<>;\n" typ typ;
2181 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2183 (* Stat internal structures. *)
2187 pr "struct guestfs_int_%s {\n" typ;
2189 | name, `Int -> pr " hyper %s;\n" name
2193 ) ["stat", stat_cols; "statvfs", statvfs_cols];
2196 fun (shortname, style, _, _, _, _, _) ->
2197 let name = "guestfs_" ^ shortname in
2199 (match snd style with
2202 pr "struct %s_args {\n" name;
2205 | String n -> pr " string %s<>;\n" n
2206 | OptString n -> pr " str *%s;\n" n
2207 | StringList n -> pr " str %s<>;\n" n
2208 | Bool n -> pr " bool %s;\n" n
2209 | Int n -> pr " int %s;\n" n
2210 | FileIn _ | FileOut _ -> ()
2214 (match fst style with
2217 pr "struct %s_ret {\n" name;
2221 pr "struct %s_ret {\n" name;
2222 pr " hyper %s;\n" n;
2225 pr "struct %s_ret {\n" name;
2229 failwithf "RConstString cannot be returned from a daemon function"
2231 pr "struct %s_ret {\n" name;
2232 pr " string %s<>;\n" n;
2235 pr "struct %s_ret {\n" name;
2236 pr " str %s<>;\n" n;
2239 pr "struct %s_ret {\n" name;
2244 pr "struct %s_ret {\n" name;
2245 pr " guestfs_lvm_int_pv_list %s;\n" n;
2248 pr "struct %s_ret {\n" name;
2249 pr " guestfs_lvm_int_vg_list %s;\n" n;
2252 pr "struct %s_ret {\n" name;
2253 pr " guestfs_lvm_int_lv_list %s;\n" n;
2256 pr "struct %s_ret {\n" name;
2257 pr " guestfs_int_stat %s;\n" n;
2260 pr "struct %s_ret {\n" name;
2261 pr " guestfs_int_statvfs %s;\n" n;
2264 pr "struct %s_ret {\n" name;
2265 pr " str %s<>;\n" n;
2270 (* Table of procedure numbers. *)
2271 pr "enum guestfs_procedure {\n";
2273 fun (shortname, _, proc_nr, _, _, _, _) ->
2274 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
2276 pr " GUESTFS_PROC_NR_PROCS\n";
2280 (* Having to choose a maximum message size is annoying for several
2281 * reasons (it limits what we can do in the API), but it (a) makes
2282 * the protocol a lot simpler, and (b) provides a bound on the size
2283 * of the daemon which operates in limited memory space. For large
2284 * file transfers you should use FTP.
2286 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
2289 (* Message header, etc. *)
2291 /* The communication protocol is now documented in the guestfs(3)
2295 const GUESTFS_PROGRAM = 0x2000F5F5;
2296 const GUESTFS_PROTOCOL_VERSION = 1;
2298 /* These constants must be larger than any possible message length. */
2299 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
2300 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
2302 enum guestfs_message_direction {
2303 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
2304 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
2307 enum guestfs_message_status {
2308 GUESTFS_STATUS_OK = 0,
2309 GUESTFS_STATUS_ERROR = 1
2312 const GUESTFS_ERROR_LEN = 256;
2314 struct guestfs_message_error {
2315 string error_message<GUESTFS_ERROR_LEN>;
2318 struct guestfs_message_header {
2319 unsigned prog; /* GUESTFS_PROGRAM */
2320 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
2321 guestfs_procedure proc; /* GUESTFS_PROC_x */
2322 guestfs_message_direction direction;
2323 unsigned serial; /* message serial number */
2324 guestfs_message_status status;
2327 const GUESTFS_MAX_CHUNK_SIZE = 8192;
2329 struct guestfs_chunk {
2330 int cancel; /* if non-zero, transfer is cancelled */
2331 /* data size is 0 bytes if the transfer has finished successfully */
2332 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
2336 (* Generate the guestfs-structs.h file. *)
2337 and generate_structs_h () =
2338 generate_header CStyle LGPLv2;
2340 (* This is a public exported header file containing various
2341 * structures. The structures are carefully written to have
2342 * exactly the same in-memory format as the XDR structures that
2343 * we use on the wire to the daemon. The reason for creating
2344 * copies of these structures here is just so we don't have to
2345 * export the whole of guestfs_protocol.h (which includes much
2346 * unrelated and XDR-dependent stuff that we don't want to be
2347 * public, or required by clients).
2349 * To reiterate, we will pass these structures to and from the
2350 * client with a simple assignment or memcpy, so the format
2351 * must be identical to what rpcgen / the RFC defines.
2354 (* guestfs_int_bool structure. *)
2355 pr "struct guestfs_int_bool {\n";
2361 (* LVM public structures. *)
2365 pr "struct guestfs_lvm_%s {\n" typ;
2368 | name, `String -> pr " char *%s;\n" name
2369 | name, `UUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
2370 | name, `Bytes -> pr " uint64_t %s;\n" name
2371 | name, `Int -> pr " int64_t %s;\n" name
2372 | name, `OptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
2376 pr "struct guestfs_lvm_%s_list {\n" typ;
2377 pr " uint32_t len;\n";
2378 pr " struct guestfs_lvm_%s *val;\n" typ;
2381 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2383 (* Stat structures. *)
2387 pr "struct guestfs_%s {\n" typ;
2390 | name, `Int -> pr " int64_t %s;\n" name
2394 ) ["stat", stat_cols; "statvfs", statvfs_cols]
2396 (* Generate the guestfs-actions.h file. *)
2397 and generate_actions_h () =
2398 generate_header CStyle LGPLv2;
2400 fun (shortname, style, _, _, _, _, _) ->
2401 let name = "guestfs_" ^ shortname in
2402 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
2406 (* Generate the client-side dispatch stubs. *)
2407 and generate_client_actions () =
2408 generate_header CStyle LGPLv2;
2414 #include \"guestfs.h\"
2415 #include \"guestfs_protocol.h\"
2417 #define error guestfs_error
2418 #define perrorf guestfs_perrorf
2419 #define safe_malloc guestfs_safe_malloc
2420 #define safe_realloc guestfs_safe_realloc
2421 #define safe_strdup guestfs_safe_strdup
2422 #define safe_memdup guestfs_safe_memdup
2424 /* Check the return message from a call for validity. */
2426 check_reply_header (guestfs_h *g,
2427 const struct guestfs_message_header *hdr,
2428 int proc_nr, int serial)
2430 if (hdr->prog != GUESTFS_PROGRAM) {
2431 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
2434 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
2435 error (g, \"wrong protocol version (%%d/%%d)\",
2436 hdr->vers, GUESTFS_PROTOCOL_VERSION);
2439 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
2440 error (g, \"unexpected message direction (%%d/%%d)\",
2441 hdr->direction, GUESTFS_DIRECTION_REPLY);
2444 if (hdr->proc != proc_nr) {
2445 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
2448 if (hdr->serial != serial) {
2449 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
2456 /* Check we are in the right state to run a high-level action. */
2458 check_state (guestfs_h *g, const char *caller)
2460 if (!guestfs_is_ready (g)) {
2461 if (guestfs_is_config (g))
2462 error (g, \"%%s: call launch() before using this function\",
2464 else if (guestfs_is_launching (g))
2465 error (g, \"%%s: call wait_ready() before using this function\",
2468 error (g, \"%%s called from the wrong state, %%d != READY\",
2469 caller, guestfs_get_state (g));
2477 (* Client-side stubs for each function. *)
2479 fun (shortname, style, _, _, _, _, _) ->
2480 let name = "guestfs_" ^ shortname in
2482 (* Generate the context struct which stores the high-level
2483 * state between callback functions.
2485 pr "struct %s_ctx {\n" shortname;
2486 pr " /* This flag is set by the callbacks, so we know we've done\n";
2487 pr " * the callbacks as expected, and in the right sequence.\n";
2488 pr " * 0 = not called, 1 = reply_cb called.\n";
2490 pr " int cb_sequence;\n";
2491 pr " struct guestfs_message_header hdr;\n";
2492 pr " struct guestfs_message_error err;\n";
2493 (match fst style with
2496 failwithf "RConstString cannot be returned from a daemon function"
2498 | RBool _ | RString _ | RStringList _
2500 | RPVList _ | RVGList _ | RLVList _
2501 | RStat _ | RStatVFS _
2503 pr " struct %s_ret ret;\n" name
2508 (* Generate the reply callback function. *)
2509 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
2511 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
2512 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
2514 pr " /* This should definitely not happen. */\n";
2515 pr " if (ctx->cb_sequence != 0) {\n";
2516 pr " ctx->cb_sequence = 9999;\n";
2517 pr " error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
2521 pr " ml->main_loop_quit (ml, g);\n";
2523 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
2524 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
2527 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
2528 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
2529 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
2536 (match fst style with
2539 failwithf "RConstString cannot be returned from a daemon function"
2541 | RBool _ | RString _ | RStringList _
2543 | RPVList _ | RVGList _ | RLVList _
2544 | RStat _ | RStatVFS _
2546 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
2547 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
2553 pr " ctx->cb_sequence = 1;\n";
2556 (* Generate the action stub. *)
2557 generate_prototype ~extern:false ~semicolon:false ~newline:true
2558 ~handle:"g" name style;
2561 match fst style with
2562 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
2564 failwithf "RConstString cannot be returned from a daemon function"
2565 | RString _ | RStringList _ | RIntBool _
2566 | RPVList _ | RVGList _ | RLVList _
2567 | RStat _ | RStatVFS _
2573 (match snd style with
2575 | _ -> pr " struct %s_args args;\n" name
2578 pr " struct %s_ctx ctx;\n" shortname;
2579 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
2580 pr " int serial;\n";
2582 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
2583 pr " guestfs_set_busy (g);\n";
2585 pr " memset (&ctx, 0, sizeof ctx);\n";
2588 (* Send the main header and arguments. *)
2589 (match snd style with
2591 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
2592 (String.uppercase shortname)
2597 pr " args.%s = (char *) %s;\n" n n
2599 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
2601 pr " args.%s.%s_val = (char **) %s;\n" n n n;
2602 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
2604 pr " args.%s = %s;\n" n n
2606 pr " args.%s = %s;\n" n n
2607 | FileIn _ | FileOut _ -> ()
2609 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
2610 (String.uppercase shortname);
2611 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
2614 pr " if (serial == -1) {\n";
2615 pr " guestfs_set_ready (g);\n";
2616 pr " return %s;\n" error_code;
2620 (* Send any additional files (FileIn) requested. *)
2621 let need_read_reply_label = ref false in
2628 pr " r = guestfs__send_file_sync (g, %s);\n" n;
2629 pr " if (r == -1) {\n";
2630 pr " guestfs_set_ready (g);\n";
2631 pr " return %s;\n" error_code;
2633 pr " if (r == -2) /* daemon cancelled */\n";
2634 pr " goto read_reply;\n";
2635 need_read_reply_label := true;
2641 (* Wait for the reply from the remote end. *)
2642 if !need_read_reply_label then pr " read_reply:\n";
2643 pr " guestfs__switch_to_receiving (g);\n";
2644 pr " ctx.cb_sequence = 0;\n";
2645 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
2646 pr " (void) ml->main_loop_run (ml, g);\n";
2647 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
2648 pr " if (ctx.cb_sequence != 1) {\n";
2649 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
2650 pr " guestfs_set_ready (g);\n";
2651 pr " return %s;\n" error_code;
2655 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
2656 (String.uppercase shortname);
2657 pr " guestfs_set_ready (g);\n";
2658 pr " return %s;\n" error_code;
2662 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
2663 pr " error (g, \"%%s\", ctx.err.error_message);\n";
2664 pr " guestfs_set_ready (g);\n";
2665 pr " return %s;\n" error_code;
2669 (* Expecting to receive further files (FileOut)? *)
2673 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
2674 pr " guestfs_set_ready (g);\n";
2675 pr " return %s;\n" error_code;
2681 pr " guestfs_set_ready (g);\n";
2683 (match fst style with
2684 | RErr -> pr " return 0;\n"
2685 | RInt n | RInt64 n | RBool n ->
2686 pr " return ctx.ret.%s;\n" n
2688 failwithf "RConstString cannot be returned from a daemon function"
2690 pr " return ctx.ret.%s; /* caller will free */\n" n
2691 | RStringList n | RHashtable n ->
2692 pr " /* caller will free this, but we need to add a NULL entry */\n";
2693 pr " ctx.ret.%s.%s_val =\n" n n;
2694 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
2695 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
2697 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
2698 pr " return ctx.ret.%s.%s_val;\n" n n
2700 pr " /* caller with free this */\n";
2701 pr " return safe_memdup (g, &ctx.ret, sizeof (ctx.ret));\n"
2702 | RPVList n | RVGList n | RLVList n
2703 | RStat n | RStatVFS n ->
2704 pr " /* caller will free this */\n";
2705 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
2711 (* Generate daemon/actions.h. *)
2712 and generate_daemon_actions_h () =
2713 generate_header CStyle GPLv2;
2715 pr "#include \"../src/guestfs_protocol.h\"\n";
2719 fun (name, style, _, _, _, _, _) ->
2721 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
2725 (* Generate the server-side stubs. *)
2726 and generate_daemon_actions () =
2727 generate_header CStyle GPLv2;
2729 pr "#include <config.h>\n";
2731 pr "#include <stdio.h>\n";
2732 pr "#include <stdlib.h>\n";
2733 pr "#include <string.h>\n";
2734 pr "#include <inttypes.h>\n";
2735 pr "#include <ctype.h>\n";
2736 pr "#include <rpc/types.h>\n";
2737 pr "#include <rpc/xdr.h>\n";
2739 pr "#include \"daemon.h\"\n";
2740 pr "#include \"../src/guestfs_protocol.h\"\n";
2741 pr "#include \"actions.h\"\n";
2745 fun (name, style, _, _, _, _, _) ->
2746 (* Generate server-side stubs. *)
2747 pr "static void %s_stub (XDR *xdr_in)\n" name;
2750 match fst style with
2751 | RErr | RInt _ -> pr " int r;\n"; "-1"
2752 | RInt64 _ -> pr " int64_t r;\n"; "-1"
2753 | RBool _ -> pr " int r;\n"; "-1"
2755 failwithf "RConstString cannot be returned from a daemon function"
2756 | RString _ -> pr " char *r;\n"; "NULL"
2757 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
2758 | RIntBool _ -> pr " guestfs_%s_ret *r;\n" name; "NULL"
2759 | RPVList _ -> pr " guestfs_lvm_int_pv_list *r;\n"; "NULL"
2760 | RVGList _ -> pr " guestfs_lvm_int_vg_list *r;\n"; "NULL"
2761 | RLVList _ -> pr " guestfs_lvm_int_lv_list *r;\n"; "NULL"
2762 | RStat _ -> pr " guestfs_int_stat *r;\n"; "NULL"
2763 | RStatVFS _ -> pr " guestfs_int_statvfs *r;\n"; "NULL" in
2765 (match snd style with
2768 pr " struct guestfs_%s_args args;\n" name;
2772 | OptString n -> pr " const char *%s;\n" n
2773 | StringList n -> pr " char **%s;\n" n
2774 | Bool n -> pr " int %s;\n" n
2775 | Int n -> pr " int %s;\n" n
2776 | FileIn _ | FileOut _ -> ()
2781 (match snd style with
2784 pr " memset (&args, 0, sizeof args);\n";
2786 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
2787 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
2792 | String n -> pr " %s = args.%s;\n" n n
2793 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
2795 pr " %s = realloc (args.%s.%s_val,\n" n n n;
2796 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
2797 pr " if (%s == NULL) {\n" n;
2798 pr " reply_with_perror (\"realloc\");\n";
2801 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
2802 pr " args.%s.%s_val = %s;\n" n n n;
2803 | Bool n -> pr " %s = args.%s;\n" n n
2804 | Int n -> pr " %s = args.%s;\n" n n
2805 | FileIn _ | FileOut _ -> ()
2810 (* Don't want to call the impl with any FileIn or FileOut
2811 * parameters, since these go "outside" the RPC protocol.
2814 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
2816 pr " r = do_%s " name;
2817 generate_call_args argsnofile;
2820 pr " if (r == %s)\n" error_code;
2821 pr " /* do_%s has already called reply_with_error */\n" name;
2825 (* If there are any FileOut parameters, then the impl must
2826 * send its own reply.
2829 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
2831 pr " /* do_%s has already sent a reply */\n" name
2833 match fst style with
2834 | RErr -> pr " reply (NULL, NULL);\n"
2835 | RInt n | RInt64 n | RBool n ->
2836 pr " struct guestfs_%s_ret ret;\n" name;
2837 pr " ret.%s = r;\n" n;
2838 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
2841 failwithf "RConstString cannot be returned from a daemon function"
2843 pr " struct guestfs_%s_ret ret;\n" name;
2844 pr " ret.%s = r;\n" n;
2845 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
2848 | RStringList n | RHashtable n ->
2849 pr " struct guestfs_%s_ret ret;\n" name;
2850 pr " ret.%s.%s_len = count_strings (r);\n" n n;
2851 pr " ret.%s.%s_val = r;\n" n n;
2852 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
2854 pr " free_strings (r);\n"
2856 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n"
2858 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n" name
2859 | RPVList n | RVGList n | RLVList n
2860 | RStat n | RStatVFS n ->
2861 pr " struct guestfs_%s_ret ret;\n" name;
2862 pr " ret.%s = *r;\n" n;
2863 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
2865 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
2869 (* Free the args. *)
2870 (match snd style with
2875 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
2882 (* Dispatch function. *)
2883 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
2885 pr " switch (proc_nr) {\n";
2888 fun (name, style, _, _, _, _, _) ->
2889 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
2890 pr " %s_stub (xdr_in);\n" name;
2895 pr " reply_with_error (\"dispatch_incoming_message: unknown procedure number %%d\", proc_nr);\n";
2900 (* LVM columns and tokenization functions. *)
2901 (* XXX This generates crap code. We should rethink how we
2907 pr "static const char *lvm_%s_cols = \"%s\";\n"
2908 typ (String.concat "," (List.map fst cols));
2911 pr "static int lvm_tokenize_%s (char *str, struct guestfs_lvm_int_%s *r)\n" typ typ;
2913 pr " char *tok, *p, *next;\n";
2917 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
2920 pr " if (!str) {\n";
2921 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
2924 pr " if (!*str || isspace (*str)) {\n";
2925 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
2930 fun (name, coltype) ->
2931 pr " if (!tok) {\n";
2932 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
2935 pr " p = strchrnul (tok, ',');\n";
2936 pr " if (*p) next = p+1; else next = NULL;\n";
2937 pr " *p = '\\0';\n";
2940 pr " r->%s = strdup (tok);\n" name;
2941 pr " if (r->%s == NULL) {\n" name;
2942 pr " perror (\"strdup\");\n";
2946 pr " for (i = j = 0; i < 32; ++j) {\n";
2947 pr " if (tok[j] == '\\0') {\n";
2948 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
2950 pr " } else if (tok[j] != '-')\n";
2951 pr " r->%s[i++] = tok[j];\n" name;
2954 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
2955 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
2959 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
2960 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
2964 pr " if (tok[0] == '\\0')\n";
2965 pr " r->%s = -1;\n" name;
2966 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
2967 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
2971 pr " tok = next;\n";
2974 pr " if (tok != NULL) {\n";
2975 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
2982 pr "guestfs_lvm_int_%s_list *\n" typ;
2983 pr "parse_command_line_%ss (void)\n" typ;
2985 pr " char *out, *err;\n";
2986 pr " char *p, *pend;\n";
2988 pr " guestfs_lvm_int_%s_list *ret;\n" typ;
2989 pr " void *newp;\n";
2991 pr " ret = malloc (sizeof *ret);\n";
2992 pr " if (!ret) {\n";
2993 pr " reply_with_perror (\"malloc\");\n";
2994 pr " return NULL;\n";
2997 pr " ret->guestfs_lvm_int_%s_list_len = 0;\n" typ;
2998 pr " ret->guestfs_lvm_int_%s_list_val = NULL;\n" typ;
3000 pr " r = command (&out, &err,\n";
3001 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
3002 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
3003 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
3004 pr " if (r == -1) {\n";
3005 pr " reply_with_error (\"%%s\", err);\n";
3006 pr " free (out);\n";
3007 pr " free (err);\n";
3008 pr " free (ret);\n";
3009 pr " return NULL;\n";
3012 pr " free (err);\n";
3014 pr " /* Tokenize each line of the output. */\n";
3017 pr " while (p) {\n";
3018 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
3019 pr " if (pend) {\n";
3020 pr " *pend = '\\0';\n";
3024 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
3027 pr " if (!*p) { /* Empty line? Skip it. */\n";
3032 pr " /* Allocate some space to store this next entry. */\n";
3033 pr " newp = realloc (ret->guestfs_lvm_int_%s_list_val,\n" typ;
3034 pr " sizeof (guestfs_lvm_int_%s) * (i+1));\n" typ;
3035 pr " if (newp == NULL) {\n";
3036 pr " reply_with_perror (\"realloc\");\n";
3037 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3038 pr " free (ret);\n";
3039 pr " free (out);\n";
3040 pr " return NULL;\n";
3042 pr " ret->guestfs_lvm_int_%s_list_val = newp;\n" typ;
3044 pr " /* Tokenize the next entry. */\n";
3045 pr " r = lvm_tokenize_%s (p, &ret->guestfs_lvm_int_%s_list_val[i]);\n" typ typ;
3046 pr " if (r == -1) {\n";
3047 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
3048 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3049 pr " free (ret);\n";
3050 pr " free (out);\n";
3051 pr " return NULL;\n";
3058 pr " ret->guestfs_lvm_int_%s_list_len = i;\n" typ;
3060 pr " free (out);\n";
3061 pr " return ret;\n";
3064 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
3066 (* Generate the tests. *)
3067 and generate_tests () =
3068 generate_header CStyle GPLv2;
3075 #include <sys/types.h>
3078 #include \"guestfs.h\"
3080 static guestfs_h *g;
3081 static int suppress_error = 0;
3083 static void print_error (guestfs_h *g, void *data, const char *msg)
3085 if (!suppress_error)
3086 fprintf (stderr, \"%%s\\n\", msg);
3089 static void print_strings (char * const * const argv)
3093 for (argc = 0; argv[argc] != NULL; ++argc)
3094 printf (\"\\t%%s\\n\", argv[argc]);
3098 static void print_table (char * const * const argv)
3102 for (i = 0; argv[i] != NULL; i += 2)
3103 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
3107 static void no_test_warnings (void)
3113 | name, _, _, _, [], _, _ ->
3114 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
3115 | name, _, _, _, tests, _, _ -> ()
3121 (* Generate the actual tests. Note that we generate the tests
3122 * in reverse order, deliberately, so that (in general) the
3123 * newest tests run first. This makes it quicker and easier to
3128 fun (name, _, _, _, tests, _, _) ->
3129 mapi (generate_one_test name) tests
3130 ) (List.rev all_functions) in
3131 let test_names = List.concat test_names in
3132 let nr_tests = List.length test_names in
3135 int main (int argc, char *argv[])
3140 const char *filename;
3142 int nr_tests, test_num = 0;
3144 no_test_warnings ();
3146 g = guestfs_create ();
3148 printf (\"guestfs_create FAILED\\n\");
3152 guestfs_set_error_handler (g, print_error, NULL);
3154 srcdir = getenv (\"srcdir\");
3155 if (!srcdir) srcdir = \".\";
3157 guestfs_set_path (g, \".\");
3159 filename = \"test1.img\";
3160 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3165 if (lseek (fd, %d, SEEK_SET) == -1) {
3171 if (write (fd, &c, 1) == -1) {
3177 if (close (fd) == -1) {
3182 if (guestfs_add_drive (g, filename) == -1) {
3183 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3187 filename = \"test2.img\";
3188 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3193 if (lseek (fd, %d, SEEK_SET) == -1) {
3199 if (write (fd, &c, 1) == -1) {
3205 if (close (fd) == -1) {
3210 if (guestfs_add_drive (g, filename) == -1) {
3211 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3215 filename = \"test3.img\";
3216 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3221 if (lseek (fd, %d, SEEK_SET) == -1) {
3227 if (write (fd, &c, 1) == -1) {
3233 if (close (fd) == -1) {
3238 if (guestfs_add_drive (g, filename) == -1) {
3239 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3243 if (guestfs_launch (g) == -1) {
3244 printf (\"guestfs_launch FAILED\\n\");
3247 if (guestfs_wait_ready (g) == -1) {
3248 printf (\"guestfs_wait_ready FAILED\\n\");
3254 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
3258 pr " test_num++;\n";
3259 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
3260 pr " if (%s () == -1) {\n" test_name;
3261 pr " printf (\"%s FAILED\\n\");\n" test_name;
3267 pr " guestfs_close (g);\n";
3268 pr " unlink (\"test1.img\");\n";
3269 pr " unlink (\"test2.img\");\n";
3270 pr " unlink (\"test3.img\");\n";
3273 pr " if (failed > 0) {\n";
3274 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
3282 and generate_one_test name i (init, test) =
3283 let test_name = sprintf "test_%s_%d" name i in
3285 pr "static int %s (void)\n" test_name;
3291 pr " /* InitEmpty for %s (%d) */\n" name i;
3292 List.iter (generate_test_command_call test_name)
3296 pr " /* InitBasicFS for %s (%d): create ext2 on /dev/sda1 */\n" name i;
3297 List.iter (generate_test_command_call test_name)
3300 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
3301 ["mkfs"; "ext2"; "/dev/sda1"];
3302 ["mount"; "/dev/sda1"; "/"]]
3303 | InitBasicFSonLVM ->
3304 pr " /* InitBasicFSonLVM for %s (%d): create ext2 on /dev/VG/LV */\n"
3306 List.iter (generate_test_command_call test_name)
3309 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
3310 ["pvcreate"; "/dev/sda1"];
3311 ["vgcreate"; "VG"; "/dev/sda1"];
3312 ["lvcreate"; "LV"; "VG"; "8"];
3313 ["mkfs"; "ext2"; "/dev/VG/LV"];
3314 ["mount"; "/dev/VG/LV"; "/"]]
3317 let get_seq_last = function
3319 failwithf "%s: you cannot use [] (empty list) when expecting a command"
3322 let seq = List.rev seq in
3323 List.rev (List.tl seq), List.hd seq
3328 pr " /* TestRun for %s (%d) */\n" name i;
3329 List.iter (generate_test_command_call test_name) seq
3330 | TestOutput (seq, expected) ->
3331 pr " /* TestOutput for %s (%d) */\n" name i;
3332 let seq, last = get_seq_last seq in
3334 pr " if (strcmp (r, \"%s\") != 0) {\n" (c_quote expected);
3335 pr " fprintf (stderr, \"%s: expected \\\"%s\\\" but got \\\"%%s\\\"\\n\", r);\n" test_name (c_quote expected);
3339 List.iter (generate_test_command_call test_name) seq;
3340 generate_test_command_call ~test test_name last
3341 | TestOutputList (seq, expected) ->
3342 pr " /* TestOutputList for %s (%d) */\n" name i;
3343 let seq, last = get_seq_last seq in
3347 pr " if (!r[%d]) {\n" i;
3348 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
3349 pr " print_strings (r);\n";
3352 pr " if (strcmp (r[%d], \"%s\") != 0) {\n" i (c_quote str);
3353 pr " fprintf (stderr, \"%s: expected \\\"%s\\\" but got \\\"%%s\\\"\\n\", r[%d]);\n" test_name (c_quote str) i;
3357 pr " if (r[%d] != NULL) {\n" (List.length expected);
3358 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
3360 pr " print_strings (r);\n";
3364 List.iter (generate_test_command_call test_name) seq;
3365 generate_test_command_call ~test test_name last
3366 | TestOutputInt (seq, expected) ->
3367 pr " /* TestOutputInt for %s (%d) */\n" name i;
3368 let seq, last = get_seq_last seq in
3370 pr " if (r != %d) {\n" expected;
3371 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
3377 List.iter (generate_test_command_call test_name) seq;
3378 generate_test_command_call ~test test_name last
3379 | TestOutputTrue seq ->
3380 pr " /* TestOutputTrue for %s (%d) */\n" name i;
3381 let seq, last = get_seq_last seq in
3384 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
3389 List.iter (generate_test_command_call test_name) seq;
3390 generate_test_command_call ~test test_name last
3391 | TestOutputFalse seq ->
3392 pr " /* TestOutputFalse for %s (%d) */\n" name i;
3393 let seq, last = get_seq_last seq in
3396 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
3401 List.iter (generate_test_command_call test_name) seq;
3402 generate_test_command_call ~test test_name last
3403 | TestOutputLength (seq, expected) ->
3404 pr " /* TestOutputLength for %s (%d) */\n" name i;
3405 let seq, last = get_seq_last seq in
3408 pr " for (j = 0; j < %d; ++j)\n" expected;
3409 pr " if (r[j] == NULL) {\n";
3410 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
3412 pr " print_strings (r);\n";
3415 pr " if (r[j] != NULL) {\n";
3416 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
3418 pr " print_strings (r);\n";
3422 List.iter (generate_test_command_call test_name) seq;
3423 generate_test_command_call ~test test_name last
3424 | TestOutputStruct (seq, checks) ->
3425 pr " /* TestOutputStruct for %s (%d) */\n" name i;
3426 let seq, last = get_seq_last seq in
3430 | CompareWithInt (field, expected) ->
3431 pr " if (r->%s != %d) {\n" field expected;
3432 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
3433 test_name field expected;
3434 pr " (int) r->%s);\n" field;
3437 | CompareWithString (field, expected) ->
3438 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
3439 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
3440 test_name field expected;
3441 pr " r->%s);\n" field;
3444 | CompareFieldsIntEq (field1, field2) ->
3445 pr " if (r->%s != r->%s) {\n" field1 field2;
3446 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
3447 test_name field1 field2;
3448 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
3451 | CompareFieldsStrEq (field1, field2) ->
3452 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
3453 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
3454 test_name field1 field2;
3455 pr " r->%s, r->%s);\n" field1 field2;
3460 List.iter (generate_test_command_call test_name) seq;
3461 generate_test_command_call ~test test_name last
3462 | TestLastFail seq ->
3463 pr " /* TestLastFail for %s (%d) */\n" name i;
3464 let seq, last = get_seq_last seq in
3465 List.iter (generate_test_command_call test_name) seq;
3466 generate_test_command_call test_name ~expect_error:true last
3474 (* Generate the code to run a command, leaving the result in 'r'.
3475 * If you expect to get an error then you should set expect_error:true.
3477 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
3479 | [] -> assert false
3481 (* Look up the command to find out what args/ret it has. *)
3484 let _, style, _, _, _, _, _ =
3485 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
3488 failwithf "%s: in test, command %s was not found" test_name name in
3490 if List.length (snd style) <> List.length args then
3491 failwithf "%s: in test, wrong number of args given to %s"
3502 | FileIn _, _ | FileOut _, _ -> ()
3503 | StringList n, arg ->
3504 pr " char *%s[] = {\n" n;
3505 let strs = string_split " " arg in
3507 fun str -> pr " \"%s\",\n" (c_quote str)
3511 ) (List.combine (snd style) args);
3514 match fst style with
3515 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
3516 | RInt64 _ -> pr " int64_t r;\n"; "-1"
3517 | RConstString _ -> pr " const char *r;\n"; "NULL"
3518 | RString _ -> pr " char *r;\n"; "NULL"
3519 | RStringList _ | RHashtable _ ->
3524 pr " struct guestfs_int_bool *r;\n"; "NULL"
3526 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
3528 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
3530 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
3532 pr " struct guestfs_stat *r;\n"; "NULL"
3534 pr " struct guestfs_statvfs *r;\n"; "NULL" in
3536 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
3537 pr " r = guestfs_%s (g" name;
3539 (* Generate the parameters. *)
3543 | FileIn _, arg | FileOut _, arg ->
3544 pr ", \"%s\"" (c_quote arg)
3545 | OptString _, arg ->
3546 if arg = "NULL" then pr ", NULL" else pr ", \"%s\"" (c_quote arg)
3547 | StringList n, _ ->
3551 try int_of_string arg
3552 with Failure "int_of_string" ->
3553 failwithf "%s: expecting an int, but got '%s'" test_name arg in
3556 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
3557 ) (List.combine (snd style) args);
3560 if not expect_error then
3561 pr " if (r == %s)\n" error_code
3563 pr " if (r != %s)\n" error_code;
3566 (* Insert the test code. *)
3572 (match fst style with
3573 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _ -> ()
3574 | RString _ -> pr " free (r);\n"
3575 | RStringList _ | RHashtable _ ->
3576 pr " for (i = 0; r[i] != NULL; ++i)\n";
3577 pr " free (r[i]);\n";
3580 pr " guestfs_free_int_bool (r);\n"
3582 pr " guestfs_free_lvm_pv_list (r);\n"
3584 pr " guestfs_free_lvm_vg_list (r);\n"
3586 pr " guestfs_free_lvm_lv_list (r);\n"
3587 | RStat _ | RStatVFS _ ->
3594 let str = replace_str str "\r" "\\r" in
3595 let str = replace_str str "\n" "\\n" in
3596 let str = replace_str str "\t" "\\t" in
3599 (* Generate a lot of different functions for guestfish. *)
3600 and generate_fish_cmds () =
3601 generate_header CStyle GPLv2;
3605 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3607 let all_functions_sorted =
3609 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3610 ) all_functions_sorted in
3612 pr "#include <stdio.h>\n";
3613 pr "#include <stdlib.h>\n";
3614 pr "#include <string.h>\n";
3615 pr "#include <inttypes.h>\n";
3617 pr "#include <guestfs.h>\n";
3618 pr "#include \"fish.h\"\n";
3621 (* list_commands function, which implements guestfish -h *)
3622 pr "void list_commands (void)\n";
3624 pr " printf (\" %%-16s %%s\\n\", \"Command\", \"Description\");\n";
3625 pr " list_builtin_commands ();\n";
3627 fun (name, _, _, flags, _, shortdesc, _) ->
3628 let name = replace_char name '_' '-' in
3629 pr " printf (\"%%-20s %%s\\n\", \"%s\", \"%s\");\n"
3631 ) all_functions_sorted;
3632 pr " printf (\" Use -h <cmd> / help <cmd> to show detailed help for a command.\\n\");\n";
3636 (* display_command function, which implements guestfish -h cmd *)
3637 pr "void display_command (const char *cmd)\n";
3640 fun (name, style, _, flags, _, shortdesc, longdesc) ->
3641 let name2 = replace_char name '_' '-' in
3643 try find_map (function FishAlias n -> Some n | _ -> None) flags
3644 with Not_found -> name in
3645 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
3647 match snd style with
3651 name2 (String.concat "> <" (List.map name_of_argt args)) in
3654 if List.mem ProtocolLimitWarning flags then
3655 ("\n\n" ^ protocol_limit_warning)
3658 (* For DangerWillRobinson commands, we should probably have
3659 * guestfish prompt before allowing you to use them (especially
3660 * in interactive mode). XXX
3664 if List.mem DangerWillRobinson flags then
3665 ("\n\n" ^ danger_will_robinson)
3668 let describe_alias =
3669 if name <> alias then
3670 sprintf "\n\nYou can use '%s' as an alias for this command." alias
3674 pr "strcasecmp (cmd, \"%s\") == 0" name;
3675 if name <> name2 then
3676 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
3677 if name <> alias then
3678 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
3680 pr " pod2text (\"%s - %s\", %S);\n"
3682 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
3685 pr " display_builtin_command (cmd);\n";
3689 (* print_{pv,vg,lv}_list functions *)
3693 pr "static void print_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
3700 pr " printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
3702 pr " printf (\"%s: \");\n" name;
3703 pr " for (i = 0; i < 32; ++i)\n";
3704 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
3705 pr " printf (\"\\n\");\n"
3707 pr " printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
3709 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
3710 | name, `OptPercent ->
3711 pr " if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
3712 typ name name typ name;
3713 pr " else printf (\"%s: \\n\");\n" name
3717 pr "static void print_%s_list (struct guestfs_lvm_%s_list *%ss)\n"
3722 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
3723 pr " print_%s (&%ss->val[i]);\n" typ typ;
3726 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
3728 (* print_{stat,statvfs} functions *)
3732 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
3737 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
3741 ) ["stat", stat_cols; "statvfs", statvfs_cols];
3743 (* run_<action> actions *)
3745 fun (name, style, _, flags, _, _, _) ->
3746 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
3748 (match fst style with
3751 | RBool _ -> pr " int r;\n"
3752 | RInt64 _ -> pr " int64_t r;\n"
3753 | RConstString _ -> pr " const char *r;\n"
3754 | RString _ -> pr " char *r;\n"
3755 | RStringList _ | RHashtable _ -> pr " char **r;\n"
3756 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"
3757 | RPVList _ -> pr " struct guestfs_lvm_pv_list *r;\n"
3758 | RVGList _ -> pr " struct guestfs_lvm_vg_list *r;\n"
3759 | RLVList _ -> pr " struct guestfs_lvm_lv_list *r;\n"
3760 | RStat _ -> pr " struct guestfs_stat *r;\n"
3761 | RStatVFS _ -> pr " struct guestfs_statvfs *r;\n"
3768 | FileOut n -> pr " const char *%s;\n" n
3769 | StringList n -> pr " char **%s;\n" n
3770 | Bool n -> pr " int %s;\n" n
3771 | Int n -> pr " int %s;\n" n
3774 (* Check and convert parameters. *)
3775 let argc_expected = List.length (snd style) in
3776 pr " if (argc != %d) {\n" argc_expected;
3777 pr " fprintf (stderr, \"%%s should have %d parameter(s)\\n\", cmd);\n"
3779 pr " fprintf (stderr, \"type 'help %%s' for help on %%s\\n\", cmd, cmd);\n";
3785 | String name -> pr " %s = argv[%d];\n" name i
3787 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
3790 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
3793 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
3795 | StringList name ->
3796 pr " %s = parse_string_list (argv[%d]);\n" name i
3798 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
3800 pr " %s = atoi (argv[%d]);\n" name i
3803 (* Call C API function. *)
3805 try find_map (function FishAction n -> Some n | _ -> None) flags
3806 with Not_found -> sprintf "guestfs_%s" name in
3808 generate_call_args ~handle:"g" (snd style);
3811 (* Check return value for errors and display command results. *)
3812 (match fst style with
3813 | RErr -> pr " return r;\n"
3815 pr " if (r == -1) return -1;\n";
3816 pr " printf (\"%%d\\n\", r);\n";
3819 pr " if (r == -1) return -1;\n";
3820 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
3823 pr " if (r == -1) return -1;\n";
3824 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
3827 pr " if (r == NULL) return -1;\n";
3828 pr " printf (\"%%s\\n\", r);\n";
3831 pr " if (r == NULL) return -1;\n";
3832 pr " printf (\"%%s\\n\", r);\n";
3836 pr " if (r == NULL) return -1;\n";
3837 pr " print_strings (r);\n";
3838 pr " free_strings (r);\n";
3841 pr " if (r == NULL) return -1;\n";
3842 pr " printf (\"%%d, %%s\\n\", r->i,\n";
3843 pr " r->b ? \"true\" : \"false\");\n";
3844 pr " guestfs_free_int_bool (r);\n";
3847 pr " if (r == NULL) return -1;\n";
3848 pr " print_pv_list (r);\n";
3849 pr " guestfs_free_lvm_pv_list (r);\n";
3852 pr " if (r == NULL) return -1;\n";
3853 pr " print_vg_list (r);\n";
3854 pr " guestfs_free_lvm_vg_list (r);\n";
3857 pr " if (r == NULL) return -1;\n";
3858 pr " print_lv_list (r);\n";
3859 pr " guestfs_free_lvm_lv_list (r);\n";
3862 pr " if (r == NULL) return -1;\n";
3863 pr " print_stat (r);\n";
3867 pr " if (r == NULL) return -1;\n";
3868 pr " print_statvfs (r);\n";
3872 pr " if (r == NULL) return -1;\n";
3873 pr " print_table (r);\n";
3874 pr " free_strings (r);\n";
3881 (* run_action function *)
3882 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
3885 fun (name, _, _, flags, _, _, _) ->
3886 let name2 = replace_char name '_' '-' in
3888 try find_map (function FishAlias n -> Some n | _ -> None) flags
3889 with Not_found -> name in
3891 pr "strcasecmp (cmd, \"%s\") == 0" name;
3892 if name <> name2 then
3893 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
3894 if name <> alias then
3895 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
3897 pr " return run_%s (cmd, argc, argv);\n" name;
3901 pr " fprintf (stderr, \"%%s: unknown command\\n\", cmd);\n";
3908 (* Readline completion for guestfish. *)
3909 and generate_fish_completion () =
3910 generate_header CStyle GPLv2;
3914 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3924 #ifdef HAVE_LIBREADLINE
3925 #include <readline/readline.h>
3930 #ifdef HAVE_LIBREADLINE
3932 static const char *const commands[] = {
3935 (* Get the commands and sort them, including the aliases. *)
3938 fun (name, _, _, flags, _, _, _) ->
3939 let name2 = replace_char name '_' '-' in
3941 try find_map (function FishAlias n -> Some n | _ -> None) flags
3942 with Not_found -> name in
3944 if name <> alias then [name2; alias] else [name2]
3946 let commands = List.flatten commands in
3947 let commands = List.sort compare commands in
3949 List.iter (pr " \"%s\",\n") commands;
3955 generator (const char *text, int state)
3957 static int index, len;
3962 len = strlen (text);
3965 while ((name = commands[index]) != NULL) {
3967 if (strncasecmp (name, text, len) == 0)
3968 return strdup (name);
3974 #endif /* HAVE_LIBREADLINE */
3976 char **do_completion (const char *text, int start, int end)
3978 char **matches = NULL;
3980 #ifdef HAVE_LIBREADLINE
3982 matches = rl_completion_matches (text, generator);
3989 (* Generate the POD documentation for guestfish. *)
3990 and generate_fish_actions_pod () =
3991 let all_functions_sorted =
3993 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3994 ) all_functions_sorted in
3996 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
3999 fun (name, style, _, flags, _, _, longdesc) ->
4001 Str.global_substitute rex (
4004 try Str.matched_group 1 s
4006 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
4007 "C<" ^ replace_char sub '_' '-' ^ ">"
4009 let name = replace_char name '_' '-' in
4011 try find_map (function FishAlias n -> Some n | _ -> None) flags
4012 with Not_found -> name in
4014 pr "=head2 %s" name;
4015 if name <> alias then
4022 | String n -> pr " %s" n
4023 | OptString n -> pr " %s" n
4024 | StringList n -> pr " '%s ...'" n
4025 | Bool _ -> pr " true|false"
4026 | Int n -> pr " %s" n
4027 | FileIn n | FileOut n -> pr " (%s|-)" n
4031 pr "%s\n\n" longdesc;
4033 if List.exists (function FileIn _ | FileOut _ -> true
4034 | _ -> false) (snd style) then
4035 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
4037 if List.mem ProtocolLimitWarning flags then
4038 pr "%s\n\n" protocol_limit_warning;
4040 if List.mem DangerWillRobinson flags then
4041 pr "%s\n\n" danger_will_robinson
4042 ) all_functions_sorted
4044 (* Generate a C function prototype. *)
4045 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
4046 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
4048 ?handle name style =
4049 if extern then pr "extern ";
4050 if static then pr "static ";
4051 (match fst style with
4053 | RInt _ -> pr "int "
4054 | RInt64 _ -> pr "int64_t "
4055 | RBool _ -> pr "int "
4056 | RConstString _ -> pr "const char *"
4057 | RString _ -> pr "char *"
4058 | RStringList _ | RHashtable _ -> pr "char **"
4060 if not in_daemon then pr "struct guestfs_int_bool *"
4061 else pr "guestfs_%s_ret *" name
4063 if not in_daemon then pr "struct guestfs_lvm_pv_list *"
4064 else pr "guestfs_lvm_int_pv_list *"
4066 if not in_daemon then pr "struct guestfs_lvm_vg_list *"
4067 else pr "guestfs_lvm_int_vg_list *"
4069 if not in_daemon then pr "struct guestfs_lvm_lv_list *"
4070 else pr "guestfs_lvm_int_lv_list *"
4072 if not in_daemon then pr "struct guestfs_stat *"
4073 else pr "guestfs_int_stat *"
4075 if not in_daemon then pr "struct guestfs_statvfs *"
4076 else pr "guestfs_int_statvfs *"
4078 pr "%s%s (" prefix name;
4079 if handle = None && List.length (snd style) = 0 then
4082 let comma = ref false in
4085 | Some handle -> pr "guestfs_h *%s" handle; comma := true
4089 if single_line then pr ", " else pr ",\n\t\t"
4096 | OptString n -> next (); pr "const char *%s" n
4097 | StringList n -> next (); pr "char * const* const %s" n
4098 | Bool n -> next (); pr "int %s" n
4099 | Int n -> next (); pr "int %s" n
4102 if not in_daemon then (next (); pr "const char *%s" n)
4106 if semicolon then pr ";";
4107 if newline then pr "\n"
4109 (* Generate C call arguments, eg "(handle, foo, bar)" *)
4110 and generate_call_args ?handle args =
4112 let comma = ref false in
4115 | Some handle -> pr "%s" handle; comma := true
4119 if !comma then pr ", ";
4121 pr "%s" (name_of_argt arg)
4125 (* Generate the OCaml bindings interface. *)
4126 and generate_ocaml_mli () =
4127 generate_header OCamlStyle LGPLv2;
4130 (** For API documentation you should refer to the C API
4131 in the guestfs(3) manual page. The OCaml API uses almost
4132 exactly the same calls. *)
4135 (** A [guestfs_h] handle. *)
4137 exception Error of string
4138 (** This exception is raised when there is an error. *)
4140 val create : unit -> t
4142 val close : t -> unit
4143 (** Handles are closed by the garbage collector when they become
4144 unreferenced, but callers can also call this in order to
4145 provide predictable cleanup. *)
4148 generate_ocaml_lvm_structure_decls ();
4150 generate_ocaml_stat_structure_decls ();
4154 fun (name, style, _, _, _, shortdesc, _) ->
4155 generate_ocaml_prototype name style;
4156 pr "(** %s *)\n" shortdesc;
4160 (* Generate the OCaml bindings implementation. *)
4161 and generate_ocaml_ml () =
4162 generate_header OCamlStyle LGPLv2;
4166 exception Error of string
4167 external create : unit -> t = \"ocaml_guestfs_create\"
4168 external close : t -> unit = \"ocaml_guestfs_close\"
4171 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
4175 generate_ocaml_lvm_structure_decls ();
4177 generate_ocaml_stat_structure_decls ();
4181 fun (name, style, _, _, _, shortdesc, _) ->
4182 generate_ocaml_prototype ~is_external:true name style;
4185 (* Generate the OCaml bindings C implementation. *)
4186 and generate_ocaml_c () =
4187 generate_header CStyle LGPLv2;
4194 #include <caml/config.h>
4195 #include <caml/alloc.h>
4196 #include <caml/callback.h>
4197 #include <caml/fail.h>
4198 #include <caml/memory.h>
4199 #include <caml/mlvalues.h>
4200 #include <caml/signals.h>
4202 #include <guestfs.h>
4204 #include \"guestfs_c.h\"
4206 /* Copy a hashtable of string pairs into an assoc-list. We return
4207 * the list in reverse order, but hashtables aren't supposed to be
4210 static CAMLprim value
4211 copy_table (char * const * argv)
4214 CAMLlocal5 (rv, pairv, kv, vv, cons);
4218 for (i = 0; argv[i] != NULL; i += 2) {
4219 kv = caml_copy_string (argv[i]);
4220 vv = caml_copy_string (argv[i+1]);
4221 pairv = caml_alloc (2, 0);
4222 Store_field (pairv, 0, kv);
4223 Store_field (pairv, 1, vv);
4224 cons = caml_alloc (2, 0);
4225 Store_field (cons, 1, rv);
4227 Store_field (cons, 0, pairv);
4235 (* LVM struct copy functions. *)
4238 let has_optpercent_col =
4239 List.exists (function (_, `OptPercent) -> true | _ -> false) cols in
4241 pr "static CAMLprim value\n";
4242 pr "copy_lvm_%s (const struct guestfs_lvm_%s *%s)\n" typ typ typ;
4244 pr " CAMLparam0 ();\n";
4245 if has_optpercent_col then
4246 pr " CAMLlocal3 (rv, v, v2);\n"
4248 pr " CAMLlocal2 (rv, v);\n";
4250 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
4255 pr " v = caml_copy_string (%s->%s);\n" typ name
4257 pr " v = caml_alloc_string (32);\n";
4258 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
4261 pr " v = caml_copy_int64 (%s->%s);\n" typ name
4262 | name, `OptPercent ->
4263 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
4264 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
4265 pr " v = caml_alloc (1, 0);\n";
4266 pr " Store_field (v, 0, v2);\n";
4267 pr " } else /* None */\n";
4268 pr " v = Val_int (0);\n";
4270 pr " Store_field (rv, %d, v);\n" i
4272 pr " CAMLreturn (rv);\n";
4276 pr "static CAMLprim value\n";
4277 pr "copy_lvm_%s_list (const struct guestfs_lvm_%s_list *%ss)\n"
4280 pr " CAMLparam0 ();\n";
4281 pr " CAMLlocal2 (rv, v);\n";
4284 pr " if (%ss->len == 0)\n" typ;
4285 pr " CAMLreturn (Atom (0));\n";
4287 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
4288 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
4289 pr " v = copy_lvm_%s (&%ss->val[i]);\n" typ typ;
4290 pr " caml_modify (&Field (rv, i), v);\n";
4292 pr " CAMLreturn (rv);\n";
4296 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
4298 (* Stat copy functions. *)
4301 pr "static CAMLprim value\n";
4302 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
4304 pr " CAMLparam0 ();\n";
4305 pr " CAMLlocal2 (rv, v);\n";
4307 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
4312 pr " v = caml_copy_int64 (%s->%s);\n" typ name
4314 pr " Store_field (rv, %d, v);\n" i
4316 pr " CAMLreturn (rv);\n";
4319 ) ["stat", stat_cols; "statvfs", statvfs_cols];
4323 fun (name, style, _, _, _, _, _) ->
4325 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
4327 pr "CAMLprim value\n";
4328 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
4329 List.iter (pr ", value %s") (List.tl params);
4334 | [p1; p2; p3; p4; p5] ->
4335 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
4336 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
4337 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
4338 pr " CAMLxparam%d (%s);\n"
4339 (List.length rest) (String.concat ", " rest)
4341 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
4343 pr " CAMLlocal1 (rv);\n";
4346 pr " guestfs_h *g = Guestfs_val (gv);\n";
4347 pr " if (g == NULL)\n";
4348 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
4356 pr " const char *%s = String_val (%sv);\n" n n
4358 pr " const char *%s =\n" n;
4359 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
4362 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
4364 pr " int %s = Bool_val (%sv);\n" n n
4366 pr " int %s = Int_val (%sv);\n" n n
4369 match fst style with
4370 | RErr -> pr " int r;\n"; "-1"
4371 | RInt _ -> pr " int r;\n"; "-1"
4372 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4373 | RBool _ -> pr " int r;\n"; "-1"
4374 | RConstString _ -> pr " const char *r;\n"; "NULL"
4375 | RString _ -> pr " char *r;\n"; "NULL"
4381 pr " struct guestfs_int_bool *r;\n"; "NULL"
4383 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
4385 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
4387 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
4389 pr " struct guestfs_stat *r;\n"; "NULL"
4391 pr " struct guestfs_statvfs *r;\n"; "NULL"
4398 pr " caml_enter_blocking_section ();\n";
4399 pr " r = guestfs_%s " name;
4400 generate_call_args ~handle:"g" (snd style);
4402 pr " caml_leave_blocking_section ();\n";
4407 pr " ocaml_guestfs_free_strings (%s);\n" n;
4408 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
4411 pr " if (r == %s)\n" error_code;
4412 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
4415 (match fst style with
4416 | RErr -> pr " rv = Val_unit;\n"
4417 | RInt _ -> pr " rv = Val_int (r);\n"
4419 pr " rv = caml_copy_int64 (r);\n"
4420 | RBool _ -> pr " rv = Val_bool (r);\n"
4421 | RConstString _ -> pr " rv = caml_copy_string (r);\n"
4423 pr " rv = caml_copy_string (r);\n";
4426 pr " rv = caml_copy_string_array ((const char **) r);\n";
4427 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
4430 pr " rv = caml_alloc (2, 0);\n";
4431 pr " Store_field (rv, 0, Val_int (r->i));\n";
4432 pr " Store_field (rv, 1, Val_bool (r->b));\n";
4433 pr " guestfs_free_int_bool (r);\n";
4435 pr " rv = copy_lvm_pv_list (r);\n";
4436 pr " guestfs_free_lvm_pv_list (r);\n";
4438 pr " rv = copy_lvm_vg_list (r);\n";
4439 pr " guestfs_free_lvm_vg_list (r);\n";
4441 pr " rv = copy_lvm_lv_list (r);\n";
4442 pr " guestfs_free_lvm_lv_list (r);\n";
4444 pr " rv = copy_stat (r);\n";
4447 pr " rv = copy_statvfs (r);\n";
4450 pr " rv = copy_table (r);\n";
4451 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
4455 pr " CAMLreturn (rv);\n";
4459 if List.length params > 5 then (
4460 pr "CAMLprim value\n";
4461 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
4463 pr " return ocaml_guestfs_%s (argv[0]" name;
4464 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
4471 and generate_ocaml_lvm_structure_decls () =
4474 pr "type lvm_%s = {\n" typ;
4477 | name, `String -> pr " %s : string;\n" name
4478 | name, `UUID -> pr " %s : string;\n" name
4479 | name, `Bytes -> pr " %s : int64;\n" name
4480 | name, `Int -> pr " %s : int64;\n" name
4481 | name, `OptPercent -> pr " %s : float option;\n" name
4485 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
4487 and generate_ocaml_stat_structure_decls () =
4490 pr "type %s = {\n" typ;
4493 | name, `Int -> pr " %s : int64;\n" name
4497 ) ["stat", stat_cols; "statvfs", statvfs_cols]
4499 and generate_ocaml_prototype ?(is_external = false) name style =
4500 if is_external then pr "external " else pr "val ";
4501 pr "%s : t -> " name;
4504 | String _ | FileIn _ | FileOut _ -> pr "string -> "
4505 | OptString _ -> pr "string option -> "
4506 | StringList _ -> pr "string array -> "
4507 | Bool _ -> pr "bool -> "
4508 | Int _ -> pr "int -> "
4510 (match fst style with
4511 | RErr -> pr "unit" (* all errors are turned into exceptions *)
4512 | RInt _ -> pr "int"
4513 | RInt64 _ -> pr "int64"
4514 | RBool _ -> pr "bool"
4515 | RConstString _ -> pr "string"
4516 | RString _ -> pr "string"
4517 | RStringList _ -> pr "string array"
4518 | RIntBool _ -> pr "int * bool"
4519 | RPVList _ -> pr "lvm_pv array"
4520 | RVGList _ -> pr "lvm_vg array"
4521 | RLVList _ -> pr "lvm_lv array"
4522 | RStat _ -> pr "stat"
4523 | RStatVFS _ -> pr "statvfs"
4524 | RHashtable _ -> pr "(string * string) list"
4526 if is_external then (
4528 if List.length (snd style) + 1 > 5 then
4529 pr "\"ocaml_guestfs_%s_byte\" " name;
4530 pr "\"ocaml_guestfs_%s\"" name
4534 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
4535 and generate_perl_xs () =
4536 generate_header CStyle LGPLv2;
4539 #include \"EXTERN.h\"
4543 #include <guestfs.h>
4546 #define PRId64 \"lld\"
4550 my_newSVll(long long val) {
4551 #ifdef USE_64_BIT_ALL
4552 return newSViv(val);
4556 len = snprintf(buf, 100, \"%%\" PRId64, val);
4557 return newSVpv(buf, len);
4562 #define PRIu64 \"llu\"
4566 my_newSVull(unsigned long long val) {
4567 #ifdef USE_64_BIT_ALL
4568 return newSVuv(val);
4572 len = snprintf(buf, 100, \"%%\" PRIu64, val);
4573 return newSVpv(buf, len);
4577 /* http://www.perlmonks.org/?node_id=680842 */
4579 XS_unpack_charPtrPtr (SV *arg) {
4584 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
4585 croak (\"array reference expected\");
4587 av = (AV *)SvRV (arg);
4588 ret = malloc (av_len (av) + 1 + 1);
4590 croak (\"malloc failed\");
4592 for (i = 0; i <= av_len (av); i++) {
4593 SV **elem = av_fetch (av, i, 0);
4595 if (!elem || !*elem)
4596 croak (\"missing element in list\");
4598 ret[i] = SvPV_nolen (*elem);
4606 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
4611 RETVAL = guestfs_create ();
4613 croak (\"could not create guestfs handle\");
4614 guestfs_set_error_handler (RETVAL, NULL, NULL);
4627 fun (name, style, _, _, _, _, _) ->
4628 (match fst style with
4629 | RErr -> pr "void\n"
4630 | RInt _ -> pr "SV *\n"
4631 | RInt64 _ -> pr "SV *\n"
4632 | RBool _ -> pr "SV *\n"
4633 | RConstString _ -> pr "SV *\n"
4634 | RString _ -> pr "SV *\n"
4637 | RPVList _ | RVGList _ | RLVList _
4638 | RStat _ | RStatVFS _
4640 pr "void\n" (* all lists returned implictly on the stack *)
4642 (* Call and arguments. *)
4644 generate_call_args ~handle:"g" (snd style);
4646 pr " guestfs_h *g;\n";
4649 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
4650 | OptString n -> pr " char *%s;\n" n
4651 | StringList n -> pr " char **%s;\n" n
4652 | Bool n -> pr " int %s;\n" n
4653 | Int n -> pr " int %s;\n" n
4656 let do_cleanups () =
4659 | String _ | OptString _ | Bool _ | Int _
4660 | FileIn _ | FileOut _ -> ()
4661 | StringList n -> pr " free (%s);\n" n
4666 (match fst style with
4671 pr " r = guestfs_%s " name;
4672 generate_call_args ~handle:"g" (snd style);
4675 pr " if (r == -1)\n";
4676 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4682 pr " %s = guestfs_%s " n name;
4683 generate_call_args ~handle:"g" (snd style);
4686 pr " if (%s == -1)\n" n;
4687 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4688 pr " RETVAL = newSViv (%s);\n" n;
4693 pr " int64_t %s;\n" n;
4695 pr " %s = guestfs_%s " n name;
4696 generate_call_args ~handle:"g" (snd style);
4699 pr " if (%s == -1)\n" n;
4700 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4701 pr " RETVAL = my_newSVll (%s);\n" n;
4706 pr " const char *%s;\n" n;
4708 pr " %s = guestfs_%s " n name;
4709 generate_call_args ~handle:"g" (snd style);
4712 pr " if (%s == NULL)\n" n;
4713 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4714 pr " RETVAL = newSVpv (%s, 0);\n" n;
4719 pr " char *%s;\n" n;
4721 pr " %s = guestfs_%s " n name;
4722 generate_call_args ~handle:"g" (snd style);
4725 pr " if (%s == NULL)\n" n;
4726 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4727 pr " RETVAL = newSVpv (%s, 0);\n" n;
4728 pr " free (%s);\n" n;
4731 | RStringList n | RHashtable n ->
4733 pr " char **%s;\n" n;
4736 pr " %s = guestfs_%s " n name;
4737 generate_call_args ~handle:"g" (snd style);
4740 pr " if (%s == NULL)\n" n;
4741 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4742 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
4743 pr " EXTEND (SP, n);\n";
4744 pr " for (i = 0; i < n; ++i) {\n";
4745 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
4746 pr " free (%s[i]);\n" n;
4748 pr " free (%s);\n" n;
4751 pr " struct guestfs_int_bool *r;\n";
4753 pr " r = guestfs_%s " name;
4754 generate_call_args ~handle:"g" (snd style);
4757 pr " if (r == NULL)\n";
4758 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4759 pr " EXTEND (SP, 2);\n";
4760 pr " PUSHs (sv_2mortal (newSViv (r->i)));\n";
4761 pr " PUSHs (sv_2mortal (newSViv (r->b)));\n";
4762 pr " guestfs_free_int_bool (r);\n";
4764 generate_perl_lvm_code "pv" pv_cols name style n do_cleanups
4766 generate_perl_lvm_code "vg" vg_cols name style n do_cleanups
4768 generate_perl_lvm_code "lv" lv_cols name style n do_cleanups
4770 generate_perl_stat_code "stat" stat_cols name style n do_cleanups
4772 generate_perl_stat_code
4773 "statvfs" statvfs_cols name style n do_cleanups
4779 and generate_perl_lvm_code typ cols name style n do_cleanups =
4781 pr " struct guestfs_lvm_%s_list *%s;\n" typ n;
4785 pr " %s = guestfs_%s " n name;
4786 generate_call_args ~handle:"g" (snd style);
4789 pr " if (%s == NULL)\n" n;
4790 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4791 pr " EXTEND (SP, %s->len);\n" n;
4792 pr " for (i = 0; i < %s->len; ++i) {\n" n;
4793 pr " hv = newHV ();\n";
4797 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
4798 name (String.length name) n name
4800 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
4801 name (String.length name) n name
4803 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
4804 name (String.length name) n name
4806 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
4807 name (String.length name) n name
4808 | name, `OptPercent ->
4809 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
4810 name (String.length name) n name
4812 pr " PUSHs (sv_2mortal ((SV *) hv));\n";
4814 pr " guestfs_free_lvm_%s_list (%s);\n" typ n
4816 and generate_perl_stat_code typ cols name style n do_cleanups =
4818 pr " struct guestfs_%s *%s;\n" typ n;
4820 pr " %s = guestfs_%s " n name;
4821 generate_call_args ~handle:"g" (snd style);
4824 pr " if (%s == NULL)\n" n;
4825 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4826 pr " EXTEND (SP, %d);\n" (List.length cols);
4830 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n" n name
4832 pr " free (%s);\n" n
4834 (* Generate Sys/Guestfs.pm. *)
4835 and generate_perl_pm () =
4836 generate_header HashStyle LGPLv2;
4843 Sys::Guestfs - Perl bindings for libguestfs
4849 my $h = Sys::Guestfs->new ();
4850 $h->add_drive ('guest.img');
4853 $h->mount ('/dev/sda1', '/');
4854 $h->touch ('/hello');
4859 The C<Sys::Guestfs> module provides a Perl XS binding to the
4860 libguestfs API for examining and modifying virtual machine
4863 Amongst the things this is good for: making batch configuration
4864 changes to guests, getting disk used/free statistics (see also:
4865 virt-df), migrating between virtualization systems (see also:
4866 virt-p2v), performing partial backups, performing partial guest
4867 clones, cloning guests and changing registry/UUID/hostname info, and
4870 Libguestfs uses Linux kernel and qemu code, and can access any type of
4871 guest filesystem that Linux and qemu can, including but not limited
4872 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
4873 schemes, qcow, qcow2, vmdk.
4875 Libguestfs provides ways to enumerate guest storage (eg. partitions,
4876 LVs, what filesystem is in each LV, etc.). It can also run commands
4877 in the context of the guest. Also you can access filesystems over FTP.
4881 All errors turn into calls to C<croak> (see L<Carp(3)>).
4889 package Sys::Guestfs;
4895 XSLoader::load ('Sys::Guestfs');
4897 =item $h = Sys::Guestfs->new ();
4899 Create a new guestfs handle.
4905 my $class = ref ($proto) || $proto;
4907 my $self = Sys::Guestfs::_create ();
4908 bless $self, $class;
4914 (* Actions. We only need to print documentation for these as
4915 * they are pulled in from the XS code automatically.
4918 fun (name, style, _, flags, _, _, longdesc) ->
4919 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
4921 generate_perl_prototype name style;
4923 pr "%s\n\n" longdesc;
4924 if List.mem ProtocolLimitWarning flags then
4925 pr "%s\n\n" protocol_limit_warning;
4926 if List.mem DangerWillRobinson flags then
4927 pr "%s\n\n" danger_will_robinson
4928 ) all_functions_sorted;
4940 Copyright (C) 2009 Red Hat Inc.
4944 Please see the file COPYING.LIB for the full license.
4948 L<guestfs(3)>, L<guestfish(1)>.
4953 and generate_perl_prototype name style =
4954 (match fst style with
4960 | RString n -> pr "$%s = " n
4961 | RIntBool (n, m) -> pr "($%s, $%s) = " n m
4965 | RLVList n -> pr "@%s = " n
4968 | RHashtable n -> pr "%%%s = " n
4971 let comma = ref false in
4974 if !comma then pr ", ";
4977 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
4984 (* Generate Python C module. *)
4985 and generate_python_c () =
4986 generate_header CStyle LGPLv2;
4995 #include \"guestfs.h\"
5003 get_handle (PyObject *obj)
5006 assert (obj != Py_None);
5007 return ((Pyguestfs_Object *) obj)->g;
5011 put_handle (guestfs_h *g)
5015 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
5018 /* This list should be freed (but not the strings) after use. */
5019 static const char **
5020 get_string_list (PyObject *obj)
5027 if (!PyList_Check (obj)) {
5028 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
5032 len = PyList_Size (obj);
5033 r = malloc (sizeof (char *) * (len+1));
5035 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
5039 for (i = 0; i < len; ++i)
5040 r[i] = PyString_AsString (PyList_GetItem (obj, i));
5047 put_string_list (char * const * const argv)
5052 for (argc = 0; argv[argc] != NULL; ++argc)
5055 list = PyList_New (argc);
5056 for (i = 0; i < argc; ++i)
5057 PyList_SetItem (list, i, PyString_FromString (argv[i]));
5063 put_table (char * const * const argv)
5065 PyObject *list, *item;
5068 for (argc = 0; argv[argc] != NULL; ++argc)
5071 list = PyList_New (argc >> 1);
5072 for (i = 0; i < argc; i += 2) {
5073 item = PyTuple_New (2);
5074 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
5075 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
5076 PyList_SetItem (list, i >> 1, item);
5083 free_strings (char **argv)
5087 for (argc = 0; argv[argc] != NULL; ++argc)
5093 py_guestfs_create (PyObject *self, PyObject *args)
5097 g = guestfs_create ();
5099 PyErr_SetString (PyExc_RuntimeError,
5100 \"guestfs.create: failed to allocate handle\");
5103 guestfs_set_error_handler (g, NULL, NULL);
5104 return put_handle (g);
5108 py_guestfs_close (PyObject *self, PyObject *args)
5113 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
5115 g = get_handle (py_g);
5119 Py_INCREF (Py_None);
5125 (* LVM structures, turned into Python dictionaries. *)
5128 pr "static PyObject *\n";
5129 pr "put_lvm_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
5131 pr " PyObject *dict;\n";
5133 pr " dict = PyDict_New ();\n";
5137 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5138 pr " PyString_FromString (%s->%s));\n"
5141 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5142 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
5145 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5146 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
5149 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5150 pr " PyLong_FromLongLong (%s->%s));\n"
5152 | name, `OptPercent ->
5153 pr " if (%s->%s >= 0)\n" typ name;
5154 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5155 pr " PyFloat_FromDouble ((double) %s->%s));\n"
5158 pr " Py_INCREF (Py_None);\n";
5159 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
5162 pr " return dict;\n";
5166 pr "static PyObject *\n";
5167 pr "put_lvm_%s_list (struct guestfs_lvm_%s_list *%ss)\n" typ typ typ;
5169 pr " PyObject *list;\n";
5172 pr " list = PyList_New (%ss->len);\n" typ;
5173 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
5174 pr " PyList_SetItem (list, i, put_lvm_%s (&%ss->val[i]));\n" typ typ;
5175 pr " return list;\n";
5178 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
5180 (* Stat structures, turned into Python dictionaries. *)
5183 pr "static PyObject *\n";
5184 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
5186 pr " PyObject *dict;\n";
5188 pr " dict = PyDict_New ();\n";
5192 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5193 pr " PyLong_FromLongLong (%s->%s));\n"
5196 pr " return dict;\n";
5199 ) ["stat", stat_cols; "statvfs", statvfs_cols];
5201 (* Python wrapper functions. *)
5203 fun (name, style, _, _, _, _, _) ->
5204 pr "static PyObject *\n";
5205 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
5208 pr " PyObject *py_g;\n";
5209 pr " guestfs_h *g;\n";
5210 pr " PyObject *py_r;\n";
5213 match fst style with
5214 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5215 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5216 | RConstString _ -> pr " const char *r;\n"; "NULL"
5217 | RString _ -> pr " char *r;\n"; "NULL"
5218 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5219 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
5220 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5221 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5222 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5223 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
5224 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
5228 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
5229 | OptString n -> pr " const char *%s;\n" n
5231 pr " PyObject *py_%s;\n" n;
5232 pr " const char **%s;\n" n
5233 | Bool n -> pr " int %s;\n" n
5234 | Int n -> pr " int %s;\n" n
5239 (* Convert the parameters. *)
5240 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
5243 | String _ | FileIn _ | FileOut _ -> pr "s"
5244 | OptString _ -> pr "z"
5245 | StringList _ -> pr "O"
5246 | Bool _ -> pr "i" (* XXX Python has booleans? *)
5249 pr ":guestfs_%s\",\n" name;
5253 | String n | FileIn n | FileOut n -> pr ", &%s" n
5254 | OptString n -> pr ", &%s" n
5255 | StringList n -> pr ", &py_%s" n
5256 | Bool n -> pr ", &%s" n
5257 | Int n -> pr ", &%s" n
5261 pr " return NULL;\n";
5263 pr " g = get_handle (py_g);\n";
5266 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5268 pr " %s = get_string_list (py_%s);\n" n n;
5269 pr " if (!%s) return NULL;\n" n
5274 pr " r = guestfs_%s " name;
5275 generate_call_args ~handle:"g" (snd style);
5280 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5282 pr " free (%s);\n" n
5285 pr " if (r == %s) {\n" error_code;
5286 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
5287 pr " return NULL;\n";
5291 (match fst style with
5293 pr " Py_INCREF (Py_None);\n";
5294 pr " py_r = Py_None;\n"
5296 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
5297 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
5298 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
5300 pr " py_r = PyString_FromString (r);\n";
5303 pr " py_r = put_string_list (r);\n";
5304 pr " free_strings (r);\n"
5306 pr " py_r = PyTuple_New (2);\n";
5307 pr " PyTuple_SetItem (py_r, 0, PyInt_FromLong ((long) r->i));\n";
5308 pr " PyTuple_SetItem (py_r, 1, PyInt_FromLong ((long) r->b));\n";
5309 pr " guestfs_free_int_bool (r);\n"
5311 pr " py_r = put_lvm_pv_list (r);\n";
5312 pr " guestfs_free_lvm_pv_list (r);\n"
5314 pr " py_r = put_lvm_vg_list (r);\n";
5315 pr " guestfs_free_lvm_vg_list (r);\n"
5317 pr " py_r = put_lvm_lv_list (r);\n";
5318 pr " guestfs_free_lvm_lv_list (r);\n"
5320 pr " py_r = put_stat (r);\n";
5323 pr " py_r = put_statvfs (r);\n";
5326 pr " py_r = put_table (r);\n";
5327 pr " free_strings (r);\n"
5330 pr " return py_r;\n";
5335 (* Table of functions. *)
5336 pr "static PyMethodDef methods[] = {\n";
5337 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
5338 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
5340 fun (name, _, _, _, _, _, _) ->
5341 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
5344 pr " { NULL, NULL, 0, NULL }\n";
5348 (* Init function. *)
5351 initlibguestfsmod (void)
5353 static int initialized = 0;
5355 if (initialized) return;
5356 Py_InitModule ((char *) \"libguestfsmod\", methods);
5361 (* Generate Python module. *)
5362 and generate_python_py () =
5363 generate_header HashStyle LGPLv2;
5366 u\"\"\"Python bindings for libguestfs
5369 g = guestfs.GuestFS ()
5370 g.add_drive (\"guest.img\")
5373 parts = g.list_partitions ()
5375 The guestfs module provides a Python binding to the libguestfs API
5376 for examining and modifying virtual machine disk images.
5378 Amongst the things this is good for: making batch configuration
5379 changes to guests, getting disk used/free statistics (see also:
5380 virt-df), migrating between virtualization systems (see also:
5381 virt-p2v), performing partial backups, performing partial guest
5382 clones, cloning guests and changing registry/UUID/hostname info, and
5385 Libguestfs uses Linux kernel and qemu code, and can access any type of
5386 guest filesystem that Linux and qemu can, including but not limited
5387 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
5388 schemes, qcow, qcow2, vmdk.
5390 Libguestfs provides ways to enumerate guest storage (eg. partitions,
5391 LVs, what filesystem is in each LV, etc.). It can also run commands
5392 in the context of the guest. Also you can access filesystems over FTP.
5394 Errors which happen while using the API are turned into Python
5395 RuntimeError exceptions.
5397 To create a guestfs handle you usually have to perform the following
5400 # Create the handle, call add_drive at least once, and possibly
5401 # several times if the guest has multiple block devices:
5402 g = guestfs.GuestFS ()
5403 g.add_drive (\"guest.img\")
5405 # Launch the qemu subprocess and wait for it to become ready:
5409 # Now you can issue commands, for example:
5414 import libguestfsmod
5417 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
5419 def __init__ (self):
5420 \"\"\"Create a new libguestfs handle.\"\"\"
5421 self._o = libguestfsmod.create ()
5424 libguestfsmod.close (self._o)
5429 fun (name, style, _, flags, _, _, longdesc) ->
5430 let doc = replace_str longdesc "C<guestfs_" "C<g." in
5432 match fst style with
5433 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _
5436 doc ^ "\n\nThis function returns a list of strings."
5438 doc ^ "\n\nThis function returns a tuple (int, bool).\n"
5440 doc ^ "\n\nThis function returns a list of PVs. Each PV is represented as a dictionary."
5442 doc ^ "\n\nThis function returns a list of VGs. Each VG is represented as a dictionary."
5444 doc ^ "\n\nThis function returns a list of LVs. Each LV is represented as a dictionary."
5446 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the stat structure."
5448 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the statvfs structure."
5450 doc ^ "\n\nThis function returns a dictionary." in
5452 if List.mem ProtocolLimitWarning flags then
5453 doc ^ "\n\n" ^ protocol_limit_warning
5456 if List.mem DangerWillRobinson flags then
5457 doc ^ "\n\n" ^ danger_will_robinson
5459 let doc = pod2text ~width:60 name doc in
5460 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
5461 let doc = String.concat "\n " doc in
5464 generate_call_args ~handle:"self" (snd style);
5466 pr " u\"\"\"%s\"\"\"\n" doc;
5467 pr " return libguestfsmod.%s " name;
5468 generate_call_args ~handle:"self._o" (snd style);
5473 (* Useful if you need the longdesc POD text as plain text. Returns a
5476 * This is the slowest thing about autogeneration.
5478 and pod2text ~width name longdesc =
5479 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
5480 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
5482 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
5483 let chan = Unix.open_process_in cmd in
5484 let lines = ref [] in
5486 let line = input_line chan in
5487 if i = 1 then (* discard the first line of output *)
5490 let line = triml line in
5491 lines := line :: !lines;
5494 let lines = try loop 1 with End_of_file -> List.rev !lines in
5495 Unix.unlink filename;
5496 match Unix.close_process_in chan with
5497 | Unix.WEXITED 0 -> lines
5499 failwithf "pod2text: process exited with non-zero status (%d)" i
5500 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
5501 failwithf "pod2text: process signalled or stopped by signal %d" i
5503 (* Generate ruby bindings. *)
5504 and generate_ruby_c () =
5505 generate_header CStyle LGPLv2;
5513 #include \"guestfs.h\"
5515 #include \"extconf.h\"
5517 static VALUE m_guestfs; /* guestfs module */
5518 static VALUE c_guestfs; /* guestfs_h handle */
5519 static VALUE e_Error; /* used for all errors */
5521 static void ruby_guestfs_free (void *p)
5524 guestfs_close ((guestfs_h *) p);
5527 static VALUE ruby_guestfs_create (VALUE m)
5531 g = guestfs_create ();
5533 rb_raise (e_Error, \"failed to create guestfs handle\");
5535 /* Don't print error messages to stderr by default. */
5536 guestfs_set_error_handler (g, NULL, NULL);
5538 /* Wrap it, and make sure the close function is called when the
5541 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
5544 static VALUE ruby_guestfs_close (VALUE gv)
5547 Data_Get_Struct (gv, guestfs_h, g);
5549 ruby_guestfs_free (g);
5550 DATA_PTR (gv) = NULL;
5558 fun (name, style, _, _, _, _, _) ->
5559 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
5560 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
5563 pr " guestfs_h *g;\n";
5564 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
5566 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
5572 | String n | FileIn n | FileOut n ->
5573 pr " const char *%s = StringValueCStr (%sv);\n" n n;
5575 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
5576 pr " \"%s\", \"%s\");\n" n name
5578 pr " const char *%s = StringValueCStr (%sv);\n" n n
5582 pr " int i, len;\n";
5583 pr " len = RARRAY_LEN (%sv);\n" n;
5584 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
5586 pr " for (i = 0; i < len; ++i) {\n";
5587 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
5588 pr " %s[i] = StringValueCStr (v);\n" n;
5590 pr " %s[len] = NULL;\n" n;
5594 pr " int %s = NUM2INT (%sv);\n" n n
5599 match fst style with
5600 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5601 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5602 | RConstString _ -> pr " const char *r;\n"; "NULL"
5603 | RString _ -> pr " char *r;\n"; "NULL"
5604 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5605 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
5606 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5607 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5608 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5609 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
5610 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
5613 pr " r = guestfs_%s " name;
5614 generate_call_args ~handle:"g" (snd style);
5619 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5621 pr " free (%s);\n" n
5624 pr " if (r == %s)\n" error_code;
5625 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
5628 (match fst style with
5630 pr " return Qnil;\n"
5631 | RInt _ | RBool _ ->
5632 pr " return INT2NUM (r);\n"
5634 pr " return ULL2NUM (r);\n"
5636 pr " return rb_str_new2 (r);\n";
5638 pr " VALUE rv = rb_str_new2 (r);\n";
5642 pr " int i, len = 0;\n";
5643 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
5644 pr " VALUE rv = rb_ary_new2 (len);\n";
5645 pr " for (i = 0; r[i] != NULL; ++i) {\n";
5646 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
5647 pr " free (r[i]);\n";
5652 pr " VALUE rv = rb_ary_new2 (2);\n";
5653 pr " rb_ary_push (rv, INT2NUM (r->i));\n";
5654 pr " rb_ary_push (rv, INT2NUM (r->b));\n";
5655 pr " guestfs_free_int_bool (r);\n";
5658 generate_ruby_lvm_code "pv" pv_cols
5660 generate_ruby_lvm_code "vg" vg_cols
5662 generate_ruby_lvm_code "lv" lv_cols
5664 pr " VALUE rv = rb_hash_new ();\n";
5668 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
5673 pr " VALUE rv = rb_hash_new ();\n";
5677 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
5682 pr " VALUE rv = rb_hash_new ();\n";
5684 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
5685 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
5686 pr " free (r[i]);\n";
5687 pr " free (r[i+1]);\n";
5698 /* Initialize the module. */
5699 void Init__guestfs ()
5701 m_guestfs = rb_define_module (\"Guestfs\");
5702 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
5703 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
5705 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
5706 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
5709 (* Define the rest of the methods. *)
5711 fun (name, style, _, _, _, _, _) ->
5712 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
5713 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
5718 (* Ruby code to return an LVM struct list. *)
5719 and generate_ruby_lvm_code typ cols =
5720 pr " VALUE rv = rb_ary_new2 (r->len);\n";
5722 pr " for (i = 0; i < r->len; ++i) {\n";
5723 pr " VALUE hv = rb_hash_new ();\n";
5727 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
5729 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
5732 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
5733 | name, `OptPercent ->
5734 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
5736 pr " rb_ary_push (rv, hv);\n";
5738 pr " guestfs_free_lvm_%s_list (r);\n" typ;
5741 (* Generate Java bindings GuestFS.java file. *)
5742 and generate_java_java () =
5743 generate_header CStyle LGPLv2;
5746 package com.redhat.et.libguestfs;
5748 import java.util.HashMap;
5749 import com.redhat.et.libguestfs.LibGuestFSException;
5750 import com.redhat.et.libguestfs.PV;
5751 import com.redhat.et.libguestfs.VG;
5752 import com.redhat.et.libguestfs.LV;
5753 import com.redhat.et.libguestfs.Stat;
5754 import com.redhat.et.libguestfs.StatVFS;
5755 import com.redhat.et.libguestfs.IntBool;
5758 * The GuestFS object is a libguestfs handle.
5762 public class GuestFS {
5763 // Load the native code.
5765 System.loadLibrary (\"guestfs_jni\");
5769 * The native guestfs_h pointer.
5774 * Create a libguestfs handle.
5776 * @throws LibGuestFSException
5778 public GuestFS () throws LibGuestFSException
5782 private native long _create () throws LibGuestFSException;
5785 * Close a libguestfs handle.
5787 * You can also leave handles to be collected by the garbage
5788 * collector, but this method ensures that the resources used
5789 * by the handle are freed up immediately. If you call any
5790 * other methods after closing the handle, you will get an
5793 * @throws LibGuestFSException
5795 public void close () throws LibGuestFSException
5801 private native void _close (long g) throws LibGuestFSException;
5803 public void finalize () throws LibGuestFSException
5811 fun (name, style, _, flags, _, shortdesc, longdesc) ->
5812 let doc = replace_str longdesc "C<guestfs_" "C<g." in
5814 if List.mem ProtocolLimitWarning flags then
5815 doc ^ "\n\n" ^ protocol_limit_warning
5818 if List.mem DangerWillRobinson flags then
5819 doc ^ "\n\n" ^ danger_will_robinson
5821 let doc = pod2text ~width:60 name doc in
5822 let doc = String.concat "\n * " doc in
5825 pr " * %s\n" shortdesc;
5828 pr " * @throws LibGuestFSException\n";
5831 generate_java_prototype ~public:true ~semicolon:false name style;
5834 pr " if (g == 0)\n";
5835 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
5838 if fst style <> RErr then pr "return ";
5840 generate_call_args ~handle:"g" (snd style);
5844 generate_java_prototype ~privat:true ~native:true name style;
5851 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
5852 ?(semicolon=true) name style =
5853 if privat then pr "private ";
5854 if public then pr "public ";
5855 if native then pr "native ";
5858 (match fst style with
5859 | RErr -> pr "void ";
5860 | RInt _ -> pr "int ";
5861 | RInt64 _ -> pr "long ";
5862 | RBool _ -> pr "boolean ";
5863 | RConstString _ | RString _ -> pr "String ";
5864 | RStringList _ -> pr "String[] ";
5865 | RIntBool _ -> pr "IntBool ";
5866 | RPVList _ -> pr "PV[] ";
5867 | RVGList _ -> pr "VG[] ";
5868 | RLVList _ -> pr "LV[] ";
5869 | RStat _ -> pr "Stat ";
5870 | RStatVFS _ -> pr "StatVFS ";
5871 | RHashtable _ -> pr "HashMap<String,String> ";
5874 if native then pr "_%s " name else pr "%s " name;
5876 let needs_comma = ref false in
5885 if !needs_comma then pr ", ";
5886 needs_comma := true;
5903 pr " throws LibGuestFSException";
5904 if semicolon then pr ";"
5906 and generate_java_struct typ cols =
5907 generate_header CStyle LGPLv2;
5910 package com.redhat.et.libguestfs;
5913 * Libguestfs %s structure.
5924 | name, `UUID -> pr " public String %s;\n" name
5926 | name, `Int -> pr " public long %s;\n" name
5927 | name, `OptPercent ->
5928 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
5929 pr " public float %s;\n" name
5934 and generate_java_c () =
5935 generate_header CStyle LGPLv2;
5942 #include \"com_redhat_et_libguestfs_GuestFS.h\"
5943 #include \"guestfs.h\"
5945 /* Note that this function returns. The exception is not thrown
5946 * until after the wrapper function returns.
5949 throw_exception (JNIEnv *env, const char *msg)
5952 cl = (*env)->FindClass (env,
5953 \"com/redhat/et/libguestfs/LibGuestFSException\");
5954 (*env)->ThrowNew (env, cl, msg);
5957 JNIEXPORT jlong JNICALL
5958 Java_com_redhat_et_libguestfs_GuestFS__1create
5959 (JNIEnv *env, jobject obj)
5963 g = guestfs_create ();
5965 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
5968 guestfs_set_error_handler (g, NULL, NULL);
5969 return (jlong) (long) g;
5972 JNIEXPORT void JNICALL
5973 Java_com_redhat_et_libguestfs_GuestFS__1close
5974 (JNIEnv *env, jobject obj, jlong jg)
5976 guestfs_h *g = (guestfs_h *) (long) jg;
5983 fun (name, style, _, _, _, _, _) ->
5985 (match fst style with
5986 | RErr -> pr "void ";
5987 | RInt _ -> pr "jint ";
5988 | RInt64 _ -> pr "jlong ";
5989 | RBool _ -> pr "jboolean ";
5990 | RConstString _ | RString _ -> pr "jstring ";
5991 | RIntBool _ | RStat _ | RStatVFS _ | RHashtable _ ->
5993 | RStringList _ | RPVList _ | RVGList _ | RLVList _ ->
5997 pr "Java_com_redhat_et_libguestfs_GuestFS_";
5998 pr "%s" (replace_str ("_" ^ name) "_" "_1");
6000 pr " (JNIEnv *env, jobject obj, jlong jg";
6007 pr ", jstring j%s" n
6009 pr ", jobjectArray j%s" n
6011 pr ", jboolean j%s" n
6017 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
6018 let error_code, no_ret =
6019 match fst style with
6020 | RErr -> pr " int r;\n"; "-1", ""
6022 | RInt _ -> pr " int r;\n"; "-1", "0"
6023 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
6024 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
6026 pr " jstring jr;\n";
6027 pr " char *r;\n"; "NULL", "NULL"
6029 pr " jobjectArray jr;\n";
6032 pr " jstring jstr;\n";
6033 pr " char **r;\n"; "NULL", "NULL"
6035 pr " jobject jr;\n";
6037 pr " jfieldID fl;\n";
6038 pr " struct guestfs_int_bool *r;\n"; "NULL", "NULL"
6040 pr " jobject jr;\n";
6042 pr " jfieldID fl;\n";
6043 pr " struct guestfs_stat *r;\n"; "NULL", "NULL"
6045 pr " jobject jr;\n";
6047 pr " jfieldID fl;\n";
6048 pr " struct guestfs_statvfs *r;\n"; "NULL", "NULL"
6050 pr " jobjectArray jr;\n";
6052 pr " jfieldID fl;\n";
6053 pr " jobject jfl;\n";
6054 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL", "NULL"
6056 pr " jobjectArray jr;\n";
6058 pr " jfieldID fl;\n";
6059 pr " jobject jfl;\n";
6060 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL", "NULL"
6062 pr " jobjectArray jr;\n";
6064 pr " jfieldID fl;\n";
6065 pr " jobject jfl;\n";
6066 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL", "NULL"
6067 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL" in
6074 pr " const char *%s;\n" n
6076 pr " int %s_len;\n" n;
6077 pr " const char **%s;\n" n
6084 (match fst style with
6085 | RStringList _ | RPVList _ | RVGList _ | RLVList _ -> true
6086 | RErr _ | RBool _ | RInt _ | RInt64 _ | RConstString _
6087 | RString _ | RIntBool _ | RStat _ | RStatVFS _
6088 | RHashtable _ -> false) ||
6089 List.exists (function StringList _ -> true | _ -> false) (snd style) in
6095 (* Get the parameters. *)
6102 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
6104 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
6105 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
6106 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6107 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6109 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
6111 pr " %s[%s_len] = NULL;\n" n n;
6114 pr " %s = j%s;\n" n n
6117 (* Make the call. *)
6118 pr " r = guestfs_%s " name;
6119 generate_call_args ~handle:"g" (snd style);
6122 (* Release the parameters. *)
6129 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
6131 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6132 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6134 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
6136 pr " free (%s);\n" n
6141 (* Check for errors. *)
6142 pr " if (r == %s) {\n" error_code;
6143 pr " throw_exception (env, guestfs_last_error (g));\n";
6144 pr " return %s;\n" no_ret;
6148 (match fst style with
6150 | RInt _ -> pr " return (jint) r;\n"
6151 | RBool _ -> pr " return (jboolean) r;\n"
6152 | RInt64 _ -> pr " return (jlong) r;\n"
6153 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
6155 pr " jr = (*env)->NewStringUTF (env, r);\n";
6159 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
6160 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
6161 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
6162 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
6163 pr " for (i = 0; i < r_len; ++i) {\n";
6164 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
6165 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
6166 pr " free (r[i]);\n";
6171 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/IntBool\");\n";
6172 pr " jr = (*env)->AllocObject (env, cl);\n";
6173 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"I\");\n";
6174 pr " (*env)->SetIntField (env, jr, fl, r->i);\n";
6175 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"Z\");\n";
6176 pr " (*env)->SetBooleanField (env, jr, fl, r->b);\n";
6177 pr " guestfs_free_int_bool (r);\n";
6180 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/Stat\");\n";
6181 pr " jr = (*env)->AllocObject (env, cl);\n";
6185 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
6187 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
6192 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/StatVFS\");\n";
6193 pr " jr = (*env)->AllocObject (env, cl);\n";
6197 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
6199 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
6204 generate_java_lvm_return "pv" "PV" pv_cols
6206 generate_java_lvm_return "vg" "VG" vg_cols
6208 generate_java_lvm_return "lv" "LV" lv_cols
6211 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
6212 pr " return NULL;\n"
6219 and generate_java_lvm_return typ jtyp cols =
6220 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
6221 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
6222 pr " for (i = 0; i < r->len; ++i) {\n";
6223 pr " jfl = (*env)->AllocObject (env, cl);\n";
6227 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
6228 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
6231 pr " char s[33];\n";
6232 pr " memcpy (s, r->val[i].%s, 32);\n" name;
6234 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
6235 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
6237 | name, (`Bytes|`Int) ->
6238 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
6239 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
6240 | name, `OptPercent ->
6241 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
6242 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
6244 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
6246 pr " guestfs_free_lvm_%s_list (r);\n" typ;
6249 let output_to filename =
6250 let filename_new = filename ^ ".new" in
6251 chan := open_out filename_new;
6256 (* Is the new file different from the current file? *)
6257 if Sys.file_exists filename && files_equal filename filename_new then
6258 Unix.unlink filename_new (* same, so skip it *)
6260 (* different, overwrite old one *)
6261 (try Unix.chmod filename 0o644 with Unix.Unix_error _ -> ());
6262 Unix.rename filename_new filename;
6263 Unix.chmod filename 0o444;
6264 printf "written %s\n%!" filename;
6273 if not (Sys.file_exists "configure.ac") then (
6275 You are probably running this from the wrong directory.
6276 Run it from the top source directory using the command
6282 let close = output_to "src/guestfs_protocol.x" in
6286 let close = output_to "src/guestfs-structs.h" in
6287 generate_structs_h ();
6290 let close = output_to "src/guestfs-actions.h" in
6291 generate_actions_h ();
6294 let close = output_to "src/guestfs-actions.c" in
6295 generate_client_actions ();
6298 let close = output_to "daemon/actions.h" in
6299 generate_daemon_actions_h ();
6302 let close = output_to "daemon/stubs.c" in
6303 generate_daemon_actions ();
6306 let close = output_to "tests.c" in
6310 let close = output_to "fish/cmds.c" in
6311 generate_fish_cmds ();
6314 let close = output_to "fish/completion.c" in
6315 generate_fish_completion ();
6318 let close = output_to "guestfs-structs.pod" in
6319 generate_structs_pod ();
6322 let close = output_to "guestfs-actions.pod" in
6323 generate_actions_pod ();
6326 let close = output_to "guestfish-actions.pod" in
6327 generate_fish_actions_pod ();
6330 let close = output_to "ocaml/guestfs.mli" in
6331 generate_ocaml_mli ();
6334 let close = output_to "ocaml/guestfs.ml" in
6335 generate_ocaml_ml ();
6338 let close = output_to "ocaml/guestfs_c_actions.c" in
6339 generate_ocaml_c ();
6342 let close = output_to "perl/Guestfs.xs" in
6343 generate_perl_xs ();
6346 let close = output_to "perl/lib/Sys/Guestfs.pm" in
6347 generate_perl_pm ();
6350 let close = output_to "python/guestfs-py.c" in
6351 generate_python_c ();
6354 let close = output_to "python/guestfs.py" in
6355 generate_python_py ();
6358 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
6362 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
6363 generate_java_java ();
6366 let close = output_to "java/com/redhat/et/libguestfs/PV.java" in
6367 generate_java_struct "PV" pv_cols;
6370 let close = output_to "java/com/redhat/et/libguestfs/VG.java" in
6371 generate_java_struct "VG" vg_cols;
6374 let close = output_to "java/com/redhat/et/libguestfs/LV.java" in
6375 generate_java_struct "LV" lv_cols;
6378 let close = output_to "java/com/redhat/et/libguestfs/Stat.java" in
6379 generate_java_struct "Stat" stat_cols;
6382 let close = output_to "java/com/redhat/et/libguestfs/StatVFS.java" in
6383 generate_java_struct "StatVFS" statvfs_cols;
6386 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in