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