blob: 801f088c134f81370bcca650c30e2a33c2dd6b05 [file] [log] [blame]
Jeff Garzik6aa20a22006-09-13 13:24:59 -04001/* drivers/net/ifb.c:
Jamal Hadi Salim253af422006-01-08 22:34:25 -08002
3 The purpose of this driver is to provide a device that allows
4 for sharing of resources:
5
6 1) qdiscs/policies that are per device as opposed to system wide.
7 ifb allows for a device which can be redirected to thus providing
8 an impression of sharing.
9
10 2) Allows for queueing incoming traffic for shaping instead of
Jeff Garzik6aa20a22006-09-13 13:24:59 -040011 dropping.
12
Jamal Hadi Salim253af422006-01-08 22:34:25 -080013 The original concept is based on what is known as the IMQ
14 driver initially written by Martin Devera, later rewritten
15 by Patrick McHardy and then maintained by Andre Correa.
16
17 You need the tc action mirror or redirect to feed this device
18 packets.
19
20 This program is free software; you can redistribute it and/or
21 modify it under the terms of the GNU General Public License
22 as published by the Free Software Foundation; either version
23 2 of the License, or (at your option) any later version.
Jeff Garzik6aa20a22006-09-13 13:24:59 -040024
Jamal Hadi Salim253af422006-01-08 22:34:25 -080025 Authors: Jamal Hadi Salim (2005)
Jeff Garzik6aa20a22006-09-13 13:24:59 -040026
Jamal Hadi Salim253af422006-01-08 22:34:25 -080027*/
28
29
Jamal Hadi Salim253af422006-01-08 22:34:25 -080030#include <linux/module.h>
31#include <linux/kernel.h>
32#include <linux/netdevice.h>
33#include <linux/etherdevice.h>
34#include <linux/init.h>
35#include <linux/moduleparam.h>
Jeff Garzik6aa20a22006-09-13 13:24:59 -040036#include <net/pkt_sched.h>
Eric W. Biederman881d9662007-09-17 11:56:21 -070037#include <net/net_namespace.h>
Jamal Hadi Salim253af422006-01-08 22:34:25 -080038
39#define TX_TIMEOUT (2*HZ)
Jeff Garzik6aa20a22006-09-13 13:24:59 -040040
Jamal Hadi Salim253af422006-01-08 22:34:25 -080041#define TX_Q_LIMIT 32
42struct ifb_private {
Jamal Hadi Salim253af422006-01-08 22:34:25 -080043 struct tasklet_struct ifb_tasklet;
44 int tasklet_pending;
45 /* mostly debug stats leave in for now */
46 unsigned long st_task_enter; /* tasklet entered */
47 unsigned long st_txq_refl_try; /* transmit queue refill attempt */
48 unsigned long st_rxq_enter; /* receive queue entered */
49 unsigned long st_rx2tx_tran; /* receive to trasmit transfers */
50 unsigned long st_rxq_notenter; /*receiveQ not entered, resched */
51 unsigned long st_rx_frm_egr; /* received from egress path */
52 unsigned long st_rx_frm_ing; /* received from ingress path */
53 unsigned long st_rxq_check;
54 unsigned long st_rxq_rsch;
55 struct sk_buff_head rq;
56 struct sk_buff_head tq;
57};
58
Richard Lucassen35eaa312006-02-23 16:23:51 -080059static int numifbs = 2;
Jamal Hadi Salim253af422006-01-08 22:34:25 -080060
61static void ri_tasklet(unsigned long dev);
Stephen Hemminger424efe92009-08-31 19:50:51 +000062static netdev_tx_t ifb_xmit(struct sk_buff *skb, struct net_device *dev);
Jamal Hadi Salim253af422006-01-08 22:34:25 -080063static int ifb_open(struct net_device *dev);
64static int ifb_close(struct net_device *dev);
65
Jeff Garzik6aa20a22006-09-13 13:24:59 -040066static void ri_tasklet(unsigned long dev)
Jamal Hadi Salim253af422006-01-08 22:34:25 -080067{
68
69 struct net_device *_dev = (struct net_device *)dev;
70 struct ifb_private *dp = netdev_priv(_dev);
Jeff Garzik09f75cd2007-10-03 17:41:50 -070071 struct net_device_stats *stats = &_dev->stats;
David S. Millerc3f26a22008-07-31 16:58:50 -070072 struct netdev_queue *txq;
Jamal Hadi Salim253af422006-01-08 22:34:25 -080073 struct sk_buff *skb;
74
David S. Millerc3f26a22008-07-31 16:58:50 -070075 txq = netdev_get_tx_queue(_dev, 0);
Jamal Hadi Salim253af422006-01-08 22:34:25 -080076 dp->st_task_enter++;
77 if ((skb = skb_peek(&dp->tq)) == NULL) {
78 dp->st_txq_refl_try++;
David S. Millerc3f26a22008-07-31 16:58:50 -070079 if (__netif_tx_trylock(txq)) {
Jamal Hadi Salim253af422006-01-08 22:34:25 -080080 dp->st_rxq_enter++;
81 while ((skb = skb_dequeue(&dp->rq)) != NULL) {
82 skb_queue_tail(&dp->tq, skb);
83 dp->st_rx2tx_tran++;
84 }
David S. Millerc3f26a22008-07-31 16:58:50 -070085 __netif_tx_unlock(txq);
Jamal Hadi Salim253af422006-01-08 22:34:25 -080086 } else {
87 /* reschedule */
88 dp->st_rxq_notenter++;
89 goto resched;
90 }
91 }
92
93 while ((skb = skb_dequeue(&dp->tq)) != NULL) {
94 u32 from = G_TC_FROM(skb->tc_verd);
95
96 skb->tc_verd = 0;
97 skb->tc_verd = SET_TC_NCLS(skb->tc_verd);
98 stats->tx_packets++;
99 stats->tx_bytes +=skb->len;
Patrick McHardyc01003c2007-03-29 11:46:52 -0700100
Eric W. Biederman881d9662007-09-17 11:56:21 -0700101 skb->dev = __dev_get_by_index(&init_net, skb->iif);
Patrick McHardyc01003c2007-03-29 11:46:52 -0700102 if (!skb->dev) {
103 dev_kfree_skb(skb);
104 stats->tx_dropped++;
105 break;
106 }
107 skb->iif = _dev->ifindex;
108
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800109 if (from & AT_EGRESS) {
110 dp->st_rx_frm_egr++;
111 dev_queue_xmit(skb);
112 } else if (from & AT_INGRESS) {
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800113 dp->st_rx_frm_ing++;
Patrick McHardyc01003c2007-03-29 11:46:52 -0700114 skb_pull(skb, skb->dev->hard_header_len);
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800115 netif_rx(skb);
Patrick McHardyc01003c2007-03-29 11:46:52 -0700116 } else
117 BUG();
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800118 }
119
David S. Millerc3f26a22008-07-31 16:58:50 -0700120 if (__netif_tx_trylock(txq)) {
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800121 dp->st_rxq_check++;
122 if ((skb = skb_peek(&dp->rq)) == NULL) {
123 dp->tasklet_pending = 0;
124 if (netif_queue_stopped(_dev))
125 netif_wake_queue(_dev);
126 } else {
127 dp->st_rxq_rsch++;
David S. Millerc3f26a22008-07-31 16:58:50 -0700128 __netif_tx_unlock(txq);
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800129 goto resched;
130 }
David S. Millerc3f26a22008-07-31 16:58:50 -0700131 __netif_tx_unlock(txq);
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800132 } else {
133resched:
134 dp->tasklet_pending = 1;
135 tasklet_schedule(&dp->ifb_tasklet);
136 }
137
138}
139
Stephen Hemminger8dfcdf32008-11-19 21:47:07 -0800140static const struct net_device_ops ifb_netdev_ops = {
Stephen Hemminger8dfcdf32008-11-19 21:47:07 -0800141 .ndo_open = ifb_open,
142 .ndo_stop = ifb_close,
Stephen Hemminger00829822008-11-20 20:14:53 -0800143 .ndo_start_xmit = ifb_xmit,
144 .ndo_validate_addr = eth_validate_addr,
Stephen Hemminger8dfcdf32008-11-19 21:47:07 -0800145};
146
Patrick McHardy9ba2cd62007-06-13 12:05:06 -0700147static void ifb_setup(struct net_device *dev)
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800148{
149 /* Initialize the device structure. */
Patrick McHardy9ba2cd62007-06-13 12:05:06 -0700150 dev->destructor = free_netdev;
Stephen Hemminger8dfcdf32008-11-19 21:47:07 -0800151 dev->netdev_ops = &ifb_netdev_ops;
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800152
153 /* Fill in device structure with ethernet-generic values. */
154 ether_setup(dev);
155 dev->tx_queue_len = TX_Q_LIMIT;
Stephen Hemminger8dfcdf32008-11-19 21:47:07 -0800156
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800157 dev->flags |= IFF_NOARP;
158 dev->flags &= ~IFF_MULTICAST;
Eric Dumazet93f154b2009-05-18 22:19:19 -0700159 dev->priv_flags &= ~IFF_XMIT_DST_RELEASE;
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800160 random_ether_addr(dev->dev_addr);
161}
162
Stephen Hemminger424efe92009-08-31 19:50:51 +0000163static netdev_tx_t ifb_xmit(struct sk_buff *skb, struct net_device *dev)
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800164{
165 struct ifb_private *dp = netdev_priv(dev);
Jeff Garzik09f75cd2007-10-03 17:41:50 -0700166 struct net_device_stats *stats = &dev->stats;
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800167 u32 from = G_TC_FROM(skb->tc_verd);
168
dean gaudet3136dcb2007-01-01 19:39:09 -0800169 stats->rx_packets++;
170 stats->rx_bytes+=skb->len;
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800171
Patrick McHardyc01003c2007-03-29 11:46:52 -0700172 if (!(from & (AT_INGRESS|AT_EGRESS)) || !skb->iif) {
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800173 dev_kfree_skb(skb);
174 stats->rx_dropped++;
Stephen Hemminger424efe92009-08-31 19:50:51 +0000175 return NETDEV_TX_OK;
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800176 }
177
178 if (skb_queue_len(&dp->rq) >= dev->tx_queue_len) {
179 netif_stop_queue(dev);
180 }
181
182 dev->trans_start = jiffies;
183 skb_queue_tail(&dp->rq, skb);
184 if (!dp->tasklet_pending) {
185 dp->tasklet_pending = 1;
186 tasklet_schedule(&dp->ifb_tasklet);
187 }
188
Stephen Hemminger424efe92009-08-31 19:50:51 +0000189 return NETDEV_TX_OK;
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800190}
191
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800192static int ifb_close(struct net_device *dev)
193{
194 struct ifb_private *dp = netdev_priv(dev);
195
196 tasklet_kill(&dp->ifb_tasklet);
197 netif_stop_queue(dev);
198 skb_queue_purge(&dp->rq);
199 skb_queue_purge(&dp->tq);
200 return 0;
201}
202
203static int ifb_open(struct net_device *dev)
204{
205 struct ifb_private *dp = netdev_priv(dev);
206
207 tasklet_init(&dp->ifb_tasklet, ri_tasklet, (unsigned long)dev);
208 skb_queue_head_init(&dp->rq);
209 skb_queue_head_init(&dp->tq);
210 netif_start_queue(dev);
211
212 return 0;
213}
214
Patrick McHardy0e068772007-07-11 19:42:31 -0700215static int ifb_validate(struct nlattr *tb[], struct nlattr *data[])
216{
217 if (tb[IFLA_ADDRESS]) {
218 if (nla_len(tb[IFLA_ADDRESS]) != ETH_ALEN)
219 return -EINVAL;
220 if (!is_valid_ether_addr(nla_data(tb[IFLA_ADDRESS])))
221 return -EADDRNOTAVAIL;
222 }
223 return 0;
224}
225
Patrick McHardy9ba2cd62007-06-13 12:05:06 -0700226static struct rtnl_link_ops ifb_link_ops __read_mostly = {
227 .kind = "ifb",
228 .priv_size = sizeof(struct ifb_private),
229 .setup = ifb_setup,
Patrick McHardy0e068772007-07-11 19:42:31 -0700230 .validate = ifb_validate,
Patrick McHardy9ba2cd62007-06-13 12:05:06 -0700231};
232
Patrick McHardy2d85cba2007-07-11 19:42:13 -0700233/* Number of ifb devices to be set up by this module. */
234module_param(numifbs, int, 0);
235MODULE_PARM_DESC(numifbs, "Number of ifb devices");
236
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800237static int __init ifb_init_one(int index)
238{
239 struct net_device *dev_ifb;
240 int err;
241
242 dev_ifb = alloc_netdev(sizeof(struct ifb_private),
243 "ifb%d", ifb_setup);
244
245 if (!dev_ifb)
246 return -ENOMEM;
247
Patrick McHardy9ba2cd62007-06-13 12:05:06 -0700248 err = dev_alloc_name(dev_ifb, dev_ifb->name);
249 if (err < 0)
250 goto err;
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800251
Patrick McHardy9ba2cd62007-06-13 12:05:06 -0700252 dev_ifb->rtnl_link_ops = &ifb_link_ops;
253 err = register_netdevice(dev_ifb);
254 if (err < 0)
255 goto err;
Jarek Poplawski94833df2008-03-20 17:05:13 -0700256
Patrick McHardy9ba2cd62007-06-13 12:05:06 -0700257 return 0;
258
259err:
260 free_netdev(dev_ifb);
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800261 return err;
262}
263
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800264static int __init ifb_init_module(void)
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400265{
Patrick McHardy9ba2cd62007-06-13 12:05:06 -0700266 int i, err;
267
268 rtnl_lock();
269 err = __rtnl_link_register(&ifb_link_ops);
Patrick McHardy62b7ffc2007-06-13 12:04:51 -0700270
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800271 for (i = 0; i < numifbs && !err; i++)
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400272 err = ifb_init_one(i);
Patrick McHardy2d85cba2007-07-11 19:42:13 -0700273 if (err)
Patrick McHardy9ba2cd62007-06-13 12:05:06 -0700274 __rtnl_link_unregister(&ifb_link_ops);
Patrick McHardy9ba2cd62007-06-13 12:05:06 -0700275 rtnl_unlock();
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800276
277 return err;
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400278}
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800279
280static void __exit ifb_cleanup_module(void)
281{
Patrick McHardy2d85cba2007-07-11 19:42:13 -0700282 rtnl_link_unregister(&ifb_link_ops);
Jamal Hadi Salim253af422006-01-08 22:34:25 -0800283}
284
285module_init(ifb_init_module);
286module_exit(ifb_cleanup_module);
287MODULE_LICENSE("GPL");
288MODULE_AUTHOR("Jamal Hadi Salim");
Patrick McHardy9ba2cd62007-06-13 12:05:06 -0700289MODULE_ALIAS_RTNL_LINK("ifb");