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 = reply_cb called.\n";
2416 pr " int cb_sequence;\n";
2417 pr " struct guestfs_message_header hdr;\n";
2418 pr " struct guestfs_message_error err;\n";
2419 (match fst style with
2422 failwithf "RConstString cannot be returned from a daemon function"
2424 | RBool _ | RString _ | RStringList _
2426 | RPVList _ | RVGList _ | RLVList _
2427 | RStat _ | RStatVFS _
2429 pr " struct %s_ret ret;\n" name
2434 (* Generate the reply callback function. *)
2435 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
2437 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
2438 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
2440 pr " /* This should definitely not happen. */\n";
2441 pr " if (ctx->cb_sequence != 0) {\n";
2442 pr " ctx->cb_sequence = 9999;\n";
2443 pr " error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
2447 pr " ml->main_loop_quit (ml, g);\n";
2449 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
2450 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
2453 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
2454 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
2455 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
2462 (match fst style with
2465 failwithf "RConstString cannot be returned from a daemon function"
2467 | RBool _ | RString _ | RStringList _
2469 | RPVList _ | RVGList _ | RLVList _
2470 | RStat _ | RStatVFS _
2472 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
2473 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
2479 pr " ctx->cb_sequence = 1;\n";
2482 (* Generate the action stub. *)
2483 generate_prototype ~extern:false ~semicolon:false ~newline:true
2484 ~handle:"g" name style;
2487 match fst style with
2488 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
2490 failwithf "RConstString cannot be returned from a daemon function"
2491 | RString _ | RStringList _ | RIntBool _
2492 | RPVList _ | RVGList _ | RLVList _
2493 | RStat _ | RStatVFS _
2499 (match snd style with
2501 | _ -> pr " struct %s_args args;\n" name
2504 pr " struct %s_ctx ctx;\n" shortname;
2505 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
2506 pr " int serial;\n";
2508 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
2509 pr " guestfs_set_busy (g);\n";
2511 pr " memset (&ctx, 0, sizeof ctx);\n";
2514 (* Send the main header and arguments. *)
2515 (match snd style with
2517 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
2518 (String.uppercase shortname)
2523 pr " args.%s = (char *) %s;\n" n n
2525 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
2527 pr " args.%s.%s_val = (char **) %s;\n" n n n;
2528 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
2530 pr " args.%s = %s;\n" n n
2532 pr " args.%s = %s;\n" n n
2533 | FileIn _ | FileOut _ -> ()
2535 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
2536 (String.uppercase shortname);
2537 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
2540 pr " if (serial == -1) {\n";
2541 pr " guestfs_set_ready (g);\n";
2542 pr " return %s;\n" error_code;
2546 (* Send any additional files (FileIn) requested. *)
2547 let need_read_reply_label = ref false in
2554 pr " r = guestfs__send_file_sync (g, %s);\n" n;
2555 pr " if (r == -1) {\n";
2556 pr " guestfs_set_ready (g);\n";
2557 pr " return %s;\n" error_code;
2559 pr " if (r == -2) /* daemon cancelled */\n";
2560 pr " goto read_reply;\n";
2561 need_read_reply_label := true;
2567 (* Wait for the reply from the remote end. *)
2568 if !need_read_reply_label then pr " read_reply:\n";
2569 pr " guestfs__switch_to_receiving (g);\n";
2570 pr " ctx.cb_sequence = 0;\n";
2571 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
2572 pr " (void) ml->main_loop_run (ml, g);\n";
2573 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
2574 pr " if (ctx.cb_sequence != 1) {\n";
2575 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
2576 pr " guestfs_set_ready (g);\n";
2577 pr " return %s;\n" error_code;
2581 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
2582 (String.uppercase shortname);
2583 pr " guestfs_set_ready (g);\n";
2584 pr " return %s;\n" error_code;
2588 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
2589 pr " error (g, \"%%s\", ctx.err.error_message);\n";
2590 pr " guestfs_set_ready (g);\n";
2591 pr " return %s;\n" error_code;
2595 (* Expecting to receive further files (FileOut)? *)
2599 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
2600 pr " guestfs_set_ready (g);\n";
2601 pr " return %s;\n" error_code;
2607 pr " guestfs_set_ready (g);\n";
2609 (match fst style with
2610 | RErr -> pr " return 0;\n"
2611 | RInt n | RInt64 n | RBool n ->
2612 pr " return ctx.ret.%s;\n" n
2614 failwithf "RConstString cannot be returned from a daemon function"
2616 pr " return ctx.ret.%s; /* caller will free */\n" n
2617 | RStringList n | RHashtable n ->
2618 pr " /* caller will free this, but we need to add a NULL entry */\n";
2619 pr " ctx.ret.%s.%s_val =\n" n n;
2620 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
2621 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
2623 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
2624 pr " return ctx.ret.%s.%s_val;\n" n n
2626 pr " /* caller with free this */\n";
2627 pr " return safe_memdup (g, &ctx.ret, sizeof (ctx.ret));\n"
2628 | RPVList n | RVGList n | RLVList n
2629 | RStat n | RStatVFS n ->
2630 pr " /* caller will free this */\n";
2631 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
2637 (* Generate daemon/actions.h. *)
2638 and generate_daemon_actions_h () =
2639 generate_header CStyle GPLv2;
2641 pr "#include \"../src/guestfs_protocol.h\"\n";
2645 fun (name, style, _, _, _, _, _) ->
2647 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
2651 (* Generate the server-side stubs. *)
2652 and generate_daemon_actions () =
2653 generate_header CStyle GPLv2;
2655 pr "#include <config.h>\n";
2657 pr "#include <stdio.h>\n";
2658 pr "#include <stdlib.h>\n";
2659 pr "#include <string.h>\n";
2660 pr "#include <inttypes.h>\n";
2661 pr "#include <ctype.h>\n";
2662 pr "#include <rpc/types.h>\n";
2663 pr "#include <rpc/xdr.h>\n";
2665 pr "#include \"daemon.h\"\n";
2666 pr "#include \"../src/guestfs_protocol.h\"\n";
2667 pr "#include \"actions.h\"\n";
2671 fun (name, style, _, _, _, _, _) ->
2672 (* Generate server-side stubs. *)
2673 pr "static void %s_stub (XDR *xdr_in)\n" name;
2676 match fst style with
2677 | RErr | RInt _ -> pr " int r;\n"; "-1"
2678 | RInt64 _ -> pr " int64_t r;\n"; "-1"
2679 | RBool _ -> pr " int r;\n"; "-1"
2681 failwithf "RConstString cannot be returned from a daemon function"
2682 | RString _ -> pr " char *r;\n"; "NULL"
2683 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
2684 | RIntBool _ -> pr " guestfs_%s_ret *r;\n" name; "NULL"
2685 | RPVList _ -> pr " guestfs_lvm_int_pv_list *r;\n"; "NULL"
2686 | RVGList _ -> pr " guestfs_lvm_int_vg_list *r;\n"; "NULL"
2687 | RLVList _ -> pr " guestfs_lvm_int_lv_list *r;\n"; "NULL"
2688 | RStat _ -> pr " guestfs_int_stat *r;\n"; "NULL"
2689 | RStatVFS _ -> pr " guestfs_int_statvfs *r;\n"; "NULL" in
2691 (match snd style with
2694 pr " struct guestfs_%s_args args;\n" name;
2698 | OptString n -> pr " const char *%s;\n" n
2699 | StringList n -> pr " char **%s;\n" n
2700 | Bool n -> pr " int %s;\n" n
2701 | Int n -> pr " int %s;\n" n
2702 | FileIn _ | FileOut _ -> ()
2707 (match snd style with
2710 pr " memset (&args, 0, sizeof args);\n";
2712 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
2713 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
2718 | String n -> pr " %s = args.%s;\n" n n
2719 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
2721 pr " args.%s.%s_val = realloc (args.%s.%s_val, sizeof (char *) * (args.%s.%s_len+1));\n" n n n n n n;
2722 pr " args.%s.%s_val[args.%s.%s_len] = NULL;\n" n n n n;
2723 pr " %s = args.%s.%s_val;\n" n n n
2724 | Bool n -> pr " %s = args.%s;\n" n n
2725 | Int n -> pr " %s = args.%s;\n" n n
2726 | FileIn _ | FileOut _ -> ()
2731 (* Don't want to call the impl with any FileIn or FileOut
2732 * parameters, since these go "outside" the RPC protocol.
2735 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
2737 pr " r = do_%s " name;
2738 generate_call_args argsnofile;
2741 pr " if (r == %s)\n" error_code;
2742 pr " /* do_%s has already called reply_with_error */\n" name;
2746 (* If there are any FileOut parameters, then the impl must
2747 * send its own reply.
2750 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
2752 pr " /* do_%s has already sent a reply */\n" name
2754 match fst style with
2755 | RErr -> pr " reply (NULL, NULL);\n"
2756 | RInt n | RInt64 n | RBool n ->
2757 pr " struct guestfs_%s_ret ret;\n" name;
2758 pr " ret.%s = r;\n" n;
2759 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
2762 failwithf "RConstString cannot be returned from a daemon function"
2764 pr " struct guestfs_%s_ret ret;\n" name;
2765 pr " ret.%s = r;\n" n;
2766 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
2769 | RStringList n | RHashtable n ->
2770 pr " struct guestfs_%s_ret ret;\n" name;
2771 pr " ret.%s.%s_len = count_strings (r);\n" n n;
2772 pr " ret.%s.%s_val = r;\n" n n;
2773 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
2775 pr " free_strings (r);\n"
2777 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n"
2779 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n" name
2780 | RPVList n | RVGList n | RLVList n
2781 | RStat n | RStatVFS n ->
2782 pr " struct guestfs_%s_ret ret;\n" name;
2783 pr " ret.%s = *r;\n" n;
2784 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
2786 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
2790 (* Free the args. *)
2791 (match snd style with
2796 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
2803 (* Dispatch function. *)
2804 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
2806 pr " switch (proc_nr) {\n";
2809 fun (name, style, _, _, _, _, _) ->
2810 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
2811 pr " %s_stub (xdr_in);\n" name;
2816 pr " reply_with_error (\"dispatch_incoming_message: unknown procedure number %%d\", proc_nr);\n";
2821 (* LVM columns and tokenization functions. *)
2822 (* XXX This generates crap code. We should rethink how we
2828 pr "static const char *lvm_%s_cols = \"%s\";\n"
2829 typ (String.concat "," (List.map fst cols));
2832 pr "static int lvm_tokenize_%s (char *str, struct guestfs_lvm_int_%s *r)\n" typ typ;
2834 pr " char *tok, *p, *next;\n";
2838 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
2841 pr " if (!str) {\n";
2842 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
2845 pr " if (!*str || isspace (*str)) {\n";
2846 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
2851 fun (name, coltype) ->
2852 pr " if (!tok) {\n";
2853 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
2856 pr " p = strchrnul (tok, ',');\n";
2857 pr " if (*p) next = p+1; else next = NULL;\n";
2858 pr " *p = '\\0';\n";
2861 pr " r->%s = strdup (tok);\n" name;
2862 pr " if (r->%s == NULL) {\n" name;
2863 pr " perror (\"strdup\");\n";
2867 pr " for (i = j = 0; i < 32; ++j) {\n";
2868 pr " if (tok[j] == '\\0') {\n";
2869 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
2871 pr " } else if (tok[j] != '-')\n";
2872 pr " r->%s[i++] = tok[j];\n" name;
2875 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
2876 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
2880 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
2881 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
2885 pr " if (tok[0] == '\\0')\n";
2886 pr " r->%s = -1;\n" name;
2887 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
2888 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
2892 pr " tok = next;\n";
2895 pr " if (tok != NULL) {\n";
2896 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
2903 pr "guestfs_lvm_int_%s_list *\n" typ;
2904 pr "parse_command_line_%ss (void)\n" typ;
2906 pr " char *out, *err;\n";
2907 pr " char *p, *pend;\n";
2909 pr " guestfs_lvm_int_%s_list *ret;\n" typ;
2910 pr " void *newp;\n";
2912 pr " ret = malloc (sizeof *ret);\n";
2913 pr " if (!ret) {\n";
2914 pr " reply_with_perror (\"malloc\");\n";
2915 pr " return NULL;\n";
2918 pr " ret->guestfs_lvm_int_%s_list_len = 0;\n" typ;
2919 pr " ret->guestfs_lvm_int_%s_list_val = NULL;\n" typ;
2921 pr " r = command (&out, &err,\n";
2922 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
2923 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
2924 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
2925 pr " if (r == -1) {\n";
2926 pr " reply_with_error (\"%%s\", err);\n";
2927 pr " free (out);\n";
2928 pr " free (err);\n";
2929 pr " free (ret);\n";
2930 pr " return NULL;\n";
2933 pr " free (err);\n";
2935 pr " /* Tokenize each line of the output. */\n";
2938 pr " while (p) {\n";
2939 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
2940 pr " if (pend) {\n";
2941 pr " *pend = '\\0';\n";
2945 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
2948 pr " if (!*p) { /* Empty line? Skip it. */\n";
2953 pr " /* Allocate some space to store this next entry. */\n";
2954 pr " newp = realloc (ret->guestfs_lvm_int_%s_list_val,\n" typ;
2955 pr " sizeof (guestfs_lvm_int_%s) * (i+1));\n" typ;
2956 pr " if (newp == NULL) {\n";
2957 pr " reply_with_perror (\"realloc\");\n";
2958 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
2959 pr " free (ret);\n";
2960 pr " free (out);\n";
2961 pr " return NULL;\n";
2963 pr " ret->guestfs_lvm_int_%s_list_val = newp;\n" typ;
2965 pr " /* Tokenize the next entry. */\n";
2966 pr " r = lvm_tokenize_%s (p, &ret->guestfs_lvm_int_%s_list_val[i]);\n" typ typ;
2967 pr " if (r == -1) {\n";
2968 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
2969 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
2970 pr " free (ret);\n";
2971 pr " free (out);\n";
2972 pr " return NULL;\n";
2979 pr " ret->guestfs_lvm_int_%s_list_len = i;\n" typ;
2981 pr " free (out);\n";
2982 pr " return ret;\n";
2985 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
2987 (* Generate the tests. *)
2988 and generate_tests () =
2989 generate_header CStyle GPLv2;
2996 #include <sys/types.h>
2999 #include \"guestfs.h\"
3001 static guestfs_h *g;
3002 static int suppress_error = 0;
3004 static void print_error (guestfs_h *g, void *data, const char *msg)
3006 if (!suppress_error)
3007 fprintf (stderr, \"%%s\\n\", msg);
3010 static void print_strings (char * const * const argv)
3014 for (argc = 0; argv[argc] != NULL; ++argc)
3015 printf (\"\\t%%s\\n\", argv[argc]);
3019 static void print_table (char * const * const argv)
3023 for (i = 0; argv[i] != NULL; i += 2)
3024 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
3028 static void no_test_warnings (void)
3034 | name, _, _, _, [], _, _ ->
3035 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
3036 | name, _, _, _, tests, _, _ -> ()
3042 (* Generate the actual tests. Note that we generate the tests
3043 * in reverse order, deliberately, so that (in general) the
3044 * newest tests run first. This makes it quicker and easier to
3049 fun (name, _, _, _, tests, _, _) ->
3050 mapi (generate_one_test name) tests
3051 ) (List.rev all_functions) in
3052 let test_names = List.concat test_names in
3053 let nr_tests = List.length test_names in
3056 int main (int argc, char *argv[])
3061 const char *filename;
3063 int nr_tests, test_num = 0;
3065 no_test_warnings ();
3067 g = guestfs_create ();
3069 printf (\"guestfs_create FAILED\\n\");
3073 guestfs_set_error_handler (g, print_error, NULL);
3075 srcdir = getenv (\"srcdir\");
3076 if (!srcdir) srcdir = \".\";
3078 guestfs_set_path (g, \".\");
3080 filename = \"test1.img\";
3081 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3086 if (lseek (fd, %d, SEEK_SET) == -1) {
3092 if (write (fd, &c, 1) == -1) {
3098 if (close (fd) == -1) {
3103 if (guestfs_add_drive (g, filename) == -1) {
3104 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3108 filename = \"test2.img\";
3109 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3114 if (lseek (fd, %d, SEEK_SET) == -1) {
3120 if (write (fd, &c, 1) == -1) {
3126 if (close (fd) == -1) {
3131 if (guestfs_add_drive (g, filename) == -1) {
3132 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3136 filename = \"test3.img\";
3137 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3142 if (lseek (fd, %d, SEEK_SET) == -1) {
3148 if (write (fd, &c, 1) == -1) {
3154 if (close (fd) == -1) {
3159 if (guestfs_add_drive (g, filename) == -1) {
3160 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3164 if (guestfs_launch (g) == -1) {
3165 printf (\"guestfs_launch FAILED\\n\");
3168 if (guestfs_wait_ready (g) == -1) {
3169 printf (\"guestfs_wait_ready FAILED\\n\");
3175 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
3179 pr " test_num++;\n";
3180 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
3181 pr " if (%s () == -1) {\n" test_name;
3182 pr " printf (\"%s FAILED\\n\");\n" test_name;
3188 pr " guestfs_close (g);\n";
3189 pr " unlink (\"test1.img\");\n";
3190 pr " unlink (\"test2.img\");\n";
3191 pr " unlink (\"test3.img\");\n";
3194 pr " if (failed > 0) {\n";
3195 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
3203 and generate_one_test name i (init, test) =
3204 let test_name = sprintf "test_%s_%d" name i in
3206 pr "static int %s (void)\n" test_name;
3212 pr " /* InitEmpty for %s (%d) */\n" name i;
3213 List.iter (generate_test_command_call test_name)
3217 pr " /* InitBasicFS for %s (%d): create ext2 on /dev/sda1 */\n" name i;
3218 List.iter (generate_test_command_call test_name)
3221 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
3222 ["mkfs"; "ext2"; "/dev/sda1"];
3223 ["mount"; "/dev/sda1"; "/"]]
3224 | InitBasicFSonLVM ->
3225 pr " /* InitBasicFSonLVM for %s (%d): create ext2 on /dev/VG/LV */\n"
3227 List.iter (generate_test_command_call test_name)
3230 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
3231 ["pvcreate"; "/dev/sda1"];
3232 ["vgcreate"; "VG"; "/dev/sda1"];
3233 ["lvcreate"; "LV"; "VG"; "8"];
3234 ["mkfs"; "ext2"; "/dev/VG/LV"];
3235 ["mount"; "/dev/VG/LV"; "/"]]
3238 let get_seq_last = function
3240 failwithf "%s: you cannot use [] (empty list) when expecting a command"
3243 let seq = List.rev seq in
3244 List.rev (List.tl seq), List.hd seq
3249 pr " /* TestRun for %s (%d) */\n" name i;
3250 List.iter (generate_test_command_call test_name) seq
3251 | TestOutput (seq, expected) ->
3252 pr " /* TestOutput for %s (%d) */\n" name i;
3253 let seq, last = get_seq_last seq in
3255 pr " if (strcmp (r, \"%s\") != 0) {\n" (c_quote expected);
3256 pr " fprintf (stderr, \"%s: expected \\\"%s\\\" but got \\\"%%s\\\"\\n\", r);\n" test_name (c_quote expected);
3260 List.iter (generate_test_command_call test_name) seq;
3261 generate_test_command_call ~test test_name last
3262 | TestOutputList (seq, expected) ->
3263 pr " /* TestOutputList for %s (%d) */\n" name i;
3264 let seq, last = get_seq_last seq in
3268 pr " if (!r[%d]) {\n" i;
3269 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
3270 pr " print_strings (r);\n";
3273 pr " if (strcmp (r[%d], \"%s\") != 0) {\n" i (c_quote str);
3274 pr " fprintf (stderr, \"%s: expected \\\"%s\\\" but got \\\"%%s\\\"\\n\", r[%d]);\n" test_name (c_quote str) i;
3278 pr " if (r[%d] != NULL) {\n" (List.length expected);
3279 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
3281 pr " print_strings (r);\n";
3285 List.iter (generate_test_command_call test_name) seq;
3286 generate_test_command_call ~test test_name last
3287 | TestOutputInt (seq, expected) ->
3288 pr " /* TestOutputInt for %s (%d) */\n" name i;
3289 let seq, last = get_seq_last seq in
3291 pr " if (r != %d) {\n" expected;
3292 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
3298 List.iter (generate_test_command_call test_name) seq;
3299 generate_test_command_call ~test test_name last
3300 | TestOutputTrue seq ->
3301 pr " /* TestOutputTrue for %s (%d) */\n" name i;
3302 let seq, last = get_seq_last seq in
3305 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
3310 List.iter (generate_test_command_call test_name) seq;
3311 generate_test_command_call ~test test_name last
3312 | TestOutputFalse seq ->
3313 pr " /* TestOutputFalse for %s (%d) */\n" name i;
3314 let seq, last = get_seq_last seq in
3317 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
3322 List.iter (generate_test_command_call test_name) seq;
3323 generate_test_command_call ~test test_name last
3324 | TestOutputLength (seq, expected) ->
3325 pr " /* TestOutputLength for %s (%d) */\n" name i;
3326 let seq, last = get_seq_last seq in
3329 pr " for (j = 0; j < %d; ++j)\n" expected;
3330 pr " if (r[j] == NULL) {\n";
3331 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
3333 pr " print_strings (r);\n";
3336 pr " if (r[j] != NULL) {\n";
3337 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
3339 pr " print_strings (r);\n";
3343 List.iter (generate_test_command_call test_name) seq;
3344 generate_test_command_call ~test test_name last
3345 | TestOutputStruct (seq, checks) ->
3346 pr " /* TestOutputStruct for %s (%d) */\n" name i;
3347 let seq, last = get_seq_last seq in
3351 | CompareWithInt (field, expected) ->
3352 pr " if (r->%s != %d) {\n" field expected;
3353 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
3354 test_name field expected;
3355 pr " (int) r->%s);\n" field;
3358 | CompareWithString (field, expected) ->
3359 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
3360 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
3361 test_name field expected;
3362 pr " r->%s);\n" field;
3365 | CompareFieldsIntEq (field1, field2) ->
3366 pr " if (r->%s != r->%s) {\n" field1 field2;
3367 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
3368 test_name field1 field2;
3369 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
3372 | CompareFieldsStrEq (field1, field2) ->
3373 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
3374 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
3375 test_name field1 field2;
3376 pr " r->%s, r->%s);\n" field1 field2;
3381 List.iter (generate_test_command_call test_name) seq;
3382 generate_test_command_call ~test test_name last
3383 | TestLastFail seq ->
3384 pr " /* TestLastFail for %s (%d) */\n" name i;
3385 let seq, last = get_seq_last seq in
3386 List.iter (generate_test_command_call test_name) seq;
3387 generate_test_command_call test_name ~expect_error:true last
3395 (* Generate the code to run a command, leaving the result in 'r'.
3396 * If you expect to get an error then you should set expect_error:true.
3398 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
3400 | [] -> assert false
3402 (* Look up the command to find out what args/ret it has. *)
3405 let _, style, _, _, _, _, _ =
3406 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
3409 failwithf "%s: in test, command %s was not found" test_name name in
3411 if List.length (snd style) <> List.length args then
3412 failwithf "%s: in test, wrong number of args given to %s"
3423 | FileIn _, _ | FileOut _, _ -> ()
3424 | StringList n, arg ->
3425 pr " char *%s[] = {\n" n;
3426 let strs = string_split " " arg in
3428 fun str -> pr " \"%s\",\n" (c_quote str)
3432 ) (List.combine (snd style) args);
3435 match fst style with
3436 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
3437 | RInt64 _ -> pr " int64_t r;\n"; "-1"
3438 | RConstString _ -> pr " const char *r;\n"; "NULL"
3439 | RString _ -> pr " char *r;\n"; "NULL"
3440 | RStringList _ | RHashtable _ ->
3445 pr " struct guestfs_int_bool *r;\n"; "NULL"
3447 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
3449 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
3451 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
3453 pr " struct guestfs_stat *r;\n"; "NULL"
3455 pr " struct guestfs_statvfs *r;\n"; "NULL" in
3457 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
3458 pr " r = guestfs_%s (g" name;
3460 (* Generate the parameters. *)
3464 | FileIn _, arg | FileOut _, arg ->
3465 pr ", \"%s\"" (c_quote arg)
3466 | OptString _, arg ->
3467 if arg = "NULL" then pr ", NULL" else pr ", \"%s\"" (c_quote arg)
3468 | StringList n, _ ->
3472 try int_of_string arg
3473 with Failure "int_of_string" ->
3474 failwithf "%s: expecting an int, but got '%s'" test_name arg in
3477 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
3478 ) (List.combine (snd style) args);
3481 if not expect_error then
3482 pr " if (r == %s)\n" error_code
3484 pr " if (r != %s)\n" error_code;
3487 (* Insert the test code. *)
3493 (match fst style with
3494 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _ -> ()
3495 | RString _ -> pr " free (r);\n"
3496 | RStringList _ | RHashtable _ ->
3497 pr " for (i = 0; r[i] != NULL; ++i)\n";
3498 pr " free (r[i]);\n";
3501 pr " guestfs_free_int_bool (r);\n"
3503 pr " guestfs_free_lvm_pv_list (r);\n"
3505 pr " guestfs_free_lvm_vg_list (r);\n"
3507 pr " guestfs_free_lvm_lv_list (r);\n"
3508 | RStat _ | RStatVFS _ ->
3515 let str = replace_str str "\r" "\\r" in
3516 let str = replace_str str "\n" "\\n" in
3517 let str = replace_str str "\t" "\\t" in
3520 (* Generate a lot of different functions for guestfish. *)
3521 and generate_fish_cmds () =
3522 generate_header CStyle GPLv2;
3526 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3528 let all_functions_sorted =
3530 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3531 ) all_functions_sorted in
3533 pr "#include <stdio.h>\n";
3534 pr "#include <stdlib.h>\n";
3535 pr "#include <string.h>\n";
3536 pr "#include <inttypes.h>\n";
3538 pr "#include <guestfs.h>\n";
3539 pr "#include \"fish.h\"\n";
3542 (* list_commands function, which implements guestfish -h *)
3543 pr "void list_commands (void)\n";
3545 pr " printf (\" %%-16s %%s\\n\", \"Command\", \"Description\");\n";
3546 pr " list_builtin_commands ();\n";
3548 fun (name, _, _, flags, _, shortdesc, _) ->
3549 let name = replace_char name '_' '-' in
3550 pr " printf (\"%%-20s %%s\\n\", \"%s\", \"%s\");\n"
3552 ) all_functions_sorted;
3553 pr " printf (\" Use -h <cmd> / help <cmd> to show detailed help for a command.\\n\");\n";
3557 (* display_command function, which implements guestfish -h cmd *)
3558 pr "void display_command (const char *cmd)\n";
3561 fun (name, style, _, flags, _, shortdesc, longdesc) ->
3562 let name2 = replace_char name '_' '-' in
3564 try find_map (function FishAlias n -> Some n | _ -> None) flags
3565 with Not_found -> name in
3566 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
3568 match snd style with
3572 name2 (String.concat "> <" (List.map name_of_argt args)) in
3575 if List.mem ProtocolLimitWarning flags then
3576 ("\n\n" ^ protocol_limit_warning)
3579 (* For DangerWillRobinson commands, we should probably have
3580 * guestfish prompt before allowing you to use them (especially
3581 * in interactive mode). XXX
3585 if List.mem DangerWillRobinson flags then
3586 ("\n\n" ^ danger_will_robinson)
3589 let describe_alias =
3590 if name <> alias then
3591 sprintf "\n\nYou can use '%s' as an alias for this command." alias
3595 pr "strcasecmp (cmd, \"%s\") == 0" name;
3596 if name <> name2 then
3597 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
3598 if name <> alias then
3599 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
3601 pr " pod2text (\"%s - %s\", %S);\n"
3603 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
3606 pr " display_builtin_command (cmd);\n";
3610 (* print_{pv,vg,lv}_list functions *)
3614 pr "static void print_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
3621 pr " printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
3623 pr " printf (\"%s: \");\n" name;
3624 pr " for (i = 0; i < 32; ++i)\n";
3625 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
3626 pr " printf (\"\\n\");\n"
3628 pr " printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
3630 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
3631 | name, `OptPercent ->
3632 pr " if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
3633 typ name name typ name;
3634 pr " else printf (\"%s: \\n\");\n" name
3638 pr "static void print_%s_list (struct guestfs_lvm_%s_list *%ss)\n"
3643 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
3644 pr " print_%s (&%ss->val[i]);\n" typ typ;
3647 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
3649 (* print_{stat,statvfs} functions *)
3653 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
3658 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
3662 ) ["stat", stat_cols; "statvfs", statvfs_cols];
3664 (* run_<action> actions *)
3666 fun (name, style, _, flags, _, _, _) ->
3667 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
3669 (match fst style with
3672 | RBool _ -> pr " int r;\n"
3673 | RInt64 _ -> pr " int64_t r;\n"
3674 | RConstString _ -> pr " const char *r;\n"
3675 | RString _ -> pr " char *r;\n"
3676 | RStringList _ | RHashtable _ -> pr " char **r;\n"
3677 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"
3678 | RPVList _ -> pr " struct guestfs_lvm_pv_list *r;\n"
3679 | RVGList _ -> pr " struct guestfs_lvm_vg_list *r;\n"
3680 | RLVList _ -> pr " struct guestfs_lvm_lv_list *r;\n"
3681 | RStat _ -> pr " struct guestfs_stat *r;\n"
3682 | RStatVFS _ -> pr " struct guestfs_statvfs *r;\n"
3689 | FileOut n -> pr " const char *%s;\n" n
3690 | StringList n -> pr " char **%s;\n" n
3691 | Bool n -> pr " int %s;\n" n
3692 | Int n -> pr " int %s;\n" n
3695 (* Check and convert parameters. *)
3696 let argc_expected = List.length (snd style) in
3697 pr " if (argc != %d) {\n" argc_expected;
3698 pr " fprintf (stderr, \"%%s should have %d parameter(s)\\n\", cmd);\n"
3700 pr " fprintf (stderr, \"type 'help %%s' for help on %%s\\n\", cmd, cmd);\n";
3706 | String name -> pr " %s = argv[%d];\n" name i
3708 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
3711 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
3714 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
3716 | StringList name ->
3717 pr " %s = parse_string_list (argv[%d]);\n" name i
3719 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
3721 pr " %s = atoi (argv[%d]);\n" name i
3724 (* Call C API function. *)
3726 try find_map (function FishAction n -> Some n | _ -> None) flags
3727 with Not_found -> sprintf "guestfs_%s" name in
3729 generate_call_args ~handle:"g" (snd style);
3732 (* Check return value for errors and display command results. *)
3733 (match fst style with
3734 | RErr -> pr " return r;\n"
3736 pr " if (r == -1) return -1;\n";
3737 pr " printf (\"%%d\\n\", r);\n";
3740 pr " if (r == -1) return -1;\n";
3741 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
3744 pr " if (r == -1) return -1;\n";
3745 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
3748 pr " if (r == NULL) return -1;\n";
3749 pr " printf (\"%%s\\n\", r);\n";
3752 pr " if (r == NULL) return -1;\n";
3753 pr " printf (\"%%s\\n\", r);\n";
3757 pr " if (r == NULL) return -1;\n";
3758 pr " print_strings (r);\n";
3759 pr " free_strings (r);\n";
3762 pr " if (r == NULL) return -1;\n";
3763 pr " printf (\"%%d, %%s\\n\", r->i,\n";
3764 pr " r->b ? \"true\" : \"false\");\n";
3765 pr " guestfs_free_int_bool (r);\n";
3768 pr " if (r == NULL) return -1;\n";
3769 pr " print_pv_list (r);\n";
3770 pr " guestfs_free_lvm_pv_list (r);\n";
3773 pr " if (r == NULL) return -1;\n";
3774 pr " print_vg_list (r);\n";
3775 pr " guestfs_free_lvm_vg_list (r);\n";
3778 pr " if (r == NULL) return -1;\n";
3779 pr " print_lv_list (r);\n";
3780 pr " guestfs_free_lvm_lv_list (r);\n";
3783 pr " if (r == NULL) return -1;\n";
3784 pr " print_stat (r);\n";
3788 pr " if (r == NULL) return -1;\n";
3789 pr " print_statvfs (r);\n";
3793 pr " if (r == NULL) return -1;\n";
3794 pr " print_table (r);\n";
3795 pr " free_strings (r);\n";
3802 (* run_action function *)
3803 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
3806 fun (name, _, _, flags, _, _, _) ->
3807 let name2 = replace_char name '_' '-' in
3809 try find_map (function FishAlias n -> Some n | _ -> None) flags
3810 with Not_found -> name in
3812 pr "strcasecmp (cmd, \"%s\") == 0" name;
3813 if name <> name2 then
3814 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
3815 if name <> alias then
3816 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
3818 pr " return run_%s (cmd, argc, argv);\n" name;
3822 pr " fprintf (stderr, \"%%s: unknown command\\n\", cmd);\n";
3829 (* Readline completion for guestfish. *)
3830 and generate_fish_completion () =
3831 generate_header CStyle GPLv2;
3835 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3845 #ifdef HAVE_LIBREADLINE
3846 #include <readline/readline.h>
3851 #ifdef HAVE_LIBREADLINE
3853 static const char *commands[] = {
3856 (* Get the commands and sort them, including the aliases. *)
3859 fun (name, _, _, flags, _, _, _) ->
3860 let name2 = replace_char name '_' '-' in
3862 try find_map (function FishAlias n -> Some n | _ -> None) flags
3863 with Not_found -> name in
3865 if name <> alias then [name2; alias] else [name2]
3867 let commands = List.flatten commands in
3868 let commands = List.sort compare commands in
3870 List.iter (pr " \"%s\",\n") commands;
3876 generator (const char *text, int state)
3878 static int index, len;
3883 len = strlen (text);
3886 while ((name = commands[index]) != NULL) {
3888 if (strncasecmp (name, text, len) == 0)
3889 return strdup (name);
3895 #endif /* HAVE_LIBREADLINE */
3897 char **do_completion (const char *text, int start, int end)
3899 char **matches = NULL;
3901 #ifdef HAVE_LIBREADLINE
3903 matches = rl_completion_matches (text, generator);
3910 (* Generate the POD documentation for guestfish. *)
3911 and generate_fish_actions_pod () =
3912 let all_functions_sorted =
3914 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3915 ) all_functions_sorted in
3917 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
3920 fun (name, style, _, flags, _, _, longdesc) ->
3922 Str.global_substitute rex (
3925 try Str.matched_group 1 s
3927 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
3928 "C<" ^ replace_char sub '_' '-' ^ ">"
3930 let name = replace_char name '_' '-' in
3932 try find_map (function FishAlias n -> Some n | _ -> None) flags
3933 with Not_found -> name in
3935 pr "=head2 %s" name;
3936 if name <> alias then
3943 | String n -> pr " %s" n
3944 | OptString n -> pr " %s" n
3945 | StringList n -> pr " '%s ...'" n
3946 | Bool _ -> pr " true|false"
3947 | Int n -> pr " %s" n
3948 | FileIn n | FileOut n -> pr " (%s|-)" n
3952 pr "%s\n\n" longdesc;
3954 if List.exists (function FileIn _ | FileOut _ -> true
3955 | _ -> false) (snd style) then
3956 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
3958 if List.mem ProtocolLimitWarning flags then
3959 pr "%s\n\n" protocol_limit_warning;
3961 if List.mem DangerWillRobinson flags then
3962 pr "%s\n\n" danger_will_robinson
3963 ) all_functions_sorted
3965 (* Generate a C function prototype. *)
3966 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
3967 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
3969 ?handle name style =
3970 if extern then pr "extern ";
3971 if static then pr "static ";
3972 (match fst style with
3974 | RInt _ -> pr "int "
3975 | RInt64 _ -> pr "int64_t "
3976 | RBool _ -> pr "int "
3977 | RConstString _ -> pr "const char *"
3978 | RString _ -> pr "char *"
3979 | RStringList _ | RHashtable _ -> pr "char **"
3981 if not in_daemon then pr "struct guestfs_int_bool *"
3982 else pr "guestfs_%s_ret *" name
3984 if not in_daemon then pr "struct guestfs_lvm_pv_list *"
3985 else pr "guestfs_lvm_int_pv_list *"
3987 if not in_daemon then pr "struct guestfs_lvm_vg_list *"
3988 else pr "guestfs_lvm_int_vg_list *"
3990 if not in_daemon then pr "struct guestfs_lvm_lv_list *"
3991 else pr "guestfs_lvm_int_lv_list *"
3993 if not in_daemon then pr "struct guestfs_stat *"
3994 else pr "guestfs_int_stat *"
3996 if not in_daemon then pr "struct guestfs_statvfs *"
3997 else pr "guestfs_int_statvfs *"
3999 pr "%s%s (" prefix name;
4000 if handle = None && List.length (snd style) = 0 then
4003 let comma = ref false in
4006 | Some handle -> pr "guestfs_h *%s" handle; comma := true
4010 if single_line then pr ", " else pr ",\n\t\t"
4017 | OptString n -> next (); pr "const char *%s" n
4018 | StringList n -> next (); pr "char * const* const %s" n
4019 | Bool n -> next (); pr "int %s" n
4020 | Int n -> next (); pr "int %s" n
4023 if not in_daemon then (next (); pr "const char *%s" n)
4027 if semicolon then pr ";";
4028 if newline then pr "\n"
4030 (* Generate C call arguments, eg "(handle, foo, bar)" *)
4031 and generate_call_args ?handle args =
4033 let comma = ref false in
4036 | Some handle -> pr "%s" handle; comma := true
4040 if !comma then pr ", ";
4042 pr "%s" (name_of_argt arg)
4046 (* Generate the OCaml bindings interface. *)
4047 and generate_ocaml_mli () =
4048 generate_header OCamlStyle LGPLv2;
4051 (** For API documentation you should refer to the C API
4052 in the guestfs(3) manual page. The OCaml API uses almost
4053 exactly the same calls. *)
4056 (** A [guestfs_h] handle. *)
4058 exception Error of string
4059 (** This exception is raised when there is an error. *)
4061 val create : unit -> t
4063 val close : t -> unit
4064 (** Handles are closed by the garbage collector when they become
4065 unreferenced, but callers can also call this in order to
4066 provide predictable cleanup. *)
4069 generate_ocaml_lvm_structure_decls ();
4071 generate_ocaml_stat_structure_decls ();
4075 fun (name, style, _, _, _, shortdesc, _) ->
4076 generate_ocaml_prototype name style;
4077 pr "(** %s *)\n" shortdesc;
4081 (* Generate the OCaml bindings implementation. *)
4082 and generate_ocaml_ml () =
4083 generate_header OCamlStyle LGPLv2;
4087 exception Error of string
4088 external create : unit -> t = \"ocaml_guestfs_create\"
4089 external close : t -> unit = \"ocaml_guestfs_close\"
4092 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
4096 generate_ocaml_lvm_structure_decls ();
4098 generate_ocaml_stat_structure_decls ();
4102 fun (name, style, _, _, _, shortdesc, _) ->
4103 generate_ocaml_prototype ~is_external:true name style;
4106 (* Generate the OCaml bindings C implementation. *)
4107 and generate_ocaml_c () =
4108 generate_header CStyle LGPLv2;
4115 #include <caml/config.h>
4116 #include <caml/alloc.h>
4117 #include <caml/callback.h>
4118 #include <caml/fail.h>
4119 #include <caml/memory.h>
4120 #include <caml/mlvalues.h>
4121 #include <caml/signals.h>
4123 #include <guestfs.h>
4125 #include \"guestfs_c.h\"
4127 /* Copy a hashtable of string pairs into an assoc-list. We return
4128 * the list in reverse order, but hashtables aren't supposed to be
4131 static CAMLprim value
4132 copy_table (char * const * argv)
4135 CAMLlocal5 (rv, pairv, kv, vv, cons);
4139 for (i = 0; argv[i] != NULL; i += 2) {
4140 kv = caml_copy_string (argv[i]);
4141 vv = caml_copy_string (argv[i+1]);
4142 pairv = caml_alloc (2, 0);
4143 Store_field (pairv, 0, kv);
4144 Store_field (pairv, 1, vv);
4145 cons = caml_alloc (2, 0);
4146 Store_field (cons, 1, rv);
4148 Store_field (cons, 0, pairv);
4156 (* LVM struct copy functions. *)
4159 let has_optpercent_col =
4160 List.exists (function (_, `OptPercent) -> true | _ -> false) cols in
4162 pr "static CAMLprim value\n";
4163 pr "copy_lvm_%s (const struct guestfs_lvm_%s *%s)\n" typ typ typ;
4165 pr " CAMLparam0 ();\n";
4166 if has_optpercent_col then
4167 pr " CAMLlocal3 (rv, v, v2);\n"
4169 pr " CAMLlocal2 (rv, v);\n";
4171 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
4176 pr " v = caml_copy_string (%s->%s);\n" typ name
4178 pr " v = caml_alloc_string (32);\n";
4179 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
4182 pr " v = caml_copy_int64 (%s->%s);\n" typ name
4183 | name, `OptPercent ->
4184 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
4185 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
4186 pr " v = caml_alloc (1, 0);\n";
4187 pr " Store_field (v, 0, v2);\n";
4188 pr " } else /* None */\n";
4189 pr " v = Val_int (0);\n";
4191 pr " Store_field (rv, %d, v);\n" i
4193 pr " CAMLreturn (rv);\n";
4197 pr "static CAMLprim value\n";
4198 pr "copy_lvm_%s_list (const struct guestfs_lvm_%s_list *%ss)\n"
4201 pr " CAMLparam0 ();\n";
4202 pr " CAMLlocal2 (rv, v);\n";
4205 pr " if (%ss->len == 0)\n" typ;
4206 pr " CAMLreturn (Atom (0));\n";
4208 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
4209 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
4210 pr " v = copy_lvm_%s (&%ss->val[i]);\n" typ typ;
4211 pr " caml_modify (&Field (rv, i), v);\n";
4213 pr " CAMLreturn (rv);\n";
4217 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
4219 (* Stat copy functions. *)
4222 pr "static CAMLprim value\n";
4223 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
4225 pr " CAMLparam0 ();\n";
4226 pr " CAMLlocal2 (rv, v);\n";
4228 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
4233 pr " v = caml_copy_int64 (%s->%s);\n" typ name
4235 pr " Store_field (rv, %d, v);\n" i
4237 pr " CAMLreturn (rv);\n";
4240 ) ["stat", stat_cols; "statvfs", statvfs_cols];
4244 fun (name, style, _, _, _, _, _) ->
4246 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
4248 pr "CAMLprim value\n";
4249 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
4250 List.iter (pr ", value %s") (List.tl params);
4255 | [p1; p2; p3; p4; p5] ->
4256 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
4257 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
4258 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
4259 pr " CAMLxparam%d (%s);\n"
4260 (List.length rest) (String.concat ", " rest)
4262 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
4264 pr " CAMLlocal1 (rv);\n";
4267 pr " guestfs_h *g = Guestfs_val (gv);\n";
4268 pr " if (g == NULL)\n";
4269 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
4277 pr " const char *%s = String_val (%sv);\n" n n
4279 pr " const char *%s =\n" n;
4280 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
4283 pr " char **%s = ocaml_guestfs_strings_val (%sv);\n" n n
4285 pr " int %s = Bool_val (%sv);\n" n n
4287 pr " int %s = Int_val (%sv);\n" n n
4290 match fst style with
4291 | RErr -> pr " int r;\n"; "-1"
4292 | RInt _ -> pr " int r;\n"; "-1"
4293 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4294 | RBool _ -> pr " int r;\n"; "-1"
4295 | RConstString _ -> pr " const char *r;\n"; "NULL"
4296 | RString _ -> pr " char *r;\n"; "NULL"
4302 pr " struct guestfs_int_bool *r;\n"; "NULL"
4304 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
4306 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
4308 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
4310 pr " struct guestfs_stat *r;\n"; "NULL"
4312 pr " struct guestfs_statvfs *r;\n"; "NULL"
4319 pr " caml_enter_blocking_section ();\n";
4320 pr " r = guestfs_%s " name;
4321 generate_call_args ~handle:"g" (snd style);
4323 pr " caml_leave_blocking_section ();\n";
4328 pr " ocaml_guestfs_free_strings (%s);\n" n;
4329 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
4332 pr " if (r == %s)\n" error_code;
4333 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
4336 (match fst style with
4337 | RErr -> pr " rv = Val_unit;\n"
4338 | RInt _ -> pr " rv = Val_int (r);\n"
4340 pr " rv = caml_copy_int64 (r);\n"
4341 | RBool _ -> pr " rv = Val_bool (r);\n"
4342 | RConstString _ -> pr " rv = caml_copy_string (r);\n"
4344 pr " rv = caml_copy_string (r);\n";
4347 pr " rv = caml_copy_string_array ((const char **) r);\n";
4348 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
4351 pr " rv = caml_alloc (2, 0);\n";
4352 pr " Store_field (rv, 0, Val_int (r->i));\n";
4353 pr " Store_field (rv, 1, Val_bool (r->b));\n";
4354 pr " guestfs_free_int_bool (r);\n";
4356 pr " rv = copy_lvm_pv_list (r);\n";
4357 pr " guestfs_free_lvm_pv_list (r);\n";
4359 pr " rv = copy_lvm_vg_list (r);\n";
4360 pr " guestfs_free_lvm_vg_list (r);\n";
4362 pr " rv = copy_lvm_lv_list (r);\n";
4363 pr " guestfs_free_lvm_lv_list (r);\n";
4365 pr " rv = copy_stat (r);\n";
4368 pr " rv = copy_statvfs (r);\n";
4371 pr " rv = copy_table (r);\n";
4372 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
4376 pr " CAMLreturn (rv);\n";
4380 if List.length params > 5 then (
4381 pr "CAMLprim value\n";
4382 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
4384 pr " return ocaml_guestfs_%s (argv[0]" name;
4385 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
4392 and generate_ocaml_lvm_structure_decls () =
4395 pr "type lvm_%s = {\n" typ;
4398 | name, `String -> pr " %s : string;\n" name
4399 | name, `UUID -> pr " %s : string;\n" name
4400 | name, `Bytes -> pr " %s : int64;\n" name
4401 | name, `Int -> pr " %s : int64;\n" name
4402 | name, `OptPercent -> pr " %s : float option;\n" name
4406 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
4408 and generate_ocaml_stat_structure_decls () =
4411 pr "type %s = {\n" typ;
4414 | name, `Int -> pr " %s : int64;\n" name
4418 ) ["stat", stat_cols; "statvfs", statvfs_cols]
4420 and generate_ocaml_prototype ?(is_external = false) name style =
4421 if is_external then pr "external " else pr "val ";
4422 pr "%s : t -> " name;
4425 | String _ | FileIn _ | FileOut _ -> pr "string -> "
4426 | OptString _ -> pr "string option -> "
4427 | StringList _ -> pr "string array -> "
4428 | Bool _ -> pr "bool -> "
4429 | Int _ -> pr "int -> "
4431 (match fst style with
4432 | RErr -> pr "unit" (* all errors are turned into exceptions *)
4433 | RInt _ -> pr "int"
4434 | RInt64 _ -> pr "int64"
4435 | RBool _ -> pr "bool"
4436 | RConstString _ -> pr "string"
4437 | RString _ -> pr "string"
4438 | RStringList _ -> pr "string array"
4439 | RIntBool _ -> pr "int * bool"
4440 | RPVList _ -> pr "lvm_pv array"
4441 | RVGList _ -> pr "lvm_vg array"
4442 | RLVList _ -> pr "lvm_lv array"
4443 | RStat _ -> pr "stat"
4444 | RStatVFS _ -> pr "statvfs"
4445 | RHashtable _ -> pr "(string * string) list"
4447 if is_external then (
4449 if List.length (snd style) + 1 > 5 then
4450 pr "\"ocaml_guestfs_%s_byte\" " name;
4451 pr "\"ocaml_guestfs_%s\"" name
4455 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
4456 and generate_perl_xs () =
4457 generate_header CStyle LGPLv2;
4460 #include \"EXTERN.h\"
4464 #include <guestfs.h>
4467 #define PRId64 \"lld\"
4471 my_newSVll(long long val) {
4472 #ifdef USE_64_BIT_ALL
4473 return newSViv(val);
4477 len = snprintf(buf, 100, \"%%\" PRId64, val);
4478 return newSVpv(buf, len);
4483 #define PRIu64 \"llu\"
4487 my_newSVull(unsigned long long val) {
4488 #ifdef USE_64_BIT_ALL
4489 return newSVuv(val);
4493 len = snprintf(buf, 100, \"%%\" PRIu64, val);
4494 return newSVpv(buf, len);
4498 /* http://www.perlmonks.org/?node_id=680842 */
4500 XS_unpack_charPtrPtr (SV *arg) {
4505 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV) {
4506 croak (\"array reference expected\");
4509 av = (AV *)SvRV (arg);
4510 ret = (char **)malloc (av_len (av) + 1 + 1);
4512 for (i = 0; i <= av_len (av); i++) {
4513 SV **elem = av_fetch (av, i, 0);
4515 if (!elem || !*elem)
4516 croak (\"missing element in list\");
4518 ret[i] = SvPV_nolen (*elem);
4526 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
4531 RETVAL = guestfs_create ();
4533 croak (\"could not create guestfs handle\");
4534 guestfs_set_error_handler (RETVAL, NULL, NULL);
4547 fun (name, style, _, _, _, _, _) ->
4548 (match fst style with
4549 | RErr -> pr "void\n"
4550 | RInt _ -> pr "SV *\n"
4551 | RInt64 _ -> pr "SV *\n"
4552 | RBool _ -> pr "SV *\n"
4553 | RConstString _ -> pr "SV *\n"
4554 | RString _ -> pr "SV *\n"
4557 | RPVList _ | RVGList _ | RLVList _
4558 | RStat _ | RStatVFS _
4560 pr "void\n" (* all lists returned implictly on the stack *)
4562 (* Call and arguments. *)
4564 generate_call_args ~handle:"g" (snd style);
4566 pr " guestfs_h *g;\n";
4569 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
4570 | OptString n -> pr " char *%s;\n" n
4571 | StringList n -> pr " char **%s;\n" n
4572 | Bool n -> pr " int %s;\n" n
4573 | Int n -> pr " int %s;\n" n
4576 let do_cleanups () =
4579 | String _ | OptString _ | Bool _ | Int _
4580 | FileIn _ | FileOut _ -> ()
4581 | StringList n -> pr " free (%s);\n" n
4586 (match fst style with
4591 pr " r = guestfs_%s " name;
4592 generate_call_args ~handle:"g" (snd style);
4595 pr " if (r == -1)\n";
4596 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4602 pr " %s = guestfs_%s " n name;
4603 generate_call_args ~handle:"g" (snd style);
4606 pr " if (%s == -1)\n" n;
4607 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4608 pr " RETVAL = newSViv (%s);\n" n;
4613 pr " int64_t %s;\n" n;
4615 pr " %s = guestfs_%s " n name;
4616 generate_call_args ~handle:"g" (snd style);
4619 pr " if (%s == -1)\n" n;
4620 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4621 pr " RETVAL = my_newSVll (%s);\n" n;
4626 pr " const char *%s;\n" n;
4628 pr " %s = guestfs_%s " n name;
4629 generate_call_args ~handle:"g" (snd style);
4632 pr " if (%s == NULL)\n" n;
4633 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4634 pr " RETVAL = newSVpv (%s, 0);\n" n;
4639 pr " char *%s;\n" n;
4641 pr " %s = guestfs_%s " n name;
4642 generate_call_args ~handle:"g" (snd style);
4645 pr " if (%s == NULL)\n" n;
4646 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4647 pr " RETVAL = newSVpv (%s, 0);\n" n;
4648 pr " free (%s);\n" n;
4651 | RStringList n | RHashtable n ->
4653 pr " char **%s;\n" n;
4656 pr " %s = guestfs_%s " n name;
4657 generate_call_args ~handle:"g" (snd style);
4660 pr " if (%s == NULL)\n" n;
4661 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4662 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
4663 pr " EXTEND (SP, n);\n";
4664 pr " for (i = 0; i < n; ++i) {\n";
4665 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
4666 pr " free (%s[i]);\n" n;
4668 pr " free (%s);\n" n;
4671 pr " struct guestfs_int_bool *r;\n";
4673 pr " r = guestfs_%s " name;
4674 generate_call_args ~handle:"g" (snd style);
4677 pr " if (r == NULL)\n";
4678 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4679 pr " EXTEND (SP, 2);\n";
4680 pr " PUSHs (sv_2mortal (newSViv (r->i)));\n";
4681 pr " PUSHs (sv_2mortal (newSViv (r->b)));\n";
4682 pr " guestfs_free_int_bool (r);\n";
4684 generate_perl_lvm_code "pv" pv_cols name style n do_cleanups
4686 generate_perl_lvm_code "vg" vg_cols name style n do_cleanups
4688 generate_perl_lvm_code "lv" lv_cols name style n do_cleanups
4690 generate_perl_stat_code "stat" stat_cols name style n do_cleanups
4692 generate_perl_stat_code
4693 "statvfs" statvfs_cols name style n do_cleanups
4699 and generate_perl_lvm_code typ cols name style n do_cleanups =
4701 pr " struct guestfs_lvm_%s_list *%s;\n" typ n;
4705 pr " %s = guestfs_%s " n name;
4706 generate_call_args ~handle:"g" (snd style);
4709 pr " if (%s == NULL)\n" n;
4710 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4711 pr " EXTEND (SP, %s->len);\n" n;
4712 pr " for (i = 0; i < %s->len; ++i) {\n" n;
4713 pr " hv = newHV ();\n";
4717 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
4718 name (String.length name) n name
4720 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
4721 name (String.length name) n name
4723 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
4724 name (String.length name) n name
4726 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
4727 name (String.length name) n name
4728 | name, `OptPercent ->
4729 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
4730 name (String.length name) n name
4732 pr " PUSHs (sv_2mortal ((SV *) hv));\n";
4734 pr " guestfs_free_lvm_%s_list (%s);\n" typ n
4736 and generate_perl_stat_code typ cols name style n do_cleanups =
4738 pr " struct guestfs_%s *%s;\n" typ n;
4740 pr " %s = guestfs_%s " n name;
4741 generate_call_args ~handle:"g" (snd style);
4744 pr " if (%s == NULL)\n" n;
4745 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4746 pr " EXTEND (SP, %d);\n" (List.length cols);
4750 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n" n name
4752 pr " free (%s);\n" n
4754 (* Generate Sys/Guestfs.pm. *)
4755 and generate_perl_pm () =
4756 generate_header HashStyle LGPLv2;
4763 Sys::Guestfs - Perl bindings for libguestfs
4769 my $h = Sys::Guestfs->new ();
4770 $h->add_drive ('guest.img');
4773 $h->mount ('/dev/sda1', '/');
4774 $h->touch ('/hello');
4779 The C<Sys::Guestfs> module provides a Perl XS binding to the
4780 libguestfs API for examining and modifying virtual machine
4783 Amongst the things this is good for: making batch configuration
4784 changes to guests, getting disk used/free statistics (see also:
4785 virt-df), migrating between virtualization systems (see also:
4786 virt-p2v), performing partial backups, performing partial guest
4787 clones, cloning guests and changing registry/UUID/hostname info, and
4790 Libguestfs uses Linux kernel and qemu code, and can access any type of
4791 guest filesystem that Linux and qemu can, including but not limited
4792 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
4793 schemes, qcow, qcow2, vmdk.
4795 Libguestfs provides ways to enumerate guest storage (eg. partitions,
4796 LVs, what filesystem is in each LV, etc.). It can also run commands
4797 in the context of the guest. Also you can access filesystems over FTP.
4801 All errors turn into calls to C<croak> (see L<Carp(3)>).
4809 package Sys::Guestfs;
4815 XSLoader::load ('Sys::Guestfs');
4817 =item $h = Sys::Guestfs->new ();
4819 Create a new guestfs handle.
4825 my $class = ref ($proto) || $proto;
4827 my $self = Sys::Guestfs::_create ();
4828 bless $self, $class;
4834 (* Actions. We only need to print documentation for these as
4835 * they are pulled in from the XS code automatically.
4838 fun (name, style, _, flags, _, _, longdesc) ->
4839 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
4841 generate_perl_prototype name style;
4843 pr "%s\n\n" longdesc;
4844 if List.mem ProtocolLimitWarning flags then
4845 pr "%s\n\n" protocol_limit_warning;
4846 if List.mem DangerWillRobinson flags then
4847 pr "%s\n\n" danger_will_robinson
4848 ) all_functions_sorted;
4860 Copyright (C) 2009 Red Hat Inc.
4864 Please see the file COPYING.LIB for the full license.
4868 L<guestfs(3)>, L<guestfish(1)>.
4873 and generate_perl_prototype name style =
4874 (match fst style with
4880 | RString n -> pr "$%s = " n
4881 | RIntBool (n, m) -> pr "($%s, $%s) = " n m
4885 | RLVList n -> pr "@%s = " n
4888 | RHashtable n -> pr "%%%s = " n
4891 let comma = ref false in
4894 if !comma then pr ", ";
4897 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
4904 (* Generate Python C module. *)
4905 and generate_python_c () =
4906 generate_header CStyle LGPLv2;
4915 #include \"guestfs.h\"
4923 get_handle (PyObject *obj)
4926 assert (obj != Py_None);
4927 return ((Pyguestfs_Object *) obj)->g;
4931 put_handle (guestfs_h *g)
4935 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
4938 /* This list should be freed (but not the strings) after use. */
4939 static const char **
4940 get_string_list (PyObject *obj)
4947 if (!PyList_Check (obj)) {
4948 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
4952 len = PyList_Size (obj);
4953 r = malloc (sizeof (char *) * (len+1));
4955 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
4959 for (i = 0; i < len; ++i)
4960 r[i] = PyString_AsString (PyList_GetItem (obj, i));
4967 put_string_list (char * const * const argv)
4972 for (argc = 0; argv[argc] != NULL; ++argc)
4975 list = PyList_New (argc);
4976 for (i = 0; i < argc; ++i)
4977 PyList_SetItem (list, i, PyString_FromString (argv[i]));
4983 put_table (char * const * const argv)
4985 PyObject *list, *item;
4988 for (argc = 0; argv[argc] != NULL; ++argc)
4991 list = PyList_New (argc >> 1);
4992 for (i = 0; i < argc; i += 2) {
4993 item = PyTuple_New (2);
4994 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
4995 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
4996 PyList_SetItem (list, i >> 1, item);
5003 free_strings (char **argv)
5007 for (argc = 0; argv[argc] != NULL; ++argc)
5013 py_guestfs_create (PyObject *self, PyObject *args)
5017 g = guestfs_create ();
5019 PyErr_SetString (PyExc_RuntimeError,
5020 \"guestfs.create: failed to allocate handle\");
5023 guestfs_set_error_handler (g, NULL, NULL);
5024 return put_handle (g);
5028 py_guestfs_close (PyObject *self, PyObject *args)
5033 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
5035 g = get_handle (py_g);
5039 Py_INCREF (Py_None);
5045 (* LVM structures, turned into Python dictionaries. *)
5048 pr "static PyObject *\n";
5049 pr "put_lvm_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
5051 pr " PyObject *dict;\n";
5053 pr " dict = PyDict_New ();\n";
5057 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5058 pr " PyString_FromString (%s->%s));\n"
5061 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5062 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
5065 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5066 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
5069 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5070 pr " PyLong_FromLongLong (%s->%s));\n"
5072 | name, `OptPercent ->
5073 pr " if (%s->%s >= 0)\n" typ name;
5074 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5075 pr " PyFloat_FromDouble ((double) %s->%s));\n"
5078 pr " Py_INCREF (Py_None);\n";
5079 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
5082 pr " return dict;\n";
5086 pr "static PyObject *\n";
5087 pr "put_lvm_%s_list (struct guestfs_lvm_%s_list *%ss)\n" typ typ typ;
5089 pr " PyObject *list;\n";
5092 pr " list = PyList_New (%ss->len);\n" typ;
5093 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
5094 pr " PyList_SetItem (list, i, put_lvm_%s (&%ss->val[i]));\n" typ typ;
5095 pr " return list;\n";
5098 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
5100 (* Stat structures, turned into Python dictionaries. *)
5103 pr "static PyObject *\n";
5104 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
5106 pr " PyObject *dict;\n";
5108 pr " dict = PyDict_New ();\n";
5112 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5113 pr " PyLong_FromLongLong (%s->%s));\n"
5116 pr " return dict;\n";
5119 ) ["stat", stat_cols; "statvfs", statvfs_cols];
5121 (* Python wrapper functions. *)
5123 fun (name, style, _, _, _, _, _) ->
5124 pr "static PyObject *\n";
5125 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
5128 pr " PyObject *py_g;\n";
5129 pr " guestfs_h *g;\n";
5130 pr " PyObject *py_r;\n";
5133 match fst style with
5134 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5135 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5136 | RConstString _ -> pr " const char *r;\n"; "NULL"
5137 | RString _ -> pr " char *r;\n"; "NULL"
5138 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5139 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
5140 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5141 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5142 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5143 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
5144 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
5148 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
5149 | OptString n -> pr " const char *%s;\n" n
5151 pr " PyObject *py_%s;\n" n;
5152 pr " const char **%s;\n" n
5153 | Bool n -> pr " int %s;\n" n
5154 | Int n -> pr " int %s;\n" n
5159 (* Convert the parameters. *)
5160 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
5163 | String _ | FileIn _ | FileOut _ -> pr "s"
5164 | OptString _ -> pr "z"
5165 | StringList _ -> pr "O"
5166 | Bool _ -> pr "i" (* XXX Python has booleans? *)
5169 pr ":guestfs_%s\",\n" name;
5173 | String n | FileIn n | FileOut n -> pr ", &%s" n
5174 | OptString n -> pr ", &%s" n
5175 | StringList n -> pr ", &py_%s" n
5176 | Bool n -> pr ", &%s" n
5177 | Int n -> pr ", &%s" n
5181 pr " return NULL;\n";
5183 pr " g = get_handle (py_g);\n";
5186 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5188 pr " %s = get_string_list (py_%s);\n" n n;
5189 pr " if (!%s) return NULL;\n" n
5194 pr " r = guestfs_%s " name;
5195 generate_call_args ~handle:"g" (snd style);
5200 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5202 pr " free (%s);\n" n
5205 pr " if (r == %s) {\n" error_code;
5206 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
5207 pr " return NULL;\n";
5211 (match fst style with
5213 pr " Py_INCREF (Py_None);\n";
5214 pr " py_r = Py_None;\n"
5216 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
5217 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
5218 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
5220 pr " py_r = PyString_FromString (r);\n";
5223 pr " py_r = put_string_list (r);\n";
5224 pr " free_strings (r);\n"
5226 pr " py_r = PyTuple_New (2);\n";
5227 pr " PyTuple_SetItem (py_r, 0, PyInt_FromLong ((long) r->i));\n";
5228 pr " PyTuple_SetItem (py_r, 1, PyInt_FromLong ((long) r->b));\n";
5229 pr " guestfs_free_int_bool (r);\n"
5231 pr " py_r = put_lvm_pv_list (r);\n";
5232 pr " guestfs_free_lvm_pv_list (r);\n"
5234 pr " py_r = put_lvm_vg_list (r);\n";
5235 pr " guestfs_free_lvm_vg_list (r);\n"
5237 pr " py_r = put_lvm_lv_list (r);\n";
5238 pr " guestfs_free_lvm_lv_list (r);\n"
5240 pr " py_r = put_stat (r);\n";
5243 pr " py_r = put_statvfs (r);\n";
5246 pr " py_r = put_table (r);\n";
5247 pr " free_strings (r);\n"
5250 pr " return py_r;\n";
5255 (* Table of functions. *)
5256 pr "static PyMethodDef methods[] = {\n";
5257 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
5258 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
5260 fun (name, _, _, _, _, _, _) ->
5261 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
5264 pr " { NULL, NULL, 0, NULL }\n";
5268 (* Init function. *)
5271 initlibguestfsmod (void)
5273 static int initialized = 0;
5275 if (initialized) return;
5276 Py_InitModule ((char *) \"libguestfsmod\", methods);
5281 (* Generate Python module. *)
5282 and generate_python_py () =
5283 generate_header HashStyle LGPLv2;
5286 u\"\"\"Python bindings for libguestfs
5289 g = guestfs.GuestFS ()
5290 g.add_drive (\"guest.img\")
5293 parts = g.list_partitions ()
5295 The guestfs module provides a Python binding to the libguestfs API
5296 for examining and modifying virtual machine disk images.
5298 Amongst the things this is good for: making batch configuration
5299 changes to guests, getting disk used/free statistics (see also:
5300 virt-df), migrating between virtualization systems (see also:
5301 virt-p2v), performing partial backups, performing partial guest
5302 clones, cloning guests and changing registry/UUID/hostname info, and
5305 Libguestfs uses Linux kernel and qemu code, and can access any type of
5306 guest filesystem that Linux and qemu can, including but not limited
5307 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
5308 schemes, qcow, qcow2, vmdk.
5310 Libguestfs provides ways to enumerate guest storage (eg. partitions,
5311 LVs, what filesystem is in each LV, etc.). It can also run commands
5312 in the context of the guest. Also you can access filesystems over FTP.
5314 Errors which happen while using the API are turned into Python
5315 RuntimeError exceptions.
5317 To create a guestfs handle you usually have to perform the following
5320 # Create the handle, call add_drive at least once, and possibly
5321 # several times if the guest has multiple block devices:
5322 g = guestfs.GuestFS ()
5323 g.add_drive (\"guest.img\")
5325 # Launch the qemu subprocess and wait for it to become ready:
5329 # Now you can issue commands, for example:
5334 import libguestfsmod
5337 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
5339 def __init__ (self):
5340 \"\"\"Create a new libguestfs handle.\"\"\"
5341 self._o = libguestfsmod.create ()
5344 libguestfsmod.close (self._o)
5349 fun (name, style, _, flags, _, _, longdesc) ->
5350 let doc = replace_str longdesc "C<guestfs_" "C<g." in
5352 match fst style with
5353 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _
5356 doc ^ "\n\nThis function returns a list of strings."
5358 doc ^ "\n\nThis function returns a tuple (int, bool).\n"
5360 doc ^ "\n\nThis function returns a list of PVs. Each PV is represented as a dictionary."
5362 doc ^ "\n\nThis function returns a list of VGs. Each VG is represented as a dictionary."
5364 doc ^ "\n\nThis function returns a list of LVs. Each LV is represented as a dictionary."
5366 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the stat structure."
5368 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the statvfs structure."
5370 doc ^ "\n\nThis function returns a dictionary." in
5372 if List.mem ProtocolLimitWarning flags then
5373 doc ^ "\n\n" ^ protocol_limit_warning
5376 if List.mem DangerWillRobinson flags then
5377 doc ^ "\n\n" ^ danger_will_robinson
5379 let doc = pod2text ~width:60 name doc in
5380 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
5381 let doc = String.concat "\n " doc in
5384 generate_call_args ~handle:"self" (snd style);
5386 pr " u\"\"\"%s\"\"\"\n" doc;
5387 pr " return libguestfsmod.%s " name;
5388 generate_call_args ~handle:"self._o" (snd style);
5393 (* Useful if you need the longdesc POD text as plain text. Returns a
5396 * This is the slowest thing about autogeneration.
5398 and pod2text ~width name longdesc =
5399 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
5400 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
5402 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
5403 let chan = Unix.open_process_in cmd in
5404 let lines = ref [] in
5406 let line = input_line chan in
5407 if i = 1 then (* discard the first line of output *)
5410 let line = triml line in
5411 lines := line :: !lines;
5414 let lines = try loop 1 with End_of_file -> List.rev !lines in
5415 Unix.unlink filename;
5416 match Unix.close_process_in chan with
5417 | Unix.WEXITED 0 -> lines
5419 failwithf "pod2text: process exited with non-zero status (%d)" i
5420 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
5421 failwithf "pod2text: process signalled or stopped by signal %d" i
5423 (* Generate ruby bindings. *)
5424 and generate_ruby_c () =
5425 generate_header CStyle LGPLv2;
5433 #include \"guestfs.h\"
5435 #include \"extconf.h\"
5437 static VALUE m_guestfs; /* guestfs module */
5438 static VALUE c_guestfs; /* guestfs_h handle */
5439 static VALUE e_Error; /* used for all errors */
5441 static void ruby_guestfs_free (void *p)
5444 guestfs_close ((guestfs_h *) p);
5447 static VALUE ruby_guestfs_create (VALUE m)
5451 g = guestfs_create ();
5453 rb_raise (e_Error, \"failed to create guestfs handle\");
5455 /* Don't print error messages to stderr by default. */
5456 guestfs_set_error_handler (g, NULL, NULL);
5458 /* Wrap it, and make sure the close function is called when the
5461 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
5464 static VALUE ruby_guestfs_close (VALUE gv)
5467 Data_Get_Struct (gv, guestfs_h, g);
5469 ruby_guestfs_free (g);
5470 DATA_PTR (gv) = NULL;
5478 fun (name, style, _, _, _, _, _) ->
5479 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
5480 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
5483 pr " guestfs_h *g;\n";
5484 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
5486 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
5492 | String n | FileIn n | FileOut n ->
5493 pr " const char *%s = StringValueCStr (%sv);\n" n n;
5495 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
5496 pr " \"%s\", \"%s\");\n" n name
5498 pr " const char *%s = StringValueCStr (%sv);\n" n n
5502 pr " int i, len;\n";
5503 pr " len = RARRAY_LEN (%sv);\n" n;
5504 pr " %s = malloc (sizeof (char *) * (len+1));\n" n;
5505 pr " for (i = 0; i < len; ++i) {\n";
5506 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
5507 pr " %s[i] = StringValueCStr (v);\n" n;
5509 pr " %s[len] = NULL;\n" n;
5513 pr " int %s = NUM2INT (%sv);\n" n n
5518 match fst style with
5519 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5520 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5521 | RConstString _ -> pr " const char *r;\n"; "NULL"
5522 | RString _ -> pr " char *r;\n"; "NULL"
5523 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5524 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
5525 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5526 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5527 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5528 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
5529 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
5532 pr " r = guestfs_%s " name;
5533 generate_call_args ~handle:"g" (snd style);
5538 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5540 pr " free (%s);\n" n
5543 pr " if (r == %s)\n" error_code;
5544 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
5547 (match fst style with
5549 pr " return Qnil;\n"
5550 | RInt _ | RBool _ ->
5551 pr " return INT2NUM (r);\n"
5553 pr " return ULL2NUM (r);\n"
5555 pr " return rb_str_new2 (r);\n";
5557 pr " VALUE rv = rb_str_new2 (r);\n";
5561 pr " int i, len = 0;\n";
5562 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
5563 pr " VALUE rv = rb_ary_new2 (len);\n";
5564 pr " for (i = 0; r[i] != NULL; ++i) {\n";
5565 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
5566 pr " free (r[i]);\n";
5571 pr " VALUE rv = rb_ary_new2 (2);\n";
5572 pr " rb_ary_push (rv, INT2NUM (r->i));\n";
5573 pr " rb_ary_push (rv, INT2NUM (r->b));\n";
5574 pr " guestfs_free_int_bool (r);\n";
5577 generate_ruby_lvm_code "pv" pv_cols
5579 generate_ruby_lvm_code "vg" vg_cols
5581 generate_ruby_lvm_code "lv" lv_cols
5583 pr " VALUE rv = rb_hash_new ();\n";
5587 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
5592 pr " VALUE rv = rb_hash_new ();\n";
5596 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
5601 pr " VALUE rv = rb_hash_new ();\n";
5603 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
5604 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
5605 pr " free (r[i]);\n";
5606 pr " free (r[i+1]);\n";
5617 /* Initialize the module. */
5618 void Init__guestfs ()
5620 m_guestfs = rb_define_module (\"Guestfs\");
5621 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
5622 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
5624 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
5625 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
5628 (* Define the rest of the methods. *)
5630 fun (name, style, _, _, _, _, _) ->
5631 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
5632 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
5637 (* Ruby code to return an LVM struct list. *)
5638 and generate_ruby_lvm_code typ cols =
5639 pr " VALUE rv = rb_ary_new2 (r->len);\n";
5641 pr " for (i = 0; i < r->len; ++i) {\n";
5642 pr " VALUE hv = rb_hash_new ();\n";
5646 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
5648 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
5651 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
5652 | name, `OptPercent ->
5653 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
5655 pr " rb_ary_push (rv, hv);\n";
5657 pr " guestfs_free_lvm_%s_list (r);\n" typ;
5660 (* Generate Java bindings GuestFS.java file. *)
5661 and generate_java_java () =
5662 generate_header CStyle LGPLv2;
5665 package com.redhat.et.libguestfs;
5667 import java.util.HashMap;
5668 import com.redhat.et.libguestfs.LibGuestFSException;
5669 import com.redhat.et.libguestfs.PV;
5670 import com.redhat.et.libguestfs.VG;
5671 import com.redhat.et.libguestfs.LV;
5672 import com.redhat.et.libguestfs.Stat;
5673 import com.redhat.et.libguestfs.StatVFS;
5674 import com.redhat.et.libguestfs.IntBool;
5677 * The GuestFS object is a libguestfs handle.
5681 public class GuestFS {
5682 // Load the native code.
5684 System.loadLibrary (\"guestfs_jni\");
5688 * The native guestfs_h pointer.
5693 * Create a libguestfs handle.
5695 * @throws LibGuestFSException
5697 public GuestFS () throws LibGuestFSException
5701 private native long _create () throws LibGuestFSException;
5704 * Close a libguestfs handle.
5706 * You can also leave handles to be collected by the garbage
5707 * collector, but this method ensures that the resources used
5708 * by the handle are freed up immediately. If you call any
5709 * other methods after closing the handle, you will get an
5712 * @throws LibGuestFSException
5714 public void close () throws LibGuestFSException
5720 private native void _close (long g) throws LibGuestFSException;
5722 public void finalize () throws LibGuestFSException
5730 fun (name, style, _, flags, _, shortdesc, longdesc) ->
5731 let doc = replace_str longdesc "C<guestfs_" "C<g." in
5733 if List.mem ProtocolLimitWarning flags then
5734 doc ^ "\n\n" ^ protocol_limit_warning
5737 if List.mem DangerWillRobinson flags then
5738 doc ^ "\n\n" ^ danger_will_robinson
5740 let doc = pod2text ~width:60 name doc in
5741 let doc = String.concat "\n * " doc in
5744 pr " * %s\n" shortdesc;
5747 pr " * @throws LibGuestFSException\n";
5750 generate_java_prototype ~public:true ~semicolon:false name style;
5753 pr " if (g == 0)\n";
5754 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
5757 if fst style <> RErr then pr "return ";
5759 generate_call_args ~handle:"g" (snd style);
5763 generate_java_prototype ~privat:true ~native:true name style;
5770 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
5771 ?(semicolon=true) name style =
5772 if privat then pr "private ";
5773 if public then pr "public ";
5774 if native then pr "native ";
5777 (match fst style with
5778 | RErr -> pr "void ";
5779 | RInt _ -> pr "int ";
5780 | RInt64 _ -> pr "long ";
5781 | RBool _ -> pr "boolean ";
5782 | RConstString _ | RString _ -> pr "String ";
5783 | RStringList _ -> pr "String[] ";
5784 | RIntBool _ -> pr "IntBool ";
5785 | RPVList _ -> pr "PV[] ";
5786 | RVGList _ -> pr "VG[] ";
5787 | RLVList _ -> pr "LV[] ";
5788 | RStat _ -> pr "Stat ";
5789 | RStatVFS _ -> pr "StatVFS ";
5790 | RHashtable _ -> pr "HashMap<String,String> ";
5793 if native then pr "_%s " name else pr "%s " name;
5795 let needs_comma = ref false in
5804 if !needs_comma then pr ", ";
5805 needs_comma := true;
5822 pr " throws LibGuestFSException";
5823 if semicolon then pr ";"
5825 and generate_java_struct typ cols =
5826 generate_header CStyle LGPLv2;
5829 package com.redhat.et.libguestfs;
5832 * Libguestfs %s structure.
5843 | name, `UUID -> pr " public String %s;\n" name
5845 | name, `Int -> pr " public long %s;\n" name
5846 | name, `OptPercent ->
5847 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
5848 pr " public float %s;\n" name
5853 and generate_java_c () =
5854 generate_header CStyle LGPLv2;
5861 #include \"com_redhat_et_libguestfs_GuestFS.h\"
5862 #include \"guestfs.h\"
5864 /* Note that this function returns. The exception is not thrown
5865 * until after the wrapper function returns.
5868 throw_exception (JNIEnv *env, const char *msg)
5871 cl = (*env)->FindClass (env,
5872 \"com/redhat/et/libguestfs/LibGuestFSException\");
5873 (*env)->ThrowNew (env, cl, msg);
5876 JNIEXPORT jlong JNICALL
5877 Java_com_redhat_et_libguestfs_GuestFS__1create
5878 (JNIEnv *env, jobject obj)
5882 g = guestfs_create ();
5884 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
5887 guestfs_set_error_handler (g, NULL, NULL);
5888 return (jlong) (long) g;
5891 JNIEXPORT void JNICALL
5892 Java_com_redhat_et_libguestfs_GuestFS__1close
5893 (JNIEnv *env, jobject obj, jlong jg)
5895 guestfs_h *g = (guestfs_h *) (long) jg;
5902 fun (name, style, _, _, _, _, _) ->
5904 (match fst style with
5905 | RErr -> pr "void ";
5906 | RInt _ -> pr "jint ";
5907 | RInt64 _ -> pr "jlong ";
5908 | RBool _ -> pr "jboolean ";
5909 | RConstString _ | RString _ -> pr "jstring ";
5910 | RIntBool _ | RStat _ | RStatVFS _ | RHashtable _ ->
5912 | RStringList _ | RPVList _ | RVGList _ | RLVList _ ->
5916 pr "Java_com_redhat_et_libguestfs_GuestFS_";
5917 pr "%s" (replace_str ("_" ^ name) "_" "_1");
5919 pr " (JNIEnv *env, jobject obj, jlong jg";
5926 pr ", jstring j%s" n
5928 pr ", jobjectArray j%s" n
5930 pr ", jboolean j%s" n
5936 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
5937 let error_code, no_ret =
5938 match fst style with
5939 | RErr -> pr " int r;\n"; "-1", ""
5941 | RInt _ -> pr " int r;\n"; "-1", "0"
5942 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
5943 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
5945 pr " jstring jr;\n";
5946 pr " char *r;\n"; "NULL", "NULL"
5948 pr " jobjectArray jr;\n";
5951 pr " jstring jstr;\n";
5952 pr " char **r;\n"; "NULL", "NULL"
5954 pr " jobject jr;\n";
5956 pr " jfieldID fl;\n";
5957 pr " struct guestfs_int_bool *r;\n"; "NULL", "NULL"
5959 pr " jobject jr;\n";
5961 pr " jfieldID fl;\n";
5962 pr " struct guestfs_stat *r;\n"; "NULL", "NULL"
5964 pr " jobject jr;\n";
5966 pr " jfieldID fl;\n";
5967 pr " struct guestfs_statvfs *r;\n"; "NULL", "NULL"
5969 pr " jobjectArray jr;\n";
5971 pr " jfieldID fl;\n";
5972 pr " jobject jfl;\n";
5973 pr " struct guestfs_lvm_pv_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_vg_list *r;\n"; "NULL", "NULL"
5981 pr " jobjectArray jr;\n";
5983 pr " jfieldID fl;\n";
5984 pr " jobject jfl;\n";
5985 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL", "NULL"
5986 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL" in
5993 pr " const char *%s;\n" n
5995 pr " int %s_len;\n" n;
5996 pr " const char **%s;\n" n
6003 (match fst style with
6004 | RStringList _ | RPVList _ | RVGList _ | RLVList _ -> true
6005 | RErr _ | RBool _ | RInt _ | RInt64 _ | RConstString _
6006 | RString _ | RIntBool _ | RStat _ | RStatVFS _
6007 | RHashtable _ -> false) ||
6008 List.exists (function StringList _ -> true | _ -> false) (snd style) in
6014 (* Get the parameters. *)
6021 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
6023 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
6024 pr " %s = malloc (sizeof (char *) * (%s_len+1));\n" n n;
6025 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6026 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6028 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
6030 pr " %s[%s_len] = NULL;\n" n n;
6033 pr " %s = j%s;\n" n n
6036 (* Make the call. *)
6037 pr " r = guestfs_%s " name;
6038 generate_call_args ~handle:"g" (snd style);
6041 (* Release the parameters. *)
6048 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
6050 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6051 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6053 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
6055 pr " free (%s);\n" n
6060 (* Check for errors. *)
6061 pr " if (r == %s) {\n" error_code;
6062 pr " throw_exception (env, guestfs_last_error (g));\n";
6063 pr " return %s;\n" no_ret;
6067 (match fst style with
6069 | RInt _ -> pr " return (jint) r;\n"
6070 | RBool _ -> pr " return (jboolean) r;\n"
6071 | RInt64 _ -> pr " return (jlong) r;\n"
6072 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
6074 pr " jr = (*env)->NewStringUTF (env, r);\n";
6078 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
6079 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
6080 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
6081 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
6082 pr " for (i = 0; i < r_len; ++i) {\n";
6083 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
6084 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
6085 pr " free (r[i]);\n";
6090 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/IntBool\");\n";
6091 pr " jr = (*env)->AllocObject (env, cl);\n";
6092 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"I\");\n";
6093 pr " (*env)->SetIntField (env, jr, fl, r->i);\n";
6094 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"Z\");\n";
6095 pr " (*env)->SetBooleanField (env, jr, fl, r->b);\n";
6096 pr " guestfs_free_int_bool (r);\n";
6099 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/Stat\");\n";
6100 pr " jr = (*env)->AllocObject (env, cl);\n";
6104 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
6106 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
6111 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/StatVFS\");\n";
6112 pr " jr = (*env)->AllocObject (env, cl);\n";
6116 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
6118 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
6123 generate_java_lvm_return "pv" "PV" pv_cols
6125 generate_java_lvm_return "vg" "VG" vg_cols
6127 generate_java_lvm_return "lv" "LV" lv_cols
6130 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
6131 pr " return NULL;\n"
6138 and generate_java_lvm_return typ jtyp cols =
6139 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
6140 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
6141 pr " for (i = 0; i < r->len; ++i) {\n";
6142 pr " jfl = (*env)->AllocObject (env, cl);\n";
6146 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
6147 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
6150 pr " char s[33];\n";
6151 pr " memcpy (s, r->val[i].%s, 32);\n" name;
6153 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
6154 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
6156 | name, (`Bytes|`Int) ->
6157 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
6158 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
6159 | name, `OptPercent ->
6160 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
6161 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
6163 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
6165 pr " guestfs_free_lvm_%s_list (r);\n" typ;
6168 let output_to filename =
6169 let filename_new = filename ^ ".new" in
6170 chan := open_out filename_new;
6174 Unix.rename filename_new filename;
6175 printf "written %s\n%!" filename;
6183 if not (Sys.file_exists "configure.ac") then (
6185 You are probably running this from the wrong directory.
6186 Run it from the top source directory using the command
6192 let close = output_to "src/guestfs_protocol.x" in
6196 let close = output_to "src/guestfs-structs.h" in
6197 generate_structs_h ();
6200 let close = output_to "src/guestfs-actions.h" in
6201 generate_actions_h ();
6204 let close = output_to "src/guestfs-actions.c" in
6205 generate_client_actions ();
6208 let close = output_to "daemon/actions.h" in
6209 generate_daemon_actions_h ();
6212 let close = output_to "daemon/stubs.c" in
6213 generate_daemon_actions ();
6216 let close = output_to "tests.c" in
6220 let close = output_to "fish/cmds.c" in
6221 generate_fish_cmds ();
6224 let close = output_to "fish/completion.c" in
6225 generate_fish_completion ();
6228 let close = output_to "guestfs-structs.pod" in
6229 generate_structs_pod ();
6232 let close = output_to "guestfs-actions.pod" in
6233 generate_actions_pod ();
6236 let close = output_to "guestfish-actions.pod" in
6237 generate_fish_actions_pod ();
6240 let close = output_to "ocaml/guestfs.mli" in
6241 generate_ocaml_mli ();
6244 let close = output_to "ocaml/guestfs.ml" in
6245 generate_ocaml_ml ();
6248 let close = output_to "ocaml/guestfs_c_actions.c" in
6249 generate_ocaml_c ();
6252 let close = output_to "perl/Guestfs.xs" in
6253 generate_perl_xs ();
6256 let close = output_to "perl/lib/Sys/Guestfs.pm" in
6257 generate_perl_pm ();
6260 let close = output_to "python/guestfs-py.c" in
6261 generate_python_c ();
6264 let close = output_to "python/guestfs.py" in
6265 generate_python_py ();
6268 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
6272 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
6273 generate_java_java ();
6276 let close = output_to "java/com/redhat/et/libguestfs/PV.java" in
6277 generate_java_struct "PV" pv_cols;
6280 let close = output_to "java/com/redhat/et/libguestfs/VG.java" in
6281 generate_java_struct "VG" vg_cols;
6284 let close = output_to "java/com/redhat/et/libguestfs/LV.java" in
6285 generate_java_struct "LV" lv_cols;
6288 let close = output_to "java/com/redhat/et/libguestfs/Stat.java" in
6289 generate_java_struct "Stat" stat_cols;
6292 let close = output_to "java/com/redhat/et/libguestfs/StatVFS.java" in
6293 generate_java_struct "StatVFS" statvfs_cols;
6296 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in