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