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 #ifndef __FIB_PATH_LIST_H__
17 #define __FIB_PATH_LIST_H__
19 #include <vlib/vlib.h>
20 #include <vnet/adj/adj.h>
22 #include <vnet/fib/fib_node.h>
23 #include <vnet/fib/fib_path.h>
26 * Enumeration of path-list flags.
28 typedef enum fib_path_list_attribute_t_ {
30 * Marker. Add new flags after this one.
32 FIB_PATH_LIST_ATTRIBUTE_FIRST = 0,
34 * This path list is shareable. Shareable path-lists
35 * are inserted into the path-list data-base.
36 * All path-list are inherently shareable, the reason we share some and
37 * not others is to limit the size of the path-list database. This DB must
38 * be searched for each route update.
40 FIB_PATH_LIST_ATTRIBUTE_SHARED = FIB_PATH_LIST_ATTRIBUTE_FIRST,
42 * explicit drop path-list. Used when the entry source needs to
43 * force a drop, despite the fact the path info is present.
45 FIB_PATH_LIST_ATTRIBUTE_DROP,
47 * explicit local path-list.
49 FIB_PATH_LIST_ATTRIBUTE_LOCAL,
51 * exclusive path-list. Exclusive means the path will resolve via the
52 * exclusive (user provided) adj.
54 FIB_PATH_LIST_ATTRIBUTE_EXCLUSIVE,
58 FIB_PATH_LIST_ATTRIBUTE_RESOLVED,
60 * looped path-list. one path looped implies the whole list is
62 FIB_PATH_LIST_ATTRIBUTE_LOOPED,
64 * a popular path-ist is one that is shared amongst many entries.
65 * Path list become popular as they gain more children, but they
66 * don't become unpopular as they lose them.
68 FIB_PATH_LIST_ATTRIBUTE_POPULAR,
70 * no uRPF - do not generate unicast RPF list for this path-list
72 FIB_PATH_LIST_ATTRIBUTE_NO_URPF,
74 * Marher. Add new flags before this one, and then update it.
76 FIB_PATH_LIST_ATTRIBUTE_LAST = FIB_PATH_LIST_ATTRIBUTE_NO_URPF,
77 } fib_path_list_attribute_t;
79 typedef enum fib_path_list_flags_t_ {
80 FIB_PATH_LIST_FLAG_NONE = 0,
81 FIB_PATH_LIST_FLAG_SHARED = (1 << FIB_PATH_LIST_ATTRIBUTE_SHARED),
82 FIB_PATH_LIST_FLAG_DROP = (1 << FIB_PATH_LIST_ATTRIBUTE_DROP),
83 FIB_PATH_LIST_FLAG_LOCAL = (1 << FIB_PATH_LIST_ATTRIBUTE_LOCAL),
84 FIB_PATH_LIST_FLAG_EXCLUSIVE = (1 << FIB_PATH_LIST_ATTRIBUTE_EXCLUSIVE),
85 FIB_PATH_LIST_FLAG_RESOLVED = (1 << FIB_PATH_LIST_ATTRIBUTE_RESOLVED),
86 FIB_PATH_LIST_FLAG_LOOPED = (1 << FIB_PATH_LIST_ATTRIBUTE_LOOPED),
87 FIB_PATH_LIST_FLAG_POPULAR = (1 << FIB_PATH_LIST_ATTRIBUTE_POPULAR),
88 FIB_PATH_LIST_FLAG_NO_URPF = (1 << FIB_PATH_LIST_ATTRIBUTE_NO_URPF),
89 } fib_path_list_flags_t;
91 #define FIB_PATH_LIST_ATTRIBUTES { \
92 [FIB_PATH_LIST_ATTRIBUTE_SHARED] = "shared", \
93 [FIB_PATH_LIST_ATTRIBUTE_RESOLVED] = "resolved", \
94 [FIB_PATH_LIST_ATTRIBUTE_DROP] = "drop", \
95 [FIB_PATH_LIST_ATTRIBUTE_EXCLUSIVE] = "exclusive", \
96 [FIB_PATH_LIST_ATTRIBUTE_LOCAL] = "local", \
97 [FIB_PATH_LIST_ATTRIBUTE_LOOPED] = "looped", \
98 [FIB_PATH_LIST_ATTRIBUTE_POPULAR] = "popular", \
99 [FIB_PATH_LIST_ATTRIBUTE_NO_URPF] = "no-uRPF", \
102 #define FOR_EACH_PATH_LIST_ATTRIBUTE(_item) \
103 for (_item = FIB_PATH_LIST_ATTRIBUTE_FIRST; \
104 _item <= FIB_PATH_LIST_ATTRIBUTE_LAST; \
108 * The flags on a path-list that contribute to its key in the DB.
109 * So path-lists with these flags different are not conisdered the
112 #define FIB_PATH_LIST_KEY_FLAGS (FIB_PATH_LIST_FLAG_NO_URPF)
114 extern fib_node_index_t fib_path_list_create(fib_path_list_flags_t flags,
115 const fib_route_path_t *paths);
116 extern fib_node_index_t fib_path_list_create_special(dpo_proto_t nh_proto,
117 fib_path_list_flags_t flags,
118 const dpo_id_t *dpo);
120 extern fib_node_index_t fib_path_list_copy_and_path_add(
121 fib_node_index_t pl_index,
122 fib_path_list_flags_t flags,
123 const fib_route_path_t *path);
124 extern fib_node_index_t fib_path_list_copy_and_path_remove(
125 fib_node_index_t pl_index,
126 fib_path_list_flags_t flags,
127 const fib_route_path_t *path);
128 extern fib_node_index_t* fib_path_list_paths_add (
129 fib_node_index_t path_list_index,
130 const fib_route_path_t *rpaths);
131 extern fib_node_index_t* fib_path_list_paths_remove (
132 fib_node_index_t path_list_index,
133 const fib_route_path_t *rpaths);
135 extern u32 fib_path_list_get_n_paths(fib_node_index_t pl_index);
138 * Flags to control how the path-list returns forwarding information
140 typedef enum fib_path_list_fwd_flags_t_
142 FIB_PATH_LIST_FWD_FLAG_NONE = 0,
143 FIB_PATH_LIST_FWD_FLAG_COLLAPSE = (1 << 0),
144 FIB_PATH_LIST_FWD_FLAG_STICKY = (1 << 1),
145 } fib_path_list_fwd_flags_t;
147 extern void fib_path_list_contribute_forwarding(fib_node_index_t path_list_index,
148 fib_forward_chain_type_t type,
149 fib_path_list_fwd_flags_t flags,
151 extern void fib_path_list_contribute_urpf(fib_node_index_t path_index,
153 extern index_t fib_path_list_get_urpf(fib_node_index_t path_list_index);
154 extern index_t fib_path_list_get_adj(fib_node_index_t path_list_index,
155 fib_forward_chain_type_t type);
157 extern u32 fib_path_list_child_add(fib_node_index_t pl_index,
158 fib_node_type_t type,
159 fib_node_index_t child_index);
160 extern void fib_path_list_child_remove(fib_node_index_t pl_index,
161 fib_node_index_t sibling_index);
162 extern void fib_path_list_back_walk(fib_node_index_t pl_index,
163 fib_node_back_walk_ctx_t *ctx);
164 extern void fib_path_list_lock(fib_node_index_t pl_index);
165 extern void fib_path_list_unlock(fib_node_index_t pl_index);
166 extern int fib_path_list_recursive_loop_detect(fib_node_index_t path_list_index,
167 fib_node_index_t **entry_indicies);
168 extern u32 fib_path_list_get_resolving_interface(fib_node_index_t path_list_index);
169 extern int fib_path_list_is_looped(fib_node_index_t path_list_index);
170 extern int fib_path_list_is_popular(fib_node_index_t path_list_index);
171 extern dpo_proto_t fib_path_list_get_proto(fib_node_index_t path_list_index);
172 extern u8 * fib_path_list_format(fib_node_index_t pl_index,
174 extern u8 * format_fib_path_list(u8 * s, va_list *args);
176 extern index_t fib_path_list_lb_map_add_or_lock(fib_node_index_t pl_index,
177 const fib_node_index_t *pis);
178 extern u32 fib_path_list_find_rpath (fib_node_index_t path_list_index,
179 const fib_route_path_t *rpath);
182 * A callback function type for walking a path-list's paths
184 typedef fib_path_list_walk_rc_t (*fib_path_list_walk_fn_t)(
185 fib_node_index_t pl_index,
186 fib_node_index_t path_index,
189 extern void fib_path_list_walk(fib_node_index_t pl_index,
190 fib_path_list_walk_fn_t func,
193 typedef fib_path_list_walk_rc_t (*fib_path_list_walk_w_ext_fn_t)(
194 fib_node_index_t pl_index,
195 fib_node_index_t path_index,
196 const struct fib_path_ext_t_ *ext_list,
199 extern void fib_path_list_walk_w_ext(fib_node_index_t pl_index,
200 const fib_path_ext_list_t *ext_list,
201 fib_path_list_walk_w_ext_fn_t func,
204 extern void fib_path_list_module_init(void);
207 * functions for testing.
209 u32 fib_path_list_pool_size(void);
210 u32 fib_path_list_db_size(void);