]> git.proxmox.com Git - ovs.git/blame - lib/odp-util.h
tunnel: Add support for matching on OAM packets.
[ovs.git] / lib / odp-util.h
CommitLineData
064af421 1/*
94f4d447 2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
064af421 3 *
a14bc59f
BP
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:
064af421 7 *
a14bc59f
BP
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
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.
064af421
BP
15 */
16
17#ifndef ODP_UTIL_H
18#define ODP_UTIL_H 1
19
20#include <stdbool.h>
3762274e 21#include <stddef.h>
064af421 22#include <stdint.h>
14608a15 23#include <string.h>
077257b8 24#include <linux/openvswitch.h>
94f4d447 25#include "flow.h"
14608a15 26#include "hash.h"
0a37839c 27#include "hmap.h"
064af421 28#include "openflow/openflow.h"
9026bf34 29#include "util.h"
064af421
BP
30
31struct ds;
5fa27009 32struct nlattr;
36956a7d 33struct ofpbuf;
44bac24b 34struct simap;
758c456d 35struct pkt_metadata;
064af421 36
7fd91025
BP
37#define SLOW_PATH_REASONS \
38 /* These reasons are mutually exclusive. */ \
39 SPR(SLOW_CFM, "cfm", "Consists of CFM packets") \
40 SPR(SLOW_BFD, "bfd", "Consists of BFD packets") \
41 SPR(SLOW_LACP, "lacp", "Consists of LACP packets") \
42 SPR(SLOW_STP, "stp", "Consists of STP packets") \
43 SPR(SLOW_CONTROLLER, "controller", \
44 "Sends \"packet-in\" messages to the OpenFlow controller") \
45 SPR(SLOW_ACTION, "action", \
46 "Uses action(s) not supported by datapath")
47
48/* Indexes for slow-path reasons. Client code uses "enum slow_path_reason"
49 * values instead of these, these are just a way to construct those. */
50enum {
51#define SPR(ENUM, STRING, EXPLANATION) ENUM##_INDEX,
52 SLOW_PATH_REASONS
53#undef SPR
54};
55
56/* Reasons why a subfacet might not be fast-pathable.
57 *
58 * Each reason is a separate bit to allow reasons to be combined. */
59enum slow_path_reason {
60#define SPR(ENUM, STRING, EXPLANATION) ENUM = 1 << ENUM##_INDEX,
61 SLOW_PATH_REASONS
62#undef SPR
63};
64
65const char *slow_path_reason_to_explanation(enum slow_path_reason);
66
4e022ec0
AW
67#define ODPP_LOCAL ODP_PORT_C(OVSP_LOCAL)
68#define ODPP_NONE ODP_PORT_C(UINT32_MAX)
c75d4dcf 69
cdee00fd
BP
70void format_odp_actions(struct ds *, const struct nlattr *odp_actions,
71 size_t actions_len);
44bac24b 72int odp_actions_from_string(const char *, const struct simap *port_names,
7202cbe5 73 struct ofpbuf *odp_actions);
064af421 74
0a37839c
GS
75/* A map from odp port number to its name. */
76struct odp_portno_names {
77 struct hmap_node hmap_node; /* A node in a port number to name hmap. */
78 odp_port_t port_no; /* Port number in the datapath. */
79 char *name; /* Name associated with the above 'port_no'. */
80};
81
82void odp_portno_names_set(struct hmap *portno_names, odp_port_t port_no,
83 char *port_name);
84void odp_portno_names_destroy(struct hmap *portno_names);
2508ac16
BP
85/* The maximum number of bytes that odp_flow_key_from_flow() appends to a
86 * buffer. This is the upper bound on the length of a nlattr-formatted flow
87 * key that ovs-vswitchd fully understands.
88 *
89 * OVS doesn't insist that ovs-vswitchd and the datapath have exactly the same
90 * idea of a flow, so therefore this value isn't necessarily an upper bound on
91 * the length of a flow key that the datapath can pass to ovs-vswitchd.
92 *
93 * The longest nlattr-formatted flow key appended by odp_flow_key_from_flow()
94 * would be:
36956a7d 95 *
354d4c98
PS
96 * struct pad nl hdr total
97 * ------ --- ------ -----
98 * OVS_KEY_ATTR_PRIORITY 4 -- 4 8
354d4c98
PS
99 * OVS_KEY_ATTR_TUNNEL 0 -- 4 4
100 * - OVS_TUNNEL_KEY_ATTR_ID 8 -- 4 12
101 * - OVS_TUNNEL_KEY_ATTR_IPV4_SRC 4 -- 4 8
102 * - OVS_TUNNEL_KEY_ATTR_IPV4_DST 4 -- 4 8
103 * - OVS_TUNNEL_KEY_ATTR_TOS 1 3 4 8
104 * - OVS_TUNNEL_KEY_ATTR_TTL 1 3 4 8
105 * - OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT 0 -- 4 4
106 * - OVS_TUNNEL_KEY_ATTR_CSUM 0 -- 4 4
94872594 107 * - OVS_TUNNEL_KEY_ATTR_OAM 0 -- 4 4
354d4c98
PS
108 * OVS_KEY_ATTR_IN_PORT 4 -- 4 8
109 * OVS_KEY_ATTR_SKB_MARK 4 -- 4 8
b96986ed
AZ
110 * OVS_KEY_ATTR_DP_HASH 4 -- 4 8
111 * OVS_KEY_ATTR_RECIRC_ID 4 -- 4 8
354d4c98
PS
112 * OVS_KEY_ATTR_ETHERNET 12 -- 4 16
113 * OVS_KEY_ATTR_ETHERTYPE 2 2 4 8 (outer VLAN ethertype)
114 * OVS_KEY_ATTR_8021Q 4 -- 4 8
115 * OVS_KEY_ATTR_ENCAP 0 -- 4 4 (VLAN encapsulation)
116 * OVS_KEY_ATTR_ETHERTYPE 2 2 4 8 (inner VLAN ethertype)
117 * OVS_KEY_ATTR_IPV6 40 -- 4 44
118 * OVS_KEY_ATTR_ICMPV6 2 2 4 8
119 * OVS_KEY_ATTR_ND 28 -- 4 32
120 * ----------------------------------------------------------
94872594 121 * total 228
2508ac16
BP
122 *
123 * We include some slack space in case the calculation isn't quite right or we
124 * add another field and forget to adjust this value.
18c43631 125 */
72e8bf28 126#define ODPUTIL_FLOW_KEY_BYTES 256
94f4d447 127BUILD_ASSERT_DECL(FLOW_WC_SEQ == 26);
18c43631 128
19cf4069
BP
129/* A buffer with sufficient size and alignment to hold an nlattr-formatted flow
130 * key. An array of "struct nlattr" might not, in theory, be sufficiently
131 * aligned because it only contains 16-bit types. */
132struct odputil_keybuf {
133 uint32_t keybuf[DIV_ROUND_UP(ODPUTIL_FLOW_KEY_BYTES, 4)];
134};
14608a15 135
617e10e7
SH
136enum odp_key_fitness odp_tun_key_from_attr(const struct nlattr *,
137 struct flow_tnl *);
138
e6cc0bab
AZ
139void odp_flow_format(const struct nlattr *key, size_t key_len,
140 const struct nlattr *mask, size_t mask_len,
0a37839c
GS
141 const struct hmap *portno_names, struct ds *,
142 bool verbose);
36956a7d 143void odp_flow_key_format(const struct nlattr *, size_t, struct ds *);
e6cc0bab
AZ
144int odp_flow_from_string(const char *s,
145 const struct simap *port_names,
146 struct ofpbuf *, struct ofpbuf *);
14608a15 147
fbfe01de 148void odp_flow_key_from_flow(struct ofpbuf *, const struct flow * flow,
7ce2769e
JS
149 const struct flow *mask, odp_port_t odp_in_port,
150 bool recirc);
661cbcd5 151void odp_flow_key_from_mask(struct ofpbuf *, const struct flow *mask,
8bfd0fda 152 const struct flow *flow, uint32_t odp_in_port,
7ce2769e 153 size_t max_mpls_depth, bool recirc);
b0f7b9b5
BP
154
155uint32_t odp_flow_key_hash(const struct nlattr *, size_t);
156
758c456d
JR
157/* Estimated space needed for metadata. */
158enum { ODP_KEY_METADATA_SIZE = 9 * 8 };
159void odp_key_from_pkt_metadata(struct ofpbuf *, const struct pkt_metadata *);
160void odp_key_to_pkt_metadata(const struct nlattr *key, size_t key_len,
161 struct pkt_metadata *md);
162
b0f7b9b5
BP
163/* How well a kernel-provided flow key (a sequence of OVS_KEY_ATTR_*
164 * attributes) matches OVS userspace expectations.
165 *
166 * These values are arranged so that greater values are "more important" than
167 * lesser ones. In particular, a single flow key can fit the descriptions for
168 * both ODP_FIT_TOO_LITTLE and ODP_FIT_TOO_MUCH. Such a key is treated as
169 * ODP_FIT_TOO_LITTLE. */
170enum odp_key_fitness {
171 ODP_FIT_PERFECT, /* The key had exactly the fields we expect. */
172 ODP_FIT_TOO_MUCH, /* The key had fields we don't understand. */
173 ODP_FIT_TOO_LITTLE, /* The key lacked fields we expected to see. */
174 ODP_FIT_ERROR, /* The key was invalid. */
175};
176enum odp_key_fitness odp_flow_key_to_flow(const struct nlattr *, size_t,
177 struct flow *);
4a221615
GY
178enum odp_key_fitness odp_flow_key_to_mask(const struct nlattr *key, size_t len,
179 struct flow *mask,
180 const struct flow *flow);
6814e51f 181const char *odp_key_fitness_to_string(enum odp_key_fitness);
14608a15 182
b9ad7294
EJ
183void commit_odp_tunnel_action(const struct flow *, struct flow *base,
184 struct ofpbuf *odp_actions);
7fd91025
BP
185enum slow_path_reason commit_odp_actions(const struct flow *,
186 struct flow *base,
187 struct ofpbuf *odp_actions,
8bfd0fda 188 struct flow_wildcards *wc);
6a7e895f
BP
189\f
190/* ofproto-dpif interface.
191 *
192 * The following types and functions are logically part of ofproto-dpif.
193 * ofproto-dpif puts values of these types into the flows that it installs in
194 * the kernel datapath, though, so ovs-dpctl needs to interpret them so that
195 * it can print flows in a more human-readable manner. */
196
6ff686f2
PS
197enum user_action_cookie_type {
198 USER_ACTION_COOKIE_UNSPEC,
29089a54
RL
199 USER_ACTION_COOKIE_SFLOW, /* Packet for per-bridge sFlow sampling. */
200 USER_ACTION_COOKIE_SLOW_PATH, /* Userspace must process this flow. */
201 USER_ACTION_COOKIE_FLOW_SAMPLE, /* Packet for per-flow sampling. */
202 USER_ACTION_COOKIE_IPFIX, /* Packet for per-bridge IPFIX sampling. */
6ff686f2
PS
203};
204
205/* user_action_cookie is passed as argument to OVS_ACTION_ATTR_USERSPACE.
0a18743a 206 * Since it is passed to kernel as u64, its size has to be 8 bytes. */
1673e0e4 207union user_action_cookie {
36fc5f18
BP
208 uint16_t type; /* enum user_action_cookie_type. */
209
1673e0e4
BP
210 struct {
211 uint16_t type; /* USER_ACTION_COOKIE_SFLOW. */
212 ovs_be16 vlan_tci; /* Destination VLAN TCI. */
213 uint32_t output; /* SFL_FLOW_SAMPLE_TYPE 'output' value. */
214 } sflow;
6ff686f2 215
6a7e895f
BP
216 struct {
217 uint16_t type; /* USER_ACTION_COOKIE_SLOW_PATH. */
218 uint16_t unused;
219 uint32_t reason; /* enum slow_path_reason. */
220 } slow_path;
29089a54
RL
221
222 struct {
223 uint16_t type; /* USER_ACTION_COOKIE_FLOW_SAMPLE. */
224 uint16_t probability; /* Sampling probability. */
225 uint32_t collector_set_id; /* ID of IPFIX collector set. */
226 uint32_t obs_domain_id; /* Observation Domain ID. */
227 uint32_t obs_point_id; /* Observation Point ID. */
228 } flow_sample;
229
230 struct {
231 uint16_t type; /* USER_ACTION_COOKIE_IPFIX. */
232 } ipfix;
6a7e895f 233};
29089a54 234BUILD_ASSERT_DECL(sizeof(union user_action_cookie) == 16);
6ff686f2 235
39db78a0 236size_t odp_put_userspace_action(uint32_t pid,
e995e3df 237 const void *userdata, size_t userdata_size,
39db78a0 238 struct ofpbuf *odp_actions);
b9ad7294
EJ
239void odp_put_tunnel_action(const struct flow_tnl *tunnel,
240 struct ofpbuf *odp_actions);
1362e248 241void odp_put_pkt_mark_action(const uint32_t pkt_mark,
09a0d2e7 242 struct ofpbuf *odp_actions);
5bbda0aa 243
064af421 244#endif /* odp-util.h */