diff mbox series

[v9,01/30] devtools: check packed attributes

Message ID	1736383715-31703-2-git-send-email-andremue@linux.microsoft.com (mailing list archive)
State	Superseded, archived
Delegated to:	Thomas Monjalon
Headers	From: Andre Muezerie <andremue@linux.microsoft.com> To: roretzla@linux.microsoft.com Cc: aman.deep.singh@intel.com, anatoly.burakov@intel.com, bruce.richardson@intel.com, byron.marohn@intel.com, conor.walsh@intel.com, cristian.dumitrescu@intel.com, david.hunt@intel.com, dev@dpdk.org, dsosnowski@nvidia.com, gakhil@marvell.com, jerinj@marvell.com, jingjing.wu@intel.com, kirill.rybalchenko@intel.com, konstantin.v.ananyev@yandex.ru, matan@nvidia.com, mb@smartsharesystems.com, orika@nvidia.com, radu.nicolau@intel.com, ruifeng.wang@arm.com, sameh.gobriel@intel.com, sivaprasad.tummala@amd.com, skori@marvell.com, stephen@networkplumber.org, suanmingm@nvidia.com, vattunuru@marvell.com, viacheslavo@nvidia.com, vladimir.medvedkin@intel.com, yipeng1.wang@intel.com, Andre Muezerie <andremue@linux.microsoft.com> Subject: [PATCH v9 01/30] devtools: check packed attributes Date: Wed, 8 Jan 2025 16:48:06 -0800 Message-Id: <1736383715-31703-2-git-send-email-andremue@linux.microsoft.com> In-Reply-To: <1736383715-31703-1-git-send-email-andremue@linux.microsoft.com> References: <1710968771-16435-1-git-send-email-roretzla@linux.microsoft.com> <1736383715-31703-1-git-send-email-andremue@linux.microsoft.com> Precedence: list Errors-To: dev-bounces@dpdk.org
Series	fix packing of structs when building with MSVC \| [v9,00/30] fix packing of structs when building with MSVC [v9,01/30] devtools: check packed attributes [v9,02/30] eal/include: add new packing macros [v9,03/30] app/test-pmd: remove unnecessary packed attributes [v9,04/30] app/test: replace packed attributes [v9,05/30] doc/guides: replace packed attributes [v9,06/30] drivers/baseband: replace packed attributes [v9,07/30] drivers/bus: replace packed attributes [v9,08/30] drivers/common: replace packed attributes [v9,09/30] drivers/compress: replace packed attributes [v9,10/30] drivers/crypto: replace packed attributes [v9,11/30] drivers/dma: replace packed attributes [v9,12/30] drivers/event: replace packed attributes [v9,13/30] drivers/mempool: replace packed attributes [v9,14/30] drivers/net: replace packed attributes [v9,15/30] drivers/raw: replace packed attributes [v9,16/30] drivers/regex: replace packed attributes [v9,17/30] drivers/vdpa: replace packed attributes [v9,18/30] examples/common: replace packed attributes [v9,19/30] examples/ip-pipeline: remove packed attributes [v9,20/30] examples/ipsec_secgw: replace packed attributes [v9,21/30] examples/l3fwd-power: replace packed attributes [v9,22/30] examples/l3fwd: replace packed attributes [v9,23/30] examples/ptpclient: replace packed attributes [v9,24/30] examples/vhost_blk: replace packed attributes [v9,25/30] lib/eal: replace packed attributes [v9,26/30] lib/ipsec: replace packed attributes [v9,27/30] lib/net: replace packed attributes [v9,28/30] lib/pipeline: replace packed attributes [v9,29/30] lib/vhost: replace packed attributes [v9,30/30] eal/include: deprecate macro __rte_packed

Checks

Context	Check	Description
ci/checkpatch	warning	coding style issues

Commit Message

Andre Muezerie Jan. 9, 2025, 12:48 a.m. UTC

Ensure __rte_packed_begin and __rte_packed_end show up in pairs
when checking patches.

Signed-off-by: Andre Muezerie <andremue@linux.microsoft.com>
Acked-by: Tyler Retzlaff <roretzla@linux.microsoft.com>
---
 devtools/checkpatches.sh | 43 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff mbox series

Patch

diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh
index 4a8591be22..7868f5e522 100755
--- a/devtools/checkpatches.sh
+++ b/devtools/checkpatches.sh
@@ -202,6 +202,14 @@  check_forbidden_additions() { # <patch>
 		-f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
 		"$1" || res=1
 
+	# forbid use of __rte_packed_begin with enums
+	awk -v FOLDERS='lib drivers app examples' \
+		-v EXPRESSIONS='enum.*__rte_packed_begin' \
+		-v RET_ON_FAIL=1 \
+		-v MESSAGE='Using __rte_packed_begin with enum is not allowed' \
+		-f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
+		"$1" || res=1
+
 	# forbid use of experimental build flag except in examples
 	awk -v FOLDERS='lib drivers app' \
 		-v EXPRESSIONS='-DALLOW_EXPERIMENTAL_API allow_experimental_apis' \
@@ -362,6 +370,33 @@  check_aligned_attributes() { # <patch>
 	return $res
 }
 
+check_packed_attributes() { # <patch>
+	res=0
+
+	if [ $(grep -E '^\+.*__rte_packed_begin' "$1" | \
+			grep -vE '\<struct[[:space:]]*__rte_packed_begin\>' | \
+			grep -vE '\<union[[:space:]]*__rte_packed_begin\>' | \
+			grep -vE '\<__rte_cache_aligned[[:space:]]*__rte_packed_begin\>' | \
+			grep -vE '\<__rte_cache_min_aligned[[:space:]]*__rte_packed_begin\>' | \
+			grep -vE '\<__rte_aligned\(.*\)[[:space:]]*__rte_packed_begin\>' | \
+			wc -l) != 0 ]; then
+		echo "Please use __rte_packed_begin only after struct, union," \
+			 " __rte_cache_aligned, __rte_cache_min_aligned or __rte_aligned."
+		res=1
+	fi
+
+	begin_count=$(grep '__rte_packed_begin' "$1" | \
+			wc -l)
+	end_count=$(grep '__rte_packed_end' "$1" | \
+			wc -l)
+	if [ $begin_count != $end_count ]; then
+		echo "__rte_packed_begin and __rte_packed_end mismatch. They should always be used in pairs."
+		res=1
+	fi
+
+	return $res
+}
+
 check_release_notes() { # <patch>
 	rel_notes_prefix=doc/guides/rel_notes/release_
 	IFS=. read year month release < VERSION
@@ -479,6 +514,14 @@  check () { # <patch-file> <commit>
 		ret=1
 	fi
 
+	! $verbose || printf '\nChecking packed attributes:\n'
+	report=$(check_packed_attributes "$tmpinput")
+	if [ $? -ne 0 ] ; then
+		$headline_printed || print_headline "$subject"
+		printf '%s\n' "$report"
+		ret=1
+	fi
+
 	! $verbose || printf '\nChecking release notes updates:\n'
 	report=$(check_release_notes "$tmpinput")
 	if [ $? -ne 0 ] ; then