From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id D7152A0A02; Fri, 15 Jan 2021 12:11:05 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id C0328140F3C; Fri, 15 Jan 2021 12:11:05 +0100 (CET) Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by mails.dpdk.org (Postfix) with ESMTP id 6C0BC140F35 for ; Fri, 15 Jan 2021 12:11:03 +0100 (CET) IronPort-SDR: //N+QfaQlMQImhJm3Y/redDZleO2RDrNUObjYZoMvfPab+lA77JS+K9E5YheEmRuE9W9iKdN1/ +HNqsaSnzkBA== X-IronPort-AV: E=McAfee;i="6000,8403,9864"; a="242602718" X-IronPort-AV: E=Sophos;i="5.79,349,1602572400"; d="scan'208";a="242602718" Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 15 Jan 2021 03:11:01 -0800 IronPort-SDR: 1LMZbRsq/MMB41olKkNH693sWr8bddJkXYWLopIFunuJpGIJv5973Z4B3d7wLlgHDPEOp0rJvS QtI/AoVadsGQ== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.79,349,1602572400"; d="scan'208";a="401252608" Received: from silpixa00399126.ir.intel.com ([10.237.222.4]) by fmsmga002.fm.intel.com with ESMTP; 15 Jan 2021 03:11:00 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: david.marchand@redhat.com, Bruce Richardson Date: Fri, 15 Jan 2021 11:10:32 +0000 Message-Id: <20210115111052.16437-1-bruce.richardson@intel.com> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20210114110606.21142-1-bruce.richardson@intel.com> References: <20210114110606.21142-1-bruce.richardson@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v2 00/19] ensure headers have correct includes X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" As a general principle, each header file should include any other headers it needs to provide data type definitions or macros. For example, any header using the uintX_t types in structures or function prototypes should include "stdint.h" to provide those type definitions. In practice, while many, but not all, headers in DPDK did include all necessary headers, it was never actually checked that each header could be included in a C file and compiled without having any compiler errors about missing definitions. This patchset fixes any missing includes in public headers from the DPDK "lib" folder and then adds a "chkincs" app. to verify this on an ongoing basis. This chkincs app does nothing when run, it's for build-time checking only. Its source code consists of one C file per public DPDK header, where that C file contains nothing except an include for that header. Therefore, if any header is added to the lib folder which fails to compile when included alone, the build of chkincs will fail with a suitable error message. Since this compile checking is not needed on most builds of DPDK, the building of chkincs is disabled by default, but can be enabled by the "test_includes" meson option. To catch errors with patch submissions, the final patch of this series enables it for a single build in test-meson-builds script. Future work could involve doing similar checks on headers for C++ compatibility, for example. V2: * Add maintainers file entry for new app * Drop patch for c11 ring header * Use build variable "headers_no_chkincs" for tracking exceptions Bruce Richardson (19): eal: fix missing header inclusion telemetry: fix missing header include ethdev: fix missing header include net: fix missing header include mbuf: fix missing header include bitratestats: fix missing header include rib: fix missing header includes vhost: fix missing header includes ipsec: fix missing header include fib: fix missing header includes table: fix missing header include pipeline: fix missing header includes metrics: fix variable declaration in header node: fix missing header include app: fix extra include paths for app builds app/chkincs: add chkincs app to verify headers eal: add missing include to mcslock eal/x86: add architecture-specific headers to chkincs test-meson-builds: add includes check to default x86 build MAINTAINERS | 4 +++ app/chkincs/gen_c_file_for_header.py | 12 +++++++++ app/chkincs/main.c | 4 +++ app/chkincs/meson.build | 28 ++++++++++++++++++++ app/meson.build | 2 ++ devtools/test-meson-builds.sh | 2 +- doc/guides/contributing/coding_style.rst | 12 +++++++++ lib/librte_bitratestats/rte_bitrate.h | 1 + lib/librte_eal/include/generic/rte_mcslock.h | 1 + lib/librte_eal/include/meson.build | 2 +- lib/librte_eal/include/rte_reciprocal.h | 1 + lib/librte_eal/include/rte_thread.h | 1 + lib/librte_eal/x86/include/meson.build | 14 ++++++---- lib/librte_ethdev/meson.build | 4 +-- lib/librte_ethdev/rte_eth_ctrl.h | 1 + lib/librte_fib/rte_fib.h | 1 + lib/librte_fib/rte_fib6.h | 1 + lib/librte_hash/meson.build | 4 +-- lib/librte_ipsec/meson.build | 3 ++- lib/librte_ipsec/rte_ipsec_sad.h | 1 + lib/librte_lpm/meson.build | 2 +- lib/librte_mbuf/rte_mbuf_core.h | 1 + lib/librte_mbuf/rte_mbuf_dyn.h | 3 +++ lib/librte_metrics/rte_metrics_telemetry.c | 2 ++ lib/librte_metrics/rte_metrics_telemetry.h | 2 -- lib/librte_net/rte_geneve.h | 1 + lib/librte_node/rte_node_ip4_api.h | 1 + lib/librte_pipeline/rte_swx_ctl.h | 1 + lib/librte_pipeline/rte_swx_pipeline.h | 1 + lib/librte_regexdev/meson.build | 2 +- lib/librte_rib/rte_rib.h | 2 ++ lib/librte_ring/meson.build | 4 ++- lib/librte_stack/meson.build | 4 ++- lib/librte_table/meson.build | 7 +++-- lib/librte_table/rte_lru_x86.h | 1 + lib/librte_telemetry/rte_telemetry.h | 1 + lib/librte_vhost/rte_vdpa.h | 2 ++ lib/librte_vhost/rte_vdpa_dev.h | 1 + lib/librte_vhost/rte_vhost_crypto.h | 7 +++++ lib/meson.build | 3 +++ meson.build | 1 + meson_options.txt | 2 ++ 42 files changed, 128 insertions(+), 22 deletions(-) create mode 100755 app/chkincs/gen_c_file_for_header.py create mode 100644 app/chkincs/main.c create mode 100644 app/chkincs/meson.build -- 2.27.0