From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:44702) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dipfo-0004yM-Cy for qemu-devel@nongnu.org; Fri, 18 Aug 2017 18:23:25 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dipfl-0005QO-6t for qemu-devel@nongnu.org; Fri, 18 Aug 2017 18:23:24 -0400 Received: from mx1.redhat.com ([209.132.183.28]:36596) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1dipfk-0005NM-UD for qemu-devel@nongnu.org; Fri, 18 Aug 2017 18:23:21 -0400 From: Eric Blake Date: Fri, 18 Aug 2017 17:23:13 -0500 Message-Id: <20170818222313.13391-1-eblake@redhat.com> Subject: [Qemu-devel] [RFC PATCH] osdep.h: Prohibit disabling assert() in supported builds List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu-devel@nongnu.org Cc: armbru@redhat.com, f4bug@amsat.org, Paolo Bonzini , "Michael S. Tsirkin" We already have several files that knowingly require assert() to work. While we do NOT want to encourage the use of 'assert(side-effects)' (that is a bad practice that prevents copy-and-paste of code to other projects that CAN disable assertions; plus it costs unnecessary reviewer mental cycles to remember our project policy on crippling asserts), we DO want to send a message that anyone that disables assertions has to tweak code in order to compile, making it obvious that we are not going to support their efforts. Signed-off-by: Eric Blake --- First mentioned as an idea here: http://lists.nongnu.org/archive/html/qemu-devel/2017-07/msg06084.html but I'm titling this RFC as I'm not 100% convinced we want to make it a project-wide, rather than a per-file decision. include/qemu/osdep.h | 12 ++++++++++++ hw/scsi/mptsas.c | 4 ---- hw/virtio/virtio.c | 4 ---- 3 files changed, 12 insertions(+), 8 deletions(-) diff --git a/include/qemu/osdep.h b/include/qemu/osdep.h index 6855b94bbf..9e745a8af9 100644 --- a/include/qemu/osdep.h +++ b/include/qemu/osdep.h @@ -107,6 +107,18 @@ extern int daemon(int, int); #include "glib-compat.h" #include "qemu/typedefs.h" +/* + * We have a lot of unaudited code that will fail in strange ways if + * you disable assertions at compile-time. You are on your own if + * you cripple these safety-checks. + */ +#ifdef NDEBUG +#error building with NDEBUG is not supported +#endif +#ifdef G_DISABLE_ASSERT +#error building with G_DISABLE_ASSERT is not supported +#endif + #ifndef O_LARGEFILE #define O_LARGEFILE 0 #endif diff --git a/hw/scsi/mptsas.c b/hw/scsi/mptsas.c index 765ab53c34..3b93f12cdb 100644 --- a/hw/scsi/mptsas.c +++ b/hw/scsi/mptsas.c @@ -1236,11 +1236,7 @@ static void *mptsas_load_request(QEMUFile *f, SCSIRequest *sreq) n = qemu_get_be32(f); /* TODO: add a way for SCSIBusInfo's load_request to fail, * and fail migration instead of asserting here. - * When we do, we might be able to re-enable NDEBUG below. */ -#ifdef NDEBUG -#error building with NDEBUG is not supported -#endif assert(n >= 0); pci_dma_sglist_init(&req->qsg, pci, n); diff --git a/hw/virtio/virtio.c b/hw/virtio/virtio.c index 464947f76d..2778adabcc 100644 --- a/hw/virtio/virtio.c +++ b/hw/virtio/virtio.c @@ -1025,11 +1025,7 @@ void *qemu_get_virtqueue_element(VirtIODevice *vdev, QEMUFile *f, size_t sz) /* TODO: teach all callers that this can fail, and return failure instead * of asserting here. - * When we do, we might be able to re-enable NDEBUG below. */ -#ifdef NDEBUG -#error building with NDEBUG is not supported -#endif assert(ARRAY_SIZE(data.in_addr) >= data.in_num); assert(ARRAY_SIZE(data.out_addr) >= data.out_num); -- 2.13.5