drivers/net/bonding/bond_options.h

   1 /*
   2  * drivers/net/bond/bond_options.h - bonding options
   3  * Copyright (c) 2013 Nikolay Aleksandrov <nikolay@redhat.com>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  */
  10
  11 #ifndef _BOND_OPTIONS_H
  12 #define _BOND_OPTIONS_H
  13
  14 #define BOND_OPT_MAX_NAMELEN 32
  15 #define BOND_OPT_VALID(opt) ((opt) < BOND_OPT_LAST)
  16 #define BOND_MODE_ALL_EX(x) (~(x))
  17
  18 /* Option flags:
  19  * BOND_OPTFLAG_NOSLAVES - check if the bond device is empty before setting
  20  * BOND_OPTFLAG_IFDOWN - check if the bond device is down before setting
  21  * BOND_OPTFLAG_RAWVAL - the option parses the value itself
  22  */
  23 enum {
  24         BOND_OPTFLAG_NOSLAVES   = BIT(0),
  25         BOND_OPTFLAG_IFDOWN     = BIT(1),
  26         BOND_OPTFLAG_RAWVAL     = BIT(2)
  27 };
  28
  29 /* Value type flags:
  30  * BOND_VALFLAG_DEFAULT - mark the value as default
  31  * BOND_VALFLAG_(MIN|MAX) - mark the value as min/max
  32  */
  33 enum {
  34         BOND_VALFLAG_DEFAULT    = BIT(0),
  35         BOND_VALFLAG_MIN        = BIT(1),
  36         BOND_VALFLAG_MAX        = BIT(2)
  37 };
  38
  39 /* Option IDs, their bit positions correspond to their IDs */
  40 enum {
  41         BOND_OPT_MODE,
  42         BOND_OPT_PACKETS_PER_SLAVE,
  43         BOND_OPT_XMIT_HASH,
  44         BOND_OPT_ARP_VALIDATE,
  45         BOND_OPT_ARP_ALL_TARGETS,
  46         BOND_OPT_FAIL_OVER_MAC,
  47         BOND_OPT_ARP_INTERVAL,
  48         BOND_OPT_ARP_TARGETS,
  49         BOND_OPT_DOWNDELAY,
  50         BOND_OPT_UPDELAY,
  51         BOND_OPT_LACP_RATE,
  52         BOND_OPT_MINLINKS,
  53         BOND_OPT_AD_SELECT,
  54         BOND_OPT_NUM_PEER_NOTIF,
  55         BOND_OPT_MIIMON,
  56         BOND_OPT_PRIMARY,
  57         BOND_OPT_PRIMARY_RESELECT,
  58         BOND_OPT_USE_CARRIER,
  59         BOND_OPT_ACTIVE_SLAVE,
  60         BOND_OPT_QUEUE_ID,
  61         BOND_OPT_ALL_SLAVES_ACTIVE,
  62         BOND_OPT_RESEND_IGMP,
  63         BOND_OPT_LP_INTERVAL,
  64         BOND_OPT_SLAVES,
  65         BOND_OPT_LAST
  66 };
  67
  68 /* This structure is used for storing option values and for passing option
  69  * values when changing an option. The logic when used as an arg is as follows:
  70  * - if string != NULL -> parse it, if the opt is RAW type then return it, else
  71  *   return the parse result
  72  * - if string == NULL -> parse value
  73  */
  74 struct bond_opt_value {
  75         char *string;
  76         u64 value;
  77         u32 flags;
  78 };
  79
  80 struct bonding;
  81
  82 struct bond_option {
  83         int id;
  84         char *name;
  85         char *desc;
  86         u32 flags;
  87
  88         /* unsuppmodes is used to denote modes in which the option isn't
  89          * supported.
  90          */
  91         unsigned long unsuppmodes;
  92         /* supported values which this option can have, can be a subset of
  93          * BOND_OPTVAL_RANGE's value range
  94          */
  95         struct bond_opt_value *values;
  96
  97         int (*set)(struct bonding *bond, struct bond_opt_value *val);
  98 };
  99
 100 int __bond_opt_set(struct bonding *bond, unsigned int option,
 101                    struct bond_opt_value *val);
 102 int bond_opt_tryset_rtnl(struct bonding *bond, unsigned int option, char *buf);
 103 struct bond_opt_value *bond_opt_parse(const struct bond_option *opt,
 104                                       struct bond_opt_value *val);
 105 struct bond_option *bond_opt_get(unsigned int option);
 106 struct bond_opt_value *bond_opt_get_val(unsigned int option, u64 val);
 107
 108 /* This helper is used to initialize a bond_opt_value structure for parameter
 109  * passing. There should be either a valid string or value, but not both.
 110  * When value is ULLONG_MAX then string will be used.
 111  */
 112 static inline void __bond_opt_init(struct bond_opt_value *optval,
 113                                    char *string, u64 value)
 114 {
 115         memset(optval, 0, sizeof(*optval));
 116         optval->value = ULLONG_MAX;
 117         if (value == ULLONG_MAX)
 118                 optval->string = string;
 119         else
 120                 optval->value = value;
 121 }
 122 #define bond_opt_initval(optval, value) __bond_opt_init(optval, NULL, value)
 123 #define bond_opt_initstr(optval, str) __bond_opt_init(optval, str, ULLONG_MAX)
 124
 125 int bond_option_mode_set(struct bonding *bond, struct bond_opt_value *newval);
 126 int bond_option_pps_set(struct bonding *bond, struct bond_opt_value *newval);
 127 int bond_option_xmit_hash_policy_set(struct bonding *bond,
 128                                      struct bond_opt_value *newval);
 129 int bond_option_arp_validate_set(struct bonding *bond,
 130                                  struct bond_opt_value *newval);
 131 int bond_option_arp_all_targets_set(struct bonding *bond,
 132                                     struct bond_opt_value *newval);
 133 int bond_option_fail_over_mac_set(struct bonding *bond,
 134                                   struct bond_opt_value *newval);
 135 int bond_option_arp_interval_set(struct bonding *bond,
 136                                  struct bond_opt_value *newval);
 137 int bond_option_arp_ip_targets_set(struct bonding *bond,
 138                                    struct bond_opt_value *newval);
 139 void bond_option_arp_ip_targets_clear(struct bonding *bond);
 140 int bond_option_downdelay_set(struct bonding *bond,
 141                               struct bond_opt_value *newval);
 142 int bond_option_updelay_set(struct bonding *bond,
 143                             struct bond_opt_value *newval);
 144 int bond_option_lacp_rate_set(struct bonding *bond,
 145                               struct bond_opt_value *newval);
 146 int bond_option_min_links_set(struct bonding *bond,
 147                               struct bond_opt_value *newval);
 148 int bond_option_ad_select_set(struct bonding *bond,
 149                               struct bond_opt_value *newval);
 150 int bond_option_num_peer_notif_set(struct bonding *bond,
 151                                    struct bond_opt_value *newval);
 152 int bond_option_miimon_set(struct bonding *bond, struct bond_opt_value *newval);
 153 int bond_option_primary_set(struct bonding *bond,
 154                             struct bond_opt_value *newval);
 155 int bond_option_primary_reselect_set(struct bonding *bond,
 156                                      struct bond_opt_value *newval);
 157 int bond_option_use_carrier_set(struct bonding *bond,
 158                                 struct bond_opt_value *newval);
 159 int bond_option_active_slave_set(struct bonding *bond,
 160                                  struct bond_opt_value *newval);
 161 int bond_option_queue_id_set(struct bonding *bond,
 162                              struct bond_opt_value *newval);
 163 int bond_option_all_slaves_active_set(struct bonding *bond,
 164                                       struct bond_opt_value *newval);
 165 int bond_option_resend_igmp_set(struct bonding *bond,
 166                                 struct bond_opt_value *newval);
 167 int bond_option_lp_interval_set(struct bonding *bond,
 168                                 struct bond_opt_value *newval);
 169 int bond_option_slaves_set(struct bonding *bond, struct bond_opt_value *newval);
 170 #endif /* _BOND_OPTIONS_H */