From patchwork Wed Aug 9 13:35:50 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 30 Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id C717843018; Wed, 9 Aug 2023 15:36:28 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 5B38940691; Wed, 9 Aug 2023 15:36:28 +0200 (CEST) Received: from mgamail.intel.com (mgamail.intel.com [134.134.136.31]) by mails.dpdk.org (Postfix) with ESMTP id 461F8400D6 for ; Wed, 9 Aug 2023 15:36:26 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1691588186; x=1723124186; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=++8M6qzAHk5+Mopi8W/Yw4IfxXErrxDdmMOMsJzE12U=; b=Iqujxl94U81Wstlv7F3kSLv+PQ++lFmzFeuUi70ohkmJas3X48D40VCq 2T0CGgqMohNag6in0orKXFbCrgY4/jFteGe9ccErHc3vS7yoba/8NEbhd LDfZByXwdJ6+lfiJmhDzvTVqDGydIoMLVl4IZytDER9+ktc0/coNYktRC SuN9ALD+OW8iblMKLAhonQ/iu6WbRKpBdv8Q7WJNBUqhaDVUl+zsSJf2M C9ob39TJMTJr6aF6ti7t1v+E9m31nL1+zQVs7MilMgqiYpXx/gBLfANPh qfw9KGSZ7MJFE0OSMGYbuJ0pmLdAGLyUa4m8oqjzTgK+53j4JKY8zCN89 w==; X-IronPort-AV: E=McAfee;i="6600,9927,10795"; a="435015570" X-IronPort-AV: E=Sophos;i="6.01,159,1684825200"; d="scan'208";a="435015570" Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 09 Aug 2023 06:36:01 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.01,202,1684825200"; d="scan'208";a="875261426" Received: from silpixa00401385.ir.intel.com ([10.237.214.156]) by fmsmga001.fm.intel.com with ESMTP; 09 Aug 2023 06:36:03 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: david.marchand@redhat.com, Bruce Richardson Subject: [PATCH v8 0/3] Split logging functionality out of EAL Date: Wed, 9 Aug 2023 14:35:50 +0100 Message-Id: <20230809133553.1396119-1-bruce.richardson@intel.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20220829151901.376754-1-bruce.richardson@intel.com> References: <20220829151901.376754-1-bruce.richardson@intel.com> MIME-Version: 1.0 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 There is a general desire to reduce the size and scope of EAL. To this end, this patchset makes a (very) small step in that direction by taking the logging functionality out of EAL and putting it into its own library that can be built and maintained separately. As with the first RFC for this, the main obstacle is the "fnmatch" function which is needed by both EAL and the new log function when building on windows. While the function cannot stay in EAL - or we would have a circular dependency, moving it to a new library or just putting it in the log library have the disadvantages that it then "leaks" into the public namespace without an rte_prefix, which could cause issues. Since only a single function is involved, subsequent versions take a different approach to v1, and just moves the offending function to be a static function in a header file. This allows use by multiple libs without conflicting names or making it public. The other complication, as explained in v1 RFC was that of multiple implementations for different OS's. This is solved here in the same way as v1, by including the OS in the name and having meson pick the correct file for each build. Since only one file is involved, there seemed little need for replicating EAL's separate subdirectories per-OS. V8: * Added "inline" to static functions in fnmatch header * Removed SCCS tag as unneeded carryover from .c file * Corrected doc cross-references and headers * Added maintainers entry V7: * re-submit to re-run CI with ABI checks disabled v6: * Updated ABI version to DPDK_24 for new log library for 23.11 release. v5: * rebased to latest main branch * fixed trailing whitespace issues in new doc section v4: * Fixed windows build error, due to missing strdup (_strdup on windows) * Added doc updates to programmers guide. v3: * Fixed missing log file for BSD * Removed "eal" from the filenames of files in the log directory * added prefixes to elements in the fnmatch header to avoid conflicts * fixed space indentation in new lines in telemetry.c (checkpatch) * removed "extern int logtype" definition in telemetry.c (checkpatch) * added log directory to list for doxygen scanning Bruce Richardson (3): eal/windows: move fnmatch function to header file log: separate logging functions out of EAL telemetry: use standard logging MAINTAINERS | 6 +- doc/api/doxy-api.conf.in | 1 + .../prog_guide/env_abstraction_layer.rst | 4 +- doc/guides/prog_guide/index.rst | 1 + doc/guides/prog_guide/log_lib.rst | 113 ++++++++++++ lib/eal/common/eal_common_options.c | 2 +- lib/eal/common/eal_private.h | 7 - lib/eal/common/meson.build | 1 - lib/eal/freebsd/eal.c | 6 +- lib/eal/include/meson.build | 1 - lib/eal/linux/eal.c | 8 +- lib/eal/linux/meson.build | 1 - lib/eal/meson.build | 2 +- lib/eal/version.map | 17 -- lib/eal/windows/eal.c | 2 +- lib/eal/windows/fnmatch.c | 172 ------------------ lib/eal/windows/include/fnmatch.h | 169 +++++++++++++++-- lib/eal/windows/meson.build | 2 - lib/kvargs/meson.build | 3 +- .../common/eal_common_log.c => log/log.c} | 7 +- lib/log/log_freebsd.c | 12 ++ .../common/eal_log.h => log/log_internal.h} | 18 +- lib/{eal/linux/eal_log.c => log/log_linux.c} | 2 +- .../windows/eal_log.c => log/log_windows.c} | 2 +- lib/log/meson.build | 9 + lib/{eal/include => log}/rte_log.h | 0 lib/log/version.map | 34 ++++ lib/meson.build | 1 + lib/telemetry/meson.build | 3 +- lib/telemetry/telemetry.c | 11 +- lib/telemetry/telemetry_internal.h | 3 +- 31 files changed, 367 insertions(+), 253 deletions(-) create mode 100644 doc/guides/prog_guide/log_lib.rst delete mode 100644 lib/eal/windows/fnmatch.c rename lib/{eal/common/eal_common_log.c => log/log.c} (99%) create mode 100644 lib/log/log_freebsd.c rename lib/{eal/common/eal_log.h => log/log_internal.h} (69%) rename lib/{eal/linux/eal_log.c => log/log_linux.c} (97%) rename lib/{eal/windows/eal_log.c => log/log_windows.c} (93%) create mode 100644 lib/log/meson.build rename lib/{eal/include => log}/rte_log.h (100%) create mode 100644 lib/log/version.map --- 2.39.2