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