2 * Copyright (c) 2010, 2011, 2012 Nicira Networks.
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.
20 #include <sys/socket.h>
21 #include <netinet/in.h>
22 #include <arpa/inet.h>
27 #include "netdev-provider.h"
29 #include "ofp-print.h"
32 #include "poll-loop.h"
36 #include "socket-util.h"
39 VLOG_DEFINE_THIS_MODULE(netdev_tunnel);
41 struct netdev_dev_tunnel {
42 struct netdev_dev netdev_dev;
43 uint8_t hwaddr[ETH_ADDR_LEN];
44 struct netdev_stats stats;
45 enum netdev_flags flags;
47 struct sockaddr_in local_addr;
48 struct sockaddr_in remote_addr;
50 bool valid_remote_port;
52 unsigned int change_seq;
55 struct netdev_tunnel {
59 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
61 static struct shash tunnel_netdev_devs = SHASH_INITIALIZER(&tunnel_netdev_devs);
63 static int netdev_tunnel_create(const struct netdev_class *, const char *,
64 struct netdev_dev **);
65 static void netdev_tunnel_update_seq(struct netdev_dev_tunnel *);
68 is_tunnel_class(const struct netdev_class *class)
70 return class->create == netdev_tunnel_create;
73 static struct netdev_dev_tunnel *
74 netdev_dev_tunnel_cast(const struct netdev_dev *netdev_dev)
76 assert(is_tunnel_class(netdev_dev_get_class(netdev_dev)));
77 return CONTAINER_OF(netdev_dev, struct netdev_dev_tunnel, netdev_dev);
80 static struct netdev_tunnel *
81 netdev_tunnel_cast(const struct netdev *netdev)
83 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
84 assert(is_tunnel_class(netdev_dev_get_class(netdev_dev)));
85 return CONTAINER_OF(netdev, struct netdev_tunnel, netdev);
89 netdev_tunnel_create(const struct netdev_class *class, const char *name,
90 struct netdev_dev **netdev_devp)
92 static unsigned int n = 0xaa550000;
93 struct netdev_dev_tunnel *netdev_dev;
96 netdev_dev = xzalloc(sizeof *netdev_dev);
97 netdev_dev_init(&netdev_dev->netdev_dev, name, class);
98 netdev_dev->hwaddr[0] = 0x55;
99 netdev_dev->hwaddr[1] = 0xaa;
100 netdev_dev->hwaddr[2] = n >> 24;
101 netdev_dev->hwaddr[3] = n >> 16;
102 netdev_dev->hwaddr[4] = n >> 8;
103 netdev_dev->hwaddr[5] = n;
104 netdev_dev->flags = 0;
105 netdev_dev->change_seq = 1;
106 memset(&netdev_dev->remote_addr, 0, sizeof(netdev_dev->remote_addr));
107 netdev_dev->valid_remote_ip = false;
108 netdev_dev->valid_remote_port = false;
109 netdev_dev->connected = false;
112 netdev_dev->sockfd = inet_open_passive(SOCK_DGRAM, "", 0, &netdev_dev->local_addr, 0);
113 if (netdev_dev->sockfd < 0) {
114 error = netdev_dev->sockfd;
119 shash_add(&tunnel_netdev_devs, name, netdev_dev);
123 *netdev_devp = &netdev_dev->netdev_dev;
125 VLOG_DBG("tunnel_create: name=%s, fd=%d, port=%d", name, netdev_dev->sockfd, netdev_dev->local_addr.sin_port);
135 netdev_tunnel_destroy(struct netdev_dev *netdev_dev_)
137 struct netdev_dev_tunnel *netdev_dev = netdev_dev_tunnel_cast(netdev_dev_);
139 if (netdev_dev->sockfd != -1)
140 close(netdev_dev->sockfd);
142 shash_find_and_delete(&tunnel_netdev_devs,
143 netdev_dev_get_name(netdev_dev_));
148 netdev_tunnel_open(struct netdev_dev *netdev_dev_, struct netdev **netdevp)
150 struct netdev_dev_tunnel *netdev_dev = netdev_dev_tunnel_cast(netdev_dev_);
151 struct netdev_tunnel *netdev;
153 netdev = xmalloc(sizeof *netdev);
154 netdev_init(&netdev->netdev, netdev_dev_);
156 *netdevp = &netdev->netdev;
161 netdev_tunnel_close(struct netdev *netdev_)
163 struct netdev_tunnel *netdev = netdev_tunnel_cast(netdev_);
168 netdev_tunnel_get_config(struct netdev_dev *dev_, struct shash *args)
170 struct netdev_dev_tunnel *netdev_dev = netdev_dev_tunnel_cast(dev_);
172 if (netdev_dev->valid_remote_ip)
173 shash_add(args, "remote_ip",
174 xasprintf(IP_FMT, IP_ARGS(&netdev_dev->remote_addr.sin_addr)));
175 if (netdev_dev->valid_remote_port)
176 shash_add(args, "remote_port",
177 xasprintf("%"PRIu16, ntohs(netdev_dev->remote_addr.sin_port)));
182 netdev_tunnel_connect(struct netdev_dev_tunnel *dev)
186 if (!dev->valid_remote_ip || !dev->valid_remote_port)
188 dev->remote_addr.sin_family = AF_INET;
189 if (connect(dev->sockfd, (struct sockaddr*) &dev->remote_addr, sizeof(dev->remote_addr)) < 0) {
192 dev->connected = true;
193 netdev_tunnel_update_seq(dev);
194 VLOG_DBG("%s: connected to (%s, %d)", netdev_dev_get_name(&dev->netdev_dev),
195 inet_ntoa(dev->remote_addr.sin_addr), ntohs(dev->remote_addr.sin_port));
200 netdev_tunnel_set_config(struct netdev_dev *dev_, const struct shash *args)
202 struct netdev_dev_tunnel *netdev_dev = netdev_dev_tunnel_cast(dev_);
203 struct shash_node *node;
205 VLOG_DBG("tunnel_set_config(%s)", netdev_dev_get_name(dev_));
206 SHASH_FOR_EACH(node, args) {
207 VLOG_DBG("arg: %s->%s", node->name, (char*)node->data);
208 if (!strcmp(node->name, "remote_ip")) {
210 if (lookup_ip(node->data, &addr)) {
211 VLOG_WARN("%s: bad 'remote_ip'", node->name);
213 netdev_dev->remote_addr.sin_addr = addr;
214 netdev_dev->valid_remote_ip = true;
216 } else if (!strcmp(node->name, "remote_port")) {
217 netdev_dev->remote_addr.sin_port = htons(atoi(node->data));
218 netdev_dev->valid_remote_port = true;
220 VLOG_WARN("%s: unknown argument '%s'",
221 netdev_dev_get_name(dev_), node->name);
224 return netdev_tunnel_connect(netdev_dev);
228 netdev_tunnel_listen(struct netdev *netdev_)
234 netdev_tunnel_recv(struct netdev *netdev_, void *buffer, size_t size)
236 struct netdev_dev_tunnel *dev =
237 netdev_dev_tunnel_cast(netdev_get_dev(netdev_));
242 retval = recv(dev->sockfd, buffer, size, MSG_TRUNC);
243 VLOG_DBG("%s: recv(%x, %d, MSG_TRUNC) = %d",
244 netdev_get_name(netdev_), buffer, size, retval);
246 return retval <= size ? retval : -EMSGSIZE;
247 } else if (errno != EINTR) {
248 if (errno != EAGAIN) {
249 VLOG_WARN_RL(&rl, "error receiveing Ethernet packet on %s: %s",
250 netdev_get_name(netdev_), strerror(errno));
258 netdev_tunnel_recv_wait(struct netdev *netdev_)
260 struct netdev_dev_tunnel *dev =
261 netdev_dev_tunnel_cast(netdev_get_dev(netdev_));
262 if (dev->sockfd >= 0) {
263 poll_fd_wait(dev->sockfd, POLLIN);
268 netdev_tunnel_send(struct netdev *netdev_, const void *buffer, size_t size)
270 struct netdev_dev_tunnel *dev =
271 netdev_dev_tunnel_cast(netdev_get_dev(netdev_));
276 retval = send(dev->sockfd, buffer, size, 0);
277 VLOG_DBG("%s: send(%x, %d) = %d", netdev_get_name(netdev_), buffer, size, retval);
279 if (retval != size) {
280 VLOG_WARN_RL(&rl, "sent partial Ethernet packet (%zd bytes of "
281 "%zu) on %s", retval, size, netdev_get_name(netdev_));
284 } else if (errno != EINTR) {
285 if (errno != EAGAIN) {
286 VLOG_WARN_RL(&rl, "error sending Ethernet packet on %s: %s",
287 netdev_get_name(netdev_), strerror(errno));
295 netdev_tunnel_send_wait(struct netdev *netdev_)
297 struct netdev_dev_tunnel *dev =
298 netdev_dev_tunnel_cast(netdev_get_dev(netdev_));
299 if (dev->sockfd >= 0) {
300 poll_fd_wait(dev->sockfd, POLLOUT);
305 netdev_tunnel_drain(struct netdev *netdev_)
307 struct netdev_dev_tunnel *dev =
308 netdev_dev_tunnel_cast(netdev_get_dev(netdev_));
315 error = recv(dev->sockfd, buffer, 128, MSG_TRUNC);
317 if (error == -EAGAIN)
319 else if (error != -EMSGSIZE)
327 netdev_tunnel_set_etheraddr(struct netdev *netdev,
328 const uint8_t mac[ETH_ADDR_LEN])
330 struct netdev_dev_tunnel *dev =
331 netdev_dev_tunnel_cast(netdev_get_dev(netdev));
333 if (!eth_addr_equals(dev->hwaddr, mac)) {
334 memcpy(dev->hwaddr, mac, ETH_ADDR_LEN);
335 netdev_tunnel_update_seq(dev);
342 netdev_tunnel_get_etheraddr(const struct netdev *netdev,
343 uint8_t mac[ETH_ADDR_LEN])
345 const struct netdev_dev_tunnel *dev =
346 netdev_dev_tunnel_cast(netdev_get_dev(netdev));
348 memcpy(mac, dev->hwaddr, ETH_ADDR_LEN);
354 netdev_tunnel_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
356 const struct netdev_dev_tunnel *dev =
357 netdev_dev_tunnel_cast(netdev_get_dev(netdev));
364 netdev_tunnel_set_stats(struct netdev *netdev, const struct netdev_stats *stats)
366 struct netdev_dev_tunnel *dev =
367 netdev_dev_tunnel_cast(netdev_get_dev(netdev));
374 netdev_tunnel_update_flags(struct netdev *netdev,
375 enum netdev_flags off, enum netdev_flags on,
376 enum netdev_flags *old_flagsp)
378 struct netdev_dev_tunnel *dev =
379 netdev_dev_tunnel_cast(netdev_get_dev(netdev));
381 if ((off | on) & ~(NETDEV_UP | NETDEV_PROMISC)) {
385 // XXX should we actually do something with this flags?
386 *old_flagsp = dev->flags;
389 if (*old_flagsp != dev->flags) {
390 netdev_tunnel_update_seq(dev);
396 netdev_tunnel_change_seq(const struct netdev *netdev)
398 return netdev_dev_tunnel_cast(netdev_get_dev(netdev))->change_seq;
401 /* Helper functions. */
404 netdev_tunnel_update_seq(struct netdev_dev_tunnel *dev)
407 if (!dev->change_seq) {
413 netdev_tunnel_get_port(struct unixctl_conn *conn,
414 int argc, const char *argv[], void *aux OVS_UNUSED)
416 struct netdev_dev_tunnel *tunnel_dev;
420 tunnel_dev = shash_find_data(&tunnel_netdev_devs, argv[1]);
422 unixctl_command_reply_error(conn, "no such tunnel netdev");
426 sprintf(buf, "%d", ntohs(tunnel_dev->local_addr.sin_port));
427 unixctl_command_reply(conn, buf);
432 netdev_tunnel_init(void)
434 unixctl_command_register("netdev-tunnel/get-port", "NAME",
435 1, 1, netdev_tunnel_get_port, NULL);
439 const struct netdev_class netdev_tunnel_class = {
441 netdev_tunnel_init, /* init */
445 netdev_tunnel_create,
446 netdev_tunnel_destroy,
447 netdev_tunnel_get_config,
448 netdev_tunnel_set_config,
453 netdev_tunnel_listen,
455 netdev_tunnel_recv_wait,
459 netdev_tunnel_send_wait,
461 netdev_tunnel_set_etheraddr,
462 netdev_tunnel_get_etheraddr,
465 NULL, /* get_ifindex */
466 NULL, /* get_carrier */
467 NULL, /* get_carrier_resets */
468 NULL, /* get_miimon */
469 netdev_tunnel_get_stats,
470 netdev_tunnel_set_stats,
472 NULL, /* get_features */
473 NULL, /* set_advertisements */
475 NULL, /* set_policing */
476 NULL, /* get_qos_types */
477 NULL, /* get_qos_capabilities */
480 NULL, /* get_queue */
481 NULL, /* set_queue */
482 NULL, /* delete_queue */
483 NULL, /* get_queue_stats */
484 NULL, /* dump_queues */
485 NULL, /* dump_queue_stats */
490 NULL, /* add_router */
491 NULL, /* get_next_hop */
492 NULL, /* get_drv_info */
493 NULL, /* arp_lookup */
495 netdev_tunnel_update_flags,
497 netdev_tunnel_change_seq