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 * Forwarding updated. Notification that the forwarding information for the
109 * entry has been updated. This notification is sent to all sources, not just
112 typedef void (*fib_entry_src_fwd_update_t)(fib_entry_src_t *src,
113 const fib_entry_t *fib_entry,
114 fib_source_t best_source);
117 * Installed. Notification that the source is now installed as
118 * the entry's forwarding source.
120 typedef void (*fib_entry_src_installed_t)(fib_entry_src_t *src,
121 const fib_entry_t *fib_entry);
126 typedef u8* (*fib_entry_src_format_t)(fib_entry_src_t *src,
131 * the source is adding a new path
133 typedef void (*fib_entry_src_path_add_t)(fib_entry_src_t *src,
134 const fib_entry_t *fib_entry,
135 fib_path_list_flags_t pl_flags,
136 const fib_route_path_t *path);
140 * the source is remoinvg a path
142 typedef void (*fib_entry_src_path_remove_t)(fib_entry_src_t *src,
143 fib_path_list_flags_t pl_flags,
144 const fib_route_path_t *path);
147 * Source path replace/swap
148 * the source is providing a new set of paths
150 typedef void (*fib_entry_src_path_swap_t)(fib_entry_src_t *src,
151 const fib_entry_t *fib_entry,
152 fib_path_list_flags_t pl_flags,
153 const fib_route_path_t *path);
156 * Set source specific opaque data
158 typedef void (*fib_entry_src_set_data_t)(fib_entry_src_t *src,
159 const fib_entry_t *fib_entry,
163 * Get source specific opaque data
165 typedef const void* (*fib_entry_src_get_data_t)(fib_entry_src_t *src,
166 const fib_entry_t *fib_entry);
169 * Virtual function table each FIB entry source will register
171 typedef struct fib_entry_src_vft_t_ {
172 fib_entry_src_init_t fesv_init;
173 fib_entry_src_deinit_t fesv_deinit;
174 fib_entry_src_activate_t fesv_activate;
175 fib_entry_src_deactivate_t fesv_deactivate;
176 fib_entry_src_add_t fesv_add;
177 fib_entry_src_remove_t fesv_remove;
178 fib_entry_src_path_swap_t fesv_path_swap;
179 fib_entry_src_path_add_t fesv_path_add;
180 fib_entry_src_path_remove_t fesv_path_remove;
181 fib_entry_src_cover_change_t fesv_cover_change;
182 fib_entry_src_cover_update_t fesv_cover_update;
183 fib_entry_src_format_t fesv_format;
184 fib_entry_src_installed_t fesv_installed;
185 fib_entry_src_fwd_update_t fesv_fwd_update;
186 fib_entry_src_get_data_t fesv_get_data;
187 fib_entry_src_set_data_t fesv_set_data;
188 } fib_entry_src_vft_t;
190 #define FOR_EACH_SRC_ADDED(_entry, _src, _source, action) \
192 vec_foreach(_src, _entry->fe_srcs) \
194 if (_src->fes_flags & FIB_ENTRY_SRC_FLAG_ADDED) { \
195 _source = _src->fes_src; \
203 extern u8* fib_entry_src_format(fib_entry_t *entry,
207 extern void fib_entry_src_register(fib_source_t source,
208 const fib_entry_src_vft_t *vft);
210 extern void fib_entry_src_action_init(fib_entry_t *entry,
211 fib_source_t source);
213 extern void fib_entry_src_action_deinit(fib_entry_t *fib_entry,
214 fib_source_t source);
216 extern fib_entry_src_cover_res_t fib_entry_src_action_cover_change(
218 fib_source_t source);
220 extern fib_entry_src_cover_res_t fib_entry_src_action_cover_update(
221 fib_entry_t *fib_entry,
222 fib_source_t source);
224 extern void fib_entry_src_action_activate(fib_entry_t *fib_entry,
225 fib_source_t source);
227 extern void fib_entry_src_action_deactivate(fib_entry_t *fib_entry,
228 fib_source_t source);
229 extern void fib_entry_src_action_reactivate(fib_entry_t *fib_entry,
230 fib_source_t source);
232 extern fib_entry_t* fib_entry_src_action_add(fib_entry_t *fib_entry,
234 fib_entry_flag_t flags,
235 const dpo_id_t *dpo);
236 extern fib_entry_t* fib_entry_src_action_update(fib_entry_t *fib_entry,
238 fib_entry_flag_t flags,
239 const dpo_id_t *dpo);
241 extern fib_entry_src_flag_t fib_entry_src_action_remove(fib_entry_t *fib_entry,
242 fib_source_t source);
244 extern void fib_entry_src_action_install(fib_entry_t *fib_entry,
245 fib_source_t source);
247 extern void fib_entry_src_action_uninstall(fib_entry_t *fib_entry);
249 extern fib_entry_t* fib_entry_src_action_path_add(fib_entry_t *fib_entry,
251 fib_entry_flag_t flags,
252 const fib_route_path_t *path);
254 extern fib_entry_t* fib_entry_src_action_path_swap(fib_entry_t *fib_entry,
256 fib_entry_flag_t flags,
257 const fib_route_path_t *path);
259 extern fib_entry_src_flag_t fib_entry_src_action_path_remove(fib_entry_t *fib_entry,
261 const fib_route_path_t *path);
263 extern void fib_entry_src_action_installed(const fib_entry_t *fib_entry,
264 fib_source_t source);
266 extern fib_forward_chain_type_t fib_entry_get_default_chain_type(
267 const fib_entry_t *fib_entry);
268 extern fib_entry_flag_t fib_entry_get_flags_i(const fib_entry_t *fib_entry);
269 extern fib_path_list_flags_t fib_entry_src_flags_2_path_list_flags(
270 fib_entry_flag_t eflags);
272 extern fib_forward_chain_type_t fib_entry_chain_type_fixup(const fib_entry_t *entry,
273 fib_forward_chain_type_t fct);
275 extern void fib_entry_src_mk_lb (fib_entry_t *fib_entry,
276 const fib_entry_src_t *esrc,
277 fib_forward_chain_type_t fct,
282 * Per-source registration. declared here so we save a separate .h file for each
284 extern void fib_entry_src_default_register(void);
285 extern void fib_entry_src_rr_register(void);
286 extern void fib_entry_src_interface_register(void);
287 extern void fib_entry_src_default_route_register(void);
288 extern void fib_entry_src_special_register(void);
289 extern void fib_entry_src_api_register(void);
290 extern void fib_entry_src_adj_register(void);
291 extern void fib_entry_src_mpls_register(void);
292 extern void fib_entry_src_lisp_register(void);
294 extern void fib_entry_src_module_init(void);