FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
l2_output_acl.c
Go to the documentation of this file.
1 /*
2  * l2_output_acl.c : layer 2 output acl processing
3  *
4  * Copyright (c) 2013 Cisco and/or its affiliates.
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at:
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #include <vlib/vlib.h>
19 #include <vnet/vnet.h>
20 #include <vnet/pg/pg.h>
21 #include <vnet/ethernet/ethernet.h>
22 #include <vnet/ethernet/packet.h>
23 #include <vnet/ip/ip_packet.h>
24 #include <vnet/ip/ip4_packet.h>
25 #include <vnet/ip/ip6_packet.h>
26 #include <vlib/cli.h>
27 #include <vnet/l2/feat_bitmap.h>
28 #include <vnet/l2/l2_output.h>
29 
30 #include <vppinfra/error.h>
31 #include <vppinfra/hash.h>
32 #include <vppinfra/cache.h>
33 
34 
35 typedef struct
36 {
37  /* Next nodes for L2 output features */
38  u32 l2_out_feat_next[32];
39 
40  /* convenience variables */
44 
45 
46 
47 typedef struct
48 {
49  /* per-pkt trace data */
50  u8 src[6];
51  u8 dst[6];
55 
56 /* packet trace format function */
57 static u8 *
58 format_l2_outacl_trace (u8 * s, va_list * args)
59 {
60  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
61  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
62  l2_outacl_trace_t *t = va_arg (*args, l2_outacl_trace_t *);
63 
64  s = format (s, "l2-output-acl: sw_if_index %d dst %U src %U",
65  t->sw_if_index,
68  return s;
69 }
70 
72 
74 
75 #define foreach_l2_outacl_error \
76 _(L2_OUTACL, "L2 output ACL packets") \
77 _(DROP, "L2 output drops")
78 
79 typedef enum
80 {
81 #define _(sym,str) L2_OUTACL_ERROR_##sym,
83 #undef _
86 
87 static char *l2_outacl_error_strings[] = {
88 #define _(sym,string) string,
90 #undef _
91 };
92 
93 typedef enum
94 {
98 
99 
100 
101 static uword
103  vlib_node_runtime_t * node, vlib_frame_t * frame)
104 {
105  u32 n_left_from, *from, *to_next;
106  l2_outacl_next_t next_index;
108  vlib_node_t *n = vlib_get_node (vm, l2_outacl_node.index);
109  u32 node_counter_base_index = n->error_heap_index;
110  vlib_error_main_t *em = &vm->error_main;
111 
112  from = vlib_frame_vector_args (frame);
113  n_left_from = frame->n_vectors; /* number of packets to process */
114  next_index = node->cached_next_index;
115 
116  while (n_left_from > 0)
117  {
118  u32 n_left_to_next;
119 
120  /* get space to enqueue frame to graph node "next_index" */
121  vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
122 
123  while (0 && n_left_from >= 4 && n_left_to_next >= 2)
124  {
125  u32 bi0, bi1;
126  vlib_buffer_t *b0, *b1;
127  u32 next0, next1;
128  u32 sw_if_index0, sw_if_index1;
129  ethernet_header_t *h0, *h1;
130 
131  /* Prefetch next iteration. */
132  {
133  vlib_buffer_t *p2, *p3;
134 
135  p2 = vlib_get_buffer (vm, from[2]);
136  p3 = vlib_get_buffer (vm, from[3]);
137 
138  vlib_prefetch_buffer_header (p2, LOAD);
139  vlib_prefetch_buffer_header (p3, LOAD);
140 
143  }
144 
145  /* speculatively enqueue b0 and b1 to the current next frame */
146  /* bi is "buffer index", b is pointer to the buffer */
147  to_next[0] = bi0 = from[0];
148  to_next[1] = bi1 = from[1];
149  from += 2;
150  to_next += 2;
151  n_left_from -= 2;
152  n_left_to_next -= 2;
153 
154  b0 = vlib_get_buffer (vm, bi0);
155  b1 = vlib_get_buffer (vm, bi1);
156 
157  /* TX interface handles */
158  sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
159  sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_TX];
160 
161  if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
162  {
163  if (b0->flags & VLIB_BUFFER_IS_TRACED)
164  {
165  l2_outacl_trace_t *t =
166  vlib_add_trace (vm, node, b0, sizeof (*t));
167  t->sw_if_index = sw_if_index0;
168  t->next_index = next0;
169  clib_memcpy (t->src, h0->src_address, 6);
170  clib_memcpy (t->dst, h0->dst_address, 6);
171  }
172  if (b1->flags & VLIB_BUFFER_IS_TRACED)
173  {
174  l2_outacl_trace_t *t =
175  vlib_add_trace (vm, node, b1, sizeof (*t));
176  t->sw_if_index = sw_if_index1;
177  t->next_index = next1;
178  clib_memcpy (t->src, h1->src_address, 6);
179  clib_memcpy (t->dst, h1->dst_address, 6);
180  }
181  }
182 
183  em->counters[node_counter_base_index + L2_OUTACL_ERROR_L2_OUTACL] +=
184  2;
185 
186  /* add core loop code here */
187 
188  /* verify speculative enqueues, maybe switch current next frame */
189  /* if next0==next1==next_index then nothing special needs to be done */
190  vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
191  to_next, n_left_to_next,
192  bi0, bi1, next0, next1);
193  }
194 
195  while (n_left_from > 0 && n_left_to_next > 0)
196  {
197  u32 bi0;
198  vlib_buffer_t *b0;
199  u32 next0;
200  u32 sw_if_index0;
201  ethernet_header_t *h0;
202 
203  /* speculatively enqueue b0 to the current next frame */
204  bi0 = from[0];
205  to_next[0] = bi0;
206  from += 1;
207  to_next += 1;
208  n_left_from -= 1;
209  n_left_to_next -= 1;
210 
211  b0 = vlib_get_buffer (vm, bi0);
212  h0 = vlib_buffer_get_current (b0);
213 
214  sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
215 
217  && (b0->flags & VLIB_BUFFER_IS_TRACED)))
218  {
219  l2_outacl_trace_t *t =
220  vlib_add_trace (vm, node, b0, sizeof (*t));
221  t->sw_if_index = sw_if_index0;
222  clib_memcpy (t->src, h0->src_address, 6);
223  clib_memcpy (t->dst, h0->dst_address, 6);
224  }
225 
226  em->counters[node_counter_base_index + L2_OUTACL_ERROR_L2_OUTACL] +=
227  1;
228 
229  /*
230  * L2_OUTACL code
231  * Dummy for now, just go to next feature node
232  */
233 
234  /* Determine next node */
235  next0 = vnet_l2_feature_next (b0, msm->l2_out_feat_next,
236  L2OUTPUT_FEAT_ACL);
237 
238  /* verify speculative enqueue, maybe switch current next frame */
239  vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
240  to_next, n_left_to_next,
241  bi0, next0);
242  }
243 
244  vlib_put_next_frame (vm, node, next_index, n_left_to_next);
245  }
246 
247  return frame->n_vectors;
248 }
249 
250 
251 /* *INDENT-OFF* */
253  .function = l2_outacl_node_fn,
254  .name = "l2-output-acl",
255  .vector_size = sizeof (u32),
256  .format_trace = format_l2_outacl_trace,
257  .type = VLIB_NODE_TYPE_INTERNAL,
258 
259  .n_errors = ARRAY_LEN(l2_outacl_error_strings),
260  .error_strings = l2_outacl_error_strings,
261 
262  .n_next_nodes = L2_OUTACL_N_NEXT,
263 
264  /* edit / add dispositions here */
265  .next_nodes = {
266  [L2_OUTACL_NEXT_DROP] = "error-drop",
267  },
268 };
269 /* *INDENT-ON* */
270 
273 {
275 
276  mp->vlib_main = vm;
277  mp->vnet_main = vnet_get_main ();
278 
279  /* Initialize the feature next-node indexes */
281  l2_outacl_node.index,
284  mp->l2_out_feat_next);
285 
286  return 0;
287 }
288 
290 
291 #if 0
292 /** @todo maybe someone will add output ACL's in the future.
293  * Set subinterface outacl enable/disable.
294  * The CLI format is:
295  * set interface acl output <interface> [disable]
296  */
297 static clib_error_t *
298 int_l2_outacl (vlib_main_t * vm,
299  unformat_input_t * input, vlib_cli_command_t * cmd)
300 {
301  vnet_main_t *vnm = vnet_get_main ();
302  clib_error_t *error = 0;
303  u32 sw_if_index;
304  u32 enable;
305 
306  if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
307  {
308  error = clib_error_return (0, "unknown interface `%U'",
309  format_unformat_error, input);
310  goto done;
311  }
312 
313  enable = 1;
314  if (unformat (input, "disable"))
315  {
316  enable = 0;
317  }
318 
319  /* set the interface flag */
320  l2output_intf_bitmap_enable (sw_if_index, L2OUTPUT_FEAT_ACL, enable);
321 
322 done:
323  return error;
324 }
325 
326 /* *INDENT-OFF* */
327 VLIB_CLI_COMMAND (int_l2_outacl_cli, static) = {
328  .path = "set interface acl output",
329  .short_help = "set interface acl output <interface> [disable]",
330  .function = int_l2_outacl,
331 };
332 /* *INDENT-ON* */
333 #endif
334 
335 /*
336  * fd.io coding-style-patch-verification: ON
337  *
338  * Local Variables:
339  * eval: (c-set-style "gnu")
340  * End:
341  */
vlib_main_t * vlib_main
Definition: l2_output_acl.c:41
u32 error_heap_index
Definition: node.h:278
#define CLIB_UNUSED(x)
Definition: clib.h:79
char ** l2output_get_feat_names(void)
Definition: l2_output.c:38
vnet_main_t * vnet_get_main(void)
Definition: misc.c:47
l2_outacl_next_t
Definition: l2_output_acl.c:93
u8 src_address[6]
Definition: packet.h:54
struct _vlib_node_registration vlib_node_registration_t
uword unformat_user(unformat_input_t *input, unformat_function_t *func,...)
Definition: unformat.c:983
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
unformat_function_t unformat_vnet_sw_interface
static uword l2_outacl_node_fn(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
static u32 vnet_l2_feature_next(vlib_buffer_t *b, u32 *next_nodes, u32 feat_bit)
Return the graph node index for the feature corresponding to the next set bit after clearing the curr...
Definition: feat_bitmap.h:94
u8 * format_ethernet_address(u8 *s, va_list *args)
Definition: format.c:44
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:111
u8 dst_address[6]
Definition: packet.h:53
#define vlib_prefetch_buffer_header(b, type)
Prefetch buffer metadata.
Definition: buffer.h:171
#define clib_error_return(e, args...)
Definition: error.h:99
void l2output_intf_bitmap_enable(u32 sw_if_index, u32 feature_bitmap, u32 enable)
Enable (or disable) the feature in the bitmap for the given interface.
Definition: l2_output.c:686
vlib_error_main_t error_main
Definition: main.h:138
struct _unformat_input_t unformat_input_t
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:195
#define PREDICT_FALSE(x)
Definition: clib.h:105
#define vlib_validate_buffer_enqueue_x2(vm, node, next_index, to_next, n_left_to_next, bi0, bi1, next0, next1)
Finish enqueueing two buffers forward in the graph.
Definition: buffer_node.h:70
#define vlib_validate_buffer_enqueue_x1(vm, node, next_index, to_next, n_left_to_next, bi0, next0)
Finish enqueueing one buffer forward in the graph.
Definition: buffer_node.h:218
#define vlib_get_next_frame(vm, node, next_index, vectors, n_vectors_left)
Get pointer to next frame vector data by (vlib_node_runtime_t, next_index).
Definition: node_funcs.h:364
u64 * counters
Definition: error.h:78
static vlib_node_registration_t l2_outacl_node
(constructor) VLIB_REGISTER_NODE (l2_outacl_node)
Definition: l2_output_acl.c:73
u16 n_vectors
Definition: node.h:344
#define CLIB_PREFETCH(addr, size, type)
Definition: cache.h:82
vlib_main_t * vm
Definition: buffer.c:283
static u8 * format_l2_outacl_trace(u8 *s, va_list *args)
Definition: l2_output_acl.c:58
static void feat_bitmap_init_next_nodes(vlib_main_t *vm, u32 node_index, u32 num_features, char **feat_names, u32 *next_nodes)
Initialize the feature next-node indexes of a graph node.
Definition: feat_bitmap.h:43
#define VLIB_BUFFER_IS_TRACED
Definition: buffer.h:93
#define clib_memcpy(a, b, c)
Definition: string.h:75
#define ARRAY_LEN(x)
Definition: clib.h:59
void vlib_put_next_frame(vlib_main_t *vm, vlib_node_runtime_t *r, u32 next_index, u32 n_vectors_left)
Release pointer to next frame vector data.
Definition: main.c:454
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:154
l2_outacl_error_t
Definition: l2_output_acl.c:79
u16 cached_next_index
Next frame index that vector arguments were last enqueued to last time this node ran.
Definition: node.h:456
unsigned int u32
Definition: types.h:88
#define VLIB_NODE_FLAG_TRACE
Definition: node.h:259
u64 uword
Definition: types.h:112
static void * vlib_add_trace(vlib_main_t *vm, vlib_node_runtime_t *r, vlib_buffer_t *b, u32 n_data_bytes)
Definition: trace_funcs.h:55
Definition: defs.h:47
clib_error_t * l2_outacl_init(vlib_main_t *vm)
unsigned char u8
Definition: types.h:56
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:267
static char * l2_outacl_error_strings[]
Definition: l2_output_acl.c:87
#define vnet_buffer(b)
Definition: buffer.h:326
#define VLIB_NODE_FUNCTION_MULTIARCH(node, fn)
Definition: node.h:158
u8 * format_unformat_error(u8 *s, va_list *va)
Definition: unformat.c:91
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:143
vnet_main_t * vnet_main
Definition: l2_output_acl.c:42
l2_outacl_main_t l2_outacl_main
Definition: l2_output_acl.c:71
u8 data[0]
Packet data.
Definition: buffer.h:159
static vlib_node_t * vlib_get_node(vlib_main_t *vm, u32 i)
Get vlib node by index.
Definition: node_funcs.h:59
u16 flags
Copy of main node flags.
Definition: node.h:450
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:67
u32 flags
buffer flags: VLIB_BUFFER_FREE_LIST_INDEX_MASK: bits used to store free list index, VLIB_BUFFER_IS_TRACED: trace this buffer.
Definition: buffer.h:75
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:57
u32 l2_out_feat_next[32]
Definition: l2_output_acl.c:38
#define foreach_l2_outacl_error
Definition: l2_output_acl.c:75
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:972