src/vnet/bonding/node.h

   1 /*
   2  * Copyright (c) 2017 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 #ifndef __included_vnet_bonding_node_h__
  16 #define __included_vnet_bonding_node_h__
  17
  18 #include <vlib/vlib.h>
  19 #include <vlib/unix/unix.h>
  20 #include <vppinfra/format.h>
  21 #include <vppinfra/hash.h>
  22 #include <vnet/ethernet/ethernet.h>
  23 #include <vnet/interface.h>
  24
  25 #define LACP_FAST_PERIODIC_TIMER        1.0
  26 #define LACP_SHORT_TIMOUT_TIME          (LACP_FAST_PERIODIC_TIMER * 3)
  27 #define LACP_SLOW_PERIODIC_TIMER        30.0
  28 #define LACP_LONG_TIMOUT_TIME           (LACP_SLOW_PERIODIC_TIMER * 3)
  29
  30 #ifndef MIN
  31 #define MIN(x,y) (((x)<(y))?(x):(y))
  32 #endif
  33
  34 #define foreach_bond_mode           \
  35   _ (1, ROUND_ROBIN, "round-robin") \
  36   _ (2, ACTIVE_BACKUP, "active-backup") \
  37   _ (3, XOR, "xor") \
  38   _ (4, BROADCAST, "broadcast") \
  39   _ (5, LACP, "lacp")
  40
  41 typedef enum
  42 {
  43 #define _(v, f, s) BOND_MODE_##f = v,
  44   foreach_bond_mode
  45 #undef _
  46 } bond_mode_t;
  47
  48 /* configurable load-balances */
  49 #define foreach_bond_lb   \
  50   _ (2, L23, "l23", l23)  \
  51   _ (1, l34 , "l34", l34) \
  52   _ (0, L2, "l2", l2)
  53
  54 /* load-balance functions implemented in bond-output */
  55 #define foreach_bond_lb_algo                     \
  56   _ (0, L2, "l2", l2)                            \
  57   _ (1, l34 , "l34", l34)                        \
  58   _ (2, L23, "l23", l23)                         \
  59   _ (3, RR, "round-robin", round_robin)          \
  60   _ (4, BC, "broadcast", broadcast)              \
  61   _ (5, AB, "active-backup", active_backup)
  62
  63 typedef enum
  64 {
  65 #define _(v, f, s, p) BOND_LB_##f = v,
  66   foreach_bond_lb_algo
  67 #undef _
  68 } bond_load_balance_t;
  69
  70 typedef struct
  71 {
  72   u8 hw_addr_set;
  73   u8 hw_addr[6];
  74   u8 mode;
  75   u8 lb;
  76   /* return */
  77   u32 sw_if_index;
  78   int rv;
  79   clib_error_t *error;
  80 } bond_create_if_args_t;
  81
  82 typedef struct
  83 {
  84   /* slave's sw_if_index */
  85   u32 slave;
  86   /* bond's sw_if_index */
  87   u32 group;
  88   u8 is_passive;
  89   u8 is_long_timeout;
  90   /* return */
  91   int rv;
  92   clib_error_t *error;
  93 } bond_enslave_args_t;
  94
  95 typedef struct
  96 {
  97   u32 slave;
  98   /* return */
  99   int rv;
 100   clib_error_t *error;
 101 } bond_detach_slave_args_t;
 102
 103 /** BOND interface details struct */
 104 typedef struct
 105 {
 106   u32 sw_if_index;
 107   u8 interface_name[64];
 108   u8 mode;
 109   u8 lb;
 110   u32 active_slaves;
 111   u32 slaves;
 112 } bond_interface_details_t;
 113
 114 /** slave interface details struct */
 115 typedef struct
 116 {
 117   u32 sw_if_index;
 118   u8 interface_name[64];
 119   u8 is_passive;
 120   u8 is_long_timeout;
 121   u32 active_slaves;
 122 } slave_interface_details_t;
 123
 124 typedef CLIB_PACKED (struct
 125                      {
 126                      u16 system_priority;
 127                      u8 system[6];
 128                      u16 key; u16 port_priority; u16 port_number;
 129                      u8 state;
 130                      }) lacp_port_info_t;
 131
 132 typedef struct
 133 {
 134   u8 admin_up;
 135   u8 mode;
 136   u8 lb;
 137
 138   /* the last slave index for the rr lb */
 139   u32 lb_rr_last_index;
 140
 141   u32 dev_instance;
 142   u32 hw_if_index;
 143   u32 sw_if_index;
 144
 145   /* Configured slaves */
 146   u32 *slaves;
 147
 148   /* Slaves that are in DISTRIBUTING state */
 149   u32 *active_slaves;
 150
 151   /* rapidly find an active slave */
 152   uword *active_slave_by_sw_if_index;
 153
 154   lacp_port_info_t partner;
 155   lacp_port_info_t actor;
 156   u8 individual_aggregator;
 157
 158   u32 group;
 159   uword *port_number_bitmap;
 160   u8 use_custom_mac;
 161   u8 hw_address[6];
 162 } bond_if_t;
 163
 164 typedef struct
 165 {
 166   u8 persistent_hw_address[6];
 167
 168   /* neighbor's vlib software interface index */
 169   u32 sw_if_index;
 170
 171   /* Neighbor time-to-live (usually 3s) */
 172   f32 ttl_in_seconds;
 173
 174   /* 1 = interface is configured with long timeout (60s) */
 175   u8 is_long_timeout;
 176
 177   /* 1 = debug is on; 0 = debug is off */
 178   u8 debug;
 179
 180   /* tx packet template id for this neighbor */
 181   u8 packet_template_index;
 182
 183   /* Info we actually keep about each neighbor */
 184
 185   /* Jenkins hash optimization: avoid tlv scan, send short keepalive msg */
 186   u8 last_packet_signature_valid;
 187   uword last_packet_signature;
 188
 189   /* last received lacp packet, for the J-hash optimization */
 190   u8 *last_rx_pkt;
 191
 192   /* last marker packet */
 193   u8 *last_marker_pkt;
 194
 195   /* neighbor vlib hw_if_index */
 196   u32 hw_if_index;
 197
 198   /* actor does not initiate the protocol exchange */
 199   u8 is_passive;
 200
 201   /* Partner port information */
 202   lacp_port_info_t partner;
 203   lacp_port_info_t partner_admin;;
 204
 205   /* Partner port information */
 206   lacp_port_info_t actor;
 207   lacp_port_info_t actor_admin;
 208
 209   /* Need To Transmit flag */
 210   u8 ntt;
 211
 212   /* Link has been established and Aggregate Port is operable */
 213   u8 port_enabled;
 214
 215   /* Initialization or reinitialization of the lacp protocol entity */
 216   u8 begin;
 217
 218   /* Aggregation Port is operating the lacp */
 219   u8 lacp_enabled;
 220
 221   /* MUX to indicate to the Selection Logic wait_while_timer expired */
 222   u8 ready_n;
 223
 224   /* Selection Logic indicates al Aggregation Ports attached */
 225   u8 ready;
 226
 227   /* Selection Logic selected an Aggregator */
 228   int selected;
 229
 230   /* RX machine indicates an Aggregation Port in PORT_DISABLED state */
 231   u8 port_moved;
 232
 233   /* timer used to detect whether received protocol information has expired */
 234   f64 current_while_timer;
 235
 236   /* timer used to detect actor churn states */
 237   f64 actor_churn_timer;
 238
 239   /* time last lacpdu was sent */
 240   f64 last_lacpdu_time;
 241
 242   /* timer used to generate periodic transmission */
 243   f64 periodic_timer;
 244
 245   /* timer used to detect partner churn states */
 246   f64 partner_churn_timer;
 247
 248   /* provides hysteresis before performing an aggregation change */
 249   f64 wait_while_timer;
 250
 251   /* Implemention variables, not in the spec */
 252   int rx_state;
 253   int tx_state;
 254   int mux_state;
 255   int ptx_state;
 256
 257   /* actor admin key */
 258   u32 group;
 259
 260   u32 marker_tx_id;
 261
 262   u32 bif_dev_instance;
 263
 264   u8 loopback_port;
 265
 266   /* bond mode */
 267   u8 mode;
 268
 269   clib_spinlock_t lockp;
 270 } slave_if_t;
 271
 272 typedef void (*lacp_enable_disable_func) (vlib_main_t * vm, bond_if_t * bif,
 273                                           slave_if_t * sif, u8 enable);
 274
 275 typedef struct
 276 {
 277   /* pool of bonding interfaces */
 278   bond_if_t *interfaces;
 279
 280   /* pool of lacp neighbors */
 281   slave_if_t *neighbors;
 282
 283   /* rapidly find a neighbor by vlib software interface index */
 284   uword *neighbor_by_sw_if_index;
 285
 286   /* rapidly find a bond by vlib software interface index */
 287   uword *bond_by_sw_if_index;
 288
 289   /* convenience variables */
 290   vlib_main_t *vlib_main;
 291   vnet_main_t *vnet_main;
 292
 293   /* lacp plugin is loaded */
 294   u8 lacp_plugin_loaded;
 295
 296   lacp_enable_disable_func lacp_enable_disable;
 297 } bond_main_t;
 298
 299 /* bond packet trace capture */
 300 typedef struct
 301 {
 302   ethernet_header_t ethernet;
 303   u32 sw_if_index;
 304   u32 bond_sw_if_index;
 305 } bond_packet_trace_t;
 306
 307 typedef u32 (*load_balance_func) (vlib_main_t * vm,
 308                                   vlib_node_runtime_t * node, bond_if_t * bif,
 309                                   vlib_buffer_t * b0);
 310
 311 typedef struct
 312 {
 313   load_balance_func load_balance;
 314 } bond_load_balance_func_t;
 315
 316 extern vlib_node_registration_t bond_input_node;
 317 extern vnet_device_class_t bond_dev_class;
 318 extern bond_main_t bond_main;
 319
 320 void bond_disable_collecting_distributing (vlib_main_t * vm,
 321                                            slave_if_t * sif);
 322 void bond_enable_collecting_distributing (vlib_main_t * vm, slave_if_t * sif);
 323 u8 *format_bond_interface_name (u8 * s, va_list * args);
 324
 325 void bond_create_if (vlib_main_t * vm, bond_create_if_args_t * args);
 326 int bond_delete_if (vlib_main_t * vm, u32 sw_if_index);
 327 void bond_enslave (vlib_main_t * vm, bond_enslave_args_t * args);
 328 void bond_detach_slave (vlib_main_t * vm, bond_detach_slave_args_t * args);
 329 int bond_dump_ifs (bond_interface_details_t ** out_bondids);
 330 int bond_dump_slave_ifs (slave_interface_details_t ** out_slaveids,
 331                          u32 bond_sw_if_index);
 332
 333 static inline uword
 334 unformat_bond_mode (unformat_input_t * input, va_list * args)
 335 {
 336   u8 *r = va_arg (*args, u8 *);
 337
 338   if (0);
 339 #define _(v, f, s) else if (unformat (input, s)) *r = BOND_MODE_##f;
 340   foreach_bond_mode
 341 #undef _
 342     else
 343     return 0;
 344
 345   return 1;
 346 }
 347
 348 static inline u8 *
 349 format_bond_mode (u8 * s, va_list * args)
 350 {
 351   u32 i = va_arg (*args, u32);
 352   u8 *t = 0;
 353
 354   switch (i)
 355     {
 356 #define _(v, f, s) case BOND_MODE_##f: t = (u8 *) s; break;
 357       foreach_bond_mode
 358 #undef _
 359     default:
 360       return format (s, "unknown");
 361     }
 362   return format (s, "%s", t);
 363 }
 364
 365 static inline uword
 366 unformat_bond_load_balance (unformat_input_t * input, va_list * args)
 367 {
 368   u8 *r = va_arg (*args, u8 *);
 369
 370   if (0);
 371 #define _(v, f, s, p) else if (unformat (input, s)) *r = BOND_LB_##f;
 372   foreach_bond_lb
 373 #undef _
 374     else
 375     return 0;
 376
 377   return 1;
 378 }
 379
 380 static inline u8 *
 381 format_bond_load_balance (u8 * s, va_list * args)
 382 {
 383   u32 i = va_arg (*args, u32);
 384   u8 *t = 0;
 385
 386   switch (i)
 387     {
 388 #define _(v, f, s, p) case BOND_LB_##f: t = (u8 *) s; break;
 389       foreach_bond_lb_algo
 390 #undef _
 391     default:
 392       return format (s, "unknown");
 393     }
 394   return format (s, "%s", t);
 395 }
 396
 397 static inline void
 398 bond_register_callback (lacp_enable_disable_func func)
 399 {
 400   bond_main_t *bm = &bond_main;
 401
 402   bm->lacp_plugin_loaded = 1;
 403   bm->lacp_enable_disable = func;
 404 }
 405
 406 static inline bond_if_t *
 407 bond_get_master_by_sw_if_index (u32 sw_if_index)
 408 {
 409   bond_main_t *bm = &bond_main;
 410   uword *p;
 411
 412   p = hash_get (bm->bond_by_sw_if_index, sw_if_index);
 413   if (!p)
 414     {
 415       return 0;
 416     }
 417   return pool_elt_at_index (bm->interfaces, p[0]);
 418 }
 419
 420 static inline bond_if_t *
 421 bond_get_master_by_dev_instance (u32 dev_instance)
 422 {
 423   bond_main_t *bm = &bond_main;
 424
 425   return pool_elt_at_index (bm->interfaces, dev_instance);
 426 }
 427
 428 static inline slave_if_t *
 429 bond_get_slave_by_sw_if_index (u32 sw_if_index)
 430 {
 431   bond_main_t *bm = &bond_main;
 432   slave_if_t *sif = 0;
 433   uword *p;
 434
 435   p = hash_get (bm->neighbor_by_sw_if_index, sw_if_index);
 436   if (p)
 437     {
 438       sif = pool_elt_at_index (bm->neighbors, p[0]);
 439     }
 440   return sif;
 441 }
 442
 443 #endif /* __included_vnet_bonding_node_h__ */
 444
 445 /*
 446  * fd.io coding-style-patch-verification: ON
 447  *
 448  * Local Variables:
 449  * eval: (c-set-style "gnu")
 450  * End:
 451  */