3 * Copyright (C) 2009 Red Hat Inc.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 (* This script generates a large amount of code and documentation for
21 * all the daemon actions.
23 * To add a new action there are only two files you need to change,
24 * this one to describe the interface (see the big table below), and
25 * daemon/<somefile>.c to write the implementation.
27 * After editing this file, run it (./src/generator.ml) to regenerate
28 * all the output files.
30 * IMPORTANT: This script should NOT print any warnings. If it prints
31 * warnings, you should treat them as errors.
32 * [Need to add -warn-error to ocaml command line]
40 type style = ret * args
42 (* "RErr" as a return value means an int used as a simple error
43 * indication, ie. 0 or -1.
46 (* "RInt" as a return value means an int which is -1 for error
47 * or any value >= 0 on success. Only use this for smallish
48 * positive ints (0 <= i < 2^30).
51 (* "RInt64" is the same as RInt, but is guaranteed to be able
52 * to return a full 64 bit value, _except_ that -1 means error
53 * (so -1 cannot be a valid, non-error return value).
56 (* "RBool" is a bool return value which can be true/false or
60 (* "RConstString" is a string that refers to a constant value.
61 * Try to avoid using this. In particular you cannot use this
62 * for values returned from the daemon, because there is no
63 * thread-safe way to return them in the C API.
65 | RConstString of string
66 (* "RString" and "RStringList" are caller-frees. *)
68 | RStringList of string
69 (* Some limited tuples are possible: *)
70 | RIntBool of string * string
71 (* LVM PVs, VGs and LVs. *)
78 (* Key-value pairs of untyped strings. Turns into a hashtable or
79 * dictionary in languages which support it. DON'T use this as a
80 * general "bucket" for results. Prefer a stronger typed return
81 * value if one is available, or write a custom struct. Don't use
82 * this if the list could potentially be very long, since it is
83 * inefficient. Keys should be unique. NULLs are not permitted.
85 | RHashtable of string
87 and args = argt list (* Function parameters, guestfs handle is implicit. *)
89 (* Note in future we should allow a "variable args" parameter as
90 * the final parameter, to allow commands like
91 * chmod mode file [file(s)...]
92 * This is not implemented yet, but many commands (such as chmod)
93 * are currently defined with the argument order keeping this future
94 * possibility in mind.
97 | String of string (* const char *name, cannot be NULL *)
98 | OptString of string (* const char *name, may be NULL *)
99 | StringList of string(* list of strings (each string cannot be NULL) *)
100 | Bool of string (* boolean *)
101 | Int of string (* int (smallish ints, signed, <= 31 bits) *)
102 (* These are treated as filenames (simple string parameters) in
103 * the C API and bindings. But in the RPC protocol, we transfer
104 * the actual file content up to or down from the daemon.
105 * FileIn: local machine -> daemon (in request)
106 * FileOut: daemon -> local machine (in reply)
107 * In guestfish (only), the special name "-" means read from
108 * stdin or write to stdout.
114 | ProtocolLimitWarning (* display warning about protocol size limits *)
115 | DangerWillRobinson (* flags particularly dangerous commands *)
116 | FishAlias of string (* provide an alias for this cmd in guestfish *)
117 | FishAction of string (* call this function in guestfish *)
118 | NotInFish (* do not export via guestfish *)
120 let protocol_limit_warning =
121 "Because of the message protocol, there is a transfer limit
122 of somewhere between 2MB and 4MB. To transfer large files you should use
125 let danger_will_robinson =
126 "B<This command is dangerous. Without careful use you
127 can easily destroy all your data>."
129 (* You can supply zero or as many tests as you want per API call.
131 * Note that the test environment has 3 block devices, of size 500MB,
132 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc).
133 * Note for partitioning purposes, the 500MB device has 63 cylinders.
135 * To be able to run the tests in a reasonable amount of time,
136 * the virtual machine and block devices are reused between tests.
137 * So don't try testing kill_subprocess :-x
139 * Between each test we umount-all and lvm-remove-all (except InitNone).
141 * Don't assume anything about the previous contents of the block
142 * devices. Use 'Init*' to create some initial scenarios.
144 type tests = (test_init * test) list
146 (* Run the command sequence and just expect nothing to fail. *)
148 (* Run the command sequence and expect the output of the final
149 * command to be the string.
151 | TestOutput of seq * string
152 (* Run the command sequence and expect the output of the final
153 * command to be the list of strings.
155 | TestOutputList of seq * string list
156 (* Run the command sequence and expect the output of the final
157 * command to be the integer.
159 | TestOutputInt of seq * int
160 (* Run the command sequence and expect the output of the final
161 * command to be a true value (!= 0 or != NULL).
163 | TestOutputTrue of seq
164 (* Run the command sequence and expect the output of the final
165 * command to be a false value (== 0 or == NULL, but not an error).
167 | TestOutputFalse of seq
168 (* Run the command sequence and expect the output of the final
169 * command to be a list of the given length (but don't care about
172 | TestOutputLength of seq * int
173 (* Run the command sequence and expect the output of the final
174 * command to be a structure.
176 | TestOutputStruct of seq * test_field_compare list
177 (* Run the command sequence and expect the final command (only)
180 | TestLastFail of seq
182 and test_field_compare =
183 | CompareWithInt of string * int
184 | CompareWithString of string * string
185 | CompareFieldsIntEq of string * string
186 | CompareFieldsStrEq of string * string
188 (* Some initial scenarios for testing. *)
190 (* Do nothing, block devices could contain random stuff including
191 * LVM PVs, and some filesystems might be mounted. This is usually
195 (* Block devices are empty and no filesystems are mounted. *)
197 (* /dev/sda contains a single partition /dev/sda1, which is formatted
198 * as ext2, empty [except for lost+found] and mounted on /.
199 * /dev/sdb and /dev/sdc may have random content.
204 * /dev/sda1 (is a PV):
205 * /dev/VG/LV (size 8MB):
206 * formatted as ext2, empty [except for lost+found], mounted on /
207 * /dev/sdb and /dev/sdc may have random content.
211 (* Sequence of commands for testing. *)
213 and cmd = string list
215 (* Note about long descriptions: When referring to another
216 * action, use the format C<guestfs_other> (ie. the full name of
217 * the C function). This will be replaced as appropriate in other
220 * Apart from that, long descriptions are just perldoc paragraphs.
223 let non_daemon_functions = [
224 ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
226 "launch the qemu subprocess",
228 Internally libguestfs is implemented by running a virtual machine
231 You should call this after configuring the handle
232 (eg. adding drives) but before performing any actions.");
234 ("wait_ready", (RErr, []), -1, [NotInFish],
236 "wait until the qemu subprocess launches",
238 Internally libguestfs is implemented by running a virtual machine
241 You should call this after C<guestfs_launch> to wait for the launch
244 ("kill_subprocess", (RErr, []), -1, [],
246 "kill the qemu subprocess",
248 This kills the qemu subprocess. You should never need to call this.");
250 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
252 "add an image to examine or modify",
254 This function adds a virtual machine disk image C<filename> to the
255 guest. The first time you call this function, the disk appears as IDE
256 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
259 You don't necessarily need to be root when using libguestfs. However
260 you obviously do need sufficient permissions to access the filename
261 for whatever operations you want to perform (ie. read access if you
262 just want to read the image or write access if you want to modify the
265 This is equivalent to the qemu parameter C<-drive file=filename>.");
267 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
269 "add a CD-ROM disk image to examine",
271 This function adds a virtual CD-ROM disk image to the guest.
273 This is equivalent to the qemu parameter C<-cdrom filename>.");
275 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
277 "add qemu parameters",
279 This can be used to add arbitrary qemu command line parameters
280 of the form C<-param value>. Actually it's not quite arbitrary - we
281 prevent you from setting some parameters which would interfere with
282 parameters that we use.
284 The first character of C<param> string must be a C<-> (dash).
286 C<value> can be NULL.");
288 ("set_qemu", (RErr, [String "qemu"]), -1, [FishAlias "qemu"],
290 "set the qemu binary",
292 Set the qemu binary that we will use.
294 The default is chosen when the library was compiled by the
297 You can also override this by setting the C<LIBGUESTFS_QEMU>
298 environment variable.
300 The string C<qemu> is stashed in the libguestfs handle, so the caller
301 must make sure it remains valid for the lifetime of the handle.
303 Setting C<qemu> to C<NULL> restores the default qemu binary.");
305 ("get_qemu", (RConstString "qemu", []), -1, [],
307 "get the qemu binary",
309 Return the current qemu binary.
311 This is always non-NULL. If it wasn't set already, then this will
312 return the default qemu binary name.");
314 ("set_path", (RErr, [String "path"]), -1, [FishAlias "path"],
316 "set the search path",
318 Set the path that libguestfs searches for kernel and initrd.img.
320 The default is C<$libdir/guestfs> unless overridden by setting
321 C<LIBGUESTFS_PATH> environment variable.
323 The string C<path> is stashed in the libguestfs handle, so the caller
324 must make sure it remains valid for the lifetime of the handle.
326 Setting C<path> to C<NULL> restores the default path.");
328 ("get_path", (RConstString "path", []), -1, [],
330 "get the search path",
332 Return the current search path.
334 This is always non-NULL. If it wasn't set already, then this will
335 return the default path.");
337 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
341 If C<autosync> is true, this enables autosync. Libguestfs will make a
342 best effort attempt to run C<guestfs_sync> when the handle is closed
343 (also if the program exits without closing handles).");
345 ("get_autosync", (RBool "autosync", []), -1, [],
349 Get the autosync flag.");
351 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
355 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
357 Verbose messages are disabled unless the environment variable
358 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
360 ("get_verbose", (RBool "verbose", []), -1, [],
364 This returns the verbose messages flag.");
366 ("is_ready", (RBool "ready", []), -1, [],
368 "is ready to accept commands",
370 This returns true iff this handle is ready to accept commands
371 (in the C<READY> state).
373 For more information on states, see L<guestfs(3)>.");
375 ("is_config", (RBool "config", []), -1, [],
377 "is in configuration state",
379 This returns true iff this handle is being configured
380 (in the C<CONFIG> state).
382 For more information on states, see L<guestfs(3)>.");
384 ("is_launching", (RBool "launching", []), -1, [],
386 "is launching subprocess",
388 This returns true iff this handle is launching the subprocess
389 (in the C<LAUNCHING> state).
391 For more information on states, see L<guestfs(3)>.");
393 ("is_busy", (RBool "busy", []), -1, [],
395 "is busy processing a command",
397 This returns true iff this handle is busy processing a command
398 (in the C<BUSY> state).
400 For more information on states, see L<guestfs(3)>.");
402 ("get_state", (RInt "state", []), -1, [],
404 "get the current state",
406 This returns the current state as an opaque integer. This is
407 only useful for printing debug and internal error messages.
409 For more information on states, see L<guestfs(3)>.");
411 ("set_busy", (RErr, []), -1, [NotInFish],
415 This sets the state to C<BUSY>. This is only used when implementing
416 actions using the low-level API.
418 For more information on states, see L<guestfs(3)>.");
420 ("set_ready", (RErr, []), -1, [NotInFish],
422 "set state to ready",
424 This sets the state to C<READY>. This is only used when implementing
425 actions using the low-level API.
427 For more information on states, see L<guestfs(3)>.");
431 let daemon_functions = [
432 ("mount", (RErr, [String "device"; String "mountpoint"]), 1, [],
433 [InitEmpty, TestOutput (
434 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
435 ["mkfs"; "ext2"; "/dev/sda1"];
436 ["mount"; "/dev/sda1"; "/"];
437 ["write_file"; "/new"; "new file contents"; "0"];
438 ["cat"; "/new"]], "new file contents")],
439 "mount a guest disk at a position in the filesystem",
441 Mount a guest disk at a position in the filesystem. Block devices
442 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
443 the guest. If those block devices contain partitions, they will have
444 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
447 The rules are the same as for L<mount(2)>: A filesystem must
448 first be mounted on C</> before others can be mounted. Other
449 filesystems can only be mounted on directories which already
452 The mounted filesystem is writable, if we have sufficient permissions
453 on the underlying device.
455 The filesystem options C<sync> and C<noatime> are set with this
456 call, in order to improve reliability.");
458 ("sync", (RErr, []), 2, [],
459 [ InitEmpty, TestRun [["sync"]]],
460 "sync disks, writes are flushed through to the disk image",
462 This syncs the disk, so that any writes are flushed through to the
463 underlying disk image.
465 You should always call this if you have modified a disk image, before
466 closing the handle.");
468 ("touch", (RErr, [String "path"]), 3, [],
469 [InitBasicFS, TestOutputTrue (
471 ["exists"; "/new"]])],
472 "update file timestamps or create a new file",
474 Touch acts like the L<touch(1)> command. It can be used to
475 update the timestamps on a file, or, if the file does not exist,
476 to create a new zero-length file.");
478 ("cat", (RString "content", [String "path"]), 4, [ProtocolLimitWarning],
479 [InitBasicFS, TestOutput (
480 [["write_file"; "/new"; "new file contents"; "0"];
481 ["cat"; "/new"]], "new file contents")],
482 "list the contents of a file",
484 Return the contents of the file named C<path>.
486 Note that this function cannot correctly handle binary files
487 (specifically, files containing C<\\0> character which is treated
488 as end of string). For those you need to use the C<guestfs_download>
489 function which has a more complex interface.");
491 ("ll", (RString "listing", [String "directory"]), 5, [],
492 [], (* XXX Tricky to test because it depends on the exact format
493 * of the 'ls -l' command, which changes between F10 and F11.
495 "list the files in a directory (long format)",
497 List the files in C<directory> (relative to the root directory,
498 there is no cwd) in the format of 'ls -la'.
500 This command is mostly useful for interactive sessions. It
501 is I<not> intended that you try to parse the output string.");
503 ("ls", (RStringList "listing", [String "directory"]), 6, [],
504 [InitBasicFS, TestOutputList (
507 ["touch"; "/newest"];
508 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
509 "list the files in a directory",
511 List the files in C<directory> (relative to the root directory,
512 there is no cwd). The '.' and '..' entries are not returned, but
513 hidden files are shown.
515 This command is mostly useful for interactive sessions. Programs
516 should probably use C<guestfs_readdir> instead.");
518 ("list_devices", (RStringList "devices", []), 7, [],
519 [InitEmpty, TestOutputList (
520 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"])],
521 "list the block devices",
523 List all the block devices.
525 The full block device names are returned, eg. C</dev/sda>");
527 ("list_partitions", (RStringList "partitions", []), 8, [],
528 [InitBasicFS, TestOutputList (
529 [["list_partitions"]], ["/dev/sda1"]);
530 InitEmpty, TestOutputList (
531 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
532 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
533 "list the partitions",
535 List all the partitions detected on all block devices.
537 The full partition device names are returned, eg. C</dev/sda1>
539 This does not return logical volumes. For that you will need to
540 call C<guestfs_lvs>.");
542 ("pvs", (RStringList "physvols", []), 9, [],
543 [InitBasicFSonLVM, TestOutputList (
544 [["pvs"]], ["/dev/sda1"]);
545 InitEmpty, TestOutputList (
546 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
547 ["pvcreate"; "/dev/sda1"];
548 ["pvcreate"; "/dev/sda2"];
549 ["pvcreate"; "/dev/sda3"];
550 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
551 "list the LVM physical volumes (PVs)",
553 List all the physical volumes detected. This is the equivalent
554 of the L<pvs(8)> command.
556 This returns a list of just the device names that contain
557 PVs (eg. C</dev/sda2>).
559 See also C<guestfs_pvs_full>.");
561 ("vgs", (RStringList "volgroups", []), 10, [],
562 [InitBasicFSonLVM, TestOutputList (
564 InitEmpty, TestOutputList (
565 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
566 ["pvcreate"; "/dev/sda1"];
567 ["pvcreate"; "/dev/sda2"];
568 ["pvcreate"; "/dev/sda3"];
569 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
570 ["vgcreate"; "VG2"; "/dev/sda3"];
571 ["vgs"]], ["VG1"; "VG2"])],
572 "list the LVM volume groups (VGs)",
574 List all the volumes groups detected. This is the equivalent
575 of the L<vgs(8)> command.
577 This returns a list of just the volume group names that were
578 detected (eg. C<VolGroup00>).
580 See also C<guestfs_vgs_full>.");
582 ("lvs", (RStringList "logvols", []), 11, [],
583 [InitBasicFSonLVM, TestOutputList (
584 [["lvs"]], ["/dev/VG/LV"]);
585 InitEmpty, TestOutputList (
586 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
587 ["pvcreate"; "/dev/sda1"];
588 ["pvcreate"; "/dev/sda2"];
589 ["pvcreate"; "/dev/sda3"];
590 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
591 ["vgcreate"; "VG2"; "/dev/sda3"];
592 ["lvcreate"; "LV1"; "VG1"; "50"];
593 ["lvcreate"; "LV2"; "VG1"; "50"];
594 ["lvcreate"; "LV3"; "VG2"; "50"];
595 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
596 "list the LVM logical volumes (LVs)",
598 List all the logical volumes detected. This is the equivalent
599 of the L<lvs(8)> command.
601 This returns a list of the logical volume device names
602 (eg. C</dev/VolGroup00/LogVol00>).
604 See also C<guestfs_lvs_full>.");
606 ("pvs_full", (RPVList "physvols", []), 12, [],
607 [], (* XXX how to test? *)
608 "list the LVM physical volumes (PVs)",
610 List all the physical volumes detected. This is the equivalent
611 of the L<pvs(8)> command. The \"full\" version includes all fields.");
613 ("vgs_full", (RVGList "volgroups", []), 13, [],
614 [], (* XXX how to test? *)
615 "list the LVM volume groups (VGs)",
617 List all the volumes groups detected. This is the equivalent
618 of the L<vgs(8)> command. The \"full\" version includes all fields.");
620 ("lvs_full", (RLVList "logvols", []), 14, [],
621 [], (* XXX how to test? *)
622 "list the LVM logical volumes (LVs)",
624 List all the logical volumes detected. This is the equivalent
625 of the L<lvs(8)> command. The \"full\" version includes all fields.");
627 ("read_lines", (RStringList "lines", [String "path"]), 15, [],
628 [InitBasicFS, TestOutputList (
629 [["write_file"; "/new"; "line1\r\nline2\nline3"; "0"];
630 ["read_lines"; "/new"]], ["line1"; "line2"; "line3"]);
631 InitBasicFS, TestOutputList (
632 [["write_file"; "/new"; ""; "0"];
633 ["read_lines"; "/new"]], [])],
634 "read file as lines",
636 Return the contents of the file named C<path>.
638 The file contents are returned as a list of lines. Trailing
639 C<LF> and C<CRLF> character sequences are I<not> returned.
641 Note that this function cannot correctly handle binary files
642 (specifically, files containing C<\\0> character which is treated
643 as end of line). For those you need to use the C<guestfs_read_file>
644 function which has a more complex interface.");
646 ("aug_init", (RErr, [String "root"; Int "flags"]), 16, [],
647 [], (* XXX Augeas code needs tests. *)
648 "create a new Augeas handle",
650 Create a new Augeas handle for editing configuration files.
651 If there was any previous Augeas handle associated with this
652 guestfs session, then it is closed.
654 You must call this before using any other C<guestfs_aug_*>
657 C<root> is the filesystem root. C<root> must not be NULL,
660 The flags are the same as the flags defined in
661 E<lt>augeas.hE<gt>, the logical I<or> of the following
666 =item C<AUG_SAVE_BACKUP> = 1
668 Keep the original file with a C<.augsave> extension.
670 =item C<AUG_SAVE_NEWFILE> = 2
672 Save changes into a file with extension C<.augnew>, and
673 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
675 =item C<AUG_TYPE_CHECK> = 4
677 Typecheck lenses (can be expensive).
679 =item C<AUG_NO_STDINC> = 8
681 Do not use standard load path for modules.
683 =item C<AUG_SAVE_NOOP> = 16
685 Make save a no-op, just record what would have been changed.
687 =item C<AUG_NO_LOAD> = 32
689 Do not load the tree in C<guestfs_aug_init>.
693 To close the handle, you can call C<guestfs_aug_close>.
695 To find out more about Augeas, see L<http://augeas.net/>.");
697 ("aug_close", (RErr, []), 26, [],
698 [], (* XXX Augeas code needs tests. *)
699 "close the current Augeas handle",
701 Close the current Augeas handle and free up any resources
702 used by it. After calling this, you have to call
703 C<guestfs_aug_init> again before you can use any other
706 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [],
707 [], (* XXX Augeas code needs tests. *)
708 "define an Augeas variable",
710 Defines an Augeas variable C<name> whose value is the result
711 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
714 On success this returns the number of nodes in C<expr>, or
715 C<0> if C<expr> evaluates to something which is not a nodeset.");
717 ("aug_defnode", (RIntBool ("nrnodes", "created"), [String "name"; String "expr"; String "val"]), 18, [],
718 [], (* XXX Augeas code needs tests. *)
719 "define an Augeas node",
721 Defines a variable C<name> whose value is the result of
724 If C<expr> evaluates to an empty nodeset, a node is created,
725 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
726 C<name> will be the nodeset containing that single node.
728 On success this returns a pair containing the
729 number of nodes in the nodeset, and a boolean flag
730 if a node was created.");
732 ("aug_get", (RString "val", [String "path"]), 19, [],
733 [], (* XXX Augeas code needs tests. *)
734 "look up the value of an Augeas path",
736 Look up the value associated with C<path>. If C<path>
737 matches exactly one node, the C<value> is returned.");
739 ("aug_set", (RErr, [String "path"; String "val"]), 20, [],
740 [], (* XXX Augeas code needs tests. *)
741 "set Augeas path to value",
743 Set the value associated with C<path> to C<value>.");
745 ("aug_insert", (RErr, [String "path"; String "label"; Bool "before"]), 21, [],
746 [], (* XXX Augeas code needs tests. *)
747 "insert a sibling Augeas node",
749 Create a new sibling C<label> for C<path>, inserting it into
750 the tree before or after C<path> (depending on the boolean
753 C<path> must match exactly one existing node in the tree, and
754 C<label> must be a label, ie. not contain C</>, C<*> or end
755 with a bracketed index C<[N]>.");
757 ("aug_rm", (RInt "nrnodes", [String "path"]), 22, [],
758 [], (* XXX Augeas code needs tests. *)
759 "remove an Augeas path",
761 Remove C<path> and all of its children.
763 On success this returns the number of entries which were removed.");
765 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [],
766 [], (* XXX Augeas code needs tests. *)
769 Move the node C<src> to C<dest>. C<src> must match exactly
770 one node. C<dest> is overwritten if it exists.");
772 ("aug_match", (RStringList "matches", [String "path"]), 24, [],
773 [], (* XXX Augeas code needs tests. *)
774 "return Augeas nodes which match path",
776 Returns a list of paths which match the path expression C<path>.
777 The returned paths are sufficiently qualified so that they match
778 exactly one node in the current tree.");
780 ("aug_save", (RErr, []), 25, [],
781 [], (* XXX Augeas code needs tests. *)
782 "write all pending Augeas changes to disk",
784 This writes all pending changes to disk.
786 The flags which were passed to C<guestfs_aug_init> affect exactly
787 how files are saved.");
789 ("aug_load", (RErr, []), 27, [],
790 [], (* XXX Augeas code needs tests. *)
791 "load files into the tree",
793 Load files into the tree.
795 See C<aug_load> in the Augeas documentation for the full gory
798 ("aug_ls", (RStringList "matches", [String "path"]), 28, [],
799 [], (* XXX Augeas code needs tests. *)
800 "list Augeas nodes under a path",
802 This is just a shortcut for listing C<guestfs_aug_match>
803 C<path/*> and sorting the resulting nodes into alphabetical order.");
805 ("rm", (RErr, [String "path"]), 29, [],
806 [InitBasicFS, TestRun
809 InitBasicFS, TestLastFail
811 InitBasicFS, TestLastFail
816 Remove the single file C<path>.");
818 ("rmdir", (RErr, [String "path"]), 30, [],
819 [InitBasicFS, TestRun
822 InitBasicFS, TestLastFail
824 InitBasicFS, TestLastFail
827 "remove a directory",
829 Remove the single directory C<path>.");
831 ("rm_rf", (RErr, [String "path"]), 31, [],
832 [InitBasicFS, TestOutputFalse
834 ["mkdir"; "/new/foo"];
835 ["touch"; "/new/foo/bar"];
837 ["exists"; "/new"]]],
838 "remove a file or directory recursively",
840 Remove the file or directory C<path>, recursively removing the
841 contents if its a directory. This is like the C<rm -rf> shell
844 ("mkdir", (RErr, [String "path"]), 32, [],
845 [InitBasicFS, TestOutputTrue
848 InitBasicFS, TestLastFail
849 [["mkdir"; "/new/foo/bar"]]],
850 "create a directory",
852 Create a directory named C<path>.");
854 ("mkdir_p", (RErr, [String "path"]), 33, [],
855 [InitBasicFS, TestOutputTrue
856 [["mkdir_p"; "/new/foo/bar"];
857 ["is_dir"; "/new/foo/bar"]];
858 InitBasicFS, TestOutputTrue
859 [["mkdir_p"; "/new/foo/bar"];
860 ["is_dir"; "/new/foo"]];
861 InitBasicFS, TestOutputTrue
862 [["mkdir_p"; "/new/foo/bar"];
863 ["is_dir"; "/new"]]],
864 "create a directory and parents",
866 Create a directory named C<path>, creating any parent directories
867 as necessary. This is like the C<mkdir -p> shell command.");
869 ("chmod", (RErr, [Int "mode"; String "path"]), 34, [],
870 [], (* XXX Need stat command to test *)
873 Change the mode (permissions) of C<path> to C<mode>. Only
874 numeric modes are supported.");
876 ("chown", (RErr, [Int "owner"; Int "group"; String "path"]), 35, [],
877 [], (* XXX Need stat command to test *)
878 "change file owner and group",
880 Change the file owner to C<owner> and group to C<group>.
882 Only numeric uid and gid are supported. If you want to use
883 names, you will need to locate and parse the password file
884 yourself (Augeas support makes this relatively easy).");
886 ("exists", (RBool "existsflag", [String "path"]), 36, [],
887 [InitBasicFS, TestOutputTrue (
889 ["exists"; "/new"]]);
890 InitBasicFS, TestOutputTrue (
892 ["exists"; "/new"]])],
893 "test if file or directory exists",
895 This returns C<true> if and only if there is a file, directory
896 (or anything) with the given C<path> name.
898 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
900 ("is_file", (RBool "fileflag", [String "path"]), 37, [],
901 [InitBasicFS, TestOutputTrue (
903 ["is_file"; "/new"]]);
904 InitBasicFS, TestOutputFalse (
906 ["is_file"; "/new"]])],
907 "test if file exists",
909 This returns C<true> if and only if there is a file
910 with the given C<path> name. Note that it returns false for
911 other objects like directories.
913 See also C<guestfs_stat>.");
915 ("is_dir", (RBool "dirflag", [String "path"]), 38, [],
916 [InitBasicFS, TestOutputFalse (
918 ["is_dir"; "/new"]]);
919 InitBasicFS, TestOutputTrue (
921 ["is_dir"; "/new"]])],
922 "test if file exists",
924 This returns C<true> if and only if there is a directory
925 with the given C<path> name. Note that it returns false for
926 other objects like files.
928 See also C<guestfs_stat>.");
930 ("pvcreate", (RErr, [String "device"]), 39, [],
931 [InitEmpty, TestOutputList (
932 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
933 ["pvcreate"; "/dev/sda1"];
934 ["pvcreate"; "/dev/sda2"];
935 ["pvcreate"; "/dev/sda3"];
936 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
937 "create an LVM physical volume",
939 This creates an LVM physical volume on the named C<device>,
940 where C<device> should usually be a partition name such
943 ("vgcreate", (RErr, [String "volgroup"; StringList "physvols"]), 40, [],
944 [InitEmpty, TestOutputList (
945 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
946 ["pvcreate"; "/dev/sda1"];
947 ["pvcreate"; "/dev/sda2"];
948 ["pvcreate"; "/dev/sda3"];
949 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
950 ["vgcreate"; "VG2"; "/dev/sda3"];
951 ["vgs"]], ["VG1"; "VG2"])],
952 "create an LVM volume group",
954 This creates an LVM volume group called C<volgroup>
955 from the non-empty list of physical volumes C<physvols>.");
957 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [],
958 [InitEmpty, TestOutputList (
959 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
960 ["pvcreate"; "/dev/sda1"];
961 ["pvcreate"; "/dev/sda2"];
962 ["pvcreate"; "/dev/sda3"];
963 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
964 ["vgcreate"; "VG2"; "/dev/sda3"];
965 ["lvcreate"; "LV1"; "VG1"; "50"];
966 ["lvcreate"; "LV2"; "VG1"; "50"];
967 ["lvcreate"; "LV3"; "VG2"; "50"];
968 ["lvcreate"; "LV4"; "VG2"; "50"];
969 ["lvcreate"; "LV5"; "VG2"; "50"];
971 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
972 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
973 "create an LVM volume group",
975 This creates an LVM volume group called C<logvol>
976 on the volume group C<volgroup>, with C<size> megabytes.");
978 ("mkfs", (RErr, [String "fstype"; String "device"]), 42, [],
979 [InitEmpty, TestOutput (
980 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
981 ["mkfs"; "ext2"; "/dev/sda1"];
982 ["mount"; "/dev/sda1"; "/"];
983 ["write_file"; "/new"; "new file contents"; "0"];
984 ["cat"; "/new"]], "new file contents")],
987 This creates a filesystem on C<device> (usually a partition
988 of LVM logical volume). The filesystem type is C<fstype>, for
991 ("sfdisk", (RErr, [String "device";
992 Int "cyls"; Int "heads"; Int "sectors";
993 StringList "lines"]), 43, [DangerWillRobinson],
995 "create partitions on a block device",
997 This is a direct interface to the L<sfdisk(8)> program for creating
998 partitions on block devices.
1000 C<device> should be a block device, for example C</dev/sda>.
1002 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1003 and sectors on the device, which are passed directly to sfdisk as
1004 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1005 of these, then the corresponding parameter is omitted. Usually for
1006 'large' disks, you can just pass C<0> for these, but for small
1007 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1008 out the right geometry and you will need to tell it.
1010 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1011 information refer to the L<sfdisk(8)> manpage.
1013 To create a single partition occupying the whole disk, you would
1014 pass C<lines> as a single element list, when the single element being
1015 the string C<,> (comma).");
1017 ("write_file", (RErr, [String "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1018 [InitBasicFS, TestOutput (
1019 [["write_file"; "/new"; "new file contents"; "0"];
1020 ["cat"; "/new"]], "new file contents");
1021 InitBasicFS, TestOutput (
1022 [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1023 ["cat"; "/new"]], "\nnew file contents\n");
1024 InitBasicFS, TestOutput (
1025 [["write_file"; "/new"; "\n\n"; "0"];
1026 ["cat"; "/new"]], "\n\n");
1027 InitBasicFS, TestOutput (
1028 [["write_file"; "/new"; ""; "0"];
1029 ["cat"; "/new"]], "");
1030 InitBasicFS, TestOutput (
1031 [["write_file"; "/new"; "\n\n\n"; "0"];
1032 ["cat"; "/new"]], "\n\n\n");
1033 InitBasicFS, TestOutput (
1034 [["write_file"; "/new"; "\n"; "0"];
1035 ["cat"; "/new"]], "\n")],
1038 This call creates a file called C<path>. The contents of the
1039 file is the string C<content> (which can contain any 8 bit data),
1040 with length C<size>.
1042 As a special case, if C<size> is C<0>
1043 then the length is calculated using C<strlen> (so in this case
1044 the content cannot contain embedded ASCII NULs).");
1046 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1047 [InitEmpty, TestOutputList (
1048 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1049 ["mkfs"; "ext2"; "/dev/sda1"];
1050 ["mount"; "/dev/sda1"; "/"];
1051 ["mounts"]], ["/dev/sda1"]);
1052 InitEmpty, TestOutputList (
1053 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1054 ["mkfs"; "ext2"; "/dev/sda1"];
1055 ["mount"; "/dev/sda1"; "/"];
1058 "unmount a filesystem",
1060 This unmounts the given filesystem. The filesystem may be
1061 specified either by its mountpoint (path) or the device which
1062 contains the filesystem.");
1064 ("mounts", (RStringList "devices", []), 46, [],
1065 [InitBasicFS, TestOutputList (
1066 [["mounts"]], ["/dev/sda1"])],
1067 "show mounted filesystems",
1069 This returns the list of currently mounted filesystems. It returns
1070 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1072 Some internal mounts are not shown.");
1074 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1075 [InitBasicFS, TestOutputList (
1078 "unmount all filesystems",
1080 This unmounts all mounted filesystems.
1082 Some internal mounts are not unmounted by this call.");
1084 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson],
1086 "remove all LVM LVs, VGs and PVs",
1088 This command removes all LVM logical volumes, volume groups
1089 and physical volumes.");
1091 ("file", (RString "description", [String "path"]), 49, [],
1092 [InitBasicFS, TestOutput (
1094 ["file"; "/new"]], "empty");
1095 InitBasicFS, TestOutput (
1096 [["write_file"; "/new"; "some content\n"; "0"];
1097 ["file"; "/new"]], "ASCII text");
1098 InitBasicFS, TestLastFail (
1099 [["file"; "/nofile"]])],
1100 "determine file type",
1102 This call uses the standard L<file(1)> command to determine
1103 the type or contents of the file. This also works on devices,
1104 for example to find out whether a partition contains a filesystem.
1106 The exact command which runs is C<file -bsL path>. Note in
1107 particular that the filename is not prepended to the output
1108 (the C<-b> option).");
1110 ("command", (RString "output", [StringList "arguments"]), 50, [],
1111 [], (* XXX how to test? *)
1112 "run a command from the guest filesystem",
1114 This call runs a command from the guest filesystem. The
1115 filesystem must be mounted, and must contain a compatible
1116 operating system (ie. something Linux, with the same
1117 or compatible processor architecture).
1119 The single parameter is an argv-style list of arguments.
1120 The first element is the name of the program to run.
1121 Subsequent elements are parameters. The list must be
1122 non-empty (ie. must contain a program name).
1124 The C<$PATH> environment variable will contain at least
1125 C</usr/bin> and C</bin>. If you require a program from
1126 another location, you should provide the full path in the
1129 Shared libraries and data files required by the program
1130 must be available on filesystems which are mounted in the
1131 correct places. It is the caller's responsibility to ensure
1132 all filesystems that are needed are mounted at the right
1135 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [],
1136 [], (* XXX how to test? *)
1137 "run a command, returning lines",
1139 This is the same as C<guestfs_command>, but splits the
1140 result into a list of lines.");
1142 ("stat", (RStat "statbuf", [String "path"]), 52, [],
1143 [InitBasicFS, TestOutputStruct (
1145 ["stat"; "/new"]], [CompareWithInt ("size", 0)])],
1146 "get file information",
1148 Returns file information for the given C<path>.
1150 This is the same as the C<stat(2)> system call.");
1152 ("lstat", (RStat "statbuf", [String "path"]), 53, [],
1153 [InitBasicFS, TestOutputStruct (
1155 ["lstat"; "/new"]], [CompareWithInt ("size", 0)])],
1156 "get file information for a symbolic link",
1158 Returns file information for the given C<path>.
1160 This is the same as C<guestfs_stat> except that if C<path>
1161 is a symbolic link, then the link is stat-ed, not the file it
1164 This is the same as the C<lstat(2)> system call.");
1166 ("statvfs", (RStatVFS "statbuf", [String "path"]), 54, [],
1167 [InitBasicFS, TestOutputStruct (
1168 [["statvfs"; "/"]], [CompareWithInt ("bfree", 487702);
1169 CompareWithInt ("blocks", 490020);
1170 CompareWithInt ("bsize", 1024)])],
1171 "get file system statistics",
1173 Returns file system statistics for any mounted file system.
1174 C<path> should be a file or directory in the mounted file system
1175 (typically it is the mount point itself, but it doesn't need to be).
1177 This is the same as the C<statvfs(2)> system call.");
1179 ("tune2fs_l", (RHashtable "superblock", [String "device"]), 55, [],
1181 "get ext2/ext3 superblock details",
1183 This returns the contents of the ext2 or ext3 filesystem superblock
1186 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1187 manpage for more details. The list of fields returned isn't
1188 clearly defined, and depends on both the version of C<tune2fs>
1189 that libguestfs was built against, and the filesystem itself.");
1191 ("blockdev_setro", (RErr, [String "device"]), 56, [],
1192 [InitEmpty, TestOutputTrue (
1193 [["blockdev_setro"; "/dev/sda"];
1194 ["blockdev_getro"; "/dev/sda"]])],
1195 "set block device to read-only",
1197 Sets the block device named C<device> to read-only.
1199 This uses the L<blockdev(8)> command.");
1201 ("blockdev_setrw", (RErr, [String "device"]), 57, [],
1202 [InitEmpty, TestOutputFalse (
1203 [["blockdev_setrw"; "/dev/sda"];
1204 ["blockdev_getro"; "/dev/sda"]])],
1205 "set block device to read-write",
1207 Sets the block device named C<device> to read-write.
1209 This uses the L<blockdev(8)> command.");
1211 ("blockdev_getro", (RBool "ro", [String "device"]), 58, [],
1212 [InitEmpty, TestOutputTrue (
1213 [["blockdev_setro"; "/dev/sda"];
1214 ["blockdev_getro"; "/dev/sda"]])],
1215 "is block device set to read-only",
1217 Returns a boolean indicating if the block device is read-only
1218 (true if read-only, false if not).
1220 This uses the L<blockdev(8)> command.");
1222 ("blockdev_getss", (RInt "sectorsize", [String "device"]), 59, [],
1223 [InitEmpty, TestOutputInt (
1224 [["blockdev_getss"; "/dev/sda"]], 512)],
1225 "get sectorsize of block device",
1227 This returns the size of sectors on a block device.
1228 Usually 512, but can be larger for modern devices.
1230 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1233 This uses the L<blockdev(8)> command.");
1235 ("blockdev_getbsz", (RInt "blocksize", [String "device"]), 60, [],
1236 [InitEmpty, TestOutputInt (
1237 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1238 "get blocksize of block device",
1240 This returns the block size of a device.
1242 (Note this is different from both I<size in blocks> and
1243 I<filesystem block size>).
1245 This uses the L<blockdev(8)> command.");
1247 ("blockdev_setbsz", (RErr, [String "device"; Int "blocksize"]), 61, [],
1249 "set blocksize of block device",
1251 This sets the block size of a device.
1253 (Note this is different from both I<size in blocks> and
1254 I<filesystem block size>).
1256 This uses the L<blockdev(8)> command.");
1258 ("blockdev_getsz", (RInt64 "sizeinsectors", [String "device"]), 62, [],
1259 [InitEmpty, TestOutputInt (
1260 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1261 "get total size of device in 512-byte sectors",
1263 This returns the size of the device in units of 512-byte sectors
1264 (even if the sectorsize isn't 512 bytes ... weird).
1266 See also C<guestfs_blockdev_getss> for the real sector size of
1267 the device, and C<guestfs_blockdev_getsize64> for the more
1268 useful I<size in bytes>.
1270 This uses the L<blockdev(8)> command.");
1272 ("blockdev_getsize64", (RInt64 "sizeinbytes", [String "device"]), 63, [],
1273 [InitEmpty, TestOutputInt (
1274 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1275 "get total size of device in bytes",
1277 This returns the size of the device in bytes.
1279 See also C<guestfs_blockdev_getsz>.
1281 This uses the L<blockdev(8)> command.");
1283 ("blockdev_flushbufs", (RErr, [String "device"]), 64, [],
1285 [["blockdev_flushbufs"; "/dev/sda"]]],
1286 "flush device buffers",
1288 This tells the kernel to flush internal buffers associated
1291 This uses the L<blockdev(8)> command.");
1293 ("blockdev_rereadpt", (RErr, [String "device"]), 65, [],
1295 [["blockdev_rereadpt"; "/dev/sda"]]],
1296 "reread partition table",
1298 Reread the partition table on C<device>.
1300 This uses the L<blockdev(8)> command.");
1302 ("upload", (RErr, [FileIn "filename"; String "remotefilename"]), 66, [],
1303 [InitBasicFS, TestOutput (
1304 (* Pick a file from cwd which isn't likely to change. *)
1305 [["upload"; "COPYING.LIB"; "/COPYING.LIB"];
1306 ["checksum"; "md5"; "/COPYING.LIB"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1307 "upload a file from the local machine",
1309 Upload local file C<filename> to C<remotefilename> on the
1312 C<filename> can also be a named pipe.
1314 See also C<guestfs_download>.");
1316 ("download", (RErr, [String "remotefilename"; FileOut "filename"]), 67, [],
1317 [InitBasicFS, TestOutput (
1318 (* Pick a file from cwd which isn't likely to change. *)
1319 [["upload"; "COPYING.LIB"; "/COPYING.LIB"];
1320 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1321 ["upload"; "testdownload.tmp"; "/upload"];
1322 ["checksum"; "md5"; "/upload"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1323 "download a file to the local machine",
1325 Download file C<remotefilename> and save it as C<filename>
1326 on the local machine.
1328 C<filename> can also be a named pipe.
1330 See also C<guestfs_upload>, C<guestfs_cat>.");
1332 ("checksum", (RString "checksum", [String "csumtype"; String "path"]), 68, [],
1333 [InitBasicFS, TestOutput (
1334 [["write_file"; "/new"; "test\n"; "0"];
1335 ["checksum"; "crc"; "/new"]], "935282863");
1336 InitBasicFS, TestLastFail (
1337 [["checksum"; "crc"; "/new"]]);
1338 InitBasicFS, TestOutput (
1339 [["write_file"; "/new"; "test\n"; "0"];
1340 ["checksum"; "md5"; "/new"]], "d8e8fca2dc0f896fd7cb4cb0031ba249");
1341 InitBasicFS, TestOutput (
1342 [["write_file"; "/new"; "test\n"; "0"];
1343 ["checksum"; "sha1"; "/new"]], "4e1243bd22c66e76c2ba9eddc1f91394e57f9f83");
1344 InitBasicFS, TestOutput (
1345 [["write_file"; "/new"; "test\n"; "0"];
1346 ["checksum"; "sha224"; "/new"]], "52f1bf093f4b7588726035c176c0cdb4376cfea53819f1395ac9e6ec");
1347 InitBasicFS, TestOutput (
1348 [["write_file"; "/new"; "test\n"; "0"];
1349 ["checksum"; "sha256"; "/new"]], "f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2");
1350 InitBasicFS, TestOutput (
1351 [["write_file"; "/new"; "test\n"; "0"];
1352 ["checksum"; "sha384"; "/new"]], "109bb6b5b6d5547c1ce03c7a8bd7d8f80c1cb0957f50c4f7fda04692079917e4f9cad52b878f3d8234e1a170b154b72d");
1353 InitBasicFS, TestOutput (
1354 [["write_file"; "/new"; "test\n"; "0"];
1355 ["checksum"; "sha512"; "/new"]], "0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123")],
1356 "compute MD5, SHAx or CRC checksum of file",
1358 This call computes the MD5, SHAx or CRC checksum of the
1361 The type of checksum to compute is given by the C<csumtype>
1362 parameter which must have one of the following values:
1368 Compute the cyclic redundancy check (CRC) specified by POSIX
1369 for the C<cksum> command.
1373 Compute the MD5 hash (using the C<md5sum> program).
1377 Compute the SHA1 hash (using the C<sha1sum> program).
1381 Compute the SHA224 hash (using the C<sha224sum> program).
1385 Compute the SHA256 hash (using the C<sha256sum> program).
1389 Compute the SHA384 hash (using the C<sha384sum> program).
1393 Compute the SHA512 hash (using the C<sha512sum> program).
1397 The checksum is returned as a printable string.");
1399 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1400 [InitBasicFS, TestOutput (
1401 [["tar_in"; "images/helloworld.tar"; "/"];
1402 ["cat"; "/hello"]], "hello\n")],
1403 "unpack tarfile to directory",
1405 This command uploads and unpacks local file C<tarfile> (an
1406 I<uncompressed> tar file) into C<directory>.
1408 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1410 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1412 "pack directory into tarfile",
1414 This command packs the contents of C<directory> and downloads
1415 it to local file C<tarfile>.
1417 To download a compressed tarball, use C<guestfs_tgz_out>.");
1419 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1420 [InitBasicFS, TestOutput (
1421 [["tgz_in"; "images/helloworld.tar.gz"; "/"];
1422 ["cat"; "/hello"]], "hello\n")],
1423 "unpack compressed tarball to directory",
1425 This command uploads and unpacks local file C<tarball> (a
1426 I<gzip compressed> tar file) into C<directory>.
1428 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1430 ("tgz_out", (RErr, [String "directory"; FileOut "tarball"]), 72, [],
1432 "pack directory into compressed tarball",
1434 This command packs the contents of C<directory> and downloads
1435 it to local file C<tarball>.
1437 To download an uncompressed tarball, use C<guestfs_tar_out>.");
1439 ("mount_ro", (RErr, [String "device"; String "mountpoint"]), 73, [],
1440 [InitBasicFS, TestLastFail (
1442 ["mount_ro"; "/dev/sda1"; "/"];
1443 ["touch"; "/new"]]);
1444 InitBasicFS, TestOutput (
1445 [["write_file"; "/new"; "data"; "0"];
1447 ["mount_ro"; "/dev/sda1"; "/"];
1448 ["cat"; "/new"]], "data")],
1449 "mount a guest disk, read-only",
1451 This is the same as the C<guestfs_mount> command, but it
1452 mounts the filesystem with the read-only (I<-o ro>) flag.");
1454 ("mount_options", (RErr, [String "options"; String "device"; String "mountpoint"]), 74, [],
1456 "mount a guest disk with mount options",
1458 This is the same as the C<guestfs_mount> command, but it
1459 allows you to set the mount options as for the
1460 L<mount(8)> I<-o> flag.");
1462 ("mount_vfs", (RErr, [String "options"; String "vfstype"; String "device"; String "mountpoint"]), 75, [],
1464 "mount a guest disk with mount options and vfstype",
1466 This is the same as the C<guestfs_mount> command, but it
1467 allows you to set both the mount options and the vfstype
1468 as for the L<mount(8)> I<-o> and I<-t> flags.");
1470 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
1472 "debugging and internals",
1474 The C<guestfs_debug> command exposes some internals of
1475 C<guestfsd> (the guestfs daemon) that runs inside the
1478 There is no comprehensive help for this command. You have
1479 to look at the file C<daemon/debug.c> in the libguestfs source
1480 to find out what you can do.");
1484 let all_functions = non_daemon_functions @ daemon_functions
1486 (* In some places we want the functions to be displayed sorted
1487 * alphabetically, so this is useful:
1489 let all_functions_sorted =
1490 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
1491 compare n1 n2) all_functions
1493 (* Column names and types from LVM PVs/VGs/LVs. *)
1502 "pv_attr", `String (* XXX *);
1503 "pv_pe_count", `Int;
1504 "pv_pe_alloc_count", `Int;
1507 "pv_mda_count", `Int;
1508 "pv_mda_free", `Bytes;
1509 (* Not in Fedora 10:
1510 "pv_mda_size", `Bytes;
1517 "vg_attr", `String (* XXX *);
1520 "vg_sysid", `String;
1521 "vg_extent_size", `Bytes;
1522 "vg_extent_count", `Int;
1523 "vg_free_count", `Int;
1531 "vg_mda_count", `Int;
1532 "vg_mda_free", `Bytes;
1533 (* Not in Fedora 10:
1534 "vg_mda_size", `Bytes;
1540 "lv_attr", `String (* XXX *);
1543 "lv_kernel_major", `Int;
1544 "lv_kernel_minor", `Int;
1548 "snap_percent", `OptPercent;
1549 "copy_percent", `OptPercent;
1552 "mirror_log", `String;
1556 (* Column names and types from stat structures.
1557 * NB. Can't use things like 'st_atime' because glibc header files
1558 * define some of these as macros. Ugh.
1575 let statvfs_cols = [
1589 (* Useful functions.
1590 * Note we don't want to use any external OCaml libraries which
1591 * makes this a bit harder than it should be.
1593 let failwithf fs = ksprintf failwith fs
1595 let replace_char s c1 c2 =
1596 let s2 = String.copy s in
1597 let r = ref false in
1598 for i = 0 to String.length s2 - 1 do
1599 if String.unsafe_get s2 i = c1 then (
1600 String.unsafe_set s2 i c2;
1604 if not !r then s else s2
1608 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
1610 let triml ?(test = isspace) str =
1612 let n = ref (String.length str) in
1613 while !n > 0 && test str.[!i]; do
1618 else String.sub str !i !n
1620 let trimr ?(test = isspace) str =
1621 let n = ref (String.length str) in
1622 while !n > 0 && test str.[!n-1]; do
1625 if !n = String.length str then str
1626 else String.sub str 0 !n
1628 let trim ?(test = isspace) str =
1629 trimr ~test (triml ~test str)
1631 let rec find s sub =
1632 let len = String.length s in
1633 let sublen = String.length sub in
1635 if i <= len-sublen then (
1637 if j < sublen then (
1638 if s.[i+j] = sub.[j] then loop2 (j+1)
1644 if r = -1 then loop (i+1) else r
1650 let rec replace_str s s1 s2 =
1651 let len = String.length s in
1652 let sublen = String.length s1 in
1653 let i = find s s1 in
1656 let s' = String.sub s 0 i in
1657 let s'' = String.sub s (i+sublen) (len-i-sublen) in
1658 s' ^ s2 ^ replace_str s'' s1 s2
1661 let rec string_split sep str =
1662 let len = String.length str in
1663 let seplen = String.length sep in
1664 let i = find str sep in
1665 if i = -1 then [str]
1667 let s' = String.sub str 0 i in
1668 let s'' = String.sub str (i+seplen) (len-i-seplen) in
1669 s' :: string_split sep s''
1672 let rec find_map f = function
1673 | [] -> raise Not_found
1677 | None -> find_map f xs
1680 let rec loop i = function
1682 | x :: xs -> f i x; loop (i+1) xs
1687 let rec loop i = function
1689 | x :: xs -> let r = f i x in r :: loop (i+1) xs
1693 let name_of_argt = function
1694 | String n | OptString n | StringList n | Bool n | Int n
1695 | FileIn n | FileOut n -> n
1697 let seq_of_test = function
1698 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
1699 | TestOutputInt (s, _) | TestOutputTrue s | TestOutputFalse s
1700 | TestOutputLength (s, _) | TestOutputStruct (s, _)
1701 | TestLastFail s -> s
1703 (* Check function names etc. for consistency. *)
1704 let check_functions () =
1705 let contains_uppercase str =
1706 let len = String.length str in
1708 if i >= len then false
1711 if c >= 'A' && c <= 'Z' then true
1718 (* Check function names. *)
1720 fun (name, _, _, _, _, _, _) ->
1721 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
1722 failwithf "function name %s does not need 'guestfs' prefix" name;
1723 if contains_uppercase name then
1724 failwithf "function name %s should not contain uppercase chars" name;
1725 if String.contains name '-' then
1726 failwithf "function name %s should not contain '-', use '_' instead."
1730 (* Check function parameter/return names. *)
1732 fun (name, style, _, _, _, _, _) ->
1733 let check_arg_ret_name n =
1734 if contains_uppercase n then
1735 failwithf "%s param/ret %s should not contain uppercase chars"
1737 if String.contains n '-' || String.contains n '_' then
1738 failwithf "%s param/ret %s should not contain '-' or '_'"
1741 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;
1742 if n = "argv" || n = "args" then
1743 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" n
1746 (match fst style with
1748 | RInt n | RInt64 n | RBool n | RConstString n | RString n
1749 | RStringList n | RPVList n | RVGList n | RLVList n
1750 | RStat n | RStatVFS n
1752 check_arg_ret_name n
1754 check_arg_ret_name n;
1755 check_arg_ret_name m
1757 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
1760 (* Check short descriptions. *)
1762 fun (name, _, _, _, _, shortdesc, _) ->
1763 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
1764 failwithf "short description of %s should begin with lowercase." name;
1765 let c = shortdesc.[String.length shortdesc-1] in
1766 if c = '\n' || c = '.' then
1767 failwithf "short description of %s should not end with . or \\n." name
1770 (* Check long dscriptions. *)
1772 fun (name, _, _, _, _, _, longdesc) ->
1773 if longdesc.[String.length longdesc-1] = '\n' then
1774 failwithf "long description of %s should not end with \\n." name
1777 (* Check proc_nrs. *)
1779 fun (name, _, proc_nr, _, _, _, _) ->
1780 if proc_nr <= 0 then
1781 failwithf "daemon function %s should have proc_nr > 0" name
1785 fun (name, _, proc_nr, _, _, _, _) ->
1786 if proc_nr <> -1 then
1787 failwithf "non-daemon function %s should have proc_nr -1" name
1788 ) non_daemon_functions;
1791 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
1794 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
1795 let rec loop = function
1798 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
1800 | (name1,nr1) :: (name2,nr2) :: _ ->
1801 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
1809 (* Ignore functions that have no tests. We generate a
1810 * warning when the user does 'make check' instead.
1812 | name, _, _, _, [], _, _ -> ()
1813 | name, _, _, _, tests, _, _ ->
1817 match seq_of_test test with
1819 failwithf "%s has a test containing an empty sequence" name
1820 | cmds -> List.map List.hd cmds
1822 let funcs = List.flatten funcs in
1824 let tested = List.mem name funcs in
1827 failwithf "function %s has tests but does not test itself" name
1830 (* 'pr' prints to the current output file. *)
1831 let chan = ref stdout
1832 let pr fs = ksprintf (output_string !chan) fs
1834 (* Generate a header block in a number of standard styles. *)
1835 type comment_style = CStyle | HashStyle | OCamlStyle
1836 type license = GPLv2 | LGPLv2
1838 let generate_header comment license =
1839 let c = match comment with
1840 | CStyle -> pr "/* "; " *"
1841 | HashStyle -> pr "# "; "#"
1842 | OCamlStyle -> pr "(* "; " *" in
1843 pr "libguestfs generated file\n";
1844 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
1845 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
1847 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
1851 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
1852 pr "%s it under the terms of the GNU General Public License as published by\n" c;
1853 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
1854 pr "%s (at your option) any later version.\n" c;
1856 pr "%s This program is distributed in the hope that it will be useful,\n" c;
1857 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
1858 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
1859 pr "%s GNU General Public License for more details.\n" c;
1861 pr "%s You should have received a copy of the GNU General Public License along\n" c;
1862 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
1863 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
1866 pr "%s This library is free software; you can redistribute it and/or\n" c;
1867 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
1868 pr "%s License as published by the Free Software Foundation; either\n" c;
1869 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
1871 pr "%s This library is distributed in the hope that it will be useful,\n" c;
1872 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
1873 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
1874 pr "%s Lesser General Public License for more details.\n" c;
1876 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
1877 pr "%s License along with this library; if not, write to the Free Software\n" c;
1878 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
1881 | CStyle -> pr " */\n"
1883 | OCamlStyle -> pr " *)\n"
1887 (* Start of main code generation functions below this line. *)
1889 (* Generate the pod documentation for the C API. *)
1890 let rec generate_actions_pod () =
1892 fun (shortname, style, _, flags, _, _, longdesc) ->
1893 let name = "guestfs_" ^ shortname in
1894 pr "=head2 %s\n\n" name;
1896 generate_prototype ~extern:false ~handle:"handle" name style;
1898 pr "%s\n\n" longdesc;
1899 (match fst style with
1901 pr "This function returns 0 on success or -1 on error.\n\n"
1903 pr "On error this function returns -1.\n\n"
1905 pr "On error this function returns -1.\n\n"
1907 pr "This function returns a C truth value on success or -1 on error.\n\n"
1909 pr "This function returns a string, or NULL on error.
1910 The string is owned by the guest handle and must I<not> be freed.\n\n"
1912 pr "This function returns a string, or NULL on error.
1913 I<The caller must free the returned string after use>.\n\n"
1915 pr "This function returns a NULL-terminated array of strings
1916 (like L<environ(3)>), or NULL if there was an error.
1917 I<The caller must free the strings and the array after use>.\n\n"
1919 pr "This function returns a C<struct guestfs_int_bool *>,
1920 or NULL if there was an error.
1921 I<The caller must call C<guestfs_free_int_bool> after use>.\n\n"
1923 pr "This function returns a C<struct guestfs_lvm_pv_list *>
1924 (see E<lt>guestfs-structs.hE<gt>),
1925 or NULL if there was an error.
1926 I<The caller must call C<guestfs_free_lvm_pv_list> after use>.\n\n"
1928 pr "This function returns a C<struct guestfs_lvm_vg_list *>
1929 (see E<lt>guestfs-structs.hE<gt>),
1930 or NULL if there was an error.
1931 I<The caller must call C<guestfs_free_lvm_vg_list> after use>.\n\n"
1933 pr "This function returns a C<struct guestfs_lvm_lv_list *>
1934 (see E<lt>guestfs-structs.hE<gt>),
1935 or NULL if there was an error.
1936 I<The caller must call C<guestfs_free_lvm_lv_list> after use>.\n\n"
1938 pr "This function returns a C<struct guestfs_stat *>
1939 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
1940 or NULL if there was an error.
1941 I<The caller must call C<free> after use>.\n\n"
1943 pr "This function returns a C<struct guestfs_statvfs *>
1944 (see L<statvfs(2)> and E<lt>guestfs-structs.hE<gt>),
1945 or NULL if there was an error.
1946 I<The caller must call C<free> after use>.\n\n"
1948 pr "This function returns a NULL-terminated array of
1949 strings, or NULL if there was an error.
1950 The array of strings will always have length C<2n+1>, where
1951 C<n> keys and values alternate, followed by the trailing NULL entry.
1952 I<The caller must free the strings and the array after use>.\n\n"
1954 if List.mem ProtocolLimitWarning flags then
1955 pr "%s\n\n" protocol_limit_warning;
1956 if List.mem DangerWillRobinson flags then
1957 pr "%s\n\n" danger_will_robinson;
1958 ) all_functions_sorted
1960 and generate_structs_pod () =
1961 (* LVM structs documentation. *)
1964 pr "=head2 guestfs_lvm_%s\n" typ;
1966 pr " struct guestfs_lvm_%s {\n" typ;
1969 | name, `String -> pr " char *%s;\n" name
1971 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
1972 pr " char %s[32];\n" name
1973 | name, `Bytes -> pr " uint64_t %s;\n" name
1974 | name, `Int -> pr " int64_t %s;\n" name
1975 | name, `OptPercent ->
1976 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
1977 pr " float %s;\n" name
1980 pr " struct guestfs_lvm_%s_list {\n" typ;
1981 pr " uint32_t len; /* Number of elements in list. */\n";
1982 pr " struct guestfs_lvm_%s *val; /* Elements. */\n" typ;
1985 pr " void guestfs_free_lvm_%s_list (struct guestfs_free_lvm_%s_list *);\n"
1988 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
1990 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
1991 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
1993 * We have to use an underscore instead of a dash because otherwise
1994 * rpcgen generates incorrect code.
1996 * This header is NOT exported to clients, but see also generate_structs_h.
1998 and generate_xdr () =
1999 generate_header CStyle LGPLv2;
2001 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
2002 pr "typedef string str<>;\n";
2005 (* LVM internal structures. *)
2009 pr "struct guestfs_lvm_int_%s {\n" typ;
2011 | name, `String -> pr " string %s<>;\n" name
2012 | name, `UUID -> pr " opaque %s[32];\n" name
2013 | name, `Bytes -> pr " hyper %s;\n" name
2014 | name, `Int -> pr " hyper %s;\n" name
2015 | name, `OptPercent -> pr " float %s;\n" name
2019 pr "typedef struct guestfs_lvm_int_%s guestfs_lvm_int_%s_list<>;\n" typ typ;
2021 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2023 (* Stat internal structures. *)
2027 pr "struct guestfs_int_%s {\n" typ;
2029 | name, `Int -> pr " hyper %s;\n" name
2033 ) ["stat", stat_cols; "statvfs", statvfs_cols];
2036 fun (shortname, style, _, _, _, _, _) ->
2037 let name = "guestfs_" ^ shortname in
2039 (match snd style with
2042 pr "struct %s_args {\n" name;
2045 | String n -> pr " string %s<>;\n" n
2046 | OptString n -> pr " str *%s;\n" n
2047 | StringList n -> pr " str %s<>;\n" n
2048 | Bool n -> pr " bool %s;\n" n
2049 | Int n -> pr " int %s;\n" n
2050 | FileIn _ | FileOut _ -> ()
2054 (match fst style with
2057 pr "struct %s_ret {\n" name;
2061 pr "struct %s_ret {\n" name;
2062 pr " hyper %s;\n" n;
2065 pr "struct %s_ret {\n" name;
2069 failwithf "RConstString cannot be returned from a daemon function"
2071 pr "struct %s_ret {\n" name;
2072 pr " string %s<>;\n" n;
2075 pr "struct %s_ret {\n" name;
2076 pr " str %s<>;\n" n;
2079 pr "struct %s_ret {\n" name;
2084 pr "struct %s_ret {\n" name;
2085 pr " guestfs_lvm_int_pv_list %s;\n" n;
2088 pr "struct %s_ret {\n" name;
2089 pr " guestfs_lvm_int_vg_list %s;\n" n;
2092 pr "struct %s_ret {\n" name;
2093 pr " guestfs_lvm_int_lv_list %s;\n" n;
2096 pr "struct %s_ret {\n" name;
2097 pr " guestfs_int_stat %s;\n" n;
2100 pr "struct %s_ret {\n" name;
2101 pr " guestfs_int_statvfs %s;\n" n;
2104 pr "struct %s_ret {\n" name;
2105 pr " str %s<>;\n" n;
2110 (* Table of procedure numbers. *)
2111 pr "enum guestfs_procedure {\n";
2113 fun (shortname, _, proc_nr, _, _, _, _) ->
2114 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
2116 pr " GUESTFS_PROC_NR_PROCS\n";
2120 (* Having to choose a maximum message size is annoying for several
2121 * reasons (it limits what we can do in the API), but it (a) makes
2122 * the protocol a lot simpler, and (b) provides a bound on the size
2123 * of the daemon which operates in limited memory space. For large
2124 * file transfers you should use FTP.
2126 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
2129 (* Message header, etc. *)
2131 /* The communication protocol is now documented in the guestfs(3)
2135 const GUESTFS_PROGRAM = 0x2000F5F5;
2136 const GUESTFS_PROTOCOL_VERSION = 1;
2138 /* These constants must be larger than any possible message length. */
2139 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
2140 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
2142 enum guestfs_message_direction {
2143 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
2144 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
2147 enum guestfs_message_status {
2148 GUESTFS_STATUS_OK = 0,
2149 GUESTFS_STATUS_ERROR = 1
2152 const GUESTFS_ERROR_LEN = 256;
2154 struct guestfs_message_error {
2155 string error_message<GUESTFS_ERROR_LEN>;
2158 struct guestfs_message_header {
2159 unsigned prog; /* GUESTFS_PROGRAM */
2160 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
2161 guestfs_procedure proc; /* GUESTFS_PROC_x */
2162 guestfs_message_direction direction;
2163 unsigned serial; /* message serial number */
2164 guestfs_message_status status;
2167 const GUESTFS_MAX_CHUNK_SIZE = 8192;
2169 struct guestfs_chunk {
2170 int cancel; /* if non-zero, transfer is cancelled */
2171 /* data size is 0 bytes if the transfer has finished successfully */
2172 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
2176 (* Generate the guestfs-structs.h file. *)
2177 and generate_structs_h () =
2178 generate_header CStyle LGPLv2;
2180 (* This is a public exported header file containing various
2181 * structures. The structures are carefully written to have
2182 * exactly the same in-memory format as the XDR structures that
2183 * we use on the wire to the daemon. The reason for creating
2184 * copies of these structures here is just so we don't have to
2185 * export the whole of guestfs_protocol.h (which includes much
2186 * unrelated and XDR-dependent stuff that we don't want to be
2187 * public, or required by clients).
2189 * To reiterate, we will pass these structures to and from the
2190 * client with a simple assignment or memcpy, so the format
2191 * must be identical to what rpcgen / the RFC defines.
2194 (* guestfs_int_bool structure. *)
2195 pr "struct guestfs_int_bool {\n";
2201 (* LVM public structures. *)
2205 pr "struct guestfs_lvm_%s {\n" typ;
2208 | name, `String -> pr " char *%s;\n" name
2209 | name, `UUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
2210 | name, `Bytes -> pr " uint64_t %s;\n" name
2211 | name, `Int -> pr " int64_t %s;\n" name
2212 | name, `OptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
2216 pr "struct guestfs_lvm_%s_list {\n" typ;
2217 pr " uint32_t len;\n";
2218 pr " struct guestfs_lvm_%s *val;\n" typ;
2221 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2223 (* Stat structures. *)
2227 pr "struct guestfs_%s {\n" typ;
2230 | name, `Int -> pr " int64_t %s;\n" name
2234 ) ["stat", stat_cols; "statvfs", statvfs_cols]
2236 (* Generate the guestfs-actions.h file. *)
2237 and generate_actions_h () =
2238 generate_header CStyle LGPLv2;
2240 fun (shortname, style, _, _, _, _, _) ->
2241 let name = "guestfs_" ^ shortname in
2242 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
2246 (* Generate the client-side dispatch stubs. *)
2247 and generate_client_actions () =
2248 generate_header CStyle LGPLv2;
2254 #include \"guestfs.h\"
2255 #include \"guestfs_protocol.h\"
2257 #define error guestfs_error
2258 #define perrorf guestfs_perrorf
2259 #define safe_malloc guestfs_safe_malloc
2260 #define safe_realloc guestfs_safe_realloc
2261 #define safe_strdup guestfs_safe_strdup
2262 #define safe_memdup guestfs_safe_memdup
2264 /* Check the return message from a call for validity. */
2266 check_reply_header (guestfs_h *g,
2267 const struct guestfs_message_header *hdr,
2268 int proc_nr, int serial)
2270 if (hdr->prog != GUESTFS_PROGRAM) {
2271 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
2274 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
2275 error (g, \"wrong protocol version (%%d/%%d)\",
2276 hdr->vers, GUESTFS_PROTOCOL_VERSION);
2279 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
2280 error (g, \"unexpected message direction (%%d/%%d)\",
2281 hdr->direction, GUESTFS_DIRECTION_REPLY);
2284 if (hdr->proc != proc_nr) {
2285 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
2288 if (hdr->serial != serial) {
2289 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
2296 /* Check we are in the right state to run a high-level action. */
2298 check_state (guestfs_h *g, const char *caller)
2300 if (!guestfs_is_ready (g)) {
2301 if (guestfs_is_config (g))
2302 error (g, \"%%s: call launch() before using this function\",
2304 else if (guestfs_is_launching (g))
2305 error (g, \"%%s: call wait_ready() before using this function\",
2308 error (g, \"%%s called from the wrong state, %%d != READY\",
2309 caller, guestfs_get_state (g));
2317 (* Client-side stubs for each function. *)
2319 fun (shortname, style, _, _, _, _, _) ->
2320 let name = "guestfs_" ^ shortname in
2322 (* Generate the context struct which stores the high-level
2323 * state between callback functions.
2325 pr "struct %s_ctx {\n" shortname;
2326 pr " /* This flag is set by the callbacks, so we know we've done\n";
2327 pr " * the callbacks as expected, and in the right sequence.\n";
2328 pr " * 0 = not called, 1 = send called,\n";
2329 pr " * 1001 = reply called.\n";
2331 pr " int cb_sequence;\n";
2332 pr " struct guestfs_message_header hdr;\n";
2333 pr " struct guestfs_message_error err;\n";
2334 (match fst style with
2337 failwithf "RConstString cannot be returned from a daemon function"
2339 | RBool _ | RString _ | RStringList _
2341 | RPVList _ | RVGList _ | RLVList _
2342 | RStat _ | RStatVFS _
2344 pr " struct %s_ret ret;\n" name
2349 (* Generate the reply callback function. *)
2350 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
2352 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
2353 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
2355 pr " ml->main_loop_quit (ml, g);\n";
2357 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
2358 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
2361 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
2362 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
2363 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
2370 (match fst style with
2373 failwithf "RConstString cannot be returned from a daemon function"
2375 | RBool _ | RString _ | RStringList _
2377 | RPVList _ | RVGList _ | RLVList _
2378 | RStat _ | RStatVFS _
2380 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
2381 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
2387 pr " ctx->cb_sequence = 1001;\n";
2390 (* Generate the action stub. *)
2391 generate_prototype ~extern:false ~semicolon:false ~newline:true
2392 ~handle:"g" name style;
2395 match fst style with
2396 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
2398 failwithf "RConstString cannot be returned from a daemon function"
2399 | RString _ | RStringList _ | RIntBool _
2400 | RPVList _ | RVGList _ | RLVList _
2401 | RStat _ | RStatVFS _
2407 (match snd style with
2409 | _ -> pr " struct %s_args args;\n" name
2412 pr " struct %s_ctx ctx;\n" shortname;
2413 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
2414 pr " int serial;\n";
2416 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
2417 pr " guestfs_set_busy (g);\n";
2419 pr " memset (&ctx, 0, sizeof ctx);\n";
2422 (* Send the main header and arguments. *)
2423 (match snd style with
2425 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
2426 (String.uppercase shortname)
2431 pr " args.%s = (char *) %s;\n" n n
2433 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
2435 pr " args.%s.%s_val = (char **) %s;\n" n n n;
2436 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
2438 pr " args.%s = %s;\n" n n
2440 pr " args.%s = %s;\n" n n
2441 | FileIn _ | FileOut _ -> ()
2443 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
2444 (String.uppercase shortname);
2445 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
2448 pr " if (serial == -1) {\n";
2449 pr " guestfs_set_ready (g);\n";
2450 pr " return %s;\n" error_code;
2454 (* Send any additional files (FileIn) requested. *)
2455 let need_read_reply_label = ref false in
2462 pr " r = guestfs__send_file_sync (g, %s);\n" n;
2463 pr " if (r == -1) {\n";
2464 pr " guestfs_set_ready (g);\n";
2465 pr " return %s;\n" error_code;
2467 pr " if (r == -2) /* daemon cancelled */\n";
2468 pr " goto read_reply;\n";
2469 need_read_reply_label := true;
2475 (* Wait for the reply from the remote end. *)
2476 if !need_read_reply_label then pr " read_reply:\n";
2477 pr " guestfs__switch_to_receiving (g);\n";
2478 pr " ctx.cb_sequence = 0;\n";
2479 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
2480 pr " (void) ml->main_loop_run (ml, g);\n";
2481 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
2482 pr " if (ctx.cb_sequence != 1001) {\n";
2483 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
2484 pr " guestfs_set_ready (g);\n";
2485 pr " return %s;\n" error_code;
2489 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
2490 (String.uppercase shortname);
2491 pr " guestfs_set_ready (g);\n";
2492 pr " return %s;\n" error_code;
2496 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
2497 pr " error (g, \"%%s\", ctx.err.error_message);\n";
2498 pr " guestfs_set_ready (g);\n";
2499 pr " return %s;\n" error_code;
2503 (* Expecting to receive further files (FileOut)? *)
2507 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
2508 pr " guestfs_set_ready (g);\n";
2509 pr " return %s;\n" error_code;
2515 pr " guestfs_set_ready (g);\n";
2517 (match fst style with
2518 | RErr -> pr " return 0;\n"
2519 | RInt n | RInt64 n | RBool n ->
2520 pr " return ctx.ret.%s;\n" n
2522 failwithf "RConstString cannot be returned from a daemon function"
2524 pr " return ctx.ret.%s; /* caller will free */\n" n
2525 | RStringList n | RHashtable n ->
2526 pr " /* caller will free this, but we need to add a NULL entry */\n";
2527 pr " ctx.ret.%s.%s_val =\n" n n;
2528 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
2529 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
2531 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
2532 pr " return ctx.ret.%s.%s_val;\n" n n
2534 pr " /* caller with free this */\n";
2535 pr " return safe_memdup (g, &ctx.ret, sizeof (ctx.ret));\n"
2536 | RPVList n | RVGList n | RLVList n
2537 | RStat n | RStatVFS n ->
2538 pr " /* caller will free this */\n";
2539 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
2545 (* Generate daemon/actions.h. *)
2546 and generate_daemon_actions_h () =
2547 generate_header CStyle GPLv2;
2549 pr "#include \"../src/guestfs_protocol.h\"\n";
2553 fun (name, style, _, _, _, _, _) ->
2555 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
2559 (* Generate the server-side stubs. *)
2560 and generate_daemon_actions () =
2561 generate_header CStyle GPLv2;
2563 pr "#include <config.h>\n";
2565 pr "#include <stdio.h>\n";
2566 pr "#include <stdlib.h>\n";
2567 pr "#include <string.h>\n";
2568 pr "#include <inttypes.h>\n";
2569 pr "#include <ctype.h>\n";
2570 pr "#include <rpc/types.h>\n";
2571 pr "#include <rpc/xdr.h>\n";
2573 pr "#include \"daemon.h\"\n";
2574 pr "#include \"../src/guestfs_protocol.h\"\n";
2575 pr "#include \"actions.h\"\n";
2579 fun (name, style, _, _, _, _, _) ->
2580 (* Generate server-side stubs. *)
2581 pr "static void %s_stub (XDR *xdr_in)\n" name;
2584 match fst style with
2585 | RErr | RInt _ -> pr " int r;\n"; "-1"
2586 | RInt64 _ -> pr " int64_t r;\n"; "-1"
2587 | RBool _ -> pr " int r;\n"; "-1"
2589 failwithf "RConstString cannot be returned from a daemon function"
2590 | RString _ -> pr " char *r;\n"; "NULL"
2591 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
2592 | RIntBool _ -> pr " guestfs_%s_ret *r;\n" name; "NULL"
2593 | RPVList _ -> pr " guestfs_lvm_int_pv_list *r;\n"; "NULL"
2594 | RVGList _ -> pr " guestfs_lvm_int_vg_list *r;\n"; "NULL"
2595 | RLVList _ -> pr " guestfs_lvm_int_lv_list *r;\n"; "NULL"
2596 | RStat _ -> pr " guestfs_int_stat *r;\n"; "NULL"
2597 | RStatVFS _ -> pr " guestfs_int_statvfs *r;\n"; "NULL" in
2599 (match snd style with
2602 pr " struct guestfs_%s_args args;\n" name;
2606 | OptString n -> pr " const char *%s;\n" n
2607 | StringList n -> pr " char **%s;\n" n
2608 | Bool n -> pr " int %s;\n" n
2609 | Int n -> pr " int %s;\n" n
2610 | FileIn _ | FileOut _ -> ()
2615 (match snd style with
2618 pr " memset (&args, 0, sizeof args);\n";
2620 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
2621 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
2626 | String n -> pr " %s = args.%s;\n" n n
2627 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
2629 pr " args.%s.%s_val = realloc (args.%s.%s_val, sizeof (char *) * (args.%s.%s_len+1));\n" n n n n n n;
2630 pr " args.%s.%s_val[args.%s.%s_len] = NULL;\n" n n n n;
2631 pr " %s = args.%s.%s_val;\n" n n n
2632 | Bool n -> pr " %s = args.%s;\n" n n
2633 | Int n -> pr " %s = args.%s;\n" n n
2634 | FileIn _ | FileOut _ -> ()
2639 (* Don't want to call the impl with any FileIn or FileOut
2640 * parameters, since these go "outside" the RPC protocol.
2643 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
2645 pr " r = do_%s " name;
2646 generate_call_args argsnofile;
2649 pr " if (r == %s)\n" error_code;
2650 pr " /* do_%s has already called reply_with_error */\n" name;
2654 (* If there are any FileOut parameters, then the impl must
2655 * send its own reply.
2658 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
2660 pr " /* do_%s has already sent a reply */\n" name
2662 match fst style with
2663 | RErr -> pr " reply (NULL, NULL);\n"
2664 | RInt n | RInt64 n | RBool n ->
2665 pr " struct guestfs_%s_ret ret;\n" name;
2666 pr " ret.%s = r;\n" n;
2667 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
2670 failwithf "RConstString cannot be returned from a daemon function"
2672 pr " struct guestfs_%s_ret ret;\n" name;
2673 pr " ret.%s = r;\n" n;
2674 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
2677 | RStringList n | RHashtable n ->
2678 pr " struct guestfs_%s_ret ret;\n" name;
2679 pr " ret.%s.%s_len = count_strings (r);\n" n n;
2680 pr " ret.%s.%s_val = r;\n" n n;
2681 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
2683 pr " free_strings (r);\n"
2685 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n"
2687 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n" name
2688 | RPVList n | RVGList n | RLVList n
2689 | RStat n | RStatVFS n ->
2690 pr " struct guestfs_%s_ret ret;\n" name;
2691 pr " ret.%s = *r;\n" n;
2692 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
2694 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
2698 (* Free the args. *)
2699 (match snd style with
2704 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
2711 (* Dispatch function. *)
2712 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
2714 pr " switch (proc_nr) {\n";
2717 fun (name, style, _, _, _, _, _) ->
2718 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
2719 pr " %s_stub (xdr_in);\n" name;
2724 pr " reply_with_error (\"dispatch_incoming_message: unknown procedure number %%d\", proc_nr);\n";
2729 (* LVM columns and tokenization functions. *)
2730 (* XXX This generates crap code. We should rethink how we
2736 pr "static const char *lvm_%s_cols = \"%s\";\n"
2737 typ (String.concat "," (List.map fst cols));
2740 pr "static int lvm_tokenize_%s (char *str, struct guestfs_lvm_int_%s *r)\n" typ typ;
2742 pr " char *tok, *p, *next;\n";
2746 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
2749 pr " if (!str) {\n";
2750 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
2753 pr " if (!*str || isspace (*str)) {\n";
2754 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
2759 fun (name, coltype) ->
2760 pr " if (!tok) {\n";
2761 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
2764 pr " p = strchrnul (tok, ',');\n";
2765 pr " if (*p) next = p+1; else next = NULL;\n";
2766 pr " *p = '\\0';\n";
2769 pr " r->%s = strdup (tok);\n" name;
2770 pr " if (r->%s == NULL) {\n" name;
2771 pr " perror (\"strdup\");\n";
2775 pr " for (i = j = 0; i < 32; ++j) {\n";
2776 pr " if (tok[j] == '\\0') {\n";
2777 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
2779 pr " } else if (tok[j] != '-')\n";
2780 pr " r->%s[i++] = tok[j];\n" name;
2783 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
2784 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
2788 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
2789 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
2793 pr " if (tok[0] == '\\0')\n";
2794 pr " r->%s = -1;\n" name;
2795 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
2796 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
2800 pr " tok = next;\n";
2803 pr " if (tok != NULL) {\n";
2804 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
2811 pr "guestfs_lvm_int_%s_list *\n" typ;
2812 pr "parse_command_line_%ss (void)\n" typ;
2814 pr " char *out, *err;\n";
2815 pr " char *p, *pend;\n";
2817 pr " guestfs_lvm_int_%s_list *ret;\n" typ;
2818 pr " void *newp;\n";
2820 pr " ret = malloc (sizeof *ret);\n";
2821 pr " if (!ret) {\n";
2822 pr " reply_with_perror (\"malloc\");\n";
2823 pr " return NULL;\n";
2826 pr " ret->guestfs_lvm_int_%s_list_len = 0;\n" typ;
2827 pr " ret->guestfs_lvm_int_%s_list_val = NULL;\n" typ;
2829 pr " r = command (&out, &err,\n";
2830 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
2831 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
2832 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
2833 pr " if (r == -1) {\n";
2834 pr " reply_with_error (\"%%s\", err);\n";
2835 pr " free (out);\n";
2836 pr " free (err);\n";
2837 pr " free (ret);\n";
2838 pr " return NULL;\n";
2841 pr " free (err);\n";
2843 pr " /* Tokenize each line of the output. */\n";
2846 pr " while (p) {\n";
2847 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
2848 pr " if (pend) {\n";
2849 pr " *pend = '\\0';\n";
2853 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
2856 pr " if (!*p) { /* Empty line? Skip it. */\n";
2861 pr " /* Allocate some space to store this next entry. */\n";
2862 pr " newp = realloc (ret->guestfs_lvm_int_%s_list_val,\n" typ;
2863 pr " sizeof (guestfs_lvm_int_%s) * (i+1));\n" typ;
2864 pr " if (newp == NULL) {\n";
2865 pr " reply_with_perror (\"realloc\");\n";
2866 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
2867 pr " free (ret);\n";
2868 pr " free (out);\n";
2869 pr " return NULL;\n";
2871 pr " ret->guestfs_lvm_int_%s_list_val = newp;\n" typ;
2873 pr " /* Tokenize the next entry. */\n";
2874 pr " r = lvm_tokenize_%s (p, &ret->guestfs_lvm_int_%s_list_val[i]);\n" typ typ;
2875 pr " if (r == -1) {\n";
2876 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
2877 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
2878 pr " free (ret);\n";
2879 pr " free (out);\n";
2880 pr " return NULL;\n";
2887 pr " ret->guestfs_lvm_int_%s_list_len = i;\n" typ;
2889 pr " free (out);\n";
2890 pr " return ret;\n";
2893 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
2895 (* Generate the tests. *)
2896 and generate_tests () =
2897 generate_header CStyle GPLv2;
2904 #include <sys/types.h>
2907 #include \"guestfs.h\"
2909 static guestfs_h *g;
2910 static int suppress_error = 0;
2912 static void print_error (guestfs_h *g, void *data, const char *msg)
2914 if (!suppress_error)
2915 fprintf (stderr, \"%%s\\n\", msg);
2918 static void print_strings (char * const * const argv)
2922 for (argc = 0; argv[argc] != NULL; ++argc)
2923 printf (\"\\t%%s\\n\", argv[argc]);
2927 static void print_table (char * const * const argv)
2931 for (i = 0; argv[i] != NULL; i += 2)
2932 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
2936 static void no_test_warnings (void)
2942 | name, _, _, _, [], _, _ ->
2943 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
2944 | name, _, _, _, tests, _, _ -> ()
2950 (* Generate the actual tests. Note that we generate the tests
2951 * in reverse order, deliberately, so that (in general) the
2952 * newest tests run first. This makes it quicker and easier to
2957 fun (name, _, _, _, tests, _, _) ->
2958 mapi (generate_one_test name) tests
2959 ) (List.rev all_functions) in
2960 let test_names = List.concat test_names in
2961 let nr_tests = List.length test_names in
2964 int main (int argc, char *argv[])
2969 const char *filename;
2971 int nr_tests, test_num = 0;
2973 no_test_warnings ();
2975 g = guestfs_create ();
2977 printf (\"guestfs_create FAILED\\n\");
2981 guestfs_set_error_handler (g, print_error, NULL);
2983 srcdir = getenv (\"srcdir\");
2984 if (!srcdir) srcdir = \".\";
2986 guestfs_set_path (g, \".\");
2988 filename = \"test1.img\";
2989 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
2994 if (lseek (fd, %d, SEEK_SET) == -1) {
3000 if (write (fd, &c, 1) == -1) {
3006 if (close (fd) == -1) {
3011 if (guestfs_add_drive (g, filename) == -1) {
3012 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3016 filename = \"test2.img\";
3017 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3022 if (lseek (fd, %d, SEEK_SET) == -1) {
3028 if (write (fd, &c, 1) == -1) {
3034 if (close (fd) == -1) {
3039 if (guestfs_add_drive (g, filename) == -1) {
3040 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3044 filename = \"test3.img\";
3045 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3050 if (lseek (fd, %d, SEEK_SET) == -1) {
3056 if (write (fd, &c, 1) == -1) {
3062 if (close (fd) == -1) {
3067 if (guestfs_add_drive (g, filename) == -1) {
3068 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3072 if (guestfs_launch (g) == -1) {
3073 printf (\"guestfs_launch FAILED\\n\");
3076 if (guestfs_wait_ready (g) == -1) {
3077 printf (\"guestfs_wait_ready FAILED\\n\");
3083 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
3087 pr " test_num++;\n";
3088 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
3089 pr " if (%s () == -1) {\n" test_name;
3090 pr " printf (\"%s FAILED\\n\");\n" test_name;
3096 pr " guestfs_close (g);\n";
3097 pr " unlink (\"test1.img\");\n";
3098 pr " unlink (\"test2.img\");\n";
3099 pr " unlink (\"test3.img\");\n";
3102 pr " if (failed > 0) {\n";
3103 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
3111 and generate_one_test name i (init, test) =
3112 let test_name = sprintf "test_%s_%d" name i in
3114 pr "static int %s (void)\n" test_name;
3120 pr " /* InitEmpty for %s (%d) */\n" name i;
3121 List.iter (generate_test_command_call test_name)
3125 pr " /* InitBasicFS for %s (%d): create ext2 on /dev/sda1 */\n" name i;
3126 List.iter (generate_test_command_call test_name)
3129 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
3130 ["mkfs"; "ext2"; "/dev/sda1"];
3131 ["mount"; "/dev/sda1"; "/"]]
3132 | InitBasicFSonLVM ->
3133 pr " /* InitBasicFSonLVM for %s (%d): create ext2 on /dev/VG/LV */\n"
3135 List.iter (generate_test_command_call test_name)
3138 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
3139 ["pvcreate"; "/dev/sda1"];
3140 ["vgcreate"; "VG"; "/dev/sda1"];
3141 ["lvcreate"; "LV"; "VG"; "8"];
3142 ["mkfs"; "ext2"; "/dev/VG/LV"];
3143 ["mount"; "/dev/VG/LV"; "/"]]
3146 let get_seq_last = function
3148 failwithf "%s: you cannot use [] (empty list) when expecting a command"
3151 let seq = List.rev seq in
3152 List.rev (List.tl seq), List.hd seq
3157 pr " /* TestRun for %s (%d) */\n" name i;
3158 List.iter (generate_test_command_call test_name) seq
3159 | TestOutput (seq, expected) ->
3160 pr " /* TestOutput for %s (%d) */\n" name i;
3161 let seq, last = get_seq_last seq in
3163 pr " if (strcmp (r, \"%s\") != 0) {\n" (c_quote expected);
3164 pr " fprintf (stderr, \"%s: expected \\\"%s\\\" but got \\\"%%s\\\"\\n\", r);\n" test_name (c_quote expected);
3168 List.iter (generate_test_command_call test_name) seq;
3169 generate_test_command_call ~test test_name last
3170 | TestOutputList (seq, expected) ->
3171 pr " /* TestOutputList for %s (%d) */\n" name i;
3172 let seq, last = get_seq_last seq in
3176 pr " if (!r[%d]) {\n" i;
3177 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
3178 pr " print_strings (r);\n";
3181 pr " if (strcmp (r[%d], \"%s\") != 0) {\n" i (c_quote str);
3182 pr " fprintf (stderr, \"%s: expected \\\"%s\\\" but got \\\"%%s\\\"\\n\", r[%d]);\n" test_name (c_quote str) i;
3186 pr " if (r[%d] != NULL) {\n" (List.length expected);
3187 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
3189 pr " print_strings (r);\n";
3193 List.iter (generate_test_command_call test_name) seq;
3194 generate_test_command_call ~test test_name last
3195 | TestOutputInt (seq, expected) ->
3196 pr " /* TestOutputInt for %s (%d) */\n" name i;
3197 let seq, last = get_seq_last seq in
3199 pr " if (r != %d) {\n" expected;
3200 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
3206 List.iter (generate_test_command_call test_name) seq;
3207 generate_test_command_call ~test test_name last
3208 | TestOutputTrue seq ->
3209 pr " /* TestOutputTrue for %s (%d) */\n" name i;
3210 let seq, last = get_seq_last seq in
3213 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
3218 List.iter (generate_test_command_call test_name) seq;
3219 generate_test_command_call ~test test_name last
3220 | TestOutputFalse seq ->
3221 pr " /* TestOutputFalse for %s (%d) */\n" name i;
3222 let seq, last = get_seq_last seq in
3225 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
3230 List.iter (generate_test_command_call test_name) seq;
3231 generate_test_command_call ~test test_name last
3232 | TestOutputLength (seq, expected) ->
3233 pr " /* TestOutputLength for %s (%d) */\n" name i;
3234 let seq, last = get_seq_last seq in
3237 pr " for (j = 0; j < %d; ++j)\n" expected;
3238 pr " if (r[j] == NULL) {\n";
3239 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
3241 pr " print_strings (r);\n";
3244 pr " if (r[j] != NULL) {\n";
3245 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
3247 pr " print_strings (r);\n";
3251 List.iter (generate_test_command_call test_name) seq;
3252 generate_test_command_call ~test test_name last
3253 | TestOutputStruct (seq, checks) ->
3254 pr " /* TestOutputStruct for %s (%d) */\n" name i;
3255 let seq, last = get_seq_last seq in
3259 | CompareWithInt (field, expected) ->
3260 pr " if (r->%s != %d) {\n" field expected;
3261 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
3262 test_name field expected;
3263 pr " (int) r->%s);\n" field;
3266 | CompareWithString (field, expected) ->
3267 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
3268 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
3269 test_name field expected;
3270 pr " r->%s);\n" field;
3273 | CompareFieldsIntEq (field1, field2) ->
3274 pr " if (r->%s != r->%s) {\n" field1 field2;
3275 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
3276 test_name field1 field2;
3277 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
3280 | CompareFieldsStrEq (field1, field2) ->
3281 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
3282 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
3283 test_name field1 field2;
3284 pr " r->%s, r->%s);\n" field1 field2;
3289 List.iter (generate_test_command_call test_name) seq;
3290 generate_test_command_call ~test test_name last
3291 | TestLastFail seq ->
3292 pr " /* TestLastFail for %s (%d) */\n" name i;
3293 let seq, last = get_seq_last seq in
3294 List.iter (generate_test_command_call test_name) seq;
3295 generate_test_command_call test_name ~expect_error:true last
3303 (* Generate the code to run a command, leaving the result in 'r'.
3304 * If you expect to get an error then you should set expect_error:true.
3306 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
3308 | [] -> assert false
3310 (* Look up the command to find out what args/ret it has. *)
3313 let _, style, _, _, _, _, _ =
3314 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
3317 failwithf "%s: in test, command %s was not found" test_name name in
3319 if List.length (snd style) <> List.length args then
3320 failwithf "%s: in test, wrong number of args given to %s"
3331 | FileIn _, _ | FileOut _, _ -> ()
3332 | StringList n, arg ->
3333 pr " char *%s[] = {\n" n;
3334 let strs = string_split " " arg in
3336 fun str -> pr " \"%s\",\n" (c_quote str)
3340 ) (List.combine (snd style) args);
3343 match fst style with
3344 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
3345 | RInt64 _ -> pr " int64_t r;\n"; "-1"
3346 | RConstString _ -> pr " const char *r;\n"; "NULL"
3347 | RString _ -> pr " char *r;\n"; "NULL"
3348 | RStringList _ | RHashtable _ ->
3353 pr " struct guestfs_int_bool *r;\n"; "NULL"
3355 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
3357 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
3359 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
3361 pr " struct guestfs_stat *r;\n"; "NULL"
3363 pr " struct guestfs_statvfs *r;\n"; "NULL" in
3365 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
3366 pr " r = guestfs_%s (g" name;
3368 (* Generate the parameters. *)
3372 | FileIn _, arg | FileOut _, arg ->
3373 pr ", \"%s\"" (c_quote arg)
3374 | OptString _, arg ->
3375 if arg = "NULL" then pr ", NULL" else pr ", \"%s\"" (c_quote arg)
3376 | StringList n, _ ->
3380 try int_of_string arg
3381 with Failure "int_of_string" ->
3382 failwithf "%s: expecting an int, but got '%s'" test_name arg in
3385 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
3386 ) (List.combine (snd style) args);
3389 if not expect_error then
3390 pr " if (r == %s)\n" error_code
3392 pr " if (r != %s)\n" error_code;
3395 (* Insert the test code. *)
3401 (match fst style with
3402 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _ -> ()
3403 | RString _ -> pr " free (r);\n"
3404 | RStringList _ | RHashtable _ ->
3405 pr " for (i = 0; r[i] != NULL; ++i)\n";
3406 pr " free (r[i]);\n";
3409 pr " guestfs_free_int_bool (r);\n"
3411 pr " guestfs_free_lvm_pv_list (r);\n"
3413 pr " guestfs_free_lvm_vg_list (r);\n"
3415 pr " guestfs_free_lvm_lv_list (r);\n"
3416 | RStat _ | RStatVFS _ ->
3423 let str = replace_str str "\r" "\\r" in
3424 let str = replace_str str "\n" "\\n" in
3425 let str = replace_str str "\t" "\\t" in
3428 (* Generate a lot of different functions for guestfish. *)
3429 and generate_fish_cmds () =
3430 generate_header CStyle GPLv2;
3434 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3436 let all_functions_sorted =
3438 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3439 ) all_functions_sorted in
3441 pr "#include <stdio.h>\n";
3442 pr "#include <stdlib.h>\n";
3443 pr "#include <string.h>\n";
3444 pr "#include <inttypes.h>\n";
3446 pr "#include <guestfs.h>\n";
3447 pr "#include \"fish.h\"\n";
3450 (* list_commands function, which implements guestfish -h *)
3451 pr "void list_commands (void)\n";
3453 pr " printf (\" %%-16s %%s\\n\", \"Command\", \"Description\");\n";
3454 pr " list_builtin_commands ();\n";
3456 fun (name, _, _, flags, _, shortdesc, _) ->
3457 let name = replace_char name '_' '-' in
3458 pr " printf (\"%%-20s %%s\\n\", \"%s\", \"%s\");\n"
3460 ) all_functions_sorted;
3461 pr " printf (\" Use -h <cmd> / help <cmd> to show detailed help for a command.\\n\");\n";
3465 (* display_command function, which implements guestfish -h cmd *)
3466 pr "void display_command (const char *cmd)\n";
3469 fun (name, style, _, flags, _, shortdesc, longdesc) ->
3470 let name2 = replace_char name '_' '-' in
3472 try find_map (function FishAlias n -> Some n | _ -> None) flags
3473 with Not_found -> name in
3474 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
3476 match snd style with
3480 name2 (String.concat "> <" (List.map name_of_argt args)) in
3483 if List.mem ProtocolLimitWarning flags then
3484 ("\n\n" ^ protocol_limit_warning)
3487 (* For DangerWillRobinson commands, we should probably have
3488 * guestfish prompt before allowing you to use them (especially
3489 * in interactive mode). XXX
3493 if List.mem DangerWillRobinson flags then
3494 ("\n\n" ^ danger_will_robinson)
3497 let describe_alias =
3498 if name <> alias then
3499 sprintf "\n\nYou can use '%s' as an alias for this command." alias
3503 pr "strcasecmp (cmd, \"%s\") == 0" name;
3504 if name <> name2 then
3505 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
3506 if name <> alias then
3507 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
3509 pr " pod2text (\"%s - %s\", %S);\n"
3511 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
3514 pr " display_builtin_command (cmd);\n";
3518 (* print_{pv,vg,lv}_list functions *)
3522 pr "static void print_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
3529 pr " printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
3531 pr " printf (\"%s: \");\n" name;
3532 pr " for (i = 0; i < 32; ++i)\n";
3533 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
3534 pr " printf (\"\\n\");\n"
3536 pr " printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
3538 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
3539 | name, `OptPercent ->
3540 pr " if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
3541 typ name name typ name;
3542 pr " else printf (\"%s: \\n\");\n" name
3546 pr "static void print_%s_list (struct guestfs_lvm_%s_list *%ss)\n"
3551 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
3552 pr " print_%s (&%ss->val[i]);\n" typ typ;
3555 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
3557 (* print_{stat,statvfs} functions *)
3561 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
3566 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
3570 ) ["stat", stat_cols; "statvfs", statvfs_cols];
3572 (* run_<action> actions *)
3574 fun (name, style, _, flags, _, _, _) ->
3575 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
3577 (match fst style with
3580 | RBool _ -> pr " int r;\n"
3581 | RInt64 _ -> pr " int64_t r;\n"
3582 | RConstString _ -> pr " const char *r;\n"
3583 | RString _ -> pr " char *r;\n"
3584 | RStringList _ | RHashtable _ -> pr " char **r;\n"
3585 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"
3586 | RPVList _ -> pr " struct guestfs_lvm_pv_list *r;\n"
3587 | RVGList _ -> pr " struct guestfs_lvm_vg_list *r;\n"
3588 | RLVList _ -> pr " struct guestfs_lvm_lv_list *r;\n"
3589 | RStat _ -> pr " struct guestfs_stat *r;\n"
3590 | RStatVFS _ -> pr " struct guestfs_statvfs *r;\n"
3597 | FileOut n -> pr " const char *%s;\n" n
3598 | StringList n -> pr " char **%s;\n" n
3599 | Bool n -> pr " int %s;\n" n
3600 | Int n -> pr " int %s;\n" n
3603 (* Check and convert parameters. *)
3604 let argc_expected = List.length (snd style) in
3605 pr " if (argc != %d) {\n" argc_expected;
3606 pr " fprintf (stderr, \"%%s should have %d parameter(s)\\n\", cmd);\n"
3608 pr " fprintf (stderr, \"type 'help %%s' for help on %%s\\n\", cmd, cmd);\n";
3614 | String name -> pr " %s = argv[%d];\n" name i
3616 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
3619 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
3622 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
3624 | StringList name ->
3625 pr " %s = parse_string_list (argv[%d]);\n" name i
3627 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
3629 pr " %s = atoi (argv[%d]);\n" name i
3632 (* Call C API function. *)
3634 try find_map (function FishAction n -> Some n | _ -> None) flags
3635 with Not_found -> sprintf "guestfs_%s" name in
3637 generate_call_args ~handle:"g" (snd style);
3640 (* Check return value for errors and display command results. *)
3641 (match fst style with
3642 | RErr -> pr " return r;\n"
3644 pr " if (r == -1) return -1;\n";
3645 pr " printf (\"%%d\\n\", r);\n";
3648 pr " if (r == -1) return -1;\n";
3649 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
3652 pr " if (r == -1) return -1;\n";
3653 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
3656 pr " if (r == NULL) return -1;\n";
3657 pr " printf (\"%%s\\n\", r);\n";
3660 pr " if (r == NULL) return -1;\n";
3661 pr " printf (\"%%s\\n\", r);\n";
3665 pr " if (r == NULL) return -1;\n";
3666 pr " print_strings (r);\n";
3667 pr " free_strings (r);\n";
3670 pr " if (r == NULL) return -1;\n";
3671 pr " printf (\"%%d, %%s\\n\", r->i,\n";
3672 pr " r->b ? \"true\" : \"false\");\n";
3673 pr " guestfs_free_int_bool (r);\n";
3676 pr " if (r == NULL) return -1;\n";
3677 pr " print_pv_list (r);\n";
3678 pr " guestfs_free_lvm_pv_list (r);\n";
3681 pr " if (r == NULL) return -1;\n";
3682 pr " print_vg_list (r);\n";
3683 pr " guestfs_free_lvm_vg_list (r);\n";
3686 pr " if (r == NULL) return -1;\n";
3687 pr " print_lv_list (r);\n";
3688 pr " guestfs_free_lvm_lv_list (r);\n";
3691 pr " if (r == NULL) return -1;\n";
3692 pr " print_stat (r);\n";
3696 pr " if (r == NULL) return -1;\n";
3697 pr " print_statvfs (r);\n";
3701 pr " if (r == NULL) return -1;\n";
3702 pr " print_table (r);\n";
3703 pr " free_strings (r);\n";
3710 (* run_action function *)
3711 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
3714 fun (name, _, _, flags, _, _, _) ->
3715 let name2 = replace_char name '_' '-' in
3717 try find_map (function FishAlias n -> Some n | _ -> None) flags
3718 with Not_found -> name in
3720 pr "strcasecmp (cmd, \"%s\") == 0" name;
3721 if name <> name2 then
3722 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
3723 if name <> alias then
3724 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
3726 pr " return run_%s (cmd, argc, argv);\n" name;
3730 pr " fprintf (stderr, \"%%s: unknown command\\n\", cmd);\n";
3737 (* Readline completion for guestfish. *)
3738 and generate_fish_completion () =
3739 generate_header CStyle GPLv2;
3743 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3753 #ifdef HAVE_LIBREADLINE
3754 #include <readline/readline.h>
3759 #ifdef HAVE_LIBREADLINE
3761 static const char *commands[] = {
3764 (* Get the commands and sort them, including the aliases. *)
3767 fun (name, _, _, flags, _, _, _) ->
3768 let name2 = replace_char name '_' '-' in
3770 try find_map (function FishAlias n -> Some n | _ -> None) flags
3771 with Not_found -> name in
3773 if name <> alias then [name2; alias] else [name2]
3775 let commands = List.flatten commands in
3776 let commands = List.sort compare commands in
3778 List.iter (pr " \"%s\",\n") commands;
3784 generator (const char *text, int state)
3786 static int index, len;
3791 len = strlen (text);
3794 while ((name = commands[index]) != NULL) {
3796 if (strncasecmp (name, text, len) == 0)
3797 return strdup (name);
3803 #endif /* HAVE_LIBREADLINE */
3805 char **do_completion (const char *text, int start, int end)
3807 char **matches = NULL;
3809 #ifdef HAVE_LIBREADLINE
3811 matches = rl_completion_matches (text, generator);
3818 (* Generate the POD documentation for guestfish. *)
3819 and generate_fish_actions_pod () =
3820 let all_functions_sorted =
3822 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3823 ) all_functions_sorted in
3825 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
3828 fun (name, style, _, flags, _, _, longdesc) ->
3830 Str.global_substitute rex (
3833 try Str.matched_group 1 s
3835 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
3836 "C<" ^ replace_char sub '_' '-' ^ ">"
3838 let name = replace_char name '_' '-' in
3840 try find_map (function FishAlias n -> Some n | _ -> None) flags
3841 with Not_found -> name in
3843 pr "=head2 %s" name;
3844 if name <> alias then
3851 | String n -> pr " %s" n
3852 | OptString n -> pr " %s" n
3853 | StringList n -> pr " '%s ...'" n
3854 | Bool _ -> pr " true|false"
3855 | Int n -> pr " %s" n
3856 | FileIn n | FileOut n -> pr " (%s|-)" n
3860 pr "%s\n\n" longdesc;
3862 if List.exists (function FileIn _ | FileOut _ -> true
3863 | _ -> false) (snd style) then
3864 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
3866 if List.mem ProtocolLimitWarning flags then
3867 pr "%s\n\n" protocol_limit_warning;
3869 if List.mem DangerWillRobinson flags then
3870 pr "%s\n\n" danger_will_robinson
3871 ) all_functions_sorted
3873 (* Generate a C function prototype. *)
3874 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
3875 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
3877 ?handle name style =
3878 if extern then pr "extern ";
3879 if static then pr "static ";
3880 (match fst style with
3882 | RInt _ -> pr "int "
3883 | RInt64 _ -> pr "int64_t "
3884 | RBool _ -> pr "int "
3885 | RConstString _ -> pr "const char *"
3886 | RString _ -> pr "char *"
3887 | RStringList _ | RHashtable _ -> pr "char **"
3889 if not in_daemon then pr "struct guestfs_int_bool *"
3890 else pr "guestfs_%s_ret *" name
3892 if not in_daemon then pr "struct guestfs_lvm_pv_list *"
3893 else pr "guestfs_lvm_int_pv_list *"
3895 if not in_daemon then pr "struct guestfs_lvm_vg_list *"
3896 else pr "guestfs_lvm_int_vg_list *"
3898 if not in_daemon then pr "struct guestfs_lvm_lv_list *"
3899 else pr "guestfs_lvm_int_lv_list *"
3901 if not in_daemon then pr "struct guestfs_stat *"
3902 else pr "guestfs_int_stat *"
3904 if not in_daemon then pr "struct guestfs_statvfs *"
3905 else pr "guestfs_int_statvfs *"
3907 pr "%s%s (" prefix name;
3908 if handle = None && List.length (snd style) = 0 then
3911 let comma = ref false in
3914 | Some handle -> pr "guestfs_h *%s" handle; comma := true
3918 if single_line then pr ", " else pr ",\n\t\t"
3925 | OptString n -> next (); pr "const char *%s" n
3926 | StringList n -> next (); pr "char * const* const %s" n
3927 | Bool n -> next (); pr "int %s" n
3928 | Int n -> next (); pr "int %s" n
3931 if not in_daemon then (next (); pr "const char *%s" n)
3935 if semicolon then pr ";";
3936 if newline then pr "\n"
3938 (* Generate C call arguments, eg "(handle, foo, bar)" *)
3939 and generate_call_args ?handle args =
3941 let comma = ref false in
3944 | Some handle -> pr "%s" handle; comma := true
3948 if !comma then pr ", ";
3950 pr "%s" (name_of_argt arg)
3954 (* Generate the OCaml bindings interface. *)
3955 and generate_ocaml_mli () =
3956 generate_header OCamlStyle LGPLv2;
3959 (** For API documentation you should refer to the C API
3960 in the guestfs(3) manual page. The OCaml API uses almost
3961 exactly the same calls. *)
3964 (** A [guestfs_h] handle. *)
3966 exception Error of string
3967 (** This exception is raised when there is an error. *)
3969 val create : unit -> t
3971 val close : t -> unit
3972 (** Handles are closed by the garbage collector when they become
3973 unreferenced, but callers can also call this in order to
3974 provide predictable cleanup. *)
3977 generate_ocaml_lvm_structure_decls ();
3979 generate_ocaml_stat_structure_decls ();
3983 fun (name, style, _, _, _, shortdesc, _) ->
3984 generate_ocaml_prototype name style;
3985 pr "(** %s *)\n" shortdesc;
3989 (* Generate the OCaml bindings implementation. *)
3990 and generate_ocaml_ml () =
3991 generate_header OCamlStyle LGPLv2;
3995 exception Error of string
3996 external create : unit -> t = \"ocaml_guestfs_create\"
3997 external close : t -> unit = \"ocaml_guestfs_close\"
4000 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
4004 generate_ocaml_lvm_structure_decls ();
4006 generate_ocaml_stat_structure_decls ();
4010 fun (name, style, _, _, _, shortdesc, _) ->
4011 generate_ocaml_prototype ~is_external:true name style;
4014 (* Generate the OCaml bindings C implementation. *)
4015 and generate_ocaml_c () =
4016 generate_header CStyle LGPLv2;
4023 #include <caml/config.h>
4024 #include <caml/alloc.h>
4025 #include <caml/callback.h>
4026 #include <caml/fail.h>
4027 #include <caml/memory.h>
4028 #include <caml/mlvalues.h>
4029 #include <caml/signals.h>
4031 #include <guestfs.h>
4033 #include \"guestfs_c.h\"
4035 /* Copy a hashtable of string pairs into an assoc-list. We return
4036 * the list in reverse order, but hashtables aren't supposed to be
4039 static CAMLprim value
4040 copy_table (char * const * argv)
4043 CAMLlocal5 (rv, pairv, kv, vv, cons);
4047 for (i = 0; argv[i] != NULL; i += 2) {
4048 kv = caml_copy_string (argv[i]);
4049 vv = caml_copy_string (argv[i+1]);
4050 pairv = caml_alloc (2, 0);
4051 Store_field (pairv, 0, kv);
4052 Store_field (pairv, 1, vv);
4053 cons = caml_alloc (2, 0);
4054 Store_field (cons, 1, rv);
4056 Store_field (cons, 0, pairv);
4064 (* LVM struct copy functions. *)
4067 let has_optpercent_col =
4068 List.exists (function (_, `OptPercent) -> true | _ -> false) cols in
4070 pr "static CAMLprim value\n";
4071 pr "copy_lvm_%s (const struct guestfs_lvm_%s *%s)\n" typ typ typ;
4073 pr " CAMLparam0 ();\n";
4074 if has_optpercent_col then
4075 pr " CAMLlocal3 (rv, v, v2);\n"
4077 pr " CAMLlocal2 (rv, v);\n";
4079 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
4084 pr " v = caml_copy_string (%s->%s);\n" typ name
4086 pr " v = caml_alloc_string (32);\n";
4087 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
4090 pr " v = caml_copy_int64 (%s->%s);\n" typ name
4091 | name, `OptPercent ->
4092 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
4093 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
4094 pr " v = caml_alloc (1, 0);\n";
4095 pr " Store_field (v, 0, v2);\n";
4096 pr " } else /* None */\n";
4097 pr " v = Val_int (0);\n";
4099 pr " Store_field (rv, %d, v);\n" i
4101 pr " CAMLreturn (rv);\n";
4105 pr "static CAMLprim value\n";
4106 pr "copy_lvm_%s_list (const struct guestfs_lvm_%s_list *%ss)\n"
4109 pr " CAMLparam0 ();\n";
4110 pr " CAMLlocal2 (rv, v);\n";
4113 pr " if (%ss->len == 0)\n" typ;
4114 pr " CAMLreturn (Atom (0));\n";
4116 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
4117 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
4118 pr " v = copy_lvm_%s (&%ss->val[i]);\n" typ typ;
4119 pr " caml_modify (&Field (rv, i), v);\n";
4121 pr " CAMLreturn (rv);\n";
4125 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
4127 (* Stat copy functions. *)
4130 pr "static CAMLprim value\n";
4131 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
4133 pr " CAMLparam0 ();\n";
4134 pr " CAMLlocal2 (rv, v);\n";
4136 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
4141 pr " v = caml_copy_int64 (%s->%s);\n" typ name
4143 pr " Store_field (rv, %d, v);\n" i
4145 pr " CAMLreturn (rv);\n";
4148 ) ["stat", stat_cols; "statvfs", statvfs_cols];
4152 fun (name, style, _, _, _, _, _) ->
4154 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
4156 pr "CAMLprim value\n";
4157 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
4158 List.iter (pr ", value %s") (List.tl params);
4163 | [p1; p2; p3; p4; p5] ->
4164 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
4165 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
4166 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
4167 pr " CAMLxparam%d (%s);\n"
4168 (List.length rest) (String.concat ", " rest)
4170 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
4172 pr " CAMLlocal1 (rv);\n";
4175 pr " guestfs_h *g = Guestfs_val (gv);\n";
4176 pr " if (g == NULL)\n";
4177 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
4185 pr " const char *%s = String_val (%sv);\n" n n
4187 pr " const char *%s =\n" n;
4188 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
4191 pr " char **%s = ocaml_guestfs_strings_val (%sv);\n" n n
4193 pr " int %s = Bool_val (%sv);\n" n n
4195 pr " int %s = Int_val (%sv);\n" n n
4198 match fst style with
4199 | RErr -> pr " int r;\n"; "-1"
4200 | RInt _ -> pr " int r;\n"; "-1"
4201 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4202 | RBool _ -> pr " int r;\n"; "-1"
4203 | RConstString _ -> pr " const char *r;\n"; "NULL"
4204 | RString _ -> pr " char *r;\n"; "NULL"
4210 pr " struct guestfs_int_bool *r;\n"; "NULL"
4212 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
4214 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
4216 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
4218 pr " struct guestfs_stat *r;\n"; "NULL"
4220 pr " struct guestfs_statvfs *r;\n"; "NULL"
4227 pr " caml_enter_blocking_section ();\n";
4228 pr " r = guestfs_%s " name;
4229 generate_call_args ~handle:"g" (snd style);
4231 pr " caml_leave_blocking_section ();\n";
4236 pr " ocaml_guestfs_free_strings (%s);\n" n;
4237 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
4240 pr " if (r == %s)\n" error_code;
4241 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
4244 (match fst style with
4245 | RErr -> pr " rv = Val_unit;\n"
4246 | RInt _ -> pr " rv = Val_int (r);\n"
4248 pr " rv = caml_copy_int64 (r);\n"
4249 | RBool _ -> pr " rv = Val_bool (r);\n"
4250 | RConstString _ -> pr " rv = caml_copy_string (r);\n"
4252 pr " rv = caml_copy_string (r);\n";
4255 pr " rv = caml_copy_string_array ((const char **) r);\n";
4256 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
4259 pr " rv = caml_alloc (2, 0);\n";
4260 pr " Store_field (rv, 0, Val_int (r->i));\n";
4261 pr " Store_field (rv, 1, Val_bool (r->b));\n";
4262 pr " guestfs_free_int_bool (r);\n";
4264 pr " rv = copy_lvm_pv_list (r);\n";
4265 pr " guestfs_free_lvm_pv_list (r);\n";
4267 pr " rv = copy_lvm_vg_list (r);\n";
4268 pr " guestfs_free_lvm_vg_list (r);\n";
4270 pr " rv = copy_lvm_lv_list (r);\n";
4271 pr " guestfs_free_lvm_lv_list (r);\n";
4273 pr " rv = copy_stat (r);\n";
4276 pr " rv = copy_statvfs (r);\n";
4279 pr " rv = copy_table (r);\n";
4280 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
4284 pr " CAMLreturn (rv);\n";
4288 if List.length params > 5 then (
4289 pr "CAMLprim value\n";
4290 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
4292 pr " return ocaml_guestfs_%s (argv[0]" name;
4293 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
4300 and generate_ocaml_lvm_structure_decls () =
4303 pr "type lvm_%s = {\n" typ;
4306 | name, `String -> pr " %s : string;\n" name
4307 | name, `UUID -> pr " %s : string;\n" name
4308 | name, `Bytes -> pr " %s : int64;\n" name
4309 | name, `Int -> pr " %s : int64;\n" name
4310 | name, `OptPercent -> pr " %s : float option;\n" name
4314 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
4316 and generate_ocaml_stat_structure_decls () =
4319 pr "type %s = {\n" typ;
4322 | name, `Int -> pr " %s : int64;\n" name
4326 ) ["stat", stat_cols; "statvfs", statvfs_cols]
4328 and generate_ocaml_prototype ?(is_external = false) name style =
4329 if is_external then pr "external " else pr "val ";
4330 pr "%s : t -> " name;
4333 | String _ | FileIn _ | FileOut _ -> pr "string -> "
4334 | OptString _ -> pr "string option -> "
4335 | StringList _ -> pr "string array -> "
4336 | Bool _ -> pr "bool -> "
4337 | Int _ -> pr "int -> "
4339 (match fst style with
4340 | RErr -> pr "unit" (* all errors are turned into exceptions *)
4341 | RInt _ -> pr "int"
4342 | RInt64 _ -> pr "int64"
4343 | RBool _ -> pr "bool"
4344 | RConstString _ -> pr "string"
4345 | RString _ -> pr "string"
4346 | RStringList _ -> pr "string array"
4347 | RIntBool _ -> pr "int * bool"
4348 | RPVList _ -> pr "lvm_pv array"
4349 | RVGList _ -> pr "lvm_vg array"
4350 | RLVList _ -> pr "lvm_lv array"
4351 | RStat _ -> pr "stat"
4352 | RStatVFS _ -> pr "statvfs"
4353 | RHashtable _ -> pr "(string * string) list"
4355 if is_external then (
4357 if List.length (snd style) + 1 > 5 then
4358 pr "\"ocaml_guestfs_%s_byte\" " name;
4359 pr "\"ocaml_guestfs_%s\"" name
4363 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
4364 and generate_perl_xs () =
4365 generate_header CStyle LGPLv2;
4368 #include \"EXTERN.h\"
4372 #include <guestfs.h>
4375 #define PRId64 \"lld\"
4379 my_newSVll(long long val) {
4380 #ifdef USE_64_BIT_ALL
4381 return newSViv(val);
4385 len = snprintf(buf, 100, \"%%\" PRId64, val);
4386 return newSVpv(buf, len);
4391 #define PRIu64 \"llu\"
4395 my_newSVull(unsigned long long val) {
4396 #ifdef USE_64_BIT_ALL
4397 return newSVuv(val);
4401 len = snprintf(buf, 100, \"%%\" PRIu64, val);
4402 return newSVpv(buf, len);
4406 /* http://www.perlmonks.org/?node_id=680842 */
4408 XS_unpack_charPtrPtr (SV *arg) {
4413 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV) {
4414 croak (\"array reference expected\");
4417 av = (AV *)SvRV (arg);
4418 ret = (char **)malloc (av_len (av) + 1 + 1);
4420 for (i = 0; i <= av_len (av); i++) {
4421 SV **elem = av_fetch (av, i, 0);
4423 if (!elem || !*elem)
4424 croak (\"missing element in list\");
4426 ret[i] = SvPV_nolen (*elem);
4434 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
4439 RETVAL = guestfs_create ();
4441 croak (\"could not create guestfs handle\");
4442 guestfs_set_error_handler (RETVAL, NULL, NULL);
4455 fun (name, style, _, _, _, _, _) ->
4456 (match fst style with
4457 | RErr -> pr "void\n"
4458 | RInt _ -> pr "SV *\n"
4459 | RInt64 _ -> pr "SV *\n"
4460 | RBool _ -> pr "SV *\n"
4461 | RConstString _ -> pr "SV *\n"
4462 | RString _ -> pr "SV *\n"
4465 | RPVList _ | RVGList _ | RLVList _
4466 | RStat _ | RStatVFS _
4468 pr "void\n" (* all lists returned implictly on the stack *)
4470 (* Call and arguments. *)
4472 generate_call_args ~handle:"g" (snd style);
4474 pr " guestfs_h *g;\n";
4477 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
4478 | OptString n -> pr " char *%s;\n" n
4479 | StringList n -> pr " char **%s;\n" n
4480 | Bool n -> pr " int %s;\n" n
4481 | Int n -> pr " int %s;\n" n
4484 let do_cleanups () =
4487 | String _ | OptString _ | Bool _ | Int _
4488 | FileIn _ | FileOut _ -> ()
4489 | StringList n -> pr " free (%s);\n" n
4494 (match fst style with
4499 pr " r = guestfs_%s " name;
4500 generate_call_args ~handle:"g" (snd style);
4503 pr " if (r == -1)\n";
4504 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4510 pr " %s = guestfs_%s " n name;
4511 generate_call_args ~handle:"g" (snd style);
4514 pr " if (%s == -1)\n" n;
4515 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4516 pr " RETVAL = newSViv (%s);\n" n;
4521 pr " int64_t %s;\n" n;
4523 pr " %s = guestfs_%s " n name;
4524 generate_call_args ~handle:"g" (snd style);
4527 pr " if (%s == -1)\n" n;
4528 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4529 pr " RETVAL = my_newSVll (%s);\n" n;
4534 pr " const char *%s;\n" n;
4536 pr " %s = guestfs_%s " n name;
4537 generate_call_args ~handle:"g" (snd style);
4540 pr " if (%s == NULL)\n" n;
4541 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4542 pr " RETVAL = newSVpv (%s, 0);\n" n;
4547 pr " char *%s;\n" n;
4549 pr " %s = guestfs_%s " n name;
4550 generate_call_args ~handle:"g" (snd style);
4553 pr " if (%s == NULL)\n" n;
4554 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4555 pr " RETVAL = newSVpv (%s, 0);\n" n;
4556 pr " free (%s);\n" n;
4559 | RStringList n | RHashtable n ->
4561 pr " char **%s;\n" n;
4564 pr " %s = guestfs_%s " n name;
4565 generate_call_args ~handle:"g" (snd style);
4568 pr " if (%s == NULL)\n" n;
4569 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4570 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
4571 pr " EXTEND (SP, n);\n";
4572 pr " for (i = 0; i < n; ++i) {\n";
4573 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
4574 pr " free (%s[i]);\n" n;
4576 pr " free (%s);\n" n;
4579 pr " struct guestfs_int_bool *r;\n";
4581 pr " r = guestfs_%s " name;
4582 generate_call_args ~handle:"g" (snd style);
4585 pr " if (r == NULL)\n";
4586 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4587 pr " EXTEND (SP, 2);\n";
4588 pr " PUSHs (sv_2mortal (newSViv (r->i)));\n";
4589 pr " PUSHs (sv_2mortal (newSViv (r->b)));\n";
4590 pr " guestfs_free_int_bool (r);\n";
4592 generate_perl_lvm_code "pv" pv_cols name style n do_cleanups
4594 generate_perl_lvm_code "vg" vg_cols name style n do_cleanups
4596 generate_perl_lvm_code "lv" lv_cols name style n do_cleanups
4598 generate_perl_stat_code "stat" stat_cols name style n do_cleanups
4600 generate_perl_stat_code
4601 "statvfs" statvfs_cols name style n do_cleanups
4607 and generate_perl_lvm_code typ cols name style n do_cleanups =
4609 pr " struct guestfs_lvm_%s_list *%s;\n" typ n;
4613 pr " %s = guestfs_%s " n name;
4614 generate_call_args ~handle:"g" (snd style);
4617 pr " if (%s == NULL)\n" n;
4618 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4619 pr " EXTEND (SP, %s->len);\n" n;
4620 pr " for (i = 0; i < %s->len; ++i) {\n" n;
4621 pr " hv = newHV ();\n";
4625 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
4626 name (String.length name) n name
4628 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
4629 name (String.length name) n name
4631 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
4632 name (String.length name) n name
4634 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
4635 name (String.length name) n name
4636 | name, `OptPercent ->
4637 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
4638 name (String.length name) n name
4640 pr " PUSHs (sv_2mortal ((SV *) hv));\n";
4642 pr " guestfs_free_lvm_%s_list (%s);\n" typ n
4644 and generate_perl_stat_code typ cols name style n do_cleanups =
4646 pr " struct guestfs_%s *%s;\n" typ n;
4648 pr " %s = guestfs_%s " n name;
4649 generate_call_args ~handle:"g" (snd style);
4652 pr " if (%s == NULL)\n" n;
4653 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4654 pr " EXTEND (SP, %d);\n" (List.length cols);
4658 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n" n name
4660 pr " free (%s);\n" n
4662 (* Generate Sys/Guestfs.pm. *)
4663 and generate_perl_pm () =
4664 generate_header HashStyle LGPLv2;
4671 Sys::Guestfs - Perl bindings for libguestfs
4677 my $h = Sys::Guestfs->new ();
4678 $h->add_drive ('guest.img');
4681 $h->mount ('/dev/sda1', '/');
4682 $h->touch ('/hello');
4687 The C<Sys::Guestfs> module provides a Perl XS binding to the
4688 libguestfs API for examining and modifying virtual machine
4691 Amongst the things this is good for: making batch configuration
4692 changes to guests, getting disk used/free statistics (see also:
4693 virt-df), migrating between virtualization systems (see also:
4694 virt-p2v), performing partial backups, performing partial guest
4695 clones, cloning guests and changing registry/UUID/hostname info, and
4698 Libguestfs uses Linux kernel and qemu code, and can access any type of
4699 guest filesystem that Linux and qemu can, including but not limited
4700 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
4701 schemes, qcow, qcow2, vmdk.
4703 Libguestfs provides ways to enumerate guest storage (eg. partitions,
4704 LVs, what filesystem is in each LV, etc.). It can also run commands
4705 in the context of the guest. Also you can access filesystems over FTP.
4709 All errors turn into calls to C<croak> (see L<Carp(3)>).
4717 package Sys::Guestfs;
4723 XSLoader::load ('Sys::Guestfs');
4725 =item $h = Sys::Guestfs->new ();
4727 Create a new guestfs handle.
4733 my $class = ref ($proto) || $proto;
4735 my $self = Sys::Guestfs::_create ();
4736 bless $self, $class;
4742 (* Actions. We only need to print documentation for these as
4743 * they are pulled in from the XS code automatically.
4746 fun (name, style, _, flags, _, _, longdesc) ->
4747 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
4749 generate_perl_prototype name style;
4751 pr "%s\n\n" longdesc;
4752 if List.mem ProtocolLimitWarning flags then
4753 pr "%s\n\n" protocol_limit_warning;
4754 if List.mem DangerWillRobinson flags then
4755 pr "%s\n\n" danger_will_robinson
4756 ) all_functions_sorted;
4768 Copyright (C) 2009 Red Hat Inc.
4772 Please see the file COPYING.LIB for the full license.
4776 L<guestfs(3)>, L<guestfish(1)>.
4781 and generate_perl_prototype name style =
4782 (match fst style with
4788 | RString n -> pr "$%s = " n
4789 | RIntBool (n, m) -> pr "($%s, $%s) = " n m
4793 | RLVList n -> pr "@%s = " n
4796 | RHashtable n -> pr "%%%s = " n
4799 let comma = ref false in
4802 if !comma then pr ", ";
4805 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
4812 (* Generate Python C module. *)
4813 and generate_python_c () =
4814 generate_header CStyle LGPLv2;
4823 #include \"guestfs.h\"
4831 get_handle (PyObject *obj)
4834 assert (obj != Py_None);
4835 return ((Pyguestfs_Object *) obj)->g;
4839 put_handle (guestfs_h *g)
4843 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
4846 /* This list should be freed (but not the strings) after use. */
4847 static const char **
4848 get_string_list (PyObject *obj)
4855 if (!PyList_Check (obj)) {
4856 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
4860 len = PyList_Size (obj);
4861 r = malloc (sizeof (char *) * (len+1));
4863 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
4867 for (i = 0; i < len; ++i)
4868 r[i] = PyString_AsString (PyList_GetItem (obj, i));
4875 put_string_list (char * const * const argv)
4880 for (argc = 0; argv[argc] != NULL; ++argc)
4883 list = PyList_New (argc);
4884 for (i = 0; i < argc; ++i)
4885 PyList_SetItem (list, i, PyString_FromString (argv[i]));
4891 put_table (char * const * const argv)
4893 PyObject *list, *item;
4896 for (argc = 0; argv[argc] != NULL; ++argc)
4899 list = PyList_New (argc >> 1);
4900 for (i = 0; i < argc; i += 2) {
4901 item = PyTuple_New (2);
4902 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
4903 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
4904 PyList_SetItem (list, i >> 1, item);
4911 free_strings (char **argv)
4915 for (argc = 0; argv[argc] != NULL; ++argc)
4921 py_guestfs_create (PyObject *self, PyObject *args)
4925 g = guestfs_create ();
4927 PyErr_SetString (PyExc_RuntimeError,
4928 \"guestfs.create: failed to allocate handle\");
4931 guestfs_set_error_handler (g, NULL, NULL);
4932 return put_handle (g);
4936 py_guestfs_close (PyObject *self, PyObject *args)
4941 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
4943 g = get_handle (py_g);
4947 Py_INCREF (Py_None);
4953 (* LVM structures, turned into Python dictionaries. *)
4956 pr "static PyObject *\n";
4957 pr "put_lvm_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
4959 pr " PyObject *dict;\n";
4961 pr " dict = PyDict_New ();\n";
4965 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
4966 pr " PyString_FromString (%s->%s));\n"
4969 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
4970 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
4973 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
4974 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
4977 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
4978 pr " PyLong_FromLongLong (%s->%s));\n"
4980 | name, `OptPercent ->
4981 pr " if (%s->%s >= 0)\n" typ name;
4982 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
4983 pr " PyFloat_FromDouble ((double) %s->%s));\n"
4986 pr " Py_INCREF (Py_None);\n";
4987 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
4990 pr " return dict;\n";
4994 pr "static PyObject *\n";
4995 pr "put_lvm_%s_list (struct guestfs_lvm_%s_list *%ss)\n" typ typ typ;
4997 pr " PyObject *list;\n";
5000 pr " list = PyList_New (%ss->len);\n" typ;
5001 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
5002 pr " PyList_SetItem (list, i, put_lvm_%s (&%ss->val[i]));\n" typ typ;
5003 pr " return list;\n";
5006 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
5008 (* Stat structures, turned into Python dictionaries. *)
5011 pr "static PyObject *\n";
5012 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
5014 pr " PyObject *dict;\n";
5016 pr " dict = PyDict_New ();\n";
5020 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5021 pr " PyLong_FromLongLong (%s->%s));\n"
5024 pr " return dict;\n";
5027 ) ["stat", stat_cols; "statvfs", statvfs_cols];
5029 (* Python wrapper functions. *)
5031 fun (name, style, _, _, _, _, _) ->
5032 pr "static PyObject *\n";
5033 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
5036 pr " PyObject *py_g;\n";
5037 pr " guestfs_h *g;\n";
5038 pr " PyObject *py_r;\n";
5041 match fst style with
5042 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5043 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5044 | RConstString _ -> pr " const char *r;\n"; "NULL"
5045 | RString _ -> pr " char *r;\n"; "NULL"
5046 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5047 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
5048 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5049 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5050 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5051 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
5052 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
5056 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
5057 | OptString n -> pr " const char *%s;\n" n
5059 pr " PyObject *py_%s;\n" n;
5060 pr " const char **%s;\n" n
5061 | Bool n -> pr " int %s;\n" n
5062 | Int n -> pr " int %s;\n" n
5067 (* Convert the parameters. *)
5068 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
5071 | String _ | FileIn _ | FileOut _ -> pr "s"
5072 | OptString _ -> pr "z"
5073 | StringList _ -> pr "O"
5074 | Bool _ -> pr "i" (* XXX Python has booleans? *)
5077 pr ":guestfs_%s\",\n" name;
5081 | String n | FileIn n | FileOut n -> pr ", &%s" n
5082 | OptString n -> pr ", &%s" n
5083 | StringList n -> pr ", &py_%s" n
5084 | Bool n -> pr ", &%s" n
5085 | Int n -> pr ", &%s" n
5089 pr " return NULL;\n";
5091 pr " g = get_handle (py_g);\n";
5094 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5096 pr " %s = get_string_list (py_%s);\n" n n;
5097 pr " if (!%s) return NULL;\n" n
5102 pr " r = guestfs_%s " name;
5103 generate_call_args ~handle:"g" (snd style);
5108 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5110 pr " free (%s);\n" n
5113 pr " if (r == %s) {\n" error_code;
5114 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
5115 pr " return NULL;\n";
5119 (match fst style with
5121 pr " Py_INCREF (Py_None);\n";
5122 pr " py_r = Py_None;\n"
5124 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
5125 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
5126 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
5128 pr " py_r = PyString_FromString (r);\n";
5131 pr " py_r = put_string_list (r);\n";
5132 pr " free_strings (r);\n"
5134 pr " py_r = PyTuple_New (2);\n";
5135 pr " PyTuple_SetItem (py_r, 0, PyInt_FromLong ((long) r->i));\n";
5136 pr " PyTuple_SetItem (py_r, 1, PyInt_FromLong ((long) r->b));\n";
5137 pr " guestfs_free_int_bool (r);\n"
5139 pr " py_r = put_lvm_pv_list (r);\n";
5140 pr " guestfs_free_lvm_pv_list (r);\n"
5142 pr " py_r = put_lvm_vg_list (r);\n";
5143 pr " guestfs_free_lvm_vg_list (r);\n"
5145 pr " py_r = put_lvm_lv_list (r);\n";
5146 pr " guestfs_free_lvm_lv_list (r);\n"
5148 pr " py_r = put_stat (r);\n";
5151 pr " py_r = put_statvfs (r);\n";
5154 pr " py_r = put_table (r);\n";
5155 pr " free_strings (r);\n"
5158 pr " return py_r;\n";
5163 (* Table of functions. *)
5164 pr "static PyMethodDef methods[] = {\n";
5165 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
5166 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
5168 fun (name, _, _, _, _, _, _) ->
5169 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
5172 pr " { NULL, NULL, 0, NULL }\n";
5176 (* Init function. *)
5179 initlibguestfsmod (void)
5181 static int initialized = 0;
5183 if (initialized) return;
5184 Py_InitModule ((char *) \"libguestfsmod\", methods);
5189 (* Generate Python module. *)
5190 and generate_python_py () =
5191 generate_header HashStyle LGPLv2;
5194 u\"\"\"Python bindings for libguestfs
5197 g = guestfs.GuestFS ()
5198 g.add_drive (\"guest.img\")
5201 parts = g.list_partitions ()
5203 The guestfs module provides a Python binding to the libguestfs API
5204 for examining and modifying virtual machine disk images.
5206 Amongst the things this is good for: making batch configuration
5207 changes to guests, getting disk used/free statistics (see also:
5208 virt-df), migrating between virtualization systems (see also:
5209 virt-p2v), performing partial backups, performing partial guest
5210 clones, cloning guests and changing registry/UUID/hostname info, and
5213 Libguestfs uses Linux kernel and qemu code, and can access any type of
5214 guest filesystem that Linux and qemu can, including but not limited
5215 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
5216 schemes, qcow, qcow2, vmdk.
5218 Libguestfs provides ways to enumerate guest storage (eg. partitions,
5219 LVs, what filesystem is in each LV, etc.). It can also run commands
5220 in the context of the guest. Also you can access filesystems over FTP.
5222 Errors which happen while using the API are turned into Python
5223 RuntimeError exceptions.
5225 To create a guestfs handle you usually have to perform the following
5228 # Create the handle, call add_drive at least once, and possibly
5229 # several times if the guest has multiple block devices:
5230 g = guestfs.GuestFS ()
5231 g.add_drive (\"guest.img\")
5233 # Launch the qemu subprocess and wait for it to become ready:
5237 # Now you can issue commands, for example:
5242 import libguestfsmod
5245 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
5247 def __init__ (self):
5248 \"\"\"Create a new libguestfs handle.\"\"\"
5249 self._o = libguestfsmod.create ()
5252 libguestfsmod.close (self._o)
5257 fun (name, style, _, flags, _, _, longdesc) ->
5258 let doc = replace_str longdesc "C<guestfs_" "C<g." in
5260 match fst style with
5261 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _
5264 doc ^ "\n\nThis function returns a list of strings."
5266 doc ^ "\n\nThis function returns a tuple (int, bool).\n"
5268 doc ^ "\n\nThis function returns a list of PVs. Each PV is represented as a dictionary."
5270 doc ^ "\n\nThis function returns a list of VGs. Each VG is represented as a dictionary."
5272 doc ^ "\n\nThis function returns a list of LVs. Each LV is represented as a dictionary."
5274 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the stat structure."
5276 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the statvfs structure."
5278 doc ^ "\n\nThis function returns a dictionary." in
5280 if List.mem ProtocolLimitWarning flags then
5281 doc ^ "\n\n" ^ protocol_limit_warning
5284 if List.mem DangerWillRobinson flags then
5285 doc ^ "\n\n" ^ danger_will_robinson
5287 let doc = pod2text ~width:60 name doc in
5288 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
5289 let doc = String.concat "\n " doc in
5292 generate_call_args ~handle:"self" (snd style);
5294 pr " u\"\"\"%s\"\"\"\n" doc;
5295 pr " return libguestfsmod.%s " name;
5296 generate_call_args ~handle:"self._o" (snd style);
5301 (* Useful if you need the longdesc POD text as plain text. Returns a
5304 * This is the slowest thing about autogeneration.
5306 and pod2text ~width name longdesc =
5307 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
5308 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
5310 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
5311 let chan = Unix.open_process_in cmd in
5312 let lines = ref [] in
5314 let line = input_line chan in
5315 if i = 1 then (* discard the first line of output *)
5318 let line = triml line in
5319 lines := line :: !lines;
5322 let lines = try loop 1 with End_of_file -> List.rev !lines in
5323 Unix.unlink filename;
5324 match Unix.close_process_in chan with
5325 | Unix.WEXITED 0 -> lines
5327 failwithf "pod2text: process exited with non-zero status (%d)" i
5328 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
5329 failwithf "pod2text: process signalled or stopped by signal %d" i
5331 (* Generate ruby bindings. *)
5332 and generate_ruby_c () =
5333 generate_header CStyle LGPLv2;
5341 #include \"guestfs.h\"
5343 #include \"extconf.h\"
5345 static VALUE m_guestfs; /* guestfs module */
5346 static VALUE c_guestfs; /* guestfs_h handle */
5347 static VALUE e_Error; /* used for all errors */
5349 static void ruby_guestfs_free (void *p)
5352 guestfs_close ((guestfs_h *) p);
5355 static VALUE ruby_guestfs_create (VALUE m)
5359 g = guestfs_create ();
5361 rb_raise (e_Error, \"failed to create guestfs handle\");
5363 /* Don't print error messages to stderr by default. */
5364 guestfs_set_error_handler (g, NULL, NULL);
5366 /* Wrap it, and make sure the close function is called when the
5369 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
5372 static VALUE ruby_guestfs_close (VALUE gv)
5375 Data_Get_Struct (gv, guestfs_h, g);
5377 ruby_guestfs_free (g);
5378 DATA_PTR (gv) = NULL;
5386 fun (name, style, _, _, _, _, _) ->
5387 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
5388 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
5391 pr " guestfs_h *g;\n";
5392 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
5394 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
5400 | String n | FileIn n | FileOut n ->
5401 pr " const char *%s = StringValueCStr (%sv);\n" n n;
5403 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
5404 pr " \"%s\", \"%s\");\n" n name
5406 pr " const char *%s = StringValueCStr (%sv);\n" n n
5410 pr " int i, len;\n";
5411 pr " len = RARRAY_LEN (%sv);\n" n;
5412 pr " %s = malloc (sizeof (char *) * (len+1));\n" n;
5413 pr " for (i = 0; i < len; ++i) {\n";
5414 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
5415 pr " %s[i] = StringValueCStr (v);\n" n;
5417 pr " %s[len] = NULL;\n" n;
5421 pr " int %s = NUM2INT (%sv);\n" n n
5426 match fst style with
5427 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5428 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5429 | RConstString _ -> pr " const char *r;\n"; "NULL"
5430 | RString _ -> pr " char *r;\n"; "NULL"
5431 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5432 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
5433 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5434 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5435 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5436 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
5437 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
5440 pr " r = guestfs_%s " name;
5441 generate_call_args ~handle:"g" (snd style);
5446 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5448 pr " free (%s);\n" n
5451 pr " if (r == %s)\n" error_code;
5452 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
5455 (match fst style with
5457 pr " return Qnil;\n"
5458 | RInt _ | RBool _ ->
5459 pr " return INT2NUM (r);\n"
5461 pr " return ULL2NUM (r);\n"
5463 pr " return rb_str_new2 (r);\n";
5465 pr " VALUE rv = rb_str_new2 (r);\n";
5469 pr " int i, len = 0;\n";
5470 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
5471 pr " VALUE rv = rb_ary_new2 (len);\n";
5472 pr " for (i = 0; r[i] != NULL; ++i) {\n";
5473 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
5474 pr " free (r[i]);\n";
5479 pr " VALUE rv = rb_ary_new2 (2);\n";
5480 pr " rb_ary_push (rv, INT2NUM (r->i));\n";
5481 pr " rb_ary_push (rv, INT2NUM (r->b));\n";
5482 pr " guestfs_free_int_bool (r);\n";
5485 generate_ruby_lvm_code "pv" pv_cols
5487 generate_ruby_lvm_code "vg" vg_cols
5489 generate_ruby_lvm_code "lv" lv_cols
5491 pr " VALUE rv = rb_hash_new ();\n";
5495 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
5500 pr " VALUE rv = rb_hash_new ();\n";
5504 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
5509 pr " VALUE rv = rb_hash_new ();\n";
5511 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
5512 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
5513 pr " free (r[i]);\n";
5514 pr " free (r[i+1]);\n";
5525 /* Initialize the module. */
5526 void Init__guestfs ()
5528 m_guestfs = rb_define_module (\"Guestfs\");
5529 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
5530 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
5532 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
5533 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
5536 (* Define the rest of the methods. *)
5538 fun (name, style, _, _, _, _, _) ->
5539 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
5540 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
5545 (* Ruby code to return an LVM struct list. *)
5546 and generate_ruby_lvm_code typ cols =
5547 pr " VALUE rv = rb_ary_new2 (r->len);\n";
5549 pr " for (i = 0; i < r->len; ++i) {\n";
5550 pr " VALUE hv = rb_hash_new ();\n";
5554 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
5556 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
5559 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
5560 | name, `OptPercent ->
5561 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
5563 pr " rb_ary_push (rv, hv);\n";
5565 pr " guestfs_free_lvm_%s_list (r);\n" typ;
5568 (* Generate Java bindings GuestFS.java file. *)
5569 and generate_java_java () =
5570 generate_header CStyle LGPLv2;
5573 package com.redhat.et.libguestfs;
5575 import java.util.HashMap;
5576 import com.redhat.et.libguestfs.LibGuestFSException;
5577 import com.redhat.et.libguestfs.PV;
5578 import com.redhat.et.libguestfs.VG;
5579 import com.redhat.et.libguestfs.LV;
5580 import com.redhat.et.libguestfs.Stat;
5581 import com.redhat.et.libguestfs.StatVFS;
5582 import com.redhat.et.libguestfs.IntBool;
5585 * The GuestFS object is a libguestfs handle.
5589 public class GuestFS {
5590 // Load the native code.
5592 System.loadLibrary (\"guestfs_jni\");
5596 * The native guestfs_h pointer.
5601 * Create a libguestfs handle.
5603 * @throws LibGuestFSException
5605 public GuestFS () throws LibGuestFSException
5609 private native long _create () throws LibGuestFSException;
5612 * Close a libguestfs handle.
5614 * You can also leave handles to be collected by the garbage
5615 * collector, but this method ensures that the resources used
5616 * by the handle are freed up immediately. If you call any
5617 * other methods after closing the handle, you will get an
5620 * @throws LibGuestFSException
5622 public void close () throws LibGuestFSException
5628 private native void _close (long g) throws LibGuestFSException;
5630 public void finalize () throws LibGuestFSException
5638 fun (name, style, _, flags, _, shortdesc, longdesc) ->
5639 let doc = replace_str longdesc "C<guestfs_" "C<g." in
5641 if List.mem ProtocolLimitWarning flags then
5642 doc ^ "\n\n" ^ protocol_limit_warning
5645 if List.mem DangerWillRobinson flags then
5646 doc ^ "\n\n" ^ danger_will_robinson
5648 let doc = pod2text ~width:60 name doc in
5649 let doc = String.concat "\n * " doc in
5652 pr " * %s\n" shortdesc;
5655 pr " * @throws LibGuestFSException\n";
5658 generate_java_prototype ~public:true ~semicolon:false name style;
5661 pr " if (g == 0)\n";
5662 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
5665 if fst style <> RErr then pr "return ";
5667 generate_call_args ~handle:"g" (snd style);
5671 generate_java_prototype ~privat:true ~native:true name style;
5678 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
5679 ?(semicolon=true) name style =
5680 if privat then pr "private ";
5681 if public then pr "public ";
5682 if native then pr "native ";
5685 (match fst style with
5686 | RErr -> pr "void ";
5687 | RInt _ -> pr "int ";
5688 | RInt64 _ -> pr "long ";
5689 | RBool _ -> pr "boolean ";
5690 | RConstString _ | RString _ -> pr "String ";
5691 | RStringList _ -> pr "String[] ";
5692 | RIntBool _ -> pr "IntBool ";
5693 | RPVList _ -> pr "PV[] ";
5694 | RVGList _ -> pr "VG[] ";
5695 | RLVList _ -> pr "LV[] ";
5696 | RStat _ -> pr "Stat ";
5697 | RStatVFS _ -> pr "StatVFS ";
5698 | RHashtable _ -> pr "HashMap<String,String> ";
5701 if native then pr "_%s " name else pr "%s " name;
5703 let needs_comma = ref false in
5712 if !needs_comma then pr ", ";
5713 needs_comma := true;
5730 pr " throws LibGuestFSException";
5731 if semicolon then pr ";"
5733 and generate_java_struct typ cols =
5734 generate_header CStyle LGPLv2;
5737 package com.redhat.et.libguestfs;
5740 * Libguestfs %s structure.
5751 | name, `UUID -> pr " public String %s;\n" name
5753 | name, `Int -> pr " public long %s;\n" name
5754 | name, `OptPercent ->
5755 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
5756 pr " public float %s;\n" name
5761 and generate_java_c () =
5762 generate_header CStyle LGPLv2;
5769 #include \"com_redhat_et_libguestfs_GuestFS.h\"
5770 #include \"guestfs.h\"
5772 /* Note that this function returns. The exception is not thrown
5773 * until after the wrapper function returns.
5776 throw_exception (JNIEnv *env, const char *msg)
5779 cl = (*env)->FindClass (env,
5780 \"com/redhat/et/libguestfs/LibGuestFSException\");
5781 (*env)->ThrowNew (env, cl, msg);
5784 JNIEXPORT jlong JNICALL
5785 Java_com_redhat_et_libguestfs_GuestFS__1create
5786 (JNIEnv *env, jobject obj)
5790 g = guestfs_create ();
5792 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
5795 guestfs_set_error_handler (g, NULL, NULL);
5796 return (jlong) (long) g;
5799 JNIEXPORT void JNICALL
5800 Java_com_redhat_et_libguestfs_GuestFS__1close
5801 (JNIEnv *env, jobject obj, jlong jg)
5803 guestfs_h *g = (guestfs_h *) (long) jg;
5810 fun (name, style, _, _, _, _, _) ->
5812 (match fst style with
5813 | RErr -> pr "void ";
5814 | RInt _ -> pr "jint ";
5815 | RInt64 _ -> pr "jlong ";
5816 | RBool _ -> pr "jboolean ";
5817 | RConstString _ | RString _ -> pr "jstring ";
5818 | RIntBool _ | RStat _ | RStatVFS _ | RHashtable _ ->
5820 | RStringList _ | RPVList _ | RVGList _ | RLVList _ ->
5824 pr "Java_com_redhat_et_libguestfs_GuestFS_";
5825 pr "%s" (replace_str ("_" ^ name) "_" "_1");
5827 pr " (JNIEnv *env, jobject obj, jlong jg";
5834 pr ", jstring j%s" n
5836 pr ", jobjectArray j%s" n
5838 pr ", jboolean j%s" n
5844 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
5845 let error_code, no_ret =
5846 match fst style with
5847 | RErr -> pr " int r;\n"; "-1", ""
5849 | RInt _ -> pr " int r;\n"; "-1", "0"
5850 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
5851 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
5853 pr " jstring jr;\n";
5854 pr " char *r;\n"; "NULL", "NULL"
5856 pr " jobjectArray jr;\n";
5859 pr " jstring jstr;\n";
5860 pr " char **r;\n"; "NULL", "NULL"
5862 pr " jobject jr;\n";
5864 pr " jfieldID fl;\n";
5865 pr " struct guestfs_int_bool *r;\n"; "NULL", "NULL"
5867 pr " jobject jr;\n";
5869 pr " jfieldID fl;\n";
5870 pr " struct guestfs_stat *r;\n"; "NULL", "NULL"
5872 pr " jobject jr;\n";
5874 pr " jfieldID fl;\n";
5875 pr " struct guestfs_statvfs *r;\n"; "NULL", "NULL"
5877 pr " jobjectArray jr;\n";
5879 pr " jfieldID fl;\n";
5880 pr " jobject jfl;\n";
5881 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL", "NULL"
5883 pr " jobjectArray jr;\n";
5885 pr " jfieldID fl;\n";
5886 pr " jobject jfl;\n";
5887 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL", "NULL"
5889 pr " jobjectArray jr;\n";
5891 pr " jfieldID fl;\n";
5892 pr " jobject jfl;\n";
5893 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL", "NULL"
5894 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL" in
5901 pr " const char *%s;\n" n
5903 pr " int %s_len;\n" n;
5904 pr " const char **%s;\n" n
5911 (match fst style with
5912 | RStringList _ | RPVList _ | RVGList _ | RLVList _ -> true
5913 | RErr _ | RBool _ | RInt _ | RInt64 _ | RConstString _
5914 | RString _ | RIntBool _ | RStat _ | RStatVFS _
5915 | RHashtable _ -> false) ||
5916 List.exists (function StringList _ -> true | _ -> false) (snd style) in
5922 (* Get the parameters. *)
5929 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
5931 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
5932 pr " %s = malloc (sizeof (char *) * (%s_len+1));\n" n n;
5933 pr " for (i = 0; i < %s_len; ++i) {\n" n;
5934 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
5936 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
5938 pr " %s[%s_len] = NULL;\n" n n;
5941 pr " %s = j%s;\n" n n
5944 (* Make the call. *)
5945 pr " r = guestfs_%s " name;
5946 generate_call_args ~handle:"g" (snd style);
5949 (* Release the parameters. *)
5956 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
5958 pr " for (i = 0; i < %s_len; ++i) {\n" n;
5959 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
5961 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
5963 pr " free (%s);\n" n
5968 (* Check for errors. *)
5969 pr " if (r == %s) {\n" error_code;
5970 pr " throw_exception (env, guestfs_last_error (g));\n";
5971 pr " return %s;\n" no_ret;
5975 (match fst style with
5977 | RInt _ -> pr " return (jint) r;\n"
5978 | RBool _ -> pr " return (jboolean) r;\n"
5979 | RInt64 _ -> pr " return (jlong) r;\n"
5980 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
5982 pr " jr = (*env)->NewStringUTF (env, r);\n";
5986 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
5987 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
5988 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
5989 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
5990 pr " for (i = 0; i < r_len; ++i) {\n";
5991 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
5992 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
5993 pr " free (r[i]);\n";
5998 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/IntBool\");\n";
5999 pr " jr = (*env)->AllocObject (env, cl);\n";
6000 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"I\");\n";
6001 pr " (*env)->SetIntField (env, jr, fl, r->i);\n";
6002 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"Z\");\n";
6003 pr " (*env)->SetBooleanField (env, jr, fl, r->b);\n";
6004 pr " guestfs_free_int_bool (r);\n";
6007 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/Stat\");\n";
6008 pr " jr = (*env)->AllocObject (env, cl);\n";
6012 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
6014 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
6019 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/StatVFS\");\n";
6020 pr " jr = (*env)->AllocObject (env, cl);\n";
6024 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
6026 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
6031 generate_java_lvm_return "pv" "PV" pv_cols
6033 generate_java_lvm_return "vg" "VG" vg_cols
6035 generate_java_lvm_return "lv" "LV" lv_cols
6038 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
6039 pr " return NULL;\n"
6046 and generate_java_lvm_return typ jtyp cols =
6047 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
6048 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
6049 pr " for (i = 0; i < r->len; ++i) {\n";
6050 pr " jfl = (*env)->AllocObject (env, cl);\n";
6054 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
6055 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
6058 pr " char s[33];\n";
6059 pr " memcpy (s, r->val[i].%s, 32);\n" name;
6061 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
6062 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
6064 | name, (`Bytes|`Int) ->
6065 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
6066 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
6067 | name, `OptPercent ->
6068 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
6069 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
6071 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
6073 pr " guestfs_free_lvm_%s_list (r);\n" typ;
6076 let output_to filename =
6077 let filename_new = filename ^ ".new" in
6078 chan := open_out filename_new;
6082 Unix.rename filename_new filename;
6083 printf "written %s\n%!" filename;
6091 if not (Sys.file_exists "configure.ac") then (
6093 You are probably running this from the wrong directory.
6094 Run it from the top source directory using the command
6100 let close = output_to "src/guestfs_protocol.x" in
6104 let close = output_to "src/guestfs-structs.h" in
6105 generate_structs_h ();
6108 let close = output_to "src/guestfs-actions.h" in
6109 generate_actions_h ();
6112 let close = output_to "src/guestfs-actions.c" in
6113 generate_client_actions ();
6116 let close = output_to "daemon/actions.h" in
6117 generate_daemon_actions_h ();
6120 let close = output_to "daemon/stubs.c" in
6121 generate_daemon_actions ();
6124 let close = output_to "tests.c" in
6128 let close = output_to "fish/cmds.c" in
6129 generate_fish_cmds ();
6132 let close = output_to "fish/completion.c" in
6133 generate_fish_completion ();
6136 let close = output_to "guestfs-structs.pod" in
6137 generate_structs_pod ();
6140 let close = output_to "guestfs-actions.pod" in
6141 generate_actions_pod ();
6144 let close = output_to "guestfish-actions.pod" in
6145 generate_fish_actions_pod ();
6148 let close = output_to "ocaml/guestfs.mli" in
6149 generate_ocaml_mli ();
6152 let close = output_to "ocaml/guestfs.ml" in
6153 generate_ocaml_ml ();
6156 let close = output_to "ocaml/guestfs_c_actions.c" in
6157 generate_ocaml_c ();
6160 let close = output_to "perl/Guestfs.xs" in
6161 generate_perl_xs ();
6164 let close = output_to "perl/lib/Sys/Guestfs.pm" in
6165 generate_perl_pm ();
6168 let close = output_to "python/guestfs-py.c" in
6169 generate_python_c ();
6172 let close = output_to "python/guestfs.py" in
6173 generate_python_py ();
6176 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
6180 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
6181 generate_java_java ();
6184 let close = output_to "java/com/redhat/et/libguestfs/PV.java" in
6185 generate_java_struct "PV" pv_cols;
6188 let close = output_to "java/com/redhat/et/libguestfs/VG.java" in
6189 generate_java_struct "VG" vg_cols;
6192 let close = output_to "java/com/redhat/et/libguestfs/LV.java" in
6193 generate_java_struct "LV" lv_cols;
6196 let close = output_to "java/com/redhat/et/libguestfs/Stat.java" in
6197 generate_java_struct "Stat" stat_cols;
6200 let close = output_to "java/com/redhat/et/libguestfs/StatVFS.java" in
6201 generate_java_struct "StatVFS" statvfs_cols;
6204 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in