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.");
1779 ("equal", (RBool "equality", [String "file1"; String "file2"]), 93, [],
1780 [InitBasicFS, TestOutputTrue (
1781 [["write_file"; "/file1"; "contents of a file"; "0"];
1782 ["cp"; "/file1"; "/file2"];
1783 ["equal"; "/file1"; "/file2"]]);
1784 InitBasicFS, TestOutputFalse (
1785 [["write_file"; "/file1"; "contents of a file"; "0"];
1786 ["write_file"; "/file2"; "contents of another file"; "0"];
1787 ["equal"; "/file1"; "/file2"]]);
1788 InitBasicFS, TestLastFail (
1789 [["equal"; "/file1"; "/file2"]])],
1790 "test if two files have equal contents",
1792 This compares the two files C<file1> and C<file2> and returns
1793 true if their content is exactly equal, or false otherwise.
1795 The external L<cmp(1)> program is used for the comparison.");
1799 let all_functions = non_daemon_functions @ daemon_functions
1801 (* In some places we want the functions to be displayed sorted
1802 * alphabetically, so this is useful:
1804 let all_functions_sorted =
1805 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
1806 compare n1 n2) all_functions
1808 (* Column names and types from LVM PVs/VGs/LVs. *)
1817 "pv_attr", `String (* XXX *);
1818 "pv_pe_count", `Int;
1819 "pv_pe_alloc_count", `Int;
1822 "pv_mda_count", `Int;
1823 "pv_mda_free", `Bytes;
1824 (* Not in Fedora 10:
1825 "pv_mda_size", `Bytes;
1832 "vg_attr", `String (* XXX *);
1835 "vg_sysid", `String;
1836 "vg_extent_size", `Bytes;
1837 "vg_extent_count", `Int;
1838 "vg_free_count", `Int;
1846 "vg_mda_count", `Int;
1847 "vg_mda_free", `Bytes;
1848 (* Not in Fedora 10:
1849 "vg_mda_size", `Bytes;
1855 "lv_attr", `String (* XXX *);
1858 "lv_kernel_major", `Int;
1859 "lv_kernel_minor", `Int;
1863 "snap_percent", `OptPercent;
1864 "copy_percent", `OptPercent;
1867 "mirror_log", `String;
1871 (* Column names and types from stat structures.
1872 * NB. Can't use things like 'st_atime' because glibc header files
1873 * define some of these as macros. Ugh.
1890 let statvfs_cols = [
1904 (* Useful functions.
1905 * Note we don't want to use any external OCaml libraries which
1906 * makes this a bit harder than it should be.
1908 let failwithf fs = ksprintf failwith fs
1910 let replace_char s c1 c2 =
1911 let s2 = String.copy s in
1912 let r = ref false in
1913 for i = 0 to String.length s2 - 1 do
1914 if String.unsafe_get s2 i = c1 then (
1915 String.unsafe_set s2 i c2;
1919 if not !r then s else s2
1923 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
1925 let triml ?(test = isspace) str =
1927 let n = ref (String.length str) in
1928 while !n > 0 && test str.[!i]; do
1933 else String.sub str !i !n
1935 let trimr ?(test = isspace) str =
1936 let n = ref (String.length str) in
1937 while !n > 0 && test str.[!n-1]; do
1940 if !n = String.length str then str
1941 else String.sub str 0 !n
1943 let trim ?(test = isspace) str =
1944 trimr ~test (triml ~test str)
1946 let rec find s sub =
1947 let len = String.length s in
1948 let sublen = String.length sub in
1950 if i <= len-sublen then (
1952 if j < sublen then (
1953 if s.[i+j] = sub.[j] then loop2 (j+1)
1959 if r = -1 then loop (i+1) else r
1965 let rec replace_str s s1 s2 =
1966 let len = String.length s in
1967 let sublen = String.length s1 in
1968 let i = find s s1 in
1971 let s' = String.sub s 0 i in
1972 let s'' = String.sub s (i+sublen) (len-i-sublen) in
1973 s' ^ s2 ^ replace_str s'' s1 s2
1976 let rec string_split sep str =
1977 let len = String.length str in
1978 let seplen = String.length sep in
1979 let i = find str sep in
1980 if i = -1 then [str]
1982 let s' = String.sub str 0 i in
1983 let s'' = String.sub str (i+seplen) (len-i-seplen) in
1984 s' :: string_split sep s''
1987 let files_equal n1 n2 =
1988 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
1989 match Sys.command cmd with
1992 | i -> failwithf "%s: failed with error code %d" cmd i
1994 let rec find_map f = function
1995 | [] -> raise Not_found
1999 | None -> find_map f xs
2002 let rec loop i = function
2004 | x :: xs -> f i x; loop (i+1) xs
2009 let rec loop i = function
2011 | x :: xs -> let r = f i x in r :: loop (i+1) xs
2015 let name_of_argt = function
2016 | String n | OptString n | StringList n | Bool n | Int n
2017 | FileIn n | FileOut n -> n
2019 let seq_of_test = function
2020 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
2021 | TestOutputInt (s, _) | TestOutputTrue s | TestOutputFalse s
2022 | TestOutputLength (s, _) | TestOutputStruct (s, _)
2023 | TestLastFail s -> s
2025 (* Check function names etc. for consistency. *)
2026 let check_functions () =
2027 let contains_uppercase str =
2028 let len = String.length str in
2030 if i >= len then false
2033 if c >= 'A' && c <= 'Z' then true
2040 (* Check function names. *)
2042 fun (name, _, _, _, _, _, _) ->
2043 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
2044 failwithf "function name %s does not need 'guestfs' prefix" name;
2045 if contains_uppercase name then
2046 failwithf "function name %s should not contain uppercase chars" name;
2047 if String.contains name '-' then
2048 failwithf "function name %s should not contain '-', use '_' instead."
2052 (* Check function parameter/return names. *)
2054 fun (name, style, _, _, _, _, _) ->
2055 let check_arg_ret_name n =
2056 if contains_uppercase n then
2057 failwithf "%s param/ret %s should not contain uppercase chars"
2059 if String.contains n '-' || String.contains n '_' then
2060 failwithf "%s param/ret %s should not contain '-' or '_'"
2063 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;
2064 if n = "argv" || n = "args" then
2065 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" n
2068 (match fst style with
2070 | RInt n | RInt64 n | RBool n | RConstString n | RString n
2071 | RStringList n | RPVList n | RVGList n | RLVList n
2072 | RStat n | RStatVFS n
2074 check_arg_ret_name n
2076 check_arg_ret_name n;
2077 check_arg_ret_name m
2079 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
2082 (* Check short descriptions. *)
2084 fun (name, _, _, _, _, shortdesc, _) ->
2085 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
2086 failwithf "short description of %s should begin with lowercase." name;
2087 let c = shortdesc.[String.length shortdesc-1] in
2088 if c = '\n' || c = '.' then
2089 failwithf "short description of %s should not end with . or \\n." name
2092 (* Check long dscriptions. *)
2094 fun (name, _, _, _, _, _, longdesc) ->
2095 if longdesc.[String.length longdesc-1] = '\n' then
2096 failwithf "long description of %s should not end with \\n." name
2099 (* Check proc_nrs. *)
2101 fun (name, _, proc_nr, _, _, _, _) ->
2102 if proc_nr <= 0 then
2103 failwithf "daemon function %s should have proc_nr > 0" name
2107 fun (name, _, proc_nr, _, _, _, _) ->
2108 if proc_nr <> -1 then
2109 failwithf "non-daemon function %s should have proc_nr -1" name
2110 ) non_daemon_functions;
2113 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
2116 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
2117 let rec loop = function
2120 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
2122 | (name1,nr1) :: (name2,nr2) :: _ ->
2123 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
2131 (* Ignore functions that have no tests. We generate a
2132 * warning when the user does 'make check' instead.
2134 | name, _, _, _, [], _, _ -> ()
2135 | name, _, _, _, tests, _, _ ->
2139 match seq_of_test test with
2141 failwithf "%s has a test containing an empty sequence" name
2142 | cmds -> List.map List.hd cmds
2144 let funcs = List.flatten funcs in
2146 let tested = List.mem name funcs in
2149 failwithf "function %s has tests but does not test itself" name
2152 (* 'pr' prints to the current output file. *)
2153 let chan = ref stdout
2154 let pr fs = ksprintf (output_string !chan) fs
2156 (* Generate a header block in a number of standard styles. *)
2157 type comment_style = CStyle | HashStyle | OCamlStyle
2158 type license = GPLv2 | LGPLv2
2160 let generate_header comment license =
2161 let c = match comment with
2162 | CStyle -> pr "/* "; " *"
2163 | HashStyle -> pr "# "; "#"
2164 | OCamlStyle -> pr "(* "; " *" in
2165 pr "libguestfs generated file\n";
2166 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
2167 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
2169 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
2173 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
2174 pr "%s it under the terms of the GNU General Public License as published by\n" c;
2175 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
2176 pr "%s (at your option) any later version.\n" c;
2178 pr "%s This program is distributed in the hope that it will be useful,\n" c;
2179 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2180 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
2181 pr "%s GNU General Public License for more details.\n" c;
2183 pr "%s You should have received a copy of the GNU General Public License along\n" c;
2184 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
2185 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
2188 pr "%s This library is free software; you can redistribute it and/or\n" c;
2189 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
2190 pr "%s License as published by the Free Software Foundation; either\n" c;
2191 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
2193 pr "%s This library is distributed in the hope that it will be useful,\n" c;
2194 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2195 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
2196 pr "%s Lesser General Public License for more details.\n" c;
2198 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
2199 pr "%s License along with this library; if not, write to the Free Software\n" c;
2200 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
2203 | CStyle -> pr " */\n"
2205 | OCamlStyle -> pr " *)\n"
2209 (* Start of main code generation functions below this line. *)
2211 (* Generate the pod documentation for the C API. *)
2212 let rec generate_actions_pod () =
2214 fun (shortname, style, _, flags, _, _, longdesc) ->
2215 let name = "guestfs_" ^ shortname in
2216 pr "=head2 %s\n\n" name;
2218 generate_prototype ~extern:false ~handle:"handle" name style;
2220 pr "%s\n\n" longdesc;
2221 (match fst style with
2223 pr "This function returns 0 on success or -1 on error.\n\n"
2225 pr "On error this function returns -1.\n\n"
2227 pr "On error this function returns -1.\n\n"
2229 pr "This function returns a C truth value on success or -1 on error.\n\n"
2231 pr "This function returns a string, or NULL on error.
2232 The string is owned by the guest handle and must I<not> be freed.\n\n"
2234 pr "This function returns a string, or NULL on error.
2235 I<The caller must free the returned string after use>.\n\n"
2237 pr "This function returns a NULL-terminated array of strings
2238 (like L<environ(3)>), or NULL if there was an error.
2239 I<The caller must free the strings and the array after use>.\n\n"
2241 pr "This function returns a C<struct guestfs_int_bool *>,
2242 or NULL if there was an error.
2243 I<The caller must call C<guestfs_free_int_bool> after use>.\n\n"
2245 pr "This function returns a C<struct guestfs_lvm_pv_list *>
2246 (see E<lt>guestfs-structs.hE<gt>),
2247 or NULL if there was an error.
2248 I<The caller must call C<guestfs_free_lvm_pv_list> after use>.\n\n"
2250 pr "This function returns a C<struct guestfs_lvm_vg_list *>
2251 (see E<lt>guestfs-structs.hE<gt>),
2252 or NULL if there was an error.
2253 I<The caller must call C<guestfs_free_lvm_vg_list> after use>.\n\n"
2255 pr "This function returns a C<struct guestfs_lvm_lv_list *>
2256 (see E<lt>guestfs-structs.hE<gt>),
2257 or NULL if there was an error.
2258 I<The caller must call C<guestfs_free_lvm_lv_list> after use>.\n\n"
2260 pr "This function returns a C<struct guestfs_stat *>
2261 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
2262 or NULL if there was an error.
2263 I<The caller must call C<free> after use>.\n\n"
2265 pr "This function returns a C<struct guestfs_statvfs *>
2266 (see L<statvfs(2)> and E<lt>guestfs-structs.hE<gt>),
2267 or NULL if there was an error.
2268 I<The caller must call C<free> after use>.\n\n"
2270 pr "This function returns a NULL-terminated array of
2271 strings, or NULL if there was an error.
2272 The array of strings will always have length C<2n+1>, where
2273 C<n> keys and values alternate, followed by the trailing NULL entry.
2274 I<The caller must free the strings and the array after use>.\n\n"
2276 if List.mem ProtocolLimitWarning flags then
2277 pr "%s\n\n" protocol_limit_warning;
2278 if List.mem DangerWillRobinson flags then
2279 pr "%s\n\n" danger_will_robinson;
2280 ) all_functions_sorted
2282 and generate_structs_pod () =
2283 (* LVM structs documentation. *)
2286 pr "=head2 guestfs_lvm_%s\n" typ;
2288 pr " struct guestfs_lvm_%s {\n" typ;
2291 | name, `String -> pr " char *%s;\n" name
2293 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
2294 pr " char %s[32];\n" name
2295 | name, `Bytes -> pr " uint64_t %s;\n" name
2296 | name, `Int -> pr " int64_t %s;\n" name
2297 | name, `OptPercent ->
2298 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
2299 pr " float %s;\n" name
2302 pr " struct guestfs_lvm_%s_list {\n" typ;
2303 pr " uint32_t len; /* Number of elements in list. */\n";
2304 pr " struct guestfs_lvm_%s *val; /* Elements. */\n" typ;
2307 pr " void guestfs_free_lvm_%s_list (struct guestfs_free_lvm_%s_list *);\n"
2310 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
2312 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
2313 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
2315 * We have to use an underscore instead of a dash because otherwise
2316 * rpcgen generates incorrect code.
2318 * This header is NOT exported to clients, but see also generate_structs_h.
2320 and generate_xdr () =
2321 generate_header CStyle LGPLv2;
2323 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
2324 pr "typedef string str<>;\n";
2327 (* LVM internal structures. *)
2331 pr "struct guestfs_lvm_int_%s {\n" typ;
2333 | name, `String -> pr " string %s<>;\n" name
2334 | name, `UUID -> pr " opaque %s[32];\n" name
2335 | name, `Bytes -> pr " hyper %s;\n" name
2336 | name, `Int -> pr " hyper %s;\n" name
2337 | name, `OptPercent -> pr " float %s;\n" name
2341 pr "typedef struct guestfs_lvm_int_%s guestfs_lvm_int_%s_list<>;\n" typ typ;
2343 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2345 (* Stat internal structures. *)
2349 pr "struct guestfs_int_%s {\n" typ;
2351 | name, `Int -> pr " hyper %s;\n" name
2355 ) ["stat", stat_cols; "statvfs", statvfs_cols];
2358 fun (shortname, style, _, _, _, _, _) ->
2359 let name = "guestfs_" ^ shortname in
2361 (match snd style with
2364 pr "struct %s_args {\n" name;
2367 | String n -> pr " string %s<>;\n" n
2368 | OptString n -> pr " str *%s;\n" n
2369 | StringList n -> pr " str %s<>;\n" n
2370 | Bool n -> pr " bool %s;\n" n
2371 | Int n -> pr " int %s;\n" n
2372 | FileIn _ | FileOut _ -> ()
2376 (match fst style with
2379 pr "struct %s_ret {\n" name;
2383 pr "struct %s_ret {\n" name;
2384 pr " hyper %s;\n" n;
2387 pr "struct %s_ret {\n" name;
2391 failwithf "RConstString cannot be returned from a daemon function"
2393 pr "struct %s_ret {\n" name;
2394 pr " string %s<>;\n" n;
2397 pr "struct %s_ret {\n" name;
2398 pr " str %s<>;\n" n;
2401 pr "struct %s_ret {\n" name;
2406 pr "struct %s_ret {\n" name;
2407 pr " guestfs_lvm_int_pv_list %s;\n" n;
2410 pr "struct %s_ret {\n" name;
2411 pr " guestfs_lvm_int_vg_list %s;\n" n;
2414 pr "struct %s_ret {\n" name;
2415 pr " guestfs_lvm_int_lv_list %s;\n" n;
2418 pr "struct %s_ret {\n" name;
2419 pr " guestfs_int_stat %s;\n" n;
2422 pr "struct %s_ret {\n" name;
2423 pr " guestfs_int_statvfs %s;\n" n;
2426 pr "struct %s_ret {\n" name;
2427 pr " str %s<>;\n" n;
2432 (* Table of procedure numbers. *)
2433 pr "enum guestfs_procedure {\n";
2435 fun (shortname, _, proc_nr, _, _, _, _) ->
2436 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
2438 pr " GUESTFS_PROC_NR_PROCS\n";
2442 (* Having to choose a maximum message size is annoying for several
2443 * reasons (it limits what we can do in the API), but it (a) makes
2444 * the protocol a lot simpler, and (b) provides a bound on the size
2445 * of the daemon which operates in limited memory space. For large
2446 * file transfers you should use FTP.
2448 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
2451 (* Message header, etc. *)
2453 /* The communication protocol is now documented in the guestfs(3)
2457 const GUESTFS_PROGRAM = 0x2000F5F5;
2458 const GUESTFS_PROTOCOL_VERSION = 1;
2460 /* These constants must be larger than any possible message length. */
2461 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
2462 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
2464 enum guestfs_message_direction {
2465 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
2466 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
2469 enum guestfs_message_status {
2470 GUESTFS_STATUS_OK = 0,
2471 GUESTFS_STATUS_ERROR = 1
2474 const GUESTFS_ERROR_LEN = 256;
2476 struct guestfs_message_error {
2477 string error_message<GUESTFS_ERROR_LEN>;
2480 struct guestfs_message_header {
2481 unsigned prog; /* GUESTFS_PROGRAM */
2482 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
2483 guestfs_procedure proc; /* GUESTFS_PROC_x */
2484 guestfs_message_direction direction;
2485 unsigned serial; /* message serial number */
2486 guestfs_message_status status;
2489 const GUESTFS_MAX_CHUNK_SIZE = 8192;
2491 struct guestfs_chunk {
2492 int cancel; /* if non-zero, transfer is cancelled */
2493 /* data size is 0 bytes if the transfer has finished successfully */
2494 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
2498 (* Generate the guestfs-structs.h file. *)
2499 and generate_structs_h () =
2500 generate_header CStyle LGPLv2;
2502 (* This is a public exported header file containing various
2503 * structures. The structures are carefully written to have
2504 * exactly the same in-memory format as the XDR structures that
2505 * we use on the wire to the daemon. The reason for creating
2506 * copies of these structures here is just so we don't have to
2507 * export the whole of guestfs_protocol.h (which includes much
2508 * unrelated and XDR-dependent stuff that we don't want to be
2509 * public, or required by clients).
2511 * To reiterate, we will pass these structures to and from the
2512 * client with a simple assignment or memcpy, so the format
2513 * must be identical to what rpcgen / the RFC defines.
2516 (* guestfs_int_bool structure. *)
2517 pr "struct guestfs_int_bool {\n";
2523 (* LVM public structures. *)
2527 pr "struct guestfs_lvm_%s {\n" typ;
2530 | name, `String -> pr " char *%s;\n" name
2531 | name, `UUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
2532 | name, `Bytes -> pr " uint64_t %s;\n" name
2533 | name, `Int -> pr " int64_t %s;\n" name
2534 | name, `OptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
2538 pr "struct guestfs_lvm_%s_list {\n" typ;
2539 pr " uint32_t len;\n";
2540 pr " struct guestfs_lvm_%s *val;\n" typ;
2543 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2545 (* Stat structures. *)
2549 pr "struct guestfs_%s {\n" typ;
2552 | name, `Int -> pr " int64_t %s;\n" name
2556 ) ["stat", stat_cols; "statvfs", statvfs_cols]
2558 (* Generate the guestfs-actions.h file. *)
2559 and generate_actions_h () =
2560 generate_header CStyle LGPLv2;
2562 fun (shortname, style, _, _, _, _, _) ->
2563 let name = "guestfs_" ^ shortname in
2564 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
2568 (* Generate the client-side dispatch stubs. *)
2569 and generate_client_actions () =
2570 generate_header CStyle LGPLv2;
2576 #include \"guestfs.h\"
2577 #include \"guestfs_protocol.h\"
2579 #define error guestfs_error
2580 #define perrorf guestfs_perrorf
2581 #define safe_malloc guestfs_safe_malloc
2582 #define safe_realloc guestfs_safe_realloc
2583 #define safe_strdup guestfs_safe_strdup
2584 #define safe_memdup guestfs_safe_memdup
2586 /* Check the return message from a call for validity. */
2588 check_reply_header (guestfs_h *g,
2589 const struct guestfs_message_header *hdr,
2590 int proc_nr, int serial)
2592 if (hdr->prog != GUESTFS_PROGRAM) {
2593 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
2596 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
2597 error (g, \"wrong protocol version (%%d/%%d)\",
2598 hdr->vers, GUESTFS_PROTOCOL_VERSION);
2601 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
2602 error (g, \"unexpected message direction (%%d/%%d)\",
2603 hdr->direction, GUESTFS_DIRECTION_REPLY);
2606 if (hdr->proc != proc_nr) {
2607 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
2610 if (hdr->serial != serial) {
2611 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
2618 /* Check we are in the right state to run a high-level action. */
2620 check_state (guestfs_h *g, const char *caller)
2622 if (!guestfs_is_ready (g)) {
2623 if (guestfs_is_config (g))
2624 error (g, \"%%s: call launch() before using this function\",
2626 else if (guestfs_is_launching (g))
2627 error (g, \"%%s: call wait_ready() before using this function\",
2630 error (g, \"%%s called from the wrong state, %%d != READY\",
2631 caller, guestfs_get_state (g));
2639 (* Client-side stubs for each function. *)
2641 fun (shortname, style, _, _, _, _, _) ->
2642 let name = "guestfs_" ^ shortname in
2644 (* Generate the context struct which stores the high-level
2645 * state between callback functions.
2647 pr "struct %s_ctx {\n" shortname;
2648 pr " /* This flag is set by the callbacks, so we know we've done\n";
2649 pr " * the callbacks as expected, and in the right sequence.\n";
2650 pr " * 0 = not called, 1 = reply_cb called.\n";
2652 pr " int cb_sequence;\n";
2653 pr " struct guestfs_message_header hdr;\n";
2654 pr " struct guestfs_message_error err;\n";
2655 (match fst style with
2658 failwithf "RConstString cannot be returned from a daemon function"
2660 | RBool _ | RString _ | RStringList _
2662 | RPVList _ | RVGList _ | RLVList _
2663 | RStat _ | RStatVFS _
2665 pr " struct %s_ret ret;\n" name
2670 (* Generate the reply callback function. *)
2671 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
2673 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
2674 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
2676 pr " /* This should definitely not happen. */\n";
2677 pr " if (ctx->cb_sequence != 0) {\n";
2678 pr " ctx->cb_sequence = 9999;\n";
2679 pr " error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
2683 pr " ml->main_loop_quit (ml, g);\n";
2685 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
2686 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
2689 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
2690 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
2691 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
2698 (match fst style with
2701 failwithf "RConstString cannot be returned from a daemon function"
2703 | RBool _ | RString _ | RStringList _
2705 | RPVList _ | RVGList _ | RLVList _
2706 | RStat _ | RStatVFS _
2708 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
2709 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
2715 pr " ctx->cb_sequence = 1;\n";
2718 (* Generate the action stub. *)
2719 generate_prototype ~extern:false ~semicolon:false ~newline:true
2720 ~handle:"g" name style;
2723 match fst style with
2724 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
2726 failwithf "RConstString cannot be returned from a daemon function"
2727 | RString _ | RStringList _ | RIntBool _
2728 | RPVList _ | RVGList _ | RLVList _
2729 | RStat _ | RStatVFS _
2735 (match snd style with
2737 | _ -> pr " struct %s_args args;\n" name
2740 pr " struct %s_ctx ctx;\n" shortname;
2741 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
2742 pr " int serial;\n";
2744 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
2745 pr " guestfs_set_busy (g);\n";
2747 pr " memset (&ctx, 0, sizeof ctx);\n";
2750 (* Send the main header and arguments. *)
2751 (match snd style with
2753 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
2754 (String.uppercase shortname)
2759 pr " args.%s = (char *) %s;\n" n n
2761 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
2763 pr " args.%s.%s_val = (char **) %s;\n" n n n;
2764 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
2766 pr " args.%s = %s;\n" n n
2768 pr " args.%s = %s;\n" n n
2769 | FileIn _ | FileOut _ -> ()
2771 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
2772 (String.uppercase shortname);
2773 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
2776 pr " if (serial == -1) {\n";
2777 pr " guestfs_set_ready (g);\n";
2778 pr " return %s;\n" error_code;
2782 (* Send any additional files (FileIn) requested. *)
2783 let need_read_reply_label = ref false in
2790 pr " r = guestfs__send_file_sync (g, %s);\n" n;
2791 pr " if (r == -1) {\n";
2792 pr " guestfs_set_ready (g);\n";
2793 pr " return %s;\n" error_code;
2795 pr " if (r == -2) /* daemon cancelled */\n";
2796 pr " goto read_reply;\n";
2797 need_read_reply_label := true;
2803 (* Wait for the reply from the remote end. *)
2804 if !need_read_reply_label then pr " read_reply:\n";
2805 pr " guestfs__switch_to_receiving (g);\n";
2806 pr " ctx.cb_sequence = 0;\n";
2807 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
2808 pr " (void) ml->main_loop_run (ml, g);\n";
2809 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
2810 pr " if (ctx.cb_sequence != 1) {\n";
2811 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
2812 pr " guestfs_set_ready (g);\n";
2813 pr " return %s;\n" error_code;
2817 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
2818 (String.uppercase shortname);
2819 pr " guestfs_set_ready (g);\n";
2820 pr " return %s;\n" error_code;
2824 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
2825 pr " error (g, \"%%s\", ctx.err.error_message);\n";
2826 pr " guestfs_set_ready (g);\n";
2827 pr " return %s;\n" error_code;
2831 (* Expecting to receive further files (FileOut)? *)
2835 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
2836 pr " guestfs_set_ready (g);\n";
2837 pr " return %s;\n" error_code;
2843 pr " guestfs_set_ready (g);\n";
2845 (match fst style with
2846 | RErr -> pr " return 0;\n"
2847 | RInt n | RInt64 n | RBool n ->
2848 pr " return ctx.ret.%s;\n" n
2850 failwithf "RConstString cannot be returned from a daemon function"
2852 pr " return ctx.ret.%s; /* caller will free */\n" n
2853 | RStringList n | RHashtable n ->
2854 pr " /* caller will free this, but we need to add a NULL entry */\n";
2855 pr " ctx.ret.%s.%s_val =\n" n n;
2856 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
2857 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
2859 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
2860 pr " return ctx.ret.%s.%s_val;\n" n n
2862 pr " /* caller with free this */\n";
2863 pr " return safe_memdup (g, &ctx.ret, sizeof (ctx.ret));\n"
2864 | RPVList n | RVGList n | RLVList n
2865 | RStat n | RStatVFS n ->
2866 pr " /* caller will free this */\n";
2867 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
2873 (* Generate daemon/actions.h. *)
2874 and generate_daemon_actions_h () =
2875 generate_header CStyle GPLv2;
2877 pr "#include \"../src/guestfs_protocol.h\"\n";
2881 fun (name, style, _, _, _, _, _) ->
2883 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
2887 (* Generate the server-side stubs. *)
2888 and generate_daemon_actions () =
2889 generate_header CStyle GPLv2;
2891 pr "#include <config.h>\n";
2893 pr "#include <stdio.h>\n";
2894 pr "#include <stdlib.h>\n";
2895 pr "#include <string.h>\n";
2896 pr "#include <inttypes.h>\n";
2897 pr "#include <ctype.h>\n";
2898 pr "#include <rpc/types.h>\n";
2899 pr "#include <rpc/xdr.h>\n";
2901 pr "#include \"daemon.h\"\n";
2902 pr "#include \"../src/guestfs_protocol.h\"\n";
2903 pr "#include \"actions.h\"\n";
2907 fun (name, style, _, _, _, _, _) ->
2908 (* Generate server-side stubs. *)
2909 pr "static void %s_stub (XDR *xdr_in)\n" name;
2912 match fst style with
2913 | RErr | RInt _ -> pr " int r;\n"; "-1"
2914 | RInt64 _ -> pr " int64_t r;\n"; "-1"
2915 | RBool _ -> pr " int r;\n"; "-1"
2917 failwithf "RConstString cannot be returned from a daemon function"
2918 | RString _ -> pr " char *r;\n"; "NULL"
2919 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
2920 | RIntBool _ -> pr " guestfs_%s_ret *r;\n" name; "NULL"
2921 | RPVList _ -> pr " guestfs_lvm_int_pv_list *r;\n"; "NULL"
2922 | RVGList _ -> pr " guestfs_lvm_int_vg_list *r;\n"; "NULL"
2923 | RLVList _ -> pr " guestfs_lvm_int_lv_list *r;\n"; "NULL"
2924 | RStat _ -> pr " guestfs_int_stat *r;\n"; "NULL"
2925 | RStatVFS _ -> pr " guestfs_int_statvfs *r;\n"; "NULL" in
2927 (match snd style with
2930 pr " struct guestfs_%s_args args;\n" name;
2934 | OptString n -> pr " const char *%s;\n" n
2935 | StringList n -> pr " char **%s;\n" n
2936 | Bool n -> pr " int %s;\n" n
2937 | Int n -> pr " int %s;\n" n
2938 | FileIn _ | FileOut _ -> ()
2943 (match snd style with
2946 pr " memset (&args, 0, sizeof args);\n";
2948 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
2949 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
2954 | String n -> pr " %s = args.%s;\n" n n
2955 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
2957 pr " %s = realloc (args.%s.%s_val,\n" n n n;
2958 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
2959 pr " if (%s == NULL) {\n" n;
2960 pr " reply_with_perror (\"realloc\");\n";
2963 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
2964 pr " args.%s.%s_val = %s;\n" n n n;
2965 | Bool n -> pr " %s = args.%s;\n" n n
2966 | Int n -> pr " %s = args.%s;\n" n n
2967 | FileIn _ | FileOut _ -> ()
2972 (* Don't want to call the impl with any FileIn or FileOut
2973 * parameters, since these go "outside" the RPC protocol.
2976 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
2978 pr " r = do_%s " name;
2979 generate_call_args argsnofile;
2982 pr " if (r == %s)\n" error_code;
2983 pr " /* do_%s has already called reply_with_error */\n" name;
2987 (* If there are any FileOut parameters, then the impl must
2988 * send its own reply.
2991 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
2993 pr " /* do_%s has already sent a reply */\n" name
2995 match fst style with
2996 | RErr -> pr " reply (NULL, NULL);\n"
2997 | RInt n | RInt64 n | RBool n ->
2998 pr " struct guestfs_%s_ret ret;\n" name;
2999 pr " ret.%s = r;\n" n;
3000 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3003 failwithf "RConstString cannot be returned from a daemon function"
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"
3010 | RStringList n | RHashtable n ->
3011 pr " struct guestfs_%s_ret ret;\n" name;
3012 pr " ret.%s.%s_len = count_strings (r);\n" n n;
3013 pr " ret.%s.%s_val = r;\n" n n;
3014 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3016 pr " free_strings (r);\n"
3018 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n"
3020 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n" name
3021 | RPVList n | RVGList n | RLVList n
3022 | RStat n | RStatVFS n ->
3023 pr " struct guestfs_%s_ret ret;\n" name;
3024 pr " ret.%s = *r;\n" n;
3025 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
3027 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
3031 (* Free the args. *)
3032 (match snd style with
3037 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
3044 (* Dispatch function. *)
3045 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
3047 pr " switch (proc_nr) {\n";
3050 fun (name, style, _, _, _, _, _) ->
3051 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
3052 pr " %s_stub (xdr_in);\n" name;
3057 pr " reply_with_error (\"dispatch_incoming_message: unknown procedure number %%d\", proc_nr);\n";
3062 (* LVM columns and tokenization functions. *)
3063 (* XXX This generates crap code. We should rethink how we
3069 pr "static const char *lvm_%s_cols = \"%s\";\n"
3070 typ (String.concat "," (List.map fst cols));
3073 pr "static int lvm_tokenize_%s (char *str, struct guestfs_lvm_int_%s *r)\n" typ typ;
3075 pr " char *tok, *p, *next;\n";
3079 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
3082 pr " if (!str) {\n";
3083 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
3086 pr " if (!*str || isspace (*str)) {\n";
3087 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
3092 fun (name, coltype) ->
3093 pr " if (!tok) {\n";
3094 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
3097 pr " p = strchrnul (tok, ',');\n";
3098 pr " if (*p) next = p+1; else next = NULL;\n";
3099 pr " *p = '\\0';\n";
3102 pr " r->%s = strdup (tok);\n" name;
3103 pr " if (r->%s == NULL) {\n" name;
3104 pr " perror (\"strdup\");\n";
3108 pr " for (i = j = 0; i < 32; ++j) {\n";
3109 pr " if (tok[j] == '\\0') {\n";
3110 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
3112 pr " } else if (tok[j] != '-')\n";
3113 pr " r->%s[i++] = tok[j];\n" name;
3116 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
3117 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3121 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
3122 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3126 pr " if (tok[0] == '\\0')\n";
3127 pr " r->%s = -1;\n" name;
3128 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
3129 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3133 pr " tok = next;\n";
3136 pr " if (tok != NULL) {\n";
3137 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
3144 pr "guestfs_lvm_int_%s_list *\n" typ;
3145 pr "parse_command_line_%ss (void)\n" typ;
3147 pr " char *out, *err;\n";
3148 pr " char *p, *pend;\n";
3150 pr " guestfs_lvm_int_%s_list *ret;\n" typ;
3151 pr " void *newp;\n";
3153 pr " ret = malloc (sizeof *ret);\n";
3154 pr " if (!ret) {\n";
3155 pr " reply_with_perror (\"malloc\");\n";
3156 pr " return NULL;\n";
3159 pr " ret->guestfs_lvm_int_%s_list_len = 0;\n" typ;
3160 pr " ret->guestfs_lvm_int_%s_list_val = NULL;\n" typ;
3162 pr " r = command (&out, &err,\n";
3163 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
3164 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
3165 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
3166 pr " if (r == -1) {\n";
3167 pr " reply_with_error (\"%%s\", err);\n";
3168 pr " free (out);\n";
3169 pr " free (err);\n";
3170 pr " free (ret);\n";
3171 pr " return NULL;\n";
3174 pr " free (err);\n";
3176 pr " /* Tokenize each line of the output. */\n";
3179 pr " while (p) {\n";
3180 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
3181 pr " if (pend) {\n";
3182 pr " *pend = '\\0';\n";
3186 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
3189 pr " if (!*p) { /* Empty line? Skip it. */\n";
3194 pr " /* Allocate some space to store this next entry. */\n";
3195 pr " newp = realloc (ret->guestfs_lvm_int_%s_list_val,\n" typ;
3196 pr " sizeof (guestfs_lvm_int_%s) * (i+1));\n" typ;
3197 pr " if (newp == NULL) {\n";
3198 pr " reply_with_perror (\"realloc\");\n";
3199 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3200 pr " free (ret);\n";
3201 pr " free (out);\n";
3202 pr " return NULL;\n";
3204 pr " ret->guestfs_lvm_int_%s_list_val = newp;\n" typ;
3206 pr " /* Tokenize the next entry. */\n";
3207 pr " r = lvm_tokenize_%s (p, &ret->guestfs_lvm_int_%s_list_val[i]);\n" typ typ;
3208 pr " if (r == -1) {\n";
3209 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
3210 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3211 pr " free (ret);\n";
3212 pr " free (out);\n";
3213 pr " return NULL;\n";
3220 pr " ret->guestfs_lvm_int_%s_list_len = i;\n" typ;
3222 pr " free (out);\n";
3223 pr " return ret;\n";
3226 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
3228 (* Generate the tests. *)
3229 and generate_tests () =
3230 generate_header CStyle GPLv2;
3237 #include <sys/types.h>
3240 #include \"guestfs.h\"
3242 static guestfs_h *g;
3243 static int suppress_error = 0;
3245 static void print_error (guestfs_h *g, void *data, const char *msg)
3247 if (!suppress_error)
3248 fprintf (stderr, \"%%s\\n\", msg);
3251 static void print_strings (char * const * const argv)
3255 for (argc = 0; argv[argc] != NULL; ++argc)
3256 printf (\"\\t%%s\\n\", argv[argc]);
3260 static void print_table (char * const * const argv)
3264 for (i = 0; argv[i] != NULL; i += 2)
3265 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
3269 static void no_test_warnings (void)
3275 | name, _, _, _, [], _, _ ->
3276 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
3277 | name, _, _, _, tests, _, _ -> ()
3283 (* Generate the actual tests. Note that we generate the tests
3284 * in reverse order, deliberately, so that (in general) the
3285 * newest tests run first. This makes it quicker and easier to
3290 fun (name, _, _, _, tests, _, _) ->
3291 mapi (generate_one_test name) tests
3292 ) (List.rev all_functions) in
3293 let test_names = List.concat test_names in
3294 let nr_tests = List.length test_names in
3297 int main (int argc, char *argv[])
3302 const char *filename;
3304 int nr_tests, test_num = 0;
3306 no_test_warnings ();
3308 g = guestfs_create ();
3310 printf (\"guestfs_create FAILED\\n\");
3314 guestfs_set_error_handler (g, print_error, NULL);
3316 srcdir = getenv (\"srcdir\");
3317 if (!srcdir) srcdir = \".\";
3319 guestfs_set_path (g, \".\");
3321 filename = \"test1.img\";
3322 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3327 if (lseek (fd, %d, SEEK_SET) == -1) {
3333 if (write (fd, &c, 1) == -1) {
3339 if (close (fd) == -1) {
3344 if (guestfs_add_drive (g, filename) == -1) {
3345 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3349 filename = \"test2.img\";
3350 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3355 if (lseek (fd, %d, SEEK_SET) == -1) {
3361 if (write (fd, &c, 1) == -1) {
3367 if (close (fd) == -1) {
3372 if (guestfs_add_drive (g, filename) == -1) {
3373 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3377 filename = \"test3.img\";
3378 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3383 if (lseek (fd, %d, SEEK_SET) == -1) {
3389 if (write (fd, &c, 1) == -1) {
3395 if (close (fd) == -1) {
3400 if (guestfs_add_drive (g, filename) == -1) {
3401 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3405 if (guestfs_launch (g) == -1) {
3406 printf (\"guestfs_launch FAILED\\n\");
3409 if (guestfs_wait_ready (g) == -1) {
3410 printf (\"guestfs_wait_ready FAILED\\n\");
3416 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
3420 pr " test_num++;\n";
3421 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
3422 pr " if (%s () == -1) {\n" test_name;
3423 pr " printf (\"%s FAILED\\n\");\n" test_name;
3429 pr " guestfs_close (g);\n";
3430 pr " unlink (\"test1.img\");\n";
3431 pr " unlink (\"test2.img\");\n";
3432 pr " unlink (\"test3.img\");\n";
3435 pr " if (failed > 0) {\n";
3436 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
3444 and generate_one_test name i (init, test) =
3445 let test_name = sprintf "test_%s_%d" name i in
3447 pr "static int %s (void)\n" test_name;
3453 pr " /* InitEmpty for %s (%d) */\n" name i;
3454 List.iter (generate_test_command_call test_name)
3458 pr " /* InitBasicFS for %s (%d): create ext2 on /dev/sda1 */\n" name i;
3459 List.iter (generate_test_command_call test_name)
3462 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
3463 ["mkfs"; "ext2"; "/dev/sda1"];
3464 ["mount"; "/dev/sda1"; "/"]]
3465 | InitBasicFSonLVM ->
3466 pr " /* InitBasicFSonLVM for %s (%d): create ext2 on /dev/VG/LV */\n"
3468 List.iter (generate_test_command_call test_name)
3471 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
3472 ["pvcreate"; "/dev/sda1"];
3473 ["vgcreate"; "VG"; "/dev/sda1"];
3474 ["lvcreate"; "LV"; "VG"; "8"];
3475 ["mkfs"; "ext2"; "/dev/VG/LV"];
3476 ["mount"; "/dev/VG/LV"; "/"]]
3479 let get_seq_last = function
3481 failwithf "%s: you cannot use [] (empty list) when expecting a command"
3484 let seq = List.rev seq in
3485 List.rev (List.tl seq), List.hd seq
3490 pr " /* TestRun for %s (%d) */\n" name i;
3491 List.iter (generate_test_command_call test_name) seq
3492 | TestOutput (seq, expected) ->
3493 pr " /* TestOutput for %s (%d) */\n" name i;
3494 let seq, last = get_seq_last seq in
3496 pr " if (strcmp (r, \"%s\") != 0) {\n" (c_quote expected);
3497 pr " fprintf (stderr, \"%s: expected \\\"%s\\\" but got \\\"%%s\\\"\\n\", r);\n" test_name (c_quote expected);
3501 List.iter (generate_test_command_call test_name) seq;
3502 generate_test_command_call ~test test_name last
3503 | TestOutputList (seq, expected) ->
3504 pr " /* TestOutputList for %s (%d) */\n" name i;
3505 let seq, last = get_seq_last seq in
3509 pr " if (!r[%d]) {\n" i;
3510 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
3511 pr " print_strings (r);\n";
3514 pr " if (strcmp (r[%d], \"%s\") != 0) {\n" i (c_quote str);
3515 pr " fprintf (stderr, \"%s: expected \\\"%s\\\" but got \\\"%%s\\\"\\n\", r[%d]);\n" test_name (c_quote str) i;
3519 pr " if (r[%d] != NULL) {\n" (List.length expected);
3520 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
3522 pr " print_strings (r);\n";
3526 List.iter (generate_test_command_call test_name) seq;
3527 generate_test_command_call ~test test_name last
3528 | TestOutputInt (seq, expected) ->
3529 pr " /* TestOutputInt for %s (%d) */\n" name i;
3530 let seq, last = get_seq_last seq in
3532 pr " if (r != %d) {\n" expected;
3533 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
3539 List.iter (generate_test_command_call test_name) seq;
3540 generate_test_command_call ~test test_name last
3541 | TestOutputTrue seq ->
3542 pr " /* TestOutputTrue for %s (%d) */\n" name i;
3543 let seq, last = get_seq_last seq in
3546 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
3551 List.iter (generate_test_command_call test_name) seq;
3552 generate_test_command_call ~test test_name last
3553 | TestOutputFalse seq ->
3554 pr " /* TestOutputFalse for %s (%d) */\n" name i;
3555 let seq, last = get_seq_last seq in
3558 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
3563 List.iter (generate_test_command_call test_name) seq;
3564 generate_test_command_call ~test test_name last
3565 | TestOutputLength (seq, expected) ->
3566 pr " /* TestOutputLength for %s (%d) */\n" name i;
3567 let seq, last = get_seq_last seq in
3570 pr " for (j = 0; j < %d; ++j)\n" expected;
3571 pr " if (r[j] == NULL) {\n";
3572 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
3574 pr " print_strings (r);\n";
3577 pr " if (r[j] != NULL) {\n";
3578 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
3580 pr " print_strings (r);\n";
3584 List.iter (generate_test_command_call test_name) seq;
3585 generate_test_command_call ~test test_name last
3586 | TestOutputStruct (seq, checks) ->
3587 pr " /* TestOutputStruct for %s (%d) */\n" name i;
3588 let seq, last = get_seq_last seq in
3592 | CompareWithInt (field, expected) ->
3593 pr " if (r->%s != %d) {\n" field expected;
3594 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
3595 test_name field expected;
3596 pr " (int) r->%s);\n" field;
3599 | CompareWithString (field, expected) ->
3600 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
3601 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
3602 test_name field expected;
3603 pr " r->%s);\n" field;
3606 | CompareFieldsIntEq (field1, field2) ->
3607 pr " if (r->%s != r->%s) {\n" field1 field2;
3608 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
3609 test_name field1 field2;
3610 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
3613 | CompareFieldsStrEq (field1, field2) ->
3614 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
3615 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
3616 test_name field1 field2;
3617 pr " r->%s, r->%s);\n" field1 field2;
3622 List.iter (generate_test_command_call test_name) seq;
3623 generate_test_command_call ~test test_name last
3624 | TestLastFail seq ->
3625 pr " /* TestLastFail for %s (%d) */\n" name i;
3626 let seq, last = get_seq_last seq in
3627 List.iter (generate_test_command_call test_name) seq;
3628 generate_test_command_call test_name ~expect_error:true last
3636 (* Generate the code to run a command, leaving the result in 'r'.
3637 * If you expect to get an error then you should set expect_error:true.
3639 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
3641 | [] -> assert false
3643 (* Look up the command to find out what args/ret it has. *)
3646 let _, style, _, _, _, _, _ =
3647 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
3650 failwithf "%s: in test, command %s was not found" test_name name in
3652 if List.length (snd style) <> List.length args then
3653 failwithf "%s: in test, wrong number of args given to %s"
3664 | FileIn _, _ | FileOut _, _ -> ()
3665 | StringList n, arg ->
3666 pr " char *%s[] = {\n" n;
3667 let strs = string_split " " arg in
3669 fun str -> pr " \"%s\",\n" (c_quote str)
3673 ) (List.combine (snd style) args);
3676 match fst style with
3677 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
3678 | RInt64 _ -> pr " int64_t r;\n"; "-1"
3679 | RConstString _ -> pr " const char *r;\n"; "NULL"
3680 | RString _ -> pr " char *r;\n"; "NULL"
3681 | RStringList _ | RHashtable _ ->
3686 pr " struct guestfs_int_bool *r;\n"; "NULL"
3688 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
3690 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
3692 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
3694 pr " struct guestfs_stat *r;\n"; "NULL"
3696 pr " struct guestfs_statvfs *r;\n"; "NULL" in
3698 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
3699 pr " r = guestfs_%s (g" name;
3701 (* Generate the parameters. *)
3705 | FileIn _, arg | FileOut _, arg ->
3706 pr ", \"%s\"" (c_quote arg)
3707 | OptString _, arg ->
3708 if arg = "NULL" then pr ", NULL" else pr ", \"%s\"" (c_quote arg)
3709 | StringList n, _ ->
3713 try int_of_string arg
3714 with Failure "int_of_string" ->
3715 failwithf "%s: expecting an int, but got '%s'" test_name arg in
3718 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
3719 ) (List.combine (snd style) args);
3722 if not expect_error then
3723 pr " if (r == %s)\n" error_code
3725 pr " if (r != %s)\n" error_code;
3728 (* Insert the test code. *)
3734 (match fst style with
3735 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _ -> ()
3736 | RString _ -> pr " free (r);\n"
3737 | RStringList _ | RHashtable _ ->
3738 pr " for (i = 0; r[i] != NULL; ++i)\n";
3739 pr " free (r[i]);\n";
3742 pr " guestfs_free_int_bool (r);\n"
3744 pr " guestfs_free_lvm_pv_list (r);\n"
3746 pr " guestfs_free_lvm_vg_list (r);\n"
3748 pr " guestfs_free_lvm_lv_list (r);\n"
3749 | RStat _ | RStatVFS _ ->
3756 let str = replace_str str "\r" "\\r" in
3757 let str = replace_str str "\n" "\\n" in
3758 let str = replace_str str "\t" "\\t" in
3761 (* Generate a lot of different functions for guestfish. *)
3762 and generate_fish_cmds () =
3763 generate_header CStyle GPLv2;
3767 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3769 let all_functions_sorted =
3771 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3772 ) all_functions_sorted in
3774 pr "#include <stdio.h>\n";
3775 pr "#include <stdlib.h>\n";
3776 pr "#include <string.h>\n";
3777 pr "#include <inttypes.h>\n";
3779 pr "#include <guestfs.h>\n";
3780 pr "#include \"fish.h\"\n";
3783 (* list_commands function, which implements guestfish -h *)
3784 pr "void list_commands (void)\n";
3786 pr " printf (\" %%-16s %%s\\n\", \"Command\", \"Description\");\n";
3787 pr " list_builtin_commands ();\n";
3789 fun (name, _, _, flags, _, shortdesc, _) ->
3790 let name = replace_char name '_' '-' in
3791 pr " printf (\"%%-20s %%s\\n\", \"%s\", \"%s\");\n"
3793 ) all_functions_sorted;
3794 pr " printf (\" Use -h <cmd> / help <cmd> to show detailed help for a command.\\n\");\n";
3798 (* display_command function, which implements guestfish -h cmd *)
3799 pr "void display_command (const char *cmd)\n";
3802 fun (name, style, _, flags, _, shortdesc, longdesc) ->
3803 let name2 = replace_char name '_' '-' in
3805 try find_map (function FishAlias n -> Some n | _ -> None) flags
3806 with Not_found -> name in
3807 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
3809 match snd style with
3813 name2 (String.concat "> <" (List.map name_of_argt args)) in
3816 if List.mem ProtocolLimitWarning flags then
3817 ("\n\n" ^ protocol_limit_warning)
3820 (* For DangerWillRobinson commands, we should probably have
3821 * guestfish prompt before allowing you to use them (especially
3822 * in interactive mode). XXX
3826 if List.mem DangerWillRobinson flags then
3827 ("\n\n" ^ danger_will_robinson)
3830 let describe_alias =
3831 if name <> alias then
3832 sprintf "\n\nYou can use '%s' as an alias for this command." alias
3836 pr "strcasecmp (cmd, \"%s\") == 0" name;
3837 if name <> name2 then
3838 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
3839 if name <> alias then
3840 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
3842 pr " pod2text (\"%s - %s\", %S);\n"
3844 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
3847 pr " display_builtin_command (cmd);\n";
3851 (* print_{pv,vg,lv}_list functions *)
3855 pr "static void print_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
3862 pr " printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
3864 pr " printf (\"%s: \");\n" name;
3865 pr " for (i = 0; i < 32; ++i)\n";
3866 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
3867 pr " printf (\"\\n\");\n"
3869 pr " printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
3871 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
3872 | name, `OptPercent ->
3873 pr " if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
3874 typ name name typ name;
3875 pr " else printf (\"%s: \\n\");\n" name
3879 pr "static void print_%s_list (struct guestfs_lvm_%s_list *%ss)\n"
3884 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
3885 pr " print_%s (&%ss->val[i]);\n" typ typ;
3888 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
3890 (* print_{stat,statvfs} functions *)
3894 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
3899 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
3903 ) ["stat", stat_cols; "statvfs", statvfs_cols];
3905 (* run_<action> actions *)
3907 fun (name, style, _, flags, _, _, _) ->
3908 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
3910 (match fst style with
3913 | RBool _ -> pr " int r;\n"
3914 | RInt64 _ -> pr " int64_t r;\n"
3915 | RConstString _ -> pr " const char *r;\n"
3916 | RString _ -> pr " char *r;\n"
3917 | RStringList _ | RHashtable _ -> pr " char **r;\n"
3918 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"
3919 | RPVList _ -> pr " struct guestfs_lvm_pv_list *r;\n"
3920 | RVGList _ -> pr " struct guestfs_lvm_vg_list *r;\n"
3921 | RLVList _ -> pr " struct guestfs_lvm_lv_list *r;\n"
3922 | RStat _ -> pr " struct guestfs_stat *r;\n"
3923 | RStatVFS _ -> pr " struct guestfs_statvfs *r;\n"
3930 | FileOut n -> pr " const char *%s;\n" n
3931 | StringList n -> pr " char **%s;\n" n
3932 | Bool n -> pr " int %s;\n" n
3933 | Int n -> pr " int %s;\n" n
3936 (* Check and convert parameters. *)
3937 let argc_expected = List.length (snd style) in
3938 pr " if (argc != %d) {\n" argc_expected;
3939 pr " fprintf (stderr, \"%%s should have %d parameter(s)\\n\", cmd);\n"
3941 pr " fprintf (stderr, \"type 'help %%s' for help on %%s\\n\", cmd, cmd);\n";
3947 | String name -> pr " %s = argv[%d];\n" name i
3949 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
3952 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
3955 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
3957 | StringList name ->
3958 pr " %s = parse_string_list (argv[%d]);\n" name i
3960 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
3962 pr " %s = atoi (argv[%d]);\n" name i
3965 (* Call C API function. *)
3967 try find_map (function FishAction n -> Some n | _ -> None) flags
3968 with Not_found -> sprintf "guestfs_%s" name in
3970 generate_call_args ~handle:"g" (snd style);
3973 (* Check return value for errors and display command results. *)
3974 (match fst style with
3975 | RErr -> pr " return r;\n"
3977 pr " if (r == -1) return -1;\n";
3978 pr " printf (\"%%d\\n\", r);\n";
3981 pr " if (r == -1) return -1;\n";
3982 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
3985 pr " if (r == -1) return -1;\n";
3986 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
3989 pr " if (r == NULL) return -1;\n";
3990 pr " printf (\"%%s\\n\", r);\n";
3993 pr " if (r == NULL) return -1;\n";
3994 pr " printf (\"%%s\\n\", r);\n";
3998 pr " if (r == NULL) return -1;\n";
3999 pr " print_strings (r);\n";
4000 pr " free_strings (r);\n";
4003 pr " if (r == NULL) return -1;\n";
4004 pr " printf (\"%%d, %%s\\n\", r->i,\n";
4005 pr " r->b ? \"true\" : \"false\");\n";
4006 pr " guestfs_free_int_bool (r);\n";
4009 pr " if (r == NULL) return -1;\n";
4010 pr " print_pv_list (r);\n";
4011 pr " guestfs_free_lvm_pv_list (r);\n";
4014 pr " if (r == NULL) return -1;\n";
4015 pr " print_vg_list (r);\n";
4016 pr " guestfs_free_lvm_vg_list (r);\n";
4019 pr " if (r == NULL) return -1;\n";
4020 pr " print_lv_list (r);\n";
4021 pr " guestfs_free_lvm_lv_list (r);\n";
4024 pr " if (r == NULL) return -1;\n";
4025 pr " print_stat (r);\n";
4029 pr " if (r == NULL) return -1;\n";
4030 pr " print_statvfs (r);\n";
4034 pr " if (r == NULL) return -1;\n";
4035 pr " print_table (r);\n";
4036 pr " free_strings (r);\n";
4043 (* run_action function *)
4044 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
4047 fun (name, _, _, flags, _, _, _) ->
4048 let name2 = replace_char name '_' '-' in
4050 try find_map (function FishAlias n -> Some n | _ -> None) flags
4051 with Not_found -> name in
4053 pr "strcasecmp (cmd, \"%s\") == 0" name;
4054 if name <> name2 then
4055 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
4056 if name <> alias then
4057 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
4059 pr " return run_%s (cmd, argc, argv);\n" name;
4063 pr " fprintf (stderr, \"%%s: unknown command\\n\", cmd);\n";
4070 (* Readline completion for guestfish. *)
4071 and generate_fish_completion () =
4072 generate_header CStyle GPLv2;
4076 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4086 #ifdef HAVE_LIBREADLINE
4087 #include <readline/readline.h>
4092 #ifdef HAVE_LIBREADLINE
4094 static const char *const commands[] = {
4097 (* Get the commands and sort them, including the aliases. *)
4100 fun (name, _, _, flags, _, _, _) ->
4101 let name2 = replace_char name '_' '-' in
4103 try find_map (function FishAlias n -> Some n | _ -> None) flags
4104 with Not_found -> name in
4106 if name <> alias then [name2; alias] else [name2]
4108 let commands = List.flatten commands in
4109 let commands = List.sort compare commands in
4111 List.iter (pr " \"%s\",\n") commands;
4117 generator (const char *text, int state)
4119 static int index, len;
4124 len = strlen (text);
4127 while ((name = commands[index]) != NULL) {
4129 if (strncasecmp (name, text, len) == 0)
4130 return strdup (name);
4136 #endif /* HAVE_LIBREADLINE */
4138 char **do_completion (const char *text, int start, int end)
4140 char **matches = NULL;
4142 #ifdef HAVE_LIBREADLINE
4144 matches = rl_completion_matches (text, generator);
4151 (* Generate the POD documentation for guestfish. *)
4152 and generate_fish_actions_pod () =
4153 let all_functions_sorted =
4155 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4156 ) all_functions_sorted in
4158 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
4161 fun (name, style, _, flags, _, _, longdesc) ->
4163 Str.global_substitute rex (
4166 try Str.matched_group 1 s
4168 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
4169 "C<" ^ replace_char sub '_' '-' ^ ">"
4171 let name = replace_char name '_' '-' in
4173 try find_map (function FishAlias n -> Some n | _ -> None) flags
4174 with Not_found -> name in
4176 pr "=head2 %s" name;
4177 if name <> alias then
4184 | String n -> pr " %s" n
4185 | OptString n -> pr " %s" n
4186 | StringList n -> pr " '%s ...'" n
4187 | Bool _ -> pr " true|false"
4188 | Int n -> pr " %s" n
4189 | FileIn n | FileOut n -> pr " (%s|-)" n
4193 pr "%s\n\n" longdesc;
4195 if List.exists (function FileIn _ | FileOut _ -> true
4196 | _ -> false) (snd style) then
4197 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
4199 if List.mem ProtocolLimitWarning flags then
4200 pr "%s\n\n" protocol_limit_warning;
4202 if List.mem DangerWillRobinson flags then
4203 pr "%s\n\n" danger_will_robinson
4204 ) all_functions_sorted
4206 (* Generate a C function prototype. *)
4207 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
4208 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
4210 ?handle name style =
4211 if extern then pr "extern ";
4212 if static then pr "static ";
4213 (match fst style with
4215 | RInt _ -> pr "int "
4216 | RInt64 _ -> pr "int64_t "
4217 | RBool _ -> pr "int "
4218 | RConstString _ -> pr "const char *"
4219 | RString _ -> pr "char *"
4220 | RStringList _ | RHashtable _ -> pr "char **"
4222 if not in_daemon then pr "struct guestfs_int_bool *"
4223 else pr "guestfs_%s_ret *" name
4225 if not in_daemon then pr "struct guestfs_lvm_pv_list *"
4226 else pr "guestfs_lvm_int_pv_list *"
4228 if not in_daemon then pr "struct guestfs_lvm_vg_list *"
4229 else pr "guestfs_lvm_int_vg_list *"
4231 if not in_daemon then pr "struct guestfs_lvm_lv_list *"
4232 else pr "guestfs_lvm_int_lv_list *"
4234 if not in_daemon then pr "struct guestfs_stat *"
4235 else pr "guestfs_int_stat *"
4237 if not in_daemon then pr "struct guestfs_statvfs *"
4238 else pr "guestfs_int_statvfs *"
4240 pr "%s%s (" prefix name;
4241 if handle = None && List.length (snd style) = 0 then
4244 let comma = ref false in
4247 | Some handle -> pr "guestfs_h *%s" handle; comma := true
4251 if single_line then pr ", " else pr ",\n\t\t"
4258 | OptString n -> next (); pr "const char *%s" n
4259 | StringList n -> next (); pr "char * const* const %s" n
4260 | Bool n -> next (); pr "int %s" n
4261 | Int n -> next (); pr "int %s" n
4264 if not in_daemon then (next (); pr "const char *%s" n)
4268 if semicolon then pr ";";
4269 if newline then pr "\n"
4271 (* Generate C call arguments, eg "(handle, foo, bar)" *)
4272 and generate_call_args ?handle args =
4274 let comma = ref false in
4277 | Some handle -> pr "%s" handle; comma := true
4281 if !comma then pr ", ";
4283 pr "%s" (name_of_argt arg)
4287 (* Generate the OCaml bindings interface. *)
4288 and generate_ocaml_mli () =
4289 generate_header OCamlStyle LGPLv2;
4292 (** For API documentation you should refer to the C API
4293 in the guestfs(3) manual page. The OCaml API uses almost
4294 exactly the same calls. *)
4297 (** A [guestfs_h] handle. *)
4299 exception Error of string
4300 (** This exception is raised when there is an error. *)
4302 val create : unit -> t
4304 val close : t -> unit
4305 (** Handles are closed by the garbage collector when they become
4306 unreferenced, but callers can also call this in order to
4307 provide predictable cleanup. *)
4310 generate_ocaml_lvm_structure_decls ();
4312 generate_ocaml_stat_structure_decls ();
4316 fun (name, style, _, _, _, shortdesc, _) ->
4317 generate_ocaml_prototype name style;
4318 pr "(** %s *)\n" shortdesc;
4322 (* Generate the OCaml bindings implementation. *)
4323 and generate_ocaml_ml () =
4324 generate_header OCamlStyle LGPLv2;
4328 exception Error of string
4329 external create : unit -> t = \"ocaml_guestfs_create\"
4330 external close : t -> unit = \"ocaml_guestfs_close\"
4333 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
4337 generate_ocaml_lvm_structure_decls ();
4339 generate_ocaml_stat_structure_decls ();
4343 fun (name, style, _, _, _, shortdesc, _) ->
4344 generate_ocaml_prototype ~is_external:true name style;
4347 (* Generate the OCaml bindings C implementation. *)
4348 and generate_ocaml_c () =
4349 generate_header CStyle LGPLv2;
4356 #include <caml/config.h>
4357 #include <caml/alloc.h>
4358 #include <caml/callback.h>
4359 #include <caml/fail.h>
4360 #include <caml/memory.h>
4361 #include <caml/mlvalues.h>
4362 #include <caml/signals.h>
4364 #include <guestfs.h>
4366 #include \"guestfs_c.h\"
4368 /* Copy a hashtable of string pairs into an assoc-list. We return
4369 * the list in reverse order, but hashtables aren't supposed to be
4372 static CAMLprim value
4373 copy_table (char * const * argv)
4376 CAMLlocal5 (rv, pairv, kv, vv, cons);
4380 for (i = 0; argv[i] != NULL; i += 2) {
4381 kv = caml_copy_string (argv[i]);
4382 vv = caml_copy_string (argv[i+1]);
4383 pairv = caml_alloc (2, 0);
4384 Store_field (pairv, 0, kv);
4385 Store_field (pairv, 1, vv);
4386 cons = caml_alloc (2, 0);
4387 Store_field (cons, 1, rv);
4389 Store_field (cons, 0, pairv);
4397 (* LVM struct copy functions. *)
4400 let has_optpercent_col =
4401 List.exists (function (_, `OptPercent) -> true | _ -> false) cols in
4403 pr "static CAMLprim value\n";
4404 pr "copy_lvm_%s (const struct guestfs_lvm_%s *%s)\n" typ typ typ;
4406 pr " CAMLparam0 ();\n";
4407 if has_optpercent_col then
4408 pr " CAMLlocal3 (rv, v, v2);\n"
4410 pr " CAMLlocal2 (rv, v);\n";
4412 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
4417 pr " v = caml_copy_string (%s->%s);\n" typ name
4419 pr " v = caml_alloc_string (32);\n";
4420 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
4423 pr " v = caml_copy_int64 (%s->%s);\n" typ name
4424 | name, `OptPercent ->
4425 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
4426 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
4427 pr " v = caml_alloc (1, 0);\n";
4428 pr " Store_field (v, 0, v2);\n";
4429 pr " } else /* None */\n";
4430 pr " v = Val_int (0);\n";
4432 pr " Store_field (rv, %d, v);\n" i
4434 pr " CAMLreturn (rv);\n";
4438 pr "static CAMLprim value\n";
4439 pr "copy_lvm_%s_list (const struct guestfs_lvm_%s_list *%ss)\n"
4442 pr " CAMLparam0 ();\n";
4443 pr " CAMLlocal2 (rv, v);\n";
4446 pr " if (%ss->len == 0)\n" typ;
4447 pr " CAMLreturn (Atom (0));\n";
4449 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
4450 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
4451 pr " v = copy_lvm_%s (&%ss->val[i]);\n" typ typ;
4452 pr " caml_modify (&Field (rv, i), v);\n";
4454 pr " CAMLreturn (rv);\n";
4458 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
4460 (* Stat copy functions. *)
4463 pr "static CAMLprim value\n";
4464 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
4466 pr " CAMLparam0 ();\n";
4467 pr " CAMLlocal2 (rv, v);\n";
4469 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
4474 pr " v = caml_copy_int64 (%s->%s);\n" typ name
4476 pr " Store_field (rv, %d, v);\n" i
4478 pr " CAMLreturn (rv);\n";
4481 ) ["stat", stat_cols; "statvfs", statvfs_cols];
4485 fun (name, style, _, _, _, _, _) ->
4487 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
4489 pr "CAMLprim value\n";
4490 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
4491 List.iter (pr ", value %s") (List.tl params);
4496 | [p1; p2; p3; p4; p5] ->
4497 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
4498 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
4499 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
4500 pr " CAMLxparam%d (%s);\n"
4501 (List.length rest) (String.concat ", " rest)
4503 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
4505 pr " CAMLlocal1 (rv);\n";
4508 pr " guestfs_h *g = Guestfs_val (gv);\n";
4509 pr " if (g == NULL)\n";
4510 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
4518 pr " const char *%s = String_val (%sv);\n" n n
4520 pr " const char *%s =\n" n;
4521 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
4524 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
4526 pr " int %s = Bool_val (%sv);\n" n n
4528 pr " int %s = Int_val (%sv);\n" n n
4531 match fst style with
4532 | RErr -> pr " int r;\n"; "-1"
4533 | RInt _ -> pr " int r;\n"; "-1"
4534 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4535 | RBool _ -> pr " int r;\n"; "-1"
4536 | RConstString _ -> pr " const char *r;\n"; "NULL"
4537 | RString _ -> pr " char *r;\n"; "NULL"
4543 pr " struct guestfs_int_bool *r;\n"; "NULL"
4545 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
4547 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
4549 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
4551 pr " struct guestfs_stat *r;\n"; "NULL"
4553 pr " struct guestfs_statvfs *r;\n"; "NULL"
4560 pr " caml_enter_blocking_section ();\n";
4561 pr " r = guestfs_%s " name;
4562 generate_call_args ~handle:"g" (snd style);
4564 pr " caml_leave_blocking_section ();\n";
4569 pr " ocaml_guestfs_free_strings (%s);\n" n;
4570 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
4573 pr " if (r == %s)\n" error_code;
4574 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
4577 (match fst style with
4578 | RErr -> pr " rv = Val_unit;\n"
4579 | RInt _ -> pr " rv = Val_int (r);\n"
4581 pr " rv = caml_copy_int64 (r);\n"
4582 | RBool _ -> pr " rv = Val_bool (r);\n"
4583 | RConstString _ -> pr " rv = caml_copy_string (r);\n"
4585 pr " rv = caml_copy_string (r);\n";
4588 pr " rv = caml_copy_string_array ((const char **) r);\n";
4589 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
4592 pr " rv = caml_alloc (2, 0);\n";
4593 pr " Store_field (rv, 0, Val_int (r->i));\n";
4594 pr " Store_field (rv, 1, Val_bool (r->b));\n";
4595 pr " guestfs_free_int_bool (r);\n";
4597 pr " rv = copy_lvm_pv_list (r);\n";
4598 pr " guestfs_free_lvm_pv_list (r);\n";
4600 pr " rv = copy_lvm_vg_list (r);\n";
4601 pr " guestfs_free_lvm_vg_list (r);\n";
4603 pr " rv = copy_lvm_lv_list (r);\n";
4604 pr " guestfs_free_lvm_lv_list (r);\n";
4606 pr " rv = copy_stat (r);\n";
4609 pr " rv = copy_statvfs (r);\n";
4612 pr " rv = copy_table (r);\n";
4613 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
4617 pr " CAMLreturn (rv);\n";
4621 if List.length params > 5 then (
4622 pr "CAMLprim value\n";
4623 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
4625 pr " return ocaml_guestfs_%s (argv[0]" name;
4626 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
4633 and generate_ocaml_lvm_structure_decls () =
4636 pr "type lvm_%s = {\n" typ;
4639 | name, `String -> pr " %s : string;\n" name
4640 | name, `UUID -> pr " %s : string;\n" name
4641 | name, `Bytes -> pr " %s : int64;\n" name
4642 | name, `Int -> pr " %s : int64;\n" name
4643 | name, `OptPercent -> pr " %s : float option;\n" name
4647 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
4649 and generate_ocaml_stat_structure_decls () =
4652 pr "type %s = {\n" typ;
4655 | name, `Int -> pr " %s : int64;\n" name
4659 ) ["stat", stat_cols; "statvfs", statvfs_cols]
4661 and generate_ocaml_prototype ?(is_external = false) name style =
4662 if is_external then pr "external " else pr "val ";
4663 pr "%s : t -> " name;
4666 | String _ | FileIn _ | FileOut _ -> pr "string -> "
4667 | OptString _ -> pr "string option -> "
4668 | StringList _ -> pr "string array -> "
4669 | Bool _ -> pr "bool -> "
4670 | Int _ -> pr "int -> "
4672 (match fst style with
4673 | RErr -> pr "unit" (* all errors are turned into exceptions *)
4674 | RInt _ -> pr "int"
4675 | RInt64 _ -> pr "int64"
4676 | RBool _ -> pr "bool"
4677 | RConstString _ -> pr "string"
4678 | RString _ -> pr "string"
4679 | RStringList _ -> pr "string array"
4680 | RIntBool _ -> pr "int * bool"
4681 | RPVList _ -> pr "lvm_pv array"
4682 | RVGList _ -> pr "lvm_vg array"
4683 | RLVList _ -> pr "lvm_lv array"
4684 | RStat _ -> pr "stat"
4685 | RStatVFS _ -> pr "statvfs"
4686 | RHashtable _ -> pr "(string * string) list"
4688 if is_external then (
4690 if List.length (snd style) + 1 > 5 then
4691 pr "\"ocaml_guestfs_%s_byte\" " name;
4692 pr "\"ocaml_guestfs_%s\"" name
4696 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
4697 and generate_perl_xs () =
4698 generate_header CStyle LGPLv2;
4701 #include \"EXTERN.h\"
4705 #include <guestfs.h>
4708 #define PRId64 \"lld\"
4712 my_newSVll(long long val) {
4713 #ifdef USE_64_BIT_ALL
4714 return newSViv(val);
4718 len = snprintf(buf, 100, \"%%\" PRId64, val);
4719 return newSVpv(buf, len);
4724 #define PRIu64 \"llu\"
4728 my_newSVull(unsigned long long val) {
4729 #ifdef USE_64_BIT_ALL
4730 return newSVuv(val);
4734 len = snprintf(buf, 100, \"%%\" PRIu64, val);
4735 return newSVpv(buf, len);
4739 /* http://www.perlmonks.org/?node_id=680842 */
4741 XS_unpack_charPtrPtr (SV *arg) {
4746 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
4747 croak (\"array reference expected\");
4749 av = (AV *)SvRV (arg);
4750 ret = malloc (av_len (av) + 1 + 1);
4752 croak (\"malloc failed\");
4754 for (i = 0; i <= av_len (av); i++) {
4755 SV **elem = av_fetch (av, i, 0);
4757 if (!elem || !*elem)
4758 croak (\"missing element in list\");
4760 ret[i] = SvPV_nolen (*elem);
4768 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
4773 RETVAL = guestfs_create ();
4775 croak (\"could not create guestfs handle\");
4776 guestfs_set_error_handler (RETVAL, NULL, NULL);
4789 fun (name, style, _, _, _, _, _) ->
4790 (match fst style with
4791 | RErr -> pr "void\n"
4792 | RInt _ -> pr "SV *\n"
4793 | RInt64 _ -> pr "SV *\n"
4794 | RBool _ -> pr "SV *\n"
4795 | RConstString _ -> pr "SV *\n"
4796 | RString _ -> pr "SV *\n"
4799 | RPVList _ | RVGList _ | RLVList _
4800 | RStat _ | RStatVFS _
4802 pr "void\n" (* all lists returned implictly on the stack *)
4804 (* Call and arguments. *)
4806 generate_call_args ~handle:"g" (snd style);
4808 pr " guestfs_h *g;\n";
4811 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
4812 | OptString n -> pr " char *%s;\n" n
4813 | StringList n -> pr " char **%s;\n" n
4814 | Bool n -> pr " int %s;\n" n
4815 | Int n -> pr " int %s;\n" n
4818 let do_cleanups () =
4821 | String _ | OptString _ | Bool _ | Int _
4822 | FileIn _ | FileOut _ -> ()
4823 | StringList n -> pr " free (%s);\n" n
4828 (match fst style with
4833 pr " r = guestfs_%s " name;
4834 generate_call_args ~handle:"g" (snd style);
4837 pr " if (r == -1)\n";
4838 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4844 pr " %s = guestfs_%s " n name;
4845 generate_call_args ~handle:"g" (snd style);
4848 pr " if (%s == -1)\n" n;
4849 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4850 pr " RETVAL = newSViv (%s);\n" n;
4855 pr " int64_t %s;\n" n;
4857 pr " %s = guestfs_%s " n name;
4858 generate_call_args ~handle:"g" (snd style);
4861 pr " if (%s == -1)\n" n;
4862 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4863 pr " RETVAL = my_newSVll (%s);\n" n;
4868 pr " const char *%s;\n" n;
4870 pr " %s = guestfs_%s " n name;
4871 generate_call_args ~handle:"g" (snd style);
4874 pr " if (%s == NULL)\n" n;
4875 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4876 pr " RETVAL = newSVpv (%s, 0);\n" n;
4881 pr " char *%s;\n" n;
4883 pr " %s = guestfs_%s " n name;
4884 generate_call_args ~handle:"g" (snd style);
4887 pr " if (%s == NULL)\n" n;
4888 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4889 pr " RETVAL = newSVpv (%s, 0);\n" n;
4890 pr " free (%s);\n" n;
4893 | RStringList n | RHashtable n ->
4895 pr " char **%s;\n" n;
4898 pr " %s = guestfs_%s " n name;
4899 generate_call_args ~handle:"g" (snd style);
4902 pr " if (%s == NULL)\n" n;
4903 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4904 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
4905 pr " EXTEND (SP, n);\n";
4906 pr " for (i = 0; i < n; ++i) {\n";
4907 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
4908 pr " free (%s[i]);\n" n;
4910 pr " free (%s);\n" n;
4913 pr " struct guestfs_int_bool *r;\n";
4915 pr " r = guestfs_%s " name;
4916 generate_call_args ~handle:"g" (snd style);
4919 pr " if (r == NULL)\n";
4920 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4921 pr " EXTEND (SP, 2);\n";
4922 pr " PUSHs (sv_2mortal (newSViv (r->i)));\n";
4923 pr " PUSHs (sv_2mortal (newSViv (r->b)));\n";
4924 pr " guestfs_free_int_bool (r);\n";
4926 generate_perl_lvm_code "pv" pv_cols name style n do_cleanups
4928 generate_perl_lvm_code "vg" vg_cols name style n do_cleanups
4930 generate_perl_lvm_code "lv" lv_cols name style n do_cleanups
4932 generate_perl_stat_code "stat" stat_cols name style n do_cleanups
4934 generate_perl_stat_code
4935 "statvfs" statvfs_cols name style n do_cleanups
4941 and generate_perl_lvm_code typ cols name style n do_cleanups =
4943 pr " struct guestfs_lvm_%s_list *%s;\n" typ n;
4947 pr " %s = guestfs_%s " n name;
4948 generate_call_args ~handle:"g" (snd style);
4951 pr " if (%s == NULL)\n" n;
4952 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4953 pr " EXTEND (SP, %s->len);\n" n;
4954 pr " for (i = 0; i < %s->len; ++i) {\n" n;
4955 pr " hv = newHV ();\n";
4959 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
4960 name (String.length name) n name
4962 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
4963 name (String.length name) n name
4965 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
4966 name (String.length name) n name
4968 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
4969 name (String.length name) n name
4970 | name, `OptPercent ->
4971 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
4972 name (String.length name) n name
4974 pr " PUSHs (sv_2mortal ((SV *) hv));\n";
4976 pr " guestfs_free_lvm_%s_list (%s);\n" typ n
4978 and generate_perl_stat_code typ cols name style n do_cleanups =
4980 pr " struct guestfs_%s *%s;\n" typ n;
4982 pr " %s = guestfs_%s " n name;
4983 generate_call_args ~handle:"g" (snd style);
4986 pr " if (%s == NULL)\n" n;
4987 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4988 pr " EXTEND (SP, %d);\n" (List.length cols);
4992 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n" n name
4994 pr " free (%s);\n" n
4996 (* Generate Sys/Guestfs.pm. *)
4997 and generate_perl_pm () =
4998 generate_header HashStyle LGPLv2;
5005 Sys::Guestfs - Perl bindings for libguestfs
5011 my $h = Sys::Guestfs->new ();
5012 $h->add_drive ('guest.img');
5015 $h->mount ('/dev/sda1', '/');
5016 $h->touch ('/hello');
5021 The C<Sys::Guestfs> module provides a Perl XS binding to the
5022 libguestfs API for examining and modifying virtual machine
5025 Amongst the things this is good for: making batch configuration
5026 changes to guests, getting disk used/free statistics (see also:
5027 virt-df), migrating between virtualization systems (see also:
5028 virt-p2v), performing partial backups, performing partial guest
5029 clones, cloning guests and changing registry/UUID/hostname info, and
5032 Libguestfs uses Linux kernel and qemu code, and can access any type of
5033 guest filesystem that Linux and qemu can, including but not limited
5034 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
5035 schemes, qcow, qcow2, vmdk.
5037 Libguestfs provides ways to enumerate guest storage (eg. partitions,
5038 LVs, what filesystem is in each LV, etc.). It can also run commands
5039 in the context of the guest. Also you can access filesystems over FTP.
5043 All errors turn into calls to C<croak> (see L<Carp(3)>).
5051 package Sys::Guestfs;
5057 XSLoader::load ('Sys::Guestfs');
5059 =item $h = Sys::Guestfs->new ();
5061 Create a new guestfs handle.
5067 my $class = ref ($proto) || $proto;
5069 my $self = Sys::Guestfs::_create ();
5070 bless $self, $class;
5076 (* Actions. We only need to print documentation for these as
5077 * they are pulled in from the XS code automatically.
5080 fun (name, style, _, flags, _, _, longdesc) ->
5081 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
5083 generate_perl_prototype name style;
5085 pr "%s\n\n" longdesc;
5086 if List.mem ProtocolLimitWarning flags then
5087 pr "%s\n\n" protocol_limit_warning;
5088 if List.mem DangerWillRobinson flags then
5089 pr "%s\n\n" danger_will_robinson
5090 ) all_functions_sorted;
5102 Copyright (C) 2009 Red Hat Inc.
5106 Please see the file COPYING.LIB for the full license.
5110 L<guestfs(3)>, L<guestfish(1)>.
5115 and generate_perl_prototype name style =
5116 (match fst style with
5122 | RString n -> pr "$%s = " n
5123 | RIntBool (n, m) -> pr "($%s, $%s) = " n m
5127 | RLVList n -> pr "@%s = " n
5130 | RHashtable n -> pr "%%%s = " n
5133 let comma = ref false in
5136 if !comma then pr ", ";
5139 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
5146 (* Generate Python C module. *)
5147 and generate_python_c () =
5148 generate_header CStyle LGPLv2;
5157 #include \"guestfs.h\"
5165 get_handle (PyObject *obj)
5168 assert (obj != Py_None);
5169 return ((Pyguestfs_Object *) obj)->g;
5173 put_handle (guestfs_h *g)
5177 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
5180 /* This list should be freed (but not the strings) after use. */
5181 static const char **
5182 get_string_list (PyObject *obj)
5189 if (!PyList_Check (obj)) {
5190 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
5194 len = PyList_Size (obj);
5195 r = malloc (sizeof (char *) * (len+1));
5197 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
5201 for (i = 0; i < len; ++i)
5202 r[i] = PyString_AsString (PyList_GetItem (obj, i));
5209 put_string_list (char * const * const argv)
5214 for (argc = 0; argv[argc] != NULL; ++argc)
5217 list = PyList_New (argc);
5218 for (i = 0; i < argc; ++i)
5219 PyList_SetItem (list, i, PyString_FromString (argv[i]));
5225 put_table (char * const * const argv)
5227 PyObject *list, *item;
5230 for (argc = 0; argv[argc] != NULL; ++argc)
5233 list = PyList_New (argc >> 1);
5234 for (i = 0; i < argc; i += 2) {
5235 item = PyTuple_New (2);
5236 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
5237 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
5238 PyList_SetItem (list, i >> 1, item);
5245 free_strings (char **argv)
5249 for (argc = 0; argv[argc] != NULL; ++argc)
5255 py_guestfs_create (PyObject *self, PyObject *args)
5259 g = guestfs_create ();
5261 PyErr_SetString (PyExc_RuntimeError,
5262 \"guestfs.create: failed to allocate handle\");
5265 guestfs_set_error_handler (g, NULL, NULL);
5266 return put_handle (g);
5270 py_guestfs_close (PyObject *self, PyObject *args)
5275 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
5277 g = get_handle (py_g);
5281 Py_INCREF (Py_None);
5287 (* LVM structures, turned into Python dictionaries. *)
5290 pr "static PyObject *\n";
5291 pr "put_lvm_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
5293 pr " PyObject *dict;\n";
5295 pr " dict = PyDict_New ();\n";
5299 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5300 pr " PyString_FromString (%s->%s));\n"
5303 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5304 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
5307 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5308 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
5311 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5312 pr " PyLong_FromLongLong (%s->%s));\n"
5314 | name, `OptPercent ->
5315 pr " if (%s->%s >= 0)\n" typ name;
5316 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5317 pr " PyFloat_FromDouble ((double) %s->%s));\n"
5320 pr " Py_INCREF (Py_None);\n";
5321 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
5324 pr " return dict;\n";
5328 pr "static PyObject *\n";
5329 pr "put_lvm_%s_list (struct guestfs_lvm_%s_list *%ss)\n" typ typ typ;
5331 pr " PyObject *list;\n";
5334 pr " list = PyList_New (%ss->len);\n" typ;
5335 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
5336 pr " PyList_SetItem (list, i, put_lvm_%s (&%ss->val[i]));\n" typ typ;
5337 pr " return list;\n";
5340 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
5342 (* Stat structures, turned into Python dictionaries. *)
5345 pr "static PyObject *\n";
5346 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
5348 pr " PyObject *dict;\n";
5350 pr " dict = PyDict_New ();\n";
5354 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5355 pr " PyLong_FromLongLong (%s->%s));\n"
5358 pr " return dict;\n";
5361 ) ["stat", stat_cols; "statvfs", statvfs_cols];
5363 (* Python wrapper functions. *)
5365 fun (name, style, _, _, _, _, _) ->
5366 pr "static PyObject *\n";
5367 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
5370 pr " PyObject *py_g;\n";
5371 pr " guestfs_h *g;\n";
5372 pr " PyObject *py_r;\n";
5375 match fst style with
5376 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5377 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5378 | RConstString _ -> pr " const char *r;\n"; "NULL"
5379 | RString _ -> pr " char *r;\n"; "NULL"
5380 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5381 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
5382 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5383 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5384 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5385 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
5386 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
5390 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
5391 | OptString n -> pr " const char *%s;\n" n
5393 pr " PyObject *py_%s;\n" n;
5394 pr " const char **%s;\n" n
5395 | Bool n -> pr " int %s;\n" n
5396 | Int n -> pr " int %s;\n" n
5401 (* Convert the parameters. *)
5402 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
5405 | String _ | FileIn _ | FileOut _ -> pr "s"
5406 | OptString _ -> pr "z"
5407 | StringList _ -> pr "O"
5408 | Bool _ -> pr "i" (* XXX Python has booleans? *)
5411 pr ":guestfs_%s\",\n" name;
5415 | String n | FileIn n | FileOut n -> pr ", &%s" n
5416 | OptString n -> pr ", &%s" n
5417 | StringList n -> pr ", &py_%s" n
5418 | Bool n -> pr ", &%s" n
5419 | Int n -> pr ", &%s" n
5423 pr " return NULL;\n";
5425 pr " g = get_handle (py_g);\n";
5428 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5430 pr " %s = get_string_list (py_%s);\n" n n;
5431 pr " if (!%s) return NULL;\n" n
5436 pr " r = guestfs_%s " name;
5437 generate_call_args ~handle:"g" (snd style);
5442 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5444 pr " free (%s);\n" n
5447 pr " if (r == %s) {\n" error_code;
5448 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
5449 pr " return NULL;\n";
5453 (match fst style with
5455 pr " Py_INCREF (Py_None);\n";
5456 pr " py_r = Py_None;\n"
5458 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
5459 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
5460 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
5462 pr " py_r = PyString_FromString (r);\n";
5465 pr " py_r = put_string_list (r);\n";
5466 pr " free_strings (r);\n"
5468 pr " py_r = PyTuple_New (2);\n";
5469 pr " PyTuple_SetItem (py_r, 0, PyInt_FromLong ((long) r->i));\n";
5470 pr " PyTuple_SetItem (py_r, 1, PyInt_FromLong ((long) r->b));\n";
5471 pr " guestfs_free_int_bool (r);\n"
5473 pr " py_r = put_lvm_pv_list (r);\n";
5474 pr " guestfs_free_lvm_pv_list (r);\n"
5476 pr " py_r = put_lvm_vg_list (r);\n";
5477 pr " guestfs_free_lvm_vg_list (r);\n"
5479 pr " py_r = put_lvm_lv_list (r);\n";
5480 pr " guestfs_free_lvm_lv_list (r);\n"
5482 pr " py_r = put_stat (r);\n";
5485 pr " py_r = put_statvfs (r);\n";
5488 pr " py_r = put_table (r);\n";
5489 pr " free_strings (r);\n"
5492 pr " return py_r;\n";
5497 (* Table of functions. *)
5498 pr "static PyMethodDef methods[] = {\n";
5499 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
5500 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
5502 fun (name, _, _, _, _, _, _) ->
5503 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
5506 pr " { NULL, NULL, 0, NULL }\n";
5510 (* Init function. *)
5513 initlibguestfsmod (void)
5515 static int initialized = 0;
5517 if (initialized) return;
5518 Py_InitModule ((char *) \"libguestfsmod\", methods);
5523 (* Generate Python module. *)
5524 and generate_python_py () =
5525 generate_header HashStyle LGPLv2;
5528 u\"\"\"Python bindings for libguestfs
5531 g = guestfs.GuestFS ()
5532 g.add_drive (\"guest.img\")
5535 parts = g.list_partitions ()
5537 The guestfs module provides a Python binding to the libguestfs API
5538 for examining and modifying virtual machine disk images.
5540 Amongst the things this is good for: making batch configuration
5541 changes to guests, getting disk used/free statistics (see also:
5542 virt-df), migrating between virtualization systems (see also:
5543 virt-p2v), performing partial backups, performing partial guest
5544 clones, cloning guests and changing registry/UUID/hostname info, and
5547 Libguestfs uses Linux kernel and qemu code, and can access any type of
5548 guest filesystem that Linux and qemu can, including but not limited
5549 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
5550 schemes, qcow, qcow2, vmdk.
5552 Libguestfs provides ways to enumerate guest storage (eg. partitions,
5553 LVs, what filesystem is in each LV, etc.). It can also run commands
5554 in the context of the guest. Also you can access filesystems over FTP.
5556 Errors which happen while using the API are turned into Python
5557 RuntimeError exceptions.
5559 To create a guestfs handle you usually have to perform the following
5562 # Create the handle, call add_drive at least once, and possibly
5563 # several times if the guest has multiple block devices:
5564 g = guestfs.GuestFS ()
5565 g.add_drive (\"guest.img\")
5567 # Launch the qemu subprocess and wait for it to become ready:
5571 # Now you can issue commands, for example:
5576 import libguestfsmod
5579 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
5581 def __init__ (self):
5582 \"\"\"Create a new libguestfs handle.\"\"\"
5583 self._o = libguestfsmod.create ()
5586 libguestfsmod.close (self._o)
5591 fun (name, style, _, flags, _, _, longdesc) ->
5592 let doc = replace_str longdesc "C<guestfs_" "C<g." in
5594 match fst style with
5595 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _
5598 doc ^ "\n\nThis function returns a list of strings."
5600 doc ^ "\n\nThis function returns a tuple (int, bool).\n"
5602 doc ^ "\n\nThis function returns a list of PVs. Each PV is represented as a dictionary."
5604 doc ^ "\n\nThis function returns a list of VGs. Each VG is represented as a dictionary."
5606 doc ^ "\n\nThis function returns a list of LVs. Each LV is represented as a dictionary."
5608 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the stat structure."
5610 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the statvfs structure."
5612 doc ^ "\n\nThis function returns a dictionary." in
5614 if List.mem ProtocolLimitWarning flags then
5615 doc ^ "\n\n" ^ protocol_limit_warning
5618 if List.mem DangerWillRobinson flags then
5619 doc ^ "\n\n" ^ danger_will_robinson
5621 let doc = pod2text ~width:60 name doc in
5622 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
5623 let doc = String.concat "\n " doc in
5626 generate_call_args ~handle:"self" (snd style);
5628 pr " u\"\"\"%s\"\"\"\n" doc;
5629 pr " return libguestfsmod.%s " name;
5630 generate_call_args ~handle:"self._o" (snd style);
5635 (* Useful if you need the longdesc POD text as plain text. Returns a
5638 * This is the slowest thing about autogeneration.
5640 and pod2text ~width name longdesc =
5641 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
5642 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
5644 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
5645 let chan = Unix.open_process_in cmd in
5646 let lines = ref [] in
5648 let line = input_line chan in
5649 if i = 1 then (* discard the first line of output *)
5652 let line = triml line in
5653 lines := line :: !lines;
5656 let lines = try loop 1 with End_of_file -> List.rev !lines in
5657 Unix.unlink filename;
5658 match Unix.close_process_in chan with
5659 | Unix.WEXITED 0 -> lines
5661 failwithf "pod2text: process exited with non-zero status (%d)" i
5662 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
5663 failwithf "pod2text: process signalled or stopped by signal %d" i
5665 (* Generate ruby bindings. *)
5666 and generate_ruby_c () =
5667 generate_header CStyle LGPLv2;
5675 #include \"guestfs.h\"
5677 #include \"extconf.h\"
5679 static VALUE m_guestfs; /* guestfs module */
5680 static VALUE c_guestfs; /* guestfs_h handle */
5681 static VALUE e_Error; /* used for all errors */
5683 static void ruby_guestfs_free (void *p)
5686 guestfs_close ((guestfs_h *) p);
5689 static VALUE ruby_guestfs_create (VALUE m)
5693 g = guestfs_create ();
5695 rb_raise (e_Error, \"failed to create guestfs handle\");
5697 /* Don't print error messages to stderr by default. */
5698 guestfs_set_error_handler (g, NULL, NULL);
5700 /* Wrap it, and make sure the close function is called when the
5703 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
5706 static VALUE ruby_guestfs_close (VALUE gv)
5709 Data_Get_Struct (gv, guestfs_h, g);
5711 ruby_guestfs_free (g);
5712 DATA_PTR (gv) = NULL;
5720 fun (name, style, _, _, _, _, _) ->
5721 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
5722 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
5725 pr " guestfs_h *g;\n";
5726 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
5728 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
5734 | String n | FileIn n | FileOut n ->
5735 pr " const char *%s = StringValueCStr (%sv);\n" n n;
5737 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
5738 pr " \"%s\", \"%s\");\n" n name
5740 pr " const char *%s = StringValueCStr (%sv);\n" n n
5744 pr " int i, len;\n";
5745 pr " len = RARRAY_LEN (%sv);\n" n;
5746 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
5748 pr " for (i = 0; i < len; ++i) {\n";
5749 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
5750 pr " %s[i] = StringValueCStr (v);\n" n;
5752 pr " %s[len] = NULL;\n" n;
5756 pr " int %s = NUM2INT (%sv);\n" n n
5761 match fst style with
5762 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5763 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5764 | RConstString _ -> pr " const char *r;\n"; "NULL"
5765 | RString _ -> pr " char *r;\n"; "NULL"
5766 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5767 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
5768 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5769 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5770 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5771 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
5772 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
5775 pr " r = guestfs_%s " name;
5776 generate_call_args ~handle:"g" (snd style);
5781 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5783 pr " free (%s);\n" n
5786 pr " if (r == %s)\n" error_code;
5787 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
5790 (match fst style with
5792 pr " return Qnil;\n"
5793 | RInt _ | RBool _ ->
5794 pr " return INT2NUM (r);\n"
5796 pr " return ULL2NUM (r);\n"
5798 pr " return rb_str_new2 (r);\n";
5800 pr " VALUE rv = rb_str_new2 (r);\n";
5804 pr " int i, len = 0;\n";
5805 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
5806 pr " VALUE rv = rb_ary_new2 (len);\n";
5807 pr " for (i = 0; r[i] != NULL; ++i) {\n";
5808 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
5809 pr " free (r[i]);\n";
5814 pr " VALUE rv = rb_ary_new2 (2);\n";
5815 pr " rb_ary_push (rv, INT2NUM (r->i));\n";
5816 pr " rb_ary_push (rv, INT2NUM (r->b));\n";
5817 pr " guestfs_free_int_bool (r);\n";
5820 generate_ruby_lvm_code "pv" pv_cols
5822 generate_ruby_lvm_code "vg" vg_cols
5824 generate_ruby_lvm_code "lv" lv_cols
5826 pr " VALUE rv = rb_hash_new ();\n";
5830 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
5835 pr " VALUE rv = rb_hash_new ();\n";
5839 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
5844 pr " VALUE rv = rb_hash_new ();\n";
5846 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
5847 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
5848 pr " free (r[i]);\n";
5849 pr " free (r[i+1]);\n";
5860 /* Initialize the module. */
5861 void Init__guestfs ()
5863 m_guestfs = rb_define_module (\"Guestfs\");
5864 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
5865 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
5867 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
5868 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
5871 (* Define the rest of the methods. *)
5873 fun (name, style, _, _, _, _, _) ->
5874 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
5875 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
5880 (* Ruby code to return an LVM struct list. *)
5881 and generate_ruby_lvm_code typ cols =
5882 pr " VALUE rv = rb_ary_new2 (r->len);\n";
5884 pr " for (i = 0; i < r->len; ++i) {\n";
5885 pr " VALUE hv = rb_hash_new ();\n";
5889 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
5891 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
5894 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
5895 | name, `OptPercent ->
5896 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
5898 pr " rb_ary_push (rv, hv);\n";
5900 pr " guestfs_free_lvm_%s_list (r);\n" typ;
5903 (* Generate Java bindings GuestFS.java file. *)
5904 and generate_java_java () =
5905 generate_header CStyle LGPLv2;
5908 package com.redhat.et.libguestfs;
5910 import java.util.HashMap;
5911 import com.redhat.et.libguestfs.LibGuestFSException;
5912 import com.redhat.et.libguestfs.PV;
5913 import com.redhat.et.libguestfs.VG;
5914 import com.redhat.et.libguestfs.LV;
5915 import com.redhat.et.libguestfs.Stat;
5916 import com.redhat.et.libguestfs.StatVFS;
5917 import com.redhat.et.libguestfs.IntBool;
5920 * The GuestFS object is a libguestfs handle.
5924 public class GuestFS {
5925 // Load the native code.
5927 System.loadLibrary (\"guestfs_jni\");
5931 * The native guestfs_h pointer.
5936 * Create a libguestfs handle.
5938 * @throws LibGuestFSException
5940 public GuestFS () throws LibGuestFSException
5944 private native long _create () throws LibGuestFSException;
5947 * Close a libguestfs handle.
5949 * You can also leave handles to be collected by the garbage
5950 * collector, but this method ensures that the resources used
5951 * by the handle are freed up immediately. If you call any
5952 * other methods after closing the handle, you will get an
5955 * @throws LibGuestFSException
5957 public void close () throws LibGuestFSException
5963 private native void _close (long g) throws LibGuestFSException;
5965 public void finalize () throws LibGuestFSException
5973 fun (name, style, _, flags, _, shortdesc, longdesc) ->
5974 let doc = replace_str longdesc "C<guestfs_" "C<g." in
5976 if List.mem ProtocolLimitWarning flags then
5977 doc ^ "\n\n" ^ protocol_limit_warning
5980 if List.mem DangerWillRobinson flags then
5981 doc ^ "\n\n" ^ danger_will_robinson
5983 let doc = pod2text ~width:60 name doc in
5984 let doc = String.concat "\n * " doc in
5987 pr " * %s\n" shortdesc;
5990 pr " * @throws LibGuestFSException\n";
5993 generate_java_prototype ~public:true ~semicolon:false name style;
5996 pr " if (g == 0)\n";
5997 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
6000 if fst style <> RErr then pr "return ";
6002 generate_call_args ~handle:"g" (snd style);
6006 generate_java_prototype ~privat:true ~native:true name style;
6013 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
6014 ?(semicolon=true) name style =
6015 if privat then pr "private ";
6016 if public then pr "public ";
6017 if native then pr "native ";
6020 (match fst style with
6021 | RErr -> pr "void ";
6022 | RInt _ -> pr "int ";
6023 | RInt64 _ -> pr "long ";
6024 | RBool _ -> pr "boolean ";
6025 | RConstString _ | RString _ -> pr "String ";
6026 | RStringList _ -> pr "String[] ";
6027 | RIntBool _ -> pr "IntBool ";
6028 | RPVList _ -> pr "PV[] ";
6029 | RVGList _ -> pr "VG[] ";
6030 | RLVList _ -> pr "LV[] ";
6031 | RStat _ -> pr "Stat ";
6032 | RStatVFS _ -> pr "StatVFS ";
6033 | RHashtable _ -> pr "HashMap<String,String> ";
6036 if native then pr "_%s " name else pr "%s " name;
6038 let needs_comma = ref false in
6047 if !needs_comma then pr ", ";
6048 needs_comma := true;
6065 pr " throws LibGuestFSException";
6066 if semicolon then pr ";"
6068 and generate_java_struct typ cols =
6069 generate_header CStyle LGPLv2;
6072 package com.redhat.et.libguestfs;
6075 * Libguestfs %s structure.
6086 | name, `UUID -> pr " public String %s;\n" name
6088 | name, `Int -> pr " public long %s;\n" name
6089 | name, `OptPercent ->
6090 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
6091 pr " public float %s;\n" name
6096 and generate_java_c () =
6097 generate_header CStyle LGPLv2;
6104 #include \"com_redhat_et_libguestfs_GuestFS.h\"
6105 #include \"guestfs.h\"
6107 /* Note that this function returns. The exception is not thrown
6108 * until after the wrapper function returns.
6111 throw_exception (JNIEnv *env, const char *msg)
6114 cl = (*env)->FindClass (env,
6115 \"com/redhat/et/libguestfs/LibGuestFSException\");
6116 (*env)->ThrowNew (env, cl, msg);
6119 JNIEXPORT jlong JNICALL
6120 Java_com_redhat_et_libguestfs_GuestFS__1create
6121 (JNIEnv *env, jobject obj)
6125 g = guestfs_create ();
6127 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
6130 guestfs_set_error_handler (g, NULL, NULL);
6131 return (jlong) (long) g;
6134 JNIEXPORT void JNICALL
6135 Java_com_redhat_et_libguestfs_GuestFS__1close
6136 (JNIEnv *env, jobject obj, jlong jg)
6138 guestfs_h *g = (guestfs_h *) (long) jg;
6145 fun (name, style, _, _, _, _, _) ->
6147 (match fst style with
6148 | RErr -> pr "void ";
6149 | RInt _ -> pr "jint ";
6150 | RInt64 _ -> pr "jlong ";
6151 | RBool _ -> pr "jboolean ";
6152 | RConstString _ | RString _ -> pr "jstring ";
6153 | RIntBool _ | RStat _ | RStatVFS _ | RHashtable _ ->
6155 | RStringList _ | RPVList _ | RVGList _ | RLVList _ ->
6159 pr "Java_com_redhat_et_libguestfs_GuestFS_";
6160 pr "%s" (replace_str ("_" ^ name) "_" "_1");
6162 pr " (JNIEnv *env, jobject obj, jlong jg";
6169 pr ", jstring j%s" n
6171 pr ", jobjectArray j%s" n
6173 pr ", jboolean j%s" n
6179 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
6180 let error_code, no_ret =
6181 match fst style with
6182 | RErr -> pr " int r;\n"; "-1", ""
6184 | RInt _ -> pr " int r;\n"; "-1", "0"
6185 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
6186 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
6188 pr " jstring jr;\n";
6189 pr " char *r;\n"; "NULL", "NULL"
6191 pr " jobjectArray jr;\n";
6194 pr " jstring jstr;\n";
6195 pr " char **r;\n"; "NULL", "NULL"
6197 pr " jobject jr;\n";
6199 pr " jfieldID fl;\n";
6200 pr " struct guestfs_int_bool *r;\n"; "NULL", "NULL"
6202 pr " jobject jr;\n";
6204 pr " jfieldID fl;\n";
6205 pr " struct guestfs_stat *r;\n"; "NULL", "NULL"
6207 pr " jobject jr;\n";
6209 pr " jfieldID fl;\n";
6210 pr " struct guestfs_statvfs *r;\n"; "NULL", "NULL"
6212 pr " jobjectArray jr;\n";
6214 pr " jfieldID fl;\n";
6215 pr " jobject jfl;\n";
6216 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL", "NULL"
6218 pr " jobjectArray jr;\n";
6220 pr " jfieldID fl;\n";
6221 pr " jobject jfl;\n";
6222 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL", "NULL"
6224 pr " jobjectArray jr;\n";
6226 pr " jfieldID fl;\n";
6227 pr " jobject jfl;\n";
6228 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL", "NULL"
6229 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL" in
6236 pr " const char *%s;\n" n
6238 pr " int %s_len;\n" n;
6239 pr " const char **%s;\n" n
6246 (match fst style with
6247 | RStringList _ | RPVList _ | RVGList _ | RLVList _ -> true
6248 | RErr _ | RBool _ | RInt _ | RInt64 _ | RConstString _
6249 | RString _ | RIntBool _ | RStat _ | RStatVFS _
6250 | RHashtable _ -> false) ||
6251 List.exists (function StringList _ -> true | _ -> false) (snd style) in
6257 (* Get the parameters. *)
6264 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
6266 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
6267 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
6268 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6269 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6271 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
6273 pr " %s[%s_len] = NULL;\n" n n;
6276 pr " %s = j%s;\n" n n
6279 (* Make the call. *)
6280 pr " r = guestfs_%s " name;
6281 generate_call_args ~handle:"g" (snd style);
6284 (* Release the parameters. *)
6291 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
6293 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6294 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6296 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
6298 pr " free (%s);\n" n
6303 (* Check for errors. *)
6304 pr " if (r == %s) {\n" error_code;
6305 pr " throw_exception (env, guestfs_last_error (g));\n";
6306 pr " return %s;\n" no_ret;
6310 (match fst style with
6312 | RInt _ -> pr " return (jint) r;\n"
6313 | RBool _ -> pr " return (jboolean) r;\n"
6314 | RInt64 _ -> pr " return (jlong) r;\n"
6315 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
6317 pr " jr = (*env)->NewStringUTF (env, r);\n";
6321 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
6322 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
6323 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
6324 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
6325 pr " for (i = 0; i < r_len; ++i) {\n";
6326 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
6327 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
6328 pr " free (r[i]);\n";
6333 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/IntBool\");\n";
6334 pr " jr = (*env)->AllocObject (env, cl);\n";
6335 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"I\");\n";
6336 pr " (*env)->SetIntField (env, jr, fl, r->i);\n";
6337 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"Z\");\n";
6338 pr " (*env)->SetBooleanField (env, jr, fl, r->b);\n";
6339 pr " guestfs_free_int_bool (r);\n";
6342 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/Stat\");\n";
6343 pr " jr = (*env)->AllocObject (env, cl);\n";
6347 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
6349 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
6354 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/StatVFS\");\n";
6355 pr " jr = (*env)->AllocObject (env, cl);\n";
6359 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
6361 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
6366 generate_java_lvm_return "pv" "PV" pv_cols
6368 generate_java_lvm_return "vg" "VG" vg_cols
6370 generate_java_lvm_return "lv" "LV" lv_cols
6373 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
6374 pr " return NULL;\n"
6381 and generate_java_lvm_return typ jtyp cols =
6382 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
6383 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
6384 pr " for (i = 0; i < r->len; ++i) {\n";
6385 pr " jfl = (*env)->AllocObject (env, cl);\n";
6389 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
6390 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
6393 pr " char s[33];\n";
6394 pr " memcpy (s, r->val[i].%s, 32);\n" name;
6396 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
6397 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
6399 | name, (`Bytes|`Int) ->
6400 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
6401 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
6402 | name, `OptPercent ->
6403 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
6404 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
6406 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
6408 pr " guestfs_free_lvm_%s_list (r);\n" typ;
6411 let output_to filename =
6412 let filename_new = filename ^ ".new" in
6413 chan := open_out filename_new;
6418 (* Is the new file different from the current file? *)
6419 if Sys.file_exists filename && files_equal filename filename_new then
6420 Unix.unlink filename_new (* same, so skip it *)
6422 (* different, overwrite old one *)
6423 (try Unix.chmod filename 0o644 with Unix.Unix_error _ -> ());
6424 Unix.rename filename_new filename;
6425 Unix.chmod filename 0o444;
6426 printf "written %s\n%!" filename;
6435 if not (Sys.file_exists "configure.ac") then (
6437 You are probably running this from the wrong directory.
6438 Run it from the top source directory using the command
6444 let close = output_to "src/guestfs_protocol.x" in
6448 let close = output_to "src/guestfs-structs.h" in
6449 generate_structs_h ();
6452 let close = output_to "src/guestfs-actions.h" in
6453 generate_actions_h ();
6456 let close = output_to "src/guestfs-actions.c" in
6457 generate_client_actions ();
6460 let close = output_to "daemon/actions.h" in
6461 generate_daemon_actions_h ();
6464 let close = output_to "daemon/stubs.c" in
6465 generate_daemon_actions ();
6468 let close = output_to "tests.c" in
6472 let close = output_to "fish/cmds.c" in
6473 generate_fish_cmds ();
6476 let close = output_to "fish/completion.c" in
6477 generate_fish_completion ();
6480 let close = output_to "guestfs-structs.pod" in
6481 generate_structs_pod ();
6484 let close = output_to "guestfs-actions.pod" in
6485 generate_actions_pod ();
6488 let close = output_to "guestfish-actions.pod" in
6489 generate_fish_actions_pod ();
6492 let close = output_to "ocaml/guestfs.mli" in
6493 generate_ocaml_mli ();
6496 let close = output_to "ocaml/guestfs.ml" in
6497 generate_ocaml_ml ();
6500 let close = output_to "ocaml/guestfs_c_actions.c" in
6501 generate_ocaml_c ();
6504 let close = output_to "perl/Guestfs.xs" in
6505 generate_perl_xs ();
6508 let close = output_to "perl/lib/Sys/Guestfs.pm" in
6509 generate_perl_pm ();
6512 let close = output_to "python/guestfs-py.c" in
6513 generate_python_c ();
6516 let close = output_to "python/guestfs.py" in
6517 generate_python_py ();
6520 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
6524 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
6525 generate_java_java ();
6528 let close = output_to "java/com/redhat/et/libguestfs/PV.java" in
6529 generate_java_struct "PV" pv_cols;
6532 let close = output_to "java/com/redhat/et/libguestfs/VG.java" in
6533 generate_java_struct "VG" vg_cols;
6536 let close = output_to "java/com/redhat/et/libguestfs/LV.java" in
6537 generate_java_struct "LV" lv_cols;
6540 let close = output_to "java/com/redhat/et/libguestfs/Stat.java" in
6541 generate_java_struct "Stat" stat_cols;
6544 let close = output_to "java/com/redhat/et/libguestfs/StatVFS.java" in
6545 generate_java_struct "StatVFS" statvfs_cols;
6548 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in