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