lib/dpif-netdev.c

   1 /*
   2  * Copyright (c) 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.h"
  19
  20 #include <ctype.h>
  21 #include <errno.h>
  22 #include <fcntl.h>
  23 #include <inttypes.h>
  24 #include <netinet/in.h>
  25 #include <sys/socket.h>
  26 #include <net/if.h>
  27 #include <stdint.h>
  28 #include <stdlib.h>
  29 #include <string.h>
  30 #include <sys/ioctl.h>
  31 #include <sys/stat.h>
  32 #include <unistd.h>
  33
  34 #include "csum.h"
  35 #include "dpif.h"
  36 #include "dpif-provider.h"
  37 #include "dummy.h"
  38 #include "dynamic-string.h"
  39 #include "flow.h"
  40 #include "hmap.h"
  41 #include "list.h"
  42 #include "netdev.h"
  43 #include "netlink.h"
  44 #include "odp-util.h"
  45 #include "ofp-print.h"
  46 #include "ofpbuf.h"
  47 #include "packets.h"
  48 #include "poll-loop.h"
  49 #include "random.h"
  50 #include "shash.h"
  51 #include "sset.h"
  52 #include "timeval.h"
  53 #include "util.h"
  54 #include "vlog.h"
  55
  56 VLOG_DEFINE_THIS_MODULE(dpif_netdev);
  57
  58 /* Configuration parameters. */
  59 enum { MAX_PORTS = 256 };       /* Maximum number of ports. */
  60 enum { MAX_FLOWS = 65536 };     /* Maximum number of flows in flow table. */
  61
  62 /* Enough headroom to add a vlan tag, plus an extra 2 bytes to allow IP
  63  * headers to be aligned on a 4-byte boundary.  */
  64 enum { DP_NETDEV_HEADROOM = 2 + VLAN_HEADER_LEN };
  65
  66 /* Queues. */
  67 enum { N_QUEUES = 2 };          /* Number of queues for dpif_recv(). */
  68 enum { MAX_QUEUE_LEN = 128 };   /* Maximum number of packets per queue. */
  69 enum { QUEUE_MASK = MAX_QUEUE_LEN - 1 };
  70 BUILD_ASSERT_DECL(IS_POW2(MAX_QUEUE_LEN));
  71
  72 struct dp_netdev_upcall {
  73     struct dpif_upcall upcall;  /* Queued upcall information. */
  74     struct ofpbuf buf;          /* ofpbuf instance for upcall.packet. */
  75 };
  76
  77 struct dp_netdev_queue {
  78     struct dp_netdev_upcall upcalls[MAX_QUEUE_LEN];
  79     unsigned int head, tail;
  80 };
  81
  82 /* Datapath based on the network device interface from netdev.h. */
  83 struct dp_netdev {
  84     const struct dpif_class *class;
  85     char *name;
  86     int open_cnt;
  87     bool destroyed;
  88
  89     struct dp_netdev_queue queues[N_QUEUES];
  90     struct hmap flow_table;     /* Flow table. */
  91
  92     /* Statistics. */
  93     long long int n_hit;        /* Number of flow table matches. */
  94     long long int n_missed;     /* Number of flow table misses. */
  95     long long int n_lost;       /* Number of misses not passed to client. */
  96
  97     /* Ports. */
  98     struct dp_netdev_port *ports[MAX_PORTS];
  99     struct list port_list;
 100     unsigned int serial;
 101 };
 102
 103 /* A port in a netdev-based datapath. */
 104 struct dp_netdev_port {
 105     int port_no;                /* Index into dp_netdev's 'ports'. */
 106     struct list node;           /* Element in dp_netdev's 'port_list'. */
 107     struct netdev *netdev;
 108     char *type;                 /* Port type as requested by user. */
 109 };
 110
 111 /* A flow in dp_netdev's 'flow_table'. */
 112 struct dp_netdev_flow {
 113     struct hmap_node node;      /* Element in dp_netdev's 'flow_table'. */
 114     struct flow key;
 115
 116     /* Statistics. */
 117     long long int used;         /* Last used time, in monotonic msecs. */
 118     long long int packet_count; /* Number of packets matched. */
 119     long long int byte_count;   /* Number of bytes matched. */
 120     uint8_t tcp_flags;          /* Bitwise-OR of seen tcp_flags values. */
 121
 122     /* Actions. */
 123     struct nlattr *actions;
 124     size_t actions_len;
 125 };
 126
 127 /* Interface to netdev-based datapath. */
 128 struct dpif_netdev {
 129     struct dpif dpif;
 130     struct dp_netdev *dp;
 131     unsigned int dp_serial;
 132 };
 133
 134 /* All netdev-based datapaths. */
 135 static struct shash dp_netdevs = SHASH_INITIALIZER(&dp_netdevs);
 136
 137 /* Maximum port MTU seen so far. */
 138 static int max_mtu = ETH_PAYLOAD_MAX;
 139
 140 static int get_port_by_number(struct dp_netdev *, uint32_t port_no,
 141                               struct dp_netdev_port **portp);
 142 static int get_port_by_name(struct dp_netdev *, const char *devname,
 143                             struct dp_netdev_port **portp);
 144 static void dp_netdev_free(struct dp_netdev *);
 145 static void dp_netdev_flow_flush(struct dp_netdev *);
 146 static int do_add_port(struct dp_netdev *, const char *devname,
 147                        const char *type, uint32_t port_no);
 148 static int do_del_port(struct dp_netdev *, uint32_t port_no);
 149 static int dpif_netdev_open(const struct dpif_class *, const char *name,
 150                             bool create, struct dpif **);
 151 static int dp_netdev_output_userspace(struct dp_netdev *, const struct ofpbuf *,
 152                                     int queue_no, const struct flow *,
 153                                     uint64_t arg);
 154 static void dp_netdev_execute_actions(struct dp_netdev *,
 155                                       struct ofpbuf *, struct flow *,
 156                                       const struct nlattr *actions,
 157                                       size_t actions_len);
 158
 159 static struct dpif_netdev *
 160 dpif_netdev_cast(const struct dpif *dpif)
 161 {
 162     ovs_assert(dpif->dpif_class->open == dpif_netdev_open);
 163     return CONTAINER_OF(dpif, struct dpif_netdev, dpif);
 164 }
 165
 166 static struct dp_netdev *
 167 get_dp_netdev(const struct dpif *dpif)
 168 {
 169     return dpif_netdev_cast(dpif)->dp;
 170 }
 171
 172 static int
 173 dpif_netdev_enumerate(struct sset *all_dps)
 174 {
 175     struct shash_node *node;
 176
 177     SHASH_FOR_EACH(node, &dp_netdevs) {
 178         sset_add(all_dps, node->name);
 179     }
 180     return 0;
 181 }
 182
 183 static bool
 184 dpif_netdev_class_is_dummy(const struct dpif_class *class)
 185 {
 186     return class != &dpif_netdev_class;
 187 }
 188
 189 static const char *
 190 dpif_netdev_port_open_type(const struct dpif_class *class, const char *type)
 191 {
 192     return strcmp(type, "internal") ? type
 193                   : dpif_netdev_class_is_dummy(class) ? "dummy"
 194                   : "tap";
 195 }
 196
 197 static struct dpif *
 198 create_dpif_netdev(struct dp_netdev *dp)
 199 {
 200     uint16_t netflow_id = hash_string(dp->name, 0);
 201     struct dpif_netdev *dpif;
 202
 203     dp->open_cnt++;
 204
 205     dpif = xmalloc(sizeof *dpif);
 206     dpif_init(&dpif->dpif, dp->class, dp->name, netflow_id >> 8, netflow_id);
 207     dpif->dp = dp;
 208     dpif->dp_serial = dp->serial;
 209
 210     return &dpif->dpif;
 211 }
 212
 213 static int
 214 choose_port(struct dp_netdev *dp, const char *name)
 215 {
 216     int port_no;
 217
 218     if (dp->class != &dpif_netdev_class) {
 219         const char *p;
 220         int start_no = 0;
 221
 222         /* If the port name begins with "br", start the number search at
 223          * 100 to make writing tests easier. */
 224         if (!strncmp(name, "br", 2)) {
 225             start_no = 100;
 226         }
 227
 228         /* If the port name contains a number, try to assign that port number.
 229          * This can make writing unit tests easier because port numbers are
 230          * predictable. */
 231         for (p = name; *p != '\0'; p++) {
 232             if (isdigit((unsigned char) *p)) {
 233                 port_no = start_no + strtol(p, NULL, 10);
 234                 if (port_no > 0 && port_no < MAX_PORTS
 235                     && !dp->ports[port_no]) {
 236                     return port_no;
 237                 }
 238                 break;
 239             }
 240         }
 241     }
 242
 243     for (port_no = 1; port_no < MAX_PORTS; port_no++) {
 244         if (!dp->ports[port_no]) {
 245             return port_no;
 246         }
 247     }
 248
 249     return -1;
 250 }
 251
 252 static int
 253 create_dp_netdev(const char *name, const struct dpif_class *class,
 254                  struct dp_netdev **dpp)
 255 {
 256     struct dp_netdev *dp;
 257     int error;
 258     int i;
 259
 260     dp = xzalloc(sizeof *dp);
 261     dp->class = class;
 262     dp->name = xstrdup(name);
 263     dp->open_cnt = 0;
 264     for (i = 0; i < N_QUEUES; i++) {
 265         dp->queues[i].head = dp->queues[i].tail = 0;
 266     }
 267     hmap_init(&dp->flow_table);
 268     list_init(&dp->port_list);
 269
 270     error = do_add_port(dp, name, "internal", OVSP_LOCAL);
 271     if (error) {
 272         dp_netdev_free(dp);
 273         return error;
 274     }
 275
 276     shash_add(&dp_netdevs, name, dp);
 277
 278     *dpp = dp;
 279     return 0;
 280 }
 281
 282 static int
 283 dpif_netdev_open(const struct dpif_class *class, const char *name,
 284                  bool create, struct dpif **dpifp)
 285 {
 286     struct dp_netdev *dp;
 287
 288     dp = shash_find_data(&dp_netdevs, name);
 289     if (!dp) {
 290         if (!create) {
 291             return ENODEV;
 292         } else {
 293             int error = create_dp_netdev(name, class, &dp);
 294             if (error) {
 295                 return error;
 296             }
 297             ovs_assert(dp != NULL);
 298         }
 299     } else {
 300         if (dp->class != class) {
 301             return EINVAL;
 302         } else if (create) {
 303             return EEXIST;
 304         }
 305     }
 306
 307     *dpifp = create_dpif_netdev(dp);
 308     return 0;
 309 }
 310
 311 static void
 312 dp_netdev_purge_queues(struct dp_netdev *dp)
 313 {
 314     int i;
 315
 316     for (i = 0; i < N_QUEUES; i++) {
 317         struct dp_netdev_queue *q = &dp->queues[i];
 318
 319         while (q->tail != q->head) {
 320             struct dp_netdev_upcall *u = &q->upcalls[q->tail++ & QUEUE_MASK];
 321             ofpbuf_uninit(&u->buf);
 322         }
 323     }
 324 }
 325
 326 static void
 327 dp_netdev_free(struct dp_netdev *dp)
 328 {
 329     struct dp_netdev_port *port, *next;
 330
 331     dp_netdev_flow_flush(dp);
 332     LIST_FOR_EACH_SAFE (port, next, node, &dp->port_list) {
 333         do_del_port(dp, port->port_no);
 334     }
 335     dp_netdev_purge_queues(dp);
 336     hmap_destroy(&dp->flow_table);
 337     free(dp->name);
 338     free(dp);
 339 }
 340
 341 static void
 342 dpif_netdev_close(struct dpif *dpif)
 343 {
 344     struct dp_netdev *dp = get_dp_netdev(dpif);
 345     ovs_assert(dp->open_cnt > 0);
 346     if (--dp->open_cnt == 0 && dp->destroyed) {
 347         shash_find_and_delete(&dp_netdevs, dp->name);
 348         dp_netdev_free(dp);
 349     }
 350     free(dpif);
 351 }
 352
 353 static int
 354 dpif_netdev_destroy(struct dpif *dpif)
 355 {
 356     struct dp_netdev *dp = get_dp_netdev(dpif);
 357     dp->destroyed = true;
 358     return 0;
 359 }
 360
 361 static int
 362 dpif_netdev_get_stats(const struct dpif *dpif, struct dpif_dp_stats *stats)
 363 {
 364     struct dp_netdev *dp = get_dp_netdev(dpif);
 365     stats->n_flows = hmap_count(&dp->flow_table);
 366     stats->n_hit = dp->n_hit;
 367     stats->n_missed = dp->n_missed;
 368     stats->n_lost = dp->n_lost;
 369     return 0;
 370 }
 371
 372 static int
 373 do_add_port(struct dp_netdev *dp, const char *devname, const char *type,
 374             uint32_t port_no)
 375 {
 376     struct dp_netdev_port *port;
 377     struct netdev *netdev;
 378     const char *open_type;
 379     int mtu;
 380     int error;
 381
 382     /* XXX reject devices already in some dp_netdev. */
 383
 384     /* Open and validate network device. */
 385     open_type = dpif_netdev_port_open_type(dp->class, type);
 386     error = netdev_open(devname, open_type, &netdev);
 387     if (error) {
 388         return error;
 389     }
 390     /* XXX reject loopback devices */
 391     /* XXX reject non-Ethernet devices */
 392
 393     error = netdev_listen(netdev);
 394     if (error
 395         && !(error == EOPNOTSUPP && dpif_netdev_class_is_dummy(dp->class))) {
 396         VLOG_ERR("%s: cannot receive packets on this network device (%s)",
 397                  devname, strerror(errno));
 398         netdev_close(netdev);
 399         return error;
 400     }
 401
 402     error = netdev_turn_flags_on(netdev, NETDEV_PROMISC, false);
 403     if (error) {
 404         netdev_close(netdev);
 405         return error;
 406     }
 407
 408     port = xmalloc(sizeof *port);
 409     port->port_no = port_no;
 410     port->netdev = netdev;
 411     port->type = xstrdup(type);
 412
 413     error = netdev_get_mtu(netdev, &mtu);
 414     if (!error) {
 415         max_mtu = mtu;
 416     }
 417
 418     list_push_back(&dp->port_list, &port->node);
 419     dp->ports[port_no] = port;
 420     dp->serial++;
 421
 422     return 0;
 423 }
 424
 425 static int
 426 dpif_netdev_port_add(struct dpif *dpif, struct netdev *netdev,
 427                      uint32_t *port_nop)
 428 {
 429     struct dp_netdev *dp = get_dp_netdev(dpif);
 430     int port_no;
 431
 432     if (*port_nop != UINT32_MAX) {
 433         if (*port_nop >= MAX_PORTS) {
 434             return EFBIG;
 435         } else if (dp->ports[*port_nop]) {
 436             return EBUSY;
 437         }
 438         port_no = *port_nop;
 439     } else {
 440         port_no = choose_port(dp, netdev_get_name(netdev));
 441     }
 442     if (port_no >= 0) {
 443         *port_nop = port_no;
 444         return do_add_port(dp, netdev_get_name(netdev),
 445                            netdev_get_type(netdev), port_no);
 446     }
 447     return EFBIG;
 448 }
 449
 450 static int
 451 dpif_netdev_port_del(struct dpif *dpif, uint32_t port_no)
 452 {
 453     struct dp_netdev *dp = get_dp_netdev(dpif);
 454     return port_no == OVSP_LOCAL ? EINVAL : do_del_port(dp, port_no);
 455 }
 456
 457 static bool
 458 is_valid_port_number(uint32_t port_no)
 459 {
 460     return port_no < MAX_PORTS;
 461 }
 462
 463 static int
 464 get_port_by_number(struct dp_netdev *dp,
 465                    uint32_t port_no, struct dp_netdev_port **portp)
 466 {
 467     if (!is_valid_port_number(port_no)) {
 468         *portp = NULL;
 469         return EINVAL;
 470     } else {
 471         *portp = dp->ports[port_no];
 472         return *portp ? 0 : ENOENT;
 473     }
 474 }
 475
 476 static int
 477 get_port_by_name(struct dp_netdev *dp,
 478                  const char *devname, struct dp_netdev_port **portp)
 479 {
 480     struct dp_netdev_port *port;
 481
 482     LIST_FOR_EACH (port, node, &dp->port_list) {
 483         if (!strcmp(netdev_get_name(port->netdev), devname)) {
 484             *portp = port;
 485             return 0;
 486         }
 487     }
 488     return ENOENT;
 489 }
 490
 491 static int
 492 do_del_port(struct dp_netdev *dp, uint32_t port_no)
 493 {
 494     struct dp_netdev_port *port;
 495     char *name;
 496     int error;
 497
 498     error = get_port_by_number(dp, port_no, &port);
 499     if (error) {
 500         return error;
 501     }
 502
 503     list_remove(&port->node);
 504     dp->ports[port->port_no] = NULL;
 505     dp->serial++;
 506
 507     name = xstrdup(netdev_get_name(port->netdev));
 508     netdev_close(port->netdev);
 509     free(port->type);
 510
 511     free(name);
 512     free(port);
 513
 514     return 0;
 515 }
 516
 517 static void
 518 answer_port_query(const struct dp_netdev_port *port,
 519                   struct dpif_port *dpif_port)
 520 {
 521     dpif_port->name = xstrdup(netdev_get_name(port->netdev));
 522     dpif_port->type = xstrdup(port->type);
 523     dpif_port->port_no = port->port_no;
 524 }
 525
 526 static int
 527 dpif_netdev_port_query_by_number(const struct dpif *dpif, uint32_t port_no,
 528                                  struct dpif_port *dpif_port)
 529 {
 530     struct dp_netdev *dp = get_dp_netdev(dpif);
 531     struct dp_netdev_port *port;
 532     int error;
 533
 534     error = get_port_by_number(dp, port_no, &port);
 535     if (!error && dpif_port) {
 536         answer_port_query(port, dpif_port);
 537     }
 538     return error;
 539 }
 540
 541 static int
 542 dpif_netdev_port_query_by_name(const struct dpif *dpif, const char *devname,
 543                                struct dpif_port *dpif_port)
 544 {
 545     struct dp_netdev *dp = get_dp_netdev(dpif);
 546     struct dp_netdev_port *port;
 547     int error;
 548
 549     error = get_port_by_name(dp, devname, &port);
 550     if (!error && dpif_port) {
 551         answer_port_query(port, dpif_port);
 552     }
 553     return error;
 554 }
 555
 556 static int
 557 dpif_netdev_get_max_ports(const struct dpif *dpif OVS_UNUSED)
 558 {
 559     return MAX_PORTS;
 560 }
 561
 562 static void
 563 dp_netdev_free_flow(struct dp_netdev *dp, struct dp_netdev_flow *flow)
 564 {
 565     hmap_remove(&dp->flow_table, &flow->node);
 566     free(flow->actions);
 567     free(flow);
 568 }
 569
 570 static void
 571 dp_netdev_flow_flush(struct dp_netdev *dp)
 572 {
 573     struct dp_netdev_flow *flow, *next;
 574
 575     HMAP_FOR_EACH_SAFE (flow, next, node, &dp->flow_table) {
 576         dp_netdev_free_flow(dp, flow);
 577     }
 578 }
 579
 580 static int
 581 dpif_netdev_flow_flush(struct dpif *dpif)
 582 {
 583     struct dp_netdev *dp = get_dp_netdev(dpif);
 584     dp_netdev_flow_flush(dp);
 585     return 0;
 586 }
 587
 588 struct dp_netdev_port_state {
 589     uint32_t port_no;
 590     char *name;
 591 };
 592
 593 static int
 594 dpif_netdev_port_dump_start(const struct dpif *dpif OVS_UNUSED, void **statep)
 595 {
 596     *statep = xzalloc(sizeof(struct dp_netdev_port_state));
 597     return 0;
 598 }
 599
 600 static int
 601 dpif_netdev_port_dump_next(const struct dpif *dpif, void *state_,
 602                            struct dpif_port *dpif_port)
 603 {
 604     struct dp_netdev_port_state *state = state_;
 605     struct dp_netdev *dp = get_dp_netdev(dpif);
 606     uint32_t port_no;
 607
 608     for (port_no = state->port_no; port_no < MAX_PORTS; port_no++) {
 609         struct dp_netdev_port *port = dp->ports[port_no];
 610         if (port) {
 611             free(state->name);
 612             state->name = xstrdup(netdev_get_name(port->netdev));
 613             dpif_port->name = state->name;
 614             dpif_port->type = port->type;
 615             dpif_port->port_no = port->port_no;
 616             state->port_no = port_no + 1;
 617             return 0;
 618         }
 619     }
 620     return EOF;
 621 }
 622
 623 static int
 624 dpif_netdev_port_dump_done(const struct dpif *dpif OVS_UNUSED, void *state_)
 625 {
 626     struct dp_netdev_port_state *state = state_;
 627     free(state->name);
 628     free(state);
 629     return 0;
 630 }
 631
 632 static int
 633 dpif_netdev_port_poll(const struct dpif *dpif_, char **devnamep OVS_UNUSED)
 634 {
 635     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
 636     if (dpif->dp_serial != dpif->dp->serial) {
 637         dpif->dp_serial = dpif->dp->serial;
 638         return ENOBUFS;
 639     } else {
 640         return EAGAIN;
 641     }
 642 }
 643
 644 static void
 645 dpif_netdev_port_poll_wait(const struct dpif *dpif_)
 646 {
 647     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
 648     if (dpif->dp_serial != dpif->dp->serial) {
 649         poll_immediate_wake();
 650     }
 651 }
 652
 653 static struct dp_netdev_flow *
 654 dp_netdev_lookup_flow(const struct dp_netdev *dp, const struct flow *key)
 655 {
 656     struct dp_netdev_flow *flow;
 657
 658     HMAP_FOR_EACH_WITH_HASH (flow, node, flow_hash(key, 0), &dp->flow_table) {
 659         if (flow_equal(&flow->key, key)) {
 660             return flow;
 661         }
 662     }
 663     return NULL;
 664 }
 665
 666 static void
 667 get_dpif_flow_stats(struct dp_netdev_flow *flow, struct dpif_flow_stats *stats)
 668 {
 669     stats->n_packets = flow->packet_count;
 670     stats->n_bytes = flow->byte_count;
 671     stats->used = flow->used;
 672     stats->tcp_flags = flow->tcp_flags;
 673 }
 674
 675 static int
 676 dpif_netdev_flow_from_nlattrs(const struct nlattr *key, uint32_t key_len,
 677                               struct flow *flow)
 678 {
 679     if (odp_flow_key_to_flow(key, key_len, flow) != ODP_FIT_PERFECT) {
 680         /* This should not happen: it indicates that odp_flow_key_from_flow()
 681          * and odp_flow_key_to_flow() disagree on the acceptable form of a
 682          * flow.  Log the problem as an error, with enough details to enable
 683          * debugging. */
 684         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 685
 686         if (!VLOG_DROP_ERR(&rl)) {
 687             struct ds s;
 688
 689             ds_init(&s);
 690             odp_flow_key_format(key, key_len, &s);
 691             VLOG_ERR("internal error parsing flow key %s", ds_cstr(&s));
 692             ds_destroy(&s);
 693         }
 694
 695         return EINVAL;
 696     }
 697
 698     if (flow->in_port < OFPP_MAX
 699         ? flow->in_port >= MAX_PORTS
 700         : flow->in_port != OFPP_LOCAL && flow->in_port != OFPP_NONE) {
 701         return EINVAL;
 702     }
 703
 704     return 0;
 705 }
 706
 707 static int
 708 dpif_netdev_flow_get(const struct dpif *dpif,
 709                      const struct nlattr *nl_key, size_t nl_key_len,
 710                      struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
 711 {
 712     struct dp_netdev *dp = get_dp_netdev(dpif);
 713     struct dp_netdev_flow *flow;
 714     struct flow key;
 715     int error;
 716
 717     error = dpif_netdev_flow_from_nlattrs(nl_key, nl_key_len, &key);
 718     if (error) {
 719         return error;
 720     }
 721
 722     flow = dp_netdev_lookup_flow(dp, &key);
 723     if (!flow) {
 724         return ENOENT;
 725     }
 726
 727     if (stats) {
 728         get_dpif_flow_stats(flow, stats);
 729     }
 730     if (actionsp) {
 731         *actionsp = ofpbuf_clone_data(flow->actions, flow->actions_len);
 732     }
 733     return 0;
 734 }
 735
 736 static int
 737 set_flow_actions(struct dp_netdev_flow *flow,
 738                  const struct nlattr *actions, size_t actions_len)
 739 {
 740     flow->actions = xrealloc(flow->actions, actions_len);
 741     flow->actions_len = actions_len;
 742     memcpy(flow->actions, actions, actions_len);
 743     return 0;
 744 }
 745
 746 static int
 747 dp_netdev_flow_add(struct dp_netdev *dp, const struct flow *key,
 748                    const struct nlattr *actions, size_t actions_len)
 749 {
 750     struct dp_netdev_flow *flow;
 751     int error;
 752
 753     flow = xzalloc(sizeof *flow);
 754     flow->key = *key;
 755
 756     error = set_flow_actions(flow, actions, actions_len);
 757     if (error) {
 758         free(flow);
 759         return error;
 760     }
 761
 762     hmap_insert(&dp->flow_table, &flow->node, flow_hash(&flow->key, 0));
 763     return 0;
 764 }
 765
 766 static void
 767 clear_stats(struct dp_netdev_flow *flow)
 768 {
 769     flow->used = 0;
 770     flow->packet_count = 0;
 771     flow->byte_count = 0;
 772     flow->tcp_flags = 0;
 773 }
 774
 775 static int
 776 dpif_netdev_flow_put(struct dpif *dpif, const struct dpif_flow_put *put)
 777 {
 778     struct dp_netdev *dp = get_dp_netdev(dpif);
 779     struct dp_netdev_flow *flow;
 780     struct flow key;
 781     int error;
 782
 783     error = dpif_netdev_flow_from_nlattrs(put->key, put->key_len, &key);
 784     if (error) {
 785         return error;
 786     }
 787
 788     flow = dp_netdev_lookup_flow(dp, &key);
 789     if (!flow) {
 790         if (put->flags & DPIF_FP_CREATE) {
 791             if (hmap_count(&dp->flow_table) < MAX_FLOWS) {
 792                 if (put->stats) {
 793                     memset(put->stats, 0, sizeof *put->stats);
 794                 }
 795                 return dp_netdev_flow_add(dp, &key, put->actions,
 796                                           put->actions_len);
 797             } else {
 798                 return EFBIG;
 799             }
 800         } else {
 801             return ENOENT;
 802         }
 803     } else {
 804         if (put->flags & DPIF_FP_MODIFY) {
 805             int error = set_flow_actions(flow, put->actions, put->actions_len);
 806             if (!error) {
 807                 if (put->stats) {
 808                     get_dpif_flow_stats(flow, put->stats);
 809                 }
 810                 if (put->flags & DPIF_FP_ZERO_STATS) {
 811                     clear_stats(flow);
 812                 }
 813             }
 814             return error;
 815         } else {
 816             return EEXIST;
 817         }
 818     }
 819 }
 820
 821 static int
 822 dpif_netdev_flow_del(struct dpif *dpif, const struct dpif_flow_del *del)
 823 {
 824     struct dp_netdev *dp = get_dp_netdev(dpif);
 825     struct dp_netdev_flow *flow;
 826     struct flow key;
 827     int error;
 828
 829     error = dpif_netdev_flow_from_nlattrs(del->key, del->key_len, &key);
 830     if (error) {
 831         return error;
 832     }
 833
 834     flow = dp_netdev_lookup_flow(dp, &key);
 835     if (flow) {
 836         if (del->stats) {
 837             get_dpif_flow_stats(flow, del->stats);
 838         }
 839         dp_netdev_free_flow(dp, flow);
 840         return 0;
 841     } else {
 842         return ENOENT;
 843     }
 844 }
 845
 846 struct dp_netdev_flow_state {
 847     uint32_t bucket;
 848     uint32_t offset;
 849     struct nlattr *actions;
 850     struct odputil_keybuf keybuf;
 851     struct dpif_flow_stats stats;
 852 };
 853
 854 static int
 855 dpif_netdev_flow_dump_start(const struct dpif *dpif OVS_UNUSED, void **statep)
 856 {
 857     struct dp_netdev_flow_state *state;
 858
 859     *statep = state = xmalloc(sizeof *state);
 860     state->bucket = 0;
 861     state->offset = 0;
 862     state->actions = NULL;
 863     return 0;
 864 }
 865
 866 static int
 867 dpif_netdev_flow_dump_next(const struct dpif *dpif, void *state_,
 868                            const struct nlattr **key, size_t *key_len,
 869                            const struct nlattr **actions, size_t *actions_len,
 870                            const struct dpif_flow_stats **stats)
 871 {
 872     struct dp_netdev_flow_state *state = state_;
 873     struct dp_netdev *dp = get_dp_netdev(dpif);
 874     struct dp_netdev_flow *flow;
 875     struct hmap_node *node;
 876
 877     node = hmap_at_position(&dp->flow_table, &state->bucket, &state->offset);
 878     if (!node) {
 879         return EOF;
 880     }
 881
 882     flow = CONTAINER_OF(node, struct dp_netdev_flow, node);
 883
 884     if (key) {
 885         struct ofpbuf buf;
 886
 887         ofpbuf_use_stack(&buf, &state->keybuf, sizeof state->keybuf);
 888         odp_flow_key_from_flow(&buf, &flow->key, flow->key.in_port);
 889
 890         *key = buf.data;
 891         *key_len = buf.size;
 892     }
 893
 894     if (actions) {
 895         free(state->actions);
 896         state->actions = xmemdup(flow->actions, flow->actions_len);
 897
 898         *actions = state->actions;
 899         *actions_len = flow->actions_len;
 900     }
 901
 902     if (stats) {
 903         get_dpif_flow_stats(flow, &state->stats);
 904         *stats = &state->stats;
 905     }
 906
 907     return 0;
 908 }
 909
 910 static int
 911 dpif_netdev_flow_dump_done(const struct dpif *dpif OVS_UNUSED, void *state_)
 912 {
 913     struct dp_netdev_flow_state *state = state_;
 914
 915     free(state->actions);
 916     free(state);
 917     return 0;
 918 }
 919
 920 static int
 921 dpif_netdev_execute(struct dpif *dpif, const struct dpif_execute *execute)
 922 {
 923     struct dp_netdev *dp = get_dp_netdev(dpif);
 924     struct ofpbuf copy;
 925     struct flow key;
 926     int error;
 927
 928     if (execute->packet->size < ETH_HEADER_LEN ||
 929         execute->packet->size > UINT16_MAX) {
 930         return EINVAL;
 931     }
 932
 933     /* Make a deep copy of 'packet', because we might modify its data. */
 934     ofpbuf_init(&copy, DP_NETDEV_HEADROOM + execute->packet->size);
 935     ofpbuf_reserve(&copy, DP_NETDEV_HEADROOM);
 936     ofpbuf_put(&copy, execute->packet->data, execute->packet->size);
 937
 938     flow_extract(&copy, 0, 0, NULL, -1, &key);
 939     error = dpif_netdev_flow_from_nlattrs(execute->key, execute->key_len,
 940                                           &key);
 941     if (!error) {
 942         dp_netdev_execute_actions(dp, &copy, &key,
 943                                   execute->actions, execute->actions_len);
 944     }
 945
 946     ofpbuf_uninit(&copy);
 947     return error;
 948 }
 949
 950 static int
 951 dpif_netdev_recv_set(struct dpif *dpif OVS_UNUSED, bool enable OVS_UNUSED)
 952 {
 953     return 0;
 954 }
 955
 956 static int
 957 dpif_netdev_queue_to_priority(const struct dpif *dpif OVS_UNUSED,
 958                               uint32_t queue_id, uint32_t *priority)
 959 {
 960     *priority = queue_id;
 961     return 0;
 962 }
 963
 964 static struct dp_netdev_queue *
 965 find_nonempty_queue(struct dpif *dpif)
 966 {
 967     struct dp_netdev *dp = get_dp_netdev(dpif);
 968     int i;
 969
 970     for (i = 0; i < N_QUEUES; i++) {
 971         struct dp_netdev_queue *q = &dp->queues[i];
 972         if (q->head != q->tail) {
 973             return q;
 974         }
 975     }
 976     return NULL;
 977 }
 978
 979 static int
 980 dpif_netdev_recv(struct dpif *dpif, struct dpif_upcall *upcall,
 981                  struct ofpbuf *buf)
 982 {
 983     struct dp_netdev_queue *q = find_nonempty_queue(dpif);
 984     if (q) {
 985         struct dp_netdev_upcall *u = &q->upcalls[q->tail++ & QUEUE_MASK];
 986
 987         *upcall = u->upcall;
 988         upcall->packet = buf;
 989
 990         ofpbuf_uninit(buf);
 991         *buf = u->buf;
 992
 993         return 0;
 994     } else {
 995         return EAGAIN;
 996     }
 997 }
 998
 999 static void
1000 dpif_netdev_recv_wait(struct dpif *dpif)
1001 {
1002     if (find_nonempty_queue(dpif)) {
1003         poll_immediate_wake();
1004     } else {
1005         /* No messages ready to be received, and dp_wait() will ensure that we
1006          * wake up to queue new messages, so there is nothing to do. */
1007     }
1008 }
1009
1010 static void
1011 dpif_netdev_recv_purge(struct dpif *dpif)
1012 {
1013     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
1014     dp_netdev_purge_queues(dpif_netdev->dp);
1015 }
1016 \f
1017 static void
1018 dp_netdev_flow_used(struct dp_netdev_flow *flow, const struct ofpbuf *packet)
1019 {
1020     flow->used = time_msec();
1021     flow->packet_count++;
1022     flow->byte_count += packet->size;
1023     flow->tcp_flags |= packet_get_tcp_flags(packet, &flow->key);
1024 }
1025
1026 static void
1027 dp_netdev_port_input(struct dp_netdev *dp, struct dp_netdev_port *port,
1028                      struct ofpbuf *packet)
1029 {
1030     struct dp_netdev_flow *flow;
1031     struct flow key;
1032
1033     if (packet->size < ETH_HEADER_LEN) {
1034         return;
1035     }
1036     flow_extract(packet, 0, 0, NULL, port->port_no, &key);
1037     flow = dp_netdev_lookup_flow(dp, &key);
1038     if (flow) {
1039         dp_netdev_flow_used(flow, packet);
1040         dp_netdev_execute_actions(dp, packet, &key,
1041                                   flow->actions, flow->actions_len);
1042         dp->n_hit++;
1043     } else {
1044         dp->n_missed++;
1045         dp_netdev_output_userspace(dp, packet, DPIF_UC_MISS, &key, 0);
1046     }
1047 }
1048
1049 static void
1050 dpif_netdev_run(struct dpif *dpif)
1051 {
1052     struct dp_netdev *dp = get_dp_netdev(dpif);
1053     struct dp_netdev_port *port;
1054     struct ofpbuf packet;
1055
1056     ofpbuf_init(&packet, DP_NETDEV_HEADROOM + VLAN_ETH_HEADER_LEN + max_mtu);
1057
1058     LIST_FOR_EACH (port, node, &dp->port_list) {
1059         int error;
1060
1061         /* Reset packet contents. */
1062         ofpbuf_clear(&packet);
1063         ofpbuf_reserve(&packet, DP_NETDEV_HEADROOM);
1064
1065         error = netdev_recv(port->netdev, &packet);
1066         if (!error) {
1067             dp_netdev_port_input(dp, port, &packet);
1068         } else if (error != EAGAIN && error != EOPNOTSUPP) {
1069             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1070             VLOG_ERR_RL(&rl, "error receiving data from %s: %s",
1071                         netdev_get_name(port->netdev), strerror(error));
1072         }
1073     }
1074     ofpbuf_uninit(&packet);
1075 }
1076
1077 static void
1078 dpif_netdev_wait(struct dpif *dpif)
1079 {
1080     struct dp_netdev *dp = get_dp_netdev(dpif);
1081     struct dp_netdev_port *port;
1082
1083     LIST_FOR_EACH (port, node, &dp->port_list) {
1084         netdev_recv_wait(port->netdev);
1085     }
1086 }
1087
1088 static void
1089 dp_netdev_set_dl(struct ofpbuf *packet, const struct ovs_key_ethernet *eth_key)
1090 {
1091     struct eth_header *eh = packet->l2;
1092
1093     memcpy(eh->eth_src, eth_key->eth_src, sizeof eh->eth_src);
1094     memcpy(eh->eth_dst, eth_key->eth_dst, sizeof eh->eth_dst);
1095 }
1096
1097 static void
1098 dp_netdev_output_port(struct dp_netdev *dp, struct ofpbuf *packet,
1099                       uint32_t out_port)
1100 {
1101     struct dp_netdev_port *p = dp->ports[out_port];
1102     if (p) {
1103         netdev_send(p->netdev, packet);
1104     }
1105 }
1106
1107 static int
1108 dp_netdev_output_userspace(struct dp_netdev *dp, const struct ofpbuf *packet,
1109                          int queue_no, const struct flow *flow, uint64_t arg)
1110 {
1111     struct dp_netdev_queue *q = &dp->queues[queue_no];
1112     struct dp_netdev_upcall *u;
1113     struct dpif_upcall *upcall;
1114     struct ofpbuf *buf;
1115     size_t key_len;
1116
1117     if (q->head - q->tail >= MAX_QUEUE_LEN) {
1118         dp->n_lost++;
1119         return ENOBUFS;
1120     }
1121
1122     u = &q->upcalls[q->head++ & QUEUE_MASK];
1123
1124     buf = &u->buf;
1125     ofpbuf_init(buf, ODPUTIL_FLOW_KEY_BYTES + 2 + packet->size);
1126     odp_flow_key_from_flow(buf, flow, flow->in_port);
1127     key_len = buf->size;
1128     ofpbuf_pull(buf, key_len);
1129     ofpbuf_reserve(buf, 2);
1130     ofpbuf_put(buf, packet->data, packet->size);
1131
1132     upcall = &u->upcall;
1133     upcall->type = queue_no;
1134     upcall->packet = buf;
1135     upcall->key = buf->base;
1136     upcall->key_len = key_len;
1137     upcall->userdata = arg;
1138
1139     return 0;
1140 }
1141
1142 static void
1143 dp_netdev_sample(struct dp_netdev *dp,
1144                  struct ofpbuf *packet, struct flow *key,
1145                  const struct nlattr *action)
1146 {
1147     const struct nlattr *subactions = NULL;
1148     const struct nlattr *a;
1149     size_t left;
1150
1151     NL_NESTED_FOR_EACH_UNSAFE (a, left, action) {
1152         int type = nl_attr_type(a);
1153
1154         switch ((enum ovs_sample_attr) type) {
1155         case OVS_SAMPLE_ATTR_PROBABILITY:
1156             if (random_uint32() >= nl_attr_get_u32(a)) {
1157                 return;
1158             }
1159             break;
1160
1161         case OVS_SAMPLE_ATTR_ACTIONS:
1162             subactions = a;
1163             break;
1164
1165         case OVS_SAMPLE_ATTR_UNSPEC:
1166         case __OVS_SAMPLE_ATTR_MAX:
1167         default:
1168             NOT_REACHED();
1169         }
1170     }
1171
1172     dp_netdev_execute_actions(dp, packet, key, nl_attr_get(subactions),
1173                               nl_attr_get_size(subactions));
1174 }
1175
1176 static void
1177 dp_netdev_action_userspace(struct dp_netdev *dp,
1178                           struct ofpbuf *packet, struct flow *key,
1179                           const struct nlattr *a)
1180 {
1181     const struct nlattr *userdata_attr;
1182     uint64_t userdata;
1183
1184     userdata_attr = nl_attr_find_nested(a, OVS_USERSPACE_ATTR_USERDATA);
1185     userdata = userdata_attr ? nl_attr_get_u64(userdata_attr) : 0;
1186     dp_netdev_output_userspace(dp, packet, DPIF_UC_ACTION, key, userdata);
1187 }
1188
1189 static void
1190 execute_set_action(struct ofpbuf *packet, const struct nlattr *a)
1191 {
1192     enum ovs_key_attr type = nl_attr_type(a);
1193     const struct ovs_key_ipv4 *ipv4_key;
1194     const struct ovs_key_ipv6 *ipv6_key;
1195     const struct ovs_key_tcp *tcp_key;
1196     const struct ovs_key_udp *udp_key;
1197
1198     switch (type) {
1199     case OVS_KEY_ATTR_TUN_ID:
1200     case OVS_KEY_ATTR_PRIORITY:
1201     case OVS_KEY_ATTR_SKB_MARK:
1202     case OVS_KEY_ATTR_TUNNEL:
1203         /* not implemented */
1204         break;
1205
1206     case OVS_KEY_ATTR_ETHERNET:
1207         dp_netdev_set_dl(packet,
1208                    nl_attr_get_unspec(a, sizeof(struct ovs_key_ethernet)));
1209         break;
1210
1211     case OVS_KEY_ATTR_IPV4:
1212         ipv4_key = nl_attr_get_unspec(a, sizeof(struct ovs_key_ipv4));
1213         packet_set_ipv4(packet, ipv4_key->ipv4_src, ipv4_key->ipv4_dst,
1214                         ipv4_key->ipv4_tos, ipv4_key->ipv4_ttl);
1215         break;
1216
1217     case OVS_KEY_ATTR_IPV6:
1218         ipv6_key = nl_attr_get_unspec(a, sizeof(struct ovs_key_ipv6));
1219         packet_set_ipv6(packet, ipv6_key->ipv6_proto, ipv6_key->ipv6_src,
1220                         ipv6_key->ipv6_dst, ipv6_key->ipv6_tclass,
1221                         ipv6_key->ipv6_label, ipv6_key->ipv6_hlimit);
1222         break;
1223
1224     case OVS_KEY_ATTR_TCP:
1225         tcp_key = nl_attr_get_unspec(a, sizeof(struct ovs_key_tcp));
1226         packet_set_tcp_port(packet, tcp_key->tcp_src, tcp_key->tcp_dst);
1227         break;
1228
1229      case OVS_KEY_ATTR_UDP:
1230         udp_key = nl_attr_get_unspec(a, sizeof(struct ovs_key_udp));
1231         packet_set_udp_port(packet, udp_key->udp_src, udp_key->udp_dst);
1232         break;
1233
1234      case OVS_KEY_ATTR_UNSPEC:
1235      case OVS_KEY_ATTR_ENCAP:
1236      case OVS_KEY_ATTR_ETHERTYPE:
1237      case OVS_KEY_ATTR_IN_PORT:
1238      case OVS_KEY_ATTR_VLAN:
1239      case OVS_KEY_ATTR_ICMP:
1240      case OVS_KEY_ATTR_ICMPV6:
1241      case OVS_KEY_ATTR_ARP:
1242      case OVS_KEY_ATTR_ND:
1243      case __OVS_KEY_ATTR_MAX:
1244      default:
1245         NOT_REACHED();
1246     }
1247 }
1248
1249 static void
1250 dp_netdev_execute_actions(struct dp_netdev *dp,
1251                           struct ofpbuf *packet, struct flow *key,
1252                           const struct nlattr *actions,
1253                           size_t actions_len)
1254 {
1255     const struct nlattr *a;
1256     unsigned int left;
1257
1258     NL_ATTR_FOR_EACH_UNSAFE (a, left, actions, actions_len) {
1259         int type = nl_attr_type(a);
1260
1261         switch ((enum ovs_action_attr) type) {
1262         case OVS_ACTION_ATTR_OUTPUT:
1263             dp_netdev_output_port(dp, packet, nl_attr_get_u32(a));
1264             break;
1265
1266         case OVS_ACTION_ATTR_USERSPACE:
1267             dp_netdev_action_userspace(dp, packet, key, a);
1268             break;
1269
1270         case OVS_ACTION_ATTR_PUSH_VLAN: {
1271             const struct ovs_action_push_vlan *vlan = nl_attr_get(a);
1272             eth_push_vlan(packet, vlan->vlan_tci);
1273             break;
1274         }
1275
1276         case OVS_ACTION_ATTR_POP_VLAN:
1277             eth_pop_vlan(packet);
1278             break;
1279
1280         case OVS_ACTION_ATTR_SET:
1281             execute_set_action(packet, nl_attr_get(a));
1282             break;
1283
1284         case OVS_ACTION_ATTR_SAMPLE:
1285             dp_netdev_sample(dp, packet, key, a);
1286             break;
1287
1288         case OVS_ACTION_ATTR_UNSPEC:
1289         case __OVS_ACTION_ATTR_MAX:
1290             NOT_REACHED();
1291         }
1292     }
1293 }
1294
1295 const struct dpif_class dpif_netdev_class = {
1296     "netdev",
1297     dpif_netdev_enumerate,
1298     dpif_netdev_port_open_type,
1299     dpif_netdev_open,
1300     dpif_netdev_close,
1301     dpif_netdev_destroy,
1302     dpif_netdev_run,
1303     dpif_netdev_wait,
1304     dpif_netdev_get_stats,
1305     dpif_netdev_port_add,
1306     dpif_netdev_port_del,
1307     dpif_netdev_port_query_by_number,
1308     dpif_netdev_port_query_by_name,
1309     dpif_netdev_get_max_ports,
1310     NULL,                       /* port_get_pid */
1311     dpif_netdev_port_dump_start,
1312     dpif_netdev_port_dump_next,
1313     dpif_netdev_port_dump_done,
1314     dpif_netdev_port_poll,
1315     dpif_netdev_port_poll_wait,
1316     dpif_netdev_flow_get,
1317     dpif_netdev_flow_put,
1318     dpif_netdev_flow_del,
1319     dpif_netdev_flow_flush,
1320     dpif_netdev_flow_dump_start,
1321     dpif_netdev_flow_dump_next,
1322     dpif_netdev_flow_dump_done,
1323     dpif_netdev_execute,
1324     NULL,                       /* operate */
1325     dpif_netdev_recv_set,
1326     dpif_netdev_queue_to_priority,
1327     dpif_netdev_recv,
1328     dpif_netdev_recv_wait,
1329     dpif_netdev_recv_purge,
1330 };
1331
1332 static void
1333 dpif_dummy_register__(const char *type)
1334 {
1335     struct dpif_class *class;
1336
1337     class = xmalloc(sizeof *class);
1338     *class = dpif_netdev_class;
1339     class->type = xstrdup(type);
1340     dp_register_provider(class);
1341 }
1342
1343 void
1344 dpif_dummy_register(bool override)
1345 {
1346     if (override) {
1347         struct sset types;
1348         const char *type;
1349
1350         sset_init(&types);
1351         dp_enumerate_types(&types);
1352         SSET_FOR_EACH (type, &types) {
1353             if (!dp_unregister_provider(type)) {
1354                 dpif_dummy_register__(type);
1355             }
1356         }
1357         sset_destroy(&types);
1358     }
1359
1360     dpif_dummy_register__("dummy");
1361 }