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