.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Podwrapper::Man 1.36.3 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "nbdkit-release-notes-1.32 1"
.TH nbdkit-release-notes-1.32 1 2024-01-17 nbdkit-1.36.3 NBDKIT
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
nbdkit\-release\-notes\-1.32 \- release notes for nbdkit 1.32
.SH DESCRIPTION
.IX Header "DESCRIPTION"
These are the release notes for nbdkit stable release 1.32.
This describes the major changes since 1.30.
.PP
nbdkit 1.32.0 was released on \fB1 August 2022\fR.
.SS Security
.IX Subsection "Security"
There were no security issues found.  All past security issues and
information about how to report new ones can be found in
\&\fBnbdkit\-security\fR\|(1).
.SS Plugins
.IX Subsection "Plugins"
\&\fBnbdkit\-ssh\-plugin\fR\|(1) has new \f(CW\*(C`create=(true|false)\*(C'\fR, \f(CW\*(C`create\-size\*(C'\fR
and \f(CW\*(C`create\-mode\*(C'\fR parameters to allow remote files to be created.
.PP
\&\fBnbdkit\-S3\-plugin\fR\|(1) was largely rewritten and should have better
performance and compatibility.  It also supports
splitting/concatenating multiple S3 objects into one virtual disk.
(Nikolaus Rath)
.SS Filters
.IX Subsection "Filters"
New \fBnbdkit\-luks\-filter\fR\|(1) allows you to open, read and write LUKSv1
disk images.  It is compatible with qemu and dm-crypt.
.PP
New \fBnbdkit\-scan\-filter\fR\|(1) which simply scans across the disk
issuing prefetches.
.PP
\&\fBnbdkit\-readahead\-filter\fR\|(1) has been completely rewritten so now it
uses prefetching from a parallel thread.  The old readahead filter was
deprecated, but if you are using it you should carefully read the new
documentation because it may require changes.
.PP
\&\fBnbdkit\-stats\-filter\fR\|(1) now summarises block size and alignment of
requests (Nikolaus Rath).
.PP
\&\fBnbdkit\-blocksize\-filter\fR\|(1) now handles parallel writes without
losing writes because of overlapping read-modify-write cycles.  If you
are using the blocksize filter it is recommended to upgrade.  (Eric
Blake)
.PP
\&\fBnbdkit\-rate\-filter\fR\|(1) has a new \f(CW\*(C`burstiness\*(C'\fR parameter allowing
the bucket capacity to be adjusted, which helps with smoothing out
large, lumpy client requests.
.SS "Language bindings"
.IX Subsection "Language bindings"
Add \f(CW\*(C`nbdkit.parse_size()\*(C'\fR binding for Python (Nikolaus Rath).
.PP
Compatibility with OCaml 4.14.
.PP
Compatibility with Perl 5.36.
.SS Server
.IX Subsection "Server"
Add macOS (Darwin) support.  See the relevant section in the top level
\&\fIREADME.md\fR file.
.PP
kTLS should now work (transparently) when available in the kernel and
GnuTLS.  Use of kTLS will be indicated in debug output.  (Daiki Ueno,
František Krenželok)
.SS "Bug fixes"
.IX Subsection "Bug fixes"
\&\fBnbdkit\-sh\-plugin\fR\|(3) now handles inline scripts correctly on
non-glibc platforms (Martin Kletzander).
.PP
Catch the case where nbdkit ends up linked to OpenSSL (because of a
transient dependency through GnuTLS) which broke
\&\fBnbdkit\-vddk\-plugin\fR\|(1).  For more details see
https://bugzilla.redhat.com/2057490.
.PP
Fix memory leak in \fBnbdkit\-python\-plugin\fR\|(3) which would lead to
large amounts of memory being leaked if your plugin implemented
\&\f(CW\*(C`list_exports\*(C'\fR or \f(CW\*(C`extents\*(C'\fR callbacks (Eric Blake).
.PP
The \fBnbdkit\-curl\-plugin\fR\|(1) cookie/header scripts feature now
generates an error properly if the shell script fails.
.PP
Fix further "phone home" messages in \fBnbdkit\-vddk\-plugin\fR\|(1) (thanks
Ming Xie).
.PP
Improve error message from \fBnbdkit\-vddk\-plugin\fR\|(1) when the
thumbprint parameter is wrong (Laszlo Ersek).
.PP
Fix \f(CW\*(C`NBDKIT_CACHE_EMULATE\*(C'\fR and \f(CW\*(C`NBDKIT_ZERO_EMULATE\*(C'\fR in filters.
These could cause assertion failures before.  (Eric Blake)
.PP
Fix \fBnbdkit\-protect\-filter\fR\|(1) test if dependencies are missing
(thanks Jim Fehlig).
.PP
Fix a bounds error in \fBnbdkit\-checkwrite\-filter\fR\|(1).
.PP
The server will now fail and exit early if the \fI\-\-tls\-verify\-peer\fR
option is used on platforms which do not support it.  Previously it
would only fail when a client connected using TLS.
.PP
Various bugs found by Coverity were analysed and fixed (Eric Blake).
.SS Documentation
.IX Subsection "Documentation"
Document how to write plugins and filters in C++.  This has always
been possible, but was never documented before.
.PP
Document how to run nbdkit from inetd or xinetd superservers.
.PP
Fix how verbatim paragraphs in the documentation are rendered in HTML.
.PP
Document how to use nbdkit + TLS with \fBnbd\-client\fR\|(1).
.SS Tests
.IX Subsection "Tests"
Various enhancements to fuzzing including supporting AFL++, AFL++
clang-LTO.  Add \f(CW\*(C`./configure \-\-disable\-linker\-script\*(C'\fR which is needed
to use ASAN, and document how to use ASAN when fuzzing.
.PP
Improve runtime of linuxdisk test (Eric Blake).
.PP
Add interoperability tests with \fBnbd\-client\fR\|(1), the Linux kernel
client, including TLS support.
.SS Build
.IX Subsection "Build"
Add GitLab continuous integration (CI) at
https://gitlab.com/nbdkit/nbdkit/\-/pipelines and many miscellaneous
build fixes (Martin Kletzander).
.PP
There are now \f(CW\*(C`string_vector\*(C'\fR and \f(CW\*(C`const_string_vector\*(C'\fR defined
under \fIcommon/utils\fR and used consistently throughout the code.
.PP
Microsoft Visual Studio Code formatting settings are available (in
\&\fI.vscode/\fR) (Nikolaus Rath).
.PP
Remove \fIscripts/vddk\-open.sh\fR.  It is now available as a separate
project: https://gitlab.com/nbdkit/vddk\-remote
.PP
\&\f(CW\*(C`ARRAY_SIZE\*(C'\fR macro added to simplify static array sizing (thanks
Laszlo Ersek).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBnbdkit\fR\|(1).
.SH AUTHORS
.IX Header "AUTHORS"
Authors of nbdkit 1.32:
.IP "Alan Somers" 4
.IX Item "Alan Somers"
.PD 0
.IP "Eric Blake" 4
.IX Item "Eric Blake"
.IP "Laszlo Ersek" 4
.IX Item "Laszlo Ersek"
.IP "Martin Kletzander" 4
.IX Item "Martin Kletzander"
.IP "Nikolaus Rath" 4
.IX Item "Nikolaus Rath"
.IP "Richard W.M. Jones" 4
.IX Item "Richard W.M. Jones"
.PD
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright Red Hat
.SH LICENSE
.IX Header "LICENSE"
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
.IP \(bu 4
Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
.IP \(bu 4
Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
.IP \(bu 4
Neither the name of Red Hat nor the names of its contributors may be
used to endorse or promote products derived from this software without
specific prior written permission.
.PP
THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.