2 * Copyright (c) 2010, 2011 Nicira Networks.
3 * Distributed under the terms of the GNU GPL version 2.
5 * Significant portions of this file may be copied from parts of the Linux
6 * kernel, by Linus Torvalds and others.
9 #include <linux/if_arp.h>
10 #include <linux/if_ether.h>
12 #include <linux/if_vlan.h>
14 #include <linux/in_route.h>
15 #include <linux/jhash.h>
16 #include <linux/kernel.h>
17 #include <linux/version.h>
18 #include <linux/workqueue.h>
20 #include <net/dsfield.h>
23 #include <net/inet_ecn.h>
25 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
28 #include <net/route.h>
38 #include "vport-generic.h"
39 #include "vport-internal_dev.h"
41 #ifdef NEED_CACHE_TIMEOUT
43 * On kernels where we can't quickly detect changes in the rest of the system
44 * we use an expiration time to invalidate the cache. A shorter expiration
45 * reduces the length of time that we may potentially blackhole packets while
46 * a longer time increases performance by reducing the frequency that the
47 * cache needs to be rebuilt. A variety of factors may cause the cache to be
48 * invalidated before the expiration time but this is the maximum. The time
49 * is expressed in jiffies.
51 #define MAX_CACHE_EXP HZ
55 * Interval to check for and remove caches that are no longer valid. Caches
56 * are checked for validity before they are used for packet encapsulation and
57 * old caches are removed at that time. However, if no packets are sent through
58 * the tunnel then the cache will never be destroyed. Since it holds
59 * references to a number of system objects, the cache will continue to use
60 * system resources by not allowing those objects to be destroyed. The cache
61 * cleaner is periodically run to free invalid caches. It does not
62 * significantly affect system performance. A lower interval will release
63 * resources faster but will itself consume resources by requiring more frequent
64 * checks. A longer interval may result in messages being printed to the kernel
65 * message buffer about unreleased resources. The interval is expressed in
68 #define CACHE_CLEANER_INTERVAL (5 * HZ)
70 #define CACHE_DATA_ALIGN 16
72 static struct tbl __rcu *port_table __read_mostly;
74 static void cache_cleaner(struct work_struct *work);
75 static DECLARE_DELAYED_WORK(cache_cleaner_wq, cache_cleaner);
78 * These are just used as an optimization: they don't require any kind of
79 * synchronization because we could have just as easily read the value before
80 * the port change happened.
82 static unsigned int key_local_remote_ports __read_mostly;
83 static unsigned int key_remote_ports __read_mostly;
84 static unsigned int local_remote_ports __read_mostly;
85 static unsigned int remote_ports __read_mostly;
87 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,36)
88 #define rt_dst(rt) (rt->dst)
90 #define rt_dst(rt) (rt->u.dst)
93 static inline struct vport *tnl_vport_to_vport(const struct tnl_vport *tnl_vport)
95 return vport_from_priv(tnl_vport);
98 static inline struct tnl_vport *tnl_vport_table_cast(const struct tbl_node *node)
100 return container_of(node, struct tnl_vport, tbl_node);
103 /* This is analogous to rtnl_dereference for the tunnel cache. It checks that
104 * cache_lock is held, so it is only for update side code.
106 static inline struct tnl_cache *cache_dereference(struct tnl_vport *tnl_vport)
108 return rcu_dereference_protected(tnl_vport->cache,
109 lockdep_is_held(&tnl_vport->cache_lock));
112 static inline void schedule_cache_cleaner(void)
114 schedule_delayed_work(&cache_cleaner_wq, CACHE_CLEANER_INTERVAL);
117 static void free_cache(struct tnl_cache *cache)
122 flow_put(cache->flow);
123 ip_rt_put(cache->rt);
127 static void free_config_rcu(struct rcu_head *rcu)
129 struct tnl_mutable_config *c = container_of(rcu, struct tnl_mutable_config, rcu);
133 static void free_cache_rcu(struct rcu_head *rcu)
135 struct tnl_cache *c = container_of(rcu, struct tnl_cache, rcu);
139 static void assign_config_rcu(struct vport *vport,
140 struct tnl_mutable_config *new_config)
142 struct tnl_vport *tnl_vport = tnl_vport_priv(vport);
143 struct tnl_mutable_config *old_config;
145 old_config = rtnl_dereference(tnl_vport->mutable);
146 rcu_assign_pointer(tnl_vport->mutable, new_config);
147 call_rcu(&old_config->rcu, free_config_rcu);
150 static void assign_cache_rcu(struct vport *vport, struct tnl_cache *new_cache)
152 struct tnl_vport *tnl_vport = tnl_vport_priv(vport);
153 struct tnl_cache *old_cache;
155 old_cache = cache_dereference(tnl_vport);
156 rcu_assign_pointer(tnl_vport->cache, new_cache);
159 call_rcu(&old_cache->rcu, free_cache_rcu);
162 static unsigned int *find_port_pool(const struct tnl_mutable_config *mutable)
164 if (mutable->flags & TNL_F_IN_KEY_MATCH) {
166 return &local_remote_ports;
168 return &remote_ports;
171 return &key_local_remote_ports;
173 return &key_remote_ports;
177 struct port_lookup_key {
178 const struct tnl_mutable_config *mutable;
186 * Modifies 'target' to store the rcu_dereferenced pointer that was used to do
189 static int port_cmp(const struct tbl_node *node, void *target, int unused)
191 const struct tnl_vport *tnl_vport = tnl_vport_table_cast(node);
192 struct port_lookup_key *lookup = target;
194 lookup->mutable = rcu_dereference_rtnl(tnl_vport->mutable);
196 return (lookup->mutable->tunnel_type == lookup->tunnel_type &&
197 lookup->mutable->daddr == lookup->daddr &&
198 lookup->mutable->in_key == lookup->key &&
199 lookup->mutable->saddr == lookup->saddr);
202 static u32 port_hash(struct port_lookup_key *k)
204 u32 x = jhash_3words((__force u32)k->saddr, (__force u32)k->daddr,
206 return jhash_2words((__force u64)k->key >> 32, (__force u32)k->key, x);
209 static u32 mutable_hash(const struct tnl_mutable_config *mutable)
211 struct port_lookup_key lookup;
213 lookup.saddr = mutable->saddr;
214 lookup.daddr = mutable->daddr;
215 lookup.key = mutable->in_key;
216 lookup.tunnel_type = mutable->tunnel_type;
218 return port_hash(&lookup);
221 static void check_table_empty(void)
223 struct tbl *old_table = rtnl_dereference(port_table);
225 if (tbl_count(old_table) == 0) {
226 cancel_delayed_work_sync(&cache_cleaner_wq);
227 rcu_assign_pointer(port_table, NULL);
228 tbl_deferred_destroy(old_table, NULL);
232 static int add_port(struct vport *vport)
234 struct tbl *cur_table = rtnl_dereference(port_table);
235 struct tnl_vport *tnl_vport = tnl_vport_priv(vport);
239 struct tbl *new_table;
241 new_table = tbl_create(TBL_MIN_BUCKETS);
245 rcu_assign_pointer(port_table, new_table);
246 schedule_cache_cleaner();
248 } else if (tbl_count(cur_table) > tbl_n_buckets(cur_table)) {
249 struct tbl *new_table;
251 new_table = tbl_expand(cur_table);
252 if (IS_ERR(new_table))
253 return PTR_ERR(new_table);
255 rcu_assign_pointer(port_table, new_table);
256 tbl_deferred_destroy(cur_table, NULL);
259 err = tbl_insert(rtnl_dereference(port_table), &tnl_vport->tbl_node,
260 mutable_hash(rtnl_dereference(tnl_vport->mutable)));
266 (*find_port_pool(rtnl_dereference(tnl_vport->mutable)))++;
271 static int move_port(struct vport *vport, struct tnl_mutable_config *new_mutable)
274 struct tbl *cur_table = rtnl_dereference(port_table);
275 struct tnl_vport *tnl_vport = tnl_vport_priv(vport);
278 hash = mutable_hash(new_mutable);
279 if (hash == tnl_vport->tbl_node.hash)
283 * Ideally we should make this move atomic to avoid having gaps in
284 * finding tunnels or the possibility of failure. However, if we do
285 * find a tunnel it will always be consistent.
287 err = tbl_remove(cur_table, &tnl_vport->tbl_node);
291 err = tbl_insert(cur_table, &tnl_vport->tbl_node, hash);
293 (*find_port_pool(rtnl_dereference(tnl_vport->mutable)))--;
299 (*find_port_pool(rtnl_dereference(tnl_vport->mutable)))--;
300 assign_config_rcu(vport, new_mutable);
301 (*find_port_pool(rtnl_dereference(tnl_vport->mutable)))++;
306 static int del_port(struct vport *vport)
308 struct tnl_vport *tnl_vport = tnl_vport_priv(vport);
311 err = tbl_remove(rtnl_dereference(port_table), &tnl_vport->tbl_node);
316 (*find_port_pool(rtnl_dereference(tnl_vport->mutable)))--;
321 struct vport *tnl_find_port(__be32 saddr, __be32 daddr, __be64 key,
323 const struct tnl_mutable_config **mutable)
325 struct port_lookup_key lookup;
326 struct tbl *table = rcu_dereference_rtnl(port_table);
327 struct tbl_node *tbl_node;
329 if (unlikely(!table))
332 lookup.saddr = saddr;
333 lookup.daddr = daddr;
335 if (tunnel_type & TNL_T_KEY_EXACT) {
337 lookup.tunnel_type = tunnel_type & ~TNL_T_KEY_MATCH;
339 if (key_local_remote_ports) {
340 tbl_node = tbl_lookup(table, &lookup, sizeof(lookup),
341 port_hash(&lookup), port_cmp);
346 if (key_remote_ports) {
349 tbl_node = tbl_lookup(table, &lookup, sizeof(lookup),
350 port_hash(&lookup), port_cmp);
354 lookup.saddr = saddr;
358 if (tunnel_type & TNL_T_KEY_MATCH) {
360 lookup.tunnel_type = tunnel_type & ~TNL_T_KEY_EXACT;
362 if (local_remote_ports) {
363 tbl_node = tbl_lookup(table, &lookup, sizeof(lookup),
364 port_hash(&lookup), port_cmp);
372 tbl_node = tbl_lookup(table, &lookup, sizeof(lookup),
373 port_hash(&lookup), port_cmp);
382 *mutable = lookup.mutable;
383 return tnl_vport_to_vport(tnl_vport_table_cast(tbl_node));
386 static void ecn_decapsulate(struct sk_buff *skb, u8 tos)
388 if (unlikely(INET_ECN_is_ce(tos))) {
389 __be16 protocol = skb->protocol;
391 skb_set_network_header(skb, ETH_HLEN);
393 if (protocol == htons(ETH_P_8021Q)) {
394 if (unlikely(!pskb_may_pull(skb, VLAN_ETH_HLEN)))
397 protocol = vlan_eth_hdr(skb)->h_vlan_encapsulated_proto;
398 skb_set_network_header(skb, VLAN_ETH_HLEN);
401 if (protocol == htons(ETH_P_IP)) {
402 if (unlikely(!pskb_may_pull(skb, skb_network_offset(skb)
403 + sizeof(struct iphdr))))
406 IP_ECN_set_ce(ip_hdr(skb));
408 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
409 else if (protocol == htons(ETH_P_IPV6)) {
410 if (unlikely(!pskb_may_pull(skb, skb_network_offset(skb)
411 + sizeof(struct ipv6hdr))))
414 IP6_ECN_set_ce(ipv6_hdr(skb));
421 * tnl_rcv - ingress point for generic tunnel code
423 * @vport: port this packet was received on
424 * @skb: received packet
425 * @tos: ToS from encapsulating IP packet, used to copy ECN bits
427 * Must be called with rcu_read_lock.
429 * Packets received by this function are in the following state:
430 * - skb->data points to the inner Ethernet header.
431 * - The inner Ethernet header is in the linear data area.
432 * - skb->csum does not include the inner Ethernet header.
433 * - The layer pointers are undefined.
435 void tnl_rcv(struct vport *vport, struct sk_buff *skb, u8 tos)
439 skb_reset_mac_header(skb);
442 if (likely(ntohs(eh->h_proto) >= 1536))
443 skb->protocol = eh->h_proto;
445 skb->protocol = htons(ETH_P_802_2);
449 skb_clear_rxhash(skb);
452 ecn_decapsulate(skb, tos);
453 vlan_set_tci(skb, 0);
455 if (unlikely(compute_ip_summed(skb, false))) {
460 vport_receive(vport, skb);
463 static bool check_ipv4_address(__be32 addr)
465 if (ipv4_is_multicast(addr) || ipv4_is_lbcast(addr)
466 || ipv4_is_loopback(addr) || ipv4_is_zeronet(addr))
472 static bool ipv4_should_icmp(struct sk_buff *skb)
474 struct iphdr *old_iph = ip_hdr(skb);
476 /* Don't respond to L2 broadcast. */
477 if (is_multicast_ether_addr(eth_hdr(skb)->h_dest))
480 /* Don't respond to L3 broadcast or invalid addresses. */
481 if (!check_ipv4_address(old_iph->daddr) ||
482 !check_ipv4_address(old_iph->saddr))
485 /* Only respond to the first fragment. */
486 if (old_iph->frag_off & htons(IP_OFFSET))
489 /* Don't respond to ICMP error messages. */
490 if (old_iph->protocol == IPPROTO_ICMP) {
491 u8 icmp_type, *icmp_typep;
493 icmp_typep = skb_header_pointer(skb, (u8 *)old_iph +
494 (old_iph->ihl << 2) +
495 offsetof(struct icmphdr, type) -
496 skb->data, sizeof(icmp_type),
502 if (*icmp_typep > NR_ICMP_TYPES
503 || (*icmp_typep <= ICMP_PARAMETERPROB
504 && *icmp_typep != ICMP_ECHOREPLY
505 && *icmp_typep != ICMP_ECHO))
512 static void ipv4_build_icmp(struct sk_buff *skb, struct sk_buff *nskb,
513 unsigned int mtu, unsigned int payload_length)
515 struct iphdr *iph, *old_iph = ip_hdr(skb);
516 struct icmphdr *icmph;
519 iph = (struct iphdr *)skb_put(nskb, sizeof(struct iphdr));
520 icmph = (struct icmphdr *)skb_put(nskb, sizeof(struct icmphdr));
521 payload = skb_put(nskb, payload_length);
525 iph->ihl = sizeof(struct iphdr) >> 2;
526 iph->tos = (old_iph->tos & IPTOS_TOS_MASK) |
527 IPTOS_PREC_INTERNETCONTROL;
528 iph->tot_len = htons(sizeof(struct iphdr)
529 + sizeof(struct icmphdr)
531 get_random_bytes(&iph->id, sizeof(iph->id));
534 iph->protocol = IPPROTO_ICMP;
535 iph->daddr = old_iph->saddr;
536 iph->saddr = old_iph->daddr;
541 icmph->type = ICMP_DEST_UNREACH;
542 icmph->code = ICMP_FRAG_NEEDED;
543 icmph->un.gateway = htonl(mtu);
546 nskb->csum = csum_partial((u8 *)icmph, sizeof(struct icmphdr), 0);
547 nskb->csum = skb_copy_and_csum_bits(skb, (u8 *)old_iph - skb->data,
548 payload, payload_length,
550 icmph->checksum = csum_fold(nskb->csum);
553 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
554 static bool ipv6_should_icmp(struct sk_buff *skb)
556 struct ipv6hdr *old_ipv6h = ipv6_hdr(skb);
558 int payload_off = (u8 *)(old_ipv6h + 1) - skb->data;
559 u8 nexthdr = ipv6_hdr(skb)->nexthdr;
561 /* Check source address is valid. */
562 addr_type = ipv6_addr_type(&old_ipv6h->saddr);
563 if (addr_type & IPV6_ADDR_MULTICAST || addr_type == IPV6_ADDR_ANY)
566 /* Don't reply to unspecified addresses. */
567 if (ipv6_addr_type(&old_ipv6h->daddr) == IPV6_ADDR_ANY)
570 /* Don't respond to ICMP error messages. */
571 payload_off = ipv6_skip_exthdr(skb, payload_off, &nexthdr);
575 if (nexthdr == NEXTHDR_ICMP) {
576 u8 icmp_type, *icmp_typep;
578 icmp_typep = skb_header_pointer(skb, payload_off +
579 offsetof(struct icmp6hdr,
581 sizeof(icmp_type), &icmp_type);
583 if (!icmp_typep || !(*icmp_typep & ICMPV6_INFOMSG_MASK))
590 static void ipv6_build_icmp(struct sk_buff *skb, struct sk_buff *nskb,
591 unsigned int mtu, unsigned int payload_length)
593 struct ipv6hdr *ipv6h, *old_ipv6h = ipv6_hdr(skb);
594 struct icmp6hdr *icmp6h;
597 ipv6h = (struct ipv6hdr *)skb_put(nskb, sizeof(struct ipv6hdr));
598 icmp6h = (struct icmp6hdr *)skb_put(nskb, sizeof(struct icmp6hdr));
599 payload = skb_put(nskb, payload_length);
604 memset(&ipv6h->flow_lbl, 0, sizeof(ipv6h->flow_lbl));
605 ipv6h->payload_len = htons(sizeof(struct icmp6hdr)
607 ipv6h->nexthdr = NEXTHDR_ICMP;
608 ipv6h->hop_limit = IPV6_DEFAULT_HOPLIMIT;
609 ipv6_addr_copy(&ipv6h->daddr, &old_ipv6h->saddr);
610 ipv6_addr_copy(&ipv6h->saddr, &old_ipv6h->daddr);
613 icmp6h->icmp6_type = ICMPV6_PKT_TOOBIG;
614 icmp6h->icmp6_code = 0;
615 icmp6h->icmp6_cksum = 0;
616 icmp6h->icmp6_mtu = htonl(mtu);
618 nskb->csum = csum_partial((u8 *)icmp6h, sizeof(struct icmp6hdr), 0);
619 nskb->csum = skb_copy_and_csum_bits(skb, (u8 *)old_ipv6h - skb->data,
620 payload, payload_length,
622 icmp6h->icmp6_cksum = csum_ipv6_magic(&ipv6h->saddr, &ipv6h->daddr,
623 sizeof(struct icmp6hdr)
625 ipv6h->nexthdr, nskb->csum);
629 bool tnl_frag_needed(struct vport *vport, const struct tnl_mutable_config *mutable,
630 struct sk_buff *skb, unsigned int mtu, __be64 flow_key)
632 unsigned int eth_hdr_len = ETH_HLEN;
633 unsigned int total_length = 0, header_length = 0, payload_length;
634 struct ethhdr *eh, *old_eh = eth_hdr(skb);
635 struct sk_buff *nskb;
638 if (skb->protocol == htons(ETH_P_IP)) {
639 if (mtu < IP_MIN_MTU)
642 if (!ipv4_should_icmp(skb))
645 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
646 else if (skb->protocol == htons(ETH_P_IPV6)) {
647 if (mtu < IPV6_MIN_MTU)
651 * In theory we should do PMTUD on IPv6 multicast messages but
652 * we don't have an address to send from so just fragment.
654 if (ipv6_addr_type(&ipv6_hdr(skb)->daddr) & IPV6_ADDR_MULTICAST)
657 if (!ipv6_should_icmp(skb))
665 if (old_eh->h_proto == htons(ETH_P_8021Q))
666 eth_hdr_len = VLAN_ETH_HLEN;
668 payload_length = skb->len - eth_hdr_len;
669 if (skb->protocol == htons(ETH_P_IP)) {
670 header_length = sizeof(struct iphdr) + sizeof(struct icmphdr);
671 total_length = min_t(unsigned int, header_length +
672 payload_length, 576);
674 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
676 header_length = sizeof(struct ipv6hdr) +
677 sizeof(struct icmp6hdr);
678 total_length = min_t(unsigned int, header_length +
679 payload_length, IPV6_MIN_MTU);
683 payload_length = total_length - header_length;
685 nskb = dev_alloc_skb(NET_IP_ALIGN + eth_hdr_len + header_length +
690 skb_reserve(nskb, NET_IP_ALIGN);
692 /* Ethernet / VLAN */
693 eh = (struct ethhdr *)skb_put(nskb, eth_hdr_len);
694 memcpy(eh->h_dest, old_eh->h_source, ETH_ALEN);
695 memcpy(eh->h_source, mutable->eth_addr, ETH_ALEN);
696 nskb->protocol = eh->h_proto = old_eh->h_proto;
697 if (old_eh->h_proto == htons(ETH_P_8021Q)) {
698 struct vlan_ethhdr *vh = (struct vlan_ethhdr *)eh;
700 vh->h_vlan_TCI = vlan_eth_hdr(skb)->h_vlan_TCI;
701 vh->h_vlan_encapsulated_proto = skb->protocol;
703 vlan_set_tci(nskb, vlan_get_tci(skb));
704 skb_reset_mac_header(nskb);
707 if (skb->protocol == htons(ETH_P_IP))
708 ipv4_build_icmp(skb, nskb, mtu, payload_length);
709 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
711 ipv6_build_icmp(skb, nskb, mtu, payload_length);
715 * Assume that flow based keys are symmetric with respect to input
716 * and output and use the key that we were going to put on the
717 * outgoing packet for the fake received packet. If the keys are
718 * not symmetric then PMTUD needs to be disabled since we won't have
719 * any way of synthesizing packets.
721 if ((mutable->flags & (TNL_F_IN_KEY_MATCH | TNL_F_OUT_KEY_ACTION)) ==
722 (TNL_F_IN_KEY_MATCH | TNL_F_OUT_KEY_ACTION))
723 OVS_CB(nskb)->tun_id = flow_key;
725 if (unlikely(compute_ip_summed(nskb, false))) {
730 vport_receive(vport, nskb);
735 static bool check_mtu(struct sk_buff *skb,
737 const struct tnl_mutable_config *mutable,
738 const struct rtable *rt, __be16 *frag_offp)
740 bool df_inherit = mutable->flags & TNL_F_DF_INHERIT;
741 bool pmtud = mutable->flags & TNL_F_PMTUD;
742 __be16 frag_off = mutable->flags & TNL_F_DF_DEFAULT ? htons(IP_DF) : 0;
744 unsigned int packet_length = skb->len - ETH_HLEN;
746 /* Allow for one level of tagging in the packet length. */
747 if (!vlan_tx_tag_present(skb) &&
748 eth_hdr(skb)->h_proto == htons(ETH_P_8021Q))
749 packet_length -= VLAN_HLEN;
754 /* The tag needs to go in packet regardless of where it
755 * currently is, so subtract it from the MTU.
757 if (vlan_tx_tag_present(skb) ||
758 eth_hdr(skb)->h_proto == htons(ETH_P_8021Q))
759 vlan_header = VLAN_HLEN;
761 mtu = dst_mtu(&rt_dst(rt))
763 - mutable->tunnel_hlen
767 if (skb->protocol == htons(ETH_P_IP)) {
768 struct iphdr *iph = ip_hdr(skb);
771 frag_off = iph->frag_off & htons(IP_DF);
773 if (pmtud && iph->frag_off & htons(IP_DF)) {
774 mtu = max(mtu, IP_MIN_MTU);
776 if (packet_length > mtu &&
777 tnl_frag_needed(vport, mutable, skb, mtu,
778 OVS_CB(skb)->tun_id))
782 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
783 else if (skb->protocol == htons(ETH_P_IPV6)) {
784 /* IPv6 requires end hosts to do fragmentation
785 * if the packet is above the minimum MTU.
787 if (df_inherit && packet_length > IPV6_MIN_MTU)
788 frag_off = htons(IP_DF);
791 mtu = max(mtu, IPV6_MIN_MTU);
793 if (packet_length > mtu &&
794 tnl_frag_needed(vport, mutable, skb, mtu,
795 OVS_CB(skb)->tun_id))
801 *frag_offp = frag_off;
805 static void create_tunnel_header(const struct vport *vport,
806 const struct tnl_mutable_config *mutable,
807 const struct rtable *rt, void *header)
809 struct tnl_vport *tnl_vport = tnl_vport_priv(vport);
810 struct iphdr *iph = header;
813 iph->ihl = sizeof(struct iphdr) >> 2;
814 iph->frag_off = htons(IP_DF);
815 iph->protocol = tnl_vport->tnl_ops->ipproto;
816 iph->tos = mutable->tos;
817 iph->daddr = rt->rt_dst;
818 iph->saddr = rt->rt_src;
819 iph->ttl = mutable->ttl;
821 iph->ttl = ip4_dst_hoplimit(&rt_dst(rt));
823 tnl_vport->tnl_ops->build_header(vport, mutable, iph + 1);
826 static inline void *get_cached_header(const struct tnl_cache *cache)
828 return (void *)cache + ALIGN(sizeof(struct tnl_cache), CACHE_DATA_ALIGN);
831 static inline bool check_cache_valid(const struct tnl_cache *cache,
832 const struct tnl_mutable_config *mutable)
835 #ifdef NEED_CACHE_TIMEOUT
836 time_before(jiffies, cache->expiration) &&
839 atomic_read(&init_net.ipv4.rt_genid) == cache->rt->rt_genid &&
842 rt_dst(cache->rt).hh->hh_lock.sequence == cache->hh_seq &&
844 mutable->seq == cache->mutable_seq &&
845 (!is_internal_dev(rt_dst(cache->rt).dev) ||
846 (cache->flow && !cache->flow->dead));
849 static int cache_cleaner_cb(struct tbl_node *tbl_node, void *aux)
851 struct tnl_vport *tnl_vport = tnl_vport_table_cast(tbl_node);
852 const struct tnl_mutable_config *mutable = rcu_dereference(tnl_vport->mutable);
853 const struct tnl_cache *cache = rcu_dereference(tnl_vport->cache);
855 if (cache && !check_cache_valid(cache, mutable) &&
856 spin_trylock_bh(&tnl_vport->cache_lock)) {
857 assign_cache_rcu(tnl_vport_to_vport(tnl_vport), NULL);
858 spin_unlock_bh(&tnl_vport->cache_lock);
864 static void cache_cleaner(struct work_struct *work)
866 schedule_cache_cleaner();
869 tbl_foreach(rcu_dereference(port_table), cache_cleaner_cb, NULL);
873 static inline void create_eth_hdr(struct tnl_cache *cache,
874 const struct rtable *rt)
876 void *cache_data = get_cached_header(cache);
877 int hh_len = rt_dst(rt).hh->hh_len;
878 int hh_off = HH_DATA_ALIGN(rt_dst(rt).hh->hh_len) - hh_len;
884 hh_seq = read_seqbegin(&rt_dst(rt).hh->hh_lock);
885 memcpy(cache_data, (void *)rt_dst(rt).hh->hh_data + hh_off, hh_len);
886 } while (read_seqretry(&rt_dst(rt).hh->hh_lock, hh_seq));
888 cache->hh_seq = hh_seq;
890 read_lock_bh(&rt_dst(rt).hh->hh_lock);
891 memcpy(cache_data, (void *)rt_dst(rt).hh->hh_data + hh_off, hh_len);
892 read_unlock_bh(&rt_dst(rt).hh->hh_lock);
896 static struct tnl_cache *build_cache(struct vport *vport,
897 const struct tnl_mutable_config *mutable,
900 struct tnl_vport *tnl_vport = tnl_vport_priv(vport);
901 struct tnl_cache *cache;
905 if (!(mutable->flags & TNL_F_HDR_CACHE))
909 * If there is no entry in the ARP cache or if this device does not
910 * support hard header caching just fall back to the IP stack.
916 * If lock is contended fall back to directly building the header.
917 * We're not going to help performance by sitting here spinning.
919 if (!spin_trylock_bh(&tnl_vport->cache_lock))
922 cache = cache_dereference(tnl_vport);
923 if (check_cache_valid(cache, mutable))
928 cache_len = rt_dst(rt).hh->hh_len + mutable->tunnel_hlen;
930 cache = kzalloc(ALIGN(sizeof(struct tnl_cache), CACHE_DATA_ALIGN) +
931 cache_len, GFP_ATOMIC);
935 cache->len = cache_len;
937 create_eth_hdr(cache, rt);
938 cache_data = get_cached_header(cache) + rt_dst(rt).hh->hh_len;
940 create_tunnel_header(vport, mutable, rt, cache_data);
942 cache->mutable_seq = mutable->seq;
944 #ifdef NEED_CACHE_TIMEOUT
945 cache->expiration = jiffies + tnl_vport->cache_exp_interval;
948 if (is_internal_dev(rt_dst(rt).dev)) {
949 struct sw_flow_key flow_key;
950 struct tbl_node *flow_node;
951 struct vport *dst_vport;
957 dst_vport = internal_dev_get_vport(rt_dst(rt).dev);
961 skb = alloc_skb(cache->len, GFP_ATOMIC);
965 __skb_put(skb, cache->len);
966 memcpy(skb->data, get_cached_header(cache), cache->len);
968 err = flow_extract(skb, dst_vport->port_no, &flow_key,
969 &flow_key_len, &is_frag);
975 flow_node = tbl_lookup(rcu_dereference(dst_vport->dp->table),
976 &flow_key, flow_key_len,
977 flow_hash(&flow_key, flow_key_len),
980 struct sw_flow *flow = flow_cast(flow_node);
988 assign_cache_rcu(vport, cache);
991 spin_unlock_bh(&tnl_vport->cache_lock);
996 static struct rtable *find_route(struct vport *vport,
997 const struct tnl_mutable_config *mutable,
998 u8 tos, struct tnl_cache **cache)
1000 struct tnl_vport *tnl_vport = tnl_vport_priv(vport);
1001 struct tnl_cache *cur_cache = rcu_dereference(tnl_vport->cache);
1006 if (likely(tos == mutable->tos && check_cache_valid(cur_cache, mutable))) {
1008 return cur_cache->rt;
1011 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,39)
1012 struct flowi fl = { .nl_u = { .ip4_u =
1013 { .daddr = mutable->daddr,
1014 .saddr = mutable->saddr,
1016 .proto = tnl_vport->tnl_ops->ipproto };
1018 if (unlikely(ip_route_output_key(&init_net, &rt, &fl)))
1021 struct flowi4 fl = { .daddr = mutable->daddr,
1022 .saddr = mutable->saddr,
1024 .flowi4_proto = tnl_vport->tnl_ops->ipproto };
1026 rt = ip_route_output_key(&init_net, &fl);
1031 if (likely(tos == mutable->tos))
1032 *cache = build_cache(vport, mutable, rt);
1038 static inline bool need_linearize(const struct sk_buff *skb)
1042 if (unlikely(skb_shinfo(skb)->frag_list))
1046 * Generally speaking we should linearize if there are paged frags.
1047 * However, if all of the refcounts are 1 we know nobody else can
1048 * change them from underneath us and we can skip the linearization.
1050 for (i = 0; i < skb_shinfo(skb)->nr_frags; i++)
1051 if (unlikely(page_count(skb_shinfo(skb)->frags[i].page) > 1))
1057 static struct sk_buff *handle_offloads(struct sk_buff *skb,
1058 const struct tnl_mutable_config *mutable,
1059 const struct rtable *rt)
1064 min_headroom = LL_RESERVED_SPACE(rt_dst(rt).dev) + rt_dst(rt).header_len
1065 + mutable->tunnel_hlen
1066 + (vlan_tx_tag_present(skb) ? VLAN_HLEN : 0);
1068 if (skb_headroom(skb) < min_headroom || skb_header_cloned(skb)) {
1069 int head_delta = SKB_DATA_ALIGN(min_headroom -
1072 err = pskb_expand_head(skb, max_t(int, head_delta, 0),
1078 forward_ip_summed(skb, true);
1080 if (skb_is_gso(skb)) {
1081 struct sk_buff *nskb;
1083 nskb = skb_gso_segment(skb, 0);
1086 err = PTR_ERR(nskb);
1092 } else if (get_ip_summed(skb) == OVS_CSUM_PARTIAL) {
1093 /* Pages aren't locked and could change at any time.
1094 * If this happens after we compute the checksum, the
1095 * checksum will be wrong. We linearize now to avoid
1098 if (unlikely(need_linearize(skb))) {
1099 err = __skb_linearize(skb);
1104 err = skb_checksum_help(skb);
1109 set_ip_summed(skb, OVS_CSUM_NONE);
1116 return ERR_PTR(err);
1119 static int send_frags(struct sk_buff *skb,
1120 const struct tnl_mutable_config *mutable)
1126 struct sk_buff *next = skb->next;
1127 int frag_len = skb->len - mutable->tunnel_hlen;
1131 memset(IPCB(skb), 0, sizeof(*IPCB(skb)));
1133 err = ip_local_out(skb);
1135 if (unlikely(net_xmit_eval(err)))
1137 sent_len += frag_len;
1144 * There's no point in continuing to send fragments once one has been
1145 * dropped so just free the rest. This may help improve the congestion
1146 * that caused the first packet to be dropped.
1148 tnl_free_linked_skbs(skb);
1152 int tnl_send(struct vport *vport, struct sk_buff *skb)
1154 struct tnl_vport *tnl_vport = tnl_vport_priv(vport);
1155 const struct tnl_mutable_config *mutable = rcu_dereference(tnl_vport->mutable);
1157 enum vport_err_type err = VPORT_E_TX_ERROR;
1159 struct dst_entry *unattached_dst = NULL;
1160 struct tnl_cache *cache;
1162 __be16 frag_off = 0;
1167 /* Validate the protocol headers before we try to use them. */
1168 if (skb->protocol == htons(ETH_P_8021Q) &&
1169 !vlan_tx_tag_present(skb)) {
1170 if (unlikely(!pskb_may_pull(skb, VLAN_ETH_HLEN)))
1173 skb->protocol = vlan_eth_hdr(skb)->h_vlan_encapsulated_proto;
1174 skb_set_network_header(skb, VLAN_ETH_HLEN);
1177 if (skb->protocol == htons(ETH_P_IP)) {
1178 if (unlikely(!pskb_may_pull(skb, skb_network_offset(skb)
1179 + sizeof(struct iphdr))))
1182 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
1183 else if (skb->protocol == htons(ETH_P_IPV6)) {
1184 if (unlikely(!pskb_may_pull(skb, skb_network_offset(skb)
1185 + sizeof(struct ipv6hdr))))
1191 if (skb->protocol == htons(ETH_P_IP))
1192 inner_tos = ip_hdr(skb)->tos;
1193 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
1194 else if (skb->protocol == htons(ETH_P_IPV6))
1195 inner_tos = ipv6_get_dsfield(ipv6_hdr(skb));
1200 if (mutable->flags & TNL_F_TOS_INHERIT)
1205 tos = INET_ECN_encapsulate(tos, inner_tos);
1208 rt = find_route(vport, mutable, tos, &cache);
1211 if (unlikely(!cache))
1212 unattached_dst = &rt_dst(rt);
1218 skb_clear_rxhash(skb);
1221 skb = handle_offloads(skb, mutable, rt);
1226 if (unlikely(!check_mtu(skb, vport, mutable, rt, &frag_off))) {
1227 err = VPORT_E_TX_DROPPED;
1232 * If we are over the MTU, allow the IP stack to handle fragmentation.
1233 * Fragmentation is a slow path anyways.
1235 if (unlikely(skb->len + mutable->tunnel_hlen > dst_mtu(&rt_dst(rt)) &&
1237 unattached_dst = &rt_dst(rt);
1238 dst_hold(unattached_dst);
1245 ttl = ip4_dst_hoplimit(&rt_dst(rt));
1247 if (mutable->flags & TNL_F_TTL_INHERIT) {
1248 if (skb->protocol == htons(ETH_P_IP))
1249 ttl = ip_hdr(skb)->ttl;
1250 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
1251 else if (skb->protocol == htons(ETH_P_IPV6))
1252 ttl = ipv6_hdr(skb)->hop_limit;
1258 struct sk_buff *next_skb = skb->next;
1261 if (unlikely(vlan_deaccel_tag(skb)))
1264 if (likely(cache)) {
1265 skb_push(skb, cache->len);
1266 memcpy(skb->data, get_cached_header(cache), cache->len);
1267 skb_reset_mac_header(skb);
1268 skb_set_network_header(skb, rt_dst(rt).hh->hh_len);
1271 skb_push(skb, mutable->tunnel_hlen);
1272 create_tunnel_header(vport, mutable, rt, skb->data);
1273 skb_reset_network_header(skb);
1276 skb_dst_set(skb, dst_clone(unattached_dst));
1278 skb_dst_set(skb, unattached_dst);
1279 unattached_dst = NULL;
1282 skb_set_transport_header(skb, skb_network_offset(skb) + sizeof(struct iphdr));
1287 iph->frag_off = frag_off;
1288 ip_select_ident(iph, &rt_dst(rt), NULL);
1290 skb = tnl_vport->tnl_ops->update_header(vport, mutable, &rt_dst(rt), skb);
1294 if (likely(cache)) {
1295 int orig_len = skb->len - cache->len;
1296 struct vport *cache_vport = internal_dev_get_vport(rt_dst(rt).dev);
1298 skb->protocol = htons(ETH_P_IP);
1300 iph->tot_len = htons(skb->len - skb_network_offset(skb));
1304 if (unlikely(compute_ip_summed(skb, true))) {
1309 OVS_CB(skb)->flow = cache->flow;
1310 vport_receive(cache_vport, skb);
1311 sent_len += orig_len;
1315 skb->dev = rt_dst(rt).dev;
1316 xmit_err = dev_queue_xmit(skb);
1318 if (likely(net_xmit_eval(xmit_err) == 0))
1319 sent_len += orig_len;
1322 sent_len += send_frags(skb, mutable);
1328 if (unlikely(sent_len == 0))
1329 vport_record_error(vport, VPORT_E_TX_DROPPED);
1334 tnl_free_linked_skbs(skb);
1336 vport_record_error(vport, err);
1338 dst_release(unattached_dst);
1342 static const struct nla_policy tnl_policy[ODP_TUNNEL_ATTR_MAX + 1] = {
1343 [ODP_TUNNEL_ATTR_FLAGS] = { .type = NLA_U32 },
1344 [ODP_TUNNEL_ATTR_DST_IPV4] = { .type = NLA_U32 },
1345 [ODP_TUNNEL_ATTR_SRC_IPV4] = { .type = NLA_U32 },
1346 [ODP_TUNNEL_ATTR_OUT_KEY] = { .type = NLA_U64 },
1347 [ODP_TUNNEL_ATTR_IN_KEY] = { .type = NLA_U64 },
1348 [ODP_TUNNEL_ATTR_TOS] = { .type = NLA_U8 },
1349 [ODP_TUNNEL_ATTR_TTL] = { .type = NLA_U8 },
1352 /* Sets ODP_TUNNEL_ATTR_* fields in 'mutable', which must initially be zeroed. */
1353 static int tnl_set_config(struct nlattr *options, const struct tnl_ops *tnl_ops,
1354 const struct vport *cur_vport,
1355 struct tnl_mutable_config *mutable)
1357 const struct vport *old_vport;
1358 const struct tnl_mutable_config *old_mutable;
1359 struct nlattr *a[ODP_TUNNEL_ATTR_MAX + 1];
1365 err = nla_parse_nested(a, ODP_TUNNEL_ATTR_MAX, options, tnl_policy);
1369 if (!a[ODP_TUNNEL_ATTR_FLAGS] || !a[ODP_TUNNEL_ATTR_DST_IPV4])
1372 mutable->flags = nla_get_u32(a[ODP_TUNNEL_ATTR_FLAGS]) & TNL_F_PUBLIC;
1374 if (a[ODP_TUNNEL_ATTR_SRC_IPV4])
1375 mutable->saddr = nla_get_be32(a[ODP_TUNNEL_ATTR_SRC_IPV4]);
1376 mutable->daddr = nla_get_be32(a[ODP_TUNNEL_ATTR_DST_IPV4]);
1378 if (a[ODP_TUNNEL_ATTR_TOS]) {
1379 mutable->tos = nla_get_u8(a[ODP_TUNNEL_ATTR_TOS]);
1380 if (mutable->tos != RT_TOS(mutable->tos))
1384 if (a[ODP_TUNNEL_ATTR_TTL])
1385 mutable->ttl = nla_get_u8(a[ODP_TUNNEL_ATTR_TTL]);
1387 mutable->tunnel_type = tnl_ops->tunnel_type;
1388 if (!a[ODP_TUNNEL_ATTR_IN_KEY]) {
1389 mutable->tunnel_type |= TNL_T_KEY_MATCH;
1390 mutable->flags |= TNL_F_IN_KEY_MATCH;
1392 mutable->tunnel_type |= TNL_T_KEY_EXACT;
1393 mutable->in_key = nla_get_be64(a[ODP_TUNNEL_ATTR_IN_KEY]);
1396 if (!a[ODP_TUNNEL_ATTR_OUT_KEY])
1397 mutable->flags |= TNL_F_OUT_KEY_ACTION;
1399 mutable->out_key = nla_get_be64(a[ODP_TUNNEL_ATTR_OUT_KEY]);
1401 mutable->tunnel_hlen = tnl_ops->hdr_len(mutable);
1402 if (mutable->tunnel_hlen < 0)
1403 return mutable->tunnel_hlen;
1405 mutable->tunnel_hlen += sizeof(struct iphdr);
1407 old_vport = tnl_find_port(mutable->saddr, mutable->daddr,
1408 mutable->in_key, mutable->tunnel_type,
1411 if (old_vport && old_vport != cur_vport)
1417 struct vport *tnl_create(const struct vport_parms *parms,
1418 const struct vport_ops *vport_ops,
1419 const struct tnl_ops *tnl_ops)
1421 struct vport *vport;
1422 struct tnl_vport *tnl_vport;
1423 struct tnl_mutable_config *mutable;
1424 int initial_frag_id;
1427 vport = vport_alloc(sizeof(struct tnl_vport), vport_ops, parms);
1428 if (IS_ERR(vport)) {
1429 err = PTR_ERR(vport);
1433 tnl_vport = tnl_vport_priv(vport);
1435 strcpy(tnl_vport->name, parms->name);
1436 tnl_vport->tnl_ops = tnl_ops;
1438 mutable = kzalloc(sizeof(struct tnl_mutable_config), GFP_KERNEL);
1441 goto error_free_vport;
1444 vport_gen_rand_ether_addr(mutable->eth_addr);
1446 get_random_bytes(&initial_frag_id, sizeof(int));
1447 atomic_set(&tnl_vport->frag_id, initial_frag_id);
1449 err = tnl_set_config(parms->options, tnl_ops, NULL, mutable);
1451 goto error_free_mutable;
1453 spin_lock_init(&tnl_vport->cache_lock);
1455 #ifdef NEED_CACHE_TIMEOUT
1456 tnl_vport->cache_exp_interval = MAX_CACHE_EXP -
1457 (net_random() % (MAX_CACHE_EXP / 2));
1460 rcu_assign_pointer(tnl_vport->mutable, mutable);
1462 err = add_port(vport);
1464 goto error_free_mutable;
1473 return ERR_PTR(err);
1476 int tnl_set_options(struct vport *vport, struct nlattr *options)
1478 struct tnl_vport *tnl_vport = tnl_vport_priv(vport);
1479 const struct tnl_mutable_config *old_mutable;
1480 struct tnl_mutable_config *mutable;
1483 mutable = kzalloc(sizeof(struct tnl_mutable_config), GFP_KERNEL);
1489 /* Copy fields whose values should be retained. */
1490 old_mutable = rtnl_dereference(tnl_vport->mutable);
1491 mutable->seq = old_mutable->seq + 1;
1492 memcpy(mutable->eth_addr, old_mutable->eth_addr, ETH_ALEN);
1494 /* Parse the others configured by userspace. */
1495 err = tnl_set_config(options, tnl_vport->tnl_ops, vport, mutable);
1499 err = move_port(vport, mutable);
1511 int tnl_get_options(const struct vport *vport, struct sk_buff *skb)
1513 const struct tnl_vport *tnl_vport = tnl_vport_priv(vport);
1514 const struct tnl_mutable_config *mutable = rcu_dereference_rtnl(tnl_vport->mutable);
1516 NLA_PUT_U32(skb, ODP_TUNNEL_ATTR_FLAGS, mutable->flags & TNL_F_PUBLIC);
1517 NLA_PUT_BE32(skb, ODP_TUNNEL_ATTR_DST_IPV4, mutable->daddr);
1519 if (!(mutable->flags & TNL_F_IN_KEY_MATCH))
1520 NLA_PUT_BE64(skb, ODP_TUNNEL_ATTR_IN_KEY, mutable->in_key);
1521 if (!(mutable->flags & TNL_F_OUT_KEY_ACTION))
1522 NLA_PUT_BE64(skb, ODP_TUNNEL_ATTR_OUT_KEY, mutable->out_key);
1524 NLA_PUT_BE32(skb, ODP_TUNNEL_ATTR_SRC_IPV4, mutable->saddr);
1526 NLA_PUT_U8(skb, ODP_TUNNEL_ATTR_TOS, mutable->tos);
1528 NLA_PUT_U8(skb, ODP_TUNNEL_ATTR_TTL, mutable->ttl);
1536 static void free_port_rcu(struct rcu_head *rcu)
1538 struct tnl_vport *tnl_vport = container_of(rcu,
1539 struct tnl_vport, rcu);
1541 free_cache((struct tnl_cache __force *)tnl_vport->cache);
1542 kfree((struct tnl_mutable __force *)tnl_vport->mutable);
1543 vport_free(tnl_vport_to_vport(tnl_vport));
1546 int tnl_destroy(struct vport *vport)
1548 struct tnl_vport *tnl_vport = tnl_vport_priv(vport);
1549 const struct tnl_mutable_config *mutable, *old_mutable;
1551 mutable = rtnl_dereference(tnl_vport->mutable);
1553 if (vport == tnl_find_port(mutable->saddr, mutable->daddr,
1554 mutable->in_key, mutable->tunnel_type,
1558 call_rcu(&tnl_vport->rcu, free_port_rcu);
1563 int tnl_set_addr(struct vport *vport, const unsigned char *addr)
1565 struct tnl_vport *tnl_vport = tnl_vport_priv(vport);
1566 struct tnl_mutable_config *mutable;
1568 mutable = kmemdup(rtnl_dereference(tnl_vport->mutable),
1569 sizeof(struct tnl_mutable_config), GFP_KERNEL);
1573 memcpy(mutable->eth_addr, addr, ETH_ALEN);
1574 assign_config_rcu(vport, mutable);
1579 const char *tnl_get_name(const struct vport *vport)
1581 const struct tnl_vport *tnl_vport = tnl_vport_priv(vport);
1582 return tnl_vport->name;
1585 const unsigned char *tnl_get_addr(const struct vport *vport)
1587 const struct tnl_vport *tnl_vport = tnl_vport_priv(vport);
1588 return rcu_dereference_rtnl(tnl_vport->mutable)->eth_addr;
1591 void tnl_free_linked_skbs(struct sk_buff *skb)
1594 struct sk_buff *next = skb->next;