lib/netdev-dummy.c

   1 /*
   2  * Copyright (c) 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
  19 #include "dummy.h"
  20
  21 #include <errno.h>
  22
  23 #include "connectivity.h"
  24 #include "flow.h"
  25 #include "list.h"
  26 #include "netdev-provider.h"
  27 #include "netdev-vport.h"
  28 #include "odp-util.h"
  29 #include "ofp-print.h"
  30 #include "ofpbuf.h"
  31 #include "packets.h"
  32 #include "pcap-file.h"
  33 #include "poll-loop.h"
  34 #include "seq.h"
  35 #include "shash.h"
  36 #include "sset.h"
  37 #include "stream.h"
  38 #include "unaligned.h"
  39 #include "timeval.h"
  40 #include "unixctl.h"
  41 #include "reconnect.h"
  42 #include "vlog.h"
  43
  44 VLOG_DEFINE_THIS_MODULE(netdev_dummy);
  45
  46 struct reconnect;
  47
  48 struct dummy_packet_stream {
  49     struct stream *stream;
  50     struct ofpbuf rxbuf;
  51     struct list txq;
  52 };
  53
  54 enum dummy_packet_conn_type {
  55     NONE,       /* No connection is configured. */
  56     PASSIVE,    /* Listener. */
  57     ACTIVE      /* Connect to listener. */
  58 };
  59
  60 struct dummy_packet_pconn {
  61     struct pstream *pstream;
  62     struct dummy_packet_stream *streams;
  63     size_t n_streams;
  64 };
  65
  66 struct dummy_packet_rconn {
  67     struct dummy_packet_stream *rstream;
  68     struct reconnect *reconnect;
  69 };
  70
  71 struct dummy_packet_conn {
  72     enum dummy_packet_conn_type type;
  73     union {
  74         struct dummy_packet_pconn pconn;
  75         struct dummy_packet_rconn rconn;
  76     } u;
  77 };
  78
  79 /* Protects 'dummy_list'. */
  80 static struct ovs_mutex dummy_list_mutex = OVS_MUTEX_INITIALIZER;
  81
  82 /* Contains all 'struct dummy_dev's. */
  83 static struct list dummy_list OVS_GUARDED_BY(dummy_list_mutex)
  84     = LIST_INITIALIZER(&dummy_list);
  85
  86 struct netdev_dummy {
  87     struct netdev up;
  88
  89     /* In dummy_list. */
  90     struct list list_node OVS_GUARDED_BY(dummy_list_mutex);
  91
  92     /* Protects all members below. */
  93     struct ovs_mutex mutex OVS_ACQ_AFTER(dummy_list_mutex);
  94
  95     uint8_t hwaddr[ETH_ADDR_LEN] OVS_GUARDED;
  96     int mtu OVS_GUARDED;
  97     struct netdev_stats stats OVS_GUARDED;
  98     enum netdev_flags flags OVS_GUARDED;
  99     int ifindex OVS_GUARDED;
 100
 101     struct dummy_packet_conn conn OVS_GUARDED;
 102
 103     FILE *tx_pcap, *rx_pcap OVS_GUARDED;
 104
 105     struct list rxes OVS_GUARDED; /* List of child "netdev_rx_dummy"s. */
 106 };
 107
 108 /* Max 'recv_queue_len' in struct netdev_dummy. */
 109 #define NETDEV_DUMMY_MAX_QUEUE 100
 110
 111 struct netdev_rx_dummy {
 112     struct netdev_rx up;
 113     struct list node;           /* In netdev_dummy's "rxes" list. */
 114     struct list recv_queue;
 115     int recv_queue_len;         /* list_size(&recv_queue). */
 116     struct seq *seq;            /* Reports newly queued packets. */
 117 };
 118
 119 static unixctl_cb_func netdev_dummy_set_admin_state;
 120 static int netdev_dummy_construct(struct netdev *);
 121 static void netdev_dummy_queue_packet(struct netdev_dummy *, struct ofpbuf *);
 122
 123 static void dummy_packet_stream_close(struct dummy_packet_stream *);
 124
 125 static bool
 126 is_dummy_class(const struct netdev_class *class)
 127 {
 128     return class->construct == netdev_dummy_construct;
 129 }
 130
 131 static struct netdev_dummy *
 132 netdev_dummy_cast(const struct netdev *netdev)
 133 {
 134     ovs_assert(is_dummy_class(netdev_get_class(netdev)));
 135     return CONTAINER_OF(netdev, struct netdev_dummy, up);
 136 }
 137
 138 static struct netdev_rx_dummy *
 139 netdev_rx_dummy_cast(const struct netdev_rx *rx)
 140 {
 141     ovs_assert(is_dummy_class(netdev_get_class(rx->netdev)));
 142     return CONTAINER_OF(rx, struct netdev_rx_dummy, up);
 143 }
 144
 145 static void
 146 dummy_packet_stream_init(struct dummy_packet_stream *s, struct stream *stream)
 147 {
 148     int rxbuf_size = stream ? 2048 : 0;
 149     s->stream = stream;
 150     ofpbuf_init(&s->rxbuf, rxbuf_size);
 151     list_init(&s->txq);
 152 }
 153
 154 static struct dummy_packet_stream *
 155 dummy_packet_stream_create(struct stream *stream)
 156 {
 157     struct dummy_packet_stream *s;
 158
 159     s = xzalloc(sizeof *s);
 160     dummy_packet_stream_init(s, stream);
 161
 162     return s;
 163 }
 164
 165 static void
 166 dummy_packet_stream_wait(struct dummy_packet_stream *s)
 167 {
 168     stream_run_wait(s->stream);
 169     if (!list_is_empty(&s->txq)) {
 170         stream_send_wait(s->stream);
 171     }
 172     stream_recv_wait(s->stream);
 173 }
 174
 175 static void
 176 dummy_packet_stream_send(struct dummy_packet_stream *s, const void *buffer, size_t size)
 177 {
 178     if (list_size(&s->txq) < NETDEV_DUMMY_MAX_QUEUE) {
 179         struct ofpbuf *b;
 180
 181         b = ofpbuf_clone_data_with_headroom(buffer, size, 2);
 182         put_unaligned_be16(ofpbuf_push_uninit(b, 2), htons(size));
 183         list_push_back(&s->txq, &b->list_node);
 184     }
 185 }
 186
 187 static int
 188 dummy_packet_stream_run(struct netdev_dummy *dev, struct dummy_packet_stream *s)
 189 {
 190     int error = 0;
 191     size_t n;
 192
 193     stream_run(s->stream);
 194
 195     if (!list_is_empty(&s->txq)) {
 196         struct ofpbuf *txbuf;
 197         int retval;
 198
 199         txbuf = ofpbuf_from_list(list_front(&s->txq));
 200         retval = stream_send(s->stream, txbuf->data, txbuf->size);
 201         if (retval > 0) {
 202             ofpbuf_pull(txbuf, retval);
 203             if (!txbuf->size) {
 204                 list_remove(&txbuf->list_node);
 205                 ofpbuf_delete(txbuf);
 206             }
 207         } else if (retval != -EAGAIN) {
 208             error = -retval;
 209         }
 210     }
 211
 212     if (!error) {
 213         if (s->rxbuf.size < 2) {
 214             n = 2 - s->rxbuf.size;
 215         } else {
 216             uint16_t frame_len;
 217
 218             frame_len = ntohs(get_unaligned_be16(s->rxbuf.data));
 219             if (frame_len < ETH_HEADER_LEN) {
 220                 error = EPROTO;
 221                 n = 0;
 222             } else {
 223                 n = (2 + frame_len) - s->rxbuf.size;
 224             }
 225         }
 226     }
 227     if (!error) {
 228         int retval;
 229
 230         ofpbuf_prealloc_tailroom(&s->rxbuf, n);
 231         retval = stream_recv(s->stream, ofpbuf_tail(&s->rxbuf), n);
 232         if (retval > 0) {
 233             s->rxbuf.size += retval;
 234             if (retval == n && s->rxbuf.size > 2) {
 235                 ofpbuf_pull(&s->rxbuf, 2);
 236                 netdev_dummy_queue_packet(dev,
 237                                           ofpbuf_clone(&s->rxbuf));
 238                 ofpbuf_clear(&s->rxbuf);
 239             }
 240         } else if (retval != -EAGAIN) {
 241             error = (retval < 0 ? -retval
 242                      : s->rxbuf.size ? EPROTO
 243                      : EOF);
 244         }
 245     }
 246
 247     return error;
 248 }
 249
 250 static void
 251 dummy_packet_stream_close(struct dummy_packet_stream *s)
 252 {
 253     stream_close(s->stream);
 254     ofpbuf_uninit(&s->rxbuf);
 255     ofpbuf_list_delete(&s->txq);
 256 }
 257
 258 static void
 259 dummy_packet_conn_init(struct dummy_packet_conn *conn)
 260 {
 261     memset(conn, 0, sizeof *conn);
 262     conn->type = NONE;
 263 }
 264
 265 static void
 266 dummy_packet_conn_get_config(struct dummy_packet_conn *conn, struct smap *args)
 267 {
 268
 269     switch (conn->type) {
 270     case PASSIVE:
 271         smap_add(args, "pstream", pstream_get_name(conn->u.pconn.pstream));
 272         break;
 273
 274     case ACTIVE:
 275         smap_add(args, "stream", stream_get_name(conn->u.rconn.rstream->stream));
 276         break;
 277
 278     case NONE:
 279     default:
 280         break;
 281     }
 282 }
 283
 284 static void
 285 dummy_packet_conn_close(struct dummy_packet_conn *conn)
 286 {
 287     int i;
 288     struct dummy_packet_pconn *pconn = &conn->u.pconn;
 289     struct dummy_packet_rconn *rconn = &conn->u.rconn;
 290
 291     switch (conn->type) {
 292     case PASSIVE:
 293         pstream_close(pconn->pstream);
 294         for (i = 0; i < pconn->n_streams; i++) {
 295             dummy_packet_stream_close(&pconn->streams[i]);
 296         }
 297         free(pconn->streams);
 298         pconn->pstream = NULL;
 299         pconn->streams = NULL;
 300         break;
 301
 302     case ACTIVE:
 303         dummy_packet_stream_close(rconn->rstream);
 304         free(rconn->rstream);
 305         rconn->rstream = NULL;
 306         reconnect_destroy(rconn->reconnect);
 307         rconn->reconnect = NULL;
 308         break;
 309
 310     case NONE:
 311     default:
 312         break;
 313     }
 314
 315     conn->type = NONE;
 316     memset(conn, 0, sizeof *conn);
 317 }
 318
 319 static void
 320 dummy_packet_conn_set_config(struct dummy_packet_conn *conn,
 321                              const struct smap *args)
 322 {
 323     const char *pstream = smap_get(args, "pstream");
 324     const char *stream = smap_get(args, "stream");
 325
 326     if (pstream && stream) {
 327          VLOG_WARN("Open failed: both %s and %s are configured",
 328                    pstream, stream);
 329          return;
 330     }
 331
 332     switch (conn->type) {
 333     case PASSIVE:
 334         if (!strcmp(pstream_get_name(conn->u.pconn.pstream), pstream)) {
 335             return;
 336         }
 337         dummy_packet_conn_close(conn);
 338         break;
 339     case ACTIVE:
 340         if (!strcmp(stream_get_name(conn->u.rconn.rstream->stream), stream)) {
 341             return;
 342         }
 343         dummy_packet_conn_close(conn);
 344         break;
 345     case NONE:
 346     default:
 347         break;
 348     }
 349
 350     if (pstream) {
 351         int error;
 352
 353         error = pstream_open(pstream, &conn->u.pconn.pstream, DSCP_DEFAULT);
 354         if (error) {
 355             VLOG_WARN("%s: open failed (%s)", pstream, ovs_strerror(error));
 356         } else {
 357             conn->type = PASSIVE;
 358         }
 359     }
 360
 361     if (stream) {
 362         int error;
 363         struct stream *active_stream;
 364         struct reconnect *reconnect;;
 365
 366         reconnect = reconnect_create(time_msec());
 367         reconnect_set_name(reconnect, stream);
 368         reconnect_set_passive(reconnect, false, time_msec());
 369         reconnect_enable(reconnect, time_msec());
 370         reconnect_set_backoff(reconnect, 1000, INT_MAX);
 371         conn->u.rconn.reconnect = reconnect;
 372
 373         error = stream_open(stream, &active_stream, DSCP_DEFAULT);
 374         conn->u.rconn.rstream = dummy_packet_stream_create(active_stream);
 375
 376         switch (error) {
 377         case 0:
 378             reconnect_connected(conn->u.rconn.reconnect, time_msec());
 379             conn->type = ACTIVE;
 380             break;
 381
 382         case EAGAIN:
 383             reconnect_connecting(conn->u.rconn.reconnect, time_msec());
 384             break;
 385
 386         default:
 387             reconnect_connecting(conn->u.rconn.reconnect, time_msec());
 388             stream_close(active_stream);
 389             break;
 390         }
 391     }
 392 }
 393
 394 static void
 395 dummy_pconn_run(struct netdev_dummy *dev)
 396     OVS_REQUIRES(dev->mutex)
 397 {
 398     struct stream *new_stream;
 399     struct dummy_packet_pconn *pconn = &dev->conn.u.pconn;
 400     int error;
 401     size_t i;
 402
 403     error = pstream_accept(pconn->pstream, &new_stream);
 404     if (!error) {
 405         struct dummy_packet_stream *s;
 406
 407         pconn->streams = xrealloc(pconn->streams,
 408                                 ((pconn->n_streams + 1)
 409                                  * sizeof *s));
 410         s = &pconn->streams[pconn->n_streams++];
 411         dummy_packet_stream_init(s, new_stream);
 412     } else if (error != EAGAIN) {
 413         VLOG_WARN("%s: accept failed (%s)",
 414                   pstream_get_name(pconn->pstream), ovs_strerror(error));
 415         pstream_close(pconn->pstream);
 416         pconn->pstream = NULL;
 417         dev->conn.type = NONE;
 418     }
 419
 420     for (i = 0; i < pconn->n_streams; i++) {
 421         struct dummy_packet_stream *s = &pconn->streams[i];
 422
 423         error = dummy_packet_stream_run(dev, s);
 424         if (error) {
 425             VLOG_DBG("%s: closing connection (%s)",
 426                      stream_get_name(s->stream),
 427                      ovs_retval_to_string(error));
 428             dummy_packet_stream_close(s);
 429             pconn->streams[i] = pconn->streams[--pconn->n_streams];
 430         }
 431     }
 432 }
 433
 434 static void
 435 dummy_rconn_run(struct netdev_dummy *dev)
 436 OVS_REQUIRES(dev->mutex)
 437 {
 438     struct dummy_packet_rconn *rconn = &dev->conn.u.rconn;
 439
 440     switch (reconnect_run(rconn->reconnect, time_msec())) {
 441     case RECONNECT_CONNECT:
 442         {
 443             int err = stream_connect(rconn->rstream->stream);
 444
 445             switch (err) {
 446             case 0: /* Connected. */
 447                 reconnect_connected(rconn->reconnect, time_msec());
 448                 dev->conn.type = ACTIVE;
 449                 break;
 450
 451             case EAGAIN:
 452                 reconnect_connecting(rconn->reconnect, time_msec());
 453                 return;
 454
 455             default:
 456                 reconnect_connect_failed(rconn->reconnect, time_msec(), err);
 457                 stream_close(rconn->rstream->stream);
 458                 return;
 459             }
 460         }
 461         break;
 462
 463     case RECONNECT_DISCONNECT:
 464     case RECONNECT_PROBE:
 465     default:
 466         break;
 467     }
 468
 469     if (reconnect_is_connected(rconn->reconnect)) {
 470         int err;
 471
 472         err = dummy_packet_stream_run(dev, rconn->rstream);
 473
 474         if (err) {
 475             reconnect_disconnected(rconn->reconnect, time_msec(), err);
 476             stream_close(rconn->rstream->stream);
 477         }
 478     }
 479 }
 480
 481 static void
 482 dummy_packet_conn_run(struct netdev_dummy *dev)
 483     OVS_REQUIRES(dev->mutex)
 484 {
 485     switch (dev->conn.type) {
 486     case PASSIVE:
 487         dummy_pconn_run(dev);
 488         break;
 489
 490     case ACTIVE:
 491         dummy_rconn_run(dev);
 492         break;
 493
 494     case NONE:
 495     default:
 496         break;
 497     }
 498 }
 499
 500 static void
 501 dummy_packet_conn_wait(struct dummy_packet_conn *conn)
 502 {
 503     int i;
 504     switch (conn->type) {
 505     case PASSIVE:
 506         pstream_wait(conn->u.pconn.pstream);
 507         for (i = 0; i < conn->u.pconn.n_streams; i++) {
 508             struct dummy_packet_stream *s = &conn->u.pconn.streams[i];
 509             dummy_packet_stream_wait(s);
 510         }
 511         break;
 512     case ACTIVE:
 513         dummy_packet_stream_wait(conn->u.rconn.rstream);
 514         break;
 515
 516     case NONE:
 517     default:
 518         break;
 519     }
 520 }
 521
 522 static void
 523 dummy_packet_conn_send(struct dummy_packet_conn *conn,
 524                        const void *buffer, size_t size)
 525 {
 526     int i;
 527
 528     switch (conn->type) {
 529     case PASSIVE:
 530         for (i = 0; i < conn->u.pconn.n_streams; i++) {
 531             struct dummy_packet_stream *s = &conn->u.pconn.streams[i];
 532
 533             dummy_packet_stream_send(s, buffer, size);
 534             pstream_wait(conn->u.pconn.pstream);
 535         }
 536         break;
 537
 538     case ACTIVE:
 539         dummy_packet_stream_send(conn->u.rconn.rstream, buffer, size);
 540         dummy_packet_stream_wait(conn->u.rconn.rstream);
 541         break;
 542
 543     case NONE:
 544     default:
 545         break;
 546     }
 547 }
 548
 549 static void
 550 netdev_dummy_run(void)
 551 {
 552     struct netdev_dummy *dev;
 553
 554     ovs_mutex_lock(&dummy_list_mutex);
 555     LIST_FOR_EACH (dev, list_node, &dummy_list) {
 556         ovs_mutex_lock(&dev->mutex);
 557         dummy_packet_conn_run(dev);
 558         ovs_mutex_unlock(&dev->mutex);
 559     }
 560     ovs_mutex_unlock(&dummy_list_mutex);
 561 }
 562
 563 static void
 564 netdev_dummy_wait(void)
 565 {
 566     struct netdev_dummy *dev;
 567
 568     ovs_mutex_lock(&dummy_list_mutex);
 569     LIST_FOR_EACH (dev, list_node, &dummy_list) {
 570         ovs_mutex_lock(&dev->mutex);
 571         dummy_packet_conn_wait(&dev->conn);
 572         ovs_mutex_unlock(&dev->mutex);
 573     }
 574     ovs_mutex_unlock(&dummy_list_mutex);
 575 }
 576
 577 static struct netdev *
 578 netdev_dummy_alloc(void)
 579 {
 580     struct netdev_dummy *netdev = xzalloc(sizeof *netdev);
 581     return &netdev->up;
 582 }
 583
 584 static int
 585 netdev_dummy_construct(struct netdev *netdev_)
 586 {
 587     static atomic_uint next_n = ATOMIC_VAR_INIT(0xaa550000);
 588     struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
 589     unsigned int n;
 590
 591     atomic_add(&next_n, 1, &n);
 592
 593     ovs_mutex_init(&netdev->mutex);
 594     ovs_mutex_lock(&netdev->mutex);
 595     netdev->hwaddr[0] = 0xaa;
 596     netdev->hwaddr[1] = 0x55;
 597     netdev->hwaddr[2] = n >> 24;
 598     netdev->hwaddr[3] = n >> 16;
 599     netdev->hwaddr[4] = n >> 8;
 600     netdev->hwaddr[5] = n;
 601     netdev->mtu = 1500;
 602     netdev->flags = 0;
 603     netdev->ifindex = -EOPNOTSUPP;
 604
 605     dummy_packet_conn_init(&netdev->conn);
 606
 607     list_init(&netdev->rxes);
 608     ovs_mutex_unlock(&netdev->mutex);
 609
 610     ovs_mutex_lock(&dummy_list_mutex);
 611     list_push_back(&dummy_list, &netdev->list_node);
 612     ovs_mutex_unlock(&dummy_list_mutex);
 613
 614     return 0;
 615 }
 616
 617 static void
 618 netdev_dummy_destruct(struct netdev *netdev_)
 619 {
 620     struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
 621
 622     ovs_mutex_lock(&dummy_list_mutex);
 623     list_remove(&netdev->list_node);
 624     ovs_mutex_unlock(&dummy_list_mutex);
 625
 626     ovs_mutex_lock(&netdev->mutex);
 627     dummy_packet_conn_close(&netdev->conn);
 628     netdev->conn.type = NONE;
 629
 630     ovs_mutex_unlock(&netdev->mutex);
 631     ovs_mutex_destroy(&netdev->mutex);
 632 }
 633
 634 static void
 635 netdev_dummy_dealloc(struct netdev *netdev_)
 636 {
 637     struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
 638
 639     free(netdev);
 640 }
 641
 642 static int
 643 netdev_dummy_get_config(const struct netdev *netdev_, struct smap *args)
 644 {
 645     struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
 646
 647     ovs_mutex_lock(&netdev->mutex);
 648
 649     if (netdev->ifindex >= 0) {
 650         smap_add_format(args, "ifindex", "%d", netdev->ifindex);
 651     }
 652
 653     dummy_packet_conn_get_config(&netdev->conn, args);
 654
 655     ovs_mutex_unlock(&netdev->mutex);
 656     return 0;
 657 }
 658
 659 static int
 660 netdev_dummy_set_config(struct netdev *netdev_, const struct smap *args)
 661 {
 662     struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
 663     const char *pcap;
 664
 665     ovs_mutex_lock(&netdev->mutex);
 666     netdev->ifindex = smap_get_int(args, "ifindex", -EOPNOTSUPP);
 667
 668     dummy_packet_conn_set_config(&netdev->conn, args);
 669
 670     if (netdev->rx_pcap) {
 671         fclose(netdev->rx_pcap);
 672     }
 673     if (netdev->tx_pcap && netdev->tx_pcap != netdev->rx_pcap) {
 674         fclose(netdev->tx_pcap);
 675     }
 676     netdev->rx_pcap = netdev->tx_pcap = NULL;
 677     pcap = smap_get(args, "pcap");
 678     if (pcap) {
 679         netdev->rx_pcap = netdev->tx_pcap = ovs_pcap_open(pcap, "ab");
 680     } else {
 681         const char *rx_pcap = smap_get(args, "rx_pcap");
 682         const char *tx_pcap = smap_get(args, "tx_pcap");
 683
 684         if (rx_pcap) {
 685             netdev->rx_pcap = ovs_pcap_open(rx_pcap, "ab");
 686         }
 687         if (tx_pcap) {
 688             netdev->tx_pcap = ovs_pcap_open(tx_pcap, "ab");
 689         }
 690     }
 691
 692     ovs_mutex_unlock(&netdev->mutex);
 693
 694     return 0;
 695 }
 696
 697 static struct netdev_rx *
 698 netdev_dummy_rx_alloc(void)
 699 {
 700     struct netdev_rx_dummy *rx = xzalloc(sizeof *rx);
 701     return &rx->up;
 702 }
 703
 704 static int
 705 netdev_dummy_rx_construct(struct netdev_rx *rx_)
 706 {
 707     struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
 708     struct netdev_dummy *netdev = netdev_dummy_cast(rx->up.netdev);
 709
 710     ovs_mutex_lock(&netdev->mutex);
 711     list_push_back(&netdev->rxes, &rx->node);
 712     list_init(&rx->recv_queue);
 713     rx->recv_queue_len = 0;
 714     rx->seq = seq_create();
 715     ovs_mutex_unlock(&netdev->mutex);
 716
 717     return 0;
 718 }
 719
 720 static void
 721 netdev_dummy_rx_destruct(struct netdev_rx *rx_)
 722 {
 723     struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
 724     struct netdev_dummy *netdev = netdev_dummy_cast(rx->up.netdev);
 725
 726     ovs_mutex_lock(&netdev->mutex);
 727     list_remove(&rx->node);
 728     ofpbuf_list_delete(&rx->recv_queue);
 729     ovs_mutex_unlock(&netdev->mutex);
 730     seq_destroy(rx->seq);
 731 }
 732
 733 static void
 734 netdev_dummy_rx_dealloc(struct netdev_rx *rx_)
 735 {
 736     struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
 737
 738     free(rx);
 739 }
 740
 741 static int
 742 netdev_dummy_rx_recv(struct netdev_rx *rx_, struct ofpbuf *buffer)
 743 {
 744     struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
 745     struct netdev_dummy *netdev = netdev_dummy_cast(rx->up.netdev);
 746     struct ofpbuf *packet;
 747     int retval;
 748
 749     ovs_mutex_lock(&netdev->mutex);
 750     if (!list_is_empty(&rx->recv_queue)) {
 751         packet = ofpbuf_from_list(list_pop_front(&rx->recv_queue));
 752         rx->recv_queue_len--;
 753     } else {
 754         packet = NULL;
 755     }
 756     ovs_mutex_unlock(&netdev->mutex);
 757
 758     if (!packet) {
 759         return EAGAIN;
 760     }
 761
 762     if (packet->size <= ofpbuf_tailroom(buffer)) {
 763         memcpy(buffer->data, packet->data, packet->size);
 764         buffer->size += packet->size;
 765         retval = 0;
 766
 767         ovs_mutex_lock(&netdev->mutex);
 768         netdev->stats.rx_packets++;
 769         netdev->stats.rx_bytes += packet->size;
 770         ovs_mutex_unlock(&netdev->mutex);
 771     } else {
 772         retval = EMSGSIZE;
 773     }
 774     ofpbuf_delete(packet);
 775
 776     return retval;
 777 }
 778
 779 static void
 780 netdev_dummy_rx_wait(struct netdev_rx *rx_)
 781 {
 782     struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
 783     struct netdev_dummy *netdev = netdev_dummy_cast(rx->up.netdev);
 784     uint64_t seq = seq_read(rx->seq);
 785
 786     ovs_mutex_lock(&netdev->mutex);
 787     if (!list_is_empty(&rx->recv_queue)) {
 788         poll_immediate_wake();
 789     } else {
 790         seq_wait(rx->seq, seq);
 791     }
 792     ovs_mutex_unlock(&netdev->mutex);
 793 }
 794
 795 static int
 796 netdev_dummy_rx_drain(struct netdev_rx *rx_)
 797 {
 798     struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
 799     struct netdev_dummy *netdev = netdev_dummy_cast(rx->up.netdev);
 800
 801     ovs_mutex_lock(&netdev->mutex);
 802     ofpbuf_list_delete(&rx->recv_queue);
 803     rx->recv_queue_len = 0;
 804     ovs_mutex_unlock(&netdev->mutex);
 805
 806     seq_change(rx->seq);
 807
 808     return 0;
 809 }
 810
 811 static int
 812 netdev_dummy_send(struct netdev *netdev, const void *buffer, size_t size)
 813 {
 814     struct netdev_dummy *dev = netdev_dummy_cast(netdev);
 815
 816     if (size < ETH_HEADER_LEN) {
 817         return EMSGSIZE;
 818     } else {
 819         const struct eth_header *eth = buffer;
 820         int max_size;
 821
 822         ovs_mutex_lock(&dev->mutex);
 823         max_size = dev->mtu + ETH_HEADER_LEN;
 824         ovs_mutex_unlock(&dev->mutex);
 825
 826         if (eth->eth_type == htons(ETH_TYPE_VLAN)) {
 827             max_size += VLAN_HEADER_LEN;
 828         }
 829         if (size > max_size) {
 830             return EMSGSIZE;
 831         }
 832     }
 833
 834     ovs_mutex_lock(&dev->mutex);
 835     dev->stats.tx_packets++;
 836     dev->stats.tx_bytes += size;
 837
 838     dummy_packet_conn_send(&dev->conn, buffer, size);
 839
 840     if (dev->tx_pcap) {
 841         struct ofpbuf packet;
 842
 843         ofpbuf_use_const(&packet, buffer, size);
 844         ovs_pcap_write(dev->tx_pcap, &packet);
 845         fflush(dev->tx_pcap);
 846     }
 847
 848     ovs_mutex_unlock(&dev->mutex);
 849
 850     return 0;
 851 }
 852
 853 static int
 854 netdev_dummy_set_etheraddr(struct netdev *netdev,
 855                            const uint8_t mac[ETH_ADDR_LEN])
 856 {
 857     struct netdev_dummy *dev = netdev_dummy_cast(netdev);
 858
 859     ovs_mutex_lock(&dev->mutex);
 860     if (!eth_addr_equals(dev->hwaddr, mac)) {
 861         memcpy(dev->hwaddr, mac, ETH_ADDR_LEN);
 862         seq_change(connectivity_seq_get());
 863     }
 864     ovs_mutex_unlock(&dev->mutex);
 865
 866     return 0;
 867 }
 868
 869 static int
 870 netdev_dummy_get_etheraddr(const struct netdev *netdev,
 871                            uint8_t mac[ETH_ADDR_LEN])
 872 {
 873     struct netdev_dummy *dev = netdev_dummy_cast(netdev);
 874
 875     ovs_mutex_lock(&dev->mutex);
 876     memcpy(mac, dev->hwaddr, ETH_ADDR_LEN);
 877     ovs_mutex_unlock(&dev->mutex);
 878
 879     return 0;
 880 }
 881
 882 static int
 883 netdev_dummy_get_mtu(const struct netdev *netdev, int *mtup)
 884 {
 885     struct netdev_dummy *dev = netdev_dummy_cast(netdev);
 886
 887     ovs_mutex_lock(&dev->mutex);
 888     *mtup = dev->mtu;
 889     ovs_mutex_unlock(&dev->mutex);
 890
 891     return 0;
 892 }
 893
 894 static int
 895 netdev_dummy_set_mtu(const struct netdev *netdev, int mtu)
 896 {
 897     struct netdev_dummy *dev = netdev_dummy_cast(netdev);
 898
 899     ovs_mutex_lock(&dev->mutex);
 900     dev->mtu = mtu;
 901     ovs_mutex_unlock(&dev->mutex);
 902
 903     return 0;
 904 }
 905
 906 static int
 907 netdev_dummy_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
 908 {
 909     struct netdev_dummy *dev = netdev_dummy_cast(netdev);
 910
 911     ovs_mutex_lock(&dev->mutex);
 912     *stats = dev->stats;
 913     ovs_mutex_unlock(&dev->mutex);
 914
 915     return 0;
 916 }
 917
 918 static int
 919 netdev_dummy_set_stats(struct netdev *netdev, const struct netdev_stats *stats)
 920 {
 921     struct netdev_dummy *dev = netdev_dummy_cast(netdev);
 922
 923     ovs_mutex_lock(&dev->mutex);
 924     dev->stats = *stats;
 925     ovs_mutex_unlock(&dev->mutex);
 926
 927     return 0;
 928 }
 929
 930 static int
 931 netdev_dummy_get_ifindex(const struct netdev *netdev)
 932 {
 933     struct netdev_dummy *dev = netdev_dummy_cast(netdev);
 934     int ifindex;
 935
 936     ovs_mutex_lock(&dev->mutex);
 937     ifindex = dev->ifindex;
 938     ovs_mutex_unlock(&dev->mutex);
 939
 940     return ifindex;
 941 }
 942
 943 static int
 944 netdev_dummy_update_flags__(struct netdev_dummy *netdev,
 945                             enum netdev_flags off, enum netdev_flags on,
 946                             enum netdev_flags *old_flagsp)
 947     OVS_REQUIRES(netdev->mutex)
 948 {
 949     if ((off | on) & ~(NETDEV_UP | NETDEV_PROMISC)) {
 950         return EINVAL;
 951     }
 952
 953     *old_flagsp = netdev->flags;
 954     netdev->flags |= on;
 955     netdev->flags &= ~off;
 956     if (*old_flagsp != netdev->flags) {
 957         seq_change(connectivity_seq_get());
 958     }
 959
 960     return 0;
 961 }
 962
 963 static int
 964 netdev_dummy_update_flags(struct netdev *netdev_,
 965                           enum netdev_flags off, enum netdev_flags on,
 966                           enum netdev_flags *old_flagsp)
 967 {
 968     struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
 969     int error;
 970
 971     ovs_mutex_lock(&netdev->mutex);
 972     error = netdev_dummy_update_flags__(netdev, off, on, old_flagsp);
 973     ovs_mutex_unlock(&netdev->mutex);
 974
 975     return error;
 976 }
 977 \f
 978 /* Helper functions. */
 979
 980 static const struct netdev_class dummy_class = {
 981     "dummy",
 982     NULL,                       /* init */
 983     netdev_dummy_run,
 984     netdev_dummy_wait,
 985
 986     netdev_dummy_alloc,
 987     netdev_dummy_construct,
 988     netdev_dummy_destruct,
 989     netdev_dummy_dealloc,
 990     netdev_dummy_get_config,
 991     netdev_dummy_set_config,
 992     NULL,                       /* get_tunnel_config */
 993
 994     netdev_dummy_send,          /* send */
 995     NULL,                       /* send_wait */
 996
 997     netdev_dummy_set_etheraddr,
 998     netdev_dummy_get_etheraddr,
 999     netdev_dummy_get_mtu,
1000     netdev_dummy_set_mtu,
1001     netdev_dummy_get_ifindex,
1002     NULL,                       /* get_carrier */
1003     NULL,                       /* get_carrier_resets */
1004     NULL,                       /* get_miimon */
1005     netdev_dummy_get_stats,
1006     netdev_dummy_set_stats,
1007
1008     NULL,                       /* get_features */
1009     NULL,                       /* set_advertisements */
1010
1011     NULL,                       /* set_policing */
1012     NULL,                       /* get_qos_types */
1013     NULL,                       /* get_qos_capabilities */
1014     NULL,                       /* get_qos */
1015     NULL,                       /* set_qos */
1016     NULL,                       /* get_queue */
1017     NULL,                       /* set_queue */
1018     NULL,                       /* delete_queue */
1019     NULL,                       /* get_queue_stats */
1020     NULL,                       /* queue_dump_start */
1021     NULL,                       /* queue_dump_next */
1022     NULL,                       /* queue_dump_done */
1023     NULL,                       /* dump_queue_stats */
1024
1025     NULL,                       /* get_in4 */
1026     NULL,                       /* set_in4 */
1027     NULL,                       /* get_in6 */
1028     NULL,                       /* add_router */
1029     NULL,                       /* get_next_hop */
1030     NULL,                       /* get_status */
1031     NULL,                       /* arp_lookup */
1032
1033     netdev_dummy_update_flags,
1034
1035     netdev_dummy_rx_alloc,
1036     netdev_dummy_rx_construct,
1037     netdev_dummy_rx_destruct,
1038     netdev_dummy_rx_dealloc,
1039     netdev_dummy_rx_recv,
1040     netdev_dummy_rx_wait,
1041     netdev_dummy_rx_drain,
1042 };
1043
1044 static struct ofpbuf *
1045 eth_from_packet_or_flow(const char *s)
1046 {
1047     enum odp_key_fitness fitness;
1048     struct ofpbuf *packet;
1049     struct ofpbuf odp_key;
1050     struct flow flow;
1051     int error;
1052
1053     if (!eth_from_hex(s, &packet)) {
1054         return packet;
1055     }
1056
1057     /* Convert string to datapath key.
1058      *
1059      * It would actually be nicer to parse an OpenFlow-like flow key here, but
1060      * the code for that currently calls exit() on parse error.  We have to
1061      * settle for parsing a datapath key for now.
1062      */
1063     ofpbuf_init(&odp_key, 0);
1064     error = odp_flow_from_string(s, NULL, &odp_key, NULL);
1065     if (error) {
1066         ofpbuf_uninit(&odp_key);
1067         return NULL;
1068     }
1069
1070     /* Convert odp_key to flow. */
1071     fitness = odp_flow_key_to_flow(odp_key.data, odp_key.size, &flow);
1072     if (fitness == ODP_FIT_ERROR) {
1073         ofpbuf_uninit(&odp_key);
1074         return NULL;
1075     }
1076
1077     packet = ofpbuf_new(0);
1078     flow_compose(packet, &flow);
1079
1080     ofpbuf_uninit(&odp_key);
1081     return packet;
1082 }
1083
1084 static void
1085 netdev_dummy_queue_packet__(struct netdev_rx_dummy *rx, struct ofpbuf *packet)
1086 {
1087     list_push_back(&rx->recv_queue, &packet->list_node);
1088     rx->recv_queue_len++;
1089     seq_change(rx->seq);
1090 }
1091
1092 static void
1093 netdev_dummy_queue_packet(struct netdev_dummy *dummy, struct ofpbuf *packet)
1094     OVS_REQUIRES(dummy->mutex)
1095 {
1096     struct netdev_rx_dummy *rx, *prev;
1097
1098     if (dummy->rx_pcap) {
1099         ovs_pcap_write(dummy->rx_pcap, packet);
1100         fflush(dummy->rx_pcap);
1101     }
1102     prev = NULL;
1103     LIST_FOR_EACH (rx, node, &dummy->rxes) {
1104         if (rx->recv_queue_len < NETDEV_DUMMY_MAX_QUEUE) {
1105             if (prev) {
1106                 netdev_dummy_queue_packet__(prev, ofpbuf_clone(packet));
1107             }
1108             prev = rx;
1109         }
1110     }
1111     if (prev) {
1112         netdev_dummy_queue_packet__(prev, packet);
1113     } else {
1114         ofpbuf_delete(packet);
1115     }
1116 }
1117
1118 static void
1119 netdev_dummy_receive(struct unixctl_conn *conn,
1120                      int argc, const char *argv[], void *aux OVS_UNUSED)
1121 {
1122     struct netdev_dummy *dummy_dev;
1123     struct netdev *netdev;
1124     int i;
1125
1126     netdev = netdev_from_name(argv[1]);
1127     if (!netdev || !is_dummy_class(netdev->netdev_class)) {
1128         unixctl_command_reply_error(conn, "no such dummy netdev");
1129         goto exit;
1130     }
1131     dummy_dev = netdev_dummy_cast(netdev);
1132
1133     for (i = 2; i < argc; i++) {
1134         struct ofpbuf *packet;
1135
1136         packet = eth_from_packet_or_flow(argv[i]);
1137         if (!packet) {
1138             unixctl_command_reply_error(conn, "bad packet syntax");
1139             goto exit;
1140         }
1141
1142         ovs_mutex_lock(&dummy_dev->mutex);
1143         netdev_dummy_queue_packet(dummy_dev, packet);
1144         ovs_mutex_unlock(&dummy_dev->mutex);
1145     }
1146
1147     unixctl_command_reply(conn, NULL);
1148
1149 exit:
1150     netdev_close(netdev);
1151 }
1152
1153 static void
1154 netdev_dummy_set_admin_state__(struct netdev_dummy *dev, bool admin_state)
1155     OVS_REQUIRES(dev->mutex)
1156 {
1157     enum netdev_flags old_flags;
1158
1159     if (admin_state) {
1160         netdev_dummy_update_flags__(dev, 0, NETDEV_UP, &old_flags);
1161     } else {
1162         netdev_dummy_update_flags__(dev, NETDEV_UP, 0, &old_flags);
1163     }
1164 }
1165
1166 static void
1167 netdev_dummy_set_admin_state(struct unixctl_conn *conn, int argc,
1168                              const char *argv[], void *aux OVS_UNUSED)
1169 {
1170     bool up;
1171
1172     if (!strcasecmp(argv[argc - 1], "up")) {
1173         up = true;
1174     } else if ( !strcasecmp(argv[argc - 1], "down")) {
1175         up = false;
1176     } else {
1177         unixctl_command_reply_error(conn, "Invalid Admin State");
1178         return;
1179     }
1180
1181     if (argc > 2) {
1182         struct netdev *netdev = netdev_from_name(argv[1]);
1183         if (netdev && is_dummy_class(netdev->netdev_class)) {
1184             struct netdev_dummy *dummy_dev = netdev_dummy_cast(netdev);
1185
1186             ovs_mutex_lock(&dummy_dev->mutex);
1187             netdev_dummy_set_admin_state__(dummy_dev, up);
1188             ovs_mutex_unlock(&dummy_dev->mutex);
1189
1190             netdev_close(netdev);
1191         } else {
1192             unixctl_command_reply_error(conn, "Unknown Dummy Interface");
1193             netdev_close(netdev);
1194             return;
1195         }
1196     } else {
1197         struct netdev_dummy *netdev;
1198
1199         ovs_mutex_lock(&dummy_list_mutex);
1200         LIST_FOR_EACH (netdev, list_node, &dummy_list) {
1201             ovs_mutex_lock(&netdev->mutex);
1202             netdev_dummy_set_admin_state__(netdev, up);
1203             ovs_mutex_unlock(&netdev->mutex);
1204         }
1205         ovs_mutex_unlock(&dummy_list_mutex);
1206     }
1207     unixctl_command_reply(conn, "OK");
1208 }
1209
1210 void
1211 netdev_dummy_register(bool override)
1212 {
1213     unixctl_command_register("netdev-dummy/receive", "NAME PACKET|FLOW...",
1214                              2, INT_MAX, netdev_dummy_receive, NULL);
1215     unixctl_command_register("netdev-dummy/set-admin-state",
1216                              "[netdev] up|down", 1, 2,
1217                              netdev_dummy_set_admin_state, NULL);
1218
1219     if (override) {
1220         struct sset types;
1221         const char *type;
1222
1223         sset_init(&types);
1224         netdev_enumerate_types(&types);
1225         SSET_FOR_EACH (type, &types) {
1226             if (!strcmp(type, "patch")) {
1227                 continue;
1228             }
1229             if (!netdev_unregister_provider(type)) {
1230                 struct netdev_class *class;
1231                 int error;
1232
1233                 class = xmemdup(&dummy_class, sizeof dummy_class);
1234                 class->type = xstrdup(type);
1235                 error = netdev_register_provider(class);
1236                 if (error) {
1237                     VLOG_ERR("%s: failed to register netdev provider (%s)",
1238                              type, ovs_strerror(error));
1239                     free(CONST_CAST(char *, class->type));
1240                     free(class);
1241                 }
1242             }
1243         }
1244         sset_destroy(&types);
1245     }
1246     netdev_register_provider(&dummy_class);
1247
1248     netdev_vport_tunnel_register();
1249 }