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