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