3 * Copyright (C) 2009 Red Hat Inc.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 (* This script generates a large amount of code and documentation for
21 * all the daemon actions.
23 * To add a new action there are only two files you need to change,
24 * this one to describe the interface (see the big table below), and
25 * daemon/<somefile>.c to write the implementation.
27 * After editing this file, run it (./src/generator.ml) to regenerate
28 * all the output files.
30 * IMPORTANT: This script should NOT print any warnings. If it prints
31 * warnings, you should treat them as errors.
32 * [Need to add -warn-error to ocaml command line]
40 type style = ret * args
42 (* "RErr" as a return value means an int used as a simple error
43 * indication, ie. 0 or -1.
46 (* "RInt" as a return value means an int which is -1 for error
47 * or any value >= 0 on success. Only use this for smallish
48 * positive ints (0 <= i < 2^30).
51 (* "RInt64" is the same as RInt, but is guaranteed to be able
52 * to return a full 64 bit value, _except_ that -1 means error
53 * (so -1 cannot be a valid, non-error return value).
56 (* "RBool" is a bool return value which can be true/false or
60 (* "RConstString" is a string that refers to a constant value.
61 * Try to avoid using this. In particular you cannot use this
62 * for values returned from the daemon, because there is no
63 * thread-safe way to return them in the C API.
65 | RConstString of string
66 (* "RString" and "RStringList" are caller-frees. *)
68 | RStringList of string
69 (* Some limited tuples are possible: *)
70 | RIntBool of string * string
71 (* LVM PVs, VGs and LVs. *)
78 (* Key-value pairs of untyped strings. Turns into a hashtable or
79 * dictionary in languages which support it. DON'T use this as a
80 * general "bucket" for results. Prefer a stronger typed return
81 * value if one is available, or write a custom struct. Don't use
82 * this if the list could potentially be very long, since it is
83 * inefficient. Keys should be unique. NULLs are not permitted.
85 | RHashtable of string
87 and args = argt list (* Function parameters, guestfs handle is implicit. *)
89 (* Note in future we should allow a "variable args" parameter as
90 * the final parameter, to allow commands like
91 * chmod mode file [file(s)...]
92 * This is not implemented yet, but many commands (such as chmod)
93 * are currently defined with the argument order keeping this future
94 * possibility in mind.
97 | String of string (* const char *name, cannot be NULL *)
98 | OptString of string (* const char *name, may be NULL *)
99 | StringList of string(* list of strings (each string cannot be NULL) *)
100 | Bool of string (* boolean *)
101 | Int of string (* int (smallish ints, signed, <= 31 bits) *)
102 (* These are treated as filenames (simple string parameters) in
103 * the C API and bindings. But in the RPC protocol, we transfer
104 * the actual file content up to or down from the daemon.
105 * FileIn: local machine -> daemon (in request)
106 * FileOut: daemon -> local machine (in reply)
107 * In guestfish (only), the special name "-" means read from
108 * stdin or write to stdout.
114 | ProtocolLimitWarning (* display warning about protocol size limits *)
115 | DangerWillRobinson (* flags particularly dangerous commands *)
116 | FishAlias of string (* provide an alias for this cmd in guestfish *)
117 | FishAction of string (* call this function in guestfish *)
118 | NotInFish (* do not export via guestfish *)
120 let protocol_limit_warning =
121 "Because of the message protocol, there is a transfer limit
122 of somewhere between 2MB and 4MB. To transfer large files you should use
125 let danger_will_robinson =
126 "B<This command is dangerous. Without careful use you
127 can easily destroy all your data>."
129 (* You can supply zero or as many tests as you want per API call.
131 * Note that the test environment has 3 block devices, of size 500MB,
132 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc).
133 * Note for partitioning purposes, the 500MB device has 63 cylinders.
135 * To be able to run the tests in a reasonable amount of time,
136 * the virtual machine and block devices are reused between tests.
137 * So don't try testing kill_subprocess :-x
139 * Between each test we blockdev-setrw, umount-all, lvm-remove-all
142 * If the appliance is running an older Linux kernel (eg. RHEL 5) then
143 * devices are named /dev/hda etc. To cope with this, the test suite
144 * adds some hairly logic to detect this case, and then automagically
145 * replaces all strings which match "/dev/sd.*" with "/dev/hd.*".
146 * When writing test cases you shouldn't have to worry about this
149 * Don't assume anything about the previous contents of the block
150 * devices. Use 'Init*' to create some initial scenarios.
152 type tests = (test_init * test) list
154 (* Run the command sequence and just expect nothing to fail. *)
156 (* Run the command sequence and expect the output of the final
157 * command to be the string.
159 | TestOutput of seq * string
160 (* Run the command sequence and expect the output of the final
161 * command to be the list of strings.
163 | TestOutputList of seq * string list
164 (* Run the command sequence and expect the output of the final
165 * command to be the integer.
167 | TestOutputInt of seq * int
168 (* Run the command sequence and expect the output of the final
169 * command to be a true value (!= 0 or != NULL).
171 | TestOutputTrue of seq
172 (* Run the command sequence and expect the output of the final
173 * command to be a false value (== 0 or == NULL, but not an error).
175 | TestOutputFalse of seq
176 (* Run the command sequence and expect the output of the final
177 * command to be a list of the given length (but don't care about
180 | TestOutputLength of seq * int
181 (* Run the command sequence and expect the output of the final
182 * command to be a structure.
184 | TestOutputStruct of seq * test_field_compare list
185 (* Run the command sequence and expect the final command (only)
188 | TestLastFail of seq
190 and test_field_compare =
191 | CompareWithInt of string * int
192 | CompareWithString of string * string
193 | CompareFieldsIntEq of string * string
194 | CompareFieldsStrEq of string * string
196 (* Some initial scenarios for testing. *)
198 (* Do nothing, block devices could contain random stuff including
199 * LVM PVs, and some filesystems might be mounted. This is usually
203 (* Block devices are empty and no filesystems are mounted. *)
205 (* /dev/sda contains a single partition /dev/sda1, which is formatted
206 * as ext2, empty [except for lost+found] and mounted on /.
207 * /dev/sdb and /dev/sdc may have random content.
212 * /dev/sda1 (is a PV):
213 * /dev/VG/LV (size 8MB):
214 * formatted as ext2, empty [except for lost+found], mounted on /
215 * /dev/sdb and /dev/sdc may have random content.
219 (* Sequence of commands for testing. *)
221 and cmd = string list
223 (* Note about long descriptions: When referring to another
224 * action, use the format C<guestfs_other> (ie. the full name of
225 * the C function). This will be replaced as appropriate in other
228 * Apart from that, long descriptions are just perldoc paragraphs.
231 let non_daemon_functions = [
232 ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
234 "launch the qemu subprocess",
236 Internally libguestfs is implemented by running a virtual machine
239 You should call this after configuring the handle
240 (eg. adding drives) but before performing any actions.");
242 ("wait_ready", (RErr, []), -1, [NotInFish],
244 "wait until the qemu subprocess launches",
246 Internally libguestfs is implemented by running a virtual machine
249 You should call this after C<guestfs_launch> to wait for the launch
252 ("kill_subprocess", (RErr, []), -1, [],
254 "kill the qemu subprocess",
256 This kills the qemu subprocess. You should never need to call this.");
258 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
260 "add an image to examine or modify",
262 This function adds a virtual machine disk image C<filename> to the
263 guest. The first time you call this function, the disk appears as IDE
264 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
267 You don't necessarily need to be root when using libguestfs. However
268 you obviously do need sufficient permissions to access the filename
269 for whatever operations you want to perform (ie. read access if you
270 just want to read the image or write access if you want to modify the
273 This is equivalent to the qemu parameter C<-drive file=filename>.");
275 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
277 "add a CD-ROM disk image to examine",
279 This function adds a virtual CD-ROM disk image to the guest.
281 This is equivalent to the qemu parameter C<-cdrom filename>.");
283 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
285 "add qemu parameters",
287 This can be used to add arbitrary qemu command line parameters
288 of the form C<-param value>. Actually it's not quite arbitrary - we
289 prevent you from setting some parameters which would interfere with
290 parameters that we use.
292 The first character of C<param> string must be a C<-> (dash).
294 C<value> can be NULL.");
296 ("set_qemu", (RErr, [String "qemu"]), -1, [FishAlias "qemu"],
298 "set the qemu binary",
300 Set the qemu binary that we will use.
302 The default is chosen when the library was compiled by the
305 You can also override this by setting the C<LIBGUESTFS_QEMU>
306 environment variable.
308 The string C<qemu> is stashed in the libguestfs handle, so the caller
309 must make sure it remains valid for the lifetime of the handle.
311 Setting C<qemu> to C<NULL> restores the default qemu binary.");
313 ("get_qemu", (RConstString "qemu", []), -1, [],
315 "get the qemu binary",
317 Return the current qemu binary.
319 This is always non-NULL. If it wasn't set already, then this will
320 return the default qemu binary name.");
322 ("set_path", (RErr, [String "path"]), -1, [FishAlias "path"],
324 "set the search path",
326 Set the path that libguestfs searches for kernel and initrd.img.
328 The default is C<$libdir/guestfs> unless overridden by setting
329 C<LIBGUESTFS_PATH> environment variable.
331 The string C<path> is stashed in the libguestfs handle, so the caller
332 must make sure it remains valid for the lifetime of the handle.
334 Setting C<path> to C<NULL> restores the default path.");
336 ("get_path", (RConstString "path", []), -1, [],
338 "get the search path",
340 Return the current search path.
342 This is always non-NULL. If it wasn't set already, then this will
343 return the default path.");
345 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
349 If C<autosync> is true, this enables autosync. Libguestfs will make a
350 best effort attempt to run C<guestfs_umount_all> followed by
351 C<guestfs_sync> when the handle is closed
352 (also if the program exits without closing handles).
354 This is disabled by default (except in guestfish where it is
355 enabled by default).");
357 ("get_autosync", (RBool "autosync", []), -1, [],
361 Get the autosync flag.");
363 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
367 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
369 Verbose messages are disabled unless the environment variable
370 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
372 ("get_verbose", (RBool "verbose", []), -1, [],
376 This returns the verbose messages flag.");
378 ("is_ready", (RBool "ready", []), -1, [],
380 "is ready to accept commands",
382 This returns true iff this handle is ready to accept commands
383 (in the C<READY> state).
385 For more information on states, see L<guestfs(3)>.");
387 ("is_config", (RBool "config", []), -1, [],
389 "is in configuration state",
391 This returns true iff this handle is being configured
392 (in the C<CONFIG> state).
394 For more information on states, see L<guestfs(3)>.");
396 ("is_launching", (RBool "launching", []), -1, [],
398 "is launching subprocess",
400 This returns true iff this handle is launching the subprocess
401 (in the C<LAUNCHING> state).
403 For more information on states, see L<guestfs(3)>.");
405 ("is_busy", (RBool "busy", []), -1, [],
407 "is busy processing a command",
409 This returns true iff this handle is busy processing a command
410 (in the C<BUSY> state).
412 For more information on states, see L<guestfs(3)>.");
414 ("get_state", (RInt "state", []), -1, [],
416 "get the current state",
418 This returns the current state as an opaque integer. This is
419 only useful for printing debug and internal error messages.
421 For more information on states, see L<guestfs(3)>.");
423 ("set_busy", (RErr, []), -1, [NotInFish],
427 This sets the state to C<BUSY>. This is only used when implementing
428 actions using the low-level API.
430 For more information on states, see L<guestfs(3)>.");
432 ("set_ready", (RErr, []), -1, [NotInFish],
434 "set state to ready",
436 This sets the state to C<READY>. This is only used when implementing
437 actions using the low-level API.
439 For more information on states, see L<guestfs(3)>.");
441 ("end_busy", (RErr, []), -1, [NotInFish],
443 "leave the busy state",
445 This sets the state to C<READY>, or if in C<CONFIG> then it leaves the
446 state as is. This is only used when implementing
447 actions using the low-level API.
449 For more information on states, see L<guestfs(3)>.");
453 let daemon_functions = [
454 ("mount", (RErr, [String "device"; String "mountpoint"]), 1, [],
455 [InitEmpty, TestOutput (
456 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
457 ["mkfs"; "ext2"; "/dev/sda1"];
458 ["mount"; "/dev/sda1"; "/"];
459 ["write_file"; "/new"; "new file contents"; "0"];
460 ["cat"; "/new"]], "new file contents")],
461 "mount a guest disk at a position in the filesystem",
463 Mount a guest disk at a position in the filesystem. Block devices
464 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
465 the guest. If those block devices contain partitions, they will have
466 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
469 The rules are the same as for L<mount(2)>: A filesystem must
470 first be mounted on C</> before others can be mounted. Other
471 filesystems can only be mounted on directories which already
474 The mounted filesystem is writable, if we have sufficient permissions
475 on the underlying device.
477 The filesystem options C<sync> and C<noatime> are set with this
478 call, in order to improve reliability.");
480 ("sync", (RErr, []), 2, [],
481 [ InitEmpty, TestRun [["sync"]]],
482 "sync disks, writes are flushed through to the disk image",
484 This syncs the disk, so that any writes are flushed through to the
485 underlying disk image.
487 You should always call this if you have modified a disk image, before
488 closing the handle.");
490 ("touch", (RErr, [String "path"]), 3, [],
491 [InitBasicFS, TestOutputTrue (
493 ["exists"; "/new"]])],
494 "update file timestamps or create a new file",
496 Touch acts like the L<touch(1)> command. It can be used to
497 update the timestamps on a file, or, if the file does not exist,
498 to create a new zero-length file.");
500 ("cat", (RString "content", [String "path"]), 4, [ProtocolLimitWarning],
501 [InitBasicFS, TestOutput (
502 [["write_file"; "/new"; "new file contents"; "0"];
503 ["cat"; "/new"]], "new file contents")],
504 "list the contents of a file",
506 Return the contents of the file named C<path>.
508 Note that this function cannot correctly handle binary files
509 (specifically, files containing C<\\0> character which is treated
510 as end of string). For those you need to use the C<guestfs_download>
511 function which has a more complex interface.");
513 ("ll", (RString "listing", [String "directory"]), 5, [],
514 [], (* XXX Tricky to test because it depends on the exact format
515 * of the 'ls -l' command, which changes between F10 and F11.
517 "list the files in a directory (long format)",
519 List the files in C<directory> (relative to the root directory,
520 there is no cwd) in the format of 'ls -la'.
522 This command is mostly useful for interactive sessions. It
523 is I<not> intended that you try to parse the output string.");
525 ("ls", (RStringList "listing", [String "directory"]), 6, [],
526 [InitBasicFS, TestOutputList (
529 ["touch"; "/newest"];
530 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
531 "list the files in a directory",
533 List the files in C<directory> (relative to the root directory,
534 there is no cwd). The '.' and '..' entries are not returned, but
535 hidden files are shown.
537 This command is mostly useful for interactive sessions. Programs
538 should probably use C<guestfs_readdir> instead.");
540 ("list_devices", (RStringList "devices", []), 7, [],
541 [InitEmpty, TestOutputList (
542 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"])],
543 "list the block devices",
545 List all the block devices.
547 The full block device names are returned, eg. C</dev/sda>");
549 ("list_partitions", (RStringList "partitions", []), 8, [],
550 [InitBasicFS, TestOutputList (
551 [["list_partitions"]], ["/dev/sda1"]);
552 InitEmpty, TestOutputList (
553 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
554 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
555 "list the partitions",
557 List all the partitions detected on all block devices.
559 The full partition device names are returned, eg. C</dev/sda1>
561 This does not return logical volumes. For that you will need to
562 call C<guestfs_lvs>.");
564 ("pvs", (RStringList "physvols", []), 9, [],
565 [InitBasicFSonLVM, TestOutputList (
566 [["pvs"]], ["/dev/sda1"]);
567 InitEmpty, TestOutputList (
568 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
569 ["pvcreate"; "/dev/sda1"];
570 ["pvcreate"; "/dev/sda2"];
571 ["pvcreate"; "/dev/sda3"];
572 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
573 "list the LVM physical volumes (PVs)",
575 List all the physical volumes detected. This is the equivalent
576 of the L<pvs(8)> command.
578 This returns a list of just the device names that contain
579 PVs (eg. C</dev/sda2>).
581 See also C<guestfs_pvs_full>.");
583 ("vgs", (RStringList "volgroups", []), 10, [],
584 [InitBasicFSonLVM, TestOutputList (
586 InitEmpty, TestOutputList (
587 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
588 ["pvcreate"; "/dev/sda1"];
589 ["pvcreate"; "/dev/sda2"];
590 ["pvcreate"; "/dev/sda3"];
591 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
592 ["vgcreate"; "VG2"; "/dev/sda3"];
593 ["vgs"]], ["VG1"; "VG2"])],
594 "list the LVM volume groups (VGs)",
596 List all the volumes groups detected. This is the equivalent
597 of the L<vgs(8)> command.
599 This returns a list of just the volume group names that were
600 detected (eg. C<VolGroup00>).
602 See also C<guestfs_vgs_full>.");
604 ("lvs", (RStringList "logvols", []), 11, [],
605 [InitBasicFSonLVM, TestOutputList (
606 [["lvs"]], ["/dev/VG/LV"]);
607 InitEmpty, TestOutputList (
608 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
609 ["pvcreate"; "/dev/sda1"];
610 ["pvcreate"; "/dev/sda2"];
611 ["pvcreate"; "/dev/sda3"];
612 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
613 ["vgcreate"; "VG2"; "/dev/sda3"];
614 ["lvcreate"; "LV1"; "VG1"; "50"];
615 ["lvcreate"; "LV2"; "VG1"; "50"];
616 ["lvcreate"; "LV3"; "VG2"; "50"];
617 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
618 "list the LVM logical volumes (LVs)",
620 List all the logical volumes detected. This is the equivalent
621 of the L<lvs(8)> command.
623 This returns a list of the logical volume device names
624 (eg. C</dev/VolGroup00/LogVol00>).
626 See also C<guestfs_lvs_full>.");
628 ("pvs_full", (RPVList "physvols", []), 12, [],
629 [], (* XXX how to test? *)
630 "list the LVM physical volumes (PVs)",
632 List all the physical volumes detected. This is the equivalent
633 of the L<pvs(8)> command. The \"full\" version includes all fields.");
635 ("vgs_full", (RVGList "volgroups", []), 13, [],
636 [], (* XXX how to test? *)
637 "list the LVM volume groups (VGs)",
639 List all the volumes groups detected. This is the equivalent
640 of the L<vgs(8)> command. The \"full\" version includes all fields.");
642 ("lvs_full", (RLVList "logvols", []), 14, [],
643 [], (* XXX how to test? *)
644 "list the LVM logical volumes (LVs)",
646 List all the logical volumes detected. This is the equivalent
647 of the L<lvs(8)> command. The \"full\" version includes all fields.");
649 ("read_lines", (RStringList "lines", [String "path"]), 15, [],
650 [InitBasicFS, TestOutputList (
651 [["write_file"; "/new"; "line1\r\nline2\nline3"; "0"];
652 ["read_lines"; "/new"]], ["line1"; "line2"; "line3"]);
653 InitBasicFS, TestOutputList (
654 [["write_file"; "/new"; ""; "0"];
655 ["read_lines"; "/new"]], [])],
656 "read file as lines",
658 Return the contents of the file named C<path>.
660 The file contents are returned as a list of lines. Trailing
661 C<LF> and C<CRLF> character sequences are I<not> returned.
663 Note that this function cannot correctly handle binary files
664 (specifically, files containing C<\\0> character which is treated
665 as end of line). For those you need to use the C<guestfs_read_file>
666 function which has a more complex interface.");
668 ("aug_init", (RErr, [String "root"; Int "flags"]), 16, [],
669 [], (* XXX Augeas code needs tests. *)
670 "create a new Augeas handle",
672 Create a new Augeas handle for editing configuration files.
673 If there was any previous Augeas handle associated with this
674 guestfs session, then it is closed.
676 You must call this before using any other C<guestfs_aug_*>
679 C<root> is the filesystem root. C<root> must not be NULL,
682 The flags are the same as the flags defined in
683 E<lt>augeas.hE<gt>, the logical I<or> of the following
688 =item C<AUG_SAVE_BACKUP> = 1
690 Keep the original file with a C<.augsave> extension.
692 =item C<AUG_SAVE_NEWFILE> = 2
694 Save changes into a file with extension C<.augnew>, and
695 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
697 =item C<AUG_TYPE_CHECK> = 4
699 Typecheck lenses (can be expensive).
701 =item C<AUG_NO_STDINC> = 8
703 Do not use standard load path for modules.
705 =item C<AUG_SAVE_NOOP> = 16
707 Make save a no-op, just record what would have been changed.
709 =item C<AUG_NO_LOAD> = 32
711 Do not load the tree in C<guestfs_aug_init>.
715 To close the handle, you can call C<guestfs_aug_close>.
717 To find out more about Augeas, see L<http://augeas.net/>.");
719 ("aug_close", (RErr, []), 26, [],
720 [], (* XXX Augeas code needs tests. *)
721 "close the current Augeas handle",
723 Close the current Augeas handle and free up any resources
724 used by it. After calling this, you have to call
725 C<guestfs_aug_init> again before you can use any other
728 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [],
729 [], (* XXX Augeas code needs tests. *)
730 "define an Augeas variable",
732 Defines an Augeas variable C<name> whose value is the result
733 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
736 On success this returns the number of nodes in C<expr>, or
737 C<0> if C<expr> evaluates to something which is not a nodeset.");
739 ("aug_defnode", (RIntBool ("nrnodes", "created"), [String "name"; String "expr"; String "val"]), 18, [],
740 [], (* XXX Augeas code needs tests. *)
741 "define an Augeas node",
743 Defines a variable C<name> whose value is the result of
746 If C<expr> evaluates to an empty nodeset, a node is created,
747 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
748 C<name> will be the nodeset containing that single node.
750 On success this returns a pair containing the
751 number of nodes in the nodeset, and a boolean flag
752 if a node was created.");
754 ("aug_get", (RString "val", [String "path"]), 19, [],
755 [], (* XXX Augeas code needs tests. *)
756 "look up the value of an Augeas path",
758 Look up the value associated with C<path>. If C<path>
759 matches exactly one node, the C<value> is returned.");
761 ("aug_set", (RErr, [String "path"; String "val"]), 20, [],
762 [], (* XXX Augeas code needs tests. *)
763 "set Augeas path to value",
765 Set the value associated with C<path> to C<value>.");
767 ("aug_insert", (RErr, [String "path"; String "label"; Bool "before"]), 21, [],
768 [], (* XXX Augeas code needs tests. *)
769 "insert a sibling Augeas node",
771 Create a new sibling C<label> for C<path>, inserting it into
772 the tree before or after C<path> (depending on the boolean
775 C<path> must match exactly one existing node in the tree, and
776 C<label> must be a label, ie. not contain C</>, C<*> or end
777 with a bracketed index C<[N]>.");
779 ("aug_rm", (RInt "nrnodes", [String "path"]), 22, [],
780 [], (* XXX Augeas code needs tests. *)
781 "remove an Augeas path",
783 Remove C<path> and all of its children.
785 On success this returns the number of entries which were removed.");
787 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [],
788 [], (* XXX Augeas code needs tests. *)
791 Move the node C<src> to C<dest>. C<src> must match exactly
792 one node. C<dest> is overwritten if it exists.");
794 ("aug_match", (RStringList "matches", [String "path"]), 24, [],
795 [], (* XXX Augeas code needs tests. *)
796 "return Augeas nodes which match path",
798 Returns a list of paths which match the path expression C<path>.
799 The returned paths are sufficiently qualified so that they match
800 exactly one node in the current tree.");
802 ("aug_save", (RErr, []), 25, [],
803 [], (* XXX Augeas code needs tests. *)
804 "write all pending Augeas changes to disk",
806 This writes all pending changes to disk.
808 The flags which were passed to C<guestfs_aug_init> affect exactly
809 how files are saved.");
811 ("aug_load", (RErr, []), 27, [],
812 [], (* XXX Augeas code needs tests. *)
813 "load files into the tree",
815 Load files into the tree.
817 See C<aug_load> in the Augeas documentation for the full gory
820 ("aug_ls", (RStringList "matches", [String "path"]), 28, [],
821 [], (* XXX Augeas code needs tests. *)
822 "list Augeas nodes under a path",
824 This is just a shortcut for listing C<guestfs_aug_match>
825 C<path/*> and sorting the resulting nodes into alphabetical order.");
827 ("rm", (RErr, [String "path"]), 29, [],
828 [InitBasicFS, TestRun
831 InitBasicFS, TestLastFail
833 InitBasicFS, TestLastFail
838 Remove the single file C<path>.");
840 ("rmdir", (RErr, [String "path"]), 30, [],
841 [InitBasicFS, TestRun
844 InitBasicFS, TestLastFail
846 InitBasicFS, TestLastFail
849 "remove a directory",
851 Remove the single directory C<path>.");
853 ("rm_rf", (RErr, [String "path"]), 31, [],
854 [InitBasicFS, TestOutputFalse
856 ["mkdir"; "/new/foo"];
857 ["touch"; "/new/foo/bar"];
859 ["exists"; "/new"]]],
860 "remove a file or directory recursively",
862 Remove the file or directory C<path>, recursively removing the
863 contents if its a directory. This is like the C<rm -rf> shell
866 ("mkdir", (RErr, [String "path"]), 32, [],
867 [InitBasicFS, TestOutputTrue
870 InitBasicFS, TestLastFail
871 [["mkdir"; "/new/foo/bar"]]],
872 "create a directory",
874 Create a directory named C<path>.");
876 ("mkdir_p", (RErr, [String "path"]), 33, [],
877 [InitBasicFS, TestOutputTrue
878 [["mkdir_p"; "/new/foo/bar"];
879 ["is_dir"; "/new/foo/bar"]];
880 InitBasicFS, TestOutputTrue
881 [["mkdir_p"; "/new/foo/bar"];
882 ["is_dir"; "/new/foo"]];
883 InitBasicFS, TestOutputTrue
884 [["mkdir_p"; "/new/foo/bar"];
885 ["is_dir"; "/new"]]],
886 "create a directory and parents",
888 Create a directory named C<path>, creating any parent directories
889 as necessary. This is like the C<mkdir -p> shell command.");
891 ("chmod", (RErr, [Int "mode"; String "path"]), 34, [],
892 [], (* XXX Need stat command to test *)
895 Change the mode (permissions) of C<path> to C<mode>. Only
896 numeric modes are supported.");
898 ("chown", (RErr, [Int "owner"; Int "group"; String "path"]), 35, [],
899 [], (* XXX Need stat command to test *)
900 "change file owner and group",
902 Change the file owner to C<owner> and group to C<group>.
904 Only numeric uid and gid are supported. If you want to use
905 names, you will need to locate and parse the password file
906 yourself (Augeas support makes this relatively easy).");
908 ("exists", (RBool "existsflag", [String "path"]), 36, [],
909 [InitBasicFS, TestOutputTrue (
911 ["exists"; "/new"]]);
912 InitBasicFS, TestOutputTrue (
914 ["exists"; "/new"]])],
915 "test if file or directory exists",
917 This returns C<true> if and only if there is a file, directory
918 (or anything) with the given C<path> name.
920 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
922 ("is_file", (RBool "fileflag", [String "path"]), 37, [],
923 [InitBasicFS, TestOutputTrue (
925 ["is_file"; "/new"]]);
926 InitBasicFS, TestOutputFalse (
928 ["is_file"; "/new"]])],
929 "test if file exists",
931 This returns C<true> if and only if there is a file
932 with the given C<path> name. Note that it returns false for
933 other objects like directories.
935 See also C<guestfs_stat>.");
937 ("is_dir", (RBool "dirflag", [String "path"]), 38, [],
938 [InitBasicFS, TestOutputFalse (
940 ["is_dir"; "/new"]]);
941 InitBasicFS, TestOutputTrue (
943 ["is_dir"; "/new"]])],
944 "test if file exists",
946 This returns C<true> if and only if there is a directory
947 with the given C<path> name. Note that it returns false for
948 other objects like files.
950 See also C<guestfs_stat>.");
952 ("pvcreate", (RErr, [String "device"]), 39, [],
953 [InitEmpty, TestOutputList (
954 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
955 ["pvcreate"; "/dev/sda1"];
956 ["pvcreate"; "/dev/sda2"];
957 ["pvcreate"; "/dev/sda3"];
958 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
959 "create an LVM physical volume",
961 This creates an LVM physical volume on the named C<device>,
962 where C<device> should usually be a partition name such
965 ("vgcreate", (RErr, [String "volgroup"; StringList "physvols"]), 40, [],
966 [InitEmpty, TestOutputList (
967 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
968 ["pvcreate"; "/dev/sda1"];
969 ["pvcreate"; "/dev/sda2"];
970 ["pvcreate"; "/dev/sda3"];
971 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
972 ["vgcreate"; "VG2"; "/dev/sda3"];
973 ["vgs"]], ["VG1"; "VG2"])],
974 "create an LVM volume group",
976 This creates an LVM volume group called C<volgroup>
977 from the non-empty list of physical volumes C<physvols>.");
979 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [],
980 [InitEmpty, TestOutputList (
981 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
982 ["pvcreate"; "/dev/sda1"];
983 ["pvcreate"; "/dev/sda2"];
984 ["pvcreate"; "/dev/sda3"];
985 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
986 ["vgcreate"; "VG2"; "/dev/sda3"];
987 ["lvcreate"; "LV1"; "VG1"; "50"];
988 ["lvcreate"; "LV2"; "VG1"; "50"];
989 ["lvcreate"; "LV3"; "VG2"; "50"];
990 ["lvcreate"; "LV4"; "VG2"; "50"];
991 ["lvcreate"; "LV5"; "VG2"; "50"];
993 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
994 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
995 "create an LVM volume group",
997 This creates an LVM volume group called C<logvol>
998 on the volume group C<volgroup>, with C<size> megabytes.");
1000 ("mkfs", (RErr, [String "fstype"; String "device"]), 42, [],
1001 [InitEmpty, TestOutput (
1002 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1003 ["mkfs"; "ext2"; "/dev/sda1"];
1004 ["mount"; "/dev/sda1"; "/"];
1005 ["write_file"; "/new"; "new file contents"; "0"];
1006 ["cat"; "/new"]], "new file contents")],
1007 "make a filesystem",
1009 This creates a filesystem on C<device> (usually a partition
1010 or LVM logical volume). The filesystem type is C<fstype>, for
1013 ("sfdisk", (RErr, [String "device";
1014 Int "cyls"; Int "heads"; Int "sectors";
1015 StringList "lines"]), 43, [DangerWillRobinson],
1017 "create partitions on a block device",
1019 This is a direct interface to the L<sfdisk(8)> program for creating
1020 partitions on block devices.
1022 C<device> should be a block device, for example C</dev/sda>.
1024 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1025 and sectors on the device, which are passed directly to sfdisk as
1026 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1027 of these, then the corresponding parameter is omitted. Usually for
1028 'large' disks, you can just pass C<0> for these, but for small
1029 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1030 out the right geometry and you will need to tell it.
1032 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1033 information refer to the L<sfdisk(8)> manpage.
1035 To create a single partition occupying the whole disk, you would
1036 pass C<lines> as a single element list, when the single element being
1037 the string C<,> (comma).");
1039 ("write_file", (RErr, [String "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1040 [InitBasicFS, TestOutput (
1041 [["write_file"; "/new"; "new file contents"; "0"];
1042 ["cat"; "/new"]], "new file contents");
1043 InitBasicFS, TestOutput (
1044 [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1045 ["cat"; "/new"]], "\nnew file contents\n");
1046 InitBasicFS, TestOutput (
1047 [["write_file"; "/new"; "\n\n"; "0"];
1048 ["cat"; "/new"]], "\n\n");
1049 InitBasicFS, TestOutput (
1050 [["write_file"; "/new"; ""; "0"];
1051 ["cat"; "/new"]], "");
1052 InitBasicFS, TestOutput (
1053 [["write_file"; "/new"; "\n\n\n"; "0"];
1054 ["cat"; "/new"]], "\n\n\n");
1055 InitBasicFS, TestOutput (
1056 [["write_file"; "/new"; "\n"; "0"];
1057 ["cat"; "/new"]], "\n")],
1060 This call creates a file called C<path>. The contents of the
1061 file is the string C<content> (which can contain any 8 bit data),
1062 with length C<size>.
1064 As a special case, if C<size> is C<0>
1065 then the length is calculated using C<strlen> (so in this case
1066 the content cannot contain embedded ASCII NULs).
1068 I<NB.> Owing to a bug, writing content containing ASCII NUL
1069 characters does I<not> work, even if the length is specified.
1070 We hope to resolve this bug in a future version. In the meantime
1071 use C<guestfs_upload>.");
1073 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1074 [InitEmpty, TestOutputList (
1075 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1076 ["mkfs"; "ext2"; "/dev/sda1"];
1077 ["mount"; "/dev/sda1"; "/"];
1078 ["mounts"]], ["/dev/sda1"]);
1079 InitEmpty, TestOutputList (
1080 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1081 ["mkfs"; "ext2"; "/dev/sda1"];
1082 ["mount"; "/dev/sda1"; "/"];
1085 "unmount a filesystem",
1087 This unmounts the given filesystem. The filesystem may be
1088 specified either by its mountpoint (path) or the device which
1089 contains the filesystem.");
1091 ("mounts", (RStringList "devices", []), 46, [],
1092 [InitBasicFS, TestOutputList (
1093 [["mounts"]], ["/dev/sda1"])],
1094 "show mounted filesystems",
1096 This returns the list of currently mounted filesystems. It returns
1097 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1099 Some internal mounts are not shown.");
1101 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1102 [InitBasicFS, TestOutputList (
1105 (* check that umount_all can unmount nested mounts correctly: *)
1106 InitEmpty, TestOutputList (
1107 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1108 ["mkfs"; "ext2"; "/dev/sda1"];
1109 ["mkfs"; "ext2"; "/dev/sda2"];
1110 ["mkfs"; "ext2"; "/dev/sda3"];
1111 ["mount"; "/dev/sda1"; "/"];
1113 ["mount"; "/dev/sda2"; "/mp1"];
1114 ["mkdir"; "/mp1/mp2"];
1115 ["mount"; "/dev/sda3"; "/mp1/mp2"];
1116 ["mkdir"; "/mp1/mp2/mp3"];
1119 "unmount all filesystems",
1121 This unmounts all mounted filesystems.
1123 Some internal mounts are not unmounted by this call.");
1125 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson],
1127 "remove all LVM LVs, VGs and PVs",
1129 This command removes all LVM logical volumes, volume groups
1130 and physical volumes.");
1132 ("file", (RString "description", [String "path"]), 49, [],
1133 [InitBasicFS, TestOutput (
1135 ["file"; "/new"]], "empty");
1136 InitBasicFS, TestOutput (
1137 [["write_file"; "/new"; "some content\n"; "0"];
1138 ["file"; "/new"]], "ASCII text");
1139 InitBasicFS, TestLastFail (
1140 [["file"; "/nofile"]])],
1141 "determine file type",
1143 This call uses the standard L<file(1)> command to determine
1144 the type or contents of the file. This also works on devices,
1145 for example to find out whether a partition contains a filesystem.
1147 The exact command which runs is C<file -bsL path>. Note in
1148 particular that the filename is not prepended to the output
1149 (the C<-b> option).");
1151 ("command", (RString "output", [StringList "arguments"]), 50, [],
1152 [], (* XXX how to test? *)
1153 "run a command from the guest filesystem",
1155 This call runs a command from the guest filesystem. The
1156 filesystem must be mounted, and must contain a compatible
1157 operating system (ie. something Linux, with the same
1158 or compatible processor architecture).
1160 The single parameter is an argv-style list of arguments.
1161 The first element is the name of the program to run.
1162 Subsequent elements are parameters. The list must be
1163 non-empty (ie. must contain a program name).
1165 The C<$PATH> environment variable will contain at least
1166 C</usr/bin> and C</bin>. If you require a program from
1167 another location, you should provide the full path in the
1170 Shared libraries and data files required by the program
1171 must be available on filesystems which are mounted in the
1172 correct places. It is the caller's responsibility to ensure
1173 all filesystems that are needed are mounted at the right
1176 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [],
1177 [], (* XXX how to test? *)
1178 "run a command, returning lines",
1180 This is the same as C<guestfs_command>, but splits the
1181 result into a list of lines.");
1183 ("stat", (RStat "statbuf", [String "path"]), 52, [],
1184 [InitBasicFS, TestOutputStruct (
1186 ["stat"; "/new"]], [CompareWithInt ("size", 0)])],
1187 "get file information",
1189 Returns file information for the given C<path>.
1191 This is the same as the C<stat(2)> system call.");
1193 ("lstat", (RStat "statbuf", [String "path"]), 53, [],
1194 [InitBasicFS, TestOutputStruct (
1196 ["lstat"; "/new"]], [CompareWithInt ("size", 0)])],
1197 "get file information for a symbolic link",
1199 Returns file information for the given C<path>.
1201 This is the same as C<guestfs_stat> except that if C<path>
1202 is a symbolic link, then the link is stat-ed, not the file it
1205 This is the same as the C<lstat(2)> system call.");
1207 ("statvfs", (RStatVFS "statbuf", [String "path"]), 54, [],
1208 [InitBasicFS, TestOutputStruct (
1209 [["statvfs"; "/"]], [CompareWithInt ("bfree", 487702);
1210 CompareWithInt ("blocks", 490020);
1211 CompareWithInt ("bsize", 1024)])],
1212 "get file system statistics",
1214 Returns file system statistics for any mounted file system.
1215 C<path> should be a file or directory in the mounted file system
1216 (typically it is the mount point itself, but it doesn't need to be).
1218 This is the same as the C<statvfs(2)> system call.");
1220 ("tune2fs_l", (RHashtable "superblock", [String "device"]), 55, [],
1222 "get ext2/ext3/ext4 superblock details",
1224 This returns the contents of the ext2, ext3 or ext4 filesystem
1225 superblock on C<device>.
1227 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1228 manpage for more details. The list of fields returned isn't
1229 clearly defined, and depends on both the version of C<tune2fs>
1230 that libguestfs was built against, and the filesystem itself.");
1232 ("blockdev_setro", (RErr, [String "device"]), 56, [],
1233 [InitEmpty, TestOutputTrue (
1234 [["blockdev_setro"; "/dev/sda"];
1235 ["blockdev_getro"; "/dev/sda"]])],
1236 "set block device to read-only",
1238 Sets the block device named C<device> to read-only.
1240 This uses the L<blockdev(8)> command.");
1242 ("blockdev_setrw", (RErr, [String "device"]), 57, [],
1243 [InitEmpty, TestOutputFalse (
1244 [["blockdev_setrw"; "/dev/sda"];
1245 ["blockdev_getro"; "/dev/sda"]])],
1246 "set block device to read-write",
1248 Sets the block device named C<device> to read-write.
1250 This uses the L<blockdev(8)> command.");
1252 ("blockdev_getro", (RBool "ro", [String "device"]), 58, [],
1253 [InitEmpty, TestOutputTrue (
1254 [["blockdev_setro"; "/dev/sda"];
1255 ["blockdev_getro"; "/dev/sda"]])],
1256 "is block device set to read-only",
1258 Returns a boolean indicating if the block device is read-only
1259 (true if read-only, false if not).
1261 This uses the L<blockdev(8)> command.");
1263 ("blockdev_getss", (RInt "sectorsize", [String "device"]), 59, [],
1264 [InitEmpty, TestOutputInt (
1265 [["blockdev_getss"; "/dev/sda"]], 512)],
1266 "get sectorsize of block device",
1268 This returns the size of sectors on a block device.
1269 Usually 512, but can be larger for modern devices.
1271 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1274 This uses the L<blockdev(8)> command.");
1276 ("blockdev_getbsz", (RInt "blocksize", [String "device"]), 60, [],
1277 [InitEmpty, TestOutputInt (
1278 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1279 "get blocksize of block device",
1281 This returns the block size of a device.
1283 (Note this is different from both I<size in blocks> and
1284 I<filesystem block size>).
1286 This uses the L<blockdev(8)> command.");
1288 ("blockdev_setbsz", (RErr, [String "device"; Int "blocksize"]), 61, [],
1290 "set blocksize of block device",
1292 This sets the block size of a device.
1294 (Note this is different from both I<size in blocks> and
1295 I<filesystem block size>).
1297 This uses the L<blockdev(8)> command.");
1299 ("blockdev_getsz", (RInt64 "sizeinsectors", [String "device"]), 62, [],
1300 [InitEmpty, TestOutputInt (
1301 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1302 "get total size of device in 512-byte sectors",
1304 This returns the size of the device in units of 512-byte sectors
1305 (even if the sectorsize isn't 512 bytes ... weird).
1307 See also C<guestfs_blockdev_getss> for the real sector size of
1308 the device, and C<guestfs_blockdev_getsize64> for the more
1309 useful I<size in bytes>.
1311 This uses the L<blockdev(8)> command.");
1313 ("blockdev_getsize64", (RInt64 "sizeinbytes", [String "device"]), 63, [],
1314 [InitEmpty, TestOutputInt (
1315 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1316 "get total size of device in bytes",
1318 This returns the size of the device in bytes.
1320 See also C<guestfs_blockdev_getsz>.
1322 This uses the L<blockdev(8)> command.");
1324 ("blockdev_flushbufs", (RErr, [String "device"]), 64, [],
1326 [["blockdev_flushbufs"; "/dev/sda"]]],
1327 "flush device buffers",
1329 This tells the kernel to flush internal buffers associated
1332 This uses the L<blockdev(8)> command.");
1334 ("blockdev_rereadpt", (RErr, [String "device"]), 65, [],
1336 [["blockdev_rereadpt"; "/dev/sda"]]],
1337 "reread partition table",
1339 Reread the partition table on C<device>.
1341 This uses the L<blockdev(8)> command.");
1343 ("upload", (RErr, [FileIn "filename"; String "remotefilename"]), 66, [],
1344 [InitBasicFS, TestOutput (
1345 (* Pick a file from cwd which isn't likely to change. *)
1346 [["upload"; "COPYING.LIB"; "/COPYING.LIB"];
1347 ["checksum"; "md5"; "/COPYING.LIB"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1348 "upload a file from the local machine",
1350 Upload local file C<filename> to C<remotefilename> on the
1353 C<filename> can also be a named pipe.
1355 See also C<guestfs_download>.");
1357 ("download", (RErr, [String "remotefilename"; FileOut "filename"]), 67, [],
1358 [InitBasicFS, TestOutput (
1359 (* Pick a file from cwd which isn't likely to change. *)
1360 [["upload"; "COPYING.LIB"; "/COPYING.LIB"];
1361 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1362 ["upload"; "testdownload.tmp"; "/upload"];
1363 ["checksum"; "md5"; "/upload"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1364 "download a file to the local machine",
1366 Download file C<remotefilename> and save it as C<filename>
1367 on the local machine.
1369 C<filename> can also be a named pipe.
1371 See also C<guestfs_upload>, C<guestfs_cat>.");
1373 ("checksum", (RString "checksum", [String "csumtype"; String "path"]), 68, [],
1374 [InitBasicFS, TestOutput (
1375 [["write_file"; "/new"; "test\n"; "0"];
1376 ["checksum"; "crc"; "/new"]], "935282863");
1377 InitBasicFS, TestLastFail (
1378 [["checksum"; "crc"; "/new"]]);
1379 InitBasicFS, TestOutput (
1380 [["write_file"; "/new"; "test\n"; "0"];
1381 ["checksum"; "md5"; "/new"]], "d8e8fca2dc0f896fd7cb4cb0031ba249");
1382 InitBasicFS, TestOutput (
1383 [["write_file"; "/new"; "test\n"; "0"];
1384 ["checksum"; "sha1"; "/new"]], "4e1243bd22c66e76c2ba9eddc1f91394e57f9f83");
1385 InitBasicFS, TestOutput (
1386 [["write_file"; "/new"; "test\n"; "0"];
1387 ["checksum"; "sha224"; "/new"]], "52f1bf093f4b7588726035c176c0cdb4376cfea53819f1395ac9e6ec");
1388 InitBasicFS, TestOutput (
1389 [["write_file"; "/new"; "test\n"; "0"];
1390 ["checksum"; "sha256"; "/new"]], "f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2");
1391 InitBasicFS, TestOutput (
1392 [["write_file"; "/new"; "test\n"; "0"];
1393 ["checksum"; "sha384"; "/new"]], "109bb6b5b6d5547c1ce03c7a8bd7d8f80c1cb0957f50c4f7fda04692079917e4f9cad52b878f3d8234e1a170b154b72d");
1394 InitBasicFS, TestOutput (
1395 [["write_file"; "/new"; "test\n"; "0"];
1396 ["checksum"; "sha512"; "/new"]], "0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123")],
1397 "compute MD5, SHAx or CRC checksum of file",
1399 This call computes the MD5, SHAx or CRC checksum of the
1402 The type of checksum to compute is given by the C<csumtype>
1403 parameter which must have one of the following values:
1409 Compute the cyclic redundancy check (CRC) specified by POSIX
1410 for the C<cksum> command.
1414 Compute the MD5 hash (using the C<md5sum> program).
1418 Compute the SHA1 hash (using the C<sha1sum> program).
1422 Compute the SHA224 hash (using the C<sha224sum> program).
1426 Compute the SHA256 hash (using the C<sha256sum> program).
1430 Compute the SHA384 hash (using the C<sha384sum> program).
1434 Compute the SHA512 hash (using the C<sha512sum> program).
1438 The checksum is returned as a printable string.");
1440 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1441 [InitBasicFS, TestOutput (
1442 [["tar_in"; "images/helloworld.tar"; "/"];
1443 ["cat"; "/hello"]], "hello\n")],
1444 "unpack tarfile to directory",
1446 This command uploads and unpacks local file C<tarfile> (an
1447 I<uncompressed> tar file) into C<directory>.
1449 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1451 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1453 "pack directory into tarfile",
1455 This command packs the contents of C<directory> and downloads
1456 it to local file C<tarfile>.
1458 To download a compressed tarball, use C<guestfs_tgz_out>.");
1460 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1461 [InitBasicFS, TestOutput (
1462 [["tgz_in"; "images/helloworld.tar.gz"; "/"];
1463 ["cat"; "/hello"]], "hello\n")],
1464 "unpack compressed tarball to directory",
1466 This command uploads and unpacks local file C<tarball> (a
1467 I<gzip compressed> tar file) into C<directory>.
1469 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1471 ("tgz_out", (RErr, [String "directory"; FileOut "tarball"]), 72, [],
1473 "pack directory into compressed tarball",
1475 This command packs the contents of C<directory> and downloads
1476 it to local file C<tarball>.
1478 To download an uncompressed tarball, use C<guestfs_tar_out>.");
1480 ("mount_ro", (RErr, [String "device"; String "mountpoint"]), 73, [],
1481 [InitBasicFS, TestLastFail (
1483 ["mount_ro"; "/dev/sda1"; "/"];
1484 ["touch"; "/new"]]);
1485 InitBasicFS, TestOutput (
1486 [["write_file"; "/new"; "data"; "0"];
1488 ["mount_ro"; "/dev/sda1"; "/"];
1489 ["cat"; "/new"]], "data")],
1490 "mount a guest disk, read-only",
1492 This is the same as the C<guestfs_mount> command, but it
1493 mounts the filesystem with the read-only (I<-o ro>) flag.");
1495 ("mount_options", (RErr, [String "options"; String "device"; String "mountpoint"]), 74, [],
1497 "mount a guest disk with mount options",
1499 This is the same as the C<guestfs_mount> command, but it
1500 allows you to set the mount options as for the
1501 L<mount(8)> I<-o> flag.");
1503 ("mount_vfs", (RErr, [String "options"; String "vfstype"; String "device"; String "mountpoint"]), 75, [],
1505 "mount a guest disk with mount options and vfstype",
1507 This is the same as the C<guestfs_mount> command, but it
1508 allows you to set both the mount options and the vfstype
1509 as for the L<mount(8)> I<-o> and I<-t> flags.");
1511 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
1513 "debugging and internals",
1515 The C<guestfs_debug> command exposes some internals of
1516 C<guestfsd> (the guestfs daemon) that runs inside the
1519 There is no comprehensive help for this command. You have
1520 to look at the file C<daemon/debug.c> in the libguestfs source
1521 to find out what you can do.");
1523 ("lvremove", (RErr, [String "device"]), 77, [],
1524 [InitEmpty, TestOutputList (
1525 [["pvcreate"; "/dev/sda"];
1526 ["vgcreate"; "VG"; "/dev/sda"];
1527 ["lvcreate"; "LV1"; "VG"; "50"];
1528 ["lvcreate"; "LV2"; "VG"; "50"];
1529 ["lvremove"; "/dev/VG/LV1"];
1530 ["lvs"]], ["/dev/VG/LV2"]);
1531 InitEmpty, TestOutputList (
1532 [["pvcreate"; "/dev/sda"];
1533 ["vgcreate"; "VG"; "/dev/sda"];
1534 ["lvcreate"; "LV1"; "VG"; "50"];
1535 ["lvcreate"; "LV2"; "VG"; "50"];
1536 ["lvremove"; "/dev/VG"];
1538 InitEmpty, TestOutputList (
1539 [["pvcreate"; "/dev/sda"];
1540 ["vgcreate"; "VG"; "/dev/sda"];
1541 ["lvcreate"; "LV1"; "VG"; "50"];
1542 ["lvcreate"; "LV2"; "VG"; "50"];
1543 ["lvremove"; "/dev/VG"];
1545 "remove an LVM logical volume",
1547 Remove an LVM logical volume C<device>, where C<device> is
1548 the path to the LV, such as C</dev/VG/LV>.
1550 You can also remove all LVs in a volume group by specifying
1551 the VG name, C</dev/VG>.");
1553 ("vgremove", (RErr, [String "vgname"]), 78, [],
1554 [InitEmpty, TestOutputList (
1555 [["pvcreate"; "/dev/sda"];
1556 ["vgcreate"; "VG"; "/dev/sda"];
1557 ["lvcreate"; "LV1"; "VG"; "50"];
1558 ["lvcreate"; "LV2"; "VG"; "50"];
1561 InitEmpty, TestOutputList (
1562 [["pvcreate"; "/dev/sda"];
1563 ["vgcreate"; "VG"; "/dev/sda"];
1564 ["lvcreate"; "LV1"; "VG"; "50"];
1565 ["lvcreate"; "LV2"; "VG"; "50"];
1568 "remove an LVM volume group",
1570 Remove an LVM volume group C<vgname>, (for example C<VG>).
1572 This also forcibly removes all logical volumes in the volume
1575 ("pvremove", (RErr, [String "device"]), 79, [],
1576 [InitEmpty, TestOutputList (
1577 [["pvcreate"; "/dev/sda"];
1578 ["vgcreate"; "VG"; "/dev/sda"];
1579 ["lvcreate"; "LV1"; "VG"; "50"];
1580 ["lvcreate"; "LV2"; "VG"; "50"];
1582 ["pvremove"; "/dev/sda"];
1584 InitEmpty, TestOutputList (
1585 [["pvcreate"; "/dev/sda"];
1586 ["vgcreate"; "VG"; "/dev/sda"];
1587 ["lvcreate"; "LV1"; "VG"; "50"];
1588 ["lvcreate"; "LV2"; "VG"; "50"];
1590 ["pvremove"; "/dev/sda"];
1592 InitEmpty, TestOutputList (
1593 [["pvcreate"; "/dev/sda"];
1594 ["vgcreate"; "VG"; "/dev/sda"];
1595 ["lvcreate"; "LV1"; "VG"; "50"];
1596 ["lvcreate"; "LV2"; "VG"; "50"];
1598 ["pvremove"; "/dev/sda"];
1600 "remove an LVM physical volume",
1602 This wipes a physical volume C<device> so that LVM will no longer
1605 The implementation uses the C<pvremove> command which refuses to
1606 wipe physical volumes that contain any volume groups, so you have
1607 to remove those first.");
1609 ("set_e2label", (RErr, [String "device"; String "label"]), 80, [],
1610 [InitBasicFS, TestOutput (
1611 [["set_e2label"; "/dev/sda1"; "testlabel"];
1612 ["get_e2label"; "/dev/sda1"]], "testlabel")],
1613 "set the ext2/3/4 filesystem label",
1615 This sets the ext2/3/4 filesystem label of the filesystem on
1616 C<device> to C<label>. Filesystem labels are limited to
1619 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
1620 to return the existing label on a filesystem.");
1622 ("get_e2label", (RString "label", [String "device"]), 81, [],
1624 "get the ext2/3/4 filesystem label",
1626 This returns the ext2/3/4 filesystem label of the filesystem on
1629 ("set_e2uuid", (RErr, [String "device"; String "uuid"]), 82, [],
1630 [InitBasicFS, TestOutput (
1631 [["set_e2uuid"; "/dev/sda1"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"];
1632 ["get_e2uuid"; "/dev/sda1"]], "a3a61220-882b-4f61-89f4-cf24dcc7297d");
1633 InitBasicFS, TestOutput (
1634 [["set_e2uuid"; "/dev/sda1"; "clear"];
1635 ["get_e2uuid"; "/dev/sda1"]], "");
1636 (* We can't predict what UUIDs will be, so just check the commands run. *)
1637 InitBasicFS, TestRun (
1638 [["set_e2uuid"; "/dev/sda1"; "random"]]);
1639 InitBasicFS, TestRun (
1640 [["set_e2uuid"; "/dev/sda1"; "time"]])],
1641 "set the ext2/3/4 filesystem UUID",
1643 This sets the ext2/3/4 filesystem UUID of the filesystem on
1644 C<device> to C<uuid>. The format of the UUID and alternatives
1645 such as C<clear>, C<random> and C<time> are described in the
1646 L<tune2fs(8)> manpage.
1648 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
1649 to return the existing UUID of a filesystem.");
1651 ("get_e2uuid", (RString "uuid", [String "device"]), 83, [],
1653 "get the ext2/3/4 filesystem UUID",
1655 This returns the ext2/3/4 filesystem UUID of the filesystem on
1658 ("fsck", (RInt "status", [String "fstype"; String "device"]), 84, [],
1659 [InitBasicFS, TestOutputInt (
1660 [["umount"; "/dev/sda1"];
1661 ["fsck"; "ext2"; "/dev/sda1"]], 0);
1662 InitBasicFS, TestOutputInt (
1663 [["umount"; "/dev/sda1"];
1664 ["zero"; "/dev/sda1"];
1665 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
1666 "run the filesystem checker",
1668 This runs the filesystem checker (fsck) on C<device> which
1669 should have filesystem type C<fstype>.
1671 The returned integer is the status. See L<fsck(8)> for the
1672 list of status codes from C<fsck>.
1680 Multiple status codes can be summed together.
1684 A non-zero return code can mean \"success\", for example if
1685 errors have been corrected on the filesystem.
1689 Checking or repairing NTFS volumes is not supported
1694 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
1696 ("zero", (RErr, [String "device"]), 85, [],
1697 [InitBasicFS, TestOutput (
1698 [["umount"; "/dev/sda1"];
1699 ["zero"; "/dev/sda1"];
1700 ["file"; "/dev/sda1"]], "data")],
1701 "write zeroes to the device",
1703 This command writes zeroes over the first few blocks of C<device>.
1705 How many blocks are zeroed isn't specified (but it's I<not> enough
1706 to securely wipe the device). It should be sufficient to remove
1707 any partition tables, filesystem superblocks and so on.");
1709 ("grub_install", (RErr, [String "root"; String "device"]), 86, [],
1710 [InitBasicFS, TestOutputTrue (
1711 [["grub_install"; "/"; "/dev/sda1"];
1712 ["is_dir"; "/boot"]])],
1715 This command installs GRUB (the Grand Unified Bootloader) on
1716 C<device>, with the root directory being C<root>.");
1718 ("cp", (RErr, [String "src"; String "dest"]), 87, [],
1719 [InitBasicFS, TestOutput (
1720 [["write_file"; "/old"; "file content"; "0"];
1721 ["cp"; "/old"; "/new"];
1722 ["cat"; "/new"]], "file content");
1723 InitBasicFS, TestOutputTrue (
1724 [["write_file"; "/old"; "file content"; "0"];
1725 ["cp"; "/old"; "/new"];
1726 ["is_file"; "/old"]]);
1727 InitBasicFS, TestOutput (
1728 [["write_file"; "/old"; "file content"; "0"];
1730 ["cp"; "/old"; "/dir/new"];
1731 ["cat"; "/dir/new"]], "file content")],
1734 This copies a file from C<src> to C<dest> where C<dest> is
1735 either a destination filename or destination directory.");
1737 ("cp_a", (RErr, [String "src"; String "dest"]), 88, [],
1738 [InitBasicFS, TestOutput (
1739 [["mkdir"; "/olddir"];
1740 ["mkdir"; "/newdir"];
1741 ["write_file"; "/olddir/file"; "file content"; "0"];
1742 ["cp_a"; "/olddir"; "/newdir"];
1743 ["cat"; "/newdir/olddir/file"]], "file content")],
1744 "copy a file or directory recursively",
1746 This copies a file or directory from C<src> to C<dest>
1747 recursively using the C<cp -a> command.");
1749 ("mv", (RErr, [String "src"; String "dest"]), 89, [],
1750 [InitBasicFS, TestOutput (
1751 [["write_file"; "/old"; "file content"; "0"];
1752 ["mv"; "/old"; "/new"];
1753 ["cat"; "/new"]], "file content");
1754 InitBasicFS, TestOutputFalse (
1755 [["write_file"; "/old"; "file content"; "0"];
1756 ["mv"; "/old"; "/new"];
1757 ["is_file"; "/old"]])],
1760 This moves a file from C<src> to C<dest> where C<dest> is
1761 either a destination filename or destination directory.");
1763 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
1764 [InitEmpty, TestRun (
1765 [["drop_caches"; "3"]])],
1766 "drop kernel page cache, dentries and inodes",
1768 This instructs the guest kernel to drop its page cache,
1769 and/or dentries and inode caches. The parameter C<whattodrop>
1770 tells the kernel what precisely to drop, see
1771 L<http://linux-mm.org/Drop_Caches>
1773 Setting C<whattodrop> to 3 should drop everything.
1775 This automatically calls L<sync(2)> before the operation,
1776 so that the maximum guest memory is freed.");
1778 ("dmesg", (RString "kmsgs", []), 91, [],
1779 [InitEmpty, TestRun (
1781 "return kernel messages",
1783 This returns the kernel messages (C<dmesg> output) from
1784 the guest kernel. This is sometimes useful for extended
1785 debugging of problems.
1787 Another way to get the same information is to enable
1788 verbose messages with C<guestfs_set_verbose> or by setting
1789 the environment variable C<LIBGUESTFS_DEBUG=1> before
1790 running the program.");
1792 ("ping_daemon", (RErr, []), 92, [],
1793 [InitEmpty, TestRun (
1794 [["ping_daemon"]])],
1795 "ping the guest daemon",
1797 This is a test probe into the guestfs daemon running inside
1798 the qemu subprocess. Calling this function checks that the
1799 daemon responds to the ping message, without affecting the daemon
1800 or attached block device(s) in any other way.");
1802 ("equal", (RBool "equality", [String "file1"; String "file2"]), 93, [],
1803 [InitBasicFS, TestOutputTrue (
1804 [["write_file"; "/file1"; "contents of a file"; "0"];
1805 ["cp"; "/file1"; "/file2"];
1806 ["equal"; "/file1"; "/file2"]]);
1807 InitBasicFS, TestOutputFalse (
1808 [["write_file"; "/file1"; "contents of a file"; "0"];
1809 ["write_file"; "/file2"; "contents of another file"; "0"];
1810 ["equal"; "/file1"; "/file2"]]);
1811 InitBasicFS, TestLastFail (
1812 [["equal"; "/file1"; "/file2"]])],
1813 "test if two files have equal contents",
1815 This compares the two files C<file1> and C<file2> and returns
1816 true if their content is exactly equal, or false otherwise.
1818 The external L<cmp(1)> program is used for the comparison.");
1820 ("strings", (RStringList "stringsout", [String "path"]), 94, [ProtocolLimitWarning],
1821 [InitBasicFS, TestOutputList (
1822 [["write_file"; "/new"; "hello\nworld\n"; "0"];
1823 ["strings"; "/new"]], ["hello"; "world"])],
1824 "print the printable strings in a file",
1826 This runs the L<strings(1)> command on a file and returns
1827 the list of printable strings found.");
1829 ("strings_e", (RStringList "stringsout", [String "encoding"; String "path"]), 95, [ProtocolLimitWarning],
1830 [InitBasicFS, TestOutputList (
1831 [["write_file"; "/new"; "hello\nworld\n"; "0"];
1832 ["strings_e"; "b"; "/new"]], []);
1833 (*InitBasicFS, TestOutputList (
1834 [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
1835 ["strings_e"; "b"; "/new"]], ["hello"; "world"])*)],
1836 "print the printable strings in a file",
1838 This is like the C<guestfs_strings> command, but allows you to
1839 specify the encoding.
1841 See the L<strings(1)> manpage for the full list of encodings.
1843 Commonly useful encodings are C<l> (lower case L) which will
1844 show strings inside Windows/x86 files.
1846 The returned strings are transcoded to UTF-8.");
1848 ("hexdump", (RString "dump", [String "path"]), 96, [ProtocolLimitWarning],
1849 [InitBasicFS, TestOutput (
1850 [["write_file"; "/new"; "hello\nworld\n"; "12"];
1851 ["hexdump"; "/new"]], "00000000 68 65 6c 6c 6f 0a 77 6f 72 6c 64 0a |hello.world.|\n0000000c\n")],
1852 "dump a file in hexadecimal",
1854 This runs C<hexdump -C> on the given C<path>. The result is
1855 the human-readable, canonical hex dump of the file.");
1859 let all_functions = non_daemon_functions @ daemon_functions
1861 (* In some places we want the functions to be displayed sorted
1862 * alphabetically, so this is useful:
1864 let all_functions_sorted =
1865 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
1866 compare n1 n2) all_functions
1868 (* Column names and types from LVM PVs/VGs/LVs. *)
1877 "pv_attr", `String (* XXX *);
1878 "pv_pe_count", `Int;
1879 "pv_pe_alloc_count", `Int;
1882 "pv_mda_count", `Int;
1883 "pv_mda_free", `Bytes;
1884 (* Not in Fedora 10:
1885 "pv_mda_size", `Bytes;
1892 "vg_attr", `String (* XXX *);
1895 "vg_sysid", `String;
1896 "vg_extent_size", `Bytes;
1897 "vg_extent_count", `Int;
1898 "vg_free_count", `Int;
1906 "vg_mda_count", `Int;
1907 "vg_mda_free", `Bytes;
1908 (* Not in Fedora 10:
1909 "vg_mda_size", `Bytes;
1915 "lv_attr", `String (* XXX *);
1918 "lv_kernel_major", `Int;
1919 "lv_kernel_minor", `Int;
1923 "snap_percent", `OptPercent;
1924 "copy_percent", `OptPercent;
1927 "mirror_log", `String;
1931 (* Column names and types from stat structures.
1932 * NB. Can't use things like 'st_atime' because glibc header files
1933 * define some of these as macros. Ugh.
1950 let statvfs_cols = [
1964 (* Useful functions.
1965 * Note we don't want to use any external OCaml libraries which
1966 * makes this a bit harder than it should be.
1968 let failwithf fs = ksprintf failwith fs
1970 let replace_char s c1 c2 =
1971 let s2 = String.copy s in
1972 let r = ref false in
1973 for i = 0 to String.length s2 - 1 do
1974 if String.unsafe_get s2 i = c1 then (
1975 String.unsafe_set s2 i c2;
1979 if not !r then s else s2
1983 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
1985 let triml ?(test = isspace) str =
1987 let n = ref (String.length str) in
1988 while !n > 0 && test str.[!i]; do
1993 else String.sub str !i !n
1995 let trimr ?(test = isspace) str =
1996 let n = ref (String.length str) in
1997 while !n > 0 && test str.[!n-1]; do
2000 if !n = String.length str then str
2001 else String.sub str 0 !n
2003 let trim ?(test = isspace) str =
2004 trimr ~test (triml ~test str)
2006 let rec find s sub =
2007 let len = String.length s in
2008 let sublen = String.length sub in
2010 if i <= len-sublen then (
2012 if j < sublen then (
2013 if s.[i+j] = sub.[j] then loop2 (j+1)
2019 if r = -1 then loop (i+1) else r
2025 let rec replace_str s s1 s2 =
2026 let len = String.length s in
2027 let sublen = String.length s1 in
2028 let i = find s s1 in
2031 let s' = String.sub s 0 i in
2032 let s'' = String.sub s (i+sublen) (len-i-sublen) in
2033 s' ^ s2 ^ replace_str s'' s1 s2
2036 let rec string_split sep str =
2037 let len = String.length str in
2038 let seplen = String.length sep in
2039 let i = find str sep in
2040 if i = -1 then [str]
2042 let s' = String.sub str 0 i in
2043 let s'' = String.sub str (i+seplen) (len-i-seplen) in
2044 s' :: string_split sep s''
2047 let files_equal n1 n2 =
2048 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
2049 match Sys.command cmd with
2052 | i -> failwithf "%s: failed with error code %d" cmd i
2054 let rec find_map f = function
2055 | [] -> raise Not_found
2059 | None -> find_map f xs
2062 let rec loop i = function
2064 | x :: xs -> f i x; loop (i+1) xs
2069 let rec loop i = function
2071 | x :: xs -> let r = f i x in r :: loop (i+1) xs
2075 let name_of_argt = function
2076 | String n | OptString n | StringList n | Bool n | Int n
2077 | FileIn n | FileOut n -> n
2079 let seq_of_test = function
2080 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
2081 | TestOutputInt (s, _) | TestOutputTrue s | TestOutputFalse s
2082 | TestOutputLength (s, _) | TestOutputStruct (s, _)
2083 | TestLastFail s -> s
2085 (* Check function names etc. for consistency. *)
2086 let check_functions () =
2087 let contains_uppercase str =
2088 let len = String.length str in
2090 if i >= len then false
2093 if c >= 'A' && c <= 'Z' then true
2100 (* Check function names. *)
2102 fun (name, _, _, _, _, _, _) ->
2103 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
2104 failwithf "function name %s does not need 'guestfs' prefix" name;
2105 if contains_uppercase name then
2106 failwithf "function name %s should not contain uppercase chars" name;
2107 if String.contains name '-' then
2108 failwithf "function name %s should not contain '-', use '_' instead."
2112 (* Check function parameter/return names. *)
2114 fun (name, style, _, _, _, _, _) ->
2115 let check_arg_ret_name n =
2116 if contains_uppercase n then
2117 failwithf "%s param/ret %s should not contain uppercase chars"
2119 if String.contains n '-' || String.contains n '_' then
2120 failwithf "%s param/ret %s should not contain '-' or '_'"
2123 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;
2124 if n = "argv" || n = "args" then
2125 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" n
2128 (match fst style with
2130 | RInt n | RInt64 n | RBool n | RConstString n | RString n
2131 | RStringList n | RPVList n | RVGList n | RLVList n
2132 | RStat n | RStatVFS n
2134 check_arg_ret_name n
2136 check_arg_ret_name n;
2137 check_arg_ret_name m
2139 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
2142 (* Check short descriptions. *)
2144 fun (name, _, _, _, _, shortdesc, _) ->
2145 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
2146 failwithf "short description of %s should begin with lowercase." name;
2147 let c = shortdesc.[String.length shortdesc-1] in
2148 if c = '\n' || c = '.' then
2149 failwithf "short description of %s should not end with . or \\n." name
2152 (* Check long dscriptions. *)
2154 fun (name, _, _, _, _, _, longdesc) ->
2155 if longdesc.[String.length longdesc-1] = '\n' then
2156 failwithf "long description of %s should not end with \\n." name
2159 (* Check proc_nrs. *)
2161 fun (name, _, proc_nr, _, _, _, _) ->
2162 if proc_nr <= 0 then
2163 failwithf "daemon function %s should have proc_nr > 0" name
2167 fun (name, _, proc_nr, _, _, _, _) ->
2168 if proc_nr <> -1 then
2169 failwithf "non-daemon function %s should have proc_nr -1" name
2170 ) non_daemon_functions;
2173 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
2176 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
2177 let rec loop = function
2180 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
2182 | (name1,nr1) :: (name2,nr2) :: _ ->
2183 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
2191 (* Ignore functions that have no tests. We generate a
2192 * warning when the user does 'make check' instead.
2194 | name, _, _, _, [], _, _ -> ()
2195 | name, _, _, _, tests, _, _ ->
2199 match seq_of_test test with
2201 failwithf "%s has a test containing an empty sequence" name
2202 | cmds -> List.map List.hd cmds
2204 let funcs = List.flatten funcs in
2206 let tested = List.mem name funcs in
2209 failwithf "function %s has tests but does not test itself" name
2212 (* 'pr' prints to the current output file. *)
2213 let chan = ref stdout
2214 let pr fs = ksprintf (output_string !chan) fs
2216 (* Generate a header block in a number of standard styles. *)
2217 type comment_style = CStyle | HashStyle | OCamlStyle | HaskellStyle
2218 type license = GPLv2 | LGPLv2
2220 let generate_header comment license =
2221 let c = match comment with
2222 | CStyle -> pr "/* "; " *"
2223 | HashStyle -> pr "# "; "#"
2224 | OCamlStyle -> pr "(* "; " *"
2225 | HaskellStyle -> pr "{- "; " " in
2226 pr "libguestfs generated file\n";
2227 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
2228 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
2230 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
2234 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
2235 pr "%s it under the terms of the GNU General Public License as published by\n" c;
2236 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
2237 pr "%s (at your option) any later version.\n" c;
2239 pr "%s This program is distributed in the hope that it will be useful,\n" c;
2240 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2241 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
2242 pr "%s GNU General Public License for more details.\n" c;
2244 pr "%s You should have received a copy of the GNU General Public License along\n" c;
2245 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
2246 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
2249 pr "%s This library is free software; you can redistribute it and/or\n" c;
2250 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
2251 pr "%s License as published by the Free Software Foundation; either\n" c;
2252 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
2254 pr "%s This library is distributed in the hope that it will be useful,\n" c;
2255 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2256 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
2257 pr "%s Lesser General Public License for more details.\n" c;
2259 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
2260 pr "%s License along with this library; if not, write to the Free Software\n" c;
2261 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
2264 | CStyle -> pr " */\n"
2266 | OCamlStyle -> pr " *)\n"
2267 | HaskellStyle -> pr "-}\n"
2271 (* Start of main code generation functions below this line. *)
2273 (* Generate the pod documentation for the C API. *)
2274 let rec generate_actions_pod () =
2276 fun (shortname, style, _, flags, _, _, longdesc) ->
2277 let name = "guestfs_" ^ shortname in
2278 pr "=head2 %s\n\n" name;
2280 generate_prototype ~extern:false ~handle:"handle" name style;
2282 pr "%s\n\n" longdesc;
2283 (match fst style with
2285 pr "This function returns 0 on success or -1 on error.\n\n"
2287 pr "On error this function returns -1.\n\n"
2289 pr "On error this function returns -1.\n\n"
2291 pr "This function returns a C truth value on success or -1 on error.\n\n"
2293 pr "This function returns a string, or NULL on error.
2294 The string is owned by the guest handle and must I<not> be freed.\n\n"
2296 pr "This function returns a string, or NULL on error.
2297 I<The caller must free the returned string after use>.\n\n"
2299 pr "This function returns a NULL-terminated array of strings
2300 (like L<environ(3)>), or NULL if there was an error.
2301 I<The caller must free the strings and the array after use>.\n\n"
2303 pr "This function returns a C<struct guestfs_int_bool *>,
2304 or NULL if there was an error.
2305 I<The caller must call C<guestfs_free_int_bool> after use>.\n\n"
2307 pr "This function returns a C<struct guestfs_lvm_pv_list *>
2308 (see E<lt>guestfs-structs.hE<gt>),
2309 or NULL if there was an error.
2310 I<The caller must call C<guestfs_free_lvm_pv_list> after use>.\n\n"
2312 pr "This function returns a C<struct guestfs_lvm_vg_list *>
2313 (see E<lt>guestfs-structs.hE<gt>),
2314 or NULL if there was an error.
2315 I<The caller must call C<guestfs_free_lvm_vg_list> after use>.\n\n"
2317 pr "This function returns a C<struct guestfs_lvm_lv_list *>
2318 (see E<lt>guestfs-structs.hE<gt>),
2319 or NULL if there was an error.
2320 I<The caller must call C<guestfs_free_lvm_lv_list> after use>.\n\n"
2322 pr "This function returns a C<struct guestfs_stat *>
2323 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
2324 or NULL if there was an error.
2325 I<The caller must call C<free> after use>.\n\n"
2327 pr "This function returns a C<struct guestfs_statvfs *>
2328 (see L<statvfs(2)> and E<lt>guestfs-structs.hE<gt>),
2329 or NULL if there was an error.
2330 I<The caller must call C<free> after use>.\n\n"
2332 pr "This function returns a NULL-terminated array of
2333 strings, or NULL if there was an error.
2334 The array of strings will always have length C<2n+1>, where
2335 C<n> keys and values alternate, followed by the trailing NULL entry.
2336 I<The caller must free the strings and the array after use>.\n\n"
2338 if List.mem ProtocolLimitWarning flags then
2339 pr "%s\n\n" protocol_limit_warning;
2340 if List.mem DangerWillRobinson flags then
2341 pr "%s\n\n" danger_will_robinson;
2342 ) all_functions_sorted
2344 and generate_structs_pod () =
2345 (* LVM structs documentation. *)
2348 pr "=head2 guestfs_lvm_%s\n" typ;
2350 pr " struct guestfs_lvm_%s {\n" typ;
2353 | name, `String -> pr " char *%s;\n" name
2355 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
2356 pr " char %s[32];\n" name
2357 | name, `Bytes -> pr " uint64_t %s;\n" name
2358 | name, `Int -> pr " int64_t %s;\n" name
2359 | name, `OptPercent ->
2360 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
2361 pr " float %s;\n" name
2364 pr " struct guestfs_lvm_%s_list {\n" typ;
2365 pr " uint32_t len; /* Number of elements in list. */\n";
2366 pr " struct guestfs_lvm_%s *val; /* Elements. */\n" typ;
2369 pr " void guestfs_free_lvm_%s_list (struct guestfs_free_lvm_%s_list *);\n"
2372 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
2374 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
2375 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
2377 * We have to use an underscore instead of a dash because otherwise
2378 * rpcgen generates incorrect code.
2380 * This header is NOT exported to clients, but see also generate_structs_h.
2382 and generate_xdr () =
2383 generate_header CStyle LGPLv2;
2385 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
2386 pr "typedef string str<>;\n";
2389 (* LVM internal structures. *)
2393 pr "struct guestfs_lvm_int_%s {\n" typ;
2395 | name, `String -> pr " string %s<>;\n" name
2396 | name, `UUID -> pr " opaque %s[32];\n" name
2397 | name, `Bytes -> pr " hyper %s;\n" name
2398 | name, `Int -> pr " hyper %s;\n" name
2399 | name, `OptPercent -> pr " float %s;\n" name
2403 pr "typedef struct guestfs_lvm_int_%s guestfs_lvm_int_%s_list<>;\n" typ typ;
2405 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2407 (* Stat internal structures. *)
2411 pr "struct guestfs_int_%s {\n" typ;
2413 | name, `Int -> pr " hyper %s;\n" name
2417 ) ["stat", stat_cols; "statvfs", statvfs_cols];
2420 fun (shortname, style, _, _, _, _, _) ->
2421 let name = "guestfs_" ^ shortname in
2423 (match snd style with
2426 pr "struct %s_args {\n" name;
2429 | String n -> pr " string %s<>;\n" n
2430 | OptString n -> pr " str *%s;\n" n
2431 | StringList n -> pr " str %s<>;\n" n
2432 | Bool n -> pr " bool %s;\n" n
2433 | Int n -> pr " int %s;\n" n
2434 | FileIn _ | FileOut _ -> ()
2438 (match fst style with
2441 pr "struct %s_ret {\n" name;
2445 pr "struct %s_ret {\n" name;
2446 pr " hyper %s;\n" n;
2449 pr "struct %s_ret {\n" name;
2453 failwithf "RConstString cannot be returned from a daemon function"
2455 pr "struct %s_ret {\n" name;
2456 pr " string %s<>;\n" n;
2459 pr "struct %s_ret {\n" name;
2460 pr " str %s<>;\n" n;
2463 pr "struct %s_ret {\n" name;
2468 pr "struct %s_ret {\n" name;
2469 pr " guestfs_lvm_int_pv_list %s;\n" n;
2472 pr "struct %s_ret {\n" name;
2473 pr " guestfs_lvm_int_vg_list %s;\n" n;
2476 pr "struct %s_ret {\n" name;
2477 pr " guestfs_lvm_int_lv_list %s;\n" n;
2480 pr "struct %s_ret {\n" name;
2481 pr " guestfs_int_stat %s;\n" n;
2484 pr "struct %s_ret {\n" name;
2485 pr " guestfs_int_statvfs %s;\n" n;
2488 pr "struct %s_ret {\n" name;
2489 pr " str %s<>;\n" n;
2494 (* Table of procedure numbers. *)
2495 pr "enum guestfs_procedure {\n";
2497 fun (shortname, _, proc_nr, _, _, _, _) ->
2498 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
2500 pr " GUESTFS_PROC_NR_PROCS\n";
2504 (* Having to choose a maximum message size is annoying for several
2505 * reasons (it limits what we can do in the API), but it (a) makes
2506 * the protocol a lot simpler, and (b) provides a bound on the size
2507 * of the daemon which operates in limited memory space. For large
2508 * file transfers you should use FTP.
2510 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
2513 (* Message header, etc. *)
2515 /* The communication protocol is now documented in the guestfs(3)
2519 const GUESTFS_PROGRAM = 0x2000F5F5;
2520 const GUESTFS_PROTOCOL_VERSION = 1;
2522 /* These constants must be larger than any possible message length. */
2523 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
2524 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
2526 enum guestfs_message_direction {
2527 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
2528 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
2531 enum guestfs_message_status {
2532 GUESTFS_STATUS_OK = 0,
2533 GUESTFS_STATUS_ERROR = 1
2536 const GUESTFS_ERROR_LEN = 256;
2538 struct guestfs_message_error {
2539 string error_message<GUESTFS_ERROR_LEN>;
2542 struct guestfs_message_header {
2543 unsigned prog; /* GUESTFS_PROGRAM */
2544 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
2545 guestfs_procedure proc; /* GUESTFS_PROC_x */
2546 guestfs_message_direction direction;
2547 unsigned serial; /* message serial number */
2548 guestfs_message_status status;
2551 const GUESTFS_MAX_CHUNK_SIZE = 8192;
2553 struct guestfs_chunk {
2554 int cancel; /* if non-zero, transfer is cancelled */
2555 /* data size is 0 bytes if the transfer has finished successfully */
2556 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
2560 (* Generate the guestfs-structs.h file. *)
2561 and generate_structs_h () =
2562 generate_header CStyle LGPLv2;
2564 (* This is a public exported header file containing various
2565 * structures. The structures are carefully written to have
2566 * exactly the same in-memory format as the XDR structures that
2567 * we use on the wire to the daemon. The reason for creating
2568 * copies of these structures here is just so we don't have to
2569 * export the whole of guestfs_protocol.h (which includes much
2570 * unrelated and XDR-dependent stuff that we don't want to be
2571 * public, or required by clients).
2573 * To reiterate, we will pass these structures to and from the
2574 * client with a simple assignment or memcpy, so the format
2575 * must be identical to what rpcgen / the RFC defines.
2578 (* guestfs_int_bool structure. *)
2579 pr "struct guestfs_int_bool {\n";
2585 (* LVM public structures. *)
2589 pr "struct guestfs_lvm_%s {\n" typ;
2592 | name, `String -> pr " char *%s;\n" name
2593 | name, `UUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
2594 | name, `Bytes -> pr " uint64_t %s;\n" name
2595 | name, `Int -> pr " int64_t %s;\n" name
2596 | name, `OptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
2600 pr "struct guestfs_lvm_%s_list {\n" typ;
2601 pr " uint32_t len;\n";
2602 pr " struct guestfs_lvm_%s *val;\n" typ;
2605 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2607 (* Stat structures. *)
2611 pr "struct guestfs_%s {\n" typ;
2614 | name, `Int -> pr " int64_t %s;\n" name
2618 ) ["stat", stat_cols; "statvfs", statvfs_cols]
2620 (* Generate the guestfs-actions.h file. *)
2621 and generate_actions_h () =
2622 generate_header CStyle LGPLv2;
2624 fun (shortname, style, _, _, _, _, _) ->
2625 let name = "guestfs_" ^ shortname in
2626 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
2630 (* Generate the client-side dispatch stubs. *)
2631 and generate_client_actions () =
2632 generate_header CStyle LGPLv2;
2638 #include \"guestfs.h\"
2639 #include \"guestfs_protocol.h\"
2641 #define error guestfs_error
2642 #define perrorf guestfs_perrorf
2643 #define safe_malloc guestfs_safe_malloc
2644 #define safe_realloc guestfs_safe_realloc
2645 #define safe_strdup guestfs_safe_strdup
2646 #define safe_memdup guestfs_safe_memdup
2648 /* Check the return message from a call for validity. */
2650 check_reply_header (guestfs_h *g,
2651 const struct guestfs_message_header *hdr,
2652 int proc_nr, int serial)
2654 if (hdr->prog != GUESTFS_PROGRAM) {
2655 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
2658 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
2659 error (g, \"wrong protocol version (%%d/%%d)\",
2660 hdr->vers, GUESTFS_PROTOCOL_VERSION);
2663 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
2664 error (g, \"unexpected message direction (%%d/%%d)\",
2665 hdr->direction, GUESTFS_DIRECTION_REPLY);
2668 if (hdr->proc != proc_nr) {
2669 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
2672 if (hdr->serial != serial) {
2673 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
2680 /* Check we are in the right state to run a high-level action. */
2682 check_state (guestfs_h *g, const char *caller)
2684 if (!guestfs_is_ready (g)) {
2685 if (guestfs_is_config (g))
2686 error (g, \"%%s: call launch() before using this function\",
2688 else if (guestfs_is_launching (g))
2689 error (g, \"%%s: call wait_ready() before using this function\",
2692 error (g, \"%%s called from the wrong state, %%d != READY\",
2693 caller, guestfs_get_state (g));
2701 (* Client-side stubs for each function. *)
2703 fun (shortname, style, _, _, _, _, _) ->
2704 let name = "guestfs_" ^ shortname in
2706 (* Generate the context struct which stores the high-level
2707 * state between callback functions.
2709 pr "struct %s_ctx {\n" shortname;
2710 pr " /* This flag is set by the callbacks, so we know we've done\n";
2711 pr " * the callbacks as expected, and in the right sequence.\n";
2712 pr " * 0 = not called, 1 = reply_cb called.\n";
2714 pr " int cb_sequence;\n";
2715 pr " struct guestfs_message_header hdr;\n";
2716 pr " struct guestfs_message_error err;\n";
2717 (match fst style with
2720 failwithf "RConstString cannot be returned from a daemon function"
2722 | RBool _ | RString _ | RStringList _
2724 | RPVList _ | RVGList _ | RLVList _
2725 | RStat _ | RStatVFS _
2727 pr " struct %s_ret ret;\n" name
2732 (* Generate the reply callback function. *)
2733 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
2735 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
2736 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
2738 pr " /* This should definitely not happen. */\n";
2739 pr " if (ctx->cb_sequence != 0) {\n";
2740 pr " ctx->cb_sequence = 9999;\n";
2741 pr " error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
2745 pr " ml->main_loop_quit (ml, g);\n";
2747 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
2748 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
2751 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
2752 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
2753 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
2760 (match fst style with
2763 failwithf "RConstString cannot be returned from a daemon function"
2765 | RBool _ | RString _ | RStringList _
2767 | RPVList _ | RVGList _ | RLVList _
2768 | RStat _ | RStatVFS _
2770 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
2771 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
2777 pr " ctx->cb_sequence = 1;\n";
2780 (* Generate the action stub. *)
2781 generate_prototype ~extern:false ~semicolon:false ~newline:true
2782 ~handle:"g" name style;
2785 match fst style with
2786 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
2788 failwithf "RConstString cannot be returned from a daemon function"
2789 | RString _ | RStringList _ | RIntBool _
2790 | RPVList _ | RVGList _ | RLVList _
2791 | RStat _ | RStatVFS _
2797 (match snd style with
2799 | _ -> pr " struct %s_args args;\n" name
2802 pr " struct %s_ctx ctx;\n" shortname;
2803 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
2804 pr " int serial;\n";
2806 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
2807 pr " guestfs_set_busy (g);\n";
2809 pr " memset (&ctx, 0, sizeof ctx);\n";
2812 (* Send the main header and arguments. *)
2813 (match snd style with
2815 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
2816 (String.uppercase shortname)
2821 pr " args.%s = (char *) %s;\n" n n
2823 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
2825 pr " args.%s.%s_val = (char **) %s;\n" n n n;
2826 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
2828 pr " args.%s = %s;\n" n n
2830 pr " args.%s = %s;\n" n n
2831 | FileIn _ | FileOut _ -> ()
2833 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
2834 (String.uppercase shortname);
2835 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
2838 pr " if (serial == -1) {\n";
2839 pr " guestfs_end_busy (g);\n";
2840 pr " return %s;\n" error_code;
2844 (* Send any additional files (FileIn) requested. *)
2845 let need_read_reply_label = ref false in
2852 pr " r = guestfs__send_file_sync (g, %s);\n" n;
2853 pr " if (r == -1) {\n";
2854 pr " guestfs_end_busy (g);\n";
2855 pr " return %s;\n" error_code;
2857 pr " if (r == -2) /* daemon cancelled */\n";
2858 pr " goto read_reply;\n";
2859 need_read_reply_label := true;
2865 (* Wait for the reply from the remote end. *)
2866 if !need_read_reply_label then pr " read_reply:\n";
2867 pr " guestfs__switch_to_receiving (g);\n";
2868 pr " ctx.cb_sequence = 0;\n";
2869 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
2870 pr " (void) ml->main_loop_run (ml, g);\n";
2871 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
2872 pr " if (ctx.cb_sequence != 1) {\n";
2873 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
2874 pr " guestfs_end_busy (g);\n";
2875 pr " return %s;\n" error_code;
2879 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
2880 (String.uppercase shortname);
2881 pr " guestfs_end_busy (g);\n";
2882 pr " return %s;\n" error_code;
2886 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
2887 pr " error (g, \"%%s\", ctx.err.error_message);\n";
2888 pr " free (ctx.err.error_message);\n";
2889 pr " guestfs_end_busy (g);\n";
2890 pr " return %s;\n" error_code;
2894 (* Expecting to receive further files (FileOut)? *)
2898 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
2899 pr " guestfs_end_busy (g);\n";
2900 pr " return %s;\n" error_code;
2906 pr " guestfs_end_busy (g);\n";
2908 (match fst style with
2909 | RErr -> pr " return 0;\n"
2910 | RInt n | RInt64 n | RBool n ->
2911 pr " return ctx.ret.%s;\n" n
2913 failwithf "RConstString cannot be returned from a daemon function"
2915 pr " return ctx.ret.%s; /* caller will free */\n" n
2916 | RStringList n | RHashtable n ->
2917 pr " /* caller will free this, but we need to add a NULL entry */\n";
2918 pr " ctx.ret.%s.%s_val =\n" n n;
2919 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
2920 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
2922 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
2923 pr " return ctx.ret.%s.%s_val;\n" n n
2925 pr " /* caller with free this */\n";
2926 pr " return safe_memdup (g, &ctx.ret, sizeof (ctx.ret));\n"
2927 | RPVList n | RVGList n | RLVList n
2928 | RStat n | RStatVFS n ->
2929 pr " /* caller will free this */\n";
2930 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
2936 (* Generate daemon/actions.h. *)
2937 and generate_daemon_actions_h () =
2938 generate_header CStyle GPLv2;
2940 pr "#include \"../src/guestfs_protocol.h\"\n";
2944 fun (name, style, _, _, _, _, _) ->
2946 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
2950 (* Generate the server-side stubs. *)
2951 and generate_daemon_actions () =
2952 generate_header CStyle GPLv2;
2954 pr "#include <config.h>\n";
2956 pr "#include <stdio.h>\n";
2957 pr "#include <stdlib.h>\n";
2958 pr "#include <string.h>\n";
2959 pr "#include <inttypes.h>\n";
2960 pr "#include <ctype.h>\n";
2961 pr "#include <rpc/types.h>\n";
2962 pr "#include <rpc/xdr.h>\n";
2964 pr "#include \"daemon.h\"\n";
2965 pr "#include \"../src/guestfs_protocol.h\"\n";
2966 pr "#include \"actions.h\"\n";
2970 fun (name, style, _, _, _, _, _) ->
2971 (* Generate server-side stubs. *)
2972 pr "static void %s_stub (XDR *xdr_in)\n" name;
2975 match fst style with
2976 | RErr | RInt _ -> pr " int r;\n"; "-1"
2977 | RInt64 _ -> pr " int64_t r;\n"; "-1"
2978 | RBool _ -> pr " int r;\n"; "-1"
2980 failwithf "RConstString cannot be returned from a daemon function"
2981 | RString _ -> pr " char *r;\n"; "NULL"
2982 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
2983 | RIntBool _ -> pr " guestfs_%s_ret *r;\n" name; "NULL"
2984 | RPVList _ -> pr " guestfs_lvm_int_pv_list *r;\n"; "NULL"
2985 | RVGList _ -> pr " guestfs_lvm_int_vg_list *r;\n"; "NULL"
2986 | RLVList _ -> pr " guestfs_lvm_int_lv_list *r;\n"; "NULL"
2987 | RStat _ -> pr " guestfs_int_stat *r;\n"; "NULL"
2988 | RStatVFS _ -> pr " guestfs_int_statvfs *r;\n"; "NULL" in
2990 (match snd style with
2993 pr " struct guestfs_%s_args args;\n" name;
2997 | OptString n -> pr " const char *%s;\n" n
2998 | StringList n -> pr " char **%s;\n" n
2999 | Bool n -> pr " int %s;\n" n
3000 | Int n -> pr " int %s;\n" n
3001 | FileIn _ | FileOut _ -> ()
3006 (match snd style with
3009 pr " memset (&args, 0, sizeof args);\n";
3011 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
3012 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
3017 | String n -> pr " %s = args.%s;\n" n n
3018 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
3020 pr " %s = realloc (args.%s.%s_val,\n" n n n;
3021 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
3022 pr " if (%s == NULL) {\n" n;
3023 pr " reply_with_perror (\"realloc\");\n";
3026 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
3027 pr " args.%s.%s_val = %s;\n" n n n;
3028 | Bool n -> pr " %s = args.%s;\n" n n
3029 | Int n -> pr " %s = args.%s;\n" n n
3030 | FileIn _ | FileOut _ -> ()
3035 (* Don't want to call the impl with any FileIn or FileOut
3036 * parameters, since these go "outside" the RPC protocol.
3039 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
3041 pr " r = do_%s " name;
3042 generate_call_args argsnofile;
3045 pr " if (r == %s)\n" error_code;
3046 pr " /* do_%s has already called reply_with_error */\n" name;
3050 (* If there are any FileOut parameters, then the impl must
3051 * send its own reply.
3054 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
3056 pr " /* do_%s has already sent a reply */\n" name
3058 match fst style with
3059 | RErr -> pr " reply (NULL, NULL);\n"
3060 | RInt n | RInt64 n | RBool n ->
3061 pr " struct guestfs_%s_ret ret;\n" name;
3062 pr " ret.%s = r;\n" n;
3063 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3066 failwithf "RConstString cannot be returned from a daemon function"
3068 pr " struct guestfs_%s_ret ret;\n" name;
3069 pr " ret.%s = r;\n" n;
3070 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3073 | RStringList n | RHashtable n ->
3074 pr " struct guestfs_%s_ret ret;\n" name;
3075 pr " ret.%s.%s_len = count_strings (r);\n" n n;
3076 pr " ret.%s.%s_val = r;\n" n n;
3077 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3079 pr " free_strings (r);\n"
3081 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n"
3083 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n" name
3084 | RPVList n | RVGList n | RLVList n
3085 | RStat n | RStatVFS n ->
3086 pr " struct guestfs_%s_ret ret;\n" name;
3087 pr " ret.%s = *r;\n" n;
3088 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
3090 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
3094 (* Free the args. *)
3095 (match snd style with
3100 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
3107 (* Dispatch function. *)
3108 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
3110 pr " switch (proc_nr) {\n";
3113 fun (name, style, _, _, _, _, _) ->
3114 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
3115 pr " %s_stub (xdr_in);\n" name;
3120 pr " reply_with_error (\"dispatch_incoming_message: unknown procedure number %%d\", proc_nr);\n";
3125 (* LVM columns and tokenization functions. *)
3126 (* XXX This generates crap code. We should rethink how we
3132 pr "static const char *lvm_%s_cols = \"%s\";\n"
3133 typ (String.concat "," (List.map fst cols));
3136 pr "static int lvm_tokenize_%s (char *str, struct guestfs_lvm_int_%s *r)\n" typ typ;
3138 pr " char *tok, *p, *next;\n";
3142 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
3145 pr " if (!str) {\n";
3146 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
3149 pr " if (!*str || isspace (*str)) {\n";
3150 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
3155 fun (name, coltype) ->
3156 pr " if (!tok) {\n";
3157 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
3160 pr " p = strchrnul (tok, ',');\n";
3161 pr " if (*p) next = p+1; else next = NULL;\n";
3162 pr " *p = '\\0';\n";
3165 pr " r->%s = strdup (tok);\n" name;
3166 pr " if (r->%s == NULL) {\n" name;
3167 pr " perror (\"strdup\");\n";
3171 pr " for (i = j = 0; i < 32; ++j) {\n";
3172 pr " if (tok[j] == '\\0') {\n";
3173 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
3175 pr " } else if (tok[j] != '-')\n";
3176 pr " r->%s[i++] = tok[j];\n" name;
3179 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
3180 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3184 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
3185 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3189 pr " if (tok[0] == '\\0')\n";
3190 pr " r->%s = -1;\n" name;
3191 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
3192 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3196 pr " tok = next;\n";
3199 pr " if (tok != NULL) {\n";
3200 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
3207 pr "guestfs_lvm_int_%s_list *\n" typ;
3208 pr "parse_command_line_%ss (void)\n" typ;
3210 pr " char *out, *err;\n";
3211 pr " char *p, *pend;\n";
3213 pr " guestfs_lvm_int_%s_list *ret;\n" typ;
3214 pr " void *newp;\n";
3216 pr " ret = malloc (sizeof *ret);\n";
3217 pr " if (!ret) {\n";
3218 pr " reply_with_perror (\"malloc\");\n";
3219 pr " return NULL;\n";
3222 pr " ret->guestfs_lvm_int_%s_list_len = 0;\n" typ;
3223 pr " ret->guestfs_lvm_int_%s_list_val = NULL;\n" typ;
3225 pr " r = command (&out, &err,\n";
3226 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
3227 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
3228 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
3229 pr " if (r == -1) {\n";
3230 pr " reply_with_error (\"%%s\", err);\n";
3231 pr " free (out);\n";
3232 pr " free (err);\n";
3233 pr " free (ret);\n";
3234 pr " return NULL;\n";
3237 pr " free (err);\n";
3239 pr " /* Tokenize each line of the output. */\n";
3242 pr " while (p) {\n";
3243 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
3244 pr " if (pend) {\n";
3245 pr " *pend = '\\0';\n";
3249 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
3252 pr " if (!*p) { /* Empty line? Skip it. */\n";
3257 pr " /* Allocate some space to store this next entry. */\n";
3258 pr " newp = realloc (ret->guestfs_lvm_int_%s_list_val,\n" typ;
3259 pr " sizeof (guestfs_lvm_int_%s) * (i+1));\n" typ;
3260 pr " if (newp == NULL) {\n";
3261 pr " reply_with_perror (\"realloc\");\n";
3262 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3263 pr " free (ret);\n";
3264 pr " free (out);\n";
3265 pr " return NULL;\n";
3267 pr " ret->guestfs_lvm_int_%s_list_val = newp;\n" typ;
3269 pr " /* Tokenize the next entry. */\n";
3270 pr " r = lvm_tokenize_%s (p, &ret->guestfs_lvm_int_%s_list_val[i]);\n" typ typ;
3271 pr " if (r == -1) {\n";
3272 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
3273 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3274 pr " free (ret);\n";
3275 pr " free (out);\n";
3276 pr " return NULL;\n";
3283 pr " ret->guestfs_lvm_int_%s_list_len = i;\n" typ;
3285 pr " free (out);\n";
3286 pr " return ret;\n";
3289 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
3291 (* Generate the tests. *)
3292 and generate_tests () =
3293 generate_header CStyle GPLv2;
3300 #include <sys/types.h>
3303 #include \"guestfs.h\"
3305 static guestfs_h *g;
3306 static int suppress_error = 0;
3308 /* This will be 's' or 'h' depending on whether the guest kernel
3309 * names IDE devices /dev/sd* or /dev/hd*.
3311 static char devchar = 's';
3313 static void print_error (guestfs_h *g, void *data, const char *msg)
3315 if (!suppress_error)
3316 fprintf (stderr, \"%%s\\n\", msg);
3319 static void print_strings (char * const * const argv)
3323 for (argc = 0; argv[argc] != NULL; ++argc)
3324 printf (\"\\t%%s\\n\", argv[argc]);
3328 static void print_table (char * const * const argv)
3332 for (i = 0; argv[i] != NULL; i += 2)
3333 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
3337 static void no_test_warnings (void)
3343 | name, _, _, _, [], _, _ ->
3344 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
3345 | name, _, _, _, tests, _, _ -> ()
3351 (* Generate the actual tests. Note that we generate the tests
3352 * in reverse order, deliberately, so that (in general) the
3353 * newest tests run first. This makes it quicker and easier to
3358 fun (name, _, _, _, tests, _, _) ->
3359 mapi (generate_one_test name) tests
3360 ) (List.rev all_functions) in
3361 let test_names = List.concat test_names in
3362 let nr_tests = List.length test_names in
3365 int main (int argc, char *argv[])
3370 const char *filename;
3372 int nr_tests, test_num = 0;
3375 no_test_warnings ();
3377 g = guestfs_create ();
3379 printf (\"guestfs_create FAILED\\n\");
3383 guestfs_set_error_handler (g, print_error, NULL);
3385 srcdir = getenv (\"srcdir\");
3386 if (!srcdir) srcdir = \".\";
3388 guestfs_set_path (g, \".\");
3390 filename = \"test1.img\";
3391 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3396 if (lseek (fd, %d, SEEK_SET) == -1) {
3402 if (write (fd, &c, 1) == -1) {
3408 if (close (fd) == -1) {
3413 if (guestfs_add_drive (g, filename) == -1) {
3414 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3418 filename = \"test2.img\";
3419 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3424 if (lseek (fd, %d, SEEK_SET) == -1) {
3430 if (write (fd, &c, 1) == -1) {
3436 if (close (fd) == -1) {
3441 if (guestfs_add_drive (g, filename) == -1) {
3442 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3446 filename = \"test3.img\";
3447 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3452 if (lseek (fd, %d, SEEK_SET) == -1) {
3458 if (write (fd, &c, 1) == -1) {
3464 if (close (fd) == -1) {
3469 if (guestfs_add_drive (g, filename) == -1) {
3470 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3474 if (guestfs_launch (g) == -1) {
3475 printf (\"guestfs_launch FAILED\\n\");
3478 if (guestfs_wait_ready (g) == -1) {
3479 printf (\"guestfs_wait_ready FAILED\\n\");
3483 /* Detect if the appliance uses /dev/sd* or /dev/hd* in device
3484 * names. This changed between RHEL 5 and RHEL 6 so we have to
3487 devs = guestfs_list_devices (g);
3488 if (devs == NULL || devs[0] == NULL) {
3489 printf (\"guestfs_list_devices FAILED\\n\");
3492 if (strncmp (devs[0], \"/dev/sd\", 7) == 0)
3494 else if (strncmp (devs[0], \"/dev/hd\", 7) == 0)
3497 printf (\"guestfs_list_devices returned unexpected string '%%s'\\n\",
3501 for (i = 0; devs[i] != NULL; ++i)
3507 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
3511 pr " test_num++;\n";
3512 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
3513 pr " if (%s () == -1) {\n" test_name;
3514 pr " printf (\"%s FAILED\\n\");\n" test_name;
3520 pr " guestfs_close (g);\n";
3521 pr " unlink (\"test1.img\");\n";
3522 pr " unlink (\"test2.img\");\n";
3523 pr " unlink (\"test3.img\");\n";
3526 pr " if (failed > 0) {\n";
3527 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
3535 and generate_one_test name i (init, test) =
3536 let test_name = sprintf "test_%s_%d" name i in
3538 pr "static int %s (void)\n" test_name;
3544 pr " /* InitEmpty for %s (%d) */\n" name i;
3545 List.iter (generate_test_command_call test_name)
3546 [["blockdev_setrw"; "/dev/sda"];
3550 pr " /* InitBasicFS for %s (%d): create ext2 on /dev/sda1 */\n" name i;
3551 List.iter (generate_test_command_call test_name)
3552 [["blockdev_setrw"; "/dev/sda"];
3555 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
3556 ["mkfs"; "ext2"; "/dev/sda1"];
3557 ["mount"; "/dev/sda1"; "/"]]
3558 | InitBasicFSonLVM ->
3559 pr " /* InitBasicFSonLVM for %s (%d): create ext2 on /dev/VG/LV */\n"
3561 List.iter (generate_test_command_call test_name)
3562 [["blockdev_setrw"; "/dev/sda"];
3565 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
3566 ["pvcreate"; "/dev/sda1"];
3567 ["vgcreate"; "VG"; "/dev/sda1"];
3568 ["lvcreate"; "LV"; "VG"; "8"];
3569 ["mkfs"; "ext2"; "/dev/VG/LV"];
3570 ["mount"; "/dev/VG/LV"; "/"]]
3573 let get_seq_last = function
3575 failwithf "%s: you cannot use [] (empty list) when expecting a command"
3578 let seq = List.rev seq in
3579 List.rev (List.tl seq), List.hd seq
3584 pr " /* TestRun for %s (%d) */\n" name i;
3585 List.iter (generate_test_command_call test_name) seq
3586 | TestOutput (seq, expected) ->
3587 pr " /* TestOutput for %s (%d) */\n" name i;
3588 pr " char expected[] = \"%s\";\n" (c_quote expected);
3589 if String.length expected > 7 &&
3590 String.sub expected 0 7 = "/dev/sd" then
3591 pr " expected[5] = devchar;\n";
3592 let seq, last = get_seq_last seq in
3594 pr " if (strcmp (r, expected) != 0) {\n";
3595 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
3599 List.iter (generate_test_command_call test_name) seq;
3600 generate_test_command_call ~test test_name last
3601 | TestOutputList (seq, expected) ->
3602 pr " /* TestOutputList for %s (%d) */\n" name i;
3603 let seq, last = get_seq_last seq in
3607 pr " if (!r[%d]) {\n" i;
3608 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
3609 pr " print_strings (r);\n";
3613 pr " char expected[] = \"%s\";\n" (c_quote str);
3614 if String.length str > 7 && String.sub str 0 7 = "/dev/sd" then
3615 pr " expected[5] = devchar;\n";
3616 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
3617 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
3622 pr " if (r[%d] != NULL) {\n" (List.length expected);
3623 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
3625 pr " print_strings (r);\n";
3629 List.iter (generate_test_command_call test_name) seq;
3630 generate_test_command_call ~test test_name last
3631 | TestOutputInt (seq, expected) ->
3632 pr " /* TestOutputInt for %s (%d) */\n" name i;
3633 let seq, last = get_seq_last seq in
3635 pr " if (r != %d) {\n" expected;
3636 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
3642 List.iter (generate_test_command_call test_name) seq;
3643 generate_test_command_call ~test test_name last
3644 | TestOutputTrue seq ->
3645 pr " /* TestOutputTrue for %s (%d) */\n" name i;
3646 let seq, last = get_seq_last seq in
3649 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
3654 List.iter (generate_test_command_call test_name) seq;
3655 generate_test_command_call ~test test_name last
3656 | TestOutputFalse seq ->
3657 pr " /* TestOutputFalse for %s (%d) */\n" name i;
3658 let seq, last = get_seq_last seq in
3661 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
3666 List.iter (generate_test_command_call test_name) seq;
3667 generate_test_command_call ~test test_name last
3668 | TestOutputLength (seq, expected) ->
3669 pr " /* TestOutputLength for %s (%d) */\n" name i;
3670 let seq, last = get_seq_last seq in
3673 pr " for (j = 0; j < %d; ++j)\n" expected;
3674 pr " if (r[j] == NULL) {\n";
3675 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
3677 pr " print_strings (r);\n";
3680 pr " if (r[j] != NULL) {\n";
3681 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
3683 pr " print_strings (r);\n";
3687 List.iter (generate_test_command_call test_name) seq;
3688 generate_test_command_call ~test test_name last
3689 | TestOutputStruct (seq, checks) ->
3690 pr " /* TestOutputStruct for %s (%d) */\n" name i;
3691 let seq, last = get_seq_last seq in
3695 | CompareWithInt (field, expected) ->
3696 pr " if (r->%s != %d) {\n" field expected;
3697 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
3698 test_name field expected;
3699 pr " (int) r->%s);\n" field;
3702 | CompareWithString (field, expected) ->
3703 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
3704 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
3705 test_name field expected;
3706 pr " r->%s);\n" field;
3709 | CompareFieldsIntEq (field1, field2) ->
3710 pr " if (r->%s != r->%s) {\n" field1 field2;
3711 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
3712 test_name field1 field2;
3713 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
3716 | CompareFieldsStrEq (field1, field2) ->
3717 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
3718 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
3719 test_name field1 field2;
3720 pr " r->%s, r->%s);\n" field1 field2;
3725 List.iter (generate_test_command_call test_name) seq;
3726 generate_test_command_call ~test test_name last
3727 | TestLastFail seq ->
3728 pr " /* TestLastFail for %s (%d) */\n" name i;
3729 let seq, last = get_seq_last seq in
3730 List.iter (generate_test_command_call test_name) seq;
3731 generate_test_command_call test_name ~expect_error:true last
3739 (* Generate the code to run a command, leaving the result in 'r'.
3740 * If you expect to get an error then you should set expect_error:true.
3742 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
3744 | [] -> assert false
3746 (* Look up the command to find out what args/ret it has. *)
3749 let _, style, _, _, _, _, _ =
3750 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
3753 failwithf "%s: in test, command %s was not found" test_name name in
3755 if List.length (snd style) <> List.length args then
3756 failwithf "%s: in test, wrong number of args given to %s"
3763 | OptString n, "NULL" -> ()
3765 | OptString n, arg ->
3766 pr " char %s[] = \"%s\";\n" n (c_quote arg);
3767 if String.length arg > 7 && String.sub arg 0 7 = "/dev/sd" then
3768 pr " %s[5] = devchar;\n" n
3771 | FileIn _, _ | FileOut _, _ -> ()
3772 | StringList n, arg ->
3773 let strs = string_split " " arg in
3776 pr " char %s_%d[] = \"%s\";\n" n i (c_quote str);
3777 if String.length str > 7 && String.sub str 0 7 = "/dev/sd" then
3778 pr " %s_%d[5] = devchar;\n" n i
3780 pr " char *%s[] = {\n" n;
3782 fun i _ -> pr " %s_%d,\n" n i
3786 ) (List.combine (snd style) args);
3789 match fst style with
3790 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
3791 | RInt64 _ -> pr " int64_t r;\n"; "-1"
3792 | RConstString _ -> pr " const char *r;\n"; "NULL"
3793 | RString _ -> pr " char *r;\n"; "NULL"
3794 | RStringList _ | RHashtable _ ->
3799 pr " struct guestfs_int_bool *r;\n"; "NULL"
3801 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
3803 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
3805 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
3807 pr " struct guestfs_stat *r;\n"; "NULL"
3809 pr " struct guestfs_statvfs *r;\n"; "NULL" in
3811 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
3812 pr " r = guestfs_%s (g" name;
3814 (* Generate the parameters. *)
3817 | OptString _, "NULL" -> pr ", NULL"
3821 | FileIn _, arg | FileOut _, arg ->
3822 pr ", \"%s\"" (c_quote arg)
3823 | StringList n, _ ->
3827 try int_of_string arg
3828 with Failure "int_of_string" ->
3829 failwithf "%s: expecting an int, but got '%s'" test_name arg in
3832 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
3833 ) (List.combine (snd style) args);
3836 if not expect_error then
3837 pr " if (r == %s)\n" error_code
3839 pr " if (r != %s)\n" error_code;
3842 (* Insert the test code. *)
3848 (match fst style with
3849 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _ -> ()
3850 | RString _ -> pr " free (r);\n"
3851 | RStringList _ | RHashtable _ ->
3852 pr " for (i = 0; r[i] != NULL; ++i)\n";
3853 pr " free (r[i]);\n";
3856 pr " guestfs_free_int_bool (r);\n"
3858 pr " guestfs_free_lvm_pv_list (r);\n"
3860 pr " guestfs_free_lvm_vg_list (r);\n"
3862 pr " guestfs_free_lvm_lv_list (r);\n"
3863 | RStat _ | RStatVFS _ ->
3870 let str = replace_str str "\r" "\\r" in
3871 let str = replace_str str "\n" "\\n" in
3872 let str = replace_str str "\t" "\\t" in
3873 let str = replace_str str "\000" "\\0" in
3876 (* Generate a lot of different functions for guestfish. *)
3877 and generate_fish_cmds () =
3878 generate_header CStyle GPLv2;
3882 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3884 let all_functions_sorted =
3886 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3887 ) all_functions_sorted in
3889 pr "#include <stdio.h>\n";
3890 pr "#include <stdlib.h>\n";
3891 pr "#include <string.h>\n";
3892 pr "#include <inttypes.h>\n";
3894 pr "#include <guestfs.h>\n";
3895 pr "#include \"fish.h\"\n";
3898 (* list_commands function, which implements guestfish -h *)
3899 pr "void list_commands (void)\n";
3901 pr " printf (\" %%-16s %%s\\n\", \"Command\", \"Description\");\n";
3902 pr " list_builtin_commands ();\n";
3904 fun (name, _, _, flags, _, shortdesc, _) ->
3905 let name = replace_char name '_' '-' in
3906 pr " printf (\"%%-20s %%s\\n\", \"%s\", \"%s\");\n"
3908 ) all_functions_sorted;
3909 pr " printf (\" Use -h <cmd> / help <cmd> to show detailed help for a command.\\n\");\n";
3913 (* display_command function, which implements guestfish -h cmd *)
3914 pr "void display_command (const char *cmd)\n";
3917 fun (name, style, _, flags, _, shortdesc, longdesc) ->
3918 let name2 = replace_char name '_' '-' in
3920 try find_map (function FishAlias n -> Some n | _ -> None) flags
3921 with Not_found -> name in
3922 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
3924 match snd style with
3928 name2 (String.concat "> <" (List.map name_of_argt args)) in
3931 if List.mem ProtocolLimitWarning flags then
3932 ("\n\n" ^ protocol_limit_warning)
3935 (* For DangerWillRobinson commands, we should probably have
3936 * guestfish prompt before allowing you to use them (especially
3937 * in interactive mode). XXX
3941 if List.mem DangerWillRobinson flags then
3942 ("\n\n" ^ danger_will_robinson)
3945 let describe_alias =
3946 if name <> alias then
3947 sprintf "\n\nYou can use '%s' as an alias for this command." alias
3951 pr "strcasecmp (cmd, \"%s\") == 0" name;
3952 if name <> name2 then
3953 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
3954 if name <> alias then
3955 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
3957 pr " pod2text (\"%s - %s\", %S);\n"
3959 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
3962 pr " display_builtin_command (cmd);\n";
3966 (* print_{pv,vg,lv}_list functions *)
3970 pr "static void print_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
3977 pr " printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
3979 pr " printf (\"%s: \");\n" name;
3980 pr " for (i = 0; i < 32; ++i)\n";
3981 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
3982 pr " printf (\"\\n\");\n"
3984 pr " printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
3986 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
3987 | name, `OptPercent ->
3988 pr " if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
3989 typ name name typ name;
3990 pr " else printf (\"%s: \\n\");\n" name
3994 pr "static void print_%s_list (struct guestfs_lvm_%s_list *%ss)\n"
3999 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
4000 pr " print_%s (&%ss->val[i]);\n" typ typ;
4003 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
4005 (* print_{stat,statvfs} functions *)
4009 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
4014 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
4018 ) ["stat", stat_cols; "statvfs", statvfs_cols];
4020 (* run_<action> actions *)
4022 fun (name, style, _, flags, _, _, _) ->
4023 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
4025 (match fst style with
4028 | RBool _ -> pr " int r;\n"
4029 | RInt64 _ -> pr " int64_t r;\n"
4030 | RConstString _ -> pr " const char *r;\n"
4031 | RString _ -> pr " char *r;\n"
4032 | RStringList _ | RHashtable _ -> pr " char **r;\n"
4033 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"
4034 | RPVList _ -> pr " struct guestfs_lvm_pv_list *r;\n"
4035 | RVGList _ -> pr " struct guestfs_lvm_vg_list *r;\n"
4036 | RLVList _ -> pr " struct guestfs_lvm_lv_list *r;\n"
4037 | RStat _ -> pr " struct guestfs_stat *r;\n"
4038 | RStatVFS _ -> pr " struct guestfs_statvfs *r;\n"
4045 | FileOut n -> pr " const char *%s;\n" n
4046 | StringList n -> pr " char **%s;\n" n
4047 | Bool n -> pr " int %s;\n" n
4048 | Int n -> pr " int %s;\n" n
4051 (* Check and convert parameters. *)
4052 let argc_expected = List.length (snd style) in
4053 pr " if (argc != %d) {\n" argc_expected;
4054 pr " fprintf (stderr, \"%%s should have %d parameter(s)\\n\", cmd);\n"
4056 pr " fprintf (stderr, \"type 'help %%s' for help on %%s\\n\", cmd, cmd);\n";
4062 | String name -> pr " %s = argv[%d];\n" name i
4064 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
4067 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
4070 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
4072 | StringList name ->
4073 pr " %s = parse_string_list (argv[%d]);\n" name i
4075 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
4077 pr " %s = atoi (argv[%d]);\n" name i
4080 (* Call C API function. *)
4082 try find_map (function FishAction n -> Some n | _ -> None) flags
4083 with Not_found -> sprintf "guestfs_%s" name in
4085 generate_call_args ~handle:"g" (snd style);
4088 (* Check return value for errors and display command results. *)
4089 (match fst style with
4090 | RErr -> pr " return r;\n"
4092 pr " if (r == -1) return -1;\n";
4093 pr " printf (\"%%d\\n\", r);\n";
4096 pr " if (r == -1) return -1;\n";
4097 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
4100 pr " if (r == -1) return -1;\n";
4101 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
4104 pr " if (r == NULL) return -1;\n";
4105 pr " printf (\"%%s\\n\", r);\n";
4108 pr " if (r == NULL) return -1;\n";
4109 pr " printf (\"%%s\\n\", r);\n";
4113 pr " if (r == NULL) return -1;\n";
4114 pr " print_strings (r);\n";
4115 pr " free_strings (r);\n";
4118 pr " if (r == NULL) return -1;\n";
4119 pr " printf (\"%%d, %%s\\n\", r->i,\n";
4120 pr " r->b ? \"true\" : \"false\");\n";
4121 pr " guestfs_free_int_bool (r);\n";
4124 pr " if (r == NULL) return -1;\n";
4125 pr " print_pv_list (r);\n";
4126 pr " guestfs_free_lvm_pv_list (r);\n";
4129 pr " if (r == NULL) return -1;\n";
4130 pr " print_vg_list (r);\n";
4131 pr " guestfs_free_lvm_vg_list (r);\n";
4134 pr " if (r == NULL) return -1;\n";
4135 pr " print_lv_list (r);\n";
4136 pr " guestfs_free_lvm_lv_list (r);\n";
4139 pr " if (r == NULL) return -1;\n";
4140 pr " print_stat (r);\n";
4144 pr " if (r == NULL) return -1;\n";
4145 pr " print_statvfs (r);\n";
4149 pr " if (r == NULL) return -1;\n";
4150 pr " print_table (r);\n";
4151 pr " free_strings (r);\n";
4158 (* run_action function *)
4159 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
4162 fun (name, _, _, flags, _, _, _) ->
4163 let name2 = replace_char name '_' '-' in
4165 try find_map (function FishAlias n -> Some n | _ -> None) flags
4166 with Not_found -> name in
4168 pr "strcasecmp (cmd, \"%s\") == 0" name;
4169 if name <> name2 then
4170 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
4171 if name <> alias then
4172 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
4174 pr " return run_%s (cmd, argc, argv);\n" name;
4178 pr " fprintf (stderr, \"%%s: unknown command\\n\", cmd);\n";
4185 (* Readline completion for guestfish. *)
4186 and generate_fish_completion () =
4187 generate_header CStyle GPLv2;
4191 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4201 #ifdef HAVE_LIBREADLINE
4202 #include <readline/readline.h>
4207 #ifdef HAVE_LIBREADLINE
4209 static const char *const commands[] = {
4212 (* Get the commands and sort them, including the aliases. *)
4215 fun (name, _, _, flags, _, _, _) ->
4216 let name2 = replace_char name '_' '-' in
4218 try find_map (function FishAlias n -> Some n | _ -> None) flags
4219 with Not_found -> name in
4221 if name <> alias then [name2; alias] else [name2]
4223 let commands = List.flatten commands in
4224 let commands = List.sort compare commands in
4226 List.iter (pr " \"%s\",\n") commands;
4232 generator (const char *text, int state)
4234 static int index, len;
4239 len = strlen (text);
4242 while ((name = commands[index]) != NULL) {
4244 if (strncasecmp (name, text, len) == 0)
4245 return strdup (name);
4251 #endif /* HAVE_LIBREADLINE */
4253 char **do_completion (const char *text, int start, int end)
4255 char **matches = NULL;
4257 #ifdef HAVE_LIBREADLINE
4259 matches = rl_completion_matches (text, generator);
4266 (* Generate the POD documentation for guestfish. *)
4267 and generate_fish_actions_pod () =
4268 let all_functions_sorted =
4270 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4271 ) all_functions_sorted in
4273 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
4276 fun (name, style, _, flags, _, _, longdesc) ->
4278 Str.global_substitute rex (
4281 try Str.matched_group 1 s
4283 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
4284 "C<" ^ replace_char sub '_' '-' ^ ">"
4286 let name = replace_char name '_' '-' in
4288 try find_map (function FishAlias n -> Some n | _ -> None) flags
4289 with Not_found -> name in
4291 pr "=head2 %s" name;
4292 if name <> alias then
4299 | String n -> pr " %s" n
4300 | OptString n -> pr " %s" n
4301 | StringList n -> pr " '%s ...'" n
4302 | Bool _ -> pr " true|false"
4303 | Int n -> pr " %s" n
4304 | FileIn n | FileOut n -> pr " (%s|-)" n
4308 pr "%s\n\n" longdesc;
4310 if List.exists (function FileIn _ | FileOut _ -> true
4311 | _ -> false) (snd style) then
4312 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
4314 if List.mem ProtocolLimitWarning flags then
4315 pr "%s\n\n" protocol_limit_warning;
4317 if List.mem DangerWillRobinson flags then
4318 pr "%s\n\n" danger_will_robinson
4319 ) all_functions_sorted
4321 (* Generate a C function prototype. *)
4322 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
4323 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
4325 ?handle name style =
4326 if extern then pr "extern ";
4327 if static then pr "static ";
4328 (match fst style with
4330 | RInt _ -> pr "int "
4331 | RInt64 _ -> pr "int64_t "
4332 | RBool _ -> pr "int "
4333 | RConstString _ -> pr "const char *"
4334 | RString _ -> pr "char *"
4335 | RStringList _ | RHashtable _ -> pr "char **"
4337 if not in_daemon then pr "struct guestfs_int_bool *"
4338 else pr "guestfs_%s_ret *" name
4340 if not in_daemon then pr "struct guestfs_lvm_pv_list *"
4341 else pr "guestfs_lvm_int_pv_list *"
4343 if not in_daemon then pr "struct guestfs_lvm_vg_list *"
4344 else pr "guestfs_lvm_int_vg_list *"
4346 if not in_daemon then pr "struct guestfs_lvm_lv_list *"
4347 else pr "guestfs_lvm_int_lv_list *"
4349 if not in_daemon then pr "struct guestfs_stat *"
4350 else pr "guestfs_int_stat *"
4352 if not in_daemon then pr "struct guestfs_statvfs *"
4353 else pr "guestfs_int_statvfs *"
4355 pr "%s%s (" prefix name;
4356 if handle = None && List.length (snd style) = 0 then
4359 let comma = ref false in
4362 | Some handle -> pr "guestfs_h *%s" handle; comma := true
4366 if single_line then pr ", " else pr ",\n\t\t"
4373 | OptString n -> next (); pr "const char *%s" n
4374 | StringList n -> next (); pr "char * const* const %s" n
4375 | Bool n -> next (); pr "int %s" n
4376 | Int n -> next (); pr "int %s" n
4379 if not in_daemon then (next (); pr "const char *%s" n)
4383 if semicolon then pr ";";
4384 if newline then pr "\n"
4386 (* Generate C call arguments, eg "(handle, foo, bar)" *)
4387 and generate_call_args ?handle args =
4389 let comma = ref false in
4392 | Some handle -> pr "%s" handle; comma := true
4396 if !comma then pr ", ";
4398 pr "%s" (name_of_argt arg)
4402 (* Generate the OCaml bindings interface. *)
4403 and generate_ocaml_mli () =
4404 generate_header OCamlStyle LGPLv2;
4407 (** For API documentation you should refer to the C API
4408 in the guestfs(3) manual page. The OCaml API uses almost
4409 exactly the same calls. *)
4412 (** A [guestfs_h] handle. *)
4414 exception Error of string
4415 (** This exception is raised when there is an error. *)
4417 val create : unit -> t
4419 val close : t -> unit
4420 (** Handles are closed by the garbage collector when they become
4421 unreferenced, but callers can also call this in order to
4422 provide predictable cleanup. *)
4425 generate_ocaml_lvm_structure_decls ();
4427 generate_ocaml_stat_structure_decls ();
4431 fun (name, style, _, _, _, shortdesc, _) ->
4432 generate_ocaml_prototype name style;
4433 pr "(** %s *)\n" shortdesc;
4437 (* Generate the OCaml bindings implementation. *)
4438 and generate_ocaml_ml () =
4439 generate_header OCamlStyle LGPLv2;
4443 exception Error of string
4444 external create : unit -> t = \"ocaml_guestfs_create\"
4445 external close : t -> unit = \"ocaml_guestfs_close\"
4448 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
4452 generate_ocaml_lvm_structure_decls ();
4454 generate_ocaml_stat_structure_decls ();
4458 fun (name, style, _, _, _, shortdesc, _) ->
4459 generate_ocaml_prototype ~is_external:true name style;
4462 (* Generate the OCaml bindings C implementation. *)
4463 and generate_ocaml_c () =
4464 generate_header CStyle LGPLv2;
4471 #include <caml/config.h>
4472 #include <caml/alloc.h>
4473 #include <caml/callback.h>
4474 #include <caml/fail.h>
4475 #include <caml/memory.h>
4476 #include <caml/mlvalues.h>
4477 #include <caml/signals.h>
4479 #include <guestfs.h>
4481 #include \"guestfs_c.h\"
4483 /* Copy a hashtable of string pairs into an assoc-list. We return
4484 * the list in reverse order, but hashtables aren't supposed to be
4487 static CAMLprim value
4488 copy_table (char * const * argv)
4491 CAMLlocal5 (rv, pairv, kv, vv, cons);
4495 for (i = 0; argv[i] != NULL; i += 2) {
4496 kv = caml_copy_string (argv[i]);
4497 vv = caml_copy_string (argv[i+1]);
4498 pairv = caml_alloc (2, 0);
4499 Store_field (pairv, 0, kv);
4500 Store_field (pairv, 1, vv);
4501 cons = caml_alloc (2, 0);
4502 Store_field (cons, 1, rv);
4504 Store_field (cons, 0, pairv);
4512 (* LVM struct copy functions. *)
4515 let has_optpercent_col =
4516 List.exists (function (_, `OptPercent) -> true | _ -> false) cols in
4518 pr "static CAMLprim value\n";
4519 pr "copy_lvm_%s (const struct guestfs_lvm_%s *%s)\n" typ typ typ;
4521 pr " CAMLparam0 ();\n";
4522 if has_optpercent_col then
4523 pr " CAMLlocal3 (rv, v, v2);\n"
4525 pr " CAMLlocal2 (rv, v);\n";
4527 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
4532 pr " v = caml_copy_string (%s->%s);\n" typ name
4534 pr " v = caml_alloc_string (32);\n";
4535 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
4538 pr " v = caml_copy_int64 (%s->%s);\n" typ name
4539 | name, `OptPercent ->
4540 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
4541 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
4542 pr " v = caml_alloc (1, 0);\n";
4543 pr " Store_field (v, 0, v2);\n";
4544 pr " } else /* None */\n";
4545 pr " v = Val_int (0);\n";
4547 pr " Store_field (rv, %d, v);\n" i
4549 pr " CAMLreturn (rv);\n";
4553 pr "static CAMLprim value\n";
4554 pr "copy_lvm_%s_list (const struct guestfs_lvm_%s_list *%ss)\n"
4557 pr " CAMLparam0 ();\n";
4558 pr " CAMLlocal2 (rv, v);\n";
4561 pr " if (%ss->len == 0)\n" typ;
4562 pr " CAMLreturn (Atom (0));\n";
4564 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
4565 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
4566 pr " v = copy_lvm_%s (&%ss->val[i]);\n" typ typ;
4567 pr " caml_modify (&Field (rv, i), v);\n";
4569 pr " CAMLreturn (rv);\n";
4573 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
4575 (* Stat copy functions. *)
4578 pr "static CAMLprim value\n";
4579 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
4581 pr " CAMLparam0 ();\n";
4582 pr " CAMLlocal2 (rv, v);\n";
4584 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
4589 pr " v = caml_copy_int64 (%s->%s);\n" typ name
4591 pr " Store_field (rv, %d, v);\n" i
4593 pr " CAMLreturn (rv);\n";
4596 ) ["stat", stat_cols; "statvfs", statvfs_cols];
4600 fun (name, style, _, _, _, _, _) ->
4602 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
4604 pr "CAMLprim value\n";
4605 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
4606 List.iter (pr ", value %s") (List.tl params);
4611 | [p1; p2; p3; p4; p5] ->
4612 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
4613 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
4614 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
4615 pr " CAMLxparam%d (%s);\n"
4616 (List.length rest) (String.concat ", " rest)
4618 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
4620 pr " CAMLlocal1 (rv);\n";
4623 pr " guestfs_h *g = Guestfs_val (gv);\n";
4624 pr " if (g == NULL)\n";
4625 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
4633 pr " const char *%s = String_val (%sv);\n" n n
4635 pr " const char *%s =\n" n;
4636 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
4639 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
4641 pr " int %s = Bool_val (%sv);\n" n n
4643 pr " int %s = Int_val (%sv);\n" n n
4646 match fst style with
4647 | RErr -> pr " int r;\n"; "-1"
4648 | RInt _ -> pr " int r;\n"; "-1"
4649 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4650 | RBool _ -> pr " int r;\n"; "-1"
4651 | RConstString _ -> pr " const char *r;\n"; "NULL"
4652 | RString _ -> pr " char *r;\n"; "NULL"
4658 pr " struct guestfs_int_bool *r;\n"; "NULL"
4660 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
4662 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
4664 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
4666 pr " struct guestfs_stat *r;\n"; "NULL"
4668 pr " struct guestfs_statvfs *r;\n"; "NULL"
4675 pr " caml_enter_blocking_section ();\n";
4676 pr " r = guestfs_%s " name;
4677 generate_call_args ~handle:"g" (snd style);
4679 pr " caml_leave_blocking_section ();\n";
4684 pr " ocaml_guestfs_free_strings (%s);\n" n;
4685 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
4688 pr " if (r == %s)\n" error_code;
4689 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
4692 (match fst style with
4693 | RErr -> pr " rv = Val_unit;\n"
4694 | RInt _ -> pr " rv = Val_int (r);\n"
4696 pr " rv = caml_copy_int64 (r);\n"
4697 | RBool _ -> pr " rv = Val_bool (r);\n"
4698 | RConstString _ -> pr " rv = caml_copy_string (r);\n"
4700 pr " rv = caml_copy_string (r);\n";
4703 pr " rv = caml_copy_string_array ((const char **) r);\n";
4704 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
4707 pr " rv = caml_alloc (2, 0);\n";
4708 pr " Store_field (rv, 0, Val_int (r->i));\n";
4709 pr " Store_field (rv, 1, Val_bool (r->b));\n";
4710 pr " guestfs_free_int_bool (r);\n";
4712 pr " rv = copy_lvm_pv_list (r);\n";
4713 pr " guestfs_free_lvm_pv_list (r);\n";
4715 pr " rv = copy_lvm_vg_list (r);\n";
4716 pr " guestfs_free_lvm_vg_list (r);\n";
4718 pr " rv = copy_lvm_lv_list (r);\n";
4719 pr " guestfs_free_lvm_lv_list (r);\n";
4721 pr " rv = copy_stat (r);\n";
4724 pr " rv = copy_statvfs (r);\n";
4727 pr " rv = copy_table (r);\n";
4728 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
4732 pr " CAMLreturn (rv);\n";
4736 if List.length params > 5 then (
4737 pr "CAMLprim value\n";
4738 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
4740 pr " return ocaml_guestfs_%s (argv[0]" name;
4741 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
4748 and generate_ocaml_lvm_structure_decls () =
4751 pr "type lvm_%s = {\n" typ;
4754 | name, `String -> pr " %s : string;\n" name
4755 | name, `UUID -> pr " %s : string;\n" name
4756 | name, `Bytes -> pr " %s : int64;\n" name
4757 | name, `Int -> pr " %s : int64;\n" name
4758 | name, `OptPercent -> pr " %s : float option;\n" name
4762 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
4764 and generate_ocaml_stat_structure_decls () =
4767 pr "type %s = {\n" typ;
4770 | name, `Int -> pr " %s : int64;\n" name
4774 ) ["stat", stat_cols; "statvfs", statvfs_cols]
4776 and generate_ocaml_prototype ?(is_external = false) name style =
4777 if is_external then pr "external " else pr "val ";
4778 pr "%s : t -> " name;
4781 | String _ | FileIn _ | FileOut _ -> pr "string -> "
4782 | OptString _ -> pr "string option -> "
4783 | StringList _ -> pr "string array -> "
4784 | Bool _ -> pr "bool -> "
4785 | Int _ -> pr "int -> "
4787 (match fst style with
4788 | RErr -> pr "unit" (* all errors are turned into exceptions *)
4789 | RInt _ -> pr "int"
4790 | RInt64 _ -> pr "int64"
4791 | RBool _ -> pr "bool"
4792 | RConstString _ -> pr "string"
4793 | RString _ -> pr "string"
4794 | RStringList _ -> pr "string array"
4795 | RIntBool _ -> pr "int * bool"
4796 | RPVList _ -> pr "lvm_pv array"
4797 | RVGList _ -> pr "lvm_vg array"
4798 | RLVList _ -> pr "lvm_lv array"
4799 | RStat _ -> pr "stat"
4800 | RStatVFS _ -> pr "statvfs"
4801 | RHashtable _ -> pr "(string * string) list"
4803 if is_external then (
4805 if List.length (snd style) + 1 > 5 then
4806 pr "\"ocaml_guestfs_%s_byte\" " name;
4807 pr "\"ocaml_guestfs_%s\"" name
4811 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
4812 and generate_perl_xs () =
4813 generate_header CStyle LGPLv2;
4816 #include \"EXTERN.h\"
4820 #include <guestfs.h>
4823 #define PRId64 \"lld\"
4827 my_newSVll(long long val) {
4828 #ifdef USE_64_BIT_ALL
4829 return newSViv(val);
4833 len = snprintf(buf, 100, \"%%\" PRId64, val);
4834 return newSVpv(buf, len);
4839 #define PRIu64 \"llu\"
4843 my_newSVull(unsigned long long val) {
4844 #ifdef USE_64_BIT_ALL
4845 return newSVuv(val);
4849 len = snprintf(buf, 100, \"%%\" PRIu64, val);
4850 return newSVpv(buf, len);
4854 /* http://www.perlmonks.org/?node_id=680842 */
4856 XS_unpack_charPtrPtr (SV *arg) {
4861 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
4862 croak (\"array reference expected\");
4864 av = (AV *)SvRV (arg);
4865 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
4867 croak (\"malloc failed\");
4869 for (i = 0; i <= av_len (av); i++) {
4870 SV **elem = av_fetch (av, i, 0);
4872 if (!elem || !*elem)
4873 croak (\"missing element in list\");
4875 ret[i] = SvPV_nolen (*elem);
4883 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
4890 RETVAL = guestfs_create ();
4892 croak (\"could not create guestfs handle\");
4893 guestfs_set_error_handler (RETVAL, NULL, NULL);
4906 fun (name, style, _, _, _, _, _) ->
4907 (match fst style with
4908 | RErr -> pr "void\n"
4909 | RInt _ -> pr "SV *\n"
4910 | RInt64 _ -> pr "SV *\n"
4911 | RBool _ -> pr "SV *\n"
4912 | RConstString _ -> pr "SV *\n"
4913 | RString _ -> pr "SV *\n"
4916 | RPVList _ | RVGList _ | RLVList _
4917 | RStat _ | RStatVFS _
4919 pr "void\n" (* all lists returned implictly on the stack *)
4921 (* Call and arguments. *)
4923 generate_call_args ~handle:"g" (snd style);
4925 pr " guestfs_h *g;\n";
4928 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
4929 | OptString n -> pr " char *%s;\n" n
4930 | StringList n -> pr " char **%s;\n" n
4931 | Bool n -> pr " int %s;\n" n
4932 | Int n -> pr " int %s;\n" n
4935 let do_cleanups () =
4938 | String _ | OptString _ | Bool _ | Int _
4939 | FileIn _ | FileOut _ -> ()
4940 | StringList n -> pr " free (%s);\n" n
4945 (match fst style with
4950 pr " r = guestfs_%s " name;
4951 generate_call_args ~handle:"g" (snd style);
4954 pr " if (r == -1)\n";
4955 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4961 pr " %s = guestfs_%s " n name;
4962 generate_call_args ~handle:"g" (snd style);
4965 pr " if (%s == -1)\n" n;
4966 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4967 pr " RETVAL = newSViv (%s);\n" n;
4972 pr " int64_t %s;\n" n;
4974 pr " %s = guestfs_%s " n name;
4975 generate_call_args ~handle:"g" (snd style);
4978 pr " if (%s == -1)\n" n;
4979 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4980 pr " RETVAL = my_newSVll (%s);\n" n;
4985 pr " const char *%s;\n" n;
4987 pr " %s = guestfs_%s " n name;
4988 generate_call_args ~handle:"g" (snd style);
4991 pr " if (%s == NULL)\n" n;
4992 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4993 pr " RETVAL = newSVpv (%s, 0);\n" n;
4998 pr " char *%s;\n" n;
5000 pr " %s = guestfs_%s " n name;
5001 generate_call_args ~handle:"g" (snd style);
5004 pr " if (%s == NULL)\n" n;
5005 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5006 pr " RETVAL = newSVpv (%s, 0);\n" n;
5007 pr " free (%s);\n" n;
5010 | RStringList n | RHashtable n ->
5012 pr " char **%s;\n" n;
5015 pr " %s = guestfs_%s " n name;
5016 generate_call_args ~handle:"g" (snd style);
5019 pr " if (%s == NULL)\n" n;
5020 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5021 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
5022 pr " EXTEND (SP, n);\n";
5023 pr " for (i = 0; i < n; ++i) {\n";
5024 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
5025 pr " free (%s[i]);\n" n;
5027 pr " free (%s);\n" n;
5030 pr " struct guestfs_int_bool *r;\n";
5032 pr " r = guestfs_%s " name;
5033 generate_call_args ~handle:"g" (snd style);
5036 pr " if (r == NULL)\n";
5037 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5038 pr " EXTEND (SP, 2);\n";
5039 pr " PUSHs (sv_2mortal (newSViv (r->i)));\n";
5040 pr " PUSHs (sv_2mortal (newSViv (r->b)));\n";
5041 pr " guestfs_free_int_bool (r);\n";
5043 generate_perl_lvm_code "pv" pv_cols name style n do_cleanups
5045 generate_perl_lvm_code "vg" vg_cols name style n do_cleanups
5047 generate_perl_lvm_code "lv" lv_cols name style n do_cleanups
5049 generate_perl_stat_code "stat" stat_cols name style n do_cleanups
5051 generate_perl_stat_code
5052 "statvfs" statvfs_cols name style n do_cleanups
5058 and generate_perl_lvm_code typ cols name style n do_cleanups =
5060 pr " struct guestfs_lvm_%s_list *%s;\n" typ n;
5064 pr " %s = guestfs_%s " n name;
5065 generate_call_args ~handle:"g" (snd style);
5068 pr " if (%s == NULL)\n" n;
5069 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5070 pr " EXTEND (SP, %s->len);\n" n;
5071 pr " for (i = 0; i < %s->len; ++i) {\n" n;
5072 pr " hv = newHV ();\n";
5076 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
5077 name (String.length name) n name
5079 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
5080 name (String.length name) n name
5082 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
5083 name (String.length name) n name
5085 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
5086 name (String.length name) n name
5087 | name, `OptPercent ->
5088 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
5089 name (String.length name) n name
5091 pr " PUSHs (sv_2mortal ((SV *) hv));\n";
5093 pr " guestfs_free_lvm_%s_list (%s);\n" typ n
5095 and generate_perl_stat_code typ cols name style n do_cleanups =
5097 pr " struct guestfs_%s *%s;\n" typ n;
5099 pr " %s = guestfs_%s " n name;
5100 generate_call_args ~handle:"g" (snd style);
5103 pr " if (%s == NULL)\n" n;
5104 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5105 pr " EXTEND (SP, %d);\n" (List.length cols);
5109 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n" n name
5111 pr " free (%s);\n" n
5113 (* Generate Sys/Guestfs.pm. *)
5114 and generate_perl_pm () =
5115 generate_header HashStyle LGPLv2;
5122 Sys::Guestfs - Perl bindings for libguestfs
5128 my $h = Sys::Guestfs->new ();
5129 $h->add_drive ('guest.img');
5132 $h->mount ('/dev/sda1', '/');
5133 $h->touch ('/hello');
5138 The C<Sys::Guestfs> module provides a Perl XS binding to the
5139 libguestfs API for examining and modifying virtual machine
5142 Amongst the things this is good for: making batch configuration
5143 changes to guests, getting disk used/free statistics (see also:
5144 virt-df), migrating between virtualization systems (see also:
5145 virt-p2v), performing partial backups, performing partial guest
5146 clones, cloning guests and changing registry/UUID/hostname info, and
5149 Libguestfs uses Linux kernel and qemu code, and can access any type of
5150 guest filesystem that Linux and qemu can, including but not limited
5151 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
5152 schemes, qcow, qcow2, vmdk.
5154 Libguestfs provides ways to enumerate guest storage (eg. partitions,
5155 LVs, what filesystem is in each LV, etc.). It can also run commands
5156 in the context of the guest. Also you can access filesystems over FTP.
5160 All errors turn into calls to C<croak> (see L<Carp(3)>).
5168 package Sys::Guestfs;
5174 XSLoader::load ('Sys::Guestfs');
5176 =item $h = Sys::Guestfs->new ();
5178 Create a new guestfs handle.
5184 my $class = ref ($proto) || $proto;
5186 my $self = Sys::Guestfs::_create ();
5187 bless $self, $class;
5193 (* Actions. We only need to print documentation for these as
5194 * they are pulled in from the XS code automatically.
5197 fun (name, style, _, flags, _, _, longdesc) ->
5198 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
5200 generate_perl_prototype name style;
5202 pr "%s\n\n" longdesc;
5203 if List.mem ProtocolLimitWarning flags then
5204 pr "%s\n\n" protocol_limit_warning;
5205 if List.mem DangerWillRobinson flags then
5206 pr "%s\n\n" danger_will_robinson
5207 ) all_functions_sorted;
5219 Copyright (C) 2009 Red Hat Inc.
5223 Please see the file COPYING.LIB for the full license.
5227 L<guestfs(3)>, L<guestfish(1)>.
5232 and generate_perl_prototype name style =
5233 (match fst style with
5239 | RString n -> pr "$%s = " n
5240 | RIntBool (n, m) -> pr "($%s, $%s) = " n m
5244 | RLVList n -> pr "@%s = " n
5247 | RHashtable n -> pr "%%%s = " n
5250 let comma = ref false in
5253 if !comma then pr ", ";
5256 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
5263 (* Generate Python C module. *)
5264 and generate_python_c () =
5265 generate_header CStyle LGPLv2;
5274 #include \"guestfs.h\"
5282 get_handle (PyObject *obj)
5285 assert (obj != Py_None);
5286 return ((Pyguestfs_Object *) obj)->g;
5290 put_handle (guestfs_h *g)
5294 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
5297 /* This list should be freed (but not the strings) after use. */
5298 static const char **
5299 get_string_list (PyObject *obj)
5306 if (!PyList_Check (obj)) {
5307 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
5311 len = PyList_Size (obj);
5312 r = malloc (sizeof (char *) * (len+1));
5314 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
5318 for (i = 0; i < len; ++i)
5319 r[i] = PyString_AsString (PyList_GetItem (obj, i));
5326 put_string_list (char * const * const argv)
5331 for (argc = 0; argv[argc] != NULL; ++argc)
5334 list = PyList_New (argc);
5335 for (i = 0; i < argc; ++i)
5336 PyList_SetItem (list, i, PyString_FromString (argv[i]));
5342 put_table (char * const * const argv)
5344 PyObject *list, *item;
5347 for (argc = 0; argv[argc] != NULL; ++argc)
5350 list = PyList_New (argc >> 1);
5351 for (i = 0; i < argc; i += 2) {
5352 item = PyTuple_New (2);
5353 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
5354 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
5355 PyList_SetItem (list, i >> 1, item);
5362 free_strings (char **argv)
5366 for (argc = 0; argv[argc] != NULL; ++argc)
5372 py_guestfs_create (PyObject *self, PyObject *args)
5376 g = guestfs_create ();
5378 PyErr_SetString (PyExc_RuntimeError,
5379 \"guestfs.create: failed to allocate handle\");
5382 guestfs_set_error_handler (g, NULL, NULL);
5383 return put_handle (g);
5387 py_guestfs_close (PyObject *self, PyObject *args)
5392 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
5394 g = get_handle (py_g);
5398 Py_INCREF (Py_None);
5404 (* LVM structures, turned into Python dictionaries. *)
5407 pr "static PyObject *\n";
5408 pr "put_lvm_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
5410 pr " PyObject *dict;\n";
5412 pr " dict = PyDict_New ();\n";
5416 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5417 pr " PyString_FromString (%s->%s));\n"
5420 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5421 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
5424 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5425 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
5428 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5429 pr " PyLong_FromLongLong (%s->%s));\n"
5431 | name, `OptPercent ->
5432 pr " if (%s->%s >= 0)\n" typ name;
5433 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5434 pr " PyFloat_FromDouble ((double) %s->%s));\n"
5437 pr " Py_INCREF (Py_None);\n";
5438 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
5441 pr " return dict;\n";
5445 pr "static PyObject *\n";
5446 pr "put_lvm_%s_list (struct guestfs_lvm_%s_list *%ss)\n" typ typ typ;
5448 pr " PyObject *list;\n";
5451 pr " list = PyList_New (%ss->len);\n" typ;
5452 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
5453 pr " PyList_SetItem (list, i, put_lvm_%s (&%ss->val[i]));\n" typ typ;
5454 pr " return list;\n";
5457 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
5459 (* Stat structures, turned into Python dictionaries. *)
5462 pr "static PyObject *\n";
5463 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
5465 pr " PyObject *dict;\n";
5467 pr " dict = PyDict_New ();\n";
5471 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5472 pr " PyLong_FromLongLong (%s->%s));\n"
5475 pr " return dict;\n";
5478 ) ["stat", stat_cols; "statvfs", statvfs_cols];
5480 (* Python wrapper functions. *)
5482 fun (name, style, _, _, _, _, _) ->
5483 pr "static PyObject *\n";
5484 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
5487 pr " PyObject *py_g;\n";
5488 pr " guestfs_h *g;\n";
5489 pr " PyObject *py_r;\n";
5492 match fst style with
5493 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5494 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5495 | RConstString _ -> pr " const char *r;\n"; "NULL"
5496 | RString _ -> pr " char *r;\n"; "NULL"
5497 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5498 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
5499 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5500 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5501 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5502 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
5503 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
5507 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
5508 | OptString n -> pr " const char *%s;\n" n
5510 pr " PyObject *py_%s;\n" n;
5511 pr " const char **%s;\n" n
5512 | Bool n -> pr " int %s;\n" n
5513 | Int n -> pr " int %s;\n" n
5518 (* Convert the parameters. *)
5519 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
5522 | String _ | FileIn _ | FileOut _ -> pr "s"
5523 | OptString _ -> pr "z"
5524 | StringList _ -> pr "O"
5525 | Bool _ -> pr "i" (* XXX Python has booleans? *)
5528 pr ":guestfs_%s\",\n" name;
5532 | String n | FileIn n | FileOut n -> pr ", &%s" n
5533 | OptString n -> pr ", &%s" n
5534 | StringList n -> pr ", &py_%s" n
5535 | Bool n -> pr ", &%s" n
5536 | Int n -> pr ", &%s" n
5540 pr " return NULL;\n";
5542 pr " g = get_handle (py_g);\n";
5545 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5547 pr " %s = get_string_list (py_%s);\n" n n;
5548 pr " if (!%s) return NULL;\n" n
5553 pr " r = guestfs_%s " name;
5554 generate_call_args ~handle:"g" (snd style);
5559 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5561 pr " free (%s);\n" n
5564 pr " if (r == %s) {\n" error_code;
5565 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
5566 pr " return NULL;\n";
5570 (match fst style with
5572 pr " Py_INCREF (Py_None);\n";
5573 pr " py_r = Py_None;\n"
5575 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
5576 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
5577 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
5579 pr " py_r = PyString_FromString (r);\n";
5582 pr " py_r = put_string_list (r);\n";
5583 pr " free_strings (r);\n"
5585 pr " py_r = PyTuple_New (2);\n";
5586 pr " PyTuple_SetItem (py_r, 0, PyInt_FromLong ((long) r->i));\n";
5587 pr " PyTuple_SetItem (py_r, 1, PyInt_FromLong ((long) r->b));\n";
5588 pr " guestfs_free_int_bool (r);\n"
5590 pr " py_r = put_lvm_pv_list (r);\n";
5591 pr " guestfs_free_lvm_pv_list (r);\n"
5593 pr " py_r = put_lvm_vg_list (r);\n";
5594 pr " guestfs_free_lvm_vg_list (r);\n"
5596 pr " py_r = put_lvm_lv_list (r);\n";
5597 pr " guestfs_free_lvm_lv_list (r);\n"
5599 pr " py_r = put_stat (r);\n";
5602 pr " py_r = put_statvfs (r);\n";
5605 pr " py_r = put_table (r);\n";
5606 pr " free_strings (r);\n"
5609 pr " return py_r;\n";
5614 (* Table of functions. *)
5615 pr "static PyMethodDef methods[] = {\n";
5616 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
5617 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
5619 fun (name, _, _, _, _, _, _) ->
5620 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
5623 pr " { NULL, NULL, 0, NULL }\n";
5627 (* Init function. *)
5630 initlibguestfsmod (void)
5632 static int initialized = 0;
5634 if (initialized) return;
5635 Py_InitModule ((char *) \"libguestfsmod\", methods);
5640 (* Generate Python module. *)
5641 and generate_python_py () =
5642 generate_header HashStyle LGPLv2;
5645 u\"\"\"Python bindings for libguestfs
5648 g = guestfs.GuestFS ()
5649 g.add_drive (\"guest.img\")
5652 parts = g.list_partitions ()
5654 The guestfs module provides a Python binding to the libguestfs API
5655 for examining and modifying virtual machine disk images.
5657 Amongst the things this is good for: making batch configuration
5658 changes to guests, getting disk used/free statistics (see also:
5659 virt-df), migrating between virtualization systems (see also:
5660 virt-p2v), performing partial backups, performing partial guest
5661 clones, cloning guests and changing registry/UUID/hostname info, and
5664 Libguestfs uses Linux kernel and qemu code, and can access any type of
5665 guest filesystem that Linux and qemu can, including but not limited
5666 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
5667 schemes, qcow, qcow2, vmdk.
5669 Libguestfs provides ways to enumerate guest storage (eg. partitions,
5670 LVs, what filesystem is in each LV, etc.). It can also run commands
5671 in the context of the guest. Also you can access filesystems over FTP.
5673 Errors which happen while using the API are turned into Python
5674 RuntimeError exceptions.
5676 To create a guestfs handle you usually have to perform the following
5679 # Create the handle, call add_drive at least once, and possibly
5680 # several times if the guest has multiple block devices:
5681 g = guestfs.GuestFS ()
5682 g.add_drive (\"guest.img\")
5684 # Launch the qemu subprocess and wait for it to become ready:
5688 # Now you can issue commands, for example:
5693 import libguestfsmod
5696 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
5698 def __init__ (self):
5699 \"\"\"Create a new libguestfs handle.\"\"\"
5700 self._o = libguestfsmod.create ()
5703 libguestfsmod.close (self._o)
5708 fun (name, style, _, flags, _, _, longdesc) ->
5709 let doc = replace_str longdesc "C<guestfs_" "C<g." in
5711 match fst style with
5712 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _
5715 doc ^ "\n\nThis function returns a list of strings."
5717 doc ^ "\n\nThis function returns a tuple (int, bool).\n"
5719 doc ^ "\n\nThis function returns a list of PVs. Each PV is represented as a dictionary."
5721 doc ^ "\n\nThis function returns a list of VGs. Each VG is represented as a dictionary."
5723 doc ^ "\n\nThis function returns a list of LVs. Each LV is represented as a dictionary."
5725 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the stat structure."
5727 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the statvfs structure."
5729 doc ^ "\n\nThis function returns a dictionary." in
5731 if List.mem ProtocolLimitWarning flags then
5732 doc ^ "\n\n" ^ protocol_limit_warning
5735 if List.mem DangerWillRobinson flags then
5736 doc ^ "\n\n" ^ danger_will_robinson
5738 let doc = pod2text ~width:60 name doc in
5739 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
5740 let doc = String.concat "\n " doc in
5743 generate_call_args ~handle:"self" (snd style);
5745 pr " u\"\"\"%s\"\"\"\n" doc;
5746 pr " return libguestfsmod.%s " name;
5747 generate_call_args ~handle:"self._o" (snd style);
5752 (* Useful if you need the longdesc POD text as plain text. Returns a
5755 * This is the slowest thing about autogeneration.
5757 and pod2text ~width name longdesc =
5758 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
5759 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
5761 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
5762 let chan = Unix.open_process_in cmd in
5763 let lines = ref [] in
5765 let line = input_line chan in
5766 if i = 1 then (* discard the first line of output *)
5769 let line = triml line in
5770 lines := line :: !lines;
5773 let lines = try loop 1 with End_of_file -> List.rev !lines in
5774 Unix.unlink filename;
5775 match Unix.close_process_in chan with
5776 | Unix.WEXITED 0 -> lines
5778 failwithf "pod2text: process exited with non-zero status (%d)" i
5779 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
5780 failwithf "pod2text: process signalled or stopped by signal %d" i
5782 (* Generate ruby bindings. *)
5783 and generate_ruby_c () =
5784 generate_header CStyle LGPLv2;
5792 #include \"guestfs.h\"
5794 #include \"extconf.h\"
5796 /* For Ruby < 1.9 */
5798 #define RARRAY_LEN(r) (RARRAY((r))->len)
5801 static VALUE m_guestfs; /* guestfs module */
5802 static VALUE c_guestfs; /* guestfs_h handle */
5803 static VALUE e_Error; /* used for all errors */
5805 static void ruby_guestfs_free (void *p)
5808 guestfs_close ((guestfs_h *) p);
5811 static VALUE ruby_guestfs_create (VALUE m)
5815 g = guestfs_create ();
5817 rb_raise (e_Error, \"failed to create guestfs handle\");
5819 /* Don't print error messages to stderr by default. */
5820 guestfs_set_error_handler (g, NULL, NULL);
5822 /* Wrap it, and make sure the close function is called when the
5825 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
5828 static VALUE ruby_guestfs_close (VALUE gv)
5831 Data_Get_Struct (gv, guestfs_h, g);
5833 ruby_guestfs_free (g);
5834 DATA_PTR (gv) = NULL;
5842 fun (name, style, _, _, _, _, _) ->
5843 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
5844 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
5847 pr " guestfs_h *g;\n";
5848 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
5850 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
5856 | String n | FileIn n | FileOut n ->
5857 pr " const char *%s = StringValueCStr (%sv);\n" n n;
5859 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
5860 pr " \"%s\", \"%s\");\n" n name
5862 pr " const char *%s = StringValueCStr (%sv);\n" n n
5866 pr " int i, len;\n";
5867 pr " len = RARRAY_LEN (%sv);\n" n;
5868 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
5870 pr " for (i = 0; i < len; ++i) {\n";
5871 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
5872 pr " %s[i] = StringValueCStr (v);\n" n;
5874 pr " %s[len] = NULL;\n" n;
5878 pr " int %s = NUM2INT (%sv);\n" n n
5883 match fst style with
5884 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5885 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5886 | RConstString _ -> pr " const char *r;\n"; "NULL"
5887 | RString _ -> pr " char *r;\n"; "NULL"
5888 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5889 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
5890 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5891 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5892 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5893 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
5894 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
5897 pr " r = guestfs_%s " name;
5898 generate_call_args ~handle:"g" (snd style);
5903 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5905 pr " free (%s);\n" n
5908 pr " if (r == %s)\n" error_code;
5909 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
5912 (match fst style with
5914 pr " return Qnil;\n"
5915 | RInt _ | RBool _ ->
5916 pr " return INT2NUM (r);\n"
5918 pr " return ULL2NUM (r);\n"
5920 pr " return rb_str_new2 (r);\n";
5922 pr " VALUE rv = rb_str_new2 (r);\n";
5926 pr " int i, len = 0;\n";
5927 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
5928 pr " VALUE rv = rb_ary_new2 (len);\n";
5929 pr " for (i = 0; r[i] != NULL; ++i) {\n";
5930 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
5931 pr " free (r[i]);\n";
5936 pr " VALUE rv = rb_ary_new2 (2);\n";
5937 pr " rb_ary_push (rv, INT2NUM (r->i));\n";
5938 pr " rb_ary_push (rv, INT2NUM (r->b));\n";
5939 pr " guestfs_free_int_bool (r);\n";
5942 generate_ruby_lvm_code "pv" pv_cols
5944 generate_ruby_lvm_code "vg" vg_cols
5946 generate_ruby_lvm_code "lv" lv_cols
5948 pr " VALUE rv = rb_hash_new ();\n";
5952 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
5957 pr " VALUE rv = rb_hash_new ();\n";
5961 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
5966 pr " VALUE rv = rb_hash_new ();\n";
5968 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
5969 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
5970 pr " free (r[i]);\n";
5971 pr " free (r[i+1]);\n";
5982 /* Initialize the module. */
5983 void Init__guestfs ()
5985 m_guestfs = rb_define_module (\"Guestfs\");
5986 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
5987 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
5989 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
5990 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
5993 (* Define the rest of the methods. *)
5995 fun (name, style, _, _, _, _, _) ->
5996 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
5997 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
6002 (* Ruby code to return an LVM struct list. *)
6003 and generate_ruby_lvm_code typ cols =
6004 pr " VALUE rv = rb_ary_new2 (r->len);\n";
6006 pr " for (i = 0; i < r->len; ++i) {\n";
6007 pr " VALUE hv = rb_hash_new ();\n";
6011 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
6013 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
6016 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
6017 | name, `OptPercent ->
6018 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
6020 pr " rb_ary_push (rv, hv);\n";
6022 pr " guestfs_free_lvm_%s_list (r);\n" typ;
6025 (* Generate Java bindings GuestFS.java file. *)
6026 and generate_java_java () =
6027 generate_header CStyle LGPLv2;
6030 package com.redhat.et.libguestfs;
6032 import java.util.HashMap;
6033 import com.redhat.et.libguestfs.LibGuestFSException;
6034 import com.redhat.et.libguestfs.PV;
6035 import com.redhat.et.libguestfs.VG;
6036 import com.redhat.et.libguestfs.LV;
6037 import com.redhat.et.libguestfs.Stat;
6038 import com.redhat.et.libguestfs.StatVFS;
6039 import com.redhat.et.libguestfs.IntBool;
6042 * The GuestFS object is a libguestfs handle.
6046 public class GuestFS {
6047 // Load the native code.
6049 System.loadLibrary (\"guestfs_jni\");
6053 * The native guestfs_h pointer.
6058 * Create a libguestfs handle.
6060 * @throws LibGuestFSException
6062 public GuestFS () throws LibGuestFSException
6066 private native long _create () throws LibGuestFSException;
6069 * Close a libguestfs handle.
6071 * You can also leave handles to be collected by the garbage
6072 * collector, but this method ensures that the resources used
6073 * by the handle are freed up immediately. If you call any
6074 * other methods after closing the handle, you will get an
6077 * @throws LibGuestFSException
6079 public void close () throws LibGuestFSException
6085 private native void _close (long g) throws LibGuestFSException;
6087 public void finalize () throws LibGuestFSException
6095 fun (name, style, _, flags, _, shortdesc, longdesc) ->
6096 let doc = replace_str longdesc "C<guestfs_" "C<g." in
6098 if List.mem ProtocolLimitWarning flags then
6099 doc ^ "\n\n" ^ protocol_limit_warning
6102 if List.mem DangerWillRobinson flags then
6103 doc ^ "\n\n" ^ danger_will_robinson
6105 let doc = pod2text ~width:60 name doc in
6106 let doc = String.concat "\n * " doc in
6109 pr " * %s\n" shortdesc;
6112 pr " * @throws LibGuestFSException\n";
6115 generate_java_prototype ~public:true ~semicolon:false name style;
6118 pr " if (g == 0)\n";
6119 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
6122 if fst style <> RErr then pr "return ";
6124 generate_call_args ~handle:"g" (snd style);
6128 generate_java_prototype ~privat:true ~native:true name style;
6135 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
6136 ?(semicolon=true) name style =
6137 if privat then pr "private ";
6138 if public then pr "public ";
6139 if native then pr "native ";
6142 (match fst style with
6143 | RErr -> pr "void ";
6144 | RInt _ -> pr "int ";
6145 | RInt64 _ -> pr "long ";
6146 | RBool _ -> pr "boolean ";
6147 | RConstString _ | RString _ -> pr "String ";
6148 | RStringList _ -> pr "String[] ";
6149 | RIntBool _ -> pr "IntBool ";
6150 | RPVList _ -> pr "PV[] ";
6151 | RVGList _ -> pr "VG[] ";
6152 | RLVList _ -> pr "LV[] ";
6153 | RStat _ -> pr "Stat ";
6154 | RStatVFS _ -> pr "StatVFS ";
6155 | RHashtable _ -> pr "HashMap<String,String> ";
6158 if native then pr "_%s " name else pr "%s " name;
6160 let needs_comma = ref false in
6169 if !needs_comma then pr ", ";
6170 needs_comma := true;
6187 pr " throws LibGuestFSException";
6188 if semicolon then pr ";"
6190 and generate_java_struct typ cols =
6191 generate_header CStyle LGPLv2;
6194 package com.redhat.et.libguestfs;
6197 * Libguestfs %s structure.
6208 | name, `UUID -> pr " public String %s;\n" name
6210 | name, `Int -> pr " public long %s;\n" name
6211 | name, `OptPercent ->
6212 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
6213 pr " public float %s;\n" name
6218 and generate_java_c () =
6219 generate_header CStyle LGPLv2;
6226 #include \"com_redhat_et_libguestfs_GuestFS.h\"
6227 #include \"guestfs.h\"
6229 /* Note that this function returns. The exception is not thrown
6230 * until after the wrapper function returns.
6233 throw_exception (JNIEnv *env, const char *msg)
6236 cl = (*env)->FindClass (env,
6237 \"com/redhat/et/libguestfs/LibGuestFSException\");
6238 (*env)->ThrowNew (env, cl, msg);
6241 JNIEXPORT jlong JNICALL
6242 Java_com_redhat_et_libguestfs_GuestFS__1create
6243 (JNIEnv *env, jobject obj)
6247 g = guestfs_create ();
6249 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
6252 guestfs_set_error_handler (g, NULL, NULL);
6253 return (jlong) (long) g;
6256 JNIEXPORT void JNICALL
6257 Java_com_redhat_et_libguestfs_GuestFS__1close
6258 (JNIEnv *env, jobject obj, jlong jg)
6260 guestfs_h *g = (guestfs_h *) (long) jg;
6267 fun (name, style, _, _, _, _, _) ->
6269 (match fst style with
6270 | RErr -> pr "void ";
6271 | RInt _ -> pr "jint ";
6272 | RInt64 _ -> pr "jlong ";
6273 | RBool _ -> pr "jboolean ";
6274 | RConstString _ | RString _ -> pr "jstring ";
6275 | RIntBool _ | RStat _ | RStatVFS _ | RHashtable _ ->
6277 | RStringList _ | RPVList _ | RVGList _ | RLVList _ ->
6281 pr "Java_com_redhat_et_libguestfs_GuestFS_";
6282 pr "%s" (replace_str ("_" ^ name) "_" "_1");
6284 pr " (JNIEnv *env, jobject obj, jlong jg";
6291 pr ", jstring j%s" n
6293 pr ", jobjectArray j%s" n
6295 pr ", jboolean j%s" n
6301 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
6302 let error_code, no_ret =
6303 match fst style with
6304 | RErr -> pr " int r;\n"; "-1", ""
6306 | RInt _ -> pr " int r;\n"; "-1", "0"
6307 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
6308 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
6310 pr " jstring jr;\n";
6311 pr " char *r;\n"; "NULL", "NULL"
6313 pr " jobjectArray jr;\n";
6316 pr " jstring jstr;\n";
6317 pr " char **r;\n"; "NULL", "NULL"
6319 pr " jobject jr;\n";
6321 pr " jfieldID fl;\n";
6322 pr " struct guestfs_int_bool *r;\n"; "NULL", "NULL"
6324 pr " jobject jr;\n";
6326 pr " jfieldID fl;\n";
6327 pr " struct guestfs_stat *r;\n"; "NULL", "NULL"
6329 pr " jobject jr;\n";
6331 pr " jfieldID fl;\n";
6332 pr " struct guestfs_statvfs *r;\n"; "NULL", "NULL"
6334 pr " jobjectArray jr;\n";
6336 pr " jfieldID fl;\n";
6337 pr " jobject jfl;\n";
6338 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL", "NULL"
6340 pr " jobjectArray jr;\n";
6342 pr " jfieldID fl;\n";
6343 pr " jobject jfl;\n";
6344 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL", "NULL"
6346 pr " jobjectArray jr;\n";
6348 pr " jfieldID fl;\n";
6349 pr " jobject jfl;\n";
6350 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL", "NULL"
6351 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL" in
6358 pr " const char *%s;\n" n
6360 pr " int %s_len;\n" n;
6361 pr " const char **%s;\n" n
6368 (match fst style with
6369 | RStringList _ | RPVList _ | RVGList _ | RLVList _ -> true
6370 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
6371 | RString _ | RIntBool _ | RStat _ | RStatVFS _
6372 | RHashtable _ -> false) ||
6373 List.exists (function StringList _ -> true | _ -> false) (snd style) in
6379 (* Get the parameters. *)
6386 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
6388 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
6389 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
6390 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6391 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6393 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
6395 pr " %s[%s_len] = NULL;\n" n n;
6398 pr " %s = j%s;\n" n n
6401 (* Make the call. *)
6402 pr " r = guestfs_%s " name;
6403 generate_call_args ~handle:"g" (snd style);
6406 (* Release the parameters. *)
6413 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
6415 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6416 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6418 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
6420 pr " free (%s);\n" n
6425 (* Check for errors. *)
6426 pr " if (r == %s) {\n" error_code;
6427 pr " throw_exception (env, guestfs_last_error (g));\n";
6428 pr " return %s;\n" no_ret;
6432 (match fst style with
6434 | RInt _ -> pr " return (jint) r;\n"
6435 | RBool _ -> pr " return (jboolean) r;\n"
6436 | RInt64 _ -> pr " return (jlong) r;\n"
6437 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
6439 pr " jr = (*env)->NewStringUTF (env, r);\n";
6443 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
6444 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
6445 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
6446 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
6447 pr " for (i = 0; i < r_len; ++i) {\n";
6448 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
6449 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
6450 pr " free (r[i]);\n";
6455 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/IntBool\");\n";
6456 pr " jr = (*env)->AllocObject (env, cl);\n";
6457 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"I\");\n";
6458 pr " (*env)->SetIntField (env, jr, fl, r->i);\n";
6459 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"Z\");\n";
6460 pr " (*env)->SetBooleanField (env, jr, fl, r->b);\n";
6461 pr " guestfs_free_int_bool (r);\n";
6464 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/Stat\");\n";
6465 pr " jr = (*env)->AllocObject (env, cl);\n";
6469 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
6471 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
6476 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/StatVFS\");\n";
6477 pr " jr = (*env)->AllocObject (env, cl);\n";
6481 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
6483 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
6488 generate_java_lvm_return "pv" "PV" pv_cols
6490 generate_java_lvm_return "vg" "VG" vg_cols
6492 generate_java_lvm_return "lv" "LV" lv_cols
6495 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
6496 pr " return NULL;\n"
6503 and generate_java_lvm_return typ jtyp cols =
6504 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
6505 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
6506 pr " for (i = 0; i < r->len; ++i) {\n";
6507 pr " jfl = (*env)->AllocObject (env, cl);\n";
6511 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
6512 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
6515 pr " char s[33];\n";
6516 pr " memcpy (s, r->val[i].%s, 32);\n" name;
6518 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
6519 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
6521 | name, (`Bytes|`Int) ->
6522 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
6523 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
6524 | name, `OptPercent ->
6525 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
6526 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
6528 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
6530 pr " guestfs_free_lvm_%s_list (r);\n" typ;
6533 and generate_haskell_hs () =
6534 generate_header HaskellStyle LGPLv2;
6536 (* XXX We only know how to generate partial FFI for Haskell
6537 * at the moment. Please help out!
6539 let can_generate style =
6540 let check_no_bad_args =
6541 List.for_all (function Bool _ | Int _ -> false | _ -> true)
6544 | RErr, args -> check_no_bad_args args
6557 | RHashtable _, _ -> false in
6560 {-# INCLUDE <guestfs.h> #-}
6561 {-# LANGUAGE ForeignFunctionInterface #-}
6566 (* List out the names of the actions we want to export. *)
6568 fun (name, style, _, _, _, _, _) ->
6569 if can_generate style then pr ",\n %s" name
6577 import Control.Exception
6578 import Data.Typeable
6580 data GuestfsS = GuestfsS -- represents the opaque C struct
6581 type GuestfsP = Ptr GuestfsS -- guestfs_h *
6582 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
6584 -- XXX define properly later XXX
6588 data IntBool = IntBool
6590 data StatVFS = StatVFS
6591 data Hashtable = Hashtable
6593 foreign import ccall unsafe \"guestfs_create\" c_create
6595 foreign import ccall unsafe \"&guestfs_close\" c_close
6596 :: FunPtr (GuestfsP -> IO ())
6597 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
6598 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
6600 create :: IO GuestfsH
6603 c_set_error_handler p nullPtr nullPtr
6604 h <- newForeignPtr c_close p
6607 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
6608 :: GuestfsP -> IO CString
6610 -- last_error :: GuestfsH -> IO (Maybe String)
6611 -- last_error h = do
6612 -- str <- withForeignPtr h (\\p -> c_last_error p)
6613 -- maybePeek peekCString str
6615 last_error :: GuestfsH -> IO (String)
6617 str <- withForeignPtr h (\\p -> c_last_error p)
6619 then return \"no error\"
6620 else peekCString str
6624 (* Generate wrappers for each foreign function. *)
6626 fun (name, style, _, _, _, _, _) ->
6627 if can_generate style then (
6628 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
6630 generate_haskell_prototype ~handle:"GuestfsP" style;
6634 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
6636 pr "%s %s = do\n" name
6637 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
6643 | String n -> pr "withCString %s $ \\%s -> " n n
6644 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
6645 | StringList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
6647 (* XXX this doesn't work *)
6649 pr " %s = case %s of\n" n n;
6652 pr " in fromIntegral %s $ \\%s ->\n" n n
6653 | Int n -> pr "fromIntegral %s $ \\%s -> " n n
6655 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
6656 (String.concat " " ("p" :: List.map name_of_argt (snd style)));
6657 (match fst style with
6658 | RErr | RInt _ | RInt64 _ | RBool _ ->
6659 pr " if (r == -1)\n";
6661 pr " err <- last_error h\n";
6663 | RConstString _ | RString _ | RStringList _ | RIntBool _
6664 | RPVList _ | RVGList _ | RLVList _ | RStat _ | RStatVFS _
6666 pr " if (r == nullPtr)\n";
6668 pr " err <- last_error h\n";
6671 (match fst style with
6673 pr " else return ()\n"
6675 pr " else return (fromIntegral r)\n"
6677 pr " else return (fromIntegral r)\n"
6679 pr " else return (toBool r)\n"
6690 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
6696 and generate_haskell_prototype ~handle ?(hs = false) style =
6698 let string = if hs then "String" else "CString" in
6699 let int = if hs then "Int" else "CInt" in
6700 let bool = if hs then "Bool" else "CInt" in
6701 let int64 = if hs then "Integer" else "Int64" in
6705 | String _ -> pr "%s" string
6706 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
6707 | StringList _ -> if hs then pr "[String]" else pr "Ptr CString"
6708 | Bool _ -> pr "%s" bool
6709 | Int _ -> pr "%s" int
6710 | FileIn _ -> pr "%s" string
6711 | FileOut _ -> pr "%s" string
6716 (match fst style with
6717 | RErr -> if not hs then pr "CInt"
6718 | RInt _ -> pr "%s" int
6719 | RInt64 _ -> pr "%s" int64
6720 | RBool _ -> pr "%s" bool
6721 | RConstString _ -> pr "%s" string
6722 | RString _ -> pr "%s" string
6723 | RStringList _ -> pr "[%s]" string
6724 | RIntBool _ -> pr "IntBool"
6725 | RPVList _ -> pr "[PV]"
6726 | RVGList _ -> pr "[VG]"
6727 | RLVList _ -> pr "[LV]"
6728 | RStat _ -> pr "Stat"
6729 | RStatVFS _ -> pr "StatVFS"
6730 | RHashtable _ -> pr "Hashtable"
6734 let output_to filename =
6735 let filename_new = filename ^ ".new" in
6736 chan := open_out filename_new;
6741 (* Is the new file different from the current file? *)
6742 if Sys.file_exists filename && files_equal filename filename_new then
6743 Unix.unlink filename_new (* same, so skip it *)
6745 (* different, overwrite old one *)
6746 (try Unix.chmod filename 0o644 with Unix.Unix_error _ -> ());
6747 Unix.rename filename_new filename;
6748 Unix.chmod filename 0o444;
6749 printf "written %s\n%!" filename;
6758 if not (Sys.file_exists "configure.ac") then (
6760 You are probably running this from the wrong directory.
6761 Run it from the top source directory using the command
6767 let close = output_to "src/guestfs_protocol.x" in
6771 let close = output_to "src/guestfs-structs.h" in
6772 generate_structs_h ();
6775 let close = output_to "src/guestfs-actions.h" in
6776 generate_actions_h ();
6779 let close = output_to "src/guestfs-actions.c" in
6780 generate_client_actions ();
6783 let close = output_to "daemon/actions.h" in
6784 generate_daemon_actions_h ();
6787 let close = output_to "daemon/stubs.c" in
6788 generate_daemon_actions ();
6791 let close = output_to "tests.c" in
6795 let close = output_to "fish/cmds.c" in
6796 generate_fish_cmds ();
6799 let close = output_to "fish/completion.c" in
6800 generate_fish_completion ();
6803 let close = output_to "guestfs-structs.pod" in
6804 generate_structs_pod ();
6807 let close = output_to "guestfs-actions.pod" in
6808 generate_actions_pod ();
6811 let close = output_to "guestfish-actions.pod" in
6812 generate_fish_actions_pod ();
6815 let close = output_to "ocaml/guestfs.mli" in
6816 generate_ocaml_mli ();
6819 let close = output_to "ocaml/guestfs.ml" in
6820 generate_ocaml_ml ();
6823 let close = output_to "ocaml/guestfs_c_actions.c" in
6824 generate_ocaml_c ();
6827 let close = output_to "perl/Guestfs.xs" in
6828 generate_perl_xs ();
6831 let close = output_to "perl/lib/Sys/Guestfs.pm" in
6832 generate_perl_pm ();
6835 let close = output_to "python/guestfs-py.c" in
6836 generate_python_c ();
6839 let close = output_to "python/guestfs.py" in
6840 generate_python_py ();
6843 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
6847 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
6848 generate_java_java ();
6851 let close = output_to "java/com/redhat/et/libguestfs/PV.java" in
6852 generate_java_struct "PV" pv_cols;
6855 let close = output_to "java/com/redhat/et/libguestfs/VG.java" in
6856 generate_java_struct "VG" vg_cols;
6859 let close = output_to "java/com/redhat/et/libguestfs/LV.java" in
6860 generate_java_struct "LV" lv_cols;
6863 let close = output_to "java/com/redhat/et/libguestfs/Stat.java" in
6864 generate_java_struct "Stat" stat_cols;
6867 let close = output_to "java/com/redhat/et/libguestfs/StatVFS.java" in
6868 generate_java_struct "StatVFS" statvfs_cols;
6871 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in
6875 let close = output_to "haskell/Guestfs.hs" in
6876 generate_haskell_hs ();