2 * Equalizer Load-balancer for serial network interfaces.
4 * (c) Copyright 1995 Simon "Guru Aleph-Null" Janes
5 * NCM: Network and Communications Management, Inc.
7 * (c) Copyright 2002 David S. Miller (davem@redhat.com)
9 * This software may be used and distributed according to the terms
10 * of the GNU General Public License, incorporated herein by reference.
12 * The author may be reached as simon@ncm.com, or C/O
17 * Phone: 1-703-847-0040 ext 103
22 * skeleton.c by Donald Becker.
24 * The Harried and Overworked Alan Cox
26 * The Alan Cox and Mike McLagan plot to get someone else to do the code,
27 * which turned out to be me.
32 * Revision 1.2 1996/04/11 17:51:52 guru
33 * Added one-line eql_remove_slave patch.
35 * Revision 1.1 1996/04/11 17:44:17 guru
38 * Revision 3.13 1996/01/21 15:17:18 alan
39 * tx_queue_len changes.
42 * Revision 3.12 1995/03/22 21:07:51 anarchy
43 * Added capable() checks on configuration.
46 * Revision 3.11 1995/01/19 23:14:31 guru
47 * slave_load = (ULONG_MAX - (ULONG_MAX / 2)) -
48 * (priority_Bps) + bytes_queued * 8;
50 * Revision 3.10 1995/01/19 23:07:53 guru
52 * slave_load = (ULONG_MAX - (ULONG_MAX / 2)) -
53 * (priority_Bps) + bytes_queued;
55 * Revision 3.9 1995/01/19 22:38:20 guru
56 * slave_load = (ULONG_MAX - (ULONG_MAX / 2)) -
57 * (priority_Bps) + bytes_queued * 4;
59 * Revision 3.8 1995/01/19 22:30:55 guru
60 * slave_load = (ULONG_MAX - (ULONG_MAX / 2)) -
61 * (priority_Bps) + bytes_queued * 2;
63 * Revision 3.7 1995/01/19 21:52:35 guru
64 * printk's trimmed out.
66 * Revision 3.6 1995/01/19 21:49:56 guru
67 * This is working pretty well. I gained 1 K/s in speed.. now it's just
68 * robustness and printk's to be diked out.
70 * Revision 3.5 1995/01/18 22:29:59 guru
71 * still crashes the kernel when the lock_wait thing is woken up.
73 * Revision 3.4 1995/01/18 21:59:47 guru
74 * Broken set-bit locking snapshot
76 * Revision 3.3 1995/01/17 22:09:18 guru
77 * infinite sleep in a lock somewhere..
79 * Revision 3.2 1995/01/15 16:46:06 guru
80 * Log trimmed of non-pertinent 1.x branch messages
82 * Revision 3.1 1995/01/15 14:41:45 guru
83 * New Scheduler and timer stuff...
85 * Revision 1.15 1995/01/15 14:29:02 guru
86 * Will make 1.14 (now 1.15) the 3.0 branch, and the 1.12 the 2.0 branch, the one
87 * with the dumber scheduler
89 * Revision 1.14 1995/01/15 02:37:08 guru
90 * shock.. the kept-new-versions could have zonked working
93 * Revision 1.13 1995/01/15 02:36:31 guru
96 * scheduler was torn out and replaced with something smarter
98 * global names not prefixed with eql_ were renamed to protect
99 * against namespace collisions
101 * a few more abstract interfaces were added to facilitate any
102 * potential change of datastructure. the driver is still using
103 * a linked list of slaves. going to a heap would be a bit of
106 * this compiles fine with no warnings.
108 * the locking mechanism and timer stuff must be written however,
109 * this version will not work otherwise
111 * Sorry, I had to rewrite most of this for 2.5.x -DaveM
114 #include <linux/module.h>
115 #include <linux/kernel.h>
116 #include <linux/init.h>
117 #include <linux/timer.h>
118 #include <linux/netdevice.h>
119 #include <net/net_namespace.h>
121 #include <linux/if.h>
122 #include <linux/if_arp.h>
123 #include <linux/if_eql.h>
125 #include <asm/uaccess.h>
127 static int eql_open(struct net_device *dev);
128 static int eql_close(struct net_device *dev);
129 static int eql_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd);
130 static int eql_slave_xmit(struct sk_buff *skb, struct net_device *dev);
131 static struct net_device_stats *eql_get_stats(struct net_device *dev);
133 #define eql_is_slave(dev) ((dev->flags & IFF_SLAVE) == IFF_SLAVE)
134 #define eql_is_master(dev) ((dev->flags & IFF_MASTER) == IFF_MASTER)
136 static void eql_kill_one_slave(slave_queue_t *queue, slave_t *slave);
138 static void eql_timer(unsigned long param)
140 equalizer_t *eql = (equalizer_t *) param;
141 struct list_head *this, *tmp, *head;
143 spin_lock_bh(&eql->queue.lock);
144 head = &eql->queue.all_slaves;
145 list_for_each_safe(this, tmp, head) {
146 slave_t *slave = list_entry(this, slave_t, list);
148 if ((slave->dev->flags & IFF_UP) == IFF_UP) {
149 slave->bytes_queued -= slave->priority_Bps;
150 if (slave->bytes_queued < 0)
151 slave->bytes_queued = 0;
153 eql_kill_one_slave(&eql->queue, slave);
157 spin_unlock_bh(&eql->queue.lock);
159 eql->timer.expires = jiffies + EQL_DEFAULT_RESCHED_IVAL;
160 add_timer(&eql->timer);
163 static char version[] __initdata =
164 "Equalizer2002: Simon Janes (simon@ncm.com) and David S. Miller (davem@redhat.com)\n";
166 static void __init eql_setup(struct net_device *dev)
168 equalizer_t *eql = netdev_priv(dev);
170 init_timer(&eql->timer);
171 eql->timer.data = (unsigned long) eql;
172 eql->timer.expires = jiffies + EQL_DEFAULT_RESCHED_IVAL;
173 eql->timer.function = eql_timer;
175 spin_lock_init(&eql->queue.lock);
176 INIT_LIST_HEAD(&eql->queue.all_slaves);
177 eql->queue.master_dev = dev;
179 dev->open = eql_open;
180 dev->stop = eql_close;
181 dev->do_ioctl = eql_ioctl;
182 dev->hard_start_xmit = eql_slave_xmit;
183 dev->get_stats = eql_get_stats;
186 * Now we undo some of the things that eth_setup does
190 dev->mtu = EQL_DEFAULT_MTU; /* set to 576 in if_eql.h */
191 dev->flags = IFF_MASTER;
193 dev->type = ARPHRD_SLIP;
194 dev->tx_queue_len = 5; /* Hands them off fast */
197 static int eql_open(struct net_device *dev)
199 equalizer_t *eql = netdev_priv(dev);
201 /* XXX We should force this off automatically for the user. */
202 printk(KERN_INFO "%s: remember to turn off Van-Jacobson compression on "
203 "your slave devices.\n", dev->name);
205 BUG_ON(!list_empty(&eql->queue.all_slaves));
208 eql->max_slaves = EQL_DEFAULT_MAX_SLAVES; /* 4 usually... */
210 add_timer(&eql->timer);
215 static void eql_kill_one_slave(slave_queue_t *queue, slave_t *slave)
217 list_del(&slave->list);
219 slave->dev->flags &= ~IFF_SLAVE;
224 static void eql_kill_slave_queue(slave_queue_t *queue)
226 struct list_head *head, *tmp, *this;
228 spin_lock_bh(&queue->lock);
230 head = &queue->all_slaves;
231 list_for_each_safe(this, tmp, head) {
232 slave_t *s = list_entry(this, slave_t, list);
234 eql_kill_one_slave(queue, s);
237 spin_unlock_bh(&queue->lock);
240 static int eql_close(struct net_device *dev)
242 equalizer_t *eql = netdev_priv(dev);
245 * The timer has to be stopped first before we start hacking away
246 * at the data structure it scans every so often...
249 del_timer_sync(&eql->timer);
251 eql_kill_slave_queue(&eql->queue);
256 static int eql_enslave(struct net_device *dev, slaving_request_t __user *srq);
257 static int eql_emancipate(struct net_device *dev, slaving_request_t __user *srq);
259 static int eql_g_slave_cfg(struct net_device *dev, slave_config_t __user *sc);
260 static int eql_s_slave_cfg(struct net_device *dev, slave_config_t __user *sc);
262 static int eql_g_master_cfg(struct net_device *dev, master_config_t __user *mc);
263 static int eql_s_master_cfg(struct net_device *dev, master_config_t __user *mc);
265 static int eql_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
267 if (cmd != EQL_GETMASTRCFG && cmd != EQL_GETSLAVECFG &&
268 !capable(CAP_NET_ADMIN))
273 return eql_enslave(dev, ifr->ifr_data);
275 return eql_emancipate(dev, ifr->ifr_data);
276 case EQL_GETSLAVECFG:
277 return eql_g_slave_cfg(dev, ifr->ifr_data);
278 case EQL_SETSLAVECFG:
279 return eql_s_slave_cfg(dev, ifr->ifr_data);
280 case EQL_GETMASTRCFG:
281 return eql_g_master_cfg(dev, ifr->ifr_data);
282 case EQL_SETMASTRCFG:
283 return eql_s_master_cfg(dev, ifr->ifr_data);
289 /* queue->lock must be held */
290 static slave_t *__eql_schedule_slaves(slave_queue_t *queue)
292 unsigned long best_load = ~0UL;
293 struct list_head *this, *tmp, *head;
298 /* Make a pass to set the best slave. */
299 head = &queue->all_slaves;
300 list_for_each_safe(this, tmp, head) {
301 slave_t *slave = list_entry(this, slave_t, list);
302 unsigned long slave_load, bytes_queued, priority_Bps;
304 /* Go through the slave list once, updating best_slave
305 * whenever a new best_load is found.
307 bytes_queued = slave->bytes_queued;
308 priority_Bps = slave->priority_Bps;
309 if ((slave->dev->flags & IFF_UP) == IFF_UP) {
310 slave_load = (~0UL - (~0UL / 2)) -
311 (priority_Bps) + bytes_queued * 8;
313 if (slave_load < best_load) {
314 best_load = slave_load;
318 /* We found a dead slave, kill it. */
319 eql_kill_one_slave(queue, slave);
325 static int eql_slave_xmit(struct sk_buff *skb, struct net_device *dev)
327 equalizer_t *eql = netdev_priv(dev);
330 spin_lock(&eql->queue.lock);
332 slave = __eql_schedule_slaves(&eql->queue);
334 struct net_device *slave_dev = slave->dev;
336 skb->dev = slave_dev;
338 slave->bytes_queued += skb->len;
340 eql->stats.tx_packets++;
342 eql->stats.tx_dropped++;
346 spin_unlock(&eql->queue.lock);
351 static struct net_device_stats * eql_get_stats(struct net_device *dev)
353 equalizer_t *eql = netdev_priv(dev);
358 * Private ioctl functions
361 /* queue->lock must be held */
362 static slave_t *__eql_find_slave_dev(slave_queue_t *queue, struct net_device *dev)
364 struct list_head *this, *head;
366 head = &queue->all_slaves;
367 list_for_each(this, head) {
368 slave_t *slave = list_entry(this, slave_t, list);
370 if (slave->dev == dev)
377 static inline int eql_is_full(slave_queue_t *queue)
379 equalizer_t *eql = netdev_priv(queue->master_dev);
381 if (queue->num_slaves >= eql->max_slaves)
386 /* queue->lock must be held */
387 static int __eql_insert_slave(slave_queue_t *queue, slave_t *slave)
389 if (!eql_is_full(queue)) {
390 slave_t *duplicate_slave = NULL;
392 duplicate_slave = __eql_find_slave_dev(queue, slave->dev);
394 eql_kill_one_slave(queue, duplicate_slave);
396 list_add(&slave->list, &queue->all_slaves);
398 slave->dev->flags |= IFF_SLAVE;
406 static int eql_enslave(struct net_device *master_dev, slaving_request_t __user *srqp)
408 struct net_device *slave_dev;
409 slaving_request_t srq;
411 if (copy_from_user(&srq, srqp, sizeof (slaving_request_t)))
414 slave_dev = dev_get_by_name(&init_net, srq.slave_name);
416 if ((master_dev->flags & IFF_UP) == IFF_UP) {
417 /* slave is not a master & not already a slave: */
418 if (!eql_is_master(slave_dev) &&
419 !eql_is_slave(slave_dev)) {
420 slave_t *s = kmalloc(sizeof(*s), GFP_KERNEL);
421 equalizer_t *eql = netdev_priv(master_dev);
429 memset(s, 0, sizeof(*s));
431 s->priority = srq.priority;
432 s->priority_bps = srq.priority;
433 s->priority_Bps = srq.priority / 8;
435 spin_lock_bh(&eql->queue.lock);
436 ret = __eql_insert_slave(&eql->queue, s);
441 spin_unlock_bh(&eql->queue.lock);
452 static int eql_emancipate(struct net_device *master_dev, slaving_request_t __user *srqp)
454 equalizer_t *eql = netdev_priv(master_dev);
455 struct net_device *slave_dev;
456 slaving_request_t srq;
459 if (copy_from_user(&srq, srqp, sizeof (slaving_request_t)))
462 slave_dev = dev_get_by_name(&init_net, srq.slave_name);
465 spin_lock_bh(&eql->queue.lock);
467 if (eql_is_slave(slave_dev)) {
468 slave_t *slave = __eql_find_slave_dev(&eql->queue,
472 eql_kill_one_slave(&eql->queue, slave);
478 spin_unlock_bh(&eql->queue.lock);
484 static int eql_g_slave_cfg(struct net_device *dev, slave_config_t __user *scp)
486 equalizer_t *eql = netdev_priv(dev);
488 struct net_device *slave_dev;
492 if (copy_from_user(&sc, scp, sizeof (slave_config_t)))
495 slave_dev = dev_get_by_name(&init_net, sc.slave_name);
501 spin_lock_bh(&eql->queue.lock);
502 if (eql_is_slave(slave_dev)) {
503 slave = __eql_find_slave_dev(&eql->queue, slave_dev);
505 sc.priority = slave->priority;
509 spin_unlock_bh(&eql->queue.lock);
513 if (!ret && copy_to_user(scp, &sc, sizeof (slave_config_t)))
519 static int eql_s_slave_cfg(struct net_device *dev, slave_config_t __user *scp)
523 struct net_device *slave_dev;
527 if (copy_from_user(&sc, scp, sizeof (slave_config_t)))
530 slave_dev = dev_get_by_name(&init_net, sc.slave_name);
536 eql = netdev_priv(dev);
537 spin_lock_bh(&eql->queue.lock);
538 if (eql_is_slave(slave_dev)) {
539 slave = __eql_find_slave_dev(&eql->queue, slave_dev);
541 slave->priority = sc.priority;
542 slave->priority_bps = sc.priority;
543 slave->priority_Bps = sc.priority / 8;
547 spin_unlock_bh(&eql->queue.lock);
552 static int eql_g_master_cfg(struct net_device *dev, master_config_t __user *mcp)
557 if (eql_is_master(dev)) {
558 eql = netdev_priv(dev);
559 mc.max_slaves = eql->max_slaves;
560 mc.min_slaves = eql->min_slaves;
561 if (copy_to_user(mcp, &mc, sizeof (master_config_t)))
568 static int eql_s_master_cfg(struct net_device *dev, master_config_t __user *mcp)
573 if (copy_from_user(&mc, mcp, sizeof (master_config_t)))
576 if (eql_is_master(dev)) {
577 eql = netdev_priv(dev);
578 eql->max_slaves = mc.max_slaves;
579 eql->min_slaves = mc.min_slaves;
585 static struct net_device *dev_eql;
587 static int __init eql_init_module(void)
593 dev_eql = alloc_netdev(sizeof(equalizer_t), "eql", eql_setup);
597 err = register_netdev(dev_eql);
599 free_netdev(dev_eql);
603 static void __exit eql_cleanup_module(void)
605 unregister_netdev(dev_eql);
606 free_netdev(dev_eql);
609 module_init(eql_init_module);
610 module_exit(eql_cleanup_module);
611 MODULE_LICENSE("GPL");