include/net/bond_options.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  * drivers/net/bond/bond_options.h - bonding options
   4  * Copyright (c) 2013 Nikolay Aleksandrov <nikolay@redhat.com>
   5  */
   6
   7 #ifndef _NET_BOND_OPTIONS_H
   8 #define _NET_BOND_OPTIONS_H
   9
  10 #include <linux/bits.h>
  11 #include <linux/limits.h>
  12 #include <linux/types.h>
  13 #include <linux/string.h>
  14
  15 struct netlink_ext_ack;
  16 struct nlattr;
  17
  18 #define BOND_OPT_MAX_NAMELEN 32
  19 #define BOND_OPT_VALID(opt) ((opt) < BOND_OPT_LAST)
  20 #define BOND_MODE_ALL_EX(x) (~(x))
  21
  22 /* Option flags:
  23  * BOND_OPTFLAG_NOSLAVES - check if the bond device is empty before setting
  24  * BOND_OPTFLAG_IFDOWN - check if the bond device is down before setting
  25  * BOND_OPTFLAG_RAWVAL - the option parses the value itself
  26  */
  27 enum {
  28         BOND_OPTFLAG_NOSLAVES   = BIT(0),
  29         BOND_OPTFLAG_IFDOWN     = BIT(1),
  30         BOND_OPTFLAG_RAWVAL     = BIT(2)
  31 };
  32
  33 /* Value type flags:
  34  * BOND_VALFLAG_DEFAULT - mark the value as default
  35  * BOND_VALFLAG_(MIN|MAX) - mark the value as min/max
  36  */
  37 enum {
  38         BOND_VALFLAG_DEFAULT    = BIT(0),
  39         BOND_VALFLAG_MIN        = BIT(1),
  40         BOND_VALFLAG_MAX        = BIT(2)
  41 };
  42
  43 /* Option IDs, their bit positions correspond to their IDs */
  44 enum {
  45         BOND_OPT_MODE,
  46         BOND_OPT_PACKETS_PER_SLAVE,
  47         BOND_OPT_XMIT_HASH,
  48         BOND_OPT_ARP_VALIDATE,
  49         BOND_OPT_ARP_ALL_TARGETS,
  50         BOND_OPT_FAIL_OVER_MAC,
  51         BOND_OPT_ARP_INTERVAL,
  52         BOND_OPT_ARP_TARGETS,
  53         BOND_OPT_DOWNDELAY,
  54         BOND_OPT_UPDELAY,
  55         BOND_OPT_LACP_RATE,
  56         BOND_OPT_MINLINKS,
  57         BOND_OPT_AD_SELECT,
  58         BOND_OPT_NUM_PEER_NOTIF,
  59         BOND_OPT_MIIMON,
  60         BOND_OPT_PRIMARY,
  61         BOND_OPT_PRIMARY_RESELECT,
  62         BOND_OPT_USE_CARRIER,
  63         BOND_OPT_ACTIVE_SLAVE,
  64         BOND_OPT_QUEUE_ID,
  65         BOND_OPT_ALL_SLAVES_ACTIVE,
  66         BOND_OPT_RESEND_IGMP,
  67         BOND_OPT_LP_INTERVAL,
  68         BOND_OPT_SLAVES,
  69         BOND_OPT_TLB_DYNAMIC_LB,
  70         BOND_OPT_AD_ACTOR_SYS_PRIO,
  71         BOND_OPT_AD_ACTOR_SYSTEM,
  72         BOND_OPT_AD_USER_PORT_KEY,
  73         BOND_OPT_NUM_PEER_NOTIF_ALIAS,
  74         BOND_OPT_PEER_NOTIF_DELAY,
  75         BOND_OPT_LACP_ACTIVE,
  76         BOND_OPT_MISSED_MAX,
  77         BOND_OPT_NS_TARGETS,
  78         BOND_OPT_PRIO,
  79         BOND_OPT_LAST
  80 };
  81
  82 /* This structure is used for storing option values and for passing option
  83  * values when changing an option. The logic when used as an arg is as follows:
  84  * - if value != ULLONG_MAX -> parse value
  85  * - if string != NULL -> parse string
  86  * - if the opt is RAW data and length less than maxlen,
  87  *   copy the data to extra storage
  88  */
  89
  90 #define BOND_OPT_EXTRA_MAXLEN 16
  91 struct bond_opt_value {
  92         char *string;
  93         u64 value;
  94         u32 flags;
  95         union {
  96                 char extra[BOND_OPT_EXTRA_MAXLEN];
  97                 struct net_device *slave_dev;
  98         };
  99 };
 100
 101 struct bonding;
 102
 103 struct bond_option {
 104         int id;
 105         const char *name;
 106         const char *desc;
 107         u32 flags;
 108
 109         /* unsuppmodes is used to denote modes in which the option isn't
 110          * supported.
 111          */
 112         unsigned long unsuppmodes;
 113         /* supported values which this option can have, can be a subset of
 114          * BOND_OPTVAL_RANGE's value range
 115          */
 116         const struct bond_opt_value *values;
 117
 118         int (*set)(struct bonding *bond, const struct bond_opt_value *val);
 119 };
 120
 121 int __bond_opt_set(struct bonding *bond, unsigned int option,
 122                    struct bond_opt_value *val,
 123                    struct nlattr *bad_attr, struct netlink_ext_ack *extack);
 124 int __bond_opt_set_notify(struct bonding *bond, unsigned int option,
 125                           struct bond_opt_value *val);
 126 int bond_opt_tryset_rtnl(struct bonding *bond, unsigned int option, char *buf);
 127
 128 const struct bond_opt_value *bond_opt_parse(const struct bond_option *opt,
 129                                             struct bond_opt_value *val);
 130 const struct bond_option *bond_opt_get(unsigned int option);
 131 const struct bond_option *bond_opt_get_by_name(const char *name);
 132 const struct bond_opt_value *bond_opt_get_val(unsigned int option, u64 val);
 133
 134 /* This helper is used to initialize a bond_opt_value structure for parameter
 135  * passing. There should be either a valid string or value, but not both.
 136  * When value is ULLONG_MAX then string will be used.
 137  */
 138 static inline void __bond_opt_init(struct bond_opt_value *optval,
 139                                    char *string, u64 value,
 140                                    void *extra, size_t extra_len)
 141 {
 142         memset(optval, 0, sizeof(*optval));
 143         optval->value = ULLONG_MAX;
 144         if (value != ULLONG_MAX)
 145                 optval->value = value;
 146         else if (string)
 147                 optval->string = string;
 148
 149         if (extra && extra_len <= BOND_OPT_EXTRA_MAXLEN)
 150                 memcpy(optval->extra, extra, extra_len);
 151 }
 152 #define bond_opt_initval(optval, value) __bond_opt_init(optval, NULL, value, NULL, 0)
 153 #define bond_opt_initstr(optval, str) __bond_opt_init(optval, str, ULLONG_MAX, NULL, 0)
 154 #define bond_opt_initextra(optval, extra, extra_len) \
 155         __bond_opt_init(optval, NULL, ULLONG_MAX, extra, extra_len)
 156 #define bond_opt_slave_initval(optval, slave_dev, value) \
 157         __bond_opt_init(optval, NULL, value, slave_dev, sizeof(struct net_device *))
 158
 159 void bond_option_arp_ip_targets_clear(struct bonding *bond);
 160 #if IS_ENABLED(CONFIG_IPV6)
 161 void bond_option_ns_ip6_targets_clear(struct bonding *bond);
 162 #endif
 163
 164 #endif /* _NET_BOND_OPTIONS_H */