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 slave {
 189         struct net_device *dev; /* first - useful for panic debug */
 190         struct list_head list;
 191         struct bonding *bond; /* our master */
 192         int    delay;
 193         unsigned long jiffies;
 194         unsigned long last_arp_rx;
 195         unsigned long target_last_arp_rx[BOND_MAX_ARP_TARGETS];
 196         s8     link;    /* one of BOND_LINK_XXXX */
 197         s8     new_link;
 198         u8     backup:1,   /* indicates backup slave. Value corresponds with
 199                               BOND_STATE_ACTIVE and BOND_STATE_BACKUP */
 200                inactive:1; /* indicates inactive slave */
 201         u8     duplex;
 202         u32    original_mtu;
 203         u32    link_failure_count;
 204         u32    speed;
 205         u16    queue_id;
 206         u8     perm_hwaddr[ETH_ALEN];
 207         struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */
 208         struct tlb_slave_info tlb_info;
 209 #ifdef CONFIG_NET_POLL_CONTROLLER
 210         struct netpoll *np;
 211 #endif
 212 };
 213
 214 /*
 215  * Link pseudo-state only used internally by monitors
 216  */
 217 #define BOND_LINK_NOCHANGE -1
 218
 219 /*
 220  * Here are the locking policies for the two bonding locks:
 221  *
 222  * 1) Get bond->lock when reading/writing slave list.
 223  * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
 224  *    (It is unnecessary when the write-lock is put with bond->lock.)
 225  * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
 226  *    beforehand.
 227  */
 228 struct bonding {
 229         struct   net_device *dev; /* first - useful for panic debug */
 230         struct   list_head slave_list;
 231         struct   slave *curr_active_slave;
 232         struct   slave *current_arp_slave;
 233         struct   slave *primary_slave;
 234         bool     force_primary;
 235         s32      slave_cnt; /* never change this value outside the attach/detach wrappers */
 236         int     (*recv_probe)(const struct sk_buff *, struct bonding *,
 237                               struct slave *);
 238         rwlock_t lock;
 239         rwlock_t curr_slave_lock;
 240         u8       send_peer_notif;
 241         u8       igmp_retrans;
 242 #ifdef CONFIG_PROC_FS
 243         struct   proc_dir_entry *proc_entry;
 244         char     proc_file_name[IFNAMSIZ];
 245 #endif /* CONFIG_PROC_FS */
 246         struct   list_head bond_list;
 247         int      (*xmit_hash_policy)(struct sk_buff *, int);
 248         u16      rr_tx_counter;
 249         struct   ad_bond_info ad_info;
 250         struct   alb_bond_info alb_info;
 251         struct   bond_params params;
 252         struct   workqueue_struct *wq;
 253         struct   delayed_work mii_work;
 254         struct   delayed_work arp_work;
 255         struct   delayed_work alb_work;
 256         struct   delayed_work ad_work;
 257         struct   delayed_work mcast_work;
 258 #ifdef CONFIG_DEBUG_FS
 259         /* debugging support via debugfs */
 260         struct   dentry *debug_dir;
 261 #endif /* CONFIG_DEBUG_FS */
 262 };
 263
 264 /* if we hold rtnl_lock() - call vlan_uses_dev() */
 265 static inline bool bond_vlan_used(struct bonding *bond)
 266 {
 267         struct net_device *upper;
 268         struct list_head *iter;
 269
 270         rcu_read_lock();
 271         netdev_for_each_upper_dev_rcu(bond->dev, upper, iter) {
 272                 if (upper->priv_flags & IFF_802_1Q_VLAN) {
 273                         rcu_read_unlock();
 274                         return true;
 275                 }
 276         }
 277         rcu_read_unlock();
 278
 279         return false;
 280 }
 281
 282 #define bond_slave_get_rcu(dev) \
 283         ((struct slave *) rcu_dereference(dev->rx_handler_data))
 284
 285 #define bond_slave_get_rtnl(dev) \
 286         ((struct slave *) rtnl_dereference(dev->rx_handler_data))
 287
 288 /**
 289  * Returns NULL if the net_device does not belong to any of the bond's slaves
 290  *
 291  * Caller must hold bond lock for read
 292  */
 293 static inline struct slave *bond_get_slave_by_dev(struct bonding *bond,
 294                                                   struct net_device *slave_dev)
 295 {
 296         struct slave *slave = NULL;
 297
 298         bond_for_each_slave(bond, slave)
 299                 if (slave->dev == slave_dev)
 300                         return slave;
 301
 302         return NULL;
 303 }
 304
 305 static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
 306 {
 307         if (!slave || !slave->bond)
 308                 return NULL;
 309         return slave->bond;
 310 }
 311
 312 static inline bool bond_is_lb(const struct bonding *bond)
 313 {
 314         return (bond->params.mode == BOND_MODE_TLB ||
 315                 bond->params.mode == BOND_MODE_ALB);
 316 }
 317
 318 static inline void bond_set_active_slave(struct slave *slave)
 319 {
 320         slave->backup = 0;
 321 }
 322
 323 static inline void bond_set_backup_slave(struct slave *slave)
 324 {
 325         slave->backup = 1;
 326 }
 327
 328 static inline int bond_slave_state(struct slave *slave)
 329 {
 330         return slave->backup;
 331 }
 332
 333 static inline bool bond_is_active_slave(struct slave *slave)
 334 {
 335         return !bond_slave_state(slave);
 336 }
 337
 338 #define BOND_PRI_RESELECT_ALWAYS        0
 339 #define BOND_PRI_RESELECT_BETTER        1
 340 #define BOND_PRI_RESELECT_FAILURE       2
 341
 342 #define BOND_FOM_NONE                   0
 343 #define BOND_FOM_ACTIVE                 1
 344 #define BOND_FOM_FOLLOW                 2
 345
 346 #define BOND_ARP_TARGETS_ANY            0
 347 #define BOND_ARP_TARGETS_ALL            1
 348
 349 #define BOND_ARP_VALIDATE_NONE          0
 350 #define BOND_ARP_VALIDATE_ACTIVE        (1 << BOND_STATE_ACTIVE)
 351 #define BOND_ARP_VALIDATE_BACKUP        (1 << BOND_STATE_BACKUP)
 352 #define BOND_ARP_VALIDATE_ALL           (BOND_ARP_VALIDATE_ACTIVE | \
 353                                          BOND_ARP_VALIDATE_BACKUP)
 354
 355 static inline int slave_do_arp_validate(struct bonding *bond,
 356                                         struct slave *slave)
 357 {
 358         return bond->params.arp_validate & (1 << bond_slave_state(slave));
 359 }
 360
 361 /* Get the oldest arp which we've received on this slave for bond's
 362  * arp_targets.
 363  */
 364 static inline unsigned long slave_oldest_target_arp_rx(struct bonding *bond,
 365                                                        struct slave *slave)
 366 {
 367         int i = 1;
 368         unsigned long ret = slave->target_last_arp_rx[0];
 369
 370         for (; (i < BOND_MAX_ARP_TARGETS) && bond->params.arp_targets[i]; i++)
 371                 if (time_before(slave->target_last_arp_rx[i], ret))
 372                         ret = slave->target_last_arp_rx[i];
 373
 374         return ret;
 375 }
 376
 377 static inline unsigned long slave_last_rx(struct bonding *bond,
 378                                         struct slave *slave)
 379 {
 380         if (slave_do_arp_validate(bond, slave)) {
 381                 if (bond->params.arp_all_targets == BOND_ARP_TARGETS_ALL)
 382                         return slave_oldest_target_arp_rx(bond, slave);
 383                 else
 384                         return slave->last_arp_rx;
 385         }
 386
 387         return slave->dev->last_rx;
 388 }
 389
 390 #ifdef CONFIG_NET_POLL_CONTROLLER
 391 static inline void bond_netpoll_send_skb(const struct slave *slave,
 392                                          struct sk_buff *skb)
 393 {
 394         struct netpoll *np = slave->np;
 395
 396         if (np)
 397                 netpoll_send_skb(np, skb);
 398 }
 399 #else
 400 static inline void bond_netpoll_send_skb(const struct slave *slave,
 401                                          struct sk_buff *skb)
 402 {
 403 }
 404 #endif
 405
 406 static inline void bond_set_slave_inactive_flags(struct slave *slave)
 407 {
 408         if (!bond_is_lb(slave->bond))
 409                 bond_set_backup_slave(slave);
 410         if (!slave->bond->params.all_slaves_active)
 411                 slave->inactive = 1;
 412 }
 413
 414 static inline void bond_set_slave_active_flags(struct slave *slave)
 415 {
 416         bond_set_active_slave(slave);
 417         slave->inactive = 0;
 418 }
 419
 420 static inline bool bond_is_slave_inactive(struct slave *slave)
 421 {
 422         return slave->inactive;
 423 }
 424
 425 static inline __be32 bond_confirm_addr(struct net_device *dev, __be32 dst, __be32 local)
 426 {
 427         struct in_device *in_dev;
 428         __be32 addr = 0;
 429
 430         rcu_read_lock();
 431         in_dev = __in_dev_get_rcu(dev);
 432
 433         if (in_dev)
 434                 addr = inet_confirm_addr(in_dev, dst, local, RT_SCOPE_HOST);
 435
 436         rcu_read_unlock();
 437         return addr;
 438 }
 439
 440 static inline bool slave_can_tx(struct slave *slave)
 441 {
 442         if (IS_UP(slave->dev) && slave->link == BOND_LINK_UP &&
 443             bond_is_active_slave(slave))
 444                 return true;
 445         else
 446                 return false;
 447 }
 448
 449 struct bond_net;
 450
 451 struct vlan_entry *bond_next_vlan(struct bonding *bond, struct vlan_entry *curr);
 452 int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
 453 void bond_xmit_slave_id(struct bonding *bond, struct sk_buff *skb, int slave_id);
 454 int bond_create(struct net *net, const char *name);
 455 int bond_create_sysfs(struct bond_net *net);
 456 void bond_destroy_sysfs(struct bond_net *net);
 457 void bond_prepare_sysfs_group(struct bonding *bond);
 458 int bond_create_slave_symlinks(struct net_device *master, struct net_device *slave);
 459 void bond_destroy_slave_symlinks(struct net_device *master, struct net_device *slave);
 460 int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
 461 int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
 462 void bond_mii_monitor(struct work_struct *);
 463 void bond_loadbalance_arp_mon(struct work_struct *);
 464 void bond_activebackup_arp_mon(struct work_struct *);
 465 void bond_set_mode_ops(struct bonding *bond, int mode);
 466 int bond_parse_parm(const char *mode_arg, const struct bond_parm_tbl *tbl);
 467 void bond_select_active_slave(struct bonding *bond);
 468 void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
 469 void bond_create_debugfs(void);
 470 void bond_destroy_debugfs(void);
 471 void bond_debug_register(struct bonding *bond);
 472 void bond_debug_unregister(struct bonding *bond);
 473 void bond_debug_reregister(struct bonding *bond);
 474 const char *bond_mode_name(int mode);
 475
 476 struct bond_net {
 477         struct net *            net;    /* Associated network namespace */
 478         struct list_head        dev_list;
 479 #ifdef CONFIG_PROC_FS
 480         struct proc_dir_entry * proc_dir;
 481 #endif
 482         struct class_attribute  class_attr_bonding_masters;
 483 };
 484
 485 #ifdef CONFIG_PROC_FS
 486 void bond_create_proc_entry(struct bonding *bond);
 487 void bond_remove_proc_entry(struct bonding *bond);
 488 void bond_create_proc_dir(struct bond_net *bn);
 489 void bond_destroy_proc_dir(struct bond_net *bn);
 490 #else
 491 static inline void bond_create_proc_entry(struct bonding *bond)
 492 {
 493 }
 494
 495 static inline void bond_remove_proc_entry(struct bonding *bond)
 496 {
 497 }
 498
 499 static inline void bond_create_proc_dir(struct bond_net *bn)
 500 {
 501 }
 502
 503 static inline void bond_destroy_proc_dir(struct bond_net *bn)
 504 {
 505 }
 506 #endif
 507
 508 static inline struct slave *bond_slave_has_mac(struct bonding *bond,
 509                                                const u8 *mac)
 510 {
 511         struct slave *tmp;
 512
 513         bond_for_each_slave(bond, tmp)
 514                 if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
 515                         return tmp;
 516
 517         return NULL;
 518 }
 519
 520 /* Check if the ip is present in arp ip list, or first free slot if ip == 0
 521  * Returns -1 if not found, index if found
 522  */
 523 static inline int bond_get_targets_ip(__be32 *targets, __be32 ip)
 524 {
 525         int i;
 526
 527         for (i = 0; i < BOND_MAX_ARP_TARGETS; i++)
 528                 if (targets[i] == ip)
 529                         return i;
 530                 else if (targets[i] == 0)
 531                         break;
 532
 533         return -1;
 534 }
 535
 536 /* exported from bond_main.c */
 537 extern int bond_net_id;
 538 extern const struct bond_parm_tbl bond_lacp_tbl[];
 539 extern const struct bond_parm_tbl bond_mode_tbl[];
 540 extern const struct bond_parm_tbl xmit_hashtype_tbl[];
 541 extern const struct bond_parm_tbl arp_validate_tbl[];
 542 extern const struct bond_parm_tbl arp_all_targets_tbl[];
 543 extern const struct bond_parm_tbl fail_over_mac_tbl[];
 544 extern const struct bond_parm_tbl pri_reselect_tbl[];
 545 extern struct bond_parm_tbl ad_select_tbl[];
 546
 547 #endif /* _LINUX_BONDING_H */