Allow the provider of a midchain adjacency to pass context data that is returned...
[vpp.git] / src / vnet / mpls / mpls_output.c
1 /*
2  * mpls_output.c: MPLS Adj rewrite
3  *
4  * Copyright (c) 2012-2014 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/pg/pg.h>
20 #include <vnet/ip/ip.h>
21 #include <vnet/mpls/mpls.h>
22
23 typedef struct {
24   /* Adjacency taken. */
25   u32 adj_index;
26   u32 flow_hash;
27 } mpls_output_trace_t;
28
29 #define foreach_mpls_output_next                \
30 _(DROP, "error-drop")
31
32 typedef enum {
33 #define _(s,n) MPLS_OUTPUT_NEXT_##s,
34   foreach_mpls_output_next
35 #undef _
36   MPLS_OUTPUT_N_NEXT,
37 } mpls_output_next_t;
38
39 static u8 *
40 format_mpls_output_trace (u8 * s, va_list * args)
41 {
42   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
43   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
44   mpls_output_trace_t * t = va_arg (*args, mpls_output_trace_t *);
45
46   s = format (s, "adj-idx %d : %U flow hash: 0x%08x",
47               t->adj_index,
48               format_ip_adjacency, t->adj_index, FORMAT_IP_ADJACENCY_NONE,
49               t->flow_hash);
50   return s;
51 }
52
53 static inline uword
54 mpls_output_inline (vlib_main_t * vm,
55                     vlib_node_runtime_t * node,
56                     vlib_frame_t * from_frame,
57                     int is_midchain)
58 {
59   u32 n_left_from, next_index, * from, * to_next, thread_index;
60   vlib_node_runtime_t * error_node;
61   u32 n_left_to_next;
62   mpls_main_t *mm;
63
64   thread_index = vlib_get_thread_index();
65   error_node = vlib_node_get_runtime (vm, mpls_output_node.index);
66   from = vlib_frame_vector_args (from_frame);
67   n_left_from = from_frame->n_vectors;
68   next_index = node->cached_next_index;
69   mm = &mpls_main;
70
71   while (n_left_from > 0)
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           ip_adjacency_t * adj0;
79           mpls_unicast_header_t *hdr0;
80           vlib_buffer_t * p0;
81           u32 pi0, rw_len0, adj_index0, next0, error0;
82
83           ip_adjacency_t * adj1;
84           mpls_unicast_header_t *hdr1;
85           vlib_buffer_t * p1;
86           u32 pi1, rw_len1, adj_index1, next1, error1;
87
88           /* Prefetch next iteration. */
89           {
90             vlib_buffer_t * p2, * p3;
91
92             p2 = vlib_get_buffer (vm, from[2]);
93             p3 = vlib_get_buffer (vm, from[3]);
94
95             vlib_prefetch_buffer_header (p2, STORE);
96             vlib_prefetch_buffer_header (p3, STORE);
97
98             CLIB_PREFETCH (p2->data, sizeof (hdr0[0]), STORE);
99             CLIB_PREFETCH (p3->data, sizeof (hdr1[0]), STORE);
100           }
101
102           pi0 = to_next[0] = from[0];
103           pi1 = to_next[1] = from[1];
104
105           from += 2;
106           n_left_from -= 2;
107           to_next += 2;
108           n_left_to_next -= 2;
109
110           p0 = vlib_get_buffer (vm, pi0);
111           p1 = vlib_get_buffer (vm, pi1);
112
113           adj_index0 = vnet_buffer (p0)->ip.adj_index[VLIB_TX];
114           adj_index1 = vnet_buffer (p1)->ip.adj_index[VLIB_TX];
115
116           adj0 = adj_get(adj_index0);
117           adj1 = adj_get(adj_index1);
118           hdr0 = vlib_buffer_get_current (p0);
119           hdr1 = vlib_buffer_get_current (p1);
120
121           /* Guess we are only writing on simple Ethernet header. */
122           vnet_rewrite_two_headers (adj0[0], adj1[0], hdr0, hdr1,
123                                    sizeof (ethernet_header_t));
124
125           /* Update packet buffer attributes/set output interface. */
126           rw_len0 = adj0[0].rewrite_header.data_bytes;
127           rw_len1 = adj1[0].rewrite_header.data_bytes;
128
129           /* Bump the adj counters for packet and bytes */
130           vlib_increment_combined_counter
131               (&adjacency_counters,
132                thread_index,
133                adj_index0,
134                1,
135                vlib_buffer_length_in_chain (vm, p0) + rw_len0);
136           vlib_increment_combined_counter
137               (&adjacency_counters,
138                thread_index,
139                adj_index1,
140                1,
141                vlib_buffer_length_in_chain (vm, p1) + rw_len1);
142
143           /* Check MTU of outgoing interface. */
144           if (PREDICT_TRUE(vlib_buffer_length_in_chain (vm, p0) <=
145                            adj0[0].rewrite_header.max_l3_packet_bytes))
146             {
147               p0->current_data -= rw_len0;
148               p0->current_length += rw_len0;
149
150               vnet_buffer (p0)->sw_if_index[VLIB_TX] =
151                   adj0[0].rewrite_header.sw_if_index;
152               next0 = adj0[0].rewrite_header.next_index;
153               error0 = IP4_ERROR_NONE;
154
155               if (PREDICT_FALSE(adj0[0].rewrite_header.flags & VNET_REWRITE_HAS_FEATURES))
156                 vnet_feature_arc_start (mm->output_feature_arc_index,
157                                         adj0[0].rewrite_header.sw_if_index,
158                                         &next0, p0);
159             }
160           else
161             {
162               error0 = IP4_ERROR_MTU_EXCEEDED;
163               next0 = MPLS_OUTPUT_NEXT_DROP;
164             }
165           if (PREDICT_TRUE(vlib_buffer_length_in_chain (vm, p1) <=
166                            adj1[0].rewrite_header.max_l3_packet_bytes))
167             {
168               p1->current_data -= rw_len1;
169               p1->current_length += rw_len1;
170
171               vnet_buffer (p1)->sw_if_index[VLIB_TX] =
172                   adj1[0].rewrite_header.sw_if_index;
173               next1 = adj1[0].rewrite_header.next_index;
174               error1 = IP4_ERROR_NONE;
175
176               if (PREDICT_FALSE(adj1[0].rewrite_header.flags & VNET_REWRITE_HAS_FEATURES))
177                 vnet_feature_arc_start (mm->output_feature_arc_index,
178                                         adj1[0].rewrite_header.sw_if_index,
179                                         &next1, p1);
180             }
181           else
182             {
183               error1 = IP4_ERROR_MTU_EXCEEDED;
184               next1 = MPLS_OUTPUT_NEXT_DROP;
185             }
186           if (is_midchain)
187           {
188               adj0->sub_type.midchain.fixup_func
189                 (vm, adj0, p0,
190                  adj0->sub_type.midchain.fixup_data);
191               adj1->sub_type.midchain.fixup_func
192                 (vm, adj1, p1,
193                  adj1->sub_type.midchain.fixup_data);
194           }
195
196           p0->error = error_node->errors[error0];
197           p1->error = error_node->errors[error1];
198
199           if (PREDICT_FALSE(p0->flags & VLIB_BUFFER_IS_TRACED))
200             {
201               mpls_output_trace_t *tr = vlib_add_trace (vm, node,
202                                                         p0, sizeof (*tr));
203               tr->adj_index = vnet_buffer(p0)->ip.adj_index[VLIB_TX];
204               tr->flow_hash = vnet_buffer(p0)->ip.flow_hash;
205             }
206           if (PREDICT_FALSE(p1->flags & VLIB_BUFFER_IS_TRACED))
207             {
208               mpls_output_trace_t *tr = vlib_add_trace (vm, node,
209                                                         p1, sizeof (*tr));
210               tr->adj_index = vnet_buffer(p1)->ip.adj_index[VLIB_TX];
211               tr->flow_hash = vnet_buffer(p1)->ip.flow_hash;
212             }
213
214           vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
215                                            to_next, n_left_to_next,
216                                            pi0, pi1, next0, next1);
217         }
218
219       while (n_left_from > 0 && n_left_to_next > 0)
220         {
221           ip_adjacency_t * adj0;
222           mpls_unicast_header_t *hdr0;
223           vlib_buffer_t * p0;
224           u32 pi0, rw_len0, adj_index0, next0, error0;
225
226           pi0 = to_next[0] = from[0];
227
228           p0 = vlib_get_buffer (vm, pi0);
229
230           adj_index0 = vnet_buffer (p0)->ip.adj_index[VLIB_TX];
231
232           adj0 = adj_get(adj_index0);
233           hdr0 = vlib_buffer_get_current (p0);
234
235           /* Guess we are only writing on simple Ethernet header. */
236           vnet_rewrite_one_header (adj0[0], hdr0, 
237                                    sizeof (ethernet_header_t));
238           
239           /* Update packet buffer attributes/set output interface. */
240           rw_len0 = adj0[0].rewrite_header.data_bytes;
241           
242           vlib_increment_combined_counter
243               (&adjacency_counters,
244                thread_index,
245                adj_index0,
246                1,
247                vlib_buffer_length_in_chain (vm, p0) + rw_len0);
248           
249           /* Check MTU of outgoing interface. */
250           if (PREDICT_TRUE(vlib_buffer_length_in_chain (vm, p0) <=
251                            adj0[0].rewrite_header.max_l3_packet_bytes))
252             {
253               p0->current_data -= rw_len0;
254               p0->current_length += rw_len0;
255
256               vnet_buffer (p0)->sw_if_index[VLIB_TX] =
257                   adj0[0].rewrite_header.sw_if_index;
258               next0 = adj0[0].rewrite_header.next_index;
259               error0 = IP4_ERROR_NONE;
260
261               if (PREDICT_FALSE(adj0[0].rewrite_header.flags & VNET_REWRITE_HAS_FEATURES))
262                 vnet_feature_arc_start (mm->output_feature_arc_index,
263                                         adj0[0].rewrite_header.sw_if_index,
264                                         &next0, p0);
265             }
266           else
267             {
268               error0 = IP4_ERROR_MTU_EXCEEDED;
269               next0 = MPLS_OUTPUT_NEXT_DROP;
270             }
271           if (is_midchain)
272           {
273               adj0->sub_type.midchain.fixup_func
274                 (vm, adj0, p0,
275                  adj0->sub_type.midchain.fixup_data);
276           }
277
278           p0->error = error_node->errors[error0];
279
280           from += 1;
281           n_left_from -= 1;
282           to_next += 1;
283           n_left_to_next -= 1;
284       
285           if (PREDICT_FALSE(p0->flags & VLIB_BUFFER_IS_TRACED)) 
286             {
287               mpls_output_trace_t *tr = vlib_add_trace (vm, node, 
288                                                         p0, sizeof (*tr));
289               tr->adj_index = vnet_buffer(p0)->ip.adj_index[VLIB_TX];
290               tr->flow_hash = vnet_buffer(p0)->ip.flow_hash;
291             }
292
293           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
294                                            to_next, n_left_to_next,
295                                            pi0, next0);
296         }
297
298       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
299     }
300   vlib_node_increment_counter (vm, mpls_output_node.index,
301                                MPLS_ERROR_PKTS_ENCAP,
302                                from_frame->n_vectors);
303
304   return from_frame->n_vectors;
305 }
306
307 static char * mpls_error_strings[] = {
308 #define mpls_error(n,s) s,
309 #include "error.def"
310 #undef mpls_error
311 };
312
313 static inline uword
314 mpls_output (vlib_main_t * vm,
315              vlib_node_runtime_t * node,
316              vlib_frame_t * from_frame)
317 {
318     return (mpls_output_inline(vm, node, from_frame, /* is_midchain */ 0));
319 }
320
321 VLIB_REGISTER_NODE (mpls_output_node) = {
322   .function = mpls_output,
323   .name = "mpls-output",
324   /* Takes a vector of packets. */
325   .vector_size = sizeof (u32),
326   .n_errors = MPLS_N_ERROR,
327   .error_strings = mpls_error_strings,
328
329   .n_next_nodes = MPLS_OUTPUT_N_NEXT,
330   .next_nodes = {
331 #define _(s,n) [MPLS_OUTPUT_NEXT_##s] = n,
332     foreach_mpls_output_next
333 #undef _
334   },
335
336   .format_trace = format_mpls_output_trace,
337 };
338
339 VLIB_NODE_FUNCTION_MULTIARCH (mpls_output_node, mpls_output)
340
341 static inline uword
342 mpls_midchain (vlib_main_t * vm,
343                vlib_node_runtime_t * node,
344                vlib_frame_t * from_frame)
345 {
346     return (mpls_output_inline(vm, node, from_frame, /* is_midchain */ 1));
347 }
348
349 VLIB_REGISTER_NODE (mpls_midchain_node) = {
350   .function = mpls_midchain,
351   .name = "mpls-midchain",
352   .vector_size = sizeof (u32),
353
354   .format_trace = format_mpls_output_trace,
355
356   .sibling_of = "mpls-output",
357 };
358
359 VLIB_NODE_FUNCTION_MULTIARCH (mpls_midchain_node, mpls_midchain)
360
361 /**
362  * @brief Next index values from the MPLS incomplete adj node
363  */
364 #define foreach_mpls_adj_incomplete_next        \
365 _(DROP, "error-drop")                   \
366 _(IP4,  "ip4-arp")                      \
367 _(IP6,  "ip6-discover-neighbor")
368
369 typedef enum {
370 #define _(s,n) MPLS_ADJ_INCOMPLETE_NEXT_##s,
371   foreach_mpls_adj_incomplete_next
372 #undef _
373   MPLS_ADJ_INCOMPLETE_N_NEXT,
374 } mpls_adj_incomplete_next_t;
375
376 /**
377  * @brief A struct to hold tracing information for the MPLS label imposition
378  * node.
379  */
380 typedef struct mpls_adj_incomplete_trace_t_
381 {
382     u32 next;
383 } mpls_adj_incomplete_trace_t;
384
385
386 /**
387  * @brief Graph node for incomplete MPLS adjacency.
388  * This node will push traffic to either the v4-arp or v6-nd node
389  * based on the next-hop proto of the adj.
390  * We pay a cost for this 'routing' node, but an incomplete adj is the
391  * exception case.
392  */
393 static inline uword
394 mpls_adj_incomplete (vlib_main_t * vm,
395                      vlib_node_runtime_t * node,
396                      vlib_frame_t * from_frame)
397 {
398     u32 n_left_from, next_index, * from, * to_next;
399
400   from = vlib_frame_vector_args (from_frame);
401   n_left_from = from_frame->n_vectors;
402   next_index = node->cached_next_index;
403
404   while (n_left_from > 0)
405     {
406       u32 n_left_to_next;
407
408       vlib_get_next_frame (vm, node, next_index,
409                            to_next, n_left_to_next);
410
411       while (n_left_from > 0 && n_left_to_next > 0)
412         {
413           u32 pi0, next0, adj_index0;
414           ip_adjacency_t * adj0;
415           vlib_buffer_t * p0;
416
417           pi0 = to_next[0] = from[0];
418           p0 = vlib_get_buffer (vm, pi0);
419           from += 1;
420           n_left_from -= 1;
421           to_next += 1;
422           n_left_to_next -= 1;
423
424           adj_index0 = vnet_buffer (p0)->ip.adj_index[VLIB_TX];
425
426           adj0 = adj_get(adj_index0);
427
428           if (PREDICT_TRUE(FIB_PROTOCOL_IP4 == adj0->ia_nh_proto))
429           {
430               next0 = MPLS_ADJ_INCOMPLETE_NEXT_IP4;
431           }
432           else
433           {
434               next0 = MPLS_ADJ_INCOMPLETE_NEXT_IP6;
435           }              
436
437           if (PREDICT_FALSE(p0->flags & VLIB_BUFFER_IS_TRACED)) 
438           {
439               mpls_adj_incomplete_trace_t *tr =
440                   vlib_add_trace (vm, node, p0, sizeof (*tr));
441               tr->next = next0;
442           }
443
444           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
445                                            to_next, n_left_to_next,
446                                            pi0, next0);
447         }
448
449       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
450     }
451
452   return from_frame->n_vectors;
453 }
454
455 static u8 *
456 format_mpls_adj_incomplete_trace (u8 * s, va_list * args)
457 {
458     CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
459     CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
460     mpls_adj_incomplete_trace_t * t;
461     u32 indent;
462
463     t = va_arg (*args, mpls_adj_incomplete_trace_t *);
464     indent = format_get_indent (s);
465
466     s = format (s, "%Unext:%d",
467                 format_white_space, indent,
468                 t->next);
469     return (s);
470 }
471
472 VLIB_REGISTER_NODE (mpls_adj_incomplete_node) = {
473   .function = mpls_adj_incomplete,
474   .name = "mpls-adj-incomplete",
475   .format_trace = format_mpls_adj_incomplete_trace,
476   /* Takes a vector of packets. */
477   .vector_size = sizeof (u32),
478   .n_errors = MPLS_N_ERROR,
479   .error_strings = mpls_error_strings,
480
481   .n_next_nodes = MPLS_ADJ_INCOMPLETE_N_NEXT,
482   .next_nodes = {
483 #define _(s,n) [MPLS_ADJ_INCOMPLETE_NEXT_##s] = n,
484     foreach_mpls_adj_incomplete_next
485 #undef _
486   },
487 };
488
489 VLIB_NODE_FUNCTION_MULTIARCH (mpls_adj_incomplete_node,
490                               mpls_adj_incomplete)