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