2 * mpls_fib.h: The Label/MPLS FIB
4 * Copyright (c) 2012 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:
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
20 * The entries in the table are programmed wtih one or more MOIs. These MOIs
21 * may result in different forwarding actions for end-of-stack (EOS) and non-EOS
22 * packets. Whether the two actions are the same more often than they are
23 * different, or vice versa, is a function of the deployment in which the router
24 * is used and thus not predictable.
25 * The desgin choice to make with an MPLS_FIB table is:
26 * 1 - 20 bit key: label only.
27 * When the EOS and non-EOS actions differ the result is a 'EOS-choice' object.
28 * 2 - 21 bit key: label and EOS-bit.
29 * The result is then the specific action based on EOS-bit.
33 * - lower memory overhead, since there are few DB entries.
35 * - slower DP performance in the case the chains differ, as more objects are
36 * encounterd in the switch path
40 * - faster DP performance
42 * - increased memory footprint.
44 * Switching between schemes based on observed/measured action similarity is not
45 * considered on the grounds of complexity and flip-flopping.
47 * VPP mantra - favour performance over memory. We choose a 21 bit key.
50 #include <vnet/fib/fib_table.h>
51 #include <vnet/dpo/load_balance.h>
52 #include <vnet/dpo/drop_dpo.h>
53 #include <vnet/dpo/punt_dpo.h>
54 #include <vnet/dpo/lookup_dpo.h>
55 #include <vnet/mpls/mpls.h>
58 * All lookups in an MPLS_FIB table must result in a DPO of type load-balance.
59 * This is the default result which links to drop
61 static index_t mpls_fib_drop_dpo_index = INDEX_INVALID;
66 #define MPLS_FLOW_HASH_DEFAULT 0
69 mpls_fib_entry_mk_key (mpls_label_t label,
73 return (label << 1 | eos);
77 mpls_fib_index_from_table_id (u32 table_id)
79 mpls_main_t *mm = &mpls_main;
82 p = hash_get (mm->fib_index_by_table_id, table_id);
84 return FIB_NODE_INDEX_INVALID;
90 mpls_fib_create_with_table_id (u32 table_id)
92 dpo_id_t dpo = DPO_NULL;
93 fib_table_t *fib_table;
98 pool_get_aligned(mpls_main.fibs, fib_table, CLIB_CACHE_LINE_BYTES);
99 memset(fib_table, 0, sizeof(*fib_table));
101 fib_table->ft_proto = FIB_PROTOCOL_MPLS;
102 fib_table->ft_index =
103 (fib_table - mpls_main.fibs);
105 hash_set (mpls_main.fib_index_by_table_id, table_id, fib_table->ft_index);
107 fib_table->ft_table_id =
109 fib_table->ft_flow_hash_config =
110 MPLS_FLOW_HASH_DEFAULT;
111 fib_table->v4.fwd_classify_table_index = ~0;
112 fib_table->v4.rev_classify_table_index = ~0;
114 fib_table_lock(fib_table->ft_index, FIB_PROTOCOL_MPLS);
116 if (INDEX_INVALID == mpls_fib_drop_dpo_index)
118 mpls_fib_drop_dpo_index = load_balance_create(1, DPO_PROTO_MPLS, 0);
119 load_balance_set_bucket(mpls_fib_drop_dpo_index,
121 drop_dpo_get(DPO_PROTO_MPLS));
124 mf = &fib_table->mpls;
125 mf->mf_entries = hash_create(0, sizeof(fib_node_index_t));
126 for (i = 0; i < MPLS_FIB_DB_SIZE; i++)
129 * initialise each DPO in the data-path lookup table
130 * to be the special MPLS drop
132 mf->mf_lbs[i] = mpls_fib_drop_dpo_index;
136 * non-default forwarding for the special labels.
138 fib_prefix_t prefix = {
139 .fp_proto = FIB_PROTOCOL_MPLS,
140 .fp_payload_proto = DPO_PROTO_MPLS,
144 * PUNT the router alert, both EOS and non-eos
146 prefix.fp_label = MPLS_IETF_ROUTER_ALERT_LABEL;
147 FOR_EACH_MPLS_EOS_BIT(eos)
150 fib_table_entry_special_dpo_add(fib_table->ft_index,
153 FIB_ENTRY_FLAG_EXCLUSIVE,
154 punt_dpo_get(DPO_PROTO_MPLS));
158 * IPv4 explicit NULL EOS lookup in the interface's IPv4 table
160 prefix.fp_label = MPLS_IETF_IPV4_EXPLICIT_NULL_LABEL;
161 prefix.fp_payload_proto = DPO_PROTO_IP4;
162 prefix.fp_eos = MPLS_EOS;
164 lookup_dpo_add_or_lock_w_fib_index(0, // unused
166 LOOKUP_INPUT_DST_ADDR,
167 LOOKUP_TABLE_FROM_INPUT_INTERFACE,
169 fib_table_entry_special_dpo_add(fib_table->ft_index,
172 FIB_ENTRY_FLAG_EXCLUSIVE,
175 prefix.fp_payload_proto = DPO_PROTO_MPLS;
176 prefix.fp_eos = MPLS_NON_EOS;
178 lookup_dpo_add_or_lock_w_fib_index(0, //unsued
180 LOOKUP_INPUT_DST_ADDR,
181 LOOKUP_TABLE_FROM_INPUT_INTERFACE,
183 fib_table_entry_special_dpo_add(fib_table->ft_index,
186 FIB_ENTRY_FLAG_EXCLUSIVE,
190 * IPv6 explicit NULL EOS lookup in the interface's IPv6 table
192 prefix.fp_label = MPLS_IETF_IPV6_EXPLICIT_NULL_LABEL;
193 prefix.fp_payload_proto = DPO_PROTO_IP6;
194 prefix.fp_eos = MPLS_EOS;
196 lookup_dpo_add_or_lock_w_fib_index(0, //unused
198 LOOKUP_INPUT_DST_ADDR,
199 LOOKUP_TABLE_FROM_INPUT_INTERFACE,
201 fib_table_entry_special_dpo_add(fib_table->ft_index,
204 FIB_ENTRY_FLAG_EXCLUSIVE,
207 prefix.fp_payload_proto = DPO_PROTO_MPLS;
208 prefix.fp_eos = MPLS_NON_EOS;
209 lookup_dpo_add_or_lock_w_fib_index(0, // unsued
211 LOOKUP_INPUT_DST_ADDR,
212 LOOKUP_TABLE_FROM_INPUT_INTERFACE,
214 fib_table_entry_special_dpo_add(fib_table->ft_index,
217 FIB_ENTRY_FLAG_EXCLUSIVE,
220 return (fib_table->ft_index);
224 mpls_fib_table_find_or_create_and_lock (u32 table_id)
228 index = mpls_fib_index_from_table_id(table_id);
230 return mpls_fib_create_with_table_id(table_id);
232 fib_table_lock(index, FIB_PROTOCOL_MPLS);
237 mpls_fib_table_create_and_lock (void)
239 return (mpls_fib_create_with_table_id(~0));
243 mpls_fib_table_destroy (mpls_fib_t *mf)
245 fib_table_t *fib_table = (fib_table_t*)mf;
246 fib_prefix_t prefix = {
247 .fp_proto = FIB_PROTOCOL_MPLS,
249 mpls_label_t special_labels[] = {
250 MPLS_IETF_ROUTER_ALERT_LABEL,
251 MPLS_IETF_IPV6_EXPLICIT_NULL_LABEL,
252 MPLS_IETF_IPV4_EXPLICIT_NULL_LABEL,
257 for (ii = 0; ii < ARRAY_LEN(special_labels); ii++)
259 FOR_EACH_MPLS_EOS_BIT(eos)
261 prefix.fp_label = special_labels[ii];
264 fib_table_entry_delete(fib_table->ft_index,
269 if (~0 != fib_table->ft_table_id)
271 hash_unset(mpls_main.fib_index_by_table_id,
272 fib_table->ft_table_id);
274 hash_delete(mf->mf_entries);
276 pool_put(mpls_main.fibs, fib_table);
280 mpls_fib_table_lookup (const mpls_fib_t *mf,
286 p = hash_get(mf->mf_entries, mpls_fib_entry_mk_key(label, eos));
289 return FIB_NODE_INDEX_INVALID;
295 mpls_fib_table_entry_insert (mpls_fib_t *mf,
298 fib_node_index_t lfei)
300 hash_set(mf->mf_entries, mpls_fib_entry_mk_key(label, eos), lfei);
304 mpls_fib_table_entry_remove (mpls_fib_t *mf,
308 hash_unset(mf->mf_entries, mpls_fib_entry_mk_key(label, eos));
312 mpls_fib_forwarding_table_update (mpls_fib_t *mf,
319 ASSERT(DPO_LOAD_BALANCE == dpo->dpoi_type);
321 key = mpls_fib_entry_mk_key(label, eos);
323 mf->mf_lbs[key] = dpo->dpoi_index;
327 mpls_fib_forwarding_table_reset (mpls_fib_t *mf,
333 key = mpls_fib_entry_mk_key(label, eos);
335 mf->mf_lbs[key] = mpls_fib_drop_dpo_index;
339 mpls_fib_table_get_flow_hash_config (u32 fib_index)
346 mpls_fib_table_show_all (const mpls_fib_t *mpls_fib,
349 fib_node_index_t lfei, *lfeip, *lfeis = NULL;
352 hash_foreach(key, lfei, mpls_fib->mf_entries,
354 vec_add1(lfeis, lfei);
357 vec_sort_with_function(lfeis, fib_entry_cmp_for_sort);
359 vec_foreach(lfeip, lfeis)
361 vlib_cli_output (vm, "%U",
362 format_fib_entry, *lfeip,
363 FIB_ENTRY_FORMAT_DETAIL);
369 mpls_fib_table_show_one (const mpls_fib_t *mpls_fib,
373 fib_node_index_t lfei;
376 FOR_EACH_MPLS_EOS_BIT(eos)
378 lfei = mpls_fib_table_lookup(mpls_fib, label, eos);
380 if (FIB_NODE_INDEX_INVALID != lfei)
382 vlib_cli_output (vm, "%U",
383 format_fib_entry, lfei, FIB_ENTRY_FORMAT_DETAIL);
388 static clib_error_t *
389 mpls_fib_show (vlib_main_t * vm,
390 unformat_input_t * input,
391 vlib_cli_command_t * cmd)
393 fib_table_t * fib_table;
398 label = MPLS_LABEL_INVALID;
400 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
402 /* if (unformat (input, "brief") || unformat (input, "summary") */
403 /* || unformat (input, "sum")) */
406 if (unformat (input, "%d", &label))
408 else if (unformat (input, "table %d", &table_id))
414 pool_foreach (fib_table, mpls_main.fibs,
416 if (table_id >= 0 && table_id != fib_table->ft_table_id)
419 vlib_cli_output (vm, "%v, fib_index %d",
420 fib_table->ft_desc, mpls_main.fibs - fib_table);
422 if (MPLS_LABEL_INVALID == label)
424 mpls_fib_table_show_all(&(fib_table->mpls), vm);
428 mpls_fib_table_show_one(&(fib_table->mpls), label, vm);
435 VLIB_CLI_COMMAND (mpls_fib_show_command, static) = {
436 .path = "show mpls fib",
437 .short_help = "show mpls fib [summary] [table <n>]",
438 .function = mpls_fib_show,