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