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