xref: /openbmc/linux/net/openvswitch/flow.h (revision 8a10bc9d)
1 /*
2  * Copyright (c) 2007-2013 Nicira, Inc.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of version 2 of the GNU General Public
6  * License as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful, but
9  * WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11  * General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
16  * 02110-1301, USA
17  */
18 
19 #ifndef FLOW_H
20 #define FLOW_H 1
21 
22 #include <linux/cache.h>
23 #include <linux/kernel.h>
24 #include <linux/netlink.h>
25 #include <linux/openvswitch.h>
26 #include <linux/spinlock.h>
27 #include <linux/types.h>
28 #include <linux/rcupdate.h>
29 #include <linux/if_ether.h>
30 #include <linux/in6.h>
31 #include <linux/jiffies.h>
32 #include <linux/time.h>
33 #include <linux/flex_array.h>
34 #include <net/inet_ecn.h>
35 
36 struct sk_buff;
37 
38 /* Used to memset ovs_key_ipv4_tunnel padding. */
39 #define OVS_TUNNEL_KEY_SIZE					\
40 	(offsetof(struct ovs_key_ipv4_tunnel, ipv4_ttl) +	\
41 	FIELD_SIZEOF(struct ovs_key_ipv4_tunnel, ipv4_ttl))
42 
43 struct ovs_key_ipv4_tunnel {
44 	__be64 tun_id;
45 	__be32 ipv4_src;
46 	__be32 ipv4_dst;
47 	__be16 tun_flags;
48 	u8   ipv4_tos;
49 	u8   ipv4_ttl;
50 };
51 
52 static inline void ovs_flow_tun_key_init(struct ovs_key_ipv4_tunnel *tun_key,
53 					 const struct iphdr *iph, __be64 tun_id,
54 					 __be16 tun_flags)
55 {
56 	tun_key->tun_id = tun_id;
57 	tun_key->ipv4_src = iph->saddr;
58 	tun_key->ipv4_dst = iph->daddr;
59 	tun_key->ipv4_tos = iph->tos;
60 	tun_key->ipv4_ttl = iph->ttl;
61 	tun_key->tun_flags = tun_flags;
62 
63 	/* clear struct padding. */
64 	memset((unsigned char *) tun_key + OVS_TUNNEL_KEY_SIZE, 0,
65 	       sizeof(*tun_key) - OVS_TUNNEL_KEY_SIZE);
66 }
67 
68 struct sw_flow_key {
69 	struct ovs_key_ipv4_tunnel tun_key;  /* Encapsulating tunnel key. */
70 	struct {
71 		u32	priority;	/* Packet QoS priority. */
72 		u32	skb_mark;	/* SKB mark. */
73 		u16	in_port;	/* Input switch port (or DP_MAX_PORTS). */
74 	} phy;
75 	struct {
76 		u8     src[ETH_ALEN];	/* Ethernet source address. */
77 		u8     dst[ETH_ALEN];	/* Ethernet destination address. */
78 		__be16 tci;		/* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
79 		__be16 type;		/* Ethernet frame type. */
80 	} eth;
81 	struct {
82 		u8     proto;		/* IP protocol or lower 8 bits of ARP opcode. */
83 		u8     tos;		/* IP ToS. */
84 		u8     ttl;		/* IP TTL/hop limit. */
85 		u8     frag;		/* One of OVS_FRAG_TYPE_*. */
86 	} ip;
87 	union {
88 		struct {
89 			struct {
90 				__be32 src;	/* IP source address. */
91 				__be32 dst;	/* IP destination address. */
92 			} addr;
93 			union {
94 				struct {
95 					__be16 src;		/* TCP/UDP/SCTP source port. */
96 					__be16 dst;		/* TCP/UDP/SCTP destination port. */
97 					__be16 flags;		/* TCP flags. */
98 				} tp;
99 				struct {
100 					u8 sha[ETH_ALEN];	/* ARP source hardware address. */
101 					u8 tha[ETH_ALEN];	/* ARP target hardware address. */
102 				} arp;
103 			};
104 		} ipv4;
105 		struct {
106 			struct {
107 				struct in6_addr src;	/* IPv6 source address. */
108 				struct in6_addr dst;	/* IPv6 destination address. */
109 			} addr;
110 			__be32 label;			/* IPv6 flow label. */
111 			struct {
112 				__be16 src;		/* TCP/UDP/SCTP source port. */
113 				__be16 dst;		/* TCP/UDP/SCTP destination port. */
114 				__be16 flags;		/* TCP flags. */
115 			} tp;
116 			struct {
117 				struct in6_addr target;	/* ND target address. */
118 				u8 sll[ETH_ALEN];	/* ND source link layer address. */
119 				u8 tll[ETH_ALEN];	/* ND target link layer address. */
120 			} nd;
121 		} ipv6;
122 	};
123 } __aligned(BITS_PER_LONG/8); /* Ensure that we can do comparisons as longs. */
124 
125 struct sw_flow_key_range {
126 	unsigned short int start;
127 	unsigned short int end;
128 };
129 
130 struct sw_flow_mask {
131 	int ref_count;
132 	struct rcu_head rcu;
133 	struct list_head list;
134 	struct sw_flow_key_range range;
135 	struct sw_flow_key key;
136 };
137 
138 struct sw_flow_match {
139 	struct sw_flow_key *key;
140 	struct sw_flow_key_range range;
141 	struct sw_flow_mask *mask;
142 };
143 
144 struct sw_flow_actions {
145 	struct rcu_head rcu;
146 	u32 actions_len;
147 	struct nlattr actions[];
148 };
149 
150 struct flow_stats {
151 	u64 packet_count;		/* Number of packets matched. */
152 	u64 byte_count;			/* Number of bytes matched. */
153 	unsigned long used;		/* Last used time (in jiffies). */
154 	spinlock_t lock;		/* Lock for atomic stats update. */
155 	__be16 tcp_flags;		/* Union of seen TCP flags. */
156 };
157 
158 struct sw_flow_stats {
159 	bool is_percpu;
160 	union {
161 		struct flow_stats *stat;
162 		struct flow_stats __percpu *cpu_stats;
163 	};
164 };
165 
166 struct sw_flow {
167 	struct rcu_head rcu;
168 	struct hlist_node hash_node[2];
169 	u32 hash;
170 
171 	struct sw_flow_key key;
172 	struct sw_flow_key unmasked_key;
173 	struct sw_flow_mask *mask;
174 	struct sw_flow_actions __rcu *sf_acts;
175 	struct sw_flow_stats stats;
176 };
177 
178 struct arp_eth_header {
179 	__be16      ar_hrd;	/* format of hardware address   */
180 	__be16      ar_pro;	/* format of protocol address   */
181 	unsigned char   ar_hln;	/* length of hardware address   */
182 	unsigned char   ar_pln;	/* length of protocol address   */
183 	__be16      ar_op;	/* ARP opcode (command)     */
184 
185 	/* Ethernet+IPv4 specific members. */
186 	unsigned char       ar_sha[ETH_ALEN];	/* sender hardware address  */
187 	unsigned char       ar_sip[4];		/* sender IP address        */
188 	unsigned char       ar_tha[ETH_ALEN];	/* target hardware address  */
189 	unsigned char       ar_tip[4];		/* target IP address        */
190 } __packed;
191 
192 void ovs_flow_stats_update(struct sw_flow *flow, struct sk_buff *skb);
193 void ovs_flow_stats_get(struct sw_flow *flow, struct ovs_flow_stats *stats,
194 			unsigned long *used, __be16 *tcp_flags);
195 void ovs_flow_stats_clear(struct sw_flow *flow);
196 u64 ovs_flow_used_time(unsigned long flow_jiffies);
197 
198 int ovs_flow_extract(struct sk_buff *, u16 in_port, struct sw_flow_key *);
199 
200 #endif /* flow.h */
201