Fix build on Linux 2.6.26.
[sliver-openvswitch.git] / datapath / datapath.c
1 /*
2  * Distributed under the terms of the GNU GPL version 2.
3  * Copyright (c) 2007, 2008 The Board of Trustees of The Leland 
4  * Stanford Junior University
5  */
6
7 /* Functions for managing the dp interface/device. */
8
9 #include <linux/init.h>
10 #include <linux/module.h>
11 #include <linux/if_arp.h>
12 #include <linux/if_bridge.h>
13 #include <linux/if_vlan.h>
14 #include <linux/in.h>
15 #include <net/genetlink.h>
16 #include <linux/ip.h>
17 #include <linux/delay.h>
18 #include <linux/etherdevice.h>
19 #include <linux/kernel.h>
20 #include <linux/kthread.h>
21 #include <linux/mutex.h>
22 #include <linux/rtnetlink.h>
23 #include <linux/rcupdate.h>
24 #include <linux/version.h>
25 #include <linux/ethtool.h>
26 #include <linux/random.h>
27 #include <asm/system.h>
28 #include <linux/netfilter_bridge.h>
29 #include <linux/inetdevice.h>
30 #include <linux/list.h>
31 #include <linux/rculist.h>
32
33 #include "openflow-netlink.h"
34 #include "datapath.h"
35 #include "table.h"
36 #include "chain.h"
37 #include "dp_dev.h"
38 #include "forward.h"
39 #include "flow.h"
40
41 #include "compat.h"
42
43
44 /* Number of milliseconds between runs of the maintenance thread. */
45 #define MAINT_SLEEP_MSECS 1000
46
47 #define BRIDGE_PORT_NO_FLOOD    0x00000001 
48
49 #define UINT32_MAX                        4294967295U
50 #define UINT16_MAX                        65535
51 #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
52
53 struct net_bridge_port {
54         u16     port_no;
55         u32 flags;
56         struct datapath *dp;
57         struct net_device *dev;
58         struct list_head node; /* Element in datapath.ports. */
59 };
60
61 static struct genl_family dp_genl_family;
62 static struct genl_multicast_group mc_group;
63
64 /* It's hard to imagine wanting more than one datapath, but... */
65 #define DP_MAX 32
66
67 /* datapaths.  Protected on the read side by rcu_read_lock, on the write side
68  * by dp_mutex.
69  *
70  * It is safe to access the datapath and net_bridge_port structures with just
71  * the dp_mutex, but to access the chain you need to take the rcu_read_lock
72  * also (because dp_mutex doesn't prevent flows from being destroyed).
73  */
74 static struct datapath *dps[DP_MAX];
75 static DEFINE_MUTEX(dp_mutex);
76
77 static int dp_maint_func(void *data);
78 static int send_port_status(struct net_bridge_port *p, uint8_t status);
79 static int dp_genl_openflow_done(struct netlink_callback *);
80 static struct net_bridge_port *new_nbp(struct datapath *,
81                                        struct net_device *, int port_no);
82 static int del_switch_port(struct net_bridge_port *);
83
84 /* nla_shrink - reduce amount of space reserved by nla_reserve
85  * @skb: socket buffer from which to recover room
86  * @nla: netlink attribute to adjust
87  * @len: new length of attribute payload
88  *
89  * Reduces amount of space reserved by a call to nla_reserve.
90  *
91  * No other attributes may be added between calling nla_reserve and this
92  * function, since it will create a hole in the message.
93  */
94 void nla_shrink(struct sk_buff *skb, struct nlattr *nla, int len)
95 {
96         int delta = nla_total_size(len) - nla_total_size(nla_len(nla));
97         BUG_ON(delta > 0);
98         skb->tail += delta;
99         skb->len  += delta;
100         nla->nla_len = nla_attr_size(len);
101 }
102
103 /* Puts a set of openflow headers for a message of the given 'type' into 'skb'.
104  * If 'sender' is nonnull, then it is used as the message's destination.  'dp'
105  * must specify the datapath to use.
106  *
107  * '*max_openflow_len' receives the maximum number of bytes that are available
108  * for the embedded OpenFlow message.  The caller must call
109  * resize_openflow_skb() to set the actual size of the message to this number
110  * of bytes or less.
111  *
112  * Returns the openflow header if successful, otherwise (if 'skb' is too small)
113  * an error code. */
114 static void *
115 put_openflow_headers(struct datapath *dp, struct sk_buff *skb, uint8_t type,
116                      const struct sender *sender, int *max_openflow_len)
117 {
118         struct ofp_header *oh;
119         struct nlattr *attr;
120         int openflow_len;
121
122         /* Assemble the Generic Netlink wrapper. */
123         if (!genlmsg_put(skb,
124                          sender ? sender->pid : 0,
125                          sender ? sender->seq : 0,
126                          &dp_genl_family, 0, DP_GENL_C_OPENFLOW))
127                 return ERR_PTR(-ENOBUFS);
128         if (nla_put_u32(skb, DP_GENL_A_DP_IDX, dp->dp_idx) < 0)
129                 return ERR_PTR(-ENOBUFS);
130         openflow_len = (skb_tailroom(skb) - NLA_HDRLEN) & ~(NLA_ALIGNTO - 1);
131         if (openflow_len < sizeof *oh)
132                 return ERR_PTR(-ENOBUFS);
133         *max_openflow_len = openflow_len;
134         attr = nla_reserve(skb, DP_GENL_A_OPENFLOW, openflow_len);
135         BUG_ON(!attr);
136
137         /* Fill in the header.  The caller is responsible for the length. */
138         oh = nla_data(attr);
139         oh->version = OFP_VERSION;
140         oh->type = type;
141         oh->xid = sender ? sender->xid : 0;
142
143         return oh;
144 }
145
146 /* Resizes OpenFlow header 'oh', which must be at the tail end of 'skb', to new
147  * length 'new_length' (in bytes), adjusting pointers and size values as
148  * necessary. */
149 static void
150 resize_openflow_skb(struct sk_buff *skb,
151                     struct ofp_header *oh, size_t new_length)
152 {
153         struct nlattr *attr = ((void *) oh) - NLA_HDRLEN;
154         nla_shrink(skb, attr, new_length);
155         oh->length = htons(new_length);
156         nlmsg_end(skb, (struct nlmsghdr *) skb->data);
157 }
158
159 /* Allocates a new skb to contain an OpenFlow message 'openflow_len' bytes in
160  * length.  Returns a null pointer if memory is unavailable, otherwise returns
161  * the OpenFlow header and stores a pointer to the skb in '*pskb'. 
162  *
163  * 'type' is the OpenFlow message type.  If 'sender' is nonnull, then it is
164  * used as the message's destination.  'dp' must specify the datapath to
165  * use.  */
166 static void *
167 alloc_openflow_skb(struct datapath *dp, size_t openflow_len, uint8_t type,
168                    const struct sender *sender, struct sk_buff **pskb) 
169 {
170         struct ofp_header *oh;
171         size_t genl_len;
172         struct sk_buff *skb;
173         int max_openflow_len;
174
175         if ((openflow_len + sizeof(struct ofp_header)) > UINT16_MAX) {
176                 if (net_ratelimit())
177                         printk("alloc_openflow_skb: openflow message too large: %zu\n", 
178                                         openflow_len);
179                 return NULL;
180         }
181
182         genl_len = nlmsg_total_size(GENL_HDRLEN + dp_genl_family.hdrsize);
183         genl_len += nla_total_size(sizeof(uint32_t)); /* DP_GENL_A_DP_IDX */
184         genl_len += nla_total_size(openflow_len);    /* DP_GENL_A_OPENFLOW */
185         skb = *pskb = genlmsg_new(genl_len, GFP_ATOMIC);
186         if (!skb) {
187                 if (net_ratelimit())
188                         printk("alloc_openflow_skb: genlmsg_new failed\n");
189                 return NULL;
190         }
191
192         oh = put_openflow_headers(dp, skb, type, sender, &max_openflow_len);
193         BUG_ON(!oh || IS_ERR(oh));
194         resize_openflow_skb(skb, oh, openflow_len);
195
196         return oh;
197 }
198
199 /* Sends 'skb' to 'sender' if it is nonnull, otherwise multicasts 'skb' to all
200  * listeners. */
201 static int
202 send_openflow_skb(struct sk_buff *skb, const struct sender *sender) 
203 {
204         return (sender
205                 ? genlmsg_unicast(skb, sender->pid)
206                 : genlmsg_multicast(skb, 0, mc_group.id, GFP_ATOMIC));
207 }
208
209 /* Generates a unique datapath id.  It incorporates the datapath index
210  * and a hardware address, if available.  If not, it generates a random
211  * one.
212  */
213 static 
214 uint64_t gen_datapath_id(uint16_t dp_idx)
215 {
216         uint64_t id;
217         int i;
218         struct net_device *dev;
219
220         /* The top 16 bits are used to identify the datapath.  The lower 48 bits
221          * use an interface address.  */
222         id = (uint64_t)dp_idx << 48;
223         if ((dev = dev_get_by_name(&init_net, "ctl0")) 
224                         || (dev = dev_get_by_name(&init_net, "eth0"))) {
225                 for (i=0; i<ETH_ALEN; i++) {
226                         id |= (uint64_t)dev->dev_addr[i] << (8*(ETH_ALEN-1 - i));
227                 }
228                 dev_put(dev);
229         } else {
230                 /* Randomly choose the lower 48 bits if we cannot find an
231                  * address and mark the most significant bit to indicate that
232                  * this was randomly generated. */
233                 uint8_t rand[ETH_ALEN];
234                 get_random_bytes(rand, ETH_ALEN);
235                 id |= (uint64_t)1 << 63;
236                 for (i=0; i<ETH_ALEN; i++) {
237                         id |= (uint64_t)rand[i] << (8*(ETH_ALEN-1 - i));
238                 }
239         }
240
241         return id;
242 }
243
244 /* Creates a new datapath numbered 'dp_idx'.  Returns 0 for success or a
245  * negative error code.
246  *
247  * Not called with any locks. */
248 static int new_dp(int dp_idx)
249 {
250         struct datapath *dp;
251         int err;
252
253         if (dp_idx < 0 || dp_idx >= DP_MAX)
254                 return -EINVAL;
255
256         if (!try_module_get(THIS_MODULE))
257                 return -ENODEV;
258
259         mutex_lock(&dp_mutex);
260         dp = rcu_dereference(dps[dp_idx]);
261         if (dp != NULL) {
262                 err = -EEXIST;
263                 goto err_unlock;
264         }
265
266         err = -ENOMEM;
267         dp = kzalloc(sizeof *dp, GFP_KERNEL);
268         if (dp == NULL)
269                 goto err_unlock;
270
271         /* Setup our "of" device */
272         err = dp_dev_setup(dp);
273         if (err)
274                 goto err_free_dp;
275
276         dp->dp_idx = dp_idx;
277         dp->id = gen_datapath_id(dp_idx);
278         dp->chain = chain_create(dp);
279         if (dp->chain == NULL)
280                 goto err_destroy_dp_dev;
281         INIT_LIST_HEAD(&dp->port_list);
282
283         dp->local_port = new_nbp(dp, dp->netdev, OFPP_LOCAL);
284         if (IS_ERR(dp->local_port)) {
285                 err = PTR_ERR(dp->local_port);
286                 goto err_destroy_local_port;
287         }
288
289         dp->flags = 0;
290         dp->miss_send_len = OFP_DEFAULT_MISS_SEND_LEN;
291
292         dp->dp_task = kthread_run(dp_maint_func, dp, "dp%d", dp_idx);
293         if (IS_ERR(dp->dp_task))
294                 goto err_destroy_chain;
295
296         rcu_assign_pointer(dps[dp_idx], dp);
297         mutex_unlock(&dp_mutex);
298
299         return 0;
300
301 err_destroy_local_port:
302         del_switch_port(dp->local_port);
303 err_destroy_chain:
304         chain_destroy(dp->chain);
305 err_destroy_dp_dev:
306         dp_dev_destroy(dp);
307 err_free_dp:
308         kfree(dp);
309 err_unlock:
310         mutex_unlock(&dp_mutex);
311         module_put(THIS_MODULE);
312                 return err;
313 }
314
315 /* Find and return a free port number under 'dp'.  Called under dp_mutex. */
316 static int find_portno(struct datapath *dp)
317 {
318         int i;
319         for (i = 0; i < OFPP_MAX; i++)
320                 if (dp->ports[i] == NULL)
321                         return i;
322         return -EXFULL;
323 }
324
325 static struct net_bridge_port *new_nbp(struct datapath *dp,
326                                        struct net_device *dev, int port_no)
327 {
328         struct net_bridge_port *p;
329
330         if (dev->br_port != NULL)
331                 return ERR_PTR(-EBUSY);
332
333         p = kzalloc(sizeof(*p), GFP_KERNEL);
334         if (p == NULL)
335                 return ERR_PTR(-ENOMEM);
336
337         rtnl_lock();
338         dev_set_promiscuity(dev, 1);
339         rtnl_unlock();
340         dev_hold(dev);
341         p->dp = dp;
342         p->dev = dev;
343         p->port_no = port_no;
344         if (port_no != OFPP_LOCAL)
345                 rcu_assign_pointer(dev->br_port, p);
346         if (port_no < OFPP_MAX)
347                 rcu_assign_pointer(dp->ports[port_no], p); 
348         list_add_rcu(&p->node, &dp->port_list);
349
350         return p;
351 }
352
353 /* Called with dp_mutex. */
354 int add_switch_port(struct datapath *dp, struct net_device *dev)
355 {
356         struct net_bridge_port *p;
357         int port_no;
358
359         if (dev->flags & IFF_LOOPBACK || dev->type != ARPHRD_ETHER
360             || is_dp_dev(dev))
361                 return -EINVAL;
362
363         port_no = find_portno(dp);
364         if (port_no < 0)
365                 return port_no;
366
367         p = new_nbp(dp, dev, port_no);
368         if (IS_ERR(p))
369                 return PTR_ERR(p);
370
371         /* Notify the ctlpath that this port has been added */
372         send_port_status(p, OFPPR_ADD);
373
374         return 0;
375 }
376
377 /* Delete 'p' from switch.
378  * Called with dp_mutex. */
379 static int del_switch_port(struct net_bridge_port *p)
380 {
381         /* First drop references to device. */
382         rtnl_lock();
383         dev_set_promiscuity(p->dev, -1);
384         rtnl_unlock();
385         list_del_rcu(&p->node);
386         if (p->port_no != OFPP_LOCAL)
387                 rcu_assign_pointer(p->dp->ports[p->port_no], NULL);
388         rcu_assign_pointer(p->dev->br_port, NULL);
389
390         /* Then wait until no one is still using it, and destroy it. */
391         synchronize_rcu();
392
393         /* Notify the ctlpath that this port no longer exists */
394         send_port_status(p, OFPPR_DELETE);
395
396         dev_put(p->dev);
397         kfree(p);
398
399         return 0;
400 }
401
402 /* Called with dp_mutex. */
403 static void del_dp(struct datapath *dp)
404 {
405         struct net_bridge_port *p, *n;
406
407         kthread_stop(dp->dp_task);
408
409         /* Drop references to DP. */
410         list_for_each_entry_safe (p, n, &dp->port_list, node)
411                 del_switch_port(p);
412         rcu_assign_pointer(dps[dp->dp_idx], NULL);
413
414         /* Kill off local_port dev references from buffered packets that have
415          * associated dst entries. */
416         synchronize_rcu();
417         fwd_discard_all();
418
419         /* Destroy dp->netdev.  (Must follow deleting switch ports since
420          * dp->local_port has a reference to it.) */
421         dp_dev_destroy(dp);
422
423         /* Wait until no longer in use, then destroy it. */
424         synchronize_rcu();
425         chain_destroy(dp->chain);
426         kfree(dp);
427         module_put(THIS_MODULE);
428 }
429
430 static int dp_maint_func(void *data)
431 {
432         struct datapath *dp = (struct datapath *) data;
433
434         while (!kthread_should_stop()) {
435                 chain_timeout(dp->chain);
436                 msleep_interruptible(MAINT_SLEEP_MSECS);
437         }
438                 
439         return 0;
440 }
441
442 static void
443 do_port_input(struct net_bridge_port *p, struct sk_buff *skb) 
444 {
445         /* Push the Ethernet header back on. */
446         skb_push(skb, ETH_HLEN);
447         fwd_port_input(p->dp->chain, skb, p->port_no);
448 }
449
450 /*
451  * Used as br_handle_frame_hook.  (Cannot run bridge at the same time, even on
452  * different set of devices!)
453  */
454 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,22)
455 /* Called with rcu_read_lock. */
456 static struct sk_buff *dp_frame_hook(struct net_bridge_port *p,
457                                          struct sk_buff *skb)
458 {
459         do_port_input(p, skb);
460         return NULL;
461 }
462 #elif LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,0)
463 static int dp_frame_hook(struct net_bridge_port *p, struct sk_buff **pskb)
464 {
465         do_port_input(p, *pskb);
466         return 1;
467 }
468 #else
469 /* NB: This has only been tested on 2.4.35 */
470
471 /* Called without any locks (?) */
472 static void dp_frame_hook(struct sk_buff *skb)
473 {
474         struct net_bridge_port *p = skb->dev->br_port;
475         if (p) {
476                 rcu_read_lock();
477                 do_port_input(p, skb);
478                 rcu_read_unlock();
479         } else
480                 kfree_skb(skb);
481 }
482 #endif
483
484 /* Forwarding output path.
485  * Based on net/bridge/br_forward.c. */
486
487 static inline unsigned packet_length(const struct sk_buff *skb)
488 {
489         int length = skb->len - ETH_HLEN;
490         if (skb->protocol == htons(ETH_P_8021Q))
491                 length -= VLAN_HLEN;
492         return length;
493 }
494
495 /* Send packets out all the ports except the originating one.  If the
496  * "flood" argument is set, only send along the minimum spanning tree.
497  */
498 static int
499 output_all(struct datapath *dp, struct sk_buff *skb, int flood)
500 {
501         u32 disable = flood ? BRIDGE_PORT_NO_FLOOD : 0;
502         struct net_bridge_port *p;
503         int prev_port = -1;
504
505         list_for_each_entry_rcu (p, &dp->port_list, node) {
506                 if (skb->dev == p->dev || p->flags & disable)
507                         continue;
508                 if (prev_port != -1) {
509                         struct sk_buff *clone = skb_clone(skb, GFP_ATOMIC);
510                         if (!clone) {
511                                 kfree_skb(skb);
512                                 return -ENOMEM;
513                         }
514                         dp_output_port(dp, clone, prev_port); 
515                 }
516                 prev_port = p->port_no;
517         }
518         if (prev_port != -1)
519                 dp_output_port(dp, skb, prev_port);
520         else
521                 kfree_skb(skb);
522
523         return 0;
524 }
525
526 /* Marks 'skb' as having originated from 'in_port' in 'dp'.
527    FIXME: how are devices reference counted? */
528 int dp_set_origin(struct datapath *dp, uint16_t in_port,
529                            struct sk_buff *skb)
530 {
531         struct net_bridge_port *p = (in_port < OFPP_MAX ? dp->ports[in_port]
532                                      : in_port == OFPP_LOCAL ? dp->local_port
533                                      : NULL);
534         if (p) {
535                 skb->dev = p->dev;
536                 return 0;
537         }
538         return -ENOENT;
539 }
540
541 /* Takes ownership of 'skb' and transmits it to 'out_port' on 'dp'.
542  */
543 int dp_output_port(struct datapath *dp, struct sk_buff *skb, int out_port)
544 {
545         BUG_ON(!skb);
546         if (out_port == OFPP_FLOOD)
547                 return output_all(dp, skb, 1);
548         else if (out_port == OFPP_ALL)
549                 return output_all(dp, skb, 0);
550         else if (out_port == OFPP_CONTROLLER)
551                 return dp_output_control(dp, skb, fwd_save_skb(skb), 0,
552                                                   OFPR_ACTION);
553         else if (out_port == OFPP_TABLE) {
554                 struct net_bridge_port *p = skb->dev->br_port;
555                 struct sw_flow_key key;
556                 struct sw_flow *flow;
557
558                 flow_extract(skb, p ? p->port_no : OFPP_LOCAL, &key);
559                 flow = chain_lookup(dp->chain, &key);
560                 if (likely(flow != NULL)) {
561                         flow_used(flow, skb);
562                         execute_actions(dp, skb, &key, flow->actions, flow->n_actions);
563                         return 0;
564                 }
565                 return -ESRCH;
566         } else if (out_port == OFPP_LOCAL) {
567                 struct net_device *dev = dp->netdev;
568                 return dev ? dp_dev_recv(dev, skb) : -ESRCH;
569         } else if (out_port >= 0 && out_port < OFPP_MAX) {
570                 struct net_bridge_port *p = dp->ports[out_port];
571                 int len = skb->len;
572                 if (p == NULL)
573                         goto bad_port;
574                 skb->dev = p->dev; 
575                 if (packet_length(skb) > skb->dev->mtu) {
576                         printk("dropped over-mtu packet: %d > %d\n",
577                                packet_length(skb), skb->dev->mtu);
578                         kfree_skb(skb);
579                         return -E2BIG;
580                 }
581
582                 dev_queue_xmit(skb);
583
584                 return len;
585         }
586
587 bad_port:
588         kfree_skb(skb);
589         if (net_ratelimit())
590                 printk("can't forward to bad port %d\n", out_port);
591         return -ENOENT;
592 }
593
594 /* Takes ownership of 'skb' and transmits it to 'dp''s control path.  If
595  * 'buffer_id' != -1, then only the first 64 bytes of 'skb' are sent;
596  * otherwise, all of 'skb' is sent.  'reason' indicates why 'skb' is being
597  * sent. 'max_len' sets the maximum number of bytes that the caller
598  * wants to be sent; a value of 0 indicates the entire packet should be
599  * sent. */
600 int
601 dp_output_control(struct datapath *dp, struct sk_buff *skb,
602                            uint32_t buffer_id, size_t max_len, int reason)
603 {
604         /* FIXME?  Can we avoid creating a new skbuff in the case where we
605          * forward the whole packet? */
606         struct sk_buff *f_skb;
607         struct ofp_packet_in *opi;
608         struct net_bridge_port *p;
609         size_t fwd_len, opi_len;
610         int err;
611
612         fwd_len = skb->len;
613         if ((buffer_id != (uint32_t) -1) && max_len)
614                 fwd_len = min(fwd_len, max_len);
615
616         opi_len = offsetof(struct ofp_packet_in, data) + fwd_len;
617         opi = alloc_openflow_skb(dp, opi_len, OFPT_PACKET_IN, NULL, &f_skb);
618         if (!opi) {
619                 err = -ENOMEM;
620                 goto out;
621         }
622         opi->buffer_id      = htonl(buffer_id);
623         opi->total_len      = htons(skb->len);
624         p = skb->dev->br_port;
625         opi->in_port        = htons(p ? p->port_no : OFPP_LOCAL);
626         opi->reason         = reason;
627         opi->pad            = 0;
628         memcpy(opi->data, skb_mac_header(skb), fwd_len);
629         err = send_openflow_skb(f_skb, NULL);
630
631 out:
632         kfree_skb(skb);
633         return err;
634 }
635
636 static void fill_port_desc(struct net_bridge_port *p, struct ofp_phy_port *desc)
637 {
638         desc->port_no = htons(p->port_no);
639         strncpy(desc->name, p->dev->name, OFP_MAX_PORT_NAME_LEN);
640         desc->name[OFP_MAX_PORT_NAME_LEN-1] = '\0';
641         memcpy(desc->hw_addr, p->dev->dev_addr, ETH_ALEN);
642         desc->flags = htonl(p->flags);
643         desc->features = 0;
644         desc->speed = 0;
645
646 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,4,24)
647         if (p->dev->ethtool_ops && p->dev->ethtool_ops->get_settings) {
648                 struct ethtool_cmd ecmd = { .cmd = ETHTOOL_GSET };
649
650                 if (!p->dev->ethtool_ops->get_settings(p->dev, &ecmd)) {
651                         if (ecmd.supported & SUPPORTED_10baseT_Half) 
652                                 desc->features |= OFPPF_10MB_HD;
653                         if (ecmd.supported & SUPPORTED_10baseT_Full)
654                                 desc->features |= OFPPF_10MB_FD;
655                         if (ecmd.supported & SUPPORTED_100baseT_Half) 
656                                 desc->features |= OFPPF_100MB_HD;
657                         if (ecmd.supported & SUPPORTED_100baseT_Full)
658                                 desc->features |= OFPPF_100MB_FD;
659                         if (ecmd.supported & SUPPORTED_1000baseT_Half)
660                                 desc->features |= OFPPF_1GB_HD;
661                         if (ecmd.supported & SUPPORTED_1000baseT_Full)
662                                 desc->features |= OFPPF_1GB_FD;
663                         /* 10Gbps half-duplex doesn't exist... */
664                         if (ecmd.supported & SUPPORTED_10000baseT_Full)
665                                 desc->features |= OFPPF_10GB_FD;
666
667                         desc->features = htonl(desc->features);
668                         desc->speed = htonl(ecmd.speed);
669                 }
670         }
671 #endif
672 }
673
674 static int 
675 fill_features_reply(struct datapath *dp, struct ofp_switch_features *ofr)
676 {
677         struct net_bridge_port *p;
678         int port_count = 0;
679
680         ofr->datapath_id    = cpu_to_be64(dp->id); 
681
682         ofr->n_exact        = htonl(2 * TABLE_HASH_MAX_FLOWS);
683         ofr->n_compression  = 0;                                           /* Not supported */
684         ofr->n_general      = htonl(TABLE_LINEAR_MAX_FLOWS);
685         ofr->buffer_mb      = htonl(UINT32_MAX);
686         ofr->n_buffers      = htonl(N_PKT_BUFFERS);
687         ofr->capabilities   = htonl(OFP_SUPPORTED_CAPABILITIES);
688         ofr->actions        = htonl(OFP_SUPPORTED_ACTIONS);
689
690         list_for_each_entry_rcu (p, &dp->port_list, node) {
691                 fill_port_desc(p, &ofr->ports[port_count]);
692                 port_count++;
693         }
694
695         return port_count;
696 }
697
698 int
699 dp_send_features_reply(struct datapath *dp, const struct sender *sender)
700 {
701         struct sk_buff *skb;
702         struct ofp_switch_features *ofr;
703         size_t ofr_len, port_max_len;
704         int port_count;
705
706         /* Overallocate. */
707         port_max_len = sizeof(struct ofp_phy_port) * OFPP_MAX;
708         ofr = alloc_openflow_skb(dp, sizeof(*ofr) + port_max_len,
709                                  OFPT_FEATURES_REPLY, sender, &skb);
710         if (!ofr)
711                 return -ENOMEM;
712
713         /* Fill. */
714         port_count = fill_features_reply(dp, ofr);
715
716         /* Shrink to fit. */
717         ofr_len = sizeof(*ofr) + (sizeof(struct ofp_phy_port) * port_count);
718         resize_openflow_skb(skb, &ofr->header, ofr_len);
719         return send_openflow_skb(skb, sender);
720 }
721
722 int
723 dp_send_config_reply(struct datapath *dp, const struct sender *sender)
724 {
725         struct sk_buff *skb;
726         struct ofp_switch_config *osc;
727
728         osc = alloc_openflow_skb(dp, sizeof *osc, OFPT_GET_CONFIG_REPLY, sender,
729                                  &skb);
730         if (!osc)
731                 return -ENOMEM;
732
733         osc->flags = htons(dp->flags);
734         osc->miss_send_len = htons(dp->miss_send_len);
735
736         return send_openflow_skb(skb, sender);
737 }
738
739 int
740 dp_update_port_flags(struct datapath *dp, const struct ofp_phy_port *opp)
741 {
742         int port_no = ntohs(opp->port_no);
743         struct net_bridge_port *p = (port_no < OFPP_MAX ? dp->ports[port_no]
744                                      : port_no == OFPP_LOCAL ? dp->local_port
745                                      : NULL);
746         /* Make sure the port id hasn't changed since this was sent */
747         if (!p || memcmp(opp->hw_addr, p->dev->dev_addr, ETH_ALEN))
748                 return -1;
749         p->flags = htonl(opp->flags);
750         return 0;
751 }
752
753
754 static int
755 send_port_status(struct net_bridge_port *p, uint8_t status)
756 {
757         struct sk_buff *skb;
758         struct ofp_port_status *ops;
759
760         ops = alloc_openflow_skb(p->dp, sizeof *ops, OFPT_PORT_STATUS, NULL,
761                                  &skb);
762         if (!ops)
763                 return -ENOMEM;
764         ops->reason = status;
765         memset(ops->pad, 0, sizeof ops->pad);
766         fill_port_desc(p, &ops->desc);
767
768         return send_openflow_skb(skb, NULL);
769 }
770
771 int 
772 dp_send_flow_expired(struct datapath *dp, struct sw_flow *flow)
773 {
774         struct sk_buff *skb;
775         struct ofp_flow_expired *ofe;
776         unsigned long duration_j;
777
778         ofe = alloc_openflow_skb(dp, sizeof *ofe, OFPT_FLOW_EXPIRED, 0, &skb);
779         if (!ofe)
780                 return -ENOMEM;
781
782         flow_fill_match(&ofe->match, &flow->key);
783
784         memset(ofe->pad, 0, sizeof ofe->pad);
785         ofe->priority = htons(flow->priority);
786
787         duration_j = (flow->timeout - HZ * flow->max_idle) - flow->init_time;
788         ofe->duration     = htonl(duration_j / HZ);
789         ofe->packet_count = cpu_to_be64(flow->packet_count);
790         ofe->byte_count   = cpu_to_be64(flow->byte_count);
791
792         return send_openflow_skb(skb, NULL);
793 }
794 EXPORT_SYMBOL(dp_send_flow_expired);
795
796 int
797 dp_send_error_msg(struct datapath *dp, const struct sender *sender, 
798                 uint16_t type, uint16_t code, const uint8_t *data, size_t len)
799 {
800         struct sk_buff *skb;
801         struct ofp_error_msg *oem;
802
803
804         oem = alloc_openflow_skb(dp, sizeof(*oem)+len, OFPT_ERROR_MSG, 
805                         sender, &skb);
806         if (!oem)
807                 return -ENOMEM;
808
809         oem->type = htons(type);
810         oem->code = htons(code);
811         memcpy(oem->data, data, len);
812
813         return send_openflow_skb(skb, sender);
814 }
815
816 int
817 dp_send_echo_reply(struct datapath *dp, const struct sender *sender,
818                    const struct ofp_header *rq)
819 {
820         struct sk_buff *skb;
821         struct ofp_header *reply;
822
823         reply = alloc_openflow_skb(dp, ntohs(rq->length), OFPT_ECHO_REPLY,
824                                    sender, &skb);
825         if (!reply)
826                 return -ENOMEM;
827
828         memcpy(reply + 1, rq + 1, ntohs(rq->length) - sizeof *rq);
829         return send_openflow_skb(skb, sender);
830 }
831
832 /* Generic Netlink interface.
833  *
834  * See netlink(7) for an introduction to netlink.  See
835  * http://linux-net.osdl.org/index.php/Netlink for more information and
836  * pointers on how to work with netlink and Generic Netlink in the kernel and
837  * in userspace. */
838
839 static struct genl_family dp_genl_family = {
840         .id = GENL_ID_GENERATE,
841         .hdrsize = 0,
842         .name = DP_GENL_FAMILY_NAME,
843         .version = 1,
844         .maxattr = DP_GENL_A_MAX,
845 };
846
847 /* Attribute policy: what each attribute may contain.  */
848 static struct nla_policy dp_genl_policy[DP_GENL_A_MAX + 1] = {
849         [DP_GENL_A_DP_IDX] = { .type = NLA_U32 },
850         [DP_GENL_A_MC_GROUP] = { .type = NLA_U32 },
851         [DP_GENL_A_PORTNAME] = { .type = NLA_STRING }
852 };
853
854 static int dp_genl_add(struct sk_buff *skb, struct genl_info *info)
855 {
856         if (!info->attrs[DP_GENL_A_DP_IDX])
857                 return -EINVAL;
858
859         return new_dp(nla_get_u32(info->attrs[DP_GENL_A_DP_IDX]));
860 }
861
862 static struct genl_ops dp_genl_ops_add_dp = {
863         .cmd = DP_GENL_C_ADD_DP,
864         .flags = GENL_ADMIN_PERM, /* Requires CAP_NET_ADMIN privilege. */
865         .policy = dp_genl_policy,
866         .doit = dp_genl_add,
867         .dumpit = NULL,
868 };
869
870 struct datapath *dp_get(int dp_idx)
871 {
872         if (dp_idx < 0 || dp_idx > DP_MAX)
873                 return NULL;
874         return rcu_dereference(dps[dp_idx]);
875 }
876
877 static int dp_genl_del(struct sk_buff *skb, struct genl_info *info)
878 {
879         struct datapath *dp;
880         int err;
881
882         if (!info->attrs[DP_GENL_A_DP_IDX])
883                 return -EINVAL;
884
885         mutex_lock(&dp_mutex);
886         dp = dp_get(nla_get_u32((info->attrs[DP_GENL_A_DP_IDX])));
887         if (!dp)
888                 err = -ENOENT;
889         else {
890                 del_dp(dp);
891                 err = 0;
892         }
893         mutex_unlock(&dp_mutex);
894         return err;
895 }
896
897 static struct genl_ops dp_genl_ops_del_dp = {
898         .cmd = DP_GENL_C_DEL_DP,
899         .flags = GENL_ADMIN_PERM, /* Requires CAP_NET_ADMIN privilege. */
900         .policy = dp_genl_policy,
901         .doit = dp_genl_del,
902         .dumpit = NULL,
903 };
904
905 /* Queries a datapath for related information.  Currently the only relevant
906  * information is the datapath's multicast group ID.  Really we want one
907  * multicast group per datapath, but because of locking issues[*] we can't
908  * easily get one.  Thus, every datapath will currently return the same
909  * global multicast group ID, but in the future it would be nice to fix that.
910  *
911  * [*] dp_genl_add, to add a new datapath, is called under the genl_lock
912  *       mutex, and genl_register_mc_group, called to acquire a new multicast
913  *       group ID, also acquires genl_lock, thus deadlock.
914  */
915 static int dp_genl_query(struct sk_buff *skb, struct genl_info *info)
916 {
917         struct datapath *dp;
918         struct sk_buff *ans_skb = NULL;
919         int dp_idx;
920         int err = -ENOMEM;
921
922         if (!info->attrs[DP_GENL_A_DP_IDX])
923                 return -EINVAL;
924
925         rcu_read_lock();
926         dp_idx = nla_get_u32((info->attrs[DP_GENL_A_DP_IDX]));
927         dp = dp_get(dp_idx);
928         if (!dp)
929                 err = -ENOENT;
930         else {
931                 void *data;
932                 ans_skb = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_ATOMIC);
933                 if (!ans_skb) {
934                         err = -ENOMEM;
935                         goto err;
936                 }
937                 data = genlmsg_put_reply(ans_skb, info, &dp_genl_family,
938                                          0, DP_GENL_C_QUERY_DP);
939                 if (data == NULL) {
940                         err = -ENOMEM;
941                         goto err;
942                 }
943                 NLA_PUT_U32(ans_skb, DP_GENL_A_DP_IDX, dp_idx);
944                 NLA_PUT_U32(ans_skb, DP_GENL_A_MC_GROUP, mc_group.id);
945
946                 genlmsg_end(ans_skb, data);
947                 err = genlmsg_reply(ans_skb, info);
948                 if (!err)
949                         ans_skb = NULL;
950         }
951 err:
952 nla_put_failure:
953         if (ans_skb)
954                 kfree_skb(ans_skb);
955         rcu_read_unlock();
956         return err;
957 }
958
959 static struct genl_ops dp_genl_ops_query_dp = {
960         .cmd = DP_GENL_C_QUERY_DP,
961         .flags = GENL_ADMIN_PERM, /* Requires CAP_NET_ADMIN privilege. */
962         .policy = dp_genl_policy,
963         .doit = dp_genl_query,
964         .dumpit = NULL,
965 };
966
967 static int dp_genl_add_del_port(struct sk_buff *skb, struct genl_info *info)
968 {
969         struct datapath *dp;
970         struct net_device *port;
971         int err;
972
973         if (!info->attrs[DP_GENL_A_DP_IDX] || !info->attrs[DP_GENL_A_PORTNAME])
974                 return -EINVAL;
975
976         /* Get datapath. */
977         mutex_lock(&dp_mutex);
978         dp = dp_get(nla_get_u32(info->attrs[DP_GENL_A_DP_IDX]));
979         if (!dp) {
980                 err = -ENOENT;
981                 goto out;
982         }
983
984         /* Get interface to add/remove. */
985         port = dev_get_by_name(&init_net, 
986                         nla_data(info->attrs[DP_GENL_A_PORTNAME]));
987         if (!port) {
988                 err = -ENOENT;
989                 goto out;
990         }
991
992         /* Execute operation. */
993         if (info->genlhdr->cmd == DP_GENL_C_ADD_PORT)
994                 err = add_switch_port(dp, port);
995         else {
996                 if (port->br_port == NULL || port->br_port->dp != dp) {
997                         err = -ENOENT;
998                         goto out_put;
999                 }
1000                 err = del_switch_port(port->br_port);
1001         }
1002
1003 out_put:
1004         dev_put(port);
1005 out:
1006         mutex_unlock(&dp_mutex);
1007         return err;
1008 }
1009
1010 static struct genl_ops dp_genl_ops_add_port = {
1011         .cmd = DP_GENL_C_ADD_PORT,
1012         .flags = GENL_ADMIN_PERM, /* Requires CAP_NET_ADMIN privilege. */
1013         .policy = dp_genl_policy,
1014         .doit = dp_genl_add_del_port,
1015         .dumpit = NULL,
1016 };
1017
1018 static struct genl_ops dp_genl_ops_del_port = {
1019         .cmd = DP_GENL_C_DEL_PORT,
1020         .flags = GENL_ADMIN_PERM, /* Requires CAP_NET_ADMIN privilege. */
1021         .policy = dp_genl_policy,
1022         .doit = dp_genl_add_del_port,
1023         .dumpit = NULL,
1024 };
1025
1026 static int dp_genl_openflow(struct sk_buff *skb, struct genl_info *info)
1027 {
1028         struct nlattr *va = info->attrs[DP_GENL_A_OPENFLOW];
1029         struct datapath *dp;
1030         struct ofp_header *oh;
1031         struct sender sender;
1032         int err;
1033
1034         if (!info->attrs[DP_GENL_A_DP_IDX] || !va)
1035                 return -EINVAL;
1036
1037         rcu_read_lock();
1038         dp = dp_get(nla_get_u32(info->attrs[DP_GENL_A_DP_IDX]));
1039         if (!dp) {
1040                 err = -ENOENT;
1041                 goto out;
1042         }
1043
1044         if (nla_len(va) < sizeof(struct ofp_header)) {
1045                 err = -EINVAL;
1046                 goto out;
1047         }
1048         oh = nla_data(va);
1049
1050         sender.xid = oh->xid;
1051         sender.pid = info->snd_pid;
1052         sender.seq = info->snd_seq;
1053         err = fwd_control_input(dp->chain, &sender, nla_data(va), nla_len(va));
1054
1055 out:
1056         rcu_read_unlock();
1057         return err;
1058 }
1059
1060 static struct nla_policy dp_genl_openflow_policy[DP_GENL_A_MAX + 1] = {
1061         [DP_GENL_A_DP_IDX] = { .type = NLA_U32 },
1062 };
1063
1064 struct flow_stats_state {
1065         int table_idx;
1066         struct sw_table_position position;
1067         const struct ofp_flow_stats_request *rq;
1068
1069         void *body;
1070         int bytes_used, bytes_allocated;
1071 };
1072
1073 static int flow_stats_init(struct datapath *dp, const void *body, int body_len,
1074                            void **state)
1075 {
1076         const struct ofp_flow_stats_request *fsr = body;
1077         struct flow_stats_state *s = kmalloc(sizeof *s, GFP_ATOMIC);
1078         if (!s)
1079                 return -ENOMEM;
1080         s->table_idx = fsr->table_id == 0xff ? 0 : fsr->table_id;
1081         memset(&s->position, 0, sizeof s->position);
1082         s->rq = fsr;
1083         *state = s;
1084         return 0;
1085 }
1086
1087 static int flow_stats_dump_callback(struct sw_flow *flow, void *private)
1088 {
1089         struct flow_stats_state *s = private;
1090         struct ofp_flow_stats *ofs;
1091         int actions_length;
1092         int length;
1093
1094         actions_length = sizeof *ofs->actions * flow->n_actions;
1095         length = sizeof *ofs + sizeof *ofs->actions * flow->n_actions;
1096         if (length + s->bytes_used > s->bytes_allocated)
1097                 return 1;
1098
1099         ofs = s->body + s->bytes_used;
1100         ofs->length          = htons(length);
1101         ofs->table_id        = s->table_idx;
1102         ofs->pad             = 0;
1103         ofs->match.wildcards = htons(flow->key.wildcards);
1104         ofs->match.in_port   = flow->key.in_port;
1105         memcpy(ofs->match.dl_src, flow->key.dl_src, ETH_ALEN);
1106         memcpy(ofs->match.dl_dst, flow->key.dl_dst, ETH_ALEN);
1107         ofs->match.dl_vlan   = flow->key.dl_vlan;
1108         ofs->match.dl_type   = flow->key.dl_type;
1109         ofs->match.nw_src    = flow->key.nw_src;
1110         ofs->match.nw_dst    = flow->key.nw_dst;
1111         ofs->match.nw_proto  = flow->key.nw_proto;
1112         memset(ofs->match.pad, 0, sizeof ofs->match.pad);
1113         ofs->match.tp_src    = flow->key.tp_src;
1114         ofs->match.tp_dst    = flow->key.tp_dst;
1115         ofs->duration        = htonl((jiffies - flow->init_time) / HZ);
1116         ofs->packet_count    = cpu_to_be64(flow->packet_count);
1117         ofs->byte_count      = cpu_to_be64(flow->byte_count);
1118         ofs->priority        = htons(flow->priority);
1119         ofs->max_idle        = htons(flow->max_idle);
1120         memcpy(ofs->actions, flow->actions, actions_length);
1121
1122         s->bytes_used += length;
1123         return 0;
1124 }
1125
1126 static int flow_stats_dump(struct datapath *dp, void *state,
1127                            void *body, int *body_len)
1128 {
1129         struct flow_stats_state *s = state;
1130         struct sw_flow_key match_key;
1131         int error = 0;
1132
1133         s->bytes_used = 0;
1134         s->bytes_allocated = *body_len;
1135         s->body = body;
1136
1137         flow_extract_match(&match_key, &s->rq->match);
1138         while (s->table_idx < dp->chain->n_tables
1139                && (s->rq->table_id == 0xff || s->rq->table_id == s->table_idx))
1140         {
1141                 struct sw_table *table = dp->chain->tables[s->table_idx];
1142
1143                 error = table->iterate(table, &match_key, &s->position,
1144                                        flow_stats_dump_callback, s);
1145                 if (error)
1146                         break;
1147
1148                 s->table_idx++;
1149                 memset(&s->position, 0, sizeof s->position);
1150         }
1151         *body_len = s->bytes_used;
1152
1153         /* If error is 0, we're done.
1154          * Otherwise, if some bytes were used, there are more flows to come.
1155          * Otherwise, we were not able to fit even a single flow in the body,
1156          * which indicates that we have a single flow with too many actions to
1157          * fit.  We won't ever make any progress at that rate, so give up. */
1158         return !error ? 0 : s->bytes_used ? 1 : -ENOMEM;
1159 }
1160
1161 static void flow_stats_done(void *state)
1162 {
1163         kfree(state);
1164 }
1165
1166 static int aggregate_stats_init(struct datapath *dp,
1167                                 const void *body, int body_len,
1168                                 void **state)
1169 {
1170         *state = (void *)body;
1171         return 0;
1172 }
1173
1174 static int aggregate_stats_dump_callback(struct sw_flow *flow, void *private)
1175 {
1176         struct ofp_aggregate_stats_reply *rpy = private;
1177         rpy->packet_count += flow->packet_count;
1178         rpy->byte_count += flow->byte_count;
1179         rpy->flow_count++;
1180         return 0;
1181 }
1182
1183 static int aggregate_stats_dump(struct datapath *dp, void *state,
1184                                 void *body, int *body_len)
1185 {
1186         struct ofp_aggregate_stats_request *rq = state;
1187         struct ofp_aggregate_stats_reply *rpy;
1188         struct sw_table_position position;
1189         struct sw_flow_key match_key;
1190         int table_idx;
1191
1192         if (*body_len < sizeof *rpy)
1193                 return -ENOBUFS;
1194         rpy = body;
1195         *body_len = sizeof *rpy;
1196
1197         memset(rpy, 0, sizeof *rpy);
1198
1199         flow_extract_match(&match_key, &rq->match);
1200         table_idx = rq->table_id == 0xff ? 0 : rq->table_id;
1201         memset(&position, 0, sizeof position);
1202         while (table_idx < dp->chain->n_tables
1203                && (rq->table_id == 0xff || rq->table_id == table_idx))
1204         {
1205                 struct sw_table *table = dp->chain->tables[table_idx];
1206                 int error;
1207
1208                 error = table->iterate(table, &match_key, &position,
1209                                        aggregate_stats_dump_callback, rpy);
1210                 if (error)
1211                         return error;
1212
1213                 table_idx++;
1214                 memset(&position, 0, sizeof position);
1215         }
1216
1217         rpy->packet_count = cpu_to_be64(rpy->packet_count);
1218         rpy->byte_count = cpu_to_be64(rpy->byte_count);
1219         rpy->flow_count = htonl(rpy->flow_count);
1220         return 0;
1221 }
1222
1223 static int table_stats_dump(struct datapath *dp, void *state,
1224                             void *body, int *body_len)
1225 {
1226         struct ofp_table_stats *ots;
1227         int nbytes = dp->chain->n_tables * sizeof *ots;
1228         int i;
1229         if (nbytes > *body_len)
1230                 return -ENOBUFS;
1231         *body_len = nbytes;
1232         for (i = 0, ots = body; i < dp->chain->n_tables; i++, ots++) {
1233                 struct sw_table_stats stats;
1234                 dp->chain->tables[i]->stats(dp->chain->tables[i], &stats);
1235                 strncpy(ots->name, stats.name, sizeof ots->name);
1236                 ots->table_id = i;
1237                 memset(ots->pad, 0, sizeof ots->pad);
1238                 ots->max_entries = htonl(stats.max_flows);
1239                 ots->active_count = htonl(stats.n_flows);
1240                 ots->matched_count = cpu_to_be64(0); /* FIXME */
1241         }
1242         return 0;
1243 }
1244
1245 struct port_stats_state {
1246         int port;
1247 };
1248
1249 static int port_stats_init(struct datapath *dp, const void *body, int body_len,
1250                            void **state)
1251 {
1252         struct port_stats_state *s = kmalloc(sizeof *s, GFP_ATOMIC);
1253         if (!s)
1254                 return -ENOMEM;
1255         s->port = 0;
1256         *state = s;
1257         return 0;
1258 }
1259
1260 static int port_stats_dump(struct datapath *dp, void *state,
1261                            void *body, int *body_len)
1262 {
1263         struct port_stats_state *s = state;
1264         struct ofp_port_stats *ops;
1265         int n_ports, max_ports;
1266         int i;
1267
1268         max_ports = *body_len / sizeof *ops;
1269         if (!max_ports)
1270                 return -ENOMEM;
1271         ops = body;
1272
1273         n_ports = 0;
1274         for (i = s->port; i < OFPP_MAX && n_ports < max_ports; i++) {
1275                 struct net_bridge_port *p = dp->ports[i];
1276                 struct net_device_stats *stats;
1277                 if (!p)
1278                         continue;
1279                 stats = p->dev->get_stats(p->dev);
1280                 ops->port_no = htons(p->port_no);
1281                 memset(ops->pad, 0, sizeof ops->pad);
1282                 ops->rx_count = cpu_to_be64(stats->rx_packets);
1283                 ops->tx_count = cpu_to_be64(stats->tx_packets);
1284                 ops->drop_count = cpu_to_be64(stats->rx_dropped
1285                                               + stats->tx_dropped);
1286                 n_ports++;
1287                 ops++;
1288         }
1289         s->port = i;
1290         *body_len = n_ports * sizeof *ops;
1291         return n_ports >= max_ports;
1292 }
1293
1294 static void port_stats_done(void *state)
1295 {
1296         kfree(state);
1297 }
1298
1299 struct stats_type {
1300         /* Minimum and maximum acceptable number of bytes in body member of
1301          * struct ofp_stats_request. */
1302         size_t min_body, max_body;
1303
1304         /* Prepares to dump some kind of statistics on 'dp'.  'body' and
1305          * 'body_len' are the 'body' member of the struct ofp_stats_request.
1306          * Returns zero if successful, otherwise a negative error code.
1307          * May initialize '*state' to state information.  May be null if no
1308          * initialization is required.*/
1309         int (*init)(struct datapath *dp, const void *body, int body_len,
1310                     void **state);
1311
1312         /* Dumps statistics for 'dp' into the '*body_len' bytes at 'body', and
1313          * modifies '*body_len' to reflect the number of bytes actually used.
1314          * ('body' will be transmitted as the 'body' member of struct
1315          * ofp_stats_reply.) */
1316         int (*dump)(struct datapath *dp, void *state,
1317                     void *body, int *body_len);
1318
1319         /* Cleans any state created by the init or dump functions.  May be null
1320          * if no cleanup is required. */
1321         void (*done)(void *state);
1322 };
1323
1324 static const struct stats_type stats[] = {
1325         [OFPST_FLOW] = {
1326                 sizeof(struct ofp_flow_stats_request),
1327                 sizeof(struct ofp_flow_stats_request),
1328                 flow_stats_init,
1329                 flow_stats_dump,
1330                 flow_stats_done
1331         },
1332         [OFPST_AGGREGATE] = {
1333                 sizeof(struct ofp_aggregate_stats_request),
1334                 sizeof(struct ofp_aggregate_stats_request),
1335                 aggregate_stats_init,
1336                 aggregate_stats_dump,
1337                 NULL
1338         },
1339         [OFPST_TABLE] = {
1340                 0,
1341                 0,
1342                 NULL,
1343                 table_stats_dump,
1344                 NULL
1345         },
1346         [OFPST_PORT] = {
1347                 0,
1348                 0,
1349                 port_stats_init,
1350                 port_stats_dump,
1351                 port_stats_done
1352         },
1353 };
1354
1355 static int
1356 dp_genl_openflow_dumpit(struct sk_buff *skb, struct netlink_callback *cb)
1357 {
1358         struct datapath *dp;
1359         struct sender sender;
1360         const struct stats_type *s;
1361         struct ofp_stats_reply *osr;
1362         int dp_idx;
1363         int max_openflow_len, body_len;
1364         void *body;
1365         int err;
1366
1367         /* Set up the cleanup function for this dump.  Linux 2.6.20 and later
1368          * support setting up cleanup functions via the .doneit member of
1369          * struct genl_ops.  This kluge supports earlier versions also. */
1370         cb->done = dp_genl_openflow_done;
1371
1372         rcu_read_lock();
1373         if (!cb->args[0]) {
1374                 struct nlattr *attrs[DP_GENL_A_MAX + 1];
1375                 struct ofp_stats_request *rq;
1376                 struct nlattr *va;
1377                 size_t len, body_len;
1378                 int type;
1379
1380                 err = nlmsg_parse(cb->nlh, GENL_HDRLEN, attrs, DP_GENL_A_MAX,
1381                                   dp_genl_openflow_policy);
1382                 if (err < 0)
1383                         return err;
1384
1385                 err = -EINVAL;
1386
1387                 if (!attrs[DP_GENL_A_DP_IDX])
1388                         goto out;
1389                 dp_idx = nla_get_u16(attrs[DP_GENL_A_DP_IDX]);
1390                 dp = dp_get(dp_idx);
1391                 if (!dp) {
1392                         err = -ENOENT;
1393                         goto out;
1394                 }
1395
1396                 va = attrs[DP_GENL_A_OPENFLOW];
1397                 len = nla_len(va);
1398                 if (!va || len < sizeof *rq)
1399                         goto out;
1400
1401                 rq = nla_data(va);
1402                 type = ntohs(rq->type);
1403                 if (rq->header.version != OFP_VERSION
1404                     || rq->header.type != OFPT_STATS_REQUEST
1405                     || ntohs(rq->header.length) != len
1406                     || type >= ARRAY_SIZE(stats)
1407                     || !stats[type].dump)
1408                         goto out;
1409
1410                 s = &stats[type];
1411                 body_len = len - offsetof(struct ofp_stats_request, body);
1412                 if (body_len < s->min_body || body_len > s->max_body)
1413                         goto out;
1414
1415                 cb->args[0] = 1;
1416                 cb->args[1] = dp_idx;
1417                 cb->args[2] = type;
1418                 cb->args[3] = rq->header.xid;
1419                 if (s->init) {
1420                         void *state;
1421                         err = s->init(dp, rq->body, body_len, &state);
1422                         if (err)
1423                                 goto out;
1424                         cb->args[4] = (long) state;
1425                 }
1426         } else if (cb->args[0] == 1) {
1427                 dp_idx = cb->args[1];
1428                 s = &stats[cb->args[2]];
1429
1430                 dp = dp_get(dp_idx);
1431                 if (!dp) {
1432                         err = -ENOENT;
1433                         goto out;
1434                 }
1435         } else {
1436                 err = 0;
1437                 goto out;
1438         }
1439
1440         sender.xid = cb->args[3];
1441         sender.pid = NETLINK_CB(cb->skb).pid;
1442         sender.seq = cb->nlh->nlmsg_seq;
1443
1444         osr = put_openflow_headers(dp, skb, OFPT_STATS_REPLY, &sender,
1445                                    &max_openflow_len);
1446         if (IS_ERR(osr)) {
1447                 err = PTR_ERR(osr);
1448                 goto out;
1449         }
1450         osr->type = htons(s - stats);
1451         osr->flags = 0;
1452         resize_openflow_skb(skb, &osr->header, max_openflow_len);
1453         body = osr->body;
1454         body_len = max_openflow_len - offsetof(struct ofp_stats_reply, body);
1455
1456         err = s->dump(dp, (void *) cb->args[4], body, &body_len);
1457         if (err >= 0) {
1458                 if (!err)
1459                         cb->args[0] = 2;
1460                 else
1461                         osr->flags = ntohs(OFPSF_REPLY_MORE);
1462                 resize_openflow_skb(skb, &osr->header,
1463                                     (offsetof(struct ofp_stats_reply, body)
1464                                      + body_len));
1465                 err = skb->len;
1466         }
1467
1468 out:
1469         rcu_read_unlock();
1470         return err;
1471 }
1472
1473 static int
1474 dp_genl_openflow_done(struct netlink_callback *cb)
1475 {
1476         if (cb->args[0]) {
1477                 const struct stats_type *s = &stats[cb->args[2]];
1478                 if (s->done)
1479                         s->done((void *) cb->args[4]);
1480         }
1481         return 0;
1482 }
1483
1484 static struct genl_ops dp_genl_ops_openflow = {
1485         .cmd = DP_GENL_C_OPENFLOW,
1486         .flags = GENL_ADMIN_PERM, /* Requires CAP_NET_ADMIN privilege. */
1487         .policy = dp_genl_openflow_policy,
1488         .doit = dp_genl_openflow,
1489         .dumpit = dp_genl_openflow_dumpit,
1490 };
1491
1492 static struct genl_ops *dp_genl_all_ops[] = {
1493         /* Keep this operation first.  Generic Netlink dispatching
1494          * looks up operations with linear search, so we want it at the
1495          * front. */
1496         &dp_genl_ops_openflow,
1497
1498         &dp_genl_ops_add_dp,
1499         &dp_genl_ops_del_dp,
1500         &dp_genl_ops_query_dp,
1501         &dp_genl_ops_add_port,
1502         &dp_genl_ops_del_port,
1503 };
1504
1505 static int dp_init_netlink(void)
1506 {
1507         int err;
1508         int i;
1509
1510         err = genl_register_family(&dp_genl_family);
1511         if (err)
1512                 return err;
1513
1514         for (i = 0; i < ARRAY_SIZE(dp_genl_all_ops); i++) {
1515                 err = genl_register_ops(&dp_genl_family, dp_genl_all_ops[i]);
1516                 if (err)
1517                         goto err_unregister;
1518         }
1519
1520         strcpy(mc_group.name, "openflow");
1521         err = genl_register_mc_group(&dp_genl_family, &mc_group);
1522         if (err < 0)
1523                 goto err_unregister;
1524
1525         return 0;
1526
1527 err_unregister:
1528         genl_unregister_family(&dp_genl_family);
1529                 return err;
1530 }
1531
1532 static void dp_uninit_netlink(void)
1533 {
1534         genl_unregister_family(&dp_genl_family);
1535 }
1536
1537 #define DRV_NAME                "openflow"
1538 #define DRV_VERSION      VERSION
1539 #define DRV_DESCRIPTION "OpenFlow switching datapath implementation"
1540 #define DRV_COPYRIGHT   "Copyright (c) 2007, 2008 The Board of Trustees of The Leland Stanford Junior University"
1541
1542
1543 static int __init dp_init(void)
1544 {
1545         int err;
1546
1547         printk(KERN_INFO DRV_NAME ": " DRV_DESCRIPTION "\n");
1548         printk(KERN_INFO DRV_NAME ": " VERSION" built on "__DATE__" "__TIME__"\n");
1549         printk(KERN_INFO DRV_NAME ": " DRV_COPYRIGHT "\n");
1550
1551         err = flow_init();
1552         if (err)
1553                 goto error;
1554
1555         err = dp_init_netlink();
1556         if (err)
1557                 goto error_flow_exit;
1558
1559         /* Hook into callback used by the bridge to intercept packets.
1560          * Parasites we are. */
1561         if (br_handle_frame_hook)
1562                 printk("openflow: hijacking bridge hook\n");
1563         br_handle_frame_hook = dp_frame_hook;
1564
1565         return 0;
1566
1567 error_flow_exit:
1568         flow_exit();
1569 error:
1570         printk(KERN_EMERG "openflow: failed to install!");
1571         return err;
1572 }
1573
1574 static void dp_cleanup(void)
1575 {
1576         fwd_exit();
1577         dp_uninit_netlink();
1578         flow_exit();
1579         br_handle_frame_hook = NULL;
1580 }
1581
1582 module_init(dp_init);
1583 module_exit(dp_cleanup);
1584
1585 MODULE_DESCRIPTION(DRV_DESCRIPTION);
1586 MODULE_AUTHOR(DRV_COPYRIGHT);
1587 MODULE_LICENSE("GPL");