src/vnet/fib/fib_entry_src.h

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