qemu-e2k/util
Markus Armbruster 668f62ec62 error: Eliminate error_propagate() with Coccinelle, part 1
When all we do with an Error we receive into a local variable is
propagating to somewhere else, we can just as well receive it there
right away.  Convert

    if (!foo(..., &err)) {
        ...
        error_propagate(errp, err);
        ...
        return ...
    }

to

    if (!foo(..., errp)) {
        ...
        ...
        return ...
    }

where nothing else needs @err.  Coccinelle script:

    @rule1 forall@
    identifier fun, err, errp, lbl;
    expression list args, args2;
    binary operator op;
    constant c1, c2;
    symbol false;
    @@
         if (
    (
    -        fun(args, &err, args2)
    +        fun(args, errp, args2)
    |
    -        !fun(args, &err, args2)
    +        !fun(args, errp, args2)
    |
    -        fun(args, &err, args2) op c1
    +        fun(args, errp, args2) op c1
    )
            )
         {
             ... when != err
                 when != lbl:
                 when strict
    -        error_propagate(errp, err);
             ... when != err
    (
             return;
    |
             return c2;
    |
             return false;
    )
         }

    @rule2 forall@
    identifier fun, err, errp, lbl;
    expression list args, args2;
    expression var;
    binary operator op;
    constant c1, c2;
    symbol false;
    @@
    -    var = fun(args, &err, args2);
    +    var = fun(args, errp, args2);
         ... when != err
         if (
    (
             var
    |
             !var
    |
             var op c1
    )
            )
         {
             ... when != err
                 when != lbl:
                 when strict
    -        error_propagate(errp, err);
             ... when != err
    (
             return;
    |
             return c2;
    |
             return false;
    |
             return var;
    )
         }

    @depends on rule1 || rule2@
    identifier err;
    @@
    -    Error *err = NULL;
         ... when != err

Not exactly elegant, I'm afraid.

The "when != lbl:" is necessary to avoid transforming

         if (fun(args, &err)) {
             goto out
         }
         ...
     out:
         error_propagate(errp, err);

even though other paths to label out still need the error_propagate().
For an actual example, see sclp_realize().

Without the "when strict", Coccinelle transforms vfio_msix_setup(),
incorrectly.  I don't know what exactly "when strict" does, only that
it helps here.

The match of return is narrower than what I want, but I can't figure
out how to express "return where the operand doesn't use @err".  For
an example where it's too narrow, see vfio_intx_enable().

Silently fails to convert hw/arm/armsse.c, because Coccinelle gets
confused by ARMSSE being used both as typedef and function-like macro
there.  Converted manually.

Line breaks tidied up manually.  One nested declaration of @local_err
deleted manually.  Preexisting unwanted blank line dropped in
hw/riscv/sifive_e.c.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <20200707160613.848843-35-armbru@redhat.com>
2020-07-10 15:18:08 +02:00
..
aio-posix.c aio-posix: disable fdmon-io_uring when GSource is used 2020-05-18 18:16:00 +01:00
aio-posix.h aio-posix: remove idle poll handlers to improve scalability 2020-03-09 16:45:16 +00:00
aio-wait.c
aio-win32.c aio-posix: disable fdmon-io_uring when GSource is used 2020-05-18 18:16:00 +01:00
aiocb.c
async.c aio-posix: disable fdmon-io_uring when GSource is used 2020-05-18 18:16:00 +01:00
atomic64.c
base64.c
bitmap.c
bitops.c
buffer.c
bufferiszero.c util/bufferiszero: improve avx2 accelerator 2020-04-01 14:24:03 -04:00
cacheinfo.c util/cacheinfo: fix crash when compiling with uClibc 2020-01-21 14:18:12 -10:00
compatfd.c
coroutine-sigaltstack.c coroutine: add check for SafeStack in sigaltstack 2020-06-23 15:46:05 +01:00
coroutine-ucontext.c coroutine: support SafeStack in ucontext backend 2020-06-23 15:46:05 +01:00
coroutine-win32.c
crc32c.c
cutils.c
dbus.c
drm.c
envlist.c
error.c
event_notifier-posix.c
event_notifier-win32.c
fdmon-epoll.c aio-posix: support userspace polling of fd monitoring 2020-03-09 16:41:31 +00:00
fdmon-io_uring.c aio-posix: don't duplicate fd handler deletion in fdmon_io_uring_destroy() 2020-05-18 18:16:00 +01:00
fdmon-poll.c aio-posix: support userspace polling of fd monitoring 2020-03-09 16:41:31 +00:00
fifo8.c
filemonitor-inotify.c
filemonitor-stub.c
getauxval.c util/getauxval: Porting to FreeBSD getauxval feature 2020-06-26 06:45:29 -04:00
guest-random.c
hbitmap.c block/dirty-bitmap: improve _next_dirty_area API 2020-03-18 14:03:46 -04:00
hexdump.c
host-utils.c
id.c
iov.c
iova-tree.c
keyval.c
lockcnt.c
log.c lockable: replaced locks with lock guard macros where appropriate 2020-05-04 16:07:43 +01:00
main-loop.c error: Eliminate error_propagate() with Coccinelle, part 1 2020-07-10 15:18:08 +02:00
Makefile.objs util/Makefile: Reduce the user-mode object list 2020-06-05 21:23:22 +02:00
memfd.c
mmap-alloc.c
module.c chardev: enable modules, use for braille 2020-07-07 15:33:59 +02:00
notify.c
nvdimm-utils.c mem: move nvdimm_device_list to utilities 2020-02-21 09:15:03 +11:00
osdep.c util/osdep: Improve error report by calling error_setg_win32() 2020-03-09 13:36:15 +01:00
oslib-posix.c util/oslib-posix : qemu_init_exec_dir implementation for Mac 2020-06-23 11:39:46 +01:00
oslib-win32.c
pagesize.c
path.c
qdist.c
qemu-co-shared-resource.c
qemu-config.c error: Eliminate error_propagate() with Coccinelle, part 1 2020-07-10 15:18:08 +02:00
qemu-coroutine-io.c
qemu-coroutine-lock.c
qemu-coroutine-sleep.c
qemu-coroutine.c
qemu-error.c
qemu-openpty.c configure / util: Auto-detect the availability of openpty() 2020-07-06 07:37:02 +02:00
qemu-option.c error: Eliminate error_propagate() with Coccinelle, part 1 2020-07-10 15:18:08 +02:00
qemu-print.c
qemu-progress.c
qemu-sockets.c qemu-sockets: add abstract UNIX domain socket support 2020-05-20 10:34:40 +01:00
qemu-thread-common.h
qemu-thread-posix.c util: Added tsan annotate for thread name. 2020-06-16 14:49:05 +01:00
qemu-thread-win32.c
qemu-timer-common.c Remove support for CLOCK_MONOTONIC not being defined 2020-02-12 16:23:01 +01:00
qemu-timer.c replay: synchronize on every virtual timer callback 2020-06-26 06:45:30 -04:00
qht.c qht: call qemu_spin_destroy for head buckets 2020-06-16 14:49:05 +01:00
qsp.c
range.c
rcu.c lockable: replaced locks with lock guard macros where appropriate 2020-05-04 16:07:43 +01:00
readline.c
selfmap.c linux-user: factor out reading of /proc/self/maps 2020-04-07 16:19:49 +01:00
stats64.c
sys_membarrier.c
systemd.c tools: Fix use of fcntl(F_SETFD) during socket activation 2020-05-04 14:54:35 -05:00
thread-pool.c lockable: replaced locks with lock guard macros where appropriate 2020-05-04 16:07:43 +01:00
throttle.c
timed-average.c
trace-events aio-posix: remove idle poll handlers to improve scalability 2020-03-09 16:45:16 +00:00
unicode.c
uri.c
uuid.c
vfio-helpers.c lockable: replaced locks with lock guard macros where appropriate 2020-05-04 16:07:43 +01:00