summaryrefslogtreecommitdiffstats
path: root/extras/emacs/pipe-skel.el
blob: bfae58dc92260892241b8f6c8cc4af20582183c5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
;;; Copyright (c) 2016 Cisco and/or its affiliates.
;;; Licensed under the Apache License, Version 2.0 (the "License");
;;; you may not use this file except in compliance with the License.
;;; You may obtain a copy of the License at:
;;;
;;;     http://www.apache.org/licenses/LICENSE-2.0
;;;
;;; Unless required by applicable law or agreed to in writing, software
;;; distributed under the License is distributed on an "AS IS" BASIS,
;;; WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
;;; See the License for the specific language governing permissions and
;;; limitations under the License.

;;; pipe-skel.el - pipelined graph node skeleton

(require 'skeleton)

(define-skeleton skel-pipeline-node
"Insert a skeleton pipelined graph node"
nil
'(setq node-name (skeleton-read "Node Name: "))
'(setq uc-node-name (upcase node-name))
'(setq nstages (skeleton-read "Number of pipeline stages: "))
"
#include <vlib/vlib.h>
#include <vppinfra/error.h>

/*
 * Dump these counters via the \"show error\" CLI command 
 * FIXME: Add packet counter / error strings as desired
 */

#define foreach_" node-name "_error \\
_(ERROR1, \"sample counter/ error string\")

static char * " node-name "_error_strings[] = {
#define _(sym,string) string,
  foreach_" node-name "_error
#undef _
};

/*
 * packet error / counter enumeration
 *
 * To count and drop a vlib_buffer_t *b:
 *
 *     Set b->error = node->errors[" uc-node-name "_ERROR_xxx];
 *     last_stage returns a disposition index bound to \"error-drop\"
 * 
 * To manually increment the specific counter " uc-node-name "_ERROR1
 *
 *  vlib_node_t *n = vlib_get_node (vm, " node-name ".index);
 *  u32 node_counter_base_index = n->error_heap_index;
 *  vlib_error_main_t * em = &vm->error_main;
 *  em->counters[node_counter_base_index + " uc-node-name "_ERROR1] += 1;
 * 
 */

typedef enum {
#define _(sym,str) " uc-node-name "_ERROR_##sym,
    foreach_" node-name "_error
#undef _
    " uc-node-name "_N_ERROR,
} " node-name "_error_t;

/*
 * enumeration of per-packet dispositions
 * FIXME: add dispositions as desired
 */

typedef enum { \n"
"    " uc-node-name "_NEXT_NORMAL,\n"
"    " uc-node-name "_N_NEXT,
} " node-name "_next_t;

#define NSTAGES " nstages "

/* 
 * Use the generic buffer metadata + first line of packet data prefetch
 * stage function from <api/pipeline.h>. This is usually a Good Idea.
 */
#define stage0 generic_stage0

/* 
 * FIXME: add stage functions. Here is the function prototype:
 * 
 * static inline void stageN (vlib_main_t * vm,
 *                            vlib_node_runtime_t * node,
 *                            u32 buffer_index)
 */

/*
 * FIXME: the last pipeline stage returns the desired pkt next node index,
 * from the " node-name "_next_t enum above
 */
static inline u32 last_stage (vlib_main_t *vm, vlib_node_runtime_t *node,
                              u32 bi)
{
    vlib_buffer_t *b = vlib_get_buffer (vm, bi);

    b->error = node->errors[EXAMPLE_ERROR_ERROR1];

    return " uc-node-name "_NEXT_NORMAL;
}

#include <api/pipeline.h>

static uword " node-name "_node_fn (vlib_main_t * vm,
                              vlib_node_runtime_t * node,
                              vlib_frame_t * frame)
{
    return dispatch_pipeline (vm, node, frame);
}

static VLIB_REGISTER_NODE (example_node) = {
  .function = " node-name "_node_fn,
  .name = \"" node-name "-node\",
  .vector_size = sizeof (u32),
  .type = VLIB_NODE_TYPE_INTERNAL,
  
  .n_errors = ARRAY_LEN(" node-name "_error_strings),
  .error_strings = " node-name "_error_strings,

  .n_next_nodes = " uc-node-name "_N_NEXT,

  /* edit / add dispositions here */
  .next_nodes = {
        [" uc-node-name "_NEXT_NORMAL] = \"error-drop\",
  },
};

/* 
 * packet generator definition to push superframes of data into the
 * new graph node. Cut and paste into <file>, then
 * \"exec <file>\", \"pa enable test\" at the QVNET prompt...
 * 
packet-generator new {
  name test
  limit 100
  node " node-name "-node
  size 374-374
  data { hex 0x02b46b96000100096978676265000500bf436973636f20494f5320536f6674776172652c2043333735304520536f66747761726520284333373530452d554e4956455253414c2d4d292c2056657273696f6e2031322e32283335295345352c2052454c4541534520534f4654574152452028666331290a436f707972696768742028632920313938362d3230303720627920436973636f2053797374656d732c20496e632e0a436f6d70696c6564205468752031392d4a756c2d30372031363a3137206279206e616368656e00060018636973636f2057532d4333373530452d3234544400020011000000010101cc0004000000000003001b54656e4769676162697445746865726e6574312f302f3100040008000000280008002400000c011200000000ffffffff010221ff000000000000001e7a50f000ff000000090004000a00060001000b0005010012000500001300050000160011000000010101cc000400000000001a00100000000100000000ffffffff }
}
 */
")
p"> | ... | Documentation | *RFC2544: Pkt throughput IPv4 IPsec tunnel mode.* | ... | ... | *[Top] Network Topologies:* TG-DUT1-DUT2-TG 3-node circular topology | ... | with single links between nodes. | ... | *[Enc] Packet Encapsulations:* Eth-IPv4 on TG-DUTn, | ... | Eth-IPv4-IPSec on DUT1-DUT2 | ... | *[Cfg] DUT configuration:* DUT1 and DUT2 are configured with multiple | ... | IPsec tunnels between them. DUTs get IPv4 traffic from TG, encrypt it | ... | and send to another DUT, where packets are decrypted and sent back to TG | ... | *[Ver] TG verification:* TG finds and reports throughput NDR (Non Drop\ | ... | Rate) with zero packet loss tolerance and throughput PDR (Partial Drop\ | ... | Rate) with non-zero packet loss tolerance (LT) expressed in percentage\ | ... | of packets transmitted. NDR and PDR are discovered for different\ | ... | Ethernet L2 frame sizes using MLRsearch library.\ | ... | Test packets are generated by TG on | ... | links to DUTs. TG traffic profile contains two L3 flow-groups | ... | (flow-group per direction, number of flows per flow-group equals to | ... | number of IPSec tunnels) with all packets | ... | containing Ethernet header, IPv4 header with IP protocol=61 and | ... | static payload. MAC addresses are matching MAC addresses of the TG | ... | node interfaces. Incrementing of IP.dst (IPv4 destination address) field | ... | is applied to both streams. | ... | *[Ref] Applicable standard specifications:* RFC4303 and RFC2544. *** Variables *** | ${nic_name}= | Intel-X710 | ${overhead}= | ${54} | ${tg_if1_ip4}= | 192.168.10.2 | ${dut1_if1_ip4}= | 192.168.10.1 | ${dut1_if2_ip4}= | 100.0.0.1 | ${dut2_if1_ip4}= | 100.0.0.2 | ${dut2_if2_ip4}= | 192.168.20.1 | ${tg_if2_ip4}= | 192.168.20.2 | ${raddr_ip4}= | 20.0.0.0 | ${laddr_ip4}= | 10.0.0.0 | ${addr_range}= | ${24} | ${n_tunnels}= | ${1000} # Traffic profile: | ${traffic_profile}= | trex-sl-3n-ethip4-ip4dst${n_tunnels} *** Keywords *** | Local Template | | [Documentation] | | ... | [Cfg] DUT runs IPSec tunneling AES_128_GCM config. | | ... | Each DUT uses ${phy_cores} physical core(s) for worker threads. | | ... | [Ver] Measure NDR and PDR values using MLRsearch algorithm.\ | | ... | | ... | *Arguments:* | | ... | - frame_size - Framesize in Bytes in integer or string (IMIX_v4_1). | | ... | Type: integer, string | | ... | - phy_cores - Number of physical cores. Type: integer | | ... | - rxq - Number of RX queues, default value: ${None}. Type: integer | | ... | | [Arguments] | ${frame_size} | ${phy_cores} | ${rxq}=${None} | | ... | | Set Test Variable | \${frame_size} | | ... | | # These are enums (not strings) so they cannot be in Variables table. | | ${encr_alg}= | Crypto Alg AES GCM 128 | | ${auth_alg}= | Integ Alg AES GCM 128 | | ${ipsec_proto}= | IPsec Proto ESP | | ... | | Given Add worker threads and rxqueues to all DUTs | ${phy_cores} | ${rxq} | | And Add PCI devices to all DUTs | | Set Max Rate And Jumbo And Handle Multi Seg | | And Add cryptodev to all DUTs | ${phy_cores} | | And Apply startup configuration on all VPP DUTs | | And VPP IPsec Select Backend | ${dut1} | ${ipsec_proto} | index=${1} | | And VPP IPsec Select Backend | ${dut2} | ${ipsec_proto} | index=${1} | | And Initialize IPSec in 3-node circular topology | | And VPP IPsec Create Tunnel Interfaces | | ... | ${nodes} | ${dut1_if2_ip4} | ${dut2_if1_ip4} | ${dut1_if2} | | ... | ${dut2_if1} | ${n_tunnels} | ${encr_alg} | ${auth_alg} | | ... | ${laddr_ip4} | ${raddr_ip4} | ${addr_range} | | Then Find NDR and PDR intervals using optimized search *** Test Cases *** | tc01-64B-1c-ethip4ipsecscale1000tnl-ip4base-int-aes128gcm-ndrpdr | | [Tags] | 64B | 1C | | frame_size=${64} | phy_cores=${1} | tc02-64B-2c-ethip4ipsecscale1000tnl-ip4base-int-aes128gcm-ndrpdr | | [Tags] | 64B | 2C | | frame_size=${64} | phy_cores=${2} | tc03-64B-4c-ethip4ipsecscale1000tnl-ip4base-int-aes128gcm-ndrpdr | | [Tags] | 64B | 4C | | frame_size=${64} | phy_cores=${4} | tc04-1518B-1c-ethip4ipsecscale1000tnl-ip4base-int-aes128gcm-ndrpdr | | [Tags] | 1518B | 1C | | frame_size=${1518} | phy_cores=${1} | tc05-1518B-2c-ethip4ipsecscale1000tnl-ip4base-int-aes128gcm-ndrpdr | | [Tags] | 1518B | 2C | | frame_size=${1518} | phy_cores=${2} | tc06-1518B-4c-ethip4ipsecscale1000tnl-ip4base-int-aes128gcm-ndrpdr | | [Tags] | 1518B | 4C | | frame_size=${1518} | phy_cores=${4} | tc07-9000B-1c-ethip4ipsecscale1000tnl-ip4base-int-aes128gcm-ndrpdr | | [Tags] | 9000B | 1C | | frame_size=${9000} | phy_cores=${1} | tc08-9000B-2c-ethip4ipsecscale1000tnl-ip4base-int-aes128gcm-ndrpdr | | [Tags] | 9000B | 2C | | frame_size=${9000} | phy_cores=${2} | tc09-9000B-4c-ethip4ipsecscale1000tnl-ip4base-int-aes128gcm-ndrpdr | | [Tags] | 9000B | 4C | | frame_size=${9000} | phy_cores=${4} | tc10-IMIX-1c-ethip4ipsecscale1000tnl-ip4base-int-aes128gcm-ndrpdr | | [Tags] | IMIX | 1C | | frame_size=IMIX_v4_1 | phy_cores=${1} | tc11-IMIX-2c-ethip4ipsecscale1000tnl-ip4base-int-aes128gcm-ndrpdr | | [Tags] | IMIX | 2C | | frame_size=IMIX_v4_1 | phy_cores=${2} | tc12-IMIX-4c-ethip4ipsecscale1000tnl-ip4base-int-aes128gcm-ndrpdr | | [Tags] | IMIX | 4C | | frame_size=IMIX_v4_1 | phy_cores=${4}