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 "bond_3ad.h" 23#include "bond_alb.h" 24 25#define DRV_VERSION "3.1.3" 26#define DRV_RELDATE "June 13, 2007" 27#define DRV_NAME "bonding" 28#define DRV_DESCRIPTION "Ethernet Channel Bonding Driver" 29 30#define BOND_MAX_ARP_TARGETS 16 31 32#ifdef BONDING_DEBUG 33#define dprintk(fmt, args...) \ 34 printk(KERN_DEBUG \ 35 DRV_NAME ": %s() %d: " fmt, __FUNCTION__, __LINE__ , ## args ) 36#else 37#define dprintk(fmt, args...) 38#endif /* BONDING_DEBUG */ 39 40#define IS_UP(dev) \ 41 ((((dev)->flags & IFF_UP) == IFF_UP) && \ 42 netif_running(dev) && \ 43 netif_carrier_ok(dev)) 44 45/* 46 * Checks whether bond is ready for transmit. 47 * 48 * Caller must hold bond->lock 49 */ 50#define BOND_IS_OK(bond) \ 51 (((bond)->dev->flags & IFF_UP) && \ 52 netif_running((bond)->dev) && \ 53 ((bond)->slave_cnt > 0)) 54 55/* 56 * Checks whether slave is ready for transmit. 57 */ 58#define SLAVE_IS_OK(slave) \ 59 (((slave)->dev->flags & IFF_UP) && \ 60 netif_running((slave)->dev) && \ 61 ((slave)->link == BOND_LINK_UP) && \ 62 ((slave)->state == BOND_STATE_ACTIVE)) 63 64 65#define USES_PRIMARY(mode) \ 66 (((mode) == BOND_MODE_ACTIVEBACKUP) || \ 67 ((mode) == BOND_MODE_TLB) || \ 68 ((mode) == BOND_MODE_ALB)) 69 70/* 71 * Less bad way to call ioctl from within the kernel; this needs to be 72 * done some other way to get the call out of interrupt context. 73 * Needs "ioctl" variable to be supplied by calling context. 74 */ 75#define IOCTL(dev, arg, cmd) ({ \ 76 int res = 0; \ 77 mm_segment_t fs = get_fs(); \ 78 set_fs(get_ds()); \ 79 res = ioctl(dev, arg, cmd); \ 80 set_fs(fs); \ 81 res; }) 82 83/** 84 * bond_for_each_slave_from - iterate the slaves list from a starting point 85 * @bond: the bond holding this list. 86 * @pos: current slave. 87 * @cnt: counter for max number of moves 88 * @start: starting point. 89 * 90 * Caller must hold bond->lock 91 */ 92#define bond_for_each_slave_from(bond, pos, cnt, start) \ 93 for (cnt = 0, pos = start; \ 94 cnt < (bond)->slave_cnt; \ 95 cnt++, pos = (pos)->next) 96 97/** 98 * bond_for_each_slave_from_to - iterate the slaves list from start point to stop point 99 * @bond: the bond holding this list. 100 * @pos: current slave. 101 * @cnt: counter for number max of moves 102 * @start: start point. 103 * @stop: stop point. 104 * 105 * Caller must hold bond->lock 106 */ 107#define bond_for_each_slave_from_to(bond, pos, cnt, start, stop) \ 108 for (cnt = 0, pos = start; \ 109 ((cnt < (bond)->slave_cnt) && (pos != (stop)->next)); \ 110 cnt++, pos = (pos)->next) 111 112/** 113 * bond_for_each_slave - iterate the slaves list from head 114 * @bond: the bond holding this list. 115 * @pos: current slave. 116 * @cnt: counter for max number of moves 117 * 118 * Caller must hold bond->lock 119 */ 120#define bond_for_each_slave(bond, pos, cnt) \ 121 bond_for_each_slave_from(bond, pos, cnt, (bond)->first_slave) 122 123 124struct bond_params { 125 int mode; 126 int xmit_policy; 127 int miimon; 128 int arp_interval; 129 int arp_validate; 130 int use_carrier; 131 int updelay; 132 int downdelay; 133 int lacp_fast; 134 char primary[IFNAMSIZ]; 135 u32 arp_targets[BOND_MAX_ARP_TARGETS]; 136}; 137 138struct bond_parm_tbl { 139 char *modename; 140 int mode; 141}; 142 143struct vlan_entry { 144 struct list_head vlan_list; 145 u32 vlan_ip; 146 unsigned short vlan_id; 147}; 148 149struct slave { 150 struct net_device *dev; /* first - useful for panic debug */ 151 struct slave *next; 152 struct slave *prev; 153 int delay; 154 unsigned long jiffies; 155 unsigned long last_arp_rx; 156 s8 link; /* one of BOND_LINK_XXXX */ 157 s8 state; /* one of BOND_STATE_XXXX */ 158 u32 original_flags; 159 u32 link_failure_count; 160 u16 speed; 161 u8 duplex; 162 u8 perm_hwaddr[ETH_ALEN]; 163 struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */ 164 struct tlb_slave_info tlb_info; 165}; 166 167/* 168 * Here are the locking policies for the two bonding locks: 169 * 170 * 1) Get bond->lock when reading/writing slave list. 171 * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave. 172 * (It is unnecessary when the write-lock is put with bond->lock.) 173 * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock 174 * beforehand. 175 */ 176struct bonding { 177 struct net_device *dev; /* first - useful for panic debug */ 178 struct slave *first_slave; 179 struct slave *curr_active_slave; 180 struct slave *current_arp_slave; 181 struct slave *primary_slave; 182 s32 slave_cnt; /* never change this value outside the attach/detach wrappers */ 183 rwlock_t lock; 184 rwlock_t curr_slave_lock; 185 struct timer_list mii_timer; 186 struct timer_list arp_timer; 187 s8 kill_timers; 188 struct net_device_stats stats; 189#ifdef CONFIG_PROC_FS 190 struct proc_dir_entry *proc_entry; 191 char proc_file_name[IFNAMSIZ]; 192#endif /* CONFIG_PROC_FS */ 193 struct list_head bond_list; 194 struct dev_mc_list *mc_list; 195 int (*xmit_hash_policy)(struct sk_buff *, struct net_device *, int); 196 u32 master_ip; 197 u16 flags; 198 struct ad_bond_info ad_info; 199 struct alb_bond_info alb_info; 200 struct bond_params params; 201 struct list_head vlan_list; 202 struct vlan_group *vlgrp; 203 struct packet_type arp_mon_pt; 204}; 205 206/** 207 * Returns NULL if the net_device does not belong to any of the bond's slaves 208 * 209 * Caller must hold bond lock for read 210 */ 211static inline struct slave *bond_get_slave_by_dev(struct bonding *bond, struct net_device *slave_dev) 212{ 213 struct slave *slave = NULL; 214 int i; 215 216 bond_for_each_slave(bond, slave, i) { 217 if (slave->dev == slave_dev) { 218 break; 219 } 220 } 221 222 return slave; 223} 224 225static inline struct bonding *bond_get_bond_by_slave(struct slave *slave) 226{ 227 if (!slave || !slave->dev->master) { 228 return NULL; 229 } 230 231 return (struct bonding *)slave->dev->master->priv; 232} 233 234#define BOND_ARP_VALIDATE_NONE 0 235#define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE) 236#define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP) 237#define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \ 238 BOND_ARP_VALIDATE_BACKUP) 239 240static inline int slave_do_arp_validate(struct bonding *bond, 241 struct slave *slave) 242{ 243 return bond->params.arp_validate & (1 << slave->state); 244} 245 246static inline unsigned long slave_last_rx(struct bonding *bond, 247 struct slave *slave) 248{ 249 if (slave_do_arp_validate(bond, slave)) 250 return slave->last_arp_rx; 251 252 return slave->dev->last_rx; 253} 254 255static inline void bond_set_slave_inactive_flags(struct slave *slave) 256{ 257 struct bonding *bond = slave->dev->master->priv; 258 if (bond->params.mode != BOND_MODE_TLB && 259 bond->params.mode != BOND_MODE_ALB) 260 slave->state = BOND_STATE_BACKUP; 261 slave->dev->priv_flags |= IFF_SLAVE_INACTIVE; 262 if (slave_do_arp_validate(bond, slave)) 263 slave->dev->priv_flags |= IFF_SLAVE_NEEDARP; 264} 265 266static inline void bond_set_slave_active_flags(struct slave *slave) 267{ 268 slave->state = BOND_STATE_ACTIVE; 269 slave->dev->priv_flags &= ~(IFF_SLAVE_INACTIVE | IFF_SLAVE_NEEDARP); 270} 271 272static inline void bond_set_master_3ad_flags(struct bonding *bond) 273{ 274 bond->dev->priv_flags |= IFF_MASTER_8023AD; 275} 276 277static inline void bond_unset_master_3ad_flags(struct bonding *bond) 278{ 279 bond->dev->priv_flags &= ~IFF_MASTER_8023AD; 280} 281 282static inline void bond_set_master_alb_flags(struct bonding *bond) 283{ 284 bond->dev->priv_flags |= IFF_MASTER_ALB; 285} 286 287static inline void bond_unset_master_alb_flags(struct bonding *bond) 288{ 289 bond->dev->priv_flags &= ~IFF_MASTER_ALB; 290} 291 292struct vlan_entry *bond_next_vlan(struct bonding *bond, struct vlan_entry *curr); 293int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev); 294int bond_create(char *name, struct bond_params *params, struct bonding **newbond); 295void bond_deinit(struct net_device *bond_dev); 296int bond_create_sysfs(void); 297void bond_destroy_sysfs(void); 298void bond_destroy_sysfs_entry(struct bonding *bond); 299int bond_create_sysfs_entry(struct bonding *bond); 300int bond_create_slave_symlinks(struct net_device *master, struct net_device *slave); 301void bond_destroy_slave_symlinks(struct net_device *master, struct net_device *slave); 302int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev); 303int bond_release(struct net_device *bond_dev, struct net_device *slave_dev); 304int bond_sethwaddr(struct net_device *bond_dev, struct net_device *slave_dev); 305void bond_mii_monitor(struct net_device *bond_dev); 306void bond_loadbalance_arp_mon(struct net_device *bond_dev); 307void bond_activebackup_arp_mon(struct net_device *bond_dev); 308void bond_set_mode_ops(struct bonding *bond, int mode); 309int bond_parse_parm(char *mode_arg, struct bond_parm_tbl *tbl); 310const char *bond_mode_name(int mode); 311void bond_select_active_slave(struct bonding *bond); 312void bond_change_active_slave(struct bonding *bond, struct slave *new_active); 313void bond_register_arp(struct bonding *); 314void bond_unregister_arp(struct bonding *); 315 316#endif /* _LINUX_BONDING_H */ 317