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 static const struct netdev_class dummy_class;
65 /* Max 'recv_queue_len' in struct netdev_dummy. */
66 #define NETDEV_DUMMY_MAX_QUEUE 100
68 struct netdev_rx_dummy {
70 struct list node; /* In netdev_dummy's "rxes" list. */
71 struct list recv_queue;
72 int recv_queue_len; /* list_size(&recv_queue). */
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 dummy_netdevs;
110 struct shash_node *node;
112 shash_init(&dummy_netdevs);
113 netdev_get_devices(&dummy_class, &dummy_netdevs);
114 SHASH_FOR_EACH (node, &dummy_netdevs) {
115 struct netdev_dummy *dev = node->data;
119 struct stream *new_stream;
122 error = pstream_accept(dev->pstream, &new_stream);
124 struct dummy_stream *s;
126 dev->streams = xrealloc(dev->streams,
127 ((dev->n_streams + 1)
128 * sizeof *dev->streams));
129 s = &dev->streams[dev->n_streams++];
130 s->stream = new_stream;
131 ofpbuf_init(&s->rxbuf, 2048);
133 } else if (error != EAGAIN) {
134 VLOG_WARN("%s: accept failed (%s)",
135 pstream_get_name(dev->pstream), ovs_strerror(error));
136 pstream_close(dev->pstream);
141 for (i = 0; i < dev->n_streams; i++) {
142 struct dummy_stream *s = &dev->streams[i];
146 stream_run(s->stream);
148 if (!list_is_empty(&s->txq)) {
149 struct ofpbuf *txbuf;
152 txbuf = ofpbuf_from_list(list_front(&s->txq));
153 retval = stream_send(s->stream, txbuf->data, txbuf->size);
155 ofpbuf_pull(txbuf, retval);
157 list_remove(&txbuf->list_node);
158 ofpbuf_delete(txbuf);
160 } else if (retval != -EAGAIN) {
166 if (s->rxbuf.size < 2) {
167 n = 2 - s->rxbuf.size;
171 frame_len = ntohs(get_unaligned_be16(s->rxbuf.data));
172 if (frame_len < ETH_HEADER_LEN) {
176 n = (2 + frame_len) - s->rxbuf.size;
183 ofpbuf_prealloc_tailroom(&s->rxbuf, n);
184 retval = stream_recv(s->stream, ofpbuf_tail(&s->rxbuf), n);
186 s->rxbuf.size += retval;
187 if (retval == n && s->rxbuf.size > 2) {
188 ofpbuf_pull(&s->rxbuf, 2);
189 netdev_dummy_queue_packet(dev,
190 ofpbuf_clone(&s->rxbuf));
191 ofpbuf_clear(&s->rxbuf);
193 } else if (retval != -EAGAIN) {
194 error = (retval < 0 ? -retval
195 : s->rxbuf.size ? EPROTO
201 VLOG_DBG("%s: closing connection (%s)",
202 stream_get_name(s->stream),
203 ovs_retval_to_string(error));
204 dummy_stream_close(&dev->streams[i]);
205 dev->streams[i] = dev->streams[--dev->n_streams];
209 netdev_close(&dev->up);
211 shash_destroy(&dummy_netdevs);
215 dummy_stream_close(struct dummy_stream *s)
217 stream_close(s->stream);
218 ofpbuf_uninit(&s->rxbuf);
219 ofpbuf_list_delete(&s->txq);
223 netdev_dummy_wait(void)
225 struct shash dummy_netdevs;
226 struct shash_node *node;
228 shash_init(&dummy_netdevs);
229 netdev_get_devices(&dummy_class, &dummy_netdevs);
230 SHASH_FOR_EACH (node, &dummy_netdevs) {
231 struct netdev_dummy *dev = node->data;
235 pstream_wait(dev->pstream);
237 for (i = 0; i < dev->n_streams; i++) {
238 struct dummy_stream *s = &dev->streams[i];
240 stream_run_wait(s->stream);
241 if (!list_is_empty(&s->txq)) {
242 stream_send_wait(s->stream);
244 stream_recv_wait(s->stream);
246 netdev_close(&dev->up);
248 shash_destroy(&dummy_netdevs);
252 netdev_dummy_create(const struct netdev_class *class, const char *name,
253 struct netdev **netdevp)
255 static atomic_uint next_n = ATOMIC_VAR_INIT(0xaa550000);
256 struct netdev_dummy *netdev;
259 atomic_add(&next_n, 1, &n);
260 netdev = xzalloc(sizeof *netdev);
261 netdev_init(&netdev->up, name, class);
262 netdev->hwaddr[0] = 0xaa;
263 netdev->hwaddr[1] = 0x55;
264 netdev->hwaddr[2] = n >> 24;
265 netdev->hwaddr[3] = n >> 16;
266 netdev->hwaddr[4] = n >> 8;
267 netdev->hwaddr[5] = n;
270 netdev->change_seq = 1;
271 netdev->ifindex = -EOPNOTSUPP;
273 netdev->pstream = NULL;
274 netdev->streams = NULL;
275 netdev->n_streams = 0;
277 list_init(&netdev->rxes);
279 *netdevp = &netdev->up;
285 netdev_dummy_destroy(struct netdev *netdev_)
287 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
290 pstream_close(netdev->pstream);
291 for (i = 0; i < netdev->n_streams; i++) {
292 dummy_stream_close(&netdev->streams[i]);
294 free(netdev->streams);
299 netdev_dummy_get_config(const struct netdev *netdev_, struct smap *args)
301 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
303 if (netdev->ifindex >= 0) {
304 smap_add_format(args, "ifindex", "%d", netdev->ifindex);
306 if (netdev->pstream) {
307 smap_add(args, "pstream", pstream_get_name(netdev->pstream));
313 netdev_dummy_set_config(struct netdev *netdev_, const struct smap *args)
315 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
318 netdev->ifindex = smap_get_int(args, "ifindex", -EOPNOTSUPP);
320 pstream = smap_get(args, "pstream");
323 || strcmp(pstream_get_name(netdev->pstream), pstream)) {
324 pstream_close(netdev->pstream);
325 netdev->pstream = NULL;
330 error = pstream_open(pstream, &netdev->pstream, DSCP_DEFAULT);
332 VLOG_WARN("%s: open failed (%s)",
333 pstream, ovs_strerror(error));
341 netdev_dummy_rx_open(struct netdev *netdev_, struct netdev_rx **rxp)
343 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
344 struct netdev_rx_dummy *rx;
346 rx = xmalloc(sizeof *rx);
347 netdev_rx_init(&rx->up, &netdev->up, &netdev_rx_dummy_class);
348 list_push_back(&netdev->rxes, &rx->node);
349 list_init(&rx->recv_queue);
350 rx->recv_queue_len = 0;
357 netdev_rx_dummy_recv(struct netdev_rx *rx_, void *buffer, size_t size)
359 struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
360 struct ofpbuf *packet;
363 if (list_is_empty(&rx->recv_queue)) {
367 packet = ofpbuf_from_list(list_pop_front(&rx->recv_queue));
368 rx->recv_queue_len--;
369 if (packet->size <= size) {
370 memcpy(buffer, packet->data, packet->size);
371 retval = packet->size;
375 ofpbuf_delete(packet);
381 netdev_rx_dummy_destroy(struct netdev_rx *rx_)
383 struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
384 list_remove(&rx->node);
385 ofpbuf_list_delete(&rx->recv_queue);
390 netdev_rx_dummy_wait(struct netdev_rx *rx_)
392 struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
393 if (!list_is_empty(&rx->recv_queue)) {
394 poll_immediate_wake();
399 netdev_rx_dummy_drain(struct netdev_rx *rx_)
401 struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
402 ofpbuf_list_delete(&rx->recv_queue);
403 rx->recv_queue_len = 0;
408 netdev_dummy_send(struct netdev *netdev, const void *buffer, size_t size)
410 struct netdev_dummy *dev = netdev_dummy_cast(netdev);
413 if (size < ETH_HEADER_LEN) {
416 const struct eth_header *eth = buffer;
419 max_size = dev->mtu + ETH_HEADER_LEN;
420 if (eth->eth_type == htons(ETH_TYPE_VLAN)) {
421 max_size += VLAN_HEADER_LEN;
423 if (size > max_size) {
428 dev->stats.tx_packets++;
429 dev->stats.tx_bytes += size;
431 for (i = 0; i < dev->n_streams; i++) {
432 struct dummy_stream *s = &dev->streams[i];
434 if (list_size(&s->txq) < NETDEV_DUMMY_MAX_QUEUE) {
437 b = ofpbuf_clone_data_with_headroom(buffer, size, 2);
438 put_unaligned_be16(ofpbuf_push_uninit(b, 2), htons(size));
439 list_push_back(&s->txq, &b->list_node);
447 netdev_dummy_set_etheraddr(struct netdev *netdev,
448 const uint8_t mac[ETH_ADDR_LEN])
450 struct netdev_dummy *dev = netdev_dummy_cast(netdev);
452 if (!eth_addr_equals(dev->hwaddr, mac)) {
453 memcpy(dev->hwaddr, mac, ETH_ADDR_LEN);
454 netdev_dummy_poll_notify(dev);
461 netdev_dummy_get_etheraddr(const struct netdev *netdev,
462 uint8_t mac[ETH_ADDR_LEN])
464 const struct netdev_dummy *dev = netdev_dummy_cast(netdev);
466 memcpy(mac, dev->hwaddr, ETH_ADDR_LEN);
471 netdev_dummy_get_mtu(const struct netdev *netdev, int *mtup)
473 const struct netdev_dummy *dev = netdev_dummy_cast(netdev);
480 netdev_dummy_set_mtu(const struct netdev *netdev, int mtu)
482 struct netdev_dummy *dev = netdev_dummy_cast(netdev);
489 netdev_dummy_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
491 const struct netdev_dummy *dev = netdev_dummy_cast(netdev);
498 netdev_dummy_set_stats(struct netdev *netdev, const struct netdev_stats *stats)
500 struct netdev_dummy *dev = netdev_dummy_cast(netdev);
507 netdev_dummy_get_ifindex(const struct netdev *netdev)
509 struct netdev_dummy *dev = netdev_dummy_cast(netdev);
515 netdev_dummy_update_flags(struct netdev *netdev_,
516 enum netdev_flags off, enum netdev_flags on,
517 enum netdev_flags *old_flagsp)
519 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
521 if ((off | on) & ~(NETDEV_UP | NETDEV_PROMISC)) {
525 *old_flagsp = netdev->flags;
527 netdev->flags &= ~off;
528 if (*old_flagsp != netdev->flags) {
529 netdev_dummy_poll_notify(netdev);
535 netdev_dummy_change_seq(const struct netdev *netdev)
537 return netdev_dummy_cast(netdev)->change_seq;
540 /* Helper functions. */
543 netdev_dummy_poll_notify(struct netdev_dummy *dev)
546 if (!dev->change_seq) {
551 static const struct netdev_class dummy_class = {
558 netdev_dummy_destroy,
559 netdev_dummy_get_config,
560 netdev_dummy_set_config,
561 NULL, /* get_tunnel_config */
563 netdev_dummy_rx_open,
565 netdev_dummy_send, /* send */
566 NULL, /* send_wait */
568 netdev_dummy_set_etheraddr,
569 netdev_dummy_get_etheraddr,
570 netdev_dummy_get_mtu,
571 netdev_dummy_set_mtu,
572 netdev_dummy_get_ifindex,
573 NULL, /* get_carrier */
574 NULL, /* get_carrier_resets */
575 NULL, /* get_miimon */
576 netdev_dummy_get_stats,
577 netdev_dummy_set_stats,
579 NULL, /* get_features */
580 NULL, /* set_advertisements */
582 NULL, /* set_policing */
583 NULL, /* get_qos_types */
584 NULL, /* get_qos_capabilities */
587 NULL, /* get_queue */
588 NULL, /* set_queue */
589 NULL, /* delete_queue */
590 NULL, /* get_queue_stats */
591 NULL, /* dump_queues */
592 NULL, /* dump_queue_stats */
597 NULL, /* add_router */
598 NULL, /* get_next_hop */
599 NULL, /* get_status */
600 NULL, /* arp_lookup */
602 netdev_dummy_update_flags,
604 netdev_dummy_change_seq
607 static const struct netdev_rx_class netdev_rx_dummy_class = {
608 netdev_rx_dummy_destroy,
609 netdev_rx_dummy_recv,
610 netdev_rx_dummy_wait,
611 netdev_rx_dummy_drain,
614 static struct ofpbuf *
615 eth_from_packet_or_flow(const char *s)
617 enum odp_key_fitness fitness;
618 struct ofpbuf *packet;
619 struct ofpbuf odp_key;
623 if (!eth_from_hex(s, &packet)) {
627 /* Convert string to datapath key.
629 * It would actually be nicer to parse an OpenFlow-like flow key here, but
630 * the code for that currently calls exit() on parse error. We have to
631 * settle for parsing a datapath key for now.
633 ofpbuf_init(&odp_key, 0);
634 error = odp_flow_from_string(s, NULL, &odp_key, NULL);
636 ofpbuf_uninit(&odp_key);
640 /* Convert odp_key to flow. */
641 fitness = odp_flow_key_to_flow(odp_key.data, odp_key.size, &flow);
642 if (fitness == ODP_FIT_ERROR) {
643 ofpbuf_uninit(&odp_key);
647 packet = ofpbuf_new(0);
648 flow_compose(packet, &flow);
650 ofpbuf_uninit(&odp_key);
655 netdev_dummy_queue_packet__(struct netdev_rx_dummy *rx, struct ofpbuf *packet)
657 list_push_back(&rx->recv_queue, &packet->list_node);
658 rx->recv_queue_len++;
662 netdev_dummy_queue_packet(struct netdev_dummy *dummy, struct ofpbuf *packet)
664 struct netdev_rx_dummy *rx, *prev;
667 LIST_FOR_EACH (rx, node, &dummy->rxes) {
668 if (rx->recv_queue_len < NETDEV_DUMMY_MAX_QUEUE) {
670 netdev_dummy_queue_packet__(prev, ofpbuf_clone(packet));
676 netdev_dummy_queue_packet__(prev, packet);
678 ofpbuf_delete(packet);
683 netdev_dummy_receive(struct unixctl_conn *conn,
684 int argc, const char *argv[], void *aux OVS_UNUSED)
686 struct netdev_dummy *dummy_dev;
687 struct netdev *netdev;
690 netdev = netdev_from_name(argv[1]);
691 if (!netdev || !is_dummy_class(netdev->netdev_class)) {
692 unixctl_command_reply_error(conn, "no such dummy netdev");
695 dummy_dev = netdev_dummy_cast(netdev);
697 for (i = 2; i < argc; i++) {
698 struct ofpbuf *packet;
700 packet = eth_from_packet_or_flow(argv[i]);
702 unixctl_command_reply_error(conn, "bad packet syntax");
706 dummy_dev->stats.rx_packets++;
707 dummy_dev->stats.rx_bytes += packet->size;
709 netdev_dummy_queue_packet(dummy_dev, packet);
712 unixctl_command_reply(conn, NULL);
715 netdev_close(netdev);
719 netdev_dummy_set_admin_state__(struct netdev_dummy *dev, bool admin_state)
721 enum netdev_flags old_flags;
724 netdev_dummy_update_flags(&dev->up, 0, NETDEV_UP, &old_flags);
726 netdev_dummy_update_flags(&dev->up, NETDEV_UP, 0, &old_flags);
731 netdev_dummy_set_admin_state(struct unixctl_conn *conn, int argc,
732 const char *argv[], void *aux OVS_UNUSED)
736 if (!strcasecmp(argv[argc - 1], "up")) {
738 } else if ( !strcasecmp(argv[argc - 1], "down")) {
741 unixctl_command_reply_error(conn, "Invalid Admin State");
746 struct netdev *netdev = netdev_from_name(argv[1]);
747 if (netdev && is_dummy_class(netdev->netdev_class)) {
748 struct netdev_dummy *dummy_dev = netdev_dummy_cast(netdev);
750 netdev_dummy_set_admin_state__(dummy_dev, up);
751 netdev_close(netdev);
753 unixctl_command_reply_error(conn, "Unknown Dummy Interface");
754 netdev_close(netdev);
758 struct shash dummy_netdevs;
759 struct shash_node *node;
761 shash_init(&dummy_netdevs);
762 netdev_get_devices(&dummy_class, &dummy_netdevs);
763 SHASH_FOR_EACH (node, &dummy_netdevs) {
764 struct netdev *netdev = node->data;
765 netdev_dummy_set_admin_state__(netdev_dummy_cast(netdev), up);
766 netdev_close(netdev);
768 shash_destroy(&dummy_netdevs);
770 unixctl_command_reply(conn, "OK");
774 netdev_dummy_register(bool override)
776 unixctl_command_register("netdev-dummy/receive", "NAME PACKET|FLOW...",
777 2, INT_MAX, netdev_dummy_receive, NULL);
778 unixctl_command_register("netdev-dummy/set-admin-state",
779 "[netdev] up|down", 1, 2,
780 netdev_dummy_set_admin_state, NULL);
787 netdev_enumerate_types(&types);
788 SSET_FOR_EACH (type, &types) {
789 if (!netdev_unregister_provider(type)) {
790 struct netdev_class *class;
792 class = xmalloc(sizeof *class);
793 *class = dummy_class;
794 class->type = xstrdup(type);
795 netdev_register_provider(class);
798 sset_destroy(&types);
800 netdev_register_provider(&dummy_class);
802 netdev_vport_tunnel_register();