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 #define BOND_MODE_IS_LB(mode)                   \
  63                 (((mode) == BOND_MODE_TLB) ||   \
  64                  ((mode) == BOND_MODE_ALB))
  65
  66 /*
  67  * Less bad way to call ioctl from within the kernel; this needs to be
  68  * done some other way to get the call out of interrupt context.
  69  * Needs "ioctl" variable to be supplied by calling context.
  70  */
  71 #define IOCTL(dev, arg, cmd) ({         \
  72         int res = 0;                    \
  73         mm_segment_t fs = get_fs();     \
  74         set_fs(get_ds());               \
  75         res = ioctl(dev, arg, cmd);     \
  76         set_fs(fs);                     \
  77         res; })
  78
  79 /* slave list primitives */
  80 #define bond_slave_list(bond) (&(bond)->dev->adj_list.lower)
  81
  82 #define bond_has_slaves(bond) !list_empty(bond_slave_list(bond))
  83
  84 /* IMPORTANT: bond_first/last_slave can return NULL in case of an empty list */
  85 #define bond_first_slave(bond) \
  86         (bond_has_slaves(bond) ? \
  87                 netdev_adjacent_get_private(bond_slave_list(bond)->next) : \
  88                 NULL)
  89 #define bond_last_slave(bond) \
  90         (bond_has_slaves(bond) ? \
  91                 netdev_adjacent_get_private(bond_slave_list(bond)->prev) : \
  92                 NULL)
  93
  94 #define bond_is_first_slave(bond, pos) (pos == bond_first_slave(bond))
  95 #define bond_is_last_slave(bond, pos) (pos == bond_last_slave(bond))
  96
  97 /**
  98  * bond_for_each_slave - iterate over all slaves
  99  * @bond:       the bond holding this list
 100  * @pos:        current slave
 101  * @iter:       list_head * iterator
 102  *
 103  * Caller must hold bond->lock
 104  */
 105 #define bond_for_each_slave(bond, pos, iter) \
 106         netdev_for_each_lower_private((bond)->dev, pos, iter)
 107
 108 /* Caller must have rcu_read_lock */
 109 #define bond_for_each_slave_rcu(bond, pos, iter) \
 110         netdev_for_each_lower_private_rcu((bond)->dev, pos, iter)
 111
 112 #ifdef CONFIG_NET_POLL_CONTROLLER
 113 extern atomic_t netpoll_block_tx;
 114
 115 static inline void block_netpoll_tx(void)
 116 {
 117         atomic_inc(&netpoll_block_tx);
 118 }
 119
 120 static inline void unblock_netpoll_tx(void)
 121 {
 122         atomic_dec(&netpoll_block_tx);
 123 }
 124
 125 static inline int is_netpoll_tx_blocked(struct net_device *dev)
 126 {
 127         if (unlikely(netpoll_tx_running(dev)))
 128                 return atomic_read(&netpoll_block_tx);
 129         return 0;
 130 }
 131 #else
 132 #define block_netpoll_tx()
 133 #define unblock_netpoll_tx()
 134 #define is_netpoll_tx_blocked(dev) (0)
 135 #endif
 136
 137 struct bond_params {
 138         int mode;
 139         int xmit_policy;
 140         int miimon;
 141         u8 num_peer_notif;
 142         int arp_interval;
 143         int arp_validate;
 144         int arp_all_targets;
 145         int use_carrier;
 146         int fail_over_mac;
 147         int updelay;
 148         int downdelay;
 149         int lacp_fast;
 150         unsigned int min_links;
 151         int ad_select;
 152         char primary[IFNAMSIZ];
 153         int primary_reselect;
 154         __be32 arp_targets[BOND_MAX_ARP_TARGETS];
 155         int tx_queues;
 156         int all_slaves_active;
 157         int resend_igmp;
 158         int lp_interval;
 159 };
 160
 161 struct bond_parm_tbl {
 162         char *modename;
 163         int mode;
 164 };
 165
 166 #define BOND_MAX_MODENAME_LEN 20
 167
 168 struct slave {
 169         struct net_device *dev; /* first - useful for panic debug */
 170         struct bonding *bond; /* our master */
 171         int    delay;
 172         unsigned long jiffies;
 173         unsigned long last_arp_rx;
 174         unsigned long target_last_arp_rx[BOND_MAX_ARP_TARGETS];
 175         s8     link;    /* one of BOND_LINK_XXXX */
 176         s8     new_link;
 177         u8     backup:1,   /* indicates backup slave. Value corresponds with
 178                               BOND_STATE_ACTIVE and BOND_STATE_BACKUP */
 179                inactive:1; /* indicates inactive slave */
 180         u8     duplex;
 181         u32    original_mtu;
 182         u32    link_failure_count;
 183         u32    speed;
 184         u16    queue_id;
 185         u8     perm_hwaddr[ETH_ALEN];
 186         struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */
 187         struct tlb_slave_info tlb_info;
 188 #ifdef CONFIG_NET_POLL_CONTROLLER
 189         struct netpoll *np;
 190 #endif
 191 };
 192
 193 /*
 194  * Link pseudo-state only used internally by monitors
 195  */
 196 #define BOND_LINK_NOCHANGE -1
 197
 198 /*
 199  * Here are the locking policies for the two bonding locks:
 200  *
 201  * 1) Get bond->lock when reading/writing slave list.
 202  * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
 203  *    (It is unnecessary when the write-lock is put with bond->lock.)
 204  * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
 205  *    beforehand.
 206  */
 207 struct bonding {
 208         struct   net_device *dev; /* first - useful for panic debug */
 209         struct   slave *curr_active_slave;
 210         struct   slave *current_arp_slave;
 211         struct   slave *primary_slave;
 212         bool     force_primary;
 213         s32      slave_cnt; /* never change this value outside the attach/detach wrappers */
 214         int     (*recv_probe)(const struct sk_buff *, struct bonding *,
 215                               struct slave *);
 216         rwlock_t lock;
 217         rwlock_t curr_slave_lock;
 218         u8       send_peer_notif;
 219         u8       igmp_retrans;
 220 #ifdef CONFIG_PROC_FS
 221         struct   proc_dir_entry *proc_entry;
 222         char     proc_file_name[IFNAMSIZ];
 223 #endif /* CONFIG_PROC_FS */
 224         struct   list_head bond_list;
 225         u16      rr_tx_counter;
 226         struct   ad_bond_info ad_info;
 227         struct   alb_bond_info alb_info;
 228         struct   bond_params params;
 229         struct   workqueue_struct *wq;
 230         struct   delayed_work mii_work;
 231         struct   delayed_work arp_work;
 232         struct   delayed_work alb_work;
 233         struct   delayed_work ad_work;
 234         struct   delayed_work mcast_work;
 235 #ifdef CONFIG_DEBUG_FS
 236         /* debugging support via debugfs */
 237         struct   dentry *debug_dir;
 238 #endif /* CONFIG_DEBUG_FS */
 239 };
 240
 241 #define bond_slave_get_rcu(dev) \
 242         ((struct slave *) rcu_dereference(dev->rx_handler_data))
 243
 244 #define bond_slave_get_rtnl(dev) \
 245         ((struct slave *) rtnl_dereference(dev->rx_handler_data))
 246
 247 /**
 248  * Returns NULL if the net_device does not belong to any of the bond's slaves
 249  *
 250  * Caller must hold bond lock for read
 251  */
 252 static inline struct slave *bond_get_slave_by_dev(struct bonding *bond,
 253                                                   struct net_device *slave_dev)
 254 {
 255         return netdev_lower_dev_get_private(bond->dev, slave_dev);
 256 }
 257
 258 static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
 259 {
 260         if (!slave || !slave->bond)
 261                 return NULL;
 262         return slave->bond;
 263 }
 264
 265 static inline bool bond_is_lb(const struct bonding *bond)
 266 {
 267         return BOND_MODE_IS_LB(bond->params.mode);
 268 }
 269
 270 static inline void bond_set_active_slave(struct slave *slave)
 271 {
 272         slave->backup = 0;
 273 }
 274
 275 static inline void bond_set_backup_slave(struct slave *slave)
 276 {
 277         slave->backup = 1;
 278 }
 279
 280 static inline int bond_slave_state(struct slave *slave)
 281 {
 282         return slave->backup;
 283 }
 284
 285 static inline bool bond_is_active_slave(struct slave *slave)
 286 {
 287         return !bond_slave_state(slave);
 288 }
 289
 290 #define BOND_PRI_RESELECT_ALWAYS        0
 291 #define BOND_PRI_RESELECT_BETTER        1
 292 #define BOND_PRI_RESELECT_FAILURE       2
 293
 294 #define BOND_FOM_NONE                   0
 295 #define BOND_FOM_ACTIVE                 1
 296 #define BOND_FOM_FOLLOW                 2
 297
 298 #define BOND_ARP_TARGETS_ANY            0
 299 #define BOND_ARP_TARGETS_ALL            1
 300
 301 #define BOND_ARP_VALIDATE_NONE          0
 302 #define BOND_ARP_VALIDATE_ACTIVE        (1 << BOND_STATE_ACTIVE)
 303 #define BOND_ARP_VALIDATE_BACKUP        (1 << BOND_STATE_BACKUP)
 304 #define BOND_ARP_VALIDATE_ALL           (BOND_ARP_VALIDATE_ACTIVE | \
 305                                          BOND_ARP_VALIDATE_BACKUP)
 306
 307 static inline int slave_do_arp_validate(struct bonding *bond,
 308                                         struct slave *slave)
 309 {
 310         return bond->params.arp_validate & (1 << bond_slave_state(slave));
 311 }
 312
 313 /* Get the oldest arp which we've received on this slave for bond's
 314  * arp_targets.
 315  */
 316 static inline unsigned long slave_oldest_target_arp_rx(struct bonding *bond,
 317                                                        struct slave *slave)
 318 {
 319         int i = 1;
 320         unsigned long ret = slave->target_last_arp_rx[0];
 321
 322         for (; (i < BOND_MAX_ARP_TARGETS) && bond->params.arp_targets[i]; i++)
 323                 if (time_before(slave->target_last_arp_rx[i], ret))
 324                         ret = slave->target_last_arp_rx[i];
 325
 326         return ret;
 327 }
 328
 329 static inline unsigned long slave_last_rx(struct bonding *bond,
 330                                         struct slave *slave)
 331 {
 332         if (slave_do_arp_validate(bond, slave)) {
 333                 if (bond->params.arp_all_targets == BOND_ARP_TARGETS_ALL)
 334                         return slave_oldest_target_arp_rx(bond, slave);
 335                 else
 336                         return slave->last_arp_rx;
 337         }
 338
 339         return slave->dev->last_rx;
 340 }
 341
 342 #ifdef CONFIG_NET_POLL_CONTROLLER
 343 static inline void bond_netpoll_send_skb(const struct slave *slave,
 344                                          struct sk_buff *skb)
 345 {
 346         struct netpoll *np = slave->np;
 347
 348         if (np)
 349                 netpoll_send_skb(np, skb);
 350 }
 351 #else
 352 static inline void bond_netpoll_send_skb(const struct slave *slave,
 353                                          struct sk_buff *skb)
 354 {
 355 }
 356 #endif
 357
 358 static inline void bond_set_slave_inactive_flags(struct slave *slave)
 359 {
 360         if (!bond_is_lb(slave->bond))
 361                 bond_set_backup_slave(slave);
 362         if (!slave->bond->params.all_slaves_active)
 363                 slave->inactive = 1;
 364 }
 365
 366 static inline void bond_set_slave_active_flags(struct slave *slave)
 367 {
 368         bond_set_active_slave(slave);
 369         slave->inactive = 0;
 370 }
 371
 372 static inline bool bond_is_slave_inactive(struct slave *slave)
 373 {
 374         return slave->inactive;
 375 }
 376
 377 static inline __be32 bond_confirm_addr(struct net_device *dev, __be32 dst, __be32 local)
 378 {
 379         struct in_device *in_dev;
 380         __be32 addr = 0;
 381
 382         rcu_read_lock();
 383         in_dev = __in_dev_get_rcu(dev);
 384
 385         if (in_dev)
 386                 addr = inet_confirm_addr(in_dev, dst, local, RT_SCOPE_HOST);
 387
 388         rcu_read_unlock();
 389         return addr;
 390 }
 391
 392 static inline bool slave_can_tx(struct slave *slave)
 393 {
 394         if (IS_UP(slave->dev) && slave->link == BOND_LINK_UP &&
 395             bond_is_active_slave(slave))
 396                 return true;
 397         else
 398                 return false;
 399 }
 400
 401 struct bond_net;
 402
 403 int bond_arp_rcv(const struct sk_buff *skb, struct bonding *bond, struct slave *slave);
 404 int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
 405 void bond_xmit_slave_id(struct bonding *bond, struct sk_buff *skb, int slave_id);
 406 int bond_create(struct net *net, const char *name);
 407 int bond_create_sysfs(struct bond_net *net);
 408 void bond_destroy_sysfs(struct bond_net *net);
 409 void bond_prepare_sysfs_group(struct bonding *bond);
 410 int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
 411 int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
 412 void bond_mii_monitor(struct work_struct *);
 413 void bond_loadbalance_arp_mon(struct work_struct *);
 414 void bond_activebackup_arp_mon(struct work_struct *);
 415 int bond_xmit_hash(struct bonding *bond, struct sk_buff *skb, int count);
 416 int bond_parse_parm(const char *mode_arg, const struct bond_parm_tbl *tbl);
 417 void bond_select_active_slave(struct bonding *bond);
 418 void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
 419 void bond_create_debugfs(void);
 420 void bond_destroy_debugfs(void);
 421 void bond_debug_register(struct bonding *bond);
 422 void bond_debug_unregister(struct bonding *bond);
 423 void bond_debug_reregister(struct bonding *bond);
 424 const char *bond_mode_name(int mode);
 425 void bond_setup(struct net_device *bond_dev);
 426 unsigned int bond_get_num_tx_queues(void);
 427 int bond_netlink_init(void);
 428 void bond_netlink_fini(void);
 429 int bond_option_mode_set(struct bonding *bond, int mode);
 430 int bond_option_active_slave_set(struct bonding *bond, struct net_device *slave_dev);
 431 struct net_device *bond_option_active_slave_get_rcu(struct bonding *bond);
 432 struct net_device *bond_option_active_slave_get(struct bonding *bond);
 433
 434 struct bond_net {
 435         struct net *            net;    /* Associated network namespace */
 436         struct list_head        dev_list;
 437 #ifdef CONFIG_PROC_FS
 438         struct proc_dir_entry * proc_dir;
 439 #endif
 440         struct class_attribute  class_attr_bonding_masters;
 441 };
 442
 443 #ifdef CONFIG_PROC_FS
 444 void bond_create_proc_entry(struct bonding *bond);
 445 void bond_remove_proc_entry(struct bonding *bond);
 446 void bond_create_proc_dir(struct bond_net *bn);
 447 void bond_destroy_proc_dir(struct bond_net *bn);
 448 #else
 449 static inline void bond_create_proc_entry(struct bonding *bond)
 450 {
 451 }
 452
 453 static inline void bond_remove_proc_entry(struct bonding *bond)
 454 {
 455 }
 456
 457 static inline void bond_create_proc_dir(struct bond_net *bn)
 458 {
 459 }
 460
 461 static inline void bond_destroy_proc_dir(struct bond_net *bn)
 462 {
 463 }
 464 #endif
 465
 466 static inline struct slave *bond_slave_has_mac(struct bonding *bond,
 467                                                const u8 *mac)
 468 {
 469         struct list_head *iter;
 470         struct slave *tmp;
 471
 472         bond_for_each_slave(bond, tmp, iter)
 473                 if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
 474                         return tmp;
 475
 476         return NULL;
 477 }
 478
 479 /* Caller must hold rcu_read_lock() for read */
 480 static inline struct slave *bond_slave_has_mac_rcu(struct bonding *bond,
 481                                                const u8 *mac)
 482 {
 483         struct list_head *iter;
 484         struct slave *tmp;
 485
 486         bond_for_each_slave_rcu(bond, tmp, iter)
 487                 if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
 488                         return tmp;
 489
 490         return NULL;
 491 }
 492
 493 /* Check if the ip is present in arp ip list, or first free slot if ip == 0
 494  * Returns -1 if not found, index if found
 495  */
 496 static inline int bond_get_targets_ip(__be32 *targets, __be32 ip)
 497 {
 498         int i;
 499
 500         for (i = 0; i < BOND_MAX_ARP_TARGETS; i++)
 501                 if (targets[i] == ip)
 502                         return i;
 503                 else if (targets[i] == 0)
 504                         break;
 505
 506         return -1;
 507 }
 508
 509 /* exported from bond_main.c */
 510 extern int bond_net_id;
 511 extern const struct bond_parm_tbl bond_lacp_tbl[];
 512 extern const struct bond_parm_tbl bond_mode_tbl[];
 513 extern const struct bond_parm_tbl xmit_hashtype_tbl[];
 514 extern const struct bond_parm_tbl arp_validate_tbl[];
 515 extern const struct bond_parm_tbl arp_all_targets_tbl[];
 516 extern const struct bond_parm_tbl fail_over_mac_tbl[];
 517 extern const struct bond_parm_tbl pri_reselect_tbl[];
 518 extern struct bond_parm_tbl ad_select_tbl[];
 519
 520 /* exported from bond_netlink.c */
 521 extern struct rtnl_link_ops bond_link_ops;
 522
 523 #endif /* _LINUX_BONDING_H */