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