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