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"
26 extern vlib_log_class_t fib_entry_logger;
28 #define FIB_ENTRY_DBG(_e, _fmt, _args...) \
30 vlib_log_debug(fib_entry_logger, \
31 "[@%d:[%U]:%U:%U]: " _fmt, \
32 fib_entry_get_index(_e), \
35 format_fib_entry_flags, \
36 fib_entry_get_flags_i(_e), \
38 fib_entry_get_source_i(_e), \
43 * Source initialisation Function
45 typedef void (*fib_entry_src_init_t)(fib_entry_src_t *src);
48 * Source deinitialisation Function
50 typedef void (*fib_entry_src_deinit_t)(fib_entry_src_t *src);
53 * Source activation. Called when the source is the new best source on the entry.
54 * Return non-zero if the entry can now install, 0 otherwise
56 typedef int (*fib_entry_src_activate_t)(fib_entry_src_t *src,
57 const fib_entry_t *fib_entry);
60 * Source re-activation. Called when the source is updated and remains
63 typedef int (*fib_entry_src_reactivate_t)(fib_entry_src_t *src,
64 const fib_entry_t *fib_entry);
68 * Called when the source is no longer best source on the entry
70 typedef void (*fib_entry_src_deactivate_t)(fib_entry_src_t *src,
71 const fib_entry_t *fib_entry);
75 * Called when the source is added to the entry
77 typedef void (*fib_entry_src_add_t)(fib_entry_src_t *src,
78 const fib_entry_t *entry,
79 fib_entry_flag_t flags,
86 typedef void (*fib_entry_src_remove_t)(fib_entry_src_t *src);
89 * Result from a cover update/change
91 typedef struct fib_entry_src_cover_res_t_ {
93 fib_node_bw_reason_flag_t bw_reason;
94 } fib_entry_src_cover_res_t;
97 * Cover changed. the source should re-evaluate its cover.
99 typedef fib_entry_src_cover_res_t (*fib_entry_src_cover_change_t)(
100 fib_entry_src_t *src,
101 const fib_entry_t *fib_entry);
104 * Cover updated. The cover the source has, has updated (i.e. its forwarding)
105 * the source may need to re-evaluate.
107 typedef fib_entry_src_cover_res_t (*fib_entry_src_cover_update_t)(
108 fib_entry_src_t *src,
109 const fib_entry_t *fib_entry);
112 * Forwarding updated. Notification that the forwarding information for the
113 * entry has been updated. This notification is sent to all sources, not just
116 typedef void (*fib_entry_src_fwd_update_t)(fib_entry_src_t *src,
117 const fib_entry_t *fib_entry,
118 fib_source_t best_source);
121 * Installed. Notification that the source is now installed as
122 * the entry's forwarding source.
124 typedef void (*fib_entry_src_installed_t)(fib_entry_src_t *src,
125 const fib_entry_t *fib_entry);
130 typedef u8* (*fib_entry_src_format_t)(fib_entry_src_t *src,
135 * the source is adding a new path
137 typedef void (*fib_entry_src_path_add_t)(fib_entry_src_t *src,
138 const fib_entry_t *fib_entry,
139 fib_path_list_flags_t pl_flags,
140 const fib_route_path_t *path);
144 * the source is remoinvg a path
146 typedef void (*fib_entry_src_path_remove_t)(fib_entry_src_t *src,
147 fib_path_list_flags_t pl_flags,
148 const fib_route_path_t *path);
151 * Source path replace/swap
152 * the source is providing a new set of paths
154 typedef void (*fib_entry_src_path_swap_t)(fib_entry_src_t *src,
155 const fib_entry_t *fib_entry,
156 fib_path_list_flags_t pl_flags,
157 const fib_route_path_t *path);
160 * Set source specific opaque data
162 typedef void (*fib_entry_src_set_data_t)(fib_entry_src_t *src,
163 const fib_entry_t *fib_entry,
167 * Get source specific opaque data
169 typedef const void* (*fib_entry_src_get_data_t)(fib_entry_src_t *src,
170 const fib_entry_t *fib_entry);
173 * Contribute forwarding to interpose inthe chain
175 typedef const dpo_id_t* (*fib_entry_src_contribute_interpose_t)(const fib_entry_src_t *src,
176 const fib_entry_t *fib_entry);
179 * The fib entry flags for this source are changing
181 typedef void (*fib_entry_src_flag_change_t)(fib_entry_src_t *src,
182 const fib_entry_t *fib_entry,
183 fib_entry_flag_t new_flags);
186 * The fib entry flags for this source are changing
188 typedef void (*fib_entry_src_copy_t)(const fib_entry_src_t *orig_src,
189 const fib_entry_t *fib_entry,
190 fib_entry_src_t *copy_src);
193 * Virtual function table each FIB entry source will register
195 typedef struct fib_entry_src_vft_t_ {
196 fib_entry_src_init_t fesv_init;
197 fib_entry_src_deinit_t fesv_deinit;
198 fib_entry_src_activate_t fesv_activate;
199 fib_entry_src_deactivate_t fesv_deactivate;
200 fib_entry_src_reactivate_t fesv_reactivate;
201 fib_entry_src_add_t fesv_add;
202 fib_entry_src_remove_t fesv_remove;
203 fib_entry_src_path_swap_t fesv_path_swap;
204 fib_entry_src_path_add_t fesv_path_add;
205 fib_entry_src_path_remove_t fesv_path_remove;
206 fib_entry_src_cover_change_t fesv_cover_change;
207 fib_entry_src_cover_update_t fesv_cover_update;
208 fib_entry_src_format_t fesv_format;
209 fib_entry_src_installed_t fesv_installed;
210 fib_entry_src_fwd_update_t fesv_fwd_update;
211 fib_entry_src_get_data_t fesv_get_data;
212 fib_entry_src_set_data_t fesv_set_data;
213 fib_entry_src_contribute_interpose_t fesv_contribute_interpose;
214 fib_entry_src_flag_change_t fesv_flags_change;
215 fib_entry_src_copy_t fesv_copy;
216 } fib_entry_src_vft_t;
218 #define FOR_EACH_SRC_ADDED(_entry, _src, _source, action) \
220 vec_foreach(_src, (_entry)->fe_srcs) \
222 if (_src->fes_flags & FIB_ENTRY_SRC_FLAG_ADDED) { \
223 _source = (_src)->fes_src; \
229 #define FIB_ENTRY_SRC_VFT_INVOKE(esrc, func, args) \
231 const fib_entry_src_vft_t *_vft; \
232 _vft = fib_entry_src_get_vft(esrc); \
237 #define FIB_ENTRY_SRC_VFT_INVOKE_AND_RETURN(esrc, func, args) \
239 const fib_entry_src_vft_t *_vft; \
240 _vft = fib_entry_src_get_vft(esrc); \
242 return (_vft->func args); \
245 #define FIB_ENTRY_SRC_VFT_EXISTS(esrc, func) \
247 const fib_entry_src_vft_t *_vft; \
248 _vft = fib_entry_src_get_vft(esrc); \
252 extern const fib_entry_src_vft_t*fib_entry_src_get_vft(
253 const fib_entry_src_t *esrc);
255 extern u8* fib_entry_src_format(fib_entry_t *entry,
259 extern void fib_entry_src_register(fib_source_t source,
260 const fib_entry_src_vft_t *vft);
262 extern fib_entry_src_cover_res_t fib_entry_src_action_cover_change(
264 fib_entry_src_t *esrc);
266 extern fib_entry_src_cover_res_t fib_entry_src_action_cover_update(
267 fib_entry_t *fib_entry,
268 fib_entry_src_t *esrc);
270 extern void fib_entry_src_action_activate(fib_entry_t *fib_entry,
271 fib_source_t source);
273 extern void fib_entry_src_action_deactivate(fib_entry_t *fib_entry,
274 fib_source_t source);
275 extern void fib_entry_src_action_reactivate(fib_entry_t *fib_entry,
276 fib_source_t source);
278 extern fib_entry_t* fib_entry_src_action_add(fib_entry_t *fib_entry,
280 fib_entry_flag_t flags,
281 const dpo_id_t *dpo);
282 extern fib_entry_t* fib_entry_src_action_update(fib_entry_t *fib_entry,
284 fib_entry_flag_t flags,
285 const dpo_id_t *dpo);
287 extern fib_entry_src_flag_t fib_entry_src_action_remove(fib_entry_t *fib_entry,
288 fib_source_t source);
289 extern fib_entry_src_flag_t
290 fib_entry_src_action_remove_or_update_inherit(fib_entry_t *fib_entry,
291 fib_source_t source);
293 extern void fib_entry_src_action_install(fib_entry_t *fib_entry,
294 fib_source_t source);
296 extern void fib_entry_src_action_uninstall(fib_entry_t *fib_entry);
298 extern fib_entry_t* fib_entry_src_action_path_add(fib_entry_t *fib_entry,
300 fib_entry_flag_t flags,
301 const fib_route_path_t *path);
303 extern fib_entry_t* fib_entry_src_action_path_swap(fib_entry_t *fib_entry,
305 fib_entry_flag_t flags,
306 const fib_route_path_t *path);
308 extern fib_entry_src_flag_t fib_entry_src_action_path_remove(fib_entry_t *fib_entry,
310 const fib_route_path_t *path);
312 extern void fib_entry_src_action_installed(const fib_entry_t *fib_entry,
313 fib_source_t source);
314 extern void fib_entry_src_inherit (const fib_entry_t *cover,
315 fib_entry_t *covered);
317 extern fib_forward_chain_type_t fib_entry_get_default_chain_type(
318 const fib_entry_t *fib_entry);
319 extern fib_source_t fib_entry_get_source_i(const fib_entry_t *fib_entry);
320 extern fib_entry_flag_t fib_entry_get_flags_i(const fib_entry_t *fib_entry);
322 extern fib_path_list_flags_t fib_entry_src_flags_2_path_list_flags(
323 fib_entry_flag_t eflags);
325 extern fib_forward_chain_type_t fib_entry_chain_type_fixup(const fib_entry_t *entry,
326 fib_forward_chain_type_t fct);
328 extern void fib_entry_src_mk_lb (fib_entry_t *fib_entry,
329 const fib_entry_src_t *esrc,
330 fib_forward_chain_type_t fct,
333 extern fib_protocol_t fib_entry_get_proto(const fib_entry_t * fib_entry);
334 extern dpo_proto_t fib_entry_get_dpo_proto(const fib_entry_t * fib_entry);
336 extern void fib_entry_source_change(fib_entry_t *fib_entry,
337 fib_source_t old_source,
338 fib_source_t new_source);
341 * Per-source registration. declared here so we save a separate .h file for each
343 extern void fib_entry_src_default_register(void);
344 extern void fib_entry_src_rr_register(void);
345 extern void fib_entry_src_interface_register(void);
346 extern void fib_entry_src_interpose_register(void);
347 extern void fib_entry_src_default_route_register(void);
348 extern void fib_entry_src_special_register(void);
349 extern void fib_entry_src_api_register(void);
350 extern void fib_entry_src_adj_register(void);
351 extern void fib_entry_src_mpls_register(void);
352 extern void fib_entry_src_lisp_register(void);
354 extern void fib_entry_src_module_init(void);