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