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/kobject.h>
  22 #include <linux/cpumask.h>
  23 #include <linux/in6.h>
  24 #include "bond_3ad.h"
  25 #include "bond_alb.h"
  26
  27 #define DRV_VERSION     "3.7.0"
  28 #define DRV_RELDATE     "June 2, 2010"
  29 #define DRV_NAME        "bonding"
  30 #define DRV_DESCRIPTION "Ethernet Channel Bonding Driver"
  31
  32 #define BOND_MAX_ARP_TARGETS    16
  33
  34 #define IS_UP(dev)                                         \
  35               ((((dev)->flags & IFF_UP) == IFF_UP)      && \
  36                netif_running(dev)                       && \
  37                netif_carrier_ok(dev))
  38
  39 /*
  40  * Checks whether bond is ready for transmit.
  41  *
  42  * Caller must hold bond->lock
  43  */
  44 #define BOND_IS_OK(bond)                             \
  45                    (((bond)->dev->flags & IFF_UP) && \
  46                     netif_running((bond)->dev)    && \
  47                     ((bond)->slave_cnt > 0))
  48
  49 /*
  50  * Checks whether slave is ready for transmit.
  51  */
  52 #define SLAVE_IS_OK(slave)                              \
  53                     (((slave)->dev->flags & IFF_UP)  && \
  54                      netif_running((slave)->dev)     && \
  55                      ((slave)->link == BOND_LINK_UP) && \
  56                      ((slave)->state == BOND_STATE_ACTIVE))
  57
  58
  59 #define USES_PRIMARY(mode)                              \
  60                 (((mode) == BOND_MODE_ACTIVEBACKUP) ||  \
  61                  ((mode) == BOND_MODE_TLB)          ||  \
  62                  ((mode) == BOND_MODE_ALB))
  63
  64 #define TX_QUEUE_OVERRIDE(mode)                         \
  65                         (((mode) == BOND_MODE_ACTIVEBACKUP) ||  \
  66                          ((mode) == BOND_MODE_ROUNDROBIN))
  67 /*
  68  * Less bad way to call ioctl from within the kernel; this needs to be
  69  * done some other way to get the call out of interrupt context.
  70  * Needs "ioctl" variable to be supplied by calling context.
  71  */
  72 #define IOCTL(dev, arg, cmd) ({         \
  73         int res = 0;                    \
  74         mm_segment_t fs = get_fs();     \
  75         set_fs(get_ds());               \
  76         res = ioctl(dev, arg, cmd);     \
  77         set_fs(fs);                     \
  78         res; })
  79
  80 /**
  81  * bond_for_each_slave_from - iterate the slaves list from a starting point
  82  * @bond:       the bond holding this list.
  83  * @pos:        current slave.
  84  * @cnt:        counter for max number of moves
  85  * @start:      starting point.
  86  *
  87  * Caller must hold bond->lock
  88  */
  89 #define bond_for_each_slave_from(bond, pos, cnt, start) \
  90         for (cnt = 0, pos = start;                              \
  91              cnt < (bond)->slave_cnt;                           \
  92              cnt++, pos = (pos)->next)
  93
  94 /**
  95  * bond_for_each_slave_from_to - iterate the slaves list from start point to stop point
  96  * @bond:       the bond holding this list.
  97  * @pos:        current slave.
  98  * @cnt:        counter for number max of moves
  99  * @start:      start point.
 100  * @stop:       stop point.
 101  *
 102  * Caller must hold bond->lock
 103  */
 104 #define bond_for_each_slave_from_to(bond, pos, cnt, start, stop)        \
 105         for (cnt = 0, pos = start;                                      \
 106              ((cnt < (bond)->slave_cnt) && (pos != (stop)->next));      \
 107              cnt++, pos = (pos)->next)
 108
 109 /**
 110  * bond_for_each_slave - iterate the slaves list from head
 111  * @bond:       the bond holding this list.
 112  * @pos:        current slave.
 113  * @cnt:        counter for max number of moves
 114  *
 115  * Caller must hold bond->lock
 116  */
 117 #define bond_for_each_slave(bond, pos, cnt)     \
 118                 bond_for_each_slave_from(bond, pos, cnt, (bond)->first_slave)
 119
 120
 121 #ifdef CONFIG_NET_POLL_CONTROLLER
 122 extern atomic_t netpoll_block_tx;
 123
 124 static inline void block_netpoll_tx(void)
 125 {
 126         atomic_inc(&netpoll_block_tx);
 127 }
 128
 129 static inline void unblock_netpoll_tx(void)
 130 {
 131         atomic_dec(&netpoll_block_tx);
 132 }
 133
 134 static inline int is_netpoll_tx_blocked(struct net_device *dev)
 135 {
 136         if (unlikely(dev->priv_flags & IFF_IN_NETPOLL))
 137                 return atomic_read(&netpoll_block_tx);
 138         return 0;
 139 }
 140 #else
 141 #define block_netpoll_tx()
 142 #define unblock_netpoll_tx()
 143 #define is_netpoll_tx_blocked(dev) (0)
 144 #endif
 145
 146 struct bond_params {
 147         int mode;
 148         int xmit_policy;
 149         int miimon;
 150         int num_grat_arp;
 151         int num_unsol_na;
 152         int arp_interval;
 153         int arp_validate;
 154         int use_carrier;
 155         int fail_over_mac;
 156         int updelay;
 157         int downdelay;
 158         int lacp_fast;
 159         int ad_select;
 160         char primary[IFNAMSIZ];
 161         int primary_reselect;
 162         __be32 arp_targets[BOND_MAX_ARP_TARGETS];
 163         int tx_queues;
 164         int all_slaves_active;
 165         int resend_igmp;
 166 };
 167
 168 struct bond_parm_tbl {
 169         char *modename;
 170         int mode;
 171 };
 172
 173 #define BOND_MAX_MODENAME_LEN 20
 174
 175 struct vlan_entry {
 176         struct list_head vlan_list;
 177         __be32 vlan_ip;
 178         unsigned short vlan_id;
 179 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
 180         struct in6_addr vlan_ipv6;
 181 #endif
 182 };
 183
 184 struct slave {
 185         struct net_device *dev; /* first - useful for panic debug */
 186         struct slave *next;
 187         struct slave *prev;
 188         int    delay;
 189         unsigned long jiffies;
 190         unsigned long last_arp_rx;
 191         s8     link;    /* one of BOND_LINK_XXXX */
 192         s8     new_link;
 193         s8     state;   /* one of BOND_STATE_XXXX */
 194         u32    original_mtu;
 195         u32    link_failure_count;
 196         u8     perm_hwaddr[ETH_ALEN];
 197         u16    speed;
 198         u8     duplex;
 199         u16    queue_id;
 200         struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */
 201         struct tlb_slave_info tlb_info;
 202 };
 203
 204 /*
 205  * Link pseudo-state only used internally by monitors
 206  */
 207 #define BOND_LINK_NOCHANGE -1
 208
 209 /*
 210  * Here are the locking policies for the two bonding locks:
 211  *
 212  * 1) Get bond->lock when reading/writing slave list.
 213  * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
 214  *    (It is unnecessary when the write-lock is put with bond->lock.)
 215  * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
 216  *    beforehand.
 217  */
 218 struct bonding {
 219         struct   net_device *dev; /* first - useful for panic debug */
 220         struct   slave *first_slave;
 221         struct   slave *curr_active_slave;
 222         struct   slave *current_arp_slave;
 223         struct   slave *primary_slave;
 224         bool     force_primary;
 225         s32      slave_cnt; /* never change this value outside the attach/detach wrappers */
 226         rwlock_t lock;
 227         rwlock_t curr_slave_lock;
 228         s8       kill_timers;
 229         s8       send_grat_arp;
 230         s8       send_unsol_na;
 231         s8       setup_by_slave;
 232         s8       igmp_retrans;
 233 #ifdef CONFIG_PROC_FS
 234         struct   proc_dir_entry *proc_entry;
 235         char     proc_file_name[IFNAMSIZ];
 236 #endif /* CONFIG_PROC_FS */
 237         struct   list_head bond_list;
 238         struct   netdev_hw_addr_list mc_list;
 239         int      (*xmit_hash_policy)(struct sk_buff *, int);
 240         __be32   master_ip;
 241         u16      flags;
 242         u16      rr_tx_counter;
 243         struct   ad_bond_info ad_info;
 244         struct   alb_bond_info alb_info;
 245         struct   bond_params params;
 246         struct   list_head vlan_list;
 247         struct   vlan_group *vlgrp;
 248         struct   packet_type arp_mon_pt;
 249         struct   workqueue_struct *wq;
 250         struct   delayed_work mii_work;
 251         struct   delayed_work arp_work;
 252         struct   delayed_work alb_work;
 253         struct   delayed_work ad_work;
 254         struct   delayed_work mcast_work;
 255 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
 256         struct   in6_addr master_ipv6;
 257 #endif
 258 #ifdef CONFIG_DEBUG_FS
 259         /* debugging suport via debugfs */
 260         struct   dentry *debug_dir;
 261 #endif /* CONFIG_DEBUG_FS */
 262 };
 263
 264 /**
 265  * Returns NULL if the net_device does not belong to any of the bond's slaves
 266  *
 267  * Caller must hold bond lock for read
 268  */
 269 static inline struct slave *bond_get_slave_by_dev(struct bonding *bond, struct net_device *slave_dev)
 270 {
 271         struct slave *slave = NULL;
 272         int i;
 273
 274         bond_for_each_slave(bond, slave, i) {
 275                 if (slave->dev == slave_dev) {
 276                         return slave;
 277                 }
 278         }
 279
 280         return 0;
 281 }
 282
 283 static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
 284 {
 285         if (!slave || !slave->dev->master) {
 286                 return NULL;
 287         }
 288
 289         return netdev_priv(slave->dev->master);
 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 #define BOND_PRI_RESELECT_ALWAYS        0
 299 #define BOND_PRI_RESELECT_BETTER        1
 300 #define BOND_PRI_RESELECT_FAILURE       2
 301
 302 #define BOND_FOM_NONE                   0
 303 #define BOND_FOM_ACTIVE                 1
 304 #define BOND_FOM_FOLLOW                 2
 305
 306 #define BOND_ARP_VALIDATE_NONE          0
 307 #define BOND_ARP_VALIDATE_ACTIVE        (1 << BOND_STATE_ACTIVE)
 308 #define BOND_ARP_VALIDATE_BACKUP        (1 << BOND_STATE_BACKUP)
 309 #define BOND_ARP_VALIDATE_ALL           (BOND_ARP_VALIDATE_ACTIVE | \
 310                                          BOND_ARP_VALIDATE_BACKUP)
 311
 312 static inline int slave_do_arp_validate(struct bonding *bond,
 313                                         struct slave *slave)
 314 {
 315         return bond->params.arp_validate & (1 << slave->state);
 316 }
 317
 318 static inline unsigned long slave_last_rx(struct bonding *bond,
 319                                         struct slave *slave)
 320 {
 321         if (slave_do_arp_validate(bond, slave))
 322                 return slave->last_arp_rx;
 323
 324         return slave->dev->last_rx;
 325 }
 326
 327 static inline void bond_set_slave_inactive_flags(struct slave *slave)
 328 {
 329         struct bonding *bond = netdev_priv(slave->dev->master);
 330         if (!bond_is_lb(bond))
 331                 slave->state = BOND_STATE_BACKUP;
 332         if (!bond->params.all_slaves_active)
 333                 slave->dev->priv_flags |= IFF_SLAVE_INACTIVE;
 334         if (slave_do_arp_validate(bond, slave))
 335                 slave->dev->priv_flags |= IFF_SLAVE_NEEDARP;
 336 }
 337
 338 static inline void bond_set_slave_active_flags(struct slave *slave)
 339 {
 340         slave->state = BOND_STATE_ACTIVE;
 341         slave->dev->priv_flags &= ~(IFF_SLAVE_INACTIVE | IFF_SLAVE_NEEDARP);
 342 }
 343
 344 static inline void bond_set_master_3ad_flags(struct bonding *bond)
 345 {
 346         bond->dev->priv_flags |= IFF_MASTER_8023AD;
 347 }
 348
 349 static inline void bond_unset_master_3ad_flags(struct bonding *bond)
 350 {
 351         bond->dev->priv_flags &= ~IFF_MASTER_8023AD;
 352 }
 353
 354 static inline void bond_set_master_alb_flags(struct bonding *bond)
 355 {
 356         bond->dev->priv_flags |= IFF_MASTER_ALB;
 357 }
 358
 359 static inline void bond_unset_master_alb_flags(struct bonding *bond)
 360 {
 361         bond->dev->priv_flags &= ~IFF_MASTER_ALB;
 362 }
 363
 364 struct vlan_entry *bond_next_vlan(struct bonding *bond, struct vlan_entry *curr);
 365 int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
 366 int bond_create(struct net *net, const char *name);
 367 int bond_create_sysfs(void);
 368 void bond_destroy_sysfs(void);
 369 void bond_prepare_sysfs_group(struct bonding *bond);
 370 int bond_create_slave_symlinks(struct net_device *master, struct net_device *slave);
 371 void bond_destroy_slave_symlinks(struct net_device *master, struct net_device *slave);
 372 int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
 373 int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
 374 void bond_mii_monitor(struct work_struct *);
 375 void bond_loadbalance_arp_mon(struct work_struct *);
 376 void bond_activebackup_arp_mon(struct work_struct *);
 377 void bond_set_mode_ops(struct bonding *bond, int mode);
 378 int bond_parse_parm(const char *mode_arg, const struct bond_parm_tbl *tbl);
 379 void bond_select_active_slave(struct bonding *bond);
 380 void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
 381 void bond_register_arp(struct bonding *);
 382 void bond_unregister_arp(struct bonding *);
 383 void bond_create_debugfs(void);
 384 void bond_destroy_debugfs(void);
 385 void bond_debug_register(struct bonding *bond);
 386 void bond_debug_unregister(struct bonding *bond);
 387 void bond_debug_reregister(struct bonding *bond);
 388
 389 struct bond_net {
 390         struct net *            net;    /* Associated network namespace */
 391         struct list_head        dev_list;
 392 #ifdef CONFIG_PROC_FS
 393         struct proc_dir_entry * proc_dir;
 394 #endif
 395 };
 396
 397 /* exported from bond_main.c */
 398 extern int bond_net_id;
 399 extern const struct bond_parm_tbl bond_lacp_tbl[];
 400 extern const struct bond_parm_tbl bond_mode_tbl[];
 401 extern const struct bond_parm_tbl xmit_hashtype_tbl[];
 402 extern const struct bond_parm_tbl arp_validate_tbl[];
 403 extern const struct bond_parm_tbl fail_over_mac_tbl[];
 404 extern const struct bond_parm_tbl pri_reselect_tbl[];
 405 extern struct bond_parm_tbl ad_select_tbl[];
 406
 407 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
 408 void bond_send_unsolicited_na(struct bonding *bond);
 409 void bond_register_ipv6_notifier(void);
 410 void bond_unregister_ipv6_notifier(void);
 411 #else
 412 static inline void bond_send_unsolicited_na(struct bonding *bond)
 413 {
 414         return;
 415 }
 416 static inline void bond_register_ipv6_notifier(void)
 417 {
 418         return;
 419 }
 420 static inline void bond_unregister_ipv6_notifier(void)
 421 {
 422         return;
 423 }
 424 #endif
 425
 426 #endif /* _LINUX_BONDING_H */