[mirror_ubuntu-eoan-kernel.git] / include / linux / if_team.h

/*
 * include/linux/if_team.h - Network team device driver header
 * Copyright (c) 2011 Jiri Pirko <jpirko@redhat.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 */
#ifndef _LINUX_IF_TEAM_H_
#define _LINUX_IF_TEAM_H_

#include <linux/netpoll.h>
#include <net/sch_generic.h>
#include <linux/types.h>
#include <uapi/linux/if_team.h>

struct team_pcpu_stats {
	u64			rx_packets;
	u64			rx_bytes;
	u64			rx_multicast;
	u64			tx_packets;
	u64			tx_bytes;
	struct u64_stats_sync	syncp;
	u32			rx_dropped;
	u32			tx_dropped;
	u32			rx_nohandler;
};

struct team;

struct team_port {
	struct net_device *dev;
	struct hlist_node hlist; /* node in enabled ports hash list */
	struct list_head list; /* node in ordinary list */
	struct team *team;
	int index; /* index of enabled port. If disabled, it's set to -1 */

	bool linkup; /* either state.linkup or user.linkup */

	struct {
		bool linkup;
		u32 speed;
		u8 duplex;
	} state;

	/* Values set by userspace */
	struct {
		bool linkup;
		bool linkup_enabled;
	} user;

	/* Custom gennetlink interface related flags */
	bool changed;
	bool removed;

	/*
	 * A place for storing original values of the device before it
	 * become a port.
	 */
	struct {
		unsigned char dev_addr[MAX_ADDR_LEN];
		unsigned int mtu;
	} orig;

#ifdef CONFIG_NET_POLL_CONTROLLER
	struct netpoll *np;
#endif

	s32 priority; /* lower number ~ higher priority */
	u16 queue_id;
	struct list_head qom_list; /* node in queue override mapping list */
	struct rcu_head	rcu;
	long mode_priv[0];
};

static inline struct team_port *team_port_get_rcu(const struct net_device *dev)
{
	return rcu_dereference(dev->rx_handler_data);
}

static inline bool team_port_enabled(struct team_port *port)
{
	return port->index != -1;
}

static inline bool team_port_txable(struct team_port *port)
{
	return port->linkup && team_port_enabled(port);
}

static inline bool team_port_dev_txable(const struct net_device *port_dev)
{
	struct team_port *port;
	bool txable;

	rcu_read_lock();
	port = team_port_get_rcu(port_dev);
	txable = port ? team_port_txable(port) : false;
	rcu_read_unlock();

	return txable;
}

#ifdef CONFIG_NET_POLL_CONTROLLER
static inline void team_netpoll_send_skb(struct team_port *port,
					 struct sk_buff *skb)
{
	struct netpoll *np = port->np;

	if (np)
		netpoll_send_skb(np, skb);
}
#else
static inline void team_netpoll_send_skb(struct team_port *port,
					 struct sk_buff *skb)
{
}
#endif

struct team_mode_ops {
	int (*init)(struct team *team);
	void (*exit)(struct team *team);
	rx_handler_result_t (*receive)(struct team *team,
				       struct team_port *port,
				       struct sk_buff *skb);
	bool (*transmit)(struct team *team, struct sk_buff *skb);
	int (*port_enter)(struct team *team, struct team_port *port);
	void (*port_leave)(struct team *team, struct team_port *port);
	void (*port_change_dev_addr)(struct team *team, struct team_port *port);
	void (*port_enabled)(struct team *team, struct team_port *port);
	void (*port_disabled)(struct team *team, struct team_port *port);
};

extern int team_modeop_port_enter(struct team *team, struct team_port *port);
extern void team_modeop_port_change_dev_addr(struct team *team,
					     struct team_port *port);

enum team_option_type {
	TEAM_OPTION_TYPE_U32,
	TEAM_OPTION_TYPE_STRING,
	TEAM_OPTION_TYPE_BINARY,
	TEAM_OPTION_TYPE_BOOL,
	TEAM_OPTION_TYPE_S32,
};

struct team_option_inst_info {
	u32 array_index;
	struct team_port *port; /* != NULL if per-port */
};

struct team_gsetter_ctx {
	union {
		u32 u32_val;
		const char *str_val;
		struct {
			const void *ptr;
			u32 len;
		} bin_val;
		bool bool_val;
		s32 s32_val;
	} data;
	struct team_option_inst_info *info;
};

struct team_option {
	struct list_head list;
	const char *name;
	bool per_port;
	unsigned int array_size; /* != 0 means the option is array */
	enum team_option_type type;
	int (*init)(struct team *team, struct team_option_inst_info *info);
	int (*getter)(struct team *team, struct team_gsetter_ctx *ctx);
	int (*setter)(struct team *team, struct team_gsetter_ctx *ctx);
};

extern void team_option_inst_set_change(struct team_option_inst_info *opt_inst_info);
extern void team_options_change_check(struct team *team);

struct team_mode {
	const char *kind;
	struct module *owner;
	size_t priv_size;
	size_t port_priv_size;
	const struct team_mode_ops *ops;
	enum netdev_lag_tx_type lag_tx_type;
};

#define TEAM_PORT_HASHBITS 4
#define TEAM_PORT_HASHENTRIES (1 << TEAM_PORT_HASHBITS)

#define TEAM_MODE_PRIV_LONGS 4
#define TEAM_MODE_PRIV_SIZE (sizeof(long) * TEAM_MODE_PRIV_LONGS)

struct team {
	struct net_device *dev; /* associated netdevice */
	struct team_pcpu_stats __percpu *pcpu_stats;

	struct mutex lock; /* used for overall locking, e.g. port lists write */

	/*
	 * List of enabled ports and their count
	 */
	int en_port_count;
	struct hlist_head en_port_hlist[TEAM_PORT_HASHENTRIES];

	struct list_head port_list; /* list of all ports */

	struct list_head option_list;
	struct list_head option_inst_list; /* list of option instances */

	const struct team_mode *mode;
	struct team_mode_ops ops;
	bool user_carrier_enabled;
	bool queue_override_enabled;
	struct list_head *qom_lists; /* array of queue override mapping lists */
	bool port_mtu_change_allowed;
	struct {
		unsigned int count;
		unsigned int interval; /* in ms */
		atomic_t count_pending;
		struct delayed_work dw;
	} notify_peers;
	struct {
		unsigned int count;
		unsigned int interval; /* in ms */
		atomic_t count_pending;
		struct delayed_work dw;
	} mcast_rejoin;
	long mode_priv[TEAM_MODE_PRIV_LONGS];
};

static inline int team_dev_queue_xmit(struct team *team, struct team_port *port,
				      struct sk_buff *skb)
{
	BUILD_BUG_ON(sizeof(skb->queue_mapping) !=
		     sizeof(qdisc_skb_cb(skb)->slave_dev_queue_mapping));
	skb_set_queue_mapping(skb, qdisc_skb_cb(skb)->slave_dev_queue_mapping);

	skb->dev = port->dev;
	if (unlikely(netpoll_tx_running(team->dev))) {
		team_netpoll_send_skb(port, skb);
		return 0;
	}
	return dev_queue_xmit(skb);
}

static inline struct hlist_head *team_port_index_hash(struct team *team,
						      int port_index)
{
	return &team->en_port_hlist[port_index & (TEAM_PORT_HASHENTRIES - 1)];
}

static inline struct team_port *team_get_port_by_index(struct team *team,
						       int port_index)
{
	struct team_port *port;
	struct hlist_head *head = team_port_index_hash(team, port_index);

	hlist_for_each_entry(port, head, hlist)
		if (port->index == port_index)
			return port;
	return NULL;
}

static inline int team_num_to_port_index(struct team *team, unsigned int num)
{
	int en_port_count = READ_ONCE(team->en_port_count);

	if (unlikely(!en_port_count))
		return 0;
	return num % en_port_count;
}

static inline struct team_port *team_get_port_by_index_rcu(struct team *team,
							   int port_index)
{
	struct team_port *port;
	struct hlist_head *head = team_port_index_hash(team, port_index);

	hlist_for_each_entry_rcu(port, head, hlist)
		if (port->index == port_index)
			return port;
	return NULL;
}

static inline struct team_port *
team_get_first_port_txable_rcu(struct team *team, struct team_port *port)
{
	struct team_port *cur;

	if (likely(team_port_txable(port)))
		return port;
	cur = port;
	list_for_each_entry_continue_rcu(cur, &team->port_list, list)
		if (team_port_txable(cur))
			return cur;
	list_for_each_entry_rcu(cur, &team->port_list, list) {
		if (cur == port)
			break;
		if (team_port_txable(cur))
			return cur;
	}
	return NULL;
}

extern int team_options_register(struct team *team,
				 const struct team_option *option,
				 size_t option_count);
extern void team_options_unregister(struct team *team,
				    const struct team_option *option,
				    size_t option_count);
extern int team_mode_register(const struct team_mode *mode);
extern void team_mode_unregister(const struct team_mode *mode);

#define TEAM_DEFAULT_NUM_TX_QUEUES 16
#define TEAM_DEFAULT_NUM_RX_QUEUES 16

#define MODULE_ALIAS_TEAM_MODE(kind) MODULE_ALIAS("team-mode-" kind)

#endif /* _LINUX_IF_TEAM_H_ */
Commit	Line	Data
3d249d4c JP	1	/*
	2	* include/linux/if_team.h - Network team device driver header
	3	* Copyright (c) 2011 Jiri Pirko <jpirko@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	*/
3d249d4c JP	10	#ifndef _LINUX_IF_TEAM_H_
	11	#define _LINUX_IF_TEAM_H_
	12
bd2d0837	13	#include <linux/netpoll.h>
6c85f2bd	14	#include <net/sch_generic.h>
fc423ff0	15	#include <linux/types.h>
607ca46e	16	#include <uapi/linux/if_team.h>
bd2d0837	17
3d249d4c JP	18	struct team_pcpu_stats {
	19	u64 rx_packets;
	20	u64 rx_bytes;
	21	u64 rx_multicast;
	22	u64 tx_packets;
	23	u64 tx_bytes;
	24	struct u64_stats_sync syncp;
	25	u32 rx_dropped;
	26	u32 tx_dropped;
bb63daf9	27	u32 rx_nohandler;
3d249d4c JP	28	};
	29
	30	struct team;
	31
	32	struct team_port {
	33	struct net_device *dev;
19a0b58e	34	struct hlist_node hlist; /* node in enabled ports hash list */
3d249d4c JP	35	struct list_head list; /* node in ordinary list */
3d249d4c JP	36	struct team *team;
19a0b58e	37	int index; /* index of enabled port. If disabled, it's set to -1 */
3d249d4c	38
71472ec1 JP	39	bool linkup; /* either state.linkup or user.linkup */
	40
	41	struct {
	42	bool linkup;
	43	u32 speed;
	44	u8 duplex;
	45	} state;
	46
	47	/* Values set by userspace */
	48	struct {
	49	bool linkup;
	50	bool linkup_enabled;
	51	} user;
	52
	53	/* Custom gennetlink interface related flags */
	54	bool changed;
	55	bool removed;
	56
3d249d4c JP	57	/*
	58	* A place for storing original values of the device before it
	59	* become a port.
	60	*/
	61	struct {
	62	unsigned char dev_addr[MAX_ADDR_LEN];
	63	unsigned int mtu;
	64	} orig;
	65
bd2d0837 JP	66	#ifdef CONFIG_NET_POLL_CONTROLLER
	67	struct netpoll *np;
	68	#endif
	69
a86fc6b7	70	s32 priority; /* lower number ~ higher priority */
8ff5105a JP	71	u16 queue_id;
8ff5105a JP	72	struct list_head qom_list; /* node in queue override mapping list */
d80b35be	73	struct rcu_head rcu;
5149ee58	74	long mode_priv[0];
3d249d4c JP	75	};
3d249d4c JP	76
3443b00e PM	77	static inline struct team_port team_port_get_rcu(const struct net_device dev)
	78	{
	79	return rcu_dereference(dev->rx_handler_data);
	80	}
	81
68c45042 JP	82	static inline bool team_port_enabled(struct team_port *port)
	83	{
	84	return port->index != -1;
	85	}
	86
	87	static inline bool team_port_txable(struct team_port *port)
	88	{
	89	return port->linkup && team_port_enabled(port);
	90	}
52a4fd77	91
eeed992b PM	92	static inline bool team_port_dev_txable(const struct net_device *port_dev)
	93	{
	94	struct team_port *port;
	95	bool txable;
	96
	97	rcu_read_lock();
	98	port = team_port_get_rcu(port_dev);
	99	txable = port ? team_port_txable(port) : false;
	100	rcu_read_unlock();
	101
	102	return txable;
	103	}
	104
bd2d0837 JP	105	#ifdef CONFIG_NET_POLL_CONTROLLER
	106	static inline void team_netpoll_send_skb(struct team_port *port,
	107	struct sk_buff *skb)
	108	{
	109	struct netpoll *np = port->np;
	110
	111	if (np)
	112	netpoll_send_skb(np, skb);
	113	}
	114	#else
	115	static inline void team_netpoll_send_skb(struct team_port *port,
	116	struct sk_buff *skb)
	117	{
	118	}
	119	#endif
	120
3d249d4c JP	121	struct team_mode_ops {
	122	int (init)(struct team team);
	123	void (exit)(struct team team);
	124	rx_handler_result_t (receive)(struct team team,
	125	struct team_port *port,
	126	struct sk_buff *skb);
	127	bool (transmit)(struct team team, struct sk_buff *skb);
	128	int (port_enter)(struct team team, struct team_port *port);
	129	void (port_leave)(struct team team, struct team_port *port);
1d76efe1	130	void (port_change_dev_addr)(struct team team, struct team_port *port);
4bccfd17 JP	131	void (port_enabled)(struct team team, struct team_port *port);
4bccfd17 JP	132	void (port_disabled)(struct team team, struct team_port *port);
3d249d4c JP	133	};
3d249d4c JP	134
acbba0d0 JP	135	extern int team_modeop_port_enter(struct team team, struct team_port port);
	136	extern void team_modeop_port_change_dev_addr(struct team *team,
	137	struct team_port *port);
	138
3d249d4c JP	139	enum team_option_type {
	140	TEAM_OPTION_TYPE_U32,
	141	TEAM_OPTION_TYPE_STRING,
2615598f	142	TEAM_OPTION_TYPE_BINARY,
14f066ba	143	TEAM_OPTION_TYPE_BOOL,
69821638	144	TEAM_OPTION_TYPE_S32,
3d249d4c JP	145	};
3d249d4c JP	146
85d59a87 JP	147	struct team_option_inst_info {
	148	u32 array_index;
	149	struct team_port port; / != NULL if per-port */
	150	};
	151
80f7c668 JP	152	struct team_gsetter_ctx {
	153	union {
	154	u32 u32_val;
	155	const char *str_val;
	156	struct {
	157	const void *ptr;
	158	u32 len;
	159	} bin_val;
14f066ba	160	bool bool_val;
69821638	161	s32 s32_val;
80f7c668	162	} data;
85d59a87	163	struct team_option_inst_info *info;
80f7c668 JP	164	};
80f7c668 JP	165
3d249d4c JP	166	struct team_option {
	167	struct list_head list;
	168	const char *name;
80f7c668	169	bool per_port;
b1303326	170	unsigned int array_size; /* != 0 means the option is array */
3d249d4c	171	enum team_option_type type;
85d59a87	172	int (init)(struct team team, struct team_option_inst_info *info);
80f7c668 JP	173	int (getter)(struct team team, struct team_gsetter_ctx *ctx);
80f7c668 JP	174	int (setter)(struct team team, struct team_gsetter_ctx *ctx);
3d249d4c JP	175	};
3d249d4c JP	176
0f1aad2b JP	177	extern void team_option_inst_set_change(struct team_option_inst_info *opt_inst_info);
	178	extern void team_options_change_check(struct team *team);
	179
3d249d4c	180	struct team_mode {
3d249d4c JP	181	const char *kind;
	182	struct module *owner;
	183	size_t priv_size;
5149ee58	184	size_t port_priv_size;
3d249d4c	185	const struct team_mode_ops *ops;
8fd72856	186	enum netdev_lag_tx_type lag_tx_type;
3d249d4c JP	187	};
	188
	189	#define TEAM_PORT_HASHBITS 4
	190	#define TEAM_PORT_HASHENTRIES (1 << TEAM_PORT_HASHBITS)
	191
	192	#define TEAM_MODE_PRIV_LONGS 4
	193	#define TEAM_MODE_PRIV_SIZE (sizeof(long) * TEAM_MODE_PRIV_LONGS)
	194
	195	struct team {
	196	struct net_device dev; / associated netdevice */
	197	struct team_pcpu_stats __percpu *pcpu_stats;
	198
61dc3461	199	struct mutex lock; /* used for overall locking, e.g. port lists write */
3d249d4c JP	200
3d249d4c JP	201	/*
19a0b58e	202	* List of enabled ports and their count
3d249d4c	203	*/
19a0b58e JP	204	int en_port_count;
	205	struct hlist_head en_port_hlist[TEAM_PORT_HASHENTRIES];
	206
	207	struct list_head port_list; /* list of all ports */
3d249d4c JP	208
3d249d4c JP	209	struct list_head option_list;
80f7c668	210	struct list_head option_inst_list; /* list of option instances */
3d249d4c JP	211
	212	const struct team_mode *mode;
	213	struct team_mode_ops ops;
e185483e	214	bool user_carrier_enabled;
8ff5105a JP	215	bool queue_override_enabled;
8ff5105a JP	216	struct list_head qom_lists; / array of queue override mapping lists */
9d0d68fa	217	bool port_mtu_change_allowed;
fc423ff0 JP	218	struct {
	219	unsigned int count;
	220	unsigned int interval; /* in ms */
	221	atomic_t count_pending;
	222	struct delayed_work dw;
	223	} notify_peers;
492b200e JP	224	struct {
	225	unsigned int count;
	226	unsigned int interval; /* in ms */
	227	atomic_t count_pending;
	228	struct delayed_work dw;
	229	} mcast_rejoin;
3d249d4c JP	230	long mode_priv[TEAM_MODE_PRIV_LONGS];
	231	};
	232
e15c3c22 AW	233	static inline int team_dev_queue_xmit(struct team team, struct team_port port,
	234	struct sk_buff *skb)
	235	{
	236	BUILD_BUG_ON(sizeof(skb->queue_mapping) !=
	237	sizeof(qdisc_skb_cb(skb)->slave_dev_queue_mapping));
	238	skb_set_queue_mapping(skb, qdisc_skb_cb(skb)->slave_dev_queue_mapping);
	239
	240	skb->dev = port->dev;
	241	if (unlikely(netpoll_tx_running(team->dev))) {
	242	team_netpoll_send_skb(port, skb);
	243	return 0;
	244	}
	245	return dev_queue_xmit(skb);
	246	}
	247
3d249d4c JP	248	static inline struct hlist_head team_port_index_hash(struct team team,
	249	int port_index)
	250	{
19a0b58e	251	return &team->en_port_hlist[port_index & (TEAM_PORT_HASHENTRIES - 1)];
3d249d4c JP	252	}
	253
	254	static inline struct team_port team_get_port_by_index(struct team team,
	255	int port_index)
	256	{
3d249d4c JP	257	struct team_port *port;
	258	struct hlist_head *head = team_port_index_hash(team, port_index);
	259
b67bfe0d	260	hlist_for_each_entry(port, head, hlist)
3d249d4c JP	261	if (port->index == port_index)
	262	return port;
	263	return NULL;
	264	}
735d381f	265
21d9629a	266	static inline int team_num_to_port_index(struct team *team, unsigned int num)
735d381f	267	{
6aa7de05	268	int en_port_count = READ_ONCE(team->en_port_count);
735d381f JP	269
	270	if (unlikely(!en_port_count))
	271	return 0;
	272	return num % en_port_count;
	273	}
	274
3d249d4c JP	275	static inline struct team_port team_get_port_by_index_rcu(struct team team,
	276	int port_index)
	277	{
3d249d4c JP	278	struct team_port *port;
	279	struct hlist_head *head = team_port_index_hash(team, port_index);
	280
b67bfe0d	281	hlist_for_each_entry_rcu(port, head, hlist)
3d249d4c JP	282	if (port->index == port_index)
	283	return port;
	284	return NULL;
	285	}
	286
753f9939 JP	287	static inline struct team_port *
	288	team_get_first_port_txable_rcu(struct team team, struct team_port port)
	289	{
	290	struct team_port *cur;
	291
	292	if (likely(team_port_txable(port)))
	293	return port;
	294	cur = port;
	295	list_for_each_entry_continue_rcu(cur, &team->port_list, list)
b79462a8	296	if (team_port_txable(cur))
753f9939 JP	297	return cur;
	298	list_for_each_entry_rcu(cur, &team->port_list, list) {
	299	if (cur == port)
	300	break;
b79462a8	301	if (team_port_txable(cur))
753f9939 JP	302	return cur;
	303	}
	304	return NULL;
	305	}
	306
358b8382 JP	307	extern int team_options_register(struct team *team,
	308	const struct team_option *option,
	309	size_t option_count);
3d249d4c	310	extern void team_options_unregister(struct team *team,
358b8382	311	const struct team_option *option,
3d249d4c	312	size_t option_count);
0402788a JP	313	extern int team_mode_register(const struct team_mode *mode);
0402788a JP	314	extern void team_mode_unregister(const struct team_mode *mode);
3d249d4c	315
6c85f2bd JP	316	#define TEAM_DEFAULT_NUM_TX_QUEUES 16
	317	#define TEAM_DEFAULT_NUM_RX_QUEUES 16
	318
3a5f8997 ZS	319	#define MODULE_ALIAS_TEAM_MODE(kind) MODULE_ALIAS("team-mode-" kind)
3a5f8997 ZS	320
3d249d4c	321	#endif /* _LINUX_IF_TEAM_H_ */