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"
37 VLOG_DEFINE_THIS_MODULE(netdev_dummy);
45 struct netdev_dev_dummy {
46 struct netdev_dev netdev_dev;
47 uint8_t hwaddr[ETH_ADDR_LEN];
49 struct netdev_stats stats;
50 enum netdev_flags flags;
51 unsigned int change_seq;
53 struct list devs; /* List of child "netdev_dummy"s. */
59 struct list node; /* In netdev_dev_dummy's "devs" list. */
60 struct list recv_queue;
64 static struct shash dummy_netdev_devs = SHASH_INITIALIZER(&dummy_netdev_devs);
66 static unixctl_cb_func netdev_dummy_set_admin_state;
67 static int netdev_dummy_create(const struct netdev_class *, const char *,
68 struct netdev_dev **);
69 static void netdev_dev_dummy_poll_notify(struct netdev_dev_dummy *);
70 static int netdev_dev_dummy_update_flags(struct netdev_dev_dummy *,
71 enum netdev_flags off,
73 enum netdev_flags *old_flagsp);
76 is_dummy_class(const struct netdev_class *class)
78 return class->create == netdev_dummy_create;
81 static struct netdev_dev_dummy *
82 netdev_dev_dummy_cast(const struct netdev_dev *netdev_dev)
84 ovs_assert(is_dummy_class(netdev_dev_get_class(netdev_dev)));
85 return CONTAINER_OF(netdev_dev, struct netdev_dev_dummy, netdev_dev);
88 static struct netdev_dummy *
89 netdev_dummy_cast(const struct netdev *netdev)
91 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
92 ovs_assert(is_dummy_class(netdev_dev_get_class(netdev_dev)));
93 return CONTAINER_OF(netdev, struct netdev_dummy, netdev);
97 netdev_dummy_create(const struct netdev_class *class, const char *name,
98 struct netdev_dev **netdev_devp)
100 static unsigned int n = 0xaa550000;
101 struct netdev_dev_dummy *netdev_dev;
103 netdev_dev = xzalloc(sizeof *netdev_dev);
104 netdev_dev_init(&netdev_dev->netdev_dev, name, class);
105 netdev_dev->hwaddr[0] = 0xaa;
106 netdev_dev->hwaddr[1] = 0x55;
107 netdev_dev->hwaddr[2] = n >> 24;
108 netdev_dev->hwaddr[3] = n >> 16;
109 netdev_dev->hwaddr[4] = n >> 8;
110 netdev_dev->hwaddr[5] = n;
111 netdev_dev->mtu = 1500;
112 netdev_dev->flags = 0;
113 netdev_dev->change_seq = 1;
114 netdev_dev->ifindex = -EOPNOTSUPP;
115 list_init(&netdev_dev->devs);
117 shash_add(&dummy_netdev_devs, name, netdev_dev);
121 *netdev_devp = &netdev_dev->netdev_dev;
127 netdev_dummy_destroy(struct netdev_dev *netdev_dev_)
129 struct netdev_dev_dummy *netdev_dev = netdev_dev_dummy_cast(netdev_dev_);
131 shash_find_and_delete(&dummy_netdev_devs,
132 netdev_dev_get_name(netdev_dev_));
137 netdev_dummy_get_config(struct netdev_dev *netdev_dev_, struct smap *args)
139 struct netdev_dev_dummy *netdev_dev = netdev_dev_dummy_cast(netdev_dev_);
141 if (netdev_dev->ifindex >= 0) {
142 smap_add_format(args, "ifindex", "%d", netdev_dev->ifindex);
148 netdev_dummy_set_config(struct netdev_dev *netdev_dev_,
149 const struct smap *args)
151 struct netdev_dev_dummy *netdev_dev = netdev_dev_dummy_cast(netdev_dev_);
153 netdev_dev->ifindex = smap_get_int(args, "ifindex", -EOPNOTSUPP);
158 netdev_dummy_open(struct netdev_dev *netdev_dev_, struct netdev **netdevp)
160 struct netdev_dev_dummy *netdev_dev = netdev_dev_dummy_cast(netdev_dev_);
161 struct netdev_dummy *netdev;
163 netdev = xmalloc(sizeof *netdev);
164 netdev_init(&netdev->netdev, netdev_dev_);
165 list_init(&netdev->recv_queue);
166 netdev->listening = false;
168 *netdevp = &netdev->netdev;
169 list_push_back(&netdev_dev->devs, &netdev->node);
174 netdev_dummy_close(struct netdev *netdev_)
176 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
177 list_remove(&netdev->node);
178 ofpbuf_list_delete(&netdev->recv_queue);
183 netdev_dummy_listen(struct netdev *netdev_)
185 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
186 netdev->listening = true;
191 netdev_dummy_recv(struct netdev *netdev_, void *buffer, size_t size)
193 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
194 struct ofpbuf *packet;
197 if (list_is_empty(&netdev->recv_queue)) {
201 packet = ofpbuf_from_list(list_pop_front(&netdev->recv_queue));
202 if (packet->size > size) {
205 packet_size = packet->size;
207 memcpy(buffer, packet->data, packet->size);
208 ofpbuf_delete(packet);
214 netdev_dummy_recv_wait(struct netdev *netdev_)
216 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
217 if (!list_is_empty(&netdev->recv_queue)) {
218 poll_immediate_wake();
223 netdev_dummy_drain(struct netdev *netdev_)
225 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
226 ofpbuf_list_delete(&netdev->recv_queue);
231 netdev_dummy_send(struct netdev *netdev, const void *buffer OVS_UNUSED,
234 struct netdev_dev_dummy *dev =
235 netdev_dev_dummy_cast(netdev_get_dev(netdev));
237 dev->stats.tx_packets++;
238 dev->stats.tx_bytes += size;
244 netdev_dummy_set_etheraddr(struct netdev *netdev,
245 const uint8_t mac[ETH_ADDR_LEN])
247 struct netdev_dev_dummy *dev =
248 netdev_dev_dummy_cast(netdev_get_dev(netdev));
250 if (!eth_addr_equals(dev->hwaddr, mac)) {
251 memcpy(dev->hwaddr, mac, ETH_ADDR_LEN);
252 netdev_dev_dummy_poll_notify(dev);
259 netdev_dummy_get_etheraddr(const struct netdev *netdev,
260 uint8_t mac[ETH_ADDR_LEN])
262 const struct netdev_dev_dummy *dev =
263 netdev_dev_dummy_cast(netdev_get_dev(netdev));
265 memcpy(mac, dev->hwaddr, ETH_ADDR_LEN);
270 netdev_dummy_get_mtu(const struct netdev *netdev, int *mtup)
272 const struct netdev_dev_dummy *dev =
273 netdev_dev_dummy_cast(netdev_get_dev(netdev));
280 netdev_dummy_set_mtu(const struct netdev *netdev, int mtu)
282 struct netdev_dev_dummy *dev =
283 netdev_dev_dummy_cast(netdev_get_dev(netdev));
290 netdev_dummy_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
292 const struct netdev_dev_dummy *dev =
293 netdev_dev_dummy_cast(netdev_get_dev(netdev));
300 netdev_dummy_set_stats(struct netdev *netdev, const struct netdev_stats *stats)
302 struct netdev_dev_dummy *dev =
303 netdev_dev_dummy_cast(netdev_get_dev(netdev));
310 netdev_dummy_get_ifindex(const struct netdev *netdev)
312 struct netdev_dev_dummy *dev =
313 netdev_dev_dummy_cast(netdev_get_dev(netdev));
319 netdev_dummy_update_flags(struct netdev *netdev,
320 enum netdev_flags off, enum netdev_flags on,
321 enum netdev_flags *old_flagsp)
323 struct netdev_dev_dummy *dev =
324 netdev_dev_dummy_cast(netdev_get_dev(netdev));
326 return netdev_dev_dummy_update_flags(dev, off, on, old_flagsp);
330 netdev_dev_dummy_update_flags(struct netdev_dev_dummy *dev,
331 enum netdev_flags off, enum netdev_flags on,
332 enum netdev_flags *old_flagsp)
334 if ((off | on) & ~(NETDEV_UP | NETDEV_PROMISC)) {
338 *old_flagsp = dev->flags;
341 if (*old_flagsp != dev->flags) {
342 netdev_dev_dummy_poll_notify(dev);
348 netdev_dummy_change_seq(const struct netdev *netdev)
350 return netdev_dev_dummy_cast(netdev_get_dev(netdev))->change_seq;
353 /* Helper functions. */
356 netdev_dev_dummy_poll_notify(struct netdev_dev_dummy *dev)
359 if (!dev->change_seq) {
364 static const struct netdev_class dummy_class = {
371 netdev_dummy_destroy,
372 netdev_dummy_get_config,
373 netdev_dummy_set_config,
374 NULL, /* get_tunnel_config */
381 netdev_dummy_recv_wait,
384 netdev_dummy_send, /* send */
385 NULL, /* send_wait */
387 netdev_dummy_set_etheraddr,
388 netdev_dummy_get_etheraddr,
389 netdev_dummy_get_mtu,
390 netdev_dummy_set_mtu,
391 netdev_dummy_get_ifindex,
392 NULL, /* get_carrier */
393 NULL, /* get_carrier_resets */
394 NULL, /* get_miimon */
395 netdev_dummy_get_stats,
396 netdev_dummy_set_stats,
398 NULL, /* get_features */
399 NULL, /* set_advertisements */
401 NULL, /* set_policing */
402 NULL, /* get_qos_types */
403 NULL, /* get_qos_capabilities */
406 NULL, /* get_queue */
407 NULL, /* set_queue */
408 NULL, /* delete_queue */
409 NULL, /* get_queue_stats */
410 NULL, /* dump_queues */
411 NULL, /* dump_queue_stats */
416 NULL, /* add_router */
417 NULL, /* get_next_hop */
418 NULL, /* get_status */
419 NULL, /* arp_lookup */
421 netdev_dummy_update_flags,
423 netdev_dummy_change_seq
426 static struct ofpbuf *
427 eth_from_packet_or_flow(const char *s)
429 enum odp_key_fitness fitness;
430 struct ofpbuf *packet;
431 struct ofpbuf odp_key;
435 if (!eth_from_hex(s, &packet)) {
439 /* Convert string to datapath key.
441 * It would actually be nicer to parse an OpenFlow-like flow key here, but
442 * the code for that currently calls exit() on parse error. We have to
443 * settle for parsing a datapath key for now.
445 ofpbuf_init(&odp_key, 0);
446 error = odp_flow_key_from_string(s, NULL, &odp_key);
448 ofpbuf_uninit(&odp_key);
452 /* Convert odp_key to flow. */
453 fitness = odp_flow_key_to_flow(odp_key.data, odp_key.size, &flow);
454 if (fitness == ODP_FIT_ERROR) {
455 ofpbuf_uninit(&odp_key);
459 packet = ofpbuf_new(0);
460 flow_compose(packet, &flow);
462 ofpbuf_uninit(&odp_key);
467 netdev_dummy_receive(struct unixctl_conn *conn,
468 int argc, const char *argv[], void *aux OVS_UNUSED)
470 struct netdev_dev_dummy *dummy_dev;
474 dummy_dev = shash_find_data(&dummy_netdev_devs, argv[1]);
476 unixctl_command_reply_error(conn, "no such dummy netdev");
481 for (i = 2; i < argc; i++) {
482 struct netdev_dummy *dev;
483 struct ofpbuf *packet;
485 packet = eth_from_packet_or_flow(argv[i]);
487 unixctl_command_reply_error(conn, "bad packet syntax");
491 dummy_dev->stats.rx_packets++;
492 dummy_dev->stats.rx_bytes += packet->size;
495 LIST_FOR_EACH (dev, node, &dummy_dev->devs) {
496 if (dev->listening) {
497 struct ofpbuf *copy = ofpbuf_clone(packet);
498 list_push_back(&dev->recv_queue, ©->list_node);
502 ofpbuf_delete(packet);
506 unixctl_command_reply(conn, "packets queued but nobody listened");
508 unixctl_command_reply(conn, "success");
513 netdev_dev_dummy_set_admin_state(struct netdev_dev_dummy *dev,
516 enum netdev_flags old_flags;
519 netdev_dev_dummy_update_flags(dev, 0, NETDEV_UP, &old_flags);
521 netdev_dev_dummy_update_flags(dev, NETDEV_UP, 0, &old_flags);
526 netdev_dummy_set_admin_state(struct unixctl_conn *conn, int argc,
527 const char *argv[], void *aux OVS_UNUSED)
531 if (!strcasecmp(argv[argc - 1], "up")) {
533 } else if ( !strcasecmp(argv[argc - 1], "down")) {
536 unixctl_command_reply_error(conn, "Invalid Admin State");
541 struct netdev_dev_dummy *dummy_dev;
543 dummy_dev = shash_find_data(&dummy_netdev_devs, argv[1]);
545 netdev_dev_dummy_set_admin_state(dummy_dev, up);
547 unixctl_command_reply_error(conn, "Unknown Dummy Interface");
551 struct shash_node *node;
553 SHASH_FOR_EACH (node, &dummy_netdev_devs) {
554 netdev_dev_dummy_set_admin_state(node->data, up);
557 unixctl_command_reply(conn, "OK");
561 netdev_dummy_register(bool override)
563 unixctl_command_register("netdev-dummy/receive", "NAME PACKET|FLOW...",
564 2, INT_MAX, netdev_dummy_receive, NULL);
565 unixctl_command_register("netdev-dummy/set-admin-state",
566 "[netdev] up|down", 1, 2,
567 netdev_dummy_set_admin_state, NULL);
574 netdev_enumerate_types(&types);
575 SSET_FOR_EACH (type, &types) {
576 if (!netdev_unregister_provider(type)) {
577 struct netdev_class *class;
579 class = xmalloc(sizeof *class);
580 *class = dummy_class;
581 class->type = xstrdup(type);
582 netdev_register_provider(class);
585 sset_destroy(&types);
587 netdev_register_provider(&dummy_class);
590 netdev_vport_tunnel_register();