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  * 2003/03/18 - Amir Noam <amir.noam at intel dot com>,
  15  *              Tsippy Mendelson <tsippy.mendelson at intel dot com> and
  16  *              Shmulik Hen <shmulik.hen at intel dot com>
  17  *      - Added support for IEEE 802.3ad Dynamic link aggregation mode.
  18  *
  19  * 2003/05/01 - Tsippy Mendelson <tsippy.mendelson at intel dot com> and
  20  *              Amir Noam <amir.noam at intel dot com>
  21  *      - Code beautification and style changes (mainly in comments).
  22  *
  23  * 2003/05/01 - Shmulik Hen <shmulik.hen at intel dot com>
  24  *      - Added support for Transmit load balancing mode.
  25  *
  26  * 2003/12/01 - Shmulik Hen <shmulik.hen at intel dot com>
  27  *      - Code cleanup and style changes
  28  *
  29  * 2005/05/05 - Jason Gabler <jygabler at lbl dot gov>
  30  *      - added "xmit_policy" kernel parameter for alternate hashing policy
  31  *        support for mode 2
  32  *
  33  * 2005/09/27 - Mitch Williams <mitch.a.williams at intel dot com>
  34  *              Radheka Godse <radheka.godse at intel dot com>
  35  *      - Added bonding sysfs interface
  36  */
  37
  38 #ifndef _LINUX_BONDING_H
  39 #define _LINUX_BONDING_H
  40
  41 #include <linux/timer.h>
  42 #include <linux/proc_fs.h>
  43 #include <linux/if_bonding.h>
  44 #include <linux/kobject.h>
  45 #include "bond_3ad.h"
  46 #include "bond_alb.h"
  47
  48 #define DRV_VERSION     "3.0.0"
  49 #define DRV_RELDATE     "November 8, 2005"
  50 #define DRV_NAME        "bonding"
  51 #define DRV_DESCRIPTION "Ethernet Channel Bonding Driver"
  52
  53 #define BOND_MAX_ARP_TARGETS    16
  54
  55 #ifdef BONDING_DEBUG
  56 #define dprintk(fmt, args...) \
  57         printk(KERN_DEBUG     \
  58                DRV_NAME ": %s() %d: " fmt, __FUNCTION__, __LINE__ , ## args )
  59 #else
  60 #define dprintk(fmt, args...)
  61 #endif /* BONDING_DEBUG */
  62
  63 #define IS_UP(dev)                                         \
  64               ((((dev)->flags & IFF_UP) == IFF_UP)      && \
  65                netif_running(dev)                       && \
  66                netif_carrier_ok(dev))
  67
  68 /*
  69  * Checks whether bond is ready for transmit.
  70  *
  71  * Caller must hold bond->lock
  72  */
  73 #define BOND_IS_OK(bond)                             \
  74                    (((bond)->dev->flags & IFF_UP) && \
  75                     netif_running((bond)->dev)    && \
  76                     ((bond)->slave_cnt > 0))
  77
  78 /*
  79  * Checks whether slave is ready for transmit.
  80  */
  81 #define SLAVE_IS_OK(slave)                              \
  82                     (((slave)->dev->flags & IFF_UP)  && \
  83                      netif_running((slave)->dev)     && \
  84                      ((slave)->link == BOND_LINK_UP) && \
  85                      ((slave)->state == BOND_STATE_ACTIVE))
  86
  87
  88 #define USES_PRIMARY(mode)                              \
  89                 (((mode) == BOND_MODE_ACTIVEBACKUP) ||  \
  90                  ((mode) == BOND_MODE_TLB)          ||  \
  91                  ((mode) == BOND_MODE_ALB))
  92
  93 /*
  94  * Less bad way to call ioctl from within the kernel; this needs to be
  95  * done some other way to get the call out of interrupt context.
  96  * Needs "ioctl" variable to be supplied by calling context.
  97  */
  98 #define IOCTL(dev, arg, cmd) ({         \
  99         int res = 0;                    \
 100         mm_segment_t fs = get_fs();     \
 101         set_fs(get_ds());               \
 102         res = ioctl(dev, arg, cmd);     \
 103         set_fs(fs);                     \
 104         res; })
 105
 106 /**
 107  * bond_for_each_slave_from - iterate the slaves list from a starting point
 108  * @bond:       the bond holding this list.
 109  * @pos:        current slave.
 110  * @cnt:        counter for max number of moves
 111  * @start:      starting point.
 112  *
 113  * Caller must hold bond->lock
 114  */
 115 #define bond_for_each_slave_from(bond, pos, cnt, start) \
 116         for (cnt = 0, pos = start;                              \
 117              cnt < (bond)->slave_cnt;                           \
 118              cnt++, pos = (pos)->next)
 119
 120 /**
 121  * bond_for_each_slave_from_to - iterate the slaves list from start point to stop point
 122  * @bond:       the bond holding this list.
 123  * @pos:        current slave.
 124  * @cnt:        counter for number max of moves
 125  * @start:      start point.
 126  * @stop:       stop point.
 127  *
 128  * Caller must hold bond->lock
 129  */
 130 #define bond_for_each_slave_from_to(bond, pos, cnt, start, stop)        \
 131         for (cnt = 0, pos = start;                                      \
 132              ((cnt < (bond)->slave_cnt) && (pos != (stop)->next));      \
 133              cnt++, pos = (pos)->next)
 134
 135 /**
 136  * bond_for_each_slave - iterate the slaves list from head
 137  * @bond:       the bond holding this list.
 138  * @pos:        current slave.
 139  * @cnt:        counter for max number of moves
 140  *
 141  * Caller must hold bond->lock
 142  */
 143 #define bond_for_each_slave(bond, pos, cnt)     \
 144                 bond_for_each_slave_from(bond, pos, cnt, (bond)->first_slave)
 145
 146
 147 struct bond_params {
 148         int mode;
 149         int xmit_policy;
 150         int miimon;
 151         int arp_interval;
 152         int use_carrier;
 153         int updelay;
 154         int downdelay;
 155         int lacp_fast;
 156         char primary[IFNAMSIZ];
 157         u32 arp_targets[BOND_MAX_ARP_TARGETS];
 158 };
 159
 160 struct bond_parm_tbl {
 161         char *modename;
 162         int mode;
 163 };
 164
 165 struct vlan_entry {
 166         struct list_head vlan_list;
 167         u32 vlan_ip;
 168         unsigned short vlan_id;
 169 };
 170
 171 struct slave {
 172         struct net_device *dev; /* first - useful for panic debug */
 173         struct slave *next;
 174         struct slave *prev;
 175         s16    delay;
 176         u32    jiffies;
 177         s8     link;    /* one of BOND_LINK_XXXX */
 178         s8     state;   /* one of BOND_STATE_XXXX */
 179         u32    original_flags;
 180         u32    link_failure_count;
 181         u16    speed;
 182         u8     duplex;
 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 };
 187
 188 /*
 189  * Here are the locking policies for the two bonding locks:
 190  *
 191  * 1) Get bond->lock when reading/writing slave list.
 192  * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
 193  *    (It is unnecessary when the write-lock is put with bond->lock.)
 194  * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
 195  *    beforehand.
 196  */
 197 struct bonding {
 198         struct   net_device *dev; /* first - useful for panic debug */
 199         struct   slave *first_slave;
 200         struct   slave *curr_active_slave;
 201         struct   slave *current_arp_slave;
 202         struct   slave *primary_slave;
 203         s32      slave_cnt; /* never change this value outside the attach/detach wrappers */
 204         rwlock_t lock;
 205         rwlock_t curr_slave_lock;
 206         struct   timer_list mii_timer;
 207         struct   timer_list arp_timer;
 208         s8       kill_timers;
 209         struct   net_device_stats stats;
 210 #ifdef CONFIG_PROC_FS
 211         struct   proc_dir_entry *proc_entry;
 212         char     proc_file_name[IFNAMSIZ];
 213 #endif /* CONFIG_PROC_FS */
 214         struct   list_head bond_list;
 215         struct   dev_mc_list *mc_list;
 216         int      (*xmit_hash_policy)(struct sk_buff *, struct net_device *, int);
 217         u32      master_ip;
 218         u16      flags;
 219         struct   ad_bond_info ad_info;
 220         struct   alb_bond_info alb_info;
 221         struct   bond_params params;
 222         struct   list_head vlan_list;
 223         struct   vlan_group *vlgrp;
 224 };
 225
 226 /**
 227  * Returns NULL if the net_device does not belong to any of the bond's slaves
 228  *
 229  * Caller must hold bond lock for read
 230  */
 231 extern inline struct slave *bond_get_slave_by_dev(struct bonding *bond, struct net_device *slave_dev)
 232 {
 233         struct slave *slave = NULL;
 234         int i;
 235
 236         bond_for_each_slave(bond, slave, i) {
 237                 if (slave->dev == slave_dev) {
 238                         break;
 239                 }
 240         }
 241
 242         return slave;
 243 }
 244
 245 extern inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
 246 {
 247         if (!slave || !slave->dev->master) {
 248                 return NULL;
 249         }
 250
 251         return (struct bonding *)slave->dev->master->priv;
 252 }
 253
 254 extern inline void bond_set_slave_inactive_flags(struct slave *slave)
 255 {
 256         slave->state = BOND_STATE_BACKUP;
 257         slave->dev->flags |= IFF_NOARP;
 258 }
 259
 260 extern inline void bond_set_slave_active_flags(struct slave *slave)
 261 {
 262         slave->state = BOND_STATE_ACTIVE;
 263         slave->dev->flags &= ~IFF_NOARP;
 264 }
 265
 266 struct vlan_entry *bond_next_vlan(struct bonding *bond, struct vlan_entry *curr);
 267 int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
 268 int bond_create(char *name, struct bond_params *params, struct bonding **newbond);
 269 void bond_deinit(struct net_device *bond_dev);
 270 int bond_create_sysfs(void);
 271 void bond_destroy_sysfs(void);
 272 void bond_destroy_sysfs_entry(struct bonding *bond);
 273 int bond_create_sysfs_entry(struct bonding *bond);
 274 int bond_create_slave_symlinks(struct net_device *master, struct net_device *slave);
 275 void bond_destroy_slave_symlinks(struct net_device *master, struct net_device *slave);
 276 int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
 277 int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
 278 int bond_sethwaddr(struct net_device *bond_dev, struct net_device *slave_dev);
 279 void bond_mii_monitor(struct net_device *bond_dev);
 280 void bond_loadbalance_arp_mon(struct net_device *bond_dev);
 281 void bond_activebackup_arp_mon(struct net_device *bond_dev);
 282 void bond_set_mode_ops(struct bonding *bond, int mode);
 283 int bond_parse_parm(char *mode_arg, struct bond_parm_tbl *tbl);
 284 const char *bond_mode_name(int mode);
 285 void bond_select_active_slave(struct bonding *bond);
 286 void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
 287
 288 #endif /* _LINUX_BONDING_H */
 289