pintos-os.org Git - openvswitch/blob - lib/dpif-netdev.c

   1 /*
   2  * Copyright (c) 2009, 2010, 2011 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 "shash.h"
  51 #include "timeval.h"
  52 #include "util.h"
  53 #include "vlog.h"
  54
  55 VLOG_DEFINE_THIS_MODULE(dpif_netdev);
  56
  57 /* Configuration parameters. */
  58 enum { MAX_PORTS = 256 };       /* Maximum number of ports. */
  59 enum { MAX_FLOWS = 65536 };     /* Maximum number of flows in flow table. */
  60
  61 /* Enough headroom to add a vlan tag, plus an extra 2 bytes to allow IP
  62  * headers to be aligned on a 4-byte boundary.  */
  63 enum { DP_NETDEV_HEADROOM = 2 + VLAN_HEADER_LEN };
  64
  65 /* Queues. */
  66 enum { N_QUEUES = 2 };          /* Number of queues for dpif_recv(). */
  67 enum { MAX_QUEUE_LEN = 128 };   /* Maximum number of packets per queue. */
  68 enum { QUEUE_MASK = MAX_QUEUE_LEN - 1 };
  69 BUILD_ASSERT_DECL(IS_POW2(MAX_QUEUE_LEN));
  70
  71 struct dp_netdev_queue {
  72     struct dpif_upcall *upcalls[MAX_QUEUE_LEN];
  73     unsigned int head, tail;
  74 };
  75
  76 /* Datapath based on the network device interface from netdev.h. */
  77 struct dp_netdev {
  78     const struct dpif_class *class;
  79     char *name;
  80     int open_cnt;
  81     bool destroyed;
  82
  83     bool drop_frags;            /* Drop all IP fragments, if true. */
  84     struct dp_netdev_queue queues[N_QUEUES];
  85     struct hmap flow_table;     /* Flow table. */
  86
  87     /* Statistics. */
  88     long long int n_frags;      /* Number of dropped IP fragments. */
  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     bool internal;              /* Internal port? */
 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     ovs_be16 tcp_ctl;           /* Bitwise-OR of seen tcp_ctl 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     int listen_mask;
 128     unsigned int dp_serial;
 129 };
 130
 131 /* All netdev-based datapaths. */
 132 static struct shash dp_netdevs = SHASH_INITIALIZER(&dp_netdevs);
 133
 134 /* Maximum port MTU seen so far. */
 135 static int max_mtu = ETH_PAYLOAD_MAX;
 136
 137 static int get_port_by_number(struct dp_netdev *, uint16_t port_no,
 138                               struct dp_netdev_port **portp);
 139 static int get_port_by_name(struct dp_netdev *, const char *devname,
 140                             struct dp_netdev_port **portp);
 141 static void dp_netdev_free(struct dp_netdev *);
 142 static void dp_netdev_flow_flush(struct dp_netdev *);
 143 static int do_add_port(struct dp_netdev *, const char *devname,
 144                        const char *type, uint16_t port_no);
 145 static int do_del_port(struct dp_netdev *, uint16_t port_no);
 146 static int dpif_netdev_open(const struct dpif_class *, const char *name,
 147                             bool create, struct dpif **);
 148 static int dp_netdev_output_userspace(struct dp_netdev *, const struct ofpbuf *,
 149                                     int queue_no, const struct flow *,
 150                                     uint64_t arg);
 151 static int dp_netdev_execute_actions(struct dp_netdev *,
 152                                      struct ofpbuf *, struct flow *,
 153                                      const struct nlattr *actions,
 154                                      size_t actions_len);
 155
 156 static struct dpif_class dpif_dummy_class;
 157
 158 static struct dpif_netdev *
 159 dpif_netdev_cast(const struct dpif *dpif)
 160 {
 161     assert(dpif->dpif_class->open == dpif_netdev_open);
 162     return CONTAINER_OF(dpif, struct dpif_netdev, dpif);
 163 }
 164
 165 static struct dp_netdev *
 166 get_dp_netdev(const struct dpif *dpif)
 167 {
 168     return dpif_netdev_cast(dpif)->dp;
 169 }
 170
 171 static struct dpif *
 172 create_dpif_netdev(struct dp_netdev *dp)
 173 {
 174     uint16_t netflow_id = hash_string(dp->name, 0);
 175     struct dpif_netdev *dpif;
 176
 177     dp->open_cnt++;
 178
 179     dpif = xmalloc(sizeof *dpif);
 180     dpif_init(&dpif->dpif, dp->class, dp->name, netflow_id >> 8, netflow_id);
 181     dpif->dp = dp;
 182     dpif->listen_mask = 0;
 183     dpif->dp_serial = dp->serial;
 184
 185     return &dpif->dpif;
 186 }
 187
 188 static int
 189 create_dp_netdev(const char *name, const struct dpif_class *class,
 190                  struct dp_netdev **dpp)
 191 {
 192     struct dp_netdev *dp;
 193     int error;
 194     int i;
 195
 196     dp = xzalloc(sizeof *dp);
 197     dp->class = class;
 198     dp->name = xstrdup(name);
 199     dp->open_cnt = 0;
 200     dp->drop_frags = false;
 201     for (i = 0; i < N_QUEUES; i++) {
 202         dp->queues[i].head = dp->queues[i].tail = 0;
 203     }
 204     hmap_init(&dp->flow_table);
 205     list_init(&dp->port_list);
 206     error = do_add_port(dp, name, "internal", OVSP_LOCAL);
 207     if (error) {
 208         dp_netdev_free(dp);
 209         return error;
 210     }
 211
 212     shash_add(&dp_netdevs, name, dp);
 213
 214     *dpp = dp;
 215     return 0;
 216 }
 217
 218 static int
 219 dpif_netdev_open(const struct dpif_class *class, const char *name,
 220                  bool create, struct dpif **dpifp)
 221 {
 222     struct dp_netdev *dp;
 223
 224     dp = shash_find_data(&dp_netdevs, name);
 225     if (!dp) {
 226         if (!create) {
 227             return ENODEV;
 228         } else {
 229             int error = create_dp_netdev(name, class, &dp);
 230             if (error) {
 231                 return error;
 232             }
 233             assert(dp != NULL);
 234         }
 235     } else {
 236         if (dp->class != class) {
 237             return EINVAL;
 238         } else if (create) {
 239             return EEXIST;
 240         }
 241     }
 242
 243     *dpifp = create_dpif_netdev(dp);
 244     return 0;
 245 }
 246
 247 static void
 248 dp_netdev_purge_queues(struct dp_netdev *dp)
 249 {
 250     int i;
 251
 252     for (i = 0; i < N_QUEUES; i++) {
 253         struct dp_netdev_queue *q = &dp->queues[i];
 254
 255         while (q->tail != q->head) {
 256             struct dpif_upcall *upcall = q->upcalls[q->tail++ & QUEUE_MASK];
 257
 258             ofpbuf_delete(upcall->packet);
 259             free(upcall);
 260         }
 261     }
 262 }
 263
 264 static void
 265 dp_netdev_free(struct dp_netdev *dp)
 266 {
 267     struct dp_netdev_port *port, *next;
 268
 269     dp_netdev_flow_flush(dp);
 270     LIST_FOR_EACH_SAFE (port, next, node, &dp->port_list) {
 271         do_del_port(dp, port->port_no);
 272     }
 273     dp_netdev_purge_queues(dp);
 274     hmap_destroy(&dp->flow_table);
 275     free(dp->name);
 276     free(dp);
 277 }
 278
 279 static void
 280 dpif_netdev_close(struct dpif *dpif)
 281 {
 282     struct dp_netdev *dp = get_dp_netdev(dpif);
 283     assert(dp->open_cnt > 0);
 284     if (--dp->open_cnt == 0 && dp->destroyed) {
 285         shash_find_and_delete(&dp_netdevs, dp->name);
 286         dp_netdev_free(dp);
 287     }
 288     free(dpif);
 289 }
 290
 291 static int
 292 dpif_netdev_destroy(struct dpif *dpif)
 293 {
 294     struct dp_netdev *dp = get_dp_netdev(dpif);
 295     dp->destroyed = true;
 296     return 0;
 297 }
 298
 299 static int
 300 dpif_netdev_get_stats(const struct dpif *dpif, struct dpif_dp_stats *stats)
 301 {
 302     struct dp_netdev *dp = get_dp_netdev(dpif);
 303     stats->n_flows = hmap_count(&dp->flow_table);
 304     stats->n_frags = dp->n_frags;
 305     stats->n_hit = dp->n_hit;
 306     stats->n_missed = dp->n_missed;
 307     stats->n_lost = dp->n_lost;
 308     return 0;
 309 }
 310
 311 static int
 312 dpif_netdev_get_drop_frags(const struct dpif *dpif, bool *drop_fragsp)
 313 {
 314     struct dp_netdev *dp = get_dp_netdev(dpif);
 315     *drop_fragsp = dp->drop_frags;
 316     return 0;
 317 }
 318
 319 static int
 320 dpif_netdev_set_drop_frags(struct dpif *dpif, bool drop_frags)
 321 {
 322     struct dp_netdev *dp = get_dp_netdev(dpif);
 323     dp->drop_frags = drop_frags;
 324     return 0;
 325 }
 326
 327 static int
 328 do_add_port(struct dp_netdev *dp, const char *devname, const char *type,
 329             uint16_t port_no)
 330 {
 331     struct dp_netdev_port *port;
 332     struct netdev *netdev;
 333     bool internal;
 334     int mtu;
 335     int error;
 336
 337     /* XXX reject devices already in some dp_netdev. */
 338     if (type[0] == '\0' || !strcmp(type, "system") || !strcmp(type, "dummy")) {
 339         internal = false;
 340     } else if (!strcmp(type, "internal")) {
 341         internal = true;
 342     } else {
 343         VLOG_WARN("%s: unsupported port type %s", devname, type);
 344         return EINVAL;
 345     }
 346
 347     /* Open and validate network device. */
 348     if (dp->class == &dpif_dummy_class) {
 349         type = "dummy";
 350     } else if (internal) {
 351         type = "tap";
 352     }
 353
 354     error = netdev_open(devname, type, &netdev);
 355     if (error) {
 356         return error;
 357     }
 358     /* XXX reject loopback devices */
 359     /* XXX reject non-Ethernet devices */
 360
 361     error = netdev_listen(netdev);
 362     if (error) {
 363         VLOG_ERR("%s: cannot receive packets on this network device (%s)",
 364                  devname, strerror(errno));
 365         netdev_close(netdev);
 366         return error;
 367     }
 368
 369     error = netdev_turn_flags_on(netdev, NETDEV_PROMISC, false);
 370     if (error) {
 371         netdev_close(netdev);
 372         return error;
 373     }
 374
 375     port = xmalloc(sizeof *port);
 376     port->port_no = port_no;
 377     port->netdev = netdev;
 378     port->internal = internal;
 379
 380     error = netdev_get_mtu(netdev, &mtu);
 381     if (!error) {
 382         max_mtu = mtu;
 383     }
 384
 385     list_push_back(&dp->port_list, &port->node);
 386     dp->ports[port_no] = port;
 387     dp->serial++;
 388
 389     return 0;
 390 }
 391
 392 static int
 393 dpif_netdev_port_add(struct dpif *dpif, struct netdev *netdev,
 394                      uint16_t *port_nop)
 395 {
 396     struct dp_netdev *dp = get_dp_netdev(dpif);
 397     int port_no;
 398
 399     for (port_no = 0; port_no < MAX_PORTS; port_no++) {
 400         if (!dp->ports[port_no]) {
 401             *port_nop = port_no;
 402             return do_add_port(dp, netdev_get_name(netdev),
 403                                netdev_get_type(netdev), port_no);
 404         }
 405     }
 406     return EFBIG;
 407 }
 408
 409 static int
 410 dpif_netdev_port_del(struct dpif *dpif, uint16_t port_no)
 411 {
 412     struct dp_netdev *dp = get_dp_netdev(dpif);
 413     return port_no == OVSP_LOCAL ? EINVAL : do_del_port(dp, port_no);
 414 }
 415
 416 static bool
 417 is_valid_port_number(uint16_t port_no)
 418 {
 419     return port_no < MAX_PORTS;
 420 }
 421
 422 static int
 423 get_port_by_number(struct dp_netdev *dp,
 424                    uint16_t port_no, struct dp_netdev_port **portp)
 425 {
 426     if (!is_valid_port_number(port_no)) {
 427         *portp = NULL;
 428         return EINVAL;
 429     } else {
 430         *portp = dp->ports[port_no];
 431         return *portp ? 0 : ENOENT;
 432     }
 433 }
 434
 435 static int
 436 get_port_by_name(struct dp_netdev *dp,
 437                  const char *devname, struct dp_netdev_port **portp)
 438 {
 439     struct dp_netdev_port *port;
 440
 441     LIST_FOR_EACH (port, node, &dp->port_list) {
 442         if (!strcmp(netdev_get_name(port->netdev), devname)) {
 443             *portp = port;
 444             return 0;
 445         }
 446     }
 447     return ENOENT;
 448 }
 449
 450 static int
 451 do_del_port(struct dp_netdev *dp, uint16_t port_no)
 452 {
 453     struct dp_netdev_port *port;
 454     char *name;
 455     int error;
 456
 457     error = get_port_by_number(dp, port_no, &port);
 458     if (error) {
 459         return error;
 460     }
 461
 462     list_remove(&port->node);
 463     dp->ports[port->port_no] = NULL;
 464     dp->serial++;
 465
 466     name = xstrdup(netdev_get_name(port->netdev));
 467     netdev_close(port->netdev);
 468
 469     free(name);
 470     free(port);
 471
 472     return 0;
 473 }
 474
 475 static void
 476 answer_port_query(const struct dp_netdev_port *port,
 477                   struct dpif_port *dpif_port)
 478 {
 479     dpif_port->name = xstrdup(netdev_get_name(port->netdev));
 480     dpif_port->type = xstrdup(port->internal ? "internal" : "system");
 481     dpif_port->port_no = port->port_no;
 482 }
 483
 484 static int
 485 dpif_netdev_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
 486                                  struct dpif_port *dpif_port)
 487 {
 488     struct dp_netdev *dp = get_dp_netdev(dpif);
 489     struct dp_netdev_port *port;
 490     int error;
 491
 492     error = get_port_by_number(dp, port_no, &port);
 493     if (!error) {
 494         answer_port_query(port, dpif_port);
 495     }
 496     return error;
 497 }
 498
 499 static int
 500 dpif_netdev_port_query_by_name(const struct dpif *dpif, const char *devname,
 501                                struct dpif_port *dpif_port)
 502 {
 503     struct dp_netdev *dp = get_dp_netdev(dpif);
 504     struct dp_netdev_port *port;
 505     int error;
 506
 507     error = get_port_by_name(dp, devname, &port);
 508     if (!error) {
 509         answer_port_query(port, dpif_port);
 510     }
 511     return error;
 512 }
 513
 514 static int
 515 dpif_netdev_get_max_ports(const struct dpif *dpif OVS_UNUSED)
 516 {
 517     return MAX_PORTS;
 518 }
 519
 520 static void
 521 dp_netdev_free_flow(struct dp_netdev *dp, struct dp_netdev_flow *flow)
 522 {
 523     hmap_remove(&dp->flow_table, &flow->node);
 524     free(flow->actions);
 525     free(flow);
 526 }
 527
 528 static void
 529 dp_netdev_flow_flush(struct dp_netdev *dp)
 530 {
 531     struct dp_netdev_flow *flow, *next;
 532
 533     HMAP_FOR_EACH_SAFE (flow, next, node, &dp->flow_table) {
 534         dp_netdev_free_flow(dp, flow);
 535     }
 536 }
 537
 538 static int
 539 dpif_netdev_flow_flush(struct dpif *dpif)
 540 {
 541     struct dp_netdev *dp = get_dp_netdev(dpif);
 542     dp_netdev_flow_flush(dp);
 543     return 0;
 544 }
 545
 546 struct dp_netdev_port_state {
 547     uint32_t port_no;
 548     char *name;
 549 };
 550
 551 static int
 552 dpif_netdev_port_dump_start(const struct dpif *dpif OVS_UNUSED, void **statep)
 553 {
 554     *statep = xzalloc(sizeof(struct dp_netdev_port_state));
 555     return 0;
 556 }
 557
 558 static int
 559 dpif_netdev_port_dump_next(const struct dpif *dpif, void *state_,
 560                            struct dpif_port *dpif_port)
 561 {
 562     struct dp_netdev_port_state *state = state_;
 563     struct dp_netdev *dp = get_dp_netdev(dpif);
 564     uint32_t port_no;
 565
 566     for (port_no = state->port_no; port_no < MAX_PORTS; port_no++) {
 567         struct dp_netdev_port *port = dp->ports[port_no];
 568         if (port) {
 569             free(state->name);
 570             state->name = xstrdup(netdev_get_name(port->netdev));
 571             dpif_port->name = state->name;
 572             dpif_port->type = port->internal ? "internal" : "system";
 573             dpif_port->port_no = port->port_no;
 574             state->port_no = port_no + 1;
 575             return 0;
 576         }
 577     }
 578     return EOF;
 579 }
 580
 581 static int
 582 dpif_netdev_port_dump_done(const struct dpif *dpif OVS_UNUSED, void *state_)
 583 {
 584     struct dp_netdev_port_state *state = state_;
 585     free(state->name);
 586     free(state);
 587     return 0;
 588 }
 589
 590 static int
 591 dpif_netdev_port_poll(const struct dpif *dpif_, char **devnamep OVS_UNUSED)
 592 {
 593     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
 594     if (dpif->dp_serial != dpif->dp->serial) {
 595         dpif->dp_serial = dpif->dp->serial;
 596         return ENOBUFS;
 597     } else {
 598         return EAGAIN;
 599     }
 600 }
 601
 602 static void
 603 dpif_netdev_port_poll_wait(const struct dpif *dpif_)
 604 {
 605     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
 606     if (dpif->dp_serial != dpif->dp->serial) {
 607         poll_immediate_wake();
 608     }
 609 }
 610
 611 static struct dp_netdev_flow *
 612 dp_netdev_lookup_flow(const struct dp_netdev *dp, const struct flow *key)
 613 {
 614     struct dp_netdev_flow *flow;
 615
 616     HMAP_FOR_EACH_WITH_HASH (flow, node, flow_hash(key, 0), &dp->flow_table) {
 617         if (flow_equal(&flow->key, key)) {
 618             return flow;
 619         }
 620     }
 621     return NULL;
 622 }
 623
 624 static void
 625 get_dpif_flow_stats(struct dp_netdev_flow *flow, struct dpif_flow_stats *stats)
 626 {
 627     stats->n_packets = flow->packet_count;
 628     stats->n_bytes = flow->byte_count;
 629     stats->used = flow->used;
 630     stats->tcp_flags = TCP_FLAGS(flow->tcp_ctl);
 631 }
 632
 633 static int
 634 dpif_netdev_flow_from_nlattrs(const struct nlattr *key, uint32_t key_len,
 635                               struct flow *flow)
 636 {
 637     if (odp_flow_key_to_flow(key, key_len, flow)) {
 638         /* This should not happen: it indicates that odp_flow_key_from_flow()
 639          * and odp_flow_key_to_flow() disagree on the acceptable form of a
 640          * flow.  Log the problem as an error, with enough details to enable
 641          * debugging. */
 642         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 643
 644         if (!VLOG_DROP_ERR(&rl)) {
 645             struct ds s;
 646
 647             ds_init(&s);
 648             odp_flow_key_format(key, key_len, &s);
 649             VLOG_ERR("internal error parsing flow key %s", ds_cstr(&s));
 650             ds_destroy(&s);
 651         }
 652
 653         return EINVAL;
 654     }
 655
 656     if (flow->in_port < OFPP_MAX
 657         ? flow->in_port >= MAX_PORTS
 658         : flow->in_port != OFPP_LOCAL && flow->in_port != OFPP_NONE) {
 659         return EINVAL;
 660     }
 661
 662     return 0;
 663 }
 664
 665 static int
 666 dpif_netdev_flow_get(const struct dpif *dpif,
 667                      const struct nlattr *nl_key, size_t nl_key_len,
 668                      struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
 669 {
 670     struct dp_netdev *dp = get_dp_netdev(dpif);
 671     struct dp_netdev_flow *flow;
 672     struct flow key;
 673     int error;
 674
 675     error = dpif_netdev_flow_from_nlattrs(nl_key, nl_key_len, &key);
 676     if (error) {
 677         return error;
 678     }
 679
 680     flow = dp_netdev_lookup_flow(dp, &key);
 681     if (!flow) {
 682         return ENOENT;
 683     }
 684
 685     if (stats) {
 686         get_dpif_flow_stats(flow, stats);
 687     }
 688     if (actionsp) {
 689         *actionsp = ofpbuf_clone_data(flow->actions, flow->actions_len);
 690     }
 691     return 0;
 692 }
 693
 694 static int
 695 set_flow_actions(struct dp_netdev_flow *flow,
 696                  const struct nlattr *actions, size_t actions_len)
 697 {
 698     flow->actions = xrealloc(flow->actions, actions_len);
 699     flow->actions_len = actions_len;
 700     memcpy(flow->actions, actions, actions_len);
 701     return 0;
 702 }
 703
 704 static int
 705 add_flow(struct dpif *dpif, const struct flow *key,
 706          const struct nlattr *actions, size_t actions_len)
 707 {
 708     struct dp_netdev *dp = get_dp_netdev(dpif);
 709     struct dp_netdev_flow *flow;
 710     int error;
 711
 712     flow = xzalloc(sizeof *flow);
 713     flow->key = *key;
 714
 715     error = set_flow_actions(flow, actions, actions_len);
 716     if (error) {
 717         free(flow);
 718         return error;
 719     }
 720
 721     hmap_insert(&dp->flow_table, &flow->node, flow_hash(&flow->key, 0));
 722     return 0;
 723 }
 724
 725 static void
 726 clear_stats(struct dp_netdev_flow *flow)
 727 {
 728     flow->used = 0;
 729     flow->packet_count = 0;
 730     flow->byte_count = 0;
 731     flow->tcp_ctl = 0;
 732 }
 733
 734 static int
 735 dpif_netdev_flow_put(struct dpif *dpif, enum dpif_flow_put_flags flags,
 736                     const struct nlattr *nl_key, size_t nl_key_len,
 737                     const struct nlattr *actions, size_t actions_len,
 738                     struct dpif_flow_stats *stats)
 739 {
 740     struct dp_netdev *dp = get_dp_netdev(dpif);
 741     struct dp_netdev_flow *flow;
 742     struct flow key;
 743     int error;
 744
 745     error = dpif_netdev_flow_from_nlattrs(nl_key, nl_key_len, &key);
 746     if (error) {
 747         return error;
 748     }
 749
 750     flow = dp_netdev_lookup_flow(dp, &key);
 751     if (!flow) {
 752         if (flags & DPIF_FP_CREATE) {
 753             if (hmap_count(&dp->flow_table) < MAX_FLOWS) {
 754                 if (stats) {
 755                     memset(stats, 0, sizeof *stats);
 756                 }
 757                 return add_flow(dpif, &key, actions, actions_len);
 758             } else {
 759                 return EFBIG;
 760             }
 761         } else {
 762             return ENOENT;
 763         }
 764     } else {
 765         if (flags & DPIF_FP_MODIFY) {
 766             int error = set_flow_actions(flow, actions, actions_len);
 767             if (!error) {
 768                 if (stats) {
 769                     get_dpif_flow_stats(flow, stats);
 770                 }
 771                 if (flags & DPIF_FP_ZERO_STATS) {
 772                     clear_stats(flow);
 773                 }
 774             }
 775             return error;
 776         } else {
 777             return EEXIST;
 778         }
 779     }
 780 }
 781
 782 static int
 783 dpif_netdev_flow_del(struct dpif *dpif,
 784                      const struct nlattr *nl_key, size_t nl_key_len,
 785                      struct dpif_flow_stats *stats)
 786 {
 787     struct dp_netdev *dp = get_dp_netdev(dpif);
 788     struct dp_netdev_flow *flow;
 789     struct flow key;
 790     int error;
 791
 792     error = dpif_netdev_flow_from_nlattrs(nl_key, nl_key_len, &key);
 793     if (error) {
 794         return error;
 795     }
 796
 797     flow = dp_netdev_lookup_flow(dp, &key);
 798     if (flow) {
 799         if (stats) {
 800             get_dpif_flow_stats(flow, stats);
 801         }
 802         dp_netdev_free_flow(dp, flow);
 803         return 0;
 804     } else {
 805         return ENOENT;
 806     }
 807 }
 808
 809 struct dp_netdev_flow_state {
 810     uint32_t bucket;
 811     uint32_t offset;
 812     struct nlattr *actions;
 813     struct odputil_keybuf keybuf;
 814     struct dpif_flow_stats stats;
 815 };
 816
 817 static int
 818 dpif_netdev_flow_dump_start(const struct dpif *dpif OVS_UNUSED, void **statep)
 819 {
 820     struct dp_netdev_flow_state *state;
 821
 822     *statep = state = xmalloc(sizeof *state);
 823     state->bucket = 0;
 824     state->offset = 0;
 825     state->actions = NULL;
 826     return 0;
 827 }
 828
 829 static int
 830 dpif_netdev_flow_dump_next(const struct dpif *dpif, void *state_,
 831                            const struct nlattr **key, size_t *key_len,
 832                            const struct nlattr **actions, size_t *actions_len,
 833                            const struct dpif_flow_stats **stats)
 834 {
 835     struct dp_netdev_flow_state *state = state_;
 836     struct dp_netdev *dp = get_dp_netdev(dpif);
 837     struct dp_netdev_flow *flow;
 838     struct hmap_node *node;
 839
 840     node = hmap_at_position(&dp->flow_table, &state->bucket, &state->offset);
 841     if (!node) {
 842         return EOF;
 843     }
 844
 845     flow = CONTAINER_OF(node, struct dp_netdev_flow, node);
 846
 847     if (key) {
 848         struct ofpbuf buf;
 849
 850         ofpbuf_use_stack(&buf, &state->keybuf, sizeof state->keybuf);
 851         odp_flow_key_from_flow(&buf, &flow->key);
 852
 853         *key = buf.data;
 854         *key_len = buf.size;
 855     }
 856
 857     if (actions) {
 858         free(state->actions);
 859         state->actions = xmemdup(flow->actions, flow->actions_len);
 860
 861         *actions = state->actions;
 862         *actions_len = flow->actions_len;
 863     }
 864
 865     if (stats) {
 866         get_dpif_flow_stats(flow, &state->stats);
 867         *stats = &state->stats;
 868     }
 869
 870     return 0;
 871 }
 872
 873 static int
 874 dpif_netdev_flow_dump_done(const struct dpif *dpif OVS_UNUSED, void *state_)
 875 {
 876     struct dp_netdev_flow_state *state = state_;
 877
 878     free(state->actions);
 879     free(state);
 880     return 0;
 881 }
 882
 883 static int
 884 dpif_netdev_execute(struct dpif *dpif,
 885                     const struct nlattr *key_attrs, size_t key_len,
 886                     const struct nlattr *actions, size_t actions_len,
 887                     const struct ofpbuf *packet)
 888 {
 889     struct dp_netdev *dp = get_dp_netdev(dpif);
 890     struct ofpbuf copy;
 891     struct flow key;
 892     int error;
 893
 894     if (packet->size < ETH_HEADER_LEN || packet->size > UINT16_MAX) {
 895         return EINVAL;
 896     }
 897
 898     /* Make a deep copy of 'packet', because we might modify its data. */
 899     ofpbuf_init(&copy, DP_NETDEV_HEADROOM + packet->size);
 900     ofpbuf_reserve(&copy, DP_NETDEV_HEADROOM);
 901     ofpbuf_put(&copy, packet->data, packet->size);
 902
 903     flow_extract(&copy, 0, -1, &key);
 904     error = dpif_netdev_flow_from_nlattrs(key_attrs, key_len, &key);
 905     if (!error) {
 906         error = dp_netdev_execute_actions(dp, &copy, &key,
 907                                           actions, actions_len);
 908     }
 909
 910     ofpbuf_uninit(&copy);
 911     return error;
 912 }
 913
 914 static int
 915 dpif_netdev_recv_get_mask(const struct dpif *dpif, int *listen_mask)
 916 {
 917     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
 918     *listen_mask = dpif_netdev->listen_mask;
 919     return 0;
 920 }
 921
 922 static int
 923 dpif_netdev_recv_set_mask(struct dpif *dpif, int listen_mask)
 924 {
 925     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
 926     dpif_netdev->listen_mask = listen_mask;
 927     return 0;
 928 }
 929
 930 static struct dp_netdev_queue *
 931 find_nonempty_queue(struct dpif *dpif)
 932 {
 933     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
 934     struct dp_netdev *dp = get_dp_netdev(dpif);
 935     int mask = dpif_netdev->listen_mask;
 936     int i;
 937
 938     for (i = 0; i < N_QUEUES; i++) {
 939         struct dp_netdev_queue *q = &dp->queues[i];
 940         if (q->head != q->tail && mask & (1u << i)) {
 941             return q;
 942         }
 943     }
 944     return NULL;
 945 }
 946
 947 static int
 948 dpif_netdev_recv(struct dpif *dpif, struct dpif_upcall *upcall)
 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         return 0;
 957     } else {
 958         return EAGAIN;
 959     }
 960 }
 961
 962 static void
 963 dpif_netdev_recv_wait(struct dpif *dpif)
 964 {
 965     if (find_nonempty_queue(dpif)) {
 966         poll_immediate_wake();
 967     } else {
 968         /* No messages ready to be received, and dp_wait() will ensure that we
 969          * wake up to queue new messages, so there is nothing to do. */
 970     }
 971 }
 972
 973 static void
 974 dpif_netdev_recv_purge(struct dpif *dpif)
 975 {
 976     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
 977     dp_netdev_purge_queues(dpif_netdev->dp);
 978 }
 979 \f
 980 static void
 981 dp_netdev_flow_used(struct dp_netdev_flow *flow, struct flow *key,
 982                     const struct ofpbuf *packet)
 983 {
 984     flow->used = time_msec();
 985     flow->packet_count++;
 986     flow->byte_count += packet->size;
 987     if (key->dl_type == htons(ETH_TYPE_IP) && key->nw_proto == IPPROTO_TCP) {
 988         struct tcp_header *th = packet->l4;
 989         flow->tcp_ctl |= th->tcp_ctl;
 990     }
 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     if (flow_extract(packet, 0, port->port_no, &key) && dp->drop_frags) {
1004         dp->n_frags++;
1005         return;
1006     }
1007
1008     flow = dp_netdev_lookup_flow(dp, &key);
1009     if (flow) {
1010         dp_netdev_flow_used(flow, &key, packet);
1011         dp_netdev_execute_actions(dp, packet, &key,
1012                                   flow->actions, flow->actions_len);
1013         dp->n_hit++;
1014     } else {
1015         dp->n_missed++;
1016         dp_netdev_output_userspace(dp, packet, DPIF_UC_MISS, &key, 0);
1017     }
1018 }
1019
1020 static void
1021 dpif_netdev_run(struct dpif *dpif)
1022 {
1023     struct dp_netdev *dp = get_dp_netdev(dpif);
1024     struct dp_netdev_port *port;
1025     struct ofpbuf packet;
1026
1027     ofpbuf_init(&packet, DP_NETDEV_HEADROOM + VLAN_ETH_HEADER_LEN + max_mtu);
1028
1029     LIST_FOR_EACH (port, node, &dp->port_list) {
1030         int error;
1031
1032         /* Reset packet contents. */
1033         ofpbuf_clear(&packet);
1034         ofpbuf_reserve(&packet, DP_NETDEV_HEADROOM);
1035
1036         error = netdev_recv(port->netdev, &packet);
1037         if (!error) {
1038             dp_netdev_port_input(dp, port, &packet);
1039         } else if (error != EAGAIN && error != EOPNOTSUPP) {
1040             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1041             VLOG_ERR_RL(&rl, "error receiving data from %s: %s",
1042                         netdev_get_name(port->netdev), strerror(error));
1043         }
1044     }
1045     ofpbuf_uninit(&packet);
1046 }
1047
1048 static void
1049 dpif_netdev_wait(struct dpif *dpif)
1050 {
1051     struct dp_netdev *dp = get_dp_netdev(dpif);
1052     struct dp_netdev_port *port;
1053
1054     LIST_FOR_EACH (port, node, &dp->port_list) {
1055         netdev_recv_wait(port->netdev);
1056     }
1057 }
1058
1059 static void
1060 dp_netdev_pop_vlan(struct ofpbuf *packet)
1061 {
1062     struct vlan_eth_header *veh = packet->l2;
1063     if (packet->size >= sizeof *veh
1064         && veh->veth_type == htons(ETH_TYPE_VLAN)) {
1065         struct eth_header tmp;
1066
1067         memcpy(tmp.eth_dst, veh->veth_dst, ETH_ADDR_LEN);
1068         memcpy(tmp.eth_src, veh->veth_src, ETH_ADDR_LEN);
1069         tmp.eth_type = veh->veth_next_type;
1070
1071         ofpbuf_pull(packet, VLAN_HEADER_LEN);
1072         packet->l2 = (char*)packet->l2 + VLAN_HEADER_LEN;
1073         memcpy(packet->data, &tmp, sizeof tmp);
1074     }
1075 }
1076
1077 static void
1078 dp_netdev_set_dl_src(struct ofpbuf *packet, const uint8_t dl_addr[ETH_ADDR_LEN])
1079 {
1080     struct eth_header *eh = packet->l2;
1081     memcpy(eh->eth_src, dl_addr, sizeof eh->eth_src);
1082 }
1083
1084 static void
1085 dp_netdev_set_dl_dst(struct ofpbuf *packet, const uint8_t dl_addr[ETH_ADDR_LEN])
1086 {
1087     struct eth_header *eh = packet->l2;
1088     memcpy(eh->eth_dst, dl_addr, sizeof eh->eth_dst);
1089 }
1090
1091 static bool
1092 is_ip(const struct ofpbuf *packet, const struct flow *key)
1093 {
1094     return key->dl_type == htons(ETH_TYPE_IP) && packet->l4;
1095 }
1096
1097 static void
1098 dp_netdev_set_nw_addr(struct ofpbuf *packet, const struct flow *key,
1099                       const struct nlattr *a)
1100 {
1101     if (is_ip(packet, key)) {
1102         struct ip_header *nh = packet->l3;
1103         ovs_be32 ip = nl_attr_get_be32(a);
1104         uint16_t type = nl_attr_type(a);
1105         ovs_be32 *field;
1106
1107         field = type == OVS_ACTION_ATTR_SET_NW_SRC ? &nh->ip_src : &nh->ip_dst;
1108         if (key->nw_proto == IPPROTO_TCP && packet->l7) {
1109             struct tcp_header *th = packet->l4;
1110             th->tcp_csum = recalc_csum32(th->tcp_csum, *field, ip);
1111         } else if (key->nw_proto == IPPROTO_UDP && packet->l7) {
1112             struct udp_header *uh = packet->l4;
1113             if (uh->udp_csum) {
1114                 uh->udp_csum = recalc_csum32(uh->udp_csum, *field, ip);
1115                 if (!uh->udp_csum) {
1116                     uh->udp_csum = htons(0xffff);
1117                 }
1118             }
1119         }
1120         nh->ip_csum = recalc_csum32(nh->ip_csum, *field, ip);
1121         *field = ip;
1122     }
1123 }
1124
1125 static void
1126 dp_netdev_set_nw_tos(struct ofpbuf *packet, const struct flow *key,
1127                      uint8_t nw_tos)
1128 {
1129     if (is_ip(packet, key)) {
1130         struct ip_header *nh = packet->l3;
1131         uint8_t *field = &nh->ip_tos;
1132
1133         /* Set the DSCP bits and preserve the ECN bits. */
1134         uint8_t new = nw_tos | (nh->ip_tos & IP_ECN_MASK);
1135
1136         nh->ip_csum = recalc_csum16(nh->ip_csum, htons((uint16_t)*field),
1137                 htons((uint16_t) new));
1138         *field = new;
1139     }
1140 }
1141
1142 static void
1143 dp_netdev_set_tp_port(struct ofpbuf *packet, const struct flow *key,
1144                       const struct nlattr *a)
1145 {
1146         if (is_ip(packet, key)) {
1147         uint16_t type = nl_attr_type(a);
1148         ovs_be16 port = nl_attr_get_be16(a);
1149         ovs_be16 *field;
1150
1151         if (key->nw_proto == IPPROTO_TCP && packet->l7) {
1152             struct tcp_header *th = packet->l4;
1153             field = (type == OVS_ACTION_ATTR_SET_TP_SRC
1154                      ? &th->tcp_src : &th->tcp_dst);
1155             th->tcp_csum = recalc_csum16(th->tcp_csum, *field, port);
1156             *field = port;
1157         } else if (key->nw_proto == IPPROTO_UDP && packet->l7) {
1158             struct udp_header *uh = packet->l4;
1159             field = (type == OVS_ACTION_ATTR_SET_TP_SRC
1160                      ? &uh->udp_src : &uh->udp_dst);
1161             uh->udp_csum = recalc_csum16(uh->udp_csum, *field, port);
1162             *field = port;
1163         } else {
1164             return;
1165         }
1166     }
1167 }
1168
1169 static void
1170 dp_netdev_output_port(struct dp_netdev *dp, struct ofpbuf *packet,
1171                       uint16_t out_port)
1172 {
1173     struct dp_netdev_port *p = dp->ports[out_port];
1174     if (p) {
1175         netdev_send(p->netdev, packet);
1176     }
1177 }
1178
1179 static int
1180 dp_netdev_output_userspace(struct dp_netdev *dp, const struct ofpbuf *packet,
1181                          int queue_no, const struct flow *flow, uint64_t arg)
1182 {
1183     struct dp_netdev_queue *q = &dp->queues[queue_no];
1184     struct dpif_upcall *upcall;
1185     struct ofpbuf *buf;
1186     size_t key_len;
1187
1188     if (q->head - q->tail >= MAX_QUEUE_LEN) {
1189         dp->n_lost++;
1190         return ENOBUFS;
1191     }
1192
1193     buf = ofpbuf_new(ODPUTIL_FLOW_KEY_BYTES + 2 + packet->size);
1194     odp_flow_key_from_flow(buf, flow);
1195     key_len = buf->size;
1196     ofpbuf_pull(buf, key_len);
1197     ofpbuf_reserve(buf, 2);
1198     ofpbuf_put(buf, packet->data, packet->size);
1199
1200     upcall = xzalloc(sizeof *upcall);
1201     upcall->type = queue_no;
1202     upcall->packet = buf;
1203     upcall->key = buf->base;
1204     upcall->key_len = key_len;
1205     upcall->userdata = arg;
1206
1207     q->upcalls[q->head++ & QUEUE_MASK] = upcall;
1208
1209     return 0;
1210 }
1211
1212 static int
1213 dp_netdev_execute_actions(struct dp_netdev *dp,
1214                           struct ofpbuf *packet, struct flow *key,
1215                           const struct nlattr *actions,
1216                           size_t actions_len)
1217 {
1218     const struct nlattr *a;
1219     unsigned int left;
1220
1221     NL_ATTR_FOR_EACH_UNSAFE (a, left, actions, actions_len) {
1222         switch (nl_attr_type(a)) {
1223         case OVS_ACTION_ATTR_OUTPUT:
1224             dp_netdev_output_port(dp, packet, nl_attr_get_u32(a));
1225             break;
1226
1227         case OVS_ACTION_ATTR_USERSPACE:
1228             dp_netdev_output_userspace(dp, packet, DPIF_UC_ACTION,
1229                                      key, nl_attr_get_u64(a));
1230             break;
1231
1232         case OVS_ACTION_ATTR_PUSH_VLAN:
1233             eth_push_vlan(packet, nl_attr_get_be16(a));
1234             break;
1235
1236         case OVS_ACTION_ATTR_POP_VLAN:
1237             dp_netdev_pop_vlan(packet);
1238             break;
1239
1240         case OVS_ACTION_ATTR_SET_DL_SRC:
1241             dp_netdev_set_dl_src(packet, nl_attr_get_unspec(a, ETH_ADDR_LEN));
1242             break;
1243
1244         case OVS_ACTION_ATTR_SET_DL_DST:
1245             dp_netdev_set_dl_dst(packet, nl_attr_get_unspec(a, ETH_ADDR_LEN));
1246             break;
1247
1248         case OVS_ACTION_ATTR_SET_NW_SRC:
1249         case OVS_ACTION_ATTR_SET_NW_DST:
1250             dp_netdev_set_nw_addr(packet, key, a);
1251             break;
1252
1253         case OVS_ACTION_ATTR_SET_NW_TOS:
1254             dp_netdev_set_nw_tos(packet, key, nl_attr_get_u8(a));
1255             break;
1256
1257         case OVS_ACTION_ATTR_SET_TP_SRC:
1258         case OVS_ACTION_ATTR_SET_TP_DST:
1259             dp_netdev_set_tp_port(packet, key, a);
1260             break;
1261         }
1262     }
1263     return 0;
1264 }
1265
1266 const struct dpif_class dpif_netdev_class = {
1267     "netdev",
1268     NULL,                       /* enumerate */
1269     dpif_netdev_open,
1270     dpif_netdev_close,
1271     dpif_netdev_destroy,
1272     dpif_netdev_run,
1273     dpif_netdev_wait,
1274     dpif_netdev_get_stats,
1275     dpif_netdev_get_drop_frags,
1276     dpif_netdev_set_drop_frags,
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     dpif_netdev_port_dump_start,
1283     dpif_netdev_port_dump_next,
1284     dpif_netdev_port_dump_done,
1285     dpif_netdev_port_poll,
1286     dpif_netdev_port_poll_wait,
1287     dpif_netdev_flow_get,
1288     dpif_netdev_flow_put,
1289     dpif_netdev_flow_del,
1290     dpif_netdev_flow_flush,
1291     dpif_netdev_flow_dump_start,
1292     dpif_netdev_flow_dump_next,
1293     dpif_netdev_flow_dump_done,
1294     dpif_netdev_execute,
1295     dpif_netdev_recv_get_mask,
1296     dpif_netdev_recv_set_mask,
1297     NULL,                       /* queue_to_priority */
1298     dpif_netdev_recv,
1299     dpif_netdev_recv_wait,
1300     dpif_netdev_recv_purge,
1301 };
1302
1303 void
1304 dpif_dummy_register(void)
1305 {
1306     if (!dpif_dummy_class.type) {
1307         dpif_dummy_class = dpif_netdev_class;
1308         dpif_dummy_class.type = "dummy";
1309         dp_register_provider(&dpif_dummy_class);
1310     }
1311 }