src/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 #include <vnet/devices/devices.h>
  22
  23 /** feature registration object */
  24 typedef struct _vnet_feature_arc_registration
  25 {
  26   /** next registration in list of all registrations*/
  27   struct _vnet_feature_arc_registration *next;
  28   /** Feature Arc name */
  29   char *arc_name;
  30   /** Start nodes */
  31   char **start_nodes;
  32   int n_start_nodes;
  33   /** End node */
  34   char *end_node;
  35   /* Feature arc index, assigned by init function */
  36   u8 feature_arc_index;
  37   u8 *arc_index_ptr;
  38 } vnet_feature_arc_registration_t;
  39
  40 /* Enable feature callback. */
  41 typedef clib_error_t *(vnet_feature_enable_disable_function_t)
  42   (u32 sw_if_index, int enable_disable);
  43
  44 /** feature registration object */
  45 typedef struct _vnet_feature_registration
  46 {
  47   /** next registration in list of all registrations*/
  48   struct _vnet_feature_registration *next;
  49   /** Feature arc name */
  50   char *arc_name;
  51   /** Graph node name */
  52   char *node_name;
  53   /** Pointer to this feature index, filled in by vnet_feature_arc_init */
  54   u32 *feature_index_ptr;
  55   u32 feature_index;
  56   /** Constraints of the form "this feature runs before X" */
  57   char **runs_before;
  58   /** Constraints of the form "this feature runs after Y" */
  59   char **runs_after;
  60
  61   /** Function to enable/disable feature  **/
  62   vnet_feature_enable_disable_function_t *enable_disable_cb;
  63 } vnet_feature_registration_t;
  64
  65 typedef struct vnet_feature_config_main_t_
  66 {
  67   vnet_config_main_t config_main;
  68   u32 *config_index_by_sw_if_index;
  69   u32 end_feature_index;
  70 } vnet_feature_config_main_t;
  71
  72 typedef struct
  73 {
  74   /** feature arc configuration list */
  75   vnet_feature_arc_registration_t *next_arc;
  76   uword **arc_index_by_name;
  77
  78   /** feature path configuration lists */
  79   vnet_feature_registration_t *next_feature;
  80   vnet_feature_registration_t **next_feature_by_arc;
  81   uword **next_feature_by_name;
  82
  83   /** feature config main objects */
  84   vnet_feature_config_main_t *feature_config_mains;
  85
  86   /** Save partial order results for show command */
  87   char ***feature_nodes;
  88
  89   /** bitmap of interfaces which have driver rx features configured */
  90   uword **sw_if_index_has_features;
  91
  92   /** feature reference counts by interface */
  93   i16 **feature_count_by_sw_if_index;
  94
  95   /** Feature arc index for device-input */
  96   u8 device_input_feature_arc_index;
  97
  98   /** convenience */
  99   vlib_main_t *vlib_main;
 100   vnet_main_t *vnet_main;
 101 } vnet_feature_main_t;
 102
 103 extern vnet_feature_main_t feature_main;
 104
 105 #define VNET_FEATURE_ARC_INIT(x,...)                            \
 106   __VA_ARGS__ vnet_feature_arc_registration_t vnet_feat_arc_##x;\
 107 static void __vnet_add_feature_arc_registration_##x (void)      \
 108   __attribute__((__constructor__)) ;                            \
 109 static void __vnet_add_feature_arc_registration_##x (void)      \
 110 {                                                               \
 111   vnet_feature_main_t * fm = &feature_main;                     \
 112   vnet_feat_arc_##x.next = fm->next_arc;                        \
 113   fm->next_arc = & vnet_feat_arc_##x;                           \
 114 }                                                               \
 115 __VA_ARGS__ vnet_feature_arc_registration_t vnet_feat_arc_##x
 116
 117 #define VNET_FEATURE_INIT(x,...)                                \
 118   __VA_ARGS__ vnet_feature_registration_t vnet_feat_##x;        \
 119 static void __vnet_add_feature_registration_##x (void)          \
 120   __attribute__((__constructor__)) ;                            \
 121 static void __vnet_add_feature_registration_##x (void)          \
 122 {                                                               \
 123   vnet_feature_main_t * fm = &feature_main;                     \
 124   vnet_feat_##x.next = fm->next_feature;                        \
 125   fm->next_feature = & vnet_feat_##x;                           \
 126 }                                                               \
 127 __VA_ARGS__ vnet_feature_registration_t vnet_feat_##x
 128
 129 void
 130 vnet_config_update_feature_count (vnet_feature_main_t * fm, u8 arc,
 131                                   u32 sw_if_index, int is_add);
 132
 133 u32 vnet_get_feature_index (u8 arc, const char *s);
 134 u8 vnet_get_feature_arc_index (const char *s);
 135 vnet_feature_registration_t *vnet_get_feature_reg (const char *arc_name,
 136                                                    const char *node_name);
 137
 138
 139 int
 140 vnet_feature_enable_disable_with_index (u8 arc_index, u32 feature_index,
 141                                         u32 sw_if_index, int enable_disable,
 142                                         void *feature_config,
 143                                         u32 n_feature_config_bytes);
 144
 145 int
 146 vnet_feature_enable_disable (const char *arc_name, const char *node_name,
 147                              u32 sw_if_index, int enable_disable,
 148                              void *feature_config,
 149                              u32 n_feature_config_bytes);
 150
 151 static inline vnet_feature_config_main_t *
 152 vnet_get_feature_arc_config_main (u8 arc_index)
 153 {
 154   vnet_feature_main_t *fm = &feature_main;
 155
 156   if (arc_index == (u8) ~ 0)
 157     return 0;
 158
 159   return &fm->feature_config_mains[arc_index];
 160 }
 161
 162 static_always_inline vnet_feature_config_main_t *
 163 vnet_feature_get_config_main (u16 arc)
 164 {
 165   vnet_feature_main_t *fm = &feature_main;
 166   return &fm->feature_config_mains[arc];
 167 }
 168
 169 static_always_inline int
 170 vnet_have_features (u8 arc, u32 sw_if_index)
 171 {
 172   vnet_feature_main_t *fm = &feature_main;
 173   return clib_bitmap_get (fm->sw_if_index_has_features[arc], sw_if_index);
 174 }
 175
 176 static_always_inline u32
 177 vnet_get_feature_config_index (u8 arc, u32 sw_if_index)
 178 {
 179   vnet_feature_main_t *fm = &feature_main;
 180   vnet_feature_config_main_t *cm = &fm->feature_config_mains[arc];
 181   return vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
 182 }
 183
 184 static_always_inline void *
 185 vnet_feature_arc_start_with_data (u8 arc, u32 sw_if_index, u32 * next,
 186                                   vlib_buffer_t * b, u32 n_data_bytes)
 187 {
 188   vnet_feature_main_t *fm = &feature_main;
 189   vnet_feature_config_main_t *cm;
 190   cm = &fm->feature_config_mains[arc];
 191
 192   if (PREDICT_FALSE (vnet_have_features (arc, sw_if_index)))
 193     {
 194       b->feature_arc_index = arc;
 195       b->current_config_index =
 196         vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
 197       return vnet_get_config_data (&cm->config_main, &b->current_config_index,
 198                                    next, n_data_bytes);
 199     }
 200   return 0;
 201 }
 202
 203 static_always_inline void
 204 vnet_feature_arc_start (u8 arc, u32 sw_if_index, u32 * next0,
 205                         vlib_buffer_t * b0)
 206 {
 207   vnet_feature_arc_start_with_data (arc, sw_if_index, next0, b0, 0);
 208 }
 209
 210 static_always_inline void *
 211 vnet_feature_next_with_data (u32 sw_if_index, u32 * next0,
 212                              vlib_buffer_t * b0, u32 n_data_bytes)
 213 {
 214   vnet_feature_main_t *fm = &feature_main;
 215   u8 arc = b0->feature_arc_index;
 216   vnet_feature_config_main_t *cm = &fm->feature_config_mains[arc];
 217
 218   return vnet_get_config_data (&cm->config_main,
 219                                &b0->current_config_index, next0,
 220                                n_data_bytes);
 221 }
 222
 223 static_always_inline void
 224 vnet_feature_next (u32 sw_if_index, u32 * next0, vlib_buffer_t * b0)
 225 {
 226   vnet_feature_next_with_data (sw_if_index, next0, b0, 0);
 227 }
 228
 229 static_always_inline void
 230 vnet_feature_start_device_input_x1 (u32 sw_if_index, u32 * next0,
 231                                     vlib_buffer_t * b0)
 232 {
 233   vnet_feature_main_t *fm = &feature_main;
 234   vnet_feature_config_main_t *cm;
 235   u8 feature_arc_index = fm->device_input_feature_arc_index;
 236   cm = &fm->feature_config_mains[feature_arc_index];
 237
 238   if (PREDICT_FALSE
 239       (clib_bitmap_get
 240        (fm->sw_if_index_has_features[feature_arc_index], sw_if_index)))
 241     {
 242       /*
 243        * Save next0 so that the last feature in the chain
 244        * can skip ethernet-input if indicated...
 245        */
 246       u16 adv;
 247
 248       vnet_buffer (b0)->device_input_feat.saved_next_index = *next0;
 249       adv = device_input_next_node_advance[*next0];
 250       vnet_buffer (b0)->device_input_feat.buffer_advance = adv;
 251       vlib_buffer_advance (b0, -adv);
 252
 253       b0->feature_arc_index = feature_arc_index;
 254       b0->current_config_index =
 255         vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
 256       vnet_get_config_data (&cm->config_main, &b0->current_config_index,
 257                             next0, /* # bytes of config data */ 0);
 258     }
 259 }
 260
 261 static_always_inline void
 262 vnet_feature_start_device_input_x2 (u32 sw_if_index,
 263                                     u32 * next0,
 264                                     u32 * next1,
 265                                     vlib_buffer_t * b0, vlib_buffer_t * b1)
 266 {
 267   vnet_feature_main_t *fm = &feature_main;
 268   vnet_feature_config_main_t *cm;
 269   u8 feature_arc_index = fm->device_input_feature_arc_index;
 270   cm = &fm->feature_config_mains[feature_arc_index];
 271
 272   if (PREDICT_FALSE
 273       (clib_bitmap_get
 274        (fm->sw_if_index_has_features[feature_arc_index], sw_if_index)))
 275     {
 276       /*
 277        * Save next0 so that the last feature in the chain
 278        * can skip ethernet-input if indicated...
 279        */
 280       u16 adv;
 281
 282       vnet_buffer (b0)->device_input_feat.saved_next_index = *next0;
 283       adv = device_input_next_node_advance[*next0];
 284       vnet_buffer (b0)->device_input_feat.buffer_advance = adv;
 285       vlib_buffer_advance (b0, -adv);
 286
 287       vnet_buffer (b1)->device_input_feat.saved_next_index = *next1;
 288       adv = device_input_next_node_advance[*next1];
 289       vnet_buffer (b1)->device_input_feat.buffer_advance = adv;
 290       vlib_buffer_advance (b1, -adv);
 291
 292       b0->feature_arc_index = feature_arc_index;
 293       b1->feature_arc_index = feature_arc_index;
 294       b0->current_config_index =
 295         vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
 296       b1->current_config_index = b0->current_config_index;
 297       vnet_get_config_data (&cm->config_main, &b0->current_config_index,
 298                             next0, /* # bytes of config data */ 0);
 299       vnet_get_config_data (&cm->config_main, &b1->current_config_index,
 300                             next1, /* # bytes of config data */ 0);
 301     }
 302 }
 303
 304 static_always_inline void
 305 vnet_feature_start_device_input_x4 (u32 sw_if_index,
 306                                     u32 * next0,
 307                                     u32 * next1,
 308                                     u32 * next2,
 309                                     u32 * next3,
 310                                     vlib_buffer_t * b0,
 311                                     vlib_buffer_t * b1,
 312                                     vlib_buffer_t * b2, vlib_buffer_t * b3)
 313 {
 314   vnet_feature_main_t *fm = &feature_main;
 315   vnet_feature_config_main_t *cm;
 316   u8 feature_arc_index = fm->device_input_feature_arc_index;
 317   cm = &fm->feature_config_mains[feature_arc_index];
 318
 319   if (PREDICT_FALSE
 320       (clib_bitmap_get
 321        (fm->sw_if_index_has_features[feature_arc_index], sw_if_index)))
 322     {
 323       /*
 324        * Save next0 so that the last feature in the chain
 325        * can skip ethernet-input if indicated...
 326        */
 327       u16 adv;
 328
 329       vnet_buffer (b0)->device_input_feat.saved_next_index = *next0;
 330       adv = device_input_next_node_advance[*next0];
 331       vnet_buffer (b0)->device_input_feat.buffer_advance = adv;
 332       vlib_buffer_advance (b0, -adv);
 333
 334       vnet_buffer (b1)->device_input_feat.saved_next_index = *next1;
 335       adv = device_input_next_node_advance[*next1];
 336       vnet_buffer (b1)->device_input_feat.buffer_advance = adv;
 337       vlib_buffer_advance (b1, -adv);
 338
 339       vnet_buffer (b2)->device_input_feat.saved_next_index = *next2;
 340       adv = device_input_next_node_advance[*next2];
 341       vnet_buffer (b2)->device_input_feat.buffer_advance = adv;
 342       vlib_buffer_advance (b2, -adv);
 343
 344       vnet_buffer (b3)->device_input_feat.saved_next_index = *next3;
 345       adv = device_input_next_node_advance[*next3];
 346       vnet_buffer (b3)->device_input_feat.buffer_advance = adv;
 347       vlib_buffer_advance (b3, -adv);
 348
 349       b0->feature_arc_index = feature_arc_index;
 350       b1->feature_arc_index = feature_arc_index;
 351       b2->feature_arc_index = feature_arc_index;
 352       b3->feature_arc_index = feature_arc_index;
 353
 354       b0->current_config_index =
 355         vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
 356       b1->current_config_index = b0->current_config_index;
 357       b2->current_config_index = b0->current_config_index;
 358       b3->current_config_index = b0->current_config_index;
 359
 360       vnet_get_config_data (&cm->config_main, &b0->current_config_index,
 361                             next0, /* # bytes of config data */ 0);
 362       vnet_get_config_data (&cm->config_main, &b1->current_config_index,
 363                             next1, /* # bytes of config data */ 0);
 364       vnet_get_config_data (&cm->config_main, &b2->current_config_index,
 365                             next2, /* # bytes of config data */ 0);
 366       vnet_get_config_data (&cm->config_main, &b3->current_config_index,
 367                             next3, /* # bytes of config data */ 0);
 368     }
 369 }
 370
 371 #define VNET_FEATURES(...)  (char*[]) { __VA_ARGS__, 0}
 372
 373 clib_error_t *vnet_feature_arc_init (vlib_main_t * vm,
 374                                      vnet_config_main_t * vcm,
 375                                      char **feature_start_nodes,
 376                                      int num_feature_start_nodes,
 377                                      vnet_feature_registration_t *
 378                                      first_reg, char ***feature_nodes);
 379
 380 void vnet_interface_features_show (vlib_main_t * vm, u32 sw_if_index);
 381
 382 #endif /* included_feature_h */
 383
 384 /*
 385  * fd.io coding-style-patch-verification: ON
 386  *
 387  * Local Variables:
 388  * eval: (c-set-style "gnu")
 389  * End:
 390  */