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;
49 uint8_t hwaddr[ETH_ADDR_LEN];
51 struct netdev_stats stats;
52 enum netdev_flags flags;
53 unsigned int change_seq;
56 struct pstream *pstream;
57 struct dummy_stream *streams;
60 struct list rxes; /* List of child "netdev_rx_dummy"s. */
63 /* Max 'recv_queue_len' in struct netdev_dummy. */
64 #define NETDEV_DUMMY_MAX_QUEUE 100
66 struct netdev_rx_dummy {
68 struct list node; /* In netdev_dummy's "rxes" list. */
69 struct list recv_queue;
70 int recv_queue_len; /* list_size(&recv_queue). */
74 static struct shash dummy_netdevs = SHASH_INITIALIZER(&dummy_netdevs);
76 static const struct netdev_rx_class netdev_rx_dummy_class;
78 static unixctl_cb_func netdev_dummy_set_admin_state;
79 static int netdev_dummy_create(const struct netdev_class *, const char *,
81 static void netdev_dummy_poll_notify(struct netdev_dummy *);
82 static void netdev_dummy_queue_packet(struct netdev_dummy *, struct ofpbuf *);
84 static void dummy_stream_close(struct dummy_stream *);
87 is_dummy_class(const struct netdev_class *class)
89 return class->create == netdev_dummy_create;
92 static struct netdev_dummy *
93 netdev_dummy_cast(const struct netdev *netdev)
95 ovs_assert(is_dummy_class(netdev_get_class(netdev)));
96 return CONTAINER_OF(netdev, struct netdev_dummy, up);
99 static struct netdev_rx_dummy *
100 netdev_rx_dummy_cast(const struct netdev_rx *rx)
102 netdev_rx_assert_class(rx, &netdev_rx_dummy_class);
103 return CONTAINER_OF(rx, struct netdev_rx_dummy, up);
107 netdev_dummy_run(void)
109 struct shash_node *node;
111 SHASH_FOR_EACH (node, &dummy_netdevs) {
112 struct netdev_dummy *dev = node->data;
116 struct stream *new_stream;
119 error = pstream_accept(dev->pstream, &new_stream);
121 struct dummy_stream *s;
123 dev->streams = xrealloc(dev->streams,
124 ((dev->n_streams + 1)
125 * sizeof *dev->streams));
126 s = &dev->streams[dev->n_streams++];
127 s->stream = new_stream;
128 ofpbuf_init(&s->rxbuf, 2048);
130 } else if (error != EAGAIN) {
131 VLOG_WARN("%s: accept failed (%s)",
132 pstream_get_name(dev->pstream), ovs_strerror(error));
133 pstream_close(dev->pstream);
138 for (i = 0; i < dev->n_streams; i++) {
139 struct dummy_stream *s = &dev->streams[i];
143 stream_run(s->stream);
145 if (!list_is_empty(&s->txq)) {
146 struct ofpbuf *txbuf;
149 txbuf = ofpbuf_from_list(list_front(&s->txq));
150 retval = stream_send(s->stream, txbuf->data, txbuf->size);
152 ofpbuf_pull(txbuf, retval);
154 list_remove(&txbuf->list_node);
155 ofpbuf_delete(txbuf);
157 } else if (retval != -EAGAIN) {
163 if (s->rxbuf.size < 2) {
164 n = 2 - s->rxbuf.size;
168 frame_len = ntohs(get_unaligned_be16(s->rxbuf.data));
169 if (frame_len < ETH_HEADER_LEN) {
173 n = (2 + frame_len) - s->rxbuf.size;
180 ofpbuf_prealloc_tailroom(&s->rxbuf, n);
181 retval = stream_recv(s->stream, ofpbuf_tail(&s->rxbuf), n);
183 s->rxbuf.size += retval;
184 if (retval == n && s->rxbuf.size > 2) {
185 ofpbuf_pull(&s->rxbuf, 2);
186 netdev_dummy_queue_packet(dev,
187 ofpbuf_clone(&s->rxbuf));
188 ofpbuf_clear(&s->rxbuf);
190 } else if (retval != -EAGAIN) {
191 error = (retval < 0 ? -retval
192 : s->rxbuf.size ? EPROTO
198 VLOG_DBG("%s: closing connection (%s)",
199 stream_get_name(s->stream),
200 ovs_retval_to_string(error));
201 dummy_stream_close(&dev->streams[i]);
202 dev->streams[i] = dev->streams[--dev->n_streams];
209 dummy_stream_close(struct dummy_stream *s)
211 stream_close(s->stream);
212 ofpbuf_uninit(&s->rxbuf);
213 ofpbuf_list_delete(&s->txq);
217 netdev_dummy_wait(void)
219 struct shash_node *node;
221 SHASH_FOR_EACH (node, &dummy_netdevs) {
222 struct netdev_dummy *dev = node->data;
226 pstream_wait(dev->pstream);
228 for (i = 0; i < dev->n_streams; i++) {
229 struct dummy_stream *s = &dev->streams[i];
231 stream_run_wait(s->stream);
232 if (!list_is_empty(&s->txq)) {
233 stream_send_wait(s->stream);
235 stream_recv_wait(s->stream);
241 netdev_dummy_create(const struct netdev_class *class, const char *name,
242 struct netdev **netdevp)
244 static unsigned int next_n = 0xaa550000;
245 static pthread_mutex_t mutex = PTHREAD_ADAPTIVE_MUTEX_INITIALIZER;
247 struct netdev_dummy *netdev;
250 xpthread_mutex_lock(&mutex);
252 xpthread_mutex_unlock(&mutex);
254 netdev = xzalloc(sizeof *netdev);
255 netdev_init(&netdev->up, name, class);
256 netdev->hwaddr[0] = 0xaa;
257 netdev->hwaddr[1] = 0x55;
258 netdev->hwaddr[2] = n >> 24;
259 netdev->hwaddr[3] = n >> 16;
260 netdev->hwaddr[4] = n >> 8;
261 netdev->hwaddr[5] = n;
264 netdev->change_seq = 1;
265 netdev->ifindex = -EOPNOTSUPP;
267 netdev->pstream = NULL;
268 netdev->streams = NULL;
269 netdev->n_streams = 0;
271 list_init(&netdev->rxes);
273 shash_add(&dummy_netdevs, name, netdev);
275 *netdevp = &netdev->up;
281 netdev_dummy_destroy(struct netdev *netdev_)
283 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
286 shash_find_and_delete(&dummy_netdevs,
287 netdev_get_name(netdev_));
288 pstream_close(netdev->pstream);
289 for (i = 0; i < netdev->n_streams; i++) {
290 dummy_stream_close(&netdev->streams[i]);
292 free(netdev->streams);
297 netdev_dummy_get_config(const struct netdev *netdev_, struct smap *args)
299 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
301 if (netdev->ifindex >= 0) {
302 smap_add_format(args, "ifindex", "%d", netdev->ifindex);
304 if (netdev->pstream) {
305 smap_add(args, "pstream", pstream_get_name(netdev->pstream));
311 netdev_dummy_set_config(struct netdev *netdev_, const struct smap *args)
313 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
316 netdev->ifindex = smap_get_int(args, "ifindex", -EOPNOTSUPP);
318 pstream = smap_get(args, "pstream");
321 || strcmp(pstream_get_name(netdev->pstream), pstream)) {
322 pstream_close(netdev->pstream);
323 netdev->pstream = NULL;
328 error = pstream_open(pstream, &netdev->pstream, DSCP_DEFAULT);
330 VLOG_WARN("%s: open failed (%s)",
331 pstream, ovs_strerror(error));
339 netdev_dummy_rx_open(struct netdev *netdev_, struct netdev_rx **rxp)
341 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
342 struct netdev_rx_dummy *rx;
344 rx = xmalloc(sizeof *rx);
345 netdev_rx_init(&rx->up, &netdev->up, &netdev_rx_dummy_class);
346 list_push_back(&netdev->rxes, &rx->node);
347 list_init(&rx->recv_queue);
348 rx->recv_queue_len = 0;
355 netdev_rx_dummy_recv(struct netdev_rx *rx_, void *buffer, size_t size)
357 struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
358 struct ofpbuf *packet;
361 if (list_is_empty(&rx->recv_queue)) {
365 packet = ofpbuf_from_list(list_pop_front(&rx->recv_queue));
366 rx->recv_queue_len--;
367 if (packet->size > size) {
370 packet_size = packet->size;
372 memcpy(buffer, packet->data, packet->size);
373 ofpbuf_delete(packet);
379 netdev_rx_dummy_destroy(struct netdev_rx *rx_)
381 struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
382 list_remove(&rx->node);
383 ofpbuf_list_delete(&rx->recv_queue);
388 netdev_rx_dummy_wait(struct netdev_rx *rx_)
390 struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
391 if (!list_is_empty(&rx->recv_queue)) {
392 poll_immediate_wake();
397 netdev_rx_dummy_drain(struct netdev_rx *rx_)
399 struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
400 ofpbuf_list_delete(&rx->recv_queue);
401 rx->recv_queue_len = 0;
406 netdev_dummy_send(struct netdev *netdev, const void *buffer, size_t size)
408 struct netdev_dummy *dev = netdev_dummy_cast(netdev);
411 if (size < ETH_HEADER_LEN) {
414 const struct eth_header *eth = buffer;
417 max_size = dev->mtu + ETH_HEADER_LEN;
418 if (eth->eth_type == htons(ETH_TYPE_VLAN)) {
419 max_size += VLAN_HEADER_LEN;
421 if (size > max_size) {
426 dev->stats.tx_packets++;
427 dev->stats.tx_bytes += size;
429 for (i = 0; i < dev->n_streams; i++) {
430 struct dummy_stream *s = &dev->streams[i];
432 if (list_size(&s->txq) < NETDEV_DUMMY_MAX_QUEUE) {
435 b = ofpbuf_clone_data_with_headroom(buffer, size, 2);
436 put_unaligned_be16(ofpbuf_push_uninit(b, 2), htons(size));
437 list_push_back(&s->txq, &b->list_node);
445 netdev_dummy_set_etheraddr(struct netdev *netdev,
446 const uint8_t mac[ETH_ADDR_LEN])
448 struct netdev_dummy *dev = netdev_dummy_cast(netdev);
450 if (!eth_addr_equals(dev->hwaddr, mac)) {
451 memcpy(dev->hwaddr, mac, ETH_ADDR_LEN);
452 netdev_dummy_poll_notify(dev);
459 netdev_dummy_get_etheraddr(const struct netdev *netdev,
460 uint8_t mac[ETH_ADDR_LEN])
462 const struct netdev_dummy *dev = netdev_dummy_cast(netdev);
464 memcpy(mac, dev->hwaddr, ETH_ADDR_LEN);
469 netdev_dummy_get_mtu(const struct netdev *netdev, int *mtup)
471 const struct netdev_dummy *dev = netdev_dummy_cast(netdev);
478 netdev_dummy_set_mtu(const struct netdev *netdev, int mtu)
480 struct netdev_dummy *dev = netdev_dummy_cast(netdev);
487 netdev_dummy_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
489 const struct netdev_dummy *dev = netdev_dummy_cast(netdev);
496 netdev_dummy_set_stats(struct netdev *netdev, const struct netdev_stats *stats)
498 struct netdev_dummy *dev = netdev_dummy_cast(netdev);
505 netdev_dummy_get_ifindex(const struct netdev *netdev)
507 struct netdev_dummy *dev = netdev_dummy_cast(netdev);
513 netdev_dummy_update_flags(struct netdev *netdev_,
514 enum netdev_flags off, enum netdev_flags on,
515 enum netdev_flags *old_flagsp)
517 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
519 if ((off | on) & ~(NETDEV_UP | NETDEV_PROMISC)) {
523 *old_flagsp = netdev->flags;
525 netdev->flags &= ~off;
526 if (*old_flagsp != netdev->flags) {
527 netdev_dummy_poll_notify(netdev);
533 netdev_dummy_change_seq(const struct netdev *netdev)
535 return netdev_dummy_cast(netdev)->change_seq;
538 /* Helper functions. */
541 netdev_dummy_poll_notify(struct netdev_dummy *dev)
544 if (!dev->change_seq) {
549 static const struct netdev_class dummy_class = {
556 netdev_dummy_destroy,
557 netdev_dummy_get_config,
558 netdev_dummy_set_config,
559 NULL, /* get_tunnel_config */
561 netdev_dummy_rx_open,
563 netdev_dummy_send, /* send */
564 NULL, /* send_wait */
566 netdev_dummy_set_etheraddr,
567 netdev_dummy_get_etheraddr,
568 netdev_dummy_get_mtu,
569 netdev_dummy_set_mtu,
570 netdev_dummy_get_ifindex,
571 NULL, /* get_carrier */
572 NULL, /* get_carrier_resets */
573 NULL, /* get_miimon */
574 netdev_dummy_get_stats,
575 netdev_dummy_set_stats,
577 NULL, /* get_features */
578 NULL, /* set_advertisements */
580 NULL, /* set_policing */
581 NULL, /* get_qos_types */
582 NULL, /* get_qos_capabilities */
585 NULL, /* get_queue */
586 NULL, /* set_queue */
587 NULL, /* delete_queue */
588 NULL, /* get_queue_stats */
589 NULL, /* dump_queues */
590 NULL, /* dump_queue_stats */
595 NULL, /* add_router */
596 NULL, /* get_next_hop */
597 NULL, /* get_status */
598 NULL, /* arp_lookup */
600 netdev_dummy_update_flags,
602 netdev_dummy_change_seq
605 static const struct netdev_rx_class netdev_rx_dummy_class = {
606 netdev_rx_dummy_destroy,
607 netdev_rx_dummy_recv,
608 netdev_rx_dummy_wait,
609 netdev_rx_dummy_drain,
612 static struct ofpbuf *
613 eth_from_packet_or_flow(const char *s)
615 enum odp_key_fitness fitness;
616 struct ofpbuf *packet;
617 struct ofpbuf odp_key;
621 if (!eth_from_hex(s, &packet)) {
625 /* Convert string to datapath key.
627 * It would actually be nicer to parse an OpenFlow-like flow key here, but
628 * the code for that currently calls exit() on parse error. We have to
629 * settle for parsing a datapath key for now.
631 ofpbuf_init(&odp_key, 0);
632 error = odp_flow_from_string(s, NULL, &odp_key, NULL);
634 ofpbuf_uninit(&odp_key);
638 /* Convert odp_key to flow. */
639 fitness = odp_flow_key_to_flow(odp_key.data, odp_key.size, &flow);
640 if (fitness == ODP_FIT_ERROR) {
641 ofpbuf_uninit(&odp_key);
645 packet = ofpbuf_new(0);
646 flow_compose(packet, &flow);
648 ofpbuf_uninit(&odp_key);
653 netdev_dummy_queue_packet__(struct netdev_rx_dummy *rx, struct ofpbuf *packet)
655 list_push_back(&rx->recv_queue, &packet->list_node);
656 rx->recv_queue_len++;
660 netdev_dummy_queue_packet(struct netdev_dummy *dummy, struct ofpbuf *packet)
662 struct netdev_rx_dummy *rx, *prev;
665 LIST_FOR_EACH (rx, node, &dummy->rxes) {
666 if (rx->recv_queue_len < NETDEV_DUMMY_MAX_QUEUE) {
668 netdev_dummy_queue_packet__(prev, ofpbuf_clone(packet));
674 netdev_dummy_queue_packet__(prev, packet);
676 ofpbuf_delete(packet);
681 netdev_dummy_receive(struct unixctl_conn *conn,
682 int argc, const char *argv[], void *aux OVS_UNUSED)
684 struct netdev_dummy *dummy_dev;
687 dummy_dev = shash_find_data(&dummy_netdevs, argv[1]);
689 unixctl_command_reply_error(conn, "no such dummy netdev");
693 for (i = 2; i < argc; i++) {
694 struct ofpbuf *packet;
696 packet = eth_from_packet_or_flow(argv[i]);
698 unixctl_command_reply_error(conn, "bad packet syntax");
702 dummy_dev->stats.rx_packets++;
703 dummy_dev->stats.rx_bytes += packet->size;
705 netdev_dummy_queue_packet(dummy_dev, packet);
708 unixctl_command_reply(conn, NULL);
712 netdev_dummy_set_admin_state__(struct netdev_dummy *dev, bool admin_state)
714 enum netdev_flags old_flags;
717 netdev_dummy_update_flags(&dev->up, 0, NETDEV_UP, &old_flags);
719 netdev_dummy_update_flags(&dev->up, NETDEV_UP, 0, &old_flags);
724 netdev_dummy_set_admin_state(struct unixctl_conn *conn, int argc,
725 const char *argv[], void *aux OVS_UNUSED)
729 if (!strcasecmp(argv[argc - 1], "up")) {
731 } else if ( !strcasecmp(argv[argc - 1], "down")) {
734 unixctl_command_reply_error(conn, "Invalid Admin State");
739 struct netdev_dummy *dummy_dev;
741 dummy_dev = shash_find_data(&dummy_netdevs, argv[1]);
743 netdev_dummy_set_admin_state__(dummy_dev, up);
745 unixctl_command_reply_error(conn, "Unknown Dummy Interface");
749 struct shash_node *node;
751 SHASH_FOR_EACH (node, &dummy_netdevs) {
752 netdev_dummy_set_admin_state__(node->data, up);
755 unixctl_command_reply(conn, "OK");
759 netdev_dummy_register(bool override)
761 unixctl_command_register("netdev-dummy/receive", "NAME PACKET|FLOW...",
762 2, INT_MAX, netdev_dummy_receive, NULL);
763 unixctl_command_register("netdev-dummy/set-admin-state",
764 "[netdev] up|down", 1, 2,
765 netdev_dummy_set_admin_state, NULL);
772 netdev_enumerate_types(&types);
773 SSET_FOR_EACH (type, &types) {
774 if (!netdev_unregister_provider(type)) {
775 struct netdev_class *class;
777 class = xmalloc(sizeof *class);
778 *class = dummy_class;
779 class->type = xstrdup(type);
780 netdev_register_provider(class);
783 sset_destroy(&types);
785 netdev_register_provider(&dummy_class);
787 netdev_vport_tunnel_register();