[v5] lib/bpf: Rename bpf function names to avoid potential conflict with libpcap

Message ID 20230314142038.23436-1-mars14850@gmail.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [v5] lib/bpf: Rename bpf function names to avoid potential conflict with libpcap |

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/Intel-compilation success Compilation OK
ci/github-robot: build success github build: passed
ci/intel-Testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-abi-testing success Testing PASS

Commit Message

J.J. Martzki March 14, 2023, 2:20 p.m. UTC
  The library libpcap has their function 'bpf_validate' either so there would
be a multiple definition issue when linking with librte_bpf.a and libpcap.a
statically (Same as http://dpdk.org/patch/52631). So just rename the
function names to avoid such issue.

Signed-off-by: J.J. Martzki <mars14850@gmail.com>

---
v5:
* Use '__rte' prefix.
* Add annotation for function naming.
v4:
* Update my name.
v3:
* Rewrite the commit message.
v2:
* Rename all functions in bpf_impl.h.
* Adjust the commit message.
---
 lib/bpf/bpf.c           |  6 +++---
 lib/bpf/bpf_convert.c   |  3 ---
 lib/bpf/bpf_impl.h      | 14 ++++++++------
 lib/bpf/bpf_jit_arm64.c |  2 +-
 lib/bpf/bpf_jit_x86.c   |  2 +-
 lib/bpf/bpf_load.c      |  4 ++--
 lib/bpf/bpf_validate.c  |  2 +-
 7 files changed, 16 insertions(+), 17 deletions(-)
  

Comments

Konstantin Ananyev March 16, 2023, 12:58 a.m. UTC | #1
14/03/2023 14:20, J.J. Martzki пишет:
> The library libpcap has their function 'bpf_validate' either so there would
> be a multiple definition issue when linking with librte_bpf.a and libpcap.a
> statically (Same as http://dpdk.org/patch/52631). So just rename the
> function names to avoid such issue.
> 
> Signed-off-by: J.J. Martzki <mars14850@gmail.com>
> 
> ---
> v5:
> * Use '__rte' prefix.
> * Add annotation for function naming.
> v4:
> * Update my name.
> v3:
> * Rewrite the commit message.
> v2:
> * Rename all functions in bpf_impl.h.
> * Adjust the commit message.
> ---
>   lib/bpf/bpf.c           |  6 +++---
>   lib/bpf/bpf_convert.c   |  3 ---
>   lib/bpf/bpf_impl.h      | 14 ++++++++------
>   lib/bpf/bpf_jit_arm64.c |  2 +-
>   lib/bpf/bpf_jit_x86.c   |  2 +-
>   lib/bpf/bpf_load.c      |  4 ++--
>   lib/bpf/bpf_validate.c  |  2 +-
>   7 files changed, 16 insertions(+), 17 deletions(-)
> 
> diff --git a/lib/bpf/bpf.c b/lib/bpf/bpf.c
> index 1e1dd42a58..8a0254d8bb 100644
> --- a/lib/bpf/bpf.c
> +++ b/lib/bpf/bpf.c
> @@ -31,14 +31,14 @@ rte_bpf_get_jit(const struct rte_bpf *bpf, struct rte_bpf_jit *jit)
>   }
>   
>   int
> -bpf_jit(struct rte_bpf *bpf)
> +__rte_bpf_jit(struct rte_bpf *bpf)
>   {
>   	int32_t rc;
>   
>   #if defined(RTE_ARCH_X86_64)
> -	rc = bpf_jit_x86(bpf);
> +	rc = __rte_bpf_jit_x86(bpf);
>   #elif defined(RTE_ARCH_ARM64)
> -	rc = bpf_jit_arm64(bpf);
> +	rc = __rte_bpf_jit_arm64(bpf);
>   #else
>   	rc = -ENOTSUP;
>   #endif
> diff --git a/lib/bpf/bpf_convert.c b/lib/bpf/bpf_convert.c
> index 9563274c9c..d441be6663 100644
> --- a/lib/bpf/bpf_convert.c
> +++ b/lib/bpf/bpf_convert.c
> @@ -23,11 +23,8 @@
>   #include <rte_malloc.h>
>   #include <rte_errno.h>
>   
> -/* Workaround name conflicts with libpcap */
> -#define bpf_validate(f, len) bpf_validate_libpcap(f, len)
>   #include <pcap/pcap.h>
>   #include <pcap/bpf.h>
> -#undef bpf_validate
>   
>   #include "bpf_impl.h"
>   #include "bpf_def.h"
> diff --git a/lib/bpf/bpf_impl.h b/lib/bpf/bpf_impl.h
> index b4d8e87c6d..3e067c1ff4 100644
> --- a/lib/bpf/bpf_impl.h
> +++ b/lib/bpf/bpf_impl.h
> @@ -17,12 +17,14 @@ struct rte_bpf {
>   	uint32_t stack_sz;
>   };
>   
> -extern int bpf_validate(struct rte_bpf *bpf);
> -
> -extern int bpf_jit(struct rte_bpf *bpf);
> -
> -extern int bpf_jit_x86(struct rte_bpf *);
> -extern int bpf_jit_arm64(struct rte_bpf *);
> +/*
> + * Use '__rte' prefix for non-static internal functions
> + * to avoid potential name conflict with other libraries.
> + */
> +extern int __rte_bpf_validate(struct rte_bpf *bpf);
> +extern int __rte_bpf_jit(struct rte_bpf *bpf);
> +extern int __rte_bpf_jit_x86(struct rte_bpf *bpf);
> +extern int __rte_bpf_jit_arm64(struct rte_bpf *bpf);
>   
>   extern int rte_bpf_logtype;
>   
> diff --git a/lib/bpf/bpf_jit_arm64.c b/lib/bpf/bpf_jit_arm64.c
> index db79ff7385..f9ddafd7dc 100644
> --- a/lib/bpf/bpf_jit_arm64.c
> +++ b/lib/bpf/bpf_jit_arm64.c
> @@ -1393,7 +1393,7 @@ emit(struct a64_jit_ctx *ctx, struct rte_bpf *bpf)
>    * Produce a native ISA version of the given BPF code.
>    */
>   int
> -bpf_jit_arm64(struct rte_bpf *bpf)
> +__rte_bpf_jit_arm64(struct rte_bpf *bpf)
>   {
>   	struct a64_jit_ctx ctx;
>   	size_t size;
> diff --git a/lib/bpf/bpf_jit_x86.c b/lib/bpf/bpf_jit_x86.c
> index c1a30e0386..a73b2006db 100644
> --- a/lib/bpf/bpf_jit_x86.c
> +++ b/lib/bpf/bpf_jit_x86.c
> @@ -1490,7 +1490,7 @@ emit(struct bpf_jit_state *st, const struct rte_bpf *bpf)
>    * produce a native ISA version of the given BPF code.
>    */
>   int
> -bpf_jit_x86(struct rte_bpf *bpf)
> +__rte_bpf_jit_x86(struct rte_bpf *bpf)
>   {
>   	int32_t rc;
>   	uint32_t i;
> diff --git a/lib/bpf/bpf_load.c b/lib/bpf/bpf_load.c
> index 1e17df6ce0..45ce9210da 100644
> --- a/lib/bpf/bpf_load.c
> +++ b/lib/bpf/bpf_load.c
> @@ -108,9 +108,9 @@ rte_bpf_load(const struct rte_bpf_prm *prm)
>   		return NULL;
>   	}
>   
> -	rc = bpf_validate(bpf);
> +	rc = __rte_bpf_validate(bpf);
>   	if (rc == 0) {
> -		bpf_jit(bpf);
> +		__rte_bpf_jit(bpf);
>   		if (mprotect(bpf, bpf->sz, PROT_READ) != 0)
>   			rc = -ENOMEM;
>   	}
> diff --git a/lib/bpf/bpf_validate.c b/lib/bpf/bpf_validate.c
> index 61cbb42216..119dc4d3aa 100644
> --- a/lib/bpf/bpf_validate.c
> +++ b/lib/bpf/bpf_validate.c
> @@ -2302,7 +2302,7 @@ evaluate(struct bpf_verifier *bvf)
>   }
>   
>   int
> -bpf_validate(struct rte_bpf *bpf)
> +__rte_bpf_validate(struct rte_bpf *bpf)
>   {
>   	int32_t rc;
>   	struct bpf_verifier bvf;

Acked-by: Konstantin Ananyev <konstantin.v.ananyev@yandex.ru>
  
Thomas Monjalon March 20, 2023, 11:50 a.m. UTC | #2
16/03/2023 01:58, Konstantin Ananyev:
> 14/03/2023 14:20, J.J. Martzki пишет:
> > The library libpcap has their function 'bpf_validate' either so there would
> > be a multiple definition issue when linking with librte_bpf.a and libpcap.a
> > statically (Same as http://dpdk.org/patch/52631). So just rename the
> > function names to avoid such issue.
> > 
> > Signed-off-by: J.J. Martzki <mars14850@gmail.com>
> 
> Acked-by: Konstantin Ananyev <konstantin.v.ananyev@yandex.ru>

Applied, thanks.
  

Patch

diff --git a/lib/bpf/bpf.c b/lib/bpf/bpf.c
index 1e1dd42a58..8a0254d8bb 100644
--- a/lib/bpf/bpf.c
+++ b/lib/bpf/bpf.c
@@ -31,14 +31,14 @@  rte_bpf_get_jit(const struct rte_bpf *bpf, struct rte_bpf_jit *jit)
 }
 
 int
-bpf_jit(struct rte_bpf *bpf)
+__rte_bpf_jit(struct rte_bpf *bpf)
 {
 	int32_t rc;
 
 #if defined(RTE_ARCH_X86_64)
-	rc = bpf_jit_x86(bpf);
+	rc = __rte_bpf_jit_x86(bpf);
 #elif defined(RTE_ARCH_ARM64)
-	rc = bpf_jit_arm64(bpf);
+	rc = __rte_bpf_jit_arm64(bpf);
 #else
 	rc = -ENOTSUP;
 #endif
diff --git a/lib/bpf/bpf_convert.c b/lib/bpf/bpf_convert.c
index 9563274c9c..d441be6663 100644
--- a/lib/bpf/bpf_convert.c
+++ b/lib/bpf/bpf_convert.c
@@ -23,11 +23,8 @@ 
 #include <rte_malloc.h>
 #include <rte_errno.h>
 
-/* Workaround name conflicts with libpcap */
-#define bpf_validate(f, len) bpf_validate_libpcap(f, len)
 #include <pcap/pcap.h>
 #include <pcap/bpf.h>
-#undef bpf_validate
 
 #include "bpf_impl.h"
 #include "bpf_def.h"
diff --git a/lib/bpf/bpf_impl.h b/lib/bpf/bpf_impl.h
index b4d8e87c6d..3e067c1ff4 100644
--- a/lib/bpf/bpf_impl.h
+++ b/lib/bpf/bpf_impl.h
@@ -17,12 +17,14 @@  struct rte_bpf {
 	uint32_t stack_sz;
 };
 
-extern int bpf_validate(struct rte_bpf *bpf);
-
-extern int bpf_jit(struct rte_bpf *bpf);
-
-extern int bpf_jit_x86(struct rte_bpf *);
-extern int bpf_jit_arm64(struct rte_bpf *);
+/*
+ * Use '__rte' prefix for non-static internal functions
+ * to avoid potential name conflict with other libraries.
+ */
+extern int __rte_bpf_validate(struct rte_bpf *bpf);
+extern int __rte_bpf_jit(struct rte_bpf *bpf);
+extern int __rte_bpf_jit_x86(struct rte_bpf *bpf);
+extern int __rte_bpf_jit_arm64(struct rte_bpf *bpf);
 
 extern int rte_bpf_logtype;
 
diff --git a/lib/bpf/bpf_jit_arm64.c b/lib/bpf/bpf_jit_arm64.c
index db79ff7385..f9ddafd7dc 100644
--- a/lib/bpf/bpf_jit_arm64.c
+++ b/lib/bpf/bpf_jit_arm64.c
@@ -1393,7 +1393,7 @@  emit(struct a64_jit_ctx *ctx, struct rte_bpf *bpf)
  * Produce a native ISA version of the given BPF code.
  */
 int
-bpf_jit_arm64(struct rte_bpf *bpf)
+__rte_bpf_jit_arm64(struct rte_bpf *bpf)
 {
 	struct a64_jit_ctx ctx;
 	size_t size;
diff --git a/lib/bpf/bpf_jit_x86.c b/lib/bpf/bpf_jit_x86.c
index c1a30e0386..a73b2006db 100644
--- a/lib/bpf/bpf_jit_x86.c
+++ b/lib/bpf/bpf_jit_x86.c
@@ -1490,7 +1490,7 @@  emit(struct bpf_jit_state *st, const struct rte_bpf *bpf)
  * produce a native ISA version of the given BPF code.
  */
 int
-bpf_jit_x86(struct rte_bpf *bpf)
+__rte_bpf_jit_x86(struct rte_bpf *bpf)
 {
 	int32_t rc;
 	uint32_t i;
diff --git a/lib/bpf/bpf_load.c b/lib/bpf/bpf_load.c
index 1e17df6ce0..45ce9210da 100644
--- a/lib/bpf/bpf_load.c
+++ b/lib/bpf/bpf_load.c
@@ -108,9 +108,9 @@  rte_bpf_load(const struct rte_bpf_prm *prm)
 		return NULL;
 	}
 
-	rc = bpf_validate(bpf);
+	rc = __rte_bpf_validate(bpf);
 	if (rc == 0) {
-		bpf_jit(bpf);
+		__rte_bpf_jit(bpf);
 		if (mprotect(bpf, bpf->sz, PROT_READ) != 0)
 			rc = -ENOMEM;
 	}
diff --git a/lib/bpf/bpf_validate.c b/lib/bpf/bpf_validate.c
index 61cbb42216..119dc4d3aa 100644
--- a/lib/bpf/bpf_validate.c
+++ b/lib/bpf/bpf_validate.c
@@ -2302,7 +2302,7 @@  evaluate(struct bpf_verifier *bvf)
 }
 
 int
-bpf_validate(struct rte_bpf *bpf)
+__rte_bpf_validate(struct rte_bpf *bpf)
 {
 	int32_t rc;
 	struct bpf_verifier bvf;