vnet/vnet/feature/feature.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 included_features_h
  17 #define included_features_h
  18
  19 #include <vnet/vnet.h>
  20 #include <vnet/api_errno.h>
  21
  22 /** feature registration object */
  23 typedef struct _vnet_feature_arc_registration
  24 {
  25   /** next registration in list of all registrations*/
  26   struct _vnet_feature_arc_registration *next;
  27   /** Feature Arc name */
  28   char *arc_name;
  29   /** Start nodes */
  30   char **start_nodes;
  31   int n_start_nodes;
  32   /* Feature arc index, assigned by init function */
  33   u8 feature_arc_index;
  34 } vnet_feature_arc_registration_t;
  35
  36 /** feature registration object */
  37 typedef struct _vnet_feature_registration
  38 {
  39   /** next registration in list of all registrations*/
  40   struct _vnet_feature_registration *next;
  41   /** Feature arc name */
  42   char *arc_name;
  43   /** Graph node name */
  44   char *node_name;
  45   /** Pointer to this feature index, filled in by vnet_feature_arc_init */
  46   u32 *feature_index;
  47   u32 feature_index_u32;
  48   /** Constraints of the form "this feature runs before X" */
  49   char **runs_before;
  50   /** Constraints of the form "this feature runs after Y" */
  51   char **runs_after;
  52 } vnet_feature_registration_t;
  53
  54 typedef struct vnet_feature_config_main_t_
  55 {
  56   vnet_config_main_t config_main;
  57   u32 *config_index_by_sw_if_index;
  58 } vnet_feature_config_main_t;
  59
  60 typedef struct
  61 {
  62   /** feature arc configuration list */
  63   vnet_feature_arc_registration_t *next_arc;
  64   uword **arc_index_by_name;
  65
  66   /** feature path configuration lists */
  67   vnet_feature_registration_t *next_feature;
  68   vnet_feature_registration_t **next_feature_by_arc;
  69   uword **next_feature_by_name;
  70
  71   /** feature config main objects */
  72   vnet_feature_config_main_t *feature_config_mains;
  73
  74   /** Save partial order results for show command */
  75   char ***feature_nodes;
  76
  77   /** bitmap of interfaces which have driver rx features configured */
  78   uword **sw_if_index_has_features;
  79
  80   /** feature reference counts by interface */
  81   i16 **feature_count_by_sw_if_index;
  82
  83   /** Feature arc index for device-input */
  84   u8 device_input_feature_arc_index;
  85
  86   /** convenience */
  87   vlib_main_t *vlib_main;
  88   vnet_main_t *vnet_main;
  89 } vnet_feature_main_t;
  90
  91 extern vnet_feature_main_t feature_main;
  92
  93 #define VNET_FEATURE_ARC_INIT(x,...)                            \
  94   __VA_ARGS__ vnet_feature_arc_registration_t vnet_feat_arc_##x;\
  95 static void __vnet_add_feature_arc_registration_##x (void)      \
  96   __attribute__((__constructor__)) ;                            \
  97 static void __vnet_add_feature_arc_registration_##x (void)      \
  98 {                                                               \
  99   vnet_feature_main_t * fm = &feature_main;                     \
 100   vnet_feat_arc_##x.next = fm->next_arc;                        \
 101   fm->next_arc = & vnet_feat_arc_##x;                           \
 102 }                                                               \
 103 __VA_ARGS__ vnet_feature_arc_registration_t vnet_feat_arc_##x
 104
 105 #define VNET_FEATURE_INIT(x,...)                                \
 106   __VA_ARGS__ vnet_feature_registration_t vnet_feat_##x;        \
 107 static void __vnet_add_feature_registration_##x (void)          \
 108   __attribute__((__constructor__)) ;                            \
 109 static void __vnet_add_feature_registration_##x (void)          \
 110 {                                                               \
 111   vnet_feature_main_t * fm = &feature_main;                     \
 112   vnet_feat_##x.next = fm->next_feature;                        \
 113   fm->next_feature = & vnet_feat_##x;                           \
 114 }                                                               \
 115 __VA_ARGS__ vnet_feature_registration_t vnet_feat_##x
 116
 117 void
 118 vnet_config_update_feature_count (vnet_feature_main_t * fm, u8 arc,
 119                                   u32 sw_if_index, int is_add);
 120
 121 u32 vnet_get_feature_index (u8 arc, const char *s);
 122 u8 vnet_get_feature_arc_index (const char *s);
 123
 124 int
 125 vnet_feature_enable_disable (const char *arc_name, const char *node_name,
 126                              u32 sw_if_index, int enable_disable,
 127                              void *feature_config,
 128                              u32 n_feature_config_bytes);
 129
 130
 131 static_always_inline int
 132 vnet_have_features (u8 arc, u32 sw_if_index)
 133 {
 134   vnet_feature_main_t *fm = &feature_main;
 135   return clib_bitmap_get (fm->sw_if_index_has_features[arc], sw_if_index);
 136 }
 137
 138 static_always_inline u32
 139 vnet_get_feature_config_index (u8 arc, u32 sw_if_index)
 140 {
 141   vnet_feature_main_t *fm = &feature_main;
 142   vnet_feature_config_main_t *cm = &fm->feature_config_mains[arc];
 143   return vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
 144 }
 145
 146 static_always_inline void *
 147 vnet_feature_arc_start_with_data (u8 arc, u32 sw_if_index, u32 * next,
 148                                   vlib_buffer_t * b, u32 n_data_bytes)
 149 {
 150   vnet_feature_main_t *fm = &feature_main;
 151   vnet_feature_config_main_t *cm;
 152   cm = &fm->feature_config_mains[arc];
 153
 154   if (PREDICT_FALSE (vnet_have_features (arc, sw_if_index)))
 155     {
 156       b->feature_arc_index = arc;
 157       b->current_config_index =
 158         vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
 159       return vnet_get_config_data (&cm->config_main, &b->current_config_index,
 160                                    next, n_data_bytes);
 161     }
 162   return 0;
 163 }
 164
 165 static_always_inline void
 166 vnet_feature_arc_start (u8 arc, u32 sw_if_index, u32 * next0,
 167                         vlib_buffer_t * b0)
 168 {
 169   vnet_feature_arc_start_with_data (arc, sw_if_index, next0, b0, 0);
 170 }
 171
 172 static_always_inline void *
 173 vnet_feature_next_with_data (u32 sw_if_index, u32 * next0,
 174                              vlib_buffer_t * b0, u32 n_data_bytes)
 175 {
 176   vnet_feature_main_t *fm = &feature_main;
 177   u8 arc = b0->feature_arc_index;
 178   vnet_feature_config_main_t *cm = &fm->feature_config_mains[arc];
 179
 180   return vnet_get_config_data (&cm->config_main,
 181                                &b0->current_config_index, next0,
 182                                n_data_bytes);
 183 }
 184
 185 static_always_inline void
 186 vnet_feature_next (u32 sw_if_index, u32 * next0, vlib_buffer_t * b0)
 187 {
 188   vnet_feature_next_with_data (sw_if_index, next0, b0, 0);
 189 }
 190
 191 static_always_inline void
 192 vnet_feature_start_device_input_x1 (u32 sw_if_index, u32 * next0,
 193                                     vlib_buffer_t * b0, u16 buffer_advanced0)
 194 {
 195   vnet_feature_main_t *fm = &feature_main;
 196   vnet_feature_config_main_t *cm;
 197   u8 feature_arc_index = fm->device_input_feature_arc_index;
 198   cm = &fm->feature_config_mains[feature_arc_index];
 199
 200   if (PREDICT_FALSE
 201       (clib_bitmap_get
 202        (fm->sw_if_index_has_features[feature_arc_index], sw_if_index)))
 203     {
 204       /*
 205        * Save next0 so that the last feature in the chain
 206        * can skip ethernet-input if indicated...
 207        */
 208       vnet_buffer (b0)->device_input_feat.saved_next_index = *next0;
 209       vnet_buffer (b0)->device_input_feat.buffer_advance = buffer_advanced0;
 210       vlib_buffer_advance (b0, -buffer_advanced0);
 211
 212       b0->feature_arc_index = feature_arc_index;
 213       b0->current_config_index =
 214         vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
 215       vnet_get_config_data (&cm->config_main, &b0->current_config_index,
 216                             next0, /* # bytes of config data */ 0);
 217     }
 218 }
 219
 220 static_always_inline void
 221 vnet_feature_start_device_input_x2 (u32 sw_if_index,
 222                                     u32 * next0,
 223                                     u32 * next1,
 224                                     vlib_buffer_t * b0,
 225                                     vlib_buffer_t * b1,
 226                                     u16 buffer_advanced0,
 227                                     u16 buffer_advanced1)
 228 {
 229   vnet_feature_main_t *fm = &feature_main;
 230   vnet_feature_config_main_t *cm;
 231   u8 feature_arc_index = fm->device_input_feature_arc_index;
 232   cm = &fm->feature_config_mains[feature_arc_index];
 233
 234   if (PREDICT_FALSE
 235       (clib_bitmap_get
 236        (fm->sw_if_index_has_features[feature_arc_index], sw_if_index)))
 237     {
 238       /*
 239        * Save next0 so that the last feature in the chain
 240        * can skip ethernet-input if indicated...
 241        */
 242       vnet_buffer (b0)->device_input_feat.saved_next_index = *next0;
 243       vnet_buffer (b1)->device_input_feat.saved_next_index = *next1;
 244       vnet_buffer (b0)->device_input_feat.buffer_advance = buffer_advanced0;
 245       vnet_buffer (b1)->device_input_feat.buffer_advance = buffer_advanced1;
 246       vlib_buffer_advance (b0, -buffer_advanced0);
 247       vlib_buffer_advance (b1, -buffer_advanced1);
 248
 249       b0->feature_arc_index = feature_arc_index;
 250       b1->feature_arc_index = feature_arc_index;
 251       b0->current_config_index =
 252         vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
 253       b1->current_config_index = b0->current_config_index;
 254       vnet_get_config_data (&cm->config_main, &b0->current_config_index,
 255                             next0, /* # bytes of config data */ 0);
 256       vnet_get_config_data (&cm->config_main, &b1->current_config_index,
 257                             next1, /* # bytes of config data */ 0);
 258     }
 259 }
 260
 261
 262 #define ORDER_CONSTRAINTS (char*[])
 263 #define VNET_FEATURES(...)  (char*[]) { __VA_ARGS__, 0}
 264
 265 clib_error_t *vnet_feature_arc_init (vlib_main_t * vm,
 266                                      vnet_config_main_t * vcm,
 267                                      char **feature_start_nodes,
 268                                      int num_feature_start_nodes,
 269                                      vnet_feature_registration_t *
 270                                      first_reg, char ***feature_nodes);
 271
 272 void vnet_interface_features_show (vlib_main_t * vm, u32 sw_if_index);
 273
 274 #endif /* included_feature_h */
 275
 276 /*
 277  * fd.io coding-style-patch-verification: ON
 278  *
 279  * Local Variables:
 280  * eval: (c-set-style "gnu")
 281  * End:
 282  */