lib/dpif-netdev.c

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