include/linux/if_team.h

   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  */
  10
  11 #ifndef _LINUX_IF_TEAM_H_
  12 #define _LINUX_IF_TEAM_H_
  13
  14 #ifdef __KERNEL__
  15
  16 struct team_pcpu_stats {
  17         u64                     rx_packets;
  18         u64                     rx_bytes;
  19         u64                     rx_multicast;
  20         u64                     tx_packets;
  21         u64                     tx_bytes;
  22         struct u64_stats_sync   syncp;
  23         u32                     rx_dropped;
  24         u32                     tx_dropped;
  25 };
  26
  27 struct team;
  28
  29 struct team_port {
  30         struct net_device *dev;
  31         struct hlist_node hlist; /* node in enabled ports hash list */
  32         struct list_head list; /* node in ordinary list */
  33         struct team *team;
  34         int index; /* index of enabled port. If disabled, it's set to -1 */
  35
  36         bool linkup; /* either state.linkup or user.linkup */
  37
  38         struct {
  39                 bool linkup;
  40                 u32 speed;
  41                 u8 duplex;
  42         } state;
  43
  44         /* Values set by userspace */
  45         struct {
  46                 bool linkup;
  47                 bool linkup_enabled;
  48         } user;
  49
  50         /* Custom gennetlink interface related flags */
  51         bool changed;
  52         bool removed;
  53
  54         /*
  55          * A place for storing original values of the device before it
  56          * become a port.
  57          */
  58         struct {
  59                 unsigned char dev_addr[MAX_ADDR_LEN];
  60                 unsigned int mtu;
  61         } orig;
  62
  63         long mode_priv[0];
  64 };
  65
  66 static inline bool team_port_enabled(struct team_port *port)
  67 {
  68         return port->index != -1;
  69 }
  70
  71 static inline bool team_port_txable(struct team_port *port)
  72 {
  73         return port->linkup && team_port_enabled(port);
  74 }
  75
  76 struct team_mode_ops {
  77         int (*init)(struct team *team);
  78         void (*exit)(struct team *team);
  79         rx_handler_result_t (*receive)(struct team *team,
  80                                        struct team_port *port,
  81                                        struct sk_buff *skb);
  82         bool (*transmit)(struct team *team, struct sk_buff *skb);
  83         int (*port_enter)(struct team *team, struct team_port *port);
  84         void (*port_leave)(struct team *team, struct team_port *port);
  85         void (*port_change_mac)(struct team *team, struct team_port *port);
  86         void (*port_enabled)(struct team *team, struct team_port *port);
  87         void (*port_disabled)(struct team *team, struct team_port *port);
  88 };
  89
  90 enum team_option_type {
  91         TEAM_OPTION_TYPE_U32,
  92         TEAM_OPTION_TYPE_STRING,
  93         TEAM_OPTION_TYPE_BINARY,
  94         TEAM_OPTION_TYPE_BOOL,
  95 };
  96
  97 struct team_option_inst_info {
  98         u32 array_index;
  99         struct team_port *port; /* != NULL if per-port */
 100 };
 101
 102 struct team_gsetter_ctx {
 103         union {
 104                 u32 u32_val;
 105                 const char *str_val;
 106                 struct {
 107                         const void *ptr;
 108                         u32 len;
 109                 } bin_val;
 110                 bool bool_val;
 111         } data;
 112         struct team_option_inst_info *info;
 113 };
 114
 115 struct team_option {
 116         struct list_head list;
 117         const char *name;
 118         bool per_port;
 119         unsigned int array_size; /* != 0 means the option is array */
 120         enum team_option_type type;
 121         int (*init)(struct team *team, struct team_option_inst_info *info);
 122         int (*getter)(struct team *team, struct team_gsetter_ctx *ctx);
 123         int (*setter)(struct team *team, struct team_gsetter_ctx *ctx);
 124 };
 125
 126 extern void team_option_inst_set_change(struct team_option_inst_info *opt_inst_info);
 127 extern void team_options_change_check(struct team *team);
 128
 129 struct team_mode {
 130         const char *kind;
 131         struct module *owner;
 132         size_t priv_size;
 133         size_t port_priv_size;
 134         const struct team_mode_ops *ops;
 135 };
 136
 137 #define TEAM_PORT_HASHBITS 4
 138 #define TEAM_PORT_HASHENTRIES (1 << TEAM_PORT_HASHBITS)
 139
 140 #define TEAM_MODE_PRIV_LONGS 4
 141 #define TEAM_MODE_PRIV_SIZE (sizeof(long) * TEAM_MODE_PRIV_LONGS)
 142
 143 struct team {
 144         struct net_device *dev; /* associated netdevice */
 145         struct team_pcpu_stats __percpu *pcpu_stats;
 146
 147         struct mutex lock; /* used for overall locking, e.g. port lists write */
 148
 149         /*
 150          * List of enabled ports and their count
 151          */
 152         int en_port_count;
 153         struct hlist_head en_port_hlist[TEAM_PORT_HASHENTRIES];
 154
 155         struct list_head port_list; /* list of all ports */
 156
 157         struct list_head option_list;
 158         struct list_head option_inst_list; /* list of option instances */
 159
 160         const struct team_mode *mode;
 161         struct team_mode_ops ops;
 162         long mode_priv[TEAM_MODE_PRIV_LONGS];
 163 };
 164
 165 static inline struct hlist_head *team_port_index_hash(struct team *team,
 166                                                       int port_index)
 167 {
 168         return &team->en_port_hlist[port_index & (TEAM_PORT_HASHENTRIES - 1)];
 169 }
 170
 171 static inline struct team_port *team_get_port_by_index(struct team *team,
 172                                                        int port_index)
 173 {
 174         struct hlist_node *p;
 175         struct team_port *port;
 176         struct hlist_head *head = team_port_index_hash(team, port_index);
 177
 178         hlist_for_each_entry(port, p, head, hlist)
 179                 if (port->index == port_index)
 180                         return port;
 181         return NULL;
 182 }
 183 static inline struct team_port *team_get_port_by_index_rcu(struct team *team,
 184                                                            int port_index)
 185 {
 186         struct hlist_node *p;
 187         struct team_port *port;
 188         struct hlist_head *head = team_port_index_hash(team, port_index);
 189
 190         hlist_for_each_entry_rcu(port, p, head, hlist)
 191                 if (port->index == port_index)
 192                         return port;
 193         return NULL;
 194 }
 195
 196 extern int team_port_set_team_mac(struct team_port *port);
 197 extern int team_options_register(struct team *team,
 198                                  const struct team_option *option,
 199                                  size_t option_count);
 200 extern void team_options_unregister(struct team *team,
 201                                     const struct team_option *option,
 202                                     size_t option_count);
 203 extern int team_mode_register(const struct team_mode *mode);
 204 extern void team_mode_unregister(const struct team_mode *mode);
 205
 206 #endif /* __KERNEL__ */
 207
 208 #define TEAM_STRING_MAX_LEN 32
 209
 210 /**********************************
 211  * NETLINK_GENERIC netlink family.
 212  **********************************/
 213
 214 enum {
 215         TEAM_CMD_NOOP,
 216         TEAM_CMD_OPTIONS_SET,
 217         TEAM_CMD_OPTIONS_GET,
 218         TEAM_CMD_PORT_LIST_GET,
 219
 220         __TEAM_CMD_MAX,
 221         TEAM_CMD_MAX = (__TEAM_CMD_MAX - 1),
 222 };
 223
 224 enum {
 225         TEAM_ATTR_UNSPEC,
 226         TEAM_ATTR_TEAM_IFINDEX,         /* u32 */
 227         TEAM_ATTR_LIST_OPTION,          /* nest */
 228         TEAM_ATTR_LIST_PORT,            /* nest */
 229
 230         __TEAM_ATTR_MAX,
 231         TEAM_ATTR_MAX = __TEAM_ATTR_MAX - 1,
 232 };
 233
 234 /* Nested layout of get/set msg:
 235  *
 236  *      [TEAM_ATTR_LIST_OPTION]
 237  *              [TEAM_ATTR_ITEM_OPTION]
 238  *                      [TEAM_ATTR_OPTION_*], ...
 239  *              [TEAM_ATTR_ITEM_OPTION]
 240  *                      [TEAM_ATTR_OPTION_*], ...
 241  *              ...
 242  *      [TEAM_ATTR_LIST_PORT]
 243  *              [TEAM_ATTR_ITEM_PORT]
 244  *                      [TEAM_ATTR_PORT_*], ...
 245  *              [TEAM_ATTR_ITEM_PORT]
 246  *                      [TEAM_ATTR_PORT_*], ...
 247  *              ...
 248  */
 249
 250 enum {
 251         TEAM_ATTR_ITEM_OPTION_UNSPEC,
 252         TEAM_ATTR_ITEM_OPTION,          /* nest */
 253
 254         __TEAM_ATTR_ITEM_OPTION_MAX,
 255         TEAM_ATTR_ITEM_OPTION_MAX = __TEAM_ATTR_ITEM_OPTION_MAX - 1,
 256 };
 257
 258 enum {
 259         TEAM_ATTR_OPTION_UNSPEC,
 260         TEAM_ATTR_OPTION_NAME,          /* string */
 261         TEAM_ATTR_OPTION_CHANGED,       /* flag */
 262         TEAM_ATTR_OPTION_TYPE,          /* u8 */
 263         TEAM_ATTR_OPTION_DATA,          /* dynamic */
 264         TEAM_ATTR_OPTION_REMOVED,       /* flag */
 265         TEAM_ATTR_OPTION_PORT_IFINDEX,  /* u32 */ /* for per-port options */
 266         TEAM_ATTR_OPTION_ARRAY_INDEX,   /* u32 */ /* for array options */
 267
 268         __TEAM_ATTR_OPTION_MAX,
 269         TEAM_ATTR_OPTION_MAX = __TEAM_ATTR_OPTION_MAX - 1,
 270 };
 271
 272 enum {
 273         TEAM_ATTR_ITEM_PORT_UNSPEC,
 274         TEAM_ATTR_ITEM_PORT,            /* nest */
 275
 276         __TEAM_ATTR_ITEM_PORT_MAX,
 277         TEAM_ATTR_ITEM_PORT_MAX = __TEAM_ATTR_ITEM_PORT_MAX - 1,
 278 };
 279
 280 enum {
 281         TEAM_ATTR_PORT_UNSPEC,
 282         TEAM_ATTR_PORT_IFINDEX,         /* u32 */
 283         TEAM_ATTR_PORT_CHANGED,         /* flag */
 284         TEAM_ATTR_PORT_LINKUP,          /* flag */
 285         TEAM_ATTR_PORT_SPEED,           /* u32 */
 286         TEAM_ATTR_PORT_DUPLEX,          /* u8 */
 287         TEAM_ATTR_PORT_REMOVED,         /* flag */
 288
 289         __TEAM_ATTR_PORT_MAX,
 290         TEAM_ATTR_PORT_MAX = __TEAM_ATTR_PORT_MAX - 1,
 291 };
 292
 293 /*
 294  * NETLINK_GENERIC related info
 295  */
 296 #define TEAM_GENL_NAME "team"
 297 #define TEAM_GENL_VERSION 0x1
 298 #define TEAM_GENL_CHANGE_EVENT_MC_GRP_NAME "change_event"
 299
 300 #endif /* _LINUX_IF_TEAM_H_ */