bonding.h

Go to the documentation of this file.

/*
 * Bond several ethernet interfaces into a Cisco, running 'Etherchannel'.
 *
 * Portions are (c) Copyright 1995 Simon "Guru Aleph-Null" Janes
 * NCM: Network and Communications Management, Inc.
 *
 * BUT, I'm the one who modified it for ethernet, so:
 * (c) Copyright 1999, Thomas Davis, [email protected]
 *
 *  This software may be used and distributed according to the terms
 *  of the GNU Public License, incorporated herein by reference.
 *
 */

#ifndef _LINUX_BONDING_H
#define _LINUX_BONDING_H

#include <linux/timer.h>
#include <linux/proc_fs.h>
#include <linux/if_bonding.h>
#include <linux/cpumask.h>
#include <linux/in6.h>
#include <linux/netpoll.h>
#include <linux/inetdevice.h>
#include "bond_3ad.h"
#include "bond_alb.h"

#define DRV_VERSION "3.7.1"
#define DRV_RELDATE "April 27, 2011"
#define DRV_NAME    "bonding"
#define DRV_DESCRIPTION "Ethernet Channel Bonding Driver"

#define bond_version DRV_DESCRIPTION ": v" DRV_VERSION " (" DRV_RELDATE ")\n"

#define BOND_MAX_ARP_TARGETS    16

#define IS_UP(dev)                     \
          ((((dev)->flags & IFF_UP) == IFF_UP)  && \
           netif_running(dev)           && \
           netif_carrier_ok(dev))

/*
 * Checks whether slave is ready for transmit.
 */
#define SLAVE_IS_OK(slave)                  \
            (((slave)->dev->flags & IFF_UP)  && \
             netif_running((slave)->dev)     && \
             ((slave)->link == BOND_LINK_UP) && \
             bond_is_active_slave(slave))


#define USES_PRIMARY(mode)              \
        (((mode) == BOND_MODE_ACTIVEBACKUP) ||  \
         ((mode) == BOND_MODE_TLB)          ||  \
         ((mode) == BOND_MODE_ALB))

#define TX_QUEUE_OVERRIDE(mode)             \
            (((mode) == BOND_MODE_ACTIVEBACKUP) ||  \
             ((mode) == BOND_MODE_ROUNDROBIN))
/*
 * Less bad way to call ioctl from within the kernel; this needs to be
 * done some other way to get the call out of interrupt context.
 * Needs "ioctl" variable to be supplied by calling context.
 */
#define IOCTL(dev, arg, cmd) ({     \
    int res = 0;            \
    mm_segment_t fs = get_fs(); \
    set_fs(get_ds());       \
    res = ioctl(dev, arg, cmd); \
    set_fs(fs);         \
    res; })

#define bond_for_each_slave_from(bond, pos, cnt, start) \
    for (cnt = 0, pos = start;              \
         cnt < (bond)->slave_cnt;               \
             cnt++, pos = (pos)->next)

#define bond_for_each_slave_from_to(bond, pos, cnt, start, stop)    \
    for (cnt = 0, pos = start;                  \
         ((cnt < (bond)->slave_cnt) && (pos != (stop)->next));  \
             cnt++, pos = (pos)->next)

#define bond_for_each_slave(bond, pos, cnt) \
        bond_for_each_slave_from(bond, pos, cnt, (bond)->first_slave)


#ifdef CONFIG_NET_POLL_CONTROLLER
extern atomic_t netpoll_block_tx;

static inline void block_netpoll_tx(void)
{
    atomic_inc(&netpoll_block_tx);
}

static inline void unblock_netpoll_tx(void)
{
    atomic_dec(&netpoll_block_tx);
}

static inline int is_netpoll_tx_blocked(struct net_device *dev)
{
    if (unlikely(netpoll_tx_running(dev)))
        return atomic_read(&netpoll_block_tx);
    return 0;
}
#else
#define block_netpoll_tx()
#define unblock_netpoll_tx()
#define is_netpoll_tx_blocked(dev) (0)
#endif

struct bond_params {
    int mode;
    int xmit_policy;
    int miimon;
    u8 num_peer_notif;
    int arp_interval;
    int arp_validate;
    int use_carrier;
    int fail_over_mac;
    int updelay;
    int downdelay;
    int lacp_fast;
    unsigned int min_links;
    int ad_select;
    char primary[IFNAMSIZ];
    int primary_reselect;
    __be32 arp_targets[BOND_MAX_ARP_TARGETS];
    int tx_queues;
    int all_slaves_active;
    int resend_igmp;
};

struct bond_parm_tbl {
    char *modename;
    int mode;
};

#define BOND_MAX_MODENAME_LEN 20

struct vlan_entry {
    struct list_head vlan_list;
    unsigned short vlan_id;
};

struct slave {
    struct net_device *dev; /* first - useful for panic debug */
    struct slave *next;
    struct slave *prev;
    struct bonding *bond; /* our master */
    int    delay;
    unsigned long jiffies;
    unsigned long last_arp_rx;
    s8     link;    /* one of BOND_LINK_XXXX */
    s8     new_link;
    u8     backup:1,   /* indicates backup slave. Value corresponds with
                  BOND_STATE_ACTIVE and BOND_STATE_BACKUP */
           inactive:1; /* indicates inactive slave */
    u8     duplex;
    u32    original_mtu;
    u32    link_failure_count;
    u32    speed;
    u16    queue_id;
    u8     perm_hwaddr[ETH_ALEN];
    struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */
    struct tlb_slave_info tlb_info;
#ifdef CONFIG_NET_POLL_CONTROLLER
    struct netpoll *np;
#endif
};

/*
 * Link pseudo-state only used internally by monitors
 */
#define BOND_LINK_NOCHANGE -1

/*
 * Here are the locking policies for the two bonding locks:
 *
 * 1) Get bond->lock when reading/writing slave list.
 * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
 *    (It is unnecessary when the write-lock is put with bond->lock.)
 * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
 *    beforehand.
 */
struct bonding {
    struct   net_device *dev; /* first - useful for panic debug */
    struct   slave *first_slave;
    struct   slave *curr_active_slave;
    struct   slave *current_arp_slave;
    struct   slave *primary_slave;
    bool     force_primary;
    s32      slave_cnt; /* never change this value outside the attach/detach wrappers */
    int     (*recv_probe)(const struct sk_buff *, struct bonding *,
                  struct slave *);
    rwlock_t lock;
    rwlock_t curr_slave_lock;
    u8   send_peer_notif;
    s8   setup_by_slave;
    s8       igmp_retrans;
#ifdef CONFIG_PROC_FS
    struct   proc_dir_entry *proc_entry;
    char     proc_file_name[IFNAMSIZ];
#endif /* CONFIG_PROC_FS */
    struct   list_head bond_list;
    struct   netdev_hw_addr_list mc_list;
    int      (*xmit_hash_policy)(struct sk_buff *, int);
    u16      rr_tx_counter;
    struct   ad_bond_info ad_info;
    struct   alb_bond_info alb_info;
    struct   bond_params params;
    struct   list_head vlan_list;
    struct   workqueue_struct *wq;
    struct   delayed_work mii_work;
    struct   delayed_work arp_work;
    struct   delayed_work alb_work;
    struct   delayed_work ad_work;
    struct   delayed_work mcast_work;
#ifdef CONFIG_DEBUG_FS
    /* debugging suport via debugfs */
    struct   dentry *debug_dir;
#endif /* CONFIG_DEBUG_FS */
};

static inline bool bond_vlan_used(struct bonding *bond)
{
    return !list_empty(&bond->vlan_list);
}

#define bond_slave_get_rcu(dev) \
    ((struct slave *) rcu_dereference(dev->rx_handler_data))

static inline struct slave *bond_get_slave_by_dev(struct bonding *bond,
                          struct net_device *slave_dev)
{
    struct slave *slave = NULL;
    int i;

    bond_for_each_slave(bond, slave, i) {
        if (slave->dev == slave_dev) {
            return slave;
        }
    }

    return NULL;
}

static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
{
    if (!slave || !slave->dev->master) {
        return NULL;
    }

    return netdev_priv(slave->dev->master);
}

static inline bool bond_is_lb(const struct bonding *bond)
{
    return (bond->params.mode == BOND_MODE_TLB ||
        bond->params.mode == BOND_MODE_ALB);
}

static inline void bond_set_active_slave(struct slave *slave)
{
    slave->backup = 0;
}

static inline void bond_set_backup_slave(struct slave *slave)
{
    slave->backup = 1;
}

static inline int bond_slave_state(struct slave *slave)
{
    return slave->backup;
}

static inline bool bond_is_active_slave(struct slave *slave)
{
    return !bond_slave_state(slave);
}

#define BOND_PRI_RESELECT_ALWAYS    0
#define BOND_PRI_RESELECT_BETTER    1
#define BOND_PRI_RESELECT_FAILURE   2

#define BOND_FOM_NONE           0
#define BOND_FOM_ACTIVE         1
#define BOND_FOM_FOLLOW         2

#define BOND_ARP_VALIDATE_NONE      0
#define BOND_ARP_VALIDATE_ACTIVE    (1 << BOND_STATE_ACTIVE)
#define BOND_ARP_VALIDATE_BACKUP    (1 << BOND_STATE_BACKUP)
#define BOND_ARP_VALIDATE_ALL       (BOND_ARP_VALIDATE_ACTIVE | \
                     BOND_ARP_VALIDATE_BACKUP)

static inline int slave_do_arp_validate(struct bonding *bond,
                    struct slave *slave)
{
    return bond->params.arp_validate & (1 << bond_slave_state(slave));
}

static inline unsigned long slave_last_rx(struct bonding *bond,
                    struct slave *slave)
{
    if (slave_do_arp_validate(bond, slave))
        return slave->last_arp_rx;

    return slave->dev->last_rx;
}

#ifdef CONFIG_NET_POLL_CONTROLLER
static inline void bond_netpoll_send_skb(const struct slave *slave,
                     struct sk_buff *skb)
{
    struct netpoll *np = slave->np;

    if (np)
        netpoll_send_skb(np, skb);
}
#else
static inline void bond_netpoll_send_skb(const struct slave *slave,
                     struct sk_buff *skb)
{
}
#endif

static inline void bond_set_slave_inactive_flags(struct slave *slave)
{
    struct bonding *bond = netdev_priv(slave->dev->master);
    if (!bond_is_lb(bond))
        bond_set_backup_slave(slave);
    if (!bond->params.all_slaves_active)
        slave->inactive = 1;
}

static inline void bond_set_slave_active_flags(struct slave *slave)
{
    bond_set_active_slave(slave);
    slave->inactive = 0;
}

static inline bool bond_is_slave_inactive(struct slave *slave)
{
    return slave->inactive;
}

static inline __be32 bond_confirm_addr(struct net_device *dev, __be32 dst, __be32 local)
{
    struct in_device *in_dev;
    __be32 addr = 0;

    rcu_read_lock();
    in_dev = __in_dev_get_rcu(dev);

    if (in_dev)
        addr = inet_confirm_addr(in_dev, dst, local, RT_SCOPE_HOST);

    rcu_read_unlock();
    return addr;
}

struct bond_net;

struct vlan_entry *bond_next_vlan(struct bonding *bond, struct vlan_entry *curr);
int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
int bond_create(struct net *net, const char *name);
int bond_create_sysfs(struct bond_net *net);
void bond_destroy_sysfs(struct bond_net *net);
void bond_prepare_sysfs_group(struct bonding *bond);
int bond_create_slave_symlinks(struct net_device *master, struct net_device *slave);
void bond_destroy_slave_symlinks(struct net_device *master, struct net_device *slave);
int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
void bond_mii_monitor(struct work_struct *);
void bond_loadbalance_arp_mon(struct work_struct *);
void bond_activebackup_arp_mon(struct work_struct *);
void bond_set_mode_ops(struct bonding *bond, int mode);
int bond_parse_parm(const char *mode_arg, const struct bond_parm_tbl *tbl);
void bond_select_active_slave(struct bonding *bond);
void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
void bond_create_debugfs(void);
void bond_destroy_debugfs(void);
void bond_debug_register(struct bonding *bond);
void bond_debug_unregister(struct bonding *bond);
void bond_debug_reregister(struct bonding *bond);
const char *bond_mode_name(int mode);

struct bond_net {
    struct net *        net;    /* Associated network namespace */
    struct list_head    dev_list;
#ifdef CONFIG_PROC_FS
    struct proc_dir_entry * proc_dir;
#endif
    struct class_attribute  class_attr_bonding_masters;
};

#ifdef CONFIG_PROC_FS
void bond_create_proc_entry(struct bonding *bond);
void bond_remove_proc_entry(struct bonding *bond);
void bond_create_proc_dir(struct bond_net *bn);
void bond_destroy_proc_dir(struct bond_net *bn);
#else
static inline void bond_create_proc_entry(struct bonding *bond)
{
}

static inline void bond_remove_proc_entry(struct bonding *bond)
{
}

static inline void bond_create_proc_dir(struct bond_net *bn)
{
}

static inline void bond_destroy_proc_dir(struct bond_net *bn)
{
}
#endif


/* exported from bond_main.c */
extern int bond_net_id;
extern const struct bond_parm_tbl bond_lacp_tbl[];
extern const struct bond_parm_tbl bond_mode_tbl[];
extern const struct bond_parm_tbl xmit_hashtype_tbl[];
extern const struct bond_parm_tbl arp_validate_tbl[];
extern const struct bond_parm_tbl fail_over_mac_tbl[];
extern const struct bond_parm_tbl pri_reselect_tbl[];
extern struct bond_parm_tbl ad_select_tbl[];

#endif /* _LINUX_BONDING_H */