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);
47 uint8_t hwaddr[ETH_ADDR_LEN];
49 struct netdev_stats stats;
50 enum netdev_flags flags;
51 unsigned int change_seq;
54 struct list rxes; /* List of child "netdev_rx_dummy"s. */
57 struct netdev_rx_dummy {
59 struct list node; /* In netdev_dummy's "rxes" list. */
60 struct list recv_queue;
63 static struct shash dummy_netdevs = SHASH_INITIALIZER(&dummy_netdevs);
65 static const struct netdev_rx_class netdev_rx_dummy_class;
67 static unixctl_cb_func netdev_dummy_set_admin_state;
68 static int netdev_dummy_create(const struct netdev_class *, const char *,
70 static void netdev_dummy_poll_notify(struct netdev_dummy *);
73 is_dummy_class(const struct netdev_class *class)
75 return class->create == netdev_dummy_create;
78 static struct netdev_dummy *
79 netdev_dummy_cast(const struct netdev *netdev)
81 ovs_assert(is_dummy_class(netdev_get_class(netdev)));
82 return CONTAINER_OF(netdev, struct netdev_dummy, up);
85 static struct netdev_rx_dummy *
86 netdev_rx_dummy_cast(const struct netdev_rx *rx)
88 netdev_rx_assert_class(rx, &netdev_rx_dummy_class);
89 return CONTAINER_OF(rx, struct netdev_rx_dummy, up);
93 netdev_dummy_create(const struct netdev_class *class, const char *name,
94 struct netdev **netdevp)
96 static unsigned int n = 0xaa550000;
97 struct netdev_dummy *netdev;
99 netdev = xzalloc(sizeof *netdev);
100 netdev_init(&netdev->up, name, class);
101 netdev->hwaddr[0] = 0xaa;
102 netdev->hwaddr[1] = 0x55;
103 netdev->hwaddr[2] = n >> 24;
104 netdev->hwaddr[3] = n >> 16;
105 netdev->hwaddr[4] = n >> 8;
106 netdev->hwaddr[5] = n;
109 netdev->change_seq = 1;
110 netdev->ifindex = -EOPNOTSUPP;
111 list_init(&netdev->rxes);
113 shash_add(&dummy_netdevs, name, netdev);
117 *netdevp = &netdev->up;
123 netdev_dummy_destroy(struct netdev *netdev_)
125 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
127 shash_find_and_delete(&dummy_netdevs,
128 netdev_get_name(netdev_));
133 netdev_dummy_get_config(const struct netdev *netdev_, struct smap *args)
135 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
137 if (netdev->ifindex >= 0) {
138 smap_add_format(args, "ifindex", "%d", netdev->ifindex);
144 netdev_dummy_set_config(struct netdev *netdev_, const struct smap *args)
146 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
148 netdev->ifindex = smap_get_int(args, "ifindex", -EOPNOTSUPP);
153 netdev_dummy_rx_open(struct netdev *netdev_, struct netdev_rx **rxp)
155 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
156 struct netdev_rx_dummy *rx;
158 rx = xmalloc(sizeof *rx);
159 netdev_rx_init(&rx->up, &netdev->up, &netdev_rx_dummy_class);
160 list_push_back(&netdev->rxes, &rx->node);
161 list_init(&rx->recv_queue);
168 netdev_rx_dummy_recv(struct netdev_rx *rx_, void *buffer, size_t size)
170 struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
171 struct ofpbuf *packet;
174 if (list_is_empty(&rx->recv_queue)) {
178 packet = ofpbuf_from_list(list_pop_front(&rx->recv_queue));
179 if (packet->size > size) {
182 packet_size = packet->size;
184 memcpy(buffer, packet->data, packet->size);
185 ofpbuf_delete(packet);
191 netdev_rx_dummy_destroy(struct netdev_rx *rx_)
193 struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
194 list_remove(&rx->node);
195 ofpbuf_list_delete(&rx->recv_queue);
200 netdev_rx_dummy_wait(struct netdev_rx *rx_)
202 struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
203 if (!list_is_empty(&rx->recv_queue)) {
204 poll_immediate_wake();
209 netdev_rx_dummy_drain(struct netdev_rx *rx_)
211 struct netdev_rx_dummy *rx = netdev_rx_dummy_cast(rx_);
212 ofpbuf_list_delete(&rx->recv_queue);
217 netdev_dummy_send(struct netdev *netdev, const void *buffer OVS_UNUSED,
220 struct netdev_dummy *dev = netdev_dummy_cast(netdev);
222 dev->stats.tx_packets++;
223 dev->stats.tx_bytes += size;
229 netdev_dummy_set_etheraddr(struct netdev *netdev,
230 const uint8_t mac[ETH_ADDR_LEN])
232 struct netdev_dummy *dev = netdev_dummy_cast(netdev);
234 if (!eth_addr_equals(dev->hwaddr, mac)) {
235 memcpy(dev->hwaddr, mac, ETH_ADDR_LEN);
236 netdev_dummy_poll_notify(dev);
243 netdev_dummy_get_etheraddr(const struct netdev *netdev,
244 uint8_t mac[ETH_ADDR_LEN])
246 const struct netdev_dummy *dev = netdev_dummy_cast(netdev);
248 memcpy(mac, dev->hwaddr, ETH_ADDR_LEN);
253 netdev_dummy_get_mtu(const struct netdev *netdev, int *mtup)
255 const struct netdev_dummy *dev = netdev_dummy_cast(netdev);
262 netdev_dummy_set_mtu(const struct netdev *netdev, int mtu)
264 struct netdev_dummy *dev = netdev_dummy_cast(netdev);
271 netdev_dummy_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
273 const struct netdev_dummy *dev = netdev_dummy_cast(netdev);
280 netdev_dummy_set_stats(struct netdev *netdev, const struct netdev_stats *stats)
282 struct netdev_dummy *dev = netdev_dummy_cast(netdev);
289 netdev_dummy_get_ifindex(const struct netdev *netdev)
291 struct netdev_dummy *dev = netdev_dummy_cast(netdev);
297 netdev_dummy_update_flags(struct netdev *netdev_,
298 enum netdev_flags off, enum netdev_flags on,
299 enum netdev_flags *old_flagsp)
301 struct netdev_dummy *netdev = netdev_dummy_cast(netdev_);
303 if ((off | on) & ~(NETDEV_UP | NETDEV_PROMISC)) {
307 *old_flagsp = netdev->flags;
309 netdev->flags &= ~off;
310 if (*old_flagsp != netdev->flags) {
311 netdev_dummy_poll_notify(netdev);
317 netdev_dummy_change_seq(const struct netdev *netdev)
319 return netdev_dummy_cast(netdev)->change_seq;
322 /* Helper functions. */
325 netdev_dummy_poll_notify(struct netdev_dummy *dev)
328 if (!dev->change_seq) {
333 static const struct netdev_class dummy_class = {
340 netdev_dummy_destroy,
341 netdev_dummy_get_config,
342 netdev_dummy_set_config,
343 NULL, /* get_tunnel_config */
345 netdev_dummy_rx_open,
347 netdev_dummy_send, /* send */
348 NULL, /* send_wait */
350 netdev_dummy_set_etheraddr,
351 netdev_dummy_get_etheraddr,
352 netdev_dummy_get_mtu,
353 netdev_dummy_set_mtu,
354 netdev_dummy_get_ifindex,
355 NULL, /* get_carrier */
356 NULL, /* get_carrier_resets */
357 NULL, /* get_miimon */
358 netdev_dummy_get_stats,
359 netdev_dummy_set_stats,
361 NULL, /* get_features */
362 NULL, /* set_advertisements */
364 NULL, /* set_policing */
365 NULL, /* get_qos_types */
366 NULL, /* get_qos_capabilities */
369 NULL, /* get_queue */
370 NULL, /* set_queue */
371 NULL, /* delete_queue */
372 NULL, /* get_queue_stats */
373 NULL, /* dump_queues */
374 NULL, /* dump_queue_stats */
379 NULL, /* add_router */
380 NULL, /* get_next_hop */
381 NULL, /* get_status */
382 NULL, /* arp_lookup */
384 netdev_dummy_update_flags,
386 netdev_dummy_change_seq
389 static const struct netdev_rx_class netdev_rx_dummy_class = {
390 netdev_rx_dummy_destroy,
391 netdev_rx_dummy_recv,
392 netdev_rx_dummy_wait,
393 netdev_rx_dummy_drain,
396 static struct ofpbuf *
397 eth_from_packet_or_flow(const char *s)
399 enum odp_key_fitness fitness;
400 struct ofpbuf *packet;
401 struct ofpbuf odp_key;
405 if (!eth_from_hex(s, &packet)) {
409 /* Convert string to datapath key.
411 * It would actually be nicer to parse an OpenFlow-like flow key here, but
412 * the code for that currently calls exit() on parse error. We have to
413 * settle for parsing a datapath key for now.
415 ofpbuf_init(&odp_key, 0);
416 error = odp_flow_key_from_string(s, NULL, &odp_key);
418 ofpbuf_uninit(&odp_key);
422 /* Convert odp_key to flow. */
423 fitness = odp_flow_key_to_flow(odp_key.data, odp_key.size, &flow);
424 if (fitness == ODP_FIT_ERROR) {
425 ofpbuf_uninit(&odp_key);
429 packet = ofpbuf_new(0);
430 flow_compose(packet, &flow);
432 ofpbuf_uninit(&odp_key);
437 netdev_dummy_receive(struct unixctl_conn *conn,
438 int argc, const char *argv[], void *aux OVS_UNUSED)
440 struct netdev_dummy *dummy_dev;
444 dummy_dev = shash_find_data(&dummy_netdevs, argv[1]);
446 unixctl_command_reply_error(conn, "no such dummy netdev");
451 for (i = 2; i < argc; i++) {
452 struct netdev_rx_dummy *rx;
453 struct ofpbuf *packet;
455 packet = eth_from_packet_or_flow(argv[i]);
457 unixctl_command_reply_error(conn, "bad packet syntax");
461 dummy_dev->stats.rx_packets++;
462 dummy_dev->stats.rx_bytes += packet->size;
465 LIST_FOR_EACH (rx, node, &dummy_dev->rxes) {
466 struct ofpbuf *copy = ofpbuf_clone(packet);
467 list_push_back(&rx->recv_queue, ©->list_node);
470 ofpbuf_delete(packet);
474 unixctl_command_reply(conn, "packets queued but nobody listened");
476 unixctl_command_reply(conn, "success");
481 netdev_dummy_set_admin_state__(struct netdev_dummy *dev, bool admin_state)
483 enum netdev_flags old_flags;
486 netdev_dummy_update_flags(&dev->up, 0, NETDEV_UP, &old_flags);
488 netdev_dummy_update_flags(&dev->up, NETDEV_UP, 0, &old_flags);
493 netdev_dummy_set_admin_state(struct unixctl_conn *conn, int argc,
494 const char *argv[], void *aux OVS_UNUSED)
498 if (!strcasecmp(argv[argc - 1], "up")) {
500 } else if ( !strcasecmp(argv[argc - 1], "down")) {
503 unixctl_command_reply_error(conn, "Invalid Admin State");
508 struct netdev_dummy *dummy_dev;
510 dummy_dev = shash_find_data(&dummy_netdevs, argv[1]);
512 netdev_dummy_set_admin_state__(dummy_dev, up);
514 unixctl_command_reply_error(conn, "Unknown Dummy Interface");
518 struct shash_node *node;
520 SHASH_FOR_EACH (node, &dummy_netdevs) {
521 netdev_dummy_set_admin_state__(node->data, up);
524 unixctl_command_reply(conn, "OK");
528 netdev_dummy_register(bool override)
530 unixctl_command_register("netdev-dummy/receive", "NAME PACKET|FLOW...",
531 2, INT_MAX, netdev_dummy_receive, NULL);
532 unixctl_command_register("netdev-dummy/set-admin-state",
533 "[netdev] up|down", 1, 2,
534 netdev_dummy_set_admin_state, NULL);
541 netdev_enumerate_types(&types);
542 SSET_FOR_EACH (type, &types) {
543 if (!netdev_unregister_provider(type)) {
544 struct netdev_class *class;
546 class = xmalloc(sizeof *class);
547 *class = dummy_class;
548 class->type = xstrdup(type);
549 netdev_register_provider(class);
552 sset_destroy(&types);
554 netdev_register_provider(&dummy_class);
557 netdev_vport_tunnel_register();