debian: Synchronize debian/changelog with downstream Debian changelog.
[openvswitch] / datapath / vport.c
1 /*
2  * Copyright (c) 2007-2012 Nicira, Inc.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of version 2 of the GNU General Public
6  * License as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful, but
9  * WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11  * General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
16  * 02110-1301, USA
17  */
18
19 #include <linux/etherdevice.h>
20 #include <linux/if.h>
21 #include <linux/if_vlan.h>
22 #include <linux/jhash.h>
23 #include <linux/kernel.h>
24 #include <linux/list.h>
25 #include <linux/mutex.h>
26 #include <linux/percpu.h>
27 #include <linux/rcupdate.h>
28 #include <linux/rtnetlink.h>
29 #include <linux/compat.h>
30 #include <linux/version.h>
31 #include <net/net_namespace.h>
32
33 #include "datapath.h"
34 #include "vport.h"
35 #include "vport-internal_dev.h"
36
37 /* List of statically compiled vport implementations.  Don't forget to also
38  * add yours to the list at the bottom of vport.h. */
39 static const struct vport_ops *base_vport_ops_list[] = {
40         &ovs_netdev_vport_ops,
41         &ovs_internal_vport_ops,
42         &ovs_patch_vport_ops,
43         &ovs_gre_vport_ops,
44 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,26)
45         &ovs_capwap_vport_ops,
46 #endif
47 };
48
49 static const struct vport_ops **vport_ops_list;
50 static int n_vport_types;
51
52 /* Protected by RCU read lock for reading, RTNL lock for writing. */
53 static struct hlist_head *dev_table;
54 #define VPORT_HASH_BUCKETS 1024
55
56 /**
57  *      ovs_vport_init - initialize vport subsystem
58  *
59  * Called at module load time to initialize the vport subsystem and any
60  * compiled in vport types.
61  */
62 int ovs_vport_init(void)
63 {
64         int err;
65         int i;
66
67         dev_table = kzalloc(VPORT_HASH_BUCKETS * sizeof(struct hlist_head),
68                             GFP_KERNEL);
69         if (!dev_table) {
70                 err = -ENOMEM;
71                 goto error;
72         }
73
74         vport_ops_list = kmalloc(ARRAY_SIZE(base_vport_ops_list) *
75                                  sizeof(struct vport_ops *), GFP_KERNEL);
76         if (!vport_ops_list) {
77                 err = -ENOMEM;
78                 goto error_dev_table;
79         }
80
81         for (i = 0; i < ARRAY_SIZE(base_vport_ops_list); i++) {
82                 const struct vport_ops *new_ops = base_vport_ops_list[i];
83
84                 if (new_ops->init)
85                         err = new_ops->init();
86                 else
87                         err = 0;
88
89                 if (!err)
90                         vport_ops_list[n_vport_types++] = new_ops;
91                 else if (new_ops->flags & VPORT_F_REQUIRED) {
92                         ovs_vport_exit();
93                         goto error;
94                 }
95         }
96
97         return 0;
98
99 error_dev_table:
100         kfree(dev_table);
101 error:
102         return err;
103 }
104
105 /**
106  *      ovs_vport_exit - shutdown vport subsystem
107  *
108  * Called at module exit time to shutdown the vport subsystem and any
109  * initialized vport types.
110  */
111 void ovs_vport_exit(void)
112 {
113         int i;
114
115         for (i = 0; i < n_vport_types; i++) {
116                 if (vport_ops_list[i]->exit)
117                         vport_ops_list[i]->exit();
118         }
119
120         kfree(vport_ops_list);
121         kfree(dev_table);
122 }
123
124 static struct hlist_head *hash_bucket(struct net *net, const char *name)
125 {
126         unsigned int hash = jhash(name, strlen(name), (unsigned long) net);
127         return &dev_table[hash & (VPORT_HASH_BUCKETS - 1)];
128 }
129
130 /**
131  *      ovs_vport_locate - find a port that has already been created
132  *
133  * @name: name of port to find
134  *
135  * Must be called with RTNL or RCU read lock.
136  */
137 struct vport *ovs_vport_locate(struct net *net, const char *name)
138 {
139         struct hlist_head *bucket = hash_bucket(net, name);
140         struct vport *vport;
141         struct hlist_node *node;
142
143         hlist_for_each_entry_rcu(vport, node, bucket, hash_node)
144                 if (!strcmp(name, vport->ops->get_name(vport)) &&
145                     net_eq(ovs_dp_get_net(vport->dp), net))
146                         return vport;
147
148         return NULL;
149 }
150
151 static void release_vport(struct kobject *kobj)
152 {
153         struct vport *p = container_of(kobj, struct vport, kobj);
154         kfree(p);
155 }
156
157 static struct kobj_type brport_ktype = {
158 #ifdef CONFIG_SYSFS
159         .sysfs_ops = &ovs_brport_sysfs_ops,
160 #endif
161         .release = release_vport
162 };
163
164 /**
165  *      ovs_vport_alloc - allocate and initialize new vport
166  *
167  * @priv_size: Size of private data area to allocate.
168  * @ops: vport device ops
169  *
170  * Allocate and initialize a new vport defined by @ops.  The vport will contain
171  * a private data area of size @priv_size that can be accessed using
172  * vport_priv().  vports that are no longer needed should be released with
173  * ovs_vport_free().
174  */
175 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *ops,
176                               const struct vport_parms *parms)
177 {
178         struct vport *vport;
179         size_t alloc_size;
180
181         alloc_size = sizeof(struct vport);
182         if (priv_size) {
183                 alloc_size = ALIGN(alloc_size, VPORT_ALIGN);
184                 alloc_size += priv_size;
185         }
186
187         vport = kzalloc(alloc_size, GFP_KERNEL);
188         if (!vport)
189                 return ERR_PTR(-ENOMEM);
190
191         vport->dp = parms->dp;
192         vport->port_no = parms->port_no;
193         vport->upcall_pid = parms->upcall_pid;
194         vport->ops = ops;
195         INIT_HLIST_NODE(&vport->dp_hash_node);
196
197         /* Initialize kobject for bridge.  This will be added as
198          * /sys/class/net/<devname>/brport later, if sysfs is enabled. */
199         vport->kobj.kset = NULL;
200         kobject_init(&vport->kobj, &brport_ktype);
201
202         vport->percpu_stats = alloc_percpu(struct vport_percpu_stats);
203         if (!vport->percpu_stats) {
204                 kfree(vport);
205                 return ERR_PTR(-ENOMEM);
206         }
207
208         spin_lock_init(&vport->stats_lock);
209
210         return vport;
211 }
212
213 /**
214  *      ovs_vport_free - uninitialize and free vport
215  *
216  * @vport: vport to free
217  *
218  * Frees a vport allocated with ovs_vport_alloc() when it is no longer needed.
219  *
220  * The caller must ensure that an RCU grace period has passed since the last
221  * time @vport was in a datapath.
222  */
223 void ovs_vport_free(struct vport *vport)
224 {
225         free_percpu(vport->percpu_stats);
226
227         kobject_put(&vport->kobj);
228 }
229
230 /**
231  *      ovs_vport_add - add vport device (for kernel callers)
232  *
233  * @parms: Information about new vport.
234  *
235  * Creates a new vport with the specified configuration (which is dependent on
236  * device type).  RTNL lock must be held.
237  */
238 struct vport *ovs_vport_add(const struct vport_parms *parms)
239 {
240         struct vport *vport;
241         int err = 0;
242         int i;
243
244         ASSERT_RTNL();
245
246         for (i = 0; i < n_vport_types; i++) {
247                 if (vport_ops_list[i]->type == parms->type) {
248                         struct hlist_head *bucket;
249
250                         vport = vport_ops_list[i]->create(parms);
251                         if (IS_ERR(vport)) {
252                                 err = PTR_ERR(vport);
253                                 goto out;
254                         }
255
256                         bucket = hash_bucket(ovs_dp_get_net(vport->dp),
257                                              vport->ops->get_name(vport));
258                         hlist_add_head_rcu(&vport->hash_node, bucket);
259                         return vport;
260                 }
261         }
262
263         err = -EAFNOSUPPORT;
264
265 out:
266         return ERR_PTR(err);
267 }
268
269 /**
270  *      ovs_vport_set_options - modify existing vport device (for kernel callers)
271  *
272  * @vport: vport to modify.
273  * @port: New configuration.
274  *
275  * Modifies an existing device with the specified configuration (which is
276  * dependent on device type).  RTNL lock must be held.
277  */
278 int ovs_vport_set_options(struct vport *vport, struct nlattr *options)
279 {
280         ASSERT_RTNL();
281
282         if (!vport->ops->set_options)
283                 return -EOPNOTSUPP;
284         return vport->ops->set_options(vport, options);
285 }
286
287 /**
288  *      ovs_vport_del - delete existing vport device
289  *
290  * @vport: vport to delete.
291  *
292  * Detaches @vport from its datapath and destroys it.  It is possible to fail
293  * for reasons such as lack of memory.  RTNL lock must be held.
294  */
295 void ovs_vport_del(struct vport *vport)
296 {
297         ASSERT_RTNL();
298
299         hlist_del_rcu(&vport->hash_node);
300
301         vport->ops->destroy(vport);
302 }
303
304 /**
305  *      ovs_vport_set_addr - set device Ethernet address (for kernel callers)
306  *
307  * @vport: vport on which to set Ethernet address.
308  * @addr: New address.
309  *
310  * Sets the Ethernet address of the given device.  Some devices may not support
311  * setting the Ethernet address, in which case the result will always be
312  * -EOPNOTSUPP.  RTNL lock must be held.
313  */
314 int ovs_vport_set_addr(struct vport *vport, const unsigned char *addr)
315 {
316         ASSERT_RTNL();
317
318         if (!is_valid_ether_addr(addr))
319                 return -EADDRNOTAVAIL;
320
321         if (vport->ops->set_addr)
322                 return vport->ops->set_addr(vport, addr);
323         else
324                 return -EOPNOTSUPP;
325 }
326
327 /**
328  *      ovs_vport_set_stats - sets offset device stats
329  *
330  * @vport: vport on which to set stats
331  * @stats: stats to set
332  *
333  * Provides a set of transmit, receive, and error stats to be added as an
334  * offset to the collect data when stats are retreived.  Some devices may not
335  * support setting the stats, in which case the result will always be
336  * -EOPNOTSUPP.
337  *
338  * Must be called with RTNL lock.
339  */
340 void ovs_vport_set_stats(struct vport *vport, struct ovs_vport_stats *stats)
341 {
342         ASSERT_RTNL();
343
344         spin_lock_bh(&vport->stats_lock);
345         vport->offset_stats = *stats;
346         spin_unlock_bh(&vport->stats_lock);
347 }
348
349 /**
350  *      ovs_vport_get_stats - retrieve device stats
351  *
352  * @vport: vport from which to retrieve the stats
353  * @stats: location to store stats
354  *
355  * Retrieves transmit, receive, and error stats for the given device.
356  *
357  * Must be called with RTNL lock or rcu_read_lock.
358  */
359 void ovs_vport_get_stats(struct vport *vport, struct ovs_vport_stats *stats)
360 {
361         int i;
362
363         /* We potentially have 3 sources of stats that need to be
364          * combined: those we have collected (split into err_stats and
365          * percpu_stats), offset_stats from set_stats(), and device
366          * error stats from netdev->get_stats() (for errors that happen
367          * downstream and therefore aren't reported through our
368          * vport_record_error() function).
369          * Stats from first two sources are merged and reported by ovs over
370          * OVS_VPORT_ATTR_STATS.
371          * netdev-stats can be directly read over netlink-ioctl.
372          */
373
374         spin_lock_bh(&vport->stats_lock);
375
376         *stats = vport->offset_stats;
377
378         stats->rx_errors        += vport->err_stats.rx_errors;
379         stats->tx_errors        += vport->err_stats.tx_errors;
380         stats->tx_dropped       += vport->err_stats.tx_dropped;
381         stats->rx_dropped       += vport->err_stats.rx_dropped;
382
383         spin_unlock_bh(&vport->stats_lock);
384
385         for_each_possible_cpu(i) {
386                 const struct vport_percpu_stats *percpu_stats;
387                 struct vport_percpu_stats local_stats;
388                 unsigned int start;
389
390                 percpu_stats = per_cpu_ptr(vport->percpu_stats, i);
391
392                 do {
393                         start = u64_stats_fetch_begin_bh(&percpu_stats->sync);
394                         local_stats = *percpu_stats;
395                 } while (u64_stats_fetch_retry_bh(&percpu_stats->sync, start));
396
397                 stats->rx_bytes         += local_stats.rx_bytes;
398                 stats->rx_packets       += local_stats.rx_packets;
399                 stats->tx_bytes         += local_stats.tx_bytes;
400                 stats->tx_packets       += local_stats.tx_packets;
401         }
402 }
403
404 /**
405  *      ovs_vport_get_options - retrieve device options
406  *
407  * @vport: vport from which to retrieve the options.
408  * @skb: sk_buff where options should be appended.
409  *
410  * Retrieves the configuration of the given device, appending an
411  * %OVS_VPORT_ATTR_OPTIONS attribute that in turn contains nested
412  * vport-specific attributes to @skb.
413  *
414  * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room, or another
415  * negative error code if a real error occurred.  If an error occurs, @skb is
416  * left unmodified.
417  *
418  * Must be called with RTNL lock or rcu_read_lock.
419  */
420 int ovs_vport_get_options(const struct vport *vport, struct sk_buff *skb)
421 {
422         struct nlattr *nla;
423
424         nla = nla_nest_start(skb, OVS_VPORT_ATTR_OPTIONS);
425         if (!nla)
426                 return -EMSGSIZE;
427
428         if (vport->ops->get_options) {
429                 int err = vport->ops->get_options(vport, skb);
430                 if (err) {
431                         nla_nest_cancel(skb, nla);
432                         return err;
433                 }
434         }
435
436         nla_nest_end(skb, nla);
437         return 0;
438 }
439
440 /**
441  *      ovs_vport_receive - pass up received packet to the datapath for processing
442  *
443  * @vport: vport that received the packet
444  * @skb: skb that was received
445  *
446  * Must be called with rcu_read_lock.  The packet cannot be shared and
447  * skb->data should point to the Ethernet header.  The caller must have already
448  * called compute_ip_summed() to initialize the checksumming fields.
449  */
450 void ovs_vport_receive(struct vport *vport, struct sk_buff *skb)
451 {
452         struct vport_percpu_stats *stats;
453
454         stats = per_cpu_ptr(vport->percpu_stats, smp_processor_id());
455
456         u64_stats_update_begin(&stats->sync);
457         stats->rx_packets++;
458         stats->rx_bytes += skb->len;
459         u64_stats_update_end(&stats->sync);
460
461         if (!(vport->ops->flags & VPORT_F_FLOW))
462                 OVS_CB(skb)->flow = NULL;
463
464         if (!(vport->ops->flags & VPORT_F_TUN_ID))
465                 OVS_CB(skb)->tun_id = 0;
466
467         ovs_dp_process_received_packet(vport, skb);
468 }
469
470 /**
471  *      ovs_vport_send - send a packet on a device
472  *
473  * @vport: vport on which to send the packet
474  * @skb: skb to send
475  *
476  * Sends the given packet and returns the length of data sent.  Either RTNL
477  * lock or rcu_read_lock must be held.
478  */
479 int ovs_vport_send(struct vport *vport, struct sk_buff *skb)
480 {
481         int sent = vport->ops->send(vport, skb);
482
483         if (likely(sent)) {
484                 struct vport_percpu_stats *stats;
485
486                 stats = per_cpu_ptr(vport->percpu_stats, smp_processor_id());
487
488                 u64_stats_update_begin(&stats->sync);
489                 stats->tx_packets++;
490                 stats->tx_bytes += sent;
491                 u64_stats_update_end(&stats->sync);
492         }
493         return sent;
494 }
495
496 /**
497  *      ovs_vport_record_error - indicate device error to generic stats layer
498  *
499  * @vport: vport that encountered the error
500  * @err_type: one of enum vport_err_type types to indicate the error type
501  *
502  * If using the vport generic stats layer indicate that an error of the given
503  * type has occured.
504  */
505 void ovs_vport_record_error(struct vport *vport, enum vport_err_type err_type)
506 {
507         spin_lock(&vport->stats_lock);
508
509         switch (err_type) {
510         case VPORT_E_RX_DROPPED:
511                 vport->err_stats.rx_dropped++;
512                 break;
513
514         case VPORT_E_RX_ERROR:
515                 vport->err_stats.rx_errors++;
516                 break;
517
518         case VPORT_E_TX_DROPPED:
519                 vport->err_stats.tx_dropped++;
520                 break;
521
522         case VPORT_E_TX_ERROR:
523                 vport->err_stats.tx_errors++;
524                 break;
525         };
526
527         spin_unlock(&vport->stats_lock);
528 }