src/vnet/l2/l2_output.h

   1 /*
   2  * l2_output.h : layer 2 output packet processing
   3  *
   4  * Copyright (c) 2013 Cisco and/or its affiliates.
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #ifndef included_vnet_l2_output_h
  19 #define included_vnet_l2_output_h
  20
  21 #include <vlib/vlib.h>
  22 #include <vnet/vnet.h>
  23 #include <vnet/l2/feat_bitmap.h>
  24 #include <vnet/l2/l2_vtr.h>
  25
  26
  27 /* The L2 output feature configuration, a per-interface struct */
  28 typedef struct
  29 {
  30
  31   /*
  32    * vlan tag rewrite for ingress and egress
  33    * ingress vtr is located here because the same config data is used for
  34    * the egress EFP filter check
  35    */
  36   vtr_config_t input_vtr;
  37   vtr_config_t output_vtr;
  38   ptr_config_t input_pbb_vtr;
  39   ptr_config_t output_pbb_vtr;
  40
  41   u32 feature_bitmap;
  42
  43   /* split horizon group */
  44   u8 shg;
  45
  46   /* flag for output vtr operation */
  47   u8 out_vtr_flag;
  48
  49 } l2_output_config_t;
  50
  51 typedef struct
  52 {
  53   /*
  54    * vector of output next node index, indexed by sw_if_index.
  55    * used when all output features have been executed and the
  56    * next nodes are the interface output nodes.
  57    */
  58   u32 *output_node_index_vec;
  59
  60   /*
  61    * array of next node index for each output feature, indexed
  62    * by l2output_feat_t. Used to determine next feature node.
  63    */
  64   u32 l2_out_feat_next[32];
  65
  66   /* config vector indexed by sw_if_index */
  67   l2_output_config_t *configs;
  68
  69   /* Convenience variables */
  70   vlib_main_t *vlib_main;
  71   vnet_main_t *vnet_main;
  72 } l2output_main_t;
  73
  74 extern l2output_main_t l2output_main;
  75
  76 extern vlib_node_registration_t l2output_node;
  77
  78 /* L2 output features */
  79
  80 /* Mappings from feature ID to graph node name in reverse order */
  81 #define foreach_l2output_feat \
  82  _(OUTPUT,            "interface-output")           \
  83  _(SPAN,              "span-l2-output")             \
  84  _(GBP_POLICY_PORT,   "gbp-policy-port")            \
  85  _(GBP_POLICY_MAC,    "gbp-policy-mac")             \
  86  _(CFM,               "feature-bitmap-drop")        \
  87  _(QOS,               "feature-bitmap-drop")        \
  88  _(ACL,               "l2-output-acl")              \
  89  _(L2PT,              "feature-bitmap-drop")        \
  90  _(EFP_FILTER,        "l2-efp-filter")              \
  91  _(IPIW,              "feature-bitmap-drop")        \
  92  _(STP_BLOCKED,       "feature-bitmap-drop")        \
  93  _(LINESTATUS_DOWN,   "feature-bitmap-drop")        \
  94  _(OUTPUT_CLASSIFY,   "l2-output-classify")         \
  95  _(OUTPUT_FEAT_ARC,   "l2-output-feat-arc")         \
  96  _(XCRW,              "l2-xcrw")
  97
  98 /* Feature bitmap positions */
  99 typedef enum
 100 {
 101 #define _(sym,str) L2OUTPUT_FEAT_##sym##_BIT,
 102   foreach_l2output_feat
 103 #undef _
 104     L2OUTPUT_N_FEAT,
 105 } l2output_feat_t;
 106
 107 STATIC_ASSERT (L2OUTPUT_N_FEAT <= 32, "too many l2 output features");
 108
 109 /* Feature bit masks */
 110 typedef enum
 111 {
 112   L2OUTPUT_FEAT_NONE = 0,
 113 #define _(sym,str) L2OUTPUT_FEAT_##sym = (1<<L2OUTPUT_FEAT_##sym##_BIT),
 114   foreach_l2output_feat
 115 #undef _
 116 } l2output_feat_masks_t;
 117
 118 #define foreach_l2output_error                          \
 119 _(L2OUTPUT,     "L2 output packets")                    \
 120 _(EFP_DROP,     "L2 EFP filter pre-rewrite drops")      \
 121 _(VTR_DROP,     "L2 output tag rewrite drops")          \
 122 _(SHG_DROP,     "L2 split horizon drops")               \
 123 _(DROP,         "L2 output drops")                      \
 124 _(MAPPING_DROP, "L2 Output interface not valid")
 125
 126 typedef enum
 127 {
 128   L2OUTPUT_NEXT_DROP,
 129   L2OUTPUT_NEXT_BAD_INTF,
 130   L2OUTPUT_N_NEXT,
 131 } l2output_next_t;
 132
 133 typedef enum
 134 {
 135 #define _(sym,str) L2OUTPUT_ERROR_##sym,
 136   foreach_l2output_error
 137 #undef _
 138     L2OUTPUT_N_ERROR,
 139 } l2output_error_t;
 140
 141 /* Return an array of strings containing graph node names of each feature */
 142 char **l2output_get_feat_names (void);
 143
 144 /* arg0 - u32 feature_bitmap, arg1 - u32 verbose */
 145 u8 *format_l2_output_features (u8 * s, va_list * args);
 146
 147 /**
 148  * The next set of functions is for use by output feature graph nodes.
 149  * When the last bit has been cleared from the output feature bitmap,
 150  * the next node is the output graph node for the TX sw_if_index.
 151  * These functions help the feature nodes get that node index.
 152  */
 153
 154 /* Create a mapping to the output graph node for the given sw_if_index */
 155 void l2output_create_output_node_mapping (vlib_main_t * vlib_main,
 156                                           vnet_main_t * vnet_main,
 157                                           u32 sw_if_index);
 158
 159 /** Get a pointer to the config for the given interface */
 160 l2_output_config_t *l2output_intf_config (u32 sw_if_index);
 161
 162 /** Enable (or disable) the feature in the bitmap for the given interface */
 163 void l2output_intf_bitmap_enable (u32 sw_if_index,
 164                                   l2output_feat_masks_t feature_bitmap,
 165                                   u32 enable);
 166
 167 #endif
 168
 169 /*
 170  * fd.io coding-style-patch-verification: ON
 171  *
 172  * Local Variables:
 173  * eval: (c-set-style "gnu")
 174  * End:
 175  */