[deliverable/linux.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_

#ifdef __KERNEL__

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;
};

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;

	struct rcu_head rcu;
	long mode_priv[0];
};

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_mac)(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,
};

struct team_gsetter_ctx {
	union {
		u32 u32_val;
		const char *str_val;
		struct {
			const void *ptr;
			u32 len;
		} bin_val;
		bool bool_val;
	} data;
	u32 array_index;
	struct team_port *port;
};

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 (*getter)(struct team *team, struct team_gsetter_ctx *ctx);
	int (*setter)(struct team *team, struct team_gsetter_ctx *ctx);
};

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

#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;
	long mode_priv[TEAM_MODE_PRIV_LONGS];
};

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 hlist_node *p;
	struct team_port *port;
	struct hlist_head *head = team_port_index_hash(team, port_index);

	hlist_for_each_entry(port, p, head, hlist)
		if (port->index == port_index)
			return port;
	return NULL;
}
static inline struct team_port *team_get_port_by_index_rcu(struct team *team,
							   int port_index)
{
	struct hlist_node *p;
	struct team_port *port;
	struct hlist_head *head = team_port_index_hash(team, port_index);

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

extern int team_port_set_team_mac(struct team_port *port);
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);

#endif /* __KERNEL__ */

#define TEAM_STRING_MAX_LEN 32

/**********************************
 * NETLINK_GENERIC netlink family.
 **********************************/

enum {
	TEAM_CMD_NOOP,
	TEAM_CMD_OPTIONS_SET,
	TEAM_CMD_OPTIONS_GET,
	TEAM_CMD_PORT_LIST_GET,

	__TEAM_CMD_MAX,
	TEAM_CMD_MAX = (__TEAM_CMD_MAX - 1),
};

enum {
	TEAM_ATTR_UNSPEC,
	TEAM_ATTR_TEAM_IFINDEX,		/* u32 */
	TEAM_ATTR_LIST_OPTION,		/* nest */
	TEAM_ATTR_LIST_PORT,		/* nest */

	__TEAM_ATTR_MAX,
	TEAM_ATTR_MAX = __TEAM_ATTR_MAX - 1,
};

/* Nested layout of get/set msg:
 *
 *	[TEAM_ATTR_LIST_OPTION]
 *		[TEAM_ATTR_ITEM_OPTION]
 *			[TEAM_ATTR_OPTION_*], ...
 *		[TEAM_ATTR_ITEM_OPTION]
 *			[TEAM_ATTR_OPTION_*], ...
 *		...
 *	[TEAM_ATTR_LIST_PORT]
 *		[TEAM_ATTR_ITEM_PORT]
 *			[TEAM_ATTR_PORT_*], ...
 *		[TEAM_ATTR_ITEM_PORT]
 *			[TEAM_ATTR_PORT_*], ...
 *		...
 */

enum {
	TEAM_ATTR_ITEM_OPTION_UNSPEC,
	TEAM_ATTR_ITEM_OPTION,		/* nest */

	__TEAM_ATTR_ITEM_OPTION_MAX,
	TEAM_ATTR_ITEM_OPTION_MAX = __TEAM_ATTR_ITEM_OPTION_MAX - 1,
};

enum {
	TEAM_ATTR_OPTION_UNSPEC,
	TEAM_ATTR_OPTION_NAME,		/* string */
	TEAM_ATTR_OPTION_CHANGED,	/* flag */
	TEAM_ATTR_OPTION_TYPE,		/* u8 */
	TEAM_ATTR_OPTION_DATA,		/* dynamic */
	TEAM_ATTR_OPTION_REMOVED,	/* flag */
	TEAM_ATTR_OPTION_PORT_IFINDEX,	/* u32 */ /* for per-port options */
	TEAM_ATTR_OPTION_ARRAY_INDEX,	/* u32 */ /* for array options */

	__TEAM_ATTR_OPTION_MAX,
	TEAM_ATTR_OPTION_MAX = __TEAM_ATTR_OPTION_MAX - 1,
};

enum {
	TEAM_ATTR_ITEM_PORT_UNSPEC,
	TEAM_ATTR_ITEM_PORT,		/* nest */

	__TEAM_ATTR_ITEM_PORT_MAX,
	TEAM_ATTR_ITEM_PORT_MAX = __TEAM_ATTR_ITEM_PORT_MAX - 1,
};

enum {
	TEAM_ATTR_PORT_UNSPEC,
	TEAM_ATTR_PORT_IFINDEX,		/* u32 */
	TEAM_ATTR_PORT_CHANGED,		/* flag */
	TEAM_ATTR_PORT_LINKUP,		/* flag */
	TEAM_ATTR_PORT_SPEED,		/* u32 */
	TEAM_ATTR_PORT_DUPLEX,		/* u8 */
	TEAM_ATTR_PORT_REMOVED,		/* flag */

	__TEAM_ATTR_PORT_MAX,
	TEAM_ATTR_PORT_MAX = __TEAM_ATTR_PORT_MAX - 1,
};

/*
 * NETLINK_GENERIC related info
 */
#define TEAM_GENL_NAME "team"
#define TEAM_GENL_VERSION 0x1
#define TEAM_GENL_CHANGE_EVENT_MC_GRP_NAME "change_event"

#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	*/
	10
	11	#ifndef _LINUX_IF_TEAM_H_
	12	#define _LINUX_IF_TEAM_H_
	13
	14	#ifdef __KERNEL__
	15
	16	struct team_pcpu_stats {
	17	u64 rx_packets;
	18	u64 rx_bytes;
	19	u64 rx_multicast;
	20	u64 tx_packets;
	21	u64 tx_bytes;
	22	struct u64_stats_sync syncp;
	23	u32 rx_dropped;
	24	u32 tx_dropped;
	25	};
	26
	27	struct team;
	28
	29	struct team_port {
	30	struct net_device *dev;
19a0b58e	31	struct hlist_node hlist; /* node in enabled ports hash list */
3d249d4c JP	32	struct list_head list; /* node in ordinary list */
3d249d4c JP	33	struct team *team;
19a0b58e	34	int index; /* index of enabled port. If disabled, it's set to -1 */
3d249d4c	35
71472ec1 JP	36	bool linkup; /* either state.linkup or user.linkup */
	37
	38	struct {
	39	bool linkup;
	40	u32 speed;
	41	u8 duplex;
	42	} state;
	43
	44	/* Values set by userspace */
	45	struct {
	46	bool linkup;
	47	bool linkup_enabled;
	48	} user;
	49
	50	/* Custom gennetlink interface related flags */
	51	bool changed;
	52	bool removed;
	53
3d249d4c JP	54	/*
	55	* A place for storing original values of the device before it
	56	* become a port.
	57	*/
	58	struct {
	59	unsigned char dev_addr[MAX_ADDR_LEN];
	60	unsigned int mtu;
	61	} orig;
	62
3d249d4c	63	struct rcu_head rcu;
5149ee58	64	long mode_priv[0];
3d249d4c JP	65	};
	66
	67	struct team_mode_ops {
	68	int (init)(struct team team);
	69	void (exit)(struct team team);
	70	rx_handler_result_t (receive)(struct team team,
	71	struct team_port *port,
	72	struct sk_buff *skb);
	73	bool (transmit)(struct team team, struct sk_buff *skb);
	74	int (port_enter)(struct team team, struct team_port *port);
	75	void (port_leave)(struct team team, struct team_port *port);
	76	void (port_change_mac)(struct team team, struct team_port *port);
	77	};
	78
	79	enum team_option_type {
	80	TEAM_OPTION_TYPE_U32,
	81	TEAM_OPTION_TYPE_STRING,
2615598f	82	TEAM_OPTION_TYPE_BINARY,
14f066ba	83	TEAM_OPTION_TYPE_BOOL,
3d249d4c JP	84	};
3d249d4c JP	85
80f7c668 JP	86	struct team_gsetter_ctx {
	87	union {
	88	u32 u32_val;
	89	const char *str_val;
	90	struct {
	91	const void *ptr;
	92	u32 len;
	93	} bin_val;
14f066ba	94	bool bool_val;
80f7c668	95	} data;
b1303326	96	u32 array_index;
80f7c668 JP	97	struct team_port *port;
	98	};
	99
3d249d4c JP	100	struct team_option {
	101	struct list_head list;
	102	const char *name;
80f7c668	103	bool per_port;
b1303326	104	unsigned int array_size; /* != 0 means the option is array */
3d249d4c	105	enum team_option_type type;
80f7c668 JP	106	int (getter)(struct team team, struct team_gsetter_ctx *ctx);
80f7c668 JP	107	int (setter)(struct team team, struct team_gsetter_ctx *ctx);
3d249d4c JP	108	};
	109
	110	struct team_mode {
3d249d4c JP	111	const char *kind;
	112	struct module *owner;
	113	size_t priv_size;
5149ee58	114	size_t port_priv_size;
3d249d4c JP	115	const struct team_mode_ops *ops;
	116	};
	117
	118	#define TEAM_PORT_HASHBITS 4
	119	#define TEAM_PORT_HASHENTRIES (1 << TEAM_PORT_HASHBITS)
	120
	121	#define TEAM_MODE_PRIV_LONGS 4
	122	#define TEAM_MODE_PRIV_SIZE (sizeof(long) * TEAM_MODE_PRIV_LONGS)
	123
	124	struct team {
	125	struct net_device dev; / associated netdevice */
	126	struct team_pcpu_stats __percpu *pcpu_stats;
	127
61dc3461	128	struct mutex lock; /* used for overall locking, e.g. port lists write */
3d249d4c JP	129
3d249d4c JP	130	/*
19a0b58e	131	* List of enabled ports and their count
3d249d4c	132	*/
19a0b58e JP	133	int en_port_count;
	134	struct hlist_head en_port_hlist[TEAM_PORT_HASHENTRIES];
	135
	136	struct list_head port_list; /* list of all ports */
3d249d4c JP	137
3d249d4c JP	138	struct list_head option_list;
80f7c668	139	struct list_head option_inst_list; /* list of option instances */
3d249d4c JP	140
	141	const struct team_mode *mode;
	142	struct team_mode_ops ops;
	143	long mode_priv[TEAM_MODE_PRIV_LONGS];
	144	};
	145
	146	static inline struct hlist_head team_port_index_hash(struct team team,
	147	int port_index)
	148	{
19a0b58e	149	return &team->en_port_hlist[port_index & (TEAM_PORT_HASHENTRIES - 1)];
3d249d4c JP	150	}
	151
	152	static inline struct team_port team_get_port_by_index(struct team team,
	153	int port_index)
	154	{
	155	struct hlist_node *p;
	156	struct team_port *port;
	157	struct hlist_head *head = team_port_index_hash(team, port_index);
	158
	159	hlist_for_each_entry(port, p, head, hlist)
	160	if (port->index == port_index)
	161	return port;
	162	return NULL;
	163	}
	164	static inline struct team_port team_get_port_by_index_rcu(struct team team,
	165	int port_index)
	166	{
	167	struct hlist_node *p;
	168	struct team_port *port;
	169	struct hlist_head *head = team_port_index_hash(team, port_index);
	170
	171	hlist_for_each_entry_rcu(port, p, head, hlist)
	172	if (port->index == port_index)
	173	return port;
	174	return NULL;
	175	}
	176
	177	extern int team_port_set_team_mac(struct team_port *port);
358b8382 JP	178	extern int team_options_register(struct team *team,
	179	const struct team_option *option,
	180	size_t option_count);
3d249d4c	181	extern void team_options_unregister(struct team *team,
358b8382	182	const struct team_option *option,
3d249d4c	183	size_t option_count);
0402788a JP	184	extern int team_mode_register(const struct team_mode *mode);
0402788a JP	185	extern void team_mode_unregister(const struct team_mode *mode);
3d249d4c JP	186
	187	#endif /* __KERNEL__ */
	188
	189	#define TEAM_STRING_MAX_LEN 32
	190
	191	/**********************************
	192	* NETLINK_GENERIC netlink family.
	193	**********************************/
	194
	195	enum {
	196	TEAM_CMD_NOOP,
	197	TEAM_CMD_OPTIONS_SET,
	198	TEAM_CMD_OPTIONS_GET,
	199	TEAM_CMD_PORT_LIST_GET,
	200
	201	__TEAM_CMD_MAX,
	202	TEAM_CMD_MAX = (__TEAM_CMD_MAX - 1),
	203	};
	204
	205	enum {
	206	TEAM_ATTR_UNSPEC,
	207	TEAM_ATTR_TEAM_IFINDEX, /* u32 */
	208	TEAM_ATTR_LIST_OPTION, /* nest */
	209	TEAM_ATTR_LIST_PORT, /* nest */
	210
	211	__TEAM_ATTR_MAX,
	212	TEAM_ATTR_MAX = __TEAM_ATTR_MAX - 1,
	213	};
	214
	215	/* Nested layout of get/set msg:
	216	*
	217	* [TEAM_ATTR_LIST_OPTION]
	218	* [TEAM_ATTR_ITEM_OPTION]
	219	* [TEAM_ATTR_OPTION_*], ...
	220	* [TEAM_ATTR_ITEM_OPTION]
	221	* [TEAM_ATTR_OPTION_*], ...
	222	* ...
	223	* [TEAM_ATTR_LIST_PORT]
	224	* [TEAM_ATTR_ITEM_PORT]
	225	* [TEAM_ATTR_PORT_*], ...
	226	* [TEAM_ATTR_ITEM_PORT]
	227	* [TEAM_ATTR_PORT_*], ...
	228	* ...
	229	*/
	230
	231	enum {
	232	TEAM_ATTR_ITEM_OPTION_UNSPEC,
	233	TEAM_ATTR_ITEM_OPTION, /* nest */
	234
	235	__TEAM_ATTR_ITEM_OPTION_MAX,
	236	TEAM_ATTR_ITEM_OPTION_MAX = __TEAM_ATTR_ITEM_OPTION_MAX - 1,
	237	};
	238
	239	enum {
	240	TEAM_ATTR_OPTION_UNSPEC,
	241	TEAM_ATTR_OPTION_NAME, /* string */
	242	TEAM_ATTR_OPTION_CHANGED, /* flag */
	243	TEAM_ATTR_OPTION_TYPE, /* u8 */
	244	TEAM_ATTR_OPTION_DATA, /* dynamic */
b82b9183	245	TEAM_ATTR_OPTION_REMOVED, /* flag */
80f7c668	246	TEAM_ATTR_OPTION_PORT_IFINDEX, /* u32 / / for per-port options */
b1303326	247	TEAM_ATTR_OPTION_ARRAY_INDEX, /* u32 / / for array options */
3d249d4c JP	248
	249	__TEAM_ATTR_OPTION_MAX,
	250	TEAM_ATTR_OPTION_MAX = __TEAM_ATTR_OPTION_MAX - 1,
	251	};
	252
	253	enum {
	254	TEAM_ATTR_ITEM_PORT_UNSPEC,
	255	TEAM_ATTR_ITEM_PORT, /* nest */
	256
	257	__TEAM_ATTR_ITEM_PORT_MAX,
	258	TEAM_ATTR_ITEM_PORT_MAX = __TEAM_ATTR_ITEM_PORT_MAX - 1,
	259	};
	260
	261	enum {
	262	TEAM_ATTR_PORT_UNSPEC,
	263	TEAM_ATTR_PORT_IFINDEX, /* u32 */
	264	TEAM_ATTR_PORT_CHANGED, /* flag */
	265	TEAM_ATTR_PORT_LINKUP, /* flag */
	266	TEAM_ATTR_PORT_SPEED, /* u32 */
	267	TEAM_ATTR_PORT_DUPLEX, /* u8 */
b82b9183	268	TEAM_ATTR_PORT_REMOVED, /* flag */
3d249d4c JP	269
	270	__TEAM_ATTR_PORT_MAX,
	271	TEAM_ATTR_PORT_MAX = __TEAM_ATTR_PORT_MAX - 1,
	272	};
	273
	274	/*
	275	* NETLINK_GENERIC related info
	276	*/
	277	#define TEAM_GENL_NAME "team"
	278	#define TEAM_GENL_VERSION 0x1
	279	#define TEAM_GENL_CHANGE_EVENT_MC_GRP_NAME "change_event"
	280
	281	#endif /* _LINUX_IF_TEAM_H_ */