lib/dpif-netdev.c

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