lib/dpif-netdev.c

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