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