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
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 "(* "; " *" in
2225 pr "libguestfs generated file\n";
2226 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
2227 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
2229 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
2233 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
2234 pr "%s it under the terms of the GNU General Public License as published by\n" c;
2235 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
2236 pr "%s (at your option) any later version.\n" c;
2238 pr "%s This program is distributed in the hope that it will be useful,\n" c;
2239 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2240 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
2241 pr "%s GNU General Public License for more details.\n" c;
2243 pr "%s You should have received a copy of the GNU General Public License along\n" c;
2244 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
2245 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
2248 pr "%s This library is free software; you can redistribute it and/or\n" c;
2249 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
2250 pr "%s License as published by the Free Software Foundation; either\n" c;
2251 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
2253 pr "%s This library is distributed in the hope that it will be useful,\n" c;
2254 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2255 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
2256 pr "%s Lesser General Public License for more details.\n" c;
2258 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
2259 pr "%s License along with this library; if not, write to the Free Software\n" c;
2260 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
2263 | CStyle -> pr " */\n"
2265 | OCamlStyle -> pr " *)\n"
2269 (* Start of main code generation functions below this line. *)
2271 (* Generate the pod documentation for the C API. *)
2272 let rec generate_actions_pod () =
2274 fun (shortname, style, _, flags, _, _, longdesc) ->
2275 let name = "guestfs_" ^ shortname in
2276 pr "=head2 %s\n\n" name;
2278 generate_prototype ~extern:false ~handle:"handle" name style;
2280 pr "%s\n\n" longdesc;
2281 (match fst style with
2283 pr "This function returns 0 on success or -1 on error.\n\n"
2285 pr "On error this function returns -1.\n\n"
2287 pr "On error this function returns -1.\n\n"
2289 pr "This function returns a C truth value on success or -1 on error.\n\n"
2291 pr "This function returns a string, or NULL on error.
2292 The string is owned by the guest handle and must I<not> be freed.\n\n"
2294 pr "This function returns a string, or NULL on error.
2295 I<The caller must free the returned string after use>.\n\n"
2297 pr "This function returns a NULL-terminated array of strings
2298 (like L<environ(3)>), or NULL if there was an error.
2299 I<The caller must free the strings and the array after use>.\n\n"
2301 pr "This function returns a C<struct guestfs_int_bool *>,
2302 or NULL if there was an error.
2303 I<The caller must call C<guestfs_free_int_bool> after use>.\n\n"
2305 pr "This function returns a C<struct guestfs_lvm_pv_list *>
2306 (see E<lt>guestfs-structs.hE<gt>),
2307 or NULL if there was an error.
2308 I<The caller must call C<guestfs_free_lvm_pv_list> after use>.\n\n"
2310 pr "This function returns a C<struct guestfs_lvm_vg_list *>
2311 (see E<lt>guestfs-structs.hE<gt>),
2312 or NULL if there was an error.
2313 I<The caller must call C<guestfs_free_lvm_vg_list> after use>.\n\n"
2315 pr "This function returns a C<struct guestfs_lvm_lv_list *>
2316 (see E<lt>guestfs-structs.hE<gt>),
2317 or NULL if there was an error.
2318 I<The caller must call C<guestfs_free_lvm_lv_list> after use>.\n\n"
2320 pr "This function returns a C<struct guestfs_stat *>
2321 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
2322 or NULL if there was an error.
2323 I<The caller must call C<free> after use>.\n\n"
2325 pr "This function returns a C<struct guestfs_statvfs *>
2326 (see L<statvfs(2)> and E<lt>guestfs-structs.hE<gt>),
2327 or NULL if there was an error.
2328 I<The caller must call C<free> after use>.\n\n"
2330 pr "This function returns a NULL-terminated array of
2331 strings, or NULL if there was an error.
2332 The array of strings will always have length C<2n+1>, where
2333 C<n> keys and values alternate, followed by the trailing NULL entry.
2334 I<The caller must free the strings and the array after use>.\n\n"
2336 if List.mem ProtocolLimitWarning flags then
2337 pr "%s\n\n" protocol_limit_warning;
2338 if List.mem DangerWillRobinson flags then
2339 pr "%s\n\n" danger_will_robinson;
2340 ) all_functions_sorted
2342 and generate_structs_pod () =
2343 (* LVM structs documentation. *)
2346 pr "=head2 guestfs_lvm_%s\n" typ;
2348 pr " struct guestfs_lvm_%s {\n" typ;
2351 | name, `String -> pr " char *%s;\n" name
2353 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
2354 pr " char %s[32];\n" name
2355 | name, `Bytes -> pr " uint64_t %s;\n" name
2356 | name, `Int -> pr " int64_t %s;\n" name
2357 | name, `OptPercent ->
2358 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
2359 pr " float %s;\n" name
2362 pr " struct guestfs_lvm_%s_list {\n" typ;
2363 pr " uint32_t len; /* Number of elements in list. */\n";
2364 pr " struct guestfs_lvm_%s *val; /* Elements. */\n" typ;
2367 pr " void guestfs_free_lvm_%s_list (struct guestfs_free_lvm_%s_list *);\n"
2370 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
2372 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
2373 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
2375 * We have to use an underscore instead of a dash because otherwise
2376 * rpcgen generates incorrect code.
2378 * This header is NOT exported to clients, but see also generate_structs_h.
2380 and generate_xdr () =
2381 generate_header CStyle LGPLv2;
2383 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
2384 pr "typedef string str<>;\n";
2387 (* LVM internal structures. *)
2391 pr "struct guestfs_lvm_int_%s {\n" typ;
2393 | name, `String -> pr " string %s<>;\n" name
2394 | name, `UUID -> pr " opaque %s[32];\n" name
2395 | name, `Bytes -> pr " hyper %s;\n" name
2396 | name, `Int -> pr " hyper %s;\n" name
2397 | name, `OptPercent -> pr " float %s;\n" name
2401 pr "typedef struct guestfs_lvm_int_%s guestfs_lvm_int_%s_list<>;\n" typ typ;
2403 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2405 (* Stat internal structures. *)
2409 pr "struct guestfs_int_%s {\n" typ;
2411 | name, `Int -> pr " hyper %s;\n" name
2415 ) ["stat", stat_cols; "statvfs", statvfs_cols];
2418 fun (shortname, style, _, _, _, _, _) ->
2419 let name = "guestfs_" ^ shortname in
2421 (match snd style with
2424 pr "struct %s_args {\n" name;
2427 | String n -> pr " string %s<>;\n" n
2428 | OptString n -> pr " str *%s;\n" n
2429 | StringList n -> pr " str %s<>;\n" n
2430 | Bool n -> pr " bool %s;\n" n
2431 | Int n -> pr " int %s;\n" n
2432 | FileIn _ | FileOut _ -> ()
2436 (match fst style with
2439 pr "struct %s_ret {\n" name;
2443 pr "struct %s_ret {\n" name;
2444 pr " hyper %s;\n" n;
2447 pr "struct %s_ret {\n" name;
2451 failwithf "RConstString cannot be returned from a daemon function"
2453 pr "struct %s_ret {\n" name;
2454 pr " string %s<>;\n" n;
2457 pr "struct %s_ret {\n" name;
2458 pr " str %s<>;\n" n;
2461 pr "struct %s_ret {\n" name;
2466 pr "struct %s_ret {\n" name;
2467 pr " guestfs_lvm_int_pv_list %s;\n" n;
2470 pr "struct %s_ret {\n" name;
2471 pr " guestfs_lvm_int_vg_list %s;\n" n;
2474 pr "struct %s_ret {\n" name;
2475 pr " guestfs_lvm_int_lv_list %s;\n" n;
2478 pr "struct %s_ret {\n" name;
2479 pr " guestfs_int_stat %s;\n" n;
2482 pr "struct %s_ret {\n" name;
2483 pr " guestfs_int_statvfs %s;\n" n;
2486 pr "struct %s_ret {\n" name;
2487 pr " str %s<>;\n" n;
2492 (* Table of procedure numbers. *)
2493 pr "enum guestfs_procedure {\n";
2495 fun (shortname, _, proc_nr, _, _, _, _) ->
2496 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
2498 pr " GUESTFS_PROC_NR_PROCS\n";
2502 (* Having to choose a maximum message size is annoying for several
2503 * reasons (it limits what we can do in the API), but it (a) makes
2504 * the protocol a lot simpler, and (b) provides a bound on the size
2505 * of the daemon which operates in limited memory space. For large
2506 * file transfers you should use FTP.
2508 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
2511 (* Message header, etc. *)
2513 /* The communication protocol is now documented in the guestfs(3)
2517 const GUESTFS_PROGRAM = 0x2000F5F5;
2518 const GUESTFS_PROTOCOL_VERSION = 1;
2520 /* These constants must be larger than any possible message length. */
2521 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
2522 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
2524 enum guestfs_message_direction {
2525 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
2526 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
2529 enum guestfs_message_status {
2530 GUESTFS_STATUS_OK = 0,
2531 GUESTFS_STATUS_ERROR = 1
2534 const GUESTFS_ERROR_LEN = 256;
2536 struct guestfs_message_error {
2537 string error_message<GUESTFS_ERROR_LEN>;
2540 struct guestfs_message_header {
2541 unsigned prog; /* GUESTFS_PROGRAM */
2542 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
2543 guestfs_procedure proc; /* GUESTFS_PROC_x */
2544 guestfs_message_direction direction;
2545 unsigned serial; /* message serial number */
2546 guestfs_message_status status;
2549 const GUESTFS_MAX_CHUNK_SIZE = 8192;
2551 struct guestfs_chunk {
2552 int cancel; /* if non-zero, transfer is cancelled */
2553 /* data size is 0 bytes if the transfer has finished successfully */
2554 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
2558 (* Generate the guestfs-structs.h file. *)
2559 and generate_structs_h () =
2560 generate_header CStyle LGPLv2;
2562 (* This is a public exported header file containing various
2563 * structures. The structures are carefully written to have
2564 * exactly the same in-memory format as the XDR structures that
2565 * we use on the wire to the daemon. The reason for creating
2566 * copies of these structures here is just so we don't have to
2567 * export the whole of guestfs_protocol.h (which includes much
2568 * unrelated and XDR-dependent stuff that we don't want to be
2569 * public, or required by clients).
2571 * To reiterate, we will pass these structures to and from the
2572 * client with a simple assignment or memcpy, so the format
2573 * must be identical to what rpcgen / the RFC defines.
2576 (* guestfs_int_bool structure. *)
2577 pr "struct guestfs_int_bool {\n";
2583 (* LVM public structures. *)
2587 pr "struct guestfs_lvm_%s {\n" typ;
2590 | name, `String -> pr " char *%s;\n" name
2591 | name, `UUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
2592 | name, `Bytes -> pr " uint64_t %s;\n" name
2593 | name, `Int -> pr " int64_t %s;\n" name
2594 | name, `OptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
2598 pr "struct guestfs_lvm_%s_list {\n" typ;
2599 pr " uint32_t len;\n";
2600 pr " struct guestfs_lvm_%s *val;\n" typ;
2603 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2605 (* Stat structures. *)
2609 pr "struct guestfs_%s {\n" typ;
2612 | name, `Int -> pr " int64_t %s;\n" name
2616 ) ["stat", stat_cols; "statvfs", statvfs_cols]
2618 (* Generate the guestfs-actions.h file. *)
2619 and generate_actions_h () =
2620 generate_header CStyle LGPLv2;
2622 fun (shortname, style, _, _, _, _, _) ->
2623 let name = "guestfs_" ^ shortname in
2624 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
2628 (* Generate the client-side dispatch stubs. *)
2629 and generate_client_actions () =
2630 generate_header CStyle LGPLv2;
2636 #include \"guestfs.h\"
2637 #include \"guestfs_protocol.h\"
2639 #define error guestfs_error
2640 #define perrorf guestfs_perrorf
2641 #define safe_malloc guestfs_safe_malloc
2642 #define safe_realloc guestfs_safe_realloc
2643 #define safe_strdup guestfs_safe_strdup
2644 #define safe_memdup guestfs_safe_memdup
2646 /* Check the return message from a call for validity. */
2648 check_reply_header (guestfs_h *g,
2649 const struct guestfs_message_header *hdr,
2650 int proc_nr, int serial)
2652 if (hdr->prog != GUESTFS_PROGRAM) {
2653 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
2656 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
2657 error (g, \"wrong protocol version (%%d/%%d)\",
2658 hdr->vers, GUESTFS_PROTOCOL_VERSION);
2661 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
2662 error (g, \"unexpected message direction (%%d/%%d)\",
2663 hdr->direction, GUESTFS_DIRECTION_REPLY);
2666 if (hdr->proc != proc_nr) {
2667 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
2670 if (hdr->serial != serial) {
2671 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
2678 /* Check we are in the right state to run a high-level action. */
2680 check_state (guestfs_h *g, const char *caller)
2682 if (!guestfs_is_ready (g)) {
2683 if (guestfs_is_config (g))
2684 error (g, \"%%s: call launch() before using this function\",
2686 else if (guestfs_is_launching (g))
2687 error (g, \"%%s: call wait_ready() before using this function\",
2690 error (g, \"%%s called from the wrong state, %%d != READY\",
2691 caller, guestfs_get_state (g));
2699 (* Client-side stubs for each function. *)
2701 fun (shortname, style, _, _, _, _, _) ->
2702 let name = "guestfs_" ^ shortname in
2704 (* Generate the context struct which stores the high-level
2705 * state between callback functions.
2707 pr "struct %s_ctx {\n" shortname;
2708 pr " /* This flag is set by the callbacks, so we know we've done\n";
2709 pr " * the callbacks as expected, and in the right sequence.\n";
2710 pr " * 0 = not called, 1 = reply_cb called.\n";
2712 pr " int cb_sequence;\n";
2713 pr " struct guestfs_message_header hdr;\n";
2714 pr " struct guestfs_message_error err;\n";
2715 (match fst style with
2718 failwithf "RConstString cannot be returned from a daemon function"
2720 | RBool _ | RString _ | RStringList _
2722 | RPVList _ | RVGList _ | RLVList _
2723 | RStat _ | RStatVFS _
2725 pr " struct %s_ret ret;\n" name
2730 (* Generate the reply callback function. *)
2731 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
2733 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
2734 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
2736 pr " /* This should definitely not happen. */\n";
2737 pr " if (ctx->cb_sequence != 0) {\n";
2738 pr " ctx->cb_sequence = 9999;\n";
2739 pr " error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
2743 pr " ml->main_loop_quit (ml, g);\n";
2745 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
2746 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
2749 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
2750 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
2751 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
2758 (match fst style with
2761 failwithf "RConstString cannot be returned from a daemon function"
2763 | RBool _ | RString _ | RStringList _
2765 | RPVList _ | RVGList _ | RLVList _
2766 | RStat _ | RStatVFS _
2768 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
2769 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
2775 pr " ctx->cb_sequence = 1;\n";
2778 (* Generate the action stub. *)
2779 generate_prototype ~extern:false ~semicolon:false ~newline:true
2780 ~handle:"g" name style;
2783 match fst style with
2784 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
2786 failwithf "RConstString cannot be returned from a daemon function"
2787 | RString _ | RStringList _ | RIntBool _
2788 | RPVList _ | RVGList _ | RLVList _
2789 | RStat _ | RStatVFS _
2795 (match snd style with
2797 | _ -> pr " struct %s_args args;\n" name
2800 pr " struct %s_ctx ctx;\n" shortname;
2801 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
2802 pr " int serial;\n";
2804 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
2805 pr " guestfs_set_busy (g);\n";
2807 pr " memset (&ctx, 0, sizeof ctx);\n";
2810 (* Send the main header and arguments. *)
2811 (match snd style with
2813 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
2814 (String.uppercase shortname)
2819 pr " args.%s = (char *) %s;\n" n n
2821 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
2823 pr " args.%s.%s_val = (char **) %s;\n" n n n;
2824 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
2826 pr " args.%s = %s;\n" n n
2828 pr " args.%s = %s;\n" n n
2829 | FileIn _ | FileOut _ -> ()
2831 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
2832 (String.uppercase shortname);
2833 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
2836 pr " if (serial == -1) {\n";
2837 pr " guestfs_end_busy (g);\n";
2838 pr " return %s;\n" error_code;
2842 (* Send any additional files (FileIn) requested. *)
2843 let need_read_reply_label = ref false in
2850 pr " r = guestfs__send_file_sync (g, %s);\n" n;
2851 pr " if (r == -1) {\n";
2852 pr " guestfs_end_busy (g);\n";
2853 pr " return %s;\n" error_code;
2855 pr " if (r == -2) /* daemon cancelled */\n";
2856 pr " goto read_reply;\n";
2857 need_read_reply_label := true;
2863 (* Wait for the reply from the remote end. *)
2864 if !need_read_reply_label then pr " read_reply:\n";
2865 pr " guestfs__switch_to_receiving (g);\n";
2866 pr " ctx.cb_sequence = 0;\n";
2867 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
2868 pr " (void) ml->main_loop_run (ml, g);\n";
2869 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
2870 pr " if (ctx.cb_sequence != 1) {\n";
2871 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
2872 pr " guestfs_end_busy (g);\n";
2873 pr " return %s;\n" error_code;
2877 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
2878 (String.uppercase shortname);
2879 pr " guestfs_end_busy (g);\n";
2880 pr " return %s;\n" error_code;
2884 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
2885 pr " error (g, \"%%s\", ctx.err.error_message);\n";
2886 pr " free (ctx.err.error_message);\n";
2887 pr " guestfs_end_busy (g);\n";
2888 pr " return %s;\n" error_code;
2892 (* Expecting to receive further files (FileOut)? *)
2896 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
2897 pr " guestfs_end_busy (g);\n";
2898 pr " return %s;\n" error_code;
2904 pr " guestfs_end_busy (g);\n";
2906 (match fst style with
2907 | RErr -> pr " return 0;\n"
2908 | RInt n | RInt64 n | RBool n ->
2909 pr " return ctx.ret.%s;\n" n
2911 failwithf "RConstString cannot be returned from a daemon function"
2913 pr " return ctx.ret.%s; /* caller will free */\n" n
2914 | RStringList n | RHashtable n ->
2915 pr " /* caller will free this, but we need to add a NULL entry */\n";
2916 pr " ctx.ret.%s.%s_val =\n" n n;
2917 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
2918 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
2920 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
2921 pr " return ctx.ret.%s.%s_val;\n" n n
2923 pr " /* caller with free this */\n";
2924 pr " return safe_memdup (g, &ctx.ret, sizeof (ctx.ret));\n"
2925 | RPVList n | RVGList n | RLVList n
2926 | RStat n | RStatVFS n ->
2927 pr " /* caller will free this */\n";
2928 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
2934 (* Generate daemon/actions.h. *)
2935 and generate_daemon_actions_h () =
2936 generate_header CStyle GPLv2;
2938 pr "#include \"../src/guestfs_protocol.h\"\n";
2942 fun (name, style, _, _, _, _, _) ->
2944 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
2948 (* Generate the server-side stubs. *)
2949 and generate_daemon_actions () =
2950 generate_header CStyle GPLv2;
2952 pr "#include <config.h>\n";
2954 pr "#include <stdio.h>\n";
2955 pr "#include <stdlib.h>\n";
2956 pr "#include <string.h>\n";
2957 pr "#include <inttypes.h>\n";
2958 pr "#include <ctype.h>\n";
2959 pr "#include <rpc/types.h>\n";
2960 pr "#include <rpc/xdr.h>\n";
2962 pr "#include \"daemon.h\"\n";
2963 pr "#include \"../src/guestfs_protocol.h\"\n";
2964 pr "#include \"actions.h\"\n";
2968 fun (name, style, _, _, _, _, _) ->
2969 (* Generate server-side stubs. *)
2970 pr "static void %s_stub (XDR *xdr_in)\n" name;
2973 match fst style with
2974 | RErr | RInt _ -> pr " int r;\n"; "-1"
2975 | RInt64 _ -> pr " int64_t r;\n"; "-1"
2976 | RBool _ -> pr " int r;\n"; "-1"
2978 failwithf "RConstString cannot be returned from a daemon function"
2979 | RString _ -> pr " char *r;\n"; "NULL"
2980 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
2981 | RIntBool _ -> pr " guestfs_%s_ret *r;\n" name; "NULL"
2982 | RPVList _ -> pr " guestfs_lvm_int_pv_list *r;\n"; "NULL"
2983 | RVGList _ -> pr " guestfs_lvm_int_vg_list *r;\n"; "NULL"
2984 | RLVList _ -> pr " guestfs_lvm_int_lv_list *r;\n"; "NULL"
2985 | RStat _ -> pr " guestfs_int_stat *r;\n"; "NULL"
2986 | RStatVFS _ -> pr " guestfs_int_statvfs *r;\n"; "NULL" in
2988 (match snd style with
2991 pr " struct guestfs_%s_args args;\n" name;
2995 | OptString n -> pr " const char *%s;\n" n
2996 | StringList n -> pr " char **%s;\n" n
2997 | Bool n -> pr " int %s;\n" n
2998 | Int n -> pr " int %s;\n" n
2999 | FileIn _ | FileOut _ -> ()
3004 (match snd style with
3007 pr " memset (&args, 0, sizeof args);\n";
3009 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
3010 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
3015 | String n -> pr " %s = args.%s;\n" n n
3016 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
3018 pr " %s = realloc (args.%s.%s_val,\n" n n n;
3019 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
3020 pr " if (%s == NULL) {\n" n;
3021 pr " reply_with_perror (\"realloc\");\n";
3024 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
3025 pr " args.%s.%s_val = %s;\n" n n n;
3026 | Bool n -> pr " %s = args.%s;\n" n n
3027 | Int n -> pr " %s = args.%s;\n" n n
3028 | FileIn _ | FileOut _ -> ()
3033 (* Don't want to call the impl with any FileIn or FileOut
3034 * parameters, since these go "outside" the RPC protocol.
3037 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
3039 pr " r = do_%s " name;
3040 generate_call_args argsnofile;
3043 pr " if (r == %s)\n" error_code;
3044 pr " /* do_%s has already called reply_with_error */\n" name;
3048 (* If there are any FileOut parameters, then the impl must
3049 * send its own reply.
3052 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
3054 pr " /* do_%s has already sent a reply */\n" name
3056 match fst style with
3057 | RErr -> pr " reply (NULL, NULL);\n"
3058 | RInt n | RInt64 n | RBool n ->
3059 pr " struct guestfs_%s_ret ret;\n" name;
3060 pr " ret.%s = r;\n" n;
3061 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3064 failwithf "RConstString cannot be returned from a daemon function"
3066 pr " struct guestfs_%s_ret ret;\n" name;
3067 pr " ret.%s = r;\n" n;
3068 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3071 | RStringList n | RHashtable n ->
3072 pr " struct guestfs_%s_ret ret;\n" name;
3073 pr " ret.%s.%s_len = count_strings (r);\n" n n;
3074 pr " ret.%s.%s_val = r;\n" n n;
3075 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3077 pr " free_strings (r);\n"
3079 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n"
3081 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n" name
3082 | RPVList n | RVGList n | RLVList n
3083 | RStat n | RStatVFS n ->
3084 pr " struct guestfs_%s_ret ret;\n" name;
3085 pr " ret.%s = *r;\n" n;
3086 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
3088 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
3092 (* Free the args. *)
3093 (match snd style with
3098 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
3105 (* Dispatch function. *)
3106 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
3108 pr " switch (proc_nr) {\n";
3111 fun (name, style, _, _, _, _, _) ->
3112 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
3113 pr " %s_stub (xdr_in);\n" name;
3118 pr " reply_with_error (\"dispatch_incoming_message: unknown procedure number %%d\", proc_nr);\n";
3123 (* LVM columns and tokenization functions. *)
3124 (* XXX This generates crap code. We should rethink how we
3130 pr "static const char *lvm_%s_cols = \"%s\";\n"
3131 typ (String.concat "," (List.map fst cols));
3134 pr "static int lvm_tokenize_%s (char *str, struct guestfs_lvm_int_%s *r)\n" typ typ;
3136 pr " char *tok, *p, *next;\n";
3140 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
3143 pr " if (!str) {\n";
3144 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
3147 pr " if (!*str || isspace (*str)) {\n";
3148 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
3153 fun (name, coltype) ->
3154 pr " if (!tok) {\n";
3155 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
3158 pr " p = strchrnul (tok, ',');\n";
3159 pr " if (*p) next = p+1; else next = NULL;\n";
3160 pr " *p = '\\0';\n";
3163 pr " r->%s = strdup (tok);\n" name;
3164 pr " if (r->%s == NULL) {\n" name;
3165 pr " perror (\"strdup\");\n";
3169 pr " for (i = j = 0; i < 32; ++j) {\n";
3170 pr " if (tok[j] == '\\0') {\n";
3171 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
3173 pr " } else if (tok[j] != '-')\n";
3174 pr " r->%s[i++] = tok[j];\n" name;
3177 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
3178 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3182 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
3183 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3187 pr " if (tok[0] == '\\0')\n";
3188 pr " r->%s = -1;\n" name;
3189 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
3190 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3194 pr " tok = next;\n";
3197 pr " if (tok != NULL) {\n";
3198 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
3205 pr "guestfs_lvm_int_%s_list *\n" typ;
3206 pr "parse_command_line_%ss (void)\n" typ;
3208 pr " char *out, *err;\n";
3209 pr " char *p, *pend;\n";
3211 pr " guestfs_lvm_int_%s_list *ret;\n" typ;
3212 pr " void *newp;\n";
3214 pr " ret = malloc (sizeof *ret);\n";
3215 pr " if (!ret) {\n";
3216 pr " reply_with_perror (\"malloc\");\n";
3217 pr " return NULL;\n";
3220 pr " ret->guestfs_lvm_int_%s_list_len = 0;\n" typ;
3221 pr " ret->guestfs_lvm_int_%s_list_val = NULL;\n" typ;
3223 pr " r = command (&out, &err,\n";
3224 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
3225 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
3226 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
3227 pr " if (r == -1) {\n";
3228 pr " reply_with_error (\"%%s\", err);\n";
3229 pr " free (out);\n";
3230 pr " free (err);\n";
3231 pr " free (ret);\n";
3232 pr " return NULL;\n";
3235 pr " free (err);\n";
3237 pr " /* Tokenize each line of the output. */\n";
3240 pr " while (p) {\n";
3241 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
3242 pr " if (pend) {\n";
3243 pr " *pend = '\\0';\n";
3247 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
3250 pr " if (!*p) { /* Empty line? Skip it. */\n";
3255 pr " /* Allocate some space to store this next entry. */\n";
3256 pr " newp = realloc (ret->guestfs_lvm_int_%s_list_val,\n" typ;
3257 pr " sizeof (guestfs_lvm_int_%s) * (i+1));\n" typ;
3258 pr " if (newp == NULL) {\n";
3259 pr " reply_with_perror (\"realloc\");\n";
3260 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3261 pr " free (ret);\n";
3262 pr " free (out);\n";
3263 pr " return NULL;\n";
3265 pr " ret->guestfs_lvm_int_%s_list_val = newp;\n" typ;
3267 pr " /* Tokenize the next entry. */\n";
3268 pr " r = lvm_tokenize_%s (p, &ret->guestfs_lvm_int_%s_list_val[i]);\n" typ typ;
3269 pr " if (r == -1) {\n";
3270 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
3271 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3272 pr " free (ret);\n";
3273 pr " free (out);\n";
3274 pr " return NULL;\n";
3281 pr " ret->guestfs_lvm_int_%s_list_len = i;\n" typ;
3283 pr " free (out);\n";
3284 pr " return ret;\n";
3287 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
3289 (* Generate the tests. *)
3290 and generate_tests () =
3291 generate_header CStyle GPLv2;
3298 #include <sys/types.h>
3301 #include \"guestfs.h\"
3303 static guestfs_h *g;
3304 static int suppress_error = 0;
3306 /* This will be 's' or 'h' depending on whether the guest kernel
3307 * names IDE devices /dev/sd* or /dev/hd*.
3309 static char devchar = 's';
3311 static void print_error (guestfs_h *g, void *data, const char *msg)
3313 if (!suppress_error)
3314 fprintf (stderr, \"%%s\\n\", msg);
3317 static void print_strings (char * const * const argv)
3321 for (argc = 0; argv[argc] != NULL; ++argc)
3322 printf (\"\\t%%s\\n\", argv[argc]);
3326 static void print_table (char * const * const argv)
3330 for (i = 0; argv[i] != NULL; i += 2)
3331 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
3335 static void no_test_warnings (void)
3341 | name, _, _, _, [], _, _ ->
3342 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
3343 | name, _, _, _, tests, _, _ -> ()
3349 (* Generate the actual tests. Note that we generate the tests
3350 * in reverse order, deliberately, so that (in general) the
3351 * newest tests run first. This makes it quicker and easier to
3356 fun (name, _, _, _, tests, _, _) ->
3357 mapi (generate_one_test name) tests
3358 ) (List.rev all_functions) in
3359 let test_names = List.concat test_names in
3360 let nr_tests = List.length test_names in
3363 int main (int argc, char *argv[])
3368 const char *filename;
3370 int nr_tests, test_num = 0;
3373 no_test_warnings ();
3375 g = guestfs_create ();
3377 printf (\"guestfs_create FAILED\\n\");
3381 guestfs_set_error_handler (g, print_error, NULL);
3383 srcdir = getenv (\"srcdir\");
3384 if (!srcdir) srcdir = \".\";
3386 guestfs_set_path (g, \".\");
3388 filename = \"test1.img\";
3389 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3394 if (lseek (fd, %d, SEEK_SET) == -1) {
3400 if (write (fd, &c, 1) == -1) {
3406 if (close (fd) == -1) {
3411 if (guestfs_add_drive (g, filename) == -1) {
3412 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3416 filename = \"test2.img\";
3417 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3422 if (lseek (fd, %d, SEEK_SET) == -1) {
3428 if (write (fd, &c, 1) == -1) {
3434 if (close (fd) == -1) {
3439 if (guestfs_add_drive (g, filename) == -1) {
3440 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3444 filename = \"test3.img\";
3445 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3450 if (lseek (fd, %d, SEEK_SET) == -1) {
3456 if (write (fd, &c, 1) == -1) {
3462 if (close (fd) == -1) {
3467 if (guestfs_add_drive (g, filename) == -1) {
3468 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3472 if (guestfs_launch (g) == -1) {
3473 printf (\"guestfs_launch FAILED\\n\");
3476 if (guestfs_wait_ready (g) == -1) {
3477 printf (\"guestfs_wait_ready FAILED\\n\");
3481 /* Detect if the appliance uses /dev/sd* or /dev/hd* in device
3482 * names. This changed between RHEL 5 and RHEL 6 so we have to
3485 devs = guestfs_list_devices (g);
3486 if (devs == NULL || devs[0] == NULL) {
3487 printf (\"guestfs_list_devices FAILED\\n\");
3490 if (strncmp (devs[0], \"/dev/sd\", 7) == 0)
3492 else if (strncmp (devs[0], \"/dev/hd\", 7) == 0)
3495 printf (\"guestfs_list_devices returned unexpected string '%%s'\\n\",
3499 for (i = 0; devs[i] != NULL; ++i)
3505 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
3509 pr " test_num++;\n";
3510 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
3511 pr " if (%s () == -1) {\n" test_name;
3512 pr " printf (\"%s FAILED\\n\");\n" test_name;
3518 pr " guestfs_close (g);\n";
3519 pr " unlink (\"test1.img\");\n";
3520 pr " unlink (\"test2.img\");\n";
3521 pr " unlink (\"test3.img\");\n";
3524 pr " if (failed > 0) {\n";
3525 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
3533 and generate_one_test name i (init, test) =
3534 let test_name = sprintf "test_%s_%d" name i in
3536 pr "static int %s (void)\n" test_name;
3542 pr " /* InitEmpty for %s (%d) */\n" name i;
3543 List.iter (generate_test_command_call test_name)
3544 [["blockdev_setrw"; "/dev/sda"];
3548 pr " /* InitBasicFS for %s (%d): create ext2 on /dev/sda1 */\n" name i;
3549 List.iter (generate_test_command_call test_name)
3550 [["blockdev_setrw"; "/dev/sda"];
3553 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
3554 ["mkfs"; "ext2"; "/dev/sda1"];
3555 ["mount"; "/dev/sda1"; "/"]]
3556 | InitBasicFSonLVM ->
3557 pr " /* InitBasicFSonLVM for %s (%d): create ext2 on /dev/VG/LV */\n"
3559 List.iter (generate_test_command_call test_name)
3560 [["blockdev_setrw"; "/dev/sda"];
3563 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
3564 ["pvcreate"; "/dev/sda1"];
3565 ["vgcreate"; "VG"; "/dev/sda1"];
3566 ["lvcreate"; "LV"; "VG"; "8"];
3567 ["mkfs"; "ext2"; "/dev/VG/LV"];
3568 ["mount"; "/dev/VG/LV"; "/"]]
3571 let get_seq_last = function
3573 failwithf "%s: you cannot use [] (empty list) when expecting a command"
3576 let seq = List.rev seq in
3577 List.rev (List.tl seq), List.hd seq
3582 pr " /* TestRun for %s (%d) */\n" name i;
3583 List.iter (generate_test_command_call test_name) seq
3584 | TestOutput (seq, expected) ->
3585 pr " /* TestOutput for %s (%d) */\n" name i;
3586 pr " char expected[] = \"%s\";\n" (c_quote expected);
3587 if String.length expected > 7 &&
3588 String.sub expected 0 7 = "/dev/sd" then
3589 pr " expected[5] = devchar;\n";
3590 let seq, last = get_seq_last seq in
3592 pr " if (strcmp (r, expected) != 0) {\n";
3593 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
3597 List.iter (generate_test_command_call test_name) seq;
3598 generate_test_command_call ~test test_name last
3599 | TestOutputList (seq, expected) ->
3600 pr " /* TestOutputList for %s (%d) */\n" name i;
3601 let seq, last = get_seq_last seq in
3605 pr " if (!r[%d]) {\n" i;
3606 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
3607 pr " print_strings (r);\n";
3611 pr " char expected[] = \"%s\";\n" (c_quote str);
3612 if String.length str > 7 && String.sub str 0 7 = "/dev/sd" then
3613 pr " expected[5] = devchar;\n";
3614 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
3615 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
3620 pr " if (r[%d] != NULL) {\n" (List.length expected);
3621 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
3623 pr " print_strings (r);\n";
3627 List.iter (generate_test_command_call test_name) seq;
3628 generate_test_command_call ~test test_name last
3629 | TestOutputInt (seq, expected) ->
3630 pr " /* TestOutputInt for %s (%d) */\n" name i;
3631 let seq, last = get_seq_last seq in
3633 pr " if (r != %d) {\n" expected;
3634 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
3640 List.iter (generate_test_command_call test_name) seq;
3641 generate_test_command_call ~test test_name last
3642 | TestOutputTrue seq ->
3643 pr " /* TestOutputTrue for %s (%d) */\n" name i;
3644 let seq, last = get_seq_last seq in
3647 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
3652 List.iter (generate_test_command_call test_name) seq;
3653 generate_test_command_call ~test test_name last
3654 | TestOutputFalse seq ->
3655 pr " /* TestOutputFalse for %s (%d) */\n" name i;
3656 let seq, last = get_seq_last seq in
3659 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
3664 List.iter (generate_test_command_call test_name) seq;
3665 generate_test_command_call ~test test_name last
3666 | TestOutputLength (seq, expected) ->
3667 pr " /* TestOutputLength for %s (%d) */\n" name i;
3668 let seq, last = get_seq_last seq in
3671 pr " for (j = 0; j < %d; ++j)\n" expected;
3672 pr " if (r[j] == NULL) {\n";
3673 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
3675 pr " print_strings (r);\n";
3678 pr " if (r[j] != NULL) {\n";
3679 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
3681 pr " print_strings (r);\n";
3685 List.iter (generate_test_command_call test_name) seq;
3686 generate_test_command_call ~test test_name last
3687 | TestOutputStruct (seq, checks) ->
3688 pr " /* TestOutputStruct for %s (%d) */\n" name i;
3689 let seq, last = get_seq_last seq in
3693 | CompareWithInt (field, expected) ->
3694 pr " if (r->%s != %d) {\n" field expected;
3695 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
3696 test_name field expected;
3697 pr " (int) r->%s);\n" field;
3700 | CompareWithString (field, expected) ->
3701 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
3702 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
3703 test_name field expected;
3704 pr " r->%s);\n" field;
3707 | CompareFieldsIntEq (field1, field2) ->
3708 pr " if (r->%s != r->%s) {\n" field1 field2;
3709 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
3710 test_name field1 field2;
3711 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
3714 | CompareFieldsStrEq (field1, field2) ->
3715 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
3716 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
3717 test_name field1 field2;
3718 pr " r->%s, r->%s);\n" field1 field2;
3723 List.iter (generate_test_command_call test_name) seq;
3724 generate_test_command_call ~test test_name last
3725 | TestLastFail seq ->
3726 pr " /* TestLastFail for %s (%d) */\n" name i;
3727 let seq, last = get_seq_last seq in
3728 List.iter (generate_test_command_call test_name) seq;
3729 generate_test_command_call test_name ~expect_error:true last
3737 (* Generate the code to run a command, leaving the result in 'r'.
3738 * If you expect to get an error then you should set expect_error:true.
3740 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
3742 | [] -> assert false
3744 (* Look up the command to find out what args/ret it has. *)
3747 let _, style, _, _, _, _, _ =
3748 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
3751 failwithf "%s: in test, command %s was not found" test_name name in
3753 if List.length (snd style) <> List.length args then
3754 failwithf "%s: in test, wrong number of args given to %s"
3761 | OptString n, "NULL" -> ()
3763 | OptString n, arg ->
3764 pr " char %s[] = \"%s\";\n" n (c_quote arg);
3765 if String.length arg > 7 && String.sub arg 0 7 = "/dev/sd" then
3766 pr " %s[5] = devchar;\n" n
3769 | FileIn _, _ | FileOut _, _ -> ()
3770 | StringList n, arg ->
3771 let strs = string_split " " arg in
3774 pr " char %s_%d[] = \"%s\";\n" n i (c_quote str);
3775 if String.length str > 7 && String.sub str 0 7 = "/dev/sd" then
3776 pr " %s_%d[5] = devchar;\n" n i
3778 pr " char *%s[] = {\n" n;
3780 fun i _ -> pr " %s_%d,\n" n i
3784 ) (List.combine (snd style) args);
3787 match fst style with
3788 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
3789 | RInt64 _ -> pr " int64_t r;\n"; "-1"
3790 | RConstString _ -> pr " const char *r;\n"; "NULL"
3791 | RString _ -> pr " char *r;\n"; "NULL"
3792 | RStringList _ | RHashtable _ ->
3797 pr " struct guestfs_int_bool *r;\n"; "NULL"
3799 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
3801 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
3803 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
3805 pr " struct guestfs_stat *r;\n"; "NULL"
3807 pr " struct guestfs_statvfs *r;\n"; "NULL" in
3809 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
3810 pr " r = guestfs_%s (g" name;
3812 (* Generate the parameters. *)
3815 | OptString _, "NULL" -> pr ", NULL"
3819 | FileIn _, arg | FileOut _, arg ->
3820 pr ", \"%s\"" (c_quote arg)
3821 | StringList n, _ ->
3825 try int_of_string arg
3826 with Failure "int_of_string" ->
3827 failwithf "%s: expecting an int, but got '%s'" test_name arg in
3830 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
3831 ) (List.combine (snd style) args);
3834 if not expect_error then
3835 pr " if (r == %s)\n" error_code
3837 pr " if (r != %s)\n" error_code;
3840 (* Insert the test code. *)
3846 (match fst style with
3847 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _ -> ()
3848 | RString _ -> pr " free (r);\n"
3849 | RStringList _ | RHashtable _ ->
3850 pr " for (i = 0; r[i] != NULL; ++i)\n";
3851 pr " free (r[i]);\n";
3854 pr " guestfs_free_int_bool (r);\n"
3856 pr " guestfs_free_lvm_pv_list (r);\n"
3858 pr " guestfs_free_lvm_vg_list (r);\n"
3860 pr " guestfs_free_lvm_lv_list (r);\n"
3861 | RStat _ | RStatVFS _ ->
3868 let str = replace_str str "\r" "\\r" in
3869 let str = replace_str str "\n" "\\n" in
3870 let str = replace_str str "\t" "\\t" in
3871 let str = replace_str str "\000" "\\0" in
3874 (* Generate a lot of different functions for guestfish. *)
3875 and generate_fish_cmds () =
3876 generate_header CStyle GPLv2;
3880 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3882 let all_functions_sorted =
3884 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3885 ) all_functions_sorted in
3887 pr "#include <stdio.h>\n";
3888 pr "#include <stdlib.h>\n";
3889 pr "#include <string.h>\n";
3890 pr "#include <inttypes.h>\n";
3892 pr "#include <guestfs.h>\n";
3893 pr "#include \"fish.h\"\n";
3896 (* list_commands function, which implements guestfish -h *)
3897 pr "void list_commands (void)\n";
3899 pr " printf (\" %%-16s %%s\\n\", \"Command\", \"Description\");\n";
3900 pr " list_builtin_commands ();\n";
3902 fun (name, _, _, flags, _, shortdesc, _) ->
3903 let name = replace_char name '_' '-' in
3904 pr " printf (\"%%-20s %%s\\n\", \"%s\", \"%s\");\n"
3906 ) all_functions_sorted;
3907 pr " printf (\" Use -h <cmd> / help <cmd> to show detailed help for a command.\\n\");\n";
3911 (* display_command function, which implements guestfish -h cmd *)
3912 pr "void display_command (const char *cmd)\n";
3915 fun (name, style, _, flags, _, shortdesc, longdesc) ->
3916 let name2 = replace_char name '_' '-' in
3918 try find_map (function FishAlias n -> Some n | _ -> None) flags
3919 with Not_found -> name in
3920 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
3922 match snd style with
3926 name2 (String.concat "> <" (List.map name_of_argt args)) in
3929 if List.mem ProtocolLimitWarning flags then
3930 ("\n\n" ^ protocol_limit_warning)
3933 (* For DangerWillRobinson commands, we should probably have
3934 * guestfish prompt before allowing you to use them (especially
3935 * in interactive mode). XXX
3939 if List.mem DangerWillRobinson flags then
3940 ("\n\n" ^ danger_will_robinson)
3943 let describe_alias =
3944 if name <> alias then
3945 sprintf "\n\nYou can use '%s' as an alias for this command." alias
3949 pr "strcasecmp (cmd, \"%s\") == 0" name;
3950 if name <> name2 then
3951 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
3952 if name <> alias then
3953 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
3955 pr " pod2text (\"%s - %s\", %S);\n"
3957 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
3960 pr " display_builtin_command (cmd);\n";
3964 (* print_{pv,vg,lv}_list functions *)
3968 pr "static void print_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
3975 pr " printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
3977 pr " printf (\"%s: \");\n" name;
3978 pr " for (i = 0; i < 32; ++i)\n";
3979 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
3980 pr " printf (\"\\n\");\n"
3982 pr " printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
3984 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
3985 | name, `OptPercent ->
3986 pr " if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
3987 typ name name typ name;
3988 pr " else printf (\"%s: \\n\");\n" name
3992 pr "static void print_%s_list (struct guestfs_lvm_%s_list *%ss)\n"
3997 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
3998 pr " print_%s (&%ss->val[i]);\n" typ typ;
4001 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
4003 (* print_{stat,statvfs} functions *)
4007 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
4012 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
4016 ) ["stat", stat_cols; "statvfs", statvfs_cols];
4018 (* run_<action> actions *)
4020 fun (name, style, _, flags, _, _, _) ->
4021 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
4023 (match fst style with
4026 | RBool _ -> pr " int r;\n"
4027 | RInt64 _ -> pr " int64_t r;\n"
4028 | RConstString _ -> pr " const char *r;\n"
4029 | RString _ -> pr " char *r;\n"
4030 | RStringList _ | RHashtable _ -> pr " char **r;\n"
4031 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"
4032 | RPVList _ -> pr " struct guestfs_lvm_pv_list *r;\n"
4033 | RVGList _ -> pr " struct guestfs_lvm_vg_list *r;\n"
4034 | RLVList _ -> pr " struct guestfs_lvm_lv_list *r;\n"
4035 | RStat _ -> pr " struct guestfs_stat *r;\n"
4036 | RStatVFS _ -> pr " struct guestfs_statvfs *r;\n"
4043 | FileOut n -> pr " const char *%s;\n" n
4044 | StringList n -> pr " char **%s;\n" n
4045 | Bool n -> pr " int %s;\n" n
4046 | Int n -> pr " int %s;\n" n
4049 (* Check and convert parameters. *)
4050 let argc_expected = List.length (snd style) in
4051 pr " if (argc != %d) {\n" argc_expected;
4052 pr " fprintf (stderr, \"%%s should have %d parameter(s)\\n\", cmd);\n"
4054 pr " fprintf (stderr, \"type 'help %%s' for help on %%s\\n\", cmd, cmd);\n";
4060 | String name -> pr " %s = argv[%d];\n" name i
4062 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
4065 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
4068 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
4070 | StringList name ->
4071 pr " %s = parse_string_list (argv[%d]);\n" name i
4073 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
4075 pr " %s = atoi (argv[%d]);\n" name i
4078 (* Call C API function. *)
4080 try find_map (function FishAction n -> Some n | _ -> None) flags
4081 with Not_found -> sprintf "guestfs_%s" name in
4083 generate_call_args ~handle:"g" (snd style);
4086 (* Check return value for errors and display command results. *)
4087 (match fst style with
4088 | RErr -> pr " return r;\n"
4090 pr " if (r == -1) return -1;\n";
4091 pr " printf (\"%%d\\n\", r);\n";
4094 pr " if (r == -1) return -1;\n";
4095 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
4098 pr " if (r == -1) return -1;\n";
4099 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
4102 pr " if (r == NULL) return -1;\n";
4103 pr " printf (\"%%s\\n\", r);\n";
4106 pr " if (r == NULL) return -1;\n";
4107 pr " printf (\"%%s\\n\", r);\n";
4111 pr " if (r == NULL) return -1;\n";
4112 pr " print_strings (r);\n";
4113 pr " free_strings (r);\n";
4116 pr " if (r == NULL) return -1;\n";
4117 pr " printf (\"%%d, %%s\\n\", r->i,\n";
4118 pr " r->b ? \"true\" : \"false\");\n";
4119 pr " guestfs_free_int_bool (r);\n";
4122 pr " if (r == NULL) return -1;\n";
4123 pr " print_pv_list (r);\n";
4124 pr " guestfs_free_lvm_pv_list (r);\n";
4127 pr " if (r == NULL) return -1;\n";
4128 pr " print_vg_list (r);\n";
4129 pr " guestfs_free_lvm_vg_list (r);\n";
4132 pr " if (r == NULL) return -1;\n";
4133 pr " print_lv_list (r);\n";
4134 pr " guestfs_free_lvm_lv_list (r);\n";
4137 pr " if (r == NULL) return -1;\n";
4138 pr " print_stat (r);\n";
4142 pr " if (r == NULL) return -1;\n";
4143 pr " print_statvfs (r);\n";
4147 pr " if (r == NULL) return -1;\n";
4148 pr " print_table (r);\n";
4149 pr " free_strings (r);\n";
4156 (* run_action function *)
4157 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
4160 fun (name, _, _, flags, _, _, _) ->
4161 let name2 = replace_char name '_' '-' in
4163 try find_map (function FishAlias n -> Some n | _ -> None) flags
4164 with Not_found -> name in
4166 pr "strcasecmp (cmd, \"%s\") == 0" name;
4167 if name <> name2 then
4168 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
4169 if name <> alias then
4170 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
4172 pr " return run_%s (cmd, argc, argv);\n" name;
4176 pr " fprintf (stderr, \"%%s: unknown command\\n\", cmd);\n";
4183 (* Readline completion for guestfish. *)
4184 and generate_fish_completion () =
4185 generate_header CStyle GPLv2;
4189 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4199 #ifdef HAVE_LIBREADLINE
4200 #include <readline/readline.h>
4205 #ifdef HAVE_LIBREADLINE
4207 static const char *const commands[] = {
4210 (* Get the commands and sort them, including the aliases. *)
4213 fun (name, _, _, flags, _, _, _) ->
4214 let name2 = replace_char name '_' '-' in
4216 try find_map (function FishAlias n -> Some n | _ -> None) flags
4217 with Not_found -> name in
4219 if name <> alias then [name2; alias] else [name2]
4221 let commands = List.flatten commands in
4222 let commands = List.sort compare commands in
4224 List.iter (pr " \"%s\",\n") commands;
4230 generator (const char *text, int state)
4232 static int index, len;
4237 len = strlen (text);
4240 while ((name = commands[index]) != NULL) {
4242 if (strncasecmp (name, text, len) == 0)
4243 return strdup (name);
4249 #endif /* HAVE_LIBREADLINE */
4251 char **do_completion (const char *text, int start, int end)
4253 char **matches = NULL;
4255 #ifdef HAVE_LIBREADLINE
4257 matches = rl_completion_matches (text, generator);
4264 (* Generate the POD documentation for guestfish. *)
4265 and generate_fish_actions_pod () =
4266 let all_functions_sorted =
4268 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4269 ) all_functions_sorted in
4271 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
4274 fun (name, style, _, flags, _, _, longdesc) ->
4276 Str.global_substitute rex (
4279 try Str.matched_group 1 s
4281 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
4282 "C<" ^ replace_char sub '_' '-' ^ ">"
4284 let name = replace_char name '_' '-' in
4286 try find_map (function FishAlias n -> Some n | _ -> None) flags
4287 with Not_found -> name in
4289 pr "=head2 %s" name;
4290 if name <> alias then
4297 | String n -> pr " %s" n
4298 | OptString n -> pr " %s" n
4299 | StringList n -> pr " '%s ...'" n
4300 | Bool _ -> pr " true|false"
4301 | Int n -> pr " %s" n
4302 | FileIn n | FileOut n -> pr " (%s|-)" n
4306 pr "%s\n\n" longdesc;
4308 if List.exists (function FileIn _ | FileOut _ -> true
4309 | _ -> false) (snd style) then
4310 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
4312 if List.mem ProtocolLimitWarning flags then
4313 pr "%s\n\n" protocol_limit_warning;
4315 if List.mem DangerWillRobinson flags then
4316 pr "%s\n\n" danger_will_robinson
4317 ) all_functions_sorted
4319 (* Generate a C function prototype. *)
4320 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
4321 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
4323 ?handle name style =
4324 if extern then pr "extern ";
4325 if static then pr "static ";
4326 (match fst style with
4328 | RInt _ -> pr "int "
4329 | RInt64 _ -> pr "int64_t "
4330 | RBool _ -> pr "int "
4331 | RConstString _ -> pr "const char *"
4332 | RString _ -> pr "char *"
4333 | RStringList _ | RHashtable _ -> pr "char **"
4335 if not in_daemon then pr "struct guestfs_int_bool *"
4336 else pr "guestfs_%s_ret *" name
4338 if not in_daemon then pr "struct guestfs_lvm_pv_list *"
4339 else pr "guestfs_lvm_int_pv_list *"
4341 if not in_daemon then pr "struct guestfs_lvm_vg_list *"
4342 else pr "guestfs_lvm_int_vg_list *"
4344 if not in_daemon then pr "struct guestfs_lvm_lv_list *"
4345 else pr "guestfs_lvm_int_lv_list *"
4347 if not in_daemon then pr "struct guestfs_stat *"
4348 else pr "guestfs_int_stat *"
4350 if not in_daemon then pr "struct guestfs_statvfs *"
4351 else pr "guestfs_int_statvfs *"
4353 pr "%s%s (" prefix name;
4354 if handle = None && List.length (snd style) = 0 then
4357 let comma = ref false in
4360 | Some handle -> pr "guestfs_h *%s" handle; comma := true
4364 if single_line then pr ", " else pr ",\n\t\t"
4371 | OptString n -> next (); pr "const char *%s" n
4372 | StringList n -> next (); pr "char * const* const %s" n
4373 | Bool n -> next (); pr "int %s" n
4374 | Int n -> next (); pr "int %s" n
4377 if not in_daemon then (next (); pr "const char *%s" n)
4381 if semicolon then pr ";";
4382 if newline then pr "\n"
4384 (* Generate C call arguments, eg "(handle, foo, bar)" *)
4385 and generate_call_args ?handle args =
4387 let comma = ref false in
4390 | Some handle -> pr "%s" handle; comma := true
4394 if !comma then pr ", ";
4396 pr "%s" (name_of_argt arg)
4400 (* Generate the OCaml bindings interface. *)
4401 and generate_ocaml_mli () =
4402 generate_header OCamlStyle LGPLv2;
4405 (** For API documentation you should refer to the C API
4406 in the guestfs(3) manual page. The OCaml API uses almost
4407 exactly the same calls. *)
4410 (** A [guestfs_h] handle. *)
4412 exception Error of string
4413 (** This exception is raised when there is an error. *)
4415 val create : unit -> t
4417 val close : t -> unit
4418 (** Handles are closed by the garbage collector when they become
4419 unreferenced, but callers can also call this in order to
4420 provide predictable cleanup. *)
4423 generate_ocaml_lvm_structure_decls ();
4425 generate_ocaml_stat_structure_decls ();
4429 fun (name, style, _, _, _, shortdesc, _) ->
4430 generate_ocaml_prototype name style;
4431 pr "(** %s *)\n" shortdesc;
4435 (* Generate the OCaml bindings implementation. *)
4436 and generate_ocaml_ml () =
4437 generate_header OCamlStyle LGPLv2;
4441 exception Error of string
4442 external create : unit -> t = \"ocaml_guestfs_create\"
4443 external close : t -> unit = \"ocaml_guestfs_close\"
4446 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
4450 generate_ocaml_lvm_structure_decls ();
4452 generate_ocaml_stat_structure_decls ();
4456 fun (name, style, _, _, _, shortdesc, _) ->
4457 generate_ocaml_prototype ~is_external:true name style;
4460 (* Generate the OCaml bindings C implementation. *)
4461 and generate_ocaml_c () =
4462 generate_header CStyle LGPLv2;
4469 #include <caml/config.h>
4470 #include <caml/alloc.h>
4471 #include <caml/callback.h>
4472 #include <caml/fail.h>
4473 #include <caml/memory.h>
4474 #include <caml/mlvalues.h>
4475 #include <caml/signals.h>
4477 #include <guestfs.h>
4479 #include \"guestfs_c.h\"
4481 /* Copy a hashtable of string pairs into an assoc-list. We return
4482 * the list in reverse order, but hashtables aren't supposed to be
4485 static CAMLprim value
4486 copy_table (char * const * argv)
4489 CAMLlocal5 (rv, pairv, kv, vv, cons);
4493 for (i = 0; argv[i] != NULL; i += 2) {
4494 kv = caml_copy_string (argv[i]);
4495 vv = caml_copy_string (argv[i+1]);
4496 pairv = caml_alloc (2, 0);
4497 Store_field (pairv, 0, kv);
4498 Store_field (pairv, 1, vv);
4499 cons = caml_alloc (2, 0);
4500 Store_field (cons, 1, rv);
4502 Store_field (cons, 0, pairv);
4510 (* LVM struct copy functions. *)
4513 let has_optpercent_col =
4514 List.exists (function (_, `OptPercent) -> true | _ -> false) cols in
4516 pr "static CAMLprim value\n";
4517 pr "copy_lvm_%s (const struct guestfs_lvm_%s *%s)\n" typ typ typ;
4519 pr " CAMLparam0 ();\n";
4520 if has_optpercent_col then
4521 pr " CAMLlocal3 (rv, v, v2);\n"
4523 pr " CAMLlocal2 (rv, v);\n";
4525 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
4530 pr " v = caml_copy_string (%s->%s);\n" typ name
4532 pr " v = caml_alloc_string (32);\n";
4533 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
4536 pr " v = caml_copy_int64 (%s->%s);\n" typ name
4537 | name, `OptPercent ->
4538 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
4539 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
4540 pr " v = caml_alloc (1, 0);\n";
4541 pr " Store_field (v, 0, v2);\n";
4542 pr " } else /* None */\n";
4543 pr " v = Val_int (0);\n";
4545 pr " Store_field (rv, %d, v);\n" i
4547 pr " CAMLreturn (rv);\n";
4551 pr "static CAMLprim value\n";
4552 pr "copy_lvm_%s_list (const struct guestfs_lvm_%s_list *%ss)\n"
4555 pr " CAMLparam0 ();\n";
4556 pr " CAMLlocal2 (rv, v);\n";
4559 pr " if (%ss->len == 0)\n" typ;
4560 pr " CAMLreturn (Atom (0));\n";
4562 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
4563 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
4564 pr " v = copy_lvm_%s (&%ss->val[i]);\n" typ typ;
4565 pr " caml_modify (&Field (rv, i), v);\n";
4567 pr " CAMLreturn (rv);\n";
4571 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
4573 (* Stat copy functions. *)
4576 pr "static CAMLprim value\n";
4577 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
4579 pr " CAMLparam0 ();\n";
4580 pr " CAMLlocal2 (rv, v);\n";
4582 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
4587 pr " v = caml_copy_int64 (%s->%s);\n" typ name
4589 pr " Store_field (rv, %d, v);\n" i
4591 pr " CAMLreturn (rv);\n";
4594 ) ["stat", stat_cols; "statvfs", statvfs_cols];
4598 fun (name, style, _, _, _, _, _) ->
4600 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
4602 pr "CAMLprim value\n";
4603 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
4604 List.iter (pr ", value %s") (List.tl params);
4609 | [p1; p2; p3; p4; p5] ->
4610 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
4611 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
4612 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
4613 pr " CAMLxparam%d (%s);\n"
4614 (List.length rest) (String.concat ", " rest)
4616 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
4618 pr " CAMLlocal1 (rv);\n";
4621 pr " guestfs_h *g = Guestfs_val (gv);\n";
4622 pr " if (g == NULL)\n";
4623 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
4631 pr " const char *%s = String_val (%sv);\n" n n
4633 pr " const char *%s =\n" n;
4634 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
4637 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
4639 pr " int %s = Bool_val (%sv);\n" n n
4641 pr " int %s = Int_val (%sv);\n" n n
4644 match fst style with
4645 | RErr -> pr " int r;\n"; "-1"
4646 | RInt _ -> pr " int r;\n"; "-1"
4647 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4648 | RBool _ -> pr " int r;\n"; "-1"
4649 | RConstString _ -> pr " const char *r;\n"; "NULL"
4650 | RString _ -> pr " char *r;\n"; "NULL"
4656 pr " struct guestfs_int_bool *r;\n"; "NULL"
4658 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
4660 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
4662 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
4664 pr " struct guestfs_stat *r;\n"; "NULL"
4666 pr " struct guestfs_statvfs *r;\n"; "NULL"
4673 pr " caml_enter_blocking_section ();\n";
4674 pr " r = guestfs_%s " name;
4675 generate_call_args ~handle:"g" (snd style);
4677 pr " caml_leave_blocking_section ();\n";
4682 pr " ocaml_guestfs_free_strings (%s);\n" n;
4683 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
4686 pr " if (r == %s)\n" error_code;
4687 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
4690 (match fst style with
4691 | RErr -> pr " rv = Val_unit;\n"
4692 | RInt _ -> pr " rv = Val_int (r);\n"
4694 pr " rv = caml_copy_int64 (r);\n"
4695 | RBool _ -> pr " rv = Val_bool (r);\n"
4696 | RConstString _ -> pr " rv = caml_copy_string (r);\n"
4698 pr " rv = caml_copy_string (r);\n";
4701 pr " rv = caml_copy_string_array ((const char **) r);\n";
4702 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
4705 pr " rv = caml_alloc (2, 0);\n";
4706 pr " Store_field (rv, 0, Val_int (r->i));\n";
4707 pr " Store_field (rv, 1, Val_bool (r->b));\n";
4708 pr " guestfs_free_int_bool (r);\n";
4710 pr " rv = copy_lvm_pv_list (r);\n";
4711 pr " guestfs_free_lvm_pv_list (r);\n";
4713 pr " rv = copy_lvm_vg_list (r);\n";
4714 pr " guestfs_free_lvm_vg_list (r);\n";
4716 pr " rv = copy_lvm_lv_list (r);\n";
4717 pr " guestfs_free_lvm_lv_list (r);\n";
4719 pr " rv = copy_stat (r);\n";
4722 pr " rv = copy_statvfs (r);\n";
4725 pr " rv = copy_table (r);\n";
4726 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
4730 pr " CAMLreturn (rv);\n";
4734 if List.length params > 5 then (
4735 pr "CAMLprim value\n";
4736 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
4738 pr " return ocaml_guestfs_%s (argv[0]" name;
4739 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
4746 and generate_ocaml_lvm_structure_decls () =
4749 pr "type lvm_%s = {\n" typ;
4752 | name, `String -> pr " %s : string;\n" name
4753 | name, `UUID -> pr " %s : string;\n" name
4754 | name, `Bytes -> pr " %s : int64;\n" name
4755 | name, `Int -> pr " %s : int64;\n" name
4756 | name, `OptPercent -> pr " %s : float option;\n" name
4760 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
4762 and generate_ocaml_stat_structure_decls () =
4765 pr "type %s = {\n" typ;
4768 | name, `Int -> pr " %s : int64;\n" name
4772 ) ["stat", stat_cols; "statvfs", statvfs_cols]
4774 and generate_ocaml_prototype ?(is_external = false) name style =
4775 if is_external then pr "external " else pr "val ";
4776 pr "%s : t -> " name;
4779 | String _ | FileIn _ | FileOut _ -> pr "string -> "
4780 | OptString _ -> pr "string option -> "
4781 | StringList _ -> pr "string array -> "
4782 | Bool _ -> pr "bool -> "
4783 | Int _ -> pr "int -> "
4785 (match fst style with
4786 | RErr -> pr "unit" (* all errors are turned into exceptions *)
4787 | RInt _ -> pr "int"
4788 | RInt64 _ -> pr "int64"
4789 | RBool _ -> pr "bool"
4790 | RConstString _ -> pr "string"
4791 | RString _ -> pr "string"
4792 | RStringList _ -> pr "string array"
4793 | RIntBool _ -> pr "int * bool"
4794 | RPVList _ -> pr "lvm_pv array"
4795 | RVGList _ -> pr "lvm_vg array"
4796 | RLVList _ -> pr "lvm_lv array"
4797 | RStat _ -> pr "stat"
4798 | RStatVFS _ -> pr "statvfs"
4799 | RHashtable _ -> pr "(string * string) list"
4801 if is_external then (
4803 if List.length (snd style) + 1 > 5 then
4804 pr "\"ocaml_guestfs_%s_byte\" " name;
4805 pr "\"ocaml_guestfs_%s\"" name
4809 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
4810 and generate_perl_xs () =
4811 generate_header CStyle LGPLv2;
4814 #include \"EXTERN.h\"
4818 #include <guestfs.h>
4821 #define PRId64 \"lld\"
4825 my_newSVll(long long val) {
4826 #ifdef USE_64_BIT_ALL
4827 return newSViv(val);
4831 len = snprintf(buf, 100, \"%%\" PRId64, val);
4832 return newSVpv(buf, len);
4837 #define PRIu64 \"llu\"
4841 my_newSVull(unsigned long long val) {
4842 #ifdef USE_64_BIT_ALL
4843 return newSVuv(val);
4847 len = snprintf(buf, 100, \"%%\" PRIu64, val);
4848 return newSVpv(buf, len);
4852 /* http://www.perlmonks.org/?node_id=680842 */
4854 XS_unpack_charPtrPtr (SV *arg) {
4859 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
4860 croak (\"array reference expected\");
4862 av = (AV *)SvRV (arg);
4863 ret = malloc (av_len (av) + 1 + 1);
4865 croak (\"malloc failed\");
4867 for (i = 0; i <= av_len (av); i++) {
4868 SV **elem = av_fetch (av, i, 0);
4870 if (!elem || !*elem)
4871 croak (\"missing element in list\");
4873 ret[i] = SvPV_nolen (*elem);
4881 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
4888 RETVAL = guestfs_create ();
4890 croak (\"could not create guestfs handle\");
4891 guestfs_set_error_handler (RETVAL, NULL, NULL);
4904 fun (name, style, _, _, _, _, _) ->
4905 (match fst style with
4906 | RErr -> pr "void\n"
4907 | RInt _ -> pr "SV *\n"
4908 | RInt64 _ -> pr "SV *\n"
4909 | RBool _ -> pr "SV *\n"
4910 | RConstString _ -> pr "SV *\n"
4911 | RString _ -> pr "SV *\n"
4914 | RPVList _ | RVGList _ | RLVList _
4915 | RStat _ | RStatVFS _
4917 pr "void\n" (* all lists returned implictly on the stack *)
4919 (* Call and arguments. *)
4921 generate_call_args ~handle:"g" (snd style);
4923 pr " guestfs_h *g;\n";
4926 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
4927 | OptString n -> pr " char *%s;\n" n
4928 | StringList n -> pr " char **%s;\n" n
4929 | Bool n -> pr " int %s;\n" n
4930 | Int n -> pr " int %s;\n" n
4933 let do_cleanups () =
4936 | String _ | OptString _ | Bool _ | Int _
4937 | FileIn _ | FileOut _ -> ()
4938 | StringList n -> pr " free (%s);\n" n
4943 (match fst style with
4948 pr " r = guestfs_%s " name;
4949 generate_call_args ~handle:"g" (snd style);
4952 pr " if (r == -1)\n";
4953 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4959 pr " %s = guestfs_%s " n name;
4960 generate_call_args ~handle:"g" (snd style);
4963 pr " if (%s == -1)\n" n;
4964 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4965 pr " RETVAL = newSViv (%s);\n" n;
4970 pr " int64_t %s;\n" n;
4972 pr " %s = guestfs_%s " n name;
4973 generate_call_args ~handle:"g" (snd style);
4976 pr " if (%s == -1)\n" n;
4977 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4978 pr " RETVAL = my_newSVll (%s);\n" n;
4983 pr " const char *%s;\n" n;
4985 pr " %s = guestfs_%s " n name;
4986 generate_call_args ~handle:"g" (snd style);
4989 pr " if (%s == NULL)\n" n;
4990 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4991 pr " RETVAL = newSVpv (%s, 0);\n" n;
4996 pr " char *%s;\n" n;
4998 pr " %s = guestfs_%s " n name;
4999 generate_call_args ~handle:"g" (snd style);
5002 pr " if (%s == NULL)\n" n;
5003 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5004 pr " RETVAL = newSVpv (%s, 0);\n" n;
5005 pr " free (%s);\n" n;
5008 | RStringList n | RHashtable n ->
5010 pr " char **%s;\n" n;
5013 pr " %s = guestfs_%s " n name;
5014 generate_call_args ~handle:"g" (snd style);
5017 pr " if (%s == NULL)\n" n;
5018 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5019 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
5020 pr " EXTEND (SP, n);\n";
5021 pr " for (i = 0; i < n; ++i) {\n";
5022 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
5023 pr " free (%s[i]);\n" n;
5025 pr " free (%s);\n" n;
5028 pr " struct guestfs_int_bool *r;\n";
5030 pr " r = guestfs_%s " name;
5031 generate_call_args ~handle:"g" (snd style);
5034 pr " if (r == NULL)\n";
5035 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5036 pr " EXTEND (SP, 2);\n";
5037 pr " PUSHs (sv_2mortal (newSViv (r->i)));\n";
5038 pr " PUSHs (sv_2mortal (newSViv (r->b)));\n";
5039 pr " guestfs_free_int_bool (r);\n";
5041 generate_perl_lvm_code "pv" pv_cols name style n do_cleanups
5043 generate_perl_lvm_code "vg" vg_cols name style n do_cleanups
5045 generate_perl_lvm_code "lv" lv_cols name style n do_cleanups
5047 generate_perl_stat_code "stat" stat_cols name style n do_cleanups
5049 generate_perl_stat_code
5050 "statvfs" statvfs_cols name style n do_cleanups
5056 and generate_perl_lvm_code typ cols name style n do_cleanups =
5058 pr " struct guestfs_lvm_%s_list *%s;\n" typ n;
5062 pr " %s = guestfs_%s " n name;
5063 generate_call_args ~handle:"g" (snd style);
5066 pr " if (%s == NULL)\n" n;
5067 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5068 pr " EXTEND (SP, %s->len);\n" n;
5069 pr " for (i = 0; i < %s->len; ++i) {\n" n;
5070 pr " hv = newHV ();\n";
5074 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
5075 name (String.length name) n name
5077 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
5078 name (String.length name) n name
5080 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
5081 name (String.length name) n name
5083 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
5084 name (String.length name) n name
5085 | name, `OptPercent ->
5086 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
5087 name (String.length name) n name
5089 pr " PUSHs (sv_2mortal ((SV *) hv));\n";
5091 pr " guestfs_free_lvm_%s_list (%s);\n" typ n
5093 and generate_perl_stat_code typ cols name style n do_cleanups =
5095 pr " struct guestfs_%s *%s;\n" typ n;
5097 pr " %s = guestfs_%s " n name;
5098 generate_call_args ~handle:"g" (snd style);
5101 pr " if (%s == NULL)\n" n;
5102 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5103 pr " EXTEND (SP, %d);\n" (List.length cols);
5107 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n" n name
5109 pr " free (%s);\n" n
5111 (* Generate Sys/Guestfs.pm. *)
5112 and generate_perl_pm () =
5113 generate_header HashStyle LGPLv2;
5120 Sys::Guestfs - Perl bindings for libguestfs
5126 my $h = Sys::Guestfs->new ();
5127 $h->add_drive ('guest.img');
5130 $h->mount ('/dev/sda1', '/');
5131 $h->touch ('/hello');
5136 The C<Sys::Guestfs> module provides a Perl XS binding to the
5137 libguestfs API for examining and modifying virtual machine
5140 Amongst the things this is good for: making batch configuration
5141 changes to guests, getting disk used/free statistics (see also:
5142 virt-df), migrating between virtualization systems (see also:
5143 virt-p2v), performing partial backups, performing partial guest
5144 clones, cloning guests and changing registry/UUID/hostname info, and
5147 Libguestfs uses Linux kernel and qemu code, and can access any type of
5148 guest filesystem that Linux and qemu can, including but not limited
5149 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
5150 schemes, qcow, qcow2, vmdk.
5152 Libguestfs provides ways to enumerate guest storage (eg. partitions,
5153 LVs, what filesystem is in each LV, etc.). It can also run commands
5154 in the context of the guest. Also you can access filesystems over FTP.
5158 All errors turn into calls to C<croak> (see L<Carp(3)>).
5166 package Sys::Guestfs;
5172 XSLoader::load ('Sys::Guestfs');
5174 =item $h = Sys::Guestfs->new ();
5176 Create a new guestfs handle.
5182 my $class = ref ($proto) || $proto;
5184 my $self = Sys::Guestfs::_create ();
5185 bless $self, $class;
5191 (* Actions. We only need to print documentation for these as
5192 * they are pulled in from the XS code automatically.
5195 fun (name, style, _, flags, _, _, longdesc) ->
5196 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
5198 generate_perl_prototype name style;
5200 pr "%s\n\n" longdesc;
5201 if List.mem ProtocolLimitWarning flags then
5202 pr "%s\n\n" protocol_limit_warning;
5203 if List.mem DangerWillRobinson flags then
5204 pr "%s\n\n" danger_will_robinson
5205 ) all_functions_sorted;
5217 Copyright (C) 2009 Red Hat Inc.
5221 Please see the file COPYING.LIB for the full license.
5225 L<guestfs(3)>, L<guestfish(1)>.
5230 and generate_perl_prototype name style =
5231 (match fst style with
5237 | RString n -> pr "$%s = " n
5238 | RIntBool (n, m) -> pr "($%s, $%s) = " n m
5242 | RLVList n -> pr "@%s = " n
5245 | RHashtable n -> pr "%%%s = " n
5248 let comma = ref false in
5251 if !comma then pr ", ";
5254 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
5261 (* Generate Python C module. *)
5262 and generate_python_c () =
5263 generate_header CStyle LGPLv2;
5272 #include \"guestfs.h\"
5280 get_handle (PyObject *obj)
5283 assert (obj != Py_None);
5284 return ((Pyguestfs_Object *) obj)->g;
5288 put_handle (guestfs_h *g)
5292 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
5295 /* This list should be freed (but not the strings) after use. */
5296 static const char **
5297 get_string_list (PyObject *obj)
5304 if (!PyList_Check (obj)) {
5305 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
5309 len = PyList_Size (obj);
5310 r = malloc (sizeof (char *) * (len+1));
5312 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
5316 for (i = 0; i < len; ++i)
5317 r[i] = PyString_AsString (PyList_GetItem (obj, i));
5324 put_string_list (char * const * const argv)
5329 for (argc = 0; argv[argc] != NULL; ++argc)
5332 list = PyList_New (argc);
5333 for (i = 0; i < argc; ++i)
5334 PyList_SetItem (list, i, PyString_FromString (argv[i]));
5340 put_table (char * const * const argv)
5342 PyObject *list, *item;
5345 for (argc = 0; argv[argc] != NULL; ++argc)
5348 list = PyList_New (argc >> 1);
5349 for (i = 0; i < argc; i += 2) {
5350 item = PyTuple_New (2);
5351 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
5352 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
5353 PyList_SetItem (list, i >> 1, item);
5360 free_strings (char **argv)
5364 for (argc = 0; argv[argc] != NULL; ++argc)
5370 py_guestfs_create (PyObject *self, PyObject *args)
5374 g = guestfs_create ();
5376 PyErr_SetString (PyExc_RuntimeError,
5377 \"guestfs.create: failed to allocate handle\");
5380 guestfs_set_error_handler (g, NULL, NULL);
5381 return put_handle (g);
5385 py_guestfs_close (PyObject *self, PyObject *args)
5390 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
5392 g = get_handle (py_g);
5396 Py_INCREF (Py_None);
5402 (* LVM structures, turned into Python dictionaries. *)
5405 pr "static PyObject *\n";
5406 pr "put_lvm_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
5408 pr " PyObject *dict;\n";
5410 pr " dict = PyDict_New ();\n";
5414 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5415 pr " PyString_FromString (%s->%s));\n"
5418 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5419 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
5422 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5423 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
5426 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5427 pr " PyLong_FromLongLong (%s->%s));\n"
5429 | name, `OptPercent ->
5430 pr " if (%s->%s >= 0)\n" typ name;
5431 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5432 pr " PyFloat_FromDouble ((double) %s->%s));\n"
5435 pr " Py_INCREF (Py_None);\n";
5436 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
5439 pr " return dict;\n";
5443 pr "static PyObject *\n";
5444 pr "put_lvm_%s_list (struct guestfs_lvm_%s_list *%ss)\n" typ typ typ;
5446 pr " PyObject *list;\n";
5449 pr " list = PyList_New (%ss->len);\n" typ;
5450 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
5451 pr " PyList_SetItem (list, i, put_lvm_%s (&%ss->val[i]));\n" typ typ;
5452 pr " return list;\n";
5455 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
5457 (* Stat structures, turned into Python dictionaries. *)
5460 pr "static PyObject *\n";
5461 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
5463 pr " PyObject *dict;\n";
5465 pr " dict = PyDict_New ();\n";
5469 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5470 pr " PyLong_FromLongLong (%s->%s));\n"
5473 pr " return dict;\n";
5476 ) ["stat", stat_cols; "statvfs", statvfs_cols];
5478 (* Python wrapper functions. *)
5480 fun (name, style, _, _, _, _, _) ->
5481 pr "static PyObject *\n";
5482 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
5485 pr " PyObject *py_g;\n";
5486 pr " guestfs_h *g;\n";
5487 pr " PyObject *py_r;\n";
5490 match fst style with
5491 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5492 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5493 | RConstString _ -> pr " const char *r;\n"; "NULL"
5494 | RString _ -> pr " char *r;\n"; "NULL"
5495 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5496 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
5497 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5498 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5499 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5500 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
5501 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
5505 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
5506 | OptString n -> pr " const char *%s;\n" n
5508 pr " PyObject *py_%s;\n" n;
5509 pr " const char **%s;\n" n
5510 | Bool n -> pr " int %s;\n" n
5511 | Int n -> pr " int %s;\n" n
5516 (* Convert the parameters. *)
5517 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
5520 | String _ | FileIn _ | FileOut _ -> pr "s"
5521 | OptString _ -> pr "z"
5522 | StringList _ -> pr "O"
5523 | Bool _ -> pr "i" (* XXX Python has booleans? *)
5526 pr ":guestfs_%s\",\n" name;
5530 | String n | FileIn n | FileOut n -> pr ", &%s" n
5531 | OptString n -> pr ", &%s" n
5532 | StringList n -> pr ", &py_%s" n
5533 | Bool n -> pr ", &%s" n
5534 | Int n -> pr ", &%s" n
5538 pr " return NULL;\n";
5540 pr " g = get_handle (py_g);\n";
5543 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5545 pr " %s = get_string_list (py_%s);\n" n n;
5546 pr " if (!%s) return NULL;\n" n
5551 pr " r = guestfs_%s " name;
5552 generate_call_args ~handle:"g" (snd style);
5557 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5559 pr " free (%s);\n" n
5562 pr " if (r == %s) {\n" error_code;
5563 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
5564 pr " return NULL;\n";
5568 (match fst style with
5570 pr " Py_INCREF (Py_None);\n";
5571 pr " py_r = Py_None;\n"
5573 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
5574 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
5575 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
5577 pr " py_r = PyString_FromString (r);\n";
5580 pr " py_r = put_string_list (r);\n";
5581 pr " free_strings (r);\n"
5583 pr " py_r = PyTuple_New (2);\n";
5584 pr " PyTuple_SetItem (py_r, 0, PyInt_FromLong ((long) r->i));\n";
5585 pr " PyTuple_SetItem (py_r, 1, PyInt_FromLong ((long) r->b));\n";
5586 pr " guestfs_free_int_bool (r);\n"
5588 pr " py_r = put_lvm_pv_list (r);\n";
5589 pr " guestfs_free_lvm_pv_list (r);\n"
5591 pr " py_r = put_lvm_vg_list (r);\n";
5592 pr " guestfs_free_lvm_vg_list (r);\n"
5594 pr " py_r = put_lvm_lv_list (r);\n";
5595 pr " guestfs_free_lvm_lv_list (r);\n"
5597 pr " py_r = put_stat (r);\n";
5600 pr " py_r = put_statvfs (r);\n";
5603 pr " py_r = put_table (r);\n";
5604 pr " free_strings (r);\n"
5607 pr " return py_r;\n";
5612 (* Table of functions. *)
5613 pr "static PyMethodDef methods[] = {\n";
5614 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
5615 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
5617 fun (name, _, _, _, _, _, _) ->
5618 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
5621 pr " { NULL, NULL, 0, NULL }\n";
5625 (* Init function. *)
5628 initlibguestfsmod (void)
5630 static int initialized = 0;
5632 if (initialized) return;
5633 Py_InitModule ((char *) \"libguestfsmod\", methods);
5638 (* Generate Python module. *)
5639 and generate_python_py () =
5640 generate_header HashStyle LGPLv2;
5643 u\"\"\"Python bindings for libguestfs
5646 g = guestfs.GuestFS ()
5647 g.add_drive (\"guest.img\")
5650 parts = g.list_partitions ()
5652 The guestfs module provides a Python binding to the libguestfs API
5653 for examining and modifying virtual machine disk images.
5655 Amongst the things this is good for: making batch configuration
5656 changes to guests, getting disk used/free statistics (see also:
5657 virt-df), migrating between virtualization systems (see also:
5658 virt-p2v), performing partial backups, performing partial guest
5659 clones, cloning guests and changing registry/UUID/hostname info, and
5662 Libguestfs uses Linux kernel and qemu code, and can access any type of
5663 guest filesystem that Linux and qemu can, including but not limited
5664 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
5665 schemes, qcow, qcow2, vmdk.
5667 Libguestfs provides ways to enumerate guest storage (eg. partitions,
5668 LVs, what filesystem is in each LV, etc.). It can also run commands
5669 in the context of the guest. Also you can access filesystems over FTP.
5671 Errors which happen while using the API are turned into Python
5672 RuntimeError exceptions.
5674 To create a guestfs handle you usually have to perform the following
5677 # Create the handle, call add_drive at least once, and possibly
5678 # several times if the guest has multiple block devices:
5679 g = guestfs.GuestFS ()
5680 g.add_drive (\"guest.img\")
5682 # Launch the qemu subprocess and wait for it to become ready:
5686 # Now you can issue commands, for example:
5691 import libguestfsmod
5694 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
5696 def __init__ (self):
5697 \"\"\"Create a new libguestfs handle.\"\"\"
5698 self._o = libguestfsmod.create ()
5701 libguestfsmod.close (self._o)
5706 fun (name, style, _, flags, _, _, longdesc) ->
5707 let doc = replace_str longdesc "C<guestfs_" "C<g." in
5709 match fst style with
5710 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _
5713 doc ^ "\n\nThis function returns a list of strings."
5715 doc ^ "\n\nThis function returns a tuple (int, bool).\n"
5717 doc ^ "\n\nThis function returns a list of PVs. Each PV is represented as a dictionary."
5719 doc ^ "\n\nThis function returns a list of VGs. Each VG is represented as a dictionary."
5721 doc ^ "\n\nThis function returns a list of LVs. Each LV is represented as a dictionary."
5723 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the stat structure."
5725 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the statvfs structure."
5727 doc ^ "\n\nThis function returns a dictionary." in
5729 if List.mem ProtocolLimitWarning flags then
5730 doc ^ "\n\n" ^ protocol_limit_warning
5733 if List.mem DangerWillRobinson flags then
5734 doc ^ "\n\n" ^ danger_will_robinson
5736 let doc = pod2text ~width:60 name doc in
5737 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
5738 let doc = String.concat "\n " doc in
5741 generate_call_args ~handle:"self" (snd style);
5743 pr " u\"\"\"%s\"\"\"\n" doc;
5744 pr " return libguestfsmod.%s " name;
5745 generate_call_args ~handle:"self._o" (snd style);
5750 (* Useful if you need the longdesc POD text as plain text. Returns a
5753 * This is the slowest thing about autogeneration.
5755 and pod2text ~width name longdesc =
5756 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
5757 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
5759 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
5760 let chan = Unix.open_process_in cmd in
5761 let lines = ref [] in
5763 let line = input_line chan in
5764 if i = 1 then (* discard the first line of output *)
5767 let line = triml line in
5768 lines := line :: !lines;
5771 let lines = try loop 1 with End_of_file -> List.rev !lines in
5772 Unix.unlink filename;
5773 match Unix.close_process_in chan with
5774 | Unix.WEXITED 0 -> lines
5776 failwithf "pod2text: process exited with non-zero status (%d)" i
5777 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
5778 failwithf "pod2text: process signalled or stopped by signal %d" i
5780 (* Generate ruby bindings. *)
5781 and generate_ruby_c () =
5782 generate_header CStyle LGPLv2;
5790 #include \"guestfs.h\"
5792 #include \"extconf.h\"
5794 /* For Ruby < 1.9 */
5796 #define RARRAY_LEN(r) (RARRAY((r))->len)
5799 static VALUE m_guestfs; /* guestfs module */
5800 static VALUE c_guestfs; /* guestfs_h handle */
5801 static VALUE e_Error; /* used for all errors */
5803 static void ruby_guestfs_free (void *p)
5806 guestfs_close ((guestfs_h *) p);
5809 static VALUE ruby_guestfs_create (VALUE m)
5813 g = guestfs_create ();
5815 rb_raise (e_Error, \"failed to create guestfs handle\");
5817 /* Don't print error messages to stderr by default. */
5818 guestfs_set_error_handler (g, NULL, NULL);
5820 /* Wrap it, and make sure the close function is called when the
5823 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
5826 static VALUE ruby_guestfs_close (VALUE gv)
5829 Data_Get_Struct (gv, guestfs_h, g);
5831 ruby_guestfs_free (g);
5832 DATA_PTR (gv) = NULL;
5840 fun (name, style, _, _, _, _, _) ->
5841 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
5842 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
5845 pr " guestfs_h *g;\n";
5846 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
5848 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
5854 | String n | FileIn n | FileOut n ->
5855 pr " const char *%s = StringValueCStr (%sv);\n" n n;
5857 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
5858 pr " \"%s\", \"%s\");\n" n name
5860 pr " const char *%s = StringValueCStr (%sv);\n" n n
5864 pr " int i, len;\n";
5865 pr " len = RARRAY_LEN (%sv);\n" n;
5866 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
5868 pr " for (i = 0; i < len; ++i) {\n";
5869 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
5870 pr " %s[i] = StringValueCStr (v);\n" n;
5872 pr " %s[len] = NULL;\n" n;
5876 pr " int %s = NUM2INT (%sv);\n" n n
5881 match fst style with
5882 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5883 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5884 | RConstString _ -> pr " const char *r;\n"; "NULL"
5885 | RString _ -> pr " char *r;\n"; "NULL"
5886 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5887 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
5888 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5889 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5890 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5891 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
5892 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
5895 pr " r = guestfs_%s " name;
5896 generate_call_args ~handle:"g" (snd style);
5901 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5903 pr " free (%s);\n" n
5906 pr " if (r == %s)\n" error_code;
5907 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
5910 (match fst style with
5912 pr " return Qnil;\n"
5913 | RInt _ | RBool _ ->
5914 pr " return INT2NUM (r);\n"
5916 pr " return ULL2NUM (r);\n"
5918 pr " return rb_str_new2 (r);\n";
5920 pr " VALUE rv = rb_str_new2 (r);\n";
5924 pr " int i, len = 0;\n";
5925 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
5926 pr " VALUE rv = rb_ary_new2 (len);\n";
5927 pr " for (i = 0; r[i] != NULL; ++i) {\n";
5928 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
5929 pr " free (r[i]);\n";
5934 pr " VALUE rv = rb_ary_new2 (2);\n";
5935 pr " rb_ary_push (rv, INT2NUM (r->i));\n";
5936 pr " rb_ary_push (rv, INT2NUM (r->b));\n";
5937 pr " guestfs_free_int_bool (r);\n";
5940 generate_ruby_lvm_code "pv" pv_cols
5942 generate_ruby_lvm_code "vg" vg_cols
5944 generate_ruby_lvm_code "lv" lv_cols
5946 pr " VALUE rv = rb_hash_new ();\n";
5950 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
5955 pr " VALUE rv = rb_hash_new ();\n";
5959 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
5964 pr " VALUE rv = rb_hash_new ();\n";
5966 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
5967 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
5968 pr " free (r[i]);\n";
5969 pr " free (r[i+1]);\n";
5980 /* Initialize the module. */
5981 void Init__guestfs ()
5983 m_guestfs = rb_define_module (\"Guestfs\");
5984 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
5985 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
5987 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
5988 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
5991 (* Define the rest of the methods. *)
5993 fun (name, style, _, _, _, _, _) ->
5994 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
5995 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
6000 (* Ruby code to return an LVM struct list. *)
6001 and generate_ruby_lvm_code typ cols =
6002 pr " VALUE rv = rb_ary_new2 (r->len);\n";
6004 pr " for (i = 0; i < r->len; ++i) {\n";
6005 pr " VALUE hv = rb_hash_new ();\n";
6009 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
6011 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
6014 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
6015 | name, `OptPercent ->
6016 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
6018 pr " rb_ary_push (rv, hv);\n";
6020 pr " guestfs_free_lvm_%s_list (r);\n" typ;
6023 (* Generate Java bindings GuestFS.java file. *)
6024 and generate_java_java () =
6025 generate_header CStyle LGPLv2;
6028 package com.redhat.et.libguestfs;
6030 import java.util.HashMap;
6031 import com.redhat.et.libguestfs.LibGuestFSException;
6032 import com.redhat.et.libguestfs.PV;
6033 import com.redhat.et.libguestfs.VG;
6034 import com.redhat.et.libguestfs.LV;
6035 import com.redhat.et.libguestfs.Stat;
6036 import com.redhat.et.libguestfs.StatVFS;
6037 import com.redhat.et.libguestfs.IntBool;
6040 * The GuestFS object is a libguestfs handle.
6044 public class GuestFS {
6045 // Load the native code.
6047 System.loadLibrary (\"guestfs_jni\");
6051 * The native guestfs_h pointer.
6056 * Create a libguestfs handle.
6058 * @throws LibGuestFSException
6060 public GuestFS () throws LibGuestFSException
6064 private native long _create () throws LibGuestFSException;
6067 * Close a libguestfs handle.
6069 * You can also leave handles to be collected by the garbage
6070 * collector, but this method ensures that the resources used
6071 * by the handle are freed up immediately. If you call any
6072 * other methods after closing the handle, you will get an
6075 * @throws LibGuestFSException
6077 public void close () throws LibGuestFSException
6083 private native void _close (long g) throws LibGuestFSException;
6085 public void finalize () throws LibGuestFSException
6093 fun (name, style, _, flags, _, shortdesc, longdesc) ->
6094 let doc = replace_str longdesc "C<guestfs_" "C<g." in
6096 if List.mem ProtocolLimitWarning flags then
6097 doc ^ "\n\n" ^ protocol_limit_warning
6100 if List.mem DangerWillRobinson flags then
6101 doc ^ "\n\n" ^ danger_will_robinson
6103 let doc = pod2text ~width:60 name doc in
6104 let doc = String.concat "\n * " doc in
6107 pr " * %s\n" shortdesc;
6110 pr " * @throws LibGuestFSException\n";
6113 generate_java_prototype ~public:true ~semicolon:false name style;
6116 pr " if (g == 0)\n";
6117 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
6120 if fst style <> RErr then pr "return ";
6122 generate_call_args ~handle:"g" (snd style);
6126 generate_java_prototype ~privat:true ~native:true name style;
6133 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
6134 ?(semicolon=true) name style =
6135 if privat then pr "private ";
6136 if public then pr "public ";
6137 if native then pr "native ";
6140 (match fst style with
6141 | RErr -> pr "void ";
6142 | RInt _ -> pr "int ";
6143 | RInt64 _ -> pr "long ";
6144 | RBool _ -> pr "boolean ";
6145 | RConstString _ | RString _ -> pr "String ";
6146 | RStringList _ -> pr "String[] ";
6147 | RIntBool _ -> pr "IntBool ";
6148 | RPVList _ -> pr "PV[] ";
6149 | RVGList _ -> pr "VG[] ";
6150 | RLVList _ -> pr "LV[] ";
6151 | RStat _ -> pr "Stat ";
6152 | RStatVFS _ -> pr "StatVFS ";
6153 | RHashtable _ -> pr "HashMap<String,String> ";
6156 if native then pr "_%s " name else pr "%s " name;
6158 let needs_comma = ref false in
6167 if !needs_comma then pr ", ";
6168 needs_comma := true;
6185 pr " throws LibGuestFSException";
6186 if semicolon then pr ";"
6188 and generate_java_struct typ cols =
6189 generate_header CStyle LGPLv2;
6192 package com.redhat.et.libguestfs;
6195 * Libguestfs %s structure.
6206 | name, `UUID -> pr " public String %s;\n" name
6208 | name, `Int -> pr " public long %s;\n" name
6209 | name, `OptPercent ->
6210 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
6211 pr " public float %s;\n" name
6216 and generate_java_c () =
6217 generate_header CStyle LGPLv2;
6224 #include \"com_redhat_et_libguestfs_GuestFS.h\"
6225 #include \"guestfs.h\"
6227 /* Note that this function returns. The exception is not thrown
6228 * until after the wrapper function returns.
6231 throw_exception (JNIEnv *env, const char *msg)
6234 cl = (*env)->FindClass (env,
6235 \"com/redhat/et/libguestfs/LibGuestFSException\");
6236 (*env)->ThrowNew (env, cl, msg);
6239 JNIEXPORT jlong JNICALL
6240 Java_com_redhat_et_libguestfs_GuestFS__1create
6241 (JNIEnv *env, jobject obj)
6245 g = guestfs_create ();
6247 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
6250 guestfs_set_error_handler (g, NULL, NULL);
6251 return (jlong) (long) g;
6254 JNIEXPORT void JNICALL
6255 Java_com_redhat_et_libguestfs_GuestFS__1close
6256 (JNIEnv *env, jobject obj, jlong jg)
6258 guestfs_h *g = (guestfs_h *) (long) jg;
6265 fun (name, style, _, _, _, _, _) ->
6267 (match fst style with
6268 | RErr -> pr "void ";
6269 | RInt _ -> pr "jint ";
6270 | RInt64 _ -> pr "jlong ";
6271 | RBool _ -> pr "jboolean ";
6272 | RConstString _ | RString _ -> pr "jstring ";
6273 | RIntBool _ | RStat _ | RStatVFS _ | RHashtable _ ->
6275 | RStringList _ | RPVList _ | RVGList _ | RLVList _ ->
6279 pr "Java_com_redhat_et_libguestfs_GuestFS_";
6280 pr "%s" (replace_str ("_" ^ name) "_" "_1");
6282 pr " (JNIEnv *env, jobject obj, jlong jg";
6289 pr ", jstring j%s" n
6291 pr ", jobjectArray j%s" n
6293 pr ", jboolean j%s" n
6299 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
6300 let error_code, no_ret =
6301 match fst style with
6302 | RErr -> pr " int r;\n"; "-1", ""
6304 | RInt _ -> pr " int r;\n"; "-1", "0"
6305 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
6306 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
6308 pr " jstring jr;\n";
6309 pr " char *r;\n"; "NULL", "NULL"
6311 pr " jobjectArray jr;\n";
6314 pr " jstring jstr;\n";
6315 pr " char **r;\n"; "NULL", "NULL"
6317 pr " jobject jr;\n";
6319 pr " jfieldID fl;\n";
6320 pr " struct guestfs_int_bool *r;\n"; "NULL", "NULL"
6322 pr " jobject jr;\n";
6324 pr " jfieldID fl;\n";
6325 pr " struct guestfs_stat *r;\n"; "NULL", "NULL"
6327 pr " jobject jr;\n";
6329 pr " jfieldID fl;\n";
6330 pr " struct guestfs_statvfs *r;\n"; "NULL", "NULL"
6332 pr " jobjectArray jr;\n";
6334 pr " jfieldID fl;\n";
6335 pr " jobject jfl;\n";
6336 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL", "NULL"
6338 pr " jobjectArray jr;\n";
6340 pr " jfieldID fl;\n";
6341 pr " jobject jfl;\n";
6342 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL", "NULL"
6344 pr " jobjectArray jr;\n";
6346 pr " jfieldID fl;\n";
6347 pr " jobject jfl;\n";
6348 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL", "NULL"
6349 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL" in
6356 pr " const char *%s;\n" n
6358 pr " int %s_len;\n" n;
6359 pr " const char **%s;\n" n
6366 (match fst style with
6367 | RStringList _ | RPVList _ | RVGList _ | RLVList _ -> true
6368 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
6369 | RString _ | RIntBool _ | RStat _ | RStatVFS _
6370 | RHashtable _ -> false) ||
6371 List.exists (function StringList _ -> true | _ -> false) (snd style) in
6377 (* Get the parameters. *)
6384 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
6386 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
6387 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
6388 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6389 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6391 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
6393 pr " %s[%s_len] = NULL;\n" n n;
6396 pr " %s = j%s;\n" n n
6399 (* Make the call. *)
6400 pr " r = guestfs_%s " name;
6401 generate_call_args ~handle:"g" (snd style);
6404 (* Release the parameters. *)
6411 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
6413 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6414 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6416 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
6418 pr " free (%s);\n" n
6423 (* Check for errors. *)
6424 pr " if (r == %s) {\n" error_code;
6425 pr " throw_exception (env, guestfs_last_error (g));\n";
6426 pr " return %s;\n" no_ret;
6430 (match fst style with
6432 | RInt _ -> pr " return (jint) r;\n"
6433 | RBool _ -> pr " return (jboolean) r;\n"
6434 | RInt64 _ -> pr " return (jlong) r;\n"
6435 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
6437 pr " jr = (*env)->NewStringUTF (env, r);\n";
6441 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
6442 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
6443 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
6444 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
6445 pr " for (i = 0; i < r_len; ++i) {\n";
6446 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
6447 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
6448 pr " free (r[i]);\n";
6453 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/IntBool\");\n";
6454 pr " jr = (*env)->AllocObject (env, cl);\n";
6455 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"I\");\n";
6456 pr " (*env)->SetIntField (env, jr, fl, r->i);\n";
6457 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"Z\");\n";
6458 pr " (*env)->SetBooleanField (env, jr, fl, r->b);\n";
6459 pr " guestfs_free_int_bool (r);\n";
6462 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/Stat\");\n";
6463 pr " jr = (*env)->AllocObject (env, cl);\n";
6467 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
6469 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
6474 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/StatVFS\");\n";
6475 pr " jr = (*env)->AllocObject (env, cl);\n";
6479 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
6481 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
6486 generate_java_lvm_return "pv" "PV" pv_cols
6488 generate_java_lvm_return "vg" "VG" vg_cols
6490 generate_java_lvm_return "lv" "LV" lv_cols
6493 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
6494 pr " return NULL;\n"
6501 and generate_java_lvm_return typ jtyp cols =
6502 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
6503 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
6504 pr " for (i = 0; i < r->len; ++i) {\n";
6505 pr " jfl = (*env)->AllocObject (env, cl);\n";
6509 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
6510 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
6513 pr " char s[33];\n";
6514 pr " memcpy (s, r->val[i].%s, 32);\n" name;
6516 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
6517 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
6519 | name, (`Bytes|`Int) ->
6520 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
6521 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
6522 | name, `OptPercent ->
6523 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
6524 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
6526 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
6528 pr " guestfs_free_lvm_%s_list (r);\n" typ;
6531 let output_to filename =
6532 let filename_new = filename ^ ".new" in
6533 chan := open_out filename_new;
6538 (* Is the new file different from the current file? *)
6539 if Sys.file_exists filename && files_equal filename filename_new then
6540 Unix.unlink filename_new (* same, so skip it *)
6542 (* different, overwrite old one *)
6543 (try Unix.chmod filename 0o644 with Unix.Unix_error _ -> ());
6544 Unix.rename filename_new filename;
6545 Unix.chmod filename 0o444;
6546 printf "written %s\n%!" filename;
6555 if not (Sys.file_exists "configure.ac") then (
6557 You are probably running this from the wrong directory.
6558 Run it from the top source directory using the command
6564 let close = output_to "src/guestfs_protocol.x" in
6568 let close = output_to "src/guestfs-structs.h" in
6569 generate_structs_h ();
6572 let close = output_to "src/guestfs-actions.h" in
6573 generate_actions_h ();
6576 let close = output_to "src/guestfs-actions.c" in
6577 generate_client_actions ();
6580 let close = output_to "daemon/actions.h" in
6581 generate_daemon_actions_h ();
6584 let close = output_to "daemon/stubs.c" in
6585 generate_daemon_actions ();
6588 let close = output_to "tests.c" in
6592 let close = output_to "fish/cmds.c" in
6593 generate_fish_cmds ();
6596 let close = output_to "fish/completion.c" in
6597 generate_fish_completion ();
6600 let close = output_to "guestfs-structs.pod" in
6601 generate_structs_pod ();
6604 let close = output_to "guestfs-actions.pod" in
6605 generate_actions_pod ();
6608 let close = output_to "guestfish-actions.pod" in
6609 generate_fish_actions_pod ();
6612 let close = output_to "ocaml/guestfs.mli" in
6613 generate_ocaml_mli ();
6616 let close = output_to "ocaml/guestfs.ml" in
6617 generate_ocaml_ml ();
6620 let close = output_to "ocaml/guestfs_c_actions.c" in
6621 generate_ocaml_c ();
6624 let close = output_to "perl/Guestfs.xs" in
6625 generate_perl_xs ();
6628 let close = output_to "perl/lib/Sys/Guestfs.pm" in
6629 generate_perl_pm ();
6632 let close = output_to "python/guestfs-py.c" in
6633 generate_python_c ();
6636 let close = output_to "python/guestfs.py" in
6637 generate_python_py ();
6640 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
6644 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
6645 generate_java_java ();
6648 let close = output_to "java/com/redhat/et/libguestfs/PV.java" in
6649 generate_java_struct "PV" pv_cols;
6652 let close = output_to "java/com/redhat/et/libguestfs/VG.java" in
6653 generate_java_struct "VG" vg_cols;
6656 let close = output_to "java/com/redhat/et/libguestfs/LV.java" in
6657 generate_java_struct "LV" lv_cols;
6660 let close = output_to "java/com/redhat/et/libguestfs/Stat.java" in
6661 generate_java_struct "Stat" stat_cols;
6664 let close = output_to "java/com/redhat/et/libguestfs/StatVFS.java" in
6665 generate_java_struct "StatVFS" statvfs_cols;
6668 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in