summaryrefslogtreecommitdiffstats
path: root/perl
diff options
context:
space:
mode:
authorRichard Jones <rjones@redhat.com>2009-04-08 20:26:35 +0100
committerRichard Jones <rjones@redhat.com>2009-04-08 20:26:35 +0100
commit94050e0344685b6916e21581e618ad3e85795008 (patch)
treeaa86daf806029bded8a9e88b18be34633d403664 /perl
parentb5ff6816face6f8c1700d4f1df752c710620ff95 (diff)
downloadlibguestfs-94050e0344685b6916e21581e618ad3e85795008.tar.gz
libguestfs-94050e0344685b6916e21581e618ad3e85795008.tar.xz
libguestfs-94050e0344685b6916e21581e618ad3e85795008.zip
Many non-daemon functions are now auto-generated.
Diffstat (limited to 'perl')
-rw-r--r--perl/Guestfs.xs76
-rw-r--r--perl/lib/Sys/Guestfs.pm106
2 files changed, 117 insertions, 65 deletions
diff --git a/perl/Guestfs.xs b/perl/Guestfs.xs
index 58def0d7..fd287e7b 100644
--- a/perl/Guestfs.xs
+++ b/perl/Guestfs.xs
@@ -92,50 +92,58 @@ DESTROY (g)
guestfs_close (g);
void
+launch (g)
+ guestfs_h *g;
+ PPCODE:
+ if (guestfs_launch (g) == -1)
+ croak ("launch: %s", last_error);
+
+void
+wait_ready (g)
+ guestfs_h *g;
+ PPCODE:
+ if (guestfs_wait_ready (g) == -1)
+ croak ("wait_ready: %s", last_error);
+
+void
+kill_subprocess (g)
+ guestfs_h *g;
+ PPCODE:
+ if (guestfs_kill_subprocess (g) == -1)
+ croak ("kill_subprocess: %s", last_error);
+
+void
add_drive (g, filename)
guestfs_h *g;
- const char *filename;
- CODE:
+ char *filename;
+ PPCODE:
if (guestfs_add_drive (g, filename) == -1)
croak ("add_drive: %s", last_error);
void
add_cdrom (g, filename)
guestfs_h *g;
- const char *filename;
- CODE:
+ char *filename;
+ PPCODE:
if (guestfs_add_cdrom (g, filename) == -1)
croak ("add_cdrom: %s", last_error);
void
-config (g, param, value)
+config (g, qemuparam, qemuvalue)
guestfs_h *g;
- const char *param;
- const char *value;
- CODE:
- if (guestfs_config (g, param, value) == -1)
+ char *qemuparam;
+ char *qemuvalue;
+ PPCODE:
+ if (guestfs_config (g, qemuparam, qemuvalue) == -1)
croak ("config: %s", last_error);
void
-launch (g)
- guestfs_h *g;
- CODE:
- if (guestfs_launch (g) == -1)
- croak ("launch: %s", last_error);
-
-void
-wait_ready (g)
- guestfs_h *g;
- CODE:
- if (guestfs_wait_ready (g) == -1)
- croak ("wait_ready: %s", last_error);
-
-void
set_path (g, path)
guestfs_h *g;
- const char *path;
- CODE:
- guestfs_set_path (g, path);
+ char *path;
+ PPCODE:
+ if (guestfs_set_path (g, path) == -1)
+ croak ("set_path: %s", last_error);
SV *
get_path (g)
@@ -144,6 +152,8 @@ PREINIT:
const char *path;
CODE:
path = guestfs_get_path (g);
+ if (path == NULL)
+ croak ("get_path: %s", last_error);
RETVAL = newSVpv (path, 0);
OUTPUT:
RETVAL
@@ -152,8 +162,9 @@ void
set_autosync (g, autosync)
guestfs_h *g;
int autosync;
- CODE:
- guestfs_set_autosync (g, autosync);
+ PPCODE:
+ if (guestfs_set_autosync (g, autosync) == -1)
+ croak ("set_autosync: %s", last_error);
SV *
get_autosync (g)
@@ -162,6 +173,8 @@ PREINIT:
int autosync;
CODE:
autosync = guestfs_get_autosync (g);
+ if (autosync == -1)
+ croak ("get_autosync: %s", last_error);
RETVAL = newSViv (autosync);
OUTPUT:
RETVAL
@@ -170,8 +183,9 @@ void
set_verbose (g, verbose)
guestfs_h *g;
int verbose;
- CODE:
- guestfs_set_verbose (g, verbose);
+ PPCODE:
+ if (guestfs_set_verbose (g, verbose) == -1)
+ croak ("set_verbose: %s", last_error);
SV *
get_verbose (g)
@@ -180,6 +194,8 @@ PREINIT:
int verbose;
CODE:
verbose = guestfs_get_verbose (g);
+ if (verbose == -1)
+ croak ("get_verbose: %s", last_error);
RETVAL = newSViv (verbose);
OUTPUT:
RETVAL
diff --git a/perl/lib/Sys/Guestfs.pm b/perl/lib/Sys/Guestfs.pm
index 0a8226fe..1798e7b8 100644
--- a/perl/lib/Sys/Guestfs.pm
+++ b/perl/lib/Sys/Guestfs.pm
@@ -91,9 +91,13 @@ sub new {
return $self;
}
-=item $h->add_drive ($filename);
+=item $h->add_cdrom (filename);
-=item $h->add_cdrom ($filename);
+This function adds a virtual CD-ROM disk image to the guest.
+
+This is equivalent to the qemu parameter C<-cdrom filename>.
+
+=item $h->add_drive (filename);
This function adds a virtual machine disk image C<filename> to the
guest. The first time you call this function, the disk appears as IDE
@@ -106,59 +110,58 @@ for whatever operations you want to perform (ie. read access if you
just want to read the image or write access if you want to modify the
image).
-The C<add_cdrom> variation adds a CD-ROM device.
-
-=item $h->config ($param, $value);
+This is equivalent to the qemu parameter C<-drive file=filename>.
-=item $h->config ($param);
+=item $content = $h->cat (path);
-Use this to add arbitrary parameters to the C<qemu> command line.
-See L<qemu(1)>.
+Return the contents of the file named C<path>.
-=item $h->launch ();
+Note that this function cannot correctly handle binary files
+(specifically, files containing C<\0> character which is treated
+as end of string). For those you need to use the C<$h-E<gt>read_file>
+function which has a more complex interface.
-=item $h->wait_ready ();
+Because of the message protocol, there is a transfer limit
+of somewhere between 2MB and 4MB. To transfer large files you should use
+FTP.
-Internally libguestfs is implemented by running a virtual machine
-using L<qemu(1)>. These calls are necessary in order to boot the
-virtual machine.
+=item $h->config (qemuparam, qemuvalue);
-You should call these two functions after configuring the handle
-(eg. adding drives) but before performing any actions.
+This can be used to add arbitrary qemu command line parameters
+of the form C<-param value>. Actually it's not quite arbitrary - we
+prevent you from setting some parameters which would interfere with
+parameters that we use.
-=item $h->set_path ($path);
+The first character of C<param> string must be a C<-> (dash).
-=item $path = $h->get_path ();
+C<value> can be NULL.
-See the discussion of C<PATH> in the L<guestfs(3)>
-manpage.
+=item $autosync = $h->get_autosync ();
-=item $h->set_autosync ($autosync);
+Get the autosync flag.
-=item $autosync = $h->get_autosync ();
+=item $path = $h->get_path ();
-See the discussion of I<AUTOSYNC> in the L<guestfs(3)>
-manpage.
+Return the current search path.
-=item $h->set_verbose ($verbose);
+This is always non-NULL. If it wasn't set already, then this will
+return the default path.
=item $verbose = $h->get_verbose ();
-This sets or gets the verbose messages flag. Verbose
-messages are sent to C<stderr>.
+This returns the verbose messages flag.
-=item $content = $h->cat (path);
+=item $h->kill_subprocess ();
-Return the contents of the file named C<path>.
+This kills the qemu subprocess. You should never need to call this.
-Note that this function cannot correctly handle binary files
-(specifically, files containing C<\0> character which is treated
-as end of string). For those you need to use the C<$h-E<gt>read_file>
-function which has a more complex interface.
+=item $h->launch ();
-Because of the message protocol, there is a transfer limit
-of somewhere between 2MB and 4MB. To transfer large files you should use
-FTP.
+Internally libguestfs is implemented by running a virtual machine
+using L<qemu(1)>.
+
+You should call this after configuring the handle
+(eg. adding drives) but before performing any actions.
=item @devices = $h->list_devices ();
@@ -241,6 +244,31 @@ See also C<$h-E<gt>pvs_full>.
List all the physical volumes detected. This is the equivalent
of the L<pvs(8)> command. The "full" version includes all fields.
+=item $h->set_autosync (autosync);
+
+If C<autosync> is true, this enables autosync. Libguestfs will make a
+best effort attempt to run C<$h-E<gt>sync> when the handle is closed
+(also if the program exits without closing handles).
+
+=item $h->set_path (path);
+
+Set the path that libguestfs searches for kernel and initrd.img.
+
+The default is C<$libdir/guestfs> unless overridden by setting
+C<LIBGUESTFS_PATH> environment variable.
+
+The string C<path> is stashed in the libguestfs handle, so the caller
+must make sure it remains valid for the lifetime of the handle.
+
+Setting C<path> to C<NULL> restores the default path.
+
+=item $h->set_verbose (verbose);
+
+If C<verbose> is true, this turns on verbose messages (to C<stderr>).
+
+Verbose messages are disabled unless the environment variable
+C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
+
=item $h->sync ();
This syncs the disk, so that any writes are flushed through to the
@@ -270,6 +298,14 @@ See also C<$h-E<gt>vgs_full>.
List all the volumes groups detected. This is the equivalent
of the L<vgs(8)> command. The "full" version includes all fields.
+=item $h->wait_ready ();
+
+Internally libguestfs is implemented by running a virtual machine
+using L<qemu(1)>.
+
+You should call this after C<$h-E<gt>launch> to wait for the launch
+to complete.
+
=cut
1;