1 /* 2 * include/linux/if_team.h - Network team device driver header 3 * Copyright (c) 2011 Jiri Pirko <[email protected]> 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 */ 10 11 #ifndef _LINUX_IF_TEAM_H_ 12 #define _LINUX_IF_TEAM_H_ 13 14 #ifdef __KERNEL__ 15 16 #include <linux/netpoll.h> 17 #include <net/sch_generic.h> 18 19 struct team_pcpu_stats { 20 u64 rx_packets; 21 u64 rx_bytes; 22 u64 rx_multicast; 23 u64 tx_packets; 24 u64 tx_bytes; 25 struct u64_stats_sync syncp; 26 u32 rx_dropped; 27 u32 tx_dropped; 28 }; 29 30 struct team; 31 32 struct team_port { 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 */ 36 struct team *team; 37 int index; /* index of enabled port. If disabled, it's set to -1 */ 38 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 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 66 #ifdef CONFIG_NET_POLL_CONTROLLER 67 struct netpoll *np; 68 #endif 69 70 s32 priority; /* lower number ~ higher priority */ 71 u16 queue_id; 72 struct list_head qom_list; /* node in queue override mapping list */ 73 long mode_priv[0]; 74 }; 75 76 static inline bool team_port_enabled(struct team_port *port) 77 { 78 return port->index != -1; 79 } 80 81 static inline bool team_port_txable(struct team_port *port) 82 { 83 return port->linkup && team_port_enabled(port); 84 } 85 86 #ifdef CONFIG_NET_POLL_CONTROLLER 87 static 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 96 static inline void team_netpoll_send_skb(struct team_port *port, 97 struct sk_buff *skb) 98 { 99 } 100 #endif 101 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); 114 }; 115 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, 122 }; 123 124 struct team_option_inst_info { 125 u32 array_index; 126 struct team_port *port; /* != NULL if per-port */ 127 }; 128 129 struct team_gsetter_ctx { 130 union { 131 u32 u32_val; 132 const char *str_val; 133 struct { 134 const void *ptr; 135 u32 len; 136 } bin_val; 137 bool bool_val; 138 s32 s32_val; 139 } data; 140 struct team_option_inst_info *info; 141 }; 142 143 struct team_option { 144 struct list_head list; 145 const char *name; 146 bool per_port; 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); 152 }; 153 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); 156 157 struct team_mode { 158 const char *kind; 159 struct module *owner; 160 size_t priv_size; 161 size_t port_priv_size; 162 const struct team_mode_ops *ops; 163 }; 164 165 #define TEAM_PORT_HASHBITS 4 166 #define TEAM_PORT_HASHENTRIES (1 << TEAM_PORT_HASHBITS) 167 168 #define TEAM_MODE_PRIV_LONGS 4 169 #define TEAM_MODE_PRIV_SIZE (sizeof(long) * TEAM_MODE_PRIV_LONGS) 170 171 struct team { 172 struct net_device *dev; /* associated netdevice */ 173 struct team_pcpu_stats __percpu *pcpu_stats; 174 175 struct mutex lock; /* used for overall locking, e.g. port lists write */ 176 177 /* 178 * List of enabled ports and their count 179 */ 180 int en_port_count; 181 struct hlist_head en_port_hlist[TEAM_PORT_HASHENTRIES]; 182 183 struct list_head port_list; /* list of all ports */ 184 185 struct list_head option_list; 186 struct list_head option_inst_list; /* list of option instances */ 187 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]; 193 }; 194 195 static inline int team_dev_queue_xmit(struct team *team, struct team_port *port, 196 struct sk_buff *skb) 197 { 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); 201 202 skb->dev = port->dev; 203 if (unlikely(netpoll_tx_running(team->dev))) { 204 team_netpoll_send_skb(port, skb); 205 return 0; 206 } 207 return dev_queue_xmit(skb); 208 } 209 210 static inline struct hlist_head *team_port_index_hash(struct team *team, 211 int port_index) 212 { 213 return &team->en_port_hlist[port_index & (TEAM_PORT_HASHENTRIES - 1)]; 214 } 215 216 static inline struct team_port *team_get_port_by_index(struct team *team, 217 int port_index) 218 { 219 struct hlist_node *p; 220 struct team_port *port; 221 struct hlist_head *head = team_port_index_hash(team, port_index); 222 223 hlist_for_each_entry(port, p, head, hlist) 224 if (port->index == port_index) 225 return port; 226 return NULL; 227 } 228 static inline struct team_port *team_get_port_by_index_rcu(struct team *team, 229 int port_index) 230 { 231 struct hlist_node *p; 232 struct team_port *port; 233 struct hlist_head *head = team_port_index_hash(team, port_index); 234 235 hlist_for_each_entry_rcu(port, p, head, hlist) 236 if (port->index == port_index) 237 return port; 238 return NULL; 239 } 240 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); 250 251 #define TEAM_DEFAULT_NUM_TX_QUEUES 16 252 #define TEAM_DEFAULT_NUM_RX_QUEUES 16 253 254 #endif /* __KERNEL__ */ 255 256 #define TEAM_STRING_MAX_LEN 32 257 258 /********************************** 259 * NETLINK_GENERIC netlink family. 260 **********************************/ 261 262 enum { 263 TEAM_CMD_NOOP, 264 TEAM_CMD_OPTIONS_SET, 265 TEAM_CMD_OPTIONS_GET, 266 TEAM_CMD_PORT_LIST_GET, 267 268 __TEAM_CMD_MAX, 269 TEAM_CMD_MAX = (__TEAM_CMD_MAX - 1), 270 }; 271 272 enum { 273 TEAM_ATTR_UNSPEC, 274 TEAM_ATTR_TEAM_IFINDEX, /* u32 */ 275 TEAM_ATTR_LIST_OPTION, /* nest */ 276 TEAM_ATTR_LIST_PORT, /* nest */ 277 278 __TEAM_ATTR_MAX, 279 TEAM_ATTR_MAX = __TEAM_ATTR_MAX - 1, 280 }; 281 282 /* Nested layout of get/set msg: 283 * 284 * [TEAM_ATTR_LIST_OPTION] 285 * [TEAM_ATTR_ITEM_OPTION] 286 * [TEAM_ATTR_OPTION_*], ... 287 * [TEAM_ATTR_ITEM_OPTION] 288 * [TEAM_ATTR_OPTION_*], ... 289 * ... 290 * [TEAM_ATTR_LIST_PORT] 291 * [TEAM_ATTR_ITEM_PORT] 292 * [TEAM_ATTR_PORT_*], ... 293 * [TEAM_ATTR_ITEM_PORT] 294 * [TEAM_ATTR_PORT_*], ... 295 * ... 296 */ 297 298 enum { 299 TEAM_ATTR_ITEM_OPTION_UNSPEC, 300 TEAM_ATTR_ITEM_OPTION, /* nest */ 301 302 __TEAM_ATTR_ITEM_OPTION_MAX, 303 TEAM_ATTR_ITEM_OPTION_MAX = __TEAM_ATTR_ITEM_OPTION_MAX - 1, 304 }; 305 306 enum { 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 */ 315 316 __TEAM_ATTR_OPTION_MAX, 317 TEAM_ATTR_OPTION_MAX = __TEAM_ATTR_OPTION_MAX - 1, 318 }; 319 320 enum { 321 TEAM_ATTR_ITEM_PORT_UNSPEC, 322 TEAM_ATTR_ITEM_PORT, /* nest */ 323 324 __TEAM_ATTR_ITEM_PORT_MAX, 325 TEAM_ATTR_ITEM_PORT_MAX = __TEAM_ATTR_ITEM_PORT_MAX - 1, 326 }; 327 328 enum { 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 */ 336 337 __TEAM_ATTR_PORT_MAX, 338 TEAM_ATTR_PORT_MAX = __TEAM_ATTR_PORT_MAX - 1, 339 }; 340 341 /* 342 * NETLINK_GENERIC related info 343 */ 344 #define TEAM_GENL_NAME "team" 345 #define TEAM_GENL_VERSION 0x1 346 #define TEAM_GENL_CHANGE_EVENT_MC_GRP_NAME "change_event" 347 348 #endif /* _LINUX_IF_TEAM_H_ */ 349