]> git.proxmox.com Git - mirror_ovs.git/blob - datapath/flow.h
59c7f6e86aab5f1518c8c71e7c1dbe13bb594001
[mirror_ovs.git] / datapath / flow.h
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/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
34 #include <net/inet_ecn.h>
35 #include <net/ip_tunnels.h>
36
37 struct sk_buff;
38 struct sw_flow_mask;
39 struct flow_table;
40
41 struct sw_flow_actions {
42 struct rcu_head rcu;
43 u32 actions_len;
44 struct nlattr actions[];
45 };
46
47 /* Used to memset ovs_key_ipv4_tunnel padding. */
48 #define OVS_TUNNEL_KEY_SIZE \
49 (offsetof(struct ovs_key_ipv4_tunnel, ipv4_ttl) + \
50 FIELD_SIZEOF(struct ovs_key_ipv4_tunnel, ipv4_ttl))
51
52 struct ovs_key_ipv4_tunnel {
53 __be64 tun_id;
54 __be32 ipv4_src;
55 __be32 ipv4_dst;
56 __be16 tun_flags;
57 u8 ipv4_tos;
58 u8 ipv4_ttl;
59 };
60
61 struct sw_flow_key {
62 struct ovs_key_ipv4_tunnel tun_key; /* Encapsulating tunnel key. */
63 struct {
64 u32 priority; /* Packet QoS priority. */
65 u32 skb_mark; /* SKB mark. */
66 u16 in_port; /* Input switch port (or DP_MAX_PORTS). */
67 } phy;
68 struct {
69 u8 src[ETH_ALEN]; /* Ethernet source address. */
70 u8 dst[ETH_ALEN]; /* Ethernet destination address. */
71 __be16 tci; /* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
72 __be16 type; /* Ethernet frame type. */
73 } eth;
74 struct {
75 u8 proto; /* IP protocol or lower 8 bits of ARP opcode. */
76 u8 tos; /* IP ToS. */
77 u8 ttl; /* IP TTL/hop limit. */
78 u8 frag; /* One of OVS_FRAG_TYPE_*. */
79 } ip;
80 union {
81 struct {
82 struct {
83 __be32 src; /* IP source address. */
84 __be32 dst; /* IP destination address. */
85 } addr;
86 union {
87 struct {
88 __be16 src; /* TCP/UDP source port. */
89 __be16 dst; /* TCP/UDP destination port. */
90 } tp;
91 struct {
92 u8 sha[ETH_ALEN]; /* ARP source hardware address. */
93 u8 tha[ETH_ALEN]; /* ARP target hardware address. */
94 } arp;
95 };
96 } ipv4;
97 struct {
98 struct {
99 struct in6_addr src; /* IPv6 source address. */
100 struct in6_addr dst; /* IPv6 destination address. */
101 } addr;
102 __be32 label; /* IPv6 flow label. */
103 struct {
104 __be16 src; /* TCP/UDP source port. */
105 __be16 dst; /* TCP/UDP destination port. */
106 } tp;
107 struct {
108 struct in6_addr target; /* ND target address. */
109 u8 sll[ETH_ALEN]; /* ND source link layer address. */
110 u8 tll[ETH_ALEN]; /* ND target link layer address. */
111 } nd;
112 } ipv6;
113 };
114 };
115
116 struct sw_flow {
117 struct rcu_head rcu;
118 struct hlist_node hash_node[2];
119 u32 hash;
120
121 struct sw_flow_key key;
122 struct sw_flow_key unmasked_key;
123 struct sw_flow_mask *mask;
124 struct sw_flow_actions __rcu *sf_acts;
125
126 spinlock_t lock; /* Lock for values below. */
127 unsigned long used; /* Last used time (in jiffies). */
128 u64 packet_count; /* Number of packets matched. */
129 u64 byte_count; /* Number of bytes matched. */
130 u8 tcp_flags; /* Union of seen TCP flags. */
131 };
132
133 struct sw_flow_key_range {
134 size_t start;
135 size_t end;
136 };
137
138 static inline u16 ovs_sw_flow_key_range_actual_size(const struct sw_flow_key_range *range)
139 {
140 return range->end - range->start;
141 }
142
143 struct sw_flow_match {
144 struct sw_flow_key *key;
145 struct sw_flow_key_range range;
146 struct sw_flow_mask *mask;
147 };
148
149 void ovs_match_init(struct sw_flow_match *match,
150 struct sw_flow_key *key, struct sw_flow_mask *mask);
151
152 struct arp_eth_header {
153 __be16 ar_hrd; /* format of hardware address */
154 __be16 ar_pro; /* format of protocol address */
155 unsigned char ar_hln; /* length of hardware address */
156 unsigned char ar_pln; /* length of protocol address */
157 __be16 ar_op; /* ARP opcode (command) */
158
159 /* Ethernet+IPv4 specific members. */
160 unsigned char ar_sha[ETH_ALEN]; /* sender hardware address */
161 unsigned char ar_sip[4]; /* sender IP address */
162 unsigned char ar_tha[ETH_ALEN]; /* target hardware address */
163 unsigned char ar_tip[4]; /* target IP address */
164 } __packed;
165
166 int ovs_flow_init(void);
167 void ovs_flow_exit(void);
168
169 struct sw_flow *ovs_flow_alloc(void);
170 void ovs_flow_deferred_free(struct sw_flow *);
171 void ovs_flow_free(struct sw_flow *, bool deferred);
172
173 struct sw_flow_actions *ovs_flow_actions_alloc(int actions_len);
174 void ovs_flow_deferred_free_acts(struct sw_flow_actions *);
175
176 int ovs_flow_extract(struct sk_buff *, u16 in_port, struct sw_flow_key *);
177 void ovs_flow_used(struct sw_flow *, struct sk_buff *);
178 u64 ovs_flow_used_time(unsigned long flow_jiffies);
179 int ovs_flow_to_nlattrs(const struct sw_flow_key *,
180 const struct sw_flow_key *, struct sk_buff *);
181 int ovs_match_from_nlattrs(struct sw_flow_match *match,
182 const struct nlattr *,
183 const struct nlattr *);
184 int ovs_flow_metadata_from_nlattrs(struct sw_flow *flow,
185 const struct nlattr *attr);
186
187 #define MAX_ACTIONS_BUFSIZE (32 * 1024)
188 #define TBL_MIN_BUCKETS 1024
189
190 struct flow_table {
191 struct flex_array *buckets;
192 unsigned int count, n_buckets;
193 struct rcu_head rcu;
194 struct list_head *mask_list;
195 int node_ver;
196 u32 hash_seed;
197 bool keep_flows;
198 };
199
200 static inline int ovs_flow_tbl_count(struct flow_table *table)
201 {
202 return table->count;
203 }
204
205 static inline int ovs_flow_tbl_need_to_expand(struct flow_table *table)
206 {
207 return (table->count > table->n_buckets);
208 }
209
210 struct sw_flow *ovs_flow_lookup(struct flow_table *,
211 const struct sw_flow_key *);
212 struct sw_flow *ovs_flow_lookup_unmasked_key(struct flow_table *table,
213 struct sw_flow_match *match);
214
215 void ovs_flow_tbl_destroy(struct flow_table *table, bool deferred);
216 struct flow_table *ovs_flow_tbl_alloc(int new_size);
217 struct flow_table *ovs_flow_tbl_expand(struct flow_table *table);
218 struct flow_table *ovs_flow_tbl_rehash(struct flow_table *table);
219
220 void ovs_flow_insert(struct flow_table *table, struct sw_flow *flow);
221 void ovs_flow_remove(struct flow_table *table, struct sw_flow *flow);
222
223 struct sw_flow *ovs_flow_dump_next(struct flow_table *table, u32 *bucket, u32 *idx);
224 extern const int ovs_key_lens[OVS_KEY_ATTR_MAX + 1];
225 int ipv4_tun_from_nlattr(const struct nlattr *attr,
226 struct sw_flow_match *match, bool is_mask);
227 int ipv4_tun_to_nlattr(struct sk_buff *skb,
228 const struct ovs_key_ipv4_tunnel *tun_key,
229 const struct ovs_key_ipv4_tunnel *output);
230
231 bool ovs_flow_cmp_unmasked_key(const struct sw_flow *flow,
232 const struct sw_flow_key *key, int key_len);
233
234 struct sw_flow_mask {
235 int ref_count;
236 struct rcu_head rcu;
237 struct list_head list;
238 struct sw_flow_key_range range;
239 struct sw_flow_key key;
240 };
241
242 static inline u16
243 ovs_sw_flow_mask_actual_size(const struct sw_flow_mask *mask)
244 {
245 return ovs_sw_flow_key_range_actual_size(&mask->range);
246 }
247
248 static inline u16
249 ovs_sw_flow_mask_size_roundup(const struct sw_flow_mask *mask)
250 {
251 return roundup(ovs_sw_flow_mask_actual_size(mask), sizeof(u32));
252 }
253
254 struct sw_flow_mask *ovs_sw_flow_mask_alloc(void);
255 void ovs_sw_flow_mask_add_ref(struct sw_flow_mask *);
256 void ovs_sw_flow_mask_del_ref(struct sw_flow_mask *, bool deferred);
257 void ovs_sw_flow_mask_insert(struct flow_table *, struct sw_flow_mask *);
258 struct sw_flow_mask *ovs_sw_flow_mask_find(const struct flow_table *,
259 const struct sw_flow_mask *);
260 void ovs_flow_key_mask(struct sw_flow_key *dst, const struct sw_flow_key *src,
261 const struct sw_flow_mask *mask);
262 #endif /* flow.h */