examples/pipeline: add packet mirroring example

Add example program to illustrate packet mirroring.

Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>

diff --git a/examples/pipeline/examples/mirroring.cli b/examples/pipeline/examples/mirroring.cli
new file mode 100644 (file)
index 0000000..46d57db
--- /dev/null
+++ b/examples/pipeline/examples/mirroring.cli
@@ -0,0 +1,43 @@
+; SPDX-License-Identifier: BSD-3-Clause
+; Copyright(c) 2022 Intel Corporation
+
+;
+; Customize the LINK parameters to match your setup.
+;
+mempool MEMPOOL0 buffer 2304 pool 32K cache 256 cpu 0
+
+link LINK0 dev 0000:18:00.0 rxq 1 128 MEMPOOL0 txq 1 512 promiscuous on
+link LINK1 dev 0000:18:00.1 rxq 1 128 MEMPOOL0 txq 1 512 promiscuous on
+link LINK2 dev 0000:3b:00.0 rxq 1 128 MEMPOOL0 txq 1 512 promiscuous on
+link LINK3 dev 0000:3b:00.1 rxq 1 128 MEMPOOL0 txq 1 512 promiscuous on
+
+;
+; PIPELINE0 setup.
+;
+pipeline PIPELINE0 create 0
+pipeline PIPELINE0 mirror slots 4 sessions 16
+
+pipeline PIPELINE0 port in 0 link LINK0 rxq 0 bsz 32
+pipeline PIPELINE0 port in 1 link LINK1 rxq 0 bsz 32
+pipeline PIPELINE0 port in 2 link LINK2 rxq 0 bsz 32
+pipeline PIPELINE0 port in 3 link LINK3 rxq 0 bsz 32
+
+pipeline PIPELINE0 port out 0 link LINK0 txq 0 bsz 32
+pipeline PIPELINE0 port out 1 link LINK1 txq 0 bsz 32
+pipeline PIPELINE0 port out 2 link LINK2 txq 0 bsz 32
+pipeline PIPELINE0 port out 3 link LINK3 txq 0 bsz 32
+
+pipeline PIPELINE0 build ./examples/pipeline/examples/mirroring.spec
+
+;
+; Packet mirroring sessions.
+;
+pipeline PIPELINE0 mirror session 0 port 1 clone fast truncate 0
+pipeline PIPELINE0 mirror session 1 port 2 clone slow truncate 0
+pipeline PIPELINE0 mirror session 2 port 3 clone slow truncate 64
+pipeline PIPELINE0 mirror session 3 port 0 clone slow truncate 128
+
+;
+; Pipelines-to-threads mapping.
+;
+thread 1 pipeline PIPELINE0 enable

diff --git a/examples/pipeline/examples/mirroring.spec b/examples/pipeline/examples/mirroring.spec
new file mode 100644 (file)
index 0000000..024e3ef
--- /dev/null
+++ b/examples/pipeline/examples/mirroring.spec
@@ -0,0 +1,80 @@
+; SPDX-License-Identifier: BSD-3-Clause
+; Copyright(c) 2022 Intel Corporation
+
+; This simple example illustrates how to perform packet mirroring. The "mirror" instruction is used
+; to flag the current packet for mirroring, which means that at TX time, before the current packet
+; is sent out, it will first be cloned (using either the fast or the slow/deep cloning method) and
+; the clone packet sent out on the output port specified by the mirror session.
+;
+; In this example, the UDP packets with destination port 5000 are mirrored to the output port
+; specified by the mirror session 0, while the rest of the packets are not mirrored. Therefore, for
+; every UDP input packet with this specific destination port there will be two output packets (the
+; current packet and its clone packet), while for every other input packet there will be a single
+; output packet.
+
+//
+// Headers
+//
+struct ethernet_h {
+       bit<48> dst_addr
+       bit<48> src_addr
+       bit<16> ethertype
+}
+
+struct ipv4_h {
+       bit<8> ver_ihl
+       bit<8> diffserv
+       bit<16> total_len
+       bit<16> identification
+       bit<16> flags_offset
+       bit<8> ttl
+       bit<8> protocol
+       bit<16> hdr_checksum
+       bit<32> src_addr
+       bit<32> dst_addr
+}
+
+struct udp_h {
+       bit<16> src_port
+       bit<16> dst_port
+       bit<16> length
+       bit<16> checksum
+}
+
+header ethernet instanceof ethernet_h
+header ipv4 instanceof ipv4_h
+header udp instanceof udp_h
+
+//
+// Meta-data.
+//
+struct metadata_t {
+       bit<32> port
+       bit<32> mirror_slot
+       bit<32> mirror_session
+}
+
+metadata instanceof metadata_t
+
+//
+// Pipeline.
+//
+apply {
+       rx m.port
+       extract h.ethernet
+       extract h.ipv4
+       extract h.udp
+
+       //
+       // Mark for mirroring all packets with UDP destination port of 5000.
+       //
+       MIRROR_UDP_DST_PORT_5000 : jmpneq EMIT h.udp.dst_port 5000
+       mov m.mirror_slot 0
+       mov m.mirror_session 0
+       mirror m.mirror_slot m.mirror_session
+
+       EMIT : emit h.ethernet
+       emit h.ipv4
+       emit h.udp
+       tx m.port
+}