blob: a6aa970758a22065901f861dd29d4b14110bbe3b [file] [log] [blame]
Jiri Pirko3d249d42011-11-11 22:16:48 +00001/*
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 */
Jiri Pirko3d249d42011-11-11 22:16:48 +000010#ifndef _LINUX_IF_TEAM_H_
11#define _LINUX_IF_TEAM_H_
12
Jiri Pirkobd2d0832012-07-17 05:22:36 +000013#include <linux/netpoll.h>
Jiri Pirko6c85f2b2012-07-20 02:28:51 +000014#include <net/sch_generic.h>
Jiri Pirkofc423ff2013-07-20 12:13:52 +020015#include <linux/types.h>
David Howells607ca462012-10-13 10:46:48 +010016#include <uapi/linux/if_team.h>
Jiri Pirkobd2d0832012-07-17 05:22:36 +000017
Jiri Pirko3d249d42011-11-11 22:16:48 +000018struct 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;
27};
28
29struct team;
30
31struct team_port {
32 struct net_device *dev;
Jiri Pirko19a0b582012-04-20 04:42:05 +000033 struct hlist_node hlist; /* node in enabled ports hash list */
Jiri Pirko3d249d42011-11-11 22:16:48 +000034 struct list_head list; /* node in ordinary list */
35 struct team *team;
Jiri Pirko19a0b582012-04-20 04:42:05 +000036 int index; /* index of enabled port. If disabled, it's set to -1 */
Jiri Pirko3d249d42011-11-11 22:16:48 +000037
Jiri Pirko71472ec2012-04-10 05:15:44 +000038 bool linkup; /* either state.linkup or user.linkup */
39
40 struct {
41 bool linkup;
42 u32 speed;
43 u8 duplex;
44 } state;
45
46 /* Values set by userspace */
47 struct {
48 bool linkup;
49 bool linkup_enabled;
50 } user;
51
52 /* Custom gennetlink interface related flags */
53 bool changed;
54 bool removed;
55
Jiri Pirko3d249d42011-11-11 22:16:48 +000056 /*
57 * A place for storing original values of the device before it
58 * become a port.
59 */
60 struct {
61 unsigned char dev_addr[MAX_ADDR_LEN];
62 unsigned int mtu;
63 } orig;
64
Jiri Pirkobd2d0832012-07-17 05:22:36 +000065#ifdef CONFIG_NET_POLL_CONTROLLER
66 struct netpoll *np;
67#endif
68
Jiri Pirkoa86fc6b2012-07-27 06:28:54 +000069 s32 priority; /* lower number ~ higher priority */
Jiri Pirko8ff51052012-07-27 06:28:55 +000070 u16 queue_id;
71 struct list_head qom_list; /* node in queue override mapping list */
Jiri Pirkod80b35b2013-06-10 17:42:24 +020072 struct rcu_head rcu;
Jiri Pirko5149ee52012-06-19 05:54:05 +000073 long mode_priv[0];
Jiri Pirko3d249d42011-11-11 22:16:48 +000074};
75
Jiri Pirko68c45042012-07-11 05:34:04 +000076static inline bool team_port_enabled(struct team_port *port)
77{
78 return port->index != -1;
79}
80
81static inline bool team_port_txable(struct team_port *port)
82{
83 return port->linkup && team_port_enabled(port);
84}
Jiri Pirko52a4fd72012-06-26 06:52:46 +000085
Jiri Pirkobd2d0832012-07-17 05:22:36 +000086#ifdef CONFIG_NET_POLL_CONTROLLER
87static inline void team_netpoll_send_skb(struct team_port *port,
88 struct sk_buff *skb)
89{
90 struct netpoll *np = port->np;
91
92 if (np)
93 netpoll_send_skb(np, skb);
94}
95#else
96static inline void team_netpoll_send_skb(struct team_port *port,
97 struct sk_buff *skb)
98{
99}
100#endif
101
Jiri Pirko3d249d42011-11-11 22:16:48 +0000102struct team_mode_ops {
103 int (*init)(struct team *team);
104 void (*exit)(struct team *team);
105 rx_handler_result_t (*receive)(struct team *team,
106 struct team_port *port,
107 struct sk_buff *skb);
108 bool (*transmit)(struct team *team, struct sk_buff *skb);
109 int (*port_enter)(struct team *team, struct team_port *port);
110 void (*port_leave)(struct team *team, struct team_port *port);
Jiri Pirko1d76efe2012-08-17 04:00:48 +0000111 void (*port_change_dev_addr)(struct team *team, struct team_port *port);
Jiri Pirko4bccfd12012-06-19 05:54:16 +0000112 void (*port_enabled)(struct team *team, struct team_port *port);
113 void (*port_disabled)(struct team *team, struct team_port *port);
Jiri Pirko3d249d42011-11-11 22:16:48 +0000114};
115
Jiri Pirkoacbba0d2013-03-06 01:31:12 +0000116extern int team_modeop_port_enter(struct team *team, struct team_port *port);
117extern void team_modeop_port_change_dev_addr(struct team *team,
118 struct team_port *port);
119
Jiri Pirko3d249d42011-11-11 22:16:48 +0000120enum team_option_type {
121 TEAM_OPTION_TYPE_U32,
122 TEAM_OPTION_TYPE_STRING,
Jiri Pirko26155982012-04-04 12:16:26 +0000123 TEAM_OPTION_TYPE_BINARY,
Jiri Pirko14f066b2012-04-10 05:15:43 +0000124 TEAM_OPTION_TYPE_BOOL,
Jiri Pirko69821632012-07-27 06:28:53 +0000125 TEAM_OPTION_TYPE_S32,
Jiri Pirko3d249d42011-11-11 22:16:48 +0000126};
127
Jiri Pirko85d59a82012-06-19 05:54:10 +0000128struct team_option_inst_info {
129 u32 array_index;
130 struct team_port *port; /* != NULL if per-port */
131};
132
Jiri Pirko80f7c662012-04-10 05:15:42 +0000133struct team_gsetter_ctx {
134 union {
135 u32 u32_val;
136 const char *str_val;
137 struct {
138 const void *ptr;
139 u32 len;
140 } bin_val;
Jiri Pirko14f066b2012-04-10 05:15:43 +0000141 bool bool_val;
Jiri Pirko69821632012-07-27 06:28:53 +0000142 s32 s32_val;
Jiri Pirko80f7c662012-04-10 05:15:42 +0000143 } data;
Jiri Pirko85d59a82012-06-19 05:54:10 +0000144 struct team_option_inst_info *info;
Jiri Pirko80f7c662012-04-10 05:15:42 +0000145};
146
Jiri Pirko3d249d42011-11-11 22:16:48 +0000147struct team_option {
148 struct list_head list;
149 const char *name;
Jiri Pirko80f7c662012-04-10 05:15:42 +0000150 bool per_port;
Jiri Pirkob1303322012-06-19 05:54:08 +0000151 unsigned int array_size; /* != 0 means the option is array */
Jiri Pirko3d249d42011-11-11 22:16:48 +0000152 enum team_option_type type;
Jiri Pirko85d59a82012-06-19 05:54:10 +0000153 int (*init)(struct team *team, struct team_option_inst_info *info);
Jiri Pirko80f7c662012-04-10 05:15:42 +0000154 int (*getter)(struct team *team, struct team_gsetter_ctx *ctx);
155 int (*setter)(struct team *team, struct team_gsetter_ctx *ctx);
Jiri Pirko3d249d42011-11-11 22:16:48 +0000156};
157
Jiri Pirko0f1aad22012-06-19 05:54:11 +0000158extern void team_option_inst_set_change(struct team_option_inst_info *opt_inst_info);
159extern void team_options_change_check(struct team *team);
160
Jiri Pirko3d249d42011-11-11 22:16:48 +0000161struct team_mode {
Jiri Pirko3d249d42011-11-11 22:16:48 +0000162 const char *kind;
163 struct module *owner;
164 size_t priv_size;
Jiri Pirko5149ee52012-06-19 05:54:05 +0000165 size_t port_priv_size;
Jiri Pirko3d249d42011-11-11 22:16:48 +0000166 const struct team_mode_ops *ops;
167};
168
169#define TEAM_PORT_HASHBITS 4
170#define TEAM_PORT_HASHENTRIES (1 << TEAM_PORT_HASHBITS)
171
172#define TEAM_MODE_PRIV_LONGS 4
173#define TEAM_MODE_PRIV_SIZE (sizeof(long) * TEAM_MODE_PRIV_LONGS)
174
175struct team {
176 struct net_device *dev; /* associated netdevice */
177 struct team_pcpu_stats __percpu *pcpu_stats;
178
Jiri Pirko61dc3462011-11-16 11:09:08 +0000179 struct mutex lock; /* used for overall locking, e.g. port lists write */
Jiri Pirko3d249d42011-11-11 22:16:48 +0000180
181 /*
Jiri Pirko19a0b582012-04-20 04:42:05 +0000182 * List of enabled ports and their count
Jiri Pirko3d249d42011-11-11 22:16:48 +0000183 */
Jiri Pirko19a0b582012-04-20 04:42:05 +0000184 int en_port_count;
185 struct hlist_head en_port_hlist[TEAM_PORT_HASHENTRIES];
186
187 struct list_head port_list; /* list of all ports */
Jiri Pirko3d249d42011-11-11 22:16:48 +0000188
189 struct list_head option_list;
Jiri Pirko80f7c662012-04-10 05:15:42 +0000190 struct list_head option_inst_list; /* list of option instances */
Jiri Pirko3d249d42011-11-11 22:16:48 +0000191
192 const struct team_mode *mode;
193 struct team_mode_ops ops;
Flavio Leitnere1854832013-02-05 09:30:55 +0000194 bool user_carrier_enabled;
Jiri Pirko8ff51052012-07-27 06:28:55 +0000195 bool queue_override_enabled;
196 struct list_head *qom_lists; /* array of queue override mapping lists */
Jiri Pirko9d0d68f2014-05-29 20:46:17 +0200197 bool port_mtu_change_allowed;
Jiri Pirkofc423ff2013-07-20 12:13:52 +0200198 struct {
199 unsigned int count;
200 unsigned int interval; /* in ms */
201 atomic_t count_pending;
202 struct delayed_work dw;
203 } notify_peers;
Jiri Pirko492b2002013-07-20 12:13:54 +0200204 struct {
205 unsigned int count;
206 unsigned int interval; /* in ms */
207 atomic_t count_pending;
208 struct delayed_work dw;
209 } mcast_rejoin;
Jiri Pirko3d249d42011-11-11 22:16:48 +0000210 long mode_priv[TEAM_MODE_PRIV_LONGS];
211};
212
Amerigo Wange15c3c222012-08-10 01:24:45 +0000213static inline int team_dev_queue_xmit(struct team *team, struct team_port *port,
214 struct sk_buff *skb)
215{
216 BUILD_BUG_ON(sizeof(skb->queue_mapping) !=
217 sizeof(qdisc_skb_cb(skb)->slave_dev_queue_mapping));
218 skb_set_queue_mapping(skb, qdisc_skb_cb(skb)->slave_dev_queue_mapping);
219
220 skb->dev = port->dev;
221 if (unlikely(netpoll_tx_running(team->dev))) {
222 team_netpoll_send_skb(port, skb);
223 return 0;
224 }
225 return dev_queue_xmit(skb);
226}
227
Jiri Pirko3d249d42011-11-11 22:16:48 +0000228static inline struct hlist_head *team_port_index_hash(struct team *team,
229 int port_index)
230{
Jiri Pirko19a0b582012-04-20 04:42:05 +0000231 return &team->en_port_hlist[port_index & (TEAM_PORT_HASHENTRIES - 1)];
Jiri Pirko3d249d42011-11-11 22:16:48 +0000232}
233
234static inline struct team_port *team_get_port_by_index(struct team *team,
235 int port_index)
236{
Jiri Pirko3d249d42011-11-11 22:16:48 +0000237 struct team_port *port;
238 struct hlist_head *head = team_port_index_hash(team, port_index);
239
Sasha Levinb67bfe02013-02-27 17:06:00 -0800240 hlist_for_each_entry(port, head, hlist)
Jiri Pirko3d249d42011-11-11 22:16:48 +0000241 if (port->index == port_index)
242 return port;
243 return NULL;
244}
Jiri Pirko735d3812013-06-10 17:42:25 +0200245
246static inline int team_num_to_port_index(struct team *team, int num)
247{
248 int en_port_count = ACCESS_ONCE(team->en_port_count);
249
250 if (unlikely(!en_port_count))
251 return 0;
252 return num % en_port_count;
253}
254
Jiri Pirko3d249d42011-11-11 22:16:48 +0000255static inline struct team_port *team_get_port_by_index_rcu(struct team *team,
256 int port_index)
257{
Jiri Pirko3d249d42011-11-11 22:16:48 +0000258 struct team_port *port;
259 struct hlist_head *head = team_port_index_hash(team, port_index);
260
Sasha Levinb67bfe02013-02-27 17:06:00 -0800261 hlist_for_each_entry_rcu(port, head, hlist)
Jiri Pirko3d249d42011-11-11 22:16:48 +0000262 if (port->index == port_index)
263 return port;
264 return NULL;
265}
266
Jiri Pirko753f9932013-03-06 01:31:13 +0000267static inline struct team_port *
268team_get_first_port_txable_rcu(struct team *team, struct team_port *port)
269{
270 struct team_port *cur;
271
272 if (likely(team_port_txable(port)))
273 return port;
274 cur = port;
275 list_for_each_entry_continue_rcu(cur, &team->port_list, list)
Jiri Pirkob79462a2013-06-08 15:00:55 +0200276 if (team_port_txable(cur))
Jiri Pirko753f9932013-03-06 01:31:13 +0000277 return cur;
278 list_for_each_entry_rcu(cur, &team->port_list, list) {
279 if (cur == port)
280 break;
Jiri Pirkob79462a2013-06-08 15:00:55 +0200281 if (team_port_txable(cur))
Jiri Pirko753f9932013-03-06 01:31:13 +0000282 return cur;
283 }
284 return NULL;
285}
286
Jiri Pirko358b8382011-11-16 11:09:09 +0000287extern int team_options_register(struct team *team,
288 const struct team_option *option,
289 size_t option_count);
Jiri Pirko3d249d42011-11-11 22:16:48 +0000290extern void team_options_unregister(struct team *team,
Jiri Pirko358b8382011-11-16 11:09:09 +0000291 const struct team_option *option,
Jiri Pirko3d249d42011-11-11 22:16:48 +0000292 size_t option_count);
Jiri Pirko04027882012-06-19 05:54:03 +0000293extern int team_mode_register(const struct team_mode *mode);
294extern void team_mode_unregister(const struct team_mode *mode);
Jiri Pirko3d249d42011-11-11 22:16:48 +0000295
Jiri Pirko6c85f2b2012-07-20 02:28:51 +0000296#define TEAM_DEFAULT_NUM_TX_QUEUES 16
297#define TEAM_DEFAULT_NUM_RX_QUEUES 16
298
Jiri Pirko3d249d42011-11-11 22:16:48 +0000299#endif /* _LINUX_IF_TEAM_H_ */