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_ENTRY_SRC_H__
17 #define __FIB_ENTRY_SRC_H__
19 #include "fib_entry.h"
20 #include "fib_path_list.h"
21 #include "fib_internal.h"
27 #define FIB_ENTRY_DBG(_e, _fmt, _args...) \
30 __tmp = format(__tmp, "e:[%d:%U", \
31 fib_entry_get_index(_e), \
32 format_ip46_address, \
33 &_e->fe_prefix.fp_addr, \
35 __tmp = format(__tmp, "/%d]:", \
36 _e->fe_prefix.fp_len); \
37 __tmp = format(__tmp, _fmt, ##_args); \
38 clib_warning("%s", __tmp); \
42 #define FIB_ENTRY_DBG(_e, _fmt, _args...)
46 * Source initialisation Function
48 typedef void (*fib_entry_src_init_t)(fib_entry_src_t *src);
51 * Source deinitialisation Function
53 typedef void (*fib_entry_src_deinit_t)(fib_entry_src_t *src);
56 * Source activation. Called when the source is the new best source on the entry.
57 * Return non-zero if the entry can now install, 0 otherwise
59 typedef int (*fib_entry_src_activate_t)(fib_entry_src_t *src,
60 const fib_entry_t *fib_entry);
64 * Called when the source is no longer best source on the entry
66 typedef void (*fib_entry_src_deactivate_t)(fib_entry_src_t *src,
67 const fib_entry_t *fib_entry);
71 * Called when the source is added to the entry
73 typedef void (*fib_entry_src_add_t)(fib_entry_src_t *src,
74 const fib_entry_t *entry,
75 fib_entry_flag_t flags,
82 typedef void (*fib_entry_src_remove_t)(fib_entry_src_t *src);
85 * Result from a cover update/change
87 typedef struct fib_entry_src_cover_res_t_ {
89 fib_node_bw_reason_flag_t bw_reason;
90 } fib_entry_src_cover_res_t;
93 * Cover changed. the source should re-evaluate its cover.
95 typedef fib_entry_src_cover_res_t (*fib_entry_src_cover_change_t)(
97 const fib_entry_t *fib_entry);
100 * Cover updated. The cover the source has, has updated (i.e. its forwarding)
101 * the source may need to re-evaluate.
103 typedef fib_entry_src_cover_res_t (*fib_entry_src_cover_update_t)(
104 fib_entry_src_t *src,
105 const fib_entry_t *fib_entry);
108 * Installed. Notification that the source is now installed as
109 * the entry's forwarding source.
111 typedef void (*fib_entry_src_installed_t)(fib_entry_src_t *src,
112 const fib_entry_t *fib_entry);
117 typedef u8* (*fib_entry_src_format_t)(fib_entry_src_t *src,
122 * the source is adding a new path
124 typedef void (*fib_entry_src_path_add_t)(fib_entry_src_t *src,
125 const fib_entry_t *fib_entry,
126 fib_path_list_flags_t pl_flags,
127 const fib_route_path_t *path);
131 * the source is remoinvg a path
133 typedef void (*fib_entry_src_path_remove_t)(fib_entry_src_t *src,
134 fib_path_list_flags_t pl_flags,
135 const fib_route_path_t *path);
138 * Source path replace/swap
139 * the source is providing a new set of paths
141 typedef void (*fib_entry_src_path_swap_t)(fib_entry_src_t *src,
142 const fib_entry_t *fib_entry,
143 fib_path_list_flags_t pl_flags,
144 const fib_route_path_t *path);
147 * Set source specific opaque data
149 typedef void (*fib_entry_src_set_data_t)(fib_entry_src_t *src,
150 const fib_entry_t *fib_entry,
154 * Get source specific opaque data
156 typedef const void* (*fib_entry_src_get_data_t)(fib_entry_src_t *src,
157 const fib_entry_t *fib_entry);
160 * Virtual function table each FIB entry source will register
162 typedef struct fib_entry_src_vft_t_ {
163 fib_entry_src_init_t fesv_init;
164 fib_entry_src_deinit_t fesv_deinit;
165 fib_entry_src_activate_t fesv_activate;
166 fib_entry_src_deactivate_t fesv_deactivate;
167 fib_entry_src_add_t fesv_add;
168 fib_entry_src_remove_t fesv_remove;
169 fib_entry_src_path_swap_t fesv_path_swap;
170 fib_entry_src_path_add_t fesv_path_add;
171 fib_entry_src_path_remove_t fesv_path_remove;
172 fib_entry_src_cover_change_t fesv_cover_change;
173 fib_entry_src_cover_update_t fesv_cover_update;
174 fib_entry_src_format_t fesv_format;
175 fib_entry_src_installed_t fesv_installed;
176 fib_entry_src_get_data_t fesv_get_data;
177 fib_entry_src_set_data_t fesv_set_data;
178 } fib_entry_src_vft_t;
180 #define FOR_EACH_SRC_ADDED(_entry, _src, _source, action) \
182 if (fib_entry_has_multiple_srcs(_entry)) \
184 vec_foreach(_src, _entry->fe_u_src.fe_srcs) \
186 if (_src->fes_flags & FIB_ENTRY_SRC_FLAG_ADDED) { \
187 _source = _src->fes_src; \
196 _src = &_entry->fe_u_src.fe_src; \
197 if (_src->fes_flags & FIB_ENTRY_SRC_FLAG_ADDED) { \
198 _source = _src->fes_src; \
206 #define FOR_EACH_SRC(_entry, _src, _source, action) \
208 if (fib_entry_has_multiple_srcs(_entry)) \
210 vec_foreach(_src, _entry->fe_u_src.fe_srcs) \
212 _source = _src->fes_src; \
220 _src = &_entry->fe_u_src.fe_src; \
221 _source = _src->fes_src; \
228 extern u8* fib_entry_src_format(fib_entry_t *entry,
232 extern void fib_entry_src_register(fib_source_t source,
233 const fib_entry_src_vft_t *vft);
235 extern void fib_entry_src_action_init(fib_entry_t *entry,
236 fib_source_t source);
238 extern void fib_entry_src_action_deinit(fib_entry_t *fib_entry,
239 fib_source_t source);
241 extern fib_entry_src_cover_res_t fib_entry_src_action_cover_change(
243 fib_source_t source);
245 extern fib_entry_src_cover_res_t fib_entry_src_action_cover_update(
246 fib_entry_t *fib_entry,
247 fib_source_t source);
249 extern void fib_entry_src_action_activate(fib_entry_t *fib_entry,
250 fib_source_t source);
252 extern void fib_entry_src_action_deactivate(fib_entry_t *fib_entry,
253 fib_source_t source);
254 extern void fib_entry_src_action_reactivate(fib_entry_t *fib_entry,
255 fib_source_t source);
257 extern fib_entry_t* fib_entry_src_action_add(fib_entry_t *fib_entry,
259 fib_entry_flag_t flags,
260 const dpo_id_t *dpo);
261 extern fib_entry_t* fib_entry_src_action_update(fib_entry_t *fib_entry,
263 fib_entry_flag_t flags,
264 const dpo_id_t *dpo);
266 extern fib_entry_src_flag_t fib_entry_src_action_remove(fib_entry_t *fib_entry,
267 fib_source_t source);
269 extern void fib_entry_src_action_install(fib_entry_t *fib_entry,
270 fib_source_t source);
272 extern void fib_entry_src_action_uninstall(fib_entry_t *fib_entry);
274 extern fib_entry_t* fib_entry_src_action_path_add(fib_entry_t *fib_entry,
276 fib_entry_flag_t flags,
277 const fib_route_path_t *path);
279 extern fib_entry_t* fib_entry_src_action_path_swap(fib_entry_t *fib_entry,
281 fib_entry_flag_t flags,
282 const fib_route_path_t *path);
284 extern fib_entry_src_flag_t fib_entry_src_action_path_remove(fib_entry_t *fib_entry,
286 const fib_route_path_t *path);
288 extern void fib_entry_src_action_installed(fib_entry_t *fib_entry,
289 fib_source_t source);
291 extern fib_forward_chain_type_t fib_entry_get_default_chain_type(
292 const fib_entry_t *fib_entry);
293 extern fib_entry_flag_t fib_entry_get_flags_i(const fib_entry_t *fib_entry);
294 extern fib_path_list_flags_t fib_entry_src_flags_2_path_list_flags(
295 fib_entry_flag_t eflags);
297 extern fib_forward_chain_type_t fib_entry_chain_type_fixup(const fib_entry_t *entry,
298 fib_forward_chain_type_t fct);
300 extern void fib_entry_src_mk_lb (fib_entry_t *fib_entry,
301 const fib_entry_src_t *esrc,
302 fib_forward_chain_type_t fct,
305 extern fib_protocol_t fib_entry_get_proto(const fib_entry_t * fib_entry);
306 extern dpo_proto_t fib_entry_get_dpo_proto(const fib_entry_t * fib_entry);
307 extern u32 fib_entry_has_multiple_srcs(const fib_entry_t * fib_entry);
310 * Per-source registration. declared here so we save a separate .h file for each
312 extern void fib_entry_src_default_register(void);
313 extern void fib_entry_src_rr_register(void);
314 extern void fib_entry_src_interface_register(void);
315 extern void fib_entry_src_default_route_register(void);
316 extern void fib_entry_src_special_register(void);
317 extern void fib_entry_src_api_register(void);
318 extern void fib_entry_src_adj_register(void);
319 extern void fib_entry_src_mpls_register(void);
320 extern void fib_entry_src_lisp_register(void);
322 extern void fib_entry_src_module_init(void);