Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 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 | */ |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 10 | #ifndef _LINUX_IF_TEAM_H_ |
| 11 | #define _LINUX_IF_TEAM_H_ |
| 12 | |
Jiri Pirko | bd2d083 | 2012-07-17 05:22:36 +0000 | [diff] [blame] | 13 | #include <linux/netpoll.h> |
Jiri Pirko | 6c85f2b | 2012-07-20 02:28:51 +0000 | [diff] [blame] | 14 | #include <net/sch_generic.h> |
Jiri Pirko | fc423ff | 2013-07-20 12:13:52 +0200 | [diff] [blame] | 15 | #include <linux/types.h> |
David Howells | 607ca46 | 2012-10-13 10:46:48 +0100 | [diff] [blame] | 16 | #include <uapi/linux/if_team.h> |
Jiri Pirko | bd2d083 | 2012-07-17 05:22:36 +0000 | [diff] [blame] | 17 | |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 18 | struct 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 Wilson | bb63daf | 2016-02-01 18:51:06 -0500 | [diff] [blame] | 27 | u32 rx_nohandler; |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 28 | }; |
| 29 | |
| 30 | struct team; |
| 31 | |
| 32 | struct team_port { |
| 33 | struct net_device *dev; |
Jiri Pirko | 19a0b58 | 2012-04-20 04:42:05 +0000 | [diff] [blame] | 34 | struct hlist_node hlist; /* node in enabled ports hash list */ |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 35 | struct list_head list; /* node in ordinary list */ |
| 36 | struct team *team; |
Jiri Pirko | 19a0b58 | 2012-04-20 04:42:05 +0000 | [diff] [blame] | 37 | int index; /* index of enabled port. If disabled, it's set to -1 */ |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 38 | |
Jiri Pirko | 71472ec | 2012-04-10 05:15:44 +0000 | [diff] [blame] | 39 | 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 Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 57 | /* |
| 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 Pirko | bd2d083 | 2012-07-17 05:22:36 +0000 | [diff] [blame] | 66 | #ifdef CONFIG_NET_POLL_CONTROLLER |
| 67 | struct netpoll *np; |
| 68 | #endif |
| 69 | |
Jiri Pirko | a86fc6b | 2012-07-27 06:28:54 +0000 | [diff] [blame] | 70 | s32 priority; /* lower number ~ higher priority */ |
Jiri Pirko | 8ff5105 | 2012-07-27 06:28:55 +0000 | [diff] [blame] | 71 | u16 queue_id; |
| 72 | struct list_head qom_list; /* node in queue override mapping list */ |
Jiri Pirko | d80b35b | 2013-06-10 17:42:24 +0200 | [diff] [blame] | 73 | struct rcu_head rcu; |
Jiri Pirko | 5149ee5 | 2012-06-19 05:54:05 +0000 | [diff] [blame] | 74 | long mode_priv[0]; |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 75 | }; |
| 76 | |
Petr Machata | 3443b00 | 2018-07-10 10:02:57 +0300 | [diff] [blame^] | 77 | static inline struct team_port *team_port_get_rcu(const struct net_device *dev) |
| 78 | { |
| 79 | return rcu_dereference(dev->rx_handler_data); |
| 80 | } |
| 81 | |
Jiri Pirko | 68c4504 | 2012-07-11 05:34:04 +0000 | [diff] [blame] | 82 | static inline bool team_port_enabled(struct team_port *port) |
| 83 | { |
| 84 | return port->index != -1; |
| 85 | } |
| 86 | |
| 87 | static inline bool team_port_txable(struct team_port *port) |
| 88 | { |
| 89 | return port->linkup && team_port_enabled(port); |
| 90 | } |
Jiri Pirko | 52a4fd7 | 2012-06-26 06:52:46 +0000 | [diff] [blame] | 91 | |
Jiri Pirko | bd2d083 | 2012-07-17 05:22:36 +0000 | [diff] [blame] | 92 | #ifdef CONFIG_NET_POLL_CONTROLLER |
| 93 | static inline void team_netpoll_send_skb(struct team_port *port, |
| 94 | struct sk_buff *skb) |
| 95 | { |
| 96 | struct netpoll *np = port->np; |
| 97 | |
| 98 | if (np) |
| 99 | netpoll_send_skb(np, skb); |
| 100 | } |
| 101 | #else |
| 102 | static inline void team_netpoll_send_skb(struct team_port *port, |
| 103 | struct sk_buff *skb) |
| 104 | { |
| 105 | } |
| 106 | #endif |
| 107 | |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 108 | struct team_mode_ops { |
| 109 | int (*init)(struct team *team); |
| 110 | void (*exit)(struct team *team); |
| 111 | rx_handler_result_t (*receive)(struct team *team, |
| 112 | struct team_port *port, |
| 113 | struct sk_buff *skb); |
| 114 | bool (*transmit)(struct team *team, struct sk_buff *skb); |
| 115 | int (*port_enter)(struct team *team, struct team_port *port); |
| 116 | void (*port_leave)(struct team *team, struct team_port *port); |
Jiri Pirko | 1d76efe | 2012-08-17 04:00:48 +0000 | [diff] [blame] | 117 | void (*port_change_dev_addr)(struct team *team, struct team_port *port); |
Jiri Pirko | 4bccfd1 | 2012-06-19 05:54:16 +0000 | [diff] [blame] | 118 | void (*port_enabled)(struct team *team, struct team_port *port); |
| 119 | void (*port_disabled)(struct team *team, struct team_port *port); |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 120 | }; |
| 121 | |
Jiri Pirko | acbba0d | 2013-03-06 01:31:12 +0000 | [diff] [blame] | 122 | extern int team_modeop_port_enter(struct team *team, struct team_port *port); |
| 123 | extern void team_modeop_port_change_dev_addr(struct team *team, |
| 124 | struct team_port *port); |
| 125 | |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 126 | enum team_option_type { |
| 127 | TEAM_OPTION_TYPE_U32, |
| 128 | TEAM_OPTION_TYPE_STRING, |
Jiri Pirko | 2615598 | 2012-04-04 12:16:26 +0000 | [diff] [blame] | 129 | TEAM_OPTION_TYPE_BINARY, |
Jiri Pirko | 14f066b | 2012-04-10 05:15:43 +0000 | [diff] [blame] | 130 | TEAM_OPTION_TYPE_BOOL, |
Jiri Pirko | 6982163 | 2012-07-27 06:28:53 +0000 | [diff] [blame] | 131 | TEAM_OPTION_TYPE_S32, |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 132 | }; |
| 133 | |
Jiri Pirko | 85d59a8 | 2012-06-19 05:54:10 +0000 | [diff] [blame] | 134 | struct team_option_inst_info { |
| 135 | u32 array_index; |
| 136 | struct team_port *port; /* != NULL if per-port */ |
| 137 | }; |
| 138 | |
Jiri Pirko | 80f7c66 | 2012-04-10 05:15:42 +0000 | [diff] [blame] | 139 | struct team_gsetter_ctx { |
| 140 | union { |
| 141 | u32 u32_val; |
| 142 | const char *str_val; |
| 143 | struct { |
| 144 | const void *ptr; |
| 145 | u32 len; |
| 146 | } bin_val; |
Jiri Pirko | 14f066b | 2012-04-10 05:15:43 +0000 | [diff] [blame] | 147 | bool bool_val; |
Jiri Pirko | 6982163 | 2012-07-27 06:28:53 +0000 | [diff] [blame] | 148 | s32 s32_val; |
Jiri Pirko | 80f7c66 | 2012-04-10 05:15:42 +0000 | [diff] [blame] | 149 | } data; |
Jiri Pirko | 85d59a8 | 2012-06-19 05:54:10 +0000 | [diff] [blame] | 150 | struct team_option_inst_info *info; |
Jiri Pirko | 80f7c66 | 2012-04-10 05:15:42 +0000 | [diff] [blame] | 151 | }; |
| 152 | |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 153 | struct team_option { |
| 154 | struct list_head list; |
| 155 | const char *name; |
Jiri Pirko | 80f7c66 | 2012-04-10 05:15:42 +0000 | [diff] [blame] | 156 | bool per_port; |
Jiri Pirko | b130332 | 2012-06-19 05:54:08 +0000 | [diff] [blame] | 157 | unsigned int array_size; /* != 0 means the option is array */ |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 158 | enum team_option_type type; |
Jiri Pirko | 85d59a8 | 2012-06-19 05:54:10 +0000 | [diff] [blame] | 159 | int (*init)(struct team *team, struct team_option_inst_info *info); |
Jiri Pirko | 80f7c66 | 2012-04-10 05:15:42 +0000 | [diff] [blame] | 160 | int (*getter)(struct team *team, struct team_gsetter_ctx *ctx); |
| 161 | int (*setter)(struct team *team, struct team_gsetter_ctx *ctx); |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 162 | }; |
| 163 | |
Jiri Pirko | 0f1aad2 | 2012-06-19 05:54:11 +0000 | [diff] [blame] | 164 | extern void team_option_inst_set_change(struct team_option_inst_info *opt_inst_info); |
| 165 | extern void team_options_change_check(struct team *team); |
| 166 | |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 167 | struct team_mode { |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 168 | const char *kind; |
| 169 | struct module *owner; |
| 170 | size_t priv_size; |
Jiri Pirko | 5149ee5 | 2012-06-19 05:54:05 +0000 | [diff] [blame] | 171 | size_t port_priv_size; |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 172 | const struct team_mode_ops *ops; |
Jiri Pirko | 8fd7285 | 2015-12-03 12:12:13 +0100 | [diff] [blame] | 173 | enum netdev_lag_tx_type lag_tx_type; |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 174 | }; |
| 175 | |
| 176 | #define TEAM_PORT_HASHBITS 4 |
| 177 | #define TEAM_PORT_HASHENTRIES (1 << TEAM_PORT_HASHBITS) |
| 178 | |
| 179 | #define TEAM_MODE_PRIV_LONGS 4 |
| 180 | #define TEAM_MODE_PRIV_SIZE (sizeof(long) * TEAM_MODE_PRIV_LONGS) |
| 181 | |
| 182 | struct team { |
| 183 | struct net_device *dev; /* associated netdevice */ |
| 184 | struct team_pcpu_stats __percpu *pcpu_stats; |
| 185 | |
Jiri Pirko | 61dc346 | 2011-11-16 11:09:08 +0000 | [diff] [blame] | 186 | struct mutex lock; /* used for overall locking, e.g. port lists write */ |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 187 | |
| 188 | /* |
Jiri Pirko | 19a0b58 | 2012-04-20 04:42:05 +0000 | [diff] [blame] | 189 | * List of enabled ports and their count |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 190 | */ |
Jiri Pirko | 19a0b58 | 2012-04-20 04:42:05 +0000 | [diff] [blame] | 191 | int en_port_count; |
| 192 | struct hlist_head en_port_hlist[TEAM_PORT_HASHENTRIES]; |
| 193 | |
| 194 | struct list_head port_list; /* list of all ports */ |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 195 | |
| 196 | struct list_head option_list; |
Jiri Pirko | 80f7c66 | 2012-04-10 05:15:42 +0000 | [diff] [blame] | 197 | struct list_head option_inst_list; /* list of option instances */ |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 198 | |
| 199 | const struct team_mode *mode; |
| 200 | struct team_mode_ops ops; |
Flavio Leitner | e185483 | 2013-02-05 09:30:55 +0000 | [diff] [blame] | 201 | bool user_carrier_enabled; |
Jiri Pirko | 8ff5105 | 2012-07-27 06:28:55 +0000 | [diff] [blame] | 202 | bool queue_override_enabled; |
| 203 | struct list_head *qom_lists; /* array of queue override mapping lists */ |
Jiri Pirko | 9d0d68f | 2014-05-29 20:46:17 +0200 | [diff] [blame] | 204 | bool port_mtu_change_allowed; |
Jiri Pirko | fc423ff | 2013-07-20 12:13:52 +0200 | [diff] [blame] | 205 | struct { |
| 206 | unsigned int count; |
| 207 | unsigned int interval; /* in ms */ |
| 208 | atomic_t count_pending; |
| 209 | struct delayed_work dw; |
| 210 | } notify_peers; |
Jiri Pirko | 492b200 | 2013-07-20 12:13:54 +0200 | [diff] [blame] | 211 | struct { |
| 212 | unsigned int count; |
| 213 | unsigned int interval; /* in ms */ |
| 214 | atomic_t count_pending; |
| 215 | struct delayed_work dw; |
| 216 | } mcast_rejoin; |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 217 | long mode_priv[TEAM_MODE_PRIV_LONGS]; |
| 218 | }; |
| 219 | |
Amerigo Wang | e15c3c22 | 2012-08-10 01:24:45 +0000 | [diff] [blame] | 220 | static inline int team_dev_queue_xmit(struct team *team, struct team_port *port, |
| 221 | struct sk_buff *skb) |
| 222 | { |
| 223 | BUILD_BUG_ON(sizeof(skb->queue_mapping) != |
| 224 | sizeof(qdisc_skb_cb(skb)->slave_dev_queue_mapping)); |
| 225 | skb_set_queue_mapping(skb, qdisc_skb_cb(skb)->slave_dev_queue_mapping); |
| 226 | |
| 227 | skb->dev = port->dev; |
| 228 | if (unlikely(netpoll_tx_running(team->dev))) { |
| 229 | team_netpoll_send_skb(port, skb); |
| 230 | return 0; |
| 231 | } |
| 232 | return dev_queue_xmit(skb); |
| 233 | } |
| 234 | |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 235 | static inline struct hlist_head *team_port_index_hash(struct team *team, |
| 236 | int port_index) |
| 237 | { |
Jiri Pirko | 19a0b58 | 2012-04-20 04:42:05 +0000 | [diff] [blame] | 238 | return &team->en_port_hlist[port_index & (TEAM_PORT_HASHENTRIES - 1)]; |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 239 | } |
| 240 | |
| 241 | static inline struct team_port *team_get_port_by_index(struct team *team, |
| 242 | int port_index) |
| 243 | { |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 244 | struct team_port *port; |
| 245 | struct hlist_head *head = team_port_index_hash(team, port_index); |
| 246 | |
Sasha Levin | b67bfe0 | 2013-02-27 17:06:00 -0800 | [diff] [blame] | 247 | hlist_for_each_entry(port, head, hlist) |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 248 | if (port->index == port_index) |
| 249 | return port; |
| 250 | return NULL; |
| 251 | } |
Jiri Pirko | 735d381 | 2013-06-10 17:42:25 +0200 | [diff] [blame] | 252 | |
Alex Sidorenko | 21d9629 | 2016-10-07 09:02:33 -0400 | [diff] [blame] | 253 | static inline int team_num_to_port_index(struct team *team, unsigned int num) |
Jiri Pirko | 735d381 | 2013-06-10 17:42:25 +0200 | [diff] [blame] | 254 | { |
Mark Rutland | 6aa7de0 | 2017-10-23 14:07:29 -0700 | [diff] [blame] | 255 | int en_port_count = READ_ONCE(team->en_port_count); |
Jiri Pirko | 735d381 | 2013-06-10 17:42:25 +0200 | [diff] [blame] | 256 | |
| 257 | if (unlikely(!en_port_count)) |
| 258 | return 0; |
| 259 | return num % en_port_count; |
| 260 | } |
| 261 | |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 262 | static inline struct team_port *team_get_port_by_index_rcu(struct team *team, |
| 263 | int port_index) |
| 264 | { |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 265 | struct team_port *port; |
| 266 | struct hlist_head *head = team_port_index_hash(team, port_index); |
| 267 | |
Sasha Levin | b67bfe0 | 2013-02-27 17:06:00 -0800 | [diff] [blame] | 268 | hlist_for_each_entry_rcu(port, head, hlist) |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 269 | if (port->index == port_index) |
| 270 | return port; |
| 271 | return NULL; |
| 272 | } |
| 273 | |
Jiri Pirko | 753f993 | 2013-03-06 01:31:13 +0000 | [diff] [blame] | 274 | static inline struct team_port * |
| 275 | team_get_first_port_txable_rcu(struct team *team, struct team_port *port) |
| 276 | { |
| 277 | struct team_port *cur; |
| 278 | |
| 279 | if (likely(team_port_txable(port))) |
| 280 | return port; |
| 281 | cur = port; |
| 282 | list_for_each_entry_continue_rcu(cur, &team->port_list, list) |
Jiri Pirko | b79462a | 2013-06-08 15:00:55 +0200 | [diff] [blame] | 283 | if (team_port_txable(cur)) |
Jiri Pirko | 753f993 | 2013-03-06 01:31:13 +0000 | [diff] [blame] | 284 | return cur; |
| 285 | list_for_each_entry_rcu(cur, &team->port_list, list) { |
| 286 | if (cur == port) |
| 287 | break; |
Jiri Pirko | b79462a | 2013-06-08 15:00:55 +0200 | [diff] [blame] | 288 | if (team_port_txable(cur)) |
Jiri Pirko | 753f993 | 2013-03-06 01:31:13 +0000 | [diff] [blame] | 289 | return cur; |
| 290 | } |
| 291 | return NULL; |
| 292 | } |
| 293 | |
Jiri Pirko | 358b838 | 2011-11-16 11:09:09 +0000 | [diff] [blame] | 294 | extern int team_options_register(struct team *team, |
| 295 | const struct team_option *option, |
| 296 | size_t option_count); |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 297 | extern void team_options_unregister(struct team *team, |
Jiri Pirko | 358b838 | 2011-11-16 11:09:09 +0000 | [diff] [blame] | 298 | const struct team_option *option, |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 299 | size_t option_count); |
Jiri Pirko | 0402788 | 2012-06-19 05:54:03 +0000 | [diff] [blame] | 300 | extern int team_mode_register(const struct team_mode *mode); |
| 301 | extern void team_mode_unregister(const struct team_mode *mode); |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 302 | |
Jiri Pirko | 6c85f2b | 2012-07-20 02:28:51 +0000 | [diff] [blame] | 303 | #define TEAM_DEFAULT_NUM_TX_QUEUES 16 |
| 304 | #define TEAM_DEFAULT_NUM_RX_QUEUES 16 |
| 305 | |
Zhang Shengju | 3a5f899 | 2017-06-01 15:37:02 +0800 | [diff] [blame] | 306 | #define MODULE_ALIAS_TEAM_MODE(kind) MODULE_ALIAS("team-mode-" kind) |
| 307 | |
Jiri Pirko | 3d249d4 | 2011-11-11 22:16:48 +0000 | [diff] [blame] | 308 | #endif /* _LINUX_IF_TEAM_H_ */ |