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