lib/dpif-netdev.c

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