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