From: David Marchand <david.marchand@redhat.com>
To: dev@dpdk.org
Cc: nhorman@tuxdriver.com, thomas@monjalon.net
Subject: [dpdk-dev] [RFC PATCH] detect missing experimental tags in headers
Date: Wed, 19 Dec 2018 14:44:53 +0100 [thread overview]
Message-ID: <1545227093-25493-1-git-send-email-david.marchand@redhat.com> (raw)
Add a little script to get the symbols of a given section looking at a
library map file, then, on installation, inspect the sources headers to
check that the declaration of the EXPERIMENTAL symbols are prefixed with
a __rte_experimental tag.
Signed-off-by: David Marchand <david.marchand@redhat.com>
---
For now, the check is not fatal, since this is just a draft.
Finding out the right headers could be improved.
We could also move this check to checkpatches so that it is enforced by
maintainers.
---
buildtools/map-list-symbol.sh | 23 +++++++++++++++++++++++
mk/rte.lib.mk | 27 ++++++++++++++++++++++++++-
2 files changed, 49 insertions(+), 1 deletion(-)
create mode 100755 buildtools/map-list-symbol.sh
diff --git a/buildtools/map-list-symbol.sh b/buildtools/map-list-symbol.sh
new file mode 100755
index 0000000..e4635df
--- /dev/null
+++ b/buildtools/map-list-symbol.sh
@@ -0,0 +1,23 @@
+#!/bin/sh
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright(c) 2018 David Marchand <david.marchand@redhat.com>
+
+section=${1:-}
+shift
+
+for file in $@; do
+ cat "$file" |awk '
+ BEGIN { in_sec = 0; }
+ /^.*{/ {
+ if ("'$section'" == "all" || $1 == "'$section'") {
+ in_sec = 1;
+ }
+ }
+ /.*}/ { in_sec = 0; }
+ /^[^}].*[^:*];/ {
+ if (in_sec == 1) {
+ gsub(";","");
+ print $1;
+ }
+ }'
+done
diff --git a/mk/rte.lib.mk b/mk/rte.lib.mk
index c696a21..fdd9059 100644
--- a/mk/rte.lib.mk
+++ b/mk/rte.lib.mk
@@ -31,7 +31,7 @@ endif
_BUILD = $(LIB)
-PREINSTALL = $(SYMLINK-FILES-y)
+PREINSTALL = $(SYMLINK-FILES-y) check_headers_experimental
_INSTALL = $(INSTALL-FILES-y) $(RTE_OUTPUT)/lib/$(LIB)
_CLEAN = doclean
@@ -127,6 +127,31 @@ $(LIB): $(OBJS-y) $(DEP_$(LIB)) FORCE
endif
#
+# __rte_experimental inspection
+#
+check_headers_experimental:
+ @list_symbols=""; \
+ for sym in $$($(RTE_SDK)/buildtools/map-list-symbol.sh EXPERIMENTAL $(SRCDIR)/$(EXPORT_MAP)); do \
+ srcdir=$(SRCDIR); \
+ if [ "$${srcdir%%linuxapp/eal}" != "$$srcdir" ]; then \
+ srcdir="$$srcdir $${srcdir%%linuxapp/eal}common"; \
+ fi; \
+ files=$$(find $$srcdir -name '*.h' |xargs grep -l $$sym); \
+ if [ -z "$$files" ]; then \
+ list_symbols="$$list_symbols $$sym"; \
+ continue; \
+ fi; \
+ if ! grep -Pzoha "[^)/;}]+\s*$$sym\s*\(" $$files |grep -q __rte_experimental; then \
+ list_symbols="$$list_symbols $$sym"; \
+ fi; \
+ done; \
+ if [ -n "$$list_symbols" ]; then \
+ for sym in $$list_symbols; do \
+ echo "ERROR: $$sym is not marked as experimental in this library headers"; \
+ done; \
+ fi
+
+#
# install lib in $(RTE_OUTPUT)/lib
#
$(RTE_OUTPUT)/lib/$(LIB): $(LIB)
--
1.8.3.1
next reply other threads:[~2018-12-19 13:45 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-12-19 13:44 David Marchand [this message]
2019-04-01 7:10 ` David Marchand
2019-04-01 7:10 ` David Marchand
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1545227093-25493-1-git-send-email-david.marchand@redhat.com \
--to=david.marchand@redhat.com \
--cc=dev@dpdk.org \
--cc=nhorman@tuxdriver.com \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).