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.");
1771 let all_functions = non_daemon_functions @ daemon_functions
1773 (* In some places we want the functions to be displayed sorted
1774 * alphabetically, so this is useful:
1776 let all_functions_sorted =
1777 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
1778 compare n1 n2) all_functions
1780 (* Column names and types from LVM PVs/VGs/LVs. *)
1789 "pv_attr", `String (* XXX *);
1790 "pv_pe_count", `Int;
1791 "pv_pe_alloc_count", `Int;
1794 "pv_mda_count", `Int;
1795 "pv_mda_free", `Bytes;
1796 (* Not in Fedora 10:
1797 "pv_mda_size", `Bytes;
1804 "vg_attr", `String (* XXX *);
1807 "vg_sysid", `String;
1808 "vg_extent_size", `Bytes;
1809 "vg_extent_count", `Int;
1810 "vg_free_count", `Int;
1818 "vg_mda_count", `Int;
1819 "vg_mda_free", `Bytes;
1820 (* Not in Fedora 10:
1821 "vg_mda_size", `Bytes;
1827 "lv_attr", `String (* XXX *);
1830 "lv_kernel_major", `Int;
1831 "lv_kernel_minor", `Int;
1835 "snap_percent", `OptPercent;
1836 "copy_percent", `OptPercent;
1839 "mirror_log", `String;
1843 (* Column names and types from stat structures.
1844 * NB. Can't use things like 'st_atime' because glibc header files
1845 * define some of these as macros. Ugh.
1862 let statvfs_cols = [
1876 (* Useful functions.
1877 * Note we don't want to use any external OCaml libraries which
1878 * makes this a bit harder than it should be.
1880 let failwithf fs = ksprintf failwith fs
1882 let replace_char s c1 c2 =
1883 let s2 = String.copy s in
1884 let r = ref false in
1885 for i = 0 to String.length s2 - 1 do
1886 if String.unsafe_get s2 i = c1 then (
1887 String.unsafe_set s2 i c2;
1891 if not !r then s else s2
1895 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
1897 let triml ?(test = isspace) str =
1899 let n = ref (String.length str) in
1900 while !n > 0 && test str.[!i]; do
1905 else String.sub str !i !n
1907 let trimr ?(test = isspace) str =
1908 let n = ref (String.length str) in
1909 while !n > 0 && test str.[!n-1]; do
1912 if !n = String.length str then str
1913 else String.sub str 0 !n
1915 let trim ?(test = isspace) str =
1916 trimr ~test (triml ~test str)
1918 let rec find s sub =
1919 let len = String.length s in
1920 let sublen = String.length sub in
1922 if i <= len-sublen then (
1924 if j < sublen then (
1925 if s.[i+j] = sub.[j] then loop2 (j+1)
1931 if r = -1 then loop (i+1) else r
1937 let rec replace_str s s1 s2 =
1938 let len = String.length s in
1939 let sublen = String.length s1 in
1940 let i = find s s1 in
1943 let s' = String.sub s 0 i in
1944 let s'' = String.sub s (i+sublen) (len-i-sublen) in
1945 s' ^ s2 ^ replace_str s'' s1 s2
1948 let rec string_split sep str =
1949 let len = String.length str in
1950 let seplen = String.length sep in
1951 let i = find str sep in
1952 if i = -1 then [str]
1954 let s' = String.sub str 0 i in
1955 let s'' = String.sub str (i+seplen) (len-i-seplen) in
1956 s' :: string_split sep s''
1959 let files_equal n1 n2 =
1960 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
1961 match Sys.command cmd with
1964 | i -> failwithf "%s: failed with error code %d" cmd i
1966 let rec find_map f = function
1967 | [] -> raise Not_found
1971 | None -> find_map f xs
1974 let rec loop i = function
1976 | x :: xs -> f i x; loop (i+1) xs
1981 let rec loop i = function
1983 | x :: xs -> let r = f i x in r :: loop (i+1) xs
1987 let name_of_argt = function
1988 | String n | OptString n | StringList n | Bool n | Int n
1989 | FileIn n | FileOut n -> n
1991 let seq_of_test = function
1992 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
1993 | TestOutputInt (s, _) | TestOutputTrue s | TestOutputFalse s
1994 | TestOutputLength (s, _) | TestOutputStruct (s, _)
1995 | TestLastFail s -> s
1997 (* Check function names etc. for consistency. *)
1998 let check_functions () =
1999 let contains_uppercase str =
2000 let len = String.length str in
2002 if i >= len then false
2005 if c >= 'A' && c <= 'Z' then true
2012 (* Check function names. *)
2014 fun (name, _, _, _, _, _, _) ->
2015 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
2016 failwithf "function name %s does not need 'guestfs' prefix" name;
2017 if contains_uppercase name then
2018 failwithf "function name %s should not contain uppercase chars" name;
2019 if String.contains name '-' then
2020 failwithf "function name %s should not contain '-', use '_' instead."
2024 (* Check function parameter/return names. *)
2026 fun (name, style, _, _, _, _, _) ->
2027 let check_arg_ret_name n =
2028 if contains_uppercase n then
2029 failwithf "%s param/ret %s should not contain uppercase chars"
2031 if String.contains n '-' || String.contains n '_' then
2032 failwithf "%s param/ret %s should not contain '-' or '_'"
2035 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;
2036 if n = "argv" || n = "args" then
2037 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" n
2040 (match fst style with
2042 | RInt n | RInt64 n | RBool n | RConstString n | RString n
2043 | RStringList n | RPVList n | RVGList n | RLVList n
2044 | RStat n | RStatVFS n
2046 check_arg_ret_name n
2048 check_arg_ret_name n;
2049 check_arg_ret_name m
2051 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
2054 (* Check short descriptions. *)
2056 fun (name, _, _, _, _, shortdesc, _) ->
2057 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
2058 failwithf "short description of %s should begin with lowercase." name;
2059 let c = shortdesc.[String.length shortdesc-1] in
2060 if c = '\n' || c = '.' then
2061 failwithf "short description of %s should not end with . or \\n." name
2064 (* Check long dscriptions. *)
2066 fun (name, _, _, _, _, _, longdesc) ->
2067 if longdesc.[String.length longdesc-1] = '\n' then
2068 failwithf "long description of %s should not end with \\n." name
2071 (* Check proc_nrs. *)
2073 fun (name, _, proc_nr, _, _, _, _) ->
2074 if proc_nr <= 0 then
2075 failwithf "daemon function %s should have proc_nr > 0" name
2079 fun (name, _, proc_nr, _, _, _, _) ->
2080 if proc_nr <> -1 then
2081 failwithf "non-daemon function %s should have proc_nr -1" name
2082 ) non_daemon_functions;
2085 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
2088 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
2089 let rec loop = function
2092 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
2094 | (name1,nr1) :: (name2,nr2) :: _ ->
2095 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
2103 (* Ignore functions that have no tests. We generate a
2104 * warning when the user does 'make check' instead.
2106 | name, _, _, _, [], _, _ -> ()
2107 | name, _, _, _, tests, _, _ ->
2111 match seq_of_test test with
2113 failwithf "%s has a test containing an empty sequence" name
2114 | cmds -> List.map List.hd cmds
2116 let funcs = List.flatten funcs in
2118 let tested = List.mem name funcs in
2121 failwithf "function %s has tests but does not test itself" name
2124 (* 'pr' prints to the current output file. *)
2125 let chan = ref stdout
2126 let pr fs = ksprintf (output_string !chan) fs
2128 (* Generate a header block in a number of standard styles. *)
2129 type comment_style = CStyle | HashStyle | OCamlStyle
2130 type license = GPLv2 | LGPLv2
2132 let generate_header comment license =
2133 let c = match comment with
2134 | CStyle -> pr "/* "; " *"
2135 | HashStyle -> pr "# "; "#"
2136 | OCamlStyle -> pr "(* "; " *" in
2137 pr "libguestfs generated file\n";
2138 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
2139 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
2141 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
2145 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
2146 pr "%s it under the terms of the GNU General Public License as published by\n" c;
2147 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
2148 pr "%s (at your option) any later version.\n" c;
2150 pr "%s This program is distributed in the hope that it will be useful,\n" c;
2151 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2152 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
2153 pr "%s GNU General Public License for more details.\n" c;
2155 pr "%s You should have received a copy of the GNU General Public License along\n" c;
2156 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
2157 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
2160 pr "%s This library is free software; you can redistribute it and/or\n" c;
2161 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
2162 pr "%s License as published by the Free Software Foundation; either\n" c;
2163 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
2165 pr "%s This library is distributed in the hope that it will be useful,\n" c;
2166 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2167 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
2168 pr "%s Lesser General Public License for more details.\n" c;
2170 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
2171 pr "%s License along with this library; if not, write to the Free Software\n" c;
2172 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
2175 | CStyle -> pr " */\n"
2177 | OCamlStyle -> pr " *)\n"
2181 (* Start of main code generation functions below this line. *)
2183 (* Generate the pod documentation for the C API. *)
2184 let rec generate_actions_pod () =
2186 fun (shortname, style, _, flags, _, _, longdesc) ->
2187 let name = "guestfs_" ^ shortname in
2188 pr "=head2 %s\n\n" name;
2190 generate_prototype ~extern:false ~handle:"handle" name style;
2192 pr "%s\n\n" longdesc;
2193 (match fst style with
2195 pr "This function returns 0 on success or -1 on error.\n\n"
2197 pr "On error this function returns -1.\n\n"
2199 pr "On error this function returns -1.\n\n"
2201 pr "This function returns a C truth value on success or -1 on error.\n\n"
2203 pr "This function returns a string, or NULL on error.
2204 The string is owned by the guest handle and must I<not> be freed.\n\n"
2206 pr "This function returns a string, or NULL on error.
2207 I<The caller must free the returned string after use>.\n\n"
2209 pr "This function returns a NULL-terminated array of strings
2210 (like L<environ(3)>), or NULL if there was an error.
2211 I<The caller must free the strings and the array after use>.\n\n"
2213 pr "This function returns a C<struct guestfs_int_bool *>,
2214 or NULL if there was an error.
2215 I<The caller must call C<guestfs_free_int_bool> after use>.\n\n"
2217 pr "This function returns a C<struct guestfs_lvm_pv_list *>
2218 (see E<lt>guestfs-structs.hE<gt>),
2219 or NULL if there was an error.
2220 I<The caller must call C<guestfs_free_lvm_pv_list> after use>.\n\n"
2222 pr "This function returns a C<struct guestfs_lvm_vg_list *>
2223 (see E<lt>guestfs-structs.hE<gt>),
2224 or NULL if there was an error.
2225 I<The caller must call C<guestfs_free_lvm_vg_list> after use>.\n\n"
2227 pr "This function returns a C<struct guestfs_lvm_lv_list *>
2228 (see E<lt>guestfs-structs.hE<gt>),
2229 or NULL if there was an error.
2230 I<The caller must call C<guestfs_free_lvm_lv_list> after use>.\n\n"
2232 pr "This function returns a C<struct guestfs_stat *>
2233 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
2234 or NULL if there was an error.
2235 I<The caller must call C<free> after use>.\n\n"
2237 pr "This function returns a C<struct guestfs_statvfs *>
2238 (see L<statvfs(2)> and E<lt>guestfs-structs.hE<gt>),
2239 or NULL if there was an error.
2240 I<The caller must call C<free> after use>.\n\n"
2242 pr "This function returns a NULL-terminated array of
2243 strings, or NULL if there was an error.
2244 The array of strings will always have length C<2n+1>, where
2245 C<n> keys and values alternate, followed by the trailing NULL entry.
2246 I<The caller must free the strings and the array after use>.\n\n"
2248 if List.mem ProtocolLimitWarning flags then
2249 pr "%s\n\n" protocol_limit_warning;
2250 if List.mem DangerWillRobinson flags then
2251 pr "%s\n\n" danger_will_robinson;
2252 ) all_functions_sorted
2254 and generate_structs_pod () =
2255 (* LVM structs documentation. *)
2258 pr "=head2 guestfs_lvm_%s\n" typ;
2260 pr " struct guestfs_lvm_%s {\n" typ;
2263 | name, `String -> pr " char *%s;\n" name
2265 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
2266 pr " char %s[32];\n" name
2267 | name, `Bytes -> pr " uint64_t %s;\n" name
2268 | name, `Int -> pr " int64_t %s;\n" name
2269 | name, `OptPercent ->
2270 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
2271 pr " float %s;\n" name
2274 pr " struct guestfs_lvm_%s_list {\n" typ;
2275 pr " uint32_t len; /* Number of elements in list. */\n";
2276 pr " struct guestfs_lvm_%s *val; /* Elements. */\n" typ;
2279 pr " void guestfs_free_lvm_%s_list (struct guestfs_free_lvm_%s_list *);\n"
2282 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
2284 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
2285 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
2287 * We have to use an underscore instead of a dash because otherwise
2288 * rpcgen generates incorrect code.
2290 * This header is NOT exported to clients, but see also generate_structs_h.
2292 and generate_xdr () =
2293 generate_header CStyle LGPLv2;
2295 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
2296 pr "typedef string str<>;\n";
2299 (* LVM internal structures. *)
2303 pr "struct guestfs_lvm_int_%s {\n" typ;
2305 | name, `String -> pr " string %s<>;\n" name
2306 | name, `UUID -> pr " opaque %s[32];\n" name
2307 | name, `Bytes -> pr " hyper %s;\n" name
2308 | name, `Int -> pr " hyper %s;\n" name
2309 | name, `OptPercent -> pr " float %s;\n" name
2313 pr "typedef struct guestfs_lvm_int_%s guestfs_lvm_int_%s_list<>;\n" typ typ;
2315 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2317 (* Stat internal structures. *)
2321 pr "struct guestfs_int_%s {\n" typ;
2323 | name, `Int -> pr " hyper %s;\n" name
2327 ) ["stat", stat_cols; "statvfs", statvfs_cols];
2330 fun (shortname, style, _, _, _, _, _) ->
2331 let name = "guestfs_" ^ shortname in
2333 (match snd style with
2336 pr "struct %s_args {\n" name;
2339 | String n -> pr " string %s<>;\n" n
2340 | OptString n -> pr " str *%s;\n" n
2341 | StringList n -> pr " str %s<>;\n" n
2342 | Bool n -> pr " bool %s;\n" n
2343 | Int n -> pr " int %s;\n" n
2344 | FileIn _ | FileOut _ -> ()
2348 (match fst style with
2351 pr "struct %s_ret {\n" name;
2355 pr "struct %s_ret {\n" name;
2356 pr " hyper %s;\n" n;
2359 pr "struct %s_ret {\n" name;
2363 failwithf "RConstString cannot be returned from a daemon function"
2365 pr "struct %s_ret {\n" name;
2366 pr " string %s<>;\n" n;
2369 pr "struct %s_ret {\n" name;
2370 pr " str %s<>;\n" n;
2373 pr "struct %s_ret {\n" name;
2378 pr "struct %s_ret {\n" name;
2379 pr " guestfs_lvm_int_pv_list %s;\n" n;
2382 pr "struct %s_ret {\n" name;
2383 pr " guestfs_lvm_int_vg_list %s;\n" n;
2386 pr "struct %s_ret {\n" name;
2387 pr " guestfs_lvm_int_lv_list %s;\n" n;
2390 pr "struct %s_ret {\n" name;
2391 pr " guestfs_int_stat %s;\n" n;
2394 pr "struct %s_ret {\n" name;
2395 pr " guestfs_int_statvfs %s;\n" n;
2398 pr "struct %s_ret {\n" name;
2399 pr " str %s<>;\n" n;
2404 (* Table of procedure numbers. *)
2405 pr "enum guestfs_procedure {\n";
2407 fun (shortname, _, proc_nr, _, _, _, _) ->
2408 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
2410 pr " GUESTFS_PROC_NR_PROCS\n";
2414 (* Having to choose a maximum message size is annoying for several
2415 * reasons (it limits what we can do in the API), but it (a) makes
2416 * the protocol a lot simpler, and (b) provides a bound on the size
2417 * of the daemon which operates in limited memory space. For large
2418 * file transfers you should use FTP.
2420 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
2423 (* Message header, etc. *)
2425 /* The communication protocol is now documented in the guestfs(3)
2429 const GUESTFS_PROGRAM = 0x2000F5F5;
2430 const GUESTFS_PROTOCOL_VERSION = 1;
2432 /* These constants must be larger than any possible message length. */
2433 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
2434 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
2436 enum guestfs_message_direction {
2437 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
2438 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
2441 enum guestfs_message_status {
2442 GUESTFS_STATUS_OK = 0,
2443 GUESTFS_STATUS_ERROR = 1
2446 const GUESTFS_ERROR_LEN = 256;
2448 struct guestfs_message_error {
2449 string error_message<GUESTFS_ERROR_LEN>;
2452 struct guestfs_message_header {
2453 unsigned prog; /* GUESTFS_PROGRAM */
2454 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
2455 guestfs_procedure proc; /* GUESTFS_PROC_x */
2456 guestfs_message_direction direction;
2457 unsigned serial; /* message serial number */
2458 guestfs_message_status status;
2461 const GUESTFS_MAX_CHUNK_SIZE = 8192;
2463 struct guestfs_chunk {
2464 int cancel; /* if non-zero, transfer is cancelled */
2465 /* data size is 0 bytes if the transfer has finished successfully */
2466 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
2470 (* Generate the guestfs-structs.h file. *)
2471 and generate_structs_h () =
2472 generate_header CStyle LGPLv2;
2474 (* This is a public exported header file containing various
2475 * structures. The structures are carefully written to have
2476 * exactly the same in-memory format as the XDR structures that
2477 * we use on the wire to the daemon. The reason for creating
2478 * copies of these structures here is just so we don't have to
2479 * export the whole of guestfs_protocol.h (which includes much
2480 * unrelated and XDR-dependent stuff that we don't want to be
2481 * public, or required by clients).
2483 * To reiterate, we will pass these structures to and from the
2484 * client with a simple assignment or memcpy, so the format
2485 * must be identical to what rpcgen / the RFC defines.
2488 (* guestfs_int_bool structure. *)
2489 pr "struct guestfs_int_bool {\n";
2495 (* LVM public structures. *)
2499 pr "struct guestfs_lvm_%s {\n" typ;
2502 | name, `String -> pr " char *%s;\n" name
2503 | name, `UUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
2504 | name, `Bytes -> pr " uint64_t %s;\n" name
2505 | name, `Int -> pr " int64_t %s;\n" name
2506 | name, `OptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
2510 pr "struct guestfs_lvm_%s_list {\n" typ;
2511 pr " uint32_t len;\n";
2512 pr " struct guestfs_lvm_%s *val;\n" typ;
2515 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2517 (* Stat structures. *)
2521 pr "struct guestfs_%s {\n" typ;
2524 | name, `Int -> pr " int64_t %s;\n" name
2528 ) ["stat", stat_cols; "statvfs", statvfs_cols]
2530 (* Generate the guestfs-actions.h file. *)
2531 and generate_actions_h () =
2532 generate_header CStyle LGPLv2;
2534 fun (shortname, style, _, _, _, _, _) ->
2535 let name = "guestfs_" ^ shortname in
2536 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
2540 (* Generate the client-side dispatch stubs. *)
2541 and generate_client_actions () =
2542 generate_header CStyle LGPLv2;
2548 #include \"guestfs.h\"
2549 #include \"guestfs_protocol.h\"
2551 #define error guestfs_error
2552 #define perrorf guestfs_perrorf
2553 #define safe_malloc guestfs_safe_malloc
2554 #define safe_realloc guestfs_safe_realloc
2555 #define safe_strdup guestfs_safe_strdup
2556 #define safe_memdup guestfs_safe_memdup
2558 /* Check the return message from a call for validity. */
2560 check_reply_header (guestfs_h *g,
2561 const struct guestfs_message_header *hdr,
2562 int proc_nr, int serial)
2564 if (hdr->prog != GUESTFS_PROGRAM) {
2565 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
2568 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
2569 error (g, \"wrong protocol version (%%d/%%d)\",
2570 hdr->vers, GUESTFS_PROTOCOL_VERSION);
2573 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
2574 error (g, \"unexpected message direction (%%d/%%d)\",
2575 hdr->direction, GUESTFS_DIRECTION_REPLY);
2578 if (hdr->proc != proc_nr) {
2579 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
2582 if (hdr->serial != serial) {
2583 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
2590 /* Check we are in the right state to run a high-level action. */
2592 check_state (guestfs_h *g, const char *caller)
2594 if (!guestfs_is_ready (g)) {
2595 if (guestfs_is_config (g))
2596 error (g, \"%%s: call launch() before using this function\",
2598 else if (guestfs_is_launching (g))
2599 error (g, \"%%s: call wait_ready() before using this function\",
2602 error (g, \"%%s called from the wrong state, %%d != READY\",
2603 caller, guestfs_get_state (g));
2611 (* Client-side stubs for each function. *)
2613 fun (shortname, style, _, _, _, _, _) ->
2614 let name = "guestfs_" ^ shortname in
2616 (* Generate the context struct which stores the high-level
2617 * state between callback functions.
2619 pr "struct %s_ctx {\n" shortname;
2620 pr " /* This flag is set by the callbacks, so we know we've done\n";
2621 pr " * the callbacks as expected, and in the right sequence.\n";
2622 pr " * 0 = not called, 1 = reply_cb called.\n";
2624 pr " int cb_sequence;\n";
2625 pr " struct guestfs_message_header hdr;\n";
2626 pr " struct guestfs_message_error err;\n";
2627 (match fst style with
2630 failwithf "RConstString cannot be returned from a daemon function"
2632 | RBool _ | RString _ | RStringList _
2634 | RPVList _ | RVGList _ | RLVList _
2635 | RStat _ | RStatVFS _
2637 pr " struct %s_ret ret;\n" name
2642 (* Generate the reply callback function. *)
2643 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
2645 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
2646 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
2648 pr " /* This should definitely not happen. */\n";
2649 pr " if (ctx->cb_sequence != 0) {\n";
2650 pr " ctx->cb_sequence = 9999;\n";
2651 pr " error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
2655 pr " ml->main_loop_quit (ml, g);\n";
2657 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
2658 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
2661 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
2662 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
2663 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
2670 (match fst style with
2673 failwithf "RConstString cannot be returned from a daemon function"
2675 | RBool _ | RString _ | RStringList _
2677 | RPVList _ | RVGList _ | RLVList _
2678 | RStat _ | RStatVFS _
2680 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
2681 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
2687 pr " ctx->cb_sequence = 1;\n";
2690 (* Generate the action stub. *)
2691 generate_prototype ~extern:false ~semicolon:false ~newline:true
2692 ~handle:"g" name style;
2695 match fst style with
2696 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
2698 failwithf "RConstString cannot be returned from a daemon function"
2699 | RString _ | RStringList _ | RIntBool _
2700 | RPVList _ | RVGList _ | RLVList _
2701 | RStat _ | RStatVFS _
2707 (match snd style with
2709 | _ -> pr " struct %s_args args;\n" name
2712 pr " struct %s_ctx ctx;\n" shortname;
2713 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
2714 pr " int serial;\n";
2716 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
2717 pr " guestfs_set_busy (g);\n";
2719 pr " memset (&ctx, 0, sizeof ctx);\n";
2722 (* Send the main header and arguments. *)
2723 (match snd style with
2725 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
2726 (String.uppercase shortname)
2731 pr " args.%s = (char *) %s;\n" n n
2733 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
2735 pr " args.%s.%s_val = (char **) %s;\n" n n n;
2736 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
2738 pr " args.%s = %s;\n" n n
2740 pr " args.%s = %s;\n" n n
2741 | FileIn _ | FileOut _ -> ()
2743 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
2744 (String.uppercase shortname);
2745 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
2748 pr " if (serial == -1) {\n";
2749 pr " guestfs_set_ready (g);\n";
2750 pr " return %s;\n" error_code;
2754 (* Send any additional files (FileIn) requested. *)
2755 let need_read_reply_label = ref false in
2762 pr " r = guestfs__send_file_sync (g, %s);\n" n;
2763 pr " if (r == -1) {\n";
2764 pr " guestfs_set_ready (g);\n";
2765 pr " return %s;\n" error_code;
2767 pr " if (r == -2) /* daemon cancelled */\n";
2768 pr " goto read_reply;\n";
2769 need_read_reply_label := true;
2775 (* Wait for the reply from the remote end. *)
2776 if !need_read_reply_label then pr " read_reply:\n";
2777 pr " guestfs__switch_to_receiving (g);\n";
2778 pr " ctx.cb_sequence = 0;\n";
2779 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
2780 pr " (void) ml->main_loop_run (ml, g);\n";
2781 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
2782 pr " if (ctx.cb_sequence != 1) {\n";
2783 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
2784 pr " guestfs_set_ready (g);\n";
2785 pr " return %s;\n" error_code;
2789 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
2790 (String.uppercase shortname);
2791 pr " guestfs_set_ready (g);\n";
2792 pr " return %s;\n" error_code;
2796 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
2797 pr " error (g, \"%%s\", ctx.err.error_message);\n";
2798 pr " guestfs_set_ready (g);\n";
2799 pr " return %s;\n" error_code;
2803 (* Expecting to receive further files (FileOut)? *)
2807 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
2808 pr " guestfs_set_ready (g);\n";
2809 pr " return %s;\n" error_code;
2815 pr " guestfs_set_ready (g);\n";
2817 (match fst style with
2818 | RErr -> pr " return 0;\n"
2819 | RInt n | RInt64 n | RBool n ->
2820 pr " return ctx.ret.%s;\n" n
2822 failwithf "RConstString cannot be returned from a daemon function"
2824 pr " return ctx.ret.%s; /* caller will free */\n" n
2825 | RStringList n | RHashtable n ->
2826 pr " /* caller will free this, but we need to add a NULL entry */\n";
2827 pr " ctx.ret.%s.%s_val =\n" n n;
2828 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
2829 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
2831 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
2832 pr " return ctx.ret.%s.%s_val;\n" n n
2834 pr " /* caller with free this */\n";
2835 pr " return safe_memdup (g, &ctx.ret, sizeof (ctx.ret));\n"
2836 | RPVList n | RVGList n | RLVList n
2837 | RStat n | RStatVFS n ->
2838 pr " /* caller will free this */\n";
2839 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
2845 (* Generate daemon/actions.h. *)
2846 and generate_daemon_actions_h () =
2847 generate_header CStyle GPLv2;
2849 pr "#include \"../src/guestfs_protocol.h\"\n";
2853 fun (name, style, _, _, _, _, _) ->
2855 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
2859 (* Generate the server-side stubs. *)
2860 and generate_daemon_actions () =
2861 generate_header CStyle GPLv2;
2863 pr "#include <config.h>\n";
2865 pr "#include <stdio.h>\n";
2866 pr "#include <stdlib.h>\n";
2867 pr "#include <string.h>\n";
2868 pr "#include <inttypes.h>\n";
2869 pr "#include <ctype.h>\n";
2870 pr "#include <rpc/types.h>\n";
2871 pr "#include <rpc/xdr.h>\n";
2873 pr "#include \"daemon.h\"\n";
2874 pr "#include \"../src/guestfs_protocol.h\"\n";
2875 pr "#include \"actions.h\"\n";
2879 fun (name, style, _, _, _, _, _) ->
2880 (* Generate server-side stubs. *)
2881 pr "static void %s_stub (XDR *xdr_in)\n" name;
2884 match fst style with
2885 | RErr | RInt _ -> pr " int r;\n"; "-1"
2886 | RInt64 _ -> pr " int64_t r;\n"; "-1"
2887 | RBool _ -> pr " int r;\n"; "-1"
2889 failwithf "RConstString cannot be returned from a daemon function"
2890 | RString _ -> pr " char *r;\n"; "NULL"
2891 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
2892 | RIntBool _ -> pr " guestfs_%s_ret *r;\n" name; "NULL"
2893 | RPVList _ -> pr " guestfs_lvm_int_pv_list *r;\n"; "NULL"
2894 | RVGList _ -> pr " guestfs_lvm_int_vg_list *r;\n"; "NULL"
2895 | RLVList _ -> pr " guestfs_lvm_int_lv_list *r;\n"; "NULL"
2896 | RStat _ -> pr " guestfs_int_stat *r;\n"; "NULL"
2897 | RStatVFS _ -> pr " guestfs_int_statvfs *r;\n"; "NULL" in
2899 (match snd style with
2902 pr " struct guestfs_%s_args args;\n" name;
2906 | OptString n -> pr " const char *%s;\n" n
2907 | StringList n -> pr " char **%s;\n" n
2908 | Bool n -> pr " int %s;\n" n
2909 | Int n -> pr " int %s;\n" n
2910 | FileIn _ | FileOut _ -> ()
2915 (match snd style with
2918 pr " memset (&args, 0, sizeof args);\n";
2920 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
2921 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
2926 | String n -> pr " %s = args.%s;\n" n n
2927 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
2929 pr " %s = realloc (args.%s.%s_val,\n" n n n;
2930 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
2931 pr " if (%s == NULL) {\n" n;
2932 pr " reply_with_perror (\"realloc\");\n";
2935 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
2936 pr " args.%s.%s_val = %s;\n" n n n;
2937 | Bool n -> pr " %s = args.%s;\n" n n
2938 | Int n -> pr " %s = args.%s;\n" n n
2939 | FileIn _ | FileOut _ -> ()
2944 (* Don't want to call the impl with any FileIn or FileOut
2945 * parameters, since these go "outside" the RPC protocol.
2948 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
2950 pr " r = do_%s " name;
2951 generate_call_args argsnofile;
2954 pr " if (r == %s)\n" error_code;
2955 pr " /* do_%s has already called reply_with_error */\n" name;
2959 (* If there are any FileOut parameters, then the impl must
2960 * send its own reply.
2963 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
2965 pr " /* do_%s has already sent a reply */\n" name
2967 match fst style with
2968 | RErr -> pr " reply (NULL, NULL);\n"
2969 | RInt n | RInt64 n | RBool n ->
2970 pr " struct guestfs_%s_ret ret;\n" name;
2971 pr " ret.%s = r;\n" n;
2972 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
2975 failwithf "RConstString cannot be returned from a daemon function"
2977 pr " struct guestfs_%s_ret ret;\n" name;
2978 pr " ret.%s = r;\n" n;
2979 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
2982 | RStringList n | RHashtable n ->
2983 pr " struct guestfs_%s_ret ret;\n" name;
2984 pr " ret.%s.%s_len = count_strings (r);\n" n n;
2985 pr " ret.%s.%s_val = r;\n" n n;
2986 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
2988 pr " free_strings (r);\n"
2990 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n"
2992 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n" name
2993 | RPVList n | RVGList n | RLVList n
2994 | RStat n | RStatVFS n ->
2995 pr " struct guestfs_%s_ret ret;\n" name;
2996 pr " ret.%s = *r;\n" n;
2997 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
2999 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
3003 (* Free the args. *)
3004 (match snd style with
3009 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
3016 (* Dispatch function. *)
3017 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
3019 pr " switch (proc_nr) {\n";
3022 fun (name, style, _, _, _, _, _) ->
3023 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
3024 pr " %s_stub (xdr_in);\n" name;
3029 pr " reply_with_error (\"dispatch_incoming_message: unknown procedure number %%d\", proc_nr);\n";
3034 (* LVM columns and tokenization functions. *)
3035 (* XXX This generates crap code. We should rethink how we
3041 pr "static const char *lvm_%s_cols = \"%s\";\n"
3042 typ (String.concat "," (List.map fst cols));
3045 pr "static int lvm_tokenize_%s (char *str, struct guestfs_lvm_int_%s *r)\n" typ typ;
3047 pr " char *tok, *p, *next;\n";
3051 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
3054 pr " if (!str) {\n";
3055 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
3058 pr " if (!*str || isspace (*str)) {\n";
3059 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
3064 fun (name, coltype) ->
3065 pr " if (!tok) {\n";
3066 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
3069 pr " p = strchrnul (tok, ',');\n";
3070 pr " if (*p) next = p+1; else next = NULL;\n";
3071 pr " *p = '\\0';\n";
3074 pr " r->%s = strdup (tok);\n" name;
3075 pr " if (r->%s == NULL) {\n" name;
3076 pr " perror (\"strdup\");\n";
3080 pr " for (i = j = 0; i < 32; ++j) {\n";
3081 pr " if (tok[j] == '\\0') {\n";
3082 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
3084 pr " } else if (tok[j] != '-')\n";
3085 pr " r->%s[i++] = tok[j];\n" name;
3088 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
3089 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3093 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
3094 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3098 pr " if (tok[0] == '\\0')\n";
3099 pr " r->%s = -1;\n" name;
3100 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
3101 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3105 pr " tok = next;\n";
3108 pr " if (tok != NULL) {\n";
3109 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
3116 pr "guestfs_lvm_int_%s_list *\n" typ;
3117 pr "parse_command_line_%ss (void)\n" typ;
3119 pr " char *out, *err;\n";
3120 pr " char *p, *pend;\n";
3122 pr " guestfs_lvm_int_%s_list *ret;\n" typ;
3123 pr " void *newp;\n";
3125 pr " ret = malloc (sizeof *ret);\n";
3126 pr " if (!ret) {\n";
3127 pr " reply_with_perror (\"malloc\");\n";
3128 pr " return NULL;\n";
3131 pr " ret->guestfs_lvm_int_%s_list_len = 0;\n" typ;
3132 pr " ret->guestfs_lvm_int_%s_list_val = NULL;\n" typ;
3134 pr " r = command (&out, &err,\n";
3135 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
3136 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
3137 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
3138 pr " if (r == -1) {\n";
3139 pr " reply_with_error (\"%%s\", err);\n";
3140 pr " free (out);\n";
3141 pr " free (err);\n";
3142 pr " free (ret);\n";
3143 pr " return NULL;\n";
3146 pr " free (err);\n";
3148 pr " /* Tokenize each line of the output. */\n";
3151 pr " while (p) {\n";
3152 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
3153 pr " if (pend) {\n";
3154 pr " *pend = '\\0';\n";
3158 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
3161 pr " if (!*p) { /* Empty line? Skip it. */\n";
3166 pr " /* Allocate some space to store this next entry. */\n";
3167 pr " newp = realloc (ret->guestfs_lvm_int_%s_list_val,\n" typ;
3168 pr " sizeof (guestfs_lvm_int_%s) * (i+1));\n" typ;
3169 pr " if (newp == NULL) {\n";
3170 pr " reply_with_perror (\"realloc\");\n";
3171 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3172 pr " free (ret);\n";
3173 pr " free (out);\n";
3174 pr " return NULL;\n";
3176 pr " ret->guestfs_lvm_int_%s_list_val = newp;\n" typ;
3178 pr " /* Tokenize the next entry. */\n";
3179 pr " r = lvm_tokenize_%s (p, &ret->guestfs_lvm_int_%s_list_val[i]);\n" typ typ;
3180 pr " if (r == -1) {\n";
3181 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
3182 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3183 pr " free (ret);\n";
3184 pr " free (out);\n";
3185 pr " return NULL;\n";
3192 pr " ret->guestfs_lvm_int_%s_list_len = i;\n" typ;
3194 pr " free (out);\n";
3195 pr " return ret;\n";
3198 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
3200 (* Generate the tests. *)
3201 and generate_tests () =
3202 generate_header CStyle GPLv2;
3209 #include <sys/types.h>
3212 #include \"guestfs.h\"
3214 static guestfs_h *g;
3215 static int suppress_error = 0;
3217 static void print_error (guestfs_h *g, void *data, const char *msg)
3219 if (!suppress_error)
3220 fprintf (stderr, \"%%s\\n\", msg);
3223 static void print_strings (char * const * const argv)
3227 for (argc = 0; argv[argc] != NULL; ++argc)
3228 printf (\"\\t%%s\\n\", argv[argc]);
3232 static void print_table (char * const * const argv)
3236 for (i = 0; argv[i] != NULL; i += 2)
3237 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
3241 static void no_test_warnings (void)
3247 | name, _, _, _, [], _, _ ->
3248 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
3249 | name, _, _, _, tests, _, _ -> ()
3255 (* Generate the actual tests. Note that we generate the tests
3256 * in reverse order, deliberately, so that (in general) the
3257 * newest tests run first. This makes it quicker and easier to
3262 fun (name, _, _, _, tests, _, _) ->
3263 mapi (generate_one_test name) tests
3264 ) (List.rev all_functions) in
3265 let test_names = List.concat test_names in
3266 let nr_tests = List.length test_names in
3269 int main (int argc, char *argv[])
3274 const char *filename;
3276 int nr_tests, test_num = 0;
3278 no_test_warnings ();
3280 g = guestfs_create ();
3282 printf (\"guestfs_create FAILED\\n\");
3286 guestfs_set_error_handler (g, print_error, NULL);
3288 srcdir = getenv (\"srcdir\");
3289 if (!srcdir) srcdir = \".\";
3291 guestfs_set_path (g, \".\");
3293 filename = \"test1.img\";
3294 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3299 if (lseek (fd, %d, SEEK_SET) == -1) {
3305 if (write (fd, &c, 1) == -1) {
3311 if (close (fd) == -1) {
3316 if (guestfs_add_drive (g, filename) == -1) {
3317 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3321 filename = \"test2.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 = \"test3.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 if (guestfs_launch (g) == -1) {
3378 printf (\"guestfs_launch FAILED\\n\");
3381 if (guestfs_wait_ready (g) == -1) {
3382 printf (\"guestfs_wait_ready FAILED\\n\");
3388 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
3392 pr " test_num++;\n";
3393 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
3394 pr " if (%s () == -1) {\n" test_name;
3395 pr " printf (\"%s FAILED\\n\");\n" test_name;
3401 pr " guestfs_close (g);\n";
3402 pr " unlink (\"test1.img\");\n";
3403 pr " unlink (\"test2.img\");\n";
3404 pr " unlink (\"test3.img\");\n";
3407 pr " if (failed > 0) {\n";
3408 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
3416 and generate_one_test name i (init, test) =
3417 let test_name = sprintf "test_%s_%d" name i in
3419 pr "static int %s (void)\n" test_name;
3425 pr " /* InitEmpty for %s (%d) */\n" name i;
3426 List.iter (generate_test_command_call test_name)
3430 pr " /* InitBasicFS for %s (%d): create ext2 on /dev/sda1 */\n" name i;
3431 List.iter (generate_test_command_call test_name)
3434 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
3435 ["mkfs"; "ext2"; "/dev/sda1"];
3436 ["mount"; "/dev/sda1"; "/"]]
3437 | InitBasicFSonLVM ->
3438 pr " /* InitBasicFSonLVM for %s (%d): create ext2 on /dev/VG/LV */\n"
3440 List.iter (generate_test_command_call test_name)
3443 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
3444 ["pvcreate"; "/dev/sda1"];
3445 ["vgcreate"; "VG"; "/dev/sda1"];
3446 ["lvcreate"; "LV"; "VG"; "8"];
3447 ["mkfs"; "ext2"; "/dev/VG/LV"];
3448 ["mount"; "/dev/VG/LV"; "/"]]
3451 let get_seq_last = function
3453 failwithf "%s: you cannot use [] (empty list) when expecting a command"
3456 let seq = List.rev seq in
3457 List.rev (List.tl seq), List.hd seq
3462 pr " /* TestRun for %s (%d) */\n" name i;
3463 List.iter (generate_test_command_call test_name) seq
3464 | TestOutput (seq, expected) ->
3465 pr " /* TestOutput for %s (%d) */\n" name i;
3466 let seq, last = get_seq_last seq in
3468 pr " if (strcmp (r, \"%s\") != 0) {\n" (c_quote expected);
3469 pr " fprintf (stderr, \"%s: expected \\\"%s\\\" but got \\\"%%s\\\"\\n\", r);\n" test_name (c_quote expected);
3473 List.iter (generate_test_command_call test_name) seq;
3474 generate_test_command_call ~test test_name last
3475 | TestOutputList (seq, expected) ->
3476 pr " /* TestOutputList for %s (%d) */\n" name i;
3477 let seq, last = get_seq_last seq in
3481 pr " if (!r[%d]) {\n" i;
3482 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
3483 pr " print_strings (r);\n";
3486 pr " if (strcmp (r[%d], \"%s\") != 0) {\n" i (c_quote str);
3487 pr " fprintf (stderr, \"%s: expected \\\"%s\\\" but got \\\"%%s\\\"\\n\", r[%d]);\n" test_name (c_quote str) i;
3491 pr " if (r[%d] != NULL) {\n" (List.length expected);
3492 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
3494 pr " print_strings (r);\n";
3498 List.iter (generate_test_command_call test_name) seq;
3499 generate_test_command_call ~test test_name last
3500 | TestOutputInt (seq, expected) ->
3501 pr " /* TestOutputInt for %s (%d) */\n" name i;
3502 let seq, last = get_seq_last seq in
3504 pr " if (r != %d) {\n" expected;
3505 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
3511 List.iter (generate_test_command_call test_name) seq;
3512 generate_test_command_call ~test test_name last
3513 | TestOutputTrue seq ->
3514 pr " /* TestOutputTrue for %s (%d) */\n" name i;
3515 let seq, last = get_seq_last seq in
3518 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
3523 List.iter (generate_test_command_call test_name) seq;
3524 generate_test_command_call ~test test_name last
3525 | TestOutputFalse seq ->
3526 pr " /* TestOutputFalse for %s (%d) */\n" name i;
3527 let seq, last = get_seq_last seq in
3530 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
3535 List.iter (generate_test_command_call test_name) seq;
3536 generate_test_command_call ~test test_name last
3537 | TestOutputLength (seq, expected) ->
3538 pr " /* TestOutputLength for %s (%d) */\n" name i;
3539 let seq, last = get_seq_last seq in
3542 pr " for (j = 0; j < %d; ++j)\n" expected;
3543 pr " if (r[j] == NULL) {\n";
3544 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
3546 pr " print_strings (r);\n";
3549 pr " if (r[j] != NULL) {\n";
3550 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
3552 pr " print_strings (r);\n";
3556 List.iter (generate_test_command_call test_name) seq;
3557 generate_test_command_call ~test test_name last
3558 | TestOutputStruct (seq, checks) ->
3559 pr " /* TestOutputStruct for %s (%d) */\n" name i;
3560 let seq, last = get_seq_last seq in
3564 | CompareWithInt (field, expected) ->
3565 pr " if (r->%s != %d) {\n" field expected;
3566 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
3567 test_name field expected;
3568 pr " (int) r->%s);\n" field;
3571 | CompareWithString (field, expected) ->
3572 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
3573 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
3574 test_name field expected;
3575 pr " r->%s);\n" field;
3578 | CompareFieldsIntEq (field1, field2) ->
3579 pr " if (r->%s != r->%s) {\n" field1 field2;
3580 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
3581 test_name field1 field2;
3582 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
3585 | CompareFieldsStrEq (field1, field2) ->
3586 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
3587 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
3588 test_name field1 field2;
3589 pr " r->%s, r->%s);\n" field1 field2;
3594 List.iter (generate_test_command_call test_name) seq;
3595 generate_test_command_call ~test test_name last
3596 | TestLastFail seq ->
3597 pr " /* TestLastFail for %s (%d) */\n" name i;
3598 let seq, last = get_seq_last seq in
3599 List.iter (generate_test_command_call test_name) seq;
3600 generate_test_command_call test_name ~expect_error:true last
3608 (* Generate the code to run a command, leaving the result in 'r'.
3609 * If you expect to get an error then you should set expect_error:true.
3611 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
3613 | [] -> assert false
3615 (* Look up the command to find out what args/ret it has. *)
3618 let _, style, _, _, _, _, _ =
3619 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
3622 failwithf "%s: in test, command %s was not found" test_name name in
3624 if List.length (snd style) <> List.length args then
3625 failwithf "%s: in test, wrong number of args given to %s"
3636 | FileIn _, _ | FileOut _, _ -> ()
3637 | StringList n, arg ->
3638 pr " char *%s[] = {\n" n;
3639 let strs = string_split " " arg in
3641 fun str -> pr " \"%s\",\n" (c_quote str)
3645 ) (List.combine (snd style) args);
3648 match fst style with
3649 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
3650 | RInt64 _ -> pr " int64_t r;\n"; "-1"
3651 | RConstString _ -> pr " const char *r;\n"; "NULL"
3652 | RString _ -> pr " char *r;\n"; "NULL"
3653 | RStringList _ | RHashtable _ ->
3658 pr " struct guestfs_int_bool *r;\n"; "NULL"
3660 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
3662 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
3664 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
3666 pr " struct guestfs_stat *r;\n"; "NULL"
3668 pr " struct guestfs_statvfs *r;\n"; "NULL" in
3670 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
3671 pr " r = guestfs_%s (g" name;
3673 (* Generate the parameters. *)
3677 | FileIn _, arg | FileOut _, arg ->
3678 pr ", \"%s\"" (c_quote arg)
3679 | OptString _, arg ->
3680 if arg = "NULL" then pr ", NULL" else pr ", \"%s\"" (c_quote arg)
3681 | StringList n, _ ->
3685 try int_of_string arg
3686 with Failure "int_of_string" ->
3687 failwithf "%s: expecting an int, but got '%s'" test_name arg in
3690 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
3691 ) (List.combine (snd style) args);
3694 if not expect_error then
3695 pr " if (r == %s)\n" error_code
3697 pr " if (r != %s)\n" error_code;
3700 (* Insert the test code. *)
3706 (match fst style with
3707 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _ -> ()
3708 | RString _ -> pr " free (r);\n"
3709 | RStringList _ | RHashtable _ ->
3710 pr " for (i = 0; r[i] != NULL; ++i)\n";
3711 pr " free (r[i]);\n";
3714 pr " guestfs_free_int_bool (r);\n"
3716 pr " guestfs_free_lvm_pv_list (r);\n"
3718 pr " guestfs_free_lvm_vg_list (r);\n"
3720 pr " guestfs_free_lvm_lv_list (r);\n"
3721 | RStat _ | RStatVFS _ ->
3728 let str = replace_str str "\r" "\\r" in
3729 let str = replace_str str "\n" "\\n" in
3730 let str = replace_str str "\t" "\\t" in
3733 (* Generate a lot of different functions for guestfish. *)
3734 and generate_fish_cmds () =
3735 generate_header CStyle GPLv2;
3739 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3741 let all_functions_sorted =
3743 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
3744 ) all_functions_sorted in
3746 pr "#include <stdio.h>\n";
3747 pr "#include <stdlib.h>\n";
3748 pr "#include <string.h>\n";
3749 pr "#include <inttypes.h>\n";
3751 pr "#include <guestfs.h>\n";
3752 pr "#include \"fish.h\"\n";
3755 (* list_commands function, which implements guestfish -h *)
3756 pr "void list_commands (void)\n";
3758 pr " printf (\" %%-16s %%s\\n\", \"Command\", \"Description\");\n";
3759 pr " list_builtin_commands ();\n";
3761 fun (name, _, _, flags, _, shortdesc, _) ->
3762 let name = replace_char name '_' '-' in
3763 pr " printf (\"%%-20s %%s\\n\", \"%s\", \"%s\");\n"
3765 ) all_functions_sorted;
3766 pr " printf (\" Use -h <cmd> / help <cmd> to show detailed help for a command.\\n\");\n";
3770 (* display_command function, which implements guestfish -h cmd *)
3771 pr "void display_command (const char *cmd)\n";
3774 fun (name, style, _, flags, _, shortdesc, longdesc) ->
3775 let name2 = replace_char name '_' '-' in
3777 try find_map (function FishAlias n -> Some n | _ -> None) flags
3778 with Not_found -> name in
3779 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
3781 match snd style with
3785 name2 (String.concat "> <" (List.map name_of_argt args)) in
3788 if List.mem ProtocolLimitWarning flags then
3789 ("\n\n" ^ protocol_limit_warning)
3792 (* For DangerWillRobinson commands, we should probably have
3793 * guestfish prompt before allowing you to use them (especially
3794 * in interactive mode). XXX
3798 if List.mem DangerWillRobinson flags then
3799 ("\n\n" ^ danger_will_robinson)
3802 let describe_alias =
3803 if name <> alias then
3804 sprintf "\n\nYou can use '%s' as an alias for this command." alias
3808 pr "strcasecmp (cmd, \"%s\") == 0" name;
3809 if name <> name2 then
3810 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
3811 if name <> alias then
3812 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
3814 pr " pod2text (\"%s - %s\", %S);\n"
3816 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
3819 pr " display_builtin_command (cmd);\n";
3823 (* print_{pv,vg,lv}_list functions *)
3827 pr "static void print_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
3834 pr " printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
3836 pr " printf (\"%s: \");\n" name;
3837 pr " for (i = 0; i < 32; ++i)\n";
3838 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
3839 pr " printf (\"\\n\");\n"
3841 pr " printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
3843 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
3844 | name, `OptPercent ->
3845 pr " if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
3846 typ name name typ name;
3847 pr " else printf (\"%s: \\n\");\n" name
3851 pr "static void print_%s_list (struct guestfs_lvm_%s_list *%ss)\n"
3856 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
3857 pr " print_%s (&%ss->val[i]);\n" typ typ;
3860 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
3862 (* print_{stat,statvfs} functions *)
3866 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
3871 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
3875 ) ["stat", stat_cols; "statvfs", statvfs_cols];
3877 (* run_<action> actions *)
3879 fun (name, style, _, flags, _, _, _) ->
3880 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
3882 (match fst style with
3885 | RBool _ -> pr " int r;\n"
3886 | RInt64 _ -> pr " int64_t r;\n"
3887 | RConstString _ -> pr " const char *r;\n"
3888 | RString _ -> pr " char *r;\n"
3889 | RStringList _ | RHashtable _ -> pr " char **r;\n"
3890 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"
3891 | RPVList _ -> pr " struct guestfs_lvm_pv_list *r;\n"
3892 | RVGList _ -> pr " struct guestfs_lvm_vg_list *r;\n"
3893 | RLVList _ -> pr " struct guestfs_lvm_lv_list *r;\n"
3894 | RStat _ -> pr " struct guestfs_stat *r;\n"
3895 | RStatVFS _ -> pr " struct guestfs_statvfs *r;\n"
3902 | FileOut n -> pr " const char *%s;\n" n
3903 | StringList n -> pr " char **%s;\n" n
3904 | Bool n -> pr " int %s;\n" n
3905 | Int n -> pr " int %s;\n" n
3908 (* Check and convert parameters. *)
3909 let argc_expected = List.length (snd style) in
3910 pr " if (argc != %d) {\n" argc_expected;
3911 pr " fprintf (stderr, \"%%s should have %d parameter(s)\\n\", cmd);\n"
3913 pr " fprintf (stderr, \"type 'help %%s' for help on %%s\\n\", cmd, cmd);\n";
3919 | String name -> pr " %s = argv[%d];\n" name i
3921 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
3924 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
3927 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
3929 | StringList name ->
3930 pr " %s = parse_string_list (argv[%d]);\n" name i
3932 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
3934 pr " %s = atoi (argv[%d]);\n" name i
3937 (* Call C API function. *)
3939 try find_map (function FishAction n -> Some n | _ -> None) flags
3940 with Not_found -> sprintf "guestfs_%s" name in
3942 generate_call_args ~handle:"g" (snd style);
3945 (* Check return value for errors and display command results. *)
3946 (match fst style with
3947 | RErr -> pr " return r;\n"
3949 pr " if (r == -1) return -1;\n";
3950 pr " printf (\"%%d\\n\", r);\n";
3953 pr " if (r == -1) return -1;\n";
3954 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
3957 pr " if (r == -1) return -1;\n";
3958 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
3961 pr " if (r == NULL) return -1;\n";
3962 pr " printf (\"%%s\\n\", r);\n";
3965 pr " if (r == NULL) return -1;\n";
3966 pr " printf (\"%%s\\n\", r);\n";
3970 pr " if (r == NULL) return -1;\n";
3971 pr " print_strings (r);\n";
3972 pr " free_strings (r);\n";
3975 pr " if (r == NULL) return -1;\n";
3976 pr " printf (\"%%d, %%s\\n\", r->i,\n";
3977 pr " r->b ? \"true\" : \"false\");\n";
3978 pr " guestfs_free_int_bool (r);\n";
3981 pr " if (r == NULL) return -1;\n";
3982 pr " print_pv_list (r);\n";
3983 pr " guestfs_free_lvm_pv_list (r);\n";
3986 pr " if (r == NULL) return -1;\n";
3987 pr " print_vg_list (r);\n";
3988 pr " guestfs_free_lvm_vg_list (r);\n";
3991 pr " if (r == NULL) return -1;\n";
3992 pr " print_lv_list (r);\n";
3993 pr " guestfs_free_lvm_lv_list (r);\n";
3996 pr " if (r == NULL) return -1;\n";
3997 pr " print_stat (r);\n";
4001 pr " if (r == NULL) return -1;\n";
4002 pr " print_statvfs (r);\n";
4006 pr " if (r == NULL) return -1;\n";
4007 pr " print_table (r);\n";
4008 pr " free_strings (r);\n";
4015 (* run_action function *)
4016 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
4019 fun (name, _, _, flags, _, _, _) ->
4020 let name2 = replace_char name '_' '-' in
4022 try find_map (function FishAlias n -> Some n | _ -> None) flags
4023 with Not_found -> name in
4025 pr "strcasecmp (cmd, \"%s\") == 0" name;
4026 if name <> name2 then
4027 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
4028 if name <> alias then
4029 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
4031 pr " return run_%s (cmd, argc, argv);\n" name;
4035 pr " fprintf (stderr, \"%%s: unknown command\\n\", cmd);\n";
4042 (* Readline completion for guestfish. *)
4043 and generate_fish_completion () =
4044 generate_header CStyle GPLv2;
4048 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4058 #ifdef HAVE_LIBREADLINE
4059 #include <readline/readline.h>
4064 #ifdef HAVE_LIBREADLINE
4066 static const char *const commands[] = {
4069 (* Get the commands and sort them, including the aliases. *)
4072 fun (name, _, _, flags, _, _, _) ->
4073 let name2 = replace_char name '_' '-' in
4075 try find_map (function FishAlias n -> Some n | _ -> None) flags
4076 with Not_found -> name in
4078 if name <> alias then [name2; alias] else [name2]
4080 let commands = List.flatten commands in
4081 let commands = List.sort compare commands in
4083 List.iter (pr " \"%s\",\n") commands;
4089 generator (const char *text, int state)
4091 static int index, len;
4096 len = strlen (text);
4099 while ((name = commands[index]) != NULL) {
4101 if (strncasecmp (name, text, len) == 0)
4102 return strdup (name);
4108 #endif /* HAVE_LIBREADLINE */
4110 char **do_completion (const char *text, int start, int end)
4112 char **matches = NULL;
4114 #ifdef HAVE_LIBREADLINE
4116 matches = rl_completion_matches (text, generator);
4123 (* Generate the POD documentation for guestfish. *)
4124 and generate_fish_actions_pod () =
4125 let all_functions_sorted =
4127 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4128 ) all_functions_sorted in
4130 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
4133 fun (name, style, _, flags, _, _, longdesc) ->
4135 Str.global_substitute rex (
4138 try Str.matched_group 1 s
4140 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
4141 "C<" ^ replace_char sub '_' '-' ^ ">"
4143 let name = replace_char name '_' '-' in
4145 try find_map (function FishAlias n -> Some n | _ -> None) flags
4146 with Not_found -> name in
4148 pr "=head2 %s" name;
4149 if name <> alias then
4156 | String n -> pr " %s" n
4157 | OptString n -> pr " %s" n
4158 | StringList n -> pr " '%s ...'" n
4159 | Bool _ -> pr " true|false"
4160 | Int n -> pr " %s" n
4161 | FileIn n | FileOut n -> pr " (%s|-)" n
4165 pr "%s\n\n" longdesc;
4167 if List.exists (function FileIn _ | FileOut _ -> true
4168 | _ -> false) (snd style) then
4169 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
4171 if List.mem ProtocolLimitWarning flags then
4172 pr "%s\n\n" protocol_limit_warning;
4174 if List.mem DangerWillRobinson flags then
4175 pr "%s\n\n" danger_will_robinson
4176 ) all_functions_sorted
4178 (* Generate a C function prototype. *)
4179 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
4180 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
4182 ?handle name style =
4183 if extern then pr "extern ";
4184 if static then pr "static ";
4185 (match fst style with
4187 | RInt _ -> pr "int "
4188 | RInt64 _ -> pr "int64_t "
4189 | RBool _ -> pr "int "
4190 | RConstString _ -> pr "const char *"
4191 | RString _ -> pr "char *"
4192 | RStringList _ | RHashtable _ -> pr "char **"
4194 if not in_daemon then pr "struct guestfs_int_bool *"
4195 else pr "guestfs_%s_ret *" name
4197 if not in_daemon then pr "struct guestfs_lvm_pv_list *"
4198 else pr "guestfs_lvm_int_pv_list *"
4200 if not in_daemon then pr "struct guestfs_lvm_vg_list *"
4201 else pr "guestfs_lvm_int_vg_list *"
4203 if not in_daemon then pr "struct guestfs_lvm_lv_list *"
4204 else pr "guestfs_lvm_int_lv_list *"
4206 if not in_daemon then pr "struct guestfs_stat *"
4207 else pr "guestfs_int_stat *"
4209 if not in_daemon then pr "struct guestfs_statvfs *"
4210 else pr "guestfs_int_statvfs *"
4212 pr "%s%s (" prefix name;
4213 if handle = None && List.length (snd style) = 0 then
4216 let comma = ref false in
4219 | Some handle -> pr "guestfs_h *%s" handle; comma := true
4223 if single_line then pr ", " else pr ",\n\t\t"
4230 | OptString n -> next (); pr "const char *%s" n
4231 | StringList n -> next (); pr "char * const* const %s" n
4232 | Bool n -> next (); pr "int %s" n
4233 | Int n -> next (); pr "int %s" n
4236 if not in_daemon then (next (); pr "const char *%s" n)
4240 if semicolon then pr ";";
4241 if newline then pr "\n"
4243 (* Generate C call arguments, eg "(handle, foo, bar)" *)
4244 and generate_call_args ?handle args =
4246 let comma = ref false in
4249 | Some handle -> pr "%s" handle; comma := true
4253 if !comma then pr ", ";
4255 pr "%s" (name_of_argt arg)
4259 (* Generate the OCaml bindings interface. *)
4260 and generate_ocaml_mli () =
4261 generate_header OCamlStyle LGPLv2;
4264 (** For API documentation you should refer to the C API
4265 in the guestfs(3) manual page. The OCaml API uses almost
4266 exactly the same calls. *)
4269 (** A [guestfs_h] handle. *)
4271 exception Error of string
4272 (** This exception is raised when there is an error. *)
4274 val create : unit -> t
4276 val close : t -> unit
4277 (** Handles are closed by the garbage collector when they become
4278 unreferenced, but callers can also call this in order to
4279 provide predictable cleanup. *)
4282 generate_ocaml_lvm_structure_decls ();
4284 generate_ocaml_stat_structure_decls ();
4288 fun (name, style, _, _, _, shortdesc, _) ->
4289 generate_ocaml_prototype name style;
4290 pr "(** %s *)\n" shortdesc;
4294 (* Generate the OCaml bindings implementation. *)
4295 and generate_ocaml_ml () =
4296 generate_header OCamlStyle LGPLv2;
4300 exception Error of string
4301 external create : unit -> t = \"ocaml_guestfs_create\"
4302 external close : t -> unit = \"ocaml_guestfs_close\"
4305 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
4309 generate_ocaml_lvm_structure_decls ();
4311 generate_ocaml_stat_structure_decls ();
4315 fun (name, style, _, _, _, shortdesc, _) ->
4316 generate_ocaml_prototype ~is_external:true name style;
4319 (* Generate the OCaml bindings C implementation. *)
4320 and generate_ocaml_c () =
4321 generate_header CStyle LGPLv2;
4328 #include <caml/config.h>
4329 #include <caml/alloc.h>
4330 #include <caml/callback.h>
4331 #include <caml/fail.h>
4332 #include <caml/memory.h>
4333 #include <caml/mlvalues.h>
4334 #include <caml/signals.h>
4336 #include <guestfs.h>
4338 #include \"guestfs_c.h\"
4340 /* Copy a hashtable of string pairs into an assoc-list. We return
4341 * the list in reverse order, but hashtables aren't supposed to be
4344 static CAMLprim value
4345 copy_table (char * const * argv)
4348 CAMLlocal5 (rv, pairv, kv, vv, cons);
4352 for (i = 0; argv[i] != NULL; i += 2) {
4353 kv = caml_copy_string (argv[i]);
4354 vv = caml_copy_string (argv[i+1]);
4355 pairv = caml_alloc (2, 0);
4356 Store_field (pairv, 0, kv);
4357 Store_field (pairv, 1, vv);
4358 cons = caml_alloc (2, 0);
4359 Store_field (cons, 1, rv);
4361 Store_field (cons, 0, pairv);
4369 (* LVM struct copy functions. *)
4372 let has_optpercent_col =
4373 List.exists (function (_, `OptPercent) -> true | _ -> false) cols in
4375 pr "static CAMLprim value\n";
4376 pr "copy_lvm_%s (const struct guestfs_lvm_%s *%s)\n" typ typ typ;
4378 pr " CAMLparam0 ();\n";
4379 if has_optpercent_col then
4380 pr " CAMLlocal3 (rv, v, v2);\n"
4382 pr " CAMLlocal2 (rv, v);\n";
4384 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
4389 pr " v = caml_copy_string (%s->%s);\n" typ name
4391 pr " v = caml_alloc_string (32);\n";
4392 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
4395 pr " v = caml_copy_int64 (%s->%s);\n" typ name
4396 | name, `OptPercent ->
4397 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
4398 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
4399 pr " v = caml_alloc (1, 0);\n";
4400 pr " Store_field (v, 0, v2);\n";
4401 pr " } else /* None */\n";
4402 pr " v = Val_int (0);\n";
4404 pr " Store_field (rv, %d, v);\n" i
4406 pr " CAMLreturn (rv);\n";
4410 pr "static CAMLprim value\n";
4411 pr "copy_lvm_%s_list (const struct guestfs_lvm_%s_list *%ss)\n"
4414 pr " CAMLparam0 ();\n";
4415 pr " CAMLlocal2 (rv, v);\n";
4418 pr " if (%ss->len == 0)\n" typ;
4419 pr " CAMLreturn (Atom (0));\n";
4421 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
4422 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
4423 pr " v = copy_lvm_%s (&%ss->val[i]);\n" typ typ;
4424 pr " caml_modify (&Field (rv, i), v);\n";
4426 pr " CAMLreturn (rv);\n";
4430 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
4432 (* Stat copy functions. *)
4435 pr "static CAMLprim value\n";
4436 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
4438 pr " CAMLparam0 ();\n";
4439 pr " CAMLlocal2 (rv, v);\n";
4441 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
4446 pr " v = caml_copy_int64 (%s->%s);\n" typ name
4448 pr " Store_field (rv, %d, v);\n" i
4450 pr " CAMLreturn (rv);\n";
4453 ) ["stat", stat_cols; "statvfs", statvfs_cols];
4457 fun (name, style, _, _, _, _, _) ->
4459 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
4461 pr "CAMLprim value\n";
4462 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
4463 List.iter (pr ", value %s") (List.tl params);
4468 | [p1; p2; p3; p4; p5] ->
4469 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
4470 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
4471 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
4472 pr " CAMLxparam%d (%s);\n"
4473 (List.length rest) (String.concat ", " rest)
4475 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
4477 pr " CAMLlocal1 (rv);\n";
4480 pr " guestfs_h *g = Guestfs_val (gv);\n";
4481 pr " if (g == NULL)\n";
4482 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
4490 pr " const char *%s = String_val (%sv);\n" n n
4492 pr " const char *%s =\n" n;
4493 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
4496 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
4498 pr " int %s = Bool_val (%sv);\n" n n
4500 pr " int %s = Int_val (%sv);\n" n n
4503 match fst style with
4504 | RErr -> pr " int r;\n"; "-1"
4505 | RInt _ -> pr " int r;\n"; "-1"
4506 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4507 | RBool _ -> pr " int r;\n"; "-1"
4508 | RConstString _ -> pr " const char *r;\n"; "NULL"
4509 | RString _ -> pr " char *r;\n"; "NULL"
4515 pr " struct guestfs_int_bool *r;\n"; "NULL"
4517 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
4519 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
4521 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
4523 pr " struct guestfs_stat *r;\n"; "NULL"
4525 pr " struct guestfs_statvfs *r;\n"; "NULL"
4532 pr " caml_enter_blocking_section ();\n";
4533 pr " r = guestfs_%s " name;
4534 generate_call_args ~handle:"g" (snd style);
4536 pr " caml_leave_blocking_section ();\n";
4541 pr " ocaml_guestfs_free_strings (%s);\n" n;
4542 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
4545 pr " if (r == %s)\n" error_code;
4546 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
4549 (match fst style with
4550 | RErr -> pr " rv = Val_unit;\n"
4551 | RInt _ -> pr " rv = Val_int (r);\n"
4553 pr " rv = caml_copy_int64 (r);\n"
4554 | RBool _ -> pr " rv = Val_bool (r);\n"
4555 | RConstString _ -> pr " rv = caml_copy_string (r);\n"
4557 pr " rv = caml_copy_string (r);\n";
4560 pr " rv = caml_copy_string_array ((const char **) r);\n";
4561 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
4564 pr " rv = caml_alloc (2, 0);\n";
4565 pr " Store_field (rv, 0, Val_int (r->i));\n";
4566 pr " Store_field (rv, 1, Val_bool (r->b));\n";
4567 pr " guestfs_free_int_bool (r);\n";
4569 pr " rv = copy_lvm_pv_list (r);\n";
4570 pr " guestfs_free_lvm_pv_list (r);\n";
4572 pr " rv = copy_lvm_vg_list (r);\n";
4573 pr " guestfs_free_lvm_vg_list (r);\n";
4575 pr " rv = copy_lvm_lv_list (r);\n";
4576 pr " guestfs_free_lvm_lv_list (r);\n";
4578 pr " rv = copy_stat (r);\n";
4581 pr " rv = copy_statvfs (r);\n";
4584 pr " rv = copy_table (r);\n";
4585 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
4589 pr " CAMLreturn (rv);\n";
4593 if List.length params > 5 then (
4594 pr "CAMLprim value\n";
4595 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
4597 pr " return ocaml_guestfs_%s (argv[0]" name;
4598 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
4605 and generate_ocaml_lvm_structure_decls () =
4608 pr "type lvm_%s = {\n" typ;
4611 | name, `String -> pr " %s : string;\n" name
4612 | name, `UUID -> pr " %s : string;\n" name
4613 | name, `Bytes -> pr " %s : int64;\n" name
4614 | name, `Int -> pr " %s : int64;\n" name
4615 | name, `OptPercent -> pr " %s : float option;\n" name
4619 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
4621 and generate_ocaml_stat_structure_decls () =
4624 pr "type %s = {\n" typ;
4627 | name, `Int -> pr " %s : int64;\n" name
4631 ) ["stat", stat_cols; "statvfs", statvfs_cols]
4633 and generate_ocaml_prototype ?(is_external = false) name style =
4634 if is_external then pr "external " else pr "val ";
4635 pr "%s : t -> " name;
4638 | String _ | FileIn _ | FileOut _ -> pr "string -> "
4639 | OptString _ -> pr "string option -> "
4640 | StringList _ -> pr "string array -> "
4641 | Bool _ -> pr "bool -> "
4642 | Int _ -> pr "int -> "
4644 (match fst style with
4645 | RErr -> pr "unit" (* all errors are turned into exceptions *)
4646 | RInt _ -> pr "int"
4647 | RInt64 _ -> pr "int64"
4648 | RBool _ -> pr "bool"
4649 | RConstString _ -> pr "string"
4650 | RString _ -> pr "string"
4651 | RStringList _ -> pr "string array"
4652 | RIntBool _ -> pr "int * bool"
4653 | RPVList _ -> pr "lvm_pv array"
4654 | RVGList _ -> pr "lvm_vg array"
4655 | RLVList _ -> pr "lvm_lv array"
4656 | RStat _ -> pr "stat"
4657 | RStatVFS _ -> pr "statvfs"
4658 | RHashtable _ -> pr "(string * string) list"
4660 if is_external then (
4662 if List.length (snd style) + 1 > 5 then
4663 pr "\"ocaml_guestfs_%s_byte\" " name;
4664 pr "\"ocaml_guestfs_%s\"" name
4668 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
4669 and generate_perl_xs () =
4670 generate_header CStyle LGPLv2;
4673 #include \"EXTERN.h\"
4677 #include <guestfs.h>
4680 #define PRId64 \"lld\"
4684 my_newSVll(long long val) {
4685 #ifdef USE_64_BIT_ALL
4686 return newSViv(val);
4690 len = snprintf(buf, 100, \"%%\" PRId64, val);
4691 return newSVpv(buf, len);
4696 #define PRIu64 \"llu\"
4700 my_newSVull(unsigned long long val) {
4701 #ifdef USE_64_BIT_ALL
4702 return newSVuv(val);
4706 len = snprintf(buf, 100, \"%%\" PRIu64, val);
4707 return newSVpv(buf, len);
4711 /* http://www.perlmonks.org/?node_id=680842 */
4713 XS_unpack_charPtrPtr (SV *arg) {
4718 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
4719 croak (\"array reference expected\");
4721 av = (AV *)SvRV (arg);
4722 ret = malloc (av_len (av) + 1 + 1);
4724 croak (\"malloc failed\");
4726 for (i = 0; i <= av_len (av); i++) {
4727 SV **elem = av_fetch (av, i, 0);
4729 if (!elem || !*elem)
4730 croak (\"missing element in list\");
4732 ret[i] = SvPV_nolen (*elem);
4740 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
4745 RETVAL = guestfs_create ();
4747 croak (\"could not create guestfs handle\");
4748 guestfs_set_error_handler (RETVAL, NULL, NULL);
4761 fun (name, style, _, _, _, _, _) ->
4762 (match fst style with
4763 | RErr -> pr "void\n"
4764 | RInt _ -> pr "SV *\n"
4765 | RInt64 _ -> pr "SV *\n"
4766 | RBool _ -> pr "SV *\n"
4767 | RConstString _ -> pr "SV *\n"
4768 | RString _ -> pr "SV *\n"
4771 | RPVList _ | RVGList _ | RLVList _
4772 | RStat _ | RStatVFS _
4774 pr "void\n" (* all lists returned implictly on the stack *)
4776 (* Call and arguments. *)
4778 generate_call_args ~handle:"g" (snd style);
4780 pr " guestfs_h *g;\n";
4783 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
4784 | OptString n -> pr " char *%s;\n" n
4785 | StringList n -> pr " char **%s;\n" n
4786 | Bool n -> pr " int %s;\n" n
4787 | Int n -> pr " int %s;\n" n
4790 let do_cleanups () =
4793 | String _ | OptString _ | Bool _ | Int _
4794 | FileIn _ | FileOut _ -> ()
4795 | StringList n -> pr " free (%s);\n" n
4800 (match fst style with
4805 pr " r = guestfs_%s " name;
4806 generate_call_args ~handle:"g" (snd style);
4809 pr " if (r == -1)\n";
4810 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4816 pr " %s = guestfs_%s " n name;
4817 generate_call_args ~handle:"g" (snd style);
4820 pr " if (%s == -1)\n" n;
4821 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4822 pr " RETVAL = newSViv (%s);\n" n;
4827 pr " int64_t %s;\n" n;
4829 pr " %s = guestfs_%s " n name;
4830 generate_call_args ~handle:"g" (snd style);
4833 pr " if (%s == -1)\n" n;
4834 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4835 pr " RETVAL = my_newSVll (%s);\n" n;
4840 pr " const char *%s;\n" n;
4842 pr " %s = guestfs_%s " n name;
4843 generate_call_args ~handle:"g" (snd style);
4846 pr " if (%s == NULL)\n" n;
4847 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4848 pr " RETVAL = newSVpv (%s, 0);\n" n;
4853 pr " char *%s;\n" n;
4855 pr " %s = guestfs_%s " n name;
4856 generate_call_args ~handle:"g" (snd style);
4859 pr " if (%s == NULL)\n" n;
4860 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4861 pr " RETVAL = newSVpv (%s, 0);\n" n;
4862 pr " free (%s);\n" n;
4865 | RStringList n | RHashtable n ->
4867 pr " 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 " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
4877 pr " EXTEND (SP, n);\n";
4878 pr " for (i = 0; i < n; ++i) {\n";
4879 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
4880 pr " free (%s[i]);\n" n;
4882 pr " free (%s);\n" n;
4885 pr " struct guestfs_int_bool *r;\n";
4887 pr " r = guestfs_%s " name;
4888 generate_call_args ~handle:"g" (snd style);
4891 pr " if (r == NULL)\n";
4892 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4893 pr " EXTEND (SP, 2);\n";
4894 pr " PUSHs (sv_2mortal (newSViv (r->i)));\n";
4895 pr " PUSHs (sv_2mortal (newSViv (r->b)));\n";
4896 pr " guestfs_free_int_bool (r);\n";
4898 generate_perl_lvm_code "pv" pv_cols name style n do_cleanups
4900 generate_perl_lvm_code "vg" vg_cols name style n do_cleanups
4902 generate_perl_lvm_code "lv" lv_cols name style n do_cleanups
4904 generate_perl_stat_code "stat" stat_cols name style n do_cleanups
4906 generate_perl_stat_code
4907 "statvfs" statvfs_cols name style n do_cleanups
4913 and generate_perl_lvm_code typ cols name style n do_cleanups =
4915 pr " struct guestfs_lvm_%s_list *%s;\n" typ n;
4919 pr " %s = guestfs_%s " n name;
4920 generate_call_args ~handle:"g" (snd style);
4923 pr " if (%s == NULL)\n" n;
4924 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4925 pr " EXTEND (SP, %s->len);\n" n;
4926 pr " for (i = 0; i < %s->len; ++i) {\n" n;
4927 pr " hv = newHV ();\n";
4931 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
4932 name (String.length name) n name
4934 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
4935 name (String.length name) n name
4937 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
4938 name (String.length name) n name
4940 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
4941 name (String.length name) n name
4942 | name, `OptPercent ->
4943 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
4944 name (String.length name) n name
4946 pr " PUSHs (sv_2mortal ((SV *) hv));\n";
4948 pr " guestfs_free_lvm_%s_list (%s);\n" typ n
4950 and generate_perl_stat_code typ cols name style n do_cleanups =
4952 pr " struct guestfs_%s *%s;\n" typ n;
4954 pr " %s = guestfs_%s " n name;
4955 generate_call_args ~handle:"g" (snd style);
4958 pr " if (%s == NULL)\n" n;
4959 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
4960 pr " EXTEND (SP, %d);\n" (List.length cols);
4964 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n" n name
4966 pr " free (%s);\n" n
4968 (* Generate Sys/Guestfs.pm. *)
4969 and generate_perl_pm () =
4970 generate_header HashStyle LGPLv2;
4977 Sys::Guestfs - Perl bindings for libguestfs
4983 my $h = Sys::Guestfs->new ();
4984 $h->add_drive ('guest.img');
4987 $h->mount ('/dev/sda1', '/');
4988 $h->touch ('/hello');
4993 The C<Sys::Guestfs> module provides a Perl XS binding to the
4994 libguestfs API for examining and modifying virtual machine
4997 Amongst the things this is good for: making batch configuration
4998 changes to guests, getting disk used/free statistics (see also:
4999 virt-df), migrating between virtualization systems (see also:
5000 virt-p2v), performing partial backups, performing partial guest
5001 clones, cloning guests and changing registry/UUID/hostname info, and
5004 Libguestfs uses Linux kernel and qemu code, and can access any type of
5005 guest filesystem that Linux and qemu can, including but not limited
5006 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
5007 schemes, qcow, qcow2, vmdk.
5009 Libguestfs provides ways to enumerate guest storage (eg. partitions,
5010 LVs, what filesystem is in each LV, etc.). It can also run commands
5011 in the context of the guest. Also you can access filesystems over FTP.
5015 All errors turn into calls to C<croak> (see L<Carp(3)>).
5023 package Sys::Guestfs;
5029 XSLoader::load ('Sys::Guestfs');
5031 =item $h = Sys::Guestfs->new ();
5033 Create a new guestfs handle.
5039 my $class = ref ($proto) || $proto;
5041 my $self = Sys::Guestfs::_create ();
5042 bless $self, $class;
5048 (* Actions. We only need to print documentation for these as
5049 * they are pulled in from the XS code automatically.
5052 fun (name, style, _, flags, _, _, longdesc) ->
5053 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
5055 generate_perl_prototype name style;
5057 pr "%s\n\n" longdesc;
5058 if List.mem ProtocolLimitWarning flags then
5059 pr "%s\n\n" protocol_limit_warning;
5060 if List.mem DangerWillRobinson flags then
5061 pr "%s\n\n" danger_will_robinson
5062 ) all_functions_sorted;
5074 Copyright (C) 2009 Red Hat Inc.
5078 Please see the file COPYING.LIB for the full license.
5082 L<guestfs(3)>, L<guestfish(1)>.
5087 and generate_perl_prototype name style =
5088 (match fst style with
5094 | RString n -> pr "$%s = " n
5095 | RIntBool (n, m) -> pr "($%s, $%s) = " n m
5099 | RLVList n -> pr "@%s = " n
5102 | RHashtable n -> pr "%%%s = " n
5105 let comma = ref false in
5108 if !comma then pr ", ";
5111 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
5118 (* Generate Python C module. *)
5119 and generate_python_c () =
5120 generate_header CStyle LGPLv2;
5129 #include \"guestfs.h\"
5137 get_handle (PyObject *obj)
5140 assert (obj != Py_None);
5141 return ((Pyguestfs_Object *) obj)->g;
5145 put_handle (guestfs_h *g)
5149 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
5152 /* This list should be freed (but not the strings) after use. */
5153 static const char **
5154 get_string_list (PyObject *obj)
5161 if (!PyList_Check (obj)) {
5162 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
5166 len = PyList_Size (obj);
5167 r = malloc (sizeof (char *) * (len+1));
5169 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
5173 for (i = 0; i < len; ++i)
5174 r[i] = PyString_AsString (PyList_GetItem (obj, i));
5181 put_string_list (char * const * const argv)
5186 for (argc = 0; argv[argc] != NULL; ++argc)
5189 list = PyList_New (argc);
5190 for (i = 0; i < argc; ++i)
5191 PyList_SetItem (list, i, PyString_FromString (argv[i]));
5197 put_table (char * const * const argv)
5199 PyObject *list, *item;
5202 for (argc = 0; argv[argc] != NULL; ++argc)
5205 list = PyList_New (argc >> 1);
5206 for (i = 0; i < argc; i += 2) {
5207 item = PyTuple_New (2);
5208 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
5209 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
5210 PyList_SetItem (list, i >> 1, item);
5217 free_strings (char **argv)
5221 for (argc = 0; argv[argc] != NULL; ++argc)
5227 py_guestfs_create (PyObject *self, PyObject *args)
5231 g = guestfs_create ();
5233 PyErr_SetString (PyExc_RuntimeError,
5234 \"guestfs.create: failed to allocate handle\");
5237 guestfs_set_error_handler (g, NULL, NULL);
5238 return put_handle (g);
5242 py_guestfs_close (PyObject *self, PyObject *args)
5247 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
5249 g = get_handle (py_g);
5253 Py_INCREF (Py_None);
5259 (* LVM structures, turned into Python dictionaries. *)
5262 pr "static PyObject *\n";
5263 pr "put_lvm_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
5265 pr " PyObject *dict;\n";
5267 pr " dict = PyDict_New ();\n";
5271 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5272 pr " PyString_FromString (%s->%s));\n"
5275 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5276 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
5279 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5280 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
5283 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5284 pr " PyLong_FromLongLong (%s->%s));\n"
5286 | name, `OptPercent ->
5287 pr " if (%s->%s >= 0)\n" typ name;
5288 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5289 pr " PyFloat_FromDouble ((double) %s->%s));\n"
5292 pr " Py_INCREF (Py_None);\n";
5293 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
5296 pr " return dict;\n";
5300 pr "static PyObject *\n";
5301 pr "put_lvm_%s_list (struct guestfs_lvm_%s_list *%ss)\n" typ typ typ;
5303 pr " PyObject *list;\n";
5306 pr " list = PyList_New (%ss->len);\n" typ;
5307 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
5308 pr " PyList_SetItem (list, i, put_lvm_%s (&%ss->val[i]));\n" typ typ;
5309 pr " return list;\n";
5312 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
5314 (* Stat structures, turned into Python dictionaries. *)
5317 pr "static PyObject *\n";
5318 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
5320 pr " PyObject *dict;\n";
5322 pr " dict = PyDict_New ();\n";
5326 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5327 pr " PyLong_FromLongLong (%s->%s));\n"
5330 pr " return dict;\n";
5333 ) ["stat", stat_cols; "statvfs", statvfs_cols];
5335 (* Python wrapper functions. *)
5337 fun (name, style, _, _, _, _, _) ->
5338 pr "static PyObject *\n";
5339 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
5342 pr " PyObject *py_g;\n";
5343 pr " guestfs_h *g;\n";
5344 pr " PyObject *py_r;\n";
5347 match fst style with
5348 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5349 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5350 | RConstString _ -> pr " const char *r;\n"; "NULL"
5351 | RString _ -> pr " char *r;\n"; "NULL"
5352 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5353 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
5354 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5355 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5356 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5357 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
5358 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
5362 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
5363 | OptString n -> pr " const char *%s;\n" n
5365 pr " PyObject *py_%s;\n" n;
5366 pr " const char **%s;\n" n
5367 | Bool n -> pr " int %s;\n" n
5368 | Int n -> pr " int %s;\n" n
5373 (* Convert the parameters. *)
5374 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
5377 | String _ | FileIn _ | FileOut _ -> pr "s"
5378 | OptString _ -> pr "z"
5379 | StringList _ -> pr "O"
5380 | Bool _ -> pr "i" (* XXX Python has booleans? *)
5383 pr ":guestfs_%s\",\n" name;
5387 | String n | FileIn n | FileOut n -> pr ", &%s" n
5388 | OptString n -> pr ", &%s" n
5389 | StringList n -> pr ", &py_%s" n
5390 | Bool n -> pr ", &%s" n
5391 | Int n -> pr ", &%s" n
5395 pr " return NULL;\n";
5397 pr " g = get_handle (py_g);\n";
5400 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5402 pr " %s = get_string_list (py_%s);\n" n n;
5403 pr " if (!%s) return NULL;\n" n
5408 pr " r = guestfs_%s " name;
5409 generate_call_args ~handle:"g" (snd style);
5414 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5416 pr " free (%s);\n" n
5419 pr " if (r == %s) {\n" error_code;
5420 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
5421 pr " return NULL;\n";
5425 (match fst style with
5427 pr " Py_INCREF (Py_None);\n";
5428 pr " py_r = Py_None;\n"
5430 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
5431 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
5432 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
5434 pr " py_r = PyString_FromString (r);\n";
5437 pr " py_r = put_string_list (r);\n";
5438 pr " free_strings (r);\n"
5440 pr " py_r = PyTuple_New (2);\n";
5441 pr " PyTuple_SetItem (py_r, 0, PyInt_FromLong ((long) r->i));\n";
5442 pr " PyTuple_SetItem (py_r, 1, PyInt_FromLong ((long) r->b));\n";
5443 pr " guestfs_free_int_bool (r);\n"
5445 pr " py_r = put_lvm_pv_list (r);\n";
5446 pr " guestfs_free_lvm_pv_list (r);\n"
5448 pr " py_r = put_lvm_vg_list (r);\n";
5449 pr " guestfs_free_lvm_vg_list (r);\n"
5451 pr " py_r = put_lvm_lv_list (r);\n";
5452 pr " guestfs_free_lvm_lv_list (r);\n"
5454 pr " py_r = put_stat (r);\n";
5457 pr " py_r = put_statvfs (r);\n";
5460 pr " py_r = put_table (r);\n";
5461 pr " free_strings (r);\n"
5464 pr " return py_r;\n";
5469 (* Table of functions. *)
5470 pr "static PyMethodDef methods[] = {\n";
5471 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
5472 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
5474 fun (name, _, _, _, _, _, _) ->
5475 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
5478 pr " { NULL, NULL, 0, NULL }\n";
5482 (* Init function. *)
5485 initlibguestfsmod (void)
5487 static int initialized = 0;
5489 if (initialized) return;
5490 Py_InitModule ((char *) \"libguestfsmod\", methods);
5495 (* Generate Python module. *)
5496 and generate_python_py () =
5497 generate_header HashStyle LGPLv2;
5500 u\"\"\"Python bindings for libguestfs
5503 g = guestfs.GuestFS ()
5504 g.add_drive (\"guest.img\")
5507 parts = g.list_partitions ()
5509 The guestfs module provides a Python binding to the libguestfs API
5510 for examining and modifying virtual machine disk images.
5512 Amongst the things this is good for: making batch configuration
5513 changes to guests, getting disk used/free statistics (see also:
5514 virt-df), migrating between virtualization systems (see also:
5515 virt-p2v), performing partial backups, performing partial guest
5516 clones, cloning guests and changing registry/UUID/hostname info, and
5519 Libguestfs uses Linux kernel and qemu code, and can access any type of
5520 guest filesystem that Linux and qemu can, including but not limited
5521 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
5522 schemes, qcow, qcow2, vmdk.
5524 Libguestfs provides ways to enumerate guest storage (eg. partitions,
5525 LVs, what filesystem is in each LV, etc.). It can also run commands
5526 in the context of the guest. Also you can access filesystems over FTP.
5528 Errors which happen while using the API are turned into Python
5529 RuntimeError exceptions.
5531 To create a guestfs handle you usually have to perform the following
5534 # Create the handle, call add_drive at least once, and possibly
5535 # several times if the guest has multiple block devices:
5536 g = guestfs.GuestFS ()
5537 g.add_drive (\"guest.img\")
5539 # Launch the qemu subprocess and wait for it to become ready:
5543 # Now you can issue commands, for example:
5548 import libguestfsmod
5551 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
5553 def __init__ (self):
5554 \"\"\"Create a new libguestfs handle.\"\"\"
5555 self._o = libguestfsmod.create ()
5558 libguestfsmod.close (self._o)
5563 fun (name, style, _, flags, _, _, longdesc) ->
5564 let doc = replace_str longdesc "C<guestfs_" "C<g." in
5566 match fst style with
5567 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _
5570 doc ^ "\n\nThis function returns a list of strings."
5572 doc ^ "\n\nThis function returns a tuple (int, bool).\n"
5574 doc ^ "\n\nThis function returns a list of PVs. Each PV is represented as a dictionary."
5576 doc ^ "\n\nThis function returns a list of VGs. Each VG is represented as a dictionary."
5578 doc ^ "\n\nThis function returns a list of LVs. Each LV is represented as a dictionary."
5580 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the stat structure."
5582 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the statvfs structure."
5584 doc ^ "\n\nThis function returns a dictionary." in
5586 if List.mem ProtocolLimitWarning flags then
5587 doc ^ "\n\n" ^ protocol_limit_warning
5590 if List.mem DangerWillRobinson flags then
5591 doc ^ "\n\n" ^ danger_will_robinson
5593 let doc = pod2text ~width:60 name doc in
5594 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
5595 let doc = String.concat "\n " doc in
5598 generate_call_args ~handle:"self" (snd style);
5600 pr " u\"\"\"%s\"\"\"\n" doc;
5601 pr " return libguestfsmod.%s " name;
5602 generate_call_args ~handle:"self._o" (snd style);
5607 (* Useful if you need the longdesc POD text as plain text. Returns a
5610 * This is the slowest thing about autogeneration.
5612 and pod2text ~width name longdesc =
5613 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
5614 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
5616 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
5617 let chan = Unix.open_process_in cmd in
5618 let lines = ref [] in
5620 let line = input_line chan in
5621 if i = 1 then (* discard the first line of output *)
5624 let line = triml line in
5625 lines := line :: !lines;
5628 let lines = try loop 1 with End_of_file -> List.rev !lines in
5629 Unix.unlink filename;
5630 match Unix.close_process_in chan with
5631 | Unix.WEXITED 0 -> lines
5633 failwithf "pod2text: process exited with non-zero status (%d)" i
5634 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
5635 failwithf "pod2text: process signalled or stopped by signal %d" i
5637 (* Generate ruby bindings. *)
5638 and generate_ruby_c () =
5639 generate_header CStyle LGPLv2;
5647 #include \"guestfs.h\"
5649 #include \"extconf.h\"
5651 static VALUE m_guestfs; /* guestfs module */
5652 static VALUE c_guestfs; /* guestfs_h handle */
5653 static VALUE e_Error; /* used for all errors */
5655 static void ruby_guestfs_free (void *p)
5658 guestfs_close ((guestfs_h *) p);
5661 static VALUE ruby_guestfs_create (VALUE m)
5665 g = guestfs_create ();
5667 rb_raise (e_Error, \"failed to create guestfs handle\");
5669 /* Don't print error messages to stderr by default. */
5670 guestfs_set_error_handler (g, NULL, NULL);
5672 /* Wrap it, and make sure the close function is called when the
5675 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
5678 static VALUE ruby_guestfs_close (VALUE gv)
5681 Data_Get_Struct (gv, guestfs_h, g);
5683 ruby_guestfs_free (g);
5684 DATA_PTR (gv) = NULL;
5692 fun (name, style, _, _, _, _, _) ->
5693 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
5694 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
5697 pr " guestfs_h *g;\n";
5698 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
5700 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
5706 | String n | FileIn n | FileOut n ->
5707 pr " const char *%s = StringValueCStr (%sv);\n" n n;
5709 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
5710 pr " \"%s\", \"%s\");\n" n name
5712 pr " const char *%s = StringValueCStr (%sv);\n" n n
5716 pr " int i, len;\n";
5717 pr " len = RARRAY_LEN (%sv);\n" n;
5718 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
5720 pr " for (i = 0; i < len; ++i) {\n";
5721 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
5722 pr " %s[i] = StringValueCStr (v);\n" n;
5724 pr " %s[len] = NULL;\n" n;
5728 pr " int %s = NUM2INT (%sv);\n" n n
5733 match fst style with
5734 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5735 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5736 | RConstString _ -> pr " const char *r;\n"; "NULL"
5737 | RString _ -> pr " char *r;\n"; "NULL"
5738 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5739 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
5740 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5741 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5742 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5743 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
5744 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
5747 pr " r = guestfs_%s " name;
5748 generate_call_args ~handle:"g" (snd style);
5753 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
5755 pr " free (%s);\n" n
5758 pr " if (r == %s)\n" error_code;
5759 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
5762 (match fst style with
5764 pr " return Qnil;\n"
5765 | RInt _ | RBool _ ->
5766 pr " return INT2NUM (r);\n"
5768 pr " return ULL2NUM (r);\n"
5770 pr " return rb_str_new2 (r);\n";
5772 pr " VALUE rv = rb_str_new2 (r);\n";
5776 pr " int i, len = 0;\n";
5777 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
5778 pr " VALUE rv = rb_ary_new2 (len);\n";
5779 pr " for (i = 0; r[i] != NULL; ++i) {\n";
5780 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
5781 pr " free (r[i]);\n";
5786 pr " VALUE rv = rb_ary_new2 (2);\n";
5787 pr " rb_ary_push (rv, INT2NUM (r->i));\n";
5788 pr " rb_ary_push (rv, INT2NUM (r->b));\n";
5789 pr " guestfs_free_int_bool (r);\n";
5792 generate_ruby_lvm_code "pv" pv_cols
5794 generate_ruby_lvm_code "vg" vg_cols
5796 generate_ruby_lvm_code "lv" lv_cols
5798 pr " VALUE rv = rb_hash_new ();\n";
5802 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
5807 pr " VALUE rv = rb_hash_new ();\n";
5811 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
5816 pr " VALUE rv = rb_hash_new ();\n";
5818 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
5819 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
5820 pr " free (r[i]);\n";
5821 pr " free (r[i+1]);\n";
5832 /* Initialize the module. */
5833 void Init__guestfs ()
5835 m_guestfs = rb_define_module (\"Guestfs\");
5836 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
5837 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
5839 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
5840 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
5843 (* Define the rest of the methods. *)
5845 fun (name, style, _, _, _, _, _) ->
5846 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
5847 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
5852 (* Ruby code to return an LVM struct list. *)
5853 and generate_ruby_lvm_code typ cols =
5854 pr " VALUE rv = rb_ary_new2 (r->len);\n";
5856 pr " for (i = 0; i < r->len; ++i) {\n";
5857 pr " VALUE hv = rb_hash_new ();\n";
5861 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
5863 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
5866 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
5867 | name, `OptPercent ->
5868 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
5870 pr " rb_ary_push (rv, hv);\n";
5872 pr " guestfs_free_lvm_%s_list (r);\n" typ;
5875 (* Generate Java bindings GuestFS.java file. *)
5876 and generate_java_java () =
5877 generate_header CStyle LGPLv2;
5880 package com.redhat.et.libguestfs;
5882 import java.util.HashMap;
5883 import com.redhat.et.libguestfs.LibGuestFSException;
5884 import com.redhat.et.libguestfs.PV;
5885 import com.redhat.et.libguestfs.VG;
5886 import com.redhat.et.libguestfs.LV;
5887 import com.redhat.et.libguestfs.Stat;
5888 import com.redhat.et.libguestfs.StatVFS;
5889 import com.redhat.et.libguestfs.IntBool;
5892 * The GuestFS object is a libguestfs handle.
5896 public class GuestFS {
5897 // Load the native code.
5899 System.loadLibrary (\"guestfs_jni\");
5903 * The native guestfs_h pointer.
5908 * Create a libguestfs handle.
5910 * @throws LibGuestFSException
5912 public GuestFS () throws LibGuestFSException
5916 private native long _create () throws LibGuestFSException;
5919 * Close a libguestfs handle.
5921 * You can also leave handles to be collected by the garbage
5922 * collector, but this method ensures that the resources used
5923 * by the handle are freed up immediately. If you call any
5924 * other methods after closing the handle, you will get an
5927 * @throws LibGuestFSException
5929 public void close () throws LibGuestFSException
5935 private native void _close (long g) throws LibGuestFSException;
5937 public void finalize () throws LibGuestFSException
5945 fun (name, style, _, flags, _, shortdesc, longdesc) ->
5946 let doc = replace_str longdesc "C<guestfs_" "C<g." in
5948 if List.mem ProtocolLimitWarning flags then
5949 doc ^ "\n\n" ^ protocol_limit_warning
5952 if List.mem DangerWillRobinson flags then
5953 doc ^ "\n\n" ^ danger_will_robinson
5955 let doc = pod2text ~width:60 name doc in
5956 let doc = String.concat "\n * " doc in
5959 pr " * %s\n" shortdesc;
5962 pr " * @throws LibGuestFSException\n";
5965 generate_java_prototype ~public:true ~semicolon:false name style;
5968 pr " if (g == 0)\n";
5969 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
5972 if fst style <> RErr then pr "return ";
5974 generate_call_args ~handle:"g" (snd style);
5978 generate_java_prototype ~privat:true ~native:true name style;
5985 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
5986 ?(semicolon=true) name style =
5987 if privat then pr "private ";
5988 if public then pr "public ";
5989 if native then pr "native ";
5992 (match fst style with
5993 | RErr -> pr "void ";
5994 | RInt _ -> pr "int ";
5995 | RInt64 _ -> pr "long ";
5996 | RBool _ -> pr "boolean ";
5997 | RConstString _ | RString _ -> pr "String ";
5998 | RStringList _ -> pr "String[] ";
5999 | RIntBool _ -> pr "IntBool ";
6000 | RPVList _ -> pr "PV[] ";
6001 | RVGList _ -> pr "VG[] ";
6002 | RLVList _ -> pr "LV[] ";
6003 | RStat _ -> pr "Stat ";
6004 | RStatVFS _ -> pr "StatVFS ";
6005 | RHashtable _ -> pr "HashMap<String,String> ";
6008 if native then pr "_%s " name else pr "%s " name;
6010 let needs_comma = ref false in
6019 if !needs_comma then pr ", ";
6020 needs_comma := true;
6037 pr " throws LibGuestFSException";
6038 if semicolon then pr ";"
6040 and generate_java_struct typ cols =
6041 generate_header CStyle LGPLv2;
6044 package com.redhat.et.libguestfs;
6047 * Libguestfs %s structure.
6058 | name, `UUID -> pr " public String %s;\n" name
6060 | name, `Int -> pr " public long %s;\n" name
6061 | name, `OptPercent ->
6062 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
6063 pr " public float %s;\n" name
6068 and generate_java_c () =
6069 generate_header CStyle LGPLv2;
6076 #include \"com_redhat_et_libguestfs_GuestFS.h\"
6077 #include \"guestfs.h\"
6079 /* Note that this function returns. The exception is not thrown
6080 * until after the wrapper function returns.
6083 throw_exception (JNIEnv *env, const char *msg)
6086 cl = (*env)->FindClass (env,
6087 \"com/redhat/et/libguestfs/LibGuestFSException\");
6088 (*env)->ThrowNew (env, cl, msg);
6091 JNIEXPORT jlong JNICALL
6092 Java_com_redhat_et_libguestfs_GuestFS__1create
6093 (JNIEnv *env, jobject obj)
6097 g = guestfs_create ();
6099 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
6102 guestfs_set_error_handler (g, NULL, NULL);
6103 return (jlong) (long) g;
6106 JNIEXPORT void JNICALL
6107 Java_com_redhat_et_libguestfs_GuestFS__1close
6108 (JNIEnv *env, jobject obj, jlong jg)
6110 guestfs_h *g = (guestfs_h *) (long) jg;
6117 fun (name, style, _, _, _, _, _) ->
6119 (match fst style with
6120 | RErr -> pr "void ";
6121 | RInt _ -> pr "jint ";
6122 | RInt64 _ -> pr "jlong ";
6123 | RBool _ -> pr "jboolean ";
6124 | RConstString _ | RString _ -> pr "jstring ";
6125 | RIntBool _ | RStat _ | RStatVFS _ | RHashtable _ ->
6127 | RStringList _ | RPVList _ | RVGList _ | RLVList _ ->
6131 pr "Java_com_redhat_et_libguestfs_GuestFS_";
6132 pr "%s" (replace_str ("_" ^ name) "_" "_1");
6134 pr " (JNIEnv *env, jobject obj, jlong jg";
6141 pr ", jstring j%s" n
6143 pr ", jobjectArray j%s" n
6145 pr ", jboolean j%s" n
6151 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
6152 let error_code, no_ret =
6153 match fst style with
6154 | RErr -> pr " int r;\n"; "-1", ""
6156 | RInt _ -> pr " int r;\n"; "-1", "0"
6157 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
6158 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
6160 pr " jstring jr;\n";
6161 pr " char *r;\n"; "NULL", "NULL"
6163 pr " jobjectArray jr;\n";
6166 pr " jstring jstr;\n";
6167 pr " char **r;\n"; "NULL", "NULL"
6169 pr " jobject jr;\n";
6171 pr " jfieldID fl;\n";
6172 pr " struct guestfs_int_bool *r;\n"; "NULL", "NULL"
6174 pr " jobject jr;\n";
6176 pr " jfieldID fl;\n";
6177 pr " struct guestfs_stat *r;\n"; "NULL", "NULL"
6179 pr " jobject jr;\n";
6181 pr " jfieldID fl;\n";
6182 pr " struct guestfs_statvfs *r;\n"; "NULL", "NULL"
6184 pr " jobjectArray jr;\n";
6186 pr " jfieldID fl;\n";
6187 pr " jobject jfl;\n";
6188 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL", "NULL"
6190 pr " jobjectArray jr;\n";
6192 pr " jfieldID fl;\n";
6193 pr " jobject jfl;\n";
6194 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL", "NULL"
6196 pr " jobjectArray jr;\n";
6198 pr " jfieldID fl;\n";
6199 pr " jobject jfl;\n";
6200 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL", "NULL"
6201 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL" in
6208 pr " const char *%s;\n" n
6210 pr " int %s_len;\n" n;
6211 pr " const char **%s;\n" n
6218 (match fst style with
6219 | RStringList _ | RPVList _ | RVGList _ | RLVList _ -> true
6220 | RErr _ | RBool _ | RInt _ | RInt64 _ | RConstString _
6221 | RString _ | RIntBool _ | RStat _ | RStatVFS _
6222 | RHashtable _ -> false) ||
6223 List.exists (function StringList _ -> true | _ -> false) (snd style) in
6229 (* Get the parameters. *)
6236 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
6238 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
6239 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
6240 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6241 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6243 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
6245 pr " %s[%s_len] = NULL;\n" n n;
6248 pr " %s = j%s;\n" n n
6251 (* Make the call. *)
6252 pr " r = guestfs_%s " name;
6253 generate_call_args ~handle:"g" (snd style);
6256 (* Release the parameters. *)
6263 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
6265 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6266 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6268 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
6270 pr " free (%s);\n" n
6275 (* Check for errors. *)
6276 pr " if (r == %s) {\n" error_code;
6277 pr " throw_exception (env, guestfs_last_error (g));\n";
6278 pr " return %s;\n" no_ret;
6282 (match fst style with
6284 | RInt _ -> pr " return (jint) r;\n"
6285 | RBool _ -> pr " return (jboolean) r;\n"
6286 | RInt64 _ -> pr " return (jlong) r;\n"
6287 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
6289 pr " jr = (*env)->NewStringUTF (env, r);\n";
6293 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
6294 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
6295 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
6296 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
6297 pr " for (i = 0; i < r_len; ++i) {\n";
6298 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
6299 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
6300 pr " free (r[i]);\n";
6305 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/IntBool\");\n";
6306 pr " jr = (*env)->AllocObject (env, cl);\n";
6307 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"I\");\n";
6308 pr " (*env)->SetIntField (env, jr, fl, r->i);\n";
6309 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"Z\");\n";
6310 pr " (*env)->SetBooleanField (env, jr, fl, r->b);\n";
6311 pr " guestfs_free_int_bool (r);\n";
6314 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/Stat\");\n";
6315 pr " jr = (*env)->AllocObject (env, cl);\n";
6319 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
6321 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
6326 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/StatVFS\");\n";
6327 pr " jr = (*env)->AllocObject (env, cl);\n";
6331 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
6333 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
6338 generate_java_lvm_return "pv" "PV" pv_cols
6340 generate_java_lvm_return "vg" "VG" vg_cols
6342 generate_java_lvm_return "lv" "LV" lv_cols
6345 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
6346 pr " return NULL;\n"
6353 and generate_java_lvm_return typ jtyp cols =
6354 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
6355 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
6356 pr " for (i = 0; i < r->len; ++i) {\n";
6357 pr " jfl = (*env)->AllocObject (env, cl);\n";
6361 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
6362 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
6365 pr " char s[33];\n";
6366 pr " memcpy (s, r->val[i].%s, 32);\n" name;
6368 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
6369 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
6371 | name, (`Bytes|`Int) ->
6372 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
6373 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
6374 | name, `OptPercent ->
6375 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
6376 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
6378 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
6380 pr " guestfs_free_lvm_%s_list (r);\n" typ;
6383 let output_to filename =
6384 let filename_new = filename ^ ".new" in
6385 chan := open_out filename_new;
6390 (* Is the new file different from the current file? *)
6391 if Sys.file_exists filename && files_equal filename filename_new then
6392 Unix.unlink filename_new (* same, so skip it *)
6394 (* different, overwrite old one *)
6395 (try Unix.chmod filename 0o644 with Unix.Unix_error _ -> ());
6396 Unix.rename filename_new filename;
6397 Unix.chmod filename 0o444;
6398 printf "written %s\n%!" filename;
6407 if not (Sys.file_exists "configure.ac") then (
6409 You are probably running this from the wrong directory.
6410 Run it from the top source directory using the command
6416 let close = output_to "src/guestfs_protocol.x" in
6420 let close = output_to "src/guestfs-structs.h" in
6421 generate_structs_h ();
6424 let close = output_to "src/guestfs-actions.h" in
6425 generate_actions_h ();
6428 let close = output_to "src/guestfs-actions.c" in
6429 generate_client_actions ();
6432 let close = output_to "daemon/actions.h" in
6433 generate_daemon_actions_h ();
6436 let close = output_to "daemon/stubs.c" in
6437 generate_daemon_actions ();
6440 let close = output_to "tests.c" in
6444 let close = output_to "fish/cmds.c" in
6445 generate_fish_cmds ();
6448 let close = output_to "fish/completion.c" in
6449 generate_fish_completion ();
6452 let close = output_to "guestfs-structs.pod" in
6453 generate_structs_pod ();
6456 let close = output_to "guestfs-actions.pod" in
6457 generate_actions_pod ();
6460 let close = output_to "guestfish-actions.pod" in
6461 generate_fish_actions_pod ();
6464 let close = output_to "ocaml/guestfs.mli" in
6465 generate_ocaml_mli ();
6468 let close = output_to "ocaml/guestfs.ml" in
6469 generate_ocaml_ml ();
6472 let close = output_to "ocaml/guestfs_c_actions.c" in
6473 generate_ocaml_c ();
6476 let close = output_to "perl/Guestfs.xs" in
6477 generate_perl_xs ();
6480 let close = output_to "perl/lib/Sys/Guestfs.pm" in
6481 generate_perl_pm ();
6484 let close = output_to "python/guestfs-py.c" in
6485 generate_python_c ();
6488 let close = output_to "python/guestfs.py" in
6489 generate_python_py ();
6492 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
6496 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
6497 generate_java_java ();
6500 let close = output_to "java/com/redhat/et/libguestfs/PV.java" in
6501 generate_java_struct "PV" pv_cols;
6504 let close = output_to "java/com/redhat/et/libguestfs/VG.java" in
6505 generate_java_struct "VG" vg_cols;
6508 let close = output_to "java/com/redhat/et/libguestfs/LV.java" in
6509 generate_java_struct "LV" lv_cols;
6512 let close = output_to "java/com/redhat/et/libguestfs/Stat.java" in
6513 generate_java_struct "Stat" stat_cols;
6516 let close = output_to "java/com/redhat/et/libguestfs/StatVFS.java" in
6517 generate_java_struct "StatVFS" statvfs_cols;
6520 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in