lib/dpif-netdev.c

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