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