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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #include <vnet/ip/ip.h>
17 #include <vnet/dpo/mpls_label_dpo.h>
18 #include <vnet/mpls/mpls.h>
21 * pool of all MPLS Label DPOs
23 mpls_label_dpo_t *mpls_label_dpo_pool;
25 static mpls_label_dpo_t *
26 mpls_label_dpo_alloc (void)
28 mpls_label_dpo_t *mld;
30 pool_get_aligned(mpls_label_dpo_pool, mld, CLIB_CACHE_LINE_BYTES);
31 memset(mld, 0, sizeof(*mld));
33 dpo_reset(&mld->mld_dpo);
39 mpls_label_dpo_get_index (mpls_label_dpo_t *mld)
41 return (mld - mpls_label_dpo_pool);
45 mpls_label_dpo_create (mpls_label_t *label_stack,
49 dpo_proto_t payload_proto,
52 mpls_label_dpo_t *mld;
55 mld = mpls_label_dpo_alloc();
56 mld->mld_n_labels = vec_len(label_stack);
57 mld->mld_n_hdr_bytes = mld->mld_n_labels * sizeof(mld->mld_hdr[0]);
58 mld->mld_payload_proto = payload_proto;
61 * construct label rewrite headers for each value value passed.
62 * get the header in network byte order since we will paint it
63 * on a packet in the data-plane
66 for (ii = 0; ii < mld->mld_n_labels-1; ii++)
68 vnet_mpls_uc_set_label(&mld->mld_hdr[ii].label_exp_s_ttl, label_stack[ii]);
69 vnet_mpls_uc_set_ttl(&mld->mld_hdr[ii].label_exp_s_ttl, 255);
70 vnet_mpls_uc_set_exp(&mld->mld_hdr[ii].label_exp_s_ttl, 0);
71 vnet_mpls_uc_set_s(&mld->mld_hdr[ii].label_exp_s_ttl, MPLS_NON_EOS);
72 mld->mld_hdr[ii].label_exp_s_ttl =
73 clib_host_to_net_u32(mld->mld_hdr[ii].label_exp_s_ttl);
77 * the inner most label
79 ii = mld->mld_n_labels-1;
81 vnet_mpls_uc_set_label(&mld->mld_hdr[ii].label_exp_s_ttl, label_stack[ii]);
82 vnet_mpls_uc_set_ttl(&mld->mld_hdr[ii].label_exp_s_ttl, ttl);
83 vnet_mpls_uc_set_exp(&mld->mld_hdr[ii].label_exp_s_ttl, exp);
84 vnet_mpls_uc_set_s(&mld->mld_hdr[ii].label_exp_s_ttl, eos);
85 mld->mld_hdr[ii].label_exp_s_ttl =
86 clib_host_to_net_u32(mld->mld_hdr[ii].label_exp_s_ttl);
89 * stack this label objct on its parent.
91 dpo_stack(DPO_MPLS_LABEL,
92 mld->mld_payload_proto,
96 return (mpls_label_dpo_get_index(mld));
100 format_mpls_label_dpo (u8 *s, va_list *args)
102 index_t index = va_arg (*args, index_t);
103 u32 indent = va_arg (*args, u32);
104 mpls_unicast_header_t hdr;
105 mpls_label_dpo_t *mld;
108 mld = mpls_label_dpo_get(index);
110 s = format(s, "mpls-label:[%d]:", index);
112 for (ii = 0; ii < mld->mld_n_labels; ii++)
114 hdr.label_exp_s_ttl =
115 clib_net_to_host_u32(mld->mld_hdr[ii].label_exp_s_ttl);
116 s = format(s, "%U", format_mpls_header, hdr);
119 s = format(s, "\n%U", format_white_space, indent);
120 s = format(s, "%U", format_dpo_id, &mld->mld_dpo, indent+2);
126 mpls_label_dpo_lock (dpo_id_t *dpo)
128 mpls_label_dpo_t *mld;
130 mld = mpls_label_dpo_get(dpo->dpoi_index);
136 mpls_label_dpo_unlock (dpo_id_t *dpo)
138 mpls_label_dpo_t *mld;
140 mld = mpls_label_dpo_get(dpo->dpoi_index);
144 if (0 == mld->mld_locks)
146 dpo_reset(&mld->mld_dpo);
147 pool_put(mpls_label_dpo_pool, mld);
152 * @brief A struct to hold tracing information for the MPLS label imposition
155 typedef struct mpls_label_imposition_trace_t_
158 * The MPLS header imposed
160 mpls_unicast_header_t hdr;
161 } mpls_label_imposition_trace_t;
163 always_inline mpls_unicast_header_t *
164 mpls_label_paint (vlib_buffer_t * b0,
165 mpls_label_dpo_t *mld0,
168 mpls_unicast_header_t *hdr0;
170 vlib_buffer_advance(b0, -(mld0->mld_n_hdr_bytes));
172 hdr0 = vlib_buffer_get_current(b0);
174 if (1 == mld0->mld_n_labels)
176 /* optimise for the common case of one label */
177 *hdr0 = mld0->mld_hdr[0];
181 clib_memcpy(hdr0, mld0->mld_hdr, mld0->mld_n_hdr_bytes);
182 hdr0 = hdr0 + (mld0->mld_n_labels - 1);
184 /* fixup the TTL for the inner most label */
185 ((char*)hdr0)[3] = ttl0;
191 mpls_label_imposition_inline (vlib_main_t * vm,
192 vlib_node_runtime_t * node,
193 vlib_frame_t * from_frame,
196 u8 payload_is_ethernet)
198 u32 n_left_from, next_index, * from, * to_next;
200 from = vlib_frame_vector_args (from_frame);
201 n_left_from = from_frame->n_vectors;
203 next_index = node->cached_next_index;
205 while (n_left_from > 0)
209 vlib_get_next_frame(vm, node, next_index, to_next, n_left_to_next);
211 while (n_left_from >= 8 && n_left_to_next >= 4)
213 u32 bi0, mldi0, bi1, mldi1, bi2, mldi2, bi3, mldi3;
214 mpls_unicast_header_t *hdr0, *hdr1, *hdr2, *hdr3;
215 mpls_label_dpo_t *mld0, *mld1, *mld2, *mld3;
216 vlib_buffer_t * b0, *b1, * b2, *b3;
217 u32 next0, next1, next2, next3;
218 u8 ttl0, ttl1,ttl2, ttl3 ;
220 bi0 = to_next[0] = from[0];
221 bi1 = to_next[1] = from[1];
222 bi2 = to_next[2] = from[2];
223 bi3 = to_next[3] = from[3];
225 /* Prefetch next iteration. */
227 vlib_buffer_t * p2, * p3, *p4, *p5;
229 p2 = vlib_get_buffer (vm, from[2]);
230 p3 = vlib_get_buffer (vm, from[3]);
231 p4 = vlib_get_buffer (vm, from[4]);
232 p5 = vlib_get_buffer (vm, from[5]);
234 vlib_prefetch_buffer_header (p2, STORE);
235 vlib_prefetch_buffer_header (p3, STORE);
236 vlib_prefetch_buffer_header (p4, STORE);
237 vlib_prefetch_buffer_header (p5, STORE);
239 CLIB_PREFETCH (p2->data, sizeof (hdr0[0]), STORE);
240 CLIB_PREFETCH (p3->data, sizeof (hdr0[0]), STORE);
241 CLIB_PREFETCH (p4->data, sizeof (hdr0[0]), STORE);
242 CLIB_PREFETCH (p5->data, sizeof (hdr0[0]), STORE);
250 b0 = vlib_get_buffer (vm, bi0);
251 b1 = vlib_get_buffer (vm, bi1);
252 b2 = vlib_get_buffer (vm, bi2);
253 b3 = vlib_get_buffer (vm, bi3);
255 /* dst lookup was done by ip4 lookup */
256 mldi0 = vnet_buffer(b0)->ip.adj_index[VLIB_TX];
257 mldi1 = vnet_buffer(b1)->ip.adj_index[VLIB_TX];
258 mldi2 = vnet_buffer(b2)->ip.adj_index[VLIB_TX];
259 mldi3 = vnet_buffer(b3)->ip.adj_index[VLIB_TX];
260 mld0 = mpls_label_dpo_get(mldi0);
261 mld1 = mpls_label_dpo_get(mldi1);
262 mld2 = mpls_label_dpo_get(mldi2);
263 mld3 = mpls_label_dpo_get(mldi3);
268 * decrement the TTL on ingress to the LSP
270 ip4_header_t * ip0 = vlib_buffer_get_current(b0);
271 ip4_header_t * ip1 = vlib_buffer_get_current(b1);
272 ip4_header_t * ip2 = vlib_buffer_get_current(b2);
273 ip4_header_t * ip3 = vlib_buffer_get_current(b3);
279 checksum0 = ip0->checksum + clib_host_to_net_u16 (0x0100);
280 checksum1 = ip1->checksum + clib_host_to_net_u16 (0x0100);
281 checksum2 = ip2->checksum + clib_host_to_net_u16 (0x0100);
282 checksum3 = ip3->checksum + clib_host_to_net_u16 (0x0100);
284 checksum0 += checksum0 >= 0xffff;
285 checksum1 += checksum1 >= 0xffff;
286 checksum2 += checksum2 >= 0xffff;
287 checksum3 += checksum3 >= 0xffff;
289 ip0->checksum = checksum0;
290 ip1->checksum = checksum1;
291 ip2->checksum = checksum2;
292 ip3->checksum = checksum3;
304 else if (payload_is_ip6)
307 * decrement the TTL on ingress to the LSP
309 ip6_header_t * ip0 = vlib_buffer_get_current(b0);
310 ip6_header_t * ip1 = vlib_buffer_get_current(b1);
311 ip6_header_t * ip2 = vlib_buffer_get_current(b2);
312 ip6_header_t * ip3 = vlib_buffer_get_current(b3);
319 ttl0 = ip0->hop_limit;
320 ttl1 = ip1->hop_limit;
321 ttl2 = ip2->hop_limit;
322 ttl3 = ip3->hop_limit;
324 else if (payload_is_ethernet)
327 * nothing to chang ein the ethernet header
329 ttl0 = ttl1 = ttl2 = ttl3 = 255;
334 * else, the packet to be encapped is an MPLS packet
336 if (PREDICT_TRUE(vnet_buffer(b0)->mpls.first))
339 * The first label to be imposed on the packet. this is a label swap.
340 * in which case we stashed the TTL and EXP bits in the
341 * packet in the lookup node
343 ASSERT(0 != vnet_buffer (b0)->mpls.ttl);
345 ttl0 = vnet_buffer(b0)->mpls.ttl - 1;
350 * not the first label. implying we are recusring down a chain of
352 * Each layer is considered a new LSP - hence the TTL is reset.
356 if (PREDICT_TRUE(vnet_buffer(b1)->mpls.first))
358 ASSERT(1 != vnet_buffer (b1)->mpls.ttl);
359 ttl1 = vnet_buffer(b1)->mpls.ttl - 1;
365 if (PREDICT_TRUE(vnet_buffer(b2)->mpls.first))
367 ASSERT(1 != vnet_buffer (b2)->mpls.ttl);
369 ttl2 = vnet_buffer(b2)->mpls.ttl - 1;
375 if (PREDICT_TRUE(vnet_buffer(b3)->mpls.first))
377 ASSERT(1 != vnet_buffer (b3)->mpls.ttl);
378 ttl3 = vnet_buffer(b3)->mpls.ttl - 1;
385 vnet_buffer(b0)->mpls.first = 0;
386 vnet_buffer(b1)->mpls.first = 0;
387 vnet_buffer(b2)->mpls.first = 0;
388 vnet_buffer(b3)->mpls.first = 0;
390 /* Paint the MPLS header */
391 hdr0 = mpls_label_paint(b0, mld0, ttl0);
392 hdr1 = mpls_label_paint(b1, mld1, ttl1);
393 hdr2 = mpls_label_paint(b2, mld2, ttl2);
394 hdr3 = mpls_label_paint(b3, mld3, ttl3);
396 next0 = mld0->mld_dpo.dpoi_next_node;
397 next1 = mld1->mld_dpo.dpoi_next_node;
398 next2 = mld2->mld_dpo.dpoi_next_node;
399 next3 = mld3->mld_dpo.dpoi_next_node;
400 vnet_buffer(b0)->ip.adj_index[VLIB_TX] = mld0->mld_dpo.dpoi_index;
401 vnet_buffer(b1)->ip.adj_index[VLIB_TX] = mld1->mld_dpo.dpoi_index;
402 vnet_buffer(b2)->ip.adj_index[VLIB_TX] = mld2->mld_dpo.dpoi_index;
403 vnet_buffer(b3)->ip.adj_index[VLIB_TX] = mld3->mld_dpo.dpoi_index;
405 if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED))
407 mpls_label_imposition_trace_t *tr =
408 vlib_add_trace (vm, node, b0, sizeof (*tr));
411 if (PREDICT_FALSE(b1->flags & VLIB_BUFFER_IS_TRACED))
413 mpls_label_imposition_trace_t *tr =
414 vlib_add_trace (vm, node, b1, sizeof (*tr));
417 if (PREDICT_FALSE(b2->flags & VLIB_BUFFER_IS_TRACED))
419 mpls_label_imposition_trace_t *tr =
420 vlib_add_trace (vm, node, b2, sizeof (*tr));
423 if (PREDICT_FALSE(b3->flags & VLIB_BUFFER_IS_TRACED))
425 mpls_label_imposition_trace_t *tr =
426 vlib_add_trace (vm, node, b3, sizeof (*tr));
430 vlib_validate_buffer_enqueue_x4(vm, node, next_index, to_next,
433 next0, next1, next2, next3);
436 while (n_left_from > 0 && n_left_to_next > 0)
438 mpls_unicast_header_t *hdr0;
439 mpls_label_dpo_t *mld0;
452 b0 = vlib_get_buffer (vm, bi0);
454 /* dst lookup was done by ip4 lookup */
455 mldi0 = vnet_buffer(b0)->ip.adj_index[VLIB_TX];
456 mld0 = mpls_label_dpo_get(mldi0);
461 * decrement the TTL on ingress to the LSP
463 ip4_header_t * ip0 = vlib_buffer_get_current(b0);
466 checksum0 = ip0->checksum + clib_host_to_net_u16 (0x0100);
467 checksum0 += checksum0 >= 0xffff;
469 ip0->checksum = checksum0;
473 else if (payload_is_ip6)
476 * decrement the TTL on ingress to the LSP
478 ip6_header_t * ip0 = vlib_buffer_get_current(b0);
481 ttl = ip0->hop_limit;
486 * else, the packet to be encapped is an MPLS packet
488 if (vnet_buffer(b0)->mpls.first)
491 * The first label to be imposed on the packet. this is a label swap.
492 * in which case we stashed the TTL and EXP bits in the
493 * packet in the lookup node
495 ASSERT(0 != vnet_buffer (b0)->mpls.ttl);
497 ttl = vnet_buffer(b0)->mpls.ttl - 1;
502 * not the first label. implying we are recusring down a chain of
504 * Each layer is considered a new LSP - hence the TTL is reset.
509 vnet_buffer(b0)->mpls.first = 0;
511 /* Paint the MPLS header */
512 vlib_buffer_advance(b0, -(mld0->mld_n_hdr_bytes));
513 hdr0 = vlib_buffer_get_current(b0);
514 clib_memcpy(hdr0, mld0->mld_hdr, mld0->mld_n_hdr_bytes);
516 /* fixup the TTL for the inner most label */
517 hdr0 = hdr0 + (mld0->mld_n_labels - 1);
518 ((char*)hdr0)[3] = ttl;
520 next0 = mld0->mld_dpo.dpoi_next_node;
521 vnet_buffer(b0)->ip.adj_index[VLIB_TX] = mld0->mld_dpo.dpoi_index;
523 if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED))
525 mpls_label_imposition_trace_t *tr =
526 vlib_add_trace (vm, node, b0, sizeof (*tr));
530 vlib_validate_buffer_enqueue_x1(vm, node, next_index, to_next,
531 n_left_to_next, bi0, next0);
533 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
535 return from_frame->n_vectors;
539 format_mpls_label_imposition_trace (u8 * s, va_list * args)
541 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
542 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
543 mpls_label_imposition_trace_t * t;
544 mpls_unicast_header_t hdr;
547 t = va_arg (*args, mpls_label_imposition_trace_t *);
548 indent = format_get_indent (s);
549 hdr.label_exp_s_ttl = clib_net_to_host_u32(t->hdr.label_exp_s_ttl);
551 s = format (s, "%Umpls-header:%U",
552 format_white_space, indent,
553 format_mpls_header, hdr);
558 mpls_label_imposition (vlib_main_t * vm,
559 vlib_node_runtime_t * node,
560 vlib_frame_t * frame)
562 return (mpls_label_imposition_inline(vm, node, frame, 0, 0, 0));
565 VLIB_REGISTER_NODE (mpls_label_imposition_node) = {
566 .function = mpls_label_imposition,
567 .name = "mpls-label-imposition",
568 .vector_size = sizeof (u32),
570 .format_trace = format_mpls_label_imposition_trace,
576 VLIB_NODE_FUNCTION_MULTIARCH (mpls_label_imposition_node,
577 mpls_label_imposition)
580 ip4_mpls_label_imposition (vlib_main_t * vm,
581 vlib_node_runtime_t * node,
582 vlib_frame_t * frame)
584 return (mpls_label_imposition_inline(vm, node, frame, 1, 0, 0));
587 VLIB_REGISTER_NODE (ip4_mpls_label_imposition_node) = {
588 .function = ip4_mpls_label_imposition,
589 .name = "ip4-mpls-label-imposition",
590 .vector_size = sizeof (u32),
592 .format_trace = format_mpls_label_imposition_trace,
598 VLIB_NODE_FUNCTION_MULTIARCH (ip4_mpls_label_imposition_node,
599 ip4_mpls_label_imposition)
602 ip6_mpls_label_imposition (vlib_main_t * vm,
603 vlib_node_runtime_t * node,
604 vlib_frame_t * frame)
606 return (mpls_label_imposition_inline(vm, node, frame, 0, 1, 0));
609 VLIB_REGISTER_NODE (ip6_mpls_label_imposition_node) = {
610 .function = ip6_mpls_label_imposition,
611 .name = "ip6-mpls-label-imposition",
612 .vector_size = sizeof (u32),
614 .format_trace = format_mpls_label_imposition_trace,
620 VLIB_NODE_FUNCTION_MULTIARCH (ip6_mpls_label_imposition_node,
621 ip6_mpls_label_imposition)
624 ethernet_mpls_label_imposition (vlib_main_t * vm,
625 vlib_node_runtime_t * node,
626 vlib_frame_t * frame)
628 return (mpls_label_imposition_inline(vm, node, frame, 0, 0, 1));
631 VLIB_REGISTER_NODE (ethernet_mpls_label_imposition_node) = {
632 .function = ethernet_mpls_label_imposition,
633 .name = "ethernet-mpls-label-imposition",
634 .vector_size = sizeof (u32),
636 .format_trace = format_mpls_label_imposition_trace,
642 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_mpls_label_imposition_node,
643 ethernet_mpls_label_imposition)
646 mpls_label_dpo_mem_show (void)
648 fib_show_memory_usage("MPLS label",
649 pool_elts(mpls_label_dpo_pool),
650 pool_len(mpls_label_dpo_pool),
651 sizeof(mpls_label_dpo_t));
654 const static dpo_vft_t mld_vft = {
655 .dv_lock = mpls_label_dpo_lock,
656 .dv_unlock = mpls_label_dpo_unlock,
657 .dv_format = format_mpls_label_dpo,
658 .dv_mem_show = mpls_label_dpo_mem_show,
661 const static char* const mpls_label_imp_ip4_nodes[] =
663 "ip4-mpls-label-imposition",
666 const static char* const mpls_label_imp_ip6_nodes[] =
668 "ip6-mpls-label-imposition",
671 const static char* const mpls_label_imp_mpls_nodes[] =
673 "mpls-label-imposition",
676 const static char* const mpls_label_imp_ethernet_nodes[] =
678 "ethernet-mpls-label-imposition",
682 const static char* const * const mpls_label_imp_nodes[DPO_PROTO_NUM] =
684 [DPO_PROTO_IP4] = mpls_label_imp_ip4_nodes,
685 [DPO_PROTO_IP6] = mpls_label_imp_ip6_nodes,
686 [DPO_PROTO_MPLS] = mpls_label_imp_mpls_nodes,
687 [DPO_PROTO_ETHERNET] = mpls_label_imp_ethernet_nodes,
692 mpls_label_dpo_module_init (void)
694 dpo_register(DPO_MPLS_LABEL, &mld_vft, mpls_label_imp_nodes);