FD.io VPP  v16.09
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 
19 typedef struct {
24 
25 /* packet trace format function */
26 static u8 * format_ip_classify_trace (u8 * s, va_list * args)
27 {
28  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
29  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
30  ip_classify_trace_t * t = va_arg (*args, ip_classify_trace_t *);
31 
32  s = format (s, "IP_CLASSIFY: next_index %d, table %d, entry %d",
34  return s;
35 }
36 
39 
40 #define foreach_ip_classify_error \
41 _(MISS, "Classify misses") \
42 _(HIT, "Classify hits") \
43 _(CHAIN_HIT, "Classify hits after chain walk")
44 
45 typedef enum {
46 #define _(sym,str) IP_CLASSIFY_ERROR_##sym,
48 #undef _
51 
52 static char * ip_classify_error_strings[] = {
53 #define _(sym,string) string,
55 #undef _
56 };
57 
58 static inline uword
60  vlib_node_runtime_t * node,
61  vlib_frame_t * frame, int is_ip4)
62 {
63  u32 n_left_from, * from, * to_next;
64  ip_lookup_next_t next_index;
66  ip_lookup_main_t * lm;
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  lm = &ip4_main.lookup_main;
75  n_next = IP4_LOOKUP_N_NEXT;
76  } else {
77  lm = &ip6_main.lookup_main;
78  n_next = IP6_LOOKUP_N_NEXT;
79  }
80 
81  from = vlib_frame_vector_args (frame);
82  n_left_from = frame->n_vectors;
83 
84  /* First pass: compute hashes */
85 
86  while (n_left_from > 2)
87  {
88  vlib_buffer_t * b0, * b1;
89  u32 bi0, bi1;
90  u8 * h0, * h1;
91  u32 adj_index0, adj_index1;
92  ip_adjacency_t * adj0, * adj1;
93  u32 table_index0, table_index1;
94  vnet_classify_table_t * t0, * t1;
95 
96  /* prefetch next iteration */
97  {
98  vlib_buffer_t * p1, * p2;
99 
100  p1 = vlib_get_buffer (vm, from[1]);
101  p2 = vlib_get_buffer (vm, from[2]);
102 
103  vlib_prefetch_buffer_header (p1, STORE);
105  vlib_prefetch_buffer_header (p2, STORE);
107  }
108 
109  bi0 = from[0];
110  b0 = vlib_get_buffer (vm, bi0);
111  h0 = (void *)vlib_buffer_get_current(b0) -
113 
114  bi1 = from[1];
115  b1 = vlib_get_buffer (vm, bi1);
116  h1 = (void *)vlib_buffer_get_current(b1) -
118 
119  adj_index0 = vnet_buffer (b0)->ip.adj_index[VLIB_TX];
120  adj0 = ip_get_adjacency (lm, adj_index0);
121  table_index0 = adj0->classify.table_index;
122 
123  adj_index1 = vnet_buffer (b1)->ip.adj_index[VLIB_TX];
124  adj1 = ip_get_adjacency (lm, adj_index1);
125  table_index1 = adj1->classify.table_index;
126 
127  t0 = pool_elt_at_index (vcm->tables, table_index0);
128 
129  t1 = pool_elt_at_index (vcm->tables, table_index1);
130 
131  vnet_buffer(b0)->l2_classify.hash =
132  vnet_classify_hash_packet (t0, (u8 *) h0);
133 
134  vnet_classify_prefetch_bucket (t0, vnet_buffer(b0)->l2_classify.hash);
135 
136  vnet_buffer(b1)->l2_classify.hash =
137  vnet_classify_hash_packet (t1, (u8 *) h1);
138 
139  vnet_classify_prefetch_bucket (t1, vnet_buffer(b1)->l2_classify.hash);
140 
141  vnet_buffer(b0)->l2_classify.table_index = table_index0;
142 
143  vnet_buffer(b1)->l2_classify.table_index = table_index1;
144 
145  from += 2;
146  n_left_from -= 2;
147  }
148 
149  while (n_left_from > 0)
150  {
151  vlib_buffer_t * b0;
152  u32 bi0;
153  u8 * h0;
154  u32 adj_index0;
155  ip_adjacency_t * adj0;
156  u32 table_index0;
158 
159  bi0 = from[0];
160  b0 = vlib_get_buffer (vm, bi0);
161  h0 = (void *)vlib_buffer_get_current(b0) -
163 
164  adj_index0 = vnet_buffer (b0)->ip.adj_index[VLIB_TX];
165  adj0 = ip_get_adjacency (lm, adj_index0);
166  table_index0 = adj0->classify.table_index;
167 
168  t0 = pool_elt_at_index (vcm->tables, table_index0);
169  vnet_buffer(b0)->l2_classify.hash =
170  vnet_classify_hash_packet (t0, (u8 *) h0);
171 
172  vnet_buffer(b0)->l2_classify.table_index = table_index0;
173  vnet_classify_prefetch_bucket (t0, vnet_buffer(b0)->l2_classify.hash);
174 
175  from++;
176  n_left_from--;
177  }
178 
179  next_index = node->cached_next_index;
180  from = vlib_frame_vector_args (frame);
181  n_left_from = frame->n_vectors;
182 
183  while (n_left_from > 0)
184  {
185  u32 n_left_to_next;
186 
187  vlib_get_next_frame (vm, node, next_index,
188  to_next, n_left_to_next);
189 
190  /* Not enough load/store slots to dual loop... */
191  while (n_left_from > 0 && n_left_to_next > 0)
192  {
193  u32 bi0;
194  vlib_buffer_t * b0;
195  u32 next0 = IP_LOOKUP_NEXT_MISS;
196  u32 table_index0;
198  vnet_classify_entry_t * e0;
199  u64 hash0;
200  u8 * h0;
201 
202  /* Stride 3 seems to work best */
203  if (PREDICT_TRUE (n_left_from > 3))
204  {
205  vlib_buffer_t * p1 = vlib_get_buffer(vm, from[3]);
206  vnet_classify_table_t * tp1;
207  u32 table_index1;
208  u64 phash1;
209 
210  table_index1 = vnet_buffer(p1)->l2_classify.table_index;
211 
212  if (PREDICT_TRUE (table_index1 != ~0))
213  {
214  tp1 = pool_elt_at_index (vcm->tables, table_index1);
215  phash1 = vnet_buffer(p1)->l2_classify.hash;
216  vnet_classify_prefetch_entry (tp1, phash1);
217  }
218  }
219 
220  /* speculatively enqueue b0 to the current next frame */
221  bi0 = from[0];
222  to_next[0] = bi0;
223  from += 1;
224  to_next += 1;
225  n_left_from -= 1;
226  n_left_to_next -= 1;
227 
228  b0 = vlib_get_buffer (vm, bi0);
229  h0 = b0->data;
230  table_index0 = vnet_buffer(b0)->l2_classify.table_index;
231  e0 = 0;
232  t0 = 0;
233  vnet_buffer(b0)->l2_classify.opaque_index = ~0;
234 
235  if (PREDICT_TRUE(table_index0 != ~0))
236  {
237  hash0 = vnet_buffer(b0)->l2_classify.hash;
238  t0 = pool_elt_at_index (vcm->tables, table_index0);
239 
240  e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0,
241  now);
242  if (e0)
243  {
244  vnet_buffer(b0)->l2_classify.opaque_index
245  = e0->opaque_index;
246  vlib_buffer_advance (b0, e0->advance);
247  next0 = (e0->next_index < node->n_next_nodes)?
248  e0->next_index:next0;
249  hits++;
250  }
251  else
252  {
253  while (1)
254  {
255  if (t0->next_table_index != ~0)
256  t0 = pool_elt_at_index (vcm->tables,
257  t0->next_table_index);
258  else
259  {
260  next0 = (t0->miss_next_index < n_next) ?
261  t0->miss_next_index : next0;
262  misses++;
263  break;
264  }
265 
266  hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
268  (t0, (u8 *) h0, hash0, now);
269  if (e0)
270  {
271  vnet_buffer(b0)->l2_classify.opaque_index
272  = e0->opaque_index;
273  vlib_buffer_advance (b0, e0->advance);
274  next0 = (e0->next_index < node->n_next_nodes)?
275  e0->next_index:next0;
276  hits++;
277  chain_hits++;
278  break;
279  }
280  }
281  }
282  }
283 
285  && (b0->flags & VLIB_BUFFER_IS_TRACED)))
286  {
287  ip_classify_trace_t *t =
288  vlib_add_trace (vm, node, b0, sizeof (*t));
289  t->next_index = next0;
290  t->table_index = t0 ? t0 - vcm->tables : ~0;
291  t->entry_index = e0 ? e0 - t0->entries : ~0;
292  }
293 
294  /* verify speculative enqueue, maybe switch current next frame */
295  vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
296  to_next, n_left_to_next,
297  bi0, next0);
298  }
299 
300  vlib_put_next_frame (vm, node, next_index, n_left_to_next);
301  }
302 
304  IP_CLASSIFY_ERROR_MISS,
305  misses);
307  IP_CLASSIFY_ERROR_HIT,
308  hits);
310  IP_CLASSIFY_ERROR_CHAIN_HIT,
311  chain_hits);
312  return frame->n_vectors;
313 }
314 
315 static uword
317  vlib_node_runtime_t * node,
318  vlib_frame_t * frame)
319 {
320  return ip_classify_inline (vm, node, frame, 1 /* is_ip4 */);
321 }
322 
323 
325  .function = ip4_classify,
326  .name = "ip4-classify",
327  .vector_size = sizeof (u32),
328  .sibling_of = "ip4-lookup",
329  .format_trace = format_ip_classify_trace,
331  .error_strings = ip_classify_error_strings,
332 
333  .n_next_nodes = 0,
334 };
335 
337 
338 static uword
340  vlib_node_runtime_t * node,
341  vlib_frame_t * frame)
342 {
343  return ip_classify_inline (vm, node, frame, 0 /* is_ip4 */);
344 }
345 
346 
348  .function = ip6_classify,
349  .name = "ip6-classify",
350  .vector_size = sizeof (u32),
351  .sibling_of = "ip6-lookup",
352  .format_trace = format_ip_classify_trace,
354  .error_strings = ip_classify_error_strings,
355 
356  .n_next_nodes = 0,
357 };
358 
360 
361 static clib_error_t *
363 {
364  return 0;
365 }
366 
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:457
ip_lookup_next_t
Common (IP4/IP6) next index stored in adjacency.
Definition: lookup.h:58
#define foreach_ip_classify_error
Definition: ip_classify.c:40
static clib_error_t * ip_classify_init(vlib_main_t *vm)
Definition: ip_classify.c:362
#define CLIB_UNUSED(x)
Definition: clib.h:79
#define PREDICT_TRUE(x)
Definition: clib.h:98
IP unicast adjacency.
Definition: lookup.h:164
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:358
struct _vlib_node_registration vlib_node_registration_t
ip_lookup_main_t lookup_main
Definition: ip4.h:115
vlib_node_registration_t ip4_classify_node
(constructor) VLIB_REGISTER_NODE (ip4_classify_node)
Definition: ip_classify.c:37
#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:187
unsigned long u64
Definition: types.h:89
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:339
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:59
#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:130
#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:348
static void vlib_node_increment_counter(vlib_main_t *vm, u32 node_index, u32 counter_index, u64 increment)
Definition: node_funcs.h:1111
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:200
#define ARRAY_LEN(x)
Definition: clib.h:59
struct ip_adjacency_t::@143::@146 classify
IP_LOOKUP_NEXT_CLASSIFY only.
struct _vnet_classify_main vnet_classify_main_t
Definition: vnet_classify.h:50
u16 cached_next_index
Definition: node.h:462
unsigned int u32
Definition: types.h:88
static char * ip_classify_error_strings[]
Definition: ip_classify.c:52
#define vnet_buffer(b)
Definition: buffer.h:335
ip6_main_t ip6_main
Definition: ip6_forward.c:2955
ip_lookup_main_t lookup_main
Definition: ip6.h:110
u8 * format(u8 *s, char *fmt,...)
Definition: format.c:418
#define VLIB_NODE_FLAG_TRACE
Definition: node.h:259
vnet_classify_main_t vnet_classify_main
Definition: vnet_classify.c:21
#define VLIB_BUFFER_IS_TRACED
Definition: buffer.h:93
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:45
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:26
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:251
Packet does not match any route in table.
Definition: lookup.h:60
#define vlib_prefetch_buffer_header(b, type)
Prefetch buffer metadata.
Definition: buffer.h:163
#define VLIB_NODE_FUNCTION_MULTIARCH(node, fn)
Definition: node.h:158
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:143
ip4_main_t ip4_main
Global ip4 main structure.
Definition: ip4_forward.c:1578
u8 data[0]
Packet data.
Definition: buffer.h:151
vlib_node_registration_t ip6_classify_node
(constructor) VLIB_REGISTER_NODE (ip6_classify_node)
Definition: ip_classify.c:38
static uword ip4_classify(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: ip_classify.c:316
#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:69
vnet_classify_entry_t * vnet_classify_find_entry(vnet_classify_table_t *t, u8 *h, u64 hash, f64 now)
static ip_adjacency_t * ip_get_adjacency(ip_lookup_main_t *lm, u32 adj_index)
Definition: lookup.h:480