xref: /openbmc/linux/net/openvswitch/flow.h (revision 7d5437c709ded4f152cb8b305d17972d6707f20c)
1 /*
2  * Copyright (c) 2007-2011 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/kernel.h>
23 #include <linux/netlink.h>
24 #include <linux/openvswitch.h>
25 #include <linux/spinlock.h>
26 #include <linux/types.h>
27 #include <linux/rcupdate.h>
28 #include <linux/if_ether.h>
29 #include <linux/in6.h>
30 #include <linux/jiffies.h>
31 #include <linux/time.h>
32 #include <linux/flex_array.h>
33 #include <net/inet_ecn.h>
34 
35 struct sk_buff;
36 
37 struct sw_flow_actions {
38 	struct rcu_head rcu;
39 	u32 actions_len;
40 	struct nlattr actions[];
41 };
42 
43 /* Used to memset ovs_key_ipv4_tunnel padding. */
44 #define OVS_TUNNEL_KEY_SIZE					\
45 	(offsetof(struct ovs_key_ipv4_tunnel, ipv4_ttl) +	\
46 	FIELD_SIZEOF(struct ovs_key_ipv4_tunnel, ipv4_ttl))
47 
48 struct ovs_key_ipv4_tunnel {
49 	__be64 tun_id;
50 	__be32 ipv4_src;
51 	__be32 ipv4_dst;
52 	u16  tun_flags;
53 	u8   ipv4_tos;
54 	u8   ipv4_ttl;
55 };
56 
57 struct sw_flow_key {
58 	struct ovs_key_ipv4_tunnel tun_key;  /* Encapsulating tunnel key. */
59 	struct {
60 		u32	priority;	/* Packet QoS priority. */
61 		u32	skb_mark;	/* SKB mark. */
62 		u16	in_port;	/* Input switch port (or DP_MAX_PORTS). */
63 	} phy;
64 	struct {
65 		u8     src[ETH_ALEN];	/* Ethernet source address. */
66 		u8     dst[ETH_ALEN];	/* Ethernet destination address. */
67 		__be16 tci;		/* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
68 		__be16 type;		/* Ethernet frame type. */
69 	} eth;
70 	struct {
71 		u8     proto;		/* IP protocol or lower 8 bits of ARP opcode. */
72 		u8     tos;		/* IP ToS. */
73 		u8     ttl;		/* IP TTL/hop limit. */
74 		u8     frag;		/* One of OVS_FRAG_TYPE_*. */
75 	} ip;
76 	union {
77 		struct {
78 			struct {
79 				__be32 src;	/* IP source address. */
80 				__be32 dst;	/* IP destination address. */
81 			} addr;
82 			union {
83 				struct {
84 					__be16 src;		/* TCP/UDP source port. */
85 					__be16 dst;		/* TCP/UDP destination port. */
86 				} tp;
87 				struct {
88 					u8 sha[ETH_ALEN];	/* ARP source hardware address. */
89 					u8 tha[ETH_ALEN];	/* ARP target hardware address. */
90 				} arp;
91 			};
92 		} ipv4;
93 		struct {
94 			struct {
95 				struct in6_addr src;	/* IPv6 source address. */
96 				struct in6_addr dst;	/* IPv6 destination address. */
97 			} addr;
98 			__be32 label;			/* IPv6 flow label. */
99 			struct {
100 				__be16 src;		/* TCP/UDP source port. */
101 				__be16 dst;		/* TCP/UDP destination port. */
102 			} tp;
103 			struct {
104 				struct in6_addr target;	/* ND target address. */
105 				u8 sll[ETH_ALEN];	/* ND source link layer address. */
106 				u8 tll[ETH_ALEN];	/* ND target link layer address. */
107 			} nd;
108 		} ipv6;
109 	};
110 };
111 
112 struct sw_flow {
113 	struct rcu_head rcu;
114 	struct hlist_node hash_node[2];
115 	u32 hash;
116 
117 	struct sw_flow_key key;
118 	struct sw_flow_actions __rcu *sf_acts;
119 
120 	spinlock_t lock;	/* Lock for values below. */
121 	unsigned long used;	/* Last used time (in jiffies). */
122 	u64 packet_count;	/* Number of packets matched. */
123 	u64 byte_count;		/* Number of bytes matched. */
124 	u8 tcp_flags;		/* Union of seen TCP flags. */
125 };
126 
127 struct arp_eth_header {
128 	__be16      ar_hrd;	/* format of hardware address   */
129 	__be16      ar_pro;	/* format of protocol address   */
130 	unsigned char   ar_hln;	/* length of hardware address   */
131 	unsigned char   ar_pln;	/* length of protocol address   */
132 	__be16      ar_op;	/* ARP opcode (command)     */
133 
134 	/* Ethernet+IPv4 specific members. */
135 	unsigned char       ar_sha[ETH_ALEN];	/* sender hardware address  */
136 	unsigned char       ar_sip[4];		/* sender IP address        */
137 	unsigned char       ar_tha[ETH_ALEN];	/* target hardware address  */
138 	unsigned char       ar_tip[4];		/* target IP address        */
139 } __packed;
140 
141 int ovs_flow_init(void);
142 void ovs_flow_exit(void);
143 
144 struct sw_flow *ovs_flow_alloc(void);
145 void ovs_flow_deferred_free(struct sw_flow *);
146 void ovs_flow_free(struct sw_flow *flow);
147 
148 struct sw_flow_actions *ovs_flow_actions_alloc(int actions_len);
149 void ovs_flow_deferred_free_acts(struct sw_flow_actions *);
150 
151 int ovs_flow_extract(struct sk_buff *, u16 in_port, struct sw_flow_key *,
152 		     int *key_lenp);
153 void ovs_flow_used(struct sw_flow *, struct sk_buff *);
154 u64 ovs_flow_used_time(unsigned long flow_jiffies);
155 
156 int ovs_flow_to_nlattrs(const struct sw_flow_key *, struct sk_buff *);
157 int ovs_flow_from_nlattrs(struct sw_flow_key *swkey, int *key_lenp,
158 		      const struct nlattr *);
159 int ovs_flow_metadata_from_nlattrs(struct sw_flow *flow,
160 				  const struct nlattr *attr);
161 
162 #define MAX_ACTIONS_BUFSIZE    (16 * 1024)
163 #define TBL_MIN_BUCKETS		1024
164 
165 struct flow_table {
166 	struct flex_array *buckets;
167 	unsigned int count, n_buckets;
168 	struct rcu_head rcu;
169 	int node_ver;
170 	u32 hash_seed;
171 	bool keep_flows;
172 };
173 
174 static inline int ovs_flow_tbl_count(struct flow_table *table)
175 {
176 	return table->count;
177 }
178 
179 static inline int ovs_flow_tbl_need_to_expand(struct flow_table *table)
180 {
181 	return (table->count > table->n_buckets);
182 }
183 
184 struct sw_flow *ovs_flow_tbl_lookup(struct flow_table *table,
185 				    struct sw_flow_key *key, int len);
186 void ovs_flow_tbl_destroy(struct flow_table *table);
187 void ovs_flow_tbl_deferred_destroy(struct flow_table *table);
188 struct flow_table *ovs_flow_tbl_alloc(int new_size);
189 struct flow_table *ovs_flow_tbl_expand(struct flow_table *table);
190 struct flow_table *ovs_flow_tbl_rehash(struct flow_table *table);
191 void ovs_flow_tbl_insert(struct flow_table *table, struct sw_flow *flow);
192 void ovs_flow_tbl_remove(struct flow_table *table, struct sw_flow *flow);
193 u32 ovs_flow_hash(const struct sw_flow_key *key, int key_len);
194 
195 struct sw_flow *ovs_flow_tbl_next(struct flow_table *table, u32 *bucket, u32 *idx);
196 extern const int ovs_key_lens[OVS_KEY_ATTR_MAX + 1];
197 int ovs_ipv4_tun_from_nlattr(const struct nlattr *attr,
198 			 struct ovs_key_ipv4_tunnel *tun_key);
199 int ovs_ipv4_tun_to_nlattr(struct sk_buff *skb,
200 			const struct ovs_key_ipv4_tunnel *tun_key);
201 
202 #endif /* flow.h */
203