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