lib/dpif-netdev.c

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