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);
63 * Source re-activation. Called when the source is updated and remains
66 typedef int (*fib_entry_src_reactivate_t)(fib_entry_src_t *src,
67 const fib_entry_t *fib_entry);
71 * Called when the source is no longer best source on the entry
73 typedef void (*fib_entry_src_deactivate_t)(fib_entry_src_t *src,
74 const fib_entry_t *fib_entry);
78 * Called when the source is added to the entry
80 typedef void (*fib_entry_src_add_t)(fib_entry_src_t *src,
81 const fib_entry_t *entry,
82 fib_entry_flag_t flags,
89 typedef void (*fib_entry_src_remove_t)(fib_entry_src_t *src);
92 * Result from a cover update/change
94 typedef struct fib_entry_src_cover_res_t_ {
96 fib_node_bw_reason_flag_t bw_reason;
97 } fib_entry_src_cover_res_t;
100 * Cover changed. the source should re-evaluate its cover.
102 typedef fib_entry_src_cover_res_t (*fib_entry_src_cover_change_t)(
103 fib_entry_src_t *src,
104 const fib_entry_t *fib_entry);
107 * Cover updated. The cover the source has, has updated (i.e. its forwarding)
108 * the source may need to re-evaluate.
110 typedef fib_entry_src_cover_res_t (*fib_entry_src_cover_update_t)(
111 fib_entry_src_t *src,
112 const fib_entry_t *fib_entry);
115 * Forwarding updated. Notification that the forwarding information for the
116 * entry has been updated. This notification is sent to all sources, not just
119 typedef void (*fib_entry_src_fwd_update_t)(fib_entry_src_t *src,
120 const fib_entry_t *fib_entry,
121 fib_source_t best_source);
124 * Installed. Notification that the source is now installed as
125 * the entry's forwarding source.
127 typedef void (*fib_entry_src_installed_t)(fib_entry_src_t *src,
128 const fib_entry_t *fib_entry);
133 typedef u8* (*fib_entry_src_format_t)(fib_entry_src_t *src,
138 * the source is adding a new path
140 typedef void (*fib_entry_src_path_add_t)(fib_entry_src_t *src,
141 const fib_entry_t *fib_entry,
142 fib_path_list_flags_t pl_flags,
143 const fib_route_path_t *path);
147 * the source is remoinvg a path
149 typedef void (*fib_entry_src_path_remove_t)(fib_entry_src_t *src,
150 fib_path_list_flags_t pl_flags,
151 const fib_route_path_t *path);
154 * Source path replace/swap
155 * the source is providing a new set of paths
157 typedef void (*fib_entry_src_path_swap_t)(fib_entry_src_t *src,
158 const fib_entry_t *fib_entry,
159 fib_path_list_flags_t pl_flags,
160 const fib_route_path_t *path);
163 * Set source specific opaque data
165 typedef void (*fib_entry_src_set_data_t)(fib_entry_src_t *src,
166 const fib_entry_t *fib_entry,
170 * Get source specific opaque data
172 typedef const void* (*fib_entry_src_get_data_t)(fib_entry_src_t *src,
173 const fib_entry_t *fib_entry);
176 * Virtual function table each FIB entry source will register
178 typedef struct fib_entry_src_vft_t_ {
179 fib_entry_src_init_t fesv_init;
180 fib_entry_src_deinit_t fesv_deinit;
181 fib_entry_src_activate_t fesv_activate;
182 fib_entry_src_deactivate_t fesv_deactivate;
183 fib_entry_src_reactivate_t fesv_reactivate;
184 fib_entry_src_add_t fesv_add;
185 fib_entry_src_remove_t fesv_remove;
186 fib_entry_src_path_swap_t fesv_path_swap;
187 fib_entry_src_path_add_t fesv_path_add;
188 fib_entry_src_path_remove_t fesv_path_remove;
189 fib_entry_src_cover_change_t fesv_cover_change;
190 fib_entry_src_cover_update_t fesv_cover_update;
191 fib_entry_src_format_t fesv_format;
192 fib_entry_src_installed_t fesv_installed;
193 fib_entry_src_fwd_update_t fesv_fwd_update;
194 fib_entry_src_get_data_t fesv_get_data;
195 fib_entry_src_set_data_t fesv_set_data;
196 } fib_entry_src_vft_t;
198 #define FOR_EACH_SRC_ADDED(_entry, _src, _source, action) \
200 vec_foreach(_src, _entry->fe_srcs) \
202 if (_src->fes_flags & FIB_ENTRY_SRC_FLAG_ADDED) { \
203 _source = _src->fes_src; \
211 extern u8* fib_entry_src_format(fib_entry_t *entry,
215 extern void fib_entry_src_register(fib_source_t source,
216 const fib_entry_src_vft_t *vft);
218 extern void fib_entry_src_action_init(fib_entry_t *entry,
219 fib_source_t source);
221 extern void fib_entry_src_action_deinit(fib_entry_t *fib_entry,
222 fib_source_t source);
224 extern fib_entry_src_cover_res_t fib_entry_src_action_cover_change(
226 fib_source_t source);
228 extern fib_entry_src_cover_res_t fib_entry_src_action_cover_update(
229 fib_entry_t *fib_entry,
230 fib_source_t source);
232 extern void fib_entry_src_action_activate(fib_entry_t *fib_entry,
233 fib_source_t source);
235 extern void fib_entry_src_action_deactivate(fib_entry_t *fib_entry,
236 fib_source_t source);
237 extern void fib_entry_src_action_reactivate(fib_entry_t *fib_entry,
238 fib_source_t source);
240 extern fib_entry_t* fib_entry_src_action_add(fib_entry_t *fib_entry,
242 fib_entry_flag_t flags,
243 const dpo_id_t *dpo);
244 extern fib_entry_t* fib_entry_src_action_update(fib_entry_t *fib_entry,
246 fib_entry_flag_t flags,
247 const dpo_id_t *dpo);
249 extern fib_entry_src_flag_t fib_entry_src_action_remove(fib_entry_t *fib_entry,
250 fib_source_t source);
251 extern fib_entry_src_flag_t
252 fib_entry_src_action_remove_or_update_inherit(fib_entry_t *fib_entry,
253 fib_source_t source);
255 extern void fib_entry_src_action_install(fib_entry_t *fib_entry,
256 fib_source_t source);
258 extern void fib_entry_src_action_uninstall(fib_entry_t *fib_entry);
260 extern fib_entry_t* fib_entry_src_action_path_add(fib_entry_t *fib_entry,
262 fib_entry_flag_t flags,
263 const fib_route_path_t *path);
265 extern fib_entry_t* fib_entry_src_action_path_swap(fib_entry_t *fib_entry,
267 fib_entry_flag_t flags,
268 const fib_route_path_t *path);
270 extern fib_entry_src_flag_t fib_entry_src_action_path_remove(fib_entry_t *fib_entry,
272 const fib_route_path_t *path);
274 extern void fib_entry_src_action_installed(const fib_entry_t *fib_entry,
275 fib_source_t source);
276 extern void fib_entry_src_inherit (const fib_entry_t *cover,
277 fib_entry_t *covered);
279 extern fib_forward_chain_type_t fib_entry_get_default_chain_type(
280 const fib_entry_t *fib_entry);
281 extern fib_entry_flag_t fib_entry_get_flags_i(const fib_entry_t *fib_entry);
283 extern fib_path_list_flags_t fib_entry_src_flags_2_path_list_flags(
284 fib_entry_flag_t eflags);
286 extern fib_forward_chain_type_t fib_entry_chain_type_fixup(const fib_entry_t *entry,
287 fib_forward_chain_type_t fct);
289 extern void fib_entry_src_mk_lb (fib_entry_t *fib_entry,
290 const fib_entry_src_t *esrc,
291 fib_forward_chain_type_t fct,
294 extern fib_protocol_t fib_entry_get_proto(const fib_entry_t * fib_entry);
295 extern dpo_proto_t fib_entry_get_dpo_proto(const fib_entry_t * fib_entry);
297 extern void fib_entry_source_change(fib_entry_t *fib_entry,
298 fib_source_t old_source,
299 fib_source_t new_source);
302 * Per-source registration. declared here so we save a separate .h file for each
304 extern void fib_entry_src_default_register(void);
305 extern void fib_entry_src_rr_register(void);
306 extern void fib_entry_src_interface_register(void);
307 extern void fib_entry_src_default_route_register(void);
308 extern void fib_entry_src_special_register(void);
309 extern void fib_entry_src_api_register(void);
310 extern void fib_entry_src_adj_register(void);
311 extern void fib_entry_src_mpls_register(void);
312 extern void fib_entry_src_lisp_register(void);
314 extern void fib_entry_src_module_init(void);