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     uint8_t tcp_flags;          /* Bitwise-OR of seen tcp_flags 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 const char* internal_port_type(const struct dp_netdev* dp)
 306 {
 307         if (dp->class == &dpif_netdev_class)
 308                 return "tap";
 309         return "dummy";
 310 }
 311
 312 static int
 313 do_add_port(struct dp_netdev *dp, const char *devname, const char *type,
 314             uint16_t port_no)
 315 {
 316     struct dp_netdev_port *port;
 317     struct netdev *netdev;
 318     const char *open_type;
 319     int mtu;
 320     int error;
 321
 322     /* XXX reject devices already in some dp_netdev. */
 323
 324     /* Open and validate network device. */
 325     open_type = (strcmp(type, "internal") ? type : internal_port_type(dp));
 326     error = netdev_open(devname, open_type, &netdev);
 327     if (error) {
 328         return error;
 329     }
 330     /* XXX reject loopback devices */
 331     /* XXX reject non-Ethernet devices */
 332
 333     error = netdev_listen(netdev);
 334     if (error) {
 335         VLOG_ERR("%s: cannot receive packets on this network device (%s)",
 336                  devname, strerror(errno));
 337         netdev_close(netdev);
 338         return error;
 339     }
 340
 341     error = netdev_turn_flags_on(netdev, NETDEV_PROMISC, false);
 342     if (error) {
 343         netdev_close(netdev);
 344         return error;
 345     }
 346
 347     port = xmalloc(sizeof *port);
 348     port->port_no = port_no;
 349     port->netdev = netdev;
 350     port->type = xstrdup(type);
 351
 352     error = netdev_get_mtu(netdev, &mtu);
 353     if (!error) {
 354         max_mtu = mtu;
 355     }
 356
 357     list_push_back(&dp->port_list, &port->node);
 358     dp->ports[port_no] = port;
 359     dp->serial++;
 360
 361     return 0;
 362 }
 363
 364 static int
 365 choose_port(struct dpif *dpif, struct netdev *netdev)
 366 {
 367     struct dp_netdev *dp = get_dp_netdev(dpif);
 368     int port_no;
 369
 370     if (dpif->dpif_class != &dpif_netdev_class) {
 371         /* If the port name contains a number, try to assign that port number.
 372          * This can make writing unit tests easier because port numbers are
 373          * predictable. */
 374         const char *p;
 375
 376         for (p = netdev_get_name(netdev); *p != '\0'; p++) {
 377             if (isdigit((unsigned char) *p)) {
 378                 port_no = strtol(p, NULL, 10);
 379                 if (port_no > 0 && port_no < MAX_PORTS
 380                     && !dp->ports[port_no]) {
 381                     return port_no;
 382                 }
 383                 break;
 384             }
 385         }
 386     }
 387
 388     for (port_no = 0; port_no < MAX_PORTS; port_no++) {
 389         if (!dp->ports[port_no]) {
 390             return port_no;
 391         }
 392     }
 393
 394     return -1;
 395 }
 396
 397 static int
 398 dpif_netdev_port_add(struct dpif *dpif, struct netdev *netdev,
 399                      uint16_t *port_nop)
 400 {
 401     struct dp_netdev *dp = get_dp_netdev(dpif);
 402     int port_no;
 403
 404     port_no = choose_port(dpif, netdev);
 405     if (port_no >= 0) {
 406         *port_nop = port_no;
 407         return do_add_port(dp, netdev_get_name(netdev),
 408                            netdev_get_type(netdev), port_no);
 409     }
 410     return EFBIG;
 411 }
 412
 413 static int
 414 dpif_netdev_port_del(struct dpif *dpif, uint16_t port_no)
 415 {
 416     struct dp_netdev *dp = get_dp_netdev(dpif);
 417     return port_no == OVSP_LOCAL ? EINVAL : do_del_port(dp, port_no);
 418 }
 419
 420 static bool
 421 is_valid_port_number(uint16_t port_no)
 422 {
 423     return port_no < MAX_PORTS;
 424 }
 425
 426 static int
 427 get_port_by_number(struct dp_netdev *dp,
 428                    uint16_t port_no, struct dp_netdev_port **portp)
 429 {
 430     if (!is_valid_port_number(port_no)) {
 431         *portp = NULL;
 432         return EINVAL;
 433     } else {
 434         *portp = dp->ports[port_no];
 435         return *portp ? 0 : ENOENT;
 436     }
 437 }
 438
 439 static int
 440 get_port_by_name(struct dp_netdev *dp,
 441                  const char *devname, struct dp_netdev_port **portp)
 442 {
 443     struct dp_netdev_port *port;
 444
 445     LIST_FOR_EACH (port, node, &dp->port_list) {
 446         if (!strcmp(netdev_get_name(port->netdev), devname)) {
 447             *portp = port;
 448             return 0;
 449         }
 450     }
 451     return ENOENT;
 452 }
 453
 454 static int
 455 do_del_port(struct dp_netdev *dp, uint16_t port_no)
 456 {
 457     struct dp_netdev_port *port;
 458     char *name;
 459     int error;
 460
 461     error = get_port_by_number(dp, port_no, &port);
 462     if (error) {
 463         return error;
 464     }
 465
 466     list_remove(&port->node);
 467     dp->ports[port->port_no] = NULL;
 468     dp->serial++;
 469
 470     name = xstrdup(netdev_get_name(port->netdev));
 471     netdev_close(port->netdev);
 472     free(port->type);
 473
 474     free(name);
 475     free(port);
 476
 477     return 0;
 478 }
 479
 480 static void
 481 answer_port_query(const struct dp_netdev_port *port,
 482                   struct dpif_port *dpif_port)
 483 {
 484     dpif_port->name = xstrdup(netdev_get_name(port->netdev));
 485     dpif_port->type = xstrdup(port->type);
 486     dpif_port->port_no = port->port_no;
 487 }
 488
 489 static int
 490 dpif_netdev_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
 491                                  struct dpif_port *dpif_port)
 492 {
 493     struct dp_netdev *dp = get_dp_netdev(dpif);
 494     struct dp_netdev_port *port;
 495     int error;
 496
 497     error = get_port_by_number(dp, port_no, &port);
 498     if (!error) {
 499         answer_port_query(port, dpif_port);
 500     }
 501     return error;
 502 }
 503
 504 static int
 505 dpif_netdev_port_query_by_name(const struct dpif *dpif, const char *devname,
 506                                struct dpif_port *dpif_port)
 507 {
 508     struct dp_netdev *dp = get_dp_netdev(dpif);
 509     struct dp_netdev_port *port;
 510     int error;
 511
 512     error = get_port_by_name(dp, devname, &port);
 513     if (!error) {
 514         answer_port_query(port, dpif_port);
 515     }
 516     return error;
 517 }
 518
 519 static int
 520 dpif_netdev_get_max_ports(const struct dpif *dpif OVS_UNUSED)
 521 {
 522     return MAX_PORTS;
 523 }
 524
 525 static void
 526 dp_netdev_free_flow(struct dp_netdev *dp, struct dp_netdev_flow *flow)
 527 {
 528     hmap_remove(&dp->flow_table, &flow->node);
 529     free(flow->actions);
 530     free(flow);
 531 }
 532
 533 static void
 534 dp_netdev_flow_flush(struct dp_netdev *dp)
 535 {
 536     struct dp_netdev_flow *flow, *next;
 537
 538     HMAP_FOR_EACH_SAFE (flow, next, node, &dp->flow_table) {
 539         dp_netdev_free_flow(dp, flow);
 540     }
 541 }
 542
 543 static int
 544 dpif_netdev_flow_flush(struct dpif *dpif)
 545 {
 546     struct dp_netdev *dp = get_dp_netdev(dpif);
 547     dp_netdev_flow_flush(dp);
 548     return 0;
 549 }
 550
 551 struct dp_netdev_port_state {
 552     uint32_t port_no;
 553     char *name;
 554 };
 555
 556 static int
 557 dpif_netdev_port_dump_start(const struct dpif *dpif OVS_UNUSED, void **statep)
 558 {
 559     *statep = xzalloc(sizeof(struct dp_netdev_port_state));
 560     return 0;
 561 }
 562
 563 static int
 564 dpif_netdev_port_dump_next(const struct dpif *dpif, void *state_,
 565                            struct dpif_port *dpif_port)
 566 {
 567     struct dp_netdev_port_state *state = state_;
 568     struct dp_netdev *dp = get_dp_netdev(dpif);
 569     uint32_t port_no;
 570
 571     for (port_no = state->port_no; port_no < MAX_PORTS; port_no++) {
 572         struct dp_netdev_port *port = dp->ports[port_no];
 573         if (port) {
 574             free(state->name);
 575             state->name = xstrdup(netdev_get_name(port->netdev));
 576             dpif_port->name = state->name;
 577             dpif_port->type = port->type;
 578             dpif_port->port_no = port->port_no;
 579             state->port_no = port_no + 1;
 580             return 0;
 581         }
 582     }
 583     return EOF;
 584 }
 585
 586 static int
 587 dpif_netdev_port_dump_done(const struct dpif *dpif OVS_UNUSED, void *state_)
 588 {
 589     struct dp_netdev_port_state *state = state_;
 590     free(state->name);
 591     free(state);
 592     return 0;
 593 }
 594
 595 static int
 596 dpif_netdev_port_poll(const struct dpif *dpif_, char **devnamep OVS_UNUSED)
 597 {
 598     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
 599     if (dpif->dp_serial != dpif->dp->serial) {
 600         dpif->dp_serial = dpif->dp->serial;
 601         return ENOBUFS;
 602     } else {
 603         return EAGAIN;
 604     }
 605 }
 606
 607 static void
 608 dpif_netdev_port_poll_wait(const struct dpif *dpif_)
 609 {
 610     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
 611     if (dpif->dp_serial != dpif->dp->serial) {
 612         poll_immediate_wake();
 613     }
 614 }
 615
 616 static struct dp_netdev_flow *
 617 dp_netdev_lookup_flow(const struct dp_netdev *dp, const struct flow *key)
 618 {
 619     struct dp_netdev_flow *flow;
 620
 621     HMAP_FOR_EACH_WITH_HASH (flow, node, flow_hash(key, 0), &dp->flow_table) {
 622         if (flow_equal(&flow->key, key)) {
 623             return flow;
 624         }
 625     }
 626     return NULL;
 627 }
 628
 629 static void
 630 get_dpif_flow_stats(struct dp_netdev_flow *flow, struct dpif_flow_stats *stats)
 631 {
 632     stats->n_packets = flow->packet_count;
 633     stats->n_bytes = flow->byte_count;
 634     stats->used = flow->used;
 635     stats->tcp_flags = flow->tcp_flags;
 636 }
 637
 638 static int
 639 dpif_netdev_flow_from_nlattrs(const struct nlattr *key, uint32_t key_len,
 640                               struct flow *flow)
 641 {
 642     if (odp_flow_key_to_flow(key, key_len, flow)) {
 643         /* This should not happen: it indicates that odp_flow_key_from_flow()
 644          * and odp_flow_key_to_flow() disagree on the acceptable form of a
 645          * flow.  Log the problem as an error, with enough details to enable
 646          * debugging. */
 647         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 648
 649         if (!VLOG_DROP_ERR(&rl)) {
 650             struct ds s;
 651
 652             ds_init(&s);
 653             odp_flow_key_format(key, key_len, &s);
 654             VLOG_ERR("internal error parsing flow key %s", ds_cstr(&s));
 655             ds_destroy(&s);
 656         }
 657
 658         return EINVAL;
 659     }
 660
 661     if (flow->in_port < OFPP_MAX
 662         ? flow->in_port >= MAX_PORTS
 663         : flow->in_port != OFPP_LOCAL && flow->in_port != OFPP_NONE) {
 664         return EINVAL;
 665     }
 666
 667     return 0;
 668 }
 669
 670 static int
 671 dpif_netdev_flow_get(const struct dpif *dpif,
 672                      const struct nlattr *nl_key, size_t nl_key_len,
 673                      struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
 674 {
 675     struct dp_netdev *dp = get_dp_netdev(dpif);
 676     struct dp_netdev_flow *flow;
 677     struct flow key;
 678     int error;
 679
 680     error = dpif_netdev_flow_from_nlattrs(nl_key, nl_key_len, &key);
 681     if (error) {
 682         return error;
 683     }
 684
 685     flow = dp_netdev_lookup_flow(dp, &key);
 686     if (!flow) {
 687         return ENOENT;
 688     }
 689
 690     if (stats) {
 691         get_dpif_flow_stats(flow, stats);
 692     }
 693     if (actionsp) {
 694         *actionsp = ofpbuf_clone_data(flow->actions, flow->actions_len);
 695     }
 696     return 0;
 697 }
 698
 699 static int
 700 set_flow_actions(struct dp_netdev_flow *flow,
 701                  const struct nlattr *actions, size_t actions_len)
 702 {
 703     flow->actions = xrealloc(flow->actions, actions_len);
 704     flow->actions_len = actions_len;
 705     memcpy(flow->actions, actions, actions_len);
 706     return 0;
 707 }
 708
 709 static int
 710 add_flow(struct dpif *dpif, const struct flow *key,
 711          const struct nlattr *actions, size_t actions_len)
 712 {
 713     struct dp_netdev *dp = get_dp_netdev(dpif);
 714     struct dp_netdev_flow *flow;
 715     int error;
 716
 717     flow = xzalloc(sizeof *flow);
 718     flow->key = *key;
 719
 720     error = set_flow_actions(flow, actions, actions_len);
 721     if (error) {
 722         free(flow);
 723         return error;
 724     }
 725
 726     hmap_insert(&dp->flow_table, &flow->node, flow_hash(&flow->key, 0));
 727     return 0;
 728 }
 729
 730 static void
 731 clear_stats(struct dp_netdev_flow *flow)
 732 {
 733     flow->used = 0;
 734     flow->packet_count = 0;
 735     flow->byte_count = 0;
 736     flow->tcp_flags = 0;
 737 }
 738
 739 static int
 740 dpif_netdev_flow_put(struct dpif *dpif, const struct dpif_flow_put *put)
 741 {
 742     struct dp_netdev *dp = get_dp_netdev(dpif);
 743     struct dp_netdev_flow *flow;
 744     struct flow key;
 745     int error;
 746
 747     error = dpif_netdev_flow_from_nlattrs(put->key, put->key_len, &key);
 748     if (error) {
 749         return error;
 750     }
 751
 752     flow = dp_netdev_lookup_flow(dp, &key);
 753     if (!flow) {
 754         if (put->flags & DPIF_FP_CREATE) {
 755             if (hmap_count(&dp->flow_table) < MAX_FLOWS) {
 756                 if (put->stats) {
 757                     memset(put->stats, 0, sizeof *put->stats);
 758                 }
 759                 return add_flow(dpif, &key, put->actions, put->actions_len);
 760             } else {
 761                 return EFBIG;
 762             }
 763         } else {
 764             return ENOENT;
 765         }
 766     } else {
 767         if (put->flags & DPIF_FP_MODIFY) {
 768             int error = set_flow_actions(flow, put->actions, put->actions_len);
 769             if (!error) {
 770                 if (put->stats) {
 771                     get_dpif_flow_stats(flow, put->stats);
 772                 }
 773                 if (put->flags & DPIF_FP_ZERO_STATS) {
 774                     clear_stats(flow);
 775                 }
 776             }
 777             return error;
 778         } else {
 779             return EEXIST;
 780         }
 781     }
 782 }
 783
 784 static int
 785 dpif_netdev_flow_del(struct dpif *dpif, const struct dpif_flow_del *del)
 786 {
 787     struct dp_netdev *dp = get_dp_netdev(dpif);
 788     struct dp_netdev_flow *flow;
 789     struct flow key;
 790     int error;
 791
 792     error = dpif_netdev_flow_from_nlattrs(del->key, del->key_len, &key);
 793     if (error) {
 794         return error;
 795     }
 796
 797     flow = dp_netdev_lookup_flow(dp, &key);
 798     if (flow) {
 799         if (del->stats) {
 800             get_dpif_flow_stats(flow, del->stats);
 801         }
 802         dp_netdev_free_flow(dp, flow);
 803         return 0;
 804     } else {
 805         return ENOENT;
 806     }
 807 }
 808
 809 struct dp_netdev_flow_state {
 810     uint32_t bucket;
 811     uint32_t offset;
 812     struct nlattr *actions;
 813     struct odputil_keybuf keybuf;
 814     struct dpif_flow_stats stats;
 815 };
 816
 817 static int
 818 dpif_netdev_flow_dump_start(const struct dpif *dpif OVS_UNUSED, void **statep)
 819 {
 820     struct dp_netdev_flow_state *state;
 821
 822     *statep = state = xmalloc(sizeof *state);
 823     state->bucket = 0;
 824     state->offset = 0;
 825     state->actions = NULL;
 826     return 0;
 827 }
 828
 829 static int
 830 dpif_netdev_flow_dump_next(const struct dpif *dpif, void *state_,
 831                            const struct nlattr **key, size_t *key_len,
 832                            const struct nlattr **actions, size_t *actions_len,
 833                            const struct dpif_flow_stats **stats)
 834 {
 835     struct dp_netdev_flow_state *state = state_;
 836     struct dp_netdev *dp = get_dp_netdev(dpif);
 837     struct dp_netdev_flow *flow;
 838     struct hmap_node *node;
 839
 840     node = hmap_at_position(&dp->flow_table, &state->bucket, &state->offset);
 841     if (!node) {
 842         return EOF;
 843     }
 844
 845     flow = CONTAINER_OF(node, struct dp_netdev_flow, node);
 846
 847     if (key) {
 848         struct ofpbuf buf;
 849
 850         ofpbuf_use_stack(&buf, &state->keybuf, sizeof state->keybuf);
 851         odp_flow_key_from_flow(&buf, &flow->key);
 852
 853         *key = buf.data;
 854         *key_len = buf.size;
 855     }
 856
 857     if (actions) {
 858         free(state->actions);
 859         state->actions = xmemdup(flow->actions, flow->actions_len);
 860
 861         *actions = state->actions;
 862         *actions_len = flow->actions_len;
 863     }
 864
 865     if (stats) {
 866         get_dpif_flow_stats(flow, &state->stats);
 867         *stats = &state->stats;
 868     }
 869
 870     return 0;
 871 }
 872
 873 static int
 874 dpif_netdev_flow_dump_done(const struct dpif *dpif OVS_UNUSED, void *state_)
 875 {
 876     struct dp_netdev_flow_state *state = state_;
 877
 878     free(state->actions);
 879     free(state);
 880     return 0;
 881 }
 882
 883 static int
 884 dpif_netdev_execute(struct dpif *dpif, const struct dpif_execute *execute)
 885 {
 886     struct dp_netdev *dp = get_dp_netdev(dpif);
 887     struct ofpbuf copy;
 888     struct flow key;
 889     int error;
 890
 891     if (execute->packet->size < ETH_HEADER_LEN ||
 892         execute->packet->size > UINT16_MAX) {
 893         return EINVAL;
 894     }
 895
 896     /* Make a deep copy of 'packet', because we might modify its data. */
 897     ofpbuf_init(&copy, DP_NETDEV_HEADROOM + execute->packet->size);
 898     ofpbuf_reserve(&copy, DP_NETDEV_HEADROOM);
 899     ofpbuf_put(&copy, execute->packet->data, execute->packet->size);
 900
 901     flow_extract(&copy, 0, 0, -1, &key);
 902     error = dpif_netdev_flow_from_nlattrs(execute->key, execute->key_len,
 903                                           &key);
 904     if (!error) {
 905         dp_netdev_execute_actions(dp, &copy, &key,
 906                                   execute->actions, execute->actions_len);
 907     }
 908
 909     ofpbuf_uninit(&copy);
 910     return error;
 911 }
 912
 913 static int
 914 dpif_netdev_recv_set(struct dpif *dpif OVS_UNUSED, bool enable OVS_UNUSED)
 915 {
 916     return 0;
 917 }
 918
 919 static int
 920 dpif_netdev_queue_to_priority(const struct dpif *dpif OVS_UNUSED,
 921                               uint32_t queue_id, uint32_t *priority)
 922 {
 923     *priority = queue_id;
 924     return 0;
 925 }
 926
 927 static struct dp_netdev_queue *
 928 find_nonempty_queue(struct dpif *dpif)
 929 {
 930     struct dp_netdev *dp = get_dp_netdev(dpif);
 931     int i;
 932
 933     for (i = 0; i < N_QUEUES; i++) {
 934         struct dp_netdev_queue *q = &dp->queues[i];
 935         if (q->head != q->tail) {
 936             return q;
 937         }
 938     }
 939     return NULL;
 940 }
 941
 942 static int
 943 dpif_netdev_recv(struct dpif *dpif, struct dpif_upcall *upcall,
 944                  struct ofpbuf *buf)
 945 {
 946     struct dp_netdev_queue *q = find_nonempty_queue(dpif);
 947     if (q) {
 948         struct dpif_upcall *u = q->upcalls[q->tail++ & QUEUE_MASK];
 949         *upcall = *u;
 950         free(u);
 951
 952         ofpbuf_uninit(buf);
 953         *buf = *u->packet;
 954
 955         return 0;
 956     } else {
 957         return EAGAIN;
 958     }
 959 }
 960
 961 static void
 962 dpif_netdev_recv_wait(struct dpif *dpif)
 963 {
 964     if (find_nonempty_queue(dpif)) {
 965         poll_immediate_wake();
 966     } else {
 967         /* No messages ready to be received, and dp_wait() will ensure that we
 968          * wake up to queue new messages, so there is nothing to do. */
 969     }
 970 }
 971
 972 static void
 973 dpif_netdev_recv_purge(struct dpif *dpif)
 974 {
 975     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
 976     dp_netdev_purge_queues(dpif_netdev->dp);
 977 }
 978 \f
 979 static void
 980 dp_netdev_flow_used(struct dp_netdev_flow *flow, struct flow *key,
 981                     const struct ofpbuf *packet)
 982 {
 983     flow->used = time_msec();
 984     flow->packet_count++;
 985     flow->byte_count += packet->size;
 986     flow->tcp_flags |= packet_get_tcp_flags(packet, key);
 987 }
 988
 989 static void
 990 dp_netdev_port_input(struct dp_netdev *dp, struct dp_netdev_port *port,
 991                      struct ofpbuf *packet)
 992 {
 993     struct dp_netdev_flow *flow;
 994     struct flow key;
 995
 996     if (packet->size < ETH_HEADER_LEN) {
 997         return;
 998     }
 999     flow_extract(packet, 0, 0, port->port_no, &key);
1000     flow = dp_netdev_lookup_flow(dp, &key);
1001     if (flow) {
1002         dp_netdev_flow_used(flow, &key, packet);
1003         dp_netdev_execute_actions(dp, packet, &key,
1004                                   flow->actions, flow->actions_len);
1005         dp->n_hit++;
1006     } else {
1007         dp->n_missed++;
1008         dp_netdev_output_userspace(dp, packet, DPIF_UC_MISS, &key, 0);
1009     }
1010 }
1011
1012 static void
1013 dpif_netdev_run(struct dpif *dpif)
1014 {
1015     struct dp_netdev *dp = get_dp_netdev(dpif);
1016     struct dp_netdev_port *port;
1017     struct ofpbuf packet;
1018
1019     ofpbuf_init(&packet, DP_NETDEV_HEADROOM + VLAN_ETH_HEADER_LEN + max_mtu);
1020
1021     LIST_FOR_EACH (port, node, &dp->port_list) {
1022         int error;
1023
1024         /* Reset packet contents. */
1025         ofpbuf_clear(&packet);
1026         ofpbuf_reserve(&packet, DP_NETDEV_HEADROOM);
1027
1028         error = netdev_recv(port->netdev, &packet);
1029         if (!error) {
1030             dp_netdev_port_input(dp, port, &packet);
1031         } else if (error != EAGAIN && error != EOPNOTSUPP) {
1032             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1033             VLOG_ERR_RL(&rl, "error receiving data from %s: %s",
1034                         netdev_get_name(port->netdev), strerror(error));
1035         }
1036     }
1037     ofpbuf_uninit(&packet);
1038 }
1039
1040 static void
1041 dpif_netdev_wait(struct dpif *dpif)
1042 {
1043     struct dp_netdev *dp = get_dp_netdev(dpif);
1044     struct dp_netdev_port *port;
1045
1046     LIST_FOR_EACH (port, node, &dp->port_list) {
1047         netdev_recv_wait(port->netdev);
1048     }
1049 }
1050
1051 static void
1052 dp_netdev_set_dl(struct ofpbuf *packet, const struct ovs_key_ethernet *eth_key)
1053 {
1054     struct eth_header *eh = packet->l2;
1055
1056     memcpy(eh->eth_src, eth_key->eth_src, sizeof eh->eth_src);
1057     memcpy(eh->eth_dst, eth_key->eth_dst, sizeof eh->eth_dst);
1058 }
1059
1060 static void
1061 dp_netdev_output_port(struct dp_netdev *dp, struct ofpbuf *packet,
1062                       uint16_t out_port)
1063 {
1064     struct dp_netdev_port *p = dp->ports[out_port];
1065     if (p) {
1066         netdev_send(p->netdev, packet);
1067     }
1068 }
1069
1070 static int
1071 dp_netdev_output_userspace(struct dp_netdev *dp, const struct ofpbuf *packet,
1072                          int queue_no, const struct flow *flow, uint64_t arg)
1073 {
1074     struct dp_netdev_queue *q = &dp->queues[queue_no];
1075     struct dpif_upcall *upcall;
1076     struct ofpbuf *buf;
1077     size_t key_len;
1078
1079     if (q->head - q->tail >= MAX_QUEUE_LEN) {
1080         dp->n_lost++;
1081         return ENOBUFS;
1082     }
1083
1084     buf = ofpbuf_new(ODPUTIL_FLOW_KEY_BYTES + 2 + packet->size);
1085     odp_flow_key_from_flow(buf, flow);
1086     key_len = buf->size;
1087     ofpbuf_pull(buf, key_len);
1088     ofpbuf_reserve(buf, 2);
1089     ofpbuf_put(buf, packet->data, packet->size);
1090
1091     upcall = xzalloc(sizeof *upcall);
1092     upcall->type = queue_no;
1093     upcall->packet = buf;
1094     upcall->key = buf->base;
1095     upcall->key_len = key_len;
1096     upcall->userdata = arg;
1097
1098     q->upcalls[q->head++ & QUEUE_MASK] = upcall;
1099
1100     return 0;
1101 }
1102
1103 static void
1104 dp_netdev_sample(struct dp_netdev *dp,
1105                  struct ofpbuf *packet, struct flow *key,
1106                  const struct nlattr *action)
1107 {
1108     const struct nlattr *subactions = NULL;
1109     const struct nlattr *a;
1110     size_t left;
1111
1112     NL_NESTED_FOR_EACH_UNSAFE (a, left, action) {
1113         int type = nl_attr_type(a);
1114
1115         switch ((enum ovs_sample_attr) type) {
1116         case OVS_SAMPLE_ATTR_PROBABILITY:
1117             if (random_uint32() >= nl_attr_get_u32(a)) {
1118                 return;
1119             }
1120             break;
1121
1122         case OVS_SAMPLE_ATTR_ACTIONS:
1123             subactions = a;
1124             break;
1125
1126         case OVS_SAMPLE_ATTR_UNSPEC:
1127         case __OVS_SAMPLE_ATTR_MAX:
1128         default:
1129             NOT_REACHED();
1130         }
1131     }
1132
1133     dp_netdev_execute_actions(dp, packet, key, nl_attr_get(subactions),
1134                               nl_attr_get_size(subactions));
1135 }
1136
1137 static void
1138 dp_netdev_action_userspace(struct dp_netdev *dp,
1139                           struct ofpbuf *packet, struct flow *key,
1140                           const struct nlattr *a)
1141 {
1142     const struct nlattr *userdata_attr;
1143     uint64_t userdata;
1144
1145     userdata_attr = nl_attr_find_nested(a, OVS_USERSPACE_ATTR_USERDATA);
1146     userdata = userdata_attr ? nl_attr_get_u64(userdata_attr) : 0;
1147     dp_netdev_output_userspace(dp, packet, DPIF_UC_ACTION, key, userdata);
1148 }
1149
1150 static void
1151 execute_set_action(struct ofpbuf *packet, const struct nlattr *a)
1152 {
1153     enum ovs_key_attr type = nl_attr_type(a);
1154     const struct ovs_key_ipv4 *ipv4_key;
1155     const struct ovs_key_tcp *tcp_key;
1156     const struct ovs_key_udp *udp_key;
1157
1158     switch (type) {
1159     case OVS_KEY_ATTR_TUN_ID:
1160     case OVS_KEY_ATTR_PRIORITY:
1161     case OVS_KEY_ATTR_IPV6:
1162         /* not implemented */
1163         break;
1164
1165     case OVS_KEY_ATTR_ETHERNET:
1166         dp_netdev_set_dl(packet,
1167                    nl_attr_get_unspec(a, sizeof(struct ovs_key_ethernet)));
1168         break;
1169
1170     case OVS_KEY_ATTR_IPV4:
1171         ipv4_key = nl_attr_get_unspec(a, sizeof(struct ovs_key_ipv4));
1172         packet_set_ipv4(packet, ipv4_key->ipv4_src, ipv4_key->ipv4_dst,
1173                         ipv4_key->ipv4_tos, ipv4_key->ipv4_ttl);
1174         break;
1175
1176     case OVS_KEY_ATTR_TCP:
1177         tcp_key = nl_attr_get_unspec(a, sizeof(struct ovs_key_tcp));
1178         packet_set_tcp_port(packet, tcp_key->tcp_src, tcp_key->tcp_dst);
1179         break;
1180
1181      case OVS_KEY_ATTR_UDP:
1182         udp_key = nl_attr_get_unspec(a, sizeof(struct ovs_key_udp));
1183         packet_set_udp_port(packet, udp_key->udp_src, udp_key->udp_dst);
1184         break;
1185
1186      case OVS_KEY_ATTR_UNSPEC:
1187      case OVS_KEY_ATTR_ENCAP:
1188      case OVS_KEY_ATTR_ETHERTYPE:
1189      case OVS_KEY_ATTR_IN_PORT:
1190      case OVS_KEY_ATTR_VLAN:
1191      case OVS_KEY_ATTR_ICMP:
1192      case OVS_KEY_ATTR_ICMPV6:
1193      case OVS_KEY_ATTR_ARP:
1194      case OVS_KEY_ATTR_ND:
1195      case __OVS_KEY_ATTR_MAX:
1196      default:
1197         NOT_REACHED();
1198     }
1199 }
1200
1201 static void
1202 dp_netdev_execute_actions(struct dp_netdev *dp,
1203                           struct ofpbuf *packet, struct flow *key,
1204                           const struct nlattr *actions,
1205                           size_t actions_len)
1206 {
1207     const struct nlattr *a;
1208     unsigned int left;
1209
1210     NL_ATTR_FOR_EACH_UNSAFE (a, left, actions, actions_len) {
1211         const struct ovs_action_push_vlan *vlan;
1212         int type = nl_attr_type(a);
1213
1214         switch ((enum ovs_action_attr) type) {
1215         case OVS_ACTION_ATTR_OUTPUT:
1216             dp_netdev_output_port(dp, packet, nl_attr_get_u32(a));
1217             break;
1218
1219         case OVS_ACTION_ATTR_USERSPACE:
1220             dp_netdev_action_userspace(dp, packet, key, a);
1221             break;
1222
1223         case OVS_ACTION_ATTR_PUSH_VLAN:
1224             vlan = nl_attr_get(a);
1225             eth_push_vlan(packet, vlan->vlan_tci);
1226             break;
1227
1228         case OVS_ACTION_ATTR_POP_VLAN:
1229             eth_pop_vlan(packet);
1230             break;
1231
1232         case OVS_ACTION_ATTR_SET:
1233             execute_set_action(packet, nl_attr_get(a));
1234             break;
1235
1236         case OVS_ACTION_ATTR_SAMPLE:
1237             dp_netdev_sample(dp, packet, key, a);
1238             break;
1239
1240         case OVS_ACTION_ATTR_UNSPEC:
1241         case __OVS_ACTION_ATTR_MAX:
1242             NOT_REACHED();
1243         }
1244     }
1245 }
1246
1247 #define DPIF_NETDEV_CLASS_FUNCTIONS                     \
1248     NULL,                       /* enumerate */         \
1249     dpif_netdev_open,                                   \
1250     dpif_netdev_close,                                  \
1251     dpif_netdev_destroy,                                \
1252     dpif_netdev_run,                                    \
1253     dpif_netdev_wait,                                   \
1254     dpif_netdev_get_stats,                              \
1255     dpif_netdev_port_add,                               \
1256     dpif_netdev_port_del,                               \
1257     dpif_netdev_port_query_by_number,                   \
1258     dpif_netdev_port_query_by_name,                     \
1259     dpif_netdev_get_max_ports,                          \
1260     NULL,                       /* port_get_pid */      \
1261     dpif_netdev_port_dump_start,                        \
1262     dpif_netdev_port_dump_next,                         \
1263     dpif_netdev_port_dump_done,                         \
1264     dpif_netdev_port_poll,                              \
1265     dpif_netdev_port_poll_wait,                         \
1266     dpif_netdev_flow_get,                               \
1267     dpif_netdev_flow_put,                               \
1268     dpif_netdev_flow_del,                               \
1269     dpif_netdev_flow_flush,                             \
1270     dpif_netdev_flow_dump_start,                        \
1271     dpif_netdev_flow_dump_next,                         \
1272     dpif_netdev_flow_dump_done,                         \
1273     dpif_netdev_execute,                                \
1274     NULL,                       /* operate */           \
1275     dpif_netdev_recv_set,                               \
1276     dpif_netdev_queue_to_priority,                      \
1277     dpif_netdev_recv,                                   \
1278     dpif_netdev_recv_wait,                              \
1279     dpif_netdev_recv_purge,                             \
1280
1281 const struct dpif_class dpif_netdev_class = {
1282     "netdev",
1283     DPIF_NETDEV_CLASS_FUNCTIONS
1284 };
1285
1286 static void
1287 dpif_dummy_register__(const char *type)
1288 {
1289     struct dpif_class *class;
1290
1291     class = xmalloc(sizeof *class);
1292     *class = dpif_netdev_class;
1293     class->type = xstrdup(type);
1294     dp_register_provider(class);
1295 }
1296
1297 void
1298 dpif_dummy_register(bool override)
1299 {
1300     if (override) {
1301         struct sset types;
1302         const char *type;
1303
1304         sset_init(&types);
1305         dp_enumerate_types(&types);
1306         SSET_FOR_EACH (type, &types) {
1307             if (!dp_unregister_provider(type)) {
1308                 dpif_dummy_register__(type);
1309             }
1310         }
1311         sset_destroy(&types);
1312     }
1313
1314     dpif_dummy_register__("dummy");
1315 }
1316