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.
19 #include "netdev-vport.h"
23 #include <sys/socket.h>
25 #include <sys/ioctl.h>
27 #include "byte-order.h"
34 #include "netdev-provider.h"
37 #include "route-table.h"
39 #include "socket-util.h"
42 VLOG_DEFINE_THIS_MODULE(netdev_vport);
44 #define VXLAN_DST_PORT 4789
45 #define LISP_DST_PORT 4341
47 #define DEFAULT_TTL 64
51 unsigned int change_seq;
52 uint8_t etheraddr[ETH_ADDR_LEN];
53 struct netdev_stats stats;
56 struct netdev_tunnel_config tnl_cfg;
63 const char *dpif_port;
64 struct netdev_class netdev_class;
67 static int netdev_vport_create(const struct netdev_class *, const char *,
69 static int get_patch_config(const struct netdev *, struct smap *args);
70 static int get_tunnel_config(const struct netdev *, struct smap *args);
71 static void netdev_vport_poll_notify(struct netdev_vport *);
74 is_vport_class(const struct netdev_class *class)
76 return class->create == netdev_vport_create;
79 static const struct vport_class *
80 vport_class_cast(const struct netdev_class *class)
82 ovs_assert(is_vport_class(class));
83 return CONTAINER_OF(class, struct vport_class, netdev_class);
86 static struct netdev_vport *
87 netdev_vport_cast(const struct netdev *netdev)
89 ovs_assert(is_vport_class(netdev_get_class(netdev)));
90 return CONTAINER_OF(netdev, struct netdev_vport, up);
93 static const struct netdev_tunnel_config *
94 get_netdev_tunnel_config(const struct netdev *netdev)
96 return &netdev_vport_cast(netdev)->tnl_cfg;
100 netdev_vport_is_patch(const struct netdev *netdev)
102 const struct netdev_class *class = netdev_get_class(netdev);
104 return class->get_config == get_patch_config;
108 netdev_vport_needs_dst_port(const struct netdev *dev)
110 const struct netdev_class *class = netdev_get_class(dev);
111 const char *type = netdev_get_type(dev);
113 return (class->get_config == get_tunnel_config &&
114 (!strcmp("vxlan", type) || !strcmp("lisp", type)));
118 netdev_vport_get_dpif_port(const struct netdev *netdev)
120 const char *dpif_port;
122 if (netdev_vport_needs_dst_port(netdev)) {
123 const struct netdev_vport *vport = netdev_vport_cast(netdev);
124 const char *type = netdev_get_type(netdev);
125 static char dpif_port_combined[IFNAMSIZ];
128 * Note: IFNAMSIZ is 16 bytes long. The maximum length of a VXLAN
129 * or LISP port name below is 15 or 14 bytes respectively. Still,
130 * assert here on the size of strlen(type) in case that changes
133 ovs_assert(strlen(type) + 10 < IFNAMSIZ);
134 snprintf(dpif_port_combined, IFNAMSIZ, "%s_sys_%d", type,
135 ntohs(vport->tnl_cfg.dst_port));
136 return dpif_port_combined;
138 const struct netdev_class *class = netdev_get_class(netdev);
139 dpif_port = (is_vport_class(class)
140 ? vport_class_cast(class)->dpif_port
144 return dpif_port ? dpif_port : netdev_get_name(netdev);
148 netdev_vport_create(const struct netdev_class *netdev_class, const char *name,
149 struct netdev **netdevp)
151 struct netdev_vport *dev;
153 dev = xzalloc(sizeof *dev);
154 netdev_init(&dev->up, name, netdev_class);
156 eth_addr_random(dev->etheraddr);
159 route_table_register();
165 netdev_vport_destroy(struct netdev *netdev_)
167 struct netdev_vport *netdev = netdev_vport_cast(netdev_);
169 route_table_unregister();
175 netdev_vport_set_etheraddr(struct netdev *netdev_,
176 const uint8_t mac[ETH_ADDR_LEN])
178 struct netdev_vport *netdev = netdev_vport_cast(netdev_);
179 memcpy(netdev->etheraddr, mac, ETH_ADDR_LEN);
180 netdev_vport_poll_notify(netdev);
185 netdev_vport_get_etheraddr(const struct netdev *netdev,
186 uint8_t mac[ETH_ADDR_LEN])
188 memcpy(mac, netdev_vport_cast(netdev)->etheraddr, ETH_ADDR_LEN);
193 tunnel_get_status(const struct netdev *netdev, struct smap *smap)
195 static char iface[IFNAMSIZ];
198 route = netdev_vport_cast(netdev)->tnl_cfg.ip_dst;
199 if (route_table_get_name(route, iface)) {
200 struct netdev *egress_netdev;
202 smap_add(smap, "tunnel_egress_iface", iface);
204 if (!netdev_open(iface, "system", &egress_netdev)) {
205 smap_add(smap, "tunnel_egress_iface_carrier",
206 netdev_get_carrier(egress_netdev) ? "up" : "down");
207 netdev_close(egress_netdev);
215 netdev_vport_update_flags(struct netdev *netdev OVS_UNUSED,
216 enum netdev_flags off,
217 enum netdev_flags on OVS_UNUSED,
218 enum netdev_flags *old_flagsp)
220 if (off & (NETDEV_UP | NETDEV_PROMISC)) {
224 *old_flagsp = NETDEV_UP | NETDEV_PROMISC;
229 netdev_vport_change_seq(const struct netdev *netdev)
231 return netdev_vport_cast(netdev)->change_seq;
235 netdev_vport_run(void)
241 netdev_vport_wait(void)
246 /* Helper functions. */
249 netdev_vport_poll_notify(struct netdev_vport *ndv)
252 if (!ndv->change_seq) {
257 /* Code specific to tunnel types. */
260 parse_key(const struct smap *args, const char *name,
261 bool *present, bool *flow)
268 s = smap_get(args, name);
270 s = smap_get(args, "key");
278 if (!strcmp(s, "flow")) {
282 return htonll(strtoull(s, NULL, 0));
287 set_tunnel_config(struct netdev *dev_, const struct smap *args)
289 struct netdev_vport *dev = netdev_vport_cast(dev_);
290 const char *name = netdev_get_name(dev_);
291 const char *type = netdev_get_type(dev_);
292 bool ipsec_mech_set, needs_dst_port, has_csum;
293 struct netdev_tunnel_config tnl_cfg;
294 struct smap_node *node;
296 has_csum = strstr(type, "gre");
297 ipsec_mech_set = false;
298 memset(&tnl_cfg, 0, sizeof tnl_cfg);
300 needs_dst_port = netdev_vport_needs_dst_port(dev_);
301 tnl_cfg.ipsec = strstr(type, "ipsec");
302 tnl_cfg.dont_fragment = true;
304 SMAP_FOR_EACH (node, args) {
305 if (!strcmp(node->key, "remote_ip")) {
306 struct in_addr in_addr;
307 if (!strcmp(node->value, "flow")) {
308 tnl_cfg.ip_dst_flow = true;
309 tnl_cfg.ip_dst = htonl(0);
310 } else if (lookup_ip(node->value, &in_addr)) {
311 VLOG_WARN("%s: bad %s 'remote_ip'", name, type);
312 } else if (ip_is_multicast(in_addr.s_addr)) {
313 VLOG_WARN("%s: multicast remote_ip="IP_FMT" not allowed",
314 name, IP_ARGS(in_addr.s_addr));
317 tnl_cfg.ip_dst = in_addr.s_addr;
319 } else if (!strcmp(node->key, "local_ip")) {
320 struct in_addr in_addr;
321 if (!strcmp(node->value, "flow")) {
322 tnl_cfg.ip_src_flow = true;
323 tnl_cfg.ip_src = htonl(0);
324 } else if (lookup_ip(node->value, &in_addr)) {
325 VLOG_WARN("%s: bad %s 'local_ip'", name, type);
327 tnl_cfg.ip_src = in_addr.s_addr;
329 } else if (!strcmp(node->key, "tos")) {
330 if (!strcmp(node->value, "inherit")) {
331 tnl_cfg.tos_inherit = true;
335 tos = strtol(node->value, &endptr, 0);
336 if (*endptr == '\0' && tos == (tos & IP_DSCP_MASK)) {
339 VLOG_WARN("%s: invalid TOS %s", name, node->value);
342 } else if (!strcmp(node->key, "ttl")) {
343 if (!strcmp(node->value, "inherit")) {
344 tnl_cfg.ttl_inherit = true;
346 tnl_cfg.ttl = atoi(node->value);
348 } else if (!strcmp(node->key, "dst_port") && needs_dst_port) {
349 tnl_cfg.dst_port = htons(atoi(node->value));
350 } else if (!strcmp(node->key, "csum") && has_csum) {
351 if (!strcmp(node->value, "true")) {
354 } else if (!strcmp(node->key, "df_default")) {
355 if (!strcmp(node->value, "false")) {
356 tnl_cfg.dont_fragment = false;
358 } else if (!strcmp(node->key, "peer_cert") && tnl_cfg.ipsec) {
359 if (smap_get(args, "certificate")) {
360 ipsec_mech_set = true;
362 const char *use_ssl_cert;
364 /* If the "use_ssl_cert" is true, then "certificate" and
365 * "private_key" will be pulled from the SSL table. The
366 * use of this option is strongly discouraged, since it
367 * will like be removed when multiple SSL configurations
368 * are supported by OVS.
370 use_ssl_cert = smap_get(args, "use_ssl_cert");
371 if (!use_ssl_cert || strcmp(use_ssl_cert, "true")) {
372 VLOG_ERR("%s: 'peer_cert' requires 'certificate' argument",
376 ipsec_mech_set = true;
378 } else if (!strcmp(node->key, "psk") && tnl_cfg.ipsec) {
379 ipsec_mech_set = true;
380 } else if (tnl_cfg.ipsec
381 && (!strcmp(node->key, "certificate")
382 || !strcmp(node->key, "private_key")
383 || !strcmp(node->key, "use_ssl_cert"))) {
384 /* Ignore options not used by the netdev. */
385 } else if (!strcmp(node->key, "key") ||
386 !strcmp(node->key, "in_key") ||
387 !strcmp(node->key, "out_key")) {
388 /* Handled separately below. */
390 VLOG_WARN("%s: unknown %s argument '%s'", name, type, node->key);
394 /* Add a default destination port for VXLAN if none specified. */
395 if (!strcmp(type, "vxlan") && !tnl_cfg.dst_port) {
396 tnl_cfg.dst_port = htons(VXLAN_DST_PORT);
399 /* Add a default destination port for LISP if none specified. */
400 if (!strcmp(type, "lisp") && !tnl_cfg.dst_port) {
401 tnl_cfg.dst_port = htons(LISP_DST_PORT);
405 static pid_t pid = 0;
407 char *file_name = xasprintf("%s/%s", ovs_rundir(),
408 "ovs-monitor-ipsec.pid");
409 pid = read_pidfile(file_name);
414 VLOG_ERR("%s: IPsec requires the ovs-monitor-ipsec daemon",
419 if (smap_get(args, "peer_cert") && smap_get(args, "psk")) {
420 VLOG_ERR("%s: cannot define both 'peer_cert' and 'psk'", name);
424 if (!ipsec_mech_set) {
425 VLOG_ERR("%s: IPsec requires an 'peer_cert' or psk' argument",
431 if (!tnl_cfg.ip_dst && !tnl_cfg.ip_dst_flow) {
432 VLOG_ERR("%s: %s type requires valid 'remote_ip' argument",
436 if (tnl_cfg.ip_src_flow && !tnl_cfg.ip_dst_flow) {
437 VLOG_ERR("%s: %s type requires 'remote_ip=flow' with 'local_ip=flow'",
442 tnl_cfg.ttl = DEFAULT_TTL;
445 tnl_cfg.in_key = parse_key(args, "in_key",
446 &tnl_cfg.in_key_present,
447 &tnl_cfg.in_key_flow);
449 tnl_cfg.out_key = parse_key(args, "out_key",
450 &tnl_cfg.out_key_present,
451 &tnl_cfg.out_key_flow);
453 dev->tnl_cfg = tnl_cfg;
454 netdev_vport_poll_notify(dev);
460 get_tunnel_config(const struct netdev *dev, struct smap *args)
462 const struct netdev_tunnel_config *tnl_cfg =
463 &netdev_vport_cast(dev)->tnl_cfg;
465 if (tnl_cfg->ip_dst) {
466 smap_add_format(args, "remote_ip", IP_FMT, IP_ARGS(tnl_cfg->ip_dst));
467 } else if (tnl_cfg->ip_dst_flow) {
468 smap_add(args, "remote_ip", "flow");
471 if (tnl_cfg->ip_src) {
472 smap_add_format(args, "local_ip", IP_FMT, IP_ARGS(tnl_cfg->ip_src));
473 } else if (tnl_cfg->ip_src_flow) {
474 smap_add(args, "local_ip", "flow");
477 if (tnl_cfg->in_key_flow && tnl_cfg->out_key_flow) {
478 smap_add(args, "key", "flow");
479 } else if (tnl_cfg->in_key_present && tnl_cfg->out_key_present
480 && tnl_cfg->in_key == tnl_cfg->out_key) {
481 smap_add_format(args, "key", "%"PRIu64, ntohll(tnl_cfg->in_key));
483 if (tnl_cfg->in_key_flow) {
484 smap_add(args, "in_key", "flow");
485 } else if (tnl_cfg->in_key_present) {
486 smap_add_format(args, "in_key", "%"PRIu64,
487 ntohll(tnl_cfg->in_key));
490 if (tnl_cfg->out_key_flow) {
491 smap_add(args, "out_key", "flow");
492 } else if (tnl_cfg->out_key_present) {
493 smap_add_format(args, "out_key", "%"PRIu64,
494 ntohll(tnl_cfg->out_key));
498 if (tnl_cfg->ttl_inherit) {
499 smap_add(args, "ttl", "inherit");
500 } else if (tnl_cfg->ttl != DEFAULT_TTL) {
501 smap_add_format(args, "ttl", "%"PRIu8, tnl_cfg->ttl);
504 if (tnl_cfg->tos_inherit) {
505 smap_add(args, "tos", "inherit");
506 } else if (tnl_cfg->tos) {
507 smap_add_format(args, "tos", "0x%x", tnl_cfg->tos);
510 if (tnl_cfg->dst_port) {
511 uint16_t dst_port = ntohs(tnl_cfg->dst_port);
512 const char *type = netdev_get_type(dev);
514 if ((!strcmp("vxlan", type) && dst_port != VXLAN_DST_PORT) ||
515 (!strcmp("lisp", type) && dst_port != LISP_DST_PORT)) {
516 smap_add_format(args, "dst_port", "%d", dst_port);
521 smap_add(args, "csum", "true");
524 if (!tnl_cfg->dont_fragment) {
525 smap_add(args, "df_default", "false");
531 /* Code specific to patch ports. */
534 netdev_vport_patch_peer(const struct netdev *netdev)
536 return (netdev_vport_is_patch(netdev)
537 ? netdev_vport_cast(netdev)->peer
542 netdev_vport_inc_rx(const struct netdev *netdev,
543 const struct dpif_flow_stats *stats)
545 if (is_vport_class(netdev_get_class(netdev))) {
546 struct netdev_vport *dev = netdev_vport_cast(netdev);
547 dev->stats.rx_packets += stats->n_packets;
548 dev->stats.rx_bytes += stats->n_bytes;
553 netdev_vport_inc_tx(const struct netdev *netdev,
554 const struct dpif_flow_stats *stats)
556 if (is_vport_class(netdev_get_class(netdev))) {
557 struct netdev_vport *dev = netdev_vport_cast(netdev);
558 dev->stats.tx_packets += stats->n_packets;
559 dev->stats.tx_bytes += stats->n_bytes;
564 get_patch_config(const struct netdev *dev_, struct smap *args)
566 struct netdev_vport *dev = netdev_vport_cast(dev_);
569 smap_add(args, "peer", dev->peer);
575 set_patch_config(struct netdev *dev_, const struct smap *args)
577 struct netdev_vport *dev = netdev_vport_cast(dev_);
578 const char *name = netdev_get_name(dev_);
581 peer = smap_get(args, "peer");
583 VLOG_ERR("%s: patch type requires valid 'peer' argument", name);
587 if (smap_count(args) > 1) {
588 VLOG_ERR("%s: patch type takes only a 'peer' argument", name);
592 if (!strcmp(name, peer)) {
593 VLOG_ERR("%s: patch peer must not be self", name);
598 dev->peer = xstrdup(peer);
604 get_stats(const struct netdev *netdev, struct netdev_stats *stats)
606 struct netdev_vport *dev = netdev_vport_cast(netdev);
607 memcpy(stats, &dev->stats, sizeof *stats);
611 #define VPORT_FUNCTIONS(GET_CONFIG, SET_CONFIG, \
612 GET_TUNNEL_CONFIG, GET_STATUS) \
617 netdev_vport_create, \
618 netdev_vport_destroy, \
623 NULL, /* rx_open */ \
626 NULL, /* send_wait */ \
628 netdev_vport_set_etheraddr, \
629 netdev_vport_get_etheraddr, \
630 NULL, /* get_mtu */ \
631 NULL, /* set_mtu */ \
632 NULL, /* get_ifindex */ \
633 NULL, /* get_carrier */ \
634 NULL, /* get_carrier_resets */ \
635 NULL, /* get_miimon */ \
637 NULL, /* set_stats */ \
639 NULL, /* get_features */ \
640 NULL, /* set_advertisements */ \
642 NULL, /* set_policing */ \
643 NULL, /* get_qos_types */ \
644 NULL, /* get_qos_capabilities */ \
645 NULL, /* get_qos */ \
646 NULL, /* set_qos */ \
647 NULL, /* get_queue */ \
648 NULL, /* set_queue */ \
649 NULL, /* delete_queue */ \
650 NULL, /* get_queue_stats */ \
651 NULL, /* dump_queues */ \
652 NULL, /* dump_queue_stats */ \
654 NULL, /* get_in4 */ \
655 NULL, /* set_in4 */ \
656 NULL, /* get_in6 */ \
657 NULL, /* add_router */ \
658 NULL, /* get_next_hop */ \
660 NULL, /* arp_lookup */ \
662 netdev_vport_update_flags, \
664 netdev_vport_change_seq
666 #define TUNNEL_CLASS(NAME, DPIF_PORT) \
668 { NAME, VPORT_FUNCTIONS(get_tunnel_config, \
670 get_netdev_tunnel_config, \
671 tunnel_get_status) }}
674 netdev_vport_tunnel_register(void)
676 static const struct vport_class vport_classes[] = {
677 TUNNEL_CLASS("gre", "gre_system"),
678 TUNNEL_CLASS("ipsec_gre", "gre_system"),
679 TUNNEL_CLASS("gre64", "gre64_system"),
680 TUNNEL_CLASS("ipsec_gre64", "gre64_system"),
681 TUNNEL_CLASS("vxlan", "vxlan_system"),
682 TUNNEL_CLASS("lisp", "lisp_system")
687 for (i = 0; i < ARRAY_SIZE(vport_classes); i++) {
688 netdev_register_provider(&vport_classes[i].netdev_class);
693 netdev_vport_patch_register(void)
695 static const struct vport_class patch_class =
697 { "patch", VPORT_FUNCTIONS(get_patch_config,
701 netdev_register_provider(&patch_class.netdev_class);