FD.io VPP  v17.07.01-10-g3be13f0
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 
64 // extern mpls_fib_t * mpls_fib_find(u32 table_id);
65 extern u32 mpls_fib_index_from_table_id(u32 table_id);
66 
67 extern u8 *format_mpls_fib_table_name(u8 * s, va_list * args);
68 
70  u32 table_id,
71  mpls_label_t label,
72  mpls_eos_bit_t eos,
73  fib_node_index_t fib_entry_index);
74 
75 
77  mpls_label_t label,
78  mpls_eos_bit_t eos);
79 
81  mpls_label_t label,
82  mpls_eos_bit_t eos);
84  mpls_label_t label,
85  mpls_eos_bit_t eos,
86  fib_node_index_t fei);
87 extern void mpls_fib_table_destroy(u32 fib_index);
88 
89 
91  mpls_label_t label,
92  mpls_eos_bit_t eos,
93  const dpo_id_t *dpo);
95  mpls_label_t label,
96  mpls_eos_bit_t eos);
97 
98 /**
99  * @brief Walk all entries in a FIB table
100  * N.B: This is NOT safe to deletes. If you need to delete walk the whole
101  * table and store elements in a vector, then delete the elements
102  */
103 extern void mpls_fib_table_walk(mpls_fib_t *fib,
105  void *ctx);
106 
107 /**
108  * @brief
109  * Lookup a label and EOS bit in the MPLS_FIB table to retrieve the
110  * load-balance index to be used for packet forwarding.
111  */
112 static inline index_t
114  const mpls_unicast_header_t *hdr)
115 {
116  mpls_label_t label;
117  mpls_fib_t *mf;
118  u32 key;
119 
120  label = clib_net_to_host_u32(hdr->label_exp_s_ttl);
121  key = (vnet_mpls_uc_get_label(label) << 1) | vnet_mpls_uc_get_s(label);
122 
123  mf = mpls_fib_get(mpls_fib_index);
124 
125  return (mf->mf_lbs[key]);
126 }
127 
128 static inline u32
130 {
131  mpls_main_t *mm = &mpls_main;
132 
133  ASSERT(vec_len(mm->fib_index_by_sw_if_index) > sw_if_index);
134 
135  return (mm->fib_index_by_sw_if_index[sw_if_index]);
136 }
137 
138 #endif
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:751
u32 * fib_index_by_sw_if_index
Definition: mpls.h:42
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:313
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:129
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:152
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:281
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:397
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:28
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:296
#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
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:347
void mpls_fib_table_entry_remove(mpls_fib_t *mf, mpls_label_t label, mpls_eos_bit_t eos)
Definition: mpls_fib.c:305
mpls_label_t label_exp_s_ttl
Definition: packet.h:31
u64 uword
Definition: types.h:112
u32 mpls_fib_table_create_and_lock(void)
Definition: mpls_fib.c:236
void mpls_fib_forwarding_table_reset(mpls_fib_t *mf, mpls_label_t label, mpls_eos_bit_t eos)
Definition: mpls_fib.c:335
#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
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:113
index_t mf_lbs[MPLS_FIB_DB_SIZE]
The load-balance indices keyed by 21 bit label+eos bit.
Definition: mpls_fib.h:53
u32 mpls_fib_table_find_or_create_and_lock(u32 table_id)
Definition: mpls_fib.c:223
struct mpls_fib_t_ * mpls_fibs
A pool of all the MPLS FIBs.
Definition: mpls.h:48
void mpls_fib_table_destroy(u32 fib_index)
Definition: mpls_fib.c:242
enum mpls_eos_bit_t_ mpls_eos_bit_t