blob: d95cae09dea0873a0cb119e63f5c3d6d7c73d823 [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;
Jarod Wilsonbb63daf2016-02-01 18:51:06 -050027 u32 rx_nohandler;
Jiri Pirko3d249d42011-11-11 22:16:48 +000028};
29
30struct team;
31
32struct team_port {
33 struct net_device *dev;
Jiri Pirko19a0b582012-04-20 04:42:05 +000034 struct hlist_node hlist; /* node in enabled ports hash list */
Jiri Pirko3d249d42011-11-11 22:16:48 +000035 struct list_head list; /* node in ordinary list */
36 struct team *team;
Jiri Pirko19a0b582012-04-20 04:42:05 +000037 int index; /* index of enabled port. If disabled, it's set to -1 */
Jiri Pirko3d249d42011-11-11 22:16:48 +000038
Jiri Pirko71472ec2012-04-10 05:15:44 +000039 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
Jiri Pirko3d249d42011-11-11 22:16:48 +000057 /*
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
Jiri Pirkobd2d0832012-07-17 05:22:36 +000066#ifdef CONFIG_NET_POLL_CONTROLLER
67 struct netpoll *np;
68#endif
69
Jiri Pirkoa86fc6b2012-07-27 06:28:54 +000070 s32 priority; /* lower number ~ higher priority */
Jiri Pirko8ff51052012-07-27 06:28:55 +000071 u16 queue_id;
72 struct list_head qom_list; /* node in queue override mapping list */
Jiri Pirkod80b35b2013-06-10 17:42:24 +020073 struct rcu_head rcu;
Jiri Pirko5149ee52012-06-19 05:54:05 +000074 long mode_priv[0];
Jiri Pirko3d249d42011-11-11 22:16:48 +000075};
76
Jiri Pirko68c45042012-07-11 05:34:04 +000077static inline bool team_port_enabled(struct team_port *port)
78{
79 return port->index != -1;
80}
81
82static inline bool team_port_txable(struct team_port *port)
83{
84 return port->linkup && team_port_enabled(port);
85}
Jiri Pirko52a4fd72012-06-26 06:52:46 +000086
Jiri Pirkobd2d0832012-07-17 05:22:36 +000087#ifdef CONFIG_NET_POLL_CONTROLLER
88static inline void team_netpoll_send_skb(struct team_port *port,
89 struct sk_buff *skb)
90{
91 struct netpoll *np = port->np;
92
93 if (np)
94 netpoll_send_skb(np, skb);
95}
96#else
97static inline void team_netpoll_send_skb(struct team_port *port,
98 struct sk_buff *skb)
99{
100}
101#endif
102
Jiri Pirko3d249d42011-11-11 22:16:48 +0000103struct team_mode_ops {
104 int (*init)(struct team *team);
105 void (*exit)(struct team *team);
106 rx_handler_result_t (*receive)(struct team *team,
107 struct team_port *port,
108 struct sk_buff *skb);
109 bool (*transmit)(struct team *team, struct sk_buff *skb);
110 int (*port_enter)(struct team *team, struct team_port *port);
111 void (*port_leave)(struct team *team, struct team_port *port);
Jiri Pirko1d76efe2012-08-17 04:00:48 +0000112 void (*port_change_dev_addr)(struct team *team, struct team_port *port);
Jiri Pirko4bccfd12012-06-19 05:54:16 +0000113 void (*port_enabled)(struct team *team, struct team_port *port);
114 void (*port_disabled)(struct team *team, struct team_port *port);
Jiri Pirko3d249d42011-11-11 22:16:48 +0000115};
116
Jiri Pirkoacbba0d2013-03-06 01:31:12 +0000117extern int team_modeop_port_enter(struct team *team, struct team_port *port);
118extern void team_modeop_port_change_dev_addr(struct team *team,
119 struct team_port *port);
120
Jiri Pirko3d249d42011-11-11 22:16:48 +0000121enum team_option_type {
122 TEAM_OPTION_TYPE_U32,
123 TEAM_OPTION_TYPE_STRING,
Jiri Pirko26155982012-04-04 12:16:26 +0000124 TEAM_OPTION_TYPE_BINARY,
Jiri Pirko14f066b2012-04-10 05:15:43 +0000125 TEAM_OPTION_TYPE_BOOL,
Jiri Pirko69821632012-07-27 06:28:53 +0000126 TEAM_OPTION_TYPE_S32,
Jiri Pirko3d249d42011-11-11 22:16:48 +0000127};
128
Jiri Pirko85d59a82012-06-19 05:54:10 +0000129struct team_option_inst_info {
130 u32 array_index;
131 struct team_port *port; /* != NULL if per-port */
132};
133
Jiri Pirko80f7c662012-04-10 05:15:42 +0000134struct team_gsetter_ctx {
135 union {
136 u32 u32_val;
137 const char *str_val;
138 struct {
139 const void *ptr;
140 u32 len;
141 } bin_val;
Jiri Pirko14f066b2012-04-10 05:15:43 +0000142 bool bool_val;
Jiri Pirko69821632012-07-27 06:28:53 +0000143 s32 s32_val;
Jiri Pirko80f7c662012-04-10 05:15:42 +0000144 } data;
Jiri Pirko85d59a82012-06-19 05:54:10 +0000145 struct team_option_inst_info *info;
Jiri Pirko80f7c662012-04-10 05:15:42 +0000146};
147
Jiri Pirko3d249d42011-11-11 22:16:48 +0000148struct team_option {
149 struct list_head list;
150 const char *name;
Jiri Pirko80f7c662012-04-10 05:15:42 +0000151 bool per_port;
Jiri Pirkob1303322012-06-19 05:54:08 +0000152 unsigned int array_size; /* != 0 means the option is array */
Jiri Pirko3d249d42011-11-11 22:16:48 +0000153 enum team_option_type type;
Jiri Pirko85d59a82012-06-19 05:54:10 +0000154 int (*init)(struct team *team, struct team_option_inst_info *info);
Jiri Pirko80f7c662012-04-10 05:15:42 +0000155 int (*getter)(struct team *team, struct team_gsetter_ctx *ctx);
156 int (*setter)(struct team *team, struct team_gsetter_ctx *ctx);
Jiri Pirko3d249d42011-11-11 22:16:48 +0000157};
158
Jiri Pirko0f1aad22012-06-19 05:54:11 +0000159extern void team_option_inst_set_change(struct team_option_inst_info *opt_inst_info);
160extern void team_options_change_check(struct team *team);
161
Jiri Pirko3d249d42011-11-11 22:16:48 +0000162struct team_mode {
Jiri Pirko3d249d42011-11-11 22:16:48 +0000163 const char *kind;
164 struct module *owner;
165 size_t priv_size;
Jiri Pirko5149ee52012-06-19 05:54:05 +0000166 size_t port_priv_size;
Jiri Pirko3d249d42011-11-11 22:16:48 +0000167 const struct team_mode_ops *ops;
Jiri Pirko8fd72852015-12-03 12:12:13 +0100168 enum netdev_lag_tx_type lag_tx_type;
Jiri Pirko3d249d42011-11-11 22:16:48 +0000169};
170
171#define TEAM_PORT_HASHBITS 4
172#define TEAM_PORT_HASHENTRIES (1 << TEAM_PORT_HASHBITS)
173
174#define TEAM_MODE_PRIV_LONGS 4
175#define TEAM_MODE_PRIV_SIZE (sizeof(long) * TEAM_MODE_PRIV_LONGS)
176
177struct team {
178 struct net_device *dev; /* associated netdevice */
179 struct team_pcpu_stats __percpu *pcpu_stats;
180
Jiri Pirko61dc3462011-11-16 11:09:08 +0000181 struct mutex lock; /* used for overall locking, e.g. port lists write */
Jiri Pirko3d249d42011-11-11 22:16:48 +0000182
183 /*
Jiri Pirko19a0b582012-04-20 04:42:05 +0000184 * List of enabled ports and their count
Jiri Pirko3d249d42011-11-11 22:16:48 +0000185 */
Jiri Pirko19a0b582012-04-20 04:42:05 +0000186 int en_port_count;
187 struct hlist_head en_port_hlist[TEAM_PORT_HASHENTRIES];
188
189 struct list_head port_list; /* list of all ports */
Jiri Pirko3d249d42011-11-11 22:16:48 +0000190
191 struct list_head option_list;
Jiri Pirko80f7c662012-04-10 05:15:42 +0000192 struct list_head option_inst_list; /* list of option instances */
Jiri Pirko3d249d42011-11-11 22:16:48 +0000193
194 const struct team_mode *mode;
195 struct team_mode_ops ops;
Flavio Leitnere1854832013-02-05 09:30:55 +0000196 bool user_carrier_enabled;
Jiri Pirko8ff51052012-07-27 06:28:55 +0000197 bool queue_override_enabled;
198 struct list_head *qom_lists; /* array of queue override mapping lists */
Jiri Pirko9d0d68f2014-05-29 20:46:17 +0200199 bool port_mtu_change_allowed;
Jiri Pirkofc423ff2013-07-20 12:13:52 +0200200 struct {
201 unsigned int count;
202 unsigned int interval; /* in ms */
203 atomic_t count_pending;
204 struct delayed_work dw;
205 } notify_peers;
Jiri Pirko492b2002013-07-20 12:13:54 +0200206 struct {
207 unsigned int count;
208 unsigned int interval; /* in ms */
209 atomic_t count_pending;
210 struct delayed_work dw;
211 } mcast_rejoin;
Jiri Pirko3d249d42011-11-11 22:16:48 +0000212 long mode_priv[TEAM_MODE_PRIV_LONGS];
213};
214
Amerigo Wange15c3c222012-08-10 01:24:45 +0000215static inline int team_dev_queue_xmit(struct team *team, struct team_port *port,
216 struct sk_buff *skb)
217{
218 BUILD_BUG_ON(sizeof(skb->queue_mapping) !=
219 sizeof(qdisc_skb_cb(skb)->slave_dev_queue_mapping));
220 skb_set_queue_mapping(skb, qdisc_skb_cb(skb)->slave_dev_queue_mapping);
221
222 skb->dev = port->dev;
223 if (unlikely(netpoll_tx_running(team->dev))) {
224 team_netpoll_send_skb(port, skb);
225 return 0;
226 }
227 return dev_queue_xmit(skb);
228}
229
Jiri Pirko3d249d42011-11-11 22:16:48 +0000230static inline struct hlist_head *team_port_index_hash(struct team *team,
231 int port_index)
232{
Jiri Pirko19a0b582012-04-20 04:42:05 +0000233 return &team->en_port_hlist[port_index & (TEAM_PORT_HASHENTRIES - 1)];
Jiri Pirko3d249d42011-11-11 22:16:48 +0000234}
235
236static inline struct team_port *team_get_port_by_index(struct team *team,
237 int port_index)
238{
Jiri Pirko3d249d42011-11-11 22:16:48 +0000239 struct team_port *port;
240 struct hlist_head *head = team_port_index_hash(team, port_index);
241
Sasha Levinb67bfe02013-02-27 17:06:00 -0800242 hlist_for_each_entry(port, head, hlist)
Jiri Pirko3d249d42011-11-11 22:16:48 +0000243 if (port->index == port_index)
244 return port;
245 return NULL;
246}
Jiri Pirko735d3812013-06-10 17:42:25 +0200247
Alex Sidorenko21d96292016-10-07 09:02:33 -0400248static inline int team_num_to_port_index(struct team *team, unsigned int num)
Jiri Pirko735d3812013-06-10 17:42:25 +0200249{
Mark Rutland6aa7de02017-10-23 14:07:29 -0700250 int en_port_count = READ_ONCE(team->en_port_count);
Jiri Pirko735d3812013-06-10 17:42:25 +0200251
252 if (unlikely(!en_port_count))
253 return 0;
254 return num % en_port_count;
255}
256
Jiri Pirko3d249d42011-11-11 22:16:48 +0000257static inline struct team_port *team_get_port_by_index_rcu(struct team *team,
258 int port_index)
259{
Jiri Pirko3d249d42011-11-11 22:16:48 +0000260 struct team_port *port;
261 struct hlist_head *head = team_port_index_hash(team, port_index);
262
Sasha Levinb67bfe02013-02-27 17:06:00 -0800263 hlist_for_each_entry_rcu(port, head, hlist)
Jiri Pirko3d249d42011-11-11 22:16:48 +0000264 if (port->index == port_index)
265 return port;
266 return NULL;
267}
268
Jiri Pirko753f9932013-03-06 01:31:13 +0000269static inline struct team_port *
270team_get_first_port_txable_rcu(struct team *team, struct team_port *port)
271{
272 struct team_port *cur;
273
274 if (likely(team_port_txable(port)))
275 return port;
276 cur = port;
277 list_for_each_entry_continue_rcu(cur, &team->port_list, list)
Jiri Pirkob79462a2013-06-08 15:00:55 +0200278 if (team_port_txable(cur))
Jiri Pirko753f9932013-03-06 01:31:13 +0000279 return cur;
280 list_for_each_entry_rcu(cur, &team->port_list, list) {
281 if (cur == port)
282 break;
Jiri Pirkob79462a2013-06-08 15:00:55 +0200283 if (team_port_txable(cur))
Jiri Pirko753f9932013-03-06 01:31:13 +0000284 return cur;
285 }
286 return NULL;
287}
288
Jiri Pirko358b8382011-11-16 11:09:09 +0000289extern int team_options_register(struct team *team,
290 const struct team_option *option,
291 size_t option_count);
Jiri Pirko3d249d42011-11-11 22:16:48 +0000292extern void team_options_unregister(struct team *team,
Jiri Pirko358b8382011-11-16 11:09:09 +0000293 const struct team_option *option,
Jiri Pirko3d249d42011-11-11 22:16:48 +0000294 size_t option_count);
Jiri Pirko04027882012-06-19 05:54:03 +0000295extern int team_mode_register(const struct team_mode *mode);
296extern void team_mode_unregister(const struct team_mode *mode);
Jiri Pirko3d249d42011-11-11 22:16:48 +0000297
Jiri Pirko6c85f2b2012-07-20 02:28:51 +0000298#define TEAM_DEFAULT_NUM_TX_QUEUES 16
299#define TEAM_DEFAULT_NUM_RX_QUEUES 16
300
Zhang Shengju3a5f8992017-06-01 15:37:02 +0800301#define MODULE_ALIAS_TEAM_MODE(kind) MODULE_ALIAS("team-mode-" kind)
302
Jiri Pirko3d249d42011-11-11 22:16:48 +0000303#endif /* _LINUX_IF_TEAM_H_ */