ofp-print: Remove vestigial 'total_len' argument.
[openvswitch] / lib / dpif.c
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #include <config.h>
18 #include "dpif-provider.h"
19
20 #include <assert.h>
21 #include <ctype.h>
22 #include <errno.h>
23 #include <inttypes.h>
24 #include <stdlib.h>
25 #include <string.h>
26
27 #include "coverage.h"
28 #include "dynamic-string.h"
29 #include "flow.h"
30 #include "netdev.h"
31 #include "netlink.h"
32 #include "odp-util.h"
33 #include "ofp-print.h"
34 #include "ofp-util.h"
35 #include "ofpbuf.h"
36 #include "packets.h"
37 #include "poll-loop.h"
38 #include "shash.h"
39 #include "sset.h"
40 #include "timeval.h"
41 #include "util.h"
42 #include "valgrind.h"
43 #include "vlog.h"
44
45 VLOG_DEFINE_THIS_MODULE(dpif);
46
47 COVERAGE_DEFINE(dpif_destroy);
48 COVERAGE_DEFINE(dpif_port_add);
49 COVERAGE_DEFINE(dpif_port_del);
50 COVERAGE_DEFINE(dpif_flow_flush);
51 COVERAGE_DEFINE(dpif_flow_get);
52 COVERAGE_DEFINE(dpif_flow_put);
53 COVERAGE_DEFINE(dpif_flow_del);
54 COVERAGE_DEFINE(dpif_flow_query_list);
55 COVERAGE_DEFINE(dpif_flow_query_list_n);
56 COVERAGE_DEFINE(dpif_execute);
57 COVERAGE_DEFINE(dpif_purge);
58
59 static const struct dpif_class *base_dpif_classes[] = {
60 #ifdef HAVE_NETLINK
61     &dpif_linux_class,
62 #endif
63     &dpif_netdev_class,
64 };
65
66 struct registered_dpif_class {
67     const struct dpif_class *dpif_class;
68     int refcount;
69 };
70 static struct shash dpif_classes = SHASH_INITIALIZER(&dpif_classes);
71 static struct sset dpif_blacklist = SSET_INITIALIZER(&dpif_blacklist);
72
73 /* Rate limit for individual messages going to or from the datapath, output at
74  * DBG level.  This is very high because, if these are enabled, it is because
75  * we really need to see them. */
76 static struct vlog_rate_limit dpmsg_rl = VLOG_RATE_LIMIT_INIT(600, 600);
77
78 /* Not really much point in logging many dpif errors. */
79 static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(60, 5);
80
81 static void log_flow_message(const struct dpif *dpif, int error,
82                              const char *operation,
83                              const struct nlattr *key, size_t key_len,
84                              const struct dpif_flow_stats *stats,
85                              const struct nlattr *actions, size_t actions_len);
86 static void log_operation(const struct dpif *, const char *operation,
87                           int error);
88 static bool should_log_flow_message(int error);
89
90 static void
91 dp_initialize(void)
92 {
93     static int status = -1;
94
95     if (status < 0) {
96         int i;
97
98         status = 0;
99         for (i = 0; i < ARRAY_SIZE(base_dpif_classes); i++) {
100             dp_register_provider(base_dpif_classes[i]);
101         }
102     }
103 }
104
105 /* Registers a new datapath provider.  After successful registration, new
106  * datapaths of that type can be opened using dpif_open(). */
107 int
108 dp_register_provider(const struct dpif_class *new_class)
109 {
110     struct registered_dpif_class *registered_class;
111
112     if (sset_contains(&dpif_blacklist, new_class->type)) {
113         VLOG_DBG("attempted to register blacklisted provider: %s",
114                  new_class->type);
115         return EINVAL;
116     }
117
118     if (shash_find(&dpif_classes, new_class->type)) {
119         VLOG_WARN("attempted to register duplicate datapath provider: %s",
120                   new_class->type);
121         return EEXIST;
122     }
123
124     registered_class = xmalloc(sizeof *registered_class);
125     registered_class->dpif_class = new_class;
126     registered_class->refcount = 0;
127
128     shash_add(&dpif_classes, new_class->type, registered_class);
129
130     return 0;
131 }
132
133 /* Unregisters a datapath provider.  'type' must have been previously
134  * registered and not currently be in use by any dpifs.  After unregistration
135  * new datapaths of that type cannot be opened using dpif_open(). */
136 int
137 dp_unregister_provider(const char *type)
138 {
139     struct shash_node *node;
140     struct registered_dpif_class *registered_class;
141
142     node = shash_find(&dpif_classes, type);
143     if (!node) {
144         VLOG_WARN("attempted to unregister a datapath provider that is not "
145                   "registered: %s", type);
146         return EAFNOSUPPORT;
147     }
148
149     registered_class = node->data;
150     if (registered_class->refcount) {
151         VLOG_WARN("attempted to unregister in use datapath provider: %s", type);
152         return EBUSY;
153     }
154
155     shash_delete(&dpif_classes, node);
156     free(registered_class);
157
158     return 0;
159 }
160
161 /* Blacklists a provider.  Causes future calls of dp_register_provider() with
162  * a dpif_class which implements 'type' to fail. */
163 void
164 dp_blacklist_provider(const char *type)
165 {
166     sset_add(&dpif_blacklist, type);
167 }
168
169 /* Clears 'types' and enumerates the types of all currently registered datapath
170  * providers into it.  The caller must first initialize the sset. */
171 void
172 dp_enumerate_types(struct sset *types)
173 {
174     struct shash_node *node;
175
176     dp_initialize();
177     sset_clear(types);
178
179     SHASH_FOR_EACH(node, &dpif_classes) {
180         const struct registered_dpif_class *registered_class = node->data;
181         sset_add(types, registered_class->dpif_class->type);
182     }
183 }
184
185 /* Clears 'names' and enumerates the names of all known created datapaths with
186  * the given 'type'.  The caller must first initialize the sset.  Returns 0 if
187  * successful, otherwise a positive errno value.
188  *
189  * Some kinds of datapaths might not be practically enumerable.  This is not
190  * considered an error. */
191 int
192 dp_enumerate_names(const char *type, struct sset *names)
193 {
194     const struct registered_dpif_class *registered_class;
195     const struct dpif_class *dpif_class;
196     int error;
197
198     dp_initialize();
199     sset_clear(names);
200
201     registered_class = shash_find_data(&dpif_classes, type);
202     if (!registered_class) {
203         VLOG_WARN("could not enumerate unknown type: %s", type);
204         return EAFNOSUPPORT;
205     }
206
207     dpif_class = registered_class->dpif_class;
208     error = dpif_class->enumerate ? dpif_class->enumerate(names) : 0;
209
210     if (error) {
211         VLOG_WARN("failed to enumerate %s datapaths: %s", dpif_class->type,
212                    strerror(error));
213     }
214
215     return error;
216 }
217
218 /* Parses 'datapath_name_', which is of the form [type@]name into its
219  * component pieces.  'name' and 'type' must be freed by the caller.
220  *
221  * The returned 'type' is normalized, as if by dpif_normalize_type(). */
222 void
223 dp_parse_name(const char *datapath_name_, char **name, char **type)
224 {
225     char *datapath_name = xstrdup(datapath_name_);
226     char *separator;
227
228     separator = strchr(datapath_name, '@');
229     if (separator) {
230         *separator = '\0';
231         *type = datapath_name;
232         *name = xstrdup(dpif_normalize_type(separator + 1));
233     } else {
234         *name = datapath_name;
235         *type = xstrdup(dpif_normalize_type(NULL));
236     }
237 }
238
239 static int
240 do_open(const char *name, const char *type, bool create, struct dpif **dpifp)
241 {
242     struct dpif *dpif = NULL;
243     int error;
244     struct registered_dpif_class *registered_class;
245
246     dp_initialize();
247
248     type = dpif_normalize_type(type);
249
250     registered_class = shash_find_data(&dpif_classes, type);
251     if (!registered_class) {
252         VLOG_WARN("could not create datapath %s of unknown type %s", name,
253                   type);
254         error = EAFNOSUPPORT;
255         goto exit;
256     }
257
258     error = registered_class->dpif_class->open(registered_class->dpif_class,
259                                                name, create, &dpif);
260     if (!error) {
261         assert(dpif->dpif_class == registered_class->dpif_class);
262         registered_class->refcount++;
263     }
264
265 exit:
266     *dpifp = error ? NULL : dpif;
267     return error;
268 }
269
270 /* Tries to open an existing datapath named 'name' and type 'type'.  Will fail
271  * if no datapath with 'name' and 'type' exists.  'type' may be either NULL or
272  * the empty string to specify the default system type.  Returns 0 if
273  * successful, otherwise a positive errno value.  On success stores a pointer
274  * to the datapath in '*dpifp', otherwise a null pointer. */
275 int
276 dpif_open(const char *name, const char *type, struct dpif **dpifp)
277 {
278     return do_open(name, type, false, dpifp);
279 }
280
281 /* Tries to create and open a new datapath with the given 'name' and 'type'.
282  * 'type' may be either NULL or the empty string to specify the default system
283  * type.  Will fail if a datapath with 'name' and 'type' already exists.
284  * Returns 0 if successful, otherwise a positive errno value.  On success
285  * stores a pointer to the datapath in '*dpifp', otherwise a null pointer. */
286 int
287 dpif_create(const char *name, const char *type, struct dpif **dpifp)
288 {
289     return do_open(name, type, true, dpifp);
290 }
291
292 /* Tries to open a datapath with the given 'name' and 'type', creating it if it
293  * does not exist.  'type' may be either NULL or the empty string to specify
294  * the default system type.  Returns 0 if successful, otherwise a positive
295  * errno value. On success stores a pointer to the datapath in '*dpifp',
296  * otherwise a null pointer. */
297 int
298 dpif_create_and_open(const char *name, const char *type, struct dpif **dpifp)
299 {
300     int error;
301
302     error = dpif_create(name, type, dpifp);
303     if (error == EEXIST || error == EBUSY) {
304         error = dpif_open(name, type, dpifp);
305         if (error) {
306             VLOG_WARN("datapath %s already exists but cannot be opened: %s",
307                       name, strerror(error));
308         }
309     } else if (error) {
310         VLOG_WARN("failed to create datapath %s: %s", name, strerror(error));
311     }
312     return error;
313 }
314
315 /* Closes and frees the connection to 'dpif'.  Does not destroy the datapath
316  * itself; call dpif_delete() first, instead, if that is desirable. */
317 void
318 dpif_close(struct dpif *dpif)
319 {
320     if (dpif) {
321         struct registered_dpif_class *registered_class;
322
323         registered_class = shash_find_data(&dpif_classes,
324                 dpif->dpif_class->type);
325         assert(registered_class);
326         assert(registered_class->refcount);
327
328         registered_class->refcount--;
329         dpif_uninit(dpif, true);
330     }
331 }
332
333 /* Performs periodic work needed by 'dpif'. */
334 void
335 dpif_run(struct dpif *dpif)
336 {
337     if (dpif->dpif_class->run) {
338         dpif->dpif_class->run(dpif);
339     }
340 }
341
342 /* Arranges for poll_block() to wake up when dp_run() needs to be called for
343  * 'dpif'. */
344 void
345 dpif_wait(struct dpif *dpif)
346 {
347     if (dpif->dpif_class->wait) {
348         dpif->dpif_class->wait(dpif);
349     }
350 }
351
352 /* Returns the name of datapath 'dpif' prefixed with the type
353  * (for use in log messages). */
354 const char *
355 dpif_name(const struct dpif *dpif)
356 {
357     return dpif->full_name;
358 }
359
360 /* Returns the name of datapath 'dpif' without the type
361  * (for use in device names). */
362 const char *
363 dpif_base_name(const struct dpif *dpif)
364 {
365     return dpif->base_name;
366 }
367
368 /* Returns the fully spelled out name for the given datapath 'type'.
369  *
370  * Normalized type string can be compared with strcmp().  Unnormalized type
371  * string might be the same even if they have different spellings. */
372 const char *
373 dpif_normalize_type(const char *type)
374 {
375     return type && type[0] ? type : "system";
376 }
377
378 /* Destroys the datapath that 'dpif' is connected to, first removing all of its
379  * ports.  After calling this function, it does not make sense to pass 'dpif'
380  * to any functions other than dpif_name() or dpif_close(). */
381 int
382 dpif_delete(struct dpif *dpif)
383 {
384     int error;
385
386     COVERAGE_INC(dpif_destroy);
387
388     error = dpif->dpif_class->destroy(dpif);
389     log_operation(dpif, "delete", error);
390     return error;
391 }
392
393 /* Retrieves statistics for 'dpif' into 'stats'.  Returns 0 if successful,
394  * otherwise a positive errno value. */
395 int
396 dpif_get_dp_stats(const struct dpif *dpif, struct dpif_dp_stats *stats)
397 {
398     int error = dpif->dpif_class->get_stats(dpif, stats);
399     if (error) {
400         memset(stats, 0, sizeof *stats);
401     }
402     log_operation(dpif, "get_stats", error);
403     return error;
404 }
405
406 /* Attempts to add 'netdev' as a port on 'dpif'.  If successful, returns 0 and
407  * sets '*port_nop' to the new port's port number (if 'port_nop' is non-null).
408  * On failure, returns a positive errno value and sets '*port_nop' to
409  * UINT16_MAX (if 'port_nop' is non-null). */
410 int
411 dpif_port_add(struct dpif *dpif, struct netdev *netdev, uint16_t *port_nop)
412 {
413     const char *netdev_name = netdev_get_name(netdev);
414     uint16_t port_no;
415     int error;
416
417     COVERAGE_INC(dpif_port_add);
418
419     error = dpif->dpif_class->port_add(dpif, netdev, &port_no);
420     if (!error) {
421         VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu16,
422                     dpif_name(dpif), netdev_name, port_no);
423     } else {
424         VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s",
425                      dpif_name(dpif), netdev_name, strerror(error));
426         port_no = UINT16_MAX;
427     }
428     if (port_nop) {
429         *port_nop = port_no;
430     }
431     return error;
432 }
433
434 /* Attempts to remove 'dpif''s port number 'port_no'.  Returns 0 if successful,
435  * otherwise a positive errno value. */
436 int
437 dpif_port_del(struct dpif *dpif, uint16_t port_no)
438 {
439     int error;
440
441     COVERAGE_INC(dpif_port_del);
442
443     error = dpif->dpif_class->port_del(dpif, port_no);
444     if (!error) {
445         VLOG_DBG_RL(&dpmsg_rl, "%s: port_del(%"PRIu16")",
446                     dpif_name(dpif), port_no);
447     } else {
448         log_operation(dpif, "port_del", error);
449     }
450     return error;
451 }
452
453 /* Makes a deep copy of 'src' into 'dst'. */
454 void
455 dpif_port_clone(struct dpif_port *dst, const struct dpif_port *src)
456 {
457     dst->name = xstrdup(src->name);
458     dst->type = xstrdup(src->type);
459     dst->port_no = src->port_no;
460 }
461
462 /* Frees memory allocated to members of 'dpif_port'.
463  *
464  * Do not call this function on a dpif_port obtained from
465  * dpif_port_dump_next(): that function retains ownership of the data in the
466  * dpif_port. */
467 void
468 dpif_port_destroy(struct dpif_port *dpif_port)
469 {
470     free(dpif_port->name);
471     free(dpif_port->type);
472 }
473
474 /* Looks up port number 'port_no' in 'dpif'.  On success, returns 0 and
475  * initializes '*port' appropriately; on failure, returns a positive errno
476  * value.
477  *
478  * The caller owns the data in 'port' and must free it with
479  * dpif_port_destroy() when it is no longer needed. */
480 int
481 dpif_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
482                           struct dpif_port *port)
483 {
484     int error = dpif->dpif_class->port_query_by_number(dpif, port_no, port);
485     if (!error) {
486         VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu16" is device %s",
487                     dpif_name(dpif), port_no, port->name);
488     } else {
489         memset(port, 0, sizeof *port);
490         VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu16": %s",
491                      dpif_name(dpif), port_no, strerror(error));
492     }
493     return error;
494 }
495
496 /* Looks up port named 'devname' in 'dpif'.  On success, returns 0 and
497  * initializes '*port' appropriately; on failure, returns a positive errno
498  * value.
499  *
500  * The caller owns the data in 'port' and must free it with
501  * dpif_port_destroy() when it is no longer needed. */
502 int
503 dpif_port_query_by_name(const struct dpif *dpif, const char *devname,
504                         struct dpif_port *port)
505 {
506     int error = dpif->dpif_class->port_query_by_name(dpif, devname, port);
507     if (!error) {
508         VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu16,
509                     dpif_name(dpif), devname, port->port_no);
510     } else {
511         memset(port, 0, sizeof *port);
512
513         /* For ENOENT or ENODEV we use DBG level because the caller is probably
514          * interested in whether 'dpif' actually has a port 'devname', so that
515          * it's not an issue worth logging if it doesn't.  Other errors are
516          * uncommon and more likely to indicate a real problem. */
517         VLOG_RL(&error_rl,
518                 error == ENOENT || error == ENODEV ? VLL_DBG : VLL_WARN,
519                 "%s: failed to query port %s: %s",
520                 dpif_name(dpif), devname, strerror(error));
521     }
522     return error;
523 }
524
525 /* Returns one greater than the maximum port number accepted in flow
526  * actions. */
527 int
528 dpif_get_max_ports(const struct dpif *dpif)
529 {
530     return dpif->dpif_class->get_max_ports(dpif);
531 }
532
533 /* Returns the Netlink PID value to supply in OVS_ACTION_ATTR_USERSPACE actions
534  * as the OVS_USERSPACE_ATTR_PID attribute's value, for use in flows whose
535  * packets arrived on port 'port_no'.
536  *
537  * The return value is only meaningful when DPIF_UC_ACTION has been enabled in
538  * the 'dpif''s listen mask.  It is allowed to change when DPIF_UC_ACTION is
539  * disabled and then re-enabled, so a client that does that must be prepared to
540  * update all of the flows that it installed that contain
541  * OVS_ACTION_ATTR_USERSPACE actions. */
542 uint32_t
543 dpif_port_get_pid(const struct dpif *dpif, uint16_t port_no)
544 {
545     return (dpif->dpif_class->port_get_pid
546             ? (dpif->dpif_class->port_get_pid)(dpif, port_no)
547             : 0);
548 }
549
550 /* Looks up port number 'port_no' in 'dpif'.  On success, returns 0 and copies
551  * the port's name into the 'name_size' bytes in 'name', ensuring that the
552  * result is null-terminated.  On failure, returns a positive errno value and
553  * makes 'name' the empty string. */
554 int
555 dpif_port_get_name(struct dpif *dpif, uint16_t port_no,
556                    char *name, size_t name_size)
557 {
558     struct dpif_port port;
559     int error;
560
561     assert(name_size > 0);
562
563     error = dpif_port_query_by_number(dpif, port_no, &port);
564     if (!error) {
565         ovs_strlcpy(name, port.name, name_size);
566         dpif_port_destroy(&port);
567     } else {
568         *name = '\0';
569     }
570     return error;
571 }
572
573 /* Initializes 'dump' to begin dumping the ports in a dpif.
574  *
575  * This function provides no status indication.  An error status for the entire
576  * dump operation is provided when it is completed by calling
577  * dpif_port_dump_done().
578  */
579 void
580 dpif_port_dump_start(struct dpif_port_dump *dump, const struct dpif *dpif)
581 {
582     dump->dpif = dpif;
583     dump->error = dpif->dpif_class->port_dump_start(dpif, &dump->state);
584     log_operation(dpif, "port_dump_start", dump->error);
585 }
586
587 /* Attempts to retrieve another port from 'dump', which must have been
588  * initialized with dpif_port_dump_start().  On success, stores a new dpif_port
589  * into 'port' and returns true.  On failure, returns false.
590  *
591  * Failure might indicate an actual error or merely that the last port has been
592  * dumped.  An error status for the entire dump operation is provided when it
593  * is completed by calling dpif_port_dump_done().
594  *
595  * The dpif owns the data stored in 'port'.  It will remain valid until at
596  * least the next time 'dump' is passed to dpif_port_dump_next() or
597  * dpif_port_dump_done(). */
598 bool
599 dpif_port_dump_next(struct dpif_port_dump *dump, struct dpif_port *port)
600 {
601     const struct dpif *dpif = dump->dpif;
602
603     if (dump->error) {
604         return false;
605     }
606
607     dump->error = dpif->dpif_class->port_dump_next(dpif, dump->state, port);
608     if (dump->error == EOF) {
609         VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all ports", dpif_name(dpif));
610     } else {
611         log_operation(dpif, "port_dump_next", dump->error);
612     }
613
614     if (dump->error) {
615         dpif->dpif_class->port_dump_done(dpif, dump->state);
616         return false;
617     }
618     return true;
619 }
620
621 /* Completes port table dump operation 'dump', which must have been initialized
622  * with dpif_port_dump_start().  Returns 0 if the dump operation was
623  * error-free, otherwise a positive errno value describing the problem. */
624 int
625 dpif_port_dump_done(struct dpif_port_dump *dump)
626 {
627     const struct dpif *dpif = dump->dpif;
628     if (!dump->error) {
629         dump->error = dpif->dpif_class->port_dump_done(dpif, dump->state);
630         log_operation(dpif, "port_dump_done", dump->error);
631     }
632     return dump->error == EOF ? 0 : dump->error;
633 }
634
635 /* Polls for changes in the set of ports in 'dpif'.  If the set of ports in
636  * 'dpif' has changed, this function does one of the following:
637  *
638  * - Stores the name of the device that was added to or deleted from 'dpif' in
639  *   '*devnamep' and returns 0.  The caller is responsible for freeing
640  *   '*devnamep' (with free()) when it no longer needs it.
641  *
642  * - Returns ENOBUFS and sets '*devnamep' to NULL.
643  *
644  * This function may also return 'false positives', where it returns 0 and
645  * '*devnamep' names a device that was not actually added or deleted or it
646  * returns ENOBUFS without any change.
647  *
648  * Returns EAGAIN if the set of ports in 'dpif' has not changed.  May also
649  * return other positive errno values to indicate that something has gone
650  * wrong. */
651 int
652 dpif_port_poll(const struct dpif *dpif, char **devnamep)
653 {
654     int error = dpif->dpif_class->port_poll(dpif, devnamep);
655     if (error) {
656         *devnamep = NULL;
657     }
658     return error;
659 }
660
661 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
662  * value other than EAGAIN. */
663 void
664 dpif_port_poll_wait(const struct dpif *dpif)
665 {
666     dpif->dpif_class->port_poll_wait(dpif);
667 }
668
669 /* Extracts the flow stats for a packet.  The 'flow' and 'packet'
670  * arguments must have been initialized through a call to flow_extract().
671  */
672 void
673 dpif_flow_stats_extract(const struct flow *flow, struct ofpbuf *packet,
674                         struct dpif_flow_stats *stats)
675 {
676     memset(stats, 0, sizeof(*stats));
677
678     if ((flow->dl_type == htons(ETH_TYPE_IP)) && packet->l4) {
679         if ((flow->nw_proto == IPPROTO_TCP) && packet->l7) {
680             struct tcp_header *tcp = packet->l4;
681             stats->tcp_flags = TCP_FLAGS(tcp->tcp_ctl);
682         }
683     }
684
685     stats->n_bytes = packet->size;
686     stats->n_packets = 1;
687 }
688
689 /* Appends a human-readable representation of 'stats' to 's'. */
690 void
691 dpif_flow_stats_format(const struct dpif_flow_stats *stats, struct ds *s)
692 {
693     ds_put_format(s, "packets:%"PRIu64", bytes:%"PRIu64", used:",
694                   stats->n_packets, stats->n_bytes);
695     if (stats->used) {
696         ds_put_format(s, "%.3fs", (time_msec() - stats->used) / 1000.0);
697     } else {
698         ds_put_format(s, "never");
699     }
700     /* XXX tcp_flags? */
701 }
702
703 /* Deletes all flows from 'dpif'.  Returns 0 if successful, otherwise a
704  * positive errno value.  */
705 int
706 dpif_flow_flush(struct dpif *dpif)
707 {
708     int error;
709
710     COVERAGE_INC(dpif_flow_flush);
711
712     error = dpif->dpif_class->flow_flush(dpif);
713     log_operation(dpif, "flow_flush", error);
714     return error;
715 }
716
717 /* Queries 'dpif' for a flow entry.  The flow is specified by the Netlink
718  * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
719  * 'key'.
720  *
721  * Returns 0 if successful.  If no flow matches, returns ENOENT.  On other
722  * failure, returns a positive errno value.
723  *
724  * If 'actionsp' is nonnull, then on success '*actionsp' will be set to an
725  * ofpbuf owned by the caller that contains the Netlink attributes for the
726  * flow's actions.  The caller must free the ofpbuf (with ofpbuf_delete()) when
727  * it is no longer needed.
728  *
729  * If 'stats' is nonnull, then on success it will be updated with the flow's
730  * statistics. */
731 int
732 dpif_flow_get(const struct dpif *dpif,
733               const struct nlattr *key, size_t key_len,
734               struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
735 {
736     int error;
737
738     COVERAGE_INC(dpif_flow_get);
739
740     error = dpif->dpif_class->flow_get(dpif, key, key_len, actionsp, stats);
741     if (error) {
742         if (actionsp) {
743             *actionsp = NULL;
744         }
745         if (stats) {
746             memset(stats, 0, sizeof *stats);
747         }
748     }
749     if (should_log_flow_message(error)) {
750         const struct nlattr *actions;
751         size_t actions_len;
752
753         if (!error && actionsp) {
754             actions = (*actionsp)->data;
755             actions_len = (*actionsp)->size;
756         } else {
757             actions = NULL;
758             actions_len = 0;
759         }
760         log_flow_message(dpif, error, "flow_get", key, key_len, stats,
761                          actions, actions_len);
762     }
763     return error;
764 }
765
766 /* Adds or modifies a flow in 'dpif'.  The flow is specified by the Netlink
767  * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
768  * 'key'.  The associated actions are specified by the Netlink attributes with
769  * types OVS_ACTION_ATTR_* in the 'actions_len' bytes starting at 'actions'.
770  *
771  * - If the flow's key does not exist in 'dpif', then the flow will be added if
772  *   'flags' includes DPIF_FP_CREATE.  Otherwise the operation will fail with
773  *   ENOENT.
774  *
775  *   If the operation succeeds, then 'stats', if nonnull, will be zeroed.
776  *
777  * - If the flow's key does exist in 'dpif', then the flow's actions will be
778  *   updated if 'flags' includes DPIF_FP_MODIFY.  Otherwise the operation will
779  *   fail with EEXIST.  If the flow's actions are updated, then its statistics
780  *   will be zeroed if 'flags' includes DPIF_FP_ZERO_STATS, and left as-is
781  *   otherwise.
782  *
783  *   If the operation succeeds, then 'stats', if nonnull, will be set to the
784  *   flow's statistics before the update.
785  */
786 int
787 dpif_flow_put(struct dpif *dpif, enum dpif_flow_put_flags flags,
788               const struct nlattr *key, size_t key_len,
789               const struct nlattr *actions, size_t actions_len,
790               struct dpif_flow_stats *stats)
791 {
792     int error;
793
794     COVERAGE_INC(dpif_flow_put);
795     assert(!(flags & ~(DPIF_FP_CREATE | DPIF_FP_MODIFY | DPIF_FP_ZERO_STATS)));
796
797     error = dpif->dpif_class->flow_put(dpif, flags, key, key_len,
798                                        actions, actions_len, stats);
799     if (error && stats) {
800         memset(stats, 0, sizeof *stats);
801     }
802     if (should_log_flow_message(error)) {
803         struct ds s;
804
805         ds_init(&s);
806         ds_put_cstr(&s, "put");
807         if (flags & DPIF_FP_CREATE) {
808             ds_put_cstr(&s, "[create]");
809         }
810         if (flags & DPIF_FP_MODIFY) {
811             ds_put_cstr(&s, "[modify]");
812         }
813         if (flags & DPIF_FP_ZERO_STATS) {
814             ds_put_cstr(&s, "[zero]");
815         }
816         log_flow_message(dpif, error, ds_cstr(&s), key, key_len, stats,
817                          actions, actions_len);
818         ds_destroy(&s);
819     }
820     return error;
821 }
822
823 /* Deletes a flow from 'dpif' and returns 0, or returns ENOENT if 'dpif' does
824  * not contain such a flow.  The flow is specified by the Netlink attributes
825  * with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at 'key'.
826  *
827  * If the operation succeeds, then 'stats', if nonnull, will be set to the
828  * flow's statistics before its deletion. */
829 int
830 dpif_flow_del(struct dpif *dpif,
831               const struct nlattr *key, size_t key_len,
832               struct dpif_flow_stats *stats)
833 {
834     int error;
835
836     COVERAGE_INC(dpif_flow_del);
837
838     error = dpif->dpif_class->flow_del(dpif, key, key_len, stats);
839     if (error && stats) {
840         memset(stats, 0, sizeof *stats);
841     }
842     if (should_log_flow_message(error)) {
843         log_flow_message(dpif, error, "flow_del", key, key_len,
844                          !error ? stats : NULL, NULL, 0);
845     }
846     return error;
847 }
848
849 /* Initializes 'dump' to begin dumping the flows in a dpif.
850  *
851  * This function provides no status indication.  An error status for the entire
852  * dump operation is provided when it is completed by calling
853  * dpif_flow_dump_done().
854  */
855 void
856 dpif_flow_dump_start(struct dpif_flow_dump *dump, const struct dpif *dpif)
857 {
858     dump->dpif = dpif;
859     dump->error = dpif->dpif_class->flow_dump_start(dpif, &dump->state);
860     log_operation(dpif, "flow_dump_start", dump->error);
861 }
862
863 /* Attempts to retrieve another flow from 'dump', which must have been
864  * initialized with dpif_flow_dump_start().  On success, updates the output
865  * parameters as described below and returns true.  Otherwise, returns false.
866  * Failure might indicate an actual error or merely the end of the flow table.
867  * An error status for the entire dump operation is provided when it is
868  * completed by calling dpif_flow_dump_done().
869  *
870  * On success, if 'key' and 'key_len' are nonnull then '*key' and '*key_len'
871  * will be set to Netlink attributes with types OVS_KEY_ATTR_* representing the
872  * dumped flow's key.  If 'actions' and 'actions_len' are nonnull then they are
873  * set to Netlink attributes with types OVS_ACTION_ATTR_* representing the
874  * dumped flow's actions.  If 'stats' is nonnull then it will be set to the
875  * dumped flow's statistics.
876  *
877  * All of the returned data is owned by 'dpif', not by the caller, and the
878  * caller must not modify or free it.  'dpif' guarantees that it remains
879  * accessible and unchanging until at least the next call to 'flow_dump_next'
880  * or 'flow_dump_done' for 'dump'. */
881 bool
882 dpif_flow_dump_next(struct dpif_flow_dump *dump,
883                     const struct nlattr **key, size_t *key_len,
884                     const struct nlattr **actions, size_t *actions_len,
885                     const struct dpif_flow_stats **stats)
886 {
887     const struct dpif *dpif = dump->dpif;
888     int error = dump->error;
889
890     if (!error) {
891         error = dpif->dpif_class->flow_dump_next(dpif, dump->state,
892                                                  key, key_len,
893                                                  actions, actions_len,
894                                                  stats);
895         if (error) {
896             dpif->dpif_class->flow_dump_done(dpif, dump->state);
897         }
898     }
899     if (error) {
900         if (key) {
901             *key = NULL;
902             *key_len = 0;
903         }
904         if (actions) {
905             *actions = NULL;
906             *actions_len = 0;
907         }
908         if (stats) {
909             *stats = NULL;
910         }
911     }
912     if (!dump->error) {
913         if (error == EOF) {
914             VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all flows", dpif_name(dpif));
915         } else if (should_log_flow_message(error)) {
916             log_flow_message(dpif, error, "flow_dump",
917                              key ? *key : NULL, key ? *key_len : 0,
918                              stats ? *stats : NULL, actions ? *actions : NULL,
919                              actions ? *actions_len : 0);
920         }
921     }
922     dump->error = error;
923     return !error;
924 }
925
926 /* Completes flow table dump operation 'dump', which must have been initialized
927  * with dpif_flow_dump_start().  Returns 0 if the dump operation was
928  * error-free, otherwise a positive errno value describing the problem. */
929 int
930 dpif_flow_dump_done(struct dpif_flow_dump *dump)
931 {
932     const struct dpif *dpif = dump->dpif;
933     if (!dump->error) {
934         dump->error = dpif->dpif_class->flow_dump_done(dpif, dump->state);
935         log_operation(dpif, "flow_dump_done", dump->error);
936     }
937     return dump->error == EOF ? 0 : dump->error;
938 }
939
940 /* Causes 'dpif' to perform the 'actions_len' bytes of actions in 'actions' on
941  * the Ethernet frame specified in 'packet' taken from the flow specified in
942  * the 'key_len' bytes of 'key'.  ('key' is mostly redundant with 'packet', but
943  * it contains some metadata that cannot be recovered from 'packet', such as
944  * tun_id and in_port.)
945  *
946  * Returns 0 if successful, otherwise a positive errno value. */
947 int
948 dpif_execute(struct dpif *dpif,
949              const struct nlattr *key, size_t key_len,
950              const struct nlattr *actions, size_t actions_len,
951              const struct ofpbuf *buf)
952 {
953     int error;
954
955     COVERAGE_INC(dpif_execute);
956     if (actions_len > 0) {
957         error = dpif->dpif_class->execute(dpif, key, key_len,
958                                           actions, actions_len, buf);
959     } else {
960         error = 0;
961     }
962
963     if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) {
964         struct ds ds = DS_EMPTY_INITIALIZER;
965         char *packet = ofp_packet_to_string(buf->data, buf->size);
966         ds_put_format(&ds, "%s: execute ", dpif_name(dpif));
967         format_odp_actions(&ds, actions, actions_len);
968         if (error) {
969             ds_put_format(&ds, " failed (%s)", strerror(error));
970         }
971         ds_put_format(&ds, " on packet %s", packet);
972         vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds));
973         ds_destroy(&ds);
974         free(packet);
975     }
976     return error;
977 }
978
979 /* Executes each of the 'n_ops' operations in 'ops' on 'dpif', in the order in
980  * which they are specified, placing each operation's results in the "output"
981  * members documented in comments.
982  *
983  * This function exists because some datapaths can perform batched operations
984  * faster than individual operations. */
985 void
986 dpif_operate(struct dpif *dpif, union dpif_op **ops, size_t n_ops)
987 {
988     size_t i;
989
990     if (dpif->dpif_class->operate) {
991         dpif->dpif_class->operate(dpif, ops, n_ops);
992         return;
993     }
994
995     for (i = 0; i < n_ops; i++) {
996         union dpif_op *op = ops[i];
997         struct dpif_flow_put *put;
998         struct dpif_execute *execute;
999
1000         switch (op->type) {
1001         case DPIF_OP_FLOW_PUT:
1002             put = &op->flow_put;
1003             put->error = dpif_flow_put(dpif, put->flags,
1004                                        put->key, put->key_len,
1005                                        put->actions, put->actions_len,
1006                                        put->stats);
1007             break;
1008
1009         case DPIF_OP_EXECUTE:
1010             execute = &op->execute;
1011             execute->error = dpif_execute(dpif, execute->key, execute->key_len,
1012                                           execute->actions,
1013                                           execute->actions_len,
1014                                           execute->packet);
1015             break;
1016
1017         default:
1018             NOT_REACHED();
1019         }
1020     }
1021 }
1022
1023
1024 /* Returns a string that represents 'type', for use in log messages. */
1025 const char *
1026 dpif_upcall_type_to_string(enum dpif_upcall_type type)
1027 {
1028     switch (type) {
1029     case DPIF_UC_MISS: return "miss";
1030     case DPIF_UC_ACTION: return "action";
1031     case DPIF_N_UC_TYPES: default: return "<unknown>";
1032     }
1033 }
1034
1035 static bool OVS_UNUSED
1036 is_valid_listen_mask(int listen_mask)
1037 {
1038     return !(listen_mask & ~((1u << DPIF_UC_MISS) |
1039                              (1u << DPIF_UC_ACTION)));
1040 }
1041
1042 /* Retrieves 'dpif''s "listen mask" into '*listen_mask'.  A 1-bit of value 2**X
1043  * set in '*listen_mask' indicates that dpif_recv() will receive messages of
1044  * the type (from "enum dpif_upcall_type") with value X.  Returns 0 if
1045  * successful, otherwise a positive errno value. */
1046 int
1047 dpif_recv_get_mask(const struct dpif *dpif, int *listen_mask)
1048 {
1049     int error = dpif->dpif_class->recv_get_mask(dpif, listen_mask);
1050     if (error) {
1051         *listen_mask = 0;
1052     }
1053     assert(is_valid_listen_mask(*listen_mask));
1054     log_operation(dpif, "recv_get_mask", error);
1055     return error;
1056 }
1057
1058 /* Sets 'dpif''s "listen mask" to 'listen_mask'.  A 1-bit of value 2**X set in
1059  * '*listen_mask' requests that dpif_recv() will receive messages of the type
1060  * (from "enum dpif_upcall_type") with value X.  Returns 0 if successful,
1061  * otherwise a positive errno value.
1062  *
1063  * Turning DPIF_UC_ACTION off and then back on may change the Netlink PID
1064  * assignments returned by dpif_port_get_pid().  If the client does this, it
1065  * must update all of the flows that have OVS_ACTION_ATTR_USERSPACE actions
1066  * using the new PID assignment. */
1067 int
1068 dpif_recv_set_mask(struct dpif *dpif, int listen_mask)
1069 {
1070     int error;
1071
1072     assert(is_valid_listen_mask(listen_mask));
1073
1074     error = dpif->dpif_class->recv_set_mask(dpif, listen_mask);
1075     log_operation(dpif, "recv_set_mask", error);
1076     return error;
1077 }
1078
1079 /* Polls for an upcall from 'dpif'.  If successful, stores the upcall into
1080  * '*upcall'.  Only upcalls of the types selected with dpif_recv_set_mask()
1081  * member function will ordinarily be received (but if a message type is
1082  * enabled and then later disabled, some stragglers might pop up).
1083  *
1084  * The caller takes ownership of the data that 'upcall' points to.
1085  * 'upcall->key' and 'upcall->actions' (if nonnull) point into data owned by
1086  * 'upcall->packet', so their memory cannot be freed separately.  (This is
1087  * hardly a great way to do things but it works out OK for the dpif providers
1088  * and clients that exist so far.)
1089  *
1090  * Returns 0 if successful, otherwise a positive errno value.  Returns EAGAIN
1091  * if no upcall is immediately available. */
1092 int
1093 dpif_recv(struct dpif *dpif, struct dpif_upcall *upcall)
1094 {
1095     int error = dpif->dpif_class->recv(dpif, upcall);
1096     if (!error && !VLOG_DROP_DBG(&dpmsg_rl)) {
1097         struct ds flow;
1098         char *packet;
1099
1100         packet = ofp_packet_to_string(upcall->packet->data,
1101                                       upcall->packet->size);
1102
1103         ds_init(&flow);
1104         odp_flow_key_format(upcall->key, upcall->key_len, &flow);
1105
1106         VLOG_DBG("%s: %s upcall:\n%s\n%s",
1107                  dpif_name(dpif), dpif_upcall_type_to_string(upcall->type),
1108                  ds_cstr(&flow), packet);
1109
1110         ds_destroy(&flow);
1111         free(packet);
1112     } else if (error && error != EAGAIN) {
1113         log_operation(dpif, "recv", error);
1114     }
1115     return error;
1116 }
1117
1118 /* Discards all messages that would otherwise be received by dpif_recv() on
1119  * 'dpif'. */
1120 void
1121 dpif_recv_purge(struct dpif *dpif)
1122 {
1123     COVERAGE_INC(dpif_purge);
1124     if (dpif->dpif_class->recv_purge) {
1125         dpif->dpif_class->recv_purge(dpif);
1126     }
1127 }
1128
1129 /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be
1130  * received with dpif_recv(). */
1131 void
1132 dpif_recv_wait(struct dpif *dpif)
1133 {
1134     dpif->dpif_class->recv_wait(dpif);
1135 }
1136
1137 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
1138  * and '*engine_id', respectively. */
1139 void
1140 dpif_get_netflow_ids(const struct dpif *dpif,
1141                      uint8_t *engine_type, uint8_t *engine_id)
1142 {
1143     *engine_type = dpif->netflow_engine_type;
1144     *engine_id = dpif->netflow_engine_id;
1145 }
1146
1147 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority
1148  * value used for setting packet priority.
1149  * On success, returns 0 and stores the priority into '*priority'.
1150  * On failure, returns a positive errno value and stores 0 into '*priority'. */
1151 int
1152 dpif_queue_to_priority(const struct dpif *dpif, uint32_t queue_id,
1153                        uint32_t *priority)
1154 {
1155     int error = (dpif->dpif_class->queue_to_priority
1156                  ? dpif->dpif_class->queue_to_priority(dpif, queue_id,
1157                                                        priority)
1158                  : EOPNOTSUPP);
1159     if (error) {
1160         *priority = 0;
1161     }
1162     log_operation(dpif, "queue_to_priority", error);
1163     return error;
1164 }
1165 \f
1166 void
1167 dpif_init(struct dpif *dpif, const struct dpif_class *dpif_class,
1168           const char *name,
1169           uint8_t netflow_engine_type, uint8_t netflow_engine_id)
1170 {
1171     dpif->dpif_class = dpif_class;
1172     dpif->base_name = xstrdup(name);
1173     dpif->full_name = xasprintf("%s@%s", dpif_class->type, name);
1174     dpif->netflow_engine_type = netflow_engine_type;
1175     dpif->netflow_engine_id = netflow_engine_id;
1176 }
1177
1178 /* Undoes the results of initialization.
1179  *
1180  * Normally this function only needs to be called from dpif_close().
1181  * However, it may be called by providers due to an error on opening
1182  * that occurs after initialization.  It this case dpif_close() would
1183  * never be called. */
1184 void
1185 dpif_uninit(struct dpif *dpif, bool close)
1186 {
1187     char *base_name = dpif->base_name;
1188     char *full_name = dpif->full_name;
1189
1190     if (close) {
1191         dpif->dpif_class->close(dpif);
1192     }
1193
1194     free(base_name);
1195     free(full_name);
1196 }
1197 \f
1198 static void
1199 log_operation(const struct dpif *dpif, const char *operation, int error)
1200 {
1201     if (!error) {
1202         VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation);
1203     } else if (is_errno(error)) {
1204         VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1205                      dpif_name(dpif), operation, strerror(error));
1206     } else {
1207         VLOG_WARN_RL(&error_rl, "%s: %s failed (%d/%d)",
1208                      dpif_name(dpif), operation,
1209                      get_ofp_err_type(error), get_ofp_err_code(error));
1210     }
1211 }
1212
1213 static enum vlog_level
1214 flow_message_log_level(int error)
1215 {
1216     return error ? VLL_WARN : VLL_DBG;
1217 }
1218
1219 static bool
1220 should_log_flow_message(int error)
1221 {
1222     return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error),
1223                              error ? &error_rl : &dpmsg_rl);
1224 }
1225
1226 static void
1227 log_flow_message(const struct dpif *dpif, int error, const char *operation,
1228                  const struct nlattr *key, size_t key_len,
1229                  const struct dpif_flow_stats *stats,
1230                  const struct nlattr *actions, size_t actions_len)
1231 {
1232     struct ds ds = DS_EMPTY_INITIALIZER;
1233     ds_put_format(&ds, "%s: ", dpif_name(dpif));
1234     if (error) {
1235         ds_put_cstr(&ds, "failed to ");
1236     }
1237     ds_put_format(&ds, "%s ", operation);
1238     if (error) {
1239         ds_put_format(&ds, "(%s) ", strerror(error));
1240     }
1241     odp_flow_key_format(key, key_len, &ds);
1242     if (stats) {
1243         ds_put_cstr(&ds, ", ");
1244         dpif_flow_stats_format(stats, &ds);
1245     }
1246     if (actions || actions_len) {
1247         ds_put_cstr(&ds, ", actions:");
1248         format_odp_actions(&ds, actions, actions_len);
1249     }
1250     vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds));
1251     ds_destroy(&ds);
1252 }