From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <bruce.richardson@intel.com>
Received: from mga06.intel.com (mga06.intel.com [134.134.136.31])
by dpdk.org (Postfix) with ESMTP id 6E6D44C74
for <dev@dpdk.org>; Tue, 26 Feb 2019 13:19:26 +0100 (CET)
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
Received: from fmsmga001.fm.intel.com ([10.253.24.23])
by orsmga104.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;
26 Feb 2019 04:19:26 -0800
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.58,415,1544515200"; d="scan'208";a="150086102"
Received: from silpixa00399126.ir.intel.com (HELO
silpixa00399126.ger.corp.intel.com) ([10.237.222.236])
by fmsmga001.fm.intel.com with ESMTP; 26 Feb 2019 04:19:25 -0800
From: Bruce Richardson <bruce.richardson@intel.com>
To: thomas@monjalon.net
Cc: dev@dpdk.org, Bruce Richardson <bruce.richardson@intel.com>,
Konstantin Ananyev <konstantin.ananyev@intel.com>
Date: Tue, 26 Feb 2019 12:19:02 +0000
Message-Id: <20190226121903.5499-5-bruce.richardson@intel.com>
X-Mailer: git-send-email 2.20.1
In-Reply-To: <20190226121903.5499-1-bruce.richardson@intel.com>
References: <20190125202642.66559-1-bruce.richardson@intel.com>
<20190226121903.5499-1-bruce.richardson@intel.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Subject: [dpdk-dev] [PATCH v3 4/5] test/bpf: move to examples folder
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Tue, 26 Feb 2019 12:19:27 -0000
The bpf folder didn't actual contain a test application, but instead
basic examples of BPF code for use with testpmd. Therefore we can
move it to the `examples` folder. Being different, it also needs
a README with it, explaining what it is and how to use it. References
to the code from the testpmd docs are suitably updated.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
---
MAINTAINERS | 2 +-
doc/guides/testpmd_app_ug/testpmd_funcs.rst | 8 ++++----
examples/bpf/README | 8 ++++++++
{test => examples}/bpf/dummy.c | 0
{test => examples}/bpf/mbuf.h | 0
examples/bpf/meson.build | 6 ++++++
{test => examples}/bpf/t1.c | 0
{test => examples}/bpf/t2.c | 0
{test => examples}/bpf/t3.c | 0
9 files changed, 19 insertions(+), 5 deletions(-)
create mode 100644 examples/bpf/README
rename {test => examples}/bpf/dummy.c (100%)
rename {test => examples}/bpf/mbuf.h (100%)
create mode 100644 examples/bpf/meson.build
rename {test => examples}/bpf/t1.c (100%)
rename {test => examples}/bpf/t2.c (100%)
rename {test => examples}/bpf/t3.c (100%)
diff --git a/MAINTAINERS b/MAINTAINERS
index b690e1e83..e1c0f669b 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1229,7 +1229,7 @@ F: doc/guides/howto/telemetry.rst
BPF - EXPERIMENTAL
M: Konstantin Ananyev <konstantin.ananyev@intel.com>
F: lib/librte_bpf/
-F: test/bpf/
+F: examples/bpf/
F: test/test/test_bpf.c
F: doc/guides/prog_guide/bpf_lib.rst
diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index 5de9f1be1..1a12da4cf 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -4503,20 +4503,20 @@ For example:
.. code-block:: console
- cd test/bpf
+ cd examples/bpf
clang -O2 -target bpf -c t1.c
Then to load (and JIT compile) t1.o at RX queue 0, port 1::
.. code-block:: console
- testpmd> bpf-load rx 1 0 J ./dpdk.org/test/bpf/t1.o
+ testpmd> bpf-load rx 1 0 J ./dpdk.org/examples/bpf/t1.o
To load (not JITed) t1.o at TX queue 0, port 0::
.. code-block:: console
- testpmd> bpf-load tx 0 0 - ./dpdk.org/test/bpf/t1.o
+ testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
bpf-unload
~~~~~~~~~~
@@ -4529,4 +4529,4 @@ For example to unload BPF filter from TX queue 0, port 0:
.. code-block:: console
- testpmd> bpf-load tx 0 0 - ./dpdk.org/test/bpf/t1.o
+ testpmd> bpf-unload tx 0 0
diff --git a/examples/bpf/README b/examples/bpf/README
new file mode 100644
index 000000000..d714180a5
--- /dev/null
+++ b/examples/bpf/README
@@ -0,0 +1,8 @@
+This folder contains example BPF programs for use with the DPDK bpf
+library. To get details of each program and how to compile it, see
+the header on the '.c' file itself.
+
+Once compiled, these example programs can be loaded into `testpmd`
+for execution on a packet stream. See `bpf-load` and `bpf-unload`
+commands documented in the `Testpmd Application User Guide` for
+details on how to do so.
diff --git a/test/bpf/dummy.c b/examples/bpf/dummy.c
similarity index 100%
rename from test/bpf/dummy.c
rename to examples/bpf/dummy.c
diff --git a/test/bpf/mbuf.h b/examples/bpf/mbuf.h
similarity index 100%
rename from test/bpf/mbuf.h
rename to examples/bpf/mbuf.h
diff --git a/examples/bpf/meson.build b/examples/bpf/meson.build
new file mode 100644
index 000000000..0a817aaea
--- /dev/null
+++ b/examples/bpf/meson.build
@@ -0,0 +1,6 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright(c) 2019 Intel Corporation
+
+# This contains BPF example code for use in testing BPF with testpmd,
+# therefore it should not be built as part of a meson build.
+build=false
diff --git a/test/bpf/t1.c b/examples/bpf/t1.c
similarity index 100%
rename from test/bpf/t1.c
rename to examples/bpf/t1.c
diff --git a/test/bpf/t2.c b/examples/bpf/t2.c
similarity index 100%
rename from test/bpf/t2.c
rename to examples/bpf/t2.c
diff --git a/test/bpf/t3.c b/examples/bpf/t3.c
similarity index 100%
rename from test/bpf/t3.c
rename to examples/bpf/t3.c
--
2.20.1