nbd: Use ERRP_GUARD()

If we want to check error after errp-function call, we need to
introduce local_err and then propagate it to errp. Instead, use
the ERRP_GUARD() macro, benefits are:
1. No need of explicit error_propagate call
2. No need of explicit local_err variable: use errp directly
3. ERRP_GUARD() leaves errp as is if it's not NULL or
   &error_fatal, this means that we don't break error_abort
   (we'll abort on error_set, not on error_propagate)

If we want to add some info to errp (by error_prepend() or
error_append_hint()), we must use the ERRP_GUARD() macro.
Otherwise, this info will not be added when errp == &error_fatal
(the program will exit prior to the error_append_hint() or
error_prepend() call).  Fix several such cases, e.g. in nbd_read().

This commit is generated by command

    sed -n '/^Network Block Device (NBD)$/,/^$/{s/^F: //p}' \
        MAINTAINERS | \
    xargs git ls-files | grep '\.[hc]$' | \
    xargs spatch \
        --sp-file scripts/coccinelle/errp-guard.cocci \
        --macro-file scripts/cocci-macro-file.h \
        --in-place --no-show-diff --max-width 80

Reported-by: Kevin Wolf <kwolf@redhat.com>
Reported-by: Greg Kurz <groug@kaod.org>
Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Commit message tweaked]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200707165037.1026246-8-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
[ERRP_AUTO_PROPAGATE() renamed to ERRP_GUARD(), and
auto-propagated-errp.cocci to errp-guard.cocci.  Commit message
tweaked again.]
This commit is contained in:
Vladimir Sementsov-Ogievskiy 2020-07-07 18:50:36 +02:00 committed by Markus Armbruster
parent 92c451222c
commit 795d946d07
4 changed files with 14 additions and 4 deletions

View File

@ -1408,16 +1408,15 @@ static void nbd_client_close(BlockDriverState *bs)
static QIOChannelSocket *nbd_establish_connection(SocketAddress *saddr, static QIOChannelSocket *nbd_establish_connection(SocketAddress *saddr,
Error **errp) Error **errp)
{ {
ERRP_GUARD();
QIOChannelSocket *sioc; QIOChannelSocket *sioc;
Error *local_err = NULL;
sioc = qio_channel_socket_new(); sioc = qio_channel_socket_new();
qio_channel_set_name(QIO_CHANNEL(sioc), "nbd-client"); qio_channel_set_name(QIO_CHANNEL(sioc), "nbd-client");
qio_channel_socket_connect_sync(sioc, saddr, &local_err); qio_channel_socket_connect_sync(sioc, saddr, errp);
if (local_err) { if (*errp) {
object_unref(OBJECT(sioc)); object_unref(OBJECT(sioc));
error_propagate(errp, local_err);
return NULL; return NULL;
} }

View File

@ -361,6 +361,7 @@ void nbd_server_start_options(NbdServerOptions *arg, Error **errp);
static inline int nbd_read(QIOChannel *ioc, void *buffer, size_t size, static inline int nbd_read(QIOChannel *ioc, void *buffer, size_t size,
const char *desc, Error **errp) const char *desc, Error **errp)
{ {
ERRP_GUARD();
int ret = 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 (ret < 0) {

View File

@ -68,6 +68,7 @@ static int nbd_send_option_request(QIOChannel *ioc, uint32_t opt,
uint32_t len, const char *data, uint32_t len, const char *data,
Error **errp) Error **errp)
{ {
ERRP_GUARD();
NBDOption req; NBDOption req;
QEMU_BUILD_BUG_ON(sizeof(req) != 16); QEMU_BUILD_BUG_ON(sizeof(req) != 16);
@ -153,6 +154,7 @@ static int nbd_receive_option_reply(QIOChannel *ioc, uint32_t opt,
static int nbd_handle_reply_err(QIOChannel *ioc, NBDOptionReply *reply, static int nbd_handle_reply_err(QIOChannel *ioc, NBDOptionReply *reply,
bool strict, Error **errp) bool strict, Error **errp)
{ {
ERRP_GUARD();
g_autofree char *msg = NULL; g_autofree char *msg = NULL;
if (!(reply->type & (1 << 31))) { if (!(reply->type & (1 << 31))) {
@ -337,6 +339,7 @@ static int nbd_receive_list(QIOChannel *ioc, char **name, char **description,
static int nbd_opt_info_or_go(QIOChannel *ioc, uint32_t opt, static int nbd_opt_info_or_go(QIOChannel *ioc, uint32_t opt,
NBDExportInfo *info, Error **errp) NBDExportInfo *info, Error **errp)
{ {
ERRP_GUARD();
NBDOptionReply reply; NBDOptionReply reply;
uint32_t len = strlen(info->name); uint32_t len = strlen(info->name);
uint16_t type; uint16_t type;
@ -882,6 +885,7 @@ static int nbd_start_negotiate(AioContext *aio_context, QIOChannel *ioc,
bool structured_reply, bool *zeroes, bool structured_reply, bool *zeroes,
Error **errp) Error **errp)
{ {
ERRP_GUARD();
uint64_t magic; uint64_t magic;
trace_nbd_start_negotiate(tlscreds, hostname ? hostname : "<null>"); trace_nbd_start_negotiate(tlscreds, hostname ? hostname : "<null>");
@ -1017,6 +1021,7 @@ int nbd_receive_negotiate(AioContext *aio_context, QIOChannel *ioc,
const char *hostname, QIOChannel **outioc, const char *hostname, QIOChannel **outioc,
NBDExportInfo *info, Error **errp) NBDExportInfo *info, Error **errp)
{ {
ERRP_GUARD();
int result; int result;
bool zeroes; bool zeroes;
bool base_allocation = info->base_allocation; bool base_allocation = info->base_allocation;

View File

@ -211,6 +211,7 @@ static int GCC_FMT_ATTR(4, 0)
nbd_negotiate_send_rep_verr(NBDClient *client, uint32_t type, nbd_negotiate_send_rep_verr(NBDClient *client, uint32_t type,
Error **errp, const char *fmt, va_list va) Error **errp, const char *fmt, va_list va)
{ {
ERRP_GUARD();
g_autofree char *msg = NULL; g_autofree char *msg = NULL;
int ret; int ret;
size_t len; size_t len;
@ -382,6 +383,7 @@ static int nbd_opt_read_name(NBDClient *client, char **name, uint32_t *length,
static int nbd_negotiate_send_rep_list(NBDClient *client, NBDExport *exp, static int nbd_negotiate_send_rep_list(NBDClient *client, NBDExport *exp,
Error **errp) Error **errp)
{ {
ERRP_GUARD();
size_t name_len, desc_len; size_t name_len, desc_len;
uint32_t len; uint32_t len;
const char *name = exp->name ? exp->name : ""; const char *name = exp->name ? exp->name : "";
@ -445,6 +447,7 @@ static void nbd_check_meta_export(NBDClient *client)
static int nbd_negotiate_handle_export_name(NBDClient *client, bool no_zeroes, static int nbd_negotiate_handle_export_name(NBDClient *client, bool no_zeroes,
Error **errp) Error **errp)
{ {
ERRP_GUARD();
g_autofree char *name = NULL; g_autofree char *name = NULL;
char buf[NBD_REPLY_EXPORT_NAME_SIZE] = ""; char buf[NBD_REPLY_EXPORT_NAME_SIZE] = "";
size_t len; size_t len;
@ -1289,6 +1292,7 @@ static int nbd_negotiate_options(NBDClient *client, Error **errp)
*/ */
static coroutine_fn int nbd_negotiate(NBDClient *client, Error **errp) static coroutine_fn int nbd_negotiate(NBDClient *client, Error **errp)
{ {
ERRP_GUARD();
char buf[NBD_OLDSTYLE_NEGOTIATE_SIZE] = ""; char buf[NBD_OLDSTYLE_NEGOTIATE_SIZE] = "";
int ret; int ret;
@ -1663,6 +1667,7 @@ void nbd_export_close(NBDExport *exp)
void nbd_export_remove(NBDExport *exp, NbdServerRemoveMode mode, Error **errp) void nbd_export_remove(NBDExport *exp, NbdServerRemoveMode mode, Error **errp)
{ {
ERRP_GUARD();
if (mode == NBD_SERVER_REMOVE_MODE_HARD || QTAILQ_EMPTY(&exp->clients)) { if (mode == NBD_SERVER_REMOVE_MODE_HARD || QTAILQ_EMPTY(&exp->clients)) {
nbd_export_close(exp); nbd_export_close(exp);
return; return;