aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorIlias Apalodimas <ilias.apalodimas@linaro.org>2018-02-16 12:12:26 +0200
committerMaxim Uvarov <maxim.uvarov@linaro.org>2018-05-11 23:39:49 +0300
commit49c671e80fd2c88b6f36337ebd1cd4748eb8bae1 (patch)
tree4ecf0359696b5e042a92b88f788cd6477968071e /doc
parent11207ff1e211658bfb44c635423ae818a0654239 (diff)
odp: pktio: add pcapng capture capabilities
Introduce new fast pcap capture interface to odp. How to test: sudo mkdir /var/run/odp/ start the ODP application sudo dd if=/var/run/odp/"pid"-ethX-flow-"queue" of=~/t.pcap Signed-off-by: Ilias Apalodimas <ilias.apalodimas@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/users-guide/Makefile.am3
-rw-r--r--doc/users-guide/users-guide-utilities-examples.adoc19
-rw-r--r--doc/users-guide/users-guide.adoc2
3 files changed, 23 insertions, 1 deletions
diff --git a/doc/users-guide/Makefile.am b/doc/users-guide/Makefile.am
index 7be32ddc1..6b2e818d0 100644
--- a/doc/users-guide/Makefile.am
+++ b/doc/users-guide/Makefile.am
@@ -7,7 +7,8 @@ SRC = users-guide.adoc \
users-guide-packet.adoc \
users-guide-pktio.adoc \
users-guide-timer.adoc \
- users-guide-tm.adoc
+ users-guide-tm.adoc \
+ users-guide-utilities-examples.adoc
TARGET = users-guide.html
IMAGES = $(IMAGES_DIR)/overview.svg \
$(IMAGES_DIR)/atomic_queue.svg \
diff --git a/doc/users-guide/users-guide-utilities-examples.adoc b/doc/users-guide/users-guide-utilities-examples.adoc
new file mode 100644
index 000000000..e51bbef85
--- /dev/null
+++ b/doc/users-guide/users-guide-utilities-examples.adoc
@@ -0,0 +1,19 @@
+== Utilities and examples
+
+=== PcapNg capture
+If compiled using `--enable-pcapng-support` ODP will offer packet capturing
+functionality in PcapNg format. If the /var/run/odp directory exists prior to
+launching the application ODP will create a fifo for each NIC queue.
+Queue naming will be of the following format: *<odp global pid>-<NIC
+name>-flow-<queue number>*. Linux dd application can be used for capturing a
+sample of the live stream from the fifo. Killing ether the application or dd
+will stop the capturing process.
+
+. `./configure --enable-pcapng-support`
+. `sudo mkdir /var/run/odp`
+. `sudo ./example/generator/odp_generator -I enp2s0 -mu --dstmac
+A0:F6:FD:AE:62:6C --dstip 192.168.49.20 --srcmac 2c:56:dc:9a:8f:06 --srcip
+192.168.49.4 -i0 -w1`
+. `sudo dd if=/var/run/odp/26737-enp2s0-flow-0 of=~/test.pcap`
+. `ctrl^c`
+. `wireshark ~/test.pcap`
diff --git a/doc/users-guide/users-guide.adoc b/doc/users-guide/users-guide.adoc
index 7914459e6..8ed581f57 100644
--- a/doc/users-guide/users-guide.adoc
+++ b/doc/users-guide/users-guide.adoc
@@ -1204,4 +1204,6 @@ include::users-guide-tm.adoc[]
include::users-guide-cls.adoc[]
+include::users-guide-utilities-examples.adoc[]
+
include::../glossary.adoc[]