2 * Copyright (c) 2010, 2011, 2012, 2013 Nicira, Inc.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
25 #include "netdev-provider.h"
26 #include "netdev-vport.h"
28 #include "ofp-print.h"
31 #include "poll-loop.h"
35 #include "unaligned.h"
39 VLOG_DEFINE_THIS_MODULE(netdev_dummy);
42 struct stream *stream;
47 /* Protects 'dummy_list'. */
48 static struct ovs_mutex dummy_list_mutex = OVS_MUTEX_INITIALIZER;
50 /* Contains all 'struct dummy_dev's. */
51 static struct list dummy_list OVS_GUARDED_BY(dummy_list_mutex)
52 = LIST_INITIALIZER(&dummy_list);
58 struct list list_node OVS_GUARDED_BY(dummy_list_mutex);
60 /* Protects all members below. */
61 struct ovs_mutex mutex OVS_ACQ_AFTER(dummy_list_mutex);
63 uint8_t hwaddr[ETH_ADDR_LEN];
65 struct netdev_stats stats;
66 enum netdev_flags flags;
67 unsigned int change_seq;
70 struct pstream *pstream;
71 struct dummy_stream *streams;
74 struct list rxes; /* List of child "netdev_rx_dummy"s. */
77 /* Max 'recv_queue_len' in struct netdev_dummy. */
78 #define NETDEV_DUMMY_MAX_QUEUE 100
80 struct netdev_rx_dummy {
82 struct list node; /* In netdev_dummy's "rxes" list. */
83 struct list recv_queue;
84 int recv_queue_len; /* list_size(&recv_queue). */
88 static unixctl_cb_func netdev_dummy_set_admin_state;
89 static int netdev_dummy_construct(struct netdev *);
90 static void netdev_dummy_poll_notify(struct netdev_dummy *netdev)
91 OVS_REQUIRES(netdev->mutex);
92 static void netdev_dummy_queue_packet(struct netdev_dummy *, struct ofpbuf *);
94 static void dummy_stream_close(struct dummy_stream *);
97 is_dummy_class(const struct netdev_class *class)
99 return class->construct == netdev_dummy_construct;
102 static struct netdev_dummy *
103 netdev_dummy_cast(const struct netdev *netdev)
105 ovs_assert(is_dummy_class(netdev_get_class(netdev)));
106 return CONTAINER_OF(netdev, struct netdev_dummy, up);
109 static struct netdev_rx_dummy *
110 netdev_rx_dummy_cast(const struct netdev_rx *rx)
112 ovs_assert(is_dummy_class(netdev_get_class(rx->netdev)));
113 return CONTAINER_OF(rx, struct netdev_rx_dummy, up);
117 netdev_dummy_run(void)
119 struct netdev_dummy *dev;
121 ovs_mutex_lock(&dummy_list_mutex);
122 LIST_FOR_EACH (dev, list_node, &dummy_list) {
125 ovs_mutex_lock(&dev->mutex);
128 struct stream *new_stream;
131 error = pstream_accept(dev->pstream, &new_stream);
133 struct dummy_stream *s;
135 dev->streams = xrealloc(dev->streams,
136 ((dev->n_streams + 1)
137 * sizeof *dev->streams));
138 s = &dev->streams[dev->n_streams++];
139 s->stream = new_stream;
140 ofpbuf_init(&s->rxbuf, 2048);
142 } else if (error != EAGAIN) {
143 VLOG_WARN("%s: accept failed (%s)",
144 pstream_get_name(dev->pstream), ovs_strerror(error));
145 pstream_close(dev->pstream);
150 for (i = 0; i < dev->n_streams; i++) {
151 struct dummy_stream *s = &dev->streams[i];
155 stream_run(s->stream);
157 if (!list_is_empty(&s->txq)) {
158 struct ofpbuf *txbuf;
161 txbuf = ofpbuf_from_list(list_front(&s->txq));
162 retval = stream_send(s->stream, txbuf->data, txbuf->size);
164 ofpbuf_pull(txbuf, retval);
166 list_remove(&txbuf->list_node);
167 ofpbuf_delete(txbuf);
169 } else if (retval != -EAGAIN) {
175 if (s->rxbuf.size < 2) {
176 n = 2 - s->rxbuf.size;
180 frame_len = ntohs(get_unaligned_be16(s->rxbuf.data));
181 if (frame_len < ETH_HEADER_LEN) {
185 n = (2 + frame_len) - s->rxbuf.size;
192 ofpbuf_prealloc_tailroom(&s->rxbuf, n);
193 retval = stream_recv(s->stream, ofpbuf_tail(&s->rxbuf), n);
195 s->rxbuf.size += retval;
196 if (retval == n && s->rxbuf.size > 2) {
197 ofpbuf_pull(&s->rxbuf, 2);
198 netdev_dummy_queue_packet(dev,
199 ofpbuf_clone(&s->rxbuf));
200 ofpbuf_clear(&s->rxbuf);
202 } else if (retval != -EAGAIN) {
203 error = (retval < 0 ? -retval
204 : s->rxbuf.size ? EPROTO
210 VLOG_DBG("%s: closing connection (%s)",
211 stream_get_name(s->stream),
212 ovs_retval_to_string(error));
213 dummy_stream_close(&dev->streams[i]);
214 dev->streams[i] = dev->streams[--dev->n_streams];
218 ovs_mutex_unlock(&dev->mutex);
220 ovs_mutex_unlock(&dummy_list_mutex);
224 dummy_stream_close(struct dummy_stream *s)
226 stream_close(s->stream);
227 ofpbuf_uninit(&s->rxbuf);
228 ofpbuf_list_delete(&s->txq);
232 netdev_dummy_wait(void)
234 struct netdev_dummy *dev;
236 ovs_mutex_lock(&dummy_list_mutex);
237 LIST_FOR_EACH (dev, list_node, &dummy_list) {
240 ovs_mutex_lock(&dev->mutex);
242 pstream_wait(dev->pstream);
244 for (i = 0; i < dev->n_streams; i++) {
245 struct dummy_stream *s = &dev->streams[i];
247 stream_run_wait(s->stream);
248 if (!list_is_empty(&s->txq)) {
249 stream_send_wait(s->stream);
251 stream_recv_wait(s->stream);
253 ovs_mutex_unlock(&dev->mutex);
255 ovs_mutex_unlock(&dummy_list_mutex);
258 static struct netdev *
259 netdev_dummy_alloc(void)
261 struct netdev_dummy *netdev = xzalloc(sizeof *netdev);
266 netdev_dummy_construct(struct netdev *netdev_)
268 static atomic_uint next_n = ATOMIC_VAR_INIT(0xaa550000);
269 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
272 atomic_add(&next_n, 1, &n);
274 ovs_mutex_init(&netdev->mutex, PTHREAD_MUTEX_NORMAL);
275 netdev->hwaddr[0] = 0xaa;
276 netdev->hwaddr[1] = 0x55;
277 netdev->hwaddr[2] = n >> 24;
278 netdev->hwaddr[3] = n >> 16;
279 netdev->hwaddr[4] = n >> 8;
280 netdev->hwaddr[5] = n;
283 netdev->change_seq = 1;
284 netdev->ifindex = -EOPNOTSUPP;
286 netdev->pstream = NULL;
287 netdev->streams = NULL;
288 netdev->n_streams = 0;
290 list_init(&netdev->rxes);
292 ovs_mutex_lock(&dummy_list_mutex);
293 list_push_back(&dummy_list, &netdev->list_node);
294 ovs_mutex_unlock(&dummy_list_mutex);
300 netdev_dummy_destruct(struct netdev *netdev_)
302 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
305 ovs_mutex_lock(&dummy_list_mutex);
306 list_remove(&netdev->list_node);
307 ovs_mutex_unlock(&dummy_list_mutex);
309 pstream_close(netdev->pstream);
310 for (i = 0; i < netdev->n_streams; i++) {
311 dummy_stream_close(&netdev->streams[i]);
313 free(netdev->streams);
314 ovs_mutex_destroy(&netdev->mutex);
318 netdev_dummy_dealloc(struct netdev *netdev_)
320 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
326 netdev_dummy_get_config(const struct netdev *netdev_, struct smap *args)
328 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
330 if (netdev->ifindex >= 0) {
331 smap_add_format(args, "ifindex", "%d", netdev->ifindex);
333 if (netdev->pstream) {
334 smap_add(args, "pstream", pstream_get_name(netdev->pstream));
340 netdev_dummy_set_config(struct netdev *netdev_, const struct smap *args)
342 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
345 ovs_mutex_lock(&netdev->mutex);
346 netdev->ifindex = smap_get_int(args, "ifindex", -EOPNOTSUPP);
348 pstream = smap_get(args, "pstream");
351 || strcmp(pstream_get_name(netdev->pstream), pstream)) {
352 pstream_close(netdev->pstream);
353 netdev->pstream = NULL;
358 error = pstream_open(pstream, &netdev->pstream, DSCP_DEFAULT);
360 VLOG_WARN("%s: open failed (%s)",
361 pstream, ovs_strerror(error));
365 ovs_mutex_unlock(&netdev->mutex);
370 static struct netdev_rx *
371 netdev_dummy_rx_alloc(void)
373 struct netdev_rx_dummy *rx = xzalloc(sizeof *rx);
378 netdev_dummy_rx_construct(struct netdev_rx *rx_)
380 struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
381 struct netdev_dummy *netdev = netdev_dummy_cast(rx->up.netdev);
383 ovs_mutex_lock(&netdev->mutex);
384 list_push_back(&netdev->rxes, &rx->node);
385 list_init(&rx->recv_queue);
386 rx->recv_queue_len = 0;
387 ovs_mutex_unlock(&netdev->mutex);
393 netdev_dummy_rx_destruct(struct netdev_rx *rx_)
395 struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
396 struct netdev_dummy *netdev = netdev_dummy_cast(rx->up.netdev);
398 ovs_mutex_lock(&netdev->mutex);
399 list_remove(&rx->node);
400 ofpbuf_list_delete(&rx->recv_queue);
401 ovs_mutex_unlock(&netdev->mutex);
405 netdev_dummy_rx_dealloc(struct netdev_rx *rx_)
407 struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
413 netdev_dummy_rx_recv(struct netdev_rx *rx_, void *buffer, size_t size)
415 struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
416 struct netdev_dummy *netdev = netdev_dummy_cast(rx->up.netdev);
417 struct ofpbuf *packet;
420 ovs_mutex_lock(&netdev->mutex);
421 if (!list_is_empty(&rx->recv_queue)) {
422 packet = ofpbuf_from_list(list_pop_front(&rx->recv_queue));
423 rx->recv_queue_len--;
427 ovs_mutex_unlock(&netdev->mutex);
433 if (packet->size <= size) {
434 memcpy(buffer, packet->data, packet->size);
435 retval = packet->size;
439 ofpbuf_delete(packet);
445 netdev_dummy_rx_wait(struct netdev_rx *rx_)
447 struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
448 struct netdev_dummy *netdev = netdev_dummy_cast(rx->up.netdev);
450 ovs_mutex_lock(&netdev->mutex);
451 if (!list_is_empty(&rx->recv_queue)) {
452 poll_immediate_wake();
454 ovs_mutex_unlock(&netdev->mutex);
458 netdev_dummy_rx_drain(struct netdev_rx *rx_)
460 struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
461 struct netdev_dummy *netdev = netdev_dummy_cast(rx->up.netdev);
463 ovs_mutex_lock(&netdev->mutex);
464 ofpbuf_list_delete(&rx->recv_queue);
465 rx->recv_queue_len = 0;
466 ovs_mutex_unlock(&netdev->mutex);
472 netdev_dummy_send(struct netdev *netdev, const void *buffer, size_t size)
474 struct netdev_dummy *dev = netdev_dummy_cast(netdev);
477 if (size < ETH_HEADER_LEN) {
480 const struct eth_header *eth = buffer;
483 max_size = dev->mtu + ETH_HEADER_LEN;
484 if (eth->eth_type == htons(ETH_TYPE_VLAN)) {
485 max_size += VLAN_HEADER_LEN;
487 if (size > max_size) {
492 ovs_mutex_lock(&dev->mutex);
493 dev->stats.tx_packets++;
494 dev->stats.tx_bytes += size;
496 for (i = 0; i < dev->n_streams; i++) {
497 struct dummy_stream *s = &dev->streams[i];
499 if (list_size(&s->txq) < NETDEV_DUMMY_MAX_QUEUE) {
502 b = ofpbuf_clone_data_with_headroom(buffer, size, 2);
503 put_unaligned_be16(ofpbuf_push_uninit(b, 2), htons(size));
504 list_push_back(&s->txq, &b->list_node);
507 ovs_mutex_unlock(&dev->mutex);
513 netdev_dummy_set_etheraddr(struct netdev *netdev,
514 const uint8_t mac[ETH_ADDR_LEN])
516 struct netdev_dummy *dev = netdev_dummy_cast(netdev);
518 ovs_mutex_lock(&dev->mutex);
519 if (!eth_addr_equals(dev->hwaddr, mac)) {
520 memcpy(dev->hwaddr, mac, ETH_ADDR_LEN);
521 netdev_dummy_poll_notify(dev);
523 ovs_mutex_unlock(&dev->mutex);
529 netdev_dummy_get_etheraddr(const struct netdev *netdev,
530 uint8_t mac[ETH_ADDR_LEN])
532 struct netdev_dummy *dev = netdev_dummy_cast(netdev);
534 ovs_mutex_lock(&dev->mutex);
535 memcpy(mac, dev->hwaddr, ETH_ADDR_LEN);
536 ovs_mutex_unlock(&dev->mutex);
542 netdev_dummy_get_mtu(const struct netdev *netdev, int *mtup)
544 struct netdev_dummy *dev = netdev_dummy_cast(netdev);
546 ovs_mutex_lock(&dev->mutex);
548 ovs_mutex_unlock(&dev->mutex);
554 netdev_dummy_set_mtu(const struct netdev *netdev, int mtu)
556 struct netdev_dummy *dev = netdev_dummy_cast(netdev);
558 ovs_mutex_lock(&dev->mutex);
560 ovs_mutex_unlock(&dev->mutex);
566 netdev_dummy_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
568 struct netdev_dummy *dev = netdev_dummy_cast(netdev);
570 ovs_mutex_lock(&dev->mutex);
572 ovs_mutex_unlock(&dev->mutex);
578 netdev_dummy_set_stats(struct netdev *netdev, const struct netdev_stats *stats)
580 struct netdev_dummy *dev = netdev_dummy_cast(netdev);
582 ovs_mutex_lock(&dev->mutex);
584 ovs_mutex_unlock(&dev->mutex);
590 netdev_dummy_get_ifindex(const struct netdev *netdev)
592 struct netdev_dummy *dev = netdev_dummy_cast(netdev);
595 ovs_mutex_lock(&dev->mutex);
596 ifindex = dev->ifindex;
597 ovs_mutex_unlock(&dev->mutex);
603 netdev_dummy_update_flags__(struct netdev_dummy *netdev,
604 enum netdev_flags off, enum netdev_flags on,
605 enum netdev_flags *old_flagsp)
606 OVS_REQUIRES(netdev->mutex)
608 if ((off | on) & ~(NETDEV_UP | NETDEV_PROMISC)) {
612 *old_flagsp = netdev->flags;
614 netdev->flags &= ~off;
615 if (*old_flagsp != netdev->flags) {
616 netdev_dummy_poll_notify(netdev);
623 netdev_dummy_update_flags(struct netdev *netdev_,
624 enum netdev_flags off, enum netdev_flags on,
625 enum netdev_flags *old_flagsp)
627 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
630 ovs_mutex_lock(&netdev->mutex);
631 error = netdev_dummy_update_flags__(netdev, off, on, old_flagsp);
632 ovs_mutex_unlock(&netdev->mutex);
638 netdev_dummy_change_seq(const struct netdev *netdev_)
640 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
641 unsigned int change_seq;
643 ovs_mutex_lock(&netdev->mutex);
644 change_seq = netdev->change_seq;
645 ovs_mutex_unlock(&netdev->mutex);
650 /* Helper functions. */
653 netdev_dummy_poll_notify(struct netdev_dummy *dev)
656 if (!dev->change_seq) {
661 static const struct netdev_class dummy_class = {
668 netdev_dummy_construct,
669 netdev_dummy_destruct,
670 netdev_dummy_dealloc,
671 netdev_dummy_get_config,
672 netdev_dummy_set_config,
673 NULL, /* get_tunnel_config */
675 netdev_dummy_send, /* send */
676 NULL, /* send_wait */
678 netdev_dummy_set_etheraddr,
679 netdev_dummy_get_etheraddr,
680 netdev_dummy_get_mtu,
681 netdev_dummy_set_mtu,
682 netdev_dummy_get_ifindex,
683 NULL, /* get_carrier */
684 NULL, /* get_carrier_resets */
685 NULL, /* get_miimon */
686 netdev_dummy_get_stats,
687 netdev_dummy_set_stats,
689 NULL, /* get_features */
690 NULL, /* set_advertisements */
692 NULL, /* set_policing */
693 NULL, /* get_qos_types */
694 NULL, /* get_qos_capabilities */
697 NULL, /* get_queue */
698 NULL, /* set_queue */
699 NULL, /* delete_queue */
700 NULL, /* get_queue_stats */
701 NULL, /* dump_queues */
702 NULL, /* dump_queue_stats */
707 NULL, /* add_router */
708 NULL, /* get_next_hop */
709 NULL, /* get_status */
710 NULL, /* arp_lookup */
712 netdev_dummy_update_flags,
714 netdev_dummy_change_seq,
716 netdev_dummy_rx_alloc,
717 netdev_dummy_rx_construct,
718 netdev_dummy_rx_destruct,
719 netdev_dummy_rx_dealloc,
720 netdev_dummy_rx_recv,
721 netdev_dummy_rx_wait,
722 netdev_dummy_rx_drain,
725 static struct ofpbuf *
726 eth_from_packet_or_flow(const char *s)
728 enum odp_key_fitness fitness;
729 struct ofpbuf *packet;
730 struct ofpbuf odp_key;
734 if (!eth_from_hex(s, &packet)) {
738 /* Convert string to datapath key.
740 * It would actually be nicer to parse an OpenFlow-like flow key here, but
741 * the code for that currently calls exit() on parse error. We have to
742 * settle for parsing a datapath key for now.
744 ofpbuf_init(&odp_key, 0);
745 error = odp_flow_from_string(s, NULL, &odp_key, NULL);
747 ofpbuf_uninit(&odp_key);
751 /* Convert odp_key to flow. */
752 fitness = odp_flow_key_to_flow(odp_key.data, odp_key.size, &flow);
753 if (fitness == ODP_FIT_ERROR) {
754 ofpbuf_uninit(&odp_key);
758 packet = ofpbuf_new(0);
759 flow_compose(packet, &flow);
761 ofpbuf_uninit(&odp_key);
766 netdev_dummy_queue_packet__(struct netdev_rx_dummy *rx, struct ofpbuf *packet)
768 list_push_back(&rx->recv_queue, &packet->list_node);
769 rx->recv_queue_len++;
773 netdev_dummy_queue_packet(struct netdev_dummy *dummy, struct ofpbuf *packet)
775 struct netdev_rx_dummy *rx, *prev;
778 LIST_FOR_EACH (rx, node, &dummy->rxes) {
779 if (rx->recv_queue_len < NETDEV_DUMMY_MAX_QUEUE) {
781 netdev_dummy_queue_packet__(prev, ofpbuf_clone(packet));
787 netdev_dummy_queue_packet__(prev, packet);
789 ofpbuf_delete(packet);
794 netdev_dummy_receive(struct unixctl_conn *conn,
795 int argc, const char *argv[], void *aux OVS_UNUSED)
797 struct netdev_dummy *dummy_dev;
798 struct netdev *netdev;
801 netdev = netdev_from_name(argv[1]);
802 if (!netdev || !is_dummy_class(netdev->netdev_class)) {
803 unixctl_command_reply_error(conn, "no such dummy netdev");
806 dummy_dev = netdev_dummy_cast(netdev);
808 for (i = 2; i < argc; i++) {
809 struct ofpbuf *packet;
811 packet = eth_from_packet_or_flow(argv[i]);
813 unixctl_command_reply_error(conn, "bad packet syntax");
817 ovs_mutex_lock(&dummy_dev->mutex);
818 dummy_dev->stats.rx_packets++;
819 dummy_dev->stats.rx_bytes += packet->size;
820 netdev_dummy_queue_packet(dummy_dev, packet);
821 ovs_mutex_unlock(&dummy_dev->mutex);
824 unixctl_command_reply(conn, NULL);
827 netdev_close(netdev);
831 netdev_dummy_set_admin_state__(struct netdev_dummy *dev, bool admin_state)
832 OVS_REQUIRES(dev->mutex)
834 enum netdev_flags old_flags;
837 netdev_dummy_update_flags__(dev, 0, NETDEV_UP, &old_flags);
839 netdev_dummy_update_flags__(dev, NETDEV_UP, 0, &old_flags);
844 netdev_dummy_set_admin_state(struct unixctl_conn *conn, int argc,
845 const char *argv[], void *aux OVS_UNUSED)
849 if (!strcasecmp(argv[argc - 1], "up")) {
851 } else if ( !strcasecmp(argv[argc - 1], "down")) {
854 unixctl_command_reply_error(conn, "Invalid Admin State");
859 struct netdev *netdev = netdev_from_name(argv[1]);
860 if (netdev && is_dummy_class(netdev->netdev_class)) {
861 struct netdev_dummy *dummy_dev = netdev_dummy_cast(netdev);
863 ovs_mutex_lock(&dummy_dev->mutex);
864 netdev_dummy_set_admin_state__(dummy_dev, up);
865 ovs_mutex_unlock(&dummy_dev->mutex);
867 netdev_close(netdev);
869 unixctl_command_reply_error(conn, "Unknown Dummy Interface");
870 netdev_close(netdev);
874 struct netdev_dummy *netdev;
876 ovs_mutex_lock(&dummy_list_mutex);
877 LIST_FOR_EACH (netdev, list_node, &dummy_list) {
878 ovs_mutex_lock(&netdev->mutex);
879 netdev_dummy_set_admin_state__(netdev, up);
880 ovs_mutex_unlock(&netdev->mutex);
882 ovs_mutex_unlock(&dummy_list_mutex);
884 unixctl_command_reply(conn, "OK");
888 netdev_dummy_register(bool override)
890 unixctl_command_register("netdev-dummy/receive", "NAME PACKET|FLOW...",
891 2, INT_MAX, netdev_dummy_receive, NULL);
892 unixctl_command_register("netdev-dummy/set-admin-state",
893 "[netdev] up|down", 1, 2,
894 netdev_dummy_set_admin_state, NULL);
901 netdev_enumerate_types(&types);
902 SSET_FOR_EACH (type, &types) {
903 if (!netdev_unregister_provider(type)) {
904 struct netdev_class *class;
907 class = xmemdup(&dummy_class, sizeof dummy_class);
908 class->type = xstrdup(type);
909 error = netdev_register_provider(class);
911 VLOG_ERR("%s: failed to register netdev provider (%s)",
912 type, ovs_strerror(error));
913 free(CONST_CAST(char *, class->type));
918 sset_destroy(&types);
920 netdev_register_provider(&dummy_class);
922 netdev_vport_tunnel_register();