]> git.proxmox.com Git - mirror_qemu.git/commit - migration/rdma.c
maint: Fix macros with broken 'do/while(0); ' usage
authorEric Blake <eblake@redhat.com>
Fri, 1 Dec 2017 23:24:32 +0000 (17:24 -0600)
committerPaolo Bonzini <pbonzini@redhat.com>
Tue, 16 Jan 2018 13:54:52 +0000 (14:54 +0100)
commit2562755ee78983930d0662fa4d3bc5e2ac166350
tree0dd521d04be12d99cabc73ca928c862eabc0c348
parent241187c11818e5223c4bdfac79f28fdf63731733
maint: Fix macros with broken 'do/while(0); ' usage

The point of writing a macro embedded in a 'do { ... } while (0)'
loop (particularly if the macro has multiple statements or would
otherwise end with an 'if' statement) is so that the macro can be
used as a drop-in statement with the caller supplying the
trailing ';'.  Although our coding style frowns on brace-less 'if':
  if (cond)
    statement;
  else
    something else;
that is the classic case where failure to use do/while(0) wrapping
would cause the 'else' to pair with any embedded 'if' in the macro
rather than the intended outer 'if'.  But conversely, if the macro
includes an embedded ';', then the same brace-less coding style
would now have two statements, making the 'else' a syntax error
rather than pairing with the outer 'if'.  Thus, even though our
coding style with required braces is not impacted, ending a macro
with ';' makes our code harder to port to projects that use
brace-less styles.

The change should have no semantic impact.  I was not able to
fully compile-test all of the changes (as some of them are
examples of the ugly bit-rotting debug print statements that are
completely elided by default, and I didn't want to recompile
with the necessary -D witnesses - cleaning those up is left as a
bite-sized task for another day); I did, however, audit that for
all files touched, all callers of the changed macros DID supply
a trailing ';' at the callsite, and did not appear to be used
as part of a brace-less conditional.

Found mechanically via: $ git grep -B1 'while (0);' | grep -A1 \\\\

Signed-off-by: Eric Blake <eblake@redhat.com>
Acked-by: Cornelia Huck <cohuck@redhat.com>
Reviewed-by: Michael S. Tsirkin <mst@redhat.com>
Acked-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
Message-Id: <20171201232433.25193-7-eblake@redhat.com>
Reviewed-by: Juan Quintela <quintela@redhat.com>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
34 files changed:
audio/paaudio.c
hw/adc/stm32f2xx_adc.c
hw/block/m25p80.c
hw/char/cadence_uart.c
hw/char/stm32f2xx_usart.c
hw/display/cg3.c
hw/display/dpcd.c
hw/display/xlnx_dp.c
hw/dma/pl330.c
hw/dma/xlnx-zynq-devcfg.c
hw/dma/xlnx_dpdma.c
hw/i2c/i2c-ddc.c
hw/misc/auxbus.c
hw/misc/macio/mac_dbdma.c
hw/misc/mmio_interface.c
hw/misc/stm32f2xx_syscfg.c
hw/misc/zynq_slcr.c
hw/net/cadence_gem.c
hw/ssi/mss-spi.c
hw/ssi/stm32f2xx_spi.c
hw/ssi/xilinx_spi.c
hw/ssi/xilinx_spips.c
hw/timer/a9gtimer.c
hw/timer/cadence_ttc.c
hw/timer/mss-timer.c
hw/timer/stm32f2xx_timer.c
hw/tpm/tpm_passthrough.c
hw/tpm/tpm_tis.c
migration/rdma.c
target/arm/translate-a64.c
target/s390x/kvm.c
tests/acpi-utils.h
tests/tcg/test-mmap.c
ui/sdl_zoom_template.h