summaryrefslogtreecommitdiffstats
path: root/extras/gomemif/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'extras/gomemif/README.rst')
-rw-r--r--extras/gomemif/README.rst50
1 files changed, 50 insertions, 0 deletions
diff --git a/extras/gomemif/README.rst b/extras/gomemif/README.rst
new file mode 100644
index 00000000000..18f382893c9
--- /dev/null
+++ b/extras/gomemif/README.rst
@@ -0,0 +1,50 @@
+.. _gomemif_doc:
+
+Gomemif library
+=======================
+
+Memif library implemented in Go. The package contains 3 examples: Bridge and ICMP responder in interrupt and polling mode.
+
+setup and run
+-------------
+To Build all examples
+
+::
+
+ bazel build //...
+
+To Run ICMP responder in interrupt mode:
+
+::
+
+ DBGvpp# create interface memif id 0 master no-zero-copy
+ DBGvpp# set int ip addr memif0/0 192.168.1.2/24
+ DBGvpp# set int state memif0/0 up
+
+ bazel-bin/examples/linux_amd64_stripped/icmp_responder_cb
+ gomemif# start
+
+ DBGvpp# ping 192.168.1.1
+
+To Run ICMP responder in polling mode:
+
+::
+
+ DBGvpp# create interface memif id 0 master no-zero-copy
+ DBGvpp# set int ip addr memif0/0 192.168.1.2/24
+ DBGvpp# set int state memif0/0 up
+
+ bazel-bin/examples/linux_amd64_stripped/icmp_responder_poll
+ gomemif# start
+
+ DBGvpp# ping 192.168.1.1
+
+To Run Bridge:
+
+::
+
+ bazel-bin/examples/linux_amd64_stripped/bridge
+ gomemif# start
+
+
+