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