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
1635 ("fsck", (RInt "status", [String "fstype"; String "device"]), 84, [],
1636 [InitBasicFS, TestRun (
1637 [["fsck"; "ext2"; "/dev/sda1"]])],
1638 "run the filesystem checker",
1640 This runs the filesystem checker (fsck) on C<device> which
1641 should have filesystem type C<fstype>.
1643 The returned integer is the status. See L<fsck(8)> for the
1644 list of status codes from C<fsck>, and note that multiple
1645 status codes can be summed together.
1647 It is entirely equivalent to running C<fsck -a -t fstype device>.
1648 Note that checking or repairing NTFS volumes is not supported
1652 let all_functions = non_daemon_functions @ daemon_functions
1654 (* In some places we want the functions to be displayed sorted
1655 * alphabetically, so this is useful:
1657 let all_functions_sorted =
1658 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
1659 compare n1 n2) all_functions
1661 (* Column names and types from LVM PVs/VGs/LVs. *)
1670 "pv_attr", `String (* XXX *);
1671 "pv_pe_count", `Int;
1672 "pv_pe_alloc_count", `Int;
1675 "pv_mda_count", `Int;
1676 "pv_mda_free", `Bytes;
1677 (* Not in Fedora 10:
1678 "pv_mda_size", `Bytes;
1685 "vg_attr", `String (* XXX *);
1688 "vg_sysid", `String;
1689 "vg_extent_size", `Bytes;
1690 "vg_extent_count", `Int;
1691 "vg_free_count", `Int;
1699 "vg_mda_count", `Int;
1700 "vg_mda_free", `Bytes;
1701 (* Not in Fedora 10:
1702 "vg_mda_size", `Bytes;
1708 "lv_attr", `String (* XXX *);
1711 "lv_kernel_major", `Int;
1712 "lv_kernel_minor", `Int;
1716 "snap_percent", `OptPercent;
1717 "copy_percent", `OptPercent;
1720 "mirror_log", `String;
1724 (* Column names and types from stat structures.
1725 * NB. Can't use things like 'st_atime' because glibc header files
1726 * define some of these as macros. Ugh.
1743 let statvfs_cols = [
1757 (* Useful functions.
1758 * Note we don't want to use any external OCaml libraries which
1759 * makes this a bit harder than it should be.
1761 let failwithf fs = ksprintf failwith fs
1763 let replace_char s c1 c2 =
1764 let s2 = String.copy s in
1765 let r = ref false in
1766 for i = 0 to String.length s2 - 1 do
1767 if String.unsafe_get s2 i = c1 then (
1768 String.unsafe_set s2 i c2;
1772 if not !r then s else s2
1776 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
1778 let triml ?(test = isspace) str =
1780 let n = ref (String.length str) in
1781 while !n > 0 && test str.[!i]; do
1786 else String.sub str !i !n
1788 let trimr ?(test = isspace) str =
1789 let n = ref (String.length str) in
1790 while !n > 0 && test str.[!n-1]; do
1793 if !n = String.length str then str
1794 else String.sub str 0 !n
1796 let trim ?(test = isspace) str =
1797 trimr ~test (triml ~test str)
1799 let rec find s sub =
1800 let len = String.length s in
1801 let sublen = String.length sub in
1803 if i <= len-sublen then (
1805 if j < sublen then (
1806 if s.[i+j] = sub.[j] then loop2 (j+1)
1812 if r = -1 then loop (i+1) else r
1818 let rec replace_str s s1 s2 =
1819 let len = String.length s in
1820 let sublen = String.length s1 in
1821 let i = find s s1 in
1824 let s' = String.sub s 0 i in
1825 let s'' = String.sub s (i+sublen) (len-i-sublen) in
1826 s' ^ s2 ^ replace_str s'' s1 s2
1829 let rec string_split sep str =
1830 let len = String.length str in
1831 let seplen = String.length sep in
1832 let i = find str sep in
1833 if i = -1 then [str]
1835 let s' = String.sub str 0 i in
1836 let s'' = String.sub str (i+seplen) (len-i-seplen) in
1837 s' :: string_split sep s''
1840 let files_equal n1 n2 =
1841 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
1842 match Sys.command cmd with
1845 | i -> failwithf "%s: failed with error code %d" cmd i
1847 let rec find_map f = function
1848 | [] -> raise Not_found
1852 | None -> find_map f xs
1855 let rec loop i = function
1857 | x :: xs -> f i x; loop (i+1) xs
1862 let rec loop i = function
1864 | x :: xs -> let r = f i x in r :: loop (i+1) xs
1868 let name_of_argt = function
1869 | String n | OptString n | StringList n | Bool n | Int n
1870 | FileIn n | FileOut n -> n
1872 let seq_of_test = function
1873 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
1874 | TestOutputInt (s, _) | TestOutputTrue s | TestOutputFalse s
1875 | TestOutputLength (s, _) | TestOutputStruct (s, _)
1876 | TestLastFail s -> s
1878 (* Check function names etc. for consistency. *)
1879 let check_functions () =
1880 let contains_uppercase str =
1881 let len = String.length str in
1883 if i >= len then false
1886 if c >= 'A' && c <= 'Z' then true
1893 (* Check function names. *)
1895 fun (name, _, _, _, _, _, _) ->
1896 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
1897 failwithf "function name %s does not need 'guestfs' prefix" name;
1898 if contains_uppercase name then
1899 failwithf "function name %s should not contain uppercase chars" name;
1900 if String.contains name '-' then
1901 failwithf "function name %s should not contain '-', use '_' instead."
1905 (* Check function parameter/return names. *)
1907 fun (name, style, _, _, _, _, _) ->
1908 let check_arg_ret_name n =
1909 if contains_uppercase n then
1910 failwithf "%s param/ret %s should not contain uppercase chars"
1912 if String.contains n '-' || String.contains n '_' then
1913 failwithf "%s param/ret %s should not contain '-' or '_'"
1916 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;
1917 if n = "argv" || n = "args" then
1918 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" n
1921 (match fst style with
1923 | RInt n | RInt64 n | RBool n | RConstString n | RString n
1924 | RStringList n | RPVList n | RVGList n | RLVList n
1925 | RStat n | RStatVFS n
1927 check_arg_ret_name n
1929 check_arg_ret_name n;
1930 check_arg_ret_name m
1932 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
1935 (* Check short descriptions. *)
1937 fun (name, _, _, _, _, shortdesc, _) ->
1938 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
1939 failwithf "short description of %s should begin with lowercase." name;
1940 let c = shortdesc.[String.length shortdesc-1] in
1941 if c = '\n' || c = '.' then
1942 failwithf "short description of %s should not end with . or \\n." name
1945 (* Check long dscriptions. *)
1947 fun (name, _, _, _, _, _, longdesc) ->
1948 if longdesc.[String.length longdesc-1] = '\n' then
1949 failwithf "long description of %s should not end with \\n." name
1952 (* Check proc_nrs. *)
1954 fun (name, _, proc_nr, _, _, _, _) ->
1955 if proc_nr <= 0 then
1956 failwithf "daemon function %s should have proc_nr > 0" name
1960 fun (name, _, proc_nr, _, _, _, _) ->
1961 if proc_nr <> -1 then
1962 failwithf "non-daemon function %s should have proc_nr -1" name
1963 ) non_daemon_functions;
1966 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
1969 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
1970 let rec loop = function
1973 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
1975 | (name1,nr1) :: (name2,nr2) :: _ ->
1976 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
1984 (* Ignore functions that have no tests. We generate a
1985 * warning when the user does 'make check' instead.
1987 | name, _, _, _, [], _, _ -> ()
1988 | name, _, _, _, tests, _, _ ->
1992 match seq_of_test test with
1994 failwithf "%s has a test containing an empty sequence" name
1995 | cmds -> List.map List.hd cmds
1997 let funcs = List.flatten funcs in
1999 let tested = List.mem name funcs in
2002 failwithf "function %s has tests but does not test itself" name
2005 (* 'pr' prints to the current output file. *)
2006 let chan = ref stdout
2007 let pr fs = ksprintf (output_string !chan) fs
2009 (* Generate a header block in a number of standard styles. *)
2010 type comment_style = CStyle | HashStyle | OCamlStyle
2011 type license = GPLv2 | LGPLv2
2013 let generate_header comment license =
2014 let c = match comment with
2015 | CStyle -> pr "/* "; " *"
2016 | HashStyle -> pr "# "; "#"
2017 | OCamlStyle -> pr "(* "; " *" in
2018 pr "libguestfs generated file\n";
2019 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
2020 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
2022 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
2026 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
2027 pr "%s it under the terms of the GNU General Public License as published by\n" c;
2028 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
2029 pr "%s (at your option) any later version.\n" c;
2031 pr "%s This program 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\n" c;
2034 pr "%s GNU General Public License for more details.\n" c;
2036 pr "%s You should have received a copy of the GNU General Public License along\n" c;
2037 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
2038 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
2041 pr "%s This library is free software; you can redistribute it and/or\n" c;
2042 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
2043 pr "%s License as published by the Free Software Foundation; either\n" c;
2044 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
2046 pr "%s This library is distributed in the hope that it will be useful,\n" c;
2047 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2048 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
2049 pr "%s Lesser General Public License for more details.\n" c;
2051 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
2052 pr "%s License along with this library; if not, write to the Free Software\n" c;
2053 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
2056 | CStyle -> pr " */\n"
2058 | OCamlStyle -> pr " *)\n"
2062 (* Start of main code generation functions below this line. *)
2064 (* Generate the pod documentation for the C API. *)
2065 let rec generate_actions_pod () =
2067 fun (shortname, style, _, flags, _, _, longdesc) ->
2068 let name = "guestfs_" ^ shortname in
2069 pr "=head2 %s\n\n" name;
2071 generate_prototype ~extern:false ~handle:"handle" name style;
2073 pr "%s\n\n" longdesc;
2074 (match fst style with
2076 pr "This function returns 0 on success or -1 on error.\n\n"
2078 pr "On error this function returns -1.\n\n"
2080 pr "On error this function returns -1.\n\n"
2082 pr "This function returns a C truth value on success or -1 on error.\n\n"
2084 pr "This function returns a string, or NULL on error.
2085 The string is owned by the guest handle and must I<not> be freed.\n\n"
2087 pr "This function returns a string, or NULL on error.
2088 I<The caller must free the returned string after use>.\n\n"
2090 pr "This function returns a NULL-terminated array of strings
2091 (like L<environ(3)>), or NULL if there was an error.
2092 I<The caller must free the strings and the array after use>.\n\n"
2094 pr "This function returns a C<struct guestfs_int_bool *>,
2095 or NULL if there was an error.
2096 I<The caller must call C<guestfs_free_int_bool> after use>.\n\n"
2098 pr "This function returns a C<struct guestfs_lvm_pv_list *>
2099 (see E<lt>guestfs-structs.hE<gt>),
2100 or NULL if there was an error.
2101 I<The caller must call C<guestfs_free_lvm_pv_list> after use>.\n\n"
2103 pr "This function returns a C<struct guestfs_lvm_vg_list *>
2104 (see E<lt>guestfs-structs.hE<gt>),
2105 or NULL if there was an error.
2106 I<The caller must call C<guestfs_free_lvm_vg_list> after use>.\n\n"
2108 pr "This function returns a C<struct guestfs_lvm_lv_list *>
2109 (see E<lt>guestfs-structs.hE<gt>),
2110 or NULL if there was an error.
2111 I<The caller must call C<guestfs_free_lvm_lv_list> after use>.\n\n"
2113 pr "This function returns a C<struct guestfs_stat *>
2114 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
2115 or NULL if there was an error.
2116 I<The caller must call C<free> after use>.\n\n"
2118 pr "This function returns a C<struct guestfs_statvfs *>
2119 (see L<statvfs(2)> and E<lt>guestfs-structs.hE<gt>),
2120 or NULL if there was an error.
2121 I<The caller must call C<free> after use>.\n\n"
2123 pr "This function returns a NULL-terminated array of
2124 strings, or NULL if there was an error.
2125 The array of strings will always have length C<2n+1>, where
2126 C<n> keys and values alternate, followed by the trailing NULL entry.
2127 I<The caller must free the strings and the array after use>.\n\n"
2129 if List.mem ProtocolLimitWarning flags then
2130 pr "%s\n\n" protocol_limit_warning;
2131 if List.mem DangerWillRobinson flags then
2132 pr "%s\n\n" danger_will_robinson;
2133 ) all_functions_sorted
2135 and generate_structs_pod () =
2136 (* LVM structs documentation. *)
2139 pr "=head2 guestfs_lvm_%s\n" typ;
2141 pr " struct guestfs_lvm_%s {\n" typ;
2144 | name, `String -> pr " char *%s;\n" name
2146 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
2147 pr " char %s[32];\n" name
2148 | name, `Bytes -> pr " uint64_t %s;\n" name
2149 | name, `Int -> pr " int64_t %s;\n" name
2150 | name, `OptPercent ->
2151 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
2152 pr " float %s;\n" name
2155 pr " struct guestfs_lvm_%s_list {\n" typ;
2156 pr " uint32_t len; /* Number of elements in list. */\n";
2157 pr " struct guestfs_lvm_%s *val; /* Elements. */\n" typ;
2160 pr " void guestfs_free_lvm_%s_list (struct guestfs_free_lvm_%s_list *);\n"
2163 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
2165 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
2166 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
2168 * We have to use an underscore instead of a dash because otherwise
2169 * rpcgen generates incorrect code.
2171 * This header is NOT exported to clients, but see also generate_structs_h.
2173 and generate_xdr () =
2174 generate_header CStyle LGPLv2;
2176 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
2177 pr "typedef string str<>;\n";
2180 (* LVM internal structures. *)
2184 pr "struct guestfs_lvm_int_%s {\n" typ;
2186 | name, `String -> pr " string %s<>;\n" name
2187 | name, `UUID -> pr " opaque %s[32];\n" name
2188 | name, `Bytes -> pr " hyper %s;\n" name
2189 | name, `Int -> pr " hyper %s;\n" name
2190 | name, `OptPercent -> pr " float %s;\n" name
2194 pr "typedef struct guestfs_lvm_int_%s guestfs_lvm_int_%s_list<>;\n" typ typ;
2196 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2198 (* Stat internal structures. *)
2202 pr "struct guestfs_int_%s {\n" typ;
2204 | name, `Int -> pr " hyper %s;\n" name
2208 ) ["stat", stat_cols; "statvfs", statvfs_cols];
2211 fun (shortname, style, _, _, _, _, _) ->
2212 let name = "guestfs_" ^ shortname in
2214 (match snd style with
2217 pr "struct %s_args {\n" name;
2220 | String n -> pr " string %s<>;\n" n
2221 | OptString n -> pr " str *%s;\n" n
2222 | StringList n -> pr " str %s<>;\n" n
2223 | Bool n -> pr " bool %s;\n" n
2224 | Int n -> pr " int %s;\n" n
2225 | FileIn _ | FileOut _ -> ()
2229 (match fst style with
2232 pr "struct %s_ret {\n" name;
2236 pr "struct %s_ret {\n" name;
2237 pr " hyper %s;\n" n;
2240 pr "struct %s_ret {\n" name;
2244 failwithf "RConstString cannot be returned from a daemon function"
2246 pr "struct %s_ret {\n" name;
2247 pr " string %s<>;\n" n;
2250 pr "struct %s_ret {\n" name;
2251 pr " str %s<>;\n" n;
2254 pr "struct %s_ret {\n" name;
2259 pr "struct %s_ret {\n" name;
2260 pr " guestfs_lvm_int_pv_list %s;\n" n;
2263 pr "struct %s_ret {\n" name;
2264 pr " guestfs_lvm_int_vg_list %s;\n" n;
2267 pr "struct %s_ret {\n" name;
2268 pr " guestfs_lvm_int_lv_list %s;\n" n;
2271 pr "struct %s_ret {\n" name;
2272 pr " guestfs_int_stat %s;\n" n;
2275 pr "struct %s_ret {\n" name;
2276 pr " guestfs_int_statvfs %s;\n" n;
2279 pr "struct %s_ret {\n" name;
2280 pr " str %s<>;\n" n;
2285 (* Table of procedure numbers. *)
2286 pr "enum guestfs_procedure {\n";
2288 fun (shortname, _, proc_nr, _, _, _, _) ->
2289 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
2291 pr " GUESTFS_PROC_NR_PROCS\n";
2295 (* Having to choose a maximum message size is annoying for several
2296 * reasons (it limits what we can do in the API), but it (a) makes
2297 * the protocol a lot simpler, and (b) provides a bound on the size
2298 * of the daemon which operates in limited memory space. For large
2299 * file transfers you should use FTP.
2301 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
2304 (* Message header, etc. *)
2306 /* The communication protocol is now documented in the guestfs(3)
2310 const GUESTFS_PROGRAM = 0x2000F5F5;
2311 const GUESTFS_PROTOCOL_VERSION = 1;
2313 /* These constants must be larger than any possible message length. */
2314 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
2315 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
2317 enum guestfs_message_direction {
2318 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
2319 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
2322 enum guestfs_message_status {
2323 GUESTFS_STATUS_OK = 0,
2324 GUESTFS_STATUS_ERROR = 1
2327 const GUESTFS_ERROR_LEN = 256;
2329 struct guestfs_message_error {
2330 string error_message<GUESTFS_ERROR_LEN>;
2333 struct guestfs_message_header {
2334 unsigned prog; /* GUESTFS_PROGRAM */
2335 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
2336 guestfs_procedure proc; /* GUESTFS_PROC_x */
2337 guestfs_message_direction direction;
2338 unsigned serial; /* message serial number */
2339 guestfs_message_status status;
2342 const GUESTFS_MAX_CHUNK_SIZE = 8192;
2344 struct guestfs_chunk {
2345 int cancel; /* if non-zero, transfer is cancelled */
2346 /* data size is 0 bytes if the transfer has finished successfully */
2347 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
2351 (* Generate the guestfs-structs.h file. *)
2352 and generate_structs_h () =
2353 generate_header CStyle LGPLv2;
2355 (* This is a public exported header file containing various
2356 * structures. The structures are carefully written to have
2357 * exactly the same in-memory format as the XDR structures that
2358 * we use on the wire to the daemon. The reason for creating
2359 * copies of these structures here is just so we don't have to
2360 * export the whole of guestfs_protocol.h (which includes much
2361 * unrelated and XDR-dependent stuff that we don't want to be
2362 * public, or required by clients).
2364 * To reiterate, we will pass these structures to and from the
2365 * client with a simple assignment or memcpy, so the format
2366 * must be identical to what rpcgen / the RFC defines.
2369 (* guestfs_int_bool structure. *)
2370 pr "struct guestfs_int_bool {\n";
2376 (* LVM public structures. *)
2380 pr "struct guestfs_lvm_%s {\n" typ;
2383 | name, `String -> pr " char *%s;\n" name
2384 | name, `UUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
2385 | name, `Bytes -> pr " uint64_t %s;\n" name
2386 | name, `Int -> pr " int64_t %s;\n" name
2387 | name, `OptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
2391 pr "struct guestfs_lvm_%s_list {\n" typ;
2392 pr " uint32_t len;\n";
2393 pr " struct guestfs_lvm_%s *val;\n" typ;
2396 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2398 (* Stat structures. *)
2402 pr "struct guestfs_%s {\n" typ;
2405 | name, `Int -> pr " int64_t %s;\n" name
2409 ) ["stat", stat_cols; "statvfs", statvfs_cols]
2411 (* Generate the guestfs-actions.h file. *)
2412 and generate_actions_h () =
2413 generate_header CStyle LGPLv2;
2415 fun (shortname, style, _, _, _, _, _) ->
2416 let name = "guestfs_" ^ shortname in
2417 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
2421 (* Generate the client-side dispatch stubs. *)
2422 and generate_client_actions () =
2423 generate_header CStyle LGPLv2;
2429 #include \"guestfs.h\"
2430 #include \"guestfs_protocol.h\"
2432 #define error guestfs_error
2433 #define perrorf guestfs_perrorf
2434 #define safe_malloc guestfs_safe_malloc
2435 #define safe_realloc guestfs_safe_realloc
2436 #define safe_strdup guestfs_safe_strdup
2437 #define safe_memdup guestfs_safe_memdup
2439 /* Check the return message from a call for validity. */
2441 check_reply_header (guestfs_h *g,
2442 const struct guestfs_message_header *hdr,
2443 int proc_nr, int serial)
2445 if (hdr->prog != GUESTFS_PROGRAM) {
2446 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
2449 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
2450 error (g, \"wrong protocol version (%%d/%%d)\",
2451 hdr->vers, GUESTFS_PROTOCOL_VERSION);
2454 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
2455 error (g, \"unexpected message direction (%%d/%%d)\",
2456 hdr->direction, GUESTFS_DIRECTION_REPLY);
2459 if (hdr->proc != proc_nr) {
2460 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
2463 if (hdr->serial != serial) {
2464 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
2471 /* Check we are in the right state to run a high-level action. */
2473 check_state (guestfs_h *g, const char *caller)
2475 if (!guestfs_is_ready (g)) {
2476 if (guestfs_is_config (g))
2477 error (g, \"%%s: call launch() before using this function\",
2479 else if (guestfs_is_launching (g))
2480 error (g, \"%%s: call wait_ready() before using this function\",
2483 error (g, \"%%s called from the wrong state, %%d != READY\",
2484 caller, guestfs_get_state (g));
2492 (* Client-side stubs for each function. *)
2494 fun (shortname, style, _, _, _, _, _) ->
2495 let name = "guestfs_" ^ shortname in
2497 (* Generate the context struct which stores the high-level
2498 * state between callback functions.
2500 pr "struct %s_ctx {\n" shortname;
2501 pr " /* This flag is set by the callbacks, so we know we've done\n";
2502 pr " * the callbacks as expected, and in the right sequence.\n";
2503 pr " * 0 = not called, 1 = reply_cb called.\n";
2505 pr " int cb_sequence;\n";
2506 pr " struct guestfs_message_header hdr;\n";
2507 pr " struct guestfs_message_error err;\n";
2508 (match fst style with
2511 failwithf "RConstString cannot be returned from a daemon function"
2513 | RBool _ | RString _ | RStringList _
2515 | RPVList _ | RVGList _ | RLVList _
2516 | RStat _ | RStatVFS _
2518 pr " struct %s_ret ret;\n" name
2523 (* Generate the reply callback function. *)
2524 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
2526 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
2527 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
2529 pr " /* This should definitely not happen. */\n";
2530 pr " if (ctx->cb_sequence != 0) {\n";
2531 pr " ctx->cb_sequence = 9999;\n";
2532 pr " error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
2536 pr " ml->main_loop_quit (ml, g);\n";
2538 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
2539 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
2542 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
2543 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
2544 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
2551 (match fst style with
2554 failwithf "RConstString cannot be returned from a daemon function"
2556 | RBool _ | RString _ | RStringList _
2558 | RPVList _ | RVGList _ | RLVList _
2559 | RStat _ | RStatVFS _
2561 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
2562 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
2568 pr " ctx->cb_sequence = 1;\n";
2571 (* Generate the action stub. *)
2572 generate_prototype ~extern:false ~semicolon:false ~newline:true
2573 ~handle:"g" name style;
2576 match fst style with
2577 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
2579 failwithf "RConstString cannot be returned from a daemon function"
2580 | RString _ | RStringList _ | RIntBool _
2581 | RPVList _ | RVGList _ | RLVList _
2582 | RStat _ | RStatVFS _
2588 (match snd style with
2590 | _ -> pr " struct %s_args args;\n" name
2593 pr " struct %s_ctx ctx;\n" shortname;
2594 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
2595 pr " int serial;\n";
2597 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
2598 pr " guestfs_set_busy (g);\n";
2600 pr " memset (&ctx, 0, sizeof ctx);\n";
2603 (* Send the main header and arguments. *)
2604 (match snd style with
2606 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
2607 (String.uppercase shortname)
2612 pr " args.%s = (char *) %s;\n" n n
2614 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
2616 pr " args.%s.%s_val = (char **) %s;\n" n n n;
2617 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
2619 pr " args.%s = %s;\n" n n
2621 pr " args.%s = %s;\n" n n
2622 | FileIn _ | FileOut _ -> ()
2624 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
2625 (String.uppercase shortname);
2626 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
2629 pr " if (serial == -1) {\n";
2630 pr " guestfs_set_ready (g);\n";
2631 pr " return %s;\n" error_code;
2635 (* Send any additional files (FileIn) requested. *)
2636 let need_read_reply_label = ref false in
2643 pr " r = guestfs__send_file_sync (g, %s);\n" n;
2644 pr " if (r == -1) {\n";
2645 pr " guestfs_set_ready (g);\n";
2646 pr " return %s;\n" error_code;
2648 pr " if (r == -2) /* daemon cancelled */\n";
2649 pr " goto read_reply;\n";
2650 need_read_reply_label := true;
2656 (* Wait for the reply from the remote end. *)
2657 if !need_read_reply_label then pr " read_reply:\n";
2658 pr " guestfs__switch_to_receiving (g);\n";
2659 pr " ctx.cb_sequence = 0;\n";
2660 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
2661 pr " (void) ml->main_loop_run (ml, g);\n";
2662 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
2663 pr " if (ctx.cb_sequence != 1) {\n";
2664 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
2665 pr " guestfs_set_ready (g);\n";
2666 pr " return %s;\n" error_code;
2670 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
2671 (String.uppercase shortname);
2672 pr " guestfs_set_ready (g);\n";
2673 pr " return %s;\n" error_code;
2677 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
2678 pr " error (g, \"%%s\", ctx.err.error_message);\n";
2679 pr " guestfs_set_ready (g);\n";
2680 pr " return %s;\n" error_code;
2684 (* Expecting to receive further files (FileOut)? *)
2688 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
2689 pr " guestfs_set_ready (g);\n";
2690 pr " return %s;\n" error_code;
2696 pr " guestfs_set_ready (g);\n";
2698 (match fst style with
2699 | RErr -> pr " return 0;\n"
2700 | RInt n | RInt64 n | RBool n ->
2701 pr " return ctx.ret.%s;\n" n
2703 failwithf "RConstString cannot be returned from a daemon function"
2705 pr " return ctx.ret.%s; /* caller will free */\n" n
2706 | RStringList n | RHashtable n ->
2707 pr " /* caller will free this, but we need to add a NULL entry */\n";
2708 pr " ctx.ret.%s.%s_val =\n" n n;
2709 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
2710 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
2712 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
2713 pr " return ctx.ret.%s.%s_val;\n" n n
2715 pr " /* caller with free this */\n";
2716 pr " return safe_memdup (g, &ctx.ret, sizeof (ctx.ret));\n"
2717 | RPVList n | RVGList n | RLVList n
2718 | RStat n | RStatVFS n ->
2719 pr " /* caller will free this */\n";
2720 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
2726 (* Generate daemon/actions.h. *)
2727 and generate_daemon_actions_h () =
2728 generate_header CStyle GPLv2;
2730 pr "#include \"../src/guestfs_protocol.h\"\n";
2734 fun (name, style, _, _, _, _, _) ->
2736 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
2740 (* Generate the server-side stubs. *)
2741 and generate_daemon_actions () =
2742 generate_header CStyle GPLv2;
2744 pr "#include <config.h>\n";
2746 pr "#include <stdio.h>\n";
2747 pr "#include <stdlib.h>\n";
2748 pr "#include <string.h>\n";
2749 pr "#include <inttypes.h>\n";
2750 pr "#include <ctype.h>\n";
2751 pr "#include <rpc/types.h>\n";
2752 pr "#include <rpc/xdr.h>\n";
2754 pr "#include \"daemon.h\"\n";
2755 pr "#include \"../src/guestfs_protocol.h\"\n";
2756 pr "#include \"actions.h\"\n";
2760 fun (name, style, _, _, _, _, _) ->
2761 (* Generate server-side stubs. *)
2762 pr "static void %s_stub (XDR *xdr_in)\n" name;
2765 match fst style with
2766 | RErr | RInt _ -> pr " int r;\n"; "-1"
2767 | RInt64 _ -> pr " int64_t r;\n"; "-1"
2768 | RBool _ -> pr " int r;\n"; "-1"
2770 failwithf "RConstString cannot be returned from a daemon function"
2771 | RString _ -> pr " char *r;\n"; "NULL"
2772 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
2773 | RIntBool _ -> pr " guestfs_%s_ret *r;\n" name; "NULL"
2774 | RPVList _ -> pr " guestfs_lvm_int_pv_list *r;\n"; "NULL"
2775 | RVGList _ -> pr " guestfs_lvm_int_vg_list *r;\n"; "NULL"
2776 | RLVList _ -> pr " guestfs_lvm_int_lv_list *r;\n"; "NULL"
2777 | RStat _ -> pr " guestfs_int_stat *r;\n"; "NULL"
2778 | RStatVFS _ -> pr " guestfs_int_statvfs *r;\n"; "NULL" in
2780 (match snd style with
2783 pr " struct guestfs_%s_args args;\n" name;
2787 | OptString n -> pr " const char *%s;\n" n
2788 | StringList n -> pr " char **%s;\n" n
2789 | Bool n -> pr " int %s;\n" n
2790 | Int n -> pr " int %s;\n" n
2791 | FileIn _ | FileOut _ -> ()
2796 (match snd style with
2799 pr " memset (&args, 0, sizeof args);\n";
2801 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
2802 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
2807 | String n -> pr " %s = args.%s;\n" n n
2808 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
2810 pr " %s = realloc (args.%s.%s_val,\n" n n n;
2811 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
2812 pr " if (%s == NULL) {\n" n;
2813 pr " reply_with_perror (\"realloc\");\n";
2816 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
2817 pr " args.%s.%s_val = %s;\n" n n n;
2818 | Bool n -> pr " %s = args.%s;\n" n n
2819 | Int n -> pr " %s = args.%s;\n" n n
2820 | FileIn _ | FileOut _ -> ()
2825 (* Don't want to call the impl with any FileIn or FileOut
2826 * parameters, since these go "outside" the RPC protocol.
2829 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
2831 pr " r = do_%s " name;
2832 generate_call_args argsnofile;
2835 pr " if (r == %s)\n" error_code;
2836 pr " /* do_%s has already called reply_with_error */\n" name;
2840 (* If there are any FileOut parameters, then the impl must
2841 * send its own reply.
2844 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
2846 pr " /* do_%s has already sent a reply */\n" name
2848 match fst style with
2849 | RErr -> pr " reply (NULL, NULL);\n"
2850 | RInt n | RInt64 n | RBool n ->
2851 pr " struct guestfs_%s_ret ret;\n" name;
2852 pr " ret.%s = r;\n" n;
2853 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
2856 failwithf "RConstString cannot be returned from a daemon function"
2858 pr " struct guestfs_%s_ret ret;\n" name;
2859 pr " ret.%s = r;\n" n;
2860 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
2863 | RStringList n | RHashtable n ->
2864 pr " struct guestfs_%s_ret ret;\n" name;
2865 pr " ret.%s.%s_len = count_strings (r);\n" n n;
2866 pr " ret.%s.%s_val = r;\n" n n;
2867 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
2869 pr " free_strings (r);\n"
2871 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n"
2873 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n" name
2874 | RPVList n | RVGList n | RLVList n
2875 | RStat n | RStatVFS n ->
2876 pr " struct guestfs_%s_ret ret;\n" name;
2877 pr " ret.%s = *r;\n" n;
2878 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
2880 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
2884 (* Free the args. *)
2885 (match snd style with
2890 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
2897 (* Dispatch function. *)
2898 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
2900 pr " switch (proc_nr) {\n";
2903 fun (name, style, _, _, _, _, _) ->
2904 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
2905 pr " %s_stub (xdr_in);\n" name;
2910 pr " reply_with_error (\"dispatch_incoming_message: unknown procedure number %%d\", proc_nr);\n";
2915 (* LVM columns and tokenization functions. *)
2916 (* XXX This generates crap code. We should rethink how we
2922 pr "static const char *lvm_%s_cols = \"%s\";\n"
2923 typ (String.concat "," (List.map fst cols));
2926 pr "static int lvm_tokenize_%s (char *str, struct guestfs_lvm_int_%s *r)\n" typ typ;
2928 pr " char *tok, *p, *next;\n";
2932 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
2935 pr " if (!str) {\n";
2936 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
2939 pr " if (!*str || isspace (*str)) {\n";
2940 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
2945 fun (name, coltype) ->
2946 pr " if (!tok) {\n";
2947 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
2950 pr " p = strchrnul (tok, ',');\n";
2951 pr " if (*p) next = p+1; else next = NULL;\n";
2952 pr " *p = '\\0';\n";
2955 pr " r->%s = strdup (tok);\n" name;
2956 pr " if (r->%s == NULL) {\n" name;
2957 pr " perror (\"strdup\");\n";
2961 pr " for (i = j = 0; i < 32; ++j) {\n";
2962 pr " if (tok[j] == '\\0') {\n";
2963 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
2965 pr " } else if (tok[j] != '-')\n";
2966 pr " r->%s[i++] = tok[j];\n" name;
2969 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
2970 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
2974 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
2975 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
2979 pr " if (tok[0] == '\\0')\n";
2980 pr " r->%s = -1;\n" name;
2981 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
2982 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
2986 pr " tok = next;\n";
2989 pr " if (tok != NULL) {\n";
2990 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
2997 pr "guestfs_lvm_int_%s_list *\n" typ;
2998 pr "parse_command_line_%ss (void)\n" typ;
3000 pr " char *out, *err;\n";
3001 pr " char *p, *pend;\n";
3003 pr " guestfs_lvm_int_%s_list *ret;\n" typ;
3004 pr " void *newp;\n";
3006 pr " ret = malloc (sizeof *ret);\n";
3007 pr " if (!ret) {\n";
3008 pr " reply_with_perror (\"malloc\");\n";
3009 pr " return NULL;\n";
3012 pr " ret->guestfs_lvm_int_%s_list_len = 0;\n" typ;
3013 pr " ret->guestfs_lvm_int_%s_list_val = NULL;\n" typ;
3015 pr " r = command (&out, &err,\n";
3016 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
3017 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
3018 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
3019 pr " if (r == -1) {\n";
3020 pr " reply_with_error (\"%%s\", err);\n";
3021 pr " free (out);\n";
3022 pr " free (err);\n";
3023 pr " free (ret);\n";
3024 pr " return NULL;\n";
3027 pr " free (err);\n";
3029 pr " /* Tokenize each line of the output. */\n";
3032 pr " while (p) {\n";
3033 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
3034 pr " if (pend) {\n";
3035 pr " *pend = '\\0';\n";
3039 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
3042 pr " if (!*p) { /* Empty line? Skip it. */\n";
3047 pr " /* Allocate some space to store this next entry. */\n";
3048 pr " newp = realloc (ret->guestfs_lvm_int_%s_list_val,\n" typ;
3049 pr " sizeof (guestfs_lvm_int_%s) * (i+1));\n" typ;
3050 pr " if (newp == NULL) {\n";
3051 pr " reply_with_perror (\"realloc\");\n";
3052 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3053 pr " free (ret);\n";
3054 pr " free (out);\n";
3055 pr " return NULL;\n";
3057 pr " ret->guestfs_lvm_int_%s_list_val = newp;\n" typ;
3059 pr " /* Tokenize the next entry. */\n";
3060 pr " r = lvm_tokenize_%s (p, &ret->guestfs_lvm_int_%s_list_val[i]);\n" typ typ;
3061 pr " if (r == -1) {\n";
3062 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
3063 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3064 pr " free (ret);\n";
3065 pr " free (out);\n";
3066 pr " return NULL;\n";
3073 pr " ret->guestfs_lvm_int_%s_list_len = i;\n" typ;
3075 pr " free (out);\n";
3076 pr " return ret;\n";
3079 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
3081 (* Generate the tests. *)
3082 and generate_tests () =
3083 generate_header CStyle GPLv2;
3090 #include <sys/types.h>
3093 #include \"guestfs.h\"
3095 static guestfs_h *g;
3096 static int suppress_error = 0;
3098 static void print_error (guestfs_h *g, void *data, const char *msg)
3100 if (!suppress_error)
3101 fprintf (stderr, \"%%s\\n\", msg);
3104 static void print_strings (char * const * const argv)
3108 for (argc = 0; argv[argc] != NULL; ++argc)
3109 printf (\"\\t%%s\\n\", argv[argc]);
3113 static void print_table (char * const * const argv)
3117 for (i = 0; argv[i] != NULL; i += 2)
3118 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
3122 static void no_test_warnings (void)
3128 | name, _, _, _, [], _, _ ->
3129 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
3130 | name, _, _, _, tests, _, _ -> ()
3136 (* Generate the actual tests. Note that we generate the tests
3137 * in reverse order, deliberately, so that (in general) the
3138 * newest tests run first. This makes it quicker and easier to
3143 fun (name, _, _, _, tests, _, _) ->
3144 mapi (generate_one_test name) tests
3145 ) (List.rev all_functions) in
3146 let test_names = List.concat test_names in
3147 let nr_tests = List.length test_names in
3150 int main (int argc, char *argv[])
3155 const char *filename;
3157 int nr_tests, test_num = 0;
3159 no_test_warnings ();
3161 g = guestfs_create ();
3163 printf (\"guestfs_create FAILED\\n\");
3167 guestfs_set_error_handler (g, print_error, NULL);
3169 srcdir = getenv (\"srcdir\");
3170 if (!srcdir) srcdir = \".\";
3172 guestfs_set_path (g, \".\");
3174 filename = \"test1.img\";
3175 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3180 if (lseek (fd, %d, SEEK_SET) == -1) {
3186 if (write (fd, &c, 1) == -1) {
3192 if (close (fd) == -1) {
3197 if (guestfs_add_drive (g, filename) == -1) {
3198 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3202 filename = \"test2.img\";
3203 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3208 if (lseek (fd, %d, SEEK_SET) == -1) {
3214 if (write (fd, &c, 1) == -1) {
3220 if (close (fd) == -1) {
3225 if (guestfs_add_drive (g, filename) == -1) {
3226 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3230 filename = \"test3.img\";
3231 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3236 if (lseek (fd, %d, SEEK_SET) == -1) {
3242 if (write (fd, &c, 1) == -1) {
3248 if (close (fd) == -1) {
3253 if (guestfs_add_drive (g, filename) == -1) {
3254 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3258 if (guestfs_launch (g) == -1) {
3259 printf (\"guestfs_launch FAILED\\n\");
3262 if (guestfs_wait_ready (g) == -1) {
3263 printf (\"guestfs_wait_ready FAILED\\n\");
3269 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
3273 pr " test_num++;\n";
3274 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
3275 pr " if (%s () == -1) {\n" test_name;
3276 pr " printf (\"%s FAILED\\n\");\n" test_name;
3282 pr " guestfs_close (g);\n";
3283 pr " unlink (\"test1.img\");\n";
3284 pr " unlink (\"test2.img\");\n";
3285 pr " unlink (\"test3.img\");\n";
3288 pr " if (failed > 0) {\n";
3289 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
3297 and generate_one_test name i (init, test) =
3298 let test_name = sprintf "test_%s_%d" name i in
3300 pr "static int %s (void)\n" test_name;
3306 pr " /* InitEmpty for %s (%d) */\n" name i;
3307 List.iter (generate_test_command_call test_name)
3311 pr " /* InitBasicFS for %s (%d): create ext2 on /dev/sda1 */\n" name i;
3312 List.iter (generate_test_command_call test_name)
3315 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
3316 ["mkfs"; "ext2"; "/dev/sda1"];
3317 ["mount"; "/dev/sda1"; "/"]]
3318 | InitBasicFSonLVM ->
3319 pr " /* InitBasicFSonLVM for %s (%d): create ext2 on /dev/VG/LV */\n"
3321 List.iter (generate_test_command_call test_name)
3324 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
3325 ["pvcreate"; "/dev/sda1"];
3326 ["vgcreate"; "VG"; "/dev/sda1"];
3327 ["lvcreate"; "LV"; "VG"; "8"];
3328 ["mkfs"; "ext2"; "/dev/VG/LV"];
3329 ["mount"; "/dev/VG/LV"; "/"]]
3332 let get_seq_last = function
3334 failwithf "%s: you cannot use [] (empty list) when expecting a command"
3337 let seq = List.rev seq in
3338 List.rev (List.tl seq), List.hd seq
3343 pr " /* TestRun for %s (%d) */\n" name i;
3344 List.iter (generate_test_command_call test_name) seq
3345 | TestOutput (seq, expected) ->
3346 pr " /* TestOutput for %s (%d) */\n" name i;
3347 let seq, last = get_seq_last seq in
3349 pr " if (strcmp (r, \"%s\") != 0) {\n" (c_quote expected);
3350 pr " fprintf (stderr, \"%s: expected \\\"%s\\\" but got \\\"%%s\\\"\\n\", r);\n" test_name (c_quote expected);
3354 List.iter (generate_test_command_call test_name) seq;
3355 generate_test_command_call ~test test_name last
3356 | TestOutputList (seq, expected) ->
3357 pr " /* TestOutputList for %s (%d) */\n" name i;
3358 let seq, last = get_seq_last seq in
3362 pr " if (!r[%d]) {\n" i;
3363 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
3364 pr " print_strings (r);\n";
3367 pr " if (strcmp (r[%d], \"%s\") != 0) {\n" i (c_quote str);
3368 pr " fprintf (stderr, \"%s: expected \\\"%s\\\" but got \\\"%%s\\\"\\n\", r[%d]);\n" test_name (c_quote str) i;
3372 pr " if (r[%d] != NULL) {\n" (List.length expected);
3373 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
3375 pr " print_strings (r);\n";
3379 List.iter (generate_test_command_call test_name) seq;
3380 generate_test_command_call ~test test_name last
3381 | TestOutputInt (seq, expected) ->
3382 pr " /* TestOutputInt for %s (%d) */\n" name i;
3383 let seq, last = get_seq_last seq in
3385 pr " if (r != %d) {\n" expected;
3386 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
3392 List.iter (generate_test_command_call test_name) seq;
3393 generate_test_command_call ~test test_name last
3394 | TestOutputTrue seq ->
3395 pr " /* TestOutputTrue for %s (%d) */\n" name i;
3396 let seq, last = get_seq_last seq in
3399 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
3404 List.iter (generate_test_command_call test_name) seq;
3405 generate_test_command_call ~test test_name last
3406 | TestOutputFalse seq ->
3407 pr " /* TestOutputFalse for %s (%d) */\n" name i;
3408 let seq, last = get_seq_last seq in
3411 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
3416 List.iter (generate_test_command_call test_name) seq;
3417 generate_test_command_call ~test test_name last
3418 | TestOutputLength (seq, expected) ->
3419 pr " /* TestOutputLength for %s (%d) */\n" name i;
3420 let seq, last = get_seq_last seq in
3423 pr " for (j = 0; j < %d; ++j)\n" expected;
3424 pr " if (r[j] == NULL) {\n";
3425 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
3427 pr " print_strings (r);\n";
3430 pr " if (r[j] != NULL) {\n";
3431 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
3433 pr " print_strings (r);\n";
3437 List.iter (generate_test_command_call test_name) seq;
3438 generate_test_command_call ~test test_name last
3439 | TestOutputStruct (seq, checks) ->
3440 pr " /* TestOutputStruct for %s (%d) */\n" name i;
3441 let seq, last = get_seq_last seq in
3445 | CompareWithInt (field, expected) ->
3446 pr " if (r->%s != %d) {\n" field expected;
3447 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
3448 test_name field expected;
3449 pr " (int) r->%s);\n" field;
3452 | CompareWithString (field, expected) ->
3453 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
3454 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
3455 test_name field expected;
3456 pr " r->%s);\n" field;
3459 | CompareFieldsIntEq (field1, field2) ->
3460 pr " if (r->%s != r->%s) {\n" field1 field2;
3461 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
3462 test_name field1 field2;
3463 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
3466 | CompareFieldsStrEq (field1, field2) ->
3467 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
3468 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
3469 test_name field1 field2;
3470 pr " r->%s, r->%s);\n" field1 field2;
3475 List.iter (generate_test_command_call test_name) seq;
3476 generate_test_command_call ~test test_name last
3477 | TestLastFail seq ->
3478 pr " /* TestLastFail for %s (%d) */\n" name i;
3479 let seq, last = get_seq_last seq in
3480 List.iter (generate_test_command_call test_name) seq;
3481 generate_test_command_call test_name ~expect_error:true last
3489 (* Generate the code to run a command, leaving the result in 'r'.
3490 * If you expect to get an error then you should set expect_error:true.
3492 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
3494 | [] -> assert false
3496 (* Look up the command to find out what args/ret it has. *)
3499 let _, style, _, _, _, _, _ =
3500 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
3503 failwithf "%s: in test, command %s was not found" test_name name in
3505 if List.length (snd style) <> List.length args then
3506 failwithf "%s: in test, wrong number of args given to %s"
3517 | FileIn _, _ | FileOut _, _ -> ()
3518 | StringList n, arg ->
3519 pr " char *%s[] = {\n" n;
3520 let strs = string_split " " arg in
3522 fun str -> pr " \"%s\",\n" (c_quote str)
3526 ) (List.combine (snd style) args);
3529 match fst style with
3530 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
3531 | RInt64 _ -> pr " int64_t r;\n"; "-1"
3532 | RConstString _ -> pr " const char *r;\n"; "NULL"
3533 | RString _ -> pr " char *r;\n"; "NULL"
3534 | RStringList _ | RHashtable _ ->
3539 pr " struct guestfs_int_bool *r;\n"; "NULL"
3541 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
3543 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
3545 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
3547 pr " struct guestfs_stat *r;\n"; "NULL"
3549 pr " struct guestfs_statvfs *r;\n"; "NULL" in
3551 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
3552 pr " r = guestfs_%s (g" name;
3554 (* Generate the parameters. *)
3558 | FileIn _, arg | FileOut _, arg ->
3559 pr ", \"%s\"" (c_quote arg)
3560 | OptString _, arg ->
3561 if arg = "NULL" then pr ", NULL" else pr ", \"%s\"" (c_quote arg)
3562 | StringList n, _ ->
3566 try int_of_string arg
3567 with Failure "int_of_string" ->
3568 failwithf "%s: expecting an int, but got '%s'" test_name arg in
3571 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
3572 ) (List.combine (snd style) args);
3575 if not expect_error then
3576 pr " if (r == %s)\n" error_code
3578 pr " if (r != %s)\n" error_code;
3581 (* Insert the test code. *)
3587 (match fst style with
3588 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _ -> ()
3589 | RString _ -> pr " free (r);\n"
3590 | RStringList _ | RHashtable _ ->
3591 pr " for (i = 0; r[i] != NULL; ++i)\n";
3592 pr " free (r[i]);\n";
3595 pr " guestfs_free_int_bool (r);\n"
3597 pr " guestfs_free_lvm_pv_list (r);\n"
3599 pr " guestfs_free_lvm_vg_list (r);\n"
3601 pr " guestfs_free_lvm_lv_list (r);\n"
3602 | RStat _ | RStatVFS _ ->
3609 let str = replace_str str "\r" "\\r" in
3610 let str = replace_str str "\n" "\\n" in
3611 let str = replace_str str "\t" "\\t" in
3614 (* Generate a lot of different functions for guestfish. *)
3615 and generate_fish_cmds () =
3616 generate_header CStyle GPLv2;
3620 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3622 let all_functions_sorted =
3624 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3625 ) all_functions_sorted in
3627 pr "#include <stdio.h>\n";
3628 pr "#include <stdlib.h>\n";
3629 pr "#include <string.h>\n";
3630 pr "#include <inttypes.h>\n";
3632 pr "#include <guestfs.h>\n";
3633 pr "#include \"fish.h\"\n";
3636 (* list_commands function, which implements guestfish -h *)
3637 pr "void list_commands (void)\n";
3639 pr " printf (\" %%-16s %%s\\n\", \"Command\", \"Description\");\n";
3640 pr " list_builtin_commands ();\n";
3642 fun (name, _, _, flags, _, shortdesc, _) ->
3643 let name = replace_char name '_' '-' in
3644 pr " printf (\"%%-20s %%s\\n\", \"%s\", \"%s\");\n"
3646 ) all_functions_sorted;
3647 pr " printf (\" Use -h <cmd> / help <cmd> to show detailed help for a command.\\n\");\n";
3651 (* display_command function, which implements guestfish -h cmd *)
3652 pr "void display_command (const char *cmd)\n";
3655 fun (name, style, _, flags, _, shortdesc, longdesc) ->
3656 let name2 = replace_char name '_' '-' in
3658 try find_map (function FishAlias n -> Some n | _ -> None) flags
3659 with Not_found -> name in
3660 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
3662 match snd style with
3666 name2 (String.concat "> <" (List.map name_of_argt args)) in
3669 if List.mem ProtocolLimitWarning flags then
3670 ("\n\n" ^ protocol_limit_warning)
3673 (* For DangerWillRobinson commands, we should probably have
3674 * guestfish prompt before allowing you to use them (especially
3675 * in interactive mode). XXX
3679 if List.mem DangerWillRobinson flags then
3680 ("\n\n" ^ danger_will_robinson)
3683 let describe_alias =
3684 if name <> alias then
3685 sprintf "\n\nYou can use '%s' as an alias for this command." alias
3689 pr "strcasecmp (cmd, \"%s\") == 0" name;
3690 if name <> name2 then
3691 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
3692 if name <> alias then
3693 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
3695 pr " pod2text (\"%s - %s\", %S);\n"
3697 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
3700 pr " display_builtin_command (cmd);\n";
3704 (* print_{pv,vg,lv}_list functions *)
3708 pr "static void print_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
3715 pr " printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
3717 pr " printf (\"%s: \");\n" name;
3718 pr " for (i = 0; i < 32; ++i)\n";
3719 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
3720 pr " printf (\"\\n\");\n"
3722 pr " printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
3724 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
3725 | name, `OptPercent ->
3726 pr " if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
3727 typ name name typ name;
3728 pr " else printf (\"%s: \\n\");\n" name
3732 pr "static void print_%s_list (struct guestfs_lvm_%s_list *%ss)\n"
3737 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
3738 pr " print_%s (&%ss->val[i]);\n" typ typ;
3741 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
3743 (* print_{stat,statvfs} functions *)
3747 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
3752 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
3756 ) ["stat", stat_cols; "statvfs", statvfs_cols];
3758 (* run_<action> actions *)
3760 fun (name, style, _, flags, _, _, _) ->
3761 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
3763 (match fst style with
3766 | RBool _ -> pr " int r;\n"
3767 | RInt64 _ -> pr " int64_t r;\n"
3768 | RConstString _ -> pr " const char *r;\n"
3769 | RString _ -> pr " char *r;\n"
3770 | RStringList _ | RHashtable _ -> pr " char **r;\n"
3771 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"
3772 | RPVList _ -> pr " struct guestfs_lvm_pv_list *r;\n"
3773 | RVGList _ -> pr " struct guestfs_lvm_vg_list *r;\n"
3774 | RLVList _ -> pr " struct guestfs_lvm_lv_list *r;\n"
3775 | RStat _ -> pr " struct guestfs_stat *r;\n"
3776 | RStatVFS _ -> pr " struct guestfs_statvfs *r;\n"
3783 | FileOut n -> pr " const char *%s;\n" n
3784 | StringList n -> pr " char **%s;\n" n
3785 | Bool n -> pr " int %s;\n" n
3786 | Int n -> pr " int %s;\n" n
3789 (* Check and convert parameters. *)
3790 let argc_expected = List.length (snd style) in
3791 pr " if (argc != %d) {\n" argc_expected;
3792 pr " fprintf (stderr, \"%%s should have %d parameter(s)\\n\", cmd);\n"
3794 pr " fprintf (stderr, \"type 'help %%s' for help on %%s\\n\", cmd, cmd);\n";
3800 | String name -> pr " %s = argv[%d];\n" name i
3802 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
3805 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
3808 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
3810 | StringList name ->
3811 pr " %s = parse_string_list (argv[%d]);\n" name i
3813 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
3815 pr " %s = atoi (argv[%d]);\n" name i
3818 (* Call C API function. *)
3820 try find_map (function FishAction n -> Some n | _ -> None) flags
3821 with Not_found -> sprintf "guestfs_%s" name in
3823 generate_call_args ~handle:"g" (snd style);
3826 (* Check return value for errors and display command results. *)
3827 (match fst style with
3828 | RErr -> pr " return r;\n"
3830 pr " if (r == -1) return -1;\n";
3831 pr " printf (\"%%d\\n\", r);\n";
3834 pr " if (r == -1) return -1;\n";
3835 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
3838 pr " if (r == -1) return -1;\n";
3839 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
3842 pr " if (r == NULL) return -1;\n";
3843 pr " printf (\"%%s\\n\", r);\n";
3846 pr " if (r == NULL) return -1;\n";
3847 pr " printf (\"%%s\\n\", r);\n";
3851 pr " if (r == NULL) return -1;\n";
3852 pr " print_strings (r);\n";
3853 pr " free_strings (r);\n";
3856 pr " if (r == NULL) return -1;\n";
3857 pr " printf (\"%%d, %%s\\n\", r->i,\n";
3858 pr " r->b ? \"true\" : \"false\");\n";
3859 pr " guestfs_free_int_bool (r);\n";
3862 pr " if (r == NULL) return -1;\n";
3863 pr " print_pv_list (r);\n";
3864 pr " guestfs_free_lvm_pv_list (r);\n";
3867 pr " if (r == NULL) return -1;\n";
3868 pr " print_vg_list (r);\n";
3869 pr " guestfs_free_lvm_vg_list (r);\n";
3872 pr " if (r == NULL) return -1;\n";
3873 pr " print_lv_list (r);\n";
3874 pr " guestfs_free_lvm_lv_list (r);\n";
3877 pr " if (r == NULL) return -1;\n";
3878 pr " print_stat (r);\n";
3882 pr " if (r == NULL) return -1;\n";
3883 pr " print_statvfs (r);\n";
3887 pr " if (r == NULL) return -1;\n";
3888 pr " print_table (r);\n";
3889 pr " free_strings (r);\n";
3896 (* run_action function *)
3897 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
3900 fun (name, _, _, flags, _, _, _) ->
3901 let name2 = replace_char name '_' '-' in
3903 try find_map (function FishAlias n -> Some n | _ -> None) flags
3904 with Not_found -> name in
3906 pr "strcasecmp (cmd, \"%s\") == 0" name;
3907 if name <> name2 then
3908 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
3909 if name <> alias then
3910 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
3912 pr " return run_%s (cmd, argc, argv);\n" name;
3916 pr " fprintf (stderr, \"%%s: unknown command\\n\", cmd);\n";
3923 (* Readline completion for guestfish. *)
3924 and generate_fish_completion () =
3925 generate_header CStyle GPLv2;
3929 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3939 #ifdef HAVE_LIBREADLINE
3940 #include <readline/readline.h>
3945 #ifdef HAVE_LIBREADLINE
3947 static const char *const commands[] = {
3950 (* Get the commands and sort them, including the aliases. *)
3953 fun (name, _, _, flags, _, _, _) ->
3954 let name2 = replace_char name '_' '-' in
3956 try find_map (function FishAlias n -> Some n | _ -> None) flags
3957 with Not_found -> name in
3959 if name <> alias then [name2; alias] else [name2]
3961 let commands = List.flatten commands in
3962 let commands = List.sort compare commands in
3964 List.iter (pr " \"%s\",\n") commands;
3970 generator (const char *text, int state)
3972 static int index, len;
3977 len = strlen (text);
3980 while ((name = commands[index]) != NULL) {
3982 if (strncasecmp (name, text, len) == 0)
3983 return strdup (name);
3989 #endif /* HAVE_LIBREADLINE */
3991 char **do_completion (const char *text, int start, int end)
3993 char **matches = NULL;
3995 #ifdef HAVE_LIBREADLINE
3997 matches = rl_completion_matches (text, generator);
4004 (* Generate the POD documentation for guestfish. *)
4005 and generate_fish_actions_pod () =
4006 let all_functions_sorted =
4008 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4009 ) all_functions_sorted in
4011 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
4014 fun (name, style, _, flags, _, _, longdesc) ->
4016 Str.global_substitute rex (
4019 try Str.matched_group 1 s
4021 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
4022 "C<" ^ replace_char sub '_' '-' ^ ">"
4024 let name = replace_char name '_' '-' in
4026 try find_map (function FishAlias n -> Some n | _ -> None) flags
4027 with Not_found -> name in
4029 pr "=head2 %s" name;
4030 if name <> alias then
4037 | String n -> pr " %s" n
4038 | OptString n -> pr " %s" n
4039 | StringList n -> pr " '%s ...'" n
4040 | Bool _ -> pr " true|false"
4041 | Int n -> pr " %s" n
4042 | FileIn n | FileOut n -> pr " (%s|-)" n
4046 pr "%s\n\n" longdesc;
4048 if List.exists (function FileIn _ | FileOut _ -> true
4049 | _ -> false) (snd style) then
4050 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
4052 if List.mem ProtocolLimitWarning flags then
4053 pr "%s\n\n" protocol_limit_warning;
4055 if List.mem DangerWillRobinson flags then
4056 pr "%s\n\n" danger_will_robinson
4057 ) all_functions_sorted
4059 (* Generate a C function prototype. *)
4060 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
4061 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
4063 ?handle name style =
4064 if extern then pr "extern ";
4065 if static then pr "static ";
4066 (match fst style with
4068 | RInt _ -> pr "int "
4069 | RInt64 _ -> pr "int64_t "
4070 | RBool _ -> pr "int "
4071 | RConstString _ -> pr "const char *"
4072 | RString _ -> pr "char *"
4073 | RStringList _ | RHashtable _ -> pr "char **"
4075 if not in_daemon then pr "struct guestfs_int_bool *"
4076 else pr "guestfs_%s_ret *" name
4078 if not in_daemon then pr "struct guestfs_lvm_pv_list *"
4079 else pr "guestfs_lvm_int_pv_list *"
4081 if not in_daemon then pr "struct guestfs_lvm_vg_list *"
4082 else pr "guestfs_lvm_int_vg_list *"
4084 if not in_daemon then pr "struct guestfs_lvm_lv_list *"
4085 else pr "guestfs_lvm_int_lv_list *"
4087 if not in_daemon then pr "struct guestfs_stat *"
4088 else pr "guestfs_int_stat *"
4090 if not in_daemon then pr "struct guestfs_statvfs *"
4091 else pr "guestfs_int_statvfs *"
4093 pr "%s%s (" prefix name;
4094 if handle = None && List.length (snd style) = 0 then
4097 let comma = ref false in
4100 | Some handle -> pr "guestfs_h *%s" handle; comma := true
4104 if single_line then pr ", " else pr ",\n\t\t"
4111 | OptString n -> next (); pr "const char *%s" n
4112 | StringList n -> next (); pr "char * const* const %s" n
4113 | Bool n -> next (); pr "int %s" n
4114 | Int n -> next (); pr "int %s" n
4117 if not in_daemon then (next (); pr "const char *%s" n)
4121 if semicolon then pr ";";
4122 if newline then pr "\n"
4124 (* Generate C call arguments, eg "(handle, foo, bar)" *)
4125 and generate_call_args ?handle args =
4127 let comma = ref false in
4130 | Some handle -> pr "%s" handle; comma := true
4134 if !comma then pr ", ";
4136 pr "%s" (name_of_argt arg)
4140 (* Generate the OCaml bindings interface. *)
4141 and generate_ocaml_mli () =
4142 generate_header OCamlStyle LGPLv2;
4145 (** For API documentation you should refer to the C API
4146 in the guestfs(3) manual page. The OCaml API uses almost
4147 exactly the same calls. *)
4150 (** A [guestfs_h] handle. *)
4152 exception Error of string
4153 (** This exception is raised when there is an error. *)
4155 val create : unit -> t
4157 val close : t -> unit
4158 (** Handles are closed by the garbage collector when they become
4159 unreferenced, but callers can also call this in order to
4160 provide predictable cleanup. *)
4163 generate_ocaml_lvm_structure_decls ();
4165 generate_ocaml_stat_structure_decls ();
4169 fun (name, style, _, _, _, shortdesc, _) ->
4170 generate_ocaml_prototype name style;
4171 pr "(** %s *)\n" shortdesc;
4175 (* Generate the OCaml bindings implementation. *)
4176 and generate_ocaml_ml () =
4177 generate_header OCamlStyle LGPLv2;
4181 exception Error of string
4182 external create : unit -> t = \"ocaml_guestfs_create\"
4183 external close : t -> unit = \"ocaml_guestfs_close\"
4186 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
4190 generate_ocaml_lvm_structure_decls ();
4192 generate_ocaml_stat_structure_decls ();
4196 fun (name, style, _, _, _, shortdesc, _) ->
4197 generate_ocaml_prototype ~is_external:true name style;
4200 (* Generate the OCaml bindings C implementation. *)
4201 and generate_ocaml_c () =
4202 generate_header CStyle LGPLv2;
4209 #include <caml/config.h>
4210 #include <caml/alloc.h>
4211 #include <caml/callback.h>
4212 #include <caml/fail.h>
4213 #include <caml/memory.h>
4214 #include <caml/mlvalues.h>
4215 #include <caml/signals.h>
4217 #include <guestfs.h>
4219 #include \"guestfs_c.h\"
4221 /* Copy a hashtable of string pairs into an assoc-list. We return
4222 * the list in reverse order, but hashtables aren't supposed to be
4225 static CAMLprim value
4226 copy_table (char * const * argv)
4229 CAMLlocal5 (rv, pairv, kv, vv, cons);
4233 for (i = 0; argv[i] != NULL; i += 2) {
4234 kv = caml_copy_string (argv[i]);
4235 vv = caml_copy_string (argv[i+1]);
4236 pairv = caml_alloc (2, 0);
4237 Store_field (pairv, 0, kv);
4238 Store_field (pairv, 1, vv);
4239 cons = caml_alloc (2, 0);
4240 Store_field (cons, 1, rv);
4242 Store_field (cons, 0, pairv);
4250 (* LVM struct copy functions. *)
4253 let has_optpercent_col =
4254 List.exists (function (_, `OptPercent) -> true | _ -> false) cols in
4256 pr "static CAMLprim value\n";
4257 pr "copy_lvm_%s (const struct guestfs_lvm_%s *%s)\n" typ typ typ;
4259 pr " CAMLparam0 ();\n";
4260 if has_optpercent_col then
4261 pr " CAMLlocal3 (rv, v, v2);\n"
4263 pr " CAMLlocal2 (rv, v);\n";
4265 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
4270 pr " v = caml_copy_string (%s->%s);\n" typ name
4272 pr " v = caml_alloc_string (32);\n";
4273 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
4276 pr " v = caml_copy_int64 (%s->%s);\n" typ name
4277 | name, `OptPercent ->
4278 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
4279 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
4280 pr " v = caml_alloc (1, 0);\n";
4281 pr " Store_field (v, 0, v2);\n";
4282 pr " } else /* None */\n";
4283 pr " v = Val_int (0);\n";
4285 pr " Store_field (rv, %d, v);\n" i
4287 pr " CAMLreturn (rv);\n";
4291 pr "static CAMLprim value\n";
4292 pr "copy_lvm_%s_list (const struct guestfs_lvm_%s_list *%ss)\n"
4295 pr " CAMLparam0 ();\n";
4296 pr " CAMLlocal2 (rv, v);\n";
4299 pr " if (%ss->len == 0)\n" typ;
4300 pr " CAMLreturn (Atom (0));\n";
4302 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
4303 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
4304 pr " v = copy_lvm_%s (&%ss->val[i]);\n" typ typ;
4305 pr " caml_modify (&Field (rv, i), v);\n";
4307 pr " CAMLreturn (rv);\n";
4311 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
4313 (* Stat copy functions. *)
4316 pr "static CAMLprim value\n";
4317 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
4319 pr " CAMLparam0 ();\n";
4320 pr " CAMLlocal2 (rv, v);\n";
4322 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
4327 pr " v = caml_copy_int64 (%s->%s);\n" typ name
4329 pr " Store_field (rv, %d, v);\n" i
4331 pr " CAMLreturn (rv);\n";
4334 ) ["stat", stat_cols; "statvfs", statvfs_cols];
4338 fun (name, style, _, _, _, _, _) ->
4340 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
4342 pr "CAMLprim value\n";
4343 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
4344 List.iter (pr ", value %s") (List.tl params);
4349 | [p1; p2; p3; p4; p5] ->
4350 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
4351 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
4352 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
4353 pr " CAMLxparam%d (%s);\n"
4354 (List.length rest) (String.concat ", " rest)
4356 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
4358 pr " CAMLlocal1 (rv);\n";
4361 pr " guestfs_h *g = Guestfs_val (gv);\n";
4362 pr " if (g == NULL)\n";
4363 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
4371 pr " const char *%s = String_val (%sv);\n" n n
4373 pr " const char *%s =\n" n;
4374 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
4377 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
4379 pr " int %s = Bool_val (%sv);\n" n n
4381 pr " int %s = Int_val (%sv);\n" n n
4384 match fst style with
4385 | RErr -> pr " int r;\n"; "-1"
4386 | RInt _ -> pr " int r;\n"; "-1"
4387 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4388 | RBool _ -> pr " int r;\n"; "-1"
4389 | RConstString _ -> pr " const char *r;\n"; "NULL"
4390 | RString _ -> pr " char *r;\n"; "NULL"
4396 pr " struct guestfs_int_bool *r;\n"; "NULL"
4398 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
4400 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
4402 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
4404 pr " struct guestfs_stat *r;\n"; "NULL"
4406 pr " struct guestfs_statvfs *r;\n"; "NULL"
4413 pr " caml_enter_blocking_section ();\n";
4414 pr " r = guestfs_%s " name;
4415 generate_call_args ~handle:"g" (snd style);
4417 pr " caml_leave_blocking_section ();\n";
4422 pr " ocaml_guestfs_free_strings (%s);\n" n;
4423 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
4426 pr " if (r == %s)\n" error_code;
4427 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
4430 (match fst style with
4431 | RErr -> pr " rv = Val_unit;\n"
4432 | RInt _ -> pr " rv = Val_int (r);\n"
4434 pr " rv = caml_copy_int64 (r);\n"
4435 | RBool _ -> pr " rv = Val_bool (r);\n"
4436 | RConstString _ -> pr " rv = caml_copy_string (r);\n"
4438 pr " rv = caml_copy_string (r);\n";
4441 pr " rv = caml_copy_string_array ((const char **) r);\n";
4442 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
4445 pr " rv = caml_alloc (2, 0);\n";
4446 pr " Store_field (rv, 0, Val_int (r->i));\n";
4447 pr " Store_field (rv, 1, Val_bool (r->b));\n";
4448 pr " guestfs_free_int_bool (r);\n";
4450 pr " rv = copy_lvm_pv_list (r);\n";
4451 pr " guestfs_free_lvm_pv_list (r);\n";
4453 pr " rv = copy_lvm_vg_list (r);\n";
4454 pr " guestfs_free_lvm_vg_list (r);\n";
4456 pr " rv = copy_lvm_lv_list (r);\n";
4457 pr " guestfs_free_lvm_lv_list (r);\n";
4459 pr " rv = copy_stat (r);\n";
4462 pr " rv = copy_statvfs (r);\n";
4465 pr " rv = copy_table (r);\n";
4466 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
4470 pr " CAMLreturn (rv);\n";
4474 if List.length params > 5 then (
4475 pr "CAMLprim value\n";
4476 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
4478 pr " return ocaml_guestfs_%s (argv[0]" name;
4479 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
4486 and generate_ocaml_lvm_structure_decls () =
4489 pr "type lvm_%s = {\n" typ;
4492 | name, `String -> pr " %s : string;\n" name
4493 | name, `UUID -> pr " %s : string;\n" name
4494 | name, `Bytes -> pr " %s : int64;\n" name
4495 | name, `Int -> pr " %s : int64;\n" name
4496 | name, `OptPercent -> pr " %s : float option;\n" name
4500 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
4502 and generate_ocaml_stat_structure_decls () =
4505 pr "type %s = {\n" typ;
4508 | name, `Int -> pr " %s : int64;\n" name
4512 ) ["stat", stat_cols; "statvfs", statvfs_cols]
4514 and generate_ocaml_prototype ?(is_external = false) name style =
4515 if is_external then pr "external " else pr "val ";
4516 pr "%s : t -> " name;
4519 | String _ | FileIn _ | FileOut _ -> pr "string -> "
4520 | OptString _ -> pr "string option -> "
4521 | StringList _ -> pr "string array -> "
4522 | Bool _ -> pr "bool -> "
4523 | Int _ -> pr "int -> "
4525 (match fst style with
4526 | RErr -> pr "unit" (* all errors are turned into exceptions *)
4527 | RInt _ -> pr "int"
4528 | RInt64 _ -> pr "int64"
4529 | RBool _ -> pr "bool"
4530 | RConstString _ -> pr "string"
4531 | RString _ -> pr "string"
4532 | RStringList _ -> pr "string array"
4533 | RIntBool _ -> pr "int * bool"
4534 | RPVList _ -> pr "lvm_pv array"
4535 | RVGList _ -> pr "lvm_vg array"
4536 | RLVList _ -> pr "lvm_lv array"
4537 | RStat _ -> pr "stat"
4538 | RStatVFS _ -> pr "statvfs"
4539 | RHashtable _ -> pr "(string * string) list"
4541 if is_external then (
4543 if List.length (snd style) + 1 > 5 then
4544 pr "\"ocaml_guestfs_%s_byte\" " name;
4545 pr "\"ocaml_guestfs_%s\"" name
4549 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
4550 and generate_perl_xs () =
4551 generate_header CStyle LGPLv2;
4554 #include \"EXTERN.h\"
4558 #include <guestfs.h>
4561 #define PRId64 \"lld\"
4565 my_newSVll(long long val) {
4566 #ifdef USE_64_BIT_ALL
4567 return newSViv(val);
4571 len = snprintf(buf, 100, \"%%\" PRId64, val);
4572 return newSVpv(buf, len);
4577 #define PRIu64 \"llu\"
4581 my_newSVull(unsigned long long val) {
4582 #ifdef USE_64_BIT_ALL
4583 return newSVuv(val);
4587 len = snprintf(buf, 100, \"%%\" PRIu64, val);
4588 return newSVpv(buf, len);
4592 /* http://www.perlmonks.org/?node_id=680842 */
4594 XS_unpack_charPtrPtr (SV *arg) {
4599 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
4600 croak (\"array reference expected\");
4602 av = (AV *)SvRV (arg);
4603 ret = malloc (av_len (av) + 1 + 1);
4605 croak (\"malloc failed\");
4607 for (i = 0; i <= av_len (av); i++) {
4608 SV **elem = av_fetch (av, i, 0);
4610 if (!elem || !*elem)
4611 croak (\"missing element in list\");
4613 ret[i] = SvPV_nolen (*elem);
4621 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
4626 RETVAL = guestfs_create ();
4628 croak (\"could not create guestfs handle\");
4629 guestfs_set_error_handler (RETVAL, NULL, NULL);
4642 fun (name, style, _, _, _, _, _) ->
4643 (match fst style with
4644 | RErr -> pr "void\n"
4645 | RInt _ -> pr "SV *\n"
4646 | RInt64 _ -> pr "SV *\n"
4647 | RBool _ -> pr "SV *\n"
4648 | RConstString _ -> pr "SV *\n"
4649 | RString _ -> pr "SV *\n"
4652 | RPVList _ | RVGList _ | RLVList _
4653 | RStat _ | RStatVFS _
4655 pr "void\n" (* all lists returned implictly on the stack *)
4657 (* Call and arguments. *)
4659 generate_call_args ~handle:"g" (snd style);
4661 pr " guestfs_h *g;\n";
4664 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
4665 | OptString n -> pr " char *%s;\n" n
4666 | StringList n -> pr " char **%s;\n" n
4667 | Bool n -> pr " int %s;\n" n
4668 | Int n -> pr " int %s;\n" n
4671 let do_cleanups () =
4674 | String _ | OptString _ | Bool _ | Int _
4675 | FileIn _ | FileOut _ -> ()
4676 | StringList n -> pr " free (%s);\n" n
4681 (match fst style with
4686 pr " r = guestfs_%s " name;
4687 generate_call_args ~handle:"g" (snd style);
4690 pr " if (r == -1)\n";
4691 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4697 pr " %s = guestfs_%s " n name;
4698 generate_call_args ~handle:"g" (snd style);
4701 pr " if (%s == -1)\n" n;
4702 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4703 pr " RETVAL = newSViv (%s);\n" n;
4708 pr " int64_t %s;\n" n;
4710 pr " %s = guestfs_%s " n name;
4711 generate_call_args ~handle:"g" (snd style);
4714 pr " if (%s == -1)\n" n;
4715 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4716 pr " RETVAL = my_newSVll (%s);\n" n;
4721 pr " const char *%s;\n" n;
4723 pr " %s = guestfs_%s " n name;
4724 generate_call_args ~handle:"g" (snd style);
4727 pr " if (%s == NULL)\n" n;
4728 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4729 pr " RETVAL = newSVpv (%s, 0);\n" n;
4734 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 " RETVAL = newSVpv (%s, 0);\n" n;
4743 pr " free (%s);\n" n;
4746 | RStringList n | RHashtable n ->
4748 pr " char **%s;\n" n;
4751 pr " %s = guestfs_%s " n name;
4752 generate_call_args ~handle:"g" (snd style);
4755 pr " if (%s == NULL)\n" n;
4756 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4757 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
4758 pr " EXTEND (SP, n);\n";
4759 pr " for (i = 0; i < n; ++i) {\n";
4760 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
4761 pr " free (%s[i]);\n" n;
4763 pr " free (%s);\n" n;
4766 pr " struct guestfs_int_bool *r;\n";
4768 pr " r = guestfs_%s " name;
4769 generate_call_args ~handle:"g" (snd style);
4772 pr " if (r == NULL)\n";
4773 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4774 pr " EXTEND (SP, 2);\n";
4775 pr " PUSHs (sv_2mortal (newSViv (r->i)));\n";
4776 pr " PUSHs (sv_2mortal (newSViv (r->b)));\n";
4777 pr " guestfs_free_int_bool (r);\n";
4779 generate_perl_lvm_code "pv" pv_cols name style n do_cleanups
4781 generate_perl_lvm_code "vg" vg_cols name style n do_cleanups
4783 generate_perl_lvm_code "lv" lv_cols name style n do_cleanups
4785 generate_perl_stat_code "stat" stat_cols name style n do_cleanups
4787 generate_perl_stat_code
4788 "statvfs" statvfs_cols name style n do_cleanups
4794 and generate_perl_lvm_code typ cols name style n do_cleanups =
4796 pr " struct guestfs_lvm_%s_list *%s;\n" typ n;
4800 pr " %s = guestfs_%s " n name;
4801 generate_call_args ~handle:"g" (snd style);
4804 pr " if (%s == NULL)\n" n;
4805 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4806 pr " EXTEND (SP, %s->len);\n" n;
4807 pr " for (i = 0; i < %s->len; ++i) {\n" n;
4808 pr " hv = newHV ();\n";
4812 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
4813 name (String.length name) n name
4815 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
4816 name (String.length name) n name
4818 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
4819 name (String.length name) n name
4821 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
4822 name (String.length name) n name
4823 | name, `OptPercent ->
4824 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
4825 name (String.length name) n name
4827 pr " PUSHs (sv_2mortal ((SV *) hv));\n";
4829 pr " guestfs_free_lvm_%s_list (%s);\n" typ n
4831 and generate_perl_stat_code typ cols name style n do_cleanups =
4833 pr " struct guestfs_%s *%s;\n" typ n;
4835 pr " %s = guestfs_%s " n name;
4836 generate_call_args ~handle:"g" (snd style);
4839 pr " if (%s == NULL)\n" n;
4840 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4841 pr " EXTEND (SP, %d);\n" (List.length cols);
4845 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n" n name
4847 pr " free (%s);\n" n
4849 (* Generate Sys/Guestfs.pm. *)
4850 and generate_perl_pm () =
4851 generate_header HashStyle LGPLv2;
4858 Sys::Guestfs - Perl bindings for libguestfs
4864 my $h = Sys::Guestfs->new ();
4865 $h->add_drive ('guest.img');
4868 $h->mount ('/dev/sda1', '/');
4869 $h->touch ('/hello');
4874 The C<Sys::Guestfs> module provides a Perl XS binding to the
4875 libguestfs API for examining and modifying virtual machine
4878 Amongst the things this is good for: making batch configuration
4879 changes to guests, getting disk used/free statistics (see also:
4880 virt-df), migrating between virtualization systems (see also:
4881 virt-p2v), performing partial backups, performing partial guest
4882 clones, cloning guests and changing registry/UUID/hostname info, and
4885 Libguestfs uses Linux kernel and qemu code, and can access any type of
4886 guest filesystem that Linux and qemu can, including but not limited
4887 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
4888 schemes, qcow, qcow2, vmdk.
4890 Libguestfs provides ways to enumerate guest storage (eg. partitions,
4891 LVs, what filesystem is in each LV, etc.). It can also run commands
4892 in the context of the guest. Also you can access filesystems over FTP.
4896 All errors turn into calls to C<croak> (see L<Carp(3)>).
4904 package Sys::Guestfs;
4910 XSLoader::load ('Sys::Guestfs');
4912 =item $h = Sys::Guestfs->new ();
4914 Create a new guestfs handle.
4920 my $class = ref ($proto) || $proto;
4922 my $self = Sys::Guestfs::_create ();
4923 bless $self, $class;
4929 (* Actions. We only need to print documentation for these as
4930 * they are pulled in from the XS code automatically.
4933 fun (name, style, _, flags, _, _, longdesc) ->
4934 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
4936 generate_perl_prototype name style;
4938 pr "%s\n\n" longdesc;
4939 if List.mem ProtocolLimitWarning flags then
4940 pr "%s\n\n" protocol_limit_warning;
4941 if List.mem DangerWillRobinson flags then
4942 pr "%s\n\n" danger_will_robinson
4943 ) all_functions_sorted;
4955 Copyright (C) 2009 Red Hat Inc.
4959 Please see the file COPYING.LIB for the full license.
4963 L<guestfs(3)>, L<guestfish(1)>.
4968 and generate_perl_prototype name style =
4969 (match fst style with
4975 | RString n -> pr "$%s = " n
4976 | RIntBool (n, m) -> pr "($%s, $%s) = " n m
4980 | RLVList n -> pr "@%s = " n
4983 | RHashtable n -> pr "%%%s = " n
4986 let comma = ref false in
4989 if !comma then pr ", ";
4992 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
4999 (* Generate Python C module. *)
5000 and generate_python_c () =
5001 generate_header CStyle LGPLv2;
5010 #include \"guestfs.h\"
5018 get_handle (PyObject *obj)
5021 assert (obj != Py_None);
5022 return ((Pyguestfs_Object *) obj)->g;
5026 put_handle (guestfs_h *g)
5030 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
5033 /* This list should be freed (but not the strings) after use. */
5034 static const char **
5035 get_string_list (PyObject *obj)
5042 if (!PyList_Check (obj)) {
5043 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
5047 len = PyList_Size (obj);
5048 r = malloc (sizeof (char *) * (len+1));
5050 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
5054 for (i = 0; i < len; ++i)
5055 r[i] = PyString_AsString (PyList_GetItem (obj, i));
5062 put_string_list (char * const * const argv)
5067 for (argc = 0; argv[argc] != NULL; ++argc)
5070 list = PyList_New (argc);
5071 for (i = 0; i < argc; ++i)
5072 PyList_SetItem (list, i, PyString_FromString (argv[i]));
5078 put_table (char * const * const argv)
5080 PyObject *list, *item;
5083 for (argc = 0; argv[argc] != NULL; ++argc)
5086 list = PyList_New (argc >> 1);
5087 for (i = 0; i < argc; i += 2) {
5088 item = PyTuple_New (2);
5089 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
5090 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
5091 PyList_SetItem (list, i >> 1, item);
5098 free_strings (char **argv)
5102 for (argc = 0; argv[argc] != NULL; ++argc)
5108 py_guestfs_create (PyObject *self, PyObject *args)
5112 g = guestfs_create ();
5114 PyErr_SetString (PyExc_RuntimeError,
5115 \"guestfs.create: failed to allocate handle\");
5118 guestfs_set_error_handler (g, NULL, NULL);
5119 return put_handle (g);
5123 py_guestfs_close (PyObject *self, PyObject *args)
5128 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
5130 g = get_handle (py_g);
5134 Py_INCREF (Py_None);
5140 (* LVM structures, turned into Python dictionaries. *)
5143 pr "static PyObject *\n";
5144 pr "put_lvm_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
5146 pr " PyObject *dict;\n";
5148 pr " dict = PyDict_New ();\n";
5152 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5153 pr " PyString_FromString (%s->%s));\n"
5156 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5157 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
5160 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5161 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
5164 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5165 pr " PyLong_FromLongLong (%s->%s));\n"
5167 | name, `OptPercent ->
5168 pr " if (%s->%s >= 0)\n" typ name;
5169 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5170 pr " PyFloat_FromDouble ((double) %s->%s));\n"
5173 pr " Py_INCREF (Py_None);\n";
5174 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
5177 pr " return dict;\n";
5181 pr "static PyObject *\n";
5182 pr "put_lvm_%s_list (struct guestfs_lvm_%s_list *%ss)\n" typ typ typ;
5184 pr " PyObject *list;\n";
5187 pr " list = PyList_New (%ss->len);\n" typ;
5188 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
5189 pr " PyList_SetItem (list, i, put_lvm_%s (&%ss->val[i]));\n" typ typ;
5190 pr " return list;\n";
5193 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
5195 (* Stat structures, turned into Python dictionaries. *)
5198 pr "static PyObject *\n";
5199 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
5201 pr " PyObject *dict;\n";
5203 pr " dict = PyDict_New ();\n";
5207 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5208 pr " PyLong_FromLongLong (%s->%s));\n"
5211 pr " return dict;\n";
5214 ) ["stat", stat_cols; "statvfs", statvfs_cols];
5216 (* Python wrapper functions. *)
5218 fun (name, style, _, _, _, _, _) ->
5219 pr "static PyObject *\n";
5220 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
5223 pr " PyObject *py_g;\n";
5224 pr " guestfs_h *g;\n";
5225 pr " PyObject *py_r;\n";
5228 match fst style with
5229 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5230 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5231 | RConstString _ -> pr " const char *r;\n"; "NULL"
5232 | RString _ -> pr " char *r;\n"; "NULL"
5233 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5234 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
5235 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5236 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5237 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5238 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
5239 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
5243 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
5244 | OptString n -> pr " const char *%s;\n" n
5246 pr " PyObject *py_%s;\n" n;
5247 pr " const char **%s;\n" n
5248 | Bool n -> pr " int %s;\n" n
5249 | Int n -> pr " int %s;\n" n
5254 (* Convert the parameters. *)
5255 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
5258 | String _ | FileIn _ | FileOut _ -> pr "s"
5259 | OptString _ -> pr "z"
5260 | StringList _ -> pr "O"
5261 | Bool _ -> pr "i" (* XXX Python has booleans? *)
5264 pr ":guestfs_%s\",\n" name;
5268 | String n | FileIn n | FileOut n -> pr ", &%s" n
5269 | OptString n -> pr ", &%s" n
5270 | StringList n -> pr ", &py_%s" n
5271 | Bool n -> pr ", &%s" n
5272 | Int n -> pr ", &%s" n
5276 pr " return NULL;\n";
5278 pr " g = get_handle (py_g);\n";
5281 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5283 pr " %s = get_string_list (py_%s);\n" n n;
5284 pr " if (!%s) return NULL;\n" n
5289 pr " r = guestfs_%s " name;
5290 generate_call_args ~handle:"g" (snd style);
5295 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5297 pr " free (%s);\n" n
5300 pr " if (r == %s) {\n" error_code;
5301 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
5302 pr " return NULL;\n";
5306 (match fst style with
5308 pr " Py_INCREF (Py_None);\n";
5309 pr " py_r = Py_None;\n"
5311 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
5312 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
5313 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
5315 pr " py_r = PyString_FromString (r);\n";
5318 pr " py_r = put_string_list (r);\n";
5319 pr " free_strings (r);\n"
5321 pr " py_r = PyTuple_New (2);\n";
5322 pr " PyTuple_SetItem (py_r, 0, PyInt_FromLong ((long) r->i));\n";
5323 pr " PyTuple_SetItem (py_r, 1, PyInt_FromLong ((long) r->b));\n";
5324 pr " guestfs_free_int_bool (r);\n"
5326 pr " py_r = put_lvm_pv_list (r);\n";
5327 pr " guestfs_free_lvm_pv_list (r);\n"
5329 pr " py_r = put_lvm_vg_list (r);\n";
5330 pr " guestfs_free_lvm_vg_list (r);\n"
5332 pr " py_r = put_lvm_lv_list (r);\n";
5333 pr " guestfs_free_lvm_lv_list (r);\n"
5335 pr " py_r = put_stat (r);\n";
5338 pr " py_r = put_statvfs (r);\n";
5341 pr " py_r = put_table (r);\n";
5342 pr " free_strings (r);\n"
5345 pr " return py_r;\n";
5350 (* Table of functions. *)
5351 pr "static PyMethodDef methods[] = {\n";
5352 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
5353 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
5355 fun (name, _, _, _, _, _, _) ->
5356 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
5359 pr " { NULL, NULL, 0, NULL }\n";
5363 (* Init function. *)
5366 initlibguestfsmod (void)
5368 static int initialized = 0;
5370 if (initialized) return;
5371 Py_InitModule ((char *) \"libguestfsmod\", methods);
5376 (* Generate Python module. *)
5377 and generate_python_py () =
5378 generate_header HashStyle LGPLv2;
5381 u\"\"\"Python bindings for libguestfs
5384 g = guestfs.GuestFS ()
5385 g.add_drive (\"guest.img\")
5388 parts = g.list_partitions ()
5390 The guestfs module provides a Python binding to the libguestfs API
5391 for examining and modifying virtual machine disk images.
5393 Amongst the things this is good for: making batch configuration
5394 changes to guests, getting disk used/free statistics (see also:
5395 virt-df), migrating between virtualization systems (see also:
5396 virt-p2v), performing partial backups, performing partial guest
5397 clones, cloning guests and changing registry/UUID/hostname info, and
5400 Libguestfs uses Linux kernel and qemu code, and can access any type of
5401 guest filesystem that Linux and qemu can, including but not limited
5402 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
5403 schemes, qcow, qcow2, vmdk.
5405 Libguestfs provides ways to enumerate guest storage (eg. partitions,
5406 LVs, what filesystem is in each LV, etc.). It can also run commands
5407 in the context of the guest. Also you can access filesystems over FTP.
5409 Errors which happen while using the API are turned into Python
5410 RuntimeError exceptions.
5412 To create a guestfs handle you usually have to perform the following
5415 # Create the handle, call add_drive at least once, and possibly
5416 # several times if the guest has multiple block devices:
5417 g = guestfs.GuestFS ()
5418 g.add_drive (\"guest.img\")
5420 # Launch the qemu subprocess and wait for it to become ready:
5424 # Now you can issue commands, for example:
5429 import libguestfsmod
5432 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
5434 def __init__ (self):
5435 \"\"\"Create a new libguestfs handle.\"\"\"
5436 self._o = libguestfsmod.create ()
5439 libguestfsmod.close (self._o)
5444 fun (name, style, _, flags, _, _, longdesc) ->
5445 let doc = replace_str longdesc "C<guestfs_" "C<g." in
5447 match fst style with
5448 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _
5451 doc ^ "\n\nThis function returns a list of strings."
5453 doc ^ "\n\nThis function returns a tuple (int, bool).\n"
5455 doc ^ "\n\nThis function returns a list of PVs. Each PV is represented as a dictionary."
5457 doc ^ "\n\nThis function returns a list of VGs. Each VG is represented as a dictionary."
5459 doc ^ "\n\nThis function returns a list of LVs. Each LV is represented as a dictionary."
5461 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the stat structure."
5463 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the statvfs structure."
5465 doc ^ "\n\nThis function returns a dictionary." in
5467 if List.mem ProtocolLimitWarning flags then
5468 doc ^ "\n\n" ^ protocol_limit_warning
5471 if List.mem DangerWillRobinson flags then
5472 doc ^ "\n\n" ^ danger_will_robinson
5474 let doc = pod2text ~width:60 name doc in
5475 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
5476 let doc = String.concat "\n " doc in
5479 generate_call_args ~handle:"self" (snd style);
5481 pr " u\"\"\"%s\"\"\"\n" doc;
5482 pr " return libguestfsmod.%s " name;
5483 generate_call_args ~handle:"self._o" (snd style);
5488 (* Useful if you need the longdesc POD text as plain text. Returns a
5491 * This is the slowest thing about autogeneration.
5493 and pod2text ~width name longdesc =
5494 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
5495 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
5497 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
5498 let chan = Unix.open_process_in cmd in
5499 let lines = ref [] in
5501 let line = input_line chan in
5502 if i = 1 then (* discard the first line of output *)
5505 let line = triml line in
5506 lines := line :: !lines;
5509 let lines = try loop 1 with End_of_file -> List.rev !lines in
5510 Unix.unlink filename;
5511 match Unix.close_process_in chan with
5512 | Unix.WEXITED 0 -> lines
5514 failwithf "pod2text: process exited with non-zero status (%d)" i
5515 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
5516 failwithf "pod2text: process signalled or stopped by signal %d" i
5518 (* Generate ruby bindings. *)
5519 and generate_ruby_c () =
5520 generate_header CStyle LGPLv2;
5528 #include \"guestfs.h\"
5530 #include \"extconf.h\"
5532 static VALUE m_guestfs; /* guestfs module */
5533 static VALUE c_guestfs; /* guestfs_h handle */
5534 static VALUE e_Error; /* used for all errors */
5536 static void ruby_guestfs_free (void *p)
5539 guestfs_close ((guestfs_h *) p);
5542 static VALUE ruby_guestfs_create (VALUE m)
5546 g = guestfs_create ();
5548 rb_raise (e_Error, \"failed to create guestfs handle\");
5550 /* Don't print error messages to stderr by default. */
5551 guestfs_set_error_handler (g, NULL, NULL);
5553 /* Wrap it, and make sure the close function is called when the
5556 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
5559 static VALUE ruby_guestfs_close (VALUE gv)
5562 Data_Get_Struct (gv, guestfs_h, g);
5564 ruby_guestfs_free (g);
5565 DATA_PTR (gv) = NULL;
5573 fun (name, style, _, _, _, _, _) ->
5574 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
5575 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
5578 pr " guestfs_h *g;\n";
5579 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
5581 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
5587 | String n | FileIn n | FileOut n ->
5588 pr " const char *%s = StringValueCStr (%sv);\n" n n;
5590 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
5591 pr " \"%s\", \"%s\");\n" n name
5593 pr " const char *%s = StringValueCStr (%sv);\n" n n
5597 pr " int i, len;\n";
5598 pr " len = RARRAY_LEN (%sv);\n" n;
5599 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
5601 pr " for (i = 0; i < len; ++i) {\n";
5602 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
5603 pr " %s[i] = StringValueCStr (v);\n" n;
5605 pr " %s[len] = NULL;\n" n;
5609 pr " int %s = NUM2INT (%sv);\n" n n
5614 match fst style with
5615 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5616 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5617 | RConstString _ -> pr " const char *r;\n"; "NULL"
5618 | RString _ -> pr " char *r;\n"; "NULL"
5619 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5620 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
5621 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5622 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5623 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5624 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
5625 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
5628 pr " r = guestfs_%s " name;
5629 generate_call_args ~handle:"g" (snd style);
5634 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5636 pr " free (%s);\n" n
5639 pr " if (r == %s)\n" error_code;
5640 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
5643 (match fst style with
5645 pr " return Qnil;\n"
5646 | RInt _ | RBool _ ->
5647 pr " return INT2NUM (r);\n"
5649 pr " return ULL2NUM (r);\n"
5651 pr " return rb_str_new2 (r);\n";
5653 pr " VALUE rv = rb_str_new2 (r);\n";
5657 pr " int i, len = 0;\n";
5658 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
5659 pr " VALUE rv = rb_ary_new2 (len);\n";
5660 pr " for (i = 0; r[i] != NULL; ++i) {\n";
5661 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
5662 pr " free (r[i]);\n";
5667 pr " VALUE rv = rb_ary_new2 (2);\n";
5668 pr " rb_ary_push (rv, INT2NUM (r->i));\n";
5669 pr " rb_ary_push (rv, INT2NUM (r->b));\n";
5670 pr " guestfs_free_int_bool (r);\n";
5673 generate_ruby_lvm_code "pv" pv_cols
5675 generate_ruby_lvm_code "vg" vg_cols
5677 generate_ruby_lvm_code "lv" lv_cols
5679 pr " VALUE rv = rb_hash_new ();\n";
5683 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
5688 pr " VALUE rv = rb_hash_new ();\n";
5692 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
5697 pr " VALUE rv = rb_hash_new ();\n";
5699 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
5700 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
5701 pr " free (r[i]);\n";
5702 pr " free (r[i+1]);\n";
5713 /* Initialize the module. */
5714 void Init__guestfs ()
5716 m_guestfs = rb_define_module (\"Guestfs\");
5717 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
5718 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
5720 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
5721 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
5724 (* Define the rest of the methods. *)
5726 fun (name, style, _, _, _, _, _) ->
5727 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
5728 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
5733 (* Ruby code to return an LVM struct list. *)
5734 and generate_ruby_lvm_code typ cols =
5735 pr " VALUE rv = rb_ary_new2 (r->len);\n";
5737 pr " for (i = 0; i < r->len; ++i) {\n";
5738 pr " VALUE hv = rb_hash_new ();\n";
5742 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
5744 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
5747 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
5748 | name, `OptPercent ->
5749 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
5751 pr " rb_ary_push (rv, hv);\n";
5753 pr " guestfs_free_lvm_%s_list (r);\n" typ;
5756 (* Generate Java bindings GuestFS.java file. *)
5757 and generate_java_java () =
5758 generate_header CStyle LGPLv2;
5761 package com.redhat.et.libguestfs;
5763 import java.util.HashMap;
5764 import com.redhat.et.libguestfs.LibGuestFSException;
5765 import com.redhat.et.libguestfs.PV;
5766 import com.redhat.et.libguestfs.VG;
5767 import com.redhat.et.libguestfs.LV;
5768 import com.redhat.et.libguestfs.Stat;
5769 import com.redhat.et.libguestfs.StatVFS;
5770 import com.redhat.et.libguestfs.IntBool;
5773 * The GuestFS object is a libguestfs handle.
5777 public class GuestFS {
5778 // Load the native code.
5780 System.loadLibrary (\"guestfs_jni\");
5784 * The native guestfs_h pointer.
5789 * Create a libguestfs handle.
5791 * @throws LibGuestFSException
5793 public GuestFS () throws LibGuestFSException
5797 private native long _create () throws LibGuestFSException;
5800 * Close a libguestfs handle.
5802 * You can also leave handles to be collected by the garbage
5803 * collector, but this method ensures that the resources used
5804 * by the handle are freed up immediately. If you call any
5805 * other methods after closing the handle, you will get an
5808 * @throws LibGuestFSException
5810 public void close () throws LibGuestFSException
5816 private native void _close (long g) throws LibGuestFSException;
5818 public void finalize () throws LibGuestFSException
5826 fun (name, style, _, flags, _, shortdesc, longdesc) ->
5827 let doc = replace_str longdesc "C<guestfs_" "C<g." in
5829 if List.mem ProtocolLimitWarning flags then
5830 doc ^ "\n\n" ^ protocol_limit_warning
5833 if List.mem DangerWillRobinson flags then
5834 doc ^ "\n\n" ^ danger_will_robinson
5836 let doc = pod2text ~width:60 name doc in
5837 let doc = String.concat "\n * " doc in
5840 pr " * %s\n" shortdesc;
5843 pr " * @throws LibGuestFSException\n";
5846 generate_java_prototype ~public:true ~semicolon:false name style;
5849 pr " if (g == 0)\n";
5850 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
5853 if fst style <> RErr then pr "return ";
5855 generate_call_args ~handle:"g" (snd style);
5859 generate_java_prototype ~privat:true ~native:true name style;
5866 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
5867 ?(semicolon=true) name style =
5868 if privat then pr "private ";
5869 if public then pr "public ";
5870 if native then pr "native ";
5873 (match fst style with
5874 | RErr -> pr "void ";
5875 | RInt _ -> pr "int ";
5876 | RInt64 _ -> pr "long ";
5877 | RBool _ -> pr "boolean ";
5878 | RConstString _ | RString _ -> pr "String ";
5879 | RStringList _ -> pr "String[] ";
5880 | RIntBool _ -> pr "IntBool ";
5881 | RPVList _ -> pr "PV[] ";
5882 | RVGList _ -> pr "VG[] ";
5883 | RLVList _ -> pr "LV[] ";
5884 | RStat _ -> pr "Stat ";
5885 | RStatVFS _ -> pr "StatVFS ";
5886 | RHashtable _ -> pr "HashMap<String,String> ";
5889 if native then pr "_%s " name else pr "%s " name;
5891 let needs_comma = ref false in
5900 if !needs_comma then pr ", ";
5901 needs_comma := true;
5918 pr " throws LibGuestFSException";
5919 if semicolon then pr ";"
5921 and generate_java_struct typ cols =
5922 generate_header CStyle LGPLv2;
5925 package com.redhat.et.libguestfs;
5928 * Libguestfs %s structure.
5939 | name, `UUID -> pr " public String %s;\n" name
5941 | name, `Int -> pr " public long %s;\n" name
5942 | name, `OptPercent ->
5943 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
5944 pr " public float %s;\n" name
5949 and generate_java_c () =
5950 generate_header CStyle LGPLv2;
5957 #include \"com_redhat_et_libguestfs_GuestFS.h\"
5958 #include \"guestfs.h\"
5960 /* Note that this function returns. The exception is not thrown
5961 * until after the wrapper function returns.
5964 throw_exception (JNIEnv *env, const char *msg)
5967 cl = (*env)->FindClass (env,
5968 \"com/redhat/et/libguestfs/LibGuestFSException\");
5969 (*env)->ThrowNew (env, cl, msg);
5972 JNIEXPORT jlong JNICALL
5973 Java_com_redhat_et_libguestfs_GuestFS__1create
5974 (JNIEnv *env, jobject obj)
5978 g = guestfs_create ();
5980 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
5983 guestfs_set_error_handler (g, NULL, NULL);
5984 return (jlong) (long) g;
5987 JNIEXPORT void JNICALL
5988 Java_com_redhat_et_libguestfs_GuestFS__1close
5989 (JNIEnv *env, jobject obj, jlong jg)
5991 guestfs_h *g = (guestfs_h *) (long) jg;
5998 fun (name, style, _, _, _, _, _) ->
6000 (match fst style with
6001 | RErr -> pr "void ";
6002 | RInt _ -> pr "jint ";
6003 | RInt64 _ -> pr "jlong ";
6004 | RBool _ -> pr "jboolean ";
6005 | RConstString _ | RString _ -> pr "jstring ";
6006 | RIntBool _ | RStat _ | RStatVFS _ | RHashtable _ ->
6008 | RStringList _ | RPVList _ | RVGList _ | RLVList _ ->
6012 pr "Java_com_redhat_et_libguestfs_GuestFS_";
6013 pr "%s" (replace_str ("_" ^ name) "_" "_1");
6015 pr " (JNIEnv *env, jobject obj, jlong jg";
6022 pr ", jstring j%s" n
6024 pr ", jobjectArray j%s" n
6026 pr ", jboolean j%s" n
6032 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
6033 let error_code, no_ret =
6034 match fst style with
6035 | RErr -> pr " int r;\n"; "-1", ""
6037 | RInt _ -> pr " int r;\n"; "-1", "0"
6038 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
6039 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
6041 pr " jstring jr;\n";
6042 pr " char *r;\n"; "NULL", "NULL"
6044 pr " jobjectArray jr;\n";
6047 pr " jstring jstr;\n";
6048 pr " char **r;\n"; "NULL", "NULL"
6050 pr " jobject jr;\n";
6052 pr " jfieldID fl;\n";
6053 pr " struct guestfs_int_bool *r;\n"; "NULL", "NULL"
6055 pr " jobject jr;\n";
6057 pr " jfieldID fl;\n";
6058 pr " struct guestfs_stat *r;\n"; "NULL", "NULL"
6060 pr " jobject jr;\n";
6062 pr " jfieldID fl;\n";
6063 pr " struct guestfs_statvfs *r;\n"; "NULL", "NULL"
6065 pr " jobjectArray jr;\n";
6067 pr " jfieldID fl;\n";
6068 pr " jobject jfl;\n";
6069 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL", "NULL"
6071 pr " jobjectArray jr;\n";
6073 pr " jfieldID fl;\n";
6074 pr " jobject jfl;\n";
6075 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL", "NULL"
6077 pr " jobjectArray jr;\n";
6079 pr " jfieldID fl;\n";
6080 pr " jobject jfl;\n";
6081 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL", "NULL"
6082 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL" in
6089 pr " const char *%s;\n" n
6091 pr " int %s_len;\n" n;
6092 pr " const char **%s;\n" n
6099 (match fst style with
6100 | RStringList _ | RPVList _ | RVGList _ | RLVList _ -> true
6101 | RErr _ | RBool _ | RInt _ | RInt64 _ | RConstString _
6102 | RString _ | RIntBool _ | RStat _ | RStatVFS _
6103 | RHashtable _ -> false) ||
6104 List.exists (function StringList _ -> true | _ -> false) (snd style) in
6110 (* Get the parameters. *)
6117 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
6119 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
6120 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
6121 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6122 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6124 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
6126 pr " %s[%s_len] = NULL;\n" n n;
6129 pr " %s = j%s;\n" n n
6132 (* Make the call. *)
6133 pr " r = guestfs_%s " name;
6134 generate_call_args ~handle:"g" (snd style);
6137 (* Release the parameters. *)
6144 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
6146 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6147 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6149 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
6151 pr " free (%s);\n" n
6156 (* Check for errors. *)
6157 pr " if (r == %s) {\n" error_code;
6158 pr " throw_exception (env, guestfs_last_error (g));\n";
6159 pr " return %s;\n" no_ret;
6163 (match fst style with
6165 | RInt _ -> pr " return (jint) r;\n"
6166 | RBool _ -> pr " return (jboolean) r;\n"
6167 | RInt64 _ -> pr " return (jlong) r;\n"
6168 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
6170 pr " jr = (*env)->NewStringUTF (env, r);\n";
6174 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
6175 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
6176 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
6177 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
6178 pr " for (i = 0; i < r_len; ++i) {\n";
6179 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
6180 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
6181 pr " free (r[i]);\n";
6186 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/IntBool\");\n";
6187 pr " jr = (*env)->AllocObject (env, cl);\n";
6188 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"I\");\n";
6189 pr " (*env)->SetIntField (env, jr, fl, r->i);\n";
6190 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"Z\");\n";
6191 pr " (*env)->SetBooleanField (env, jr, fl, r->b);\n";
6192 pr " guestfs_free_int_bool (r);\n";
6195 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/Stat\");\n";
6196 pr " jr = (*env)->AllocObject (env, cl);\n";
6200 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
6202 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
6207 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/StatVFS\");\n";
6208 pr " jr = (*env)->AllocObject (env, cl);\n";
6212 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
6214 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
6219 generate_java_lvm_return "pv" "PV" pv_cols
6221 generate_java_lvm_return "vg" "VG" vg_cols
6223 generate_java_lvm_return "lv" "LV" lv_cols
6226 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
6227 pr " return NULL;\n"
6234 and generate_java_lvm_return typ jtyp cols =
6235 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
6236 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
6237 pr " for (i = 0; i < r->len; ++i) {\n";
6238 pr " jfl = (*env)->AllocObject (env, cl);\n";
6242 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
6243 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
6246 pr " char s[33];\n";
6247 pr " memcpy (s, r->val[i].%s, 32);\n" name;
6249 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
6250 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
6252 | name, (`Bytes|`Int) ->
6253 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
6254 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
6255 | name, `OptPercent ->
6256 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
6257 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
6259 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
6261 pr " guestfs_free_lvm_%s_list (r);\n" typ;
6264 let output_to filename =
6265 let filename_new = filename ^ ".new" in
6266 chan := open_out filename_new;
6271 (* Is the new file different from the current file? *)
6272 if Sys.file_exists filename && files_equal filename filename_new then
6273 Unix.unlink filename_new (* same, so skip it *)
6275 (* different, overwrite old one *)
6276 (try Unix.chmod filename 0o644 with Unix.Unix_error _ -> ());
6277 Unix.rename filename_new filename;
6278 Unix.chmod filename 0o444;
6279 printf "written %s\n%!" filename;
6288 if not (Sys.file_exists "configure.ac") then (
6290 You are probably running this from the wrong directory.
6291 Run it from the top source directory using the command
6297 let close = output_to "src/guestfs_protocol.x" in
6301 let close = output_to "src/guestfs-structs.h" in
6302 generate_structs_h ();
6305 let close = output_to "src/guestfs-actions.h" in
6306 generate_actions_h ();
6309 let close = output_to "src/guestfs-actions.c" in
6310 generate_client_actions ();
6313 let close = output_to "daemon/actions.h" in
6314 generate_daemon_actions_h ();
6317 let close = output_to "daemon/stubs.c" in
6318 generate_daemon_actions ();
6321 let close = output_to "tests.c" in
6325 let close = output_to "fish/cmds.c" in
6326 generate_fish_cmds ();
6329 let close = output_to "fish/completion.c" in
6330 generate_fish_completion ();
6333 let close = output_to "guestfs-structs.pod" in
6334 generate_structs_pod ();
6337 let close = output_to "guestfs-actions.pod" in
6338 generate_actions_pod ();
6341 let close = output_to "guestfish-actions.pod" in
6342 generate_fish_actions_pod ();
6345 let close = output_to "ocaml/guestfs.mli" in
6346 generate_ocaml_mli ();
6349 let close = output_to "ocaml/guestfs.ml" in
6350 generate_ocaml_ml ();
6353 let close = output_to "ocaml/guestfs_c_actions.c" in
6354 generate_ocaml_c ();
6357 let close = output_to "perl/Guestfs.xs" in
6358 generate_perl_xs ();
6361 let close = output_to "perl/lib/Sys/Guestfs.pm" in
6362 generate_perl_pm ();
6365 let close = output_to "python/guestfs-py.c" in
6366 generate_python_c ();
6369 let close = output_to "python/guestfs.py" in
6370 generate_python_py ();
6373 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
6377 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
6378 generate_java_java ();
6381 let close = output_to "java/com/redhat/et/libguestfs/PV.java" in
6382 generate_java_struct "PV" pv_cols;
6385 let close = output_to "java/com/redhat/et/libguestfs/VG.java" in
6386 generate_java_struct "VG" vg_cols;
6389 let close = output_to "java/com/redhat/et/libguestfs/LV.java" in
6390 generate_java_struct "LV" lv_cols;
6393 let close = output_to "java/com/redhat/et/libguestfs/Stat.java" in
6394 generate_java_struct "Stat" stat_cols;
6397 let close = output_to "java/com/redhat/et/libguestfs/StatVFS.java" in
6398 generate_java_struct "StatVFS" statvfs_cols;
6401 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in