FD.io VPP  v18.10-34-gcce845e
Vector Packet Processing
ip4_whitelist.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 #include <vnet/cop/cop.h>
16 #include <vnet/fib/ip4_fib.h>
17 #include <vnet/dpo/load_balance.h>
18 
19 typedef struct {
23 
24 /* packet trace format function */
25 static u8 * format_ip4_cop_whitelist_trace (u8 * s, va_list * args)
26 {
27  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
28  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
30 
31  s = format (s, "IP4_COP_WHITELIST: sw_if_index %d, next index %d",
32  t->sw_if_index, t->next_index);
33  return s;
34 }
35 
37 
38 #define foreach_ip4_cop_whitelist_error \
39 _(DROPPED, "ip4 cop whitelist packets dropped")
40 
41 typedef enum {
42 #define _(sym,str) IP4_COP_WHITELIST_ERROR_##sym,
44 #undef _
47 
49 #define _(sym,string) string,
51 #undef _
52 };
53 
54 static uword
56  vlib_node_runtime_t * node,
57  vlib_frame_t * frame)
58 {
59  u32 n_left_from, * from, * to_next;
60  cop_feature_type_t next_index;
61  cop_main_t *cm = &cop_main;
63  u32 thread_index = vm->thread_index;
64 
65  from = vlib_frame_vector_args (frame);
66  n_left_from = frame->n_vectors;
67  next_index = node->cached_next_index;
68 
69  while (n_left_from > 0)
70  {
71  u32 n_left_to_next;
72 
73  vlib_get_next_frame (vm, node, next_index,
74  to_next, n_left_to_next);
75 
76  while (n_left_from >= 4 && n_left_to_next >= 2)
77  {
78  u32 bi0, bi1;
79  vlib_buffer_t * b0, * b1;
80  u32 next0, next1;
81  u32 sw_if_index0, sw_if_index1;
82  ip4_header_t * ip0, * ip1;
83  cop_config_main_t * ccm0, * ccm1;
84  cop_config_data_t * c0, * c1;
85  ip4_fib_mtrie_t * mtrie0, * mtrie1;
86  ip4_fib_mtrie_leaf_t leaf0, leaf1;
87  u32 lb_index0, lb_index1;
88  const load_balance_t * lb0, *lb1;
89  const dpo_id_t *dpo0, *dpo1;
90 
91  /* Prefetch next iteration. */
92  {
93  vlib_buffer_t * p2, * p3;
94 
95  p2 = vlib_get_buffer (vm, from[2]);
96  p3 = vlib_get_buffer (vm, from[3]);
97 
98  vlib_prefetch_buffer_header (p2, LOAD);
99  vlib_prefetch_buffer_header (p3, LOAD);
100 
103  }
104 
105  /* speculatively enqueue b0 and b1 to the current next frame */
106  to_next[0] = bi0 = from[0];
107  to_next[1] = bi1 = from[1];
108  from += 2;
109  to_next += 2;
110  n_left_from -= 2;
111  n_left_to_next -= 2;
112 
113  b0 = vlib_get_buffer (vm, bi0);
114  sw_if_index0 = vnet_buffer(b0)->sw_if_index[VLIB_RX];
115 
116  ip0 = vlib_buffer_get_current (b0);
117 
118  ccm0 = cm->cop_config_mains + VNET_COP_IP4;
119 
121  (&ccm0->config_main,
122  &vnet_buffer (b0)->cop.current_config_index,
123  &next0,
124  sizeof (c0[0]));
125 
126  mtrie0 = &ip4_fib_get (c0->fib_index)->mtrie;
127 
128  leaf0 = ip4_fib_mtrie_lookup_step_one (mtrie0, &ip0->src_address);
129 
130  leaf0 = ip4_fib_mtrie_lookup_step (mtrie0, leaf0,
131  &ip0->src_address, 2);
132 
133  leaf0 = ip4_fib_mtrie_lookup_step (mtrie0, leaf0,
134  &ip0->src_address, 3);
135 
136  lb_index0 = ip4_fib_mtrie_leaf_get_adj_index (leaf0);
137 
138  ASSERT (lb_index0
140  &ip0->src_address));
141  lb0 = load_balance_get (lb_index0);
142  dpo0 = load_balance_get_bucket_i(lb0, 0);
143 
144  if (PREDICT_FALSE(dpo0->dpoi_type != DPO_RECEIVE))
145  {
146  b0->error = node->errors[IP4_COP_WHITELIST_ERROR_DROPPED];
147  next0 = RX_COP_DROP;
148  }
149 
150  b1 = vlib_get_buffer (vm, bi1);
151  sw_if_index1 = vnet_buffer(b1)->sw_if_index[VLIB_RX];
152 
153  ip1 = vlib_buffer_get_current (b1);
154 
155  ccm1 = cm->cop_config_mains + VNET_COP_IP4;
156 
158  (&ccm1->config_main,
159  &vnet_buffer (b1)->cop.current_config_index,
160  &next1,
161  sizeof (c1[0]));
162  mtrie1 = &ip4_fib_get (c1->fib_index)->mtrie;
163 
164  leaf1 = ip4_fib_mtrie_lookup_step_one (mtrie1, &ip1->src_address);
165 
166  leaf1 = ip4_fib_mtrie_lookup_step (mtrie1, leaf1,
167  &ip1->src_address, 2);
168 
169  leaf1 = ip4_fib_mtrie_lookup_step (mtrie1, leaf1,
170  &ip1->src_address, 3);
171 
172  lb_index1 = ip4_fib_mtrie_leaf_get_adj_index (leaf1);
173  ASSERT (lb_index1
175  &ip1->src_address));
176  lb1 = load_balance_get (lb_index1);
177  dpo1 = load_balance_get_bucket_i(lb1, 0);
178 
180  (vcm, thread_index, lb_index0, 1,
182  + sizeof(ethernet_header_t));
183 
185  (vcm, thread_index, lb_index1, 1,
187  + sizeof(ethernet_header_t));
188 
189 
190  if (PREDICT_FALSE(dpo1->dpoi_type != DPO_RECEIVE))
191  {
192  b1->error = node->errors[IP4_COP_WHITELIST_ERROR_DROPPED];
193  next1 = RX_COP_DROP;
194  }
195 
197  && (b0->flags & VLIB_BUFFER_IS_TRACED)))
198  {
200  vlib_add_trace (vm, node, b0, sizeof (*t));
201  t->sw_if_index = sw_if_index0;
202  t->next_index = next0;
203  }
204 
206  && (b1->flags & VLIB_BUFFER_IS_TRACED)))
207  {
209  vlib_add_trace (vm, node, b1, sizeof (*t));
210  t->sw_if_index = sw_if_index1;
211  t->next_index = next1;
212  }
213 
214  /* verify speculative enqueues, maybe switch current next frame */
215  vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
216  to_next, n_left_to_next,
217  bi0, bi1, next0, next1);
218  }
219 
220  while (n_left_from > 0 && n_left_to_next > 0)
221  {
222  u32 bi0;
223  vlib_buffer_t * b0;
224  u32 next0;
225  u32 sw_if_index0;
226  ip4_header_t * ip0;
227  cop_config_main_t *ccm0;
228  cop_config_data_t *c0;
229  ip4_fib_mtrie_t * mtrie0;
230  ip4_fib_mtrie_leaf_t leaf0;
231  u32 lb_index0;
232  const load_balance_t * lb0;
233  const dpo_id_t *dpo0;
234 
235  /* speculatively enqueue b0 to the current next frame */
236  bi0 = from[0];
237  to_next[0] = bi0;
238  from += 1;
239  to_next += 1;
240  n_left_from -= 1;
241  n_left_to_next -= 1;
242 
243  b0 = vlib_get_buffer (vm, bi0);
244  sw_if_index0 = vnet_buffer(b0)->sw_if_index[VLIB_RX];
245 
246  ip0 = vlib_buffer_get_current (b0);
247 
248  ccm0 = cm->cop_config_mains + VNET_COP_IP4;
249 
251  (&ccm0->config_main,
252  &vnet_buffer (b0)->cop.current_config_index,
253  &next0,
254  sizeof (c0[0]));
255 
256  mtrie0 = &ip4_fib_get (c0->fib_index)->mtrie;
257 
258  leaf0 = ip4_fib_mtrie_lookup_step_one (mtrie0, &ip0->src_address);
259 
260  leaf0 = ip4_fib_mtrie_lookup_step (mtrie0, leaf0,
261  &ip0->src_address, 2);
262 
263  leaf0 = ip4_fib_mtrie_lookup_step (mtrie0, leaf0,
264  &ip0->src_address, 3);
265 
266  lb_index0 = ip4_fib_mtrie_leaf_get_adj_index (leaf0);
267 
268  ASSERT (lb_index0
270  &ip0->src_address));
271 
272  lb0 = load_balance_get (lb_index0);
273  dpo0 = load_balance_get_bucket_i(lb0, 0);
274 
276  (vcm, thread_index, lb_index0, 1,
278  + sizeof(ethernet_header_t));
279 
280  if (PREDICT_FALSE(dpo0->dpoi_type != DPO_RECEIVE))
281  {
282  b0->error = node->errors[IP4_COP_WHITELIST_ERROR_DROPPED];
283  next0 = RX_COP_DROP;
284  }
285 
287  && (b0->flags & VLIB_BUFFER_IS_TRACED)))
288  {
290  vlib_add_trace (vm, node, b0, sizeof (*t));
291  t->sw_if_index = sw_if_index0;
292  t->next_index = next0;
293  }
294 
295  /* verify speculative enqueue, maybe switch current next frame */
296  vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
297  to_next, n_left_to_next,
298  bi0, next0);
299  }
300 
301  vlib_put_next_frame (vm, node, next_index, n_left_to_next);
302  }
303  return frame->n_vectors;
304 }
305 
307  .function = ip4_cop_whitelist_node_fn,
308  .name = "ip4-cop-whitelist",
309  .vector_size = sizeof (u32),
310  .format_trace = format_ip4_cop_whitelist_trace,
311  .type = VLIB_NODE_TYPE_INTERNAL,
312 
314  .error_strings = ip4_cop_whitelist_error_strings,
315 
316  .n_next_nodes = COP_RX_N_FEATURES,
317 
318  /* edit / add dispositions here */
319  .next_nodes = {
320  [IP4_RX_COP_WHITELIST] = "ip4-cop-whitelist",
321  [IP6_RX_COP_WHITELIST] = "ip6-cop-whitelist",
322  [DEFAULT_RX_COP_WHITELIST] = "default-cop-whitelist",
323  [IP4_RX_COP_INPUT] = "ip4-input",
324  [IP6_RX_COP_INPUT] = "ip6-input",
325  [DEFAULT_RX_COP_INPUT] = "ethernet-input",
326  [RX_COP_DROP] = "error-drop",
327  },
328 };
329 
331 
332 static clib_error_t *
334 {
335  return 0;
336 }
337 
#define CLIB_UNUSED(x)
Definition: clib.h:81
static void vlib_increment_combined_counter(vlib_combined_counter_main_t *cm, u32 thread_index, u32 index, u64 n_packets, u64 n_bytes)
Increment a combined counter.
Definition: counter.h:204
The mutiway-TRIE.
Definition: ip4_mtrie.h:129
cop_config_main_t cop_config_mains[VNET_N_COPS]
Definition: cop.h:66
ip4_address_t src_address
Definition: ip4_packet.h:169
static ip4_fib_mtrie_leaf_t ip4_fib_mtrie_lookup_step(const ip4_fib_mtrie_t *m, ip4_fib_mtrie_leaf_t current_leaf, const ip4_address_t *dst_address, u32 dst_address_byte_index)
Lookup step.
Definition: ip4_mtrie.h:202
#define foreach_ip4_cop_whitelist_error
Definition: ip4_whitelist.c:38
u32 thread_index
Definition: main.h:179
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
vlib_error_t * errors
Vector of errors for this node.
Definition: node.h:472
static uword vlib_buffer_length_in_chain(vlib_main_t *vm, vlib_buffer_t *b)
Get length in bytes of the buffer chain.
Definition: buffer_funcs.h:263
static u8 * format_ip4_cop_whitelist_trace(u8 *s, va_list *args)
Definition: ip4_whitelist.c:25
unsigned char u8
Definition: types.h:56
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:163
#define vlib_prefetch_buffer_header(b, type)
Prefetch buffer metadata.
Definition: buffer.h:187
u32 ip4_fib_mtrie_leaf_t
Definition: ip4_mtrie.h:52
unsigned int u32
Definition: types.h:88
static u32 ip4_fib_mtrie_leaf_get_adj_index(ip4_fib_mtrie_leaf_t n)
From the stored slot value extract the LB index value.
Definition: ip4_mtrie.h:192
#define VLIB_NODE_FUNCTION_MULTIARCH(node, fn)
Definition: node.h:209
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:168
static char * ip4_cop_whitelist_error_strings[]
Definition: ip4_whitelist.c:48
dpo_type_t dpoi_type
the type
Definition: dpo.h:172
static const dpo_id_t * load_balance_get_bucket_i(const load_balance_t *lb, u32 bucket)
Definition: load_balance.h:209
cop_feature_type_t
Definition: cop.h:39
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:205
static void * vnet_get_config_data(vnet_config_main_t *cm, u32 *config_index, u32 *next_index, u32 n_data_bytes)
Definition: config.h:122
The FIB DPO provieds;.
Definition: load_balance.h:84
#define PREDICT_FALSE(x)
Definition: clib.h:107
load_balance_main_t load_balance_main
The one instance of load-balance main.
Definition: load_balance.c:56
#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
ip4_fib_mtrie_t mtrie
Mtrie for fast lookups.
Definition: ip4_fib.h:48
vlib_error_t error
Error code for buffers to be enqueued to error handler.
Definition: buffer.h:138
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:155
vlib_node_registration_t ip4_cop_whitelist_node
(constructor) VLIB_REGISTER_NODE (ip4_cop_whitelist_node)
Definition: ip4_whitelist.c:36
u16 n_vectors
Definition: node.h:401
#define CLIB_PREFETCH(addr, size, type)
Definition: cache.h:79
vlib_main_t * vm
Definition: buffer.c:294
static ip4_fib_t * ip4_fib_get(u32 index)
Get the FIB at the given index.
Definition: ip4_fib.h:113
#define ARRAY_LEN(x)
Definition: clib.h:61
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:455
cop_main_t cop_main
Definition: cop.c:17
vlib_combined_counter_main_t lbm_via_counters
Definition: load_balance.h:47
u16 cached_next_index
Next frame index that vector arguments were last enqueued to last time this node ran.
Definition: node.h:513
#define ASSERT(truth)
static ip4_fib_mtrie_leaf_t ip4_fib_mtrie_lookup_step_one(const ip4_fib_mtrie_t *m, const ip4_address_t *dst_address)
Lookup step number 1.
Definition: ip4_mtrie.h:224
static load_balance_t * load_balance_get(index_t lbi)
Definition: load_balance.h:200
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:57
ip4_cop_whitelist_error_t
Definition: ip4_whitelist.c:41
struct _vlib_node_registration vlib_node_registration_t
u64 uword
Definition: types.h:112
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:267
static clib_error_t * ip4_whitelist_init(vlib_main_t *vm)
A collection of combined counters.
Definition: counter.h:172
#define vnet_buffer(b)
Definition: buffer.h:344
u8 data[0]
Packet data.
Definition: buffer.h:175
index_t ip4_fib_table_lookup_lb(ip4_fib_t *fib, const ip4_address_t *addr)
Definition: ip4_fib.c:267
u16 flags
Copy of main node flags.
Definition: node.h:507
Definition: cop.h:65
#define VLIB_NODE_FLAG_TRACE
Definition: node.h:310
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:59
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:116
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:58
static uword ip4_cop_whitelist_node_fn(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: ip4_whitelist.c:55
u32 fib_index
Definition: cop.h:62
Definition: defs.h:46
vnet_config_main_t config_main
Definition: cop.h:57