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_LAST
  65 };
  66
  67 /* This structure is used for storing option values and for passing option
  68  * values when changing an option. The logic when used as an arg is as follows:
  69  * - if string != NULL -> parse it, if the opt is RAW type then return it, else
  70  *   return the parse result
  71  * - if string == NULL -> parse value
  72  */
  73 struct bond_opt_value {
  74         char *string;
  75         u64 value;
  76         u32 flags;
  77 };
  78
  79 struct bonding;
  80
  81 struct bond_option {
  82         int id;
  83         char *name;
  84         char *desc;
  85         u32 flags;
  86
  87         /* unsuppmodes is used to denote modes in which the option isn't
  88          * supported.
  89          */
  90         unsigned long unsuppmodes;
  91         /* supported values which this option can have, can be a subset of
  92          * BOND_OPTVAL_RANGE's value range
  93          */
  94         struct bond_opt_value *values;
  95
  96         int (*set)(struct bonding *bond, struct bond_opt_value *val);
  97 };
  98
  99 int __bond_opt_set(struct bonding *bond, unsigned int option,
 100                    struct bond_opt_value *val);
 101 int bond_opt_tryset_rtnl(struct bonding *bond, unsigned int option, char *buf);
 102 struct bond_opt_value *bond_opt_parse(const struct bond_option *opt,
 103                                       struct bond_opt_value *val);
 104 struct bond_option *bond_opt_get(unsigned int option);
 105 struct bond_opt_value *bond_opt_get_val(unsigned int option, u64 val);
 106
 107 /* This helper is used to initialize a bond_opt_value structure for parameter
 108  * passing. There should be either a valid string or value, but not both.
 109  * When value is ULLONG_MAX then string will be used.
 110  */
 111 static inline void __bond_opt_init(struct bond_opt_value *optval,
 112                                    char *string, u64 value)
 113 {
 114         memset(optval, 0, sizeof(*optval));
 115         optval->value = ULLONG_MAX;
 116         if (value == ULLONG_MAX)
 117                 optval->string = string;
 118         else
 119                 optval->value = value;
 120 }
 121 #define bond_opt_initval(optval, value) __bond_opt_init(optval, NULL, value)
 122 #define bond_opt_initstr(optval, str) __bond_opt_init(optval, str, ULLONG_MAX)
 123
 124 int bond_option_mode_set(struct bonding *bond, struct bond_opt_value *newval);
 125 int bond_option_pps_set(struct bonding *bond, struct bond_opt_value *newval);
 126 int bond_option_xmit_hash_policy_set(struct bonding *bond,
 127                                      struct bond_opt_value *newval);
 128 int bond_option_arp_validate_set(struct bonding *bond,
 129                                  struct bond_opt_value *newval);
 130 int bond_option_arp_all_targets_set(struct bonding *bond,
 131                                     struct bond_opt_value *newval);
 132 int bond_option_fail_over_mac_set(struct bonding *bond,
 133                                   struct bond_opt_value *newval);
 134 int bond_option_arp_interval_set(struct bonding *bond,
 135                                  struct bond_opt_value *newval);
 136 int bond_option_arp_ip_targets_set(struct bonding *bond,
 137                                    struct bond_opt_value *newval);
 138 void bond_option_arp_ip_targets_clear(struct bonding *bond);
 139 int bond_option_downdelay_set(struct bonding *bond,
 140                               struct bond_opt_value *newval);
 141 int bond_option_updelay_set(struct bonding *bond,
 142                             struct bond_opt_value *newval);
 143 int bond_option_lacp_rate_set(struct bonding *bond,
 144                               struct bond_opt_value *newval);
 145 int bond_option_min_links_set(struct bonding *bond,
 146                               struct bond_opt_value *newval);
 147 int bond_option_ad_select_set(struct bonding *bond,
 148                               struct bond_opt_value *newval);
 149 int bond_option_num_peer_notif_set(struct bonding *bond,
 150                                    struct bond_opt_value *newval);
 151 int bond_option_miimon_set(struct bonding *bond, struct bond_opt_value *newval);
 152 int bond_option_primary_set(struct bonding *bond,
 153                             struct bond_opt_value *newval);
 154 int bond_option_primary_reselect_set(struct bonding *bond,
 155                                      struct bond_opt_value *newval);
 156 int bond_option_use_carrier_set(struct bonding *bond,
 157                                 struct bond_opt_value *newval);
 158 int bond_option_active_slave_set(struct bonding *bond,
 159                                  struct bond_opt_value *newval);
 160 int bond_option_queue_id_set(struct bonding *bond,
 161                              struct bond_opt_value *newval);
 162 int bond_option_all_slaves_active_set(struct bonding *bond,
 163                                       struct bond_opt_value *newval);
 164 int bond_option_resend_igmp_set(struct bonding *bond,
 165                                 struct bond_opt_value *newval);
 166 int bond_option_lp_interval_set(struct bonding *bond,
 167                                 struct bond_opt_value *newval);
 168 #endif /* _BOND_OPTIONS_H */