lib/dpif-netdev.c

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