src/vnet/mfib/mfib_types.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 __MFIB_TYPES_H__
  17 #define __MFIB_TYPES_H__
  18
  19 #include <vnet/fib/fib_types.h>
  20
  21 /**
  22  * Aggregrate type for a prefix
  23  */
  24 typedef struct mfib_prefix_t_ {
  25     /**
  26      * The mask length
  27      */
  28     u16 fp_len;
  29
  30     /**
  31      * protocol type
  32      */
  33     fib_protocol_t fp_proto;
  34
  35     /**
  36      * Pad to keep the address 4 byte aligned
  37      */
  38     u8 ___fp___pad;
  39
  40     /**
  41      * The address type is not deriveable from the fp_addr member.
  42      * If it's v4, then the first 3 u32s of the address will be 0.
  43      * v6 addresses (even v4 mapped ones) have at least 2 u32s assigned
  44      * to non-zero values. true. but when it's all zero, one cannot decide.
  45      */
  46     ip46_address_t fp_grp_addr;
  47     ip46_address_t fp_src_addr;
  48 } mfib_prefix_t;
  49
  50 typedef enum mfib_entry_attribute_t_
  51 {
  52     MFIB_ENTRY_ATTRIBUTE_FIRST = 0,
  53     /**
  54      * The control planes needs packets mathing this entry to generate
  55      * a signal.
  56      */
  57     MFIB_ENTRY_SIGNAL =  MFIB_ENTRY_ATTRIBUTE_FIRST,
  58     /**
  59      * Drop all traffic to this route
  60      */
  61     MFIB_ENTRY_DROP,
  62     /**
  63      * The control plane needs to be informed of coneected sources
  64      */
  65     MFIB_ENTRY_CONNECTED,
  66     /**
  67      * Accept packets from any incpoming interface
  68      *        Use with extreme caution
  69      */
  70     MFIB_ENTRY_ACCEPT_ALL_ITF,
  71     MFIB_ENTRY_INHERIT_ACCEPT,
  72     MFIB_ENTRY_ATTRIBUTE_LAST = MFIB_ENTRY_INHERIT_ACCEPT,
  73 } mfib_entry_attribute_t;
  74
  75 #define FOR_EACH_MFIB_ATTRIBUTE(_item)                  \
  76     for (_item = MFIB_ENTRY_ATTRIBUTE_FIRST;            \
  77          _item <= MFIB_ENTRY_ATTRIBUTE_LAST;            \
  78          _item++)
  79
  80 #define MFIB_ENTRY_NAMES_SHORT  {          \
  81     [MFIB_ENTRY_SIGNAL]         = "S",     \
  82     [MFIB_ENTRY_CONNECTED]      = "C",     \
  83     [MFIB_ENTRY_DROP]           = "D",     \
  84     [MFIB_ENTRY_ACCEPT_ALL_ITF] = "AA",    \
  85     [MFIB_ENTRY_INHERIT_ACCEPT] = "IA",    \
  86 }
  87
  88 #define MFIB_ENTRY_NAMES_LONG  {                    \
  89     [MFIB_ENTRY_SIGNAL]         = "Signal",         \
  90     [MFIB_ENTRY_CONNECTED]      = "Connected",      \
  91     [MFIB_ENTRY_DROP]           = "Drop",           \
  92     [MFIB_ENTRY_ACCEPT_ALL_ITF] = "Accept-all-itf", \
  93     [MFIB_ENTRY_INHERIT_ACCEPT] = "Inherit-Accept", \
  94 }
  95
  96 typedef enum mfib_entry_flags_t_
  97 {
  98     MFIB_ENTRY_FLAG_NONE,
  99     MFIB_ENTRY_FLAG_SIGNAL = (1 << MFIB_ENTRY_SIGNAL),
 100     MFIB_ENTRY_FLAG_DROP = (1 << MFIB_ENTRY_DROP),
 101     MFIB_ENTRY_FLAG_CONNECTED = (1 << MFIB_ENTRY_CONNECTED),
 102     MFIB_ENTRY_FLAG_INHERIT_ACCEPT = (1 << MFIB_ENTRY_INHERIT_ACCEPT),
 103     MFIB_ENTRY_FLAG_ACCEPT_ALL_ITF = (1 << MFIB_ENTRY_ACCEPT_ALL_ITF),
 104 } mfib_entry_flags_t;
 105
 106 typedef enum mfib_itf_attribute_t_
 107 {
 108     MFIB_ITF_ATTRIBUTE_FIRST,
 109     MFIB_ITF_NEGATE_SIGNAL = MFIB_ITF_ATTRIBUTE_FIRST,
 110     MFIB_ITF_ACCEPT,
 111     MFIB_ITF_FORWARD,
 112     MFIB_ITF_SIGNAL_PRESENT,
 113     MFIB_ITF_DONT_PRESERVE,
 114     MFIB_ITF_ATTRIBUTE_LAST = MFIB_ITF_DONT_PRESERVE,
 115 } mfib_itf_attribute_t;
 116
 117 #define FOR_EACH_MFIB_ITF_ATTRIBUTE(_item)              \
 118     for (_item = MFIB_ITF_ATTRIBUTE_FIRST;              \
 119          _item <= MFIB_ITF_ATTRIBUTE_LAST;              \
 120          _item++)
 121
 122 #define MFIB_ITF_NAMES_SHORT  {             \
 123     [MFIB_ITF_NEGATE_SIGNAL] = "NS",        \
 124     [MFIB_ITF_ACCEPT] = "A",                \
 125     [MFIB_ITF_FORWARD] = "F",               \
 126     [MFIB_ITF_SIGNAL_PRESENT] = "SP",       \
 127     [MFIB_ITF_DONT_PRESERVE] = "DP",        \
 128 }
 129
 130 #define MFIB_ITF_NAMES_LONG  {                    \
 131     [MFIB_ITF_NEGATE_SIGNAL] = "Negate-Signal",   \
 132     [MFIB_ITF_ACCEPT] = "Accept",                 \
 133     [MFIB_ITF_FORWARD] = "Forward",               \
 134     [MFIB_ITF_SIGNAL_PRESENT] = "Signal-Present", \
 135     [MFIB_ITF_DONT_PRESERVE] = "Don't-Preserve", \
 136 }
 137
 138 typedef enum mfib_itf_flags_t_
 139 {
 140     MFIB_ITF_FLAG_NONE,
 141     MFIB_ITF_FLAG_NEGATE_SIGNAL = (1 << MFIB_ITF_NEGATE_SIGNAL),
 142     MFIB_ITF_FLAG_ACCEPT = (1 << MFIB_ITF_ACCEPT),
 143     MFIB_ITF_FLAG_FORWARD = (1 << MFIB_ITF_FORWARD),
 144     MFIB_ITF_FLAG_SIGNAL_PRESENT = (1 << MFIB_ITF_SIGNAL_PRESENT),
 145     MFIB_ITF_FLAG_DONT_PRESERVE = (1 << MFIB_ITF_DONT_PRESERVE),
 146 } mfib_itf_flags_t;
 147
 148 /**
 149  * Possible [control plane] sources of MFIB entries
 150  */
 151 typedef enum mfib_source_t_
 152 {
 153     MFIB_SOURCE_SPECIAL,
 154     MFIB_SOURCE_API,
 155     MFIB_SOURCE_CLI,
 156     MFIB_SOURCE_VXLAN,
 157     MFIB_SOURCE_DHCP,
 158     MFIB_SOURCE_DEFAULT_ROUTE,
 159 } mfib_source_t;
 160
 161 #define MFIB_SOURCE_NAMES {                        \
 162     [MFIB_SOURCE_SPECIAL] = "Special",             \
 163     [MFIB_SOURCE_API] = "API",                     \
 164     [MFIB_SOURCE_CLI] = "CLI",                     \
 165     [MFIB_SOURCE_DHCP] = "DHCP",                   \
 166     [MFIB_SOURCE_VXLAN] = "VXLAN",                 \
 167     [MFIB_SOURCE_DEFAULT_ROUTE] = "Default Route", \
 168 }
 169
 170 /**
 171  * \brief Compare two prefixes for equality
 172  */
 173 extern int mfib_prefix_cmp(const mfib_prefix_t *p1,
 174                            const mfib_prefix_t *p2);
 175
 176 extern u8 * format_mfib_prefix(u8 * s, va_list * args);
 177
 178 extern u8 *format_mfib_entry_flags(u8 * s, va_list * args);
 179 extern u8 *format_mfib_itf_flags(u8 * s, va_list * args);
 180 extern uword unformat_mfib_itf_flags(unformat_input_t * input,
 181                                      va_list * args);
 182 extern uword unformat_mfib_entry_flags(unformat_input_t * input,
 183                                        va_list * args);
 184
 185 #endif