1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
|
/*
* Copyright (c) 2016 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef __FIB_ENTRY_SRC_H__
#define __FIB_ENTRY_SRC_H__
#include "fib_entry.h"
#include "fib_path_list.h"
#include "fib_internal.h"
/**
* Debug macro
*/
extern vlib_log_class_t fib_entry_logger;
#define FIB_ENTRY_DBG(_e, _fmt, _args...) \
{ \
vlib_log_debug(fib_entry_logger, \
"[@%d:[%U]:%U:%U]: " _fmt, \
fib_entry_get_index(_e), \
format_fib_prefix, \
&_e->fe_prefix, \
format_fib_entry_flags, \
fib_entry_get_flags_i(_e), \
format_fib_source, \
fib_entry_get_source_i(_e), \
##_args); \
}
/**
* Source initialisation Function
*/
typedef void (*fib_entry_src_init_t)(fib_entry_src_t *src);
/**
* Source deinitialisation Function
*/
typedef void (*fib_entry_src_deinit_t)(fib_entry_src_t *src);
/**
* Source activation. Called when the source is the new best source on the entry.
* Return non-zero if the entry can now install, 0 otherwise
*/
typedef int (*fib_entry_src_activate_t)(fib_entry_src_t *src,
const fib_entry_t *fib_entry);
/**
* Source re-activation. Called when the source is updated and remains
* the best source.
*/
typedef int (*fib_entry_src_reactivate_t)(fib_entry_src_t *src,
const fib_entry_t *fib_entry);
/**
* Source Deactivate.
* Called when the source is no longer best source on the entry
*/
typedef void (*fib_entry_src_deactivate_t)(fib_entry_src_t *src,
const fib_entry_t *fib_entry);
/**
* Source Add.
* Called when the source is added to the entry
*/
typedef void (*fib_entry_src_add_t)(fib_entry_src_t *src,
const fib_entry_t *entry,
fib_entry_flag_t flags,
dpo_proto_t proto,
const dpo_id_t *dpo);
/**
* Source Remove.
*/
typedef void (*fib_entry_src_remove_t)(fib_entry_src_t *src);
/**
* Result from a cover update/change
*/
typedef struct fib_entry_src_cover_res_t_ {
u16 install;
fib_node_bw_reason_flag_t bw_reason;
} fib_entry_src_cover_res_t;
/**
* Cover changed. the source should re-evaluate its cover.
*/
typedef fib_entry_src_cover_res_t (*fib_entry_src_cover_change_t)(
fib_entry_src_t *src,
const fib_entry_t *fib_entry);
/**
* Cover updated. The cover the source has, has updated (i.e. its forwarding)
* the source may need to re-evaluate.
*/
typedef fib_entry_src_cover_res_t (*fib_entry_src_cover_update_t)(
fib_entry_src_t *src,
const fib_entry_t *fib_entry);
/**
* Forwarding updated. Notification that the forwarding information for the
* entry has been updated. This notification is sent to all sources, not just
* the active best.
*/
typedef void (*fib_entry_src_fwd_update_t)(fib_entry_src_t *src,
const fib_entry_t *fib_entry,
fib_source_t best_source);
/**
* Installed. Notification that the source is now installed as
* the entry's forwarding source.
*/
typedef void (*fib_entry_src_installed_t)(fib_entry_src_t *src,
const fib_entry_t *fib_entry);
/**
* format.
*/
typedef u8* (*fib_entry_src_format_t)(fib_entry_src_t *src,
u8* s);
/**
* Source path add
* the source is adding a new path
*/
typedef void (*fib_entry_src_path_add_t)(fib_entry_src_t *src,
const fib_entry_t *fib_entry,
fib_path_list_flags_t pl_flags,
const fib_route_path_t *path);
/**
* Source path remove
* the source is remoinvg a path
*/
typedef void (*fib_entry_src_path_remove_t)(fib_entry_src_t *src,
fib_path_list_flags_t pl_flags,
const fib_route_path_t *path);
/**
* Source path replace/swap
* the source is providing a new set of paths
*/
typedef void (*fib_entry_src_path_swap_t)(fib_entry_src_t *src,
const fib_entry_t *fib_entry,
fib_path_list_flags_t pl_flags,
const fib_route_path_t *path);
/**
* Set source specific opaque data
*/
typedef void (*fib_entry_src_set_data_t)(fib_entry_src_t *src,
const fib_entry_t *fib_entry,
const void *data);
/**
* Get source specific opaque data
*/
typedef const void* (*fib_entry_src_get_data_t)(fib_entry_src_t *src,
const fib_entry_t *fib_entry);
/**
* Contribute forwarding to interpose inthe chain
*/
typedef const dpo_id_t* (*fib_entry_src_contribute_interpose_t)(const fib_entry_src_t *src,
const fib_entry_t *fib_entry);
/**
* The fib entry flags for this source are changing
*/
typedef void (*fib_entry_src_flag_change_t)(fib_entry_src_t *src,
const fib_entry_t *fib_entry,
fib_entry_flag_t new_flags);
/**
* The fib entry flags for this source are changing
*/
typedef void (*fib_entry_src_copy_t)(const fib_entry_src_t *orig_src,
const fib_entry_t *fib_entry,
fib_entry_src_t *copy_src);
/**
* Virtual function table each FIB entry source will register
*/
typedef struct fib_entry_src_vft_t_ {
fib_entry_src_init_t fesv_init;
fib_entry_src_deinit_t fesv_deinit;
fib_entry_src_activate_t fesv_activate;
fib_entry_src_deactivate_t fesv_deactivate;
fib_entry_src_reactivate_t fesv_reactivate;
fib_entry_src_add_t fesv_add;
fib_entry_src_remove_t fesv_remove;
fib_entry_src_path_swap_t fesv_path_swap;
fib_entry_src_path_add_t fesv_path_add;
fib_entry_src_path_remove_t fesv_path_remove;
fib_entry_src_cover_change_t fesv_cover_change;
fib_entry_src_cover_update_t fesv_cover_update;
fib_entry_src_format_t fesv_format;
fib_entry_src_installed_t fesv_installed;
fib_entry_src_fwd_update_t fesv_fwd_update;
fib_entry_src_get_data_t fesv_get_data;
fib_entry_src_set_data_t fesv_set_data;
fib_entry_src_contribute_interpose_t fesv_contribute_interpose;
fib_entry_src_flag_change_t fesv_flags_change;
fib_entry_src_copy_t fesv_copy;
} fib_entry_src_vft_t;
#define FOR_EACH_SRC_ADDED(_entry, _src, _source, action) \
{ \
vec_foreach(_src, (_entry)->fe_srcs) \
{ \
if (_src->fes_flags & FIB_ENTRY_SRC_FLAG_ADDED) { \
_source = (_src)->fes_src; \
action; \
} \
} \
}
#define FIB_ENTRY_SRC_VFT_INVOKE(esrc, func, args) \
{ \
const fib_entry_src_vft_t *_vft; \
_vft = fib_entry_src_get_vft(esrc); \
if (_vft->func) { \
(esrc)->fes_flags &= ~FIB_ENTRY_SRC_FLAG_STALE; \
_vft->func args; \
} \
}
#define FIB_ENTRY_SRC_VFT_INVOKE_AND_RETURN(esrc, func, args) \
{ \
const fib_entry_src_vft_t *_vft; \
_vft = fib_entry_src_get_vft(esrc); \
if (_vft->func) { \
(esrc)->fes_flags &= ~FIB_ENTRY_SRC_FLAG_STALE; \
return (_vft->func args); \
} \
}
#define FIB_ENTRY_SRC_VFT_EXISTS(esrc, func) \
{ \
const fib_entry_src_vft_t *_vft; \
_vft = fib_entry_src_get_vft(esrc); \
(_vft->func); \
}
extern const fib_entry_src_vft_t*fib_entry_src_get_vft(
const fib_entry_src_t *esrc);
extern u8* fib_entry_src_format(fib_entry_t *entry,
fib_source_t source,
u8* s);
extern void fib_entry_src_register(fib_source_t source,
const fib_entry_src_vft_t *vft);
extern fib_entry_src_cover_res_t fib_entry_src_action_cover_change(
fib_entry_t *entry,
fib_entry_src_t *esrc);
extern fib_entry_src_cover_res_t fib_entry_src_action_cover_update(
fib_entry_t *fib_entry,
fib_entry_src_t *esrc);
extern void fib_entry_src_action_activate(fib_entry_t *fib_entry,
fib_source_t source);
extern void fib_entry_src_action_deactivate(fib_entry_t *fib_entry,
fib_source_t source);
extern void fib_entry_src_action_reactivate(fib_entry_t *fib_entry,
fib_source_t source);
extern fib_entry_t* fib_entry_src_action_add(fib_entry_t *fib_entry,
fib_source_t source,
fib_entry_flag_t flags,
const dpo_id_t *dpo);
extern fib_entry_t* fib_entry_src_action_update(fib_entry_t *fib_entry,
fib_source_t source,
fib_entry_flag_t flags,
const dpo_id_t *dpo);
extern fib_entry_src_flag_t fib_entry_src_action_remove(fib_entry_t *fib_entry,
fib_source_t source);
extern fib_entry_src_flag_t
fib_entry_src_action_remove_or_update_inherit(fib_entry_t *fib_entry,
fib_source_t source);
extern void fib_entry_src_action_install(fib_entry_t *fib_entry,
fib_source_t source);
extern void fib_entry_src_action_uninstall(fib_entry_t *fib_entry);
extern fib_entry_t* fib_entry_src_action_path_add(fib_entry_t *fib_entry,
fib_source_t source,
fib_entry_flag_t flags,
const fib_route_path_t *path);
extern fib_entry_t* fib_entry_src_action_path_swap(fib_entry_t *fib_entry,
fib_source_t source,
fib_entry_flag_t flags,
const fib_route_path_t *path);
extern fib_entry_src_flag_t fib_entry_src_action_path_remove(fib_entry_t *fib_entry,
fib_source_t source,
const fib_route_path_t *path);
extern void fib_entry_src_action_installed(const fib_entry_t *fib_entry,
fib_source_t source);
extern void fib_entry_src_inherit (const fib_entry_t *cover,
fib_entry_t *covered);
extern fib_forward_chain_type_t fib_entry_get_default_chain_type(
const fib_entry_t *fib_entry);
extern fib_source_t fib_entry_get_source_i(const fib_entry_t *fib_entry);
extern fib_entry_flag_t fib_entry_get_flags_i(const fib_entry_t *fib_entry);
extern fib_path_list_flags_t fib_entry_src_flags_2_path_list_flags(
fib_entry_flag_t eflags);
extern fib_forward_chain_type_t fib_entry_chain_type_fixup(const fib_entry_t *entry,
fib_forward_chain_type_t fct);
extern void fib_entry_src_mk_lb (fib_entry_t *fib_entry,
const fib_entry_src_t *esrc,
fib_forward_chain_type_t fct,
dpo_id_t *dpo_lb);
extern fib_protocol_t fib_entry_get_proto(const fib_entry_t * fib_entry);
extern dpo_proto_t fib_entry_get_dpo_proto(const fib_entry_t * fib_entry);
extern void fib_entry_source_change(fib_entry_t *fib_entry,
fib_source_t old_source,
fib_source_t new_source);
/*
* Per-source registration. declared here so we save a separate .h file for each
*/
extern void fib_entry_src_default_register(void);
extern void fib_entry_src_rr_register(void);
extern void fib_entry_src_interface_register(void);
extern void fib_entry_src_interpose_register(void);
extern void fib_entry_src_default_route_register(void);
extern void fib_entry_src_special_register(void);
extern void fib_entry_src_api_register(void);
extern void fib_entry_src_adj_register(void);
extern void fib_entry_src_mpls_register(void);
extern void fib_entry_src_lisp_register(void);
extern void fib_entry_src_module_init(void);
#endif
|
