src/vnet/fib/fib_entry_delegate.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_DELEGATE_T__
  17 #define __FIB_ENTRY_DELEGATE_T__
  18
  19 #include <vnet/fib/fib_node.h>
  20
  21 /**
  22  * Delegate types
  23  */
  24 typedef enum fib_entry_delegate_type_t_ {
  25     /**
  26      * Forwarding chain types:
  27      * for the vast majority of FIB entries only one chain is required - the
  28      * one that forwards traffic matching the fib_entry_t's fib_prefix_t. For those
  29      * fib_entry_t that are a resolution target for other fib_entry_t's they will also
  30      * need the chain to provide forwarding for those children. We store these additional
  31      * chains in delegates to save memory in the common case.
  32      */
  33     FIB_ENTRY_DELEGATE_CHAIN_UNICAST_IP4 = FIB_FORW_CHAIN_TYPE_UNICAST_IP4,
  34     FIB_ENTRY_DELEGATE_CHAIN_UNICAST_IP6 = FIB_FORW_CHAIN_TYPE_UNICAST_IP6,
  35     FIB_ENTRY_DELEGATE_CHAIN_MPLS_EOS = FIB_FORW_CHAIN_TYPE_MPLS_EOS,
  36     FIB_ENTRY_DELEGATE_CHAIN_MPLS_NON_EOS = FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS,
  37     FIB_ENTRY_DELEGATE_CHAIN_ETHERNET = FIB_FORW_CHAIN_TYPE_ETHERNET,
  38     /**
  39      * Dependency list of covered entries.
  40      * these are more specific entries that are interested in changes
  41      * to their respective cover
  42      */
  43     FIB_ENTRY_DELEGATE_COVERED,
  44     /**
  45      * Attached import/export functionality
  46      */
  47     FIB_ENTRY_DELEGATE_ATTACHED_IMPORT,
  48     FIB_ENTRY_DELEGATE_ATTACHED_EXPORT,
  49 } fib_entry_delegate_type_t;
  50
  51 #define FOR_EACH_DELEGATE_CHAIN(_entry, _fdt, _fed, _body)    \
  52 {                                                             \
  53     for (_fdt = FIB_ENTRY_DELEGATE_CHAIN_UNICAST_IP4;         \
  54          _fdt <= FIB_ENTRY_DELEGATE_CHAIN_ETHERNET;           \
  55          _fdt++)                                              \
  56     {                                                         \
  57         _fed = fib_entry_delegate_get(_entry, _fdt);          \
  58         if (NULL != _fed) {                                   \
  59             _body;                                            \
  60         }                                                     \
  61     }                                                         \
  62 }
  63
  64 /**
  65  * A Delagate is a means to implmenet the Delagation design pattern; the extension of an
  66  * objects functionality through the composition of, and delgation to, other objects.
  67  * These 'other' objects are delegates. Delagates are thus attached to other FIB objects
  68  * to extend their functionality.
  69  */
  70 typedef struct fib_entry_delegate_t_
  71 {
  72     /**
  73      * The FIB entry object to which the delagate is attached
  74      */
  75     fib_node_index_t fd_entry_index;
  76
  77     /**
  78      * The delagate type
  79      */
  80     fib_entry_delegate_type_t fd_type;
  81
  82     /**
  83      * A union of data for the different delegate types
  84      * These delegates are stored in a sparse vector on the entry, so they
  85      * must all be of the same size. We could use indirection here for all types,
  86      * i.e. store an index, that's ok for large delegates, like the attached export
  87      * but for the chain delegates it's excessive
  88      */
  89     union
  90     {
  91         /**
  92          * Valid for the forwarding chain delegates. The LB that is built.
  93          */
  94         dpo_id_t fd_dpo;
  95
  96         /**
  97          * Valid for the attached import cases. An index of the importer/exporter
  98          */
  99         fib_node_index_t fd_index;
 100
 101         /**
 102          * For the cover tracking. The node list;
 103          */
 104         fib_node_list_t fd_list;
 105     };
 106 } fib_entry_delegate_t;
 107
 108 struct fib_entry_t_;
 109
 110 extern void fib_entry_delegate_remove(struct fib_entry_t_ *fib_entry,
 111                                       fib_entry_delegate_type_t type);
 112
 113 extern fib_entry_delegate_t *fib_entry_delegate_find_or_add(struct fib_entry_t_ *fib_entry,
 114                                                             fib_entry_delegate_type_t fdt);
 115 extern fib_entry_delegate_t *fib_entry_delegate_get(const struct fib_entry_t_ *fib_entry,
 116                                                     fib_entry_delegate_type_t type);
 117
 118 extern fib_forward_chain_type_t fib_entry_delegate_type_to_chain_type(
 119     fib_entry_delegate_type_t type);
 120
 121 extern fib_entry_delegate_type_t fib_entry_chain_type_to_delegate_type(
 122      fib_forward_chain_type_t type);
 123
 124 #endif