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
 15struct netlink_ext_ack;
 16struct 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 */
 27enum {
 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 */
 37enum {
 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 */
 44enum {
 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_COUPLED_CONTROL,
 80	BOND_OPT_BROADCAST_NEIGH,
 81	BOND_OPT_ACTOR_PORT_PRIO,
 82	BOND_OPT_LAST
 83};
 84
 85/* This structure is used for storing option values and for passing option
 86 * values when changing an option. The logic when used as an arg is as follows:
 87 * - if value != ULLONG_MAX -> parse value
 88 * - if string != NULL -> parse string
 89 * - if the opt is RAW data and length less than maxlen,
 90 *   copy the data to extra storage
 91 */
 92
 93#define BOND_OPT_EXTRA_MAXLEN 16
 94struct bond_opt_value {
 95	char *string;
 96	u64 value;
 97	u32 flags;
 98	union {
 99		char extra[BOND_OPT_EXTRA_MAXLEN];
100		struct net_device *slave_dev;
101	};
102};
103
104struct bonding;
105
106struct bond_option {
107	int id;
108	const char *name;
109	const char *desc;
110	u32 flags;
111
112	/* unsuppmodes is used to denote modes in which the option isn't
113	 * supported.
114	 */
115	unsigned long unsuppmodes;
116	/* supported values which this option can have, can be a subset of
117	 * BOND_OPTVAL_RANGE's value range
118	 */
119	const struct bond_opt_value *values;
120
121	int (*set)(struct bonding *bond, const struct bond_opt_value *val);
122};
123
124int __bond_opt_set(struct bonding *bond, unsigned int option,
125		   struct bond_opt_value *val,
126		   struct nlattr *bad_attr, struct netlink_ext_ack *extack);
127int __bond_opt_set_notify(struct bonding *bond, unsigned int option,
128			  struct bond_opt_value *val);
129int bond_opt_tryset_rtnl(struct bonding *bond, unsigned int option, char *buf);
130
131const struct bond_opt_value *bond_opt_parse(const struct bond_option *opt,
132					    struct bond_opt_value *val);
133const struct bond_option *bond_opt_get(unsigned int option);
134const struct bond_option *bond_opt_get_by_name(const char *name);
135const struct bond_opt_value *bond_opt_get_val(unsigned int option, u64 val);
136
137/* This helper is used to initialize a bond_opt_value structure for parameter
138 * passing. There should be either a valid string or value, but not both.
139 * When value is ULLONG_MAX then string will be used.
140 */
141static inline void __bond_opt_init(struct bond_opt_value *optval,
142				   char *string, u64 value,
143				   void *extra, size_t extra_len)
144{
145	memset(optval, 0, sizeof(*optval));
146	optval->value = ULLONG_MAX;
147	if (value != ULLONG_MAX)
148		optval->value = value;
149	else if (string)
150		optval->string = string;
151
152	if (extra && extra_len <= BOND_OPT_EXTRA_MAXLEN)
153		memcpy(optval->extra, extra, extra_len);
154}
155#define bond_opt_initval(optval, value) __bond_opt_init(optval, NULL, value, NULL, 0)
156#define bond_opt_initstr(optval, str) __bond_opt_init(optval, str, ULLONG_MAX, NULL, 0)
157#define bond_opt_initextra(optval, extra, extra_len) \
158	__bond_opt_init(optval, NULL, ULLONG_MAX, extra, extra_len)
159#define bond_opt_slave_initval(optval, slave_dev, value) \
160	__bond_opt_init(optval, NULL, value, slave_dev, sizeof(struct net_device *))
161
162void bond_option_arp_ip_targets_clear(struct bonding *bond);
163#if IS_ENABLED(CONFIG_IPV6)
164void bond_option_ns_ip6_targets_clear(struct bonding *bond);
165#endif
166void bond_slave_ns_maddrs_add(struct bonding *bond, struct slave *slave);
167void bond_slave_ns_maddrs_del(struct bonding *bond, struct slave *slave);
168
169#endif /* _NET_BOND_OPTIONS_H */