.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Podwrapper::Man 1.20.0 (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 "nbd_pread 3"
.TH nbd_pread 3 2024-05-31 libnbd-1.20.0 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
nbd_pread \- read from the NBD server
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& #include <libnbd.h>
\&
\& int nbd_pread (
\&       struct nbd_handle *h, void *buf, size_t count,
\&       uint64_t offset, uint32_t flags
\&     );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Issue a read command to the NBD server for the range starting
at \f(CW\*(C`offset\*(C'\fR and ending at \f(CW\*(C`offset\*(C'\fR + \f(CW\*(C`count\*(C'\fR \- 1.  NBD
can only read all or nothing using this call.  The call
returns when the data has been read fully into \f(CW\*(C`buf\*(C'\fR or there is an
error.  See also \fBnbd_pread_structured\fR\|(3), if finer visibility is
required into the server's replies, or if you want to use
\&\f(CW\*(C`LIBNBD_CMD_FLAG_DF\*(C'\fR.
.PP
Note that libnbd currently enforces a maximum read buffer of 64MiB,
even if the server would permit a larger buffer in a single transaction;
attempts to exceed this will result in an \f(CW\*(C`ERANGE\*(C'\fR error.  The server
may enforce a smaller limit, which can be learned with
\&\fBnbd_get_block_size\fR\|(3).
.PP
The \f(CW\*(C`flags\*(C'\fR parameter must be \f(CW0\fR for now (it exists for future NBD
protocol extensions).
.PP
Note that if this command fails, and \fBnbd_get_pread_initialize\fR\|(3)
returns true, then libnbd sanitized \f(CW\*(C`buf\*(C'\fR, but it is unspecified
whether the contents of \f(CW\*(C`buf\*(C'\fR will read as zero or as partial results
from the server.  If \fBnbd_get_pread_initialize\fR\|(3) returns false,
then libnbd did not sanitize \f(CW\*(C`buf\*(C'\fR, and the contents are undefined
on failure.
.PP
By default, libnbd will reject attempts to use this function with
parameters that are likely to result in server failure, such as
requesting an unknown command flag.  The \fBnbd_set_strict_mode\fR\|(3)
function can be used to alter which scenarios should await a server
reply rather than failing fast.
.SH "RETURN VALUE"
.IX Header "RETURN VALUE"
If the call is successful the function returns \f(CW0\fR.
.SH ERRORS
.IX Header "ERRORS"
On error \f(CW\-1\fR is returned.
.PP
Refer to "ERROR HANDLING" in \fBlibnbd\fR\|(3)
for how to get further details of the error.
.PP
The following parameters must not be NULL: \f(CW\*(C`h\*(C'\fR, \f(CW\*(C`buf\*(C'\fR.
For more information see "Non-NULL parameters" in \fBlibnbd\fR\|(3).
.SH "HANDLE STATE"
.IX Header "HANDLE STATE"
nbd_pread
can be called when the handle is in the following state:
.PP
.Vb 8
\& ┌─────────────────────────────────────┬─────────────────────────┐
\& │ Handle created, before connecting   │ ❌ error                │
\& │ Connecting                          │ ❌ error                │
\& │ Connecting & handshaking (opt_mode) │ ❌ error                │
\& │ Connected to the server             │ ✅ allowed              │
\& │ Connection shut down                │ ❌ error                │
\& │ Handle dead                         │ ❌ error                │
\& └─────────────────────────────────────┴─────────────────────────┘
.Ve
.SH VERSION
.IX Header "VERSION"
This function first appeared in libnbd 1.0.
.PP
If you need to test if this function is available at compile time
check if the following macro is defined:
.PP
.Vb 1
\& #define LIBNBD_HAVE_NBD_PREAD 1
.Ve
.SH EXAMPLE
.IX Header "EXAMPLE"
This example is also available as \fIexamples/fetch\-first\-sector.c\fR
in the libnbd source code.
.PP
.Vb 10
\& /* This example shows how to connect to an NBD server
\&  * and fetch and print the first sector (usually the
\&  * boot sector or partition table or filesystem
\&  * superblock).
\&  *
\&  * You can test it with nbdkit like this:
\&  *
\&  * nbdkit \-U \- floppy . \e
\&  *   \-\-run \*(Aq./fetch\-first\-sector $unixsocket\*(Aq
\&  *
\&  * The nbdkit floppy plugin creates an MBR disk so the
\&  * first sector is the partition table.
\&  */
\&
\& #include <stdio.h>
\& #include <stdlib.h>
\&
\& #include <libnbd.h>
\&
\& int
\& main (int argc, char *argv[])
\& {
\&   struct nbd_handle *nbd;
\&   char buf[512];
\&   FILE *pp;
\&
\&   if (argc != 2) {
\&     fprintf (stderr, "%s socket\en", argv[0]);
\&     exit (EXIT_FAILURE);
\&   }
\&
\&   /* Create the libnbd handle. */
\&   nbd = nbd_create ();
\&   if (nbd == NULL) {
\&     fprintf (stderr, "%s\en", nbd_get_error ());
\&     exit (EXIT_FAILURE);
\&   }
\&
\&   /* Connect to the NBD server over a
\&    * Unix domain socket.
\&    */
\&   if (nbd_connect_unix (nbd, argv[1]) == \-1) {
\&     fprintf (stderr, "%s\en", nbd_get_error ());
\&     exit (EXIT_FAILURE);
\&   }
\&
\&   /* Read the first sector synchronously. */
\&   if (nbd_pread (nbd, buf, sizeof buf, 0, 0) == \-1) {
\&     fprintf (stderr, "%s\en", nbd_get_error ());
\&     exit (EXIT_FAILURE);
\&   }
\&
\&   /* Close the libnbd handle. */
\&   nbd_close (nbd);
\&
\&   /* Print the first sector. */
\&   pp = popen ("hexdump \-C", "w");
\&   if (pp == NULL) {
\&     perror ("popen: hexdump");
\&     exit (EXIT_FAILURE);
\&   }
\&   fwrite (buf, sizeof buf, 1, pp);
\&   pclose (pp);
\&
\&   exit (EXIT_SUCCESS);
\& }
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBnbd_aio_pread\fR\|(3),
\&\fBnbd_create\fR\|(3),
\&\fBnbd_get_block_size\fR\|(3),
\&\fBnbd_get_pread_initialize\fR\|(3),
\&\fBnbd_pread_structured\fR\|(3),
\&\fBnbd_set_pread_initialize\fR\|(3),
\&\fBnbd_set_strict_mode\fR\|(3),
\&\fBlibnbd\fR\|(3).
.SH AUTHORS
.IX Header "AUTHORS"
Eric Blake
.PP
Richard W.M. Jones
.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