FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
mpls_fib.h
Go to the documentation of this file.
1 /*
2  * mpls_fib.h: The Label/MPLS FIB
3  *
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:
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 #ifndef __MPLS_FIB_TABLE_H__
19 #define __MPLS_FIB_TABLE_H__
20 
21 #include <vnet/vnet.h>
22 #include <vnet/mpls/mpls.h>
23 #include <vnet/fib/fib_types.h>
24 #include <vnet/dpo/dpo.h>
25 #include <vnet/mpls/mpls.h>
26 #include <vnet/fib/fib_table.h>
27 
28 #define MPLS_FIB_DEFAULT_TABLE_ID 0
29 
30 /**
31  * Type exposure is to allow the DP fast/inlined access
32  */
33 #define MPLS_FIB_KEY_SIZE 21
34 #define MPLS_FIB_DB_SIZE (1 << (MPLS_FIB_KEY_SIZE-1))
35 
36 /**
37  * There are no options for controlling the MPLS flow hash
38  */
39 #define MPLS_FLOW_HASH_DEFAULT 0
40 
41 typedef struct mpls_fib_t_
42 {
43  /**
44  * A hash table of entries. 21 bit key
45  * Hash table for reduced memory footprint
46  */
48 
49  /**
50  * The load-balance indices keyed by 21 bit label+eos bit.
51  * A flat array for maximum lookup performace.
52  */
54 } mpls_fib_t;
55 
56 static inline mpls_fib_t*
58 {
59  return (pool_elt_at_index(mpls_main.mpls_fibs, index));
60 }
61 
63  fib_source_t src);
65 // extern mpls_fib_t * mpls_fib_find(u32 table_id);
66 extern u32 mpls_fib_index_from_table_id(u32 table_id);
67 
68 extern u8 *format_mpls_fib_table_name(u8 * s, va_list * args);
69 
71  u32 table_id,
72  mpls_label_t label,
73  mpls_eos_bit_t eos,
74  fib_node_index_t fib_entry_index);
75 
76 
78  mpls_label_t label,
79  mpls_eos_bit_t eos);
80 
82  mpls_label_t label,
83  mpls_eos_bit_t eos);
85  mpls_label_t label,
86  mpls_eos_bit_t eos,
87  fib_node_index_t fei);
88 extern void mpls_fib_table_destroy(u32 fib_index);
89 
90 
92  mpls_label_t label,
93  mpls_eos_bit_t eos,
94  const dpo_id_t *dpo);
96  mpls_label_t label,
97  mpls_eos_bit_t eos);
98 
99 /**
100  * @brief Walk all entries in a FIB table
101  * N.B: This is NOT safe to deletes. If you need to delete walk the whole
102  * table and store elements in a vector, then delete the elements
103  */
104 extern void mpls_fib_table_walk(mpls_fib_t *fib,
106  void *ctx);
107 
108 extern u8 *format_mpls_fib_table_memory(u8 * s, va_list * args);
109 
110 /**
111  * @brief
112  * Lookup a label and EOS bit in the MPLS_FIB table to retrieve the
113  * load-balance index to be used for packet forwarding.
114  */
115 static inline index_t
117  const mpls_unicast_header_t *hdr)
118 {
119  mpls_label_t label;
120  mpls_fib_t *mf;
121  u32 key;
122 
123  label = clib_net_to_host_u32(hdr->label_exp_s_ttl);
124  key = (vnet_mpls_uc_get_label(label) << 1) | vnet_mpls_uc_get_s(label);
125 
126  mf = mpls_fib_get(mpls_fib_index);
127 
128  return (mf->mf_lbs[key]);
129 }
130 
131 static inline u32
133 {
134  mpls_main_t *mm = &mpls_main;
135 
136  ASSERT(vec_len(mm->fib_index_by_sw_if_index) > sw_if_index);
137 
138  return (mm->fib_index_by_sw_if_index[sw_if_index]);
139 }
140 
141 #endif
u8 * format_mpls_fib_table_memory(u8 *s, va_list *args)
Definition: mpls_fib.c:363
int(* fib_table_walk_fn_t)(fib_node_index_t fei, void *ctx)
Call back function when walking entries in a FIB table.
Definition: fib_table.h:798
u32 * fib_index_by_sw_if_index
Definition: mpls.h:44
u32 mpls_label_t
A label value only, i.e.
Definition: packet.h:24
u32 index_t
A Data-Path Object is an object that represents actions that are applied to packets are they are swit...
Definition: dpo.h:41
void mpls_fib_forwarding_table_update(mpls_fib_t *mf, mpls_label_t label, mpls_eos_bit_t eos, const dpo_id_t *dpo)
Definition: mpls_fib.c:315
u32 mpls_fib_index_from_table_id(u32 table_id)
Definition: mpls_fib.c:73
fib_node_index_t mpls_fib_table_entry_add_from_ip_fib_entry(u32 table_id, mpls_label_t label, mpls_eos_bit_t eos, fib_node_index_t fib_entry_index)
#define MPLS_FIB_DB_SIZE
Definition: mpls_fib.h:34
static u32 mpls_fib_table_get_index_for_sw_if_index(u32 sw_if_index)
Definition: mpls_fib.h:132
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:166
fib_node_index_t mpls_fib_table_lookup(const mpls_fib_t *mf, mpls_label_t label, mpls_eos_bit_t eos)
Definition: mpls_fib.c:283
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:459
enum fib_source_t_ fib_source_t
The different sources that can create a route.
struct mpls_fib_t_ mpls_fib_t
static u32 vnet_mpls_uc_get_label(mpls_label_t label_exp_s_ttl)
Definition: packet.h:77
u8 * format_mpls_fib_table_name(u8 *s, va_list *args)
mpls_main_t mpls_main
Definition: mpls.c:25
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:29
void mpls_fib_table_entry_insert(mpls_fib_t *mf, mpls_label_t label, mpls_eos_bit_t eos, fib_node_index_t fei)
Definition: mpls_fib.c:298
#define ASSERT(truth)
uword * mf_entries
A hash table of entries.
Definition: mpls_fib.h:47
unsigned int u32
Definition: types.h:88
static mpls_fib_t * mpls_fib_get(fib_node_index_t index)
Definition: mpls_fib.h:57
u32 mpls_fib_table_create_and_lock(fib_source_t src)
Definition: mpls_fib.c:238
long ctx[MAX_CONNS]
Definition: main.c:122
void mpls_fib_table_walk(mpls_fib_t *fib, fib_table_walk_fn_t fn, void *ctx)
Walk all entries in a FIB table N.B: This is NOT safe to deletes.
Definition: mpls_fib.c:349
void mpls_fib_table_entry_remove(mpls_fib_t *mf, mpls_label_t label, mpls_eos_bit_t eos)
Definition: mpls_fib.c:307
mpls_label_t label_exp_s_ttl
Definition: packet.h:31
u64 uword
Definition: types.h:112
void mpls_fib_forwarding_table_reset(mpls_fib_t *mf, mpls_label_t label, mpls_eos_bit_t eos)
Definition: mpls_fib.c:337
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
static u32 vnet_mpls_uc_get_s(mpls_label_t label_exp_s_ttl)
Definition: packet.h:87
unsigned char u8
Definition: types.h:56
u32 mpls_fib_table_find_or_create_and_lock(u32 table_id, fib_source_t src)
Definition: mpls_fib.c:224
static index_t mpls_fib_table_forwarding_lookup(u32 mpls_fib_index, const mpls_unicast_header_t *hdr)
Lookup a label and EOS bit in the MPLS_FIB table to retrieve the load-balance index to be used for pa...
Definition: mpls_fib.h:116
index_t mf_lbs[MPLS_FIB_DB_SIZE]
The load-balance indices keyed by 21 bit label+eos bit.
Definition: mpls_fib.h:53
struct mpls_fib_t_ * mpls_fibs
A pool of all the MPLS FIBs.
Definition: mpls.h:50
void mpls_fib_table_destroy(u32 fib_index)
Definition: mpls_fib.c:244
enum mpls_eos_bit_t_ mpls_eos_bit_t