1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * include/linux/if_team.h - Network team device driver header
4 * Copyright (c) 2011 Jiri Pirko <jpirko@redhat.com>
6 #ifndef _LINUX_IF_TEAM_H_
7 #define _LINUX_IF_TEAM_H_
9 #include <linux/netpoll.h>
10 #include <net/sch_generic.h>
11 #include <linux/types.h>
12 #include <uapi/linux/if_team.h>
14 struct team_pcpu_stats {
15 u64_stats_t rx_packets;
17 u64_stats_t rx_multicast;
18 u64_stats_t tx_packets;
20 struct u64_stats_sync syncp;
29 struct net_device *dev;
30 struct hlist_node hlist; /* node in enabled ports hash list */
31 struct list_head list; /* node in ordinary list */
33 int index; /* index of enabled port. If disabled, it's set to -1 */
35 bool linkup; /* either state.linkup or user.linkup */
43 /* Values set by userspace */
49 /* Custom gennetlink interface related flags */
54 * A place for storing original values of the device before it
58 unsigned char dev_addr[MAX_ADDR_LEN];
62 #ifdef CONFIG_NET_POLL_CONTROLLER
66 s32 priority; /* lower number ~ higher priority */
68 struct list_head qom_list; /* node in queue override mapping list */
73 static inline struct team_port *team_port_get_rcu(const struct net_device *dev)
75 return rcu_dereference(dev->rx_handler_data);
78 static inline bool team_port_enabled(struct team_port *port)
80 return port->index != -1;
83 static inline bool team_port_txable(struct team_port *port)
85 return port->linkup && team_port_enabled(port);
88 static inline bool team_port_dev_txable(const struct net_device *port_dev)
90 struct team_port *port;
94 port = team_port_get_rcu(port_dev);
95 txable = port ? team_port_txable(port) : false;
101 #ifdef CONFIG_NET_POLL_CONTROLLER
102 static inline void team_netpoll_send_skb(struct team_port *port,
105 netpoll_send_skb(port->np, skb);
108 static inline void team_netpoll_send_skb(struct team_port *port,
114 struct team_mode_ops {
115 int (*init)(struct team *team);
116 void (*exit)(struct team *team);
117 rx_handler_result_t (*receive)(struct team *team,
118 struct team_port *port,
119 struct sk_buff *skb);
120 bool (*transmit)(struct team *team, struct sk_buff *skb);
121 int (*port_enter)(struct team *team, struct team_port *port);
122 void (*port_leave)(struct team *team, struct team_port *port);
123 void (*port_change_dev_addr)(struct team *team, struct team_port *port);
124 void (*port_enabled)(struct team *team, struct team_port *port);
125 void (*port_disabled)(struct team *team, struct team_port *port);
128 extern int team_modeop_port_enter(struct team *team, struct team_port *port);
129 extern void team_modeop_port_change_dev_addr(struct team *team,
130 struct team_port *port);
132 enum team_option_type {
133 TEAM_OPTION_TYPE_U32,
134 TEAM_OPTION_TYPE_STRING,
135 TEAM_OPTION_TYPE_BINARY,
136 TEAM_OPTION_TYPE_BOOL,
137 TEAM_OPTION_TYPE_S32,
140 struct team_option_inst_info {
142 struct team_port *port; /* != NULL if per-port */
145 struct team_gsetter_ctx {
156 struct team_option_inst_info *info;
160 struct list_head list;
163 unsigned int array_size; /* != 0 means the option is array */
164 enum team_option_type type;
165 void (*init)(struct team *team, struct team_option_inst_info *info);
166 void (*getter)(struct team *team, struct team_gsetter_ctx *ctx);
167 int (*setter)(struct team *team, struct team_gsetter_ctx *ctx);
170 extern void team_option_inst_set_change(struct team_option_inst_info *opt_inst_info);
171 extern void team_options_change_check(struct team *team);
175 struct module *owner;
177 size_t port_priv_size;
178 const struct team_mode_ops *ops;
179 enum netdev_lag_tx_type lag_tx_type;
182 #define TEAM_PORT_HASHBITS 4
183 #define TEAM_PORT_HASHENTRIES (1 << TEAM_PORT_HASHBITS)
185 #define TEAM_MODE_PRIV_LONGS 4
186 #define TEAM_MODE_PRIV_SIZE (sizeof(long) * TEAM_MODE_PRIV_LONGS)
189 struct net_device *dev; /* associated netdevice */
190 struct team_pcpu_stats __percpu *pcpu_stats;
192 struct mutex lock; /* used for overall locking, e.g. port lists write */
195 * List of enabled ports and their count
198 struct hlist_head en_port_hlist[TEAM_PORT_HASHENTRIES];
200 struct list_head port_list; /* list of all ports */
202 struct list_head option_list;
203 struct list_head option_inst_list; /* list of option instances */
205 const struct team_mode *mode;
206 struct team_mode_ops ops;
207 bool user_carrier_enabled;
208 bool queue_override_enabled;
209 struct list_head *qom_lists; /* array of queue override mapping lists */
210 bool port_mtu_change_allowed;
214 unsigned int interval; /* in ms */
215 atomic_t count_pending;
216 struct delayed_work dw;
220 unsigned int interval; /* in ms */
221 atomic_t count_pending;
222 struct delayed_work dw;
224 struct lock_class_key team_lock_key;
225 long mode_priv[TEAM_MODE_PRIV_LONGS];
228 static inline int team_dev_queue_xmit(struct team *team, struct team_port *port,
231 BUILD_BUG_ON(sizeof(skb->queue_mapping) !=
232 sizeof(qdisc_skb_cb(skb)->slave_dev_queue_mapping));
233 skb_set_queue_mapping(skb, qdisc_skb_cb(skb)->slave_dev_queue_mapping);
235 skb->dev = port->dev;
236 if (unlikely(netpoll_tx_running(team->dev))) {
237 team_netpoll_send_skb(port, skb);
240 return dev_queue_xmit(skb);
243 static inline struct hlist_head *team_port_index_hash(struct team *team,
246 return &team->en_port_hlist[port_index & (TEAM_PORT_HASHENTRIES - 1)];
249 static inline struct team_port *team_get_port_by_index(struct team *team,
252 struct team_port *port;
253 struct hlist_head *head = team_port_index_hash(team, port_index);
255 hlist_for_each_entry(port, head, hlist)
256 if (port->index == port_index)
261 static inline int team_num_to_port_index(struct team *team, unsigned int num)
263 int en_port_count = READ_ONCE(team->en_port_count);
265 if (unlikely(!en_port_count))
267 return num % en_port_count;
270 static inline struct team_port *team_get_port_by_index_rcu(struct team *team,
273 struct team_port *port;
274 struct hlist_head *head = team_port_index_hash(team, port_index);
276 hlist_for_each_entry_rcu(port, head, hlist)
277 if (port->index == port_index)
282 static inline struct team_port *
283 team_get_first_port_txable_rcu(struct team *team, struct team_port *port)
285 struct team_port *cur;
287 if (likely(team_port_txable(port)))
290 list_for_each_entry_continue_rcu(cur, &team->port_list, list)
291 if (team_port_txable(cur))
293 list_for_each_entry_rcu(cur, &team->port_list, list) {
296 if (team_port_txable(cur))
302 extern int team_options_register(struct team *team,
303 const struct team_option *option,
304 size_t option_count);
305 extern void team_options_unregister(struct team *team,
306 const struct team_option *option,
307 size_t option_count);
308 extern int team_mode_register(const struct team_mode *mode);
309 extern void team_mode_unregister(const struct team_mode *mode);
311 #define TEAM_DEFAULT_NUM_TX_QUEUES 16
312 #define TEAM_DEFAULT_NUM_RX_QUEUES 16
314 #define MODULE_ALIAS_TEAM_MODE(kind) MODULE_ALIAS("team-mode-" kind)
316 #endif /* _LINUX_IF_TEAM_H_ */