X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=perl%2Flib%2FSys%2FGuestfs.pm;h=ad200881834d8ef628c1ee438d5242535da83801;hp=c708a29c77979b6e307f01abfb9ed48f91778124;hb=24ccbb29ac475187f51a27dcd318db2b4824a0c1;hpb=b4d2a01828e5de85e5eee3631f7fe3925a0312ca diff --git a/perl/lib/Sys/Guestfs.pm b/perl/lib/Sys/Guestfs.pm index c708a29..ad20088 100644 --- a/perl/lib/Sys/Guestfs.pm +++ b/perl/lib/Sys/Guestfs.pm @@ -245,19 +245,141 @@ how files are saved. Set the value associated with C to C. +=item $h->blockdev_flushbufs ($device); + +This tells the kernel to flush internal buffers associated +with C. + +This uses the L command. + +=item $blocksize = $h->blockdev_getbsz ($device); + +This returns the block size of a device. + +(Note this is different from both I and +I). + +This uses the L command. + +=item $ro = $h->blockdev_getro ($device); + +Returns a boolean indicating if the block device is read-only +(true if read-only, false if not). + +This uses the L command. + +=item $sizeinbytes = $h->blockdev_getsize64 ($device); + +This returns the size of the device in bytes. + +See also C<$h-Eblockdev_getsz>. + +This uses the L command. + +=item $sectorsize = $h->blockdev_getss ($device); + +This returns the size of sectors on a block device. +Usually 512, but can be larger for modern devices. + +(Note, this is not the size in sectors, use C<$h-Eblockdev_getsz> +for that). + +This uses the L command. + +=item $sizeinsectors = $h->blockdev_getsz ($device); + +This returns the size of the device in units of 512-byte sectors +(even if the sectorsize isn't 512 bytes ... weird). + +See also C<$h-Eblockdev_getss> for the real sector size of +the device, and C<$h-Eblockdev_getsize64> for the more +useful I. + +This uses the L command. + +=item $h->blockdev_rereadpt ($device); + +Reread the partition table on C. + +This uses the L command. + +=item $h->blockdev_setbsz ($device, $blocksize); + +This sets the block size of a device. + +(Note this is different from both I and +I). + +This uses the L command. + +=item $h->blockdev_setro ($device); + +Sets the block device named C to read-only. + +This uses the L command. + +=item $h->blockdev_setrw ($device); + +Sets the block device named C to read-write. + +This uses the L command. + =item $content = $h->cat ($path); Return the contents of the file named C. 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-Eread_file> +as end of string). For those you need to use the C<$h-Edownload> function which has a more complex interface. Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. To transfer large files you should use FTP. +=item $checksum = $h->checksum ($csumtype, $path); + +This call computes the MD5, SHAx or CRC checksum of the +file named C. + +The type of checksum to compute is given by the C +parameter which must have one of the following values: + +=over 4 + +=item C + +Compute the cyclic redundancy check (CRC) specified by POSIX +for the C command. + +=item C + +Compute the MD5 hash (using the C program). + +=item C + +Compute the SHA1 hash (using the C program). + +=item C + +Compute the SHA224 hash (using the C program). + +=item C + +Compute the SHA256 hash (using the C program). + +=item C + +Compute the SHA384 hash (using the C program). + +=item C + +Compute the SHA512 hash (using the C program). + +=back + +The checksum is returned as a printable string. + =item $h->chmod ($mode, $path); Change the mode (permissions) of C to C. Only @@ -271,6 +393,34 @@ Only numeric uid and gid are supported. If you want to use names, you will need to locate and parse the password file yourself (Augeas support makes this relatively easy). +=item $output = $h->command (\@arguments); + +This call runs a command from the guest filesystem. The +filesystem must be mounted, and must contain a compatible +operating system (ie. something Linux, with the same +or compatible processor architecture). + +The single parameter is an argv-style list of arguments. +The first element is the name of the program to run. +Subsequent elements are parameters. The list must be +non-empty (ie. must contain a program name). + +The C<$PATH> environment variable will contain at least +C and C. If you require a program from +another location, you should provide the full path in the +first parameter. + +Shared libraries and data files required by the program +must be available on filesystems which are mounted in the +correct places. It is the caller's responsibility to ensure +all filesystems that are needed are mounted at the right +locations. + +=item @lines = $h->command_lines (\@arguments); + +This is the same as C<$h-Ecommand>, but splits the +result into a list of lines. + =item $h->config ($qemuparam, $qemuvalue); This can be used to add arbitrary qemu command line parameters @@ -282,6 +432,15 @@ The first character of C string must be a C<-> (dash). C can be NULL. +=item $h->download ($remotefilename, $filename); + +Download file C and save it as C +on the local machine. + +C can also be a named pipe. + +See also C<$h-Eupload>, C<$h-Ecat>. + =item $existsflag = $h->exists ($path); This returns C if and only if there is a file, directory @@ -289,6 +448,16 @@ This returns C if and only if there is a file, directory See also C<$h-Eis_file>, C<$h-Eis_dir>, C<$h-Estat>. +=item $description = $h->file ($path); + +This call uses the standard L command to determine +the type or contents of the file. This also works on devices, +for example to find out whether a partition contains a filesystem. + +The exact command which runs is C. Note in +particular that the filename is not prepended to the output +(the C<-b> option). + =item $autosync = $h->get_autosync (); Get the autosync flag. @@ -300,10 +469,31 @@ Return the current search path. This is always non-NULL. If it wasn't set already, then this will return the default path. +=item $state = $h->get_state (); + +This returns the current state as an opaque integer. This is +only useful for printing debug and internal error messages. + +For more information on states, see L. + =item $verbose = $h->get_verbose (); This returns the verbose messages flag. +=item $busy = $h->is_busy (); + +This returns true iff this handle is busy processing a command +(in the C state). + +For more information on states, see L. + +=item $config = $h->is_config (); + +This returns true iff this handle is being configured +(in the C state). + +For more information on states, see L. + =item $dirflag = $h->is_dir ($path); This returns C if and only if there is a directory @@ -320,6 +510,20 @@ other objects like directories. See also C<$h-Estat>. +=item $launching = $h->is_launching (); + +This returns true iff this handle is launching the subprocess +(in the C state). + +For more information on states, see L. + +=item $ready = $h->is_ready (); + +This returns true iff this handle is ready to accept commands +(in the C state). + +For more information on states, see L. + =item $h->kill_subprocess (); This kills the qemu subprocess. You should never need to call this. @@ -364,6 +568,16 @@ hidden files are shown. This command is mostly useful for interactive sessions. Programs should probably use C<$h-Ereaddir> instead. +=item %statbuf = $h->lstat ($path); + +Returns file information for the given C. + +This is the same as C<$h-Estat> except that if C +is a symbolic link, then the link is stat-ed, not the file it +refers to. + +This is the same as the C system call. + =item $h->lvcreate ($logvol, $volgroup, $mbytes); This creates an LVM volume group called C @@ -486,6 +700,13 @@ If C is true, this enables autosync. Libguestfs will make a best effort attempt to run C<$h-Esync> when the handle is closed (also if the program exits without closing handles). +=item $h->set_busy (); + +This sets the state to C. This is only used when implementing +actions using the low-level API. + +For more information on states, see L. + =item $h->set_path ($path); Set the path that libguestfs searches for kernel and initrd.img. @@ -498,6 +719,13 @@ must make sure it remains valid for the lifetime of the handle. Setting C to C restores the default path. +=item $h->set_ready (); + +This sets the state to C. This is only used when implementing +actions using the low-level API. + +For more information on states, see L. + =item $h->set_verbose ($verbose); If C is true, this turns on verbose messages (to C). @@ -530,6 +758,20 @@ the string C<,> (comma). B. +=item %statbuf = $h->stat ($path); + +Returns file information for the given C. + +This is the same as the C system call. + +=item %statbuf = $h->statvfs ($path); + +Returns file system statistics for any mounted file system. +C should be a file or directory in the mounted file system +(typically it is the mount point itself, but it doesn't need to be). + +This is the same as the C system call. + =item $h->sync (); This syncs the disk, so that any writes are flushed through to the @@ -544,6 +786,16 @@ Touch acts like the L command. It can be used to update the timestamps on a file, or, if the file does not exist, to create a new zero-length file. +=item %superblock = $h->tune2fs_l ($device); + +This returns the contents of the ext2 or ext3 filesystem superblock +on C. + +It is the same as running C. See L +manpage for more details. The list of fields returned isn't +clearly defined, and depends on both the version of C +that libguestfs was built against, and the filesystem itself. + =item $h->umount ($pathordevice); This unmounts the given filesystem. The filesystem may be @@ -556,6 +808,15 @@ This unmounts all mounted filesystems. Some internal mounts are not unmounted by this call. +=item $h->upload ($filename, $remotefilename); + +Upload local file C to C on the +filesystem. + +C can also be a named pipe. + +See also C<$h-Edownload>. + =item $h->vgcreate ($volgroup, \@physvols); This creates an LVM volume group called C