datapath: Drop queue information from odp_stats.
[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 "svec.h"
40 #include "util.h"
41 #include "valgrind.h"
42 #include "vlog.h"
43
44 VLOG_DEFINE_THIS_MODULE(dpif);
45
46 COVERAGE_DEFINE(dpif_destroy);
47 COVERAGE_DEFINE(dpif_port_add);
48 COVERAGE_DEFINE(dpif_port_del);
49 COVERAGE_DEFINE(dpif_flow_flush);
50 COVERAGE_DEFINE(dpif_flow_get);
51 COVERAGE_DEFINE(dpif_flow_put);
52 COVERAGE_DEFINE(dpif_flow_del);
53 COVERAGE_DEFINE(dpif_flow_query_list);
54 COVERAGE_DEFINE(dpif_flow_query_list_n);
55 COVERAGE_DEFINE(dpif_execute);
56 COVERAGE_DEFINE(dpif_purge);
57
58 static const struct dpif_class *base_dpif_classes[] = {
59 #ifdef HAVE_NETLINK
60     &dpif_linux_class,
61 #endif
62     &dpif_netdev_class,
63 };
64
65 struct registered_dpif_class {
66     const struct dpif_class *dpif_class;
67     int refcount;
68 };
69 static struct shash dpif_classes = SHASH_INITIALIZER(&dpif_classes);
70
71 /* Rate limit for individual messages going to or from the datapath, output at
72  * DBG level.  This is very high because, if these are enabled, it is because
73  * we really need to see them. */
74 static struct vlog_rate_limit dpmsg_rl = VLOG_RATE_LIMIT_INIT(600, 600);
75
76 /* Not really much point in logging many dpif errors. */
77 static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(60, 5);
78
79 static void log_operation(const struct dpif *, const char *operation,
80                           int error);
81 static void log_flow_operation(const struct dpif *, const char *operation,
82                                int error, struct odp_flow *flow);
83 static void log_flow_put(struct dpif *, int error,
84                          const struct odp_flow_put *);
85 static bool should_log_flow_message(int error);
86 static void check_rw_flow_actions(struct odp_flow *);
87 static void check_rw_flow_key(struct odp_flow *);
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 /* Looks up port number 'port_no' in 'dpif'.  On success, returns 0 and copies
565  * the port's name into the 'name_size' bytes in 'name', ensuring that the
566  * result is null-terminated.  On failure, returns a positive errno value and
567  * makes 'name' the empty string. */
568 int
569 dpif_port_get_name(struct dpif *dpif, uint16_t port_no,
570                    char *name, size_t name_size)
571 {
572     struct dpif_port port;
573     int error;
574
575     assert(name_size > 0);
576
577     error = dpif_port_query_by_number(dpif, port_no, &port);
578     if (!error) {
579         ovs_strlcpy(name, port.name, name_size);
580         dpif_port_destroy(&port);
581     } else {
582         *name = '\0';
583     }
584     return error;
585 }
586
587 /* Initializes 'dump' to begin dumping the ports in a dpif.
588  *
589  * This function provides no status indication.  An error status for the entire
590  * dump operation is provided when it is completed by calling
591  * dpif_port_dump_done().
592  */
593 void
594 dpif_port_dump_start(struct dpif_port_dump *dump, const struct dpif *dpif)
595 {
596     dump->dpif = dpif;
597     dump->error = dpif->dpif_class->port_dump_start(dpif, &dump->state);
598     log_operation(dpif, "port_dump_start", dump->error);
599 }
600
601 /* Attempts to retrieve another port from 'dump', which must have been
602  * initialized with dpif_port_dump_start().  On success, stores a new dpif_port
603  * into 'port' and returns true.  On failure, returns false.
604  *
605  * Failure might indicate an actual error or merely that the last port has been
606  * dumped.  An error status for the entire dump operation is provided when it
607  * is completed by calling dpif_port_dump_done().
608  *
609  * The dpif owns the data stored in 'port'.  It will remain valid until at
610  * least the next time 'dump' is passed to dpif_port_dump_next() or
611  * dpif_port_dump_done(). */
612 bool
613 dpif_port_dump_next(struct dpif_port_dump *dump, struct dpif_port *port)
614 {
615     const struct dpif *dpif = dump->dpif;
616
617     if (dump->error) {
618         return false;
619     }
620
621     dump->error = dpif->dpif_class->port_dump_next(dpif, dump->state, port);
622     if (dump->error == EOF) {
623         VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all ports", dpif_name(dpif));
624     } else {
625         log_operation(dpif, "port_dump_next", dump->error);
626     }
627
628     if (dump->error) {
629         dpif->dpif_class->port_dump_done(dpif, dump->state);
630         return false;
631     }
632     return true;
633 }
634
635 /* Completes port table dump operation 'dump', which must have been initialized
636  * with dpif_port_dump_start().  Returns 0 if the dump operation was
637  * error-free, otherwise a positive errno value describing the problem. */
638 int
639 dpif_port_dump_done(struct dpif_port_dump *dump)
640 {
641     const struct dpif *dpif = dump->dpif;
642     if (!dump->error) {
643         dump->error = dpif->dpif_class->port_dump_done(dpif, dump->state);
644         log_operation(dpif, "port_dump_done", dump->error);
645     }
646     return dump->error == EOF ? 0 : dump->error;
647 }
648
649 /* Polls for changes in the set of ports in 'dpif'.  If the set of ports in
650  * 'dpif' has changed, this function does one of the following:
651  *
652  * - Stores the name of the device that was added to or deleted from 'dpif' in
653  *   '*devnamep' and returns 0.  The caller is responsible for freeing
654  *   '*devnamep' (with free()) when it no longer needs it.
655  *
656  * - Returns ENOBUFS and sets '*devnamep' to NULL.
657  *
658  * This function may also return 'false positives', where it returns 0 and
659  * '*devnamep' names a device that was not actually added or deleted or it
660  * returns ENOBUFS without any change.
661  *
662  * Returns EAGAIN if the set of ports in 'dpif' has not changed.  May also
663  * return other positive errno values to indicate that something has gone
664  * wrong. */
665 int
666 dpif_port_poll(const struct dpif *dpif, char **devnamep)
667 {
668     int error = dpif->dpif_class->port_poll(dpif, devnamep);
669     if (error) {
670         *devnamep = NULL;
671     }
672     return error;
673 }
674
675 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
676  * value other than EAGAIN. */
677 void
678 dpif_port_poll_wait(const struct dpif *dpif)
679 {
680     dpif->dpif_class->port_poll_wait(dpif);
681 }
682
683 /* Deletes all flows from 'dpif'.  Returns 0 if successful, otherwise a
684  * positive errno value.  */
685 int
686 dpif_flow_flush(struct dpif *dpif)
687 {
688     int error;
689
690     COVERAGE_INC(dpif_flow_flush);
691
692     error = dpif->dpif_class->flow_flush(dpif);
693     log_operation(dpif, "flow_flush", error);
694     return error;
695 }
696
697 /* Queries 'dpif' for a flow entry matching 'flow->key'.
698  *
699  * If a flow matching 'flow->key' exists in 'dpif', stores statistics for the
700  * flow into 'flow->stats'.  If 'flow->actions_len' is zero, then
701  * 'flow->actions' is ignored.  If 'flow->actions_len' is nonzero, then
702  * 'flow->actions' should point to an array of the specified number of bytes.
703  * At most that many bytes of the flow's actions will be copied into that
704  * array.  'flow->actions_len' will be updated to the number of bytes of
705  * actions actually present in the flow, which may be greater than the amount
706  * stored if the flow has more actions than space available in the array.
707  *
708  * If no flow matching 'flow->key' exists in 'dpif', returns ENOENT.  On other
709  * failure, returns a positive errno value. */
710 int
711 dpif_flow_get(const struct dpif *dpif, struct odp_flow *flow)
712 {
713     int error;
714
715     COVERAGE_INC(dpif_flow_get);
716
717     check_rw_flow_actions(flow);
718     error = dpif->dpif_class->flow_get(dpif, flow, 1);
719     if (!error) {
720         error = flow->stats.error;
721     }
722     if (error) {
723         /* Make the results predictable on error. */
724         memset(&flow->stats, 0, sizeof flow->stats);
725         flow->actions_len = 0;
726     }
727     if (should_log_flow_message(error)) {
728         log_flow_operation(dpif, "flow_get", error, flow);
729     }
730     return error;
731 }
732
733 /* For each flow 'flow' in the 'n' flows in 'flows':
734  *
735  * - If a flow matching 'flow->key' exists in 'dpif':
736  *
737  *     Stores 0 into 'flow->stats.error' and stores statistics for the flow
738  *     into 'flow->stats'.
739  *
740  *     If 'flow->actions_len' is zero, then 'flow->actions' is ignored.  If
741  *     'flow->actions_len' is nonzero, then 'flow->actions' should point to an
742  *     array of the specified number of bytes.  At most that amount of flow's
743  *     actions will be copied into that array.  'flow->actions_len' will be
744  *     updated to the number of bytes of actions actually present in the flow,
745  *     which may be greater than the amount stored if the flow's actions are
746  *     longer than the available space.
747  *
748  * - Flow-specific errors are indicated by a positive errno value in
749  *   'flow->stats.error'.  In particular, ENOENT indicates that no flow
750  *   matching 'flow->key' exists in 'dpif'.  When an error value is stored, the
751  *   contents of 'flow->key' are preserved but other members of 'flow' should
752  *   be treated as indeterminate.
753  *
754  * Returns 0 if all 'n' flows in 'flows' were updated (whether they were
755  * individually successful or not is indicated by 'flow->stats.error',
756  * however).  Returns a positive errno value if an error that prevented this
757  * update occurred, in which the caller must not depend on any elements in
758  * 'flows' being updated or not updated.
759  */
760 int
761 dpif_flow_get_multiple(const struct dpif *dpif,
762                        struct odp_flow flows[], size_t n)
763 {
764     int error;
765     size_t i;
766
767     COVERAGE_ADD(dpif_flow_get, n);
768
769     for (i = 0; i < n; i++) {
770         check_rw_flow_actions(&flows[i]);
771     }
772
773     error = dpif->dpif_class->flow_get(dpif, flows, n);
774     log_operation(dpif, "flow_get_multiple", error);
775     return error;
776 }
777
778 /* Adds or modifies a flow in 'dpif' as specified in 'put':
779  *
780  * - If the flow specified in 'put->flow' does not exist in 'dpif', then
781  *   behavior depends on whether ODPPF_CREATE is specified in 'put->flags': if
782  *   it is, the flow will be added, otherwise the operation will fail with
783  *   ENOENT.
784  *
785  * - Otherwise, the flow specified in 'put->flow' does exist in 'dpif'.
786  *   Behavior in this case depends on whether ODPPF_MODIFY is specified in
787  *   'put->flags': if it is, the flow's actions will be updated, otherwise the
788  *   operation will fail with EEXIST.  If the flow's actions are updated, then
789  *   its statistics will be zeroed if ODPPF_ZERO_STATS is set in 'put->flags',
790  *   left as-is otherwise.
791  *
792  * Returns 0 if successful, otherwise a positive errno value.
793  */
794 int
795 dpif_flow_put(struct dpif *dpif, struct odp_flow_put *put)
796 {
797     int error;
798
799     COVERAGE_INC(dpif_flow_put);
800
801     error = dpif->dpif_class->flow_put(dpif, put);
802     if (should_log_flow_message(error)) {
803         log_flow_put(dpif, error, put);
804     }
805     return error;
806 }
807
808 /* Deletes a flow matching 'flow->key' from 'dpif' or returns ENOENT if 'dpif'
809  * does not contain such a flow.
810  *
811  * If successful, updates 'flow->stats', 'flow->actions_len', and
812  * 'flow->actions' as described for dpif_flow_get(). */
813 int
814 dpif_flow_del(struct dpif *dpif, struct odp_flow *flow)
815 {
816     int error;
817
818     COVERAGE_INC(dpif_flow_del);
819
820     check_rw_flow_actions(flow);
821     memset(&flow->stats, 0, sizeof flow->stats);
822
823     error = dpif->dpif_class->flow_del(dpif, flow);
824     if (should_log_flow_message(error)) {
825         log_flow_operation(dpif, "delete flow", error, flow);
826     }
827     return error;
828 }
829
830 /* Initializes 'dump' to begin dumping the flows in a dpif.
831  *
832  * This function provides no status indication.  An error status for the entire
833  * dump operation is provided when it is completed by calling
834  * dpif_flow_dump_done().
835  */
836 void
837 dpif_flow_dump_start(struct dpif_flow_dump *dump, const struct dpif *dpif)
838 {
839     dump->dpif = dpif;
840     dump->error = dpif->dpif_class->flow_dump_start(dpif, &dump->state);
841     log_operation(dpif, "flow_dump_start", dump->error);
842 }
843
844 /* Attempts to retrieve another flow from 'dump', which must have been
845  * initialized with dpif_flow_dump_start().  On success, stores a new odp_flow
846  * into 'flow' and returns true.  Failure might indicate an actual error or
847  * merely the end of the flow table.  An error status for the entire dump
848  * operation is provided when it is completed by calling dpif_flow_dump_done().
849  *
850  * Dumping flow actions is optional.  To avoid dumping actions initialize
851  * 'flow->actions' to NULL and 'flow->actions_len' to 0.  Otherwise, point
852  * 'flow->actions' to an array of struct nlattr and initialize
853  * 'flow->actions_len' with the number of bytes of Netlink attributes.
854  * dpif_flow_dump_next() will fill in as many actions as will fit into the
855  * provided array and update 'flow->actions_len' with the number of bytes
856  * required (regardless of whether they fit in the provided space). */
857 bool
858 dpif_flow_dump_next(struct dpif_flow_dump *dump, struct odp_flow *flow)
859 {
860     const struct dpif *dpif = dump->dpif;
861
862     check_rw_flow_actions(flow);
863     check_rw_flow_key(flow);
864
865     if (dump->error) {
866         return false;
867     }
868
869     dump->error = dpif->dpif_class->flow_dump_next(dpif, dump->state, flow);
870     if (dump->error == EOF) {
871         VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all flows", dpif_name(dpif));
872     } else {
873         if (dump->error) {
874             flow->key_len = 0;
875         }
876         if (should_log_flow_message(dump->error)) {
877             log_flow_operation(dpif, "flow_dump_next", dump->error, flow);
878         }
879     }
880
881     if (dump->error) {
882         dpif->dpif_class->flow_dump_done(dpif, dump->state);
883         return false;
884     }
885     return true;
886 }
887
888 /* Completes flow table dump operation 'dump', which must have been initialized
889  * with dpif_flow_dump_start().  Returns 0 if the dump operation was
890  * error-free, otherwise a positive errno value describing the problem. */
891 int
892 dpif_flow_dump_done(struct dpif_flow_dump *dump)
893 {
894     const struct dpif *dpif = dump->dpif;
895     if (!dump->error) {
896         dump->error = dpif->dpif_class->flow_dump_done(dpif, dump->state);
897         log_operation(dpif, "flow_dump_done", dump->error);
898     }
899     return dump->error == EOF ? 0 : dump->error;
900 }
901
902 /* Causes 'dpif' to perform the 'actions_len' bytes of actions in 'actions' on
903  * the Ethernet frame specified in 'packet'.
904  *
905  * Returns 0 if successful, otherwise a positive errno value. */
906 int
907 dpif_execute(struct dpif *dpif,
908              const struct nlattr *actions, size_t actions_len,
909              const struct ofpbuf *buf)
910 {
911     int error;
912
913     COVERAGE_INC(dpif_execute);
914     if (actions_len > 0) {
915         error = dpif->dpif_class->execute(dpif, actions, actions_len, buf);
916     } else {
917         error = 0;
918     }
919
920     if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) {
921         struct ds ds = DS_EMPTY_INITIALIZER;
922         char *packet = ofp_packet_to_string(buf->data, buf->size, buf->size);
923         ds_put_format(&ds, "%s: execute ", dpif_name(dpif));
924         format_odp_actions(&ds, actions, actions_len);
925         if (error) {
926             ds_put_format(&ds, " failed (%s)", strerror(error));
927         }
928         ds_put_format(&ds, " on packet %s", packet);
929         vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds));
930         ds_destroy(&ds);
931         free(packet);
932     }
933     return error;
934 }
935
936 /* Retrieves 'dpif''s "listen mask" into '*listen_mask'.  Each ODPL_* bit set
937  * in '*listen_mask' indicates that dpif_recv() will receive messages of that
938  * type.  Returns 0 if successful, otherwise a positive errno value. */
939 int
940 dpif_recv_get_mask(const struct dpif *dpif, int *listen_mask)
941 {
942     int error = dpif->dpif_class->recv_get_mask(dpif, listen_mask);
943     if (error) {
944         *listen_mask = 0;
945     }
946     log_operation(dpif, "recv_get_mask", error);
947     return error;
948 }
949
950 /* Sets 'dpif''s "listen mask" to 'listen_mask'.  Each ODPL_* bit set in
951  * '*listen_mask' requests that dpif_recv() receive messages of that type.
952  * Returns 0 if successful, otherwise a positive errno value. */
953 int
954 dpif_recv_set_mask(struct dpif *dpif, int listen_mask)
955 {
956     int error = dpif->dpif_class->recv_set_mask(dpif, listen_mask);
957     log_operation(dpif, "recv_set_mask", error);
958     return error;
959 }
960
961 /* Retrieve the sFlow sampling probability.  '*probability' is expressed as the
962  * number of packets out of UINT_MAX to sample, e.g. probability/UINT_MAX is
963  * the probability of sampling a given packet.
964  *
965  * Returns 0 if successful, otherwise a positive errno value.  EOPNOTSUPP
966  * indicates that 'dpif' does not support sFlow sampling. */
967 int
968 dpif_get_sflow_probability(const struct dpif *dpif, uint32_t *probability)
969 {
970     int error = (dpif->dpif_class->get_sflow_probability
971                  ? dpif->dpif_class->get_sflow_probability(dpif, probability)
972                  : EOPNOTSUPP);
973     if (error) {
974         *probability = 0;
975     }
976     log_operation(dpif, "get_sflow_probability", error);
977     return error;
978 }
979
980 /* Set the sFlow sampling probability.  'probability' is expressed as the
981  * number of packets out of UINT_MAX to sample, e.g. probability/UINT_MAX is
982  * the probability of sampling a given packet.
983  *
984  * Returns 0 if successful, otherwise a positive errno value.  EOPNOTSUPP
985  * indicates that 'dpif' does not support sFlow sampling. */
986 int
987 dpif_set_sflow_probability(struct dpif *dpif, uint32_t probability)
988 {
989     int error = (dpif->dpif_class->set_sflow_probability
990                  ? dpif->dpif_class->set_sflow_probability(dpif, probability)
991                  : EOPNOTSUPP);
992     log_operation(dpif, "set_sflow_probability", error);
993     return error;
994 }
995
996 /* Polls for an upcall from 'dpif'.  If successful, stores the upcall into
997  * '*upcall'.  Only upcalls of the types selected with the set_listen_mask
998  * member function will ordinarily be received (but if a message type is
999  * enabled and then later disabled, some stragglers might pop up).
1000  *
1001  * The caller takes ownership of the data that 'upcall' points to.
1002  * 'upcall->key' and 'upcall->actions' (if nonnull) point into data owned by
1003  * 'upcall->packet', so their memory cannot be freed separately.  (This is
1004  * hardly a great way to do things but it works out OK for the dpif providers
1005  * and clients that exist so far.)
1006  *
1007  * Returns 0 if successful, otherwise a positive errno value.  Returns EAGAIN
1008  * if no upcall is immediately available. */
1009 int
1010 dpif_recv(struct dpif *dpif, struct dpif_upcall *upcall)
1011 {
1012     int error = dpif->dpif_class->recv(dpif, upcall);
1013     if (!error && !VLOG_DROP_DBG(&dpmsg_rl)) {
1014         struct flow flow;
1015         char *s;
1016
1017         s = ofp_packet_to_string(upcall->packet->data,
1018                                  upcall->packet->size, upcall->packet->size);
1019         odp_flow_key_to_flow(upcall->key, upcall->key_len, &flow);
1020
1021         VLOG_DBG("%s: %s upcall on port %"PRIu16": %s", dpif_name(dpif),
1022                  (upcall->type == _ODPL_MISS_NR ? "miss"
1023                   : upcall->type == _ODPL_ACTION_NR ? "action"
1024                   : upcall->type == _ODPL_SFLOW_NR ? "sFlow"
1025                   : "<unknown>"),
1026                  flow.in_port, s);
1027         free(s);
1028     }
1029     return error;
1030 }
1031
1032 /* Discards all messages that would otherwise be received by dpif_recv() on
1033  * 'dpif'. */
1034 void
1035 dpif_recv_purge(struct dpif *dpif)
1036 {
1037     COVERAGE_INC(dpif_purge);
1038     if (dpif->dpif_class->recv_purge) {
1039         dpif->dpif_class->recv_purge(dpif);
1040     }
1041 }
1042
1043 /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be
1044  * received with dpif_recv(). */
1045 void
1046 dpif_recv_wait(struct dpif *dpif)
1047 {
1048     dpif->dpif_class->recv_wait(dpif);
1049 }
1050
1051 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
1052  * and '*engine_id', respectively. */
1053 void
1054 dpif_get_netflow_ids(const struct dpif *dpif,
1055                      uint8_t *engine_type, uint8_t *engine_id)
1056 {
1057     *engine_type = dpif->netflow_engine_type;
1058     *engine_id = dpif->netflow_engine_id;
1059 }
1060
1061 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority
1062  * value for use in the ODPAT_SET_PRIORITY action.  On success, returns 0 and
1063  * stores the priority into '*priority'.  On failure, returns a positive errno
1064  * value and stores 0 into '*priority'. */
1065 int
1066 dpif_queue_to_priority(const struct dpif *dpif, uint32_t queue_id,
1067                        uint32_t *priority)
1068 {
1069     int error = (dpif->dpif_class->queue_to_priority
1070                  ? dpif->dpif_class->queue_to_priority(dpif, queue_id,
1071                                                        priority)
1072                  : EOPNOTSUPP);
1073     if (error) {
1074         *priority = 0;
1075     }
1076     log_operation(dpif, "queue_to_priority", error);
1077     return error;
1078 }
1079 \f
1080 void
1081 dpif_init(struct dpif *dpif, const struct dpif_class *dpif_class,
1082           const char *name,
1083           uint8_t netflow_engine_type, uint8_t netflow_engine_id)
1084 {
1085     dpif->dpif_class = dpif_class;
1086     dpif->base_name = xstrdup(name);
1087     dpif->full_name = xasprintf("%s@%s", dpif_class->type, name);
1088     dpif->netflow_engine_type = netflow_engine_type;
1089     dpif->netflow_engine_id = netflow_engine_id;
1090 }
1091
1092 /* Undoes the results of initialization.
1093  *
1094  * Normally this function only needs to be called from dpif_close().
1095  * However, it may be called by providers due to an error on opening
1096  * that occurs after initialization.  It this case dpif_close() would
1097  * never be called. */
1098 void
1099 dpif_uninit(struct dpif *dpif, bool close)
1100 {
1101     char *base_name = dpif->base_name;
1102     char *full_name = dpif->full_name;
1103
1104     if (close) {
1105         dpif->dpif_class->close(dpif);
1106     }
1107
1108     free(base_name);
1109     free(full_name);
1110 }
1111 \f
1112 static void
1113 log_operation(const struct dpif *dpif, const char *operation, int error)
1114 {
1115     if (!error) {
1116         VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation);
1117     } else if (is_errno(error)) {
1118         VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1119                      dpif_name(dpif), operation, strerror(error));
1120     } else {
1121         VLOG_WARN_RL(&error_rl, "%s: %s failed (%d/%d)",
1122                      dpif_name(dpif), operation,
1123                      get_ofp_err_type(error), get_ofp_err_code(error));
1124     }
1125 }
1126
1127 static enum vlog_level
1128 flow_message_log_level(int error)
1129 {
1130     return error ? VLL_WARN : VLL_DBG;
1131 }
1132
1133 static bool
1134 should_log_flow_message(int error)
1135 {
1136     return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error),
1137                              error ? &error_rl : &dpmsg_rl);
1138 }
1139
1140 static void
1141 log_flow_message(const struct dpif *dpif, int error, const char *operation,
1142                  const struct nlattr *key, size_t key_len,
1143                  const struct odp_flow_stats *stats,
1144                  const struct nlattr *actions, size_t actions_len)
1145 {
1146     struct ds ds = DS_EMPTY_INITIALIZER;
1147     ds_put_format(&ds, "%s: ", dpif_name(dpif));
1148     if (error) {
1149         ds_put_cstr(&ds, "failed to ");
1150     }
1151     ds_put_format(&ds, "%s ", operation);
1152     if (error) {
1153         ds_put_format(&ds, "(%s) ", strerror(error));
1154     }
1155     odp_flow_key_format(key, key_len, &ds);
1156     if (stats) {
1157         ds_put_cstr(&ds, ", ");
1158         format_odp_flow_stats(&ds, stats);
1159     }
1160     if (actions || actions_len) {
1161         ds_put_cstr(&ds, ", actions:");
1162         format_odp_actions(&ds, actions, actions_len);
1163     }
1164     vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds));
1165     ds_destroy(&ds);
1166 }
1167
1168 static void
1169 log_flow_operation(const struct dpif *dpif, const char *operation, int error,
1170                    struct odp_flow *flow)
1171 {
1172     if (error) {
1173         flow->key_len = 0;
1174         flow->actions_len = 0;
1175     }
1176     log_flow_message(dpif, error, operation,
1177                      flow->key, flow->key_len, !error ? &flow->stats : NULL,
1178                      flow->actions, flow->actions_len);
1179 }
1180
1181 static void
1182 log_flow_put(struct dpif *dpif, int error, const struct odp_flow_put *put)
1183 {
1184     enum { ODPPF_ALL = ODPPF_CREATE | ODPPF_MODIFY | ODPPF_ZERO_STATS };
1185     struct ds s;
1186
1187     ds_init(&s);
1188     ds_put_cstr(&s, "put");
1189     if (put->flags & ODPPF_CREATE) {
1190         ds_put_cstr(&s, "[create]");
1191     }
1192     if (put->flags & ODPPF_MODIFY) {
1193         ds_put_cstr(&s, "[modify]");
1194     }
1195     if (put->flags & ODPPF_ZERO_STATS) {
1196         ds_put_cstr(&s, "[zero]");
1197     }
1198     if (put->flags & ~ODPPF_ALL) {
1199         ds_put_format(&s, "[%x]", put->flags & ~ODPPF_ALL);
1200     }
1201     log_flow_message(dpif, error, ds_cstr(&s),
1202                      put->flow.key, put->flow.key_len,
1203                      !error ? &put->flow.stats : NULL,
1204                      put->flow.actions, put->flow.actions_len);
1205     ds_destroy(&s);
1206 }
1207
1208 /* There is a tendency to construct odp_flow objects on the stack and to
1209  * forget to properly initialize their "actions" and "actions_len" members.
1210  * When this happens, we get memory corruption because the kernel
1211  * writes through the random pointer that is in the "actions" member.
1212  *
1213  * This function attempts to combat the problem by:
1214  *
1215  *      - Forcing a segfault if "actions" points to an invalid region (instead
1216  *        of just getting back EFAULT, which can be easily missed in the log).
1217  *
1218  *      - Storing a distinctive value that is likely to cause an
1219  *        easy-to-identify error later if it is dereferenced, etc.
1220  *
1221  *      - Triggering a warning on uninitialized memory from Valgrind if
1222  *        "actions" or "actions_len" was not initialized.
1223  */
1224 static void
1225 check_rw_flow_actions(struct odp_flow *flow)
1226 {
1227     if (flow->actions_len) {
1228         memset(&flow->actions[0], 0xcc, sizeof flow->actions[0]);
1229     }
1230 }
1231
1232 /* Same as check_rw_flow_actions() but for flow->key. */
1233 static void
1234 check_rw_flow_key(struct odp_flow *flow)
1235 {
1236     if (flow->key_len) {
1237         memset(&flow->key[0], 0xcc, sizeof flow->key[0]);
1238     }
1239 }