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