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/lookup.h>
17 #include <vnet/dpo/replicate_dpo.h>
18 #include <vnet/dpo/drop_dpo.h>
19 #include <vnet/adj/adj.h>
20 #include <vnet/mpls/mpls_types.h>
25 #define REP_DBG(_rep, _fmt, _args...) \
28 clib_warning("rep:[%s]:" _fmt, \
29 replicate_format(replicate_get_index((_rep)), \
35 #define REP_DBG(_p, _fmt, _args...)
38 #define foreach_replicate_dpo_error \
39 _(BUFFER_ALLOCATION_FAILURE, "Buffer Allocation Failure")
42 #define _(sym,str) REPLICATE_DPO_ERROR_##sym,
43 foreach_replicate_dpo_error
45 REPLICATE_DPO_N_ERROR,
46 } replicate_dpo_error_t;
48 static char * replicate_dpo_error_strings[] = {
49 #define _(sym,string) string,
50 foreach_replicate_dpo_error
55 * Pool of all DPOs. It's not static so the DP can have fast access
57 replicate_t *replicate_pool;
60 * The one instance of replicate main
62 replicate_main_t replicate_main;
65 replicate_get_index (const replicate_t *rep)
67 return (rep - replicate_pool);
70 static inline dpo_id_t*
71 replicate_get_buckets (replicate_t *rep)
73 if (REP_HAS_INLINE_BUCKETS(rep))
75 return (rep->rep_buckets_inline);
79 return (rep->rep_buckets);
84 replicate_alloc_i (void)
88 pool_get_aligned(replicate_pool, rep, CLIB_CACHE_LINE_BYTES);
89 memset(rep, 0, sizeof(*rep));
91 vlib_validate_combined_counter(&(replicate_main.repm_counters),
92 replicate_get_index(rep));
93 vlib_zero_combined_counter(&(replicate_main.repm_counters),
94 replicate_get_index(rep));
100 replicate_format (index_t repi,
101 replicate_format_flags_t flags,
110 repi &= ~MPLS_IS_REPLICATE;
111 rep = replicate_get(repi);
112 vlib_get_combined_counter(&(replicate_main.repm_counters), repi, &to);
113 buckets = replicate_get_buckets(rep);
115 s = format(s, "%U: ", format_dpo_type, DPO_REPLICATE);
116 s = format(s, "[index:%d buckets:%d ", repi, rep->rep_n_buckets);
117 s = format(s, "to:[%Ld:%Ld]]", to.packets, to.bytes);
119 for (i = 0; i < rep->rep_n_buckets; i++)
121 s = format(s, "\n%U", format_white_space, indent+2);
122 s = format(s, "[%d]", i);
123 s = format(s, " %U", format_dpo_id, &buckets[i], indent+6);
129 format_replicate (u8 * s, va_list * args)
131 index_t repi = va_arg(*args, index_t);
132 replicate_format_flags_t flags = va_arg(*args, replicate_format_flags_t);
134 return (replicate_format(repi, flags, 0, s));
137 format_replicate_dpo (u8 * s, va_list * args)
139 index_t repi = va_arg(*args, index_t);
140 u32 indent = va_arg(*args, u32);
142 return (replicate_format(repi, REPLICATE_FORMAT_DETAIL, indent, s));
147 replicate_create_i (u32 num_buckets,
148 dpo_proto_t rep_proto)
152 rep = replicate_alloc_i();
153 rep->rep_n_buckets = num_buckets;
154 rep->rep_proto = rep_proto;
156 if (!REP_HAS_INLINE_BUCKETS(rep))
158 vec_validate_aligned(rep->rep_buckets,
159 rep->rep_n_buckets - 1,
160 CLIB_CACHE_LINE_BYTES);
163 REP_DBG(rep, "create");
169 replicate_create (u32 n_buckets,
170 dpo_proto_t rep_proto)
172 return (replicate_get_index(replicate_create_i(n_buckets, rep_proto)));
176 replicate_set_bucket_i (replicate_t *rep,
179 const dpo_id_t *next)
181 dpo_stack(DPO_REPLICATE, rep->rep_proto, &buckets[bucket], next);
185 replicate_set_bucket (index_t repi,
187 const dpo_id_t *next)
192 repi &= ~MPLS_IS_REPLICATE;
193 rep = replicate_get(repi);
194 buckets = replicate_get_buckets(rep);
196 ASSERT(bucket < rep->rep_n_buckets);
198 replicate_set_bucket_i(rep, bucket, buckets, next);
202 replicate_is_drop (const dpo_id_t *dpo)
207 if (DPO_REPLICATE != dpo->dpoi_type)
210 repi = dpo->dpoi_index & ~MPLS_IS_REPLICATE;
211 rep = replicate_get(repi);
213 if (1 == rep->rep_n_buckets)
215 return (dpo_is_drop(replicate_get_bucket_i(rep, 0)));
221 replicate_get_bucket (index_t repi,
226 repi &= ~MPLS_IS_REPLICATE;
227 rep = replicate_get(repi);
229 return (replicate_get_bucket_i(rep, bucket));
233 static load_balance_path_t *
234 replicate_multipath_next_hop_fixup (load_balance_path_t *nhs,
235 dpo_proto_t drop_proto)
237 if (0 == vec_len(nhs))
239 load_balance_path_t *nh;
242 * we need something for the replicate. so use the drop
244 vec_add2(nhs, nh, 1);
247 dpo_copy(&nh->path_dpo, drop_dpo_get(drop_proto));
254 * Fill in adjacencies in block based on corresponding
255 * next hop adjacencies.
258 replicate_fill_buckets (replicate_t *rep,
259 load_balance_path_t *nhs,
263 load_balance_path_t * nh;
269 * the next-hops have normalised weights. that means their sum is the number
270 * of buckets we need to fill.
272 vec_foreach (nh, nhs)
274 ASSERT(bucket < n_buckets);
275 replicate_set_bucket_i(rep, bucket++, buckets, &nh->path_dpo);
280 replicate_set_n_buckets (replicate_t *rep,
283 rep->rep_n_buckets = n_buckets;
287 replicate_multipath_update (const dpo_id_t *dpo,
288 load_balance_path_t * next_hops)
290 load_balance_path_t * nh, * nhs;
296 ASSERT(DPO_REPLICATE == dpo->dpoi_type);
297 repi = dpo->dpoi_index & ~MPLS_IS_REPLICATE;
298 rep = replicate_get(repi);
299 nhs = replicate_multipath_next_hop_fixup(next_hops,
301 n_buckets = vec_len(nhs);
303 if (0 == rep->rep_n_buckets)
306 * first time initialisation. no packets inflight, so we can write
309 replicate_set_n_buckets(rep, n_buckets);
311 if (!REP_HAS_INLINE_BUCKETS(rep))
312 vec_validate_aligned(rep->rep_buckets,
313 rep->rep_n_buckets - 1,
314 CLIB_CACHE_LINE_BYTES);
316 replicate_fill_buckets(rep, nhs,
317 replicate_get_buckets(rep),
323 * This is a modification of an existing replicate.
324 * We need to ensure that packets in flight see a consistent state, that
325 * is the number of reported buckets the REP has
326 * is not more than it actually has. So if the
327 * number of buckets is increasing, we must update the bucket array first,
328 * then the reported number. vice-versa if the number of buckets goes down.
330 if (n_buckets == rep->rep_n_buckets)
333 * no change in the number of buckets. we can simply fill what
334 * is new over what is old.
336 replicate_fill_buckets(rep, nhs,
337 replicate_get_buckets(rep),
340 else if (n_buckets > rep->rep_n_buckets)
343 * we have more buckets. the old replicate map (if there is one)
344 * will remain valid, i.e. mapping to indices within range, so we
347 if (n_buckets > REP_NUM_INLINE_BUCKETS &&
348 rep->rep_n_buckets <= REP_NUM_INLINE_BUCKETS)
351 * the new increased number of buckets is crossing the threshold
352 * from the inline storage to out-line. Alloc the outline buckets
353 * first, then fixup the number. then reset the inlines.
355 ASSERT(NULL == rep->rep_buckets);
356 vec_validate_aligned(rep->rep_buckets,
358 CLIB_CACHE_LINE_BYTES);
360 replicate_fill_buckets(rep, nhs,
363 CLIB_MEMORY_BARRIER();
364 replicate_set_n_buckets(rep, n_buckets);
366 CLIB_MEMORY_BARRIER();
368 for (ii = 0; ii < REP_NUM_INLINE_BUCKETS; ii++)
370 dpo_reset(&rep->rep_buckets_inline[ii]);
375 if (n_buckets <= REP_NUM_INLINE_BUCKETS)
378 * we are not crossing the threshold and it's still inline buckets.
379 * we can write the new on the old..
381 replicate_fill_buckets(rep, nhs,
382 replicate_get_buckets(rep),
384 CLIB_MEMORY_BARRIER();
385 replicate_set_n_buckets(rep, n_buckets);
390 * we are not crossing the threshold. We need a new bucket array to
391 * hold the increased number of choices.
393 dpo_id_t *new_buckets, *old_buckets, *tmp_dpo;
396 old_buckets = replicate_get_buckets(rep);
398 vec_validate_aligned(new_buckets,
400 CLIB_CACHE_LINE_BYTES);
402 replicate_fill_buckets(rep, nhs, new_buckets, n_buckets);
403 CLIB_MEMORY_BARRIER();
404 rep->rep_buckets = new_buckets;
405 CLIB_MEMORY_BARRIER();
406 replicate_set_n_buckets(rep, n_buckets);
408 vec_foreach(tmp_dpo, old_buckets)
412 vec_free(old_buckets);
419 * bucket size shrinkage.
421 if (n_buckets <= REP_NUM_INLINE_BUCKETS &&
422 rep->rep_n_buckets > REP_NUM_INLINE_BUCKETS)
425 * the new decreased number of buckets is crossing the threshold
426 * from out-line storage to inline:
427 * 1 - Fill the inline buckets,
428 * 2 - fixup the number (and this point the inline buckets are
430 * 3 - free the outline buckets
432 replicate_fill_buckets(rep, nhs,
433 rep->rep_buckets_inline,
435 CLIB_MEMORY_BARRIER();
436 replicate_set_n_buckets(rep, n_buckets);
437 CLIB_MEMORY_BARRIER();
439 vec_foreach(tmp_dpo, rep->rep_buckets)
443 vec_free(rep->rep_buckets);
448 * not crossing the threshold.
449 * 1 - update the number to the smaller size
450 * 2 - write the new buckets
451 * 3 - reset those no longer used.
456 old_n_buckets = rep->rep_n_buckets;
457 buckets = replicate_get_buckets(rep);
459 replicate_set_n_buckets(rep, n_buckets);
460 CLIB_MEMORY_BARRIER();
462 replicate_fill_buckets(rep, nhs,
466 for (ii = n_buckets; ii < old_n_buckets; ii++)
468 dpo_reset(&buckets[ii]);
474 vec_foreach (nh, nhs)
476 dpo_reset(&nh->path_dpo);
482 replicate_lock (dpo_id_t *dpo)
486 rep = replicate_get(dpo->dpoi_index);
492 replicate_destroy (replicate_t *rep)
497 buckets = replicate_get_buckets(rep);
499 for (i = 0; i < rep->rep_n_buckets; i++)
501 dpo_reset(&buckets[i]);
504 REP_DBG(rep, "destroy");
505 if (!REP_HAS_INLINE_BUCKETS(rep))
507 vec_free(rep->rep_buckets);
510 pool_put(replicate_pool, rep);
514 replicate_unlock (dpo_id_t *dpo)
518 rep = replicate_get(dpo->dpoi_index);
522 if (0 == rep->rep_locks)
524 replicate_destroy(rep);
529 replicate_mem_show (void)
531 fib_show_memory_usage("replicate",
532 pool_elts(replicate_pool),
533 pool_len(replicate_pool),
534 sizeof(replicate_t));
537 const static dpo_vft_t rep_vft = {
538 .dv_lock = replicate_lock,
539 .dv_unlock = replicate_unlock,
540 .dv_format = format_replicate_dpo,
541 .dv_mem_show = replicate_mem_show,
545 * @brief The per-protocol VLIB graph nodes that are assigned to a replicate
548 * this means that these graph nodes are ones from which a replicate is the
549 * parent object in the DPO-graph.
551 const static char* const replicate_ip4_nodes[] =
556 const static char* const replicate_ip6_nodes[] =
561 const static char* const replicate_mpls_nodes[] =
567 const static char* const * const replicate_nodes[DPO_PROTO_NUM] =
569 [DPO_PROTO_IP4] = replicate_ip4_nodes,
570 [DPO_PROTO_IP6] = replicate_ip6_nodes,
571 [DPO_PROTO_MPLS] = replicate_mpls_nodes,
575 replicate_module_init (void)
577 dpo_register(DPO_REPLICATE, &rep_vft, replicate_nodes);
580 static clib_error_t *
581 replicate_show (vlib_main_t * vm,
582 unformat_input_t * input,
583 vlib_cli_command_t * cmd)
585 index_t repi = INDEX_INVALID;
587 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
589 if (unformat (input, "%d", &repi))
595 if (INDEX_INVALID != repi)
597 vlib_cli_output (vm, "%U", format_replicate, repi,
598 REPLICATE_FORMAT_DETAIL);
604 pool_foreach(rep, replicate_pool,
606 vlib_cli_output (vm, "%U", format_replicate,
607 replicate_get_index(rep),
608 REPLICATE_FORMAT_NONE);
615 VLIB_CLI_COMMAND (replicate_show_command, static) = {
616 .path = "show replicate",
617 .short_help = "show replicate [<index>]",
618 .function = replicate_show,
621 typedef struct replicate_trace_t_
628 replicate_inline (vlib_main_t * vm,
629 vlib_node_runtime_t * node,
630 vlib_frame_t * frame)
632 vlib_combined_counter_main_t * cm = &replicate_main.repm_counters;
633 replicate_main_t * rm = &replicate_main;
634 u32 n_left_from, * from, * to_next, next_index;
635 u32 thread_index = vlib_get_thread_index();
637 from = vlib_frame_vector_args (frame);
638 n_left_from = frame->n_vectors;
639 next_index = node->cached_next_index;
641 while (n_left_from > 0)
645 vlib_get_next_frame (vm, node, next_index,
646 to_next, n_left_to_next);
648 while (n_left_from > 0 && n_left_to_next > 0)
650 u32 next0, ci0, bi0, bucket, repi0;
651 const replicate_t *rep0;
652 vlib_buffer_t * b0, *c0;
653 const dpo_id_t *dpo0;
660 b0 = vlib_get_buffer (vm, bi0);
661 repi0 = vnet_buffer (b0)->ip.adj_index[VLIB_TX];
662 rep0 = replicate_get(repi0);
664 vlib_increment_combined_counter(
665 cm, thread_index, repi0, 1,
666 vlib_buffer_length_in_chain(vm, b0));
668 vec_validate (rm->clones[thread_index], rep0->rep_n_buckets - 1);
670 num_cloned = vlib_buffer_clone (vm, bi0, rm->clones[thread_index], rep0->rep_n_buckets, 128);
672 if (num_cloned != rep0->rep_n_buckets)
674 vlib_node_increment_counter
675 (vm, node->node_index,
676 REPLICATE_DPO_ERROR_BUFFER_ALLOCATION_FAILURE, 1);
679 for (bucket = 0; bucket < num_cloned; bucket++)
681 ci0 = rm->clones[thread_index][bucket];
682 c0 = vlib_get_buffer(vm, ci0);
688 dpo0 = replicate_get_bucket_i(rep0, bucket);
689 next0 = dpo0->dpoi_next_node;
690 vnet_buffer (c0)->ip.adj_index[VLIB_TX] = dpo0->dpoi_index;
692 if (PREDICT_FALSE(c0->flags & VLIB_BUFFER_IS_TRACED))
694 replicate_trace_t *t;
696 vlib_trace_buffer (vm, node, next0, c0, 0);
697 t = vlib_add_trace (vm, node, c0, sizeof (*t));
698 t->rep_index = repi0;
702 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
703 to_next, n_left_to_next,
705 if (PREDICT_FALSE (n_left_to_next == 0))
707 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
708 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
711 vec_reset_length (rm->clones[thread_index]);
714 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
717 return frame->n_vectors;
721 format_replicate_trace (u8 * s, va_list * args)
723 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
724 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
725 replicate_trace_t *t = va_arg (*args, replicate_trace_t *);
727 s = format (s, "replicate: %d via %U",
729 format_dpo_id, &t->dpo, 0);
734 ip4_replicate (vlib_main_t * vm,
735 vlib_node_runtime_t * node,
736 vlib_frame_t * frame)
738 return (replicate_inline (vm, node, frame));
742 * @brief IP4 replication node
744 VLIB_REGISTER_NODE (ip4_replicate_node) = {
745 .function = ip4_replicate,
746 .name = "ip4-replicate",
747 .vector_size = sizeof (u32),
749 .n_errors = ARRAY_LEN(replicate_dpo_error_strings),
750 .error_strings = replicate_dpo_error_strings,
752 .format_trace = format_replicate_trace,
760 ip6_replicate (vlib_main_t * vm,
761 vlib_node_runtime_t * node,
762 vlib_frame_t * frame)
764 return (replicate_inline (vm, node, frame));
768 * @brief IPv6 replication node
770 VLIB_REGISTER_NODE (ip6_replicate_node) = {
771 .function = ip6_replicate,
772 .name = "ip6-replicate",
773 .vector_size = sizeof (u32),
775 .n_errors = ARRAY_LEN(replicate_dpo_error_strings),
776 .error_strings = replicate_dpo_error_strings,
778 .format_trace = format_replicate_trace,
786 mpls_replicate (vlib_main_t * vm,
787 vlib_node_runtime_t * node,
788 vlib_frame_t * frame)
790 return (replicate_inline (vm, node, frame));
794 * @brief MPLS replication node
796 VLIB_REGISTER_NODE (mpls_replicate_node) = {
797 .function = mpls_replicate,
798 .name = "mpls-replicate",
799 .vector_size = sizeof (u32),
801 .n_errors = ARRAY_LEN(replicate_dpo_error_strings),
802 .error_strings = replicate_dpo_error_strings,
804 .format_trace = format_replicate_trace,
812 replicate_dpo_init (vlib_main_t * vm)
814 replicate_main_t * rm = &replicate_main;
816 vec_validate (rm->clones, vlib_num_workers());
821 VLIB_INIT_FUNCTION (replicate_dpo_init);