FD.io VPP  v17.01-9-ge7dcee4
Vector Packet Processing
ip_classify.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 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/ip/ip.h>
16 #include <vnet/ethernet/ethernet.h> /* for ethernet_header_t */
18 #include <vnet/dpo/classify_dpo.h>
19 
20 typedef struct {
25 
26 /* packet trace format function */
27 static u8 * format_ip_classify_trace (u8 * s, va_list * args)
28 {
29  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
30  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
31  ip_classify_trace_t * t = va_arg (*args, ip_classify_trace_t *);
32 
33  s = format (s, "IP_CLASSIFY: next_index %d, table %d, entry %d",
35  return s;
36 }
37 
40 
41 #define foreach_ip_classify_error \
42 _(MISS, "Classify misses") \
43 _(HIT, "Classify hits") \
44 _(CHAIN_HIT, "Classify hits after chain walk")
45 
46 typedef enum {
47 #define _(sym,str) IP_CLASSIFY_ERROR_##sym,
49 #undef _
52 
53 static char * ip_classify_error_strings[] = {
54 #define _(sym,string) string,
56 #undef _
57 };
58 
59 static inline uword
61  vlib_node_runtime_t * node,
62  vlib_frame_t * frame, int is_ip4)
63 {
64  u32 n_left_from, * from, * to_next;
65  ip_lookup_next_t next_index;
67  f64 now = vlib_time_now (vm);
68  u32 hits = 0;
69  u32 misses = 0;
70  u32 chain_hits = 0;
71  u32 n_next;
72 
73  if (is_ip4) {
74  n_next = IP4_LOOKUP_N_NEXT;
75  } else {
76  n_next = IP6_LOOKUP_N_NEXT;
77  }
78 
79  from = vlib_frame_vector_args (frame);
80  n_left_from = frame->n_vectors;
81 
82  /* First pass: compute hashes */
83 
84  while (n_left_from > 2)
85  {
86  vlib_buffer_t * b0, * b1;
87  u32 bi0, bi1;
88  u8 * h0, * h1;
89  u32 cd_index0, cd_index1;
90  classify_dpo_t *cd0, * cd1;
91  u32 table_index0, table_index1;
92  vnet_classify_table_t * t0, * t1;
93 
94  /* prefetch next iteration */
95  {
96  vlib_buffer_t * p1, * p2;
97 
98  p1 = vlib_get_buffer (vm, from[1]);
99  p2 = vlib_get_buffer (vm, from[2]);
100 
101  vlib_prefetch_buffer_header (p1, STORE);
103  vlib_prefetch_buffer_header (p2, STORE);
105  }
106 
107  bi0 = from[0];
108  b0 = vlib_get_buffer (vm, bi0);
109  h0 = (void *)vlib_buffer_get_current(b0) -
111 
112  bi1 = from[1];
113  b1 = vlib_get_buffer (vm, bi1);
114  h1 = (void *)vlib_buffer_get_current(b1) -
116 
117  cd_index0 = vnet_buffer (b0)->ip.adj_index[VLIB_TX];
118  cd0 = classify_dpo_get(cd_index0);
119  table_index0 = cd0->cd_table_index;
120 
121  cd_index1 = vnet_buffer (b1)->ip.adj_index[VLIB_TX];
122  cd1 = classify_dpo_get(cd_index1);
123  table_index1 = cd1->cd_table_index;
124 
125  t0 = pool_elt_at_index (vcm->tables, table_index0);
126 
127  t1 = pool_elt_at_index (vcm->tables, table_index1);
128 
129  vnet_buffer(b0)->l2_classify.hash =
130  vnet_classify_hash_packet (t0, (u8 *) h0);
131 
132  vnet_classify_prefetch_bucket (t0, vnet_buffer(b0)->l2_classify.hash);
133 
134  vnet_buffer(b1)->l2_classify.hash =
135  vnet_classify_hash_packet (t1, (u8 *) h1);
136 
137  vnet_classify_prefetch_bucket (t1, vnet_buffer(b1)->l2_classify.hash);
138 
139  vnet_buffer(b0)->l2_classify.table_index = table_index0;
140 
141  vnet_buffer(b1)->l2_classify.table_index = table_index1;
142 
143  from += 2;
144  n_left_from -= 2;
145  }
146 
147  while (n_left_from > 0)
148  {
149  vlib_buffer_t * b0;
150  u32 bi0;
151  u8 * h0;
152  u32 cd_index0;
153  classify_dpo_t *cd0;
154  u32 table_index0;
156 
157  bi0 = from[0];
158  b0 = vlib_get_buffer (vm, bi0);
159  h0 = (void *)vlib_buffer_get_current(b0) -
161 
162  cd_index0 = vnet_buffer (b0)->ip.adj_index[VLIB_TX];
163  cd0 = classify_dpo_get(cd_index0);
164  table_index0 = cd0->cd_table_index;
165 
166  t0 = pool_elt_at_index (vcm->tables, table_index0);
167  vnet_buffer(b0)->l2_classify.hash =
168  vnet_classify_hash_packet (t0, (u8 *) h0);
169 
170  vnet_buffer(b0)->l2_classify.table_index = table_index0;
171  vnet_classify_prefetch_bucket (t0, vnet_buffer(b0)->l2_classify.hash);
172 
173  from++;
174  n_left_from--;
175  }
176 
177  next_index = node->cached_next_index;
178  from = vlib_frame_vector_args (frame);
179  n_left_from = frame->n_vectors;
180 
181  while (n_left_from > 0)
182  {
183  u32 n_left_to_next;
184 
185  vlib_get_next_frame (vm, node, next_index,
186  to_next, n_left_to_next);
187 
188  /* Not enough load/store slots to dual loop... */
189  while (n_left_from > 0 && n_left_to_next > 0)
190  {
191  u32 bi0;
192  vlib_buffer_t * b0;
193  u32 next0 = IP_LOOKUP_NEXT_DROP;
194  u32 table_index0;
196  vnet_classify_entry_t * e0;
197  u64 hash0;
198  u8 * h0;
199 
200  /* Stride 3 seems to work best */
201  if (PREDICT_TRUE (n_left_from > 3))
202  {
203  vlib_buffer_t * p1 = vlib_get_buffer(vm, from[3]);
204  vnet_classify_table_t * tp1;
205  u32 table_index1;
206  u64 phash1;
207 
208  table_index1 = vnet_buffer(p1)->l2_classify.table_index;
209 
210  if (PREDICT_TRUE (table_index1 != ~0))
211  {
212  tp1 = pool_elt_at_index (vcm->tables, table_index1);
213  phash1 = vnet_buffer(p1)->l2_classify.hash;
214  vnet_classify_prefetch_entry (tp1, phash1);
215  }
216  }
217 
218  /* speculatively enqueue b0 to the current next frame */
219  bi0 = from[0];
220  to_next[0] = bi0;
221  from += 1;
222  to_next += 1;
223  n_left_from -= 1;
224  n_left_to_next -= 1;
225 
226  b0 = vlib_get_buffer (vm, bi0);
227  h0 = b0->data;
228  table_index0 = vnet_buffer(b0)->l2_classify.table_index;
229  e0 = 0;
230  t0 = 0;
231  vnet_buffer(b0)->l2_classify.opaque_index = ~0;
232 
233  if (PREDICT_TRUE(table_index0 != ~0))
234  {
235  hash0 = vnet_buffer(b0)->l2_classify.hash;
236  t0 = pool_elt_at_index (vcm->tables, table_index0);
237 
238  e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0,
239  now);
240  if (e0)
241  {
242  vnet_buffer(b0)->l2_classify.opaque_index
243  = e0->opaque_index;
244  vlib_buffer_advance (b0, e0->advance);
245  next0 = (e0->next_index < node->n_next_nodes)?
246  e0->next_index:next0;
247  hits++;
248  }
249  else
250  {
251  while (1)
252  {
253  if (t0->next_table_index != ~0)
254  t0 = pool_elt_at_index (vcm->tables,
255  t0->next_table_index);
256  else
257  {
258  next0 = (t0->miss_next_index < n_next) ?
259  t0->miss_next_index : next0;
260  misses++;
261  break;
262  }
263 
264  hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
266  (t0, (u8 *) h0, hash0, now);
267  if (e0)
268  {
269  vnet_buffer(b0)->l2_classify.opaque_index
270  = e0->opaque_index;
271  vlib_buffer_advance (b0, e0->advance);
272  next0 = (e0->next_index < node->n_next_nodes)?
273  e0->next_index:next0;
274  hits++;
275  chain_hits++;
276  break;
277  }
278  }
279  }
280  }
281 
283  && (b0->flags & VLIB_BUFFER_IS_TRACED)))
284  {
285  ip_classify_trace_t *t =
286  vlib_add_trace (vm, node, b0, sizeof (*t));
287  t->next_index = next0;
288  t->table_index = t0 ? t0 - vcm->tables : ~0;
289  t->entry_index = e0 ? e0 - t0->entries : ~0;
290  }
291 
292  /* verify speculative enqueue, maybe switch current next frame */
293  vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
294  to_next, n_left_to_next,
295  bi0, next0);
296  }
297 
298  vlib_put_next_frame (vm, node, next_index, n_left_to_next);
299  }
300 
302  IP_CLASSIFY_ERROR_MISS,
303  misses);
305  IP_CLASSIFY_ERROR_HIT,
306  hits);
308  IP_CLASSIFY_ERROR_CHAIN_HIT,
309  chain_hits);
310  return frame->n_vectors;
311 }
312 
313 static uword
315  vlib_node_runtime_t * node,
316  vlib_frame_t * frame)
317 {
318  return ip_classify_inline (vm, node, frame, 1 /* is_ip4 */);
319 }
320 
321 
323  .function = ip4_classify,
324  .name = "ip4-classify",
325  .vector_size = sizeof (u32),
326  .sibling_of = "ip4-lookup",
327  .format_trace = format_ip_classify_trace,
329  .error_strings = ip_classify_error_strings,
330 
331  .n_next_nodes = 0,
332 };
333 
335 
336 static uword
338  vlib_node_runtime_t * node,
339  vlib_frame_t * frame)
340 {
341  return ip_classify_inline (vm, node, frame, 0 /* is_ip4 */);
342 }
343 
344 
346  .function = ip6_classify,
347  .name = "ip6-classify",
348  .vector_size = sizeof (u32),
349  .sibling_of = "ip6-lookup",
350  .format_trace = format_ip_classify_trace,
352  .error_strings = ip_classify_error_strings,
353 
354  .n_next_nodes = 0,
355 };
356 
358 
359 static clib_error_t *
361 {
362  return 0;
363 }
364 
u64 vnet_classify_hash_packet(vnet_classify_table_t *t, u8 *h)
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:459
ip_lookup_next_t
Common (IP4/IP6) next index stored in adjacency.
Definition: lookup.h:60
#define foreach_ip_classify_error
Definition: ip_classify.c:41
static clib_error_t * ip_classify_init(vlib_main_t *vm)
Definition: ip_classify.c:360
#define CLIB_UNUSED(x)
Definition: clib.h:79
#define PREDICT_TRUE(x)
Definition: clib.h:98
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:182
#define ethernet_buffer_header_size(b)
Determine the size of the Ethernet headers of the current frame in the buffer.
Definition: ethernet.h:387
struct _vlib_node_registration vlib_node_registration_t
vlib_node_registration_t ip4_classify_node
(constructor) VLIB_REGISTER_NODE (ip4_classify_node)
Definition: ip_classify.c:38
Adjacency to drop this packet.
Definition: lookup.h:63
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:111
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:194
unsigned long u64
Definition: types.h:89
A representation of an MPLS label for imposition in the data-path.
Definition: classify_dpo.h:26
static void vnet_classify_prefetch_bucket(vnet_classify_table_t *t, u64 hash)
static void vnet_classify_prefetch_entry(vnet_classify_table_t *t, u64 hash)
static uword ip6_classify(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: ip_classify.c:337
static uword ip_classify_inline(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame, int is_ip4)
Definition: ip_classify.c:60
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:369
vnet_classify_entry_t * entries
#define PREDICT_FALSE(x)
Definition: clib.h:97
#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:216
#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:350
static void vlib_node_increment_counter(vlib_main_t *vm, u32 node_index, u32 counter_index, u64 increment)
Definition: node_funcs.h:1113
u16 n_vectors
Definition: node.h:344
#define CLIB_PREFETCH(addr, size, type)
Definition: cache.h:82
static void vlib_buffer_advance(vlib_buffer_t *b, word l)
Advance current data pointer by the supplied (signed!) amount.
Definition: buffer.h:207
#define ARRAY_LEN(x)
Definition: clib.h:59
struct _vnet_classify_main vnet_classify_main_t
Definition: vnet_classify.h:69
u16 cached_next_index
Definition: node.h:463
unsigned int u32
Definition: types.h:88
static char * ip_classify_error_strings[]
Definition: ip_classify.c:53
#define vnet_buffer(b)
Definition: buffer.h:361
#define VLIB_NODE_FLAG_TRACE
Definition: node.h:259
vnet_classify_main_t vnet_classify_main
Definition: vnet_classify.c:22
#define VLIB_BUFFER_IS_TRACED
Definition: buffer.h:95
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
ip_classify_error_t
Definition: ip_classify.c:46
double f64
Definition: types.h:142
unsigned char u8
Definition: types.h:56
static u8 * format_ip_classify_trace(u8 *s, va_list *args)
Definition: ip_classify.c:27
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:253
static classify_dpo_t * classify_dpo_get(index_t index)
Definition: classify_dpo.h:49
#define vlib_prefetch_buffer_header(b, type)
Prefetch buffer metadata.
Definition: buffer.h:170
#define VLIB_NODE_FUNCTION_MULTIARCH(node, fn)
Definition: node.h:158
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:143
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:418
u8 data[0]
Packet data.
Definition: buffer.h:158
vlib_node_registration_t ip6_classify_node
(constructor) VLIB_REGISTER_NODE (ip6_classify_node)
Definition: ip_classify.c:39
static uword ip4_classify(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: ip_classify.c:314
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:67
u32 flags
buffer flags: VLIB_BUFFER_IS_TRACED: trace this buffer.
Definition: buffer.h:85
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
vnet_classify_entry_t * vnet_classify_find_entry(vnet_classify_table_t *t, u8 *h, u64 hash, f64 now)