[linux-block.git] / include / net / bond_options.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * drivers/net/bond/bond_options.h - bonding options
 * Copyright (c) 2013 Nikolay Aleksandrov <nikolay@redhat.com>
 */

#ifndef _NET_BOND_OPTIONS_H
#define _NET_BOND_OPTIONS_H

#define BOND_OPT_MAX_NAMELEN 32
#define BOND_OPT_VALID(opt) ((opt) < BOND_OPT_LAST)
#define BOND_MODE_ALL_EX(x) (~(x))

/* Option flags:
 * BOND_OPTFLAG_NOSLAVES - check if the bond device is empty before setting
 * BOND_OPTFLAG_IFDOWN - check if the bond device is down before setting
 * BOND_OPTFLAG_RAWVAL - the option parses the value itself
 */
enum {
	BOND_OPTFLAG_NOSLAVES	= BIT(0),
	BOND_OPTFLAG_IFDOWN	= BIT(1),
	BOND_OPTFLAG_RAWVAL	= BIT(2)
};

/* Value type flags:
 * BOND_VALFLAG_DEFAULT - mark the value as default
 * BOND_VALFLAG_(MIN|MAX) - mark the value as min/max
 */
enum {
	BOND_VALFLAG_DEFAULT	= BIT(0),
	BOND_VALFLAG_MIN	= BIT(1),
	BOND_VALFLAG_MAX	= BIT(2)
};

/* Option IDs, their bit positions correspond to their IDs */
enum {
	BOND_OPT_MODE,
	BOND_OPT_PACKETS_PER_SLAVE,
	BOND_OPT_XMIT_HASH,
	BOND_OPT_ARP_VALIDATE,
	BOND_OPT_ARP_ALL_TARGETS,
	BOND_OPT_FAIL_OVER_MAC,
	BOND_OPT_ARP_INTERVAL,
	BOND_OPT_ARP_TARGETS,
	BOND_OPT_DOWNDELAY,
	BOND_OPT_UPDELAY,
	BOND_OPT_LACP_RATE,
	BOND_OPT_MINLINKS,
	BOND_OPT_AD_SELECT,
	BOND_OPT_NUM_PEER_NOTIF,
	BOND_OPT_MIIMON,
	BOND_OPT_PRIMARY,
	BOND_OPT_PRIMARY_RESELECT,
	BOND_OPT_USE_CARRIER,
	BOND_OPT_ACTIVE_SLAVE,
	BOND_OPT_QUEUE_ID,
	BOND_OPT_ALL_SLAVES_ACTIVE,
	BOND_OPT_RESEND_IGMP,
	BOND_OPT_LP_INTERVAL,
	BOND_OPT_SLAVES,
	BOND_OPT_TLB_DYNAMIC_LB,
	BOND_OPT_AD_ACTOR_SYS_PRIO,
	BOND_OPT_AD_ACTOR_SYSTEM,
	BOND_OPT_AD_USER_PORT_KEY,
	BOND_OPT_NUM_PEER_NOTIF_ALIAS,
	BOND_OPT_PEER_NOTIF_DELAY,
	BOND_OPT_LACP_ACTIVE,
	BOND_OPT_MISSED_MAX,
	BOND_OPT_NS_TARGETS,
	BOND_OPT_LAST
};

/* This structure is used for storing option values and for passing option
 * values when changing an option. The logic when used as an arg is as follows:
 * - if value != ULLONG_MAX -> parse value
 * - if string != NULL -> parse string
 * - if the opt is RAW data and length less than maxlen,
 *   copy the data to extra storage
 */

#define BOND_OPT_EXTRA_MAXLEN 16
struct bond_opt_value {
	char *string;
	u64 value;
	u32 flags;
	char extra[BOND_OPT_EXTRA_MAXLEN];
};

struct bonding;

struct bond_option {
	int id;
	const char *name;
	const char *desc;
	u32 flags;

	/* unsuppmodes is used to denote modes in which the option isn't
	 * supported.
	 */
	unsigned long unsuppmodes;
	/* supported values which this option can have, can be a subset of
	 * BOND_OPTVAL_RANGE's value range
	 */
	const struct bond_opt_value *values;

	int (*set)(struct bonding *bond, const struct bond_opt_value *val);
};

int __bond_opt_set(struct bonding *bond, unsigned int option,
		   struct bond_opt_value *val);
int __bond_opt_set_notify(struct bonding *bond, unsigned int option,
			  struct bond_opt_value *val);
int bond_opt_tryset_rtnl(struct bonding *bond, unsigned int option, char *buf);

const struct bond_opt_value *bond_opt_parse(const struct bond_option *opt,
					    struct bond_opt_value *val);
const struct bond_option *bond_opt_get(unsigned int option);
const struct bond_option *bond_opt_get_by_name(const char *name);
const struct bond_opt_value *bond_opt_get_val(unsigned int option, u64 val);

/* This helper is used to initialize a bond_opt_value structure for parameter
 * passing. There should be either a valid string or value, but not both.
 * When value is ULLONG_MAX then string will be used.
 */
static inline void __bond_opt_init(struct bond_opt_value *optval,
				   char *string, u64 value,
				   void *extra, size_t extra_len)
{
	memset(optval, 0, sizeof(*optval));
	optval->value = ULLONG_MAX;
	if (value != ULLONG_MAX)
		optval->value = value;
	else if (string)
		optval->string = string;
	else if (extra_len <= BOND_OPT_EXTRA_MAXLEN)
		memcpy(optval->extra, extra, extra_len);
}
#define bond_opt_initval(optval, value) __bond_opt_init(optval, NULL, value, NULL, 0)
#define bond_opt_initstr(optval, str) __bond_opt_init(optval, str, ULLONG_MAX, NULL, 0)
#define bond_opt_initextra(optval, extra, extra_len) \
	__bond_opt_init(optval, NULL, ULLONG_MAX, extra, extra_len)

void bond_option_arp_ip_targets_clear(struct bonding *bond);
#if IS_ENABLED(CONFIG_IPV6)
void bond_option_ns_ip6_targets_clear(struct bonding *bond);
#endif

#endif /* _NET_BOND_OPTIONS_H */
Commit	Line	Data
2874c5fd	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
09117362 NA	2	/*
	3	* drivers/net/bond/bond_options.h - bonding options
	4	* Copyright (c) 2013 Nikolay Aleksandrov <nikolay@redhat.com>
09117362 NA	5	*/
09117362 NA	6
1ef8019b DM	7	#ifndef _NET_BOND_OPTIONS_H
1ef8019b DM	8	#define _NET_BOND_OPTIONS_H
09117362 NA	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 {
2b3798d5	37	BOND_OPT_MODE,
aa59d851	38	BOND_OPT_PACKETS_PER_SLAVE,
a4b32ce7	39	BOND_OPT_XMIT_HASH,
16228881	40	BOND_OPT_ARP_VALIDATE,
edf36b24	41	BOND_OPT_ARP_ALL_TARGETS,
1df6b6aa	42	BOND_OPT_FAIL_OVER_MAC,
7bdb04ed	43	BOND_OPT_ARP_INTERVAL,
4fb0ef58	44	BOND_OPT_ARP_TARGETS,
25a9b54a	45	BOND_OPT_DOWNDELAY,
e4994612	46	BOND_OPT_UPDELAY,
d3131de7	47	BOND_OPT_LACP_RATE,
633ddc9e	48	BOND_OPT_MINLINKS,
9e5f5eeb	49	BOND_OPT_AD_SELECT,
ef56becb	50	BOND_OPT_NUM_PEER_NOTIF,
b98d9c66	51	BOND_OPT_MIIMON,
180222f0	52	BOND_OPT_PRIMARY,
388d3a6d	53	BOND_OPT_PRIMARY_RESELECT,
0fff0608	54	BOND_OPT_USE_CARRIER,
d1fbd3ed	55	BOND_OPT_ACTIVE_SLAVE,
24089ba1	56	BOND_OPT_QUEUE_ID,
3df01162	57	BOND_OPT_ALL_SLAVES_ACTIVE,
105c8fb6	58	BOND_OPT_RESEND_IGMP,
4325b374	59	BOND_OPT_LP_INTERVAL,
0e2e5b66	60	BOND_OPT_SLAVES,
e9f0fb88	61	BOND_OPT_TLB_DYNAMIC_LB,
6791e466	62	BOND_OPT_AD_ACTOR_SYS_PRIO,
74514957	63	BOND_OPT_AD_ACTOR_SYSTEM,
d22a5fc0	64	BOND_OPT_AD_USER_PORT_KEY,
205845a3	65	BOND_OPT_NUM_PEER_NOTIF_ALIAS,
07a4ddec	66	BOND_OPT_PEER_NOTIF_DELAY,
3a755cd8	67	BOND_OPT_LACP_ACTIVE,
5944b5ab	68	BOND_OPT_MISSED_MAX,
129e3c1b	69	BOND_OPT_NS_TARGETS,
09117362 NA	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:
841e9564 HL	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
09117362	79	*/
841e9564 HL	80
841e9564 HL	81	#define BOND_OPT_EXTRA_MAXLEN 16
09117362 NA	82	struct bond_opt_value {
	83	char *string;
	84	u64 value;
	85	u32 flags;
841e9564	86	char extra[BOND_OPT_EXTRA_MAXLEN];
09117362 NA	87	};
	88
	89	struct bonding;
	90
	91	struct bond_option {
	92	int id;
f3253339	93	const char *name;
f3253339	94	const char *desc;
09117362 NA	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	*/
f3253339	104	const struct bond_opt_value *values;
09117362	105
28f084cc	106	int (set)(struct bonding bond, const struct bond_opt_value *val);
09117362 NA	107	};
	108
	109	int __bond_opt_set(struct bonding *bond, unsigned int option,
	110	struct bond_opt_value *val);
7a7e96e0 VY	111	int __bond_opt_set_notify(struct bonding *bond, unsigned int option,
7a7e96e0 VY	112	struct bond_opt_value *val);
09117362	113	int bond_opt_tryset_rtnl(struct bonding bond, unsigned int option, char buf);
28f084cc	114
f3253339	115	const struct bond_opt_value bond_opt_parse(const struct bond_option opt,
28f084cc	116	struct bond_opt_value *val);
f3253339	117	const struct bond_option *bond_opt_get(unsigned int option);
dc3e5d18	118	const struct bond_option bond_opt_get_by_name(const char name);
f3253339	119	const struct bond_opt_value *bond_opt_get_val(unsigned int option, u64 val);
09117362 NA	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,
841e9564 HL	126	char *string, u64 value,
841e9564 HL	127	void *extra, size_t extra_len)
09117362 NA	128	{
	129	memset(optval, 0, sizeof(*optval));
	130	optval->value = ULLONG_MAX;
841e9564	131	if (value != ULLONG_MAX)
09117362	132	optval->value = value;
841e9564 HL	133	else if (string)
	134	optval->string = string;
	135	else if (extra_len <= BOND_OPT_EXTRA_MAXLEN)
	136	memcpy(optval->extra, extra, extra_len);
09117362	137	}
841e9564 HL	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)
2b3798d5	142
4fb0ef58	143	void bond_option_arp_ip_targets_clear(struct bonding *bond);
129e3c1b HL	144	#if IS_ENABLED(CONFIG_IPV6)
	145	void bond_option_ns_ip6_targets_clear(struct bonding *bond);
	146	#endif
f3253339	147
1ef8019b	148	#endif /* _NET_BOND_OPTIONS_H */