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_umount_all> followed by
343 C<guestfs_sync> when the handle is closed
344 (also if the program exits without closing handles).
346 This is disabled by default (except in guestfish where it is
347 enabled by default).");
349 ("get_autosync", (RBool "autosync", []), -1, [],
353 Get the autosync flag.");
355 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
359 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
361 Verbose messages are disabled unless the environment variable
362 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
364 ("get_verbose", (RBool "verbose", []), -1, [],
368 This returns the verbose messages flag.");
370 ("is_ready", (RBool "ready", []), -1, [],
372 "is ready to accept commands",
374 This returns true iff this handle is ready to accept commands
375 (in the C<READY> state).
377 For more information on states, see L<guestfs(3)>.");
379 ("is_config", (RBool "config", []), -1, [],
381 "is in configuration state",
383 This returns true iff this handle is being configured
384 (in the C<CONFIG> state).
386 For more information on states, see L<guestfs(3)>.");
388 ("is_launching", (RBool "launching", []), -1, [],
390 "is launching subprocess",
392 This returns true iff this handle is launching the subprocess
393 (in the C<LAUNCHING> state).
395 For more information on states, see L<guestfs(3)>.");
397 ("is_busy", (RBool "busy", []), -1, [],
399 "is busy processing a command",
401 This returns true iff this handle is busy processing a command
402 (in the C<BUSY> state).
404 For more information on states, see L<guestfs(3)>.");
406 ("get_state", (RInt "state", []), -1, [],
408 "get the current state",
410 This returns the current state as an opaque integer. This is
411 only useful for printing debug and internal error messages.
413 For more information on states, see L<guestfs(3)>.");
415 ("set_busy", (RErr, []), -1, [NotInFish],
419 This sets the state to C<BUSY>. This is only used when implementing
420 actions using the low-level API.
422 For more information on states, see L<guestfs(3)>.");
424 ("set_ready", (RErr, []), -1, [NotInFish],
426 "set state to ready",
428 This sets the state to C<READY>. This is only used when implementing
429 actions using the low-level API.
431 For more information on states, see L<guestfs(3)>.");
435 let daemon_functions = [
436 ("mount", (RErr, [String "device"; String "mountpoint"]), 1, [],
437 [InitEmpty, TestOutput (
438 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
439 ["mkfs"; "ext2"; "/dev/sda1"];
440 ["mount"; "/dev/sda1"; "/"];
441 ["write_file"; "/new"; "new file contents"; "0"];
442 ["cat"; "/new"]], "new file contents")],
443 "mount a guest disk at a position in the filesystem",
445 Mount a guest disk at a position in the filesystem. Block devices
446 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
447 the guest. If those block devices contain partitions, they will have
448 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
451 The rules are the same as for L<mount(2)>: A filesystem must
452 first be mounted on C</> before others can be mounted. Other
453 filesystems can only be mounted on directories which already
456 The mounted filesystem is writable, if we have sufficient permissions
457 on the underlying device.
459 The filesystem options C<sync> and C<noatime> are set with this
460 call, in order to improve reliability.");
462 ("sync", (RErr, []), 2, [],
463 [ InitEmpty, TestRun [["sync"]]],
464 "sync disks, writes are flushed through to the disk image",
466 This syncs the disk, so that any writes are flushed through to the
467 underlying disk image.
469 You should always call this if you have modified a disk image, before
470 closing the handle.");
472 ("touch", (RErr, [String "path"]), 3, [],
473 [InitBasicFS, TestOutputTrue (
475 ["exists"; "/new"]])],
476 "update file timestamps or create a new file",
478 Touch acts like the L<touch(1)> command. It can be used to
479 update the timestamps on a file, or, if the file does not exist,
480 to create a new zero-length file.");
482 ("cat", (RString "content", [String "path"]), 4, [ProtocolLimitWarning],
483 [InitBasicFS, TestOutput (
484 [["write_file"; "/new"; "new file contents"; "0"];
485 ["cat"; "/new"]], "new file contents")],
486 "list the contents of a file",
488 Return the contents of the file named C<path>.
490 Note that this function cannot correctly handle binary files
491 (specifically, files containing C<\\0> character which is treated
492 as end of string). For those you need to use the C<guestfs_download>
493 function which has a more complex interface.");
495 ("ll", (RString "listing", [String "directory"]), 5, [],
496 [], (* XXX Tricky to test because it depends on the exact format
497 * of the 'ls -l' command, which changes between F10 and F11.
499 "list the files in a directory (long format)",
501 List the files in C<directory> (relative to the root directory,
502 there is no cwd) in the format of 'ls -la'.
504 This command is mostly useful for interactive sessions. It
505 is I<not> intended that you try to parse the output string.");
507 ("ls", (RStringList "listing", [String "directory"]), 6, [],
508 [InitBasicFS, TestOutputList (
511 ["touch"; "/newest"];
512 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
513 "list the files in a directory",
515 List the files in C<directory> (relative to the root directory,
516 there is no cwd). The '.' and '..' entries are not returned, but
517 hidden files are shown.
519 This command is mostly useful for interactive sessions. Programs
520 should probably use C<guestfs_readdir> instead.");
522 ("list_devices", (RStringList "devices", []), 7, [],
523 [InitEmpty, TestOutputList (
524 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"])],
525 "list the block devices",
527 List all the block devices.
529 The full block device names are returned, eg. C</dev/sda>");
531 ("list_partitions", (RStringList "partitions", []), 8, [],
532 [InitBasicFS, TestOutputList (
533 [["list_partitions"]], ["/dev/sda1"]);
534 InitEmpty, TestOutputList (
535 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
536 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
537 "list the partitions",
539 List all the partitions detected on all block devices.
541 The full partition device names are returned, eg. C</dev/sda1>
543 This does not return logical volumes. For that you will need to
544 call C<guestfs_lvs>.");
546 ("pvs", (RStringList "physvols", []), 9, [],
547 [InitBasicFSonLVM, TestOutputList (
548 [["pvs"]], ["/dev/sda1"]);
549 InitEmpty, TestOutputList (
550 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
551 ["pvcreate"; "/dev/sda1"];
552 ["pvcreate"; "/dev/sda2"];
553 ["pvcreate"; "/dev/sda3"];
554 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
555 "list the LVM physical volumes (PVs)",
557 List all the physical volumes detected. This is the equivalent
558 of the L<pvs(8)> command.
560 This returns a list of just the device names that contain
561 PVs (eg. C</dev/sda2>).
563 See also C<guestfs_pvs_full>.");
565 ("vgs", (RStringList "volgroups", []), 10, [],
566 [InitBasicFSonLVM, TestOutputList (
568 InitEmpty, TestOutputList (
569 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
570 ["pvcreate"; "/dev/sda1"];
571 ["pvcreate"; "/dev/sda2"];
572 ["pvcreate"; "/dev/sda3"];
573 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
574 ["vgcreate"; "VG2"; "/dev/sda3"];
575 ["vgs"]], ["VG1"; "VG2"])],
576 "list the LVM volume groups (VGs)",
578 List all the volumes groups detected. This is the equivalent
579 of the L<vgs(8)> command.
581 This returns a list of just the volume group names that were
582 detected (eg. C<VolGroup00>).
584 See also C<guestfs_vgs_full>.");
586 ("lvs", (RStringList "logvols", []), 11, [],
587 [InitBasicFSonLVM, TestOutputList (
588 [["lvs"]], ["/dev/VG/LV"]);
589 InitEmpty, TestOutputList (
590 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
591 ["pvcreate"; "/dev/sda1"];
592 ["pvcreate"; "/dev/sda2"];
593 ["pvcreate"; "/dev/sda3"];
594 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
595 ["vgcreate"; "VG2"; "/dev/sda3"];
596 ["lvcreate"; "LV1"; "VG1"; "50"];
597 ["lvcreate"; "LV2"; "VG1"; "50"];
598 ["lvcreate"; "LV3"; "VG2"; "50"];
599 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
600 "list the LVM logical volumes (LVs)",
602 List all the logical volumes detected. This is the equivalent
603 of the L<lvs(8)> command.
605 This returns a list of the logical volume device names
606 (eg. C</dev/VolGroup00/LogVol00>).
608 See also C<guestfs_lvs_full>.");
610 ("pvs_full", (RPVList "physvols", []), 12, [],
611 [], (* XXX how to test? *)
612 "list the LVM physical volumes (PVs)",
614 List all the physical volumes detected. This is the equivalent
615 of the L<pvs(8)> command. The \"full\" version includes all fields.");
617 ("vgs_full", (RVGList "volgroups", []), 13, [],
618 [], (* XXX how to test? *)
619 "list the LVM volume groups (VGs)",
621 List all the volumes groups detected. This is the equivalent
622 of the L<vgs(8)> command. The \"full\" version includes all fields.");
624 ("lvs_full", (RLVList "logvols", []), 14, [],
625 [], (* XXX how to test? *)
626 "list the LVM logical volumes (LVs)",
628 List all the logical volumes detected. This is the equivalent
629 of the L<lvs(8)> command. The \"full\" version includes all fields.");
631 ("read_lines", (RStringList "lines", [String "path"]), 15, [],
632 [InitBasicFS, TestOutputList (
633 [["write_file"; "/new"; "line1\r\nline2\nline3"; "0"];
634 ["read_lines"; "/new"]], ["line1"; "line2"; "line3"]);
635 InitBasicFS, TestOutputList (
636 [["write_file"; "/new"; ""; "0"];
637 ["read_lines"; "/new"]], [])],
638 "read file as lines",
640 Return the contents of the file named C<path>.
642 The file contents are returned as a list of lines. Trailing
643 C<LF> and C<CRLF> character sequences are I<not> returned.
645 Note that this function cannot correctly handle binary files
646 (specifically, files containing C<\\0> character which is treated
647 as end of line). For those you need to use the C<guestfs_read_file>
648 function which has a more complex interface.");
650 ("aug_init", (RErr, [String "root"; Int "flags"]), 16, [],
651 [], (* XXX Augeas code needs tests. *)
652 "create a new Augeas handle",
654 Create a new Augeas handle for editing configuration files.
655 If there was any previous Augeas handle associated with this
656 guestfs session, then it is closed.
658 You must call this before using any other C<guestfs_aug_*>
661 C<root> is the filesystem root. C<root> must not be NULL,
664 The flags are the same as the flags defined in
665 E<lt>augeas.hE<gt>, the logical I<or> of the following
670 =item C<AUG_SAVE_BACKUP> = 1
672 Keep the original file with a C<.augsave> extension.
674 =item C<AUG_SAVE_NEWFILE> = 2
676 Save changes into a file with extension C<.augnew>, and
677 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
679 =item C<AUG_TYPE_CHECK> = 4
681 Typecheck lenses (can be expensive).
683 =item C<AUG_NO_STDINC> = 8
685 Do not use standard load path for modules.
687 =item C<AUG_SAVE_NOOP> = 16
689 Make save a no-op, just record what would have been changed.
691 =item C<AUG_NO_LOAD> = 32
693 Do not load the tree in C<guestfs_aug_init>.
697 To close the handle, you can call C<guestfs_aug_close>.
699 To find out more about Augeas, see L<http://augeas.net/>.");
701 ("aug_close", (RErr, []), 26, [],
702 [], (* XXX Augeas code needs tests. *)
703 "close the current Augeas handle",
705 Close the current Augeas handle and free up any resources
706 used by it. After calling this, you have to call
707 C<guestfs_aug_init> again before you can use any other
710 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [],
711 [], (* XXX Augeas code needs tests. *)
712 "define an Augeas variable",
714 Defines an Augeas variable C<name> whose value is the result
715 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
718 On success this returns the number of nodes in C<expr>, or
719 C<0> if C<expr> evaluates to something which is not a nodeset.");
721 ("aug_defnode", (RIntBool ("nrnodes", "created"), [String "name"; String "expr"; String "val"]), 18, [],
722 [], (* XXX Augeas code needs tests. *)
723 "define an Augeas node",
725 Defines a variable C<name> whose value is the result of
728 If C<expr> evaluates to an empty nodeset, a node is created,
729 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
730 C<name> will be the nodeset containing that single node.
732 On success this returns a pair containing the
733 number of nodes in the nodeset, and a boolean flag
734 if a node was created.");
736 ("aug_get", (RString "val", [String "path"]), 19, [],
737 [], (* XXX Augeas code needs tests. *)
738 "look up the value of an Augeas path",
740 Look up the value associated with C<path>. If C<path>
741 matches exactly one node, the C<value> is returned.");
743 ("aug_set", (RErr, [String "path"; String "val"]), 20, [],
744 [], (* XXX Augeas code needs tests. *)
745 "set Augeas path to value",
747 Set the value associated with C<path> to C<value>.");
749 ("aug_insert", (RErr, [String "path"; String "label"; Bool "before"]), 21, [],
750 [], (* XXX Augeas code needs tests. *)
751 "insert a sibling Augeas node",
753 Create a new sibling C<label> for C<path>, inserting it into
754 the tree before or after C<path> (depending on the boolean
757 C<path> must match exactly one existing node in the tree, and
758 C<label> must be a label, ie. not contain C</>, C<*> or end
759 with a bracketed index C<[N]>.");
761 ("aug_rm", (RInt "nrnodes", [String "path"]), 22, [],
762 [], (* XXX Augeas code needs tests. *)
763 "remove an Augeas path",
765 Remove C<path> and all of its children.
767 On success this returns the number of entries which were removed.");
769 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [],
770 [], (* XXX Augeas code needs tests. *)
773 Move the node C<src> to C<dest>. C<src> must match exactly
774 one node. C<dest> is overwritten if it exists.");
776 ("aug_match", (RStringList "matches", [String "path"]), 24, [],
777 [], (* XXX Augeas code needs tests. *)
778 "return Augeas nodes which match path",
780 Returns a list of paths which match the path expression C<path>.
781 The returned paths are sufficiently qualified so that they match
782 exactly one node in the current tree.");
784 ("aug_save", (RErr, []), 25, [],
785 [], (* XXX Augeas code needs tests. *)
786 "write all pending Augeas changes to disk",
788 This writes all pending changes to disk.
790 The flags which were passed to C<guestfs_aug_init> affect exactly
791 how files are saved.");
793 ("aug_load", (RErr, []), 27, [],
794 [], (* XXX Augeas code needs tests. *)
795 "load files into the tree",
797 Load files into the tree.
799 See C<aug_load> in the Augeas documentation for the full gory
802 ("aug_ls", (RStringList "matches", [String "path"]), 28, [],
803 [], (* XXX Augeas code needs tests. *)
804 "list Augeas nodes under a path",
806 This is just a shortcut for listing C<guestfs_aug_match>
807 C<path/*> and sorting the resulting nodes into alphabetical order.");
809 ("rm", (RErr, [String "path"]), 29, [],
810 [InitBasicFS, TestRun
813 InitBasicFS, TestLastFail
815 InitBasicFS, TestLastFail
820 Remove the single file C<path>.");
822 ("rmdir", (RErr, [String "path"]), 30, [],
823 [InitBasicFS, TestRun
826 InitBasicFS, TestLastFail
828 InitBasicFS, TestLastFail
831 "remove a directory",
833 Remove the single directory C<path>.");
835 ("rm_rf", (RErr, [String "path"]), 31, [],
836 [InitBasicFS, TestOutputFalse
838 ["mkdir"; "/new/foo"];
839 ["touch"; "/new/foo/bar"];
841 ["exists"; "/new"]]],
842 "remove a file or directory recursively",
844 Remove the file or directory C<path>, recursively removing the
845 contents if its a directory. This is like the C<rm -rf> shell
848 ("mkdir", (RErr, [String "path"]), 32, [],
849 [InitBasicFS, TestOutputTrue
852 InitBasicFS, TestLastFail
853 [["mkdir"; "/new/foo/bar"]]],
854 "create a directory",
856 Create a directory named C<path>.");
858 ("mkdir_p", (RErr, [String "path"]), 33, [],
859 [InitBasicFS, TestOutputTrue
860 [["mkdir_p"; "/new/foo/bar"];
861 ["is_dir"; "/new/foo/bar"]];
862 InitBasicFS, TestOutputTrue
863 [["mkdir_p"; "/new/foo/bar"];
864 ["is_dir"; "/new/foo"]];
865 InitBasicFS, TestOutputTrue
866 [["mkdir_p"; "/new/foo/bar"];
867 ["is_dir"; "/new"]]],
868 "create a directory and parents",
870 Create a directory named C<path>, creating any parent directories
871 as necessary. This is like the C<mkdir -p> shell command.");
873 ("chmod", (RErr, [Int "mode"; String "path"]), 34, [],
874 [], (* XXX Need stat command to test *)
877 Change the mode (permissions) of C<path> to C<mode>. Only
878 numeric modes are supported.");
880 ("chown", (RErr, [Int "owner"; Int "group"; String "path"]), 35, [],
881 [], (* XXX Need stat command to test *)
882 "change file owner and group",
884 Change the file owner to C<owner> and group to C<group>.
886 Only numeric uid and gid are supported. If you want to use
887 names, you will need to locate and parse the password file
888 yourself (Augeas support makes this relatively easy).");
890 ("exists", (RBool "existsflag", [String "path"]), 36, [],
891 [InitBasicFS, TestOutputTrue (
893 ["exists"; "/new"]]);
894 InitBasicFS, TestOutputTrue (
896 ["exists"; "/new"]])],
897 "test if file or directory exists",
899 This returns C<true> if and only if there is a file, directory
900 (or anything) with the given C<path> name.
902 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
904 ("is_file", (RBool "fileflag", [String "path"]), 37, [],
905 [InitBasicFS, TestOutputTrue (
907 ["is_file"; "/new"]]);
908 InitBasicFS, TestOutputFalse (
910 ["is_file"; "/new"]])],
911 "test if file exists",
913 This returns C<true> if and only if there is a file
914 with the given C<path> name. Note that it returns false for
915 other objects like directories.
917 See also C<guestfs_stat>.");
919 ("is_dir", (RBool "dirflag", [String "path"]), 38, [],
920 [InitBasicFS, TestOutputFalse (
922 ["is_dir"; "/new"]]);
923 InitBasicFS, TestOutputTrue (
925 ["is_dir"; "/new"]])],
926 "test if file exists",
928 This returns C<true> if and only if there is a directory
929 with the given C<path> name. Note that it returns false for
930 other objects like files.
932 See also C<guestfs_stat>.");
934 ("pvcreate", (RErr, [String "device"]), 39, [],
935 [InitEmpty, TestOutputList (
936 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
937 ["pvcreate"; "/dev/sda1"];
938 ["pvcreate"; "/dev/sda2"];
939 ["pvcreate"; "/dev/sda3"];
940 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
941 "create an LVM physical volume",
943 This creates an LVM physical volume on the named C<device>,
944 where C<device> should usually be a partition name such
947 ("vgcreate", (RErr, [String "volgroup"; StringList "physvols"]), 40, [],
948 [InitEmpty, TestOutputList (
949 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
950 ["pvcreate"; "/dev/sda1"];
951 ["pvcreate"; "/dev/sda2"];
952 ["pvcreate"; "/dev/sda3"];
953 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
954 ["vgcreate"; "VG2"; "/dev/sda3"];
955 ["vgs"]], ["VG1"; "VG2"])],
956 "create an LVM volume group",
958 This creates an LVM volume group called C<volgroup>
959 from the non-empty list of physical volumes C<physvols>.");
961 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [],
962 [InitEmpty, TestOutputList (
963 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
964 ["pvcreate"; "/dev/sda1"];
965 ["pvcreate"; "/dev/sda2"];
966 ["pvcreate"; "/dev/sda3"];
967 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
968 ["vgcreate"; "VG2"; "/dev/sda3"];
969 ["lvcreate"; "LV1"; "VG1"; "50"];
970 ["lvcreate"; "LV2"; "VG1"; "50"];
971 ["lvcreate"; "LV3"; "VG2"; "50"];
972 ["lvcreate"; "LV4"; "VG2"; "50"];
973 ["lvcreate"; "LV5"; "VG2"; "50"];
975 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
976 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
977 "create an LVM volume group",
979 This creates an LVM volume group called C<logvol>
980 on the volume group C<volgroup>, with C<size> megabytes.");
982 ("mkfs", (RErr, [String "fstype"; String "device"]), 42, [],
983 [InitEmpty, TestOutput (
984 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
985 ["mkfs"; "ext2"; "/dev/sda1"];
986 ["mount"; "/dev/sda1"; "/"];
987 ["write_file"; "/new"; "new file contents"; "0"];
988 ["cat"; "/new"]], "new file contents")],
991 This creates a filesystem on C<device> (usually a partition
992 of LVM logical volume). The filesystem type is C<fstype>, for
995 ("sfdisk", (RErr, [String "device";
996 Int "cyls"; Int "heads"; Int "sectors";
997 StringList "lines"]), 43, [DangerWillRobinson],
999 "create partitions on a block device",
1001 This is a direct interface to the L<sfdisk(8)> program for creating
1002 partitions on block devices.
1004 C<device> should be a block device, for example C</dev/sda>.
1006 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1007 and sectors on the device, which are passed directly to sfdisk as
1008 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1009 of these, then the corresponding parameter is omitted. Usually for
1010 'large' disks, you can just pass C<0> for these, but for small
1011 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1012 out the right geometry and you will need to tell it.
1014 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1015 information refer to the L<sfdisk(8)> manpage.
1017 To create a single partition occupying the whole disk, you would
1018 pass C<lines> as a single element list, when the single element being
1019 the string C<,> (comma).");
1021 ("write_file", (RErr, [String "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1022 [InitBasicFS, TestOutput (
1023 [["write_file"; "/new"; "new file contents"; "0"];
1024 ["cat"; "/new"]], "new file contents");
1025 InitBasicFS, TestOutput (
1026 [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1027 ["cat"; "/new"]], "\nnew file contents\n");
1028 InitBasicFS, TestOutput (
1029 [["write_file"; "/new"; "\n\n"; "0"];
1030 ["cat"; "/new"]], "\n\n");
1031 InitBasicFS, TestOutput (
1032 [["write_file"; "/new"; ""; "0"];
1033 ["cat"; "/new"]], "");
1034 InitBasicFS, TestOutput (
1035 [["write_file"; "/new"; "\n\n\n"; "0"];
1036 ["cat"; "/new"]], "\n\n\n");
1037 InitBasicFS, TestOutput (
1038 [["write_file"; "/new"; "\n"; "0"];
1039 ["cat"; "/new"]], "\n")],
1042 This call creates a file called C<path>. The contents of the
1043 file is the string C<content> (which can contain any 8 bit data),
1044 with length C<size>.
1046 As a special case, if C<size> is C<0>
1047 then the length is calculated using C<strlen> (so in this case
1048 the content cannot contain embedded ASCII NULs).");
1050 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1051 [InitEmpty, TestOutputList (
1052 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1053 ["mkfs"; "ext2"; "/dev/sda1"];
1054 ["mount"; "/dev/sda1"; "/"];
1055 ["mounts"]], ["/dev/sda1"]);
1056 InitEmpty, TestOutputList (
1057 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1058 ["mkfs"; "ext2"; "/dev/sda1"];
1059 ["mount"; "/dev/sda1"; "/"];
1062 "unmount a filesystem",
1064 This unmounts the given filesystem. The filesystem may be
1065 specified either by its mountpoint (path) or the device which
1066 contains the filesystem.");
1068 ("mounts", (RStringList "devices", []), 46, [],
1069 [InitBasicFS, TestOutputList (
1070 [["mounts"]], ["/dev/sda1"])],
1071 "show mounted filesystems",
1073 This returns the list of currently mounted filesystems. It returns
1074 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1076 Some internal mounts are not shown.");
1078 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1079 [InitBasicFS, TestOutputList (
1082 (* check that umount_all can unmount nested mounts correctly: *)
1083 InitEmpty, TestOutputList (
1084 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1085 ["mkfs"; "ext2"; "/dev/sda1"];
1086 ["mkfs"; "ext2"; "/dev/sda2"];
1087 ["mkfs"; "ext2"; "/dev/sda3"];
1088 ["mount"; "/dev/sda1"; "/"];
1090 ["mount"; "/dev/sda2"; "/mp1"];
1091 ["mkdir"; "/mp1/mp2"];
1092 ["mount"; "/dev/sda3"; "/mp1/mp2"];
1093 ["mkdir"; "/mp1/mp2/mp3"];
1096 "unmount all filesystems",
1098 This unmounts all mounted filesystems.
1100 Some internal mounts are not unmounted by this call.");
1102 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson],
1104 "remove all LVM LVs, VGs and PVs",
1106 This command removes all LVM logical volumes, volume groups
1107 and physical volumes.");
1109 ("file", (RString "description", [String "path"]), 49, [],
1110 [InitBasicFS, TestOutput (
1112 ["file"; "/new"]], "empty");
1113 InitBasicFS, TestOutput (
1114 [["write_file"; "/new"; "some content\n"; "0"];
1115 ["file"; "/new"]], "ASCII text");
1116 InitBasicFS, TestLastFail (
1117 [["file"; "/nofile"]])],
1118 "determine file type",
1120 This call uses the standard L<file(1)> command to determine
1121 the type or contents of the file. This also works on devices,
1122 for example to find out whether a partition contains a filesystem.
1124 The exact command which runs is C<file -bsL path>. Note in
1125 particular that the filename is not prepended to the output
1126 (the C<-b> option).");
1128 ("command", (RString "output", [StringList "arguments"]), 50, [],
1129 [], (* XXX how to test? *)
1130 "run a command from the guest filesystem",
1132 This call runs a command from the guest filesystem. The
1133 filesystem must be mounted, and must contain a compatible
1134 operating system (ie. something Linux, with the same
1135 or compatible processor architecture).
1137 The single parameter is an argv-style list of arguments.
1138 The first element is the name of the program to run.
1139 Subsequent elements are parameters. The list must be
1140 non-empty (ie. must contain a program name).
1142 The C<$PATH> environment variable will contain at least
1143 C</usr/bin> and C</bin>. If you require a program from
1144 another location, you should provide the full path in the
1147 Shared libraries and data files required by the program
1148 must be available on filesystems which are mounted in the
1149 correct places. It is the caller's responsibility to ensure
1150 all filesystems that are needed are mounted at the right
1153 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [],
1154 [], (* XXX how to test? *)
1155 "run a command, returning lines",
1157 This is the same as C<guestfs_command>, but splits the
1158 result into a list of lines.");
1160 ("stat", (RStat "statbuf", [String "path"]), 52, [],
1161 [InitBasicFS, TestOutputStruct (
1163 ["stat"; "/new"]], [CompareWithInt ("size", 0)])],
1164 "get file information",
1166 Returns file information for the given C<path>.
1168 This is the same as the C<stat(2)> system call.");
1170 ("lstat", (RStat "statbuf", [String "path"]), 53, [],
1171 [InitBasicFS, TestOutputStruct (
1173 ["lstat"; "/new"]], [CompareWithInt ("size", 0)])],
1174 "get file information for a symbolic link",
1176 Returns file information for the given C<path>.
1178 This is the same as C<guestfs_stat> except that if C<path>
1179 is a symbolic link, then the link is stat-ed, not the file it
1182 This is the same as the C<lstat(2)> system call.");
1184 ("statvfs", (RStatVFS "statbuf", [String "path"]), 54, [],
1185 [InitBasicFS, TestOutputStruct (
1186 [["statvfs"; "/"]], [CompareWithInt ("bfree", 487702);
1187 CompareWithInt ("blocks", 490020);
1188 CompareWithInt ("bsize", 1024)])],
1189 "get file system statistics",
1191 Returns file system statistics for any mounted file system.
1192 C<path> should be a file or directory in the mounted file system
1193 (typically it is the mount point itself, but it doesn't need to be).
1195 This is the same as the C<statvfs(2)> system call.");
1197 ("tune2fs_l", (RHashtable "superblock", [String "device"]), 55, [],
1199 "get ext2/ext3/ext4 superblock details",
1201 This returns the contents of the ext2, ext3 or ext4 filesystem
1202 superblock on C<device>.
1204 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1205 manpage for more details. The list of fields returned isn't
1206 clearly defined, and depends on both the version of C<tune2fs>
1207 that libguestfs was built against, and the filesystem itself.");
1209 ("blockdev_setro", (RErr, [String "device"]), 56, [],
1210 [InitEmpty, TestOutputTrue (
1211 [["blockdev_setro"; "/dev/sda"];
1212 ["blockdev_getro"; "/dev/sda"]])],
1213 "set block device to read-only",
1215 Sets the block device named C<device> to read-only.
1217 This uses the L<blockdev(8)> command.");
1219 ("blockdev_setrw", (RErr, [String "device"]), 57, [],
1220 [InitEmpty, TestOutputFalse (
1221 [["blockdev_setrw"; "/dev/sda"];
1222 ["blockdev_getro"; "/dev/sda"]])],
1223 "set block device to read-write",
1225 Sets the block device named C<device> to read-write.
1227 This uses the L<blockdev(8)> command.");
1229 ("blockdev_getro", (RBool "ro", [String "device"]), 58, [],
1230 [InitEmpty, TestOutputTrue (
1231 [["blockdev_setro"; "/dev/sda"];
1232 ["blockdev_getro"; "/dev/sda"]])],
1233 "is block device set to read-only",
1235 Returns a boolean indicating if the block device is read-only
1236 (true if read-only, false if not).
1238 This uses the L<blockdev(8)> command.");
1240 ("blockdev_getss", (RInt "sectorsize", [String "device"]), 59, [],
1241 [InitEmpty, TestOutputInt (
1242 [["blockdev_getss"; "/dev/sda"]], 512)],
1243 "get sectorsize of block device",
1245 This returns the size of sectors on a block device.
1246 Usually 512, but can be larger for modern devices.
1248 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1251 This uses the L<blockdev(8)> command.");
1253 ("blockdev_getbsz", (RInt "blocksize", [String "device"]), 60, [],
1254 [InitEmpty, TestOutputInt (
1255 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1256 "get blocksize of block device",
1258 This returns the block size of a device.
1260 (Note this is different from both I<size in blocks> and
1261 I<filesystem block size>).
1263 This uses the L<blockdev(8)> command.");
1265 ("blockdev_setbsz", (RErr, [String "device"; Int "blocksize"]), 61, [],
1267 "set blocksize of block device",
1269 This sets the block size of a device.
1271 (Note this is different from both I<size in blocks> and
1272 I<filesystem block size>).
1274 This uses the L<blockdev(8)> command.");
1276 ("blockdev_getsz", (RInt64 "sizeinsectors", [String "device"]), 62, [],
1277 [InitEmpty, TestOutputInt (
1278 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1279 "get total size of device in 512-byte sectors",
1281 This returns the size of the device in units of 512-byte sectors
1282 (even if the sectorsize isn't 512 bytes ... weird).
1284 See also C<guestfs_blockdev_getss> for the real sector size of
1285 the device, and C<guestfs_blockdev_getsize64> for the more
1286 useful I<size in bytes>.
1288 This uses the L<blockdev(8)> command.");
1290 ("blockdev_getsize64", (RInt64 "sizeinbytes", [String "device"]), 63, [],
1291 [InitEmpty, TestOutputInt (
1292 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1293 "get total size of device in bytes",
1295 This returns the size of the device in bytes.
1297 See also C<guestfs_blockdev_getsz>.
1299 This uses the L<blockdev(8)> command.");
1301 ("blockdev_flushbufs", (RErr, [String "device"]), 64, [],
1303 [["blockdev_flushbufs"; "/dev/sda"]]],
1304 "flush device buffers",
1306 This tells the kernel to flush internal buffers associated
1309 This uses the L<blockdev(8)> command.");
1311 ("blockdev_rereadpt", (RErr, [String "device"]), 65, [],
1313 [["blockdev_rereadpt"; "/dev/sda"]]],
1314 "reread partition table",
1316 Reread the partition table on C<device>.
1318 This uses the L<blockdev(8)> command.");
1320 ("upload", (RErr, [FileIn "filename"; String "remotefilename"]), 66, [],
1321 [InitBasicFS, TestOutput (
1322 (* Pick a file from cwd which isn't likely to change. *)
1323 [["upload"; "COPYING.LIB"; "/COPYING.LIB"];
1324 ["checksum"; "md5"; "/COPYING.LIB"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1325 "upload a file from the local machine",
1327 Upload local file C<filename> to C<remotefilename> on the
1330 C<filename> can also be a named pipe.
1332 See also C<guestfs_download>.");
1334 ("download", (RErr, [String "remotefilename"; FileOut "filename"]), 67, [],
1335 [InitBasicFS, TestOutput (
1336 (* Pick a file from cwd which isn't likely to change. *)
1337 [["upload"; "COPYING.LIB"; "/COPYING.LIB"];
1338 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1339 ["upload"; "testdownload.tmp"; "/upload"];
1340 ["checksum"; "md5"; "/upload"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1341 "download a file to the local machine",
1343 Download file C<remotefilename> and save it as C<filename>
1344 on the local machine.
1346 C<filename> can also be a named pipe.
1348 See also C<guestfs_upload>, C<guestfs_cat>.");
1350 ("checksum", (RString "checksum", [String "csumtype"; String "path"]), 68, [],
1351 [InitBasicFS, TestOutput (
1352 [["write_file"; "/new"; "test\n"; "0"];
1353 ["checksum"; "crc"; "/new"]], "935282863");
1354 InitBasicFS, TestLastFail (
1355 [["checksum"; "crc"; "/new"]]);
1356 InitBasicFS, TestOutput (
1357 [["write_file"; "/new"; "test\n"; "0"];
1358 ["checksum"; "md5"; "/new"]], "d8e8fca2dc0f896fd7cb4cb0031ba249");
1359 InitBasicFS, TestOutput (
1360 [["write_file"; "/new"; "test\n"; "0"];
1361 ["checksum"; "sha1"; "/new"]], "4e1243bd22c66e76c2ba9eddc1f91394e57f9f83");
1362 InitBasicFS, TestOutput (
1363 [["write_file"; "/new"; "test\n"; "0"];
1364 ["checksum"; "sha224"; "/new"]], "52f1bf093f4b7588726035c176c0cdb4376cfea53819f1395ac9e6ec");
1365 InitBasicFS, TestOutput (
1366 [["write_file"; "/new"; "test\n"; "0"];
1367 ["checksum"; "sha256"; "/new"]], "f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2");
1368 InitBasicFS, TestOutput (
1369 [["write_file"; "/new"; "test\n"; "0"];
1370 ["checksum"; "sha384"; "/new"]], "109bb6b5b6d5547c1ce03c7a8bd7d8f80c1cb0957f50c4f7fda04692079917e4f9cad52b878f3d8234e1a170b154b72d");
1371 InitBasicFS, TestOutput (
1372 [["write_file"; "/new"; "test\n"; "0"];
1373 ["checksum"; "sha512"; "/new"]], "0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123")],
1374 "compute MD5, SHAx or CRC checksum of file",
1376 This call computes the MD5, SHAx or CRC checksum of the
1379 The type of checksum to compute is given by the C<csumtype>
1380 parameter which must have one of the following values:
1386 Compute the cyclic redundancy check (CRC) specified by POSIX
1387 for the C<cksum> command.
1391 Compute the MD5 hash (using the C<md5sum> program).
1395 Compute the SHA1 hash (using the C<sha1sum> program).
1399 Compute the SHA224 hash (using the C<sha224sum> program).
1403 Compute the SHA256 hash (using the C<sha256sum> program).
1407 Compute the SHA384 hash (using the C<sha384sum> program).
1411 Compute the SHA512 hash (using the C<sha512sum> program).
1415 The checksum is returned as a printable string.");
1417 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1418 [InitBasicFS, TestOutput (
1419 [["tar_in"; "images/helloworld.tar"; "/"];
1420 ["cat"; "/hello"]], "hello\n")],
1421 "unpack tarfile to directory",
1423 This command uploads and unpacks local file C<tarfile> (an
1424 I<uncompressed> tar file) into C<directory>.
1426 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1428 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1430 "pack directory into tarfile",
1432 This command packs the contents of C<directory> and downloads
1433 it to local file C<tarfile>.
1435 To download a compressed tarball, use C<guestfs_tgz_out>.");
1437 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1438 [InitBasicFS, TestOutput (
1439 [["tgz_in"; "images/helloworld.tar.gz"; "/"];
1440 ["cat"; "/hello"]], "hello\n")],
1441 "unpack compressed tarball to directory",
1443 This command uploads and unpacks local file C<tarball> (a
1444 I<gzip compressed> tar file) into C<directory>.
1446 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1448 ("tgz_out", (RErr, [String "directory"; FileOut "tarball"]), 72, [],
1450 "pack directory into compressed tarball",
1452 This command packs the contents of C<directory> and downloads
1453 it to local file C<tarball>.
1455 To download an uncompressed tarball, use C<guestfs_tar_out>.");
1457 ("mount_ro", (RErr, [String "device"; String "mountpoint"]), 73, [],
1458 [InitBasicFS, TestLastFail (
1460 ["mount_ro"; "/dev/sda1"; "/"];
1461 ["touch"; "/new"]]);
1462 InitBasicFS, TestOutput (
1463 [["write_file"; "/new"; "data"; "0"];
1465 ["mount_ro"; "/dev/sda1"; "/"];
1466 ["cat"; "/new"]], "data")],
1467 "mount a guest disk, read-only",
1469 This is the same as the C<guestfs_mount> command, but it
1470 mounts the filesystem with the read-only (I<-o ro>) flag.");
1472 ("mount_options", (RErr, [String "options"; String "device"; String "mountpoint"]), 74, [],
1474 "mount a guest disk with mount options",
1476 This is the same as the C<guestfs_mount> command, but it
1477 allows you to set the mount options as for the
1478 L<mount(8)> I<-o> flag.");
1480 ("mount_vfs", (RErr, [String "options"; String "vfstype"; String "device"; String "mountpoint"]), 75, [],
1482 "mount a guest disk with mount options and vfstype",
1484 This is the same as the C<guestfs_mount> command, but it
1485 allows you to set both the mount options and the vfstype
1486 as for the L<mount(8)> I<-o> and I<-t> flags.");
1488 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
1490 "debugging and internals",
1492 The C<guestfs_debug> command exposes some internals of
1493 C<guestfsd> (the guestfs daemon) that runs inside the
1496 There is no comprehensive help for this command. You have
1497 to look at the file C<daemon/debug.c> in the libguestfs source
1498 to find out what you can do.");
1500 ("lvremove", (RErr, [String "device"]), 77, [],
1501 [InitEmpty, TestOutputList (
1502 [["pvcreate"; "/dev/sda"];
1503 ["vgcreate"; "VG"; "/dev/sda"];
1504 ["lvcreate"; "LV1"; "VG"; "50"];
1505 ["lvcreate"; "LV2"; "VG"; "50"];
1506 ["lvremove"; "/dev/VG/LV1"];
1507 ["lvs"]], ["/dev/VG/LV2"]);
1508 InitEmpty, TestOutputList (
1509 [["pvcreate"; "/dev/sda"];
1510 ["vgcreate"; "VG"; "/dev/sda"];
1511 ["lvcreate"; "LV1"; "VG"; "50"];
1512 ["lvcreate"; "LV2"; "VG"; "50"];
1513 ["lvremove"; "/dev/VG"];
1515 InitEmpty, TestOutputList (
1516 [["pvcreate"; "/dev/sda"];
1517 ["vgcreate"; "VG"; "/dev/sda"];
1518 ["lvcreate"; "LV1"; "VG"; "50"];
1519 ["lvcreate"; "LV2"; "VG"; "50"];
1520 ["lvremove"; "/dev/VG"];
1522 "remove an LVM logical volume",
1524 Remove an LVM logical volume C<device>, where C<device> is
1525 the path to the LV, such as C</dev/VG/LV>.
1527 You can also remove all LVs in a volume group by specifying
1528 the VG name, C</dev/VG>.");
1530 ("vgremove", (RErr, [String "vgname"]), 78, [],
1531 [InitEmpty, TestOutputList (
1532 [["pvcreate"; "/dev/sda"];
1533 ["vgcreate"; "VG"; "/dev/sda"];
1534 ["lvcreate"; "LV1"; "VG"; "50"];
1535 ["lvcreate"; "LV2"; "VG"; "50"];
1538 InitEmpty, TestOutputList (
1539 [["pvcreate"; "/dev/sda"];
1540 ["vgcreate"; "VG"; "/dev/sda"];
1541 ["lvcreate"; "LV1"; "VG"; "50"];
1542 ["lvcreate"; "LV2"; "VG"; "50"];
1545 "remove an LVM volume group",
1547 Remove an LVM volume group C<vgname>, (for example C<VG>).
1549 This also forcibly removes all logical volumes in the volume
1552 ("pvremove", (RErr, [String "device"]), 79, [],
1553 [InitEmpty, TestOutputList (
1554 [["pvcreate"; "/dev/sda"];
1555 ["vgcreate"; "VG"; "/dev/sda"];
1556 ["lvcreate"; "LV1"; "VG"; "50"];
1557 ["lvcreate"; "LV2"; "VG"; "50"];
1559 ["pvremove"; "/dev/sda"];
1561 InitEmpty, TestOutputList (
1562 [["pvcreate"; "/dev/sda"];
1563 ["vgcreate"; "VG"; "/dev/sda"];
1564 ["lvcreate"; "LV1"; "VG"; "50"];
1565 ["lvcreate"; "LV2"; "VG"; "50"];
1567 ["pvremove"; "/dev/sda"];
1569 InitEmpty, TestOutputList (
1570 [["pvcreate"; "/dev/sda"];
1571 ["vgcreate"; "VG"; "/dev/sda"];
1572 ["lvcreate"; "LV1"; "VG"; "50"];
1573 ["lvcreate"; "LV2"; "VG"; "50"];
1575 ["pvremove"; "/dev/sda"];
1577 "remove an LVM physical volume",
1579 This wipes a physical volume C<device> so that LVM will no longer
1582 The implementation uses the C<pvremove> command which refuses to
1583 wipe physical volumes that contain any volume groups, so you have
1584 to remove those first.");
1586 ("set_e2label", (RErr, [String "device"; String "label"]), 80, [],
1587 [InitBasicFS, TestOutput (
1588 [["set_e2label"; "/dev/sda1"; "testlabel"];
1589 ["get_e2label"; "/dev/sda1"]], "testlabel")],
1590 "set the ext2/3/4 filesystem label",
1592 This sets the ext2/3/4 filesystem label of the filesystem on
1593 C<device> to C<label>. Filesystem labels are limited to
1596 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
1597 to return the existing label on a filesystem.");
1599 ("get_e2label", (RString "label", [String "device"]), 81, [],
1601 "get the ext2/3/4 filesystem label",
1603 This returns the ext2/3/4 filesystem label of the filesystem on
1606 ("set_e2uuid", (RErr, [String "device"; String "uuid"]), 82, [],
1607 [InitBasicFS, TestOutput (
1608 [["set_e2uuid"; "/dev/sda1"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"];
1609 ["get_e2uuid"; "/dev/sda1"]], "a3a61220-882b-4f61-89f4-cf24dcc7297d");
1610 InitBasicFS, TestOutput (
1611 [["set_e2uuid"; "/dev/sda1"; "clear"];
1612 ["get_e2uuid"; "/dev/sda1"]], "");
1613 (* We can't predict what UUIDs will be, so just check the commands run. *)
1614 InitBasicFS, TestRun (
1615 [["set_e2uuid"; "/dev/sda1"; "random"]]);
1616 InitBasicFS, TestRun (
1617 [["set_e2uuid"; "/dev/sda1"; "time"]])],
1618 "set the ext2/3/4 filesystem UUID",
1620 This sets the ext2/3/4 filesystem UUID of the filesystem on
1621 C<device> to C<uuid>. The format of the UUID and alternatives
1622 such as C<clear>, C<random> and C<time> are described in the
1623 L<tune2fs(8)> manpage.
1625 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
1626 to return the existing UUID of a filesystem.");
1628 ("get_e2uuid", (RString "uuid", [String "device"]), 83, [],
1630 "get the ext2/3/4 filesystem UUID",
1632 This returns the ext2/3/4 filesystem UUID of the filesystem on
1635 ("fsck", (RInt "status", [String "fstype"; String "device"]), 84, [],
1636 [InitBasicFS, TestOutputInt (
1637 [["umount"; "/dev/sda1"];
1638 ["fsck"; "ext2"; "/dev/sda1"]], 0);
1639 InitBasicFS, TestOutputInt (
1640 [["umount"; "/dev/sda1"];
1641 ["zero"; "/dev/sda1"];
1642 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
1643 "run the filesystem checker",
1645 This runs the filesystem checker (fsck) on C<device> which
1646 should have filesystem type C<fstype>.
1648 The returned integer is the status. See L<fsck(8)> for the
1649 list of status codes from C<fsck>.
1657 Multiple status codes can be summed together.
1661 A non-zero return code can mean \"success\", for example if
1662 errors have been corrected on the filesystem.
1666 Checking or repairing NTFS volumes is not supported
1671 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
1673 ("zero", (RErr, [String "device"]), 85, [],
1674 [InitBasicFS, TestOutput (
1675 [["umount"; "/dev/sda1"];
1676 ["zero"; "/dev/sda1"];
1677 ["file"; "/dev/sda1"]], "data")],
1678 "write zeroes to the device",
1680 This command writes zeroes over the first few blocks of C<device>.
1682 How many blocks are zeroed isn't specified (but it's I<not> enough
1683 to securely wipe the device). It should be sufficient to remove
1684 any partition tables, filesystem superblocks and so on.");
1686 ("grub_install", (RErr, [String "root"; String "device"]), 86, [],
1687 [InitBasicFS, TestOutputTrue (
1688 [["grub_install"; "/"; "/dev/sda1"];
1689 ["is_dir"; "/boot"]])],
1692 This command installs GRUB (the Grand Unified Bootloader) on
1693 C<device>, with the root directory being C<root>.");
1695 ("cp", (RErr, [String "src"; String "dest"]), 87, [],
1696 [InitBasicFS, TestOutput (
1697 [["write_file"; "/old"; "file content"; "0"];
1698 ["cp"; "/old"; "/new"];
1699 ["cat"; "/new"]], "file content");
1700 InitBasicFS, TestOutputTrue (
1701 [["write_file"; "/old"; "file content"; "0"];
1702 ["cp"; "/old"; "/new"];
1703 ["is_file"; "/old"]]);
1704 InitBasicFS, TestOutput (
1705 [["write_file"; "/old"; "file content"; "0"];
1707 ["cp"; "/old"; "/dir/new"];
1708 ["cat"; "/dir/new"]], "file content")],
1711 This copies a file from C<src> to C<dest> where C<dest> is
1712 either a destination filename or destination directory.");
1714 ("cp_a", (RErr, [String "src"; String "dest"]), 88, [],
1715 [InitBasicFS, TestOutput (
1716 [["mkdir"; "/olddir"];
1717 ["mkdir"; "/newdir"];
1718 ["write_file"; "/olddir/file"; "file content"; "0"];
1719 ["cp_a"; "/olddir"; "/newdir"];
1720 ["cat"; "/newdir/olddir/file"]], "file content")],
1721 "copy a file or directory recursively",
1723 This copies a file or directory from C<src> to C<dest>
1724 recursively using the C<cp -a> command.");
1726 ("mv", (RErr, [String "src"; String "dest"]), 89, [],
1727 [InitBasicFS, TestOutput (
1728 [["write_file"; "/old"; "file content"; "0"];
1729 ["mv"; "/old"; "/new"];
1730 ["cat"; "/new"]], "file content");
1731 InitBasicFS, TestOutputFalse (
1732 [["write_file"; "/old"; "file content"; "0"];
1733 ["mv"; "/old"; "/new"];
1734 ["is_file"; "/old"]])],
1737 This moves a file from C<src> to C<dest> where C<dest> is
1738 either a destination filename or destination directory.");
1740 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
1741 [InitEmpty, TestRun (
1742 [["drop_caches"; "3"]])],
1743 "drop kernel page cache, dentries and inodes",
1745 This instructs the guest kernel to drop its page cache,
1746 and/or dentries and inode caches. The parameter C<whattodrop>
1747 tells the kernel what precisely to drop, see
1748 L<http://linux-mm.org/Drop_Caches>
1750 Setting C<whattodrop> to 3 should drop everything.
1752 This automatically calls L<sync(2)> before the operation,
1753 so that the maximum guest memory is freed.");
1755 ("dmesg", (RString "kmsgs", []), 91, [],
1756 [InitEmpty, TestRun (
1758 "return kernel messages",
1760 This returns the kernel messages (C<dmesg> output) from
1761 the guest kernel. This is sometimes useful for extended
1762 debugging of problems.
1764 Another way to get the same information is to enable
1765 verbose messages with C<guestfs_set_verbose> or by setting
1766 the environment variable C<LIBGUESTFS_DEBUG=1> before
1767 running the program.");
1769 ("ping_daemon", (RErr, []), 92, [],
1770 [InitEmpty, TestRun (
1771 [["ping_daemon"]])],
1772 "ping the guest daemon",
1774 This is a test probe into the guestfs daemon running inside
1775 the qemu subprocess. Calling this function checks that the
1776 daemon responds to the ping message, without affecting the daemon
1777 or attached block device(s) in any other way.");
1781 let all_functions = non_daemon_functions @ daemon_functions
1783 (* In some places we want the functions to be displayed sorted
1784 * alphabetically, so this is useful:
1786 let all_functions_sorted =
1787 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
1788 compare n1 n2) all_functions
1790 (* Column names and types from LVM PVs/VGs/LVs. *)
1799 "pv_attr", `String (* XXX *);
1800 "pv_pe_count", `Int;
1801 "pv_pe_alloc_count", `Int;
1804 "pv_mda_count", `Int;
1805 "pv_mda_free", `Bytes;
1806 (* Not in Fedora 10:
1807 "pv_mda_size", `Bytes;
1814 "vg_attr", `String (* XXX *);
1817 "vg_sysid", `String;
1818 "vg_extent_size", `Bytes;
1819 "vg_extent_count", `Int;
1820 "vg_free_count", `Int;
1828 "vg_mda_count", `Int;
1829 "vg_mda_free", `Bytes;
1830 (* Not in Fedora 10:
1831 "vg_mda_size", `Bytes;
1837 "lv_attr", `String (* XXX *);
1840 "lv_kernel_major", `Int;
1841 "lv_kernel_minor", `Int;
1845 "snap_percent", `OptPercent;
1846 "copy_percent", `OptPercent;
1849 "mirror_log", `String;
1853 (* Column names and types from stat structures.
1854 * NB. Can't use things like 'st_atime' because glibc header files
1855 * define some of these as macros. Ugh.
1872 let statvfs_cols = [
1886 (* Useful functions.
1887 * Note we don't want to use any external OCaml libraries which
1888 * makes this a bit harder than it should be.
1890 let failwithf fs = ksprintf failwith fs
1892 let replace_char s c1 c2 =
1893 let s2 = String.copy s in
1894 let r = ref false in
1895 for i = 0 to String.length s2 - 1 do
1896 if String.unsafe_get s2 i = c1 then (
1897 String.unsafe_set s2 i c2;
1901 if not !r then s else s2
1905 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
1907 let triml ?(test = isspace) str =
1909 let n = ref (String.length str) in
1910 while !n > 0 && test str.[!i]; do
1915 else String.sub str !i !n
1917 let trimr ?(test = isspace) str =
1918 let n = ref (String.length str) in
1919 while !n > 0 && test str.[!n-1]; do
1922 if !n = String.length str then str
1923 else String.sub str 0 !n
1925 let trim ?(test = isspace) str =
1926 trimr ~test (triml ~test str)
1928 let rec find s sub =
1929 let len = String.length s in
1930 let sublen = String.length sub in
1932 if i <= len-sublen then (
1934 if j < sublen then (
1935 if s.[i+j] = sub.[j] then loop2 (j+1)
1941 if r = -1 then loop (i+1) else r
1947 let rec replace_str s s1 s2 =
1948 let len = String.length s in
1949 let sublen = String.length s1 in
1950 let i = find s s1 in
1953 let s' = String.sub s 0 i in
1954 let s'' = String.sub s (i+sublen) (len-i-sublen) in
1955 s' ^ s2 ^ replace_str s'' s1 s2
1958 let rec string_split sep str =
1959 let len = String.length str in
1960 let seplen = String.length sep in
1961 let i = find str sep in
1962 if i = -1 then [str]
1964 let s' = String.sub str 0 i in
1965 let s'' = String.sub str (i+seplen) (len-i-seplen) in
1966 s' :: string_split sep s''
1969 let files_equal n1 n2 =
1970 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
1971 match Sys.command cmd with
1974 | i -> failwithf "%s: failed with error code %d" cmd i
1976 let rec find_map f = function
1977 | [] -> raise Not_found
1981 | None -> find_map f xs
1984 let rec loop i = function
1986 | x :: xs -> f i x; loop (i+1) xs
1991 let rec loop i = function
1993 | x :: xs -> let r = f i x in r :: loop (i+1) xs
1997 let name_of_argt = function
1998 | String n | OptString n | StringList n | Bool n | Int n
1999 | FileIn n | FileOut n -> n
2001 let seq_of_test = function
2002 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
2003 | TestOutputInt (s, _) | TestOutputTrue s | TestOutputFalse s
2004 | TestOutputLength (s, _) | TestOutputStruct (s, _)
2005 | TestLastFail s -> s
2007 (* Check function names etc. for consistency. *)
2008 let check_functions () =
2009 let contains_uppercase str =
2010 let len = String.length str in
2012 if i >= len then false
2015 if c >= 'A' && c <= 'Z' then true
2022 (* Check function names. *)
2024 fun (name, _, _, _, _, _, _) ->
2025 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
2026 failwithf "function name %s does not need 'guestfs' prefix" name;
2027 if contains_uppercase name then
2028 failwithf "function name %s should not contain uppercase chars" name;
2029 if String.contains name '-' then
2030 failwithf "function name %s should not contain '-', use '_' instead."
2034 (* Check function parameter/return names. *)
2036 fun (name, style, _, _, _, _, _) ->
2037 let check_arg_ret_name n =
2038 if contains_uppercase n then
2039 failwithf "%s param/ret %s should not contain uppercase chars"
2041 if String.contains n '-' || String.contains n '_' then
2042 failwithf "%s param/ret %s should not contain '-' or '_'"
2045 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;
2046 if n = "argv" || n = "args" then
2047 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" n
2050 (match fst style with
2052 | RInt n | RInt64 n | RBool n | RConstString n | RString n
2053 | RStringList n | RPVList n | RVGList n | RLVList n
2054 | RStat n | RStatVFS n
2056 check_arg_ret_name n
2058 check_arg_ret_name n;
2059 check_arg_ret_name m
2061 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
2064 (* Check short descriptions. *)
2066 fun (name, _, _, _, _, shortdesc, _) ->
2067 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
2068 failwithf "short description of %s should begin with lowercase." name;
2069 let c = shortdesc.[String.length shortdesc-1] in
2070 if c = '\n' || c = '.' then
2071 failwithf "short description of %s should not end with . or \\n." name
2074 (* Check long dscriptions. *)
2076 fun (name, _, _, _, _, _, longdesc) ->
2077 if longdesc.[String.length longdesc-1] = '\n' then
2078 failwithf "long description of %s should not end with \\n." name
2081 (* Check proc_nrs. *)
2083 fun (name, _, proc_nr, _, _, _, _) ->
2084 if proc_nr <= 0 then
2085 failwithf "daemon function %s should have proc_nr > 0" name
2089 fun (name, _, proc_nr, _, _, _, _) ->
2090 if proc_nr <> -1 then
2091 failwithf "non-daemon function %s should have proc_nr -1" name
2092 ) non_daemon_functions;
2095 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
2098 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
2099 let rec loop = function
2102 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
2104 | (name1,nr1) :: (name2,nr2) :: _ ->
2105 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
2113 (* Ignore functions that have no tests. We generate a
2114 * warning when the user does 'make check' instead.
2116 | name, _, _, _, [], _, _ -> ()
2117 | name, _, _, _, tests, _, _ ->
2121 match seq_of_test test with
2123 failwithf "%s has a test containing an empty sequence" name
2124 | cmds -> List.map List.hd cmds
2126 let funcs = List.flatten funcs in
2128 let tested = List.mem name funcs in
2131 failwithf "function %s has tests but does not test itself" name
2134 (* 'pr' prints to the current output file. *)
2135 let chan = ref stdout
2136 let pr fs = ksprintf (output_string !chan) fs
2138 (* Generate a header block in a number of standard styles. *)
2139 type comment_style = CStyle | HashStyle | OCamlStyle
2140 type license = GPLv2 | LGPLv2
2142 let generate_header comment license =
2143 let c = match comment with
2144 | CStyle -> pr "/* "; " *"
2145 | HashStyle -> pr "# "; "#"
2146 | OCamlStyle -> pr "(* "; " *" in
2147 pr "libguestfs generated file\n";
2148 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
2149 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
2151 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
2155 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
2156 pr "%s it under the terms of the GNU General Public License as published by\n" c;
2157 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
2158 pr "%s (at your option) any later version.\n" c;
2160 pr "%s This program is distributed in the hope that it will be useful,\n" c;
2161 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2162 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
2163 pr "%s GNU General Public License for more details.\n" c;
2165 pr "%s You should have received a copy of the GNU General Public License along\n" c;
2166 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
2167 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
2170 pr "%s This library is free software; you can redistribute it and/or\n" c;
2171 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
2172 pr "%s License as published by the Free Software Foundation; either\n" c;
2173 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
2175 pr "%s This library is distributed in the hope that it will be useful,\n" c;
2176 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2177 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
2178 pr "%s Lesser General Public License for more details.\n" c;
2180 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
2181 pr "%s License along with this library; if not, write to the Free Software\n" c;
2182 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
2185 | CStyle -> pr " */\n"
2187 | OCamlStyle -> pr " *)\n"
2191 (* Start of main code generation functions below this line. *)
2193 (* Generate the pod documentation for the C API. *)
2194 let rec generate_actions_pod () =
2196 fun (shortname, style, _, flags, _, _, longdesc) ->
2197 let name = "guestfs_" ^ shortname in
2198 pr "=head2 %s\n\n" name;
2200 generate_prototype ~extern:false ~handle:"handle" name style;
2202 pr "%s\n\n" longdesc;
2203 (match fst style with
2205 pr "This function returns 0 on success or -1 on error.\n\n"
2207 pr "On error this function returns -1.\n\n"
2209 pr "On error this function returns -1.\n\n"
2211 pr "This function returns a C truth value on success or -1 on error.\n\n"
2213 pr "This function returns a string, or NULL on error.
2214 The string is owned by the guest handle and must I<not> be freed.\n\n"
2216 pr "This function returns a string, or NULL on error.
2217 I<The caller must free the returned string after use>.\n\n"
2219 pr "This function returns a NULL-terminated array of strings
2220 (like L<environ(3)>), or NULL if there was an error.
2221 I<The caller must free the strings and the array after use>.\n\n"
2223 pr "This function returns a C<struct guestfs_int_bool *>,
2224 or NULL if there was an error.
2225 I<The caller must call C<guestfs_free_int_bool> after use>.\n\n"
2227 pr "This function returns a C<struct guestfs_lvm_pv_list *>
2228 (see E<lt>guestfs-structs.hE<gt>),
2229 or NULL if there was an error.
2230 I<The caller must call C<guestfs_free_lvm_pv_list> after use>.\n\n"
2232 pr "This function returns a C<struct guestfs_lvm_vg_list *>
2233 (see E<lt>guestfs-structs.hE<gt>),
2234 or NULL if there was an error.
2235 I<The caller must call C<guestfs_free_lvm_vg_list> after use>.\n\n"
2237 pr "This function returns a C<struct guestfs_lvm_lv_list *>
2238 (see E<lt>guestfs-structs.hE<gt>),
2239 or NULL if there was an error.
2240 I<The caller must call C<guestfs_free_lvm_lv_list> after use>.\n\n"
2242 pr "This function returns a C<struct guestfs_stat *>
2243 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
2244 or NULL if there was an error.
2245 I<The caller must call C<free> after use>.\n\n"
2247 pr "This function returns a C<struct guestfs_statvfs *>
2248 (see L<statvfs(2)> and E<lt>guestfs-structs.hE<gt>),
2249 or NULL if there was an error.
2250 I<The caller must call C<free> after use>.\n\n"
2252 pr "This function returns a NULL-terminated array of
2253 strings, or NULL if there was an error.
2254 The array of strings will always have length C<2n+1>, where
2255 C<n> keys and values alternate, followed by the trailing NULL entry.
2256 I<The caller must free the strings and the array after use>.\n\n"
2258 if List.mem ProtocolLimitWarning flags then
2259 pr "%s\n\n" protocol_limit_warning;
2260 if List.mem DangerWillRobinson flags then
2261 pr "%s\n\n" danger_will_robinson;
2262 ) all_functions_sorted
2264 and generate_structs_pod () =
2265 (* LVM structs documentation. *)
2268 pr "=head2 guestfs_lvm_%s\n" typ;
2270 pr " struct guestfs_lvm_%s {\n" typ;
2273 | name, `String -> pr " char *%s;\n" name
2275 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
2276 pr " char %s[32];\n" name
2277 | name, `Bytes -> pr " uint64_t %s;\n" name
2278 | name, `Int -> pr " int64_t %s;\n" name
2279 | name, `OptPercent ->
2280 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
2281 pr " float %s;\n" name
2284 pr " struct guestfs_lvm_%s_list {\n" typ;
2285 pr " uint32_t len; /* Number of elements in list. */\n";
2286 pr " struct guestfs_lvm_%s *val; /* Elements. */\n" typ;
2289 pr " void guestfs_free_lvm_%s_list (struct guestfs_free_lvm_%s_list *);\n"
2292 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
2294 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
2295 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
2297 * We have to use an underscore instead of a dash because otherwise
2298 * rpcgen generates incorrect code.
2300 * This header is NOT exported to clients, but see also generate_structs_h.
2302 and generate_xdr () =
2303 generate_header CStyle LGPLv2;
2305 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
2306 pr "typedef string str<>;\n";
2309 (* LVM internal structures. *)
2313 pr "struct guestfs_lvm_int_%s {\n" typ;
2315 | name, `String -> pr " string %s<>;\n" name
2316 | name, `UUID -> pr " opaque %s[32];\n" name
2317 | name, `Bytes -> pr " hyper %s;\n" name
2318 | name, `Int -> pr " hyper %s;\n" name
2319 | name, `OptPercent -> pr " float %s;\n" name
2323 pr "typedef struct guestfs_lvm_int_%s guestfs_lvm_int_%s_list<>;\n" typ typ;
2325 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2327 (* Stat internal structures. *)
2331 pr "struct guestfs_int_%s {\n" typ;
2333 | name, `Int -> pr " hyper %s;\n" name
2337 ) ["stat", stat_cols; "statvfs", statvfs_cols];
2340 fun (shortname, style, _, _, _, _, _) ->
2341 let name = "guestfs_" ^ shortname in
2343 (match snd style with
2346 pr "struct %s_args {\n" name;
2349 | String n -> pr " string %s<>;\n" n
2350 | OptString n -> pr " str *%s;\n" n
2351 | StringList n -> pr " str %s<>;\n" n
2352 | Bool n -> pr " bool %s;\n" n
2353 | Int n -> pr " int %s;\n" n
2354 | FileIn _ | FileOut _ -> ()
2358 (match fst style with
2361 pr "struct %s_ret {\n" name;
2365 pr "struct %s_ret {\n" name;
2366 pr " hyper %s;\n" n;
2369 pr "struct %s_ret {\n" name;
2373 failwithf "RConstString cannot be returned from a daemon function"
2375 pr "struct %s_ret {\n" name;
2376 pr " string %s<>;\n" n;
2379 pr "struct %s_ret {\n" name;
2380 pr " str %s<>;\n" n;
2383 pr "struct %s_ret {\n" name;
2388 pr "struct %s_ret {\n" name;
2389 pr " guestfs_lvm_int_pv_list %s;\n" n;
2392 pr "struct %s_ret {\n" name;
2393 pr " guestfs_lvm_int_vg_list %s;\n" n;
2396 pr "struct %s_ret {\n" name;
2397 pr " guestfs_lvm_int_lv_list %s;\n" n;
2400 pr "struct %s_ret {\n" name;
2401 pr " guestfs_int_stat %s;\n" n;
2404 pr "struct %s_ret {\n" name;
2405 pr " guestfs_int_statvfs %s;\n" n;
2408 pr "struct %s_ret {\n" name;
2409 pr " str %s<>;\n" n;
2414 (* Table of procedure numbers. *)
2415 pr "enum guestfs_procedure {\n";
2417 fun (shortname, _, proc_nr, _, _, _, _) ->
2418 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
2420 pr " GUESTFS_PROC_NR_PROCS\n";
2424 (* Having to choose a maximum message size is annoying for several
2425 * reasons (it limits what we can do in the API), but it (a) makes
2426 * the protocol a lot simpler, and (b) provides a bound on the size
2427 * of the daemon which operates in limited memory space. For large
2428 * file transfers you should use FTP.
2430 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
2433 (* Message header, etc. *)
2435 /* The communication protocol is now documented in the guestfs(3)
2439 const GUESTFS_PROGRAM = 0x2000F5F5;
2440 const GUESTFS_PROTOCOL_VERSION = 1;
2442 /* These constants must be larger than any possible message length. */
2443 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
2444 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
2446 enum guestfs_message_direction {
2447 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
2448 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
2451 enum guestfs_message_status {
2452 GUESTFS_STATUS_OK = 0,
2453 GUESTFS_STATUS_ERROR = 1
2456 const GUESTFS_ERROR_LEN = 256;
2458 struct guestfs_message_error {
2459 string error_message<GUESTFS_ERROR_LEN>;
2462 struct guestfs_message_header {
2463 unsigned prog; /* GUESTFS_PROGRAM */
2464 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
2465 guestfs_procedure proc; /* GUESTFS_PROC_x */
2466 guestfs_message_direction direction;
2467 unsigned serial; /* message serial number */
2468 guestfs_message_status status;
2471 const GUESTFS_MAX_CHUNK_SIZE = 8192;
2473 struct guestfs_chunk {
2474 int cancel; /* if non-zero, transfer is cancelled */
2475 /* data size is 0 bytes if the transfer has finished successfully */
2476 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
2480 (* Generate the guestfs-structs.h file. *)
2481 and generate_structs_h () =
2482 generate_header CStyle LGPLv2;
2484 (* This is a public exported header file containing various
2485 * structures. The structures are carefully written to have
2486 * exactly the same in-memory format as the XDR structures that
2487 * we use on the wire to the daemon. The reason for creating
2488 * copies of these structures here is just so we don't have to
2489 * export the whole of guestfs_protocol.h (which includes much
2490 * unrelated and XDR-dependent stuff that we don't want to be
2491 * public, or required by clients).
2493 * To reiterate, we will pass these structures to and from the
2494 * client with a simple assignment or memcpy, so the format
2495 * must be identical to what rpcgen / the RFC defines.
2498 (* guestfs_int_bool structure. *)
2499 pr "struct guestfs_int_bool {\n";
2505 (* LVM public structures. *)
2509 pr "struct guestfs_lvm_%s {\n" typ;
2512 | name, `String -> pr " char *%s;\n" name
2513 | name, `UUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
2514 | name, `Bytes -> pr " uint64_t %s;\n" name
2515 | name, `Int -> pr " int64_t %s;\n" name
2516 | name, `OptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
2520 pr "struct guestfs_lvm_%s_list {\n" typ;
2521 pr " uint32_t len;\n";
2522 pr " struct guestfs_lvm_%s *val;\n" typ;
2525 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2527 (* Stat structures. *)
2531 pr "struct guestfs_%s {\n" typ;
2534 | name, `Int -> pr " int64_t %s;\n" name
2538 ) ["stat", stat_cols; "statvfs", statvfs_cols]
2540 (* Generate the guestfs-actions.h file. *)
2541 and generate_actions_h () =
2542 generate_header CStyle LGPLv2;
2544 fun (shortname, style, _, _, _, _, _) ->
2545 let name = "guestfs_" ^ shortname in
2546 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
2550 (* Generate the client-side dispatch stubs. *)
2551 and generate_client_actions () =
2552 generate_header CStyle LGPLv2;
2558 #include \"guestfs.h\"
2559 #include \"guestfs_protocol.h\"
2561 #define error guestfs_error
2562 #define perrorf guestfs_perrorf
2563 #define safe_malloc guestfs_safe_malloc
2564 #define safe_realloc guestfs_safe_realloc
2565 #define safe_strdup guestfs_safe_strdup
2566 #define safe_memdup guestfs_safe_memdup
2568 /* Check the return message from a call for validity. */
2570 check_reply_header (guestfs_h *g,
2571 const struct guestfs_message_header *hdr,
2572 int proc_nr, int serial)
2574 if (hdr->prog != GUESTFS_PROGRAM) {
2575 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
2578 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
2579 error (g, \"wrong protocol version (%%d/%%d)\",
2580 hdr->vers, GUESTFS_PROTOCOL_VERSION);
2583 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
2584 error (g, \"unexpected message direction (%%d/%%d)\",
2585 hdr->direction, GUESTFS_DIRECTION_REPLY);
2588 if (hdr->proc != proc_nr) {
2589 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
2592 if (hdr->serial != serial) {
2593 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
2600 /* Check we are in the right state to run a high-level action. */
2602 check_state (guestfs_h *g, const char *caller)
2604 if (!guestfs_is_ready (g)) {
2605 if (guestfs_is_config (g))
2606 error (g, \"%%s: call launch() before using this function\",
2608 else if (guestfs_is_launching (g))
2609 error (g, \"%%s: call wait_ready() before using this function\",
2612 error (g, \"%%s called from the wrong state, %%d != READY\",
2613 caller, guestfs_get_state (g));
2621 (* Client-side stubs for each function. *)
2623 fun (shortname, style, _, _, _, _, _) ->
2624 let name = "guestfs_" ^ shortname in
2626 (* Generate the context struct which stores the high-level
2627 * state between callback functions.
2629 pr "struct %s_ctx {\n" shortname;
2630 pr " /* This flag is set by the callbacks, so we know we've done\n";
2631 pr " * the callbacks as expected, and in the right sequence.\n";
2632 pr " * 0 = not called, 1 = reply_cb called.\n";
2634 pr " int cb_sequence;\n";
2635 pr " struct guestfs_message_header hdr;\n";
2636 pr " struct guestfs_message_error err;\n";
2637 (match fst style with
2640 failwithf "RConstString cannot be returned from a daemon function"
2642 | RBool _ | RString _ | RStringList _
2644 | RPVList _ | RVGList _ | RLVList _
2645 | RStat _ | RStatVFS _
2647 pr " struct %s_ret ret;\n" name
2652 (* Generate the reply callback function. *)
2653 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
2655 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
2656 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
2658 pr " /* This should definitely not happen. */\n";
2659 pr " if (ctx->cb_sequence != 0) {\n";
2660 pr " ctx->cb_sequence = 9999;\n";
2661 pr " error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
2665 pr " ml->main_loop_quit (ml, g);\n";
2667 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
2668 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
2671 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
2672 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
2673 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
2680 (match fst style with
2683 failwithf "RConstString cannot be returned from a daemon function"
2685 | RBool _ | RString _ | RStringList _
2687 | RPVList _ | RVGList _ | RLVList _
2688 | RStat _ | RStatVFS _
2690 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
2691 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
2697 pr " ctx->cb_sequence = 1;\n";
2700 (* Generate the action stub. *)
2701 generate_prototype ~extern:false ~semicolon:false ~newline:true
2702 ~handle:"g" name style;
2705 match fst style with
2706 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
2708 failwithf "RConstString cannot be returned from a daemon function"
2709 | RString _ | RStringList _ | RIntBool _
2710 | RPVList _ | RVGList _ | RLVList _
2711 | RStat _ | RStatVFS _
2717 (match snd style with
2719 | _ -> pr " struct %s_args args;\n" name
2722 pr " struct %s_ctx ctx;\n" shortname;
2723 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
2724 pr " int serial;\n";
2726 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
2727 pr " guestfs_set_busy (g);\n";
2729 pr " memset (&ctx, 0, sizeof ctx);\n";
2732 (* Send the main header and arguments. *)
2733 (match snd style with
2735 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
2736 (String.uppercase shortname)
2741 pr " args.%s = (char *) %s;\n" n n
2743 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
2745 pr " args.%s.%s_val = (char **) %s;\n" n n n;
2746 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
2748 pr " args.%s = %s;\n" n n
2750 pr " args.%s = %s;\n" n n
2751 | FileIn _ | FileOut _ -> ()
2753 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
2754 (String.uppercase shortname);
2755 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
2758 pr " if (serial == -1) {\n";
2759 pr " guestfs_set_ready (g);\n";
2760 pr " return %s;\n" error_code;
2764 (* Send any additional files (FileIn) requested. *)
2765 let need_read_reply_label = ref false in
2772 pr " r = guestfs__send_file_sync (g, %s);\n" n;
2773 pr " if (r == -1) {\n";
2774 pr " guestfs_set_ready (g);\n";
2775 pr " return %s;\n" error_code;
2777 pr " if (r == -2) /* daemon cancelled */\n";
2778 pr " goto read_reply;\n";
2779 need_read_reply_label := true;
2785 (* Wait for the reply from the remote end. *)
2786 if !need_read_reply_label then pr " read_reply:\n";
2787 pr " guestfs__switch_to_receiving (g);\n";
2788 pr " ctx.cb_sequence = 0;\n";
2789 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
2790 pr " (void) ml->main_loop_run (ml, g);\n";
2791 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
2792 pr " if (ctx.cb_sequence != 1) {\n";
2793 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
2794 pr " guestfs_set_ready (g);\n";
2795 pr " return %s;\n" error_code;
2799 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
2800 (String.uppercase shortname);
2801 pr " guestfs_set_ready (g);\n";
2802 pr " return %s;\n" error_code;
2806 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
2807 pr " error (g, \"%%s\", ctx.err.error_message);\n";
2808 pr " guestfs_set_ready (g);\n";
2809 pr " return %s;\n" error_code;
2813 (* Expecting to receive further files (FileOut)? *)
2817 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
2818 pr " guestfs_set_ready (g);\n";
2819 pr " return %s;\n" error_code;
2825 pr " guestfs_set_ready (g);\n";
2827 (match fst style with
2828 | RErr -> pr " return 0;\n"
2829 | RInt n | RInt64 n | RBool n ->
2830 pr " return ctx.ret.%s;\n" n
2832 failwithf "RConstString cannot be returned from a daemon function"
2834 pr " return ctx.ret.%s; /* caller will free */\n" n
2835 | RStringList n | RHashtable n ->
2836 pr " /* caller will free this, but we need to add a NULL entry */\n";
2837 pr " ctx.ret.%s.%s_val =\n" n n;
2838 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
2839 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
2841 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
2842 pr " return ctx.ret.%s.%s_val;\n" n n
2844 pr " /* caller with free this */\n";
2845 pr " return safe_memdup (g, &ctx.ret, sizeof (ctx.ret));\n"
2846 | RPVList n | RVGList n | RLVList n
2847 | RStat n | RStatVFS n ->
2848 pr " /* caller will free this */\n";
2849 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
2855 (* Generate daemon/actions.h. *)
2856 and generate_daemon_actions_h () =
2857 generate_header CStyle GPLv2;
2859 pr "#include \"../src/guestfs_protocol.h\"\n";
2863 fun (name, style, _, _, _, _, _) ->
2865 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
2869 (* Generate the server-side stubs. *)
2870 and generate_daemon_actions () =
2871 generate_header CStyle GPLv2;
2873 pr "#include <config.h>\n";
2875 pr "#include <stdio.h>\n";
2876 pr "#include <stdlib.h>\n";
2877 pr "#include <string.h>\n";
2878 pr "#include <inttypes.h>\n";
2879 pr "#include <ctype.h>\n";
2880 pr "#include <rpc/types.h>\n";
2881 pr "#include <rpc/xdr.h>\n";
2883 pr "#include \"daemon.h\"\n";
2884 pr "#include \"../src/guestfs_protocol.h\"\n";
2885 pr "#include \"actions.h\"\n";
2889 fun (name, style, _, _, _, _, _) ->
2890 (* Generate server-side stubs. *)
2891 pr "static void %s_stub (XDR *xdr_in)\n" name;
2894 match fst style with
2895 | RErr | RInt _ -> pr " int r;\n"; "-1"
2896 | RInt64 _ -> pr " int64_t r;\n"; "-1"
2897 | RBool _ -> pr " int r;\n"; "-1"
2899 failwithf "RConstString cannot be returned from a daemon function"
2900 | RString _ -> pr " char *r;\n"; "NULL"
2901 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
2902 | RIntBool _ -> pr " guestfs_%s_ret *r;\n" name; "NULL"
2903 | RPVList _ -> pr " guestfs_lvm_int_pv_list *r;\n"; "NULL"
2904 | RVGList _ -> pr " guestfs_lvm_int_vg_list *r;\n"; "NULL"
2905 | RLVList _ -> pr " guestfs_lvm_int_lv_list *r;\n"; "NULL"
2906 | RStat _ -> pr " guestfs_int_stat *r;\n"; "NULL"
2907 | RStatVFS _ -> pr " guestfs_int_statvfs *r;\n"; "NULL" in
2909 (match snd style with
2912 pr " struct guestfs_%s_args args;\n" name;
2916 | OptString n -> pr " const char *%s;\n" n
2917 | StringList n -> pr " char **%s;\n" n
2918 | Bool n -> pr " int %s;\n" n
2919 | Int n -> pr " int %s;\n" n
2920 | FileIn _ | FileOut _ -> ()
2925 (match snd style with
2928 pr " memset (&args, 0, sizeof args);\n";
2930 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
2931 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
2936 | String n -> pr " %s = args.%s;\n" n n
2937 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
2939 pr " %s = realloc (args.%s.%s_val,\n" n n n;
2940 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
2941 pr " if (%s == NULL) {\n" n;
2942 pr " reply_with_perror (\"realloc\");\n";
2945 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
2946 pr " args.%s.%s_val = %s;\n" n n n;
2947 | Bool n -> pr " %s = args.%s;\n" n n
2948 | Int n -> pr " %s = args.%s;\n" n n
2949 | FileIn _ | FileOut _ -> ()
2954 (* Don't want to call the impl with any FileIn or FileOut
2955 * parameters, since these go "outside" the RPC protocol.
2958 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
2960 pr " r = do_%s " name;
2961 generate_call_args argsnofile;
2964 pr " if (r == %s)\n" error_code;
2965 pr " /* do_%s has already called reply_with_error */\n" name;
2969 (* If there are any FileOut parameters, then the impl must
2970 * send its own reply.
2973 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
2975 pr " /* do_%s has already sent a reply */\n" name
2977 match fst style with
2978 | RErr -> pr " reply (NULL, NULL);\n"
2979 | RInt n | RInt64 n | RBool n ->
2980 pr " struct guestfs_%s_ret ret;\n" name;
2981 pr " ret.%s = r;\n" n;
2982 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
2985 failwithf "RConstString cannot be returned from a daemon function"
2987 pr " struct guestfs_%s_ret ret;\n" name;
2988 pr " ret.%s = r;\n" n;
2989 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
2992 | RStringList n | RHashtable n ->
2993 pr " struct guestfs_%s_ret ret;\n" name;
2994 pr " ret.%s.%s_len = count_strings (r);\n" n n;
2995 pr " ret.%s.%s_val = r;\n" n n;
2996 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
2998 pr " free_strings (r);\n"
3000 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n"
3002 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n" name
3003 | RPVList n | RVGList n | RLVList n
3004 | RStat n | RStatVFS n ->
3005 pr " struct guestfs_%s_ret ret;\n" name;
3006 pr " ret.%s = *r;\n" n;
3007 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
3009 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
3013 (* Free the args. *)
3014 (match snd style with
3019 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
3026 (* Dispatch function. *)
3027 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
3029 pr " switch (proc_nr) {\n";
3032 fun (name, style, _, _, _, _, _) ->
3033 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
3034 pr " %s_stub (xdr_in);\n" name;
3039 pr " reply_with_error (\"dispatch_incoming_message: unknown procedure number %%d\", proc_nr);\n";
3044 (* LVM columns and tokenization functions. *)
3045 (* XXX This generates crap code. We should rethink how we
3051 pr "static const char *lvm_%s_cols = \"%s\";\n"
3052 typ (String.concat "," (List.map fst cols));
3055 pr "static int lvm_tokenize_%s (char *str, struct guestfs_lvm_int_%s *r)\n" typ typ;
3057 pr " char *tok, *p, *next;\n";
3061 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
3064 pr " if (!str) {\n";
3065 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
3068 pr " if (!*str || isspace (*str)) {\n";
3069 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
3074 fun (name, coltype) ->
3075 pr " if (!tok) {\n";
3076 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
3079 pr " p = strchrnul (tok, ',');\n";
3080 pr " if (*p) next = p+1; else next = NULL;\n";
3081 pr " *p = '\\0';\n";
3084 pr " r->%s = strdup (tok);\n" name;
3085 pr " if (r->%s == NULL) {\n" name;
3086 pr " perror (\"strdup\");\n";
3090 pr " for (i = j = 0; i < 32; ++j) {\n";
3091 pr " if (tok[j] == '\\0') {\n";
3092 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
3094 pr " } else if (tok[j] != '-')\n";
3095 pr " r->%s[i++] = tok[j];\n" name;
3098 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
3099 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3103 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
3104 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3108 pr " if (tok[0] == '\\0')\n";
3109 pr " r->%s = -1;\n" name;
3110 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
3111 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3115 pr " tok = next;\n";
3118 pr " if (tok != NULL) {\n";
3119 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
3126 pr "guestfs_lvm_int_%s_list *\n" typ;
3127 pr "parse_command_line_%ss (void)\n" typ;
3129 pr " char *out, *err;\n";
3130 pr " char *p, *pend;\n";
3132 pr " guestfs_lvm_int_%s_list *ret;\n" typ;
3133 pr " void *newp;\n";
3135 pr " ret = malloc (sizeof *ret);\n";
3136 pr " if (!ret) {\n";
3137 pr " reply_with_perror (\"malloc\");\n";
3138 pr " return NULL;\n";
3141 pr " ret->guestfs_lvm_int_%s_list_len = 0;\n" typ;
3142 pr " ret->guestfs_lvm_int_%s_list_val = NULL;\n" typ;
3144 pr " r = command (&out, &err,\n";
3145 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
3146 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
3147 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
3148 pr " if (r == -1) {\n";
3149 pr " reply_with_error (\"%%s\", err);\n";
3150 pr " free (out);\n";
3151 pr " free (err);\n";
3152 pr " free (ret);\n";
3153 pr " return NULL;\n";
3156 pr " free (err);\n";
3158 pr " /* Tokenize each line of the output. */\n";
3161 pr " while (p) {\n";
3162 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
3163 pr " if (pend) {\n";
3164 pr " *pend = '\\0';\n";
3168 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
3171 pr " if (!*p) { /* Empty line? Skip it. */\n";
3176 pr " /* Allocate some space to store this next entry. */\n";
3177 pr " newp = realloc (ret->guestfs_lvm_int_%s_list_val,\n" typ;
3178 pr " sizeof (guestfs_lvm_int_%s) * (i+1));\n" typ;
3179 pr " if (newp == NULL) {\n";
3180 pr " reply_with_perror (\"realloc\");\n";
3181 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3182 pr " free (ret);\n";
3183 pr " free (out);\n";
3184 pr " return NULL;\n";
3186 pr " ret->guestfs_lvm_int_%s_list_val = newp;\n" typ;
3188 pr " /* Tokenize the next entry. */\n";
3189 pr " r = lvm_tokenize_%s (p, &ret->guestfs_lvm_int_%s_list_val[i]);\n" typ typ;
3190 pr " if (r == -1) {\n";
3191 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
3192 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3193 pr " free (ret);\n";
3194 pr " free (out);\n";
3195 pr " return NULL;\n";
3202 pr " ret->guestfs_lvm_int_%s_list_len = i;\n" typ;
3204 pr " free (out);\n";
3205 pr " return ret;\n";
3208 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
3210 (* Generate the tests. *)
3211 and generate_tests () =
3212 generate_header CStyle GPLv2;
3219 #include <sys/types.h>
3222 #include \"guestfs.h\"
3224 static guestfs_h *g;
3225 static int suppress_error = 0;
3227 static void print_error (guestfs_h *g, void *data, const char *msg)
3229 if (!suppress_error)
3230 fprintf (stderr, \"%%s\\n\", msg);
3233 static void print_strings (char * const * const argv)
3237 for (argc = 0; argv[argc] != NULL; ++argc)
3238 printf (\"\\t%%s\\n\", argv[argc]);
3242 static void print_table (char * const * const argv)
3246 for (i = 0; argv[i] != NULL; i += 2)
3247 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
3251 static void no_test_warnings (void)
3257 | name, _, _, _, [], _, _ ->
3258 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
3259 | name, _, _, _, tests, _, _ -> ()
3265 (* Generate the actual tests. Note that we generate the tests
3266 * in reverse order, deliberately, so that (in general) the
3267 * newest tests run first. This makes it quicker and easier to
3272 fun (name, _, _, _, tests, _, _) ->
3273 mapi (generate_one_test name) tests
3274 ) (List.rev all_functions) in
3275 let test_names = List.concat test_names in
3276 let nr_tests = List.length test_names in
3279 int main (int argc, char *argv[])
3284 const char *filename;
3286 int nr_tests, test_num = 0;
3288 no_test_warnings ();
3290 g = guestfs_create ();
3292 printf (\"guestfs_create FAILED\\n\");
3296 guestfs_set_error_handler (g, print_error, NULL);
3298 srcdir = getenv (\"srcdir\");
3299 if (!srcdir) srcdir = \".\";
3301 guestfs_set_path (g, \".\");
3303 filename = \"test1.img\";
3304 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3309 if (lseek (fd, %d, SEEK_SET) == -1) {
3315 if (write (fd, &c, 1) == -1) {
3321 if (close (fd) == -1) {
3326 if (guestfs_add_drive (g, filename) == -1) {
3327 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3331 filename = \"test2.img\";
3332 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3337 if (lseek (fd, %d, SEEK_SET) == -1) {
3343 if (write (fd, &c, 1) == -1) {
3349 if (close (fd) == -1) {
3354 if (guestfs_add_drive (g, filename) == -1) {
3355 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3359 filename = \"test3.img\";
3360 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3365 if (lseek (fd, %d, SEEK_SET) == -1) {
3371 if (write (fd, &c, 1) == -1) {
3377 if (close (fd) == -1) {
3382 if (guestfs_add_drive (g, filename) == -1) {
3383 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3387 if (guestfs_launch (g) == -1) {
3388 printf (\"guestfs_launch FAILED\\n\");
3391 if (guestfs_wait_ready (g) == -1) {
3392 printf (\"guestfs_wait_ready FAILED\\n\");
3398 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
3402 pr " test_num++;\n";
3403 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
3404 pr " if (%s () == -1) {\n" test_name;
3405 pr " printf (\"%s FAILED\\n\");\n" test_name;
3411 pr " guestfs_close (g);\n";
3412 pr " unlink (\"test1.img\");\n";
3413 pr " unlink (\"test2.img\");\n";
3414 pr " unlink (\"test3.img\");\n";
3417 pr " if (failed > 0) {\n";
3418 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
3426 and generate_one_test name i (init, test) =
3427 let test_name = sprintf "test_%s_%d" name i in
3429 pr "static int %s (void)\n" test_name;
3435 pr " /* InitEmpty for %s (%d) */\n" name i;
3436 List.iter (generate_test_command_call test_name)
3440 pr " /* InitBasicFS for %s (%d): create ext2 on /dev/sda1 */\n" name i;
3441 List.iter (generate_test_command_call test_name)
3444 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
3445 ["mkfs"; "ext2"; "/dev/sda1"];
3446 ["mount"; "/dev/sda1"; "/"]]
3447 | InitBasicFSonLVM ->
3448 pr " /* InitBasicFSonLVM for %s (%d): create ext2 on /dev/VG/LV */\n"
3450 List.iter (generate_test_command_call test_name)
3453 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
3454 ["pvcreate"; "/dev/sda1"];
3455 ["vgcreate"; "VG"; "/dev/sda1"];
3456 ["lvcreate"; "LV"; "VG"; "8"];
3457 ["mkfs"; "ext2"; "/dev/VG/LV"];
3458 ["mount"; "/dev/VG/LV"; "/"]]
3461 let get_seq_last = function
3463 failwithf "%s: you cannot use [] (empty list) when expecting a command"
3466 let seq = List.rev seq in
3467 List.rev (List.tl seq), List.hd seq
3472 pr " /* TestRun for %s (%d) */\n" name i;
3473 List.iter (generate_test_command_call test_name) seq
3474 | TestOutput (seq, expected) ->
3475 pr " /* TestOutput for %s (%d) */\n" name i;
3476 let seq, last = get_seq_last seq in
3478 pr " if (strcmp (r, \"%s\") != 0) {\n" (c_quote expected);
3479 pr " fprintf (stderr, \"%s: expected \\\"%s\\\" but got \\\"%%s\\\"\\n\", r);\n" test_name (c_quote expected);
3483 List.iter (generate_test_command_call test_name) seq;
3484 generate_test_command_call ~test test_name last
3485 | TestOutputList (seq, expected) ->
3486 pr " /* TestOutputList for %s (%d) */\n" name i;
3487 let seq, last = get_seq_last seq in
3491 pr " if (!r[%d]) {\n" i;
3492 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
3493 pr " print_strings (r);\n";
3496 pr " if (strcmp (r[%d], \"%s\") != 0) {\n" i (c_quote str);
3497 pr " fprintf (stderr, \"%s: expected \\\"%s\\\" but got \\\"%%s\\\"\\n\", r[%d]);\n" test_name (c_quote str) i;
3501 pr " if (r[%d] != NULL) {\n" (List.length expected);
3502 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
3504 pr " print_strings (r);\n";
3508 List.iter (generate_test_command_call test_name) seq;
3509 generate_test_command_call ~test test_name last
3510 | TestOutputInt (seq, expected) ->
3511 pr " /* TestOutputInt for %s (%d) */\n" name i;
3512 let seq, last = get_seq_last seq in
3514 pr " if (r != %d) {\n" expected;
3515 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
3521 List.iter (generate_test_command_call test_name) seq;
3522 generate_test_command_call ~test test_name last
3523 | TestOutputTrue seq ->
3524 pr " /* TestOutputTrue for %s (%d) */\n" name i;
3525 let seq, last = get_seq_last seq in
3528 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
3533 List.iter (generate_test_command_call test_name) seq;
3534 generate_test_command_call ~test test_name last
3535 | TestOutputFalse seq ->
3536 pr " /* TestOutputFalse for %s (%d) */\n" name i;
3537 let seq, last = get_seq_last seq in
3540 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
3545 List.iter (generate_test_command_call test_name) seq;
3546 generate_test_command_call ~test test_name last
3547 | TestOutputLength (seq, expected) ->
3548 pr " /* TestOutputLength for %s (%d) */\n" name i;
3549 let seq, last = get_seq_last seq in
3552 pr " for (j = 0; j < %d; ++j)\n" expected;
3553 pr " if (r[j] == NULL) {\n";
3554 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
3556 pr " print_strings (r);\n";
3559 pr " if (r[j] != NULL) {\n";
3560 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
3562 pr " print_strings (r);\n";
3566 List.iter (generate_test_command_call test_name) seq;
3567 generate_test_command_call ~test test_name last
3568 | TestOutputStruct (seq, checks) ->
3569 pr " /* TestOutputStruct for %s (%d) */\n" name i;
3570 let seq, last = get_seq_last seq in
3574 | CompareWithInt (field, expected) ->
3575 pr " if (r->%s != %d) {\n" field expected;
3576 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
3577 test_name field expected;
3578 pr " (int) r->%s);\n" field;
3581 | CompareWithString (field, expected) ->
3582 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
3583 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
3584 test_name field expected;
3585 pr " r->%s);\n" field;
3588 | CompareFieldsIntEq (field1, field2) ->
3589 pr " if (r->%s != r->%s) {\n" field1 field2;
3590 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
3591 test_name field1 field2;
3592 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
3595 | CompareFieldsStrEq (field1, field2) ->
3596 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
3597 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
3598 test_name field1 field2;
3599 pr " r->%s, r->%s);\n" field1 field2;
3604 List.iter (generate_test_command_call test_name) seq;
3605 generate_test_command_call ~test test_name last
3606 | TestLastFail seq ->
3607 pr " /* TestLastFail for %s (%d) */\n" name i;
3608 let seq, last = get_seq_last seq in
3609 List.iter (generate_test_command_call test_name) seq;
3610 generate_test_command_call test_name ~expect_error:true last
3618 (* Generate the code to run a command, leaving the result in 'r'.
3619 * If you expect to get an error then you should set expect_error:true.
3621 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
3623 | [] -> assert false
3625 (* Look up the command to find out what args/ret it has. *)
3628 let _, style, _, _, _, _, _ =
3629 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
3632 failwithf "%s: in test, command %s was not found" test_name name in
3634 if List.length (snd style) <> List.length args then
3635 failwithf "%s: in test, wrong number of args given to %s"
3646 | FileIn _, _ | FileOut _, _ -> ()
3647 | StringList n, arg ->
3648 pr " char *%s[] = {\n" n;
3649 let strs = string_split " " arg in
3651 fun str -> pr " \"%s\",\n" (c_quote str)
3655 ) (List.combine (snd style) args);
3658 match fst style with
3659 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
3660 | RInt64 _ -> pr " int64_t r;\n"; "-1"
3661 | RConstString _ -> pr " const char *r;\n"; "NULL"
3662 | RString _ -> pr " char *r;\n"; "NULL"
3663 | RStringList _ | RHashtable _ ->
3668 pr " struct guestfs_int_bool *r;\n"; "NULL"
3670 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
3672 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
3674 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
3676 pr " struct guestfs_stat *r;\n"; "NULL"
3678 pr " struct guestfs_statvfs *r;\n"; "NULL" in
3680 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
3681 pr " r = guestfs_%s (g" name;
3683 (* Generate the parameters. *)
3687 | FileIn _, arg | FileOut _, arg ->
3688 pr ", \"%s\"" (c_quote arg)
3689 | OptString _, arg ->
3690 if arg = "NULL" then pr ", NULL" else pr ", \"%s\"" (c_quote arg)
3691 | StringList n, _ ->
3695 try int_of_string arg
3696 with Failure "int_of_string" ->
3697 failwithf "%s: expecting an int, but got '%s'" test_name arg in
3700 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
3701 ) (List.combine (snd style) args);
3704 if not expect_error then
3705 pr " if (r == %s)\n" error_code
3707 pr " if (r != %s)\n" error_code;
3710 (* Insert the test code. *)
3716 (match fst style with
3717 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _ -> ()
3718 | RString _ -> pr " free (r);\n"
3719 | RStringList _ | RHashtable _ ->
3720 pr " for (i = 0; r[i] != NULL; ++i)\n";
3721 pr " free (r[i]);\n";
3724 pr " guestfs_free_int_bool (r);\n"
3726 pr " guestfs_free_lvm_pv_list (r);\n"
3728 pr " guestfs_free_lvm_vg_list (r);\n"
3730 pr " guestfs_free_lvm_lv_list (r);\n"
3731 | RStat _ | RStatVFS _ ->
3738 let str = replace_str str "\r" "\\r" in
3739 let str = replace_str str "\n" "\\n" in
3740 let str = replace_str str "\t" "\\t" in
3743 (* Generate a lot of different functions for guestfish. *)
3744 and generate_fish_cmds () =
3745 generate_header CStyle GPLv2;
3749 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3751 let all_functions_sorted =
3753 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3754 ) all_functions_sorted in
3756 pr "#include <stdio.h>\n";
3757 pr "#include <stdlib.h>\n";
3758 pr "#include <string.h>\n";
3759 pr "#include <inttypes.h>\n";
3761 pr "#include <guestfs.h>\n";
3762 pr "#include \"fish.h\"\n";
3765 (* list_commands function, which implements guestfish -h *)
3766 pr "void list_commands (void)\n";
3768 pr " printf (\" %%-16s %%s\\n\", \"Command\", \"Description\");\n";
3769 pr " list_builtin_commands ();\n";
3771 fun (name, _, _, flags, _, shortdesc, _) ->
3772 let name = replace_char name '_' '-' in
3773 pr " printf (\"%%-20s %%s\\n\", \"%s\", \"%s\");\n"
3775 ) all_functions_sorted;
3776 pr " printf (\" Use -h <cmd> / help <cmd> to show detailed help for a command.\\n\");\n";
3780 (* display_command function, which implements guestfish -h cmd *)
3781 pr "void display_command (const char *cmd)\n";
3784 fun (name, style, _, flags, _, shortdesc, longdesc) ->
3785 let name2 = replace_char name '_' '-' in
3787 try find_map (function FishAlias n -> Some n | _ -> None) flags
3788 with Not_found -> name in
3789 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
3791 match snd style with
3795 name2 (String.concat "> <" (List.map name_of_argt args)) in
3798 if List.mem ProtocolLimitWarning flags then
3799 ("\n\n" ^ protocol_limit_warning)
3802 (* For DangerWillRobinson commands, we should probably have
3803 * guestfish prompt before allowing you to use them (especially
3804 * in interactive mode). XXX
3808 if List.mem DangerWillRobinson flags then
3809 ("\n\n" ^ danger_will_robinson)
3812 let describe_alias =
3813 if name <> alias then
3814 sprintf "\n\nYou can use '%s' as an alias for this command." alias
3818 pr "strcasecmp (cmd, \"%s\") == 0" name;
3819 if name <> name2 then
3820 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
3821 if name <> alias then
3822 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
3824 pr " pod2text (\"%s - %s\", %S);\n"
3826 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
3829 pr " display_builtin_command (cmd);\n";
3833 (* print_{pv,vg,lv}_list functions *)
3837 pr "static void print_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
3844 pr " printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
3846 pr " printf (\"%s: \");\n" name;
3847 pr " for (i = 0; i < 32; ++i)\n";
3848 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
3849 pr " printf (\"\\n\");\n"
3851 pr " printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
3853 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
3854 | name, `OptPercent ->
3855 pr " if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
3856 typ name name typ name;
3857 pr " else printf (\"%s: \\n\");\n" name
3861 pr "static void print_%s_list (struct guestfs_lvm_%s_list *%ss)\n"
3866 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
3867 pr " print_%s (&%ss->val[i]);\n" typ typ;
3870 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
3872 (* print_{stat,statvfs} functions *)
3876 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
3881 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
3885 ) ["stat", stat_cols; "statvfs", statvfs_cols];
3887 (* run_<action> actions *)
3889 fun (name, style, _, flags, _, _, _) ->
3890 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
3892 (match fst style with
3895 | RBool _ -> pr " int r;\n"
3896 | RInt64 _ -> pr " int64_t r;\n"
3897 | RConstString _ -> pr " const char *r;\n"
3898 | RString _ -> pr " char *r;\n"
3899 | RStringList _ | RHashtable _ -> pr " char **r;\n"
3900 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"
3901 | RPVList _ -> pr " struct guestfs_lvm_pv_list *r;\n"
3902 | RVGList _ -> pr " struct guestfs_lvm_vg_list *r;\n"
3903 | RLVList _ -> pr " struct guestfs_lvm_lv_list *r;\n"
3904 | RStat _ -> pr " struct guestfs_stat *r;\n"
3905 | RStatVFS _ -> pr " struct guestfs_statvfs *r;\n"
3912 | FileOut n -> pr " const char *%s;\n" n
3913 | StringList n -> pr " char **%s;\n" n
3914 | Bool n -> pr " int %s;\n" n
3915 | Int n -> pr " int %s;\n" n
3918 (* Check and convert parameters. *)
3919 let argc_expected = List.length (snd style) in
3920 pr " if (argc != %d) {\n" argc_expected;
3921 pr " fprintf (stderr, \"%%s should have %d parameter(s)\\n\", cmd);\n"
3923 pr " fprintf (stderr, \"type 'help %%s' for help on %%s\\n\", cmd, cmd);\n";
3929 | String name -> pr " %s = argv[%d];\n" name i
3931 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
3934 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
3937 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
3939 | StringList name ->
3940 pr " %s = parse_string_list (argv[%d]);\n" name i
3942 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
3944 pr " %s = atoi (argv[%d]);\n" name i
3947 (* Call C API function. *)
3949 try find_map (function FishAction n -> Some n | _ -> None) flags
3950 with Not_found -> sprintf "guestfs_%s" name in
3952 generate_call_args ~handle:"g" (snd style);
3955 (* Check return value for errors and display command results. *)
3956 (match fst style with
3957 | RErr -> pr " return r;\n"
3959 pr " if (r == -1) return -1;\n";
3960 pr " printf (\"%%d\\n\", r);\n";
3963 pr " if (r == -1) return -1;\n";
3964 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
3967 pr " if (r == -1) return -1;\n";
3968 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
3971 pr " if (r == NULL) return -1;\n";
3972 pr " printf (\"%%s\\n\", r);\n";
3975 pr " if (r == NULL) return -1;\n";
3976 pr " printf (\"%%s\\n\", r);\n";
3980 pr " if (r == NULL) return -1;\n";
3981 pr " print_strings (r);\n";
3982 pr " free_strings (r);\n";
3985 pr " if (r == NULL) return -1;\n";
3986 pr " printf (\"%%d, %%s\\n\", r->i,\n";
3987 pr " r->b ? \"true\" : \"false\");\n";
3988 pr " guestfs_free_int_bool (r);\n";
3991 pr " if (r == NULL) return -1;\n";
3992 pr " print_pv_list (r);\n";
3993 pr " guestfs_free_lvm_pv_list (r);\n";
3996 pr " if (r == NULL) return -1;\n";
3997 pr " print_vg_list (r);\n";
3998 pr " guestfs_free_lvm_vg_list (r);\n";
4001 pr " if (r == NULL) return -1;\n";
4002 pr " print_lv_list (r);\n";
4003 pr " guestfs_free_lvm_lv_list (r);\n";
4006 pr " if (r == NULL) return -1;\n";
4007 pr " print_stat (r);\n";
4011 pr " if (r == NULL) return -1;\n";
4012 pr " print_statvfs (r);\n";
4016 pr " if (r == NULL) return -1;\n";
4017 pr " print_table (r);\n";
4018 pr " free_strings (r);\n";
4025 (* run_action function *)
4026 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
4029 fun (name, _, _, flags, _, _, _) ->
4030 let name2 = replace_char name '_' '-' in
4032 try find_map (function FishAlias n -> Some n | _ -> None) flags
4033 with Not_found -> name in
4035 pr "strcasecmp (cmd, \"%s\") == 0" name;
4036 if name <> name2 then
4037 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
4038 if name <> alias then
4039 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
4041 pr " return run_%s (cmd, argc, argv);\n" name;
4045 pr " fprintf (stderr, \"%%s: unknown command\\n\", cmd);\n";
4052 (* Readline completion for guestfish. *)
4053 and generate_fish_completion () =
4054 generate_header CStyle GPLv2;
4058 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4068 #ifdef HAVE_LIBREADLINE
4069 #include <readline/readline.h>
4074 #ifdef HAVE_LIBREADLINE
4076 static const char *const commands[] = {
4079 (* Get the commands and sort them, including the aliases. *)
4082 fun (name, _, _, flags, _, _, _) ->
4083 let name2 = replace_char name '_' '-' in
4085 try find_map (function FishAlias n -> Some n | _ -> None) flags
4086 with Not_found -> name in
4088 if name <> alias then [name2; alias] else [name2]
4090 let commands = List.flatten commands in
4091 let commands = List.sort compare commands in
4093 List.iter (pr " \"%s\",\n") commands;
4099 generator (const char *text, int state)
4101 static int index, len;
4106 len = strlen (text);
4109 while ((name = commands[index]) != NULL) {
4111 if (strncasecmp (name, text, len) == 0)
4112 return strdup (name);
4118 #endif /* HAVE_LIBREADLINE */
4120 char **do_completion (const char *text, int start, int end)
4122 char **matches = NULL;
4124 #ifdef HAVE_LIBREADLINE
4126 matches = rl_completion_matches (text, generator);
4133 (* Generate the POD documentation for guestfish. *)
4134 and generate_fish_actions_pod () =
4135 let all_functions_sorted =
4137 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4138 ) all_functions_sorted in
4140 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
4143 fun (name, style, _, flags, _, _, longdesc) ->
4145 Str.global_substitute rex (
4148 try Str.matched_group 1 s
4150 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
4151 "C<" ^ replace_char sub '_' '-' ^ ">"
4153 let name = replace_char name '_' '-' in
4155 try find_map (function FishAlias n -> Some n | _ -> None) flags
4156 with Not_found -> name in
4158 pr "=head2 %s" name;
4159 if name <> alias then
4166 | String n -> pr " %s" n
4167 | OptString n -> pr " %s" n
4168 | StringList n -> pr " '%s ...'" n
4169 | Bool _ -> pr " true|false"
4170 | Int n -> pr " %s" n
4171 | FileIn n | FileOut n -> pr " (%s|-)" n
4175 pr "%s\n\n" longdesc;
4177 if List.exists (function FileIn _ | FileOut _ -> true
4178 | _ -> false) (snd style) then
4179 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
4181 if List.mem ProtocolLimitWarning flags then
4182 pr "%s\n\n" protocol_limit_warning;
4184 if List.mem DangerWillRobinson flags then
4185 pr "%s\n\n" danger_will_robinson
4186 ) all_functions_sorted
4188 (* Generate a C function prototype. *)
4189 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
4190 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
4192 ?handle name style =
4193 if extern then pr "extern ";
4194 if static then pr "static ";
4195 (match fst style with
4197 | RInt _ -> pr "int "
4198 | RInt64 _ -> pr "int64_t "
4199 | RBool _ -> pr "int "
4200 | RConstString _ -> pr "const char *"
4201 | RString _ -> pr "char *"
4202 | RStringList _ | RHashtable _ -> pr "char **"
4204 if not in_daemon then pr "struct guestfs_int_bool *"
4205 else pr "guestfs_%s_ret *" name
4207 if not in_daemon then pr "struct guestfs_lvm_pv_list *"
4208 else pr "guestfs_lvm_int_pv_list *"
4210 if not in_daemon then pr "struct guestfs_lvm_vg_list *"
4211 else pr "guestfs_lvm_int_vg_list *"
4213 if not in_daemon then pr "struct guestfs_lvm_lv_list *"
4214 else pr "guestfs_lvm_int_lv_list *"
4216 if not in_daemon then pr "struct guestfs_stat *"
4217 else pr "guestfs_int_stat *"
4219 if not in_daemon then pr "struct guestfs_statvfs *"
4220 else pr "guestfs_int_statvfs *"
4222 pr "%s%s (" prefix name;
4223 if handle = None && List.length (snd style) = 0 then
4226 let comma = ref false in
4229 | Some handle -> pr "guestfs_h *%s" handle; comma := true
4233 if single_line then pr ", " else pr ",\n\t\t"
4240 | OptString n -> next (); pr "const char *%s" n
4241 | StringList n -> next (); pr "char * const* const %s" n
4242 | Bool n -> next (); pr "int %s" n
4243 | Int n -> next (); pr "int %s" n
4246 if not in_daemon then (next (); pr "const char *%s" n)
4250 if semicolon then pr ";";
4251 if newline then pr "\n"
4253 (* Generate C call arguments, eg "(handle, foo, bar)" *)
4254 and generate_call_args ?handle args =
4256 let comma = ref false in
4259 | Some handle -> pr "%s" handle; comma := true
4263 if !comma then pr ", ";
4265 pr "%s" (name_of_argt arg)
4269 (* Generate the OCaml bindings interface. *)
4270 and generate_ocaml_mli () =
4271 generate_header OCamlStyle LGPLv2;
4274 (** For API documentation you should refer to the C API
4275 in the guestfs(3) manual page. The OCaml API uses almost
4276 exactly the same calls. *)
4279 (** A [guestfs_h] handle. *)
4281 exception Error of string
4282 (** This exception is raised when there is an error. *)
4284 val create : unit -> t
4286 val close : t -> unit
4287 (** Handles are closed by the garbage collector when they become
4288 unreferenced, but callers can also call this in order to
4289 provide predictable cleanup. *)
4292 generate_ocaml_lvm_structure_decls ();
4294 generate_ocaml_stat_structure_decls ();
4298 fun (name, style, _, _, _, shortdesc, _) ->
4299 generate_ocaml_prototype name style;
4300 pr "(** %s *)\n" shortdesc;
4304 (* Generate the OCaml bindings implementation. *)
4305 and generate_ocaml_ml () =
4306 generate_header OCamlStyle LGPLv2;
4310 exception Error of string
4311 external create : unit -> t = \"ocaml_guestfs_create\"
4312 external close : t -> unit = \"ocaml_guestfs_close\"
4315 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
4319 generate_ocaml_lvm_structure_decls ();
4321 generate_ocaml_stat_structure_decls ();
4325 fun (name, style, _, _, _, shortdesc, _) ->
4326 generate_ocaml_prototype ~is_external:true name style;
4329 (* Generate the OCaml bindings C implementation. *)
4330 and generate_ocaml_c () =
4331 generate_header CStyle LGPLv2;
4338 #include <caml/config.h>
4339 #include <caml/alloc.h>
4340 #include <caml/callback.h>
4341 #include <caml/fail.h>
4342 #include <caml/memory.h>
4343 #include <caml/mlvalues.h>
4344 #include <caml/signals.h>
4346 #include <guestfs.h>
4348 #include \"guestfs_c.h\"
4350 /* Copy a hashtable of string pairs into an assoc-list. We return
4351 * the list in reverse order, but hashtables aren't supposed to be
4354 static CAMLprim value
4355 copy_table (char * const * argv)
4358 CAMLlocal5 (rv, pairv, kv, vv, cons);
4362 for (i = 0; argv[i] != NULL; i += 2) {
4363 kv = caml_copy_string (argv[i]);
4364 vv = caml_copy_string (argv[i+1]);
4365 pairv = caml_alloc (2, 0);
4366 Store_field (pairv, 0, kv);
4367 Store_field (pairv, 1, vv);
4368 cons = caml_alloc (2, 0);
4369 Store_field (cons, 1, rv);
4371 Store_field (cons, 0, pairv);
4379 (* LVM struct copy functions. *)
4382 let has_optpercent_col =
4383 List.exists (function (_, `OptPercent) -> true | _ -> false) cols in
4385 pr "static CAMLprim value\n";
4386 pr "copy_lvm_%s (const struct guestfs_lvm_%s *%s)\n" typ typ typ;
4388 pr " CAMLparam0 ();\n";
4389 if has_optpercent_col then
4390 pr " CAMLlocal3 (rv, v, v2);\n"
4392 pr " CAMLlocal2 (rv, v);\n";
4394 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
4399 pr " v = caml_copy_string (%s->%s);\n" typ name
4401 pr " v = caml_alloc_string (32);\n";
4402 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
4405 pr " v = caml_copy_int64 (%s->%s);\n" typ name
4406 | name, `OptPercent ->
4407 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
4408 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
4409 pr " v = caml_alloc (1, 0);\n";
4410 pr " Store_field (v, 0, v2);\n";
4411 pr " } else /* None */\n";
4412 pr " v = Val_int (0);\n";
4414 pr " Store_field (rv, %d, v);\n" i
4416 pr " CAMLreturn (rv);\n";
4420 pr "static CAMLprim value\n";
4421 pr "copy_lvm_%s_list (const struct guestfs_lvm_%s_list *%ss)\n"
4424 pr " CAMLparam0 ();\n";
4425 pr " CAMLlocal2 (rv, v);\n";
4428 pr " if (%ss->len == 0)\n" typ;
4429 pr " CAMLreturn (Atom (0));\n";
4431 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
4432 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
4433 pr " v = copy_lvm_%s (&%ss->val[i]);\n" typ typ;
4434 pr " caml_modify (&Field (rv, i), v);\n";
4436 pr " CAMLreturn (rv);\n";
4440 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
4442 (* Stat copy functions. *)
4445 pr "static CAMLprim value\n";
4446 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
4448 pr " CAMLparam0 ();\n";
4449 pr " CAMLlocal2 (rv, v);\n";
4451 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
4456 pr " v = caml_copy_int64 (%s->%s);\n" typ name
4458 pr " Store_field (rv, %d, v);\n" i
4460 pr " CAMLreturn (rv);\n";
4463 ) ["stat", stat_cols; "statvfs", statvfs_cols];
4467 fun (name, style, _, _, _, _, _) ->
4469 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
4471 pr "CAMLprim value\n";
4472 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
4473 List.iter (pr ", value %s") (List.tl params);
4478 | [p1; p2; p3; p4; p5] ->
4479 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
4480 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
4481 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
4482 pr " CAMLxparam%d (%s);\n"
4483 (List.length rest) (String.concat ", " rest)
4485 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
4487 pr " CAMLlocal1 (rv);\n";
4490 pr " guestfs_h *g = Guestfs_val (gv);\n";
4491 pr " if (g == NULL)\n";
4492 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
4500 pr " const char *%s = String_val (%sv);\n" n n
4502 pr " const char *%s =\n" n;
4503 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
4506 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
4508 pr " int %s = Bool_val (%sv);\n" n n
4510 pr " int %s = Int_val (%sv);\n" n n
4513 match fst style with
4514 | RErr -> pr " int r;\n"; "-1"
4515 | RInt _ -> pr " int r;\n"; "-1"
4516 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4517 | RBool _ -> pr " int r;\n"; "-1"
4518 | RConstString _ -> pr " const char *r;\n"; "NULL"
4519 | RString _ -> pr " char *r;\n"; "NULL"
4525 pr " struct guestfs_int_bool *r;\n"; "NULL"
4527 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
4529 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
4531 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
4533 pr " struct guestfs_stat *r;\n"; "NULL"
4535 pr " struct guestfs_statvfs *r;\n"; "NULL"
4542 pr " caml_enter_blocking_section ();\n";
4543 pr " r = guestfs_%s " name;
4544 generate_call_args ~handle:"g" (snd style);
4546 pr " caml_leave_blocking_section ();\n";
4551 pr " ocaml_guestfs_free_strings (%s);\n" n;
4552 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
4555 pr " if (r == %s)\n" error_code;
4556 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
4559 (match fst style with
4560 | RErr -> pr " rv = Val_unit;\n"
4561 | RInt _ -> pr " rv = Val_int (r);\n"
4563 pr " rv = caml_copy_int64 (r);\n"
4564 | RBool _ -> pr " rv = Val_bool (r);\n"
4565 | RConstString _ -> pr " rv = caml_copy_string (r);\n"
4567 pr " rv = caml_copy_string (r);\n";
4570 pr " rv = caml_copy_string_array ((const char **) r);\n";
4571 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
4574 pr " rv = caml_alloc (2, 0);\n";
4575 pr " Store_field (rv, 0, Val_int (r->i));\n";
4576 pr " Store_field (rv, 1, Val_bool (r->b));\n";
4577 pr " guestfs_free_int_bool (r);\n";
4579 pr " rv = copy_lvm_pv_list (r);\n";
4580 pr " guestfs_free_lvm_pv_list (r);\n";
4582 pr " rv = copy_lvm_vg_list (r);\n";
4583 pr " guestfs_free_lvm_vg_list (r);\n";
4585 pr " rv = copy_lvm_lv_list (r);\n";
4586 pr " guestfs_free_lvm_lv_list (r);\n";
4588 pr " rv = copy_stat (r);\n";
4591 pr " rv = copy_statvfs (r);\n";
4594 pr " rv = copy_table (r);\n";
4595 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
4599 pr " CAMLreturn (rv);\n";
4603 if List.length params > 5 then (
4604 pr "CAMLprim value\n";
4605 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
4607 pr " return ocaml_guestfs_%s (argv[0]" name;
4608 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
4615 and generate_ocaml_lvm_structure_decls () =
4618 pr "type lvm_%s = {\n" typ;
4621 | name, `String -> pr " %s : string;\n" name
4622 | name, `UUID -> pr " %s : string;\n" name
4623 | name, `Bytes -> pr " %s : int64;\n" name
4624 | name, `Int -> pr " %s : int64;\n" name
4625 | name, `OptPercent -> pr " %s : float option;\n" name
4629 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
4631 and generate_ocaml_stat_structure_decls () =
4634 pr "type %s = {\n" typ;
4637 | name, `Int -> pr " %s : int64;\n" name
4641 ) ["stat", stat_cols; "statvfs", statvfs_cols]
4643 and generate_ocaml_prototype ?(is_external = false) name style =
4644 if is_external then pr "external " else pr "val ";
4645 pr "%s : t -> " name;
4648 | String _ | FileIn _ | FileOut _ -> pr "string -> "
4649 | OptString _ -> pr "string option -> "
4650 | StringList _ -> pr "string array -> "
4651 | Bool _ -> pr "bool -> "
4652 | Int _ -> pr "int -> "
4654 (match fst style with
4655 | RErr -> pr "unit" (* all errors are turned into exceptions *)
4656 | RInt _ -> pr "int"
4657 | RInt64 _ -> pr "int64"
4658 | RBool _ -> pr "bool"
4659 | RConstString _ -> pr "string"
4660 | RString _ -> pr "string"
4661 | RStringList _ -> pr "string array"
4662 | RIntBool _ -> pr "int * bool"
4663 | RPVList _ -> pr "lvm_pv array"
4664 | RVGList _ -> pr "lvm_vg array"
4665 | RLVList _ -> pr "lvm_lv array"
4666 | RStat _ -> pr "stat"
4667 | RStatVFS _ -> pr "statvfs"
4668 | RHashtable _ -> pr "(string * string) list"
4670 if is_external then (
4672 if List.length (snd style) + 1 > 5 then
4673 pr "\"ocaml_guestfs_%s_byte\" " name;
4674 pr "\"ocaml_guestfs_%s\"" name
4678 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
4679 and generate_perl_xs () =
4680 generate_header CStyle LGPLv2;
4683 #include \"EXTERN.h\"
4687 #include <guestfs.h>
4690 #define PRId64 \"lld\"
4694 my_newSVll(long long val) {
4695 #ifdef USE_64_BIT_ALL
4696 return newSViv(val);
4700 len = snprintf(buf, 100, \"%%\" PRId64, val);
4701 return newSVpv(buf, len);
4706 #define PRIu64 \"llu\"
4710 my_newSVull(unsigned long long val) {
4711 #ifdef USE_64_BIT_ALL
4712 return newSVuv(val);
4716 len = snprintf(buf, 100, \"%%\" PRIu64, val);
4717 return newSVpv(buf, len);
4721 /* http://www.perlmonks.org/?node_id=680842 */
4723 XS_unpack_charPtrPtr (SV *arg) {
4728 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
4729 croak (\"array reference expected\");
4731 av = (AV *)SvRV (arg);
4732 ret = malloc (av_len (av) + 1 + 1);
4734 croak (\"malloc failed\");
4736 for (i = 0; i <= av_len (av); i++) {
4737 SV **elem = av_fetch (av, i, 0);
4739 if (!elem || !*elem)
4740 croak (\"missing element in list\");
4742 ret[i] = SvPV_nolen (*elem);
4750 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
4755 RETVAL = guestfs_create ();
4757 croak (\"could not create guestfs handle\");
4758 guestfs_set_error_handler (RETVAL, NULL, NULL);
4771 fun (name, style, _, _, _, _, _) ->
4772 (match fst style with
4773 | RErr -> pr "void\n"
4774 | RInt _ -> pr "SV *\n"
4775 | RInt64 _ -> pr "SV *\n"
4776 | RBool _ -> pr "SV *\n"
4777 | RConstString _ -> pr "SV *\n"
4778 | RString _ -> pr "SV *\n"
4781 | RPVList _ | RVGList _ | RLVList _
4782 | RStat _ | RStatVFS _
4784 pr "void\n" (* all lists returned implictly on the stack *)
4786 (* Call and arguments. *)
4788 generate_call_args ~handle:"g" (snd style);
4790 pr " guestfs_h *g;\n";
4793 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
4794 | OptString n -> pr " char *%s;\n" n
4795 | StringList n -> pr " char **%s;\n" n
4796 | Bool n -> pr " int %s;\n" n
4797 | Int n -> pr " int %s;\n" n
4800 let do_cleanups () =
4803 | String _ | OptString _ | Bool _ | Int _
4804 | FileIn _ | FileOut _ -> ()
4805 | StringList n -> pr " free (%s);\n" n
4810 (match fst style with
4815 pr " r = guestfs_%s " name;
4816 generate_call_args ~handle:"g" (snd style);
4819 pr " if (r == -1)\n";
4820 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4826 pr " %s = guestfs_%s " n name;
4827 generate_call_args ~handle:"g" (snd style);
4830 pr " if (%s == -1)\n" n;
4831 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4832 pr " RETVAL = newSViv (%s);\n" n;
4837 pr " int64_t %s;\n" n;
4839 pr " %s = guestfs_%s " n name;
4840 generate_call_args ~handle:"g" (snd style);
4843 pr " if (%s == -1)\n" n;
4844 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4845 pr " RETVAL = my_newSVll (%s);\n" n;
4850 pr " const char *%s;\n" n;
4852 pr " %s = guestfs_%s " n name;
4853 generate_call_args ~handle:"g" (snd style);
4856 pr " if (%s == NULL)\n" n;
4857 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4858 pr " RETVAL = newSVpv (%s, 0);\n" n;
4863 pr " char *%s;\n" n;
4865 pr " %s = guestfs_%s " n name;
4866 generate_call_args ~handle:"g" (snd style);
4869 pr " if (%s == NULL)\n" n;
4870 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4871 pr " RETVAL = newSVpv (%s, 0);\n" n;
4872 pr " free (%s);\n" n;
4875 | RStringList n | RHashtable n ->
4877 pr " char **%s;\n" n;
4880 pr " %s = guestfs_%s " n name;
4881 generate_call_args ~handle:"g" (snd style);
4884 pr " if (%s == NULL)\n" n;
4885 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4886 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
4887 pr " EXTEND (SP, n);\n";
4888 pr " for (i = 0; i < n; ++i) {\n";
4889 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
4890 pr " free (%s[i]);\n" n;
4892 pr " free (%s);\n" n;
4895 pr " struct guestfs_int_bool *r;\n";
4897 pr " r = guestfs_%s " name;
4898 generate_call_args ~handle:"g" (snd style);
4901 pr " if (r == NULL)\n";
4902 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4903 pr " EXTEND (SP, 2);\n";
4904 pr " PUSHs (sv_2mortal (newSViv (r->i)));\n";
4905 pr " PUSHs (sv_2mortal (newSViv (r->b)));\n";
4906 pr " guestfs_free_int_bool (r);\n";
4908 generate_perl_lvm_code "pv" pv_cols name style n do_cleanups
4910 generate_perl_lvm_code "vg" vg_cols name style n do_cleanups
4912 generate_perl_lvm_code "lv" lv_cols name style n do_cleanups
4914 generate_perl_stat_code "stat" stat_cols name style n do_cleanups
4916 generate_perl_stat_code
4917 "statvfs" statvfs_cols name style n do_cleanups
4923 and generate_perl_lvm_code typ cols name style n do_cleanups =
4925 pr " struct guestfs_lvm_%s_list *%s;\n" typ n;
4929 pr " %s = guestfs_%s " n name;
4930 generate_call_args ~handle:"g" (snd style);
4933 pr " if (%s == NULL)\n" n;
4934 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4935 pr " EXTEND (SP, %s->len);\n" n;
4936 pr " for (i = 0; i < %s->len; ++i) {\n" n;
4937 pr " hv = newHV ();\n";
4941 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
4942 name (String.length name) n name
4944 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
4945 name (String.length name) n name
4947 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
4948 name (String.length name) n name
4950 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
4951 name (String.length name) n name
4952 | name, `OptPercent ->
4953 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
4954 name (String.length name) n name
4956 pr " PUSHs (sv_2mortal ((SV *) hv));\n";
4958 pr " guestfs_free_lvm_%s_list (%s);\n" typ n
4960 and generate_perl_stat_code typ cols name style n do_cleanups =
4962 pr " struct guestfs_%s *%s;\n" typ n;
4964 pr " %s = guestfs_%s " n name;
4965 generate_call_args ~handle:"g" (snd style);
4968 pr " if (%s == NULL)\n" n;
4969 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4970 pr " EXTEND (SP, %d);\n" (List.length cols);
4974 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n" n name
4976 pr " free (%s);\n" n
4978 (* Generate Sys/Guestfs.pm. *)
4979 and generate_perl_pm () =
4980 generate_header HashStyle LGPLv2;
4987 Sys::Guestfs - Perl bindings for libguestfs
4993 my $h = Sys::Guestfs->new ();
4994 $h->add_drive ('guest.img');
4997 $h->mount ('/dev/sda1', '/');
4998 $h->touch ('/hello');
5003 The C<Sys::Guestfs> module provides a Perl XS binding to the
5004 libguestfs API for examining and modifying virtual machine
5007 Amongst the things this is good for: making batch configuration
5008 changes to guests, getting disk used/free statistics (see also:
5009 virt-df), migrating between virtualization systems (see also:
5010 virt-p2v), performing partial backups, performing partial guest
5011 clones, cloning guests and changing registry/UUID/hostname info, and
5014 Libguestfs uses Linux kernel and qemu code, and can access any type of
5015 guest filesystem that Linux and qemu can, including but not limited
5016 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
5017 schemes, qcow, qcow2, vmdk.
5019 Libguestfs provides ways to enumerate guest storage (eg. partitions,
5020 LVs, what filesystem is in each LV, etc.). It can also run commands
5021 in the context of the guest. Also you can access filesystems over FTP.
5025 All errors turn into calls to C<croak> (see L<Carp(3)>).
5033 package Sys::Guestfs;
5039 XSLoader::load ('Sys::Guestfs');
5041 =item $h = Sys::Guestfs->new ();
5043 Create a new guestfs handle.
5049 my $class = ref ($proto) || $proto;
5051 my $self = Sys::Guestfs::_create ();
5052 bless $self, $class;
5058 (* Actions. We only need to print documentation for these as
5059 * they are pulled in from the XS code automatically.
5062 fun (name, style, _, flags, _, _, longdesc) ->
5063 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
5065 generate_perl_prototype name style;
5067 pr "%s\n\n" longdesc;
5068 if List.mem ProtocolLimitWarning flags then
5069 pr "%s\n\n" protocol_limit_warning;
5070 if List.mem DangerWillRobinson flags then
5071 pr "%s\n\n" danger_will_robinson
5072 ) all_functions_sorted;
5084 Copyright (C) 2009 Red Hat Inc.
5088 Please see the file COPYING.LIB for the full license.
5092 L<guestfs(3)>, L<guestfish(1)>.
5097 and generate_perl_prototype name style =
5098 (match fst style with
5104 | RString n -> pr "$%s = " n
5105 | RIntBool (n, m) -> pr "($%s, $%s) = " n m
5109 | RLVList n -> pr "@%s = " n
5112 | RHashtable n -> pr "%%%s = " n
5115 let comma = ref false in
5118 if !comma then pr ", ";
5121 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
5128 (* Generate Python C module. *)
5129 and generate_python_c () =
5130 generate_header CStyle LGPLv2;
5139 #include \"guestfs.h\"
5147 get_handle (PyObject *obj)
5150 assert (obj != Py_None);
5151 return ((Pyguestfs_Object *) obj)->g;
5155 put_handle (guestfs_h *g)
5159 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
5162 /* This list should be freed (but not the strings) after use. */
5163 static const char **
5164 get_string_list (PyObject *obj)
5171 if (!PyList_Check (obj)) {
5172 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
5176 len = PyList_Size (obj);
5177 r = malloc (sizeof (char *) * (len+1));
5179 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
5183 for (i = 0; i < len; ++i)
5184 r[i] = PyString_AsString (PyList_GetItem (obj, i));
5191 put_string_list (char * const * const argv)
5196 for (argc = 0; argv[argc] != NULL; ++argc)
5199 list = PyList_New (argc);
5200 for (i = 0; i < argc; ++i)
5201 PyList_SetItem (list, i, PyString_FromString (argv[i]));
5207 put_table (char * const * const argv)
5209 PyObject *list, *item;
5212 for (argc = 0; argv[argc] != NULL; ++argc)
5215 list = PyList_New (argc >> 1);
5216 for (i = 0; i < argc; i += 2) {
5217 item = PyTuple_New (2);
5218 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
5219 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
5220 PyList_SetItem (list, i >> 1, item);
5227 free_strings (char **argv)
5231 for (argc = 0; argv[argc] != NULL; ++argc)
5237 py_guestfs_create (PyObject *self, PyObject *args)
5241 g = guestfs_create ();
5243 PyErr_SetString (PyExc_RuntimeError,
5244 \"guestfs.create: failed to allocate handle\");
5247 guestfs_set_error_handler (g, NULL, NULL);
5248 return put_handle (g);
5252 py_guestfs_close (PyObject *self, PyObject *args)
5257 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
5259 g = get_handle (py_g);
5263 Py_INCREF (Py_None);
5269 (* LVM structures, turned into Python dictionaries. *)
5272 pr "static PyObject *\n";
5273 pr "put_lvm_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
5275 pr " PyObject *dict;\n";
5277 pr " dict = PyDict_New ();\n";
5281 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5282 pr " PyString_FromString (%s->%s));\n"
5285 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5286 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
5289 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5290 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
5293 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5294 pr " PyLong_FromLongLong (%s->%s));\n"
5296 | name, `OptPercent ->
5297 pr " if (%s->%s >= 0)\n" typ name;
5298 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5299 pr " PyFloat_FromDouble ((double) %s->%s));\n"
5302 pr " Py_INCREF (Py_None);\n";
5303 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
5306 pr " return dict;\n";
5310 pr "static PyObject *\n";
5311 pr "put_lvm_%s_list (struct guestfs_lvm_%s_list *%ss)\n" typ typ typ;
5313 pr " PyObject *list;\n";
5316 pr " list = PyList_New (%ss->len);\n" typ;
5317 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
5318 pr " PyList_SetItem (list, i, put_lvm_%s (&%ss->val[i]));\n" typ typ;
5319 pr " return list;\n";
5322 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
5324 (* Stat structures, turned into Python dictionaries. *)
5327 pr "static PyObject *\n";
5328 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
5330 pr " PyObject *dict;\n";
5332 pr " dict = PyDict_New ();\n";
5336 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5337 pr " PyLong_FromLongLong (%s->%s));\n"
5340 pr " return dict;\n";
5343 ) ["stat", stat_cols; "statvfs", statvfs_cols];
5345 (* Python wrapper functions. *)
5347 fun (name, style, _, _, _, _, _) ->
5348 pr "static PyObject *\n";
5349 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
5352 pr " PyObject *py_g;\n";
5353 pr " guestfs_h *g;\n";
5354 pr " PyObject *py_r;\n";
5357 match fst style with
5358 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5359 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5360 | RConstString _ -> pr " const char *r;\n"; "NULL"
5361 | RString _ -> pr " char *r;\n"; "NULL"
5362 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5363 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
5364 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5365 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5366 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5367 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
5368 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
5372 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
5373 | OptString n -> pr " const char *%s;\n" n
5375 pr " PyObject *py_%s;\n" n;
5376 pr " const char **%s;\n" n
5377 | Bool n -> pr " int %s;\n" n
5378 | Int n -> pr " int %s;\n" n
5383 (* Convert the parameters. *)
5384 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
5387 | String _ | FileIn _ | FileOut _ -> pr "s"
5388 | OptString _ -> pr "z"
5389 | StringList _ -> pr "O"
5390 | Bool _ -> pr "i" (* XXX Python has booleans? *)
5393 pr ":guestfs_%s\",\n" name;
5397 | String n | FileIn n | FileOut n -> pr ", &%s" n
5398 | OptString n -> pr ", &%s" n
5399 | StringList n -> pr ", &py_%s" n
5400 | Bool n -> pr ", &%s" n
5401 | Int n -> pr ", &%s" n
5405 pr " return NULL;\n";
5407 pr " g = get_handle (py_g);\n";
5410 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5412 pr " %s = get_string_list (py_%s);\n" n n;
5413 pr " if (!%s) return NULL;\n" n
5418 pr " r = guestfs_%s " name;
5419 generate_call_args ~handle:"g" (snd style);
5424 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5426 pr " free (%s);\n" n
5429 pr " if (r == %s) {\n" error_code;
5430 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
5431 pr " return NULL;\n";
5435 (match fst style with
5437 pr " Py_INCREF (Py_None);\n";
5438 pr " py_r = Py_None;\n"
5440 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
5441 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
5442 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
5444 pr " py_r = PyString_FromString (r);\n";
5447 pr " py_r = put_string_list (r);\n";
5448 pr " free_strings (r);\n"
5450 pr " py_r = PyTuple_New (2);\n";
5451 pr " PyTuple_SetItem (py_r, 0, PyInt_FromLong ((long) r->i));\n";
5452 pr " PyTuple_SetItem (py_r, 1, PyInt_FromLong ((long) r->b));\n";
5453 pr " guestfs_free_int_bool (r);\n"
5455 pr " py_r = put_lvm_pv_list (r);\n";
5456 pr " guestfs_free_lvm_pv_list (r);\n"
5458 pr " py_r = put_lvm_vg_list (r);\n";
5459 pr " guestfs_free_lvm_vg_list (r);\n"
5461 pr " py_r = put_lvm_lv_list (r);\n";
5462 pr " guestfs_free_lvm_lv_list (r);\n"
5464 pr " py_r = put_stat (r);\n";
5467 pr " py_r = put_statvfs (r);\n";
5470 pr " py_r = put_table (r);\n";
5471 pr " free_strings (r);\n"
5474 pr " return py_r;\n";
5479 (* Table of functions. *)
5480 pr "static PyMethodDef methods[] = {\n";
5481 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
5482 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
5484 fun (name, _, _, _, _, _, _) ->
5485 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
5488 pr " { NULL, NULL, 0, NULL }\n";
5492 (* Init function. *)
5495 initlibguestfsmod (void)
5497 static int initialized = 0;
5499 if (initialized) return;
5500 Py_InitModule ((char *) \"libguestfsmod\", methods);
5505 (* Generate Python module. *)
5506 and generate_python_py () =
5507 generate_header HashStyle LGPLv2;
5510 u\"\"\"Python bindings for libguestfs
5513 g = guestfs.GuestFS ()
5514 g.add_drive (\"guest.img\")
5517 parts = g.list_partitions ()
5519 The guestfs module provides a Python binding to the libguestfs API
5520 for examining and modifying virtual machine disk images.
5522 Amongst the things this is good for: making batch configuration
5523 changes to guests, getting disk used/free statistics (see also:
5524 virt-df), migrating between virtualization systems (see also:
5525 virt-p2v), performing partial backups, performing partial guest
5526 clones, cloning guests and changing registry/UUID/hostname info, and
5529 Libguestfs uses Linux kernel and qemu code, and can access any type of
5530 guest filesystem that Linux and qemu can, including but not limited
5531 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
5532 schemes, qcow, qcow2, vmdk.
5534 Libguestfs provides ways to enumerate guest storage (eg. partitions,
5535 LVs, what filesystem is in each LV, etc.). It can also run commands
5536 in the context of the guest. Also you can access filesystems over FTP.
5538 Errors which happen while using the API are turned into Python
5539 RuntimeError exceptions.
5541 To create a guestfs handle you usually have to perform the following
5544 # Create the handle, call add_drive at least once, and possibly
5545 # several times if the guest has multiple block devices:
5546 g = guestfs.GuestFS ()
5547 g.add_drive (\"guest.img\")
5549 # Launch the qemu subprocess and wait for it to become ready:
5553 # Now you can issue commands, for example:
5558 import libguestfsmod
5561 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
5563 def __init__ (self):
5564 \"\"\"Create a new libguestfs handle.\"\"\"
5565 self._o = libguestfsmod.create ()
5568 libguestfsmod.close (self._o)
5573 fun (name, style, _, flags, _, _, longdesc) ->
5574 let doc = replace_str longdesc "C<guestfs_" "C<g." in
5576 match fst style with
5577 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _
5580 doc ^ "\n\nThis function returns a list of strings."
5582 doc ^ "\n\nThis function returns a tuple (int, bool).\n"
5584 doc ^ "\n\nThis function returns a list of PVs. Each PV is represented as a dictionary."
5586 doc ^ "\n\nThis function returns a list of VGs. Each VG is represented as a dictionary."
5588 doc ^ "\n\nThis function returns a list of LVs. Each LV is represented as a dictionary."
5590 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the stat structure."
5592 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the statvfs structure."
5594 doc ^ "\n\nThis function returns a dictionary." in
5596 if List.mem ProtocolLimitWarning flags then
5597 doc ^ "\n\n" ^ protocol_limit_warning
5600 if List.mem DangerWillRobinson flags then
5601 doc ^ "\n\n" ^ danger_will_robinson
5603 let doc = pod2text ~width:60 name doc in
5604 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
5605 let doc = String.concat "\n " doc in
5608 generate_call_args ~handle:"self" (snd style);
5610 pr " u\"\"\"%s\"\"\"\n" doc;
5611 pr " return libguestfsmod.%s " name;
5612 generate_call_args ~handle:"self._o" (snd style);
5617 (* Useful if you need the longdesc POD text as plain text. Returns a
5620 * This is the slowest thing about autogeneration.
5622 and pod2text ~width name longdesc =
5623 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
5624 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
5626 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
5627 let chan = Unix.open_process_in cmd in
5628 let lines = ref [] in
5630 let line = input_line chan in
5631 if i = 1 then (* discard the first line of output *)
5634 let line = triml line in
5635 lines := line :: !lines;
5638 let lines = try loop 1 with End_of_file -> List.rev !lines in
5639 Unix.unlink filename;
5640 match Unix.close_process_in chan with
5641 | Unix.WEXITED 0 -> lines
5643 failwithf "pod2text: process exited with non-zero status (%d)" i
5644 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
5645 failwithf "pod2text: process signalled or stopped by signal %d" i
5647 (* Generate ruby bindings. *)
5648 and generate_ruby_c () =
5649 generate_header CStyle LGPLv2;
5657 #include \"guestfs.h\"
5659 #include \"extconf.h\"
5661 static VALUE m_guestfs; /* guestfs module */
5662 static VALUE c_guestfs; /* guestfs_h handle */
5663 static VALUE e_Error; /* used for all errors */
5665 static void ruby_guestfs_free (void *p)
5668 guestfs_close ((guestfs_h *) p);
5671 static VALUE ruby_guestfs_create (VALUE m)
5675 g = guestfs_create ();
5677 rb_raise (e_Error, \"failed to create guestfs handle\");
5679 /* Don't print error messages to stderr by default. */
5680 guestfs_set_error_handler (g, NULL, NULL);
5682 /* Wrap it, and make sure the close function is called when the
5685 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
5688 static VALUE ruby_guestfs_close (VALUE gv)
5691 Data_Get_Struct (gv, guestfs_h, g);
5693 ruby_guestfs_free (g);
5694 DATA_PTR (gv) = NULL;
5702 fun (name, style, _, _, _, _, _) ->
5703 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
5704 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
5707 pr " guestfs_h *g;\n";
5708 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
5710 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
5716 | String n | FileIn n | FileOut n ->
5717 pr " const char *%s = StringValueCStr (%sv);\n" n n;
5719 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
5720 pr " \"%s\", \"%s\");\n" n name
5722 pr " const char *%s = StringValueCStr (%sv);\n" n n
5726 pr " int i, len;\n";
5727 pr " len = RARRAY_LEN (%sv);\n" n;
5728 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
5730 pr " for (i = 0; i < len; ++i) {\n";
5731 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
5732 pr " %s[i] = StringValueCStr (v);\n" n;
5734 pr " %s[len] = NULL;\n" n;
5738 pr " int %s = NUM2INT (%sv);\n" n n
5743 match fst style with
5744 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5745 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5746 | RConstString _ -> pr " const char *r;\n"; "NULL"
5747 | RString _ -> pr " char *r;\n"; "NULL"
5748 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5749 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
5750 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5751 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5752 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5753 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
5754 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
5757 pr " r = guestfs_%s " name;
5758 generate_call_args ~handle:"g" (snd style);
5763 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5765 pr " free (%s);\n" n
5768 pr " if (r == %s)\n" error_code;
5769 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
5772 (match fst style with
5774 pr " return Qnil;\n"
5775 | RInt _ | RBool _ ->
5776 pr " return INT2NUM (r);\n"
5778 pr " return ULL2NUM (r);\n"
5780 pr " return rb_str_new2 (r);\n";
5782 pr " VALUE rv = rb_str_new2 (r);\n";
5786 pr " int i, len = 0;\n";
5787 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
5788 pr " VALUE rv = rb_ary_new2 (len);\n";
5789 pr " for (i = 0; r[i] != NULL; ++i) {\n";
5790 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
5791 pr " free (r[i]);\n";
5796 pr " VALUE rv = rb_ary_new2 (2);\n";
5797 pr " rb_ary_push (rv, INT2NUM (r->i));\n";
5798 pr " rb_ary_push (rv, INT2NUM (r->b));\n";
5799 pr " guestfs_free_int_bool (r);\n";
5802 generate_ruby_lvm_code "pv" pv_cols
5804 generate_ruby_lvm_code "vg" vg_cols
5806 generate_ruby_lvm_code "lv" lv_cols
5808 pr " VALUE rv = rb_hash_new ();\n";
5812 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
5817 pr " VALUE rv = rb_hash_new ();\n";
5821 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
5826 pr " VALUE rv = rb_hash_new ();\n";
5828 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
5829 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
5830 pr " free (r[i]);\n";
5831 pr " free (r[i+1]);\n";
5842 /* Initialize the module. */
5843 void Init__guestfs ()
5845 m_guestfs = rb_define_module (\"Guestfs\");
5846 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
5847 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
5849 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
5850 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
5853 (* Define the rest of the methods. *)
5855 fun (name, style, _, _, _, _, _) ->
5856 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
5857 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
5862 (* Ruby code to return an LVM struct list. *)
5863 and generate_ruby_lvm_code typ cols =
5864 pr " VALUE rv = rb_ary_new2 (r->len);\n";
5866 pr " for (i = 0; i < r->len; ++i) {\n";
5867 pr " VALUE hv = rb_hash_new ();\n";
5871 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
5873 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
5876 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
5877 | name, `OptPercent ->
5878 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
5880 pr " rb_ary_push (rv, hv);\n";
5882 pr " guestfs_free_lvm_%s_list (r);\n" typ;
5885 (* Generate Java bindings GuestFS.java file. *)
5886 and generate_java_java () =
5887 generate_header CStyle LGPLv2;
5890 package com.redhat.et.libguestfs;
5892 import java.util.HashMap;
5893 import com.redhat.et.libguestfs.LibGuestFSException;
5894 import com.redhat.et.libguestfs.PV;
5895 import com.redhat.et.libguestfs.VG;
5896 import com.redhat.et.libguestfs.LV;
5897 import com.redhat.et.libguestfs.Stat;
5898 import com.redhat.et.libguestfs.StatVFS;
5899 import com.redhat.et.libguestfs.IntBool;
5902 * The GuestFS object is a libguestfs handle.
5906 public class GuestFS {
5907 // Load the native code.
5909 System.loadLibrary (\"guestfs_jni\");
5913 * The native guestfs_h pointer.
5918 * Create a libguestfs handle.
5920 * @throws LibGuestFSException
5922 public GuestFS () throws LibGuestFSException
5926 private native long _create () throws LibGuestFSException;
5929 * Close a libguestfs handle.
5931 * You can also leave handles to be collected by the garbage
5932 * collector, but this method ensures that the resources used
5933 * by the handle are freed up immediately. If you call any
5934 * other methods after closing the handle, you will get an
5937 * @throws LibGuestFSException
5939 public void close () throws LibGuestFSException
5945 private native void _close (long g) throws LibGuestFSException;
5947 public void finalize () throws LibGuestFSException
5955 fun (name, style, _, flags, _, shortdesc, longdesc) ->
5956 let doc = replace_str longdesc "C<guestfs_" "C<g." in
5958 if List.mem ProtocolLimitWarning flags then
5959 doc ^ "\n\n" ^ protocol_limit_warning
5962 if List.mem DangerWillRobinson flags then
5963 doc ^ "\n\n" ^ danger_will_robinson
5965 let doc = pod2text ~width:60 name doc in
5966 let doc = String.concat "\n * " doc in
5969 pr " * %s\n" shortdesc;
5972 pr " * @throws LibGuestFSException\n";
5975 generate_java_prototype ~public:true ~semicolon:false name style;
5978 pr " if (g == 0)\n";
5979 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
5982 if fst style <> RErr then pr "return ";
5984 generate_call_args ~handle:"g" (snd style);
5988 generate_java_prototype ~privat:true ~native:true name style;
5995 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
5996 ?(semicolon=true) name style =
5997 if privat then pr "private ";
5998 if public then pr "public ";
5999 if native then pr "native ";
6002 (match fst style with
6003 | RErr -> pr "void ";
6004 | RInt _ -> pr "int ";
6005 | RInt64 _ -> pr "long ";
6006 | RBool _ -> pr "boolean ";
6007 | RConstString _ | RString _ -> pr "String ";
6008 | RStringList _ -> pr "String[] ";
6009 | RIntBool _ -> pr "IntBool ";
6010 | RPVList _ -> pr "PV[] ";
6011 | RVGList _ -> pr "VG[] ";
6012 | RLVList _ -> pr "LV[] ";
6013 | RStat _ -> pr "Stat ";
6014 | RStatVFS _ -> pr "StatVFS ";
6015 | RHashtable _ -> pr "HashMap<String,String> ";
6018 if native then pr "_%s " name else pr "%s " name;
6020 let needs_comma = ref false in
6029 if !needs_comma then pr ", ";
6030 needs_comma := true;
6047 pr " throws LibGuestFSException";
6048 if semicolon then pr ";"
6050 and generate_java_struct typ cols =
6051 generate_header CStyle LGPLv2;
6054 package com.redhat.et.libguestfs;
6057 * Libguestfs %s structure.
6068 | name, `UUID -> pr " public String %s;\n" name
6070 | name, `Int -> pr " public long %s;\n" name
6071 | name, `OptPercent ->
6072 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
6073 pr " public float %s;\n" name
6078 and generate_java_c () =
6079 generate_header CStyle LGPLv2;
6086 #include \"com_redhat_et_libguestfs_GuestFS.h\"
6087 #include \"guestfs.h\"
6089 /* Note that this function returns. The exception is not thrown
6090 * until after the wrapper function returns.
6093 throw_exception (JNIEnv *env, const char *msg)
6096 cl = (*env)->FindClass (env,
6097 \"com/redhat/et/libguestfs/LibGuestFSException\");
6098 (*env)->ThrowNew (env, cl, msg);
6101 JNIEXPORT jlong JNICALL
6102 Java_com_redhat_et_libguestfs_GuestFS__1create
6103 (JNIEnv *env, jobject obj)
6107 g = guestfs_create ();
6109 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
6112 guestfs_set_error_handler (g, NULL, NULL);
6113 return (jlong) (long) g;
6116 JNIEXPORT void JNICALL
6117 Java_com_redhat_et_libguestfs_GuestFS__1close
6118 (JNIEnv *env, jobject obj, jlong jg)
6120 guestfs_h *g = (guestfs_h *) (long) jg;
6127 fun (name, style, _, _, _, _, _) ->
6129 (match fst style with
6130 | RErr -> pr "void ";
6131 | RInt _ -> pr "jint ";
6132 | RInt64 _ -> pr "jlong ";
6133 | RBool _ -> pr "jboolean ";
6134 | RConstString _ | RString _ -> pr "jstring ";
6135 | RIntBool _ | RStat _ | RStatVFS _ | RHashtable _ ->
6137 | RStringList _ | RPVList _ | RVGList _ | RLVList _ ->
6141 pr "Java_com_redhat_et_libguestfs_GuestFS_";
6142 pr "%s" (replace_str ("_" ^ name) "_" "_1");
6144 pr " (JNIEnv *env, jobject obj, jlong jg";
6151 pr ", jstring j%s" n
6153 pr ", jobjectArray j%s" n
6155 pr ", jboolean j%s" n
6161 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
6162 let error_code, no_ret =
6163 match fst style with
6164 | RErr -> pr " int r;\n"; "-1", ""
6166 | RInt _ -> pr " int r;\n"; "-1", "0"
6167 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
6168 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
6170 pr " jstring jr;\n";
6171 pr " char *r;\n"; "NULL", "NULL"
6173 pr " jobjectArray jr;\n";
6176 pr " jstring jstr;\n";
6177 pr " char **r;\n"; "NULL", "NULL"
6179 pr " jobject jr;\n";
6181 pr " jfieldID fl;\n";
6182 pr " struct guestfs_int_bool *r;\n"; "NULL", "NULL"
6184 pr " jobject jr;\n";
6186 pr " jfieldID fl;\n";
6187 pr " struct guestfs_stat *r;\n"; "NULL", "NULL"
6189 pr " jobject jr;\n";
6191 pr " jfieldID fl;\n";
6192 pr " struct guestfs_statvfs *r;\n"; "NULL", "NULL"
6194 pr " jobjectArray jr;\n";
6196 pr " jfieldID fl;\n";
6197 pr " jobject jfl;\n";
6198 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL", "NULL"
6200 pr " jobjectArray jr;\n";
6202 pr " jfieldID fl;\n";
6203 pr " jobject jfl;\n";
6204 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL", "NULL"
6206 pr " jobjectArray jr;\n";
6208 pr " jfieldID fl;\n";
6209 pr " jobject jfl;\n";
6210 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL", "NULL"
6211 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL" in
6218 pr " const char *%s;\n" n
6220 pr " int %s_len;\n" n;
6221 pr " const char **%s;\n" n
6228 (match fst style with
6229 | RStringList _ | RPVList _ | RVGList _ | RLVList _ -> true
6230 | RErr _ | RBool _ | RInt _ | RInt64 _ | RConstString _
6231 | RString _ | RIntBool _ | RStat _ | RStatVFS _
6232 | RHashtable _ -> false) ||
6233 List.exists (function StringList _ -> true | _ -> false) (snd style) in
6239 (* Get the parameters. *)
6246 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
6248 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
6249 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
6250 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6251 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6253 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
6255 pr " %s[%s_len] = NULL;\n" n n;
6258 pr " %s = j%s;\n" n n
6261 (* Make the call. *)
6262 pr " r = guestfs_%s " name;
6263 generate_call_args ~handle:"g" (snd style);
6266 (* Release the parameters. *)
6273 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
6275 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6276 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6278 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
6280 pr " free (%s);\n" n
6285 (* Check for errors. *)
6286 pr " if (r == %s) {\n" error_code;
6287 pr " throw_exception (env, guestfs_last_error (g));\n";
6288 pr " return %s;\n" no_ret;
6292 (match fst style with
6294 | RInt _ -> pr " return (jint) r;\n"
6295 | RBool _ -> pr " return (jboolean) r;\n"
6296 | RInt64 _ -> pr " return (jlong) r;\n"
6297 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
6299 pr " jr = (*env)->NewStringUTF (env, r);\n";
6303 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
6304 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
6305 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
6306 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
6307 pr " for (i = 0; i < r_len; ++i) {\n";
6308 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
6309 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
6310 pr " free (r[i]);\n";
6315 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/IntBool\");\n";
6316 pr " jr = (*env)->AllocObject (env, cl);\n";
6317 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"I\");\n";
6318 pr " (*env)->SetIntField (env, jr, fl, r->i);\n";
6319 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"Z\");\n";
6320 pr " (*env)->SetBooleanField (env, jr, fl, r->b);\n";
6321 pr " guestfs_free_int_bool (r);\n";
6324 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/Stat\");\n";
6325 pr " jr = (*env)->AllocObject (env, cl);\n";
6329 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
6331 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
6336 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/StatVFS\");\n";
6337 pr " jr = (*env)->AllocObject (env, cl);\n";
6341 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
6343 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
6348 generate_java_lvm_return "pv" "PV" pv_cols
6350 generate_java_lvm_return "vg" "VG" vg_cols
6352 generate_java_lvm_return "lv" "LV" lv_cols
6355 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
6356 pr " return NULL;\n"
6363 and generate_java_lvm_return typ jtyp cols =
6364 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
6365 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
6366 pr " for (i = 0; i < r->len; ++i) {\n";
6367 pr " jfl = (*env)->AllocObject (env, cl);\n";
6371 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
6372 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
6375 pr " char s[33];\n";
6376 pr " memcpy (s, r->val[i].%s, 32);\n" name;
6378 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
6379 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
6381 | name, (`Bytes|`Int) ->
6382 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
6383 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
6384 | name, `OptPercent ->
6385 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
6386 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
6388 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
6390 pr " guestfs_free_lvm_%s_list (r);\n" typ;
6393 let output_to filename =
6394 let filename_new = filename ^ ".new" in
6395 chan := open_out filename_new;
6400 (* Is the new file different from the current file? *)
6401 if Sys.file_exists filename && files_equal filename filename_new then
6402 Unix.unlink filename_new (* same, so skip it *)
6404 (* different, overwrite old one *)
6405 (try Unix.chmod filename 0o644 with Unix.Unix_error _ -> ());
6406 Unix.rename filename_new filename;
6407 Unix.chmod filename 0o444;
6408 printf "written %s\n%!" filename;
6417 if not (Sys.file_exists "configure.ac") then (
6419 You are probably running this from the wrong directory.
6420 Run it from the top source directory using the command
6426 let close = output_to "src/guestfs_protocol.x" in
6430 let close = output_to "src/guestfs-structs.h" in
6431 generate_structs_h ();
6434 let close = output_to "src/guestfs-actions.h" in
6435 generate_actions_h ();
6438 let close = output_to "src/guestfs-actions.c" in
6439 generate_client_actions ();
6442 let close = output_to "daemon/actions.h" in
6443 generate_daemon_actions_h ();
6446 let close = output_to "daemon/stubs.c" in
6447 generate_daemon_actions ();
6450 let close = output_to "tests.c" in
6454 let close = output_to "fish/cmds.c" in
6455 generate_fish_cmds ();
6458 let close = output_to "fish/completion.c" in
6459 generate_fish_completion ();
6462 let close = output_to "guestfs-structs.pod" in
6463 generate_structs_pod ();
6466 let close = output_to "guestfs-actions.pod" in
6467 generate_actions_pod ();
6470 let close = output_to "guestfish-actions.pod" in
6471 generate_fish_actions_pod ();
6474 let close = output_to "ocaml/guestfs.mli" in
6475 generate_ocaml_mli ();
6478 let close = output_to "ocaml/guestfs.ml" in
6479 generate_ocaml_ml ();
6482 let close = output_to "ocaml/guestfs_c_actions.c" in
6483 generate_ocaml_c ();
6486 let close = output_to "perl/Guestfs.xs" in
6487 generate_perl_xs ();
6490 let close = output_to "perl/lib/Sys/Guestfs.pm" in
6491 generate_perl_pm ();
6494 let close = output_to "python/guestfs-py.c" in
6495 generate_python_c ();
6498 let close = output_to "python/guestfs.py" in
6499 generate_python_py ();
6502 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
6506 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
6507 generate_java_java ();
6510 let close = output_to "java/com/redhat/et/libguestfs/PV.java" in
6511 generate_java_struct "PV" pv_cols;
6514 let close = output_to "java/com/redhat/et/libguestfs/VG.java" in
6515 generate_java_struct "VG" vg_cols;
6518 let close = output_to "java/com/redhat/et/libguestfs/LV.java" in
6519 generate_java_struct "LV" lv_cols;
6522 let close = output_to "java/com/redhat/et/libguestfs/Stat.java" in
6523 generate_java_struct "Stat" stat_cols;
6526 let close = output_to "java/com/redhat/et/libguestfs/StatVFS.java" in
6527 generate_java_struct "StatVFS" statvfs_cols;
6530 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in