From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 480AAC54EBD for ; Thu, 12 Jan 2023 15:49:49 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pFyrZ-0003hl-Un; Thu, 12 Jan 2023 09:47:29 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pFyrY-0003h6-U1 for qemu-devel@nongnu.org; Thu, 12 Jan 2023 09:47:28 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pFyrW-0004wC-EK for qemu-devel@nongnu.org; Thu, 12 Jan 2023 09:47:28 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1673534845; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=W/fVAbhTSCKn36CoCFZfOgn98LrHMlA4vtdqO0hTv4M=; b=f4OQWgYm7KTCRcpalFXAU5+uYUaeU09jwLyZgCFMExSy3uXjlMSBy9r5onylEefllvyQeY 8gHB1e3bszRAHLpCd7tbSSFKeIXJ6ZsxYa9TAdWlUb0O6B2iZ3xJW7BiwytI+a+HjHW2G4 yrFI8qDAjBoWKq/raGGxs4fPjYdfsi8= Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-636-hOM0BqJPP6eRye7pR-FeKg-1; Thu, 12 Jan 2023 09:47:21 -0500 X-MC-Unique: hOM0BqJPP6eRye7pR-FeKg-1 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.rdu2.redhat.com [10.11.54.6]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 0629018E0920; Thu, 12 Jan 2023 14:47:21 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.78]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 6DAC12166B26; Thu, 12 Jan 2023 14:47:20 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 40C2A21E6A36; Thu, 12 Jan 2023 15:47:19 +0100 (CET) From: Markus Armbruster To: "Michael S. Tsirkin" Cc: Markus Armbruster , qemu-devel@nongnu.org, imp@bsdimp.com, kevans@freebsd.org, berrange@redhat.com, ben.widawsky@intel.com, jonathan.cameron@huawei.com, kbastian@mail.uni-paderborn.de, jasowang@redhat.com, michael.roth@amd.com, kkostiuk@redhat.com, tsimpson@quicinc.com, palmer@dabbelt.com, alistair.francis@wdc.com, bin.meng@windriver.com, qemu-riscv@nongnu.org, philmd@linaro.org, Bin Meng Subject: Re: [PATCH v3 1/1] include: Don't include qemu/osdep.h References: <20230112115005.1504812-1-armbru@redhat.com> <20230112115005.1504812-2-armbru@redhat.com> <20230112082537-mutt-send-email-mst@kernel.org> <20230112085520-mutt-send-email-mst@kernel.org> Date: Thu, 12 Jan 2023 15:47:19 +0100 In-Reply-To: <20230112085520-mutt-send-email-mst@kernel.org> (Michael S. Tsirkin's message of "Thu, 12 Jan 2023 08:56:03 -0500") Message-ID: <87zgan4xoo.fsf@pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.1 on 10.11.54.6 Received-SPF: pass client-ip=170.10.133.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org "Michael S. Tsirkin" writes: > On Thu, Jan 12, 2023 at 08:51:32AM -0500, Michael S. Tsirkin wrote: >> On Thu, Jan 12, 2023 at 12:50:05PM +0100, Markus Armbruster wrote: >> > docs/devel/style.rst mandates: >> >=20 >> > The "qemu/osdep.h" header contains preprocessor macros that affect >> > the behavior of core system headers like . It must be >> > the first include so that core system headers included by external >> > libraries get the preprocessor macros that QEMU depends on. >> >=20 >> > Do not include "qemu/osdep.h" from header files since the .c file >> > will have already included it. >> >=20 >> > A few violations have crept in. Fix them. >> >=20 >> > Signed-off-by: Markus Armbruster >> > Reviewed-by: Philippe Mathieu-Daud=C3=A9 >> > Reviewed-by: Bin Meng >> > Reviewed-by: Taylor Simpson >> > Reviewed-by: Alistair Francis >>=20 >> With my awesome grep skillz I found one more: >> $ grep -r --include=3D'*.h' qemu/osdep.h >> include/block/graph-lock.h:#include "qemu/osdep.h" Crept in after I prepared my v1. I neglected to re-check. > Also: > $ grep -r --include=3D'*.inc' qemu/osdep.h > ui/vnc-enc-zrle.c.inc:#include "qemu/osdep.h" > crypto/akcipher-nettle.c.inc:#include "qemu/osdep.h" > crypto/akcipher-gcrypt.c.inc:#include "qemu/osdep.h" > crypto/rsakey-nettle.c.inc:#include "qemu/osdep.h" > crypto/cipher-gnutls.c.inc:#include "qemu/osdep.h" > target/xtensa/core-dc233c/xtensa-modules.c.inc:#include "qemu/osdep.h" > target/xtensa/core-sample_controller/xtensa-modules.c.inc:#include "qemu/= osdep.h" > target/xtensa/core-de212/xtensa-modules.c.inc:#include "qemu/osdep.h" > target/xtensa/core-dc232b/xtensa-modules.c.inc:#include "qemu/osdep.h" > target/xtensa/core-fsf/xtensa-modules.c.inc:#include "qemu/osdep.h" > target/cris/translate_v10.c.inc:#include "qemu/osdep.h" Good point. Looks like I successfully supressed all memory of .inc. >> Looks like all C files must include qemu/osdep.h, no? I remember there are a few exceptions, but I don't remember which .c they are. Hmm... see commit 4bd802b209cff612d1a99674a91895b735be8630. >> How about >>=20 >> 1- add -include qemu/osdep.h on compile command line >> drop #include "qemu/osdep.h" from C files Then you need to encode the exceptions in the build system. Which might not be a bad thing. >> 2- drop double include guards, replace with a warning. >>=20 >> following patch implements part 2: >>=20 >>=20 >> qemu/osdep: don't include it from headers >>=20 >> doing so will lead to trouble eventually - instead of >> working around such cases make it more likely it will fail. >>=20 >> Signed-off-by: Michael S. Tsirkin >>=20 >> --- >>=20 >> diff --git a/include/qemu/osdep.h b/include/qemu/osdep.h >> index 7d059ad526..e4a60f911c 100644 >> --- a/include/qemu/osdep.h >> +++ b/include/qemu/osdep.h >> @@ -24,7 +24,12 @@ >> * This work is licensed under the terms of the GNU GPL, version 2 or l= ater. >> * See the COPYING file in the top-level directory. >> */ >> -#ifndef QEMU_OSDEP_H >> +#ifdef QEMU_OSDEP_H >> +#warning "Never include qemu/osdep.h from a header!" >> +#endif >> + >> +static inline void qemu_osdep_never_include_from_header(void) {} >> + Why do you need the function, too? >> #define QEMU_OSDEP_H >>=20=20 >> #include "config-host.h" >> @@ -714,5 +719,3 @@ static inline int platform_does_not_support_system(c= onst char *command) >> #ifdef __cplusplus >> } >> #endif >> - >> -#endif