.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Podwrapper::Man 1.20.1 (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 "libnbd-release-notes-1.12 1"
.TH libnbd-release-notes-1.12 1 2024-05-08 libnbd-1.20.1 LIBNBD
.\" 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
libnbd\-release\-notes\-1.12 \- release notes for libnbd 1.12
.SH DESCRIPTION
.IX Header "DESCRIPTION"
These are the release notes for libnbd stable release 1.12.
This describes the major changes since 1.10.
.PP
libnbd 1.12.0 was released on \fB24 February 2022\fR.
.SS Security
.IX Subsection "Security"
.IP CVE\-2022\-0485 4
.IX Item "CVE-2022-0485"
Silent data corruption when using \fBnbdcopy\fR\|(1).
.Sp
See the full announcement here:
https://listman.redhat.com/archives/libguestfs/2022\-February/msg00104.html
.PP
If you find a security issue, please read \fISECURITY\fR in the source
(online here:
https://gitlab.com/nbdkit/libnbd/blob/master/SECURITY).  To
find out about previous security issues in libnbd, see
\&\fBlibnbd\-security\fR\|(3).
.SS "New APIs"
.IX Subsection "New APIs"
.IP get_pread_initialize 4
.IX Item "get_pread_initialize"
.PD 0
.IP set_pread_initialize 4
.IX Item "set_pread_initialize"
.PD
Control whether libnbd clears the pread buffer to avoid leaking memory
contents if the client does not properly handle errors.  These were
added as part of the fix for CVE\-2022\-0485 (Eric Blake).
.IP get_request_block_size 4
.IX Item "get_request_block_size"
.PD 0
.IP set_request_block_size 4
.IX Item "set_request_block_size"
.PD
Control whether libnbd requests block size constraints from the server
during negotiation (Eric Blake).
.SS "Enhancements to existing APIs"
.IX Subsection "Enhancements to existing APIs"
Error messages about incorrect URIs in \fBnbd_connect_uri\fR\|(3) have been
improved to make common mistakes clearer for the user.
.SS Tools
.IX Subsection "Tools"
New syntax: \f(CW\*(C`nbdinfo [ CMD ... ]\*(C'\fR allowing you to query the
properties of an NBD server directly.
.PP
\&\fBnbdcopy\fR\|(1) new \fI\-\-queue\-size\fR option to control the maximum size
of the internal buffer (Nir Soffer).
.PP
\&\fBnbdcopy\fR\|(1) now names the source and destination handles to make it
easier to understand debug output.
.SS Tests
.IX Subsection "Tests"
Adopt libvirt-ci's \fIci/gitlab.yml\fR (Martin Kletzander).
.PP
Fix the OCaml extents example (thanks Laszlo Ersek).
.PP
Golang benchmarks were added to the test suite (Nir Soffer).
.PP
The large \fItests/errors.c\fR test was split into about a dozen separate
tests.  Also this adds a new test for checking server-side block size
constraint error policy which was missing before.
.SS "Other improvements and bug fixes"
.IX Subsection "Other improvements and bug fixes"
New OCaml \f(CW\*(C`NBD.with_handle\*(C'\fR helper which ensures that \f(CW\*(C`NBD.close\*(C'\fR is
always called even if the inner code throws an exception.
.PP
The OCaml bindings now consistently use the correct types for buffer
sizes everywhere (Laszlo Ersek).
.PP
Several improvements and fixes to the golang bindings and tests.  The
golang bindings have been relicensed to LGPLv2+ like the rest of the
library and are now published as a golang module at
https://libguestfs.org/libnbd (Nir Soffer).
.PP
The Python bindings no longer crash if you pass \f(CW\*(C`None\*(C'\fR in place of a
buffer parameter.  In addition some memory leaks were fixed (Eric
Blake).
.PP
Various memory leaks have been fixed when using the optional
strict_mode settings (Eric Blake).
.PP
The performance of the internal vector library has been improved
greatly and overflow is now handled correctly (Nir Soffer, Laszlo
Ersek and Eric Blake).
.PP
Add \f(CW\*(C`simple_copy\*(C'\fR and \f(CW\*(C`aio_copy\*(C'\fR Golang examples (Nir Soffer).
.PP
Error handling was reviewed and fixed across many of the example
programs and documentation (Eric Blake, Nir Soffer).
.PP
Simplify and optimize handling of the extents callback in Golang (Nir
Soffer).
.PP
Golang AioBuffer was enhanced, making it safer to use, faster and
adding documentation (Nir Soffer).
.SS Documentation
.IX Subsection "Documentation"
Document the limits on lengths and sizes of parameters to various APIs
(Eric Blake).
.SS Build
.IX Subsection "Build"
You can now build programs that use the OCaml bindings of libnbd
against the libnbd build directory instead of requiring libnbd to be
installed (Laszlo Ersek).
.PP
Compatibility with OCaml 4.13.
.PP
Line locations in the state machine should be more accurate when
stepping through with a debugger like gdb.
.PP
\&\fI.editorconfig\fR file can be used to help code formatting, see
https://editorconfig.org/ (Nir Soffer, Eric Blake).
.PP
\&\f(CW\*(C`MIN\*(C'\fR and \f(CW\*(C`MAX\*(C'\fR macros can be nested (thanks Eric Blake).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBlibnbd\fR\|(3).
.SH AUTHORS
.IX Header "AUTHORS"
.IP "Eric Blake" 4
.IX Item "Eric Blake"
.PD 0
.IP "Laszlo Ersek" 4
.IX Item "Laszlo Ersek"
.IP "Martin Kletzander" 4
.IX Item "Martin Kletzander"
.IP "Nir Soffer" 4
.IX Item "Nir Soffer"
.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"
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
.PP
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.
.PP
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301 USA