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 int brc_err; /* Error code from userspace. */
44 static u32 brc_seq; /* Sequence number for current op. */
46 static int brc_send_command(const char *bridge, const char *port, int op);
49 get_dp_ifindices(int *indices, int num)
54 for (i=0; i < ODP_MAX && index < num; i++) {
55 struct datapath *dp = get_dp(i);
58 indices[index++] = dp->ports[ODPP_LOCAL]->dev->ifindex;
66 get_port_ifindices(struct datapath *dp, int *ifindices, int num)
68 struct net_bridge_port *p;
71 list_for_each_entry_rcu (p, &dp->port_list, node) {
73 ifindices[p->port_no] = p->dev->ifindex;
78 static int brc_add_del_bridge(char __user *uname, int add)
82 if (copy_from_user(name, uname, IFNAMSIZ))
85 name[IFNAMSIZ - 1] = 0;
86 return brc_send_command(name, NULL,
87 add ? BRC_GENL_C_DP_ADD : BRC_GENL_C_DP_DEL);
90 static int brc_get_bridges(int __user *uindices, int n)
98 indices = kcalloc(n, sizeof(int), GFP_KERNEL);
102 n = get_dp_ifindices(indices, n);
104 ret = copy_to_user(uindices, indices, n * sizeof(int)) ? -EFAULT : n;
110 /* Legacy deviceless bridge ioctl's. Called with br_ioctl_mutex. */
112 old_deviceless(void __user *uarg)
114 unsigned long args[3];
116 if (copy_from_user(args, uarg, sizeof(args)))
120 case BRCTL_GET_BRIDGES:
121 return brc_get_bridges((int __user *)args[1], args[2]);
123 case BRCTL_ADD_BRIDGE:
124 return brc_add_del_bridge((void __user *)args[1], 1);
125 case BRCTL_DEL_BRIDGE:
126 return brc_add_del_bridge((void __user *)args[1], 0);
132 /* Called with the br_ioctl_mutex. */
134 #if LINUX_VERSION_CODE <= KERNEL_VERSION(2,6,23)
135 brc_ioctl_deviceless_stub(unsigned int cmd, void __user *uarg)
137 brc_ioctl_deviceless_stub(struct net *net, unsigned int cmd, void __user *uarg)
143 return old_deviceless(uarg);
146 return brc_add_del_bridge(uarg, 1);
148 return brc_add_del_bridge(uarg, 0);
155 brc_add_del_port(struct net_device *dev, int port_ifindex, int add)
157 struct net_device *port;
158 char dev_name[IFNAMSIZ], port_name[IFNAMSIZ];
161 port = __dev_get_by_index(&init_net, port_ifindex);
165 /* Save name of dev and port because there's a race between the
166 * rtnl_unlock() and the brc_send_command(). */
167 strcpy(dev_name, dev->name);
168 strcpy(port_name, port->name);
171 err = brc_send_command(dev_name, port_name,
172 add ? BRC_GENL_C_PORT_ADD : BRC_GENL_C_PORT_DEL);
179 brc_get_bridge_info(struct net_device *dev, struct __bridge_info __user *ub)
181 struct __bridge_info b;
185 memset(&b, 0, sizeof(struct __bridge_info));
187 for (i=0; i<ETH_ALEN; i++)
188 id |= (u64)dev->dev_addr[i] << (8*(ETH_ALEN-1 - i));
189 b.bridge_id = cpu_to_be64(id);
192 if (copy_to_user(ub, &b, sizeof(struct __bridge_info)))
199 brc_get_port_list(struct net_device *dev, int __user *uindices, int num)
201 struct dp_dev *dp_dev = netdev_priv(dev);
202 struct datapath *dp = dp_dev->dp;
209 if (num > DP_MAX_PORTS)
212 indices = kcalloc(num, sizeof(int), GFP_KERNEL);
216 get_port_ifindices(dp, indices, num);
217 if (copy_to_user(uindices, indices, num * sizeof(int)))
223 /* Legacy ioctl's through SIOCDEVPRIVATE. Called with rtnl_lock. */
225 old_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd)
227 unsigned long args[4];
229 if (copy_from_user(args, rq->ifr_data, sizeof(args)))
234 return brc_add_del_port(dev, args[1], 1);
236 return brc_add_del_port(dev, args[1], 0);
238 case BRCTL_GET_BRIDGE_INFO:
239 return brc_get_bridge_info(dev, (struct __bridge_info __user *)args[1]);
241 case BRCTL_GET_PORT_LIST:
242 return brc_get_port_list(dev, (int __user *)args[1], args[2]);
248 /* Called with the rtnl_lock. */
250 brc_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd)
256 err = old_dev_ioctl(dev, rq, cmd);
260 return brc_add_del_port(dev, rq->ifr_ifindex, 1);
262 return brc_add_del_port(dev, rq->ifr_ifindex, 0);
273 static struct genl_family brc_genl_family = {
274 .id = GENL_ID_GENERATE,
276 .name = BRC_GENL_FAMILY_NAME,
278 .maxattr = BRC_GENL_A_MAX,
281 static int brc_genl_query(struct sk_buff *skb, struct genl_info *info)
284 struct sk_buff *ans_skb;
287 ans_skb = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_KERNEL);
291 data = genlmsg_put_reply(ans_skb, info, &brc_genl_family,
292 0, BRC_GENL_C_QUERY_MC);
297 NLA_PUT_U32(ans_skb, BRC_GENL_A_MC_GROUP, brc_mc_group.id);
299 genlmsg_end(ans_skb, data);
300 return genlmsg_reply(ans_skb, info);
308 static struct genl_ops brc_genl_ops_query_dp = {
309 .cmd = BRC_GENL_C_QUERY_MC,
310 .flags = GENL_ADMIN_PERM, /* Requires CAP_NET_ADMIN privelege. */
312 .doit = brc_genl_query,
316 /* Attribute policy: what each attribute may contain. */
317 static struct nla_policy brc_genl_policy[BRC_GENL_A_MAX + 1] = {
318 [BRC_GENL_A_ERR_CODE] = { .type = NLA_U32 },
319 [BRC_GENL_A_PROC_DIR] = { .type = NLA_NUL_STRING },
320 [BRC_GENL_A_PROC_NAME] = { .type = NLA_NUL_STRING },
321 [BRC_GENL_A_PROC_DATA] = { .type = NLA_NUL_STRING },
325 brc_genl_dp_result(struct sk_buff *skb, struct genl_info *info)
327 unsigned long int flags;
330 if (!info->attrs[BRC_GENL_A_ERR_CODE])
333 spin_lock_irqsave(&brc_lock, flags);
334 if (brc_seq == info->snd_seq) {
335 brc_err = nla_get_u32(info->attrs[BRC_GENL_A_ERR_CODE]);
341 spin_unlock_irqrestore(&brc_lock, flags);
346 static struct genl_ops brc_genl_ops_dp_result = {
347 .cmd = BRC_GENL_C_DP_RESULT,
348 .flags = GENL_ADMIN_PERM, /* Requires CAP_NET_ADMIN privelege. */
349 .policy = brc_genl_policy,
350 .doit = brc_genl_dp_result,
354 static struct genl_ops brc_genl_ops_set_proc = {
355 .cmd = BRC_GENL_C_SET_PROC,
356 .flags = GENL_ADMIN_PERM, /* Requires CAP_NET_ADMIN privelege. */
357 .policy = brc_genl_policy,
358 .doit = brc_genl_set_proc,
362 static int brc_send_command(const char *bridge, const char *port, int op)
364 unsigned long int flags;
369 mutex_lock(&brc_serial);
371 /* Increment sequence number first, so that we ignore any replies
372 * to stale requests. */
373 spin_lock_irqsave(&brc_lock, flags);
375 INIT_COMPLETION(brc_done);
376 spin_unlock_irqrestore(&brc_lock, flags);
378 /* Compose message. */
379 skb = genlmsg_new(NLMSG_GOODSIZE, GFP_KERNEL);
383 data = genlmsg_put(skb, 0, brc_seq, &brc_genl_family, 0, op);
385 NLA_PUT_STRING(skb, BRC_GENL_A_DP_NAME, bridge);
387 NLA_PUT_STRING(skb, BRC_GENL_A_PORT_NAME, port);
389 genlmsg_end(skb, data);
392 error = genlmsg_multicast(skb, 0, brc_mc_group.id, GFP_KERNEL);
396 /* Wait for reply. */
398 if (!wait_for_completion_timeout(&brc_done, BRC_TIMEOUT))
407 mutex_unlock(&brc_serial);
411 int brc_add_dp(struct datapath *dp)
413 if (!try_module_get(THIS_MODULE))
415 brc_sysfs_add_dp(dp);
420 int brc_del_dp(struct datapath *dp)
422 brc_sysfs_del_dp(dp);
423 module_put(THIS_MODULE);
429 __init brc_init(void)
434 printk("Open vSwitch Bridge Compatibility, built "__DATE__" "__TIME__"\n");
437 for (i=0; i<ODP_MAX; i++) {
440 printk(KERN_EMERG "brcompat: no datapaths may exist!\n");
446 /* Set the bridge ioctl handler */
447 brioctl_set(brc_ioctl_deviceless_stub);
449 /* Set the openvswitch_mod device ioctl handler */
450 dp_ioctl_hook = brc_dev_ioctl;
452 /* Register hooks for datapath adds and deletes */
453 dp_add_dp_hook = brc_add_dp;
454 dp_del_dp_hook = brc_del_dp;
456 /* Register hooks for interface adds and deletes */
457 dp_add_if_hook = brc_sysfs_add_if;
458 dp_del_if_hook = brc_sysfs_del_if;
460 /* Randomize the initial sequence number. This is not a security
461 * feature; it only helps avoid crossed wires between userspace and
462 * the kernel when the module is unloaded and reloaded. */
463 brc_seq = net_random();
465 /* Register generic netlink family to communicate changes to
467 err = genl_register_family(&brc_genl_family);
471 err = genl_register_ops(&brc_genl_family, &brc_genl_ops_query_dp);
475 err = genl_register_ops(&brc_genl_family, &brc_genl_ops_dp_result);
479 err = genl_register_ops(&brc_genl_family, &brc_genl_ops_set_proc);
483 strcpy(brc_mc_group.name, "brcompat");
484 err = genl_register_mc_group(&brc_genl_family, &brc_mc_group);
491 genl_unregister_family(&brc_genl_family);
493 printk(KERN_EMERG "brcompat: failed to install!");
500 /* Unregister hooks for datapath adds and deletes */
501 dp_add_dp_hook = NULL;
502 dp_del_dp_hook = NULL;
504 /* Unregister hooks for interface adds and deletes */
505 dp_add_if_hook = NULL;
506 dp_del_if_hook = NULL;
508 /* Unregister ioctl hooks */
509 dp_ioctl_hook = NULL;
512 genl_unregister_family(&brc_genl_family);
516 module_init(brc_init);
517 module_exit(brc_cleanup);
519 MODULE_DESCRIPTION("Open vSwitch bridge compatibility");
520 MODULE_AUTHOR("Nicira Networks");
521 MODULE_LICENSE("GPL");