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