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 "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#ifdef CONFIG_NET_POLL_CONTROLLER
 121extern atomic_t netpoll_block_tx;
 122
 123static inline void block_netpoll_tx(void)
 124{
 125        atomic_inc(&netpoll_block_tx);
 126}
 127
 128static inline void unblock_netpoll_tx(void)
 129{
 130        atomic_dec(&netpoll_block_tx);
 131}
 132
 133static inline int is_netpoll_tx_blocked(struct net_device *dev)
 134{
 135        if (unlikely(dev->priv_flags & IFF_IN_NETPOLL))
 136                return atomic_read(&netpoll_block_tx);
 137        return 0;
 138}
 139#else
 140#define block_netpoll_tx()
 141#define unblock_netpoll_tx()
 142#define is_netpoll_tx_blocked(dev) (0)
 143#endif
 144
 145struct bond_params {
 146        int mode;
 147        int xmit_policy;
 148        int miimon;
 149        int num_grat_arp;
 150        int num_unsol_na;
 151        int arp_interval;
 152        int arp_validate;
 153        int use_carrier;
 154        int fail_over_mac;
 155        int updelay;
 156        int downdelay;
 157        int lacp_fast;
 158        int ad_select;
 159        char primary[IFNAMSIZ];
 160        int primary_reselect;
 161        __be32 arp_targets[BOND_MAX_ARP_TARGETS];
 162        int tx_queues;
 163        int all_slaves_active;
 164        int resend_igmp;
 165};
 166
 167struct bond_parm_tbl {
 168        char *modename;
 169        int mode;
 170};
 171
 172#define BOND_MAX_MODENAME_LEN 20
 173
 174struct vlan_entry {
 175        struct list_head vlan_list;
 176        __be32 vlan_ip;
 177        unsigned short vlan_id;
 178#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
 179        struct in6_addr vlan_ipv6;
 180#endif
 181};
 182
 183struct slave {
 184        struct net_device *dev; /* first - useful for panic debug */
 185        struct slave *next;
 186        struct slave *prev;
 187        int    delay;
 188        unsigned long jiffies;
 189        unsigned long last_arp_rx;
 190        s8     link;    /* one of BOND_LINK_XXXX */
 191        s8     new_link;
 192        s8     state;   /* one of BOND_STATE_XXXX */
 193        u32    original_mtu;
 194        u32    link_failure_count;
 195        u8     perm_hwaddr[ETH_ALEN];
 196        u16    speed;
 197        u8     duplex;
 198        u16    queue_id;
 199        struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */
 200        struct tlb_slave_info tlb_info;
 201};
 202
 203/*
 204 * Link pseudo-state only used internally by monitors
 205 */
 206#define BOND_LINK_NOCHANGE -1
 207
 208/*
 209 * Here are the locking policies for the two bonding locks:
 210 *
 211 * 1) Get bond->lock when reading/writing slave list.
 212 * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
 213 *    (It is unnecessary when the write-lock is put with bond->lock.)
 214 * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
 215 *    beforehand.
 216 */
 217struct bonding {
 218        struct   net_device *dev; /* first - useful for panic debug */
 219        struct   slave *first_slave;
 220        struct   slave *curr_active_slave;
 221        struct   slave *current_arp_slave;
 222        struct   slave *primary_slave;
 223        bool     force_primary;
 224        s32      slave_cnt; /* never change this value outside the attach/detach wrappers */
 225        rwlock_t lock;
 226        rwlock_t curr_slave_lock;
 227        s8       kill_timers;
 228        s8       send_grat_arp;
 229        s8       send_unsol_na;
 230        s8       setup_by_slave;
 231        s8       igmp_retrans;
 232#ifdef CONFIG_PROC_FS
 233        struct   proc_dir_entry *proc_entry;
 234        char     proc_file_name[IFNAMSIZ];
 235#endif /* CONFIG_PROC_FS */
 236        struct   list_head bond_list;
 237        struct   netdev_hw_addr_list mc_list;
 238        int      (*xmit_hash_policy)(struct sk_buff *, int);
 239        __be32   master_ip;
 240        u16      flags;
 241        u16      rr_tx_counter;
 242        struct   ad_bond_info ad_info;
 243        struct   alb_bond_info alb_info;
 244        struct   bond_params params;
 245        struct   list_head vlan_list;
 246        struct   vlan_group *vlgrp;
 247        struct   packet_type arp_mon_pt;
 248        struct   workqueue_struct *wq;
 249        struct   delayed_work mii_work;
 250        struct   delayed_work arp_work;
 251        struct   delayed_work alb_work;
 252        struct   delayed_work ad_work;
 253        struct   delayed_work mcast_work;
 254#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
 255        struct   in6_addr master_ipv6;
 256#endif
 257#ifdef CONFIG_DEBUG_FS
 258        /* debugging suport via debugfs */
 259        struct   dentry *debug_dir;
 260#endif /* CONFIG_DEBUG_FS */
 261};
 262
 263/**
 264 * Returns NULL if the net_device does not belong to any of the bond's slaves
 265 *
 266 * Caller must hold bond lock for read
 267 */
 268static inline struct slave *bond_get_slave_by_dev(struct bonding *bond, struct net_device *slave_dev)
 269{
 270        struct slave *slave = NULL;
 271        int i;
 272
 273        bond_for_each_slave(bond, slave, i) {
 274                if (slave->dev == slave_dev) {
 275                        return slave;
 276                }
 277        }
 278
 279        return 0;
 280}
 281
 282static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
 283{
 284        if (!slave || !slave->dev->master) {
 285                return NULL;
 286        }
 287
 288        return netdev_priv(slave->dev->master);
 289}
 290
 291static inline bool bond_is_lb(const struct bonding *bond)
 292{
 293        return (bond->params.mode == BOND_MODE_TLB ||
 294                bond->params.mode == BOND_MODE_ALB);
 295}
 296
 297#define BOND_PRI_RESELECT_ALWAYS        0
 298#define BOND_PRI_RESELECT_BETTER        1
 299#define BOND_PRI_RESELECT_FAILURE       2
 300
 301#define BOND_FOM_NONE                   0
 302#define BOND_FOM_ACTIVE                 1
 303#define BOND_FOM_FOLLOW                 2
 304
 305#define BOND_ARP_VALIDATE_NONE          0
 306#define BOND_ARP_VALIDATE_ACTIVE        (1 << BOND_STATE_ACTIVE)
 307#define BOND_ARP_VALIDATE_BACKUP        (1 << BOND_STATE_BACKUP)
 308#define BOND_ARP_VALIDATE_ALL           (BOND_ARP_VALIDATE_ACTIVE | \
 309                                         BOND_ARP_VALIDATE_BACKUP)
 310
 311static inline int slave_do_arp_validate(struct bonding *bond,
 312                                        struct slave *slave)
 313{
 314        return bond->params.arp_validate & (1 << slave->state);
 315}
 316
 317static inline unsigned long slave_last_rx(struct bonding *bond,
 318                                        struct slave *slave)
 319{
 320        if (slave_do_arp_validate(bond, slave))
 321                return slave->last_arp_rx;
 322
 323        return slave->dev->last_rx;
 324}
 325
 326static inline void bond_set_slave_inactive_flags(struct slave *slave)
 327{
 328        struct bonding *bond = netdev_priv(slave->dev->master);
 329        if (!bond_is_lb(bond))
 330                slave->state = BOND_STATE_BACKUP;
 331        if (!bond->params.all_slaves_active)
 332                slave->dev->priv_flags |= IFF_SLAVE_INACTIVE;
 333        if (slave_do_arp_validate(bond, slave))
 334                slave->dev->priv_flags |= IFF_SLAVE_NEEDARP;
 335}
 336
 337static inline void bond_set_slave_active_flags(struct slave *slave)
 338{
 339        slave->state = BOND_STATE_ACTIVE;
 340        slave->dev->priv_flags &= ~(IFF_SLAVE_INACTIVE | IFF_SLAVE_NEEDARP);
 341}
 342
 343static inline void bond_set_master_3ad_flags(struct bonding *bond)
 344{
 345        bond->dev->priv_flags |= IFF_MASTER_8023AD;
 346}
 347
 348static inline void bond_unset_master_3ad_flags(struct bonding *bond)
 349{
 350        bond->dev->priv_flags &= ~IFF_MASTER_8023AD;
 351}
 352
 353static inline void bond_set_master_alb_flags(struct bonding *bond)
 354{
 355        bond->dev->priv_flags |= IFF_MASTER_ALB;
 356}
 357
 358static inline void bond_unset_master_alb_flags(struct bonding *bond)
 359{
 360        bond->dev->priv_flags &= ~IFF_MASTER_ALB;
 361}
 362
 363struct vlan_entry *bond_next_vlan(struct bonding *bond, struct vlan_entry *curr);
 364int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
 365int bond_create(struct net *net, const char *name);
 366int bond_create_sysfs(void);
 367void bond_destroy_sysfs(void);
 368void bond_prepare_sysfs_group(struct bonding *bond);
 369int bond_create_slave_symlinks(struct net_device *master, struct net_device *slave);
 370void bond_destroy_slave_symlinks(struct net_device *master, struct net_device *slave);
 371int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
 372int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
 373void bond_mii_monitor(struct work_struct *);
 374void bond_loadbalance_arp_mon(struct work_struct *);
 375void bond_activebackup_arp_mon(struct work_struct *);
 376void bond_set_mode_ops(struct bonding *bond, int mode);
 377int bond_parse_parm(const char *mode_arg, const struct bond_parm_tbl *tbl);
 378void bond_select_active_slave(struct bonding *bond);
 379void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
 380void bond_register_arp(struct bonding *);
 381void bond_unregister_arp(struct bonding *);
 382void bond_create_debugfs(void);
 383void bond_destroy_debugfs(void);
 384void bond_debug_register(struct bonding *bond);
 385void bond_debug_unregister(struct bonding *bond);
 386void bond_debug_reregister(struct bonding *bond);
 387
 388struct bond_net {
 389        struct net *            net;    /* Associated network namespace */
 390        struct list_head        dev_list;
 391#ifdef CONFIG_PROC_FS
 392        struct proc_dir_entry * proc_dir;
 393#endif
 394};
 395
 396/* exported from bond_main.c */
 397extern int bond_net_id;
 398extern const struct bond_parm_tbl bond_lacp_tbl[];
 399extern const struct bond_parm_tbl bond_mode_tbl[];
 400extern const struct bond_parm_tbl xmit_hashtype_tbl[];
 401extern const struct bond_parm_tbl arp_validate_tbl[];
 402extern const struct bond_parm_tbl fail_over_mac_tbl[];
 403extern const struct bond_parm_tbl pri_reselect_tbl[];
 404extern struct bond_parm_tbl ad_select_tbl[];
 405
 406#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
 407void bond_send_unsolicited_na(struct bonding *bond);
 408void bond_register_ipv6_notifier(void);
 409void bond_unregister_ipv6_notifier(void);
 410#else
 411static inline void bond_send_unsolicited_na(struct bonding *bond)
 412{
 413        return;
 414}
 415static inline void bond_register_ipv6_notifier(void)
 416{
 417        return;
 418}
 419static inline void bond_unregister_ipv6_notifier(void)
 420{
 421        return;
 422}
 423#endif
 424
 425#endif /* _LINUX_BONDING_H */
 426