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