nbd: generalize usage of nbd_read
PATCH 1/1 nbd: generalize usage of nbd_read
We generally do very similar things around nbd_read: error_prepend, specifying, what we have tried to read and be_to_cpu conversion of integers.
So, it seems reasonable to move common things to helper functions, which:
1. simplify code a bit
2. generalize nbd_read error descriptions, all starting with "Failed to read"
3. make it more difficult to forget to convert things from BE
--- include/block/nbd.h | 31 ++++++++++++++-- block/nbd-client.c | 5 ++- nbd/client.c | 88 +++++++++++++++------------------------------ nbd/common.c | 2 +- nbd/server.c | 27 +++++--------- 5 files changed, 70 insertions(+), 83 deletions(-)
include/block/nbd.h +29 -2
@@ -23,6 +23,7 @@#include "qapi/qapi-types-block.h" #include "io/channel-socket.h" #include "crypto/tlscreds.h" +#include "qapi/error.h" /* Handshake phase structs - this struct is passed on the wire */
@@ -336,11 +337,37 @@ void nbd_server_start(SocketAddress *addr, const char *tls_creds,* Reads @size bytes from @ioc. Returns 0 on success. */ static inline int nbd_read (QIOChannel *ioc,void *buffer,size_t size, -Error **errp) +const char *desc,Error **errp) { -return qio_channel_read_all (ioc, buffer, size, errp) <0 ? -EIO :0 ; +int ret =qio_channel_read_all (ioc, buffer, size, errp) <0 ? -EIO :0 ; + +if (ret <0 ) { +if (desc) { +error_prepend (errp,"Failed to read %s: " , desc); + } +return -1 ; + } + +return 0 ; +} + +#define DEF_NBD_READ (bits) \ +static inline int nbd_read ## bits(QIOChannel *ioc, uint ## bits ## _t * val, \ + const char *desc, Error **errp) \ +{ \ + if (nbd_read(ioc, val, sizeof(*val), desc, errp) < 0) { \ + return -1; \ + } \ + *val = be ## bits ## _to_cpu(*val); \ + return 0; \ } +DEF_NBD_READ(16) /* Defines nbd_read16(). */ +DEF_NBD_READ(32) /* Defines nbd_read32(). */ +DEF_NBD_READ(64) /* Defines nbd_read64(). */ + +#undef DEF_NBD_READ +static inline bool nbd_reply_is_simple (NBDReply *reply) {return reply->magic ==NBD_SIMPLE_REPLY_MAGIC ;
block/nbd-client.c +2 -3
@@ -337,10 +337,9 @@ static int nbd_co_receive_offset_data_payload(NBDClientSession *s,return -EINVAL ; } -if (nbd_read (s->ioc, &offset,sizeof (offset), errp) <0 ) { +if (nbd_read64 (s->ioc, &offset,"OFFSET_DATA offset" , errp) <0 ) {return -EIO ; } -be64_to_cpus (&offset); data_size = chunk->length -sizeof (offset);assert (data_size);
@@ -387,7 +386,7 @@ static coroutine_fn int nbd_co_receive_structured_payload( } *payload =g_new (char, len); - ret =nbd_read (s->ioc, *payload, len, errp); + ret =nbd_read (s->ioc, *payload, len,"structured payload" , errp);if (ret <0 ) {g_free (*payload); *payload =NULL ;
nbd/client.c +29 -59
239 lines not on this page · raw message
nbd/common.c +1 -1
@@ -31,7 +31,7 @@ int nbd_drop(QIOChannel *ioc, size_t size, Error **errp) buffer =sizeof (small) >= size ? small :g_malloc (MIN (65536 , size));while (size >0 ) {ssize_t count =MIN (65536 , size); - ret =nbd_read (ioc, buffer,MIN (65536 , size), errp); + ret =nbd_read (ioc, buffer,MIN (65536 , size),NULL , errp);if (ret <0 ) { goto cleanup;
nbd/server.c +9 -18
@@ -438,8 +438,7 @@ static int nbd_negotiate_handle_export_name(NBDClient *client,error_setg (errp,"Bad length received" );return -EINVAL ; } -if (nbd_read (client->ioc, name, client->optlen, errp) <0 ) { -error_prepend (errp,"read failed: " ); +if (nbd_read (client->ioc, name, client->optlen,"export name" , errp) <0 ) {return -EIO ; } name[client->optlen] ='\0' ;
@@ -1046,11 +1045,9 @@ static int nbd_negotiate_options(NBDClient *client, uint16_t myflags,... Rest of request */ -if (nbd_read (client->ioc, &flags,sizeof (flags), errp) <0 ) { -error_prepend (errp,"read failed: " ); +if (nbd_read32 (client->ioc, &flags,"flags" , errp) <0 ) {return -EIO ; } - flags =be32_to_cpu (flags);trace_nbd_negotiate_options_flags (flags);if (flags &NBD_FLAG_C_FIXED_NEWSTYLE ) { fixedNewstyle = true;
@@ -1070,30 +1067,23 @@ static int nbd_negotiate_options(NBDClient *client, uint16_t myflags,uint32_t option, length;uint64_t magic; -if (nbd_read (client->ioc, &magic,sizeof (magic), errp) <0 ) { -error_prepend (errp,"read failed: " ); +if (nbd_read64 (client->ioc, &magic,"opts magic" , errp) <0 ) {return -EINVAL ; } - magic =be64_to_cpu (magic);trace_nbd_negotiate_options_check_magic (magic);if (magic !=NBD_OPTS_MAGIC ) {error_setg (errp,"Bad magic received" );return -EINVAL ; } -if (nbd_read (client->ioc, &option, -sizeof (option), errp) <0 ) { -error_prepend (errp,"read failed: " ); +if (nbd_read32 (client->ioc, &option,"option" , errp) <0 ) {return -EINVAL ; } - option =be32_to_cpu (option); client->opt = option; -if (nbd_read (client->ioc, &length,sizeof (length), errp) <0 ) { -error_prepend (errp,"read failed: " ); +if (nbd_read32 (client->ioc, &length,"option length" , errp) <0 ) {return -EINVAL ; } - length =be32_to_cpu (length);assert (!client->optlen); client->optlen = length;
@@ -1306,7 +1296,7 @@ static int nbd_receive_request(QIOChannel *ioc, NBDRequest *request,uint32_t magic;int ret; - ret =nbd_read (ioc, buf,sizeof (buf), errp); + ret =nbd_read (ioc, buf,sizeof (buf),"request" , errp);if (ret <0 ) {return ret; }
@@ -2111,8 +2101,9 @@ static int nbd_co_receive_request(NBDRequestData *req, NBDRequest *request, } }if (request->type ==NBD_CMD_WRITE ) { -if (nbd_read (client->ioc, req->data, request->len, errp) <0 ) { -error_prepend (errp,"reading from socket failed: " ); +if (nbd_read (client->ioc, req->data, request->len,"CMD_WRITE data" , + errp) <0 ) + {return -EIO ; } req->complete = true;
Signature · 1 line
2.18.0
Quoted 21 lines · Vladimir Sementsov-Ogievskiy
We generally do very similar things around
nbd_read:error_prepend, specifying, what we have tried to read andbe_to_cpuconversion of integers.So, it seems reasonable to move common things to helper functions, which:
1. simplify code a bit
2. generalizenbd_readerror descriptions, all starting with "Failed to read"
3. make it more difficult to forget to convert things from BESigned-off-by Vladimir Sementsov-Ogievskiy <[email protected]>--- include/block/nbd.h | 31 ++++++++++++++-- block/nbd-client.c | 5 ++- nbd/client.c | 88 +++++++++++++++------------------------------ nbd/common.c | 2 +- nbd/server.c | 27 +++++--------- 5 files changed, 70 insertions(+), 83 deletions(-)
include/block/nbd.h void nbd_server_start(SocketAddress *addr, const char *tls_creds, · line 355
Quoted 3 lines
include/block/nbd.h +3
-0+ +#define DEF_NBD_READ (bits) \ +static inline int nbd_read ## bits(QIOChannel *ioc, uint ## bits ## _t * val, \
checkpatch didn't flag it, but I think our style is '*val', not '* val'.
Quoted 4 lines
include/block/nbd.h +4
-0+ const char *desc, Error **errp) \ +{ \ + if (nbd_read(ioc, val, sizeof(*val), desc, errp) < 0) { \ +return -1 ; \
include/block/nbd.h void nbd_server_start(SocketAddress *addr, const char *tls_creds, · line 369
Quoted 10 lines
include/block/nbd.h +8
-0+ } \ + *val = be ## bits ## _to_cpu(*val); \ + return 0; \ } +DEF_NBD_READ(16) /* Defines nbd_read16(). */ +DEF_NBD_READ(32) /* Defines nbd_read32(). */ +DEF_NBD_READ(64) /* Defines nbd_read64(). */ + +#undef DEF_NBD_READ
I think the name DEF_NBD_READ_N is slightly nicer; that's minor enough that I don't mind tweaking it.
Thanks; queued for my next NBD pull request.
Signature · 3 lines
Eric Blake, Principal Software Engineer Red Hat, Inc. +1-919-301-3226 Virtualization: qemu.org | libvirt.org
Quoted 7 lines · Eric Blake
include/block/nbd.h void nbd_server_start(SocketAddress *addr, const char *tls_creds, · line 355
Quoted 5 lines
include/block/nbd.h +3
-0+ +#define DEF_NBD_READ (bits) \ +static inline int nbd_read ## bits(QIOChannel *ioc, uint ## bits ## _t * val, \checkpatch didn't flag it, but I think our style is '*val', not '* val'.
But it DOES flag '*val' as a false positive. Oh well.
Signature · 3 lines
Eric Blake, Principal Software Engineer Red Hat, Inc. +1-919-301-3226 Virtualization: qemu.org | libvirt.org
Patchew URL: https://patchew.org/QEMU/[email protected]/
Patchew URL: https://patchew.org/QEMU/[email protected]/
Hi,
This series failed the docker-mingw@fedora build test. Please find the testing commands and their output below. If you have Docker installed, you can probably reproduce it locally.
=== TEST SCRIPT BEGIN ===
#!/bin/bash
time make docker-test-mingw@fedora SHOW_ENV=1 J=14 === TEST SCRIPT END ===
Configure options:
--enable-werror --target-list=x86_64-softmmu,aarch64-softmmu --prefix=/tmp/qemu-test/install --python=/usr/bin/python3 --cross-prefix=x86_64-w64-mingw32- --enable-trace-backends=simple --enable-gnutls --enable-nettle --enable-curl --enable-vnc --enable-bzip2 --enable-guest-agent --with-sdlabi=2.0
ERROR: unknown option --with-sdlabi=2.0
Try '/tmp/qemu-test/src/configure --help' for more information
# QEMU configure log Sun Feb 3 16:01:28 UTC 2019
# Configured with: '/tmp/qemu-test/src/configure' '--enable-werror' '--target-list=x86_64-softmmu,aarch64-softmmu' '--prefix=/tmp/qemu-test/install' '--python=/usr/bin/python3' '--cross-prefix=x86_64-w64-mingw32-' '--enable-trace-backends=simple' '--enable-gnutls' '--enable-nettle' '--enable-curl' '--enable-vnc' '--enable-bzip2' '--enable-guest-agent' '--with-sdlabi=2.0'
---
funcs: do_compiler do_cc compile_object check_define main
lines: 92 122 617 634 0
x86_64-w64-mingw32-gcc -D_GNU_SOURCE -D_FILE_OFFSET_BITS=64 -D_LARGEFILE_SOURCE -Wstrict-prototypes -Wredundant-decls -Wall -Wundef -Wwrite-strings -Wmissing-prototypes -fno-strict-aliasing -fno-common -fwrapv -std=gnu99 -c -o config-temp/qemu-conf.o config-temp/qemu-conf.cconfig-temp/qemu-conf.c:2:2: error: #error __linux__ not defined
#error __linux__ not defined
^~~~~
---
funcs: do_compiler do_cc compile_object check_define main
lines: 92 122 617 686 0
x86_64-w64-mingw32-gcc -D_GNU_SOURCE -D_FILE_OFFSET_BITS=64 -D_LARGEFILE_SOURCE -Wstrict-prototypes -Wredundant-decls -Wall -Wundef -Wwrite-strings -Wmissing-prototypes -fno-strict-aliasing -fno-common -fwrapv -std=gnu99 -c -o config-temp/qemu-conf.o config-temp/qemu-conf.c config-temp/qemu-conf.c:2:2: error: #error __i386__ not defined
#error __i386__ not defined
^~~~~
---
funcs: do_compiler do_cc compile_object check_define main
lines: 92 122 617 689 0
x86_64-w64-mingw32-gcc -D_GNU_SOURCE -D_FILE_OFFSET_BITS=64 -D_LARGEFILE_SOURCE -Wstrict-prototypes -Wredundant-decls -Wall -Wundef -Wwrite-strings -Wmissing-prototypes -fno-strict-aliasing -fno-common -fwrapv -std=gnu99 -c -o config-temp/qemu-conf.o config-temp/qemu-conf.c config-temp/qemu-conf.c:2:2: error: #error __ILP32__ not defined
#error __ILP32__ not defined
^~~~~
---
lines: 92 128 920 0
x86_64-w64-mingw32-gcc -mthreads -D_GNU_SOURCE -D_FILE_OFFSET_BITS=64 -D_LARGEFILE_SOURCE -Wstrict-prototypes -Wredundant-decls -Wall -Wundef -Wwrite-strings -Wmissing-prototypes -fno-strict-aliasing -fno-common -fwrapv -std=gnu99 -o config-temp/qemu-conf.exe config-temp/qemu-conf.c -g -liberty /usr/lib/gcc/x86_64-w64-mingw32/8.2.0/../../../../x86_64-w64-mingw32/bin/ld: cannot find -liberty
collect2: error: ld returned 1 exit status
Failed to run 'configure'
Traceback (most recent call last):
File "./tests/docker/docker.py", line 563, in <module>
The full log is available at
http://patchew.org/logs/[email protected]/testing.docker-mingw@fedora/?type=message.
---
Email generated automatically by Patchew [http://patchew.org/].
Please send your feedback to [email protected]