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