src/vnet/bonding/bond.api

   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
  16 /** \file
  17
  18     This file defines vpe control-plane API messages for
  19     the bonding device driver
  20 */
  21
  22 option version = "2.1.0";
  23
  24 import "vnet/interface_types.api";
  25 import "vnet/ethernet/ethernet_types.api";
  26
  27 enum bond_mode
  28 {
  29   BOND_API_MODE_ROUND_ROBIN = 1,
  30   BOND_API_MODE_ACTIVE_BACKUP = 2,
  31   BOND_API_MODE_XOR = 3,
  32   BOND_API_MODE_BROADCAST = 4,
  33   BOND_API_MODE_LACP = 5,
  34 };
  35
  36 enum bond_lb_algo
  37 {
  38  BOND_API_LB_ALGO_L2 = 0,
  39  BOND_API_LB_ALGO_L34 = 1,
  40  BOND_API_LB_ALGO_L23 = 2,
  41  BOND_API_LB_ALGO_RR = 3,
  42  BOND_API_LB_ALGO_BC = 4,
  43  BOND_API_LB_ALGO_AB = 5,
  44 };
  45
  46 /** \brief Initialize a new bond interface with the given paramters
  47     @param client_index - opaque cookie to identify the sender
  48     @param context - sender context, to match reply w/ request
  49     @param id - if non-~0, specifies a custom interface ID
  50     @param use_custom_mac - if set, mac_address is valid
  51     @param mac_address - mac addr to assign to the interface if use_custom_mac is set
  52     @param mode - mode, required (1=round-robin, 2=active-backup, 3=xor, 4=broadcast, 5=lacp)
  53     @param lb - load balance, optional (0=l2, 1=l34, 2=l23) valid for xor and lacp modes. Otherwise ignored
  54     @param numa_only - if numa_only is set, pkts will be transmitted by LAG members on local numa node only if have at least one, otherwise it works as usual.
  55 */
  56 define bond_create
  57 {
  58   u32 client_index;
  59   u32 context;
  60   u32 id [default=0xFFFFFFFF];
  61   bool use_custom_mac;
  62   vl_api_mac_address_t mac_address;
  63   vl_api_bond_mode_t mode;
  64   vl_api_bond_lb_algo_t lb;
  65   bool numa_only;
  66 };
  67
  68 /** \brief Reply for bond create reply
  69     @param context - returned sender context, to match reply w/ request
  70     @param retval - return code
  71     @param sw_if_index - software index allocated for the new tap interface
  72 */
  73 define bond_create_reply
  74 {
  75   u32 context;
  76   i32 retval;
  77   vl_api_interface_index_t sw_if_index;
  78 };
  79
  80 /** \brief Delete bond interface
  81     @param client_index - opaque cookie to identify the sender
  82     @param context - sender context, to match reply w/ request
  83     @param sw_if_index - interface index of member interface
  84 */
  85 autoreply define bond_delete
  86 {
  87   u32 client_index;
  88   u32 context;
  89   vl_api_interface_index_t sw_if_index;
  90 };
  91
  92 /** \brief Initialize a new bond interface with the given paramters
  93     @param client_index - opaque cookie to identify the sender
  94     @param context - sender context, to match reply w/ request
  95     @param sw_if_index - slave sw_if_index
  96     @param bond_sw_if_index - bond sw_if_index
  97     @param is_passive - interface does not initiate the lacp protocol, remote must be active speaker
  98     @param is_long_timeout - 90 seconds vs default 3 seconds neighbor timeout
  99 */
 100 define bond_enslave
 101 {
 102   option deprecated="20.06";
 103   u32 client_index;
 104   u32 context;
 105   vl_api_interface_index_t sw_if_index;
 106   vl_api_interface_index_t bond_sw_if_index;
 107   bool is_passive;
 108   bool is_long_timeout;
 109 };
 110
 111 /** \brief Reply for bond enslave reply
 112     @param context - returned sender context, to match reply w/ request
 113     @param retval - return code
 114 */
 115 define bond_enslave_reply
 116 {
 117   u32 context;
 118   i32 retval;
 119 };
 120
 121 /** \brief Initialize a new bond interface with the given paramters
 122     @param client_index - opaque cookie to identify the sender
 123     @param context - sender context, to match reply w/ request
 124     @param sw_if_index - member sw_if_index
 125     @param bond_sw_if_index - bond sw_if_index
 126     @param is_passive - interface does not initiate the lacp protocol, remote must be active speaker
 127     @param is_long_timeout - 90 seconds vs default 3 seconds neighbor timeout
 128 */
 129 define bond_add_member
 130 {
 131   u32 client_index;
 132   u32 context;
 133   vl_api_interface_index_t sw_if_index;
 134   vl_api_interface_index_t bond_sw_if_index;
 135   bool is_passive;
 136   bool is_long_timeout;
 137 };
 138
 139 /** \brief Reply for bond add_member reply
 140     @param context - returned sender context, to match reply w/ request
 141     @param retval - return code
 142 */
 143 define bond_add_member_reply
 144 {
 145   u32 context;
 146   i32 retval;
 147 };
 148
 149 /** \brief bond detach slave
 150     @param client_index - opaque cookie to identify the sender
 151     @param context - sender context, to match reply w/ request
 152     @param sw_if_index - interface index of member interface
 153 */
 154 autoreply define bond_detach_slave
 155 {
 156   option deprecated="20.06";
 157   u32 client_index;
 158   u32 context;
 159   vl_api_interface_index_t sw_if_index;
 160 };
 161
 162 /** \brief bond detach member
 163     @param client_index - opaque cookie to identify the sender
 164     @param context - sender context, to match reply w/ request
 165     @param sw_if_index - interface index of member interface
 166 */
 167 autoreply define bond_detach_member
 168 {
 169   u32 client_index;
 170   u32 context;
 171   vl_api_interface_index_t sw_if_index;
 172 };
 173
 174 /** \brief Dump bond interfaces request */
 175 define sw_interface_bond_dump
 176 {
 177   option deprecated="20.06";
 178   u32 client_index;
 179   u32 context;
 180 };
 181
 182 /** \brief Reply for bond dump request
 183     @param sw_if_index - software index of bond interface
 184     @param id - ID of interface
 185     @param interface_name - name of interface
 186     @param mode - bonding mode
 187     @param lb - load balance algo
 188     @param numa_only - enable local numa TX for lacp mode
 189     @param active_slaves - active member count
 190     @param slaves - config member count
 191 */
 192 define sw_interface_bond_details
 193 {
 194   u32 context;
 195   vl_api_interface_index_t sw_if_index;
 196   u32 id;
 197   vl_api_bond_mode_t mode;
 198   vl_api_bond_lb_algo_t lb;
 199   bool numa_only;
 200   u32 active_slaves;
 201   u32 slaves;
 202   string interface_name[64];
 203 };
 204
 205 /** \brief Dump bond interfaces request */
 206 define sw_bond_interface_dump
 207 {
 208   u32 client_index;
 209   u32 context;
 210   vl_api_interface_index_t sw_if_index [default=0xffffffff];
 211 };
 212
 213 /** \brief Reply for bond dump request
 214     @param sw_if_index - software index of bond interface
 215     @param id - ID of interface
 216     @param mode - bonding mode
 217     @param lb - load balance algo
 218     @param numa_only - enable local numa TX for lacp mode
 219     @param active_members - active members count
 220     @param members - config member count
 221     @param interface_name - name of interface
 222 */
 223 define sw_bond_interface_details
 224 {
 225   u32 context;
 226   vl_api_interface_index_t sw_if_index;
 227   u32 id;
 228   vl_api_bond_mode_t mode;
 229   vl_api_bond_lb_algo_t lb;
 230   bool numa_only;
 231   u32 active_members;
 232   u32 members;
 233   string interface_name[64];
 234 };
 235
 236 /** \brief bond slave dump
 237     @param client_index - opaque cookie to identify the sender
 238     @param context - sender context, to match reply w/ request
 239     @param sw_if_index - interface index of bond interface
 240 */
 241 define sw_interface_slave_dump
 242 {
 243   option deprecated="20.06";
 244   u32 client_index;
 245   u32 context;
 246   vl_api_interface_index_t sw_if_index;
 247 };
 248
 249 /** \brief Reply for slave dump request
 250     @param sw_if_index - software index of slave interface
 251     @param interface_name - name of interface
 252     @param is_passve - interface does not initiate the lacp protocol, remote must be active speaker
 253     @param is_long_timeout - 90 seconds vs default 3 seconds neighbor timeout
 254     @param is_local_numa - the slave interface is local numa
 255     @param weight - the weight for the slave interface (active-backup mode only)
 256 */
 257 define sw_interface_slave_details
 258 {
 259   u32 context;
 260   vl_api_interface_index_t sw_if_index;
 261   string interface_name[64];
 262   bool is_passive;
 263   bool is_long_timeout;
 264   bool is_local_numa;
 265   u32 weight;
 266 };
 267
 268 /** \brief bond member dump
 269     @param client_index - opaque cookie to identify the sender
 270     @param context - sender context, to match reply w/ request
 271     @param sw_if_index - interface index of bond interface
 272 */
 273 define sw_member_interface_dump
 274 {
 275   u32 client_index;
 276   u32 context;
 277   vl_api_interface_index_t sw_if_index;
 278 };
 279
 280 /** \brief Reply for member dump request
 281     @param sw_if_index - software index of member interface
 282     @param interface_name - name of interface
 283     @param is_passve - interface does not initiate the lacp protocol, remote must be active speaker
 284     @param is_long_timeout - 90 seconds vs default 3 seconds neighbor timeout
 285     @param is_local_numa - the member interface is local numa
 286     @param weight - the weight for the member interface (active-backup mode only)
 287 */
 288 define sw_member_interface_details
 289 {
 290   u32 context;
 291   vl_api_interface_index_t sw_if_index;
 292   string interface_name[64];
 293   bool is_passive;
 294   bool is_long_timeout;
 295   bool is_local_numa;
 296   u32 weight;
 297 };
 298
 299 /** \brief Interface set bond weight
 300     @param client_index - opaque cookie to identify the sender
 301     @param context - sender context, to match reply w/ request
 302     @param sw_if_index - member interface for which to set the weight
 303     @param weight - weight value to be set for the member interface
 304 */
 305 autoreply define sw_interface_set_bond_weight
 306 {
 307   u32 client_index;
 308   u32 context;
 309   vl_api_interface_index_t sw_if_index;
 310   u32 weight;
 311 };
 312
 313 /*
 314  * Local Variables:
 315  * eval: (c-set-style "gnu")
 316  * End:
 317  */