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/ext4 superblock details",
1183 This returns the contents of the ext2, ext3 or ext4 filesystem
1184 superblock on C<device>.
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.");
1482 ("lvremove", (RErr, [String "device"]), 77, [],
1483 [InitEmpty, TestOutputList (
1484 [["pvcreate"; "/dev/sda"];
1485 ["vgcreate"; "VG"; "/dev/sda"];
1486 ["lvcreate"; "LV1"; "VG"; "50"];
1487 ["lvcreate"; "LV2"; "VG"; "50"];
1488 ["lvremove"; "/dev/VG/LV1"];
1489 ["lvs"]], ["/dev/VG/LV2"]);
1490 InitEmpty, TestOutputList (
1491 [["pvcreate"; "/dev/sda"];
1492 ["vgcreate"; "VG"; "/dev/sda"];
1493 ["lvcreate"; "LV1"; "VG"; "50"];
1494 ["lvcreate"; "LV2"; "VG"; "50"];
1495 ["lvremove"; "/dev/VG"];
1497 InitEmpty, TestOutputList (
1498 [["pvcreate"; "/dev/sda"];
1499 ["vgcreate"; "VG"; "/dev/sda"];
1500 ["lvcreate"; "LV1"; "VG"; "50"];
1501 ["lvcreate"; "LV2"; "VG"; "50"];
1502 ["lvremove"; "/dev/VG"];
1504 "remove an LVM logical volume",
1506 Remove an LVM logical volume C<device>, where C<device> is
1507 the path to the LV, such as C</dev/VG/LV>.
1509 You can also remove all LVs in a volume group by specifying
1510 the VG name, C</dev/VG>.");
1512 ("vgremove", (RErr, [String "vgname"]), 78, [],
1513 [InitEmpty, TestOutputList (
1514 [["pvcreate"; "/dev/sda"];
1515 ["vgcreate"; "VG"; "/dev/sda"];
1516 ["lvcreate"; "LV1"; "VG"; "50"];
1517 ["lvcreate"; "LV2"; "VG"; "50"];
1520 InitEmpty, TestOutputList (
1521 [["pvcreate"; "/dev/sda"];
1522 ["vgcreate"; "VG"; "/dev/sda"];
1523 ["lvcreate"; "LV1"; "VG"; "50"];
1524 ["lvcreate"; "LV2"; "VG"; "50"];
1527 "remove an LVM volume group",
1529 Remove an LVM volume group C<vgname>, (for example C<VG>).
1531 This also forcibly removes all logical volumes in the volume
1534 ("pvremove", (RErr, [String "device"]), 79, [],
1535 [InitEmpty, TestOutputList (
1536 [["pvcreate"; "/dev/sda"];
1537 ["vgcreate"; "VG"; "/dev/sda"];
1538 ["lvcreate"; "LV1"; "VG"; "50"];
1539 ["lvcreate"; "LV2"; "VG"; "50"];
1541 ["pvremove"; "/dev/sda"];
1543 InitEmpty, TestOutputList (
1544 [["pvcreate"; "/dev/sda"];
1545 ["vgcreate"; "VG"; "/dev/sda"];
1546 ["lvcreate"; "LV1"; "VG"; "50"];
1547 ["lvcreate"; "LV2"; "VG"; "50"];
1549 ["pvremove"; "/dev/sda"];
1551 InitEmpty, TestOutputList (
1552 [["pvcreate"; "/dev/sda"];
1553 ["vgcreate"; "VG"; "/dev/sda"];
1554 ["lvcreate"; "LV1"; "VG"; "50"];
1555 ["lvcreate"; "LV2"; "VG"; "50"];
1557 ["pvremove"; "/dev/sda"];
1559 "remove an LVM physical volume",
1561 This wipes a physical volume C<device> so that LVM will no longer
1564 The implementation uses the C<pvremove> command which refuses to
1565 wipe physical volumes that contain any volume groups, so you have
1566 to remove those first.");
1570 let all_functions = non_daemon_functions @ daemon_functions
1572 (* In some places we want the functions to be displayed sorted
1573 * alphabetically, so this is useful:
1575 let all_functions_sorted =
1576 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
1577 compare n1 n2) all_functions
1579 (* Column names and types from LVM PVs/VGs/LVs. *)
1588 "pv_attr", `String (* XXX *);
1589 "pv_pe_count", `Int;
1590 "pv_pe_alloc_count", `Int;
1593 "pv_mda_count", `Int;
1594 "pv_mda_free", `Bytes;
1595 (* Not in Fedora 10:
1596 "pv_mda_size", `Bytes;
1603 "vg_attr", `String (* XXX *);
1606 "vg_sysid", `String;
1607 "vg_extent_size", `Bytes;
1608 "vg_extent_count", `Int;
1609 "vg_free_count", `Int;
1617 "vg_mda_count", `Int;
1618 "vg_mda_free", `Bytes;
1619 (* Not in Fedora 10:
1620 "vg_mda_size", `Bytes;
1626 "lv_attr", `String (* XXX *);
1629 "lv_kernel_major", `Int;
1630 "lv_kernel_minor", `Int;
1634 "snap_percent", `OptPercent;
1635 "copy_percent", `OptPercent;
1638 "mirror_log", `String;
1642 (* Column names and types from stat structures.
1643 * NB. Can't use things like 'st_atime' because glibc header files
1644 * define some of these as macros. Ugh.
1661 let statvfs_cols = [
1675 (* Useful functions.
1676 * Note we don't want to use any external OCaml libraries which
1677 * makes this a bit harder than it should be.
1679 let failwithf fs = ksprintf failwith fs
1681 let replace_char s c1 c2 =
1682 let s2 = String.copy s in
1683 let r = ref false in
1684 for i = 0 to String.length s2 - 1 do
1685 if String.unsafe_get s2 i = c1 then (
1686 String.unsafe_set s2 i c2;
1690 if not !r then s else s2
1694 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
1696 let triml ?(test = isspace) str =
1698 let n = ref (String.length str) in
1699 while !n > 0 && test str.[!i]; do
1704 else String.sub str !i !n
1706 let trimr ?(test = isspace) str =
1707 let n = ref (String.length str) in
1708 while !n > 0 && test str.[!n-1]; do
1711 if !n = String.length str then str
1712 else String.sub str 0 !n
1714 let trim ?(test = isspace) str =
1715 trimr ~test (triml ~test str)
1717 let rec find s sub =
1718 let len = String.length s in
1719 let sublen = String.length sub in
1721 if i <= len-sublen then (
1723 if j < sublen then (
1724 if s.[i+j] = sub.[j] then loop2 (j+1)
1730 if r = -1 then loop (i+1) else r
1736 let rec replace_str s s1 s2 =
1737 let len = String.length s in
1738 let sublen = String.length s1 in
1739 let i = find s s1 in
1742 let s' = String.sub s 0 i in
1743 let s'' = String.sub s (i+sublen) (len-i-sublen) in
1744 s' ^ s2 ^ replace_str s'' s1 s2
1747 let rec string_split sep str =
1748 let len = String.length str in
1749 let seplen = String.length sep in
1750 let i = find str sep in
1751 if i = -1 then [str]
1753 let s' = String.sub str 0 i in
1754 let s'' = String.sub str (i+seplen) (len-i-seplen) in
1755 s' :: string_split sep s''
1758 let rec find_map f = function
1759 | [] -> raise Not_found
1763 | None -> find_map f xs
1766 let rec loop i = function
1768 | x :: xs -> f i x; loop (i+1) xs
1773 let rec loop i = function
1775 | x :: xs -> let r = f i x in r :: loop (i+1) xs
1779 let name_of_argt = function
1780 | String n | OptString n | StringList n | Bool n | Int n
1781 | FileIn n | FileOut n -> n
1783 let seq_of_test = function
1784 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
1785 | TestOutputInt (s, _) | TestOutputTrue s | TestOutputFalse s
1786 | TestOutputLength (s, _) | TestOutputStruct (s, _)
1787 | TestLastFail s -> s
1789 (* Check function names etc. for consistency. *)
1790 let check_functions () =
1791 let contains_uppercase str =
1792 let len = String.length str in
1794 if i >= len then false
1797 if c >= 'A' && c <= 'Z' then true
1804 (* Check function names. *)
1806 fun (name, _, _, _, _, _, _) ->
1807 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
1808 failwithf "function name %s does not need 'guestfs' prefix" name;
1809 if contains_uppercase name then
1810 failwithf "function name %s should not contain uppercase chars" name;
1811 if String.contains name '-' then
1812 failwithf "function name %s should not contain '-', use '_' instead."
1816 (* Check function parameter/return names. *)
1818 fun (name, style, _, _, _, _, _) ->
1819 let check_arg_ret_name n =
1820 if contains_uppercase n then
1821 failwithf "%s param/ret %s should not contain uppercase chars"
1823 if String.contains n '-' || String.contains n '_' then
1824 failwithf "%s param/ret %s should not contain '-' or '_'"
1827 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;
1828 if n = "argv" || n = "args" then
1829 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" n
1832 (match fst style with
1834 | RInt n | RInt64 n | RBool n | RConstString n | RString n
1835 | RStringList n | RPVList n | RVGList n | RLVList n
1836 | RStat n | RStatVFS n
1838 check_arg_ret_name n
1840 check_arg_ret_name n;
1841 check_arg_ret_name m
1843 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
1846 (* Check short descriptions. *)
1848 fun (name, _, _, _, _, shortdesc, _) ->
1849 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
1850 failwithf "short description of %s should begin with lowercase." name;
1851 let c = shortdesc.[String.length shortdesc-1] in
1852 if c = '\n' || c = '.' then
1853 failwithf "short description of %s should not end with . or \\n." name
1856 (* Check long dscriptions. *)
1858 fun (name, _, _, _, _, _, longdesc) ->
1859 if longdesc.[String.length longdesc-1] = '\n' then
1860 failwithf "long description of %s should not end with \\n." name
1863 (* Check proc_nrs. *)
1865 fun (name, _, proc_nr, _, _, _, _) ->
1866 if proc_nr <= 0 then
1867 failwithf "daemon function %s should have proc_nr > 0" name
1871 fun (name, _, proc_nr, _, _, _, _) ->
1872 if proc_nr <> -1 then
1873 failwithf "non-daemon function %s should have proc_nr -1" name
1874 ) non_daemon_functions;
1877 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
1880 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
1881 let rec loop = function
1884 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
1886 | (name1,nr1) :: (name2,nr2) :: _ ->
1887 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
1895 (* Ignore functions that have no tests. We generate a
1896 * warning when the user does 'make check' instead.
1898 | name, _, _, _, [], _, _ -> ()
1899 | name, _, _, _, tests, _, _ ->
1903 match seq_of_test test with
1905 failwithf "%s has a test containing an empty sequence" name
1906 | cmds -> List.map List.hd cmds
1908 let funcs = List.flatten funcs in
1910 let tested = List.mem name funcs in
1913 failwithf "function %s has tests but does not test itself" name
1916 (* 'pr' prints to the current output file. *)
1917 let chan = ref stdout
1918 let pr fs = ksprintf (output_string !chan) fs
1920 (* Generate a header block in a number of standard styles. *)
1921 type comment_style = CStyle | HashStyle | OCamlStyle
1922 type license = GPLv2 | LGPLv2
1924 let generate_header comment license =
1925 let c = match comment with
1926 | CStyle -> pr "/* "; " *"
1927 | HashStyle -> pr "# "; "#"
1928 | OCamlStyle -> pr "(* "; " *" in
1929 pr "libguestfs generated file\n";
1930 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
1931 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
1933 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
1937 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
1938 pr "%s it under the terms of the GNU General Public License as published by\n" c;
1939 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
1940 pr "%s (at your option) any later version.\n" c;
1942 pr "%s This program is distributed in the hope that it will be useful,\n" c;
1943 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
1944 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
1945 pr "%s GNU General Public License for more details.\n" c;
1947 pr "%s You should have received a copy of the GNU General Public License along\n" c;
1948 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
1949 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
1952 pr "%s This library is free software; you can redistribute it and/or\n" c;
1953 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
1954 pr "%s License as published by the Free Software Foundation; either\n" c;
1955 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
1957 pr "%s This library is distributed in the hope that it will be useful,\n" c;
1958 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
1959 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
1960 pr "%s Lesser General Public License for more details.\n" c;
1962 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
1963 pr "%s License along with this library; if not, write to the Free Software\n" c;
1964 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
1967 | CStyle -> pr " */\n"
1969 | OCamlStyle -> pr " *)\n"
1973 (* Start of main code generation functions below this line. *)
1975 (* Generate the pod documentation for the C API. *)
1976 let rec generate_actions_pod () =
1978 fun (shortname, style, _, flags, _, _, longdesc) ->
1979 let name = "guestfs_" ^ shortname in
1980 pr "=head2 %s\n\n" name;
1982 generate_prototype ~extern:false ~handle:"handle" name style;
1984 pr "%s\n\n" longdesc;
1985 (match fst style with
1987 pr "This function returns 0 on success or -1 on error.\n\n"
1989 pr "On error this function returns -1.\n\n"
1991 pr "On error this function returns -1.\n\n"
1993 pr "This function returns a C truth value on success or -1 on error.\n\n"
1995 pr "This function returns a string, or NULL on error.
1996 The string is owned by the guest handle and must I<not> be freed.\n\n"
1998 pr "This function returns a string, or NULL on error.
1999 I<The caller must free the returned string after use>.\n\n"
2001 pr "This function returns a NULL-terminated array of strings
2002 (like L<environ(3)>), or NULL if there was an error.
2003 I<The caller must free the strings and the array after use>.\n\n"
2005 pr "This function returns a C<struct guestfs_int_bool *>,
2006 or NULL if there was an error.
2007 I<The caller must call C<guestfs_free_int_bool> after use>.\n\n"
2009 pr "This function returns a C<struct guestfs_lvm_pv_list *>
2010 (see E<lt>guestfs-structs.hE<gt>),
2011 or NULL if there was an error.
2012 I<The caller must call C<guestfs_free_lvm_pv_list> after use>.\n\n"
2014 pr "This function returns a C<struct guestfs_lvm_vg_list *>
2015 (see E<lt>guestfs-structs.hE<gt>),
2016 or NULL if there was an error.
2017 I<The caller must call C<guestfs_free_lvm_vg_list> after use>.\n\n"
2019 pr "This function returns a C<struct guestfs_lvm_lv_list *>
2020 (see E<lt>guestfs-structs.hE<gt>),
2021 or NULL if there was an error.
2022 I<The caller must call C<guestfs_free_lvm_lv_list> after use>.\n\n"
2024 pr "This function returns a C<struct guestfs_stat *>
2025 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
2026 or NULL if there was an error.
2027 I<The caller must call C<free> after use>.\n\n"
2029 pr "This function returns a C<struct guestfs_statvfs *>
2030 (see L<statvfs(2)> and E<lt>guestfs-structs.hE<gt>),
2031 or NULL if there was an error.
2032 I<The caller must call C<free> after use>.\n\n"
2034 pr "This function returns a NULL-terminated array of
2035 strings, or NULL if there was an error.
2036 The array of strings will always have length C<2n+1>, where
2037 C<n> keys and values alternate, followed by the trailing NULL entry.
2038 I<The caller must free the strings and the array after use>.\n\n"
2040 if List.mem ProtocolLimitWarning flags then
2041 pr "%s\n\n" protocol_limit_warning;
2042 if List.mem DangerWillRobinson flags then
2043 pr "%s\n\n" danger_will_robinson;
2044 ) all_functions_sorted
2046 and generate_structs_pod () =
2047 (* LVM structs documentation. *)
2050 pr "=head2 guestfs_lvm_%s\n" typ;
2052 pr " struct guestfs_lvm_%s {\n" typ;
2055 | name, `String -> pr " char *%s;\n" name
2057 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
2058 pr " char %s[32];\n" name
2059 | name, `Bytes -> pr " uint64_t %s;\n" name
2060 | name, `Int -> pr " int64_t %s;\n" name
2061 | name, `OptPercent ->
2062 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
2063 pr " float %s;\n" name
2066 pr " struct guestfs_lvm_%s_list {\n" typ;
2067 pr " uint32_t len; /* Number of elements in list. */\n";
2068 pr " struct guestfs_lvm_%s *val; /* Elements. */\n" typ;
2071 pr " void guestfs_free_lvm_%s_list (struct guestfs_free_lvm_%s_list *);\n"
2074 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
2076 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
2077 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
2079 * We have to use an underscore instead of a dash because otherwise
2080 * rpcgen generates incorrect code.
2082 * This header is NOT exported to clients, but see also generate_structs_h.
2084 and generate_xdr () =
2085 generate_header CStyle LGPLv2;
2087 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
2088 pr "typedef string str<>;\n";
2091 (* LVM internal structures. *)
2095 pr "struct guestfs_lvm_int_%s {\n" typ;
2097 | name, `String -> pr " string %s<>;\n" name
2098 | name, `UUID -> pr " opaque %s[32];\n" name
2099 | name, `Bytes -> pr " hyper %s;\n" name
2100 | name, `Int -> pr " hyper %s;\n" name
2101 | name, `OptPercent -> pr " float %s;\n" name
2105 pr "typedef struct guestfs_lvm_int_%s guestfs_lvm_int_%s_list<>;\n" typ typ;
2107 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2109 (* Stat internal structures. *)
2113 pr "struct guestfs_int_%s {\n" typ;
2115 | name, `Int -> pr " hyper %s;\n" name
2119 ) ["stat", stat_cols; "statvfs", statvfs_cols];
2122 fun (shortname, style, _, _, _, _, _) ->
2123 let name = "guestfs_" ^ shortname in
2125 (match snd style with
2128 pr "struct %s_args {\n" name;
2131 | String n -> pr " string %s<>;\n" n
2132 | OptString n -> pr " str *%s;\n" n
2133 | StringList n -> pr " str %s<>;\n" n
2134 | Bool n -> pr " bool %s;\n" n
2135 | Int n -> pr " int %s;\n" n
2136 | FileIn _ | FileOut _ -> ()
2140 (match fst style with
2143 pr "struct %s_ret {\n" name;
2147 pr "struct %s_ret {\n" name;
2148 pr " hyper %s;\n" n;
2151 pr "struct %s_ret {\n" name;
2155 failwithf "RConstString cannot be returned from a daemon function"
2157 pr "struct %s_ret {\n" name;
2158 pr " string %s<>;\n" n;
2161 pr "struct %s_ret {\n" name;
2162 pr " str %s<>;\n" n;
2165 pr "struct %s_ret {\n" name;
2170 pr "struct %s_ret {\n" name;
2171 pr " guestfs_lvm_int_pv_list %s;\n" n;
2174 pr "struct %s_ret {\n" name;
2175 pr " guestfs_lvm_int_vg_list %s;\n" n;
2178 pr "struct %s_ret {\n" name;
2179 pr " guestfs_lvm_int_lv_list %s;\n" n;
2182 pr "struct %s_ret {\n" name;
2183 pr " guestfs_int_stat %s;\n" n;
2186 pr "struct %s_ret {\n" name;
2187 pr " guestfs_int_statvfs %s;\n" n;
2190 pr "struct %s_ret {\n" name;
2191 pr " str %s<>;\n" n;
2196 (* Table of procedure numbers. *)
2197 pr "enum guestfs_procedure {\n";
2199 fun (shortname, _, proc_nr, _, _, _, _) ->
2200 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
2202 pr " GUESTFS_PROC_NR_PROCS\n";
2206 (* Having to choose a maximum message size is annoying for several
2207 * reasons (it limits what we can do in the API), but it (a) makes
2208 * the protocol a lot simpler, and (b) provides a bound on the size
2209 * of the daemon which operates in limited memory space. For large
2210 * file transfers you should use FTP.
2212 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
2215 (* Message header, etc. *)
2217 /* The communication protocol is now documented in the guestfs(3)
2221 const GUESTFS_PROGRAM = 0x2000F5F5;
2222 const GUESTFS_PROTOCOL_VERSION = 1;
2224 /* These constants must be larger than any possible message length. */
2225 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
2226 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
2228 enum guestfs_message_direction {
2229 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
2230 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
2233 enum guestfs_message_status {
2234 GUESTFS_STATUS_OK = 0,
2235 GUESTFS_STATUS_ERROR = 1
2238 const GUESTFS_ERROR_LEN = 256;
2240 struct guestfs_message_error {
2241 string error_message<GUESTFS_ERROR_LEN>;
2244 struct guestfs_message_header {
2245 unsigned prog; /* GUESTFS_PROGRAM */
2246 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
2247 guestfs_procedure proc; /* GUESTFS_PROC_x */
2248 guestfs_message_direction direction;
2249 unsigned serial; /* message serial number */
2250 guestfs_message_status status;
2253 const GUESTFS_MAX_CHUNK_SIZE = 8192;
2255 struct guestfs_chunk {
2256 int cancel; /* if non-zero, transfer is cancelled */
2257 /* data size is 0 bytes if the transfer has finished successfully */
2258 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
2262 (* Generate the guestfs-structs.h file. *)
2263 and generate_structs_h () =
2264 generate_header CStyle LGPLv2;
2266 (* This is a public exported header file containing various
2267 * structures. The structures are carefully written to have
2268 * exactly the same in-memory format as the XDR structures that
2269 * we use on the wire to the daemon. The reason for creating
2270 * copies of these structures here is just so we don't have to
2271 * export the whole of guestfs_protocol.h (which includes much
2272 * unrelated and XDR-dependent stuff that we don't want to be
2273 * public, or required by clients).
2275 * To reiterate, we will pass these structures to and from the
2276 * client with a simple assignment or memcpy, so the format
2277 * must be identical to what rpcgen / the RFC defines.
2280 (* guestfs_int_bool structure. *)
2281 pr "struct guestfs_int_bool {\n";
2287 (* LVM public structures. *)
2291 pr "struct guestfs_lvm_%s {\n" typ;
2294 | name, `String -> pr " char *%s;\n" name
2295 | name, `UUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
2296 | name, `Bytes -> pr " uint64_t %s;\n" name
2297 | name, `Int -> pr " int64_t %s;\n" name
2298 | name, `OptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
2302 pr "struct guestfs_lvm_%s_list {\n" typ;
2303 pr " uint32_t len;\n";
2304 pr " struct guestfs_lvm_%s *val;\n" typ;
2307 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2309 (* Stat structures. *)
2313 pr "struct guestfs_%s {\n" typ;
2316 | name, `Int -> pr " int64_t %s;\n" name
2320 ) ["stat", stat_cols; "statvfs", statvfs_cols]
2322 (* Generate the guestfs-actions.h file. *)
2323 and generate_actions_h () =
2324 generate_header CStyle LGPLv2;
2326 fun (shortname, style, _, _, _, _, _) ->
2327 let name = "guestfs_" ^ shortname in
2328 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
2332 (* Generate the client-side dispatch stubs. *)
2333 and generate_client_actions () =
2334 generate_header CStyle LGPLv2;
2340 #include \"guestfs.h\"
2341 #include \"guestfs_protocol.h\"
2343 #define error guestfs_error
2344 #define perrorf guestfs_perrorf
2345 #define safe_malloc guestfs_safe_malloc
2346 #define safe_realloc guestfs_safe_realloc
2347 #define safe_strdup guestfs_safe_strdup
2348 #define safe_memdup guestfs_safe_memdup
2350 /* Check the return message from a call for validity. */
2352 check_reply_header (guestfs_h *g,
2353 const struct guestfs_message_header *hdr,
2354 int proc_nr, int serial)
2356 if (hdr->prog != GUESTFS_PROGRAM) {
2357 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
2360 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
2361 error (g, \"wrong protocol version (%%d/%%d)\",
2362 hdr->vers, GUESTFS_PROTOCOL_VERSION);
2365 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
2366 error (g, \"unexpected message direction (%%d/%%d)\",
2367 hdr->direction, GUESTFS_DIRECTION_REPLY);
2370 if (hdr->proc != proc_nr) {
2371 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
2374 if (hdr->serial != serial) {
2375 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
2382 /* Check we are in the right state to run a high-level action. */
2384 check_state (guestfs_h *g, const char *caller)
2386 if (!guestfs_is_ready (g)) {
2387 if (guestfs_is_config (g))
2388 error (g, \"%%s: call launch() before using this function\",
2390 else if (guestfs_is_launching (g))
2391 error (g, \"%%s: call wait_ready() before using this function\",
2394 error (g, \"%%s called from the wrong state, %%d != READY\",
2395 caller, guestfs_get_state (g));
2403 (* Client-side stubs for each function. *)
2405 fun (shortname, style, _, _, _, _, _) ->
2406 let name = "guestfs_" ^ shortname in
2408 (* Generate the context struct which stores the high-level
2409 * state between callback functions.
2411 pr "struct %s_ctx {\n" shortname;
2412 pr " /* This flag is set by the callbacks, so we know we've done\n";
2413 pr " * the callbacks as expected, and in the right sequence.\n";
2414 pr " * 0 = not called, 1 = send called,\n";
2415 pr " * 1001 = reply called.\n";
2417 pr " int cb_sequence;\n";
2418 pr " struct guestfs_message_header hdr;\n";
2419 pr " struct guestfs_message_error err;\n";
2420 (match fst style with
2423 failwithf "RConstString cannot be returned from a daemon function"
2425 | RBool _ | RString _ | RStringList _
2427 | RPVList _ | RVGList _ | RLVList _
2428 | RStat _ | RStatVFS _
2430 pr " struct %s_ret ret;\n" name
2435 (* Generate the reply callback function. *)
2436 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
2438 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
2439 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
2441 pr " ml->main_loop_quit (ml, g);\n";
2443 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
2444 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
2447 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
2448 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
2449 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
2456 (match fst style with
2459 failwithf "RConstString cannot be returned from a daemon function"
2461 | RBool _ | RString _ | RStringList _
2463 | RPVList _ | RVGList _ | RLVList _
2464 | RStat _ | RStatVFS _
2466 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
2467 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
2473 pr " ctx->cb_sequence = 1001;\n";
2476 (* Generate the action stub. *)
2477 generate_prototype ~extern:false ~semicolon:false ~newline:true
2478 ~handle:"g" name style;
2481 match fst style with
2482 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
2484 failwithf "RConstString cannot be returned from a daemon function"
2485 | RString _ | RStringList _ | RIntBool _
2486 | RPVList _ | RVGList _ | RLVList _
2487 | RStat _ | RStatVFS _
2493 (match snd style with
2495 | _ -> pr " struct %s_args args;\n" name
2498 pr " struct %s_ctx ctx;\n" shortname;
2499 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
2500 pr " int serial;\n";
2502 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
2503 pr " guestfs_set_busy (g);\n";
2505 pr " memset (&ctx, 0, sizeof ctx);\n";
2508 (* Send the main header and arguments. *)
2509 (match snd style with
2511 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
2512 (String.uppercase shortname)
2517 pr " args.%s = (char *) %s;\n" n n
2519 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
2521 pr " args.%s.%s_val = (char **) %s;\n" n n n;
2522 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
2524 pr " args.%s = %s;\n" n n
2526 pr " args.%s = %s;\n" n n
2527 | FileIn _ | FileOut _ -> ()
2529 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
2530 (String.uppercase shortname);
2531 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
2534 pr " if (serial == -1) {\n";
2535 pr " guestfs_set_ready (g);\n";
2536 pr " return %s;\n" error_code;
2540 (* Send any additional files (FileIn) requested. *)
2541 let need_read_reply_label = ref false in
2548 pr " r = guestfs__send_file_sync (g, %s);\n" n;
2549 pr " if (r == -1) {\n";
2550 pr " guestfs_set_ready (g);\n";
2551 pr " return %s;\n" error_code;
2553 pr " if (r == -2) /* daemon cancelled */\n";
2554 pr " goto read_reply;\n";
2555 need_read_reply_label := true;
2561 (* Wait for the reply from the remote end. *)
2562 if !need_read_reply_label then pr " read_reply:\n";
2563 pr " guestfs__switch_to_receiving (g);\n";
2564 pr " ctx.cb_sequence = 0;\n";
2565 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
2566 pr " (void) ml->main_loop_run (ml, g);\n";
2567 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
2568 pr " if (ctx.cb_sequence != 1001) {\n";
2569 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
2570 pr " guestfs_set_ready (g);\n";
2571 pr " return %s;\n" error_code;
2575 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
2576 (String.uppercase shortname);
2577 pr " guestfs_set_ready (g);\n";
2578 pr " return %s;\n" error_code;
2582 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
2583 pr " error (g, \"%%s\", ctx.err.error_message);\n";
2584 pr " guestfs_set_ready (g);\n";
2585 pr " return %s;\n" error_code;
2589 (* Expecting to receive further files (FileOut)? *)
2593 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
2594 pr " guestfs_set_ready (g);\n";
2595 pr " return %s;\n" error_code;
2601 pr " guestfs_set_ready (g);\n";
2603 (match fst style with
2604 | RErr -> pr " return 0;\n"
2605 | RInt n | RInt64 n | RBool n ->
2606 pr " return ctx.ret.%s;\n" n
2608 failwithf "RConstString cannot be returned from a daemon function"
2610 pr " return ctx.ret.%s; /* caller will free */\n" n
2611 | RStringList n | RHashtable n ->
2612 pr " /* caller will free this, but we need to add a NULL entry */\n";
2613 pr " ctx.ret.%s.%s_val =\n" n n;
2614 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
2615 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
2617 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
2618 pr " return ctx.ret.%s.%s_val;\n" n n
2620 pr " /* caller with free this */\n";
2621 pr " return safe_memdup (g, &ctx.ret, sizeof (ctx.ret));\n"
2622 | RPVList n | RVGList n | RLVList n
2623 | RStat n | RStatVFS n ->
2624 pr " /* caller will free this */\n";
2625 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
2631 (* Generate daemon/actions.h. *)
2632 and generate_daemon_actions_h () =
2633 generate_header CStyle GPLv2;
2635 pr "#include \"../src/guestfs_protocol.h\"\n";
2639 fun (name, style, _, _, _, _, _) ->
2641 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
2645 (* Generate the server-side stubs. *)
2646 and generate_daemon_actions () =
2647 generate_header CStyle GPLv2;
2649 pr "#include <config.h>\n";
2651 pr "#include <stdio.h>\n";
2652 pr "#include <stdlib.h>\n";
2653 pr "#include <string.h>\n";
2654 pr "#include <inttypes.h>\n";
2655 pr "#include <ctype.h>\n";
2656 pr "#include <rpc/types.h>\n";
2657 pr "#include <rpc/xdr.h>\n";
2659 pr "#include \"daemon.h\"\n";
2660 pr "#include \"../src/guestfs_protocol.h\"\n";
2661 pr "#include \"actions.h\"\n";
2665 fun (name, style, _, _, _, _, _) ->
2666 (* Generate server-side stubs. *)
2667 pr "static void %s_stub (XDR *xdr_in)\n" name;
2670 match fst style with
2671 | RErr | RInt _ -> pr " int r;\n"; "-1"
2672 | RInt64 _ -> pr " int64_t r;\n"; "-1"
2673 | RBool _ -> pr " int r;\n"; "-1"
2675 failwithf "RConstString cannot be returned from a daemon function"
2676 | RString _ -> pr " char *r;\n"; "NULL"
2677 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
2678 | RIntBool _ -> pr " guestfs_%s_ret *r;\n" name; "NULL"
2679 | RPVList _ -> pr " guestfs_lvm_int_pv_list *r;\n"; "NULL"
2680 | RVGList _ -> pr " guestfs_lvm_int_vg_list *r;\n"; "NULL"
2681 | RLVList _ -> pr " guestfs_lvm_int_lv_list *r;\n"; "NULL"
2682 | RStat _ -> pr " guestfs_int_stat *r;\n"; "NULL"
2683 | RStatVFS _ -> pr " guestfs_int_statvfs *r;\n"; "NULL" in
2685 (match snd style with
2688 pr " struct guestfs_%s_args args;\n" name;
2692 | OptString n -> pr " const char *%s;\n" n
2693 | StringList n -> pr " char **%s;\n" n
2694 | Bool n -> pr " int %s;\n" n
2695 | Int n -> pr " int %s;\n" n
2696 | FileIn _ | FileOut _ -> ()
2701 (match snd style with
2704 pr " memset (&args, 0, sizeof args);\n";
2706 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
2707 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
2712 | String n -> pr " %s = args.%s;\n" n n
2713 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
2715 pr " args.%s.%s_val = realloc (args.%s.%s_val, sizeof (char *) * (args.%s.%s_len+1));\n" n n n n n n;
2716 pr " args.%s.%s_val[args.%s.%s_len] = NULL;\n" n n n n;
2717 pr " %s = args.%s.%s_val;\n" n n n
2718 | Bool n -> pr " %s = args.%s;\n" n n
2719 | Int n -> pr " %s = args.%s;\n" n n
2720 | FileIn _ | FileOut _ -> ()
2725 (* Don't want to call the impl with any FileIn or FileOut
2726 * parameters, since these go "outside" the RPC protocol.
2729 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
2731 pr " r = do_%s " name;
2732 generate_call_args argsnofile;
2735 pr " if (r == %s)\n" error_code;
2736 pr " /* do_%s has already called reply_with_error */\n" name;
2740 (* If there are any FileOut parameters, then the impl must
2741 * send its own reply.
2744 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
2746 pr " /* do_%s has already sent a reply */\n" name
2748 match fst style with
2749 | RErr -> pr " reply (NULL, NULL);\n"
2750 | RInt n | RInt64 n | RBool n ->
2751 pr " struct guestfs_%s_ret ret;\n" name;
2752 pr " ret.%s = r;\n" n;
2753 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
2756 failwithf "RConstString cannot be returned from a daemon function"
2758 pr " struct guestfs_%s_ret ret;\n" name;
2759 pr " ret.%s = r;\n" n;
2760 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
2763 | RStringList n | RHashtable n ->
2764 pr " struct guestfs_%s_ret ret;\n" name;
2765 pr " ret.%s.%s_len = count_strings (r);\n" n n;
2766 pr " ret.%s.%s_val = r;\n" n n;
2767 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
2769 pr " free_strings (r);\n"
2771 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n"
2773 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n" name
2774 | RPVList n | RVGList n | RLVList n
2775 | RStat n | RStatVFS n ->
2776 pr " struct guestfs_%s_ret ret;\n" name;
2777 pr " ret.%s = *r;\n" n;
2778 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
2780 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
2784 (* Free the args. *)
2785 (match snd style with
2790 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
2797 (* Dispatch function. *)
2798 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
2800 pr " switch (proc_nr) {\n";
2803 fun (name, style, _, _, _, _, _) ->
2804 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
2805 pr " %s_stub (xdr_in);\n" name;
2810 pr " reply_with_error (\"dispatch_incoming_message: unknown procedure number %%d\", proc_nr);\n";
2815 (* LVM columns and tokenization functions. *)
2816 (* XXX This generates crap code. We should rethink how we
2822 pr "static const char *lvm_%s_cols = \"%s\";\n"
2823 typ (String.concat "," (List.map fst cols));
2826 pr "static int lvm_tokenize_%s (char *str, struct guestfs_lvm_int_%s *r)\n" typ typ;
2828 pr " char *tok, *p, *next;\n";
2832 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
2835 pr " if (!str) {\n";
2836 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
2839 pr " if (!*str || isspace (*str)) {\n";
2840 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
2845 fun (name, coltype) ->
2846 pr " if (!tok) {\n";
2847 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
2850 pr " p = strchrnul (tok, ',');\n";
2851 pr " if (*p) next = p+1; else next = NULL;\n";
2852 pr " *p = '\\0';\n";
2855 pr " r->%s = strdup (tok);\n" name;
2856 pr " if (r->%s == NULL) {\n" name;
2857 pr " perror (\"strdup\");\n";
2861 pr " for (i = j = 0; i < 32; ++j) {\n";
2862 pr " if (tok[j] == '\\0') {\n";
2863 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
2865 pr " } else if (tok[j] != '-')\n";
2866 pr " r->%s[i++] = tok[j];\n" name;
2869 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
2870 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
2874 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
2875 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
2879 pr " if (tok[0] == '\\0')\n";
2880 pr " r->%s = -1;\n" name;
2881 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
2882 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
2886 pr " tok = next;\n";
2889 pr " if (tok != NULL) {\n";
2890 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
2897 pr "guestfs_lvm_int_%s_list *\n" typ;
2898 pr "parse_command_line_%ss (void)\n" typ;
2900 pr " char *out, *err;\n";
2901 pr " char *p, *pend;\n";
2903 pr " guestfs_lvm_int_%s_list *ret;\n" typ;
2904 pr " void *newp;\n";
2906 pr " ret = malloc (sizeof *ret);\n";
2907 pr " if (!ret) {\n";
2908 pr " reply_with_perror (\"malloc\");\n";
2909 pr " return NULL;\n";
2912 pr " ret->guestfs_lvm_int_%s_list_len = 0;\n" typ;
2913 pr " ret->guestfs_lvm_int_%s_list_val = NULL;\n" typ;
2915 pr " r = command (&out, &err,\n";
2916 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
2917 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
2918 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
2919 pr " if (r == -1) {\n";
2920 pr " reply_with_error (\"%%s\", err);\n";
2921 pr " free (out);\n";
2922 pr " free (err);\n";
2923 pr " free (ret);\n";
2924 pr " return NULL;\n";
2927 pr " free (err);\n";
2929 pr " /* Tokenize each line of the output. */\n";
2932 pr " while (p) {\n";
2933 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
2934 pr " if (pend) {\n";
2935 pr " *pend = '\\0';\n";
2939 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
2942 pr " if (!*p) { /* Empty line? Skip it. */\n";
2947 pr " /* Allocate some space to store this next entry. */\n";
2948 pr " newp = realloc (ret->guestfs_lvm_int_%s_list_val,\n" typ;
2949 pr " sizeof (guestfs_lvm_int_%s) * (i+1));\n" typ;
2950 pr " if (newp == NULL) {\n";
2951 pr " reply_with_perror (\"realloc\");\n";
2952 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
2953 pr " free (ret);\n";
2954 pr " free (out);\n";
2955 pr " return NULL;\n";
2957 pr " ret->guestfs_lvm_int_%s_list_val = newp;\n" typ;
2959 pr " /* Tokenize the next entry. */\n";
2960 pr " r = lvm_tokenize_%s (p, &ret->guestfs_lvm_int_%s_list_val[i]);\n" typ typ;
2961 pr " if (r == -1) {\n";
2962 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
2963 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
2964 pr " free (ret);\n";
2965 pr " free (out);\n";
2966 pr " return NULL;\n";
2973 pr " ret->guestfs_lvm_int_%s_list_len = i;\n" typ;
2975 pr " free (out);\n";
2976 pr " return ret;\n";
2979 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
2981 (* Generate the tests. *)
2982 and generate_tests () =
2983 generate_header CStyle GPLv2;
2990 #include <sys/types.h>
2993 #include \"guestfs.h\"
2995 static guestfs_h *g;
2996 static int suppress_error = 0;
2998 static void print_error (guestfs_h *g, void *data, const char *msg)
3000 if (!suppress_error)
3001 fprintf (stderr, \"%%s\\n\", msg);
3004 static void print_strings (char * const * const argv)
3008 for (argc = 0; argv[argc] != NULL; ++argc)
3009 printf (\"\\t%%s\\n\", argv[argc]);
3013 static void print_table (char * const * const argv)
3017 for (i = 0; argv[i] != NULL; i += 2)
3018 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
3022 static void no_test_warnings (void)
3028 | name, _, _, _, [], _, _ ->
3029 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
3030 | name, _, _, _, tests, _, _ -> ()
3036 (* Generate the actual tests. Note that we generate the tests
3037 * in reverse order, deliberately, so that (in general) the
3038 * newest tests run first. This makes it quicker and easier to
3043 fun (name, _, _, _, tests, _, _) ->
3044 mapi (generate_one_test name) tests
3045 ) (List.rev all_functions) in
3046 let test_names = List.concat test_names in
3047 let nr_tests = List.length test_names in
3050 int main (int argc, char *argv[])
3055 const char *filename;
3057 int nr_tests, test_num = 0;
3059 no_test_warnings ();
3061 g = guestfs_create ();
3063 printf (\"guestfs_create FAILED\\n\");
3067 guestfs_set_error_handler (g, print_error, NULL);
3069 srcdir = getenv (\"srcdir\");
3070 if (!srcdir) srcdir = \".\";
3072 guestfs_set_path (g, \".\");
3074 filename = \"test1.img\";
3075 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3080 if (lseek (fd, %d, SEEK_SET) == -1) {
3086 if (write (fd, &c, 1) == -1) {
3092 if (close (fd) == -1) {
3097 if (guestfs_add_drive (g, filename) == -1) {
3098 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3102 filename = \"test2.img\";
3103 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3108 if (lseek (fd, %d, SEEK_SET) == -1) {
3114 if (write (fd, &c, 1) == -1) {
3120 if (close (fd) == -1) {
3125 if (guestfs_add_drive (g, filename) == -1) {
3126 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3130 filename = \"test3.img\";
3131 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3136 if (lseek (fd, %d, SEEK_SET) == -1) {
3142 if (write (fd, &c, 1) == -1) {
3148 if (close (fd) == -1) {
3153 if (guestfs_add_drive (g, filename) == -1) {
3154 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3158 if (guestfs_launch (g) == -1) {
3159 printf (\"guestfs_launch FAILED\\n\");
3162 if (guestfs_wait_ready (g) == -1) {
3163 printf (\"guestfs_wait_ready FAILED\\n\");
3169 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
3173 pr " test_num++;\n";
3174 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
3175 pr " if (%s () == -1) {\n" test_name;
3176 pr " printf (\"%s FAILED\\n\");\n" test_name;
3182 pr " guestfs_close (g);\n";
3183 pr " unlink (\"test1.img\");\n";
3184 pr " unlink (\"test2.img\");\n";
3185 pr " unlink (\"test3.img\");\n";
3188 pr " if (failed > 0) {\n";
3189 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
3197 and generate_one_test name i (init, test) =
3198 let test_name = sprintf "test_%s_%d" name i in
3200 pr "static int %s (void)\n" test_name;
3206 pr " /* InitEmpty for %s (%d) */\n" name i;
3207 List.iter (generate_test_command_call test_name)
3211 pr " /* InitBasicFS for %s (%d): create ext2 on /dev/sda1 */\n" name i;
3212 List.iter (generate_test_command_call test_name)
3215 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
3216 ["mkfs"; "ext2"; "/dev/sda1"];
3217 ["mount"; "/dev/sda1"; "/"]]
3218 | InitBasicFSonLVM ->
3219 pr " /* InitBasicFSonLVM for %s (%d): create ext2 on /dev/VG/LV */\n"
3221 List.iter (generate_test_command_call test_name)
3224 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
3225 ["pvcreate"; "/dev/sda1"];
3226 ["vgcreate"; "VG"; "/dev/sda1"];
3227 ["lvcreate"; "LV"; "VG"; "8"];
3228 ["mkfs"; "ext2"; "/dev/VG/LV"];
3229 ["mount"; "/dev/VG/LV"; "/"]]
3232 let get_seq_last = function
3234 failwithf "%s: you cannot use [] (empty list) when expecting a command"
3237 let seq = List.rev seq in
3238 List.rev (List.tl seq), List.hd seq
3243 pr " /* TestRun for %s (%d) */\n" name i;
3244 List.iter (generate_test_command_call test_name) seq
3245 | TestOutput (seq, expected) ->
3246 pr " /* TestOutput for %s (%d) */\n" name i;
3247 let seq, last = get_seq_last seq in
3249 pr " if (strcmp (r, \"%s\") != 0) {\n" (c_quote expected);
3250 pr " fprintf (stderr, \"%s: expected \\\"%s\\\" but got \\\"%%s\\\"\\n\", r);\n" test_name (c_quote expected);
3254 List.iter (generate_test_command_call test_name) seq;
3255 generate_test_command_call ~test test_name last
3256 | TestOutputList (seq, expected) ->
3257 pr " /* TestOutputList for %s (%d) */\n" name i;
3258 let seq, last = get_seq_last seq in
3262 pr " if (!r[%d]) {\n" i;
3263 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
3264 pr " print_strings (r);\n";
3267 pr " if (strcmp (r[%d], \"%s\") != 0) {\n" i (c_quote str);
3268 pr " fprintf (stderr, \"%s: expected \\\"%s\\\" but got \\\"%%s\\\"\\n\", r[%d]);\n" test_name (c_quote str) i;
3272 pr " if (r[%d] != NULL) {\n" (List.length expected);
3273 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
3275 pr " print_strings (r);\n";
3279 List.iter (generate_test_command_call test_name) seq;
3280 generate_test_command_call ~test test_name last
3281 | TestOutputInt (seq, expected) ->
3282 pr " /* TestOutputInt for %s (%d) */\n" name i;
3283 let seq, last = get_seq_last seq in
3285 pr " if (r != %d) {\n" expected;
3286 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
3292 List.iter (generate_test_command_call test_name) seq;
3293 generate_test_command_call ~test test_name last
3294 | TestOutputTrue seq ->
3295 pr " /* TestOutputTrue for %s (%d) */\n" name i;
3296 let seq, last = get_seq_last seq in
3299 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
3304 List.iter (generate_test_command_call test_name) seq;
3305 generate_test_command_call ~test test_name last
3306 | TestOutputFalse seq ->
3307 pr " /* TestOutputFalse for %s (%d) */\n" name i;
3308 let seq, last = get_seq_last seq in
3311 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
3316 List.iter (generate_test_command_call test_name) seq;
3317 generate_test_command_call ~test test_name last
3318 | TestOutputLength (seq, expected) ->
3319 pr " /* TestOutputLength for %s (%d) */\n" name i;
3320 let seq, last = get_seq_last seq in
3323 pr " for (j = 0; j < %d; ++j)\n" expected;
3324 pr " if (r[j] == NULL) {\n";
3325 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
3327 pr " print_strings (r);\n";
3330 pr " if (r[j] != NULL) {\n";
3331 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
3333 pr " print_strings (r);\n";
3337 List.iter (generate_test_command_call test_name) seq;
3338 generate_test_command_call ~test test_name last
3339 | TestOutputStruct (seq, checks) ->
3340 pr " /* TestOutputStruct for %s (%d) */\n" name i;
3341 let seq, last = get_seq_last seq in
3345 | CompareWithInt (field, expected) ->
3346 pr " if (r->%s != %d) {\n" field expected;
3347 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
3348 test_name field expected;
3349 pr " (int) r->%s);\n" field;
3352 | CompareWithString (field, expected) ->
3353 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
3354 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
3355 test_name field expected;
3356 pr " r->%s);\n" field;
3359 | CompareFieldsIntEq (field1, field2) ->
3360 pr " if (r->%s != r->%s) {\n" field1 field2;
3361 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
3362 test_name field1 field2;
3363 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
3366 | CompareFieldsStrEq (field1, field2) ->
3367 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
3368 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
3369 test_name field1 field2;
3370 pr " r->%s, r->%s);\n" field1 field2;
3375 List.iter (generate_test_command_call test_name) seq;
3376 generate_test_command_call ~test test_name last
3377 | TestLastFail seq ->
3378 pr " /* TestLastFail for %s (%d) */\n" name i;
3379 let seq, last = get_seq_last seq in
3380 List.iter (generate_test_command_call test_name) seq;
3381 generate_test_command_call test_name ~expect_error:true last
3389 (* Generate the code to run a command, leaving the result in 'r'.
3390 * If you expect to get an error then you should set expect_error:true.
3392 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
3394 | [] -> assert false
3396 (* Look up the command to find out what args/ret it has. *)
3399 let _, style, _, _, _, _, _ =
3400 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
3403 failwithf "%s: in test, command %s was not found" test_name name in
3405 if List.length (snd style) <> List.length args then
3406 failwithf "%s: in test, wrong number of args given to %s"
3417 | FileIn _, _ | FileOut _, _ -> ()
3418 | StringList n, arg ->
3419 pr " char *%s[] = {\n" n;
3420 let strs = string_split " " arg in
3422 fun str -> pr " \"%s\",\n" (c_quote str)
3426 ) (List.combine (snd style) args);
3429 match fst style with
3430 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
3431 | RInt64 _ -> pr " int64_t r;\n"; "-1"
3432 | RConstString _ -> pr " const char *r;\n"; "NULL"
3433 | RString _ -> pr " char *r;\n"; "NULL"
3434 | RStringList _ | RHashtable _ ->
3439 pr " struct guestfs_int_bool *r;\n"; "NULL"
3441 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
3443 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
3445 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
3447 pr " struct guestfs_stat *r;\n"; "NULL"
3449 pr " struct guestfs_statvfs *r;\n"; "NULL" in
3451 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
3452 pr " r = guestfs_%s (g" name;
3454 (* Generate the parameters. *)
3458 | FileIn _, arg | FileOut _, arg ->
3459 pr ", \"%s\"" (c_quote arg)
3460 | OptString _, arg ->
3461 if arg = "NULL" then pr ", NULL" else pr ", \"%s\"" (c_quote arg)
3462 | StringList n, _ ->
3466 try int_of_string arg
3467 with Failure "int_of_string" ->
3468 failwithf "%s: expecting an int, but got '%s'" test_name arg in
3471 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
3472 ) (List.combine (snd style) args);
3475 if not expect_error then
3476 pr " if (r == %s)\n" error_code
3478 pr " if (r != %s)\n" error_code;
3481 (* Insert the test code. *)
3487 (match fst style with
3488 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _ -> ()
3489 | RString _ -> pr " free (r);\n"
3490 | RStringList _ | RHashtable _ ->
3491 pr " for (i = 0; r[i] != NULL; ++i)\n";
3492 pr " free (r[i]);\n";
3495 pr " guestfs_free_int_bool (r);\n"
3497 pr " guestfs_free_lvm_pv_list (r);\n"
3499 pr " guestfs_free_lvm_vg_list (r);\n"
3501 pr " guestfs_free_lvm_lv_list (r);\n"
3502 | RStat _ | RStatVFS _ ->
3509 let str = replace_str str "\r" "\\r" in
3510 let str = replace_str str "\n" "\\n" in
3511 let str = replace_str str "\t" "\\t" in
3514 (* Generate a lot of different functions for guestfish. *)
3515 and generate_fish_cmds () =
3516 generate_header CStyle GPLv2;
3520 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3522 let all_functions_sorted =
3524 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3525 ) all_functions_sorted in
3527 pr "#include <stdio.h>\n";
3528 pr "#include <stdlib.h>\n";
3529 pr "#include <string.h>\n";
3530 pr "#include <inttypes.h>\n";
3532 pr "#include <guestfs.h>\n";
3533 pr "#include \"fish.h\"\n";
3536 (* list_commands function, which implements guestfish -h *)
3537 pr "void list_commands (void)\n";
3539 pr " printf (\" %%-16s %%s\\n\", \"Command\", \"Description\");\n";
3540 pr " list_builtin_commands ();\n";
3542 fun (name, _, _, flags, _, shortdesc, _) ->
3543 let name = replace_char name '_' '-' in
3544 pr " printf (\"%%-20s %%s\\n\", \"%s\", \"%s\");\n"
3546 ) all_functions_sorted;
3547 pr " printf (\" Use -h <cmd> / help <cmd> to show detailed help for a command.\\n\");\n";
3551 (* display_command function, which implements guestfish -h cmd *)
3552 pr "void display_command (const char *cmd)\n";
3555 fun (name, style, _, flags, _, shortdesc, longdesc) ->
3556 let name2 = replace_char name '_' '-' in
3558 try find_map (function FishAlias n -> Some n | _ -> None) flags
3559 with Not_found -> name in
3560 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
3562 match snd style with
3566 name2 (String.concat "> <" (List.map name_of_argt args)) in
3569 if List.mem ProtocolLimitWarning flags then
3570 ("\n\n" ^ protocol_limit_warning)
3573 (* For DangerWillRobinson commands, we should probably have
3574 * guestfish prompt before allowing you to use them (especially
3575 * in interactive mode). XXX
3579 if List.mem DangerWillRobinson flags then
3580 ("\n\n" ^ danger_will_robinson)
3583 let describe_alias =
3584 if name <> alias then
3585 sprintf "\n\nYou can use '%s' as an alias for this command." alias
3589 pr "strcasecmp (cmd, \"%s\") == 0" name;
3590 if name <> name2 then
3591 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
3592 if name <> alias then
3593 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
3595 pr " pod2text (\"%s - %s\", %S);\n"
3597 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
3600 pr " display_builtin_command (cmd);\n";
3604 (* print_{pv,vg,lv}_list functions *)
3608 pr "static void print_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
3615 pr " printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
3617 pr " printf (\"%s: \");\n" name;
3618 pr " for (i = 0; i < 32; ++i)\n";
3619 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
3620 pr " printf (\"\\n\");\n"
3622 pr " printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
3624 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
3625 | name, `OptPercent ->
3626 pr " if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
3627 typ name name typ name;
3628 pr " else printf (\"%s: \\n\");\n" name
3632 pr "static void print_%s_list (struct guestfs_lvm_%s_list *%ss)\n"
3637 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
3638 pr " print_%s (&%ss->val[i]);\n" typ typ;
3641 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
3643 (* print_{stat,statvfs} functions *)
3647 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
3652 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
3656 ) ["stat", stat_cols; "statvfs", statvfs_cols];
3658 (* run_<action> actions *)
3660 fun (name, style, _, flags, _, _, _) ->
3661 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
3663 (match fst style with
3666 | RBool _ -> pr " int r;\n"
3667 | RInt64 _ -> pr " int64_t r;\n"
3668 | RConstString _ -> pr " const char *r;\n"
3669 | RString _ -> pr " char *r;\n"
3670 | RStringList _ | RHashtable _ -> pr " char **r;\n"
3671 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"
3672 | RPVList _ -> pr " struct guestfs_lvm_pv_list *r;\n"
3673 | RVGList _ -> pr " struct guestfs_lvm_vg_list *r;\n"
3674 | RLVList _ -> pr " struct guestfs_lvm_lv_list *r;\n"
3675 | RStat _ -> pr " struct guestfs_stat *r;\n"
3676 | RStatVFS _ -> pr " struct guestfs_statvfs *r;\n"
3683 | FileOut n -> pr " const char *%s;\n" n
3684 | StringList n -> pr " char **%s;\n" n
3685 | Bool n -> pr " int %s;\n" n
3686 | Int n -> pr " int %s;\n" n
3689 (* Check and convert parameters. *)
3690 let argc_expected = List.length (snd style) in
3691 pr " if (argc != %d) {\n" argc_expected;
3692 pr " fprintf (stderr, \"%%s should have %d parameter(s)\\n\", cmd);\n"
3694 pr " fprintf (stderr, \"type 'help %%s' for help on %%s\\n\", cmd, cmd);\n";
3700 | String name -> pr " %s = argv[%d];\n" name i
3702 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
3705 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
3708 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
3710 | StringList name ->
3711 pr " %s = parse_string_list (argv[%d]);\n" name i
3713 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
3715 pr " %s = atoi (argv[%d]);\n" name i
3718 (* Call C API function. *)
3720 try find_map (function FishAction n -> Some n | _ -> None) flags
3721 with Not_found -> sprintf "guestfs_%s" name in
3723 generate_call_args ~handle:"g" (snd style);
3726 (* Check return value for errors and display command results. *)
3727 (match fst style with
3728 | RErr -> pr " return r;\n"
3730 pr " if (r == -1) return -1;\n";
3731 pr " printf (\"%%d\\n\", r);\n";
3734 pr " if (r == -1) return -1;\n";
3735 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
3738 pr " if (r == -1) return -1;\n";
3739 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
3742 pr " if (r == NULL) return -1;\n";
3743 pr " printf (\"%%s\\n\", r);\n";
3746 pr " if (r == NULL) return -1;\n";
3747 pr " printf (\"%%s\\n\", r);\n";
3751 pr " if (r == NULL) return -1;\n";
3752 pr " print_strings (r);\n";
3753 pr " free_strings (r);\n";
3756 pr " if (r == NULL) return -1;\n";
3757 pr " printf (\"%%d, %%s\\n\", r->i,\n";
3758 pr " r->b ? \"true\" : \"false\");\n";
3759 pr " guestfs_free_int_bool (r);\n";
3762 pr " if (r == NULL) return -1;\n";
3763 pr " print_pv_list (r);\n";
3764 pr " guestfs_free_lvm_pv_list (r);\n";
3767 pr " if (r == NULL) return -1;\n";
3768 pr " print_vg_list (r);\n";
3769 pr " guestfs_free_lvm_vg_list (r);\n";
3772 pr " if (r == NULL) return -1;\n";
3773 pr " print_lv_list (r);\n";
3774 pr " guestfs_free_lvm_lv_list (r);\n";
3777 pr " if (r == NULL) return -1;\n";
3778 pr " print_stat (r);\n";
3782 pr " if (r == NULL) return -1;\n";
3783 pr " print_statvfs (r);\n";
3787 pr " if (r == NULL) return -1;\n";
3788 pr " print_table (r);\n";
3789 pr " free_strings (r);\n";
3796 (* run_action function *)
3797 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
3800 fun (name, _, _, flags, _, _, _) ->
3801 let name2 = replace_char name '_' '-' in
3803 try find_map (function FishAlias n -> Some n | _ -> None) flags
3804 with Not_found -> name in
3806 pr "strcasecmp (cmd, \"%s\") == 0" name;
3807 if name <> name2 then
3808 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
3809 if name <> alias then
3810 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
3812 pr " return run_%s (cmd, argc, argv);\n" name;
3816 pr " fprintf (stderr, \"%%s: unknown command\\n\", cmd);\n";
3823 (* Readline completion for guestfish. *)
3824 and generate_fish_completion () =
3825 generate_header CStyle GPLv2;
3829 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3839 #ifdef HAVE_LIBREADLINE
3840 #include <readline/readline.h>
3845 #ifdef HAVE_LIBREADLINE
3847 static const char *commands[] = {
3850 (* Get the commands and sort them, including the aliases. *)
3853 fun (name, _, _, flags, _, _, _) ->
3854 let name2 = replace_char name '_' '-' in
3856 try find_map (function FishAlias n -> Some n | _ -> None) flags
3857 with Not_found -> name in
3859 if name <> alias then [name2; alias] else [name2]
3861 let commands = List.flatten commands in
3862 let commands = List.sort compare commands in
3864 List.iter (pr " \"%s\",\n") commands;
3870 generator (const char *text, int state)
3872 static int index, len;
3877 len = strlen (text);
3880 while ((name = commands[index]) != NULL) {
3882 if (strncasecmp (name, text, len) == 0)
3883 return strdup (name);
3889 #endif /* HAVE_LIBREADLINE */
3891 char **do_completion (const char *text, int start, int end)
3893 char **matches = NULL;
3895 #ifdef HAVE_LIBREADLINE
3897 matches = rl_completion_matches (text, generator);
3904 (* Generate the POD documentation for guestfish. *)
3905 and generate_fish_actions_pod () =
3906 let all_functions_sorted =
3908 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3909 ) all_functions_sorted in
3911 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
3914 fun (name, style, _, flags, _, _, longdesc) ->
3916 Str.global_substitute rex (
3919 try Str.matched_group 1 s
3921 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
3922 "C<" ^ replace_char sub '_' '-' ^ ">"
3924 let name = replace_char name '_' '-' in
3926 try find_map (function FishAlias n -> Some n | _ -> None) flags
3927 with Not_found -> name in
3929 pr "=head2 %s" name;
3930 if name <> alias then
3937 | String n -> pr " %s" n
3938 | OptString n -> pr " %s" n
3939 | StringList n -> pr " '%s ...'" n
3940 | Bool _ -> pr " true|false"
3941 | Int n -> pr " %s" n
3942 | FileIn n | FileOut n -> pr " (%s|-)" n
3946 pr "%s\n\n" longdesc;
3948 if List.exists (function FileIn _ | FileOut _ -> true
3949 | _ -> false) (snd style) then
3950 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
3952 if List.mem ProtocolLimitWarning flags then
3953 pr "%s\n\n" protocol_limit_warning;
3955 if List.mem DangerWillRobinson flags then
3956 pr "%s\n\n" danger_will_robinson
3957 ) all_functions_sorted
3959 (* Generate a C function prototype. *)
3960 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
3961 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
3963 ?handle name style =
3964 if extern then pr "extern ";
3965 if static then pr "static ";
3966 (match fst style with
3968 | RInt _ -> pr "int "
3969 | RInt64 _ -> pr "int64_t "
3970 | RBool _ -> pr "int "
3971 | RConstString _ -> pr "const char *"
3972 | RString _ -> pr "char *"
3973 | RStringList _ | RHashtable _ -> pr "char **"
3975 if not in_daemon then pr "struct guestfs_int_bool *"
3976 else pr "guestfs_%s_ret *" name
3978 if not in_daemon then pr "struct guestfs_lvm_pv_list *"
3979 else pr "guestfs_lvm_int_pv_list *"
3981 if not in_daemon then pr "struct guestfs_lvm_vg_list *"
3982 else pr "guestfs_lvm_int_vg_list *"
3984 if not in_daemon then pr "struct guestfs_lvm_lv_list *"
3985 else pr "guestfs_lvm_int_lv_list *"
3987 if not in_daemon then pr "struct guestfs_stat *"
3988 else pr "guestfs_int_stat *"
3990 if not in_daemon then pr "struct guestfs_statvfs *"
3991 else pr "guestfs_int_statvfs *"
3993 pr "%s%s (" prefix name;
3994 if handle = None && List.length (snd style) = 0 then
3997 let comma = ref false in
4000 | Some handle -> pr "guestfs_h *%s" handle; comma := true
4004 if single_line then pr ", " else pr ",\n\t\t"
4011 | OptString n -> next (); pr "const char *%s" n
4012 | StringList n -> next (); pr "char * const* const %s" n
4013 | Bool n -> next (); pr "int %s" n
4014 | Int n -> next (); pr "int %s" n
4017 if not in_daemon then (next (); pr "const char *%s" n)
4021 if semicolon then pr ";";
4022 if newline then pr "\n"
4024 (* Generate C call arguments, eg "(handle, foo, bar)" *)
4025 and generate_call_args ?handle args =
4027 let comma = ref false in
4030 | Some handle -> pr "%s" handle; comma := true
4034 if !comma then pr ", ";
4036 pr "%s" (name_of_argt arg)
4040 (* Generate the OCaml bindings interface. *)
4041 and generate_ocaml_mli () =
4042 generate_header OCamlStyle LGPLv2;
4045 (** For API documentation you should refer to the C API
4046 in the guestfs(3) manual page. The OCaml API uses almost
4047 exactly the same calls. *)
4050 (** A [guestfs_h] handle. *)
4052 exception Error of string
4053 (** This exception is raised when there is an error. *)
4055 val create : unit -> t
4057 val close : t -> unit
4058 (** Handles are closed by the garbage collector when they become
4059 unreferenced, but callers can also call this in order to
4060 provide predictable cleanup. *)
4063 generate_ocaml_lvm_structure_decls ();
4065 generate_ocaml_stat_structure_decls ();
4069 fun (name, style, _, _, _, shortdesc, _) ->
4070 generate_ocaml_prototype name style;
4071 pr "(** %s *)\n" shortdesc;
4075 (* Generate the OCaml bindings implementation. *)
4076 and generate_ocaml_ml () =
4077 generate_header OCamlStyle LGPLv2;
4081 exception Error of string
4082 external create : unit -> t = \"ocaml_guestfs_create\"
4083 external close : t -> unit = \"ocaml_guestfs_close\"
4086 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
4090 generate_ocaml_lvm_structure_decls ();
4092 generate_ocaml_stat_structure_decls ();
4096 fun (name, style, _, _, _, shortdesc, _) ->
4097 generate_ocaml_prototype ~is_external:true name style;
4100 (* Generate the OCaml bindings C implementation. *)
4101 and generate_ocaml_c () =
4102 generate_header CStyle LGPLv2;
4109 #include <caml/config.h>
4110 #include <caml/alloc.h>
4111 #include <caml/callback.h>
4112 #include <caml/fail.h>
4113 #include <caml/memory.h>
4114 #include <caml/mlvalues.h>
4115 #include <caml/signals.h>
4117 #include <guestfs.h>
4119 #include \"guestfs_c.h\"
4121 /* Copy a hashtable of string pairs into an assoc-list. We return
4122 * the list in reverse order, but hashtables aren't supposed to be
4125 static CAMLprim value
4126 copy_table (char * const * argv)
4129 CAMLlocal5 (rv, pairv, kv, vv, cons);
4133 for (i = 0; argv[i] != NULL; i += 2) {
4134 kv = caml_copy_string (argv[i]);
4135 vv = caml_copy_string (argv[i+1]);
4136 pairv = caml_alloc (2, 0);
4137 Store_field (pairv, 0, kv);
4138 Store_field (pairv, 1, vv);
4139 cons = caml_alloc (2, 0);
4140 Store_field (cons, 1, rv);
4142 Store_field (cons, 0, pairv);
4150 (* LVM struct copy functions. *)
4153 let has_optpercent_col =
4154 List.exists (function (_, `OptPercent) -> true | _ -> false) cols in
4156 pr "static CAMLprim value\n";
4157 pr "copy_lvm_%s (const struct guestfs_lvm_%s *%s)\n" typ typ typ;
4159 pr " CAMLparam0 ();\n";
4160 if has_optpercent_col then
4161 pr " CAMLlocal3 (rv, v, v2);\n"
4163 pr " CAMLlocal2 (rv, v);\n";
4165 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
4170 pr " v = caml_copy_string (%s->%s);\n" typ name
4172 pr " v = caml_alloc_string (32);\n";
4173 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
4176 pr " v = caml_copy_int64 (%s->%s);\n" typ name
4177 | name, `OptPercent ->
4178 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
4179 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
4180 pr " v = caml_alloc (1, 0);\n";
4181 pr " Store_field (v, 0, v2);\n";
4182 pr " } else /* None */\n";
4183 pr " v = Val_int (0);\n";
4185 pr " Store_field (rv, %d, v);\n" i
4187 pr " CAMLreturn (rv);\n";
4191 pr "static CAMLprim value\n";
4192 pr "copy_lvm_%s_list (const struct guestfs_lvm_%s_list *%ss)\n"
4195 pr " CAMLparam0 ();\n";
4196 pr " CAMLlocal2 (rv, v);\n";
4199 pr " if (%ss->len == 0)\n" typ;
4200 pr " CAMLreturn (Atom (0));\n";
4202 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
4203 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
4204 pr " v = copy_lvm_%s (&%ss->val[i]);\n" typ typ;
4205 pr " caml_modify (&Field (rv, i), v);\n";
4207 pr " CAMLreturn (rv);\n";
4211 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
4213 (* Stat copy functions. *)
4216 pr "static CAMLprim value\n";
4217 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
4219 pr " CAMLparam0 ();\n";
4220 pr " CAMLlocal2 (rv, v);\n";
4222 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
4227 pr " v = caml_copy_int64 (%s->%s);\n" typ name
4229 pr " Store_field (rv, %d, v);\n" i
4231 pr " CAMLreturn (rv);\n";
4234 ) ["stat", stat_cols; "statvfs", statvfs_cols];
4238 fun (name, style, _, _, _, _, _) ->
4240 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
4242 pr "CAMLprim value\n";
4243 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
4244 List.iter (pr ", value %s") (List.tl params);
4249 | [p1; p2; p3; p4; p5] ->
4250 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
4251 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
4252 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
4253 pr " CAMLxparam%d (%s);\n"
4254 (List.length rest) (String.concat ", " rest)
4256 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
4258 pr " CAMLlocal1 (rv);\n";
4261 pr " guestfs_h *g = Guestfs_val (gv);\n";
4262 pr " if (g == NULL)\n";
4263 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
4271 pr " const char *%s = String_val (%sv);\n" n n
4273 pr " const char *%s =\n" n;
4274 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
4277 pr " char **%s = ocaml_guestfs_strings_val (%sv);\n" n n
4279 pr " int %s = Bool_val (%sv);\n" n n
4281 pr " int %s = Int_val (%sv);\n" n n
4284 match fst style with
4285 | RErr -> pr " int r;\n"; "-1"
4286 | RInt _ -> pr " int r;\n"; "-1"
4287 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4288 | RBool _ -> pr " int r;\n"; "-1"
4289 | RConstString _ -> pr " const char *r;\n"; "NULL"
4290 | RString _ -> pr " char *r;\n"; "NULL"
4296 pr " struct guestfs_int_bool *r;\n"; "NULL"
4298 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
4300 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
4302 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
4304 pr " struct guestfs_stat *r;\n"; "NULL"
4306 pr " struct guestfs_statvfs *r;\n"; "NULL"
4313 pr " caml_enter_blocking_section ();\n";
4314 pr " r = guestfs_%s " name;
4315 generate_call_args ~handle:"g" (snd style);
4317 pr " caml_leave_blocking_section ();\n";
4322 pr " ocaml_guestfs_free_strings (%s);\n" n;
4323 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
4326 pr " if (r == %s)\n" error_code;
4327 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
4330 (match fst style with
4331 | RErr -> pr " rv = Val_unit;\n"
4332 | RInt _ -> pr " rv = Val_int (r);\n"
4334 pr " rv = caml_copy_int64 (r);\n"
4335 | RBool _ -> pr " rv = Val_bool (r);\n"
4336 | RConstString _ -> pr " rv = caml_copy_string (r);\n"
4338 pr " rv = caml_copy_string (r);\n";
4341 pr " rv = caml_copy_string_array ((const char **) r);\n";
4342 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
4345 pr " rv = caml_alloc (2, 0);\n";
4346 pr " Store_field (rv, 0, Val_int (r->i));\n";
4347 pr " Store_field (rv, 1, Val_bool (r->b));\n";
4348 pr " guestfs_free_int_bool (r);\n";
4350 pr " rv = copy_lvm_pv_list (r);\n";
4351 pr " guestfs_free_lvm_pv_list (r);\n";
4353 pr " rv = copy_lvm_vg_list (r);\n";
4354 pr " guestfs_free_lvm_vg_list (r);\n";
4356 pr " rv = copy_lvm_lv_list (r);\n";
4357 pr " guestfs_free_lvm_lv_list (r);\n";
4359 pr " rv = copy_stat (r);\n";
4362 pr " rv = copy_statvfs (r);\n";
4365 pr " rv = copy_table (r);\n";
4366 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
4370 pr " CAMLreturn (rv);\n";
4374 if List.length params > 5 then (
4375 pr "CAMLprim value\n";
4376 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
4378 pr " return ocaml_guestfs_%s (argv[0]" name;
4379 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
4386 and generate_ocaml_lvm_structure_decls () =
4389 pr "type lvm_%s = {\n" typ;
4392 | name, `String -> pr " %s : string;\n" name
4393 | name, `UUID -> pr " %s : string;\n" name
4394 | name, `Bytes -> pr " %s : int64;\n" name
4395 | name, `Int -> pr " %s : int64;\n" name
4396 | name, `OptPercent -> pr " %s : float option;\n" name
4400 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
4402 and generate_ocaml_stat_structure_decls () =
4405 pr "type %s = {\n" typ;
4408 | name, `Int -> pr " %s : int64;\n" name
4412 ) ["stat", stat_cols; "statvfs", statvfs_cols]
4414 and generate_ocaml_prototype ?(is_external = false) name style =
4415 if is_external then pr "external " else pr "val ";
4416 pr "%s : t -> " name;
4419 | String _ | FileIn _ | FileOut _ -> pr "string -> "
4420 | OptString _ -> pr "string option -> "
4421 | StringList _ -> pr "string array -> "
4422 | Bool _ -> pr "bool -> "
4423 | Int _ -> pr "int -> "
4425 (match fst style with
4426 | RErr -> pr "unit" (* all errors are turned into exceptions *)
4427 | RInt _ -> pr "int"
4428 | RInt64 _ -> pr "int64"
4429 | RBool _ -> pr "bool"
4430 | RConstString _ -> pr "string"
4431 | RString _ -> pr "string"
4432 | RStringList _ -> pr "string array"
4433 | RIntBool _ -> pr "int * bool"
4434 | RPVList _ -> pr "lvm_pv array"
4435 | RVGList _ -> pr "lvm_vg array"
4436 | RLVList _ -> pr "lvm_lv array"
4437 | RStat _ -> pr "stat"
4438 | RStatVFS _ -> pr "statvfs"
4439 | RHashtable _ -> pr "(string * string) list"
4441 if is_external then (
4443 if List.length (snd style) + 1 > 5 then
4444 pr "\"ocaml_guestfs_%s_byte\" " name;
4445 pr "\"ocaml_guestfs_%s\"" name
4449 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
4450 and generate_perl_xs () =
4451 generate_header CStyle LGPLv2;
4454 #include \"EXTERN.h\"
4458 #include <guestfs.h>
4461 #define PRId64 \"lld\"
4465 my_newSVll(long long val) {
4466 #ifdef USE_64_BIT_ALL
4467 return newSViv(val);
4471 len = snprintf(buf, 100, \"%%\" PRId64, val);
4472 return newSVpv(buf, len);
4477 #define PRIu64 \"llu\"
4481 my_newSVull(unsigned long long val) {
4482 #ifdef USE_64_BIT_ALL
4483 return newSVuv(val);
4487 len = snprintf(buf, 100, \"%%\" PRIu64, val);
4488 return newSVpv(buf, len);
4492 /* http://www.perlmonks.org/?node_id=680842 */
4494 XS_unpack_charPtrPtr (SV *arg) {
4499 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV) {
4500 croak (\"array reference expected\");
4503 av = (AV *)SvRV (arg);
4504 ret = (char **)malloc (av_len (av) + 1 + 1);
4506 for (i = 0; i <= av_len (av); i++) {
4507 SV **elem = av_fetch (av, i, 0);
4509 if (!elem || !*elem)
4510 croak (\"missing element in list\");
4512 ret[i] = SvPV_nolen (*elem);
4520 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
4525 RETVAL = guestfs_create ();
4527 croak (\"could not create guestfs handle\");
4528 guestfs_set_error_handler (RETVAL, NULL, NULL);
4541 fun (name, style, _, _, _, _, _) ->
4542 (match fst style with
4543 | RErr -> pr "void\n"
4544 | RInt _ -> pr "SV *\n"
4545 | RInt64 _ -> pr "SV *\n"
4546 | RBool _ -> pr "SV *\n"
4547 | RConstString _ -> pr "SV *\n"
4548 | RString _ -> pr "SV *\n"
4551 | RPVList _ | RVGList _ | RLVList _
4552 | RStat _ | RStatVFS _
4554 pr "void\n" (* all lists returned implictly on the stack *)
4556 (* Call and arguments. *)
4558 generate_call_args ~handle:"g" (snd style);
4560 pr " guestfs_h *g;\n";
4563 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
4564 | OptString n -> pr " char *%s;\n" n
4565 | StringList n -> pr " char **%s;\n" n
4566 | Bool n -> pr " int %s;\n" n
4567 | Int n -> pr " int %s;\n" n
4570 let do_cleanups () =
4573 | String _ | OptString _ | Bool _ | Int _
4574 | FileIn _ | FileOut _ -> ()
4575 | StringList n -> pr " free (%s);\n" n
4580 (match fst style with
4585 pr " r = guestfs_%s " name;
4586 generate_call_args ~handle:"g" (snd style);
4589 pr " if (r == -1)\n";
4590 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4596 pr " %s = guestfs_%s " n name;
4597 generate_call_args ~handle:"g" (snd style);
4600 pr " if (%s == -1)\n" n;
4601 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4602 pr " RETVAL = newSViv (%s);\n" n;
4607 pr " int64_t %s;\n" n;
4609 pr " %s = guestfs_%s " n name;
4610 generate_call_args ~handle:"g" (snd style);
4613 pr " if (%s == -1)\n" n;
4614 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4615 pr " RETVAL = my_newSVll (%s);\n" n;
4620 pr " const char *%s;\n" n;
4622 pr " %s = guestfs_%s " n name;
4623 generate_call_args ~handle:"g" (snd style);
4626 pr " if (%s == NULL)\n" n;
4627 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4628 pr " RETVAL = newSVpv (%s, 0);\n" n;
4633 pr " char *%s;\n" n;
4635 pr " %s = guestfs_%s " n name;
4636 generate_call_args ~handle:"g" (snd style);
4639 pr " if (%s == NULL)\n" n;
4640 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4641 pr " RETVAL = newSVpv (%s, 0);\n" n;
4642 pr " free (%s);\n" n;
4645 | RStringList n | RHashtable n ->
4647 pr " char **%s;\n" n;
4650 pr " %s = guestfs_%s " n name;
4651 generate_call_args ~handle:"g" (snd style);
4654 pr " if (%s == NULL)\n" n;
4655 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4656 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
4657 pr " EXTEND (SP, n);\n";
4658 pr " for (i = 0; i < n; ++i) {\n";
4659 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
4660 pr " free (%s[i]);\n" n;
4662 pr " free (%s);\n" n;
4665 pr " struct guestfs_int_bool *r;\n";
4667 pr " r = guestfs_%s " name;
4668 generate_call_args ~handle:"g" (snd style);
4671 pr " if (r == NULL)\n";
4672 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4673 pr " EXTEND (SP, 2);\n";
4674 pr " PUSHs (sv_2mortal (newSViv (r->i)));\n";
4675 pr " PUSHs (sv_2mortal (newSViv (r->b)));\n";
4676 pr " guestfs_free_int_bool (r);\n";
4678 generate_perl_lvm_code "pv" pv_cols name style n do_cleanups
4680 generate_perl_lvm_code "vg" vg_cols name style n do_cleanups
4682 generate_perl_lvm_code "lv" lv_cols name style n do_cleanups
4684 generate_perl_stat_code "stat" stat_cols name style n do_cleanups
4686 generate_perl_stat_code
4687 "statvfs" statvfs_cols name style n do_cleanups
4693 and generate_perl_lvm_code typ cols name style n do_cleanups =
4695 pr " struct guestfs_lvm_%s_list *%s;\n" typ n;
4699 pr " %s = guestfs_%s " n name;
4700 generate_call_args ~handle:"g" (snd style);
4703 pr " if (%s == NULL)\n" n;
4704 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4705 pr " EXTEND (SP, %s->len);\n" n;
4706 pr " for (i = 0; i < %s->len; ++i) {\n" n;
4707 pr " hv = newHV ();\n";
4711 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
4712 name (String.length name) n name
4714 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
4715 name (String.length name) n name
4717 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
4718 name (String.length name) n name
4720 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
4721 name (String.length name) n name
4722 | name, `OptPercent ->
4723 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
4724 name (String.length name) n name
4726 pr " PUSHs (sv_2mortal ((SV *) hv));\n";
4728 pr " guestfs_free_lvm_%s_list (%s);\n" typ n
4730 and generate_perl_stat_code typ cols name style n do_cleanups =
4732 pr " struct guestfs_%s *%s;\n" typ n;
4734 pr " %s = guestfs_%s " n name;
4735 generate_call_args ~handle:"g" (snd style);
4738 pr " if (%s == NULL)\n" n;
4739 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4740 pr " EXTEND (SP, %d);\n" (List.length cols);
4744 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n" n name
4746 pr " free (%s);\n" n
4748 (* Generate Sys/Guestfs.pm. *)
4749 and generate_perl_pm () =
4750 generate_header HashStyle LGPLv2;
4757 Sys::Guestfs - Perl bindings for libguestfs
4763 my $h = Sys::Guestfs->new ();
4764 $h->add_drive ('guest.img');
4767 $h->mount ('/dev/sda1', '/');
4768 $h->touch ('/hello');
4773 The C<Sys::Guestfs> module provides a Perl XS binding to the
4774 libguestfs API for examining and modifying virtual machine
4777 Amongst the things this is good for: making batch configuration
4778 changes to guests, getting disk used/free statistics (see also:
4779 virt-df), migrating between virtualization systems (see also:
4780 virt-p2v), performing partial backups, performing partial guest
4781 clones, cloning guests and changing registry/UUID/hostname info, and
4784 Libguestfs uses Linux kernel and qemu code, and can access any type of
4785 guest filesystem that Linux and qemu can, including but not limited
4786 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
4787 schemes, qcow, qcow2, vmdk.
4789 Libguestfs provides ways to enumerate guest storage (eg. partitions,
4790 LVs, what filesystem is in each LV, etc.). It can also run commands
4791 in the context of the guest. Also you can access filesystems over FTP.
4795 All errors turn into calls to C<croak> (see L<Carp(3)>).
4803 package Sys::Guestfs;
4809 XSLoader::load ('Sys::Guestfs');
4811 =item $h = Sys::Guestfs->new ();
4813 Create a new guestfs handle.
4819 my $class = ref ($proto) || $proto;
4821 my $self = Sys::Guestfs::_create ();
4822 bless $self, $class;
4828 (* Actions. We only need to print documentation for these as
4829 * they are pulled in from the XS code automatically.
4832 fun (name, style, _, flags, _, _, longdesc) ->
4833 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
4835 generate_perl_prototype name style;
4837 pr "%s\n\n" longdesc;
4838 if List.mem ProtocolLimitWarning flags then
4839 pr "%s\n\n" protocol_limit_warning;
4840 if List.mem DangerWillRobinson flags then
4841 pr "%s\n\n" danger_will_robinson
4842 ) all_functions_sorted;
4854 Copyright (C) 2009 Red Hat Inc.
4858 Please see the file COPYING.LIB for the full license.
4862 L<guestfs(3)>, L<guestfish(1)>.
4867 and generate_perl_prototype name style =
4868 (match fst style with
4874 | RString n -> pr "$%s = " n
4875 | RIntBool (n, m) -> pr "($%s, $%s) = " n m
4879 | RLVList n -> pr "@%s = " n
4882 | RHashtable n -> pr "%%%s = " n
4885 let comma = ref false in
4888 if !comma then pr ", ";
4891 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
4898 (* Generate Python C module. *)
4899 and generate_python_c () =
4900 generate_header CStyle LGPLv2;
4909 #include \"guestfs.h\"
4917 get_handle (PyObject *obj)
4920 assert (obj != Py_None);
4921 return ((Pyguestfs_Object *) obj)->g;
4925 put_handle (guestfs_h *g)
4929 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
4932 /* This list should be freed (but not the strings) after use. */
4933 static const char **
4934 get_string_list (PyObject *obj)
4941 if (!PyList_Check (obj)) {
4942 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
4946 len = PyList_Size (obj);
4947 r = malloc (sizeof (char *) * (len+1));
4949 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
4953 for (i = 0; i < len; ++i)
4954 r[i] = PyString_AsString (PyList_GetItem (obj, i));
4961 put_string_list (char * const * const argv)
4966 for (argc = 0; argv[argc] != NULL; ++argc)
4969 list = PyList_New (argc);
4970 for (i = 0; i < argc; ++i)
4971 PyList_SetItem (list, i, PyString_FromString (argv[i]));
4977 put_table (char * const * const argv)
4979 PyObject *list, *item;
4982 for (argc = 0; argv[argc] != NULL; ++argc)
4985 list = PyList_New (argc >> 1);
4986 for (i = 0; i < argc; i += 2) {
4987 item = PyTuple_New (2);
4988 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
4989 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
4990 PyList_SetItem (list, i >> 1, item);
4997 free_strings (char **argv)
5001 for (argc = 0; argv[argc] != NULL; ++argc)
5007 py_guestfs_create (PyObject *self, PyObject *args)
5011 g = guestfs_create ();
5013 PyErr_SetString (PyExc_RuntimeError,
5014 \"guestfs.create: failed to allocate handle\");
5017 guestfs_set_error_handler (g, NULL, NULL);
5018 return put_handle (g);
5022 py_guestfs_close (PyObject *self, PyObject *args)
5027 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
5029 g = get_handle (py_g);
5033 Py_INCREF (Py_None);
5039 (* LVM structures, turned into Python dictionaries. *)
5042 pr "static PyObject *\n";
5043 pr "put_lvm_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
5045 pr " PyObject *dict;\n";
5047 pr " dict = PyDict_New ();\n";
5051 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5052 pr " PyString_FromString (%s->%s));\n"
5055 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5056 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
5059 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5060 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
5063 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5064 pr " PyLong_FromLongLong (%s->%s));\n"
5066 | name, `OptPercent ->
5067 pr " if (%s->%s >= 0)\n" typ name;
5068 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5069 pr " PyFloat_FromDouble ((double) %s->%s));\n"
5072 pr " Py_INCREF (Py_None);\n";
5073 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
5076 pr " return dict;\n";
5080 pr "static PyObject *\n";
5081 pr "put_lvm_%s_list (struct guestfs_lvm_%s_list *%ss)\n" typ typ typ;
5083 pr " PyObject *list;\n";
5086 pr " list = PyList_New (%ss->len);\n" typ;
5087 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
5088 pr " PyList_SetItem (list, i, put_lvm_%s (&%ss->val[i]));\n" typ typ;
5089 pr " return list;\n";
5092 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
5094 (* Stat structures, turned into Python dictionaries. *)
5097 pr "static PyObject *\n";
5098 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
5100 pr " PyObject *dict;\n";
5102 pr " dict = PyDict_New ();\n";
5106 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5107 pr " PyLong_FromLongLong (%s->%s));\n"
5110 pr " return dict;\n";
5113 ) ["stat", stat_cols; "statvfs", statvfs_cols];
5115 (* Python wrapper functions. *)
5117 fun (name, style, _, _, _, _, _) ->
5118 pr "static PyObject *\n";
5119 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
5122 pr " PyObject *py_g;\n";
5123 pr " guestfs_h *g;\n";
5124 pr " PyObject *py_r;\n";
5127 match fst style with
5128 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5129 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5130 | RConstString _ -> pr " const char *r;\n"; "NULL"
5131 | RString _ -> pr " char *r;\n"; "NULL"
5132 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5133 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
5134 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5135 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5136 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5137 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
5138 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
5142 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
5143 | OptString n -> pr " const char *%s;\n" n
5145 pr " PyObject *py_%s;\n" n;
5146 pr " const char **%s;\n" n
5147 | Bool n -> pr " int %s;\n" n
5148 | Int n -> pr " int %s;\n" n
5153 (* Convert the parameters. *)
5154 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
5157 | String _ | FileIn _ | FileOut _ -> pr "s"
5158 | OptString _ -> pr "z"
5159 | StringList _ -> pr "O"
5160 | Bool _ -> pr "i" (* XXX Python has booleans? *)
5163 pr ":guestfs_%s\",\n" name;
5167 | String n | FileIn n | FileOut n -> pr ", &%s" n
5168 | OptString n -> pr ", &%s" n
5169 | StringList n -> pr ", &py_%s" n
5170 | Bool n -> pr ", &%s" n
5171 | Int n -> pr ", &%s" n
5175 pr " return NULL;\n";
5177 pr " g = get_handle (py_g);\n";
5180 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5182 pr " %s = get_string_list (py_%s);\n" n n;
5183 pr " if (!%s) return NULL;\n" n
5188 pr " r = guestfs_%s " name;
5189 generate_call_args ~handle:"g" (snd style);
5194 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5196 pr " free (%s);\n" n
5199 pr " if (r == %s) {\n" error_code;
5200 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
5201 pr " return NULL;\n";
5205 (match fst style with
5207 pr " Py_INCREF (Py_None);\n";
5208 pr " py_r = Py_None;\n"
5210 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
5211 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
5212 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
5214 pr " py_r = PyString_FromString (r);\n";
5217 pr " py_r = put_string_list (r);\n";
5218 pr " free_strings (r);\n"
5220 pr " py_r = PyTuple_New (2);\n";
5221 pr " PyTuple_SetItem (py_r, 0, PyInt_FromLong ((long) r->i));\n";
5222 pr " PyTuple_SetItem (py_r, 1, PyInt_FromLong ((long) r->b));\n";
5223 pr " guestfs_free_int_bool (r);\n"
5225 pr " py_r = put_lvm_pv_list (r);\n";
5226 pr " guestfs_free_lvm_pv_list (r);\n"
5228 pr " py_r = put_lvm_vg_list (r);\n";
5229 pr " guestfs_free_lvm_vg_list (r);\n"
5231 pr " py_r = put_lvm_lv_list (r);\n";
5232 pr " guestfs_free_lvm_lv_list (r);\n"
5234 pr " py_r = put_stat (r);\n";
5237 pr " py_r = put_statvfs (r);\n";
5240 pr " py_r = put_table (r);\n";
5241 pr " free_strings (r);\n"
5244 pr " return py_r;\n";
5249 (* Table of functions. *)
5250 pr "static PyMethodDef methods[] = {\n";
5251 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
5252 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
5254 fun (name, _, _, _, _, _, _) ->
5255 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
5258 pr " { NULL, NULL, 0, NULL }\n";
5262 (* Init function. *)
5265 initlibguestfsmod (void)
5267 static int initialized = 0;
5269 if (initialized) return;
5270 Py_InitModule ((char *) \"libguestfsmod\", methods);
5275 (* Generate Python module. *)
5276 and generate_python_py () =
5277 generate_header HashStyle LGPLv2;
5280 u\"\"\"Python bindings for libguestfs
5283 g = guestfs.GuestFS ()
5284 g.add_drive (\"guest.img\")
5287 parts = g.list_partitions ()
5289 The guestfs module provides a Python binding to the libguestfs API
5290 for examining and modifying virtual machine disk images.
5292 Amongst the things this is good for: making batch configuration
5293 changes to guests, getting disk used/free statistics (see also:
5294 virt-df), migrating between virtualization systems (see also:
5295 virt-p2v), performing partial backups, performing partial guest
5296 clones, cloning guests and changing registry/UUID/hostname info, and
5299 Libguestfs uses Linux kernel and qemu code, and can access any type of
5300 guest filesystem that Linux and qemu can, including but not limited
5301 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
5302 schemes, qcow, qcow2, vmdk.
5304 Libguestfs provides ways to enumerate guest storage (eg. partitions,
5305 LVs, what filesystem is in each LV, etc.). It can also run commands
5306 in the context of the guest. Also you can access filesystems over FTP.
5308 Errors which happen while using the API are turned into Python
5309 RuntimeError exceptions.
5311 To create a guestfs handle you usually have to perform the following
5314 # Create the handle, call add_drive at least once, and possibly
5315 # several times if the guest has multiple block devices:
5316 g = guestfs.GuestFS ()
5317 g.add_drive (\"guest.img\")
5319 # Launch the qemu subprocess and wait for it to become ready:
5323 # Now you can issue commands, for example:
5328 import libguestfsmod
5331 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
5333 def __init__ (self):
5334 \"\"\"Create a new libguestfs handle.\"\"\"
5335 self._o = libguestfsmod.create ()
5338 libguestfsmod.close (self._o)
5343 fun (name, style, _, flags, _, _, longdesc) ->
5344 let doc = replace_str longdesc "C<guestfs_" "C<g." in
5346 match fst style with
5347 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _
5350 doc ^ "\n\nThis function returns a list of strings."
5352 doc ^ "\n\nThis function returns a tuple (int, bool).\n"
5354 doc ^ "\n\nThis function returns a list of PVs. Each PV is represented as a dictionary."
5356 doc ^ "\n\nThis function returns a list of VGs. Each VG is represented as a dictionary."
5358 doc ^ "\n\nThis function returns a list of LVs. Each LV is represented as a dictionary."
5360 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the stat structure."
5362 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the statvfs structure."
5364 doc ^ "\n\nThis function returns a dictionary." in
5366 if List.mem ProtocolLimitWarning flags then
5367 doc ^ "\n\n" ^ protocol_limit_warning
5370 if List.mem DangerWillRobinson flags then
5371 doc ^ "\n\n" ^ danger_will_robinson
5373 let doc = pod2text ~width:60 name doc in
5374 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
5375 let doc = String.concat "\n " doc in
5378 generate_call_args ~handle:"self" (snd style);
5380 pr " u\"\"\"%s\"\"\"\n" doc;
5381 pr " return libguestfsmod.%s " name;
5382 generate_call_args ~handle:"self._o" (snd style);
5387 (* Useful if you need the longdesc POD text as plain text. Returns a
5390 * This is the slowest thing about autogeneration.
5392 and pod2text ~width name longdesc =
5393 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
5394 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
5396 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
5397 let chan = Unix.open_process_in cmd in
5398 let lines = ref [] in
5400 let line = input_line chan in
5401 if i = 1 then (* discard the first line of output *)
5404 let line = triml line in
5405 lines := line :: !lines;
5408 let lines = try loop 1 with End_of_file -> List.rev !lines in
5409 Unix.unlink filename;
5410 match Unix.close_process_in chan with
5411 | Unix.WEXITED 0 -> lines
5413 failwithf "pod2text: process exited with non-zero status (%d)" i
5414 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
5415 failwithf "pod2text: process signalled or stopped by signal %d" i
5417 (* Generate ruby bindings. *)
5418 and generate_ruby_c () =
5419 generate_header CStyle LGPLv2;
5427 #include \"guestfs.h\"
5429 #include \"extconf.h\"
5431 static VALUE m_guestfs; /* guestfs module */
5432 static VALUE c_guestfs; /* guestfs_h handle */
5433 static VALUE e_Error; /* used for all errors */
5435 static void ruby_guestfs_free (void *p)
5438 guestfs_close ((guestfs_h *) p);
5441 static VALUE ruby_guestfs_create (VALUE m)
5445 g = guestfs_create ();
5447 rb_raise (e_Error, \"failed to create guestfs handle\");
5449 /* Don't print error messages to stderr by default. */
5450 guestfs_set_error_handler (g, NULL, NULL);
5452 /* Wrap it, and make sure the close function is called when the
5455 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
5458 static VALUE ruby_guestfs_close (VALUE gv)
5461 Data_Get_Struct (gv, guestfs_h, g);
5463 ruby_guestfs_free (g);
5464 DATA_PTR (gv) = NULL;
5472 fun (name, style, _, _, _, _, _) ->
5473 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
5474 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
5477 pr " guestfs_h *g;\n";
5478 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
5480 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
5486 | String n | FileIn n | FileOut n ->
5487 pr " const char *%s = StringValueCStr (%sv);\n" n n;
5489 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
5490 pr " \"%s\", \"%s\");\n" n name
5492 pr " const char *%s = StringValueCStr (%sv);\n" n n
5496 pr " int i, len;\n";
5497 pr " len = RARRAY_LEN (%sv);\n" n;
5498 pr " %s = malloc (sizeof (char *) * (len+1));\n" n;
5499 pr " for (i = 0; i < len; ++i) {\n";
5500 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
5501 pr " %s[i] = StringValueCStr (v);\n" n;
5503 pr " %s[len] = NULL;\n" n;
5507 pr " int %s = NUM2INT (%sv);\n" n n
5512 match fst style with
5513 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5514 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5515 | RConstString _ -> pr " const char *r;\n"; "NULL"
5516 | RString _ -> pr " char *r;\n"; "NULL"
5517 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5518 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
5519 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5520 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5521 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5522 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
5523 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
5526 pr " r = guestfs_%s " name;
5527 generate_call_args ~handle:"g" (snd style);
5532 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5534 pr " free (%s);\n" n
5537 pr " if (r == %s)\n" error_code;
5538 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
5541 (match fst style with
5543 pr " return Qnil;\n"
5544 | RInt _ | RBool _ ->
5545 pr " return INT2NUM (r);\n"
5547 pr " return ULL2NUM (r);\n"
5549 pr " return rb_str_new2 (r);\n";
5551 pr " VALUE rv = rb_str_new2 (r);\n";
5555 pr " int i, len = 0;\n";
5556 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
5557 pr " VALUE rv = rb_ary_new2 (len);\n";
5558 pr " for (i = 0; r[i] != NULL; ++i) {\n";
5559 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
5560 pr " free (r[i]);\n";
5565 pr " VALUE rv = rb_ary_new2 (2);\n";
5566 pr " rb_ary_push (rv, INT2NUM (r->i));\n";
5567 pr " rb_ary_push (rv, INT2NUM (r->b));\n";
5568 pr " guestfs_free_int_bool (r);\n";
5571 generate_ruby_lvm_code "pv" pv_cols
5573 generate_ruby_lvm_code "vg" vg_cols
5575 generate_ruby_lvm_code "lv" lv_cols
5577 pr " VALUE rv = rb_hash_new ();\n";
5581 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
5586 pr " VALUE rv = rb_hash_new ();\n";
5590 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
5595 pr " VALUE rv = rb_hash_new ();\n";
5597 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
5598 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
5599 pr " free (r[i]);\n";
5600 pr " free (r[i+1]);\n";
5611 /* Initialize the module. */
5612 void Init__guestfs ()
5614 m_guestfs = rb_define_module (\"Guestfs\");
5615 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
5616 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
5618 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
5619 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
5622 (* Define the rest of the methods. *)
5624 fun (name, style, _, _, _, _, _) ->
5625 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
5626 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
5631 (* Ruby code to return an LVM struct list. *)
5632 and generate_ruby_lvm_code typ cols =
5633 pr " VALUE rv = rb_ary_new2 (r->len);\n";
5635 pr " for (i = 0; i < r->len; ++i) {\n";
5636 pr " VALUE hv = rb_hash_new ();\n";
5640 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
5642 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
5645 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
5646 | name, `OptPercent ->
5647 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
5649 pr " rb_ary_push (rv, hv);\n";
5651 pr " guestfs_free_lvm_%s_list (r);\n" typ;
5654 (* Generate Java bindings GuestFS.java file. *)
5655 and generate_java_java () =
5656 generate_header CStyle LGPLv2;
5659 package com.redhat.et.libguestfs;
5661 import java.util.HashMap;
5662 import com.redhat.et.libguestfs.LibGuestFSException;
5663 import com.redhat.et.libguestfs.PV;
5664 import com.redhat.et.libguestfs.VG;
5665 import com.redhat.et.libguestfs.LV;
5666 import com.redhat.et.libguestfs.Stat;
5667 import com.redhat.et.libguestfs.StatVFS;
5668 import com.redhat.et.libguestfs.IntBool;
5671 * The GuestFS object is a libguestfs handle.
5675 public class GuestFS {
5676 // Load the native code.
5678 System.loadLibrary (\"guestfs_jni\");
5682 * The native guestfs_h pointer.
5687 * Create a libguestfs handle.
5689 * @throws LibGuestFSException
5691 public GuestFS () throws LibGuestFSException
5695 private native long _create () throws LibGuestFSException;
5698 * Close a libguestfs handle.
5700 * You can also leave handles to be collected by the garbage
5701 * collector, but this method ensures that the resources used
5702 * by the handle are freed up immediately. If you call any
5703 * other methods after closing the handle, you will get an
5706 * @throws LibGuestFSException
5708 public void close () throws LibGuestFSException
5714 private native void _close (long g) throws LibGuestFSException;
5716 public void finalize () throws LibGuestFSException
5724 fun (name, style, _, flags, _, shortdesc, longdesc) ->
5725 let doc = replace_str longdesc "C<guestfs_" "C<g." in
5727 if List.mem ProtocolLimitWarning flags then
5728 doc ^ "\n\n" ^ protocol_limit_warning
5731 if List.mem DangerWillRobinson flags then
5732 doc ^ "\n\n" ^ danger_will_robinson
5734 let doc = pod2text ~width:60 name doc in
5735 let doc = String.concat "\n * " doc in
5738 pr " * %s\n" shortdesc;
5741 pr " * @throws LibGuestFSException\n";
5744 generate_java_prototype ~public:true ~semicolon:false name style;
5747 pr " if (g == 0)\n";
5748 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
5751 if fst style <> RErr then pr "return ";
5753 generate_call_args ~handle:"g" (snd style);
5757 generate_java_prototype ~privat:true ~native:true name style;
5764 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
5765 ?(semicolon=true) name style =
5766 if privat then pr "private ";
5767 if public then pr "public ";
5768 if native then pr "native ";
5771 (match fst style with
5772 | RErr -> pr "void ";
5773 | RInt _ -> pr "int ";
5774 | RInt64 _ -> pr "long ";
5775 | RBool _ -> pr "boolean ";
5776 | RConstString _ | RString _ -> pr "String ";
5777 | RStringList _ -> pr "String[] ";
5778 | RIntBool _ -> pr "IntBool ";
5779 | RPVList _ -> pr "PV[] ";
5780 | RVGList _ -> pr "VG[] ";
5781 | RLVList _ -> pr "LV[] ";
5782 | RStat _ -> pr "Stat ";
5783 | RStatVFS _ -> pr "StatVFS ";
5784 | RHashtable _ -> pr "HashMap<String,String> ";
5787 if native then pr "_%s " name else pr "%s " name;
5789 let needs_comma = ref false in
5798 if !needs_comma then pr ", ";
5799 needs_comma := true;
5816 pr " throws LibGuestFSException";
5817 if semicolon then pr ";"
5819 and generate_java_struct typ cols =
5820 generate_header CStyle LGPLv2;
5823 package com.redhat.et.libguestfs;
5826 * Libguestfs %s structure.
5837 | name, `UUID -> pr " public String %s;\n" name
5839 | name, `Int -> pr " public long %s;\n" name
5840 | name, `OptPercent ->
5841 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
5842 pr " public float %s;\n" name
5847 and generate_java_c () =
5848 generate_header CStyle LGPLv2;
5855 #include \"com_redhat_et_libguestfs_GuestFS.h\"
5856 #include \"guestfs.h\"
5858 /* Note that this function returns. The exception is not thrown
5859 * until after the wrapper function returns.
5862 throw_exception (JNIEnv *env, const char *msg)
5865 cl = (*env)->FindClass (env,
5866 \"com/redhat/et/libguestfs/LibGuestFSException\");
5867 (*env)->ThrowNew (env, cl, msg);
5870 JNIEXPORT jlong JNICALL
5871 Java_com_redhat_et_libguestfs_GuestFS__1create
5872 (JNIEnv *env, jobject obj)
5876 g = guestfs_create ();
5878 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
5881 guestfs_set_error_handler (g, NULL, NULL);
5882 return (jlong) (long) g;
5885 JNIEXPORT void JNICALL
5886 Java_com_redhat_et_libguestfs_GuestFS__1close
5887 (JNIEnv *env, jobject obj, jlong jg)
5889 guestfs_h *g = (guestfs_h *) (long) jg;
5896 fun (name, style, _, _, _, _, _) ->
5898 (match fst style with
5899 | RErr -> pr "void ";
5900 | RInt _ -> pr "jint ";
5901 | RInt64 _ -> pr "jlong ";
5902 | RBool _ -> pr "jboolean ";
5903 | RConstString _ | RString _ -> pr "jstring ";
5904 | RIntBool _ | RStat _ | RStatVFS _ | RHashtable _ ->
5906 | RStringList _ | RPVList _ | RVGList _ | RLVList _ ->
5910 pr "Java_com_redhat_et_libguestfs_GuestFS_";
5911 pr "%s" (replace_str ("_" ^ name) "_" "_1");
5913 pr " (JNIEnv *env, jobject obj, jlong jg";
5920 pr ", jstring j%s" n
5922 pr ", jobjectArray j%s" n
5924 pr ", jboolean j%s" n
5930 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
5931 let error_code, no_ret =
5932 match fst style with
5933 | RErr -> pr " int r;\n"; "-1", ""
5935 | RInt _ -> pr " int r;\n"; "-1", "0"
5936 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
5937 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
5939 pr " jstring jr;\n";
5940 pr " char *r;\n"; "NULL", "NULL"
5942 pr " jobjectArray jr;\n";
5945 pr " jstring jstr;\n";
5946 pr " char **r;\n"; "NULL", "NULL"
5948 pr " jobject jr;\n";
5950 pr " jfieldID fl;\n";
5951 pr " struct guestfs_int_bool *r;\n"; "NULL", "NULL"
5953 pr " jobject jr;\n";
5955 pr " jfieldID fl;\n";
5956 pr " struct guestfs_stat *r;\n"; "NULL", "NULL"
5958 pr " jobject jr;\n";
5960 pr " jfieldID fl;\n";
5961 pr " struct guestfs_statvfs *r;\n"; "NULL", "NULL"
5963 pr " jobjectArray jr;\n";
5965 pr " jfieldID fl;\n";
5966 pr " jobject jfl;\n";
5967 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL", "NULL"
5969 pr " jobjectArray jr;\n";
5971 pr " jfieldID fl;\n";
5972 pr " jobject jfl;\n";
5973 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL", "NULL"
5975 pr " jobjectArray jr;\n";
5977 pr " jfieldID fl;\n";
5978 pr " jobject jfl;\n";
5979 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL", "NULL"
5980 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL" in
5987 pr " const char *%s;\n" n
5989 pr " int %s_len;\n" n;
5990 pr " const char **%s;\n" n
5997 (match fst style with
5998 | RStringList _ | RPVList _ | RVGList _ | RLVList _ -> true
5999 | RErr _ | RBool _ | RInt _ | RInt64 _ | RConstString _
6000 | RString _ | RIntBool _ | RStat _ | RStatVFS _
6001 | RHashtable _ -> false) ||
6002 List.exists (function StringList _ -> true | _ -> false) (snd style) in
6008 (* Get the parameters. *)
6015 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
6017 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
6018 pr " %s = malloc (sizeof (char *) * (%s_len+1));\n" n n;
6019 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6020 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6022 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
6024 pr " %s[%s_len] = NULL;\n" n n;
6027 pr " %s = j%s;\n" n n
6030 (* Make the call. *)
6031 pr " r = guestfs_%s " name;
6032 generate_call_args ~handle:"g" (snd style);
6035 (* Release the parameters. *)
6042 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
6044 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6045 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6047 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
6049 pr " free (%s);\n" n
6054 (* Check for errors. *)
6055 pr " if (r == %s) {\n" error_code;
6056 pr " throw_exception (env, guestfs_last_error (g));\n";
6057 pr " return %s;\n" no_ret;
6061 (match fst style with
6063 | RInt _ -> pr " return (jint) r;\n"
6064 | RBool _ -> pr " return (jboolean) r;\n"
6065 | RInt64 _ -> pr " return (jlong) r;\n"
6066 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
6068 pr " jr = (*env)->NewStringUTF (env, r);\n";
6072 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
6073 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
6074 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
6075 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
6076 pr " for (i = 0; i < r_len; ++i) {\n";
6077 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
6078 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
6079 pr " free (r[i]);\n";
6084 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/IntBool\");\n";
6085 pr " jr = (*env)->AllocObject (env, cl);\n";
6086 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"I\");\n";
6087 pr " (*env)->SetIntField (env, jr, fl, r->i);\n";
6088 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"Z\");\n";
6089 pr " (*env)->SetBooleanField (env, jr, fl, r->b);\n";
6090 pr " guestfs_free_int_bool (r);\n";
6093 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/Stat\");\n";
6094 pr " jr = (*env)->AllocObject (env, cl);\n";
6098 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
6100 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
6105 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/StatVFS\");\n";
6106 pr " jr = (*env)->AllocObject (env, cl);\n";
6110 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
6112 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
6117 generate_java_lvm_return "pv" "PV" pv_cols
6119 generate_java_lvm_return "vg" "VG" vg_cols
6121 generate_java_lvm_return "lv" "LV" lv_cols
6124 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
6125 pr " return NULL;\n"
6132 and generate_java_lvm_return typ jtyp cols =
6133 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
6134 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
6135 pr " for (i = 0; i < r->len; ++i) {\n";
6136 pr " jfl = (*env)->AllocObject (env, cl);\n";
6140 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
6141 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
6144 pr " char s[33];\n";
6145 pr " memcpy (s, r->val[i].%s, 32);\n" name;
6147 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
6148 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
6150 | name, (`Bytes|`Int) ->
6151 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
6152 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
6153 | name, `OptPercent ->
6154 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
6155 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
6157 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
6159 pr " guestfs_free_lvm_%s_list (r);\n" typ;
6162 let output_to filename =
6163 let filename_new = filename ^ ".new" in
6164 chan := open_out filename_new;
6168 Unix.rename filename_new filename;
6169 printf "written %s\n%!" filename;
6177 if not (Sys.file_exists "configure.ac") then (
6179 You are probably running this from the wrong directory.
6180 Run it from the top source directory using the command
6186 let close = output_to "src/guestfs_protocol.x" in
6190 let close = output_to "src/guestfs-structs.h" in
6191 generate_structs_h ();
6194 let close = output_to "src/guestfs-actions.h" in
6195 generate_actions_h ();
6198 let close = output_to "src/guestfs-actions.c" in
6199 generate_client_actions ();
6202 let close = output_to "daemon/actions.h" in
6203 generate_daemon_actions_h ();
6206 let close = output_to "daemon/stubs.c" in
6207 generate_daemon_actions ();
6210 let close = output_to "tests.c" in
6214 let close = output_to "fish/cmds.c" in
6215 generate_fish_cmds ();
6218 let close = output_to "fish/completion.c" in
6219 generate_fish_completion ();
6222 let close = output_to "guestfs-structs.pod" in
6223 generate_structs_pod ();
6226 let close = output_to "guestfs-actions.pod" in
6227 generate_actions_pod ();
6230 let close = output_to "guestfish-actions.pod" in
6231 generate_fish_actions_pod ();
6234 let close = output_to "ocaml/guestfs.mli" in
6235 generate_ocaml_mli ();
6238 let close = output_to "ocaml/guestfs.ml" in
6239 generate_ocaml_ml ();
6242 let close = output_to "ocaml/guestfs_c_actions.c" in
6243 generate_ocaml_c ();
6246 let close = output_to "perl/Guestfs.xs" in
6247 generate_perl_xs ();
6250 let close = output_to "perl/lib/Sys/Guestfs.pm" in
6251 generate_perl_pm ();
6254 let close = output_to "python/guestfs-py.c" in
6255 generate_python_c ();
6258 let close = output_to "python/guestfs.py" in
6259 generate_python_py ();
6262 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
6266 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
6267 generate_java_java ();
6270 let close = output_to "java/com/redhat/et/libguestfs/PV.java" in
6271 generate_java_struct "PV" pv_cols;
6274 let close = output_to "java/com/redhat/et/libguestfs/VG.java" in
6275 generate_java_struct "VG" vg_cols;
6278 let close = output_to "java/com/redhat/et/libguestfs/LV.java" in
6279 generate_java_struct "LV" lv_cols;
6282 let close = output_to "java/com/redhat/et/libguestfs/Stat.java" in
6283 generate_java_struct "Stat" stat_cols;
6286 let close = output_to "java/com/redhat/et/libguestfs/StatVFS.java" in
6287 generate_java_struct "StatVFS" statvfs_cols;
6290 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in