1 /* net/sched/sch_teql.c "True" (or "trivial") link equalizer.
3 * This program is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU General Public License
5 * as published by the Free Software Foundation; either version
6 * 2 of the License, or (at your option) any later version.
8 * Authors: Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
11 #include <linux/module.h>
12 #include <linux/types.h>
13 #include <linux/kernel.h>
14 #include <linux/slab.h>
15 #include <linux/string.h>
16 #include <linux/errno.h>
17 #include <linux/if_arp.h>
18 #include <linux/netdevice.h>
19 #include <linux/init.h>
20 #include <linux/skbuff.h>
21 #include <linux/moduleparam.h>
23 #include <net/neighbour.h>
24 #include <net/pkt_sched.h>
30 After loading this module you will find a new device teqlN
31 and new qdisc with the same name. To join a slave to the equalizer
32 you should just set this qdisc on a device f.e.
34 # tc qdisc add dev eth0 root teql0
35 # tc qdisc add dev eth1 root teql0
37 That's all. Full PnP 8)
42 1. Slave devices MUST be active devices, i.e., they must raise the tbusy
43 signal and generate EOI events. If you want to equalize virtual devices
44 like tunnels, use a normal eql device.
45 2. This device puts no limitations on physical slave characteristics
46 f.e. it will equalize 9600baud line and 100Mb ethernet perfectly :-)
47 Certainly, large difference in link speeds will make the resulting
48 eqalized link unusable, because of huge packet reordering.
49 I estimate an upper useful difference as ~10 times.
50 3. If the slave requires address resolution, only protocols using
51 neighbour cache (IPv4/IPv6) will work over the equalized link.
52 Other protocols are still allowed to use the slave device directly,
53 which will not break load balancing, though native slave
54 traffic will have the highest priority. */
57 struct Qdisc_ops qops
;
58 struct net_device
*dev
;
60 struct list_head master_list
;
61 unsigned long tx_bytes
;
62 unsigned long tx_packets
;
63 unsigned long tx_errors
;
64 unsigned long tx_dropped
;
67 struct teql_sched_data
{
69 struct teql_master
*m
;
70 struct neighbour
*ncache
;
71 struct sk_buff_head q
;
74 #define NEXT_SLAVE(q) (((struct teql_sched_data *)qdisc_priv(q))->next)
76 #define FMASK (IFF_BROADCAST | IFF_POINTOPOINT)
78 /* "teql*" qdisc routines */
81 teql_enqueue(struct sk_buff
*skb
, struct Qdisc
*sch
)
83 struct net_device
*dev
= qdisc_dev(sch
);
84 struct teql_sched_data
*q
= qdisc_priv(sch
);
86 if (q
->q
.qlen
< dev
->tx_queue_len
) {
87 __skb_queue_tail(&q
->q
, skb
);
88 return NET_XMIT_SUCCESS
;
96 static struct sk_buff
*
97 teql_dequeue(struct Qdisc
*sch
)
99 struct teql_sched_data
*dat
= qdisc_priv(sch
);
100 struct netdev_queue
*dat_queue
;
103 skb
= __skb_dequeue(&dat
->q
);
104 dat_queue
= netdev_get_tx_queue(dat
->m
->dev
, 0);
106 struct net_device
*m
= qdisc_dev(dat_queue
->qdisc
);
108 dat
->m
->slaves
= sch
;
112 qdisc_bstats_update(sch
, skb
);
114 sch
->q
.qlen
= dat
->q
.qlen
+ dat_queue
->qdisc
->q
.qlen
;
118 static struct sk_buff
*
119 teql_peek(struct Qdisc
*sch
)
121 /* teql is meant to be used as root qdisc */
126 teql_neigh_release(struct neighbour
*n
)
133 teql_reset(struct Qdisc
*sch
)
135 struct teql_sched_data
*dat
= qdisc_priv(sch
);
137 skb_queue_purge(&dat
->q
);
139 teql_neigh_release(xchg(&dat
->ncache
, NULL
));
143 teql_destroy(struct Qdisc
*sch
)
145 struct Qdisc
*q
, *prev
;
146 struct teql_sched_data
*dat
= qdisc_priv(sch
);
147 struct teql_master
*master
= dat
->m
;
149 prev
= master
->slaves
;
152 q
= NEXT_SLAVE(prev
);
154 NEXT_SLAVE(prev
) = NEXT_SLAVE(q
);
155 if (q
== master
->slaves
) {
156 master
->slaves
= NEXT_SLAVE(q
);
157 if (q
== master
->slaves
) {
158 struct netdev_queue
*txq
;
159 spinlock_t
*root_lock
;
161 txq
= netdev_get_tx_queue(master
->dev
, 0);
162 master
->slaves
= NULL
;
164 root_lock
= qdisc_root_sleeping_lock(txq
->qdisc
);
165 spin_lock_bh(root_lock
);
166 qdisc_reset(txq
->qdisc
);
167 spin_unlock_bh(root_lock
);
170 skb_queue_purge(&dat
->q
);
171 teql_neigh_release(xchg(&dat
->ncache
, NULL
));
175 } while ((prev
= q
) != master
->slaves
);
179 static int teql_qdisc_init(struct Qdisc
*sch
, struct nlattr
*opt
)
181 struct net_device
*dev
= qdisc_dev(sch
);
182 struct teql_master
*m
= (struct teql_master
*)sch
->ops
;
183 struct teql_sched_data
*q
= qdisc_priv(sch
);
185 if (dev
->hard_header_len
> m
->dev
->hard_header_len
)
193 skb_queue_head_init(&q
->q
);
196 if (m
->dev
->flags
& IFF_UP
) {
197 if ((m
->dev
->flags
& IFF_POINTOPOINT
&&
198 !(dev
->flags
& IFF_POINTOPOINT
)) ||
199 (m
->dev
->flags
& IFF_BROADCAST
&&
200 !(dev
->flags
& IFF_BROADCAST
)) ||
201 (m
->dev
->flags
& IFF_MULTICAST
&&
202 !(dev
->flags
& IFF_MULTICAST
)) ||
203 dev
->mtu
< m
->dev
->mtu
)
206 if (!(dev
->flags
&IFF_POINTOPOINT
))
207 m
->dev
->flags
&= ~IFF_POINTOPOINT
;
208 if (!(dev
->flags
&IFF_BROADCAST
))
209 m
->dev
->flags
&= ~IFF_BROADCAST
;
210 if (!(dev
->flags
&IFF_MULTICAST
))
211 m
->dev
->flags
&= ~IFF_MULTICAST
;
212 if (dev
->mtu
< m
->dev
->mtu
)
213 m
->dev
->mtu
= dev
->mtu
;
215 q
->next
= NEXT_SLAVE(m
->slaves
);
216 NEXT_SLAVE(m
->slaves
) = sch
;
220 m
->dev
->mtu
= dev
->mtu
;
221 m
->dev
->flags
= (m
->dev
->flags
&~FMASK
)|(dev
->flags
&FMASK
);
228 __teql_resolve(struct sk_buff
*skb
, struct sk_buff
*skb_res
,
229 struct net_device
*dev
, struct netdev_queue
*txq
,
230 struct neighbour
*mn
)
232 struct teql_sched_data
*q
= qdisc_priv(txq
->qdisc
);
233 struct neighbour
*n
= q
->ncache
;
237 if (n
&& n
->tbl
== mn
->tbl
&&
238 memcmp(n
->primary_key
, mn
->primary_key
, mn
->tbl
->key_len
) == 0) {
239 atomic_inc(&n
->refcnt
);
241 n
= __neigh_lookup_errno(mn
->tbl
, mn
->primary_key
, dev
);
245 if (neigh_event_send(n
, skb_res
) == 0) {
247 char haddr
[MAX_ADDR_LEN
];
249 neigh_ha_snapshot(haddr
, n
, dev
);
250 err
= dev_hard_header(skb
, dev
, ntohs(skb
->protocol
), haddr
,
257 teql_neigh_release(xchg(&q
->ncache
, n
));
261 return (skb_res
== NULL
) ? -EAGAIN
: 1;
264 static inline int teql_resolve(struct sk_buff
*skb
,
265 struct sk_buff
*skb_res
,
266 struct net_device
*dev
,
267 struct netdev_queue
*txq
)
269 struct dst_entry
*dst
= skb_dst(skb
);
270 struct neighbour
*mn
;
273 if (txq
->qdisc
== &noop_qdisc
)
276 if (!dev
->header_ops
|| !dst
)
280 mn
= dst_get_neighbour(dst
);
281 res
= mn
? __teql_resolve(skb
, skb_res
, dev
, txq
, mn
) : 0;
287 static netdev_tx_t
teql_master_xmit(struct sk_buff
*skb
, struct net_device
*dev
)
289 struct teql_master
*master
= netdev_priv(dev
);
290 struct Qdisc
*start
, *q
;
293 int subq
= skb_get_queue_mapping(skb
);
294 struct sk_buff
*skb_res
= NULL
;
296 start
= master
->slaves
;
307 struct net_device
*slave
= qdisc_dev(q
);
308 struct netdev_queue
*slave_txq
= netdev_get_tx_queue(slave
, 0);
309 const struct net_device_ops
*slave_ops
= slave
->netdev_ops
;
311 if (slave_txq
->qdisc_sleeping
!= q
)
313 if (__netif_subqueue_stopped(slave
, subq
) ||
314 !netif_running(slave
)) {
319 switch (teql_resolve(skb
, skb_res
, slave
, slave_txq
)) {
321 if (__netif_tx_trylock(slave_txq
)) {
322 unsigned int length
= qdisc_pkt_len(skb
);
324 if (!netif_tx_queue_frozen_or_stopped(slave_txq
) &&
325 slave_ops
->ndo_start_xmit(skb
, slave
) == NETDEV_TX_OK
) {
326 txq_trans_update(slave_txq
);
327 __netif_tx_unlock(slave_txq
);
328 master
->slaves
= NEXT_SLAVE(q
);
329 netif_wake_queue(dev
);
330 master
->tx_packets
++;
331 master
->tx_bytes
+= length
;
334 __netif_tx_unlock(slave_txq
);
336 if (netif_queue_stopped(dev
))
340 master
->slaves
= NEXT_SLAVE(q
);
346 __skb_pull(skb
, skb_network_offset(skb
));
347 } while ((q
= NEXT_SLAVE(q
)) != start
);
349 if (nores
&& skb_res
== NULL
) {
355 netif_stop_queue(dev
);
356 return NETDEV_TX_BUSY
;
361 master
->tx_dropped
++;
366 static int teql_master_open(struct net_device
*dev
)
369 struct teql_master
*m
= netdev_priv(dev
);
371 unsigned int flags
= IFF_NOARP
| IFF_MULTICAST
;
373 if (m
->slaves
== NULL
)
380 struct net_device
*slave
= qdisc_dev(q
);
385 if (slave
->mtu
< mtu
)
387 if (slave
->hard_header_len
> LL_MAX_HEADER
)
390 /* If all the slaves are BROADCAST, master is BROADCAST
391 If all the slaves are PtP, master is PtP
392 Otherwise, master is NBMA.
394 if (!(slave
->flags
&IFF_POINTOPOINT
))
395 flags
&= ~IFF_POINTOPOINT
;
396 if (!(slave
->flags
&IFF_BROADCAST
))
397 flags
&= ~IFF_BROADCAST
;
398 if (!(slave
->flags
&IFF_MULTICAST
))
399 flags
&= ~IFF_MULTICAST
;
400 } while ((q
= NEXT_SLAVE(q
)) != m
->slaves
);
403 m
->dev
->flags
= (m
->dev
->flags
&~FMASK
) | flags
;
404 netif_start_queue(m
->dev
);
408 static int teql_master_close(struct net_device
*dev
)
410 netif_stop_queue(dev
);
414 static struct rtnl_link_stats64
*teql_master_stats64(struct net_device
*dev
,
415 struct rtnl_link_stats64
*stats
)
417 struct teql_master
*m
= netdev_priv(dev
);
419 stats
->tx_packets
= m
->tx_packets
;
420 stats
->tx_bytes
= m
->tx_bytes
;
421 stats
->tx_errors
= m
->tx_errors
;
422 stats
->tx_dropped
= m
->tx_dropped
;
426 static int teql_master_mtu(struct net_device
*dev
, int new_mtu
)
428 struct teql_master
*m
= netdev_priv(dev
);
437 if (new_mtu
> qdisc_dev(q
)->mtu
)
439 } while ((q
= NEXT_SLAVE(q
)) != m
->slaves
);
446 static const struct net_device_ops teql_netdev_ops
= {
447 .ndo_open
= teql_master_open
,
448 .ndo_stop
= teql_master_close
,
449 .ndo_start_xmit
= teql_master_xmit
,
450 .ndo_get_stats64
= teql_master_stats64
,
451 .ndo_change_mtu
= teql_master_mtu
,
454 static __init
void teql_master_setup(struct net_device
*dev
)
456 struct teql_master
*master
= netdev_priv(dev
);
457 struct Qdisc_ops
*ops
= &master
->qops
;
460 ops
->priv_size
= sizeof(struct teql_sched_data
);
462 ops
->enqueue
= teql_enqueue
;
463 ops
->dequeue
= teql_dequeue
;
464 ops
->peek
= teql_peek
;
465 ops
->init
= teql_qdisc_init
;
466 ops
->reset
= teql_reset
;
467 ops
->destroy
= teql_destroy
;
468 ops
->owner
= THIS_MODULE
;
470 dev
->netdev_ops
= &teql_netdev_ops
;
471 dev
->type
= ARPHRD_VOID
;
473 dev
->tx_queue_len
= 100;
474 dev
->flags
= IFF_NOARP
;
475 dev
->hard_header_len
= LL_MAX_HEADER
;
476 dev
->priv_flags
&= ~IFF_XMIT_DST_RELEASE
;
479 static LIST_HEAD(master_dev_list
);
480 static int max_equalizers
= 1;
481 module_param(max_equalizers
, int, 0);
482 MODULE_PARM_DESC(max_equalizers
, "Max number of link equalizers");
484 static int __init
teql_init(void)
489 for (i
= 0; i
< max_equalizers
; i
++) {
490 struct net_device
*dev
;
491 struct teql_master
*master
;
493 dev
= alloc_netdev(sizeof(struct teql_master
),
494 "teql%d", teql_master_setup
);
500 if ((err
= register_netdev(dev
))) {
505 master
= netdev_priv(dev
);
507 strlcpy(master
->qops
.id
, dev
->name
, IFNAMSIZ
);
508 err
= register_qdisc(&master
->qops
);
511 unregister_netdev(dev
);
516 list_add_tail(&master
->master_list
, &master_dev_list
);
521 static void __exit
teql_exit(void)
523 struct teql_master
*master
, *nxt
;
525 list_for_each_entry_safe(master
, nxt
, &master_dev_list
, master_list
) {
527 list_del(&master
->master_list
);
529 unregister_qdisc(&master
->qops
);
530 unregister_netdev(master
->dev
);
531 free_netdev(master
->dev
);
535 module_init(teql_init
);
536 module_exit(teql_exit
);
538 MODULE_LICENSE("GPL");