2 * Copyright (c) 2009 Nicira Networks.
3 * Distributed under the terms of the GNU GPL version 2.
5 * Significant portions of this file may be copied from parts of the Linux
6 * kernel, by Linus Torvalds and others.
9 #include <linux/kernel.h>
10 #include <asm/uaccess.h>
11 #include <linux/completion.h>
12 #include <linux/delay.h>
13 #include <linux/etherdevice.h>
14 #include <linux/if_bridge.h>
15 #include <linux/rculist.h>
16 #include <linux/netdevice.h>
17 #include <linux/rtnetlink.h>
18 #include <net/genetlink.h>
21 #include "openvswitch/brcompat-netlink.h"
22 #include "brc_procfs.h"
23 #include "brc_sysfs.h"
27 static struct genl_family brc_genl_family;
28 static struct genl_multicast_group brc_mc_group;
30 /* Time to wait for ovs-vswitchd to respond to a datapath action, in
32 #define BRC_TIMEOUT (HZ * 5)
34 /* Mutex to serialize ovs-brcompatd callbacks. (Some callbacks naturally hold
35 * br_ioctl_mutex, others hold rtnl_lock, but we can't take the former
36 * ourselves and we don't want to hold the latter over a potentially long
38 static DEFINE_MUTEX(brc_serial);
40 /* Userspace communication. */
41 static DEFINE_SPINLOCK(brc_lock); /* Ensure atomic access to these vars. */
42 static DECLARE_COMPLETION(brc_done); /* Userspace signaled operation done? */
43 static struct sk_buff *brc_reply; /* Reply from userspace. */
44 static u32 brc_seq; /* Sequence number for current op. */
46 static struct sk_buff *brc_send_command(struct sk_buff *, struct nlattr **attrs);
47 static int brc_send_simple_command(struct sk_buff *);
50 get_dp_ifindices(int *indices, int num)
55 for (i=0; i < ODP_MAX && index < num; i++) {
56 struct datapath *dp = get_dp(i);
59 indices[index++] = dp->ports[ODPP_LOCAL]->dev->ifindex;
67 get_port_ifindices(struct datapath *dp, int *ifindices, int num)
69 struct net_bridge_port *p;
72 list_for_each_entry_rcu (p, &dp->port_list, node) {
74 ifindices[p->port_no] = p->dev->ifindex;
79 static struct sk_buff *
80 brc_make_request(int op, const char *bridge, const char *port)
82 struct sk_buff *skb = genlmsg_new(NLMSG_GOODSIZE, GFP_KERNEL);
86 genlmsg_put(skb, 0, 0, &brc_genl_family, 0, op);
87 NLA_PUT_STRING(skb, BRC_GENL_A_DP_NAME, bridge);
89 NLA_PUT_STRING(skb, BRC_GENL_A_PORT_NAME, port);
98 static int brc_send_simple_command(struct sk_buff *request)
100 struct nlattr *attrs[BRC_GENL_A_MAX + 1];
101 struct sk_buff *reply;
104 reply = brc_send_command(request, attrs);
106 return PTR_ERR(reply);
108 error = nla_get_u32(attrs[BRC_GENL_A_ERR_CODE]);
113 static int brc_add_del_bridge(char __user *uname, int add)
115 struct sk_buff *request;
118 if (copy_from_user(name, uname, IFNAMSIZ))
121 name[IFNAMSIZ - 1] = 0;
122 request = brc_make_request(add ? BRC_GENL_C_DP_ADD : BRC_GENL_C_DP_DEL,
127 return brc_send_simple_command(request);
130 static int brc_get_bridges(int __user *uindices, int n)
138 indices = kcalloc(n, sizeof(int), GFP_KERNEL);
142 n = get_dp_ifindices(indices, n);
144 ret = copy_to_user(uindices, indices, n * sizeof(int)) ? -EFAULT : n;
150 /* Legacy deviceless bridge ioctl's. Called with br_ioctl_mutex. */
152 old_deviceless(void __user *uarg)
154 unsigned long args[3];
156 if (copy_from_user(args, uarg, sizeof(args)))
160 case BRCTL_GET_BRIDGES:
161 return brc_get_bridges((int __user *)args[1], args[2]);
163 case BRCTL_ADD_BRIDGE:
164 return brc_add_del_bridge((void __user *)args[1], 1);
165 case BRCTL_DEL_BRIDGE:
166 return brc_add_del_bridge((void __user *)args[1], 0);
172 /* Called with the br_ioctl_mutex. */
174 #if LINUX_VERSION_CODE <= KERNEL_VERSION(2,6,23)
175 brc_ioctl_deviceless_stub(unsigned int cmd, void __user *uarg)
177 brc_ioctl_deviceless_stub(struct net *net, unsigned int cmd, void __user *uarg)
183 return old_deviceless(uarg);
186 return brc_add_del_bridge(uarg, 1);
188 return brc_add_del_bridge(uarg, 0);
195 brc_add_del_port(struct net_device *dev, int port_ifindex, int add)
197 struct sk_buff *request;
198 struct net_device *port;
201 port = __dev_get_by_index(&init_net, port_ifindex);
205 /* Save name of dev and port because there's a race between the
206 * rtnl_unlock() and the brc_send_simple_command(). */
207 request = brc_make_request(add ? BRC_GENL_C_PORT_ADD : BRC_GENL_C_PORT_DEL,
208 dev->name, port->name);
213 err = brc_send_simple_command(request);
220 brc_get_bridge_info(struct net_device *dev, struct __bridge_info __user *ub)
222 struct __bridge_info b;
226 memset(&b, 0, sizeof(struct __bridge_info));
228 for (i=0; i<ETH_ALEN; i++)
229 id |= (u64)dev->dev_addr[i] << (8*(ETH_ALEN-1 - i));
230 b.bridge_id = cpu_to_be64(id);
233 if (copy_to_user(ub, &b, sizeof(struct __bridge_info)))
240 brc_get_port_list(struct net_device *dev, int __user *uindices, int num)
242 struct dp_dev *dp_dev = netdev_priv(dev);
243 struct datapath *dp = dp_dev->dp;
250 if (num > DP_MAX_PORTS)
253 indices = kcalloc(num, sizeof(int), GFP_KERNEL);
257 get_port_ifindices(dp, indices, num);
258 if (copy_to_user(uindices, indices, num * sizeof(int)))
264 /* Legacy ioctl's through SIOCDEVPRIVATE. Called with rtnl_lock. */
266 old_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd)
268 unsigned long args[4];
270 if (copy_from_user(args, rq->ifr_data, sizeof(args)))
275 return brc_add_del_port(dev, args[1], 1);
277 return brc_add_del_port(dev, args[1], 0);
279 case BRCTL_GET_BRIDGE_INFO:
280 return brc_get_bridge_info(dev, (struct __bridge_info __user *)args[1]);
282 case BRCTL_GET_PORT_LIST:
283 return brc_get_port_list(dev, (int __user *)args[1], args[2]);
289 /* Called with the rtnl_lock. */
291 brc_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd)
297 err = old_dev_ioctl(dev, rq, cmd);
301 return brc_add_del_port(dev, rq->ifr_ifindex, 1);
303 return brc_add_del_port(dev, rq->ifr_ifindex, 0);
314 static struct genl_family brc_genl_family = {
315 .id = GENL_ID_GENERATE,
317 .name = BRC_GENL_FAMILY_NAME,
319 .maxattr = BRC_GENL_A_MAX,
322 static int brc_genl_query(struct sk_buff *skb, struct genl_info *info)
325 struct sk_buff *ans_skb;
328 ans_skb = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_KERNEL);
332 data = genlmsg_put_reply(ans_skb, info, &brc_genl_family,
333 0, BRC_GENL_C_QUERY_MC);
338 NLA_PUT_U32(ans_skb, BRC_GENL_A_MC_GROUP, brc_mc_group.id);
340 genlmsg_end(ans_skb, data);
341 return genlmsg_reply(ans_skb, info);
349 static struct genl_ops brc_genl_ops_query_dp = {
350 .cmd = BRC_GENL_C_QUERY_MC,
351 .flags = GENL_ADMIN_PERM, /* Requires CAP_NET_ADMIN privelege. */
353 .doit = brc_genl_query,
357 /* Attribute policy: what each attribute may contain. */
358 static struct nla_policy brc_genl_policy[BRC_GENL_A_MAX + 1] = {
359 [BRC_GENL_A_ERR_CODE] = { .type = NLA_U32 },
360 [BRC_GENL_A_PROC_DIR] = { .type = NLA_NUL_STRING },
361 [BRC_GENL_A_PROC_NAME] = { .type = NLA_NUL_STRING },
362 [BRC_GENL_A_PROC_DATA] = { .type = NLA_NUL_STRING },
366 brc_genl_dp_result(struct sk_buff *skb, struct genl_info *info)
368 unsigned long int flags;
371 if (!info->attrs[BRC_GENL_A_ERR_CODE])
374 skb = skb_clone(skb, GFP_KERNEL);
378 spin_lock_irqsave(&brc_lock, flags);
379 if (brc_seq == info->snd_seq) {
383 kfree_skb(brc_reply);
392 spin_unlock_irqrestore(&brc_lock, flags);
397 static struct genl_ops brc_genl_ops_dp_result = {
398 .cmd = BRC_GENL_C_DP_RESULT,
399 .flags = GENL_ADMIN_PERM, /* Requires CAP_NET_ADMIN privelege. */
400 .policy = brc_genl_policy,
401 .doit = brc_genl_dp_result,
405 static struct genl_ops brc_genl_ops_set_proc = {
406 .cmd = BRC_GENL_C_SET_PROC,
407 .flags = GENL_ADMIN_PERM, /* Requires CAP_NET_ADMIN privelege. */
408 .policy = brc_genl_policy,
409 .doit = brc_genl_set_proc,
413 static struct sk_buff *brc_send_command(struct sk_buff *request, struct nlattr **attrs)
415 unsigned long int flags;
416 struct sk_buff *reply;
419 mutex_lock(&brc_serial);
421 /* Increment sequence number first, so that we ignore any replies
422 * to stale requests. */
423 spin_lock_irqsave(&brc_lock, flags);
424 nlmsg_hdr(request)->nlmsg_seq = ++brc_seq;
425 INIT_COMPLETION(brc_done);
426 spin_unlock_irqrestore(&brc_lock, flags);
428 nlmsg_end(request, nlmsg_hdr(request));
431 error = genlmsg_multicast(request, 0, brc_mc_group.id, GFP_KERNEL);
435 /* Wait for reply. */
437 if (!wait_for_completion_timeout(&brc_done, BRC_TIMEOUT))
441 spin_lock_irqsave(&brc_lock, flags);
444 spin_unlock_irqrestore(&brc_lock, flags);
446 mutex_unlock(&brc_serial);
448 /* Re-parse message. Can't fail, since it parsed correctly once
450 error = nlmsg_parse(nlmsg_hdr(reply), GENL_HDRLEN,
451 attrs, BRC_GENL_A_MAX, brc_genl_policy);
457 mutex_unlock(&brc_serial);
458 return ERR_PTR(error);
461 int brc_add_dp(struct datapath *dp)
463 if (!try_module_get(THIS_MODULE))
466 brc_sysfs_add_dp(dp);
472 int brc_del_dp(struct datapath *dp)
475 brc_sysfs_del_dp(dp);
477 module_put(THIS_MODULE);
483 __init brc_init(void)
488 printk("Open vSwitch Bridge Compatibility, built "__DATE__" "__TIME__"\n");
491 for (i=0; i<ODP_MAX; i++) {
494 printk(KERN_EMERG "brcompat: no datapaths may exist!\n");
500 /* Set the bridge ioctl handler */
501 brioctl_set(brc_ioctl_deviceless_stub);
503 /* Set the openvswitch_mod device ioctl handler */
504 dp_ioctl_hook = brc_dev_ioctl;
506 /* Register hooks for datapath adds and deletes */
507 dp_add_dp_hook = brc_add_dp;
508 dp_del_dp_hook = brc_del_dp;
510 /* Register hooks for interface adds and deletes */
512 dp_add_if_hook = brc_sysfs_add_if;
513 dp_del_if_hook = brc_sysfs_del_if;
516 /* Randomize the initial sequence number. This is not a security
517 * feature; it only helps avoid crossed wires between userspace and
518 * the kernel when the module is unloaded and reloaded. */
519 brc_seq = net_random();
521 /* Register generic netlink family to communicate changes to
523 err = genl_register_family(&brc_genl_family);
527 err = genl_register_ops(&brc_genl_family, &brc_genl_ops_query_dp);
531 err = genl_register_ops(&brc_genl_family, &brc_genl_ops_dp_result);
535 err = genl_register_ops(&brc_genl_family, &brc_genl_ops_set_proc);
539 strcpy(brc_mc_group.name, "brcompat");
540 err = genl_register_mc_group(&brc_genl_family, &brc_mc_group);
547 genl_unregister_family(&brc_genl_family);
549 printk(KERN_EMERG "brcompat: failed to install!");
556 /* Unregister hooks for datapath adds and deletes */
557 dp_add_dp_hook = NULL;
558 dp_del_dp_hook = NULL;
560 /* Unregister hooks for interface adds and deletes */
561 dp_add_if_hook = NULL;
562 dp_del_if_hook = NULL;
564 /* Unregister ioctl hooks */
565 dp_ioctl_hook = NULL;
568 genl_unregister_family(&brc_genl_family);
572 module_init(brc_init);
573 module_exit(brc_cleanup);
575 MODULE_DESCRIPTION("Open vSwitch bridge compatibility");
576 MODULE_AUTHOR("Nicira Networks");
577 MODULE_LICENSE("GPL");