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