FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
bier_table.h
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 
16 #ifndef __BIER_TABLE_H__
17 #define __BIER_TABLE_H__
18 
19 #include <vlib/vlib.h>
20 #include <vnet/fib/fib_types.h>
21 #include <vnet/bier/bier_types.h>
22 #include <vnet/bier/bier_entry.h>
23 
24 #include <vnet/dpo/dpo.h>
25 
26 /**
27  * Forward declarations
28  */
29 struct bier_route_update_t_;
30 
31 /**
32  * A BIER Table is the bit-indexed forwarding table.
33  * Each entry (bit-position) represents one destination, and its reachability
34  *
35  * The number of entries in a table is thus the maximum supported
36  * bit-position. Since this is smal <4096, the table is a flat arry
37  */
38 typedef struct bier_table_t_ {
39  /**
40  * Save the MPLS local label associated with the table
41  */
43 
44  /**
45  * The path-list used for the ECMP-tables
46  */
48 
49  /**
50  * The index of the lfib entry created for this table.
51  * Only the EOS is required.
52  */
54 
55  /**
56  * Number of locks on the table
57  */
59 
60  /**
61  * Entries in the table
62  * This is a vector sized to the appropriate number of entries
63  * given the table's supported Bit-string length
64  */
66 
67  /**
68  * Everything before this declaration is unused in the switch path
69  */
70  CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
71 
72  /**
73  * The identity/key or the table. we need the hdr_len in the data-path
74  */
76 
77  /**
78  * f-masks in the ECMP table
79  * This is a vector sized to the appropriate number of entries
80  * given the table's supported Bit-string length.
81  * In the ECMP table the LB choice has been pre-resolved, so each entry
82  * links to just one f-mask, i.e. there is a 1:1 mapping of bit-position to
83  * fmask. For efficient forwarding we collapse the fmasks up to the table.
84  */
86 } bier_table_t;
87 
89  "BIER table fits on 2 cache lines");
90 
92  mpls_label_t ll);
93 extern void bier_table_unlock(const bier_table_id_t *id);
94 
95 extern void bier_table_route_add(const bier_table_id_t *bti,
96  bier_bp_t bp,
97  fib_route_path_t *brp);
98 extern void bier_table_route_remove(const bier_table_id_t *bti,
99  bier_bp_t bp,
100  fib_route_path_t *brp);
101 
102 extern void bier_table_show_all(vlib_main_t * vm,
104 
105 extern const bier_table_id_t *bier_table_get_id(index_t bti);
106 
107 extern u8 *format_bier_table (u8 *s, va_list *args);
108 extern u8 *format_bier_table_entry (u8 *s, va_list *args);
109 
111 extern void bier_table_ecmp_unlock(index_t bti);
112 extern void bier_table_ecmp_set_fmask(index_t bti,
113  bier_bp_t bp,
114  index_t bfmi);
115 
117  dpo_id_t *dpo);
118 
119 /**
120  * Types and functions to walk the ECMP tables of a main table
121  */
122 typedef void (*bier_table_ecmp_walk_fn_t)(index_t btei,
123  void *ctx);
124 extern void bier_table_ecmp_walk(index_t bti,
126  void *ctx);
127 extern int bier_table_is_main (const bier_table_t *bt);
128 
129 /**
130  * Types and functions to walk all the BIER Tables
131  */
132 typedef void (*bier_tables_walk_fn_t)(const bier_table_t *bt,
133  void *ctx);
135  void *ctx);
136 
137 /**
138  * Types and functions to walk all the entries in one BIER Table
139  */
140 typedef void (*bier_table_walk_fn_t)(const bier_table_t *bt,
141  const bier_entry_t *be,
142  void *ctx);
143 extern void bier_table_walk(const bier_table_id_t *id,
145  void *ctx);
146 
147 /*
148  * provided for fast data plane access.
149  */
151 
152 static inline bier_table_t *
154 {
155  return (pool_elt_at_index(bier_table_pool, bti));
156 }
157 
158 static inline const index_t
160  bier_bp_t bp)
161 {
162  return (bt->bt_entries[BIER_BP_TO_INDEX(bp)]);
163 }
164 
165 static inline const index_t
167  bier_bp_t bp)
168 {
169  return (bt->bt_fmasks[BIER_BP_TO_INDEX(bp)]);
170 }
171 
172 #endif
void bier_table_ecmp_set_fmask(index_t bti, bier_bp_t bp, index_t bfmi)
Definition: bier_table.c:661
void bier_table_route_add(const bier_table_id_t *bti, bier_bp_t bp, fib_route_path_t *brp)
Definition: bier_table.c:513
bier_table_t * bier_table_pool
Memory pool of all the allocated tables.
Definition: bier_table.c:32
void bier_table_show_all(vlib_main_t *vm, bier_show_flags_t flags)
Definition: bier_table.c:771
A representation of a path as described by a route producer.
Definition: fib_types.h:377
u16 bt_locks
Number of locks on the table.
Definition: bier_table.h:58
index_t * bt_fmasks
f-masks in the ECMP table This is a vector sized to the appropriate number of entries given the table...
Definition: bier_table.h:85
enum bier_show_flags_t_ bier_show_flags_t
Flags to control show output.
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(* bier_table_ecmp_walk_fn_t)(index_t btei, void *ctx)
Types and functions to walk the ECMP tables of a main table.
Definition: bier_table.h:122
void bier_table_contribute_forwarding(index_t bti, dpo_id_t *dpo)
Definition: bier_table.c:601
static bier_table_t * bier_table_get(index_t bti)
Definition: bier_table.h:153
The ID of a table.
Definition: bier_types.h:446
void bier_table_unlock(const bier_table_id_t *id)
Definition: bier_table.c:218
void(* bier_tables_walk_fn_t)(const bier_table_t *bt, void *ctx)
Types and functions to walk all the BIER Tables.
Definition: bier_table.h:132
u8 * format_bier_table_entry(u8 *s, va_list *args)
Definition: bier_table.c:679
int bier_table_is_main(const bier_table_t *bt)
Definition: bier_table.c:53
mpls_label_t bt_ll
Save the MPLS local label associated with the table.
Definition: bier_table.h:42
void bier_table_ecmp_unlock(index_t bti)
Definition: bier_table.c:426
u32 bier_bp_t
A bit positon as assigned to egress PEs.
Definition: bier_types.h:346
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
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:459
u8 * format_bier_table(u8 *s, va_list *args)
Definition: bier_table.c:714
static const index_t bier_table_fwd_lookup(const bier_table_t *bt, bier_bp_t bp)
Definition: bier_table.h:166
vlib_main_t * vm
Definition: buffer.c:283
STATIC_ASSERT((sizeof(bier_table_t)<=2 *CLIB_CACHE_LINE_BYTES),"BIER table fits on 2 cache lines")
static const index_t bier_table_lookup(const bier_table_t *bt, bier_bp_t bp)
Definition: bier_table.h:159
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:29
const bier_table_id_t * bier_table_get_id(index_t bti)
Definition: bier_table.c:488
fib_node_index_t bt_lfei
The index of the lfib entry created for this table.
Definition: bier_table.h:53
The BIER entry.
Definition: bier_entry.h:46
index_t * bt_entries
Entries in the table This is a vector sized to the appropriate number of entries given the table&#39;s su...
Definition: bier_table.h:65
long ctx[MAX_CONNS]
Definition: main.c:122
void bier_table_route_remove(const bier_table_id_t *bti, bier_bp_t bp, fib_route_path_t *brp)
Definition: bier_table.c:565
fib_node_index_t bt_pl
The path-list used for the ECMP-tables.
Definition: bier_table.h:47
void(* bier_table_walk_fn_t)(const bier_table_t *bt, const bier_entry_t *be, void *ctx)
Types and functions to walk all the entries in one BIER Table.
Definition: bier_table.h:140
bier_table_id_t bt_id
The identity/key or the table.
Definition: bier_table.h:75
CLIB_CACHE_LINE_ALIGN_MARK(cacheline0)
Everything before this declaration is unused in the switch path.
unsigned short u16
Definition: types.h:57
void bier_tables_walk(bier_tables_walk_fn_t fn, void *ctx)
Definition: bier_table.c:790
unsigned char u8
Definition: types.h:56
A BIER Table is the bit-indexed forwarding table.
Definition: bier_table.h:38
#define BIER_BP_TO_INDEX(bp)
Definition: bier_types.h:348
struct bier_table_t_ bier_table_t
A BIER Table is the bit-indexed forwarding table.
void bier_table_walk(const bier_table_id_t *id, bier_table_walk_fn_t fn, void *ctx)
Definition: bier_table.c:798
u32 flags
Definition: vhost-user.h:77
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:67
void bier_table_ecmp_walk(index_t bti, bier_table_ecmp_walk_fn_t fn, void *ctx)
Definition: bier_table.c:643
index_t bier_table_ecmp_create_and_lock(const bier_table_id_t *id)
Definition: bier_table.c:420
index_t bier_table_add_or_lock(const bier_table_id_t *id, mpls_label_t ll)
Definition: bier_table.c:333