drivers/net/bonding/bonding.h

   1 /*
   2  * Bond several ethernet interfaces into a Cisco, running 'Etherchannel'.
   3  *
   4  * Portions are (c) Copyright 1995 Simon "Guru Aleph-Null" Janes
   5  * NCM: Network and Communications Management, Inc.
   6  *
   7  * BUT, I'm the one who modified it for ethernet, so:
   8  * (c) Copyright 1999, Thomas Davis, tadavis@lbl.gov
   9  *
  10  *      This software may be used and distributed according to the terms
  11  *      of the GNU Public License, incorporated herein by reference.
  12  *
  13  */
  14
  15 #ifndef _LINUX_BONDING_H
  16 #define _LINUX_BONDING_H
  17
  18 #include <linux/timer.h>
  19 #include <linux/proc_fs.h>
  20 #include <linux/if_bonding.h>
  21 #include <linux/cpumask.h>
  22 #include <linux/in6.h>
  23 #include <linux/netpoll.h>
  24 #include <linux/inetdevice.h>
  25 #include <linux/etherdevice.h>
  26 #include "bond_3ad.h"
  27 #include "bond_alb.h"
  28
  29 #define DRV_VERSION     "3.7.1"
  30 #define DRV_RELDATE     "April 27, 2011"
  31 #define DRV_NAME        "bonding"
  32 #define DRV_DESCRIPTION "Ethernet Channel Bonding Driver"
  33
  34 #define bond_version DRV_DESCRIPTION ": v" DRV_VERSION " (" DRV_RELDATE ")\n"
  35
  36 #define BOND_MAX_ARP_TARGETS    16
  37
  38 #define IS_UP(dev)                                         \
  39               ((((dev)->flags & IFF_UP) == IFF_UP)      && \
  40                netif_running(dev)                       && \
  41                netif_carrier_ok(dev))
  42
  43 /*
  44  * Checks whether slave is ready for transmit.
  45  */
  46 #define SLAVE_IS_OK(slave)                              \
  47                     (((slave)->dev->flags & IFF_UP)  && \
  48                      netif_running((slave)->dev)     && \
  49                      ((slave)->link == BOND_LINK_UP) && \
  50                      bond_is_active_slave(slave))
  51
  52
  53 #define USES_PRIMARY(mode)                              \
  54                 (((mode) == BOND_MODE_ACTIVEBACKUP) ||  \
  55                  ((mode) == BOND_MODE_TLB)          ||  \
  56                  ((mode) == BOND_MODE_ALB))
  57
  58 #define TX_QUEUE_OVERRIDE(mode)                         \
  59                         (((mode) == BOND_MODE_ACTIVEBACKUP) ||  \
  60                          ((mode) == BOND_MODE_ROUNDROBIN))
  61 /*
  62  * Less bad way to call ioctl from within the kernel; this needs to be
  63  * done some other way to get the call out of interrupt context.
  64  * Needs "ioctl" variable to be supplied by calling context.
  65  */
  66 #define IOCTL(dev, arg, cmd) ({         \
  67         int res = 0;                    \
  68         mm_segment_t fs = get_fs();     \
  69         set_fs(get_ds());               \
  70         res = ioctl(dev, arg, cmd);     \
  71         set_fs(fs);                     \
  72         res; })
  73
  74 /**
  75  * bond_for_each_slave_from - iterate the slaves list from a starting point
  76  * @bond:       the bond holding this list.
  77  * @pos:        current slave.
  78  * @cnt:        counter for max number of moves
  79  * @start:      starting point.
  80  *
  81  * Caller must hold bond->lock
  82  */
  83 #define bond_for_each_slave_from(bond, pos, cnt, start) \
  84         for (cnt = 0, pos = start;                              \
  85              cnt < (bond)->slave_cnt;                           \
  86              cnt++, pos = (pos)->next)
  87
  88 /**
  89  * bond_for_each_slave_from_to - iterate the slaves list from start point to stop point
  90  * @bond:       the bond holding this list.
  91  * @pos:        current slave.
  92  * @cnt:        counter for number max of moves
  93  * @start:      start point.
  94  * @stop:       stop point.
  95  *
  96  * Caller must hold bond->lock
  97  */
  98 #define bond_for_each_slave_from_to(bond, pos, cnt, start, stop)        \
  99         for (cnt = 0, pos = start;                                      \
 100              ((cnt < (bond)->slave_cnt) && (pos != (stop)->next));      \
 101              cnt++, pos = (pos)->next)
 102
 103 /**
 104  * bond_for_each_slave - iterate the slaves list from head
 105  * @bond:       the bond holding this list.
 106  * @pos:        current slave.
 107  * @cnt:        counter for max number of moves
 108  *
 109  * Caller must hold bond->lock
 110  */
 111 #define bond_for_each_slave(bond, pos, cnt)     \
 112                 bond_for_each_slave_from(bond, pos, cnt, (bond)->first_slave)
 113
 114
 115 #ifdef CONFIG_NET_POLL_CONTROLLER
 116 extern atomic_t netpoll_block_tx;
 117
 118 static inline void block_netpoll_tx(void)
 119 {
 120         atomic_inc(&netpoll_block_tx);
 121 }
 122
 123 static inline void unblock_netpoll_tx(void)
 124 {
 125         atomic_dec(&netpoll_block_tx);
 126 }
 127
 128 static inline int is_netpoll_tx_blocked(struct net_device *dev)
 129 {
 130         if (unlikely(netpoll_tx_running(dev)))
 131                 return atomic_read(&netpoll_block_tx);
 132         return 0;
 133 }
 134 #else
 135 #define block_netpoll_tx()
 136 #define unblock_netpoll_tx()
 137 #define is_netpoll_tx_blocked(dev) (0)
 138 #endif
 139
 140 struct bond_params {
 141         int mode;
 142         int xmit_policy;
 143         int miimon;
 144         u8 num_peer_notif;
 145         int arp_interval;
 146         int arp_validate;
 147         int use_carrier;
 148         int fail_over_mac;
 149         int updelay;
 150         int downdelay;
 151         int lacp_fast;
 152         unsigned int min_links;
 153         int ad_select;
 154         char primary[IFNAMSIZ];
 155         int primary_reselect;
 156         __be32 arp_targets[BOND_MAX_ARP_TARGETS];
 157         int tx_queues;
 158         int all_slaves_active;
 159         int resend_igmp;
 160 };
 161
 162 struct bond_parm_tbl {
 163         char *modename;
 164         int mode;
 165 };
 166
 167 #define BOND_MAX_MODENAME_LEN 20
 168
 169 struct vlan_entry {
 170         struct list_head vlan_list;
 171         unsigned short vlan_id;
 172 };
 173
 174 struct slave {
 175         struct net_device *dev; /* first - useful for panic debug */
 176         struct slave *next;
 177         struct slave *prev;
 178         struct bonding *bond; /* our master */
 179         int    delay;
 180         unsigned long jiffies;
 181         unsigned long last_arp_rx;
 182         s8     link;    /* one of BOND_LINK_XXXX */
 183         s8     new_link;
 184         u8     backup:1,   /* indicates backup slave. Value corresponds with
 185                               BOND_STATE_ACTIVE and BOND_STATE_BACKUP */
 186                inactive:1; /* indicates inactive slave */
 187         u8     duplex;
 188         u32    original_mtu;
 189         u32    link_failure_count;
 190         u32    speed;
 191         u16    queue_id;
 192         u8     perm_hwaddr[ETH_ALEN];
 193         struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */
 194         struct tlb_slave_info tlb_info;
 195 #ifdef CONFIG_NET_POLL_CONTROLLER
 196         struct netpoll *np;
 197 #endif
 198 };
 199
 200 /*
 201  * Link pseudo-state only used internally by monitors
 202  */
 203 #define BOND_LINK_NOCHANGE -1
 204
 205 /*
 206  * Here are the locking policies for the two bonding locks:
 207  *
 208  * 1) Get bond->lock when reading/writing slave list.
 209  * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
 210  *    (It is unnecessary when the write-lock is put with bond->lock.)
 211  * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
 212  *    beforehand.
 213  */
 214 struct bonding {
 215         struct   net_device *dev; /* first - useful for panic debug */
 216         struct   slave *first_slave;
 217         struct   slave *curr_active_slave;
 218         struct   slave *current_arp_slave;
 219         struct   slave *primary_slave;
 220         bool     force_primary;
 221         s32      slave_cnt; /* never change this value outside the attach/detach wrappers */
 222         int     (*recv_probe)(const struct sk_buff *, struct bonding *,
 223                               struct slave *);
 224         rwlock_t lock;
 225         rwlock_t curr_slave_lock;
 226         u8       send_peer_notif;
 227         s8       setup_by_slave;
 228         s8       igmp_retrans;
 229 #ifdef CONFIG_PROC_FS
 230         struct   proc_dir_entry *proc_entry;
 231         char     proc_file_name[IFNAMSIZ];
 232 #endif /* CONFIG_PROC_FS */
 233         struct   list_head bond_list;
 234         struct   netdev_hw_addr_list mc_list;
 235         int      (*xmit_hash_policy)(struct sk_buff *, int);
 236         u16      rr_tx_counter;
 237         struct   ad_bond_info ad_info;
 238         struct   alb_bond_info alb_info;
 239         struct   bond_params params;
 240         struct   list_head vlan_list;
 241         struct   workqueue_struct *wq;
 242         struct   delayed_work mii_work;
 243         struct   delayed_work arp_work;
 244         struct   delayed_work alb_work;
 245         struct   delayed_work ad_work;
 246         struct   delayed_work mcast_work;
 247 #ifdef CONFIG_DEBUG_FS
 248         /* debugging support via debugfs */
 249         struct   dentry *debug_dir;
 250 #endif /* CONFIG_DEBUG_FS */
 251         bool    dev_addr_from_first;
 252 };
 253
 254 static inline bool bond_vlan_used(struct bonding *bond)
 255 {
 256         return !list_empty(&bond->vlan_list);
 257 }
 258
 259 #define bond_slave_get_rcu(dev) \
 260         ((struct slave *) rcu_dereference(dev->rx_handler_data))
 261
 262 #define bond_slave_get_rtnl(dev) \
 263         ((struct slave *) rtnl_dereference(dev->rx_handler_data))
 264
 265 /**
 266  * Returns NULL if the net_device does not belong to any of the bond's slaves
 267  *
 268  * Caller must hold bond lock for read
 269  */
 270 static inline struct slave *bond_get_slave_by_dev(struct bonding *bond,
 271                                                   struct net_device *slave_dev)
 272 {
 273         struct slave *slave = NULL;
 274         int i;
 275
 276         bond_for_each_slave(bond, slave, i) {
 277                 if (slave->dev == slave_dev) {
 278                         return slave;
 279                 }
 280         }
 281
 282         return NULL;
 283 }
 284
 285 static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
 286 {
 287         if (!slave || !slave->bond)
 288                 return NULL;
 289         return slave->bond;
 290 }
 291
 292 static inline bool bond_is_lb(const struct bonding *bond)
 293 {
 294         return (bond->params.mode == BOND_MODE_TLB ||
 295                 bond->params.mode == BOND_MODE_ALB);
 296 }
 297
 298 static inline void bond_set_active_slave(struct slave *slave)
 299 {
 300         slave->backup = 0;
 301 }
 302
 303 static inline void bond_set_backup_slave(struct slave *slave)
 304 {
 305         slave->backup = 1;
 306 }
 307
 308 static inline int bond_slave_state(struct slave *slave)
 309 {
 310         return slave->backup;
 311 }
 312
 313 static inline bool bond_is_active_slave(struct slave *slave)
 314 {
 315         return !bond_slave_state(slave);
 316 }
 317
 318 #define BOND_PRI_RESELECT_ALWAYS        0
 319 #define BOND_PRI_RESELECT_BETTER        1
 320 #define BOND_PRI_RESELECT_FAILURE       2
 321
 322 #define BOND_FOM_NONE                   0
 323 #define BOND_FOM_ACTIVE                 1
 324 #define BOND_FOM_FOLLOW                 2
 325
 326 #define BOND_ARP_VALIDATE_NONE          0
 327 #define BOND_ARP_VALIDATE_ACTIVE        (1 << BOND_STATE_ACTIVE)
 328 #define BOND_ARP_VALIDATE_BACKUP        (1 << BOND_STATE_BACKUP)
 329 #define BOND_ARP_VALIDATE_ALL           (BOND_ARP_VALIDATE_ACTIVE | \
 330                                          BOND_ARP_VALIDATE_BACKUP)
 331
 332 static inline int slave_do_arp_validate(struct bonding *bond,
 333                                         struct slave *slave)
 334 {
 335         return bond->params.arp_validate & (1 << bond_slave_state(slave));
 336 }
 337
 338 static inline unsigned long slave_last_rx(struct bonding *bond,
 339                                         struct slave *slave)
 340 {
 341         if (slave_do_arp_validate(bond, slave))
 342                 return slave->last_arp_rx;
 343
 344         return slave->dev->last_rx;
 345 }
 346
 347 #ifdef CONFIG_NET_POLL_CONTROLLER
 348 static inline void bond_netpoll_send_skb(const struct slave *slave,
 349                                          struct sk_buff *skb)
 350 {
 351         struct netpoll *np = slave->np;
 352
 353         if (np)
 354                 netpoll_send_skb(np, skb);
 355 }
 356 #else
 357 static inline void bond_netpoll_send_skb(const struct slave *slave,
 358                                          struct sk_buff *skb)
 359 {
 360 }
 361 #endif
 362
 363 static inline void bond_set_slave_inactive_flags(struct slave *slave)
 364 {
 365         if (!bond_is_lb(slave->bond))
 366                 bond_set_backup_slave(slave);
 367         if (!slave->bond->params.all_slaves_active)
 368                 slave->inactive = 1;
 369 }
 370
 371 static inline void bond_set_slave_active_flags(struct slave *slave)
 372 {
 373         bond_set_active_slave(slave);
 374         slave->inactive = 0;
 375 }
 376
 377 static inline bool bond_is_slave_inactive(struct slave *slave)
 378 {
 379         return slave->inactive;
 380 }
 381
 382 static inline __be32 bond_confirm_addr(struct net_device *dev, __be32 dst, __be32 local)
 383 {
 384         struct in_device *in_dev;
 385         __be32 addr = 0;
 386
 387         rcu_read_lock();
 388         in_dev = __in_dev_get_rcu(dev);
 389
 390         if (in_dev)
 391                 addr = inet_confirm_addr(in_dev, dst, local, RT_SCOPE_HOST);
 392
 393         rcu_read_unlock();
 394         return addr;
 395 }
 396
 397 struct bond_net;
 398
 399 struct vlan_entry *bond_next_vlan(struct bonding *bond, struct vlan_entry *curr);
 400 int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
 401 int bond_create(struct net *net, const char *name);
 402 int bond_create_sysfs(struct bond_net *net);
 403 void bond_destroy_sysfs(struct bond_net *net);
 404 void bond_prepare_sysfs_group(struct bonding *bond);
 405 int bond_create_slave_symlinks(struct net_device *master, struct net_device *slave);
 406 void bond_destroy_slave_symlinks(struct net_device *master, struct net_device *slave);
 407 int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
 408 int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
 409 void bond_mii_monitor(struct work_struct *);
 410 void bond_loadbalance_arp_mon(struct work_struct *);
 411 void bond_activebackup_arp_mon(struct work_struct *);
 412 void bond_set_mode_ops(struct bonding *bond, int mode);
 413 int bond_parse_parm(const char *mode_arg, const struct bond_parm_tbl *tbl);
 414 void bond_select_active_slave(struct bonding *bond);
 415 void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
 416 void bond_create_debugfs(void);
 417 void bond_destroy_debugfs(void);
 418 void bond_debug_register(struct bonding *bond);
 419 void bond_debug_unregister(struct bonding *bond);
 420 void bond_debug_reregister(struct bonding *bond);
 421 const char *bond_mode_name(int mode);
 422
 423 struct bond_net {
 424         struct net *            net;    /* Associated network namespace */
 425         struct list_head        dev_list;
 426 #ifdef CONFIG_PROC_FS
 427         struct proc_dir_entry * proc_dir;
 428 #endif
 429         struct class_attribute  class_attr_bonding_masters;
 430 };
 431
 432 #ifdef CONFIG_PROC_FS
 433 void bond_create_proc_entry(struct bonding *bond);
 434 void bond_remove_proc_entry(struct bonding *bond);
 435 void bond_create_proc_dir(struct bond_net *bn);
 436 void bond_destroy_proc_dir(struct bond_net *bn);
 437 #else
 438 static inline void bond_create_proc_entry(struct bonding *bond)
 439 {
 440 }
 441
 442 static inline void bond_remove_proc_entry(struct bonding *bond)
 443 {
 444 }
 445
 446 static inline void bond_create_proc_dir(struct bond_net *bn)
 447 {
 448 }
 449
 450 static inline void bond_destroy_proc_dir(struct bond_net *bn)
 451 {
 452 }
 453 #endif
 454
 455 static inline struct slave *bond_slave_has_mac(struct bonding *bond,
 456                                                const u8 *mac)
 457 {
 458         int i = 0;
 459         struct slave *tmp;
 460
 461         bond_for_each_slave(bond, tmp, i)
 462                 if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
 463                         return tmp;
 464
 465         return NULL;
 466 }
 467
 468 /* exported from bond_main.c */
 469 extern int bond_net_id;
 470 extern const struct bond_parm_tbl bond_lacp_tbl[];
 471 extern const struct bond_parm_tbl bond_mode_tbl[];
 472 extern const struct bond_parm_tbl xmit_hashtype_tbl[];
 473 extern const struct bond_parm_tbl arp_validate_tbl[];
 474 extern const struct bond_parm_tbl fail_over_mac_tbl[];
 475 extern const struct bond_parm_tbl pri_reselect_tbl[];
 476 extern struct bond_parm_tbl ad_select_tbl[];
 477
 478 #endif /* _LINUX_BONDING_H */