2 * include/linux/if_team.h - Network team device driver header
3 * Copyright (c) 2011 Jiri Pirko <jpirko@redhat.com>
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.
11 #ifndef _LINUX_IF_TEAM_H_
12 #define _LINUX_IF_TEAM_H_
16 #include <linux/netpoll.h>
17 #include <net/sch_generic.h>
19 struct team_pcpu_stats {
25 struct u64_stats_sync syncp;
33 struct net_device *dev;
34 struct hlist_node hlist; /* node in enabled ports hash list */
35 struct list_head list; /* node in ordinary list */
37 int index; /* index of enabled port. If disabled, it's set to -1 */
39 bool linkup; /* either state.linkup or user.linkup */
47 /* Values set by userspace */
53 /* Custom gennetlink interface related flags */
58 * A place for storing original values of the device before it
62 unsigned char dev_addr[MAX_ADDR_LEN];
66 #ifdef CONFIG_NET_POLL_CONTROLLER
70 s32 priority; /* lower number ~ higher priority */
72 struct list_head qom_list; /* node in queue override mapping list */
76 static inline bool team_port_enabled(struct team_port *port)
78 return port->index != -1;
81 static inline bool team_port_txable(struct team_port *port)
83 return port->linkup && team_port_enabled(port);
86 #ifdef CONFIG_NET_POLL_CONTROLLER
87 static inline void team_netpoll_send_skb(struct team_port *port,
90 struct netpoll *np = port->np;
93 netpoll_send_skb(np, skb);
96 static inline void team_netpoll_send_skb(struct team_port *port,
102 struct 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);
111 void (*port_change_dev_addr)(struct team *team, struct team_port *port);
112 void (*port_enabled)(struct team *team, struct team_port *port);
113 void (*port_disabled)(struct team *team, struct team_port *port);
116 enum team_option_type {
117 TEAM_OPTION_TYPE_U32,
118 TEAM_OPTION_TYPE_STRING,
119 TEAM_OPTION_TYPE_BINARY,
120 TEAM_OPTION_TYPE_BOOL,
121 TEAM_OPTION_TYPE_S32,
124 struct team_option_inst_info {
126 struct team_port *port; /* != NULL if per-port */
129 struct team_gsetter_ctx {
140 struct team_option_inst_info *info;
144 struct list_head list;
147 unsigned int array_size; /* != 0 means the option is array */
148 enum team_option_type type;
149 int (*init)(struct team *team, struct team_option_inst_info *info);
150 int (*getter)(struct team *team, struct team_gsetter_ctx *ctx);
151 int (*setter)(struct team *team, struct team_gsetter_ctx *ctx);
154 extern void team_option_inst_set_change(struct team_option_inst_info *opt_inst_info);
155 extern void team_options_change_check(struct team *team);
159 struct module *owner;
161 size_t port_priv_size;
162 const struct team_mode_ops *ops;
165 #define TEAM_PORT_HASHBITS 4
166 #define TEAM_PORT_HASHENTRIES (1 << TEAM_PORT_HASHBITS)
168 #define TEAM_MODE_PRIV_LONGS 4
169 #define TEAM_MODE_PRIV_SIZE (sizeof(long) * TEAM_MODE_PRIV_LONGS)
172 struct net_device *dev; /* associated netdevice */
173 struct team_pcpu_stats __percpu *pcpu_stats;
175 struct mutex lock; /* used for overall locking, e.g. port lists write */
178 * List of enabled ports and their count
181 struct hlist_head en_port_hlist[TEAM_PORT_HASHENTRIES];
183 struct list_head port_list; /* list of all ports */
185 struct list_head option_list;
186 struct list_head option_inst_list; /* list of option instances */
188 const struct team_mode *mode;
189 struct team_mode_ops ops;
190 bool queue_override_enabled;
191 struct list_head *qom_lists; /* array of queue override mapping lists */
192 long mode_priv[TEAM_MODE_PRIV_LONGS];
195 static inline int team_dev_queue_xmit(struct team *team, struct team_port *port,
198 BUILD_BUG_ON(sizeof(skb->queue_mapping) !=
199 sizeof(qdisc_skb_cb(skb)->slave_dev_queue_mapping));
200 skb_set_queue_mapping(skb, qdisc_skb_cb(skb)->slave_dev_queue_mapping);
202 skb->dev = port->dev;
203 if (unlikely(netpoll_tx_running(team->dev))) {
204 team_netpoll_send_skb(port, skb);
207 return dev_queue_xmit(skb);
210 static inline struct hlist_head *team_port_index_hash(struct team *team,
213 return &team->en_port_hlist[port_index & (TEAM_PORT_HASHENTRIES - 1)];
216 static inline struct team_port *team_get_port_by_index(struct team *team,
219 struct hlist_node *p;
220 struct team_port *port;
221 struct hlist_head *head = team_port_index_hash(team, port_index);
223 hlist_for_each_entry(port, p, head, hlist)
224 if (port->index == port_index)
228 static inline struct team_port *team_get_port_by_index_rcu(struct team *team,
231 struct hlist_node *p;
232 struct team_port *port;
233 struct hlist_head *head = team_port_index_hash(team, port_index);
235 hlist_for_each_entry_rcu(port, p, head, hlist)
236 if (port->index == port_index)
241 extern int team_port_set_team_dev_addr(struct team_port *port);
242 extern int team_options_register(struct team *team,
243 const struct team_option *option,
244 size_t option_count);
245 extern void team_options_unregister(struct team *team,
246 const struct team_option *option,
247 size_t option_count);
248 extern int team_mode_register(const struct team_mode *mode);
249 extern void team_mode_unregister(const struct team_mode *mode);
251 #define TEAM_DEFAULT_NUM_TX_QUEUES 16
252 #define TEAM_DEFAULT_NUM_RX_QUEUES 16
254 #endif /* __KERNEL__ */
256 #define TEAM_STRING_MAX_LEN 32
258 /**********************************
259 * NETLINK_GENERIC netlink family.
260 **********************************/
264 TEAM_CMD_OPTIONS_SET,
265 TEAM_CMD_OPTIONS_GET,
266 TEAM_CMD_PORT_LIST_GET,
269 TEAM_CMD_MAX = (__TEAM_CMD_MAX - 1),
274 TEAM_ATTR_TEAM_IFINDEX, /* u32 */
275 TEAM_ATTR_LIST_OPTION, /* nest */
276 TEAM_ATTR_LIST_PORT, /* nest */
279 TEAM_ATTR_MAX = __TEAM_ATTR_MAX - 1,
282 /* Nested layout of get/set msg:
284 * [TEAM_ATTR_LIST_OPTION]
285 * [TEAM_ATTR_ITEM_OPTION]
286 * [TEAM_ATTR_OPTION_*], ...
287 * [TEAM_ATTR_ITEM_OPTION]
288 * [TEAM_ATTR_OPTION_*], ...
290 * [TEAM_ATTR_LIST_PORT]
291 * [TEAM_ATTR_ITEM_PORT]
292 * [TEAM_ATTR_PORT_*], ...
293 * [TEAM_ATTR_ITEM_PORT]
294 * [TEAM_ATTR_PORT_*], ...
299 TEAM_ATTR_ITEM_OPTION_UNSPEC,
300 TEAM_ATTR_ITEM_OPTION, /* nest */
302 __TEAM_ATTR_ITEM_OPTION_MAX,
303 TEAM_ATTR_ITEM_OPTION_MAX = __TEAM_ATTR_ITEM_OPTION_MAX - 1,
307 TEAM_ATTR_OPTION_UNSPEC,
308 TEAM_ATTR_OPTION_NAME, /* string */
309 TEAM_ATTR_OPTION_CHANGED, /* flag */
310 TEAM_ATTR_OPTION_TYPE, /* u8 */
311 TEAM_ATTR_OPTION_DATA, /* dynamic */
312 TEAM_ATTR_OPTION_REMOVED, /* flag */
313 TEAM_ATTR_OPTION_PORT_IFINDEX, /* u32 */ /* for per-port options */
314 TEAM_ATTR_OPTION_ARRAY_INDEX, /* u32 */ /* for array options */
316 __TEAM_ATTR_OPTION_MAX,
317 TEAM_ATTR_OPTION_MAX = __TEAM_ATTR_OPTION_MAX - 1,
321 TEAM_ATTR_ITEM_PORT_UNSPEC,
322 TEAM_ATTR_ITEM_PORT, /* nest */
324 __TEAM_ATTR_ITEM_PORT_MAX,
325 TEAM_ATTR_ITEM_PORT_MAX = __TEAM_ATTR_ITEM_PORT_MAX - 1,
329 TEAM_ATTR_PORT_UNSPEC,
330 TEAM_ATTR_PORT_IFINDEX, /* u32 */
331 TEAM_ATTR_PORT_CHANGED, /* flag */
332 TEAM_ATTR_PORT_LINKUP, /* flag */
333 TEAM_ATTR_PORT_SPEED, /* u32 */
334 TEAM_ATTR_PORT_DUPLEX, /* u8 */
335 TEAM_ATTR_PORT_REMOVED, /* flag */
337 __TEAM_ATTR_PORT_MAX,
338 TEAM_ATTR_PORT_MAX = __TEAM_ATTR_PORT_MAX - 1,
342 * NETLINK_GENERIC related info
344 #define TEAM_GENL_NAME "team"
345 #define TEAM_GENL_VERSION 0x1
346 #define TEAM_GENL_CHANGE_EVENT_MC_GRP_NAME "change_event"
348 #endif /* _LINUX_IF_TEAM_H_ */