1 ;;; plugin-node-skel.el - vpp engine plug-in "node.c" skeleton
3 ;;; Copyright (c) 2016 Cisco and/or its affiliates.
4 ;;; Licensed under the Apache License, Version 2.0 (the "License");
5 ;;; you may not use this file except in compliance with the License.
6 ;;; You may obtain a copy of the License at:
8 ;;; http://www.apache.org/licenses/LICENSE-2.0
10 ;;; Unless required by applicable law or agreed to in writing, software
11 ;;; distributed under the License is distributed on an "AS IS" BASIS,
12 ;;; WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 ;;; See the License for the specific language governing permissions and
14 ;;; limitations under the License.
18 (define-skeleton skel-plugin-node
19 "Insert a plug-in 'node.c' skeleton "
21 '(if (not (boundp 'plugin-name))
22 (setq plugin-name (read-string "Plugin name: ")))
23 '(setq PLUGIN-NAME (upcase plugin-name))
24 '(setq capital-oh-en "ON")
26 * node.c - skeleton vpp engine plug-in dual-loop node skeleton
28 * Copyright (c) <current-year> <your-organization>
29 * Licensed under the Apache License, Version 2.0 (the \"License\");
30 * you may not use this file except in compliance with the License.
31 * You may obtain a copy of the License at:
33 * http://www.apache.org/licenses/LICENSE-2.0
35 * Unless required by applicable law or agreed to in writing, software
36 * distributed under the License is distributed on an \"AS IS\" BASIS,
37 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
38 * See the License for the specific language governing permissions and
39 * limitations under the License.
41 #include <vlib/vlib.h>
42 #include <vnet/vnet.h>
43 #include <vnet/pg/pg.h>
44 #include <vppinfra/error.h>
45 #include <" plugin-name "/" plugin-name ".h>
53 } " plugin-name "_trace_t;
56 format_mac_address (u8 * s, va_list * args)
58 u8 *a = va_arg (*args, u8 *);
59 return format (s, \"%02x:%02x:%02x:%02x:%02x:%02x\",
60 a[0], a[1], a[2], a[3], a[4], a[5]);
63 /* packet trace format function */
64 static u8 * format_" plugin-name "_trace (u8 * s, va_list * args)
66 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
67 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
68 " plugin-name "_trace_t * t = va_arg (*args, " plugin-name "_trace_t *);
70 s = format (s, \"" PLUGIN-NAME ": sw_if_index %d, next index %d\\n\",
71 t->sw_if_index, t->next_index);
72 s = format (s, \" new src %U -> new dst %U\",
73 format_mac_address, t->new_src_mac,
74 format_mac_address, t->new_dst_mac);
78 vlib_node_registration_t " plugin-name "_node;
80 #define foreach_" plugin-name "_error \\
81 _(SWAPPED, \"Mac swap packets processed\")
84 #define _(sym,str) " PLUGIN-NAME "_ERROR_##sym,
85 foreach_" plugin-name "_error
87 " PLUGIN-NAME "_N_ERROR,
88 } " plugin-name "_error_t;
90 static char * " plugin-name "_error_strings[] = {
91 #define _(sym,string) string,
92 foreach_" plugin-name "_error
98 " PLUGIN-NAME "_NEXT_INTERFACE_OUTPUT,
99 " PLUGIN-NAME "_N_NEXT,
100 } " plugin-name "_next_t;
102 #define foreach_mac_address_offset \\
111 " plugin-name "_node_fn (vlib_main_t * vm,
112 vlib_node_runtime_t * node,
113 vlib_frame_t * frame)
115 u32 n_left_from, * from, * to_next;
116 " plugin-name "_next_t next_index;
117 u32 pkts_swapped = 0;
119 from = vlib_frame_vector_args (frame);
120 n_left_from = frame->n_vectors;
121 next_index = node->cached_next_index;
123 while (n_left_from > 0)
127 vlib_get_next_frame (vm, node, next_index,
128 to_next, n_left_to_next);
130 while (n_left_from >= 4 && n_left_to_next >= 2)
132 u32 next0 = " PLUGIN-NAME "_NEXT_INTERFACE_OUTPUT;
133 u32 next1 = " PLUGIN-NAME "_NEXT_INTERFACE_OUTPUT;
134 u32 sw_if_index0, sw_if_index1;
136 ethernet_header_t *en0, *en1;
138 vlib_buffer_t * b0, * b1;
140 /* Prefetch next iteration. */
142 vlib_buffer_t * p2, * p3;
144 p2 = vlib_get_buffer (vm, from[2]);
145 p3 = vlib_get_buffer (vm, from[3]);
147 vlib_prefetch_buffer_header (p2, LOAD);
148 vlib_prefetch_buffer_header (p3, LOAD);
150 CLIB_PREFETCH (p2->data, CLIB_CACHE_LINE_BYTES, STORE);
151 CLIB_PREFETCH (p3->data, CLIB_CACHE_LINE_BYTES, STORE);
154 /* speculatively enqueue b0 and b1 to the current next frame */
155 to_next[0] = bi0 = from[0];
156 to_next[1] = bi1 = from[1];
162 b0 = vlib_get_buffer (vm, bi0);
163 b1 = vlib_get_buffer (vm, bi1);
165 ASSERT (b0->current_data == 0);
166 ASSERT (b1->current_data == 0);
168 en0 = vlib_buffer_get_current (b0);
169 en1 = vlib_buffer_get_current (b1);
171 /* This is not the fastest way to swap src + dst mac addresses */
172 #define _(a) tmp0[a] = en0->src_address[a];
173 foreach_mac_address_offset;
175 #define _(a) en0->src_address[a] = en0->dst_address[a];
176 foreach_mac_address_offset;
178 #define _(a) en0->dst_address[a] = tmp0[a];
179 foreach_mac_address_offset;
182 #define _(a) tmp1[a] = en1->src_address[a];
183 foreach_mac_address_offset;
185 #define _(a) en1->src_address[a] = en1->dst_address[a];
186 foreach_mac_address_offset;
188 #define _(a) en1->dst_address[a] = tmp1[a];
189 foreach_mac_address_offset;
192 sw_if_index0 = vnet_buffer(b0)->sw_if_index[VLIB_RX];
193 sw_if_index1 = vnet_buffer(b1)->sw_if_index[VLIB_RX];
195 /* Send pkt back out the RX interface */
196 vnet_buffer(b0)->sw_if_index[VLIB_TX] = sw_if_index0;
197 vnet_buffer(b1)->sw_if_index[VLIB_TX] = sw_if_index1;
201 if (PREDICT_FALSE((node->flags & VLIB_NODE_FLAG_TRACE)))
203 if (b0->flags & VLIB_BUFFER_IS_TRACED)
205 " plugin-name "_trace_t *t =
206 vlib_add_trace (vm, node, b0, sizeof (*t));
207 t->sw_if_index = sw_if_index0;
208 t->next_index = next0;
209 clib_memcpy (t->new_src_mac, en0->src_address,
210 sizeof (t->new_src_mac));
211 clib_memcpy (t->new_dst_mac, en0->dst_address,
212 sizeof (t->new_dst_mac));
214 if (b1->flags & VLIB_BUFFER_IS_TRACED)
216 " plugin-name "_trace_t *t =
217 vlib_add_trace (vm, node, b1, sizeof (*t));
218 t->sw_if_index = sw_if_index1;
219 t->next_index = next1;
220 clib_memcpy (t->new_src_mac, en1->src_address,
221 sizeof (t->new_src_mac));
222 clib_memcpy (t->new_dst_mac, en1->dst_address,
223 sizeof (t->new_dst_mac));
227 /* verify speculative enqueues, maybe switch current next frame */
228 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
229 to_next, n_left_to_next,
230 bi0, bi1, next0, next1);
233 while (n_left_from > 0 && n_left_to_next > 0)
237 u32 next0 = " PLUGIN-NAME "_NEXT_INTERFACE_OUTPUT;
240 ethernet_header_t *en0;
242 /* speculatively enqueue b0 to the current next frame */
250 b0 = vlib_get_buffer (vm, bi0);
252 * Direct from the driver, we should be at offset 0
253 * aka at &b0->data[0]
255 ASSERT (b0->current_data == 0);
257 en0 = vlib_buffer_get_current (b0);
259 /* This is not the fastest way to swap src + dst mac addresses */
260 #define _(a) tmp0[a] = en0->src_address[a];
261 foreach_mac_address_offset;
263 #define _(a) en0->src_address[a] = en0->dst_address[a];
264 foreach_mac_address_offset;
266 #define _(a) en0->dst_address[a] = tmp0[a];
267 foreach_mac_address_offset;
270 sw_if_index0 = vnet_buffer(b0)->sw_if_index[VLIB_RX];
272 /* Send pkt back out the RX interface */
273 vnet_buffer(b0)->sw_if_index[VLIB_TX] = sw_if_index0;
275 if (PREDICT_FALSE((node->flags & VLIB_NODE_FLAG_TRACE)
276 && (b0->flags & VLIB_BUFFER_IS_TRACED))) {
277 " plugin-name "_trace_t *t =
278 vlib_add_trace (vm, node, b0, sizeof (*t));
279 t->sw_if_index = sw_if_index0;
280 t->next_index = next0;
281 clib_memcpy (t->new_src_mac, en0->src_address,
282 sizeof (t->new_src_mac));
283 clib_memcpy (t->new_dst_mac, en0->dst_address,
284 sizeof (t->new_dst_mac));
289 /* verify speculative enqueue, maybe switch current next frame */
290 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
291 to_next, n_left_to_next,
295 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
298 vlib_node_increment_counter (vm, " plugin-name "_node.index,
299 " PLUGIN-NAME "_ERROR_SWAPPED, pkts_swapped);
300 return frame->n_vectors;
304 VLIB_REGISTER_NODE (" plugin-name "_node) =
306 .function = " plugin-name "_node_fn,
307 .name = \"" plugin-name "\",
308 .vector_size = sizeof (u32),
309 .format_trace = format_" plugin-name "_trace,
310 .type = VLIB_NODE_TYPE_INTERNAL,
312 .n_errors = ARRAY_LEN(" plugin-name "_error_strings),
313 .error_strings = " plugin-name "_error_strings,
315 .n_next_nodes = " PLUGIN-NAME "_N_NEXT,
317 /* edit / add dispositions here */
319 [" PLUGIN-NAME "_NEXT_INTERFACE_OUTPUT] = \"interface-output\",
324 * fd.io coding-style-patch-verification: " capital-oh-en "
327 * eval: (c-set-style \"gnu\")