diff mbox series

[v5,02/52] devtools: forbid use of strerror

Message ID	20241104111037.3632161-3-huangdengdui@huawei.com (mailing list archive)
State	Superseded, archived
Delegated to:	Thomas Monjalon
Headers	From: Dengdui Huang <huangdengdui@huawei.com> To: <dev@dpdk.org> CC: <ajit.khaparde@broadcom.com>, <thomas@monjalon.net>, <ferruh.yigit@amd.com>, <stephen@networkplumber.org>, <mb@smartsharesystems.com>, <david.marchand@redhat.com>, <iboukris@gmail.com>, <lihuisong@huawei.com>, <fengchengwen@huawei.com>, <haijie1@huawei.com>, <liuyonglong@huawei.com> Subject: [PATCH v5 02/52] devtools: forbid use of strerror Date: Mon, 4 Nov 2024 19:09:47 +0800 Message-ID: <20241104111037.3632161-3-huangdengdui@huawei.com> In-Reply-To: <20241104111037.3632161-1-huangdengdui@huawei.com> References: <20231114082539.1858594-1-huangdengdui@huawei.com> <20241104111037.3632161-1-huangdengdui@huawei.com> MIME-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: 8bit Precedence: list Errors-To: dev-bounces@dpdk.org
Series	replace strerror \| [v5,00/52] replace strerror [v5,01/52] eal: fix use rte errno for libc function [v5,02/52] devtools: forbid use of strerror [v5,03/52] eal: replace strerror with reentrant version [v5,04/52] eventdev: replace strerror with reentrant version [v5,05/52] latency: replace strerror with reentrant version [v5,06/52] node: replace strerror with reentrant version [v5,07/52] pdump: replace strerror with reentrant version [v5,08/52] pdump: use rte strerror [v5,09/52] power: replace strerror with reentrant version [v5,10/52] vhost: replace strerror with reentrant version [v5,11/52] bpf: replace strerror with reentrant version [v5,12/52] bus/cdx: replace strerror with reentrant version [v5,13/52] bus/dpaa: replace strerror with reentrant version [v5,14/52] bus/fslmc: replace strerror with reentrant version [v5,15/52] bus/pci: replace strerror with reentrant version [v5,16/52] bus/vmbus: replace strerror with reentrant version [v5,17/52] bus/vdev: use rte strerror [v5,18/52] common/cnxk: replace strerror with reentrant version [v5,19/52] common/mlx5: replace strerror with reentrant version [v5,20/52] common/mlx5: use rte strerror [v5,21/52] crypto/caam_jr: replace strerror with reentrant version [v5,22/52] dma/idxd: replace strerror with reentrant version [v5,23/52] net/bnxt: replace strerror with reentrant version [v5,24/52] net/af_xdp: replace strerror with reentrant version [v5,25/52] net/af_xdp: use rte strerror [v5,26/52] net/bonding: replace strerror with reentrant version [v5,27/52] net/bonding: use rte strerror [v5,28/52] net/cnxk: replace strerror with reentrant version [v5,29/52] net/dpaa: replace strerror with reentrant version [v5,30/52] net/dpaa2: replace strerror with reentrant version [v5,31/52] net/enetfec: replace strerror with reentrant version [v5,32/52] net/failsafe: replace strerror with reentrant version [v5,33/52] net/failsafe: use rte strerror [v5,34/52] net/i40e: replace strerror with reentrant version [v5,35/52] net/ice: replace strerror with reentrant version [v5,36/52] net/ixgbe: replace strerror with reentrant version [v5,37/52] net/memif: replace strerror with reentrant version [v5,38/52] net/memif: use rte strerror [v5,39/52] net/mlx4: replace strerror with reentrant version [v5,40/52] net/mlx4: use rte strerror [v5,41/52] net/mlx5: replace strerror with reentrant version [v5,42/52] net/mlx5: use rte strerror [v5,43/52] net/qede: replace strerror with reentrant version [v5,44/52] net/sfc: replace strerror with reentrant version [v5,45/52] net/tap: replace strerror with reentrant version [v5,46/52] net/tap: use rte strerror [v5,47/52] net/vhost: replace strerror with reentrant version [v5,48/52] net/virtio: replace strerror with reentrant version [v5,49/52] raw/ifpga: replace strerror with reentrant version [v5,50/52] vdpa/ifc: replace strerror with reentrant version [v5,51/52] vdpa/mlx5: replace strerror with reentrant version [v5,52/52] vdpa/sfc: replace strerror with reentrant version

Checks

Context	Check	Description
ci/checkpatch	success	coding style OK

Commit Message

huangdengdui Nov. 4, 2024, 11:09 a.m. UTC

The function strerror() is insecure in a multi-thread environment.
rte_strerror() or strerror_r() has been provided in DPDK to replace it.
In addition, replace strerror_s with strerror_r on the Windows platform.

Signed-off-by: Dengdui Huang <huangdengdui@huawei.com>
Acked-by: Chengwen Feng <fengchengwen@huawei.com>
Acked-by: Morten Brørup <mb@smartsharesystems.com>
Acked-by: Huisong Li <lihuisong@huawei.com>
---
 devtools/checkpatches.sh              | 8 ++++++++
 lib/eal/windows/include/rte_os_shim.h | 1 +
 2 files changed, 9 insertions(+)

diff mbox series

Patch

diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh
index 4a8591be22..c9ee3550c1 100755
--- a/devtools/checkpatches.sh
+++ b/devtools/checkpatches.sh
@@ -210,6 +210,14 @@  check_forbidden_additions() { # <patch>
 		-f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
 		"$1" || res=1
 
+	# refrain from using strerror() for drivers and libs
+	awk -v FOLDERS="lib drivers" \
+		-v EXPRESSIONS="\\\sstrerror\\\(" \
+		-v RET_ON_FAIL=1 \
+		-v MESSAGE='Using strerror, prefer rte_strerror or strerror_r' \
+		-f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
+		"$1" || res=1
+
 	# refrain from using RTE_LOG_REGISTER for drivers and libs
 	awk -v FOLDERS='lib drivers' \
 		-v EXPRESSIONS='\\<RTE_LOG_REGISTER\\>' \
diff --git a/lib/eal/windows/include/rte_os_shim.h b/lib/eal/windows/include/rte_os_shim.h
index eda8113662..2bac31e716 100644
--- a/lib/eal/windows/include/rte_os_shim.h
+++ b/lib/eal/windows/include/rte_os_shim.h
@@ -20,6 +20,7 @@ 
 
 #define strdup(str) _strdup(str)
 #define strtok_r(str, delim, saveptr) strtok_s(str, delim, saveptr)
+#define strerror_r(errnum, buf, buflen) strerror_s(buf, buflen, errnum)
 #ifndef RTE_TOOLCHAIN_GCC
 #define strcasecmp(s1, s2) _stricmp(s1, s2)
 #define strncasecmp(s1, s2, count) _strnicmp(s1, s2, count)