c44f25e2add4f2f415a4286bef0634649c3d9837
[vpp.git] / vnet / vnet / classify / ip_classify.c
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 */
17 #include <vnet/classify/vnet_classify.h>
18
19 typedef struct {
20   u32 next_index;
21   u32 table_index;
22   u32 entry_index;
23 } ip_classify_trace_t;
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",
33               t->next_index, t->table_index, t->entry_index);
34   return s;
35 }
36
37 vlib_node_registration_t ip4_classify_node;
38 vlib_node_registration_t ip6_classify_node;
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,
47   foreach_ip_classify_error
48 #undef _
49   IP_CLASSIFY_N_ERROR,
50 } ip_classify_error_t;
51
52 static char * ip_classify_error_strings[] = {
53 #define _(sym,string) string,
54   foreach_ip_classify_error
55 #undef _
56 };
57
58 static inline uword
59 ip_classify_inline (vlib_main_t * vm,
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;
65   vnet_classify_main_t * vcm = &vnet_classify_main;
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);
104           CLIB_PREFETCH (p1->data, CLIB_CACHE_LINE_BYTES, STORE);
105           vlib_prefetch_buffer_header (p2, STORE);
106           CLIB_PREFETCH (p2->data, CLIB_CACHE_LINE_BYTES, STORE);
107         }
108         
109       bi0 = from[0];
110       b0 = vlib_get_buffer (vm, bi0);
111       h0 = (void *)vlib_buffer_get_current(b0) -
112                 ethernet_buffer_header_size(b0);
113
114       bi1 = from[1];
115       b1 = vlib_get_buffer (vm, bi1);
116       h1 = (void *)vlib_buffer_get_current(b1) -
117                 ethernet_buffer_header_size(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;
157       vnet_classify_table_t * t0;
158
159       bi0 = from[0];
160       b0 = vlib_get_buffer (vm, bi0);
161       h0 = (void *)vlib_buffer_get_current(b0) -
162                 ethernet_buffer_header_size(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;
197           vnet_classify_table_t * t0;
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);
267                       e0 = vnet_classify_find_entry
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
284           if (PREDICT_FALSE((node->flags & VLIB_NODE_FLAG_TRACE) 
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
303   vlib_node_increment_counter (vm, node->node_index, 
304                                IP_CLASSIFY_ERROR_MISS, 
305                                misses);
306   vlib_node_increment_counter (vm, node->node_index, 
307                                IP_CLASSIFY_ERROR_HIT, 
308                                hits);
309   vlib_node_increment_counter (vm, node->node_index, 
310                                IP_CLASSIFY_ERROR_CHAIN_HIT, 
311                                chain_hits);
312   return frame->n_vectors;
313 }
314
315 static uword
316 ip4_classify (vlib_main_t * vm,
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
324 VLIB_REGISTER_NODE (ip4_classify_node) = {
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,
330   .n_errors = ARRAY_LEN(ip_classify_error_strings),
331   .error_strings = ip_classify_error_strings,
332
333   .n_next_nodes = 0,
334 };
335
336 VLIB_NODE_FUNCTION_MULTIARCH (ip4_classify_node, ip4_classify)
337
338 static uword
339 ip6_classify (vlib_main_t * vm,
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
347 VLIB_REGISTER_NODE (ip6_classify_node) = {
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,
353   .n_errors = ARRAY_LEN(ip_classify_error_strings),
354   .error_strings = ip_classify_error_strings,
355
356   .n_next_nodes = 0,
357 };
358
359 VLIB_NODE_FUNCTION_MULTIARCH (ip6_classify_node, ip6_classify)
360
361 static clib_error_t *
362 ip_classify_init (vlib_main_t * vm)
363 {
364   return 0;
365 }
366
367 VLIB_INIT_FUNCTION (ip_classify_init);