docs/nbdkit-release-notes-1.26.pod

   1 =head1 NAME
   2
   3 nbdkit-release-notes-1.26 - release notes for nbdkit 1.26
   4
   5 =head1 DESCRIPTION
   6
   7 These are the release notes for nbdkit stable release 1.26.
   8 This describes the major changes since 1.24.
   9
  10 nbdkit 1.26.0 was released on B<7 June 2021>.
  11
  12 nbdkit is now hosted on gitlab:
  13 L<https://listman.redhat.com/archives/libguestfs/2021-February/msg00021.html>
  14
  15 =head2 Security
  16
  17 There were no security issues found.  All past security issues and
  18 information about how to report new ones can be found in
  19 L<nbdkit-security(1)>.
  20
  21 =begin comment
  22
  23 =head2 Server
  24
  25 =end comment
  26
  27 =head2 Plugins
  28
  29 nbdkit-gzip-plugin and nbdkit-tar-plugin have been removed.  They were
  30 deprecated in nbdkit 1.22.  The functionality has been replaced by
  31 L<nbdkit-gzip-filter(1)> and L<nbdkit-tar-filter(1)> respectively.
  32
  33 nbdkit-streaming-plugin(1) has been deprecated and will be removed
  34 in S<nbdkit 1.30>.  You can use L<nbdcopy(1)> instead.
  35
  36 L<nbdkit-curl-plugin(1)> adds these features: C<followlocation=false>
  37 to disable following redirects.  C<cookiefile> and C<cookiejar> to
  38 control saving cookies.
  39
  40 L<nbdkit-ssh-plugin(1)> now advertises multi-conn if the server is
  41 OpenSSH, improving performance (Eric Blake).
  42
  43 L<nbdkit-ondemand-plugin(1)> has a new C<wait=true> flag allowing you
  44 to choose between clients waiting for an export to become free or
  45 being immediately rejected.
  46
  47 L<nbdkit-sparse-random-plugin(1)> now does not generate fully random
  48 data within each block.  Using perf we observed that the plugin was
  49 spending 34% of the total time during benchmarks just doing this.  You
  50 can enable the old behaviour using C<random-content=true>.
  51
  52 L<nbdkit-file-plugin(1)> now checks if the file is read-only and
  53 exports a read-only NBD connection in this case (Eric Blake).
  54
  55 L<nbdkit-vddk-plugin(1)> has been tested with VDDK 7.0.2.
  56
  57 =head2 Filters
  58
  59 There is a new API for use by filters to manage "contexts".  Instead
  60 of the previous 1-1 relationship between filter connections and plugin
  61 connections, filters can now open more than one context into the
  62 backend from a single connection, or share contexts between
  63 connections (Eric Blake).
  64
  65 New L<nbdkit-multi-conn-filter(1)> which allows you to add multi-conn
  66 support to plugins which don't support it (although the emulation is
  67 expensive), or change whether multi-conn is advertised to clients
  68 (Eric Blake).
  69
  70 L<nbdkit-cow-filter(1)> now ignores flush/FUA requests (which are not
  71 useful for a temporary overlay).  The filter now implements extents
  72 and efficient trimming.  Fine-grained locking is used around shared
  73 structures, greatly improving parallel performance.  Added support for
  74 multi-conn.
  75
  76 L<nbdkit-cache-filter(1)> advertises multi-conn when possible
  77 (Eric Blake).
  78
  79 nbdkit-cache-filter and nbdkit-cow-filter can now handle arbitrary
  80 sized disks, instead of rounding the disk size down.
  81
  82 L<nbdkit-blocksize-filter(1)> supports parallel requests (Eric Blake).
  83
  84 L<nbdkit-checkwrite-filter(1)> supports multi-conn (Eric Blake).
  85
  86 L<nbdkit-ext2-filter(1)> no longer supports multi-conn.  The filter is
  87 single-threaded so it does not matter, but it was not safe.  Fix trim,
  88 zero and flush support (Eric Blake).
  89
  90 L<nbdkit-readahead-filter(1)> fixes multi-conn support (Eric Blake).
  91
  92 L<nbdkit-gzip-filter(1)> and L<nbdkit-xz-filter(1)> now both support
  93 multi-conn (Eric Blake).
  94
  95 =head2 Language bindings
  96
  97 L<nbdkit-python-plugin(3)> supports the following new features:
  98 C<after_fork> and C<preconnect> methods.  C<nbdkit.shutdown()>
  99 binding.
 100
 101 L<nbdkit-rust-plugin(3)> updated for newer Rust compiler versions
 102 (Alan Somers).
 103
 104 L<nbdkit-golang-plugin(3)> now uses and requires golang modules.
 105 Golang E<ge> 1.13 must be used.
 106
 107 =head2 API
 108
 109 New C<.cleanup> callback for plugins and filters.  This is called
 110 shortly before C<.unload>, but unlike C<.unload> it is guaranteed that
 111 no plugin or filter code has been dlclosed (Eric Blake).
 112
 113 New C<nbdkit_extents_full> is a helper function for filters which can
 114 be used to read all extents from a plugin covering a region.
 115
 116 =begin comment
 117
 118 =head2 Bug fixes
 119
 120 =head2 Documentation
 121
 122 =end comment
 123
 124 =head2 Tests
 125
 126 Old plugins that we use for testing were rebuilt so they no longer
 127 depend on libselinux (thanks Thomas Weißschuh).
 128
 129 L<nbdkit-ssh-plugin(1)> can still be built even if ssh-keygen is
 130 unavailable for testing it (thanks Thomas Weißschuh).
 131
 132 Improve F<tests/test-captive.sh> to avoid crashes during testing.
 133
 134 Test coverage on FreeBSD has been improved, fewer tests should skip
 135 unnecessarily.
 136
 137 =head2 Build
 138
 139 nbdkit and plugins can now be built with I<-fvisibility=hidden>, which
 140 allows the compiler to make some optimizations.
 141
 142 Add a dependency so nbdkit is relinked if the linker script
 143 (F<nbdkit.syms>) changes (Eric Blake).
 144
 145 xorriso is now preferred over genisoimage or mkisofs (see
 146 L<https://wiki.debian.org/genisoimage>).
 147
 148 It is now possible to compile nbdkit with clang with warnings enabled.
 149 Several warnings have been suppressed or fixed.
 150
 151 C<MALLOC_CHECK_> and C<MALLOC_PERTURB_> are only enabled when running
 152 the tests, not when running nbdkit from the build directory.  This
 153 makes it easier to do benchmarks.
 154
 155 C<nbdkit_peer_*> implemented on OpenBSD.
 156
 157 =head2 Internals
 158
 159 When fuzzing nbdkit we now recommend using the S<I<-t 1>> flag (which
 160 disables threads).  This improves the fuzz-stability of nbdkit.
 161
 162 =head1 SEE ALSO
 163
 164 L<nbdkit(1)>.
 165
 166 =head1 AUTHORS
 167
 168 Authors of nbdkit 1.26:
 169
 170 =over 4
 171
 172 =item *
 173
 174 Alan Somers
 175
 176 =item *
 177
 178 Eric Blake
 179
 180 =item *
 181
 182 Michael Ablassmeier
 183
 184 =item *
 185
 186 Richard W.M. Jones
 187
 188 =item *
 189
 190 Timm Bäder
 191
 192 =back
 193
 194 =head1 COPYRIGHT
 195
 196 Copyright Red Hat