August 2019 - Libguestfs - libguestfs List Archives

[nbdkit PATCH 0/2] errno cleanup patches
by Eric Blake 13 Aug '19

13 Aug '19

I ran into these while trying to prepare patches to add NBD_CMD_FLAG_FAST_ZERO, which will expose a new NBD_ENOTSUP wire value. Eric Blake (2): plugins: Don't lose original error when emulating FUA plugins: Permit ENOTSUP as synonym for EOPNOTSUPP docs/nbdkit-filter.pod | 11 ++++++----- docs/nbdkit-plugin.pod | 12 +++++++----- plugins/file/file.c | 16 +++++++++++----- plugins/perl/perl.c | 2 +- plugins/python/python.c | 2 +- plugins/ruby/ruby.c | 2 +- server/plugins.c | 11 ++++------- 7 files changed, 31 insertions(+), 25 deletions(-) -- 2.20.1

2 3

[PATCH] v2v: -o rhv-upload: fix the phony ovirtsdk4 module
by Pino Toscano 12 Aug '19

12 Aug '19

- add a no-op Connection.close(), as it called explicitly in the close() callback of the nbdkit plugin (rhv-upload-plugin.py) - fix the types of the 'id' variables, which are strings --- v2v/test-v2v-o-rhv-upload-module/ovirtsdk4/__init__.py | 3 +++ v2v/test-v2v-o-rhv-upload-module/ovirtsdk4/types.py | 4 ++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/v2v/test-v2v-o-rhv-upload-module/ovirtsdk4/__init__.py b/v2v/test-v2v-o-rhv-upload-module/ovirtsdk4/__init__.py index cc4224ccd..2ceb07c0c 100644 --- a/v2v/test-v2v-o-rhv-upload-module/ovirtsdk4/__init__.py +++ b/v2v/test-v2v-o-rhv-upload-module/ovirtsdk4/__init__.py @@ -35,6 +35,9 @@ class Connection(object): ): pass + def close(self): + pass + def system_service(self): return SystemService() diff --git a/v2v/test-v2v-o-rhv-upload-module/ovirtsdk4/types.py b/v2v/test-v2v-o-rhv-upload-module/ovirtsdk4/types.py index 9b3f557ee..60ba541cd 100644 --- a/v2v/test-v2v-o-rhv-upload-module/ovirtsdk4/types.py +++ b/v2v/test-v2v-o-rhv-upload-module/ovirtsdk4/types.py @@ -73,7 +73,7 @@ class Disk(object): ): pass - id = 123 + id = "123" status = DiskStatus.OK class ImageTransferPhase(Enum): @@ -104,7 +104,7 @@ class ImageTransfer(object): ): pass - id = 456 + id = "456" phase = ImageTransferPhase.TRANSFERRING transfer_url = "http://localhost:" + str(imageio_port) + "/" -- 2.21.0

2 1

[PATCH] Fix small issues in documentations of APIs
by Pino Toscano 12 Aug '19

12 Aug '19

- fix names of arguments & optional arguments in C<..> markers - use https for URLs where possible - fix links to other guestfs APIs - use more C<..> markers for special tests, shell commands, values of arguments, and names of fields - link to command man pages where an explicit command is mentioned - fix few incorrect documentation bits --- generator/actions_augeas.ml | 4 +- generator/actions_core.ml | 126 ++++++++++----------- generator/actions_core_deprecated.ml | 22 ++-- generator/actions_inspection.ml | 8 +- generator/actions_inspection_deprecated.ml | 10 +- generator/actions_properties.ml | 6 +- 6 files changed, 88 insertions(+), 88 deletions(-) diff --git a/generator/actions_augeas.ml b/generator/actions_augeas.ml index 3c419e2fc..bb0fe4db0 100644 --- a/generator/actions_augeas.ml +++ b/generator/actions_augeas.ml @@ -118,7 +118,7 @@ Defines a variable C<name> whose value is the result of evaluating C<expr>. If C<expr> evaluates to an empty nodeset, a node is created, -equivalent to calling C<guestfs_aug_set> C<expr>, C<value>. +equivalent to calling C<guestfs_aug_set> C<expr>, C<val>. C<name> will be the nodeset containing that single node. On success this returns a pair containing the @@ -146,7 +146,7 @@ matches exactly one node, the C<value> is returned." }; ]; shortdesc = "set Augeas path to value"; longdesc = "\ -Set the value associated with C<path> to C<val>. +Set the value associated with C<augpath> to C<val>. In the Augeas API, it is possible to clear a node by setting the value to NULL. Due to an oversight in the libguestfs API diff --git a/generator/actions_core.ml b/generator/actions_core.ml index 7b6568b90..8443ae79e 100644 --- a/generator/actions_core.ml +++ b/generator/actions_core.ml @@ -490,12 +490,12 @@ domain is not running (unless C<readonly> is true). In a future version we will try to acquire the libvirt lock on each disk. Disks must be accessible locally. This often means that adding disks -from a remote libvirt connection (see L<http://libvirt.org/remote.html>) +from a remote libvirt connection (see L<https://libvirt.org/remote.html>) will fail unless those disks are accessible via the same device path locally too. The optional C<libvirturi> parameter sets the libvirt URI -(see L<http://libvirt.org/uri.html>). If this is not set then +(see L<https://libvirt.org/uri.html>). If this is not set then we connect to the default libvirt URI (or one set through an environment variable, see the libvirt documentation for full details). @@ -582,7 +582,7 @@ domain is not running (unless C<readonly> is true). In a future version we will try to acquire the libvirt lock on each disk. Disks must be accessible locally. This often means that adding disks -from a remote libvirt connection (see L<http://libvirt.org/remote.html>) +from a remote libvirt connection (see L<https://libvirt.org/remote.html>) will fail unless those disks are accessible via the same device path locally too. @@ -955,7 +955,7 @@ C<names> is the list of files from this directory. On return you get a flat list of xattr structs which must be interpreted sequentially. The first xattr struct always has a zero-length C<attrname>. C<attrval> in this struct is zero-length -to indicate there was an error doing C<lgetxattr> for this +to indicate there was an error doing C<guestfs_lgetxattr> for this file, I<or> is a C string which is a decimal number (the number of following attributes for this file, which could be C<\"0\">). Then after the first xattr struct are the @@ -1005,7 +1005,7 @@ list a directory contents without making many round-trips." }; shortdesc = "list the files in a directory"; longdesc = "\ List the files in F<directory> (relative to the root directory, -there is no cwd). The '.' and '..' entries are not returned, but +there is no cwd). The C<.> and C<..> entries are not returned, but hidden files are shown." }; { defaults with @@ -1271,7 +1271,7 @@ There are two common places that you might call C<guestfs_user_cancel>: In an interactive text-based program, you might call it from a C<SIGINT> signal handler so that pressing C<^C> cancels the current -operation. (You also need to call L</guestfs_set_pgroup> so that +operation. (You also need to call C<guestfs_set_pgroup> so that child processes don't receive the C<^C> signal). In a graphical program, when the main thread is displaying a progress @@ -1585,7 +1585,7 @@ file types such as directories, symbolic links, block special etc." }; shortdesc = "list the files in a directory (long format)"; longdesc = "\ List the files in F<directory> (relative to the root directory, -there is no cwd) in the format of 'ls -la'. +there is no cwd) in the format of C<ls -la>. This command is mostly useful for interactive sessions. It is I<not> intended that you try to parse the output string." }; @@ -2574,27 +2574,27 @@ for the C<cksum> command. =item C<md5> -Compute the MD5 hash (using the C<md5sum> program). +Compute the MD5 hash (using the L<md5sum(1)> program). =item C<sha1> -Compute the SHA1 hash (using the C<sha1sum> program). +Compute the SHA1 hash (using the L<sha1sum(1)> program). =item C<sha224> -Compute the SHA224 hash (using the C<sha224sum> program). +Compute the SHA224 hash (using the L<sha224sum(1)> program). =item C<sha256> -Compute the SHA256 hash (using the C<sha256sum> program). +Compute the SHA256 hash (using the L<sha256sum(1)> program). =item C<sha384> -Compute the SHA384 hash (using the C<sha384sum> program). +Compute the SHA384 hash (using the L<sha384sum(1)> program). =item C<sha512> -Compute the SHA512 hash (using the C<sha512sum> program). +Compute the SHA512 hash (using the L<sha512sum(1)> program). =back @@ -2854,7 +2854,7 @@ group (if any)." }; This wipes a physical volume C<device> so that LVM will no longer recognise it. -The implementation uses the C<pvremove> command which refuses to +The implementation uses the L<pvremove(8)> command which refuses to wipe physical volumes that contain any volume groups, so you have to remove those first." }; @@ -2958,7 +2958,7 @@ caveats in L<guestfs(3)/RUNNING COMMANDS>. =item * -This uses C<grub-install> from the host. Unfortunately grub is +This uses L<grub-install(8)> from the host. Unfortunately grub is not always compatible with itself, so this only works in rather narrow circumstances. Careful testing with each guest version is advisable. @@ -3054,7 +3054,7 @@ See also: C<guestfs_rename>." }; This instructs the guest kernel to drop its page cache, and/or dentries and inode caches. The parameter C<whattodrop> tells the kernel what precisely to drop, see -L<http://linux-mm.org/Drop_Caches> +L<https://linux-mm.org/Drop_Caches> Setting C<whattodrop> to 3 should drop everything. @@ -3070,7 +3070,7 @@ so that the maximum guest memory is freed." }; ]; shortdesc = "return kernel messages"; longdesc = "\ -This returns the kernel messages (C<dmesg> output) from +This returns the kernel messages (L<dmesg(1)> output) from the guest kernel. This is sometimes useful for extended debugging of problems. @@ -3682,7 +3682,7 @@ If the parameter C<nrlines> is a positive number, this returns the last C<nrlines> lines of the file C<path>. If the parameter C<nrlines> is a negative number, this returns lines -from the file C<path>, starting with the C<-nrlines>th line. +from the file C<path>, starting with the C<-nrlines>'th line. If the parameter C<nrlines> is zero, this returns an empty list." }; @@ -3692,7 +3692,7 @@ If the parameter C<nrlines> is zero, this returns an empty list." }; test_excuse = "tricky to test because it depends on the exact format of the 'df' command and other imponderables"; shortdesc = "report file system disk space usage"; longdesc = "\ -This command runs the C<df> command to report disk space used. +This command runs the L<df(1)> command to report disk space used. This command is mostly useful for interactive sessions. It is I<not> intended that you try to parse the output string. @@ -4167,7 +4167,7 @@ for full details." }; ]; shortdesc = "return lines matching a pattern"; longdesc = "\ -This calls the external C<grep> program and returns the +This calls the external L<grep(1)> program and returns the matching lines. The optional flags are: @@ -4190,7 +4190,7 @@ Match case-insensitive. This is the same as using the I<-i> flag. =item C<compressed> -Use C<zgrep> instead of C<grep>. This allows the input to be +Use L<zgrep(1)> instead of L<grep(1)>. This allows the input to be compress- or gzip-compressed. =back" }; @@ -4220,7 +4220,7 @@ returned path has no C<.>, C<..> or symbolic link path elements." }; ]; shortdesc = "create a hard link"; longdesc = "\ -This command creates a hard link using the C<ln> command." }; +This command creates a hard link." }; { defaults with name = "ln_f"; added = (1, 0, 66); @@ -4235,8 +4235,8 @@ This command creates a hard link using the C<ln> command." }; ]; shortdesc = "create a hard link"; longdesc = "\ -This command creates a hard link using the C<ln -f> command. -The I<-f> option removes the link (C<linkname>) if it exists already." }; +This command creates a hard link, removing the link C<linkname> +if it exists already." }; { defaults with name = "ln_s"; added = (1, 0, 66); @@ -4623,7 +4623,7 @@ they were created. In Windows itself this would not be a problem. Bug or feature? You decide: -L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1> +L<https://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1> C<guestfs_case_sensitive_path> attempts to resolve the true case of each element in the path. It will return a resolved path if either the @@ -4744,10 +4744,10 @@ file of zeroes, use C<guestfs_fallocate64> instead." }; This command sets the timestamps of a file with nanosecond precision. -C<atsecs, atnsecs> are the last access time (atime) in secs and +C<atsecs>, C<atnsecs> are the last access time (atime) in secs and nanoseconds from the epoch. -C<mtsecs, mtnsecs> are the last modification time (mtime) in +C<mtsecs>, C<mtnsecs> are the last modification time (mtime) in secs and nanoseconds from the epoch. If the C<*nsecs> field contains the special value C<-1> then @@ -4890,9 +4890,9 @@ Possible values for C<parttype> are: =over 4 -=item B<efi> +=item C<efi> -=item B<gpt> +=item C<gpt> Intel EFI / GPT partition table. @@ -4900,9 +4900,9 @@ This is recommended for >= 2 TB partitions that will be accessed from Linux and Intel-based Mac OS X. It also has limited backwards compatibility with the C<mbr> format. -=item B<mbr> +=item C<mbr> -=item B<msdos> +=item C<msdos> The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and Windows. This partition type will B<only> work @@ -4916,37 +4916,37 @@ supported include: =over 4 -=item B<aix> +=item C<aix> AIX disk labels. -=item B<amiga> +=item C<amiga> -=item B<rdb> +=item C<rdb> Amiga \"Rigid Disk Block\" format. -=item B<bsd> +=item C<bsd> BSD disk labels. -=item B<dasd> +=item C<dasd> DASD, used on IBM mainframes. -=item B<dvh> +=item C<dvh> MIPS/SGI volumes. -=item B<mac> +=item C<mac> Old Mac partition format. Modern Macs use C<gpt>. -=item B<pc98> +=item C<pc98> NEC PC-98 format, common in Japan apparently. -=item B<sun> +=item C<sun> Sun disk labels. @@ -5052,20 +5052,20 @@ The fields in the returned structure are: =over 4 -=item B<part_num> +=item C<part_num> Partition number, counting from 1. -=item B<part_start> +=item C<part_start> Start of the partition I<in bytes>. To get sectors you have to divide by the device’s sector size, see C<guestfs_blockdev_getss>. -=item B<part_end> +=item C<part_end> End of the partition in bytes. -=item B<part_size> +=item C<part_size> Size of the partition in bytes. @@ -5344,7 +5344,7 @@ checksums supported see the C<guestfs_checksum> command." }; shortdesc = "expand an LV to fill free space"; longdesc = "\ This expands an existing logical volume C<lv> so that it fills -C<pc>% of the remaining free space in the volume group. Commonly +C<pc> % of the remaining free space in the volume group. Commonly you would call this with pc = 100 which expands the logical volume as much as possible, using all remaining free space in the volume group." }; @@ -5683,7 +5683,7 @@ of the underlying block device." }; longdesc = "\ This command erases existing data on C<device> and formats the device as a LUKS encrypted device. C<key> is the -initial key, which is added to key slot C<slot>. (LUKS +initial key, which is added to key slot C<keyslot>. (LUKS supports 8 key slots, numbered 0-7)." }; { defaults with @@ -6115,7 +6115,7 @@ See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>." }; longdesc = "\ This command is the same as C<guestfs_resize2fs>, but the filesystem is resized to its minimum size. This works like the I<-M> option -to the C<resize2fs> command. +to the L<resize2fs(8)> command. To get the resulting size of the filesystem you should call C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> @@ -6463,18 +6463,18 @@ The optional parameters are: =item C<force> Force tune2fs to complete the operation even in the face of errors. -This is the same as the tune2fs C<-f> option. +This is the same as the L<tune2fs(8)> C<-f> option. =item C<maxmountcount> Set the number of mounts after which the filesystem is checked by L<e2fsck(8)>. If this is C<0> then the number of mounts is -disregarded. This is the same as the tune2fs C<-c> option. +disregarded. This is the same as the L<tune2fs(8)> C<-c> option. =item C<mountcount> Set the number of times the filesystem has been mounted. -This is the same as the tune2fs C<-C> option. +This is the same as the L<tune2fs(8)> C<-C> option. =item C<errorbehavior> @@ -6483,12 +6483,12 @@ Possible values currently are: C<continue>, C<remount-ro>, C<panic>. In practice these options don't really make any difference, particularly for write errors. -This is the same as the tune2fs C<-e> option. +This is the same as the L<tune2fs(8)> C<-e> option. =item C<group> Set the group which can use reserved filesystem blocks. -This is the same as the tune2fs C<-g> option except that it +This is the same as the L<tune2fs(8)> C<-g> option except that it can only be specified as a number. =item C<intervalbetweenchecks> @@ -6497,27 +6497,27 @@ Adjust the maximal time between two filesystem checks (in seconds). If the option is passed as C<0> then time-dependent checking is disabled. -This is the same as the tune2fs C<-i> option. +This is the same as the L<tune2fs(8)> C<-i> option. =item C<reservedblockspercentage> Set the percentage of the filesystem which may only be allocated by privileged processes. -This is the same as the tune2fs C<-m> option. +This is the same as the L<tune2fs(8)> C<-m> option. =item C<lastmounteddirectory> Set the last mounted directory. -This is the same as the tune2fs C<-M> option. +This is the same as the L<tune2fs(8)> C<-M> option. =item C<reservedblockscount> Set the number of reserved filesystem blocks. -This is the same as the tune2fs C<-r> option. +This is the same as the L<tune2fs(8)> C<-r> option. =item C<user> Set the user who can use the reserved filesystem blocks. -This is the same as the tune2fs C<-u> option except that it +This is the same as the L<tune2fs(8)> C<-u> option except that it can only be specified as a number. =back @@ -6578,8 +6578,8 @@ The chunk size in bytes. =item C<level> The RAID level, which can be one of: -I<linear>, I<raid0>, I<0>, I<stripe>, I<raid1>, I<1>, I<mirror>, -I<raid4>, I<4>, I<raid5>, I<5>, I<raid6>, I<6>, I<raid10>, I<10>. +C<linear>, C<raid0>, C<0>, C<stripe>, C<raid1>, C<1>, C<mirror>, +C<raid4>, C<4>, C<raid5>, C<5>, C<raid6>, C<6>, C<raid10>, C<10>. Some of these are synonymous, and more levels may be added in future. If not set, this defaults to C<raid1>. @@ -6601,7 +6601,7 @@ List all Linux md devices." }; optional = Some "mdadm"; shortdesc = "obtain metadata for an MD device"; longdesc = "\ -This command exposes the output of 'mdadm -DY E<lt>mdE<gt>'. +This command exposes the output of C<mdadm -DY E<lt>mdE<gt>>. The following fields are usually present in the returned hash. Other fields may also be present. @@ -6908,7 +6908,7 @@ with the I<-d> option on the host to analyze ISO files, instead of going through libguestfs. For information on the primary volume descriptor fields, see -L<http://wiki.osdev.org/ISO_9660#The_Primary_Volume_Descriptor>" }; +L<https://wiki.osdev.org/ISO_9660#The_Primary_Volume_Descriptor>" }; { defaults with name = "isoinfo"; added = (1, 17, 19); @@ -8232,7 +8232,7 @@ Set the type GUID of numbered GPT partition C<partnum> to C<guid>. Return an error if the partition table of C<device> isn't GPT, or if C<guid> is not a valid GUID. -See L<http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs> +See L<https://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs> for a useful list of type GUIDs." }; { defaults with @@ -8624,7 +8624,7 @@ This function is used internally when testing the appliance." }; Copy the attributes of a path (which can be a file or a directory) to another path. -By default C<no> attribute is copied, so make sure to specify any +By default B<no> attribute is copied, so make sure to specify any (or C<all> to copy everything). The optional arguments specify which attributes can be copied: diff --git a/generator/actions_core_deprecated.ml b/generator/actions_core_deprecated.ml index 93c716627..6f2a9192f 100644 --- a/generator/actions_core_deprecated.ml +++ b/generator/actions_core_deprecated.ml @@ -154,14 +154,14 @@ partitions on block devices. C<device> should be a block device, for example F</dev/sda>. C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads -and sectors on the device, which are passed directly to sfdisk as -the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any +and sectors on the device, which are passed directly to L<sfdisk(8)> +as the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the corresponding parameter is omitted. Usually for ‘large’ disks, you can just pass C<0> for these, but for small -(floppy-sized) disks, sfdisk (or rather, the kernel) cannot work +(floppy-sized) disks, L<sfdisk(8)> (or rather, the kernel) cannot work out the right geometry and you will need to tell it. -C<lines> is a list of lines that we feed to C<sfdisk>. For more +C<lines> is a list of lines that we feed to L<sfdisk(8)>. For more information refer to the L<sfdisk(8)> manpage. To create a single partition occupying the whole disk, you would @@ -370,10 +370,10 @@ and C<guestfs_part_disk>" }; deprecated_by = Replaced_by "file"; shortdesc = "determine file type inside a compressed file"; longdesc = "\ -This command runs F<file> after first decompressing C<path> -using C<method>. +This command runs L<file(1)> after first decompressing C<path> +using C<meth>. -C<method> must be one of C<gzip>, C<compress> or C<bzip2>. +C<meth> must be one of C<gzip>, C<compress> or C<bzip2>. Since 1.0.63, use C<guestfs_file> instead which can now process compressed files." }; @@ -390,7 +390,7 @@ process compressed files." }; ]; shortdesc = "return lines matching a pattern"; longdesc = "\ -This calls the external C<egrep> program and returns the +This calls the external L<egrep(1)> program and returns the matching lines." }; { defaults with @@ -405,7 +405,7 @@ matching lines." }; ]; shortdesc = "return lines matching a pattern"; longdesc = "\ -This calls the external C<fgrep> program and returns the +This calls the external L<fgrep(1)> program and returns the matching lines." }; { defaults with @@ -465,7 +465,7 @@ matching lines." }; ]; shortdesc = "return lines matching a pattern"; longdesc = "\ -This calls the external C<zgrep> program and returns the +This calls the external L<zgrep(1)> program and returns the matching lines." }; { defaults with @@ -778,7 +778,7 @@ it to local file C<tarball> (as an xz compressed tar archive)." }; deprecated_by = Replaced_by "lgetxattrs"; shortdesc = "list the files in a directory (long format with SELinux contexts)"; longdesc = "\ -List the files in F<directory> in the format of 'ls -laZ'. +List the files in F<directory> in the format of C<ls -laZ>. This command is mostly useful for interactive sessions. It is I<not> intended that you try to parse the output string." }; diff --git a/generator/actions_inspection.ml b/generator/actions_inspection.ml index 7c033ae4f..809344c8c 100644 --- a/generator/actions_inspection.ml +++ b/generator/actions_inspection.ml @@ -632,8 +632,8 @@ The application structure contains the following fields: =item C<app2_name> -The name of the application. For Red Hat-derived and Debian-derived -Linux guests, this is the package name. +The name of the application. For Linux guests, this is the package +name. =item C<app2_display_name> @@ -763,8 +763,8 @@ required size. =item * Extracting icons from Windows guests requires the external -C<wrestool> program from the C<icoutils> package, and -several programs (C<bmptopnm>, C<pnmtopng>, C<pamcut>) +L<wrestool(1)> program from the C<icoutils> package, and +several programs (L<bmptopnm(1)>, L<pnmtopng(1)>, L<pamcut(1)>) from the C<netpbm> package. These must be installed separately. =item * diff --git a/generator/actions_inspection_deprecated.ml b/generator/actions_inspection_deprecated.ml index 0d5b48c49..8a6749eec 100644 --- a/generator/actions_inspection_deprecated.ml +++ b/generator/actions_inspection_deprecated.ml @@ -50,8 +50,8 @@ The application structure contains the following fields: =item C<app_name> -The name of the application. For Red Hat-derived and Debian-derived -Linux guests, this is the package name. +The name of the application. For Linux guests, this is the package +name. =item C<app_display_name> @@ -136,16 +136,16 @@ installer CDs. This API would return: =over 4 -=item \"installed\" +=item C<installed> This is an installed operating system. -=item \"installer\" +=item C<installer> The disk image being inspected is not an installed operating system, but a I<bootable> install disk, live CD, or similar. -=item \"unknown\" +=item C<unknown> The format of this disk image is not known. diff --git a/generator/actions_properties.ml b/generator/actions_properties.ml index a713609ae..bbda430bb 100644 --- a/generator/actions_properties.ml +++ b/generator/actions_properties.ml @@ -600,9 +600,9 @@ Get the handle identifier. See C<guestfs_set_identifier>." }; longdesc = "\ Get the directory used by the handle to store temporary socket files. -This is different from C<guestfs_tmpdir>, as we need shorter paths for -sockets (due to the limited buffers of filenames for UNIX sockets), -and C<guestfs_tmpdir> may be too long for them. +This is different from C<guestfs_get_tmpdir>, as we need shorter +paths for sockets (due to the limited buffers of filenames for UNIX +sockets), and C<guestfs_get_tmpdir> may be too long for them. The environment variable C<XDG_RUNTIME_DIR> controls the default value: If C<XDG_RUNTIME_DIR> is set, then that is the default. -- 2.21.0

2 1

[PATCH libnbd proposal] api: Add semi-private function for freeing persistent data.
by Richard W.M. Jones 12 Aug '19

12 Aug '19

This adds a C-only semi-private function for freeing various types of persistent data passed to libnbd. There are some similarities with nbd_add_close_callback which we removed in commit 7f191b150b52ed50098976309a6af883d245fc56. --- generator/generator | 46 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/generator/generator b/generator/generator index 55c4dfc..0ea6b61 100755 --- a/generator/generator +++ b/generator/generator @@ -3284,6 +3284,7 @@ let generate_lib_libnbd_syms () = pr "LIBNBD_%d.%d {\n" major minor; pr " global:\n"; if (major, minor) = (1, 0) then ( + pr " nbd_add_free_callback;\n"; pr " nbd_create;\n"; pr " nbd_close;\n"; pr " nbd_get_errno;\n"; @@ -3581,6 +3582,12 @@ let generate_include_libnbd_h () = pr "extern int nbd_get_errno (void);\n"; pr "#define LIBNBD_HAVE_NBD_GET_ERRNO 1\n"; pr "\n"; + pr "typedef void (*nbd_free_callback) (void *ptr);\n"; + pr "extern int nbd_add_free_callback (struct nbd_handle *h,\n"; + pr " nbd_free_callback cb,\n"; + pr " void *ptr);\n"; + pr "#define LIBNBD_HAVE_NBD_ADD_FREE_CALLBACK 1\n"; + pr "\n"; print_closure_typedefs (); List.iter ( fun (name, { args; optargs; ret }) -> @@ -4005,6 +4012,45 @@ C<E<lt>errno.hE<gt>>. List.iter print_api handle_calls; pr "\ +=head1 FREE CALLBACKS + +B<Note:> The API described in this section is only +available from C. It is designed to help when writing +bindings to libnbd in other programming languages. +As such it is B<not> covered by the usual API stability +guarantee offered by other parts of the C API. Use it with care. + +Some pointers passed to libnbd calls are saved in the +S<C<struct nbd_handle>>. These include pointers to buffers +passed to C<nbd_aio_pread>, C<nbd_aio_pwrite>, etc., +and pointers to the C<user_data> for callbacks. If you +want to know when it is safe to free these objects then +you can register a free callback using: + + typedef void (*nbd_free_callback) (void *ptr); + int nbd_add_free_callback (struct nbd_handle *h, + nbd_free_callback cb, + void *ptr); + +C<ptr> is a pointer to the object (ie. the buffer or +callback C<user_data>). C<cb (ptr)> is called when libnbd +no longer holds a reference to that object. + +To illustrate how this works with an example: + + struct my_user_data *my_user_data; + void *buf; + + my_user_data = malloc (sizeof *my_user_data); + buf = malloc (512); + nbd_add_free_callback (nbd, free, my_user_data); + nbd_add_free_callback (nbd, free, buf); + nbd_aio_pwrite_callback (nbd, buf, 512, 0, + write_completed, my_user_data, 0); + +This would free both C<my_user_data> and C<buf> once libnbd +has finished with them. + =head1 SEE ALSO L<libnbd(3)>. -- 2.22.0

2 3

[PATCH libnbd v2 0/3] python: Add test for doing asynch copy.
by Richard W.M. Jones 12 Aug '19

12 Aug '19

v1 was here: https://www.redhat.com/archives/libguestfs/2019-August/msg00103.html In v2 I've made several changes: - Fix Python callbacks so if they don't return something which is int-like, we assume they mean to return 0. - Add nbd.Buffer free() method. Read commit message in patch 2 to see what this is about. - Fixed the asynch copy test to deal with the unbelievably braindead behaviour of Python closures. It took me many hours this morning to work out what was going on. It turns out that Python closures aren't closed (yeah, the clue is in the name, Python developers). Rich.

2 4

[PATCH libnbd 0/9] Add Enum and Flags types.
by Richard W.M. Jones 12 Aug '19

12 Aug '19

This largish series adds several new features to the generator. Enum maps to enumerated types (like enum in C). The only current use for this is replacing the nbd_set_tls (nbd, 0/1/2) parameter with LIBNBD_TLS_DISABLE, LIBNBD_TLS_ALLOW, LIBNBD_TLS_REQUIRE (and natural equivalents in other programming languages). Flags maps to any uint32_t bitmask. It is basically a non-optional, generalized variation on OFlags with some nice features. Two commits also add checking so that we check that the Enum, Flags or OFlags parameters don't contain values which are invalid at the time of compilation. This breaks new caller / old DLL at runtime (which may not be a bad thing). Note that at least patch #9 and maybe even #7 and #8 are mainly being posted for discussion. Rich.

2 23

[PATCH libnbd 0/5] WIP: python: Add test for doing asynch copy.
by Richard W.M. Jones 11 Aug '19

11 Aug '19

This doesn't yet work. However it does make me more convinced than ever that we really need to sort out persistent buffer lifetimes in the library (similar to what we did for closures). Rich.

2 8

[PATCH] v2v: rhv-upload-plugin - improve wait logic after finalize (RHBZ#1680361)
by Daniel Erez 09 Aug '19

09 Aug '19

After invoking transfer_service.finalize, check operation status by examining ImageTransferPhase and DiskStatus. This is done instead of failing after a predefined timeout regardless the status. * not verified * Bug-Url: https://bugzilla.redhat.com/show_bug.cgi?id=1680361 --- v2v/rhv-upload-plugin.py | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/v2v/rhv-upload-plugin.py b/v2v/rhv-upload-plugin.py index 2a950c5ed..873c11ce1 100644 --- a/v2v/rhv-upload-plugin.py +++ b/v2v/rhv-upload-plugin.py @@ -523,14 +523,30 @@ def close(h): # waiting for the transfer object to cease to exist, which # falls through to the exception case and then we can # continue. - endt = time.time() + timeout + start = time.time() try: while True: time.sleep(1) - tmp = transfer_service.get() - if time.time() > endt: - raise RuntimeError("timed out waiting for transfer " - "to finalize") + transfer = transfer_service.get() + + if transfer is None: + disk_service = h['disk_service'] + disk = disk_service.get() + if disk.status == types.DiskStatus.OK: + continue + + if transfer.phase == types.ImageTransferPhase.FINISHED_SUCCESS: + debug("finalized after %s seconds", time.time() - start) + break + + if transfer.phase == types.ImageTransferPhase.FINALIZING_SUCCESS: + if time.time() > start + timeout: + raise RuntimeError("timed out waiting for transfer " + "to finalize") + continue + + raise RuntimeError("Unexpected transfer phase while finalizing " + "upload %r" % transfer.phase) except sdk.NotFoundError: pass --

3 9

[PATCH libnbd 0/2] generator: Preparatory changes to the generator.
by Richard W.M. Jones 09 Aug '19

09 Aug '19

These are some simplifications to the generator. They don't probably make much sense on their own, but they are preparatory to better handling of enums, and or'd lists of flags. Rich.

2 6

Re: [Libguestfs] Debian 10 on libguestfs
by Richard W.M. Jones 08 Aug '19

08 Aug '19

On Thu, Aug 08, 2019 at 12:28:49PM +0200, titi wrote: > Hello, > > Are you planning to import Debian 10 on libguestfs ? Ah it was released, I missed that. Yes I'll push something when I get a moment. Rich. -- Richard Jones, Virtualization Group, Red Hat http://people.redhat.com/~rjones Read my programming and virtualization blog: http://rwmj.wordpress.com virt-top is 'top' for virtual machines. Tiny program with many powerful monitoring features, net stats, disk stats, logging, etc. http://people.redhat.com/~rjones/virt-top

1 0