.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Podwrapper::Man 1.38.2 (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.36 1"
.TH nbdkit-release-notes-1.36 1 2024-05-08 nbdkit-1.38.2 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.36 \- release notes for nbdkit 1.36
.SH DESCRIPTION
.IX Header "DESCRIPTION"
These are the release notes for nbdkit stable release 1.36.
This describes the major changes since 1.34.
.PP
nbdkit 1.36.0 was released on \fB27 September 2023\fR.
.SS Security
.IX Subsection "Security"
No security issues were identified in this release.
.PP
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"
New \fBnbdkit\-ones\-plugin\fR\|(1) which creates a fully allocated disk
containing all 0xff (all ones), or another byte of your choice.
.PP
\&\fBnbdkit\-curl\-plugin\fR\|(1) now uses a curl "multi" interface.  This
enables much better performance, and also allows the curl plugin to
handle requests in parallel.  The curl plugin now falls back to making
a \f(CW\*(C`GET\*(C'\fR request to get the size of the remote file for certain
servers which do not support \f(CW\*(C`HEAD\*(C'\fR requests.  This plugin adds new
options: \f(CW\*(C`ipresolve\*(C'\fR (force IPv4 or IPv6), \f(CW\*(C`resolve\*(C'\fR (force a
particular IP address), \fI\-D curl.times=1\fR (print detailed timing
stats), and \fI\-D curl.verbose.ids=1\fR (display connection and transfer
IDs).
.PP
\&\fBnbdkit\-memory\-plugin\fR\|(1) now uses a read-write lock to protect
internal structures, resulting in improved performance for mostly read
workloads.
.PP
\&\fBnbdkit\-data\-plugin\fR\|(1) now has more optimizations.
.PP
\&\fBnbdkit\-file\-plugin\fR\|(1) now supports 4k sector sizes on Windows
(Brian Carnes).
.SS Filters
.IX Subsection "Filters"
New \fBnbdkit\-evil\-filter\fR\|(1) adds random but consistent data
corruption to the underlying plugin.
.PP
New \fBnbdkit\-qcow2dec\-filter\fR\|(1) which can decode qcow2 files (but not
write to them).
.PP
\&\fBnbdkit\-ip\-filter\fR\|(1) can now filter by client SELinux label.
.PP
\&\fBnbdkit\-partition\-filter\fR\|(1) now supports 4k sector sizes (Brian
Carnes).
.PP
\&\fBnbdkit\-retry\-request\-filter\fR\|(1) allows the \f(CW\*(C`get_size\*(C'\fR operation to
be retried.
.PP
\&\fBnbdkit\-tar\-filter\fR\|(1) adds new \f(CW\*(C`tar\-limit\*(C'\fR parameter which can be
used to ensure the filter does not read indefinite amounts of input
when opening the tar file.
.PP
Filters can now append their own output to nbdkit \fI\-\-dump\-plugin\fR
output.
.SS "Language bindings"
.IX Subsection "Language bindings"
Rust bindings add support for \f(CW\*(C`after_fork\*(C'\fR, \f(CW\*(C`block_size\*(C'\fR,
\&\f(CW\*(C`nbdkit_debug\*(C'\fR, \f(CW\*(C`nbdkit_is_tls\*(C'\fR, \f(CW\*(C`nbdkit_parse_size\*(C'\fR,
\&\f(CW\*(C`nbdkit_parse_bool\*(C'\fR and \f(CW\*(C`nbdkit_parse_probability\*(C'\fR.  The \f(CW\*(C`open\*(C'\fR
method can now return an error; note this is not backwards compatible
and requires a small source code change to Rust plugins.  (Thanks Alan
Somers)
.PP
\&\fBnbdkit\-ocaml\-plugin\fR\|(3) now supports OCaml 5.
.PP
OCaml bindings add support for \f(CW\*(C`nbdkit_stdio_safe\*(C'\fR, \f(CW\*(C`nbdkit_is_tls\*(C'\fR,
\&\f(CW\*(C`nbdkit_peer_name\*(C'\fR and \f(CW\*(C`nbdkit_peer_security_context\*(C'\fR.
.PP
\&\fBnbdkit\-perl\-plugin\fR\|(3) now supports Perl 5.38.
.PP
Shell script plugins (\fBnbdkit\-sh\-plugin\fR\|(3)) may now ignore stdin in
their \f(CW\*(C`pwrite\*(C'\fR method, whereas previously it was required to read and
discard stdin along error paths (thanks Eric Blake).
.SS Server
.IX Subsection "Server"
When using the \fI\-\-run\fR option, the default is now to use a private
Unix domain socket (as if \fI\-U \-\fR was specified), whereas in nbdkit
≤ 1.34 the default was to open a TCP port.  The new default
reflects the most common and safest way to use the \fI\-\-run\fR option.
You can find out if nbdkit has the new behaviour by checking
\&\f(CW\*(C`nbdkit\ \-\-dump\-config\*(C'\fR and looking for \f(CW\*(C`run_default_socket=Unix\*(C'\fR
in the output.
.PP
Debug strings containing control codes and other non-printable
characters are now escaped properly.
.PP
New flag \fI\-D nbdkit.environ=1\fR can be used to dump the server
environment in debug output.
.SS API
.IX Subsection "API"
New \f(CW\*(C`nbdkit_parse_probability\*(C'\fR function which can be used to parse
probabilities in various formats, like \f(CW"10%"\fR or \f(CW"1:10"\fR.
.PP
New \f(CW\*(C`nbdkit_peer_security_context\*(C'\fR function which returns the
security context (usually SELinux label) of the client.
.SS "Bug fixes"
.IX Subsection "Bug fixes"
Fix long-standing double-free in \fBnbdkit\-file\-plugin\fR\|(1) when the
client closes the connection during negotiation (thanks Eric Blake).
.PP
nbdkit-file-plugin now has improved error messages when you try to
open a file with an empty name (\f(CW""\fR).
.SS Documentation
.IX Subsection "Documentation"
Miscellaneous documentation improvements for Windows (Brian Carnes).
.PP
Fuzzing instructions updated for Clang 17, AFL++ 4.08c.
.SS Tests
.IX Subsection "Tests"
Ongoing CI maintenance and fixes (Laszlo Ersek, Eric Blake).
.PP
Many fixes in the test suite for MinGW and Wine.
.PP
Several internal consistency checks were added to the test suite, to
ensure, for example, that we always use \f(CW\*(C`requires_run\*(C'\fR when the test
uses the nbdkit \fI\-\-run\fR option.
.SS Build
.IX Subsection "Build"
Optionally \f(CW\*(C`zlib\-ng\*(C'\fR can be used (instead of \f(CW\*(C`zlib\*(C'\fR) for faster
decompression in various places.
.PP
No longer link with msvcrt on Windows.
.PP
\&\f(CW\*(C`awk\*(C'\fR is a build requirement.  It was implicitly required before
(because it is needed by the \f(CW\*(C`./configure\*(C'\fR script generated by
autoconf), but now the dependency is explicit (Eric Blake).
.SS Internals
.IX Subsection "Internals"
\&\f(CW\*(C`podwrapper\*(C'\fR has a new \fI\-\-replace\fR parameter which makes it easier
to use \f(CW\*(C`AC_SUBST\*(C'\fR\-substitutions in documentation.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBnbdkit\fR\|(1).
.SH AUTHORS
.IX Header "AUTHORS"
Authors of nbdkit 1.36:
.IP "Alan Somers" 4
.IX Item "Alan Somers"
.PD 0
.IP "Brian Carnes" 4
.IX Item "Brian Carnes"
.IP "Eric Blake" 4
.IX Item "Eric Blake"
.IP "Laszlo Ersek" 4
.IX Item "Laszlo Ersek"
.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.