2 * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
24 #include <linux/openvswitch.h>
27 #include "openflow/openflow.h"
33 struct flow_wildcards;
39 #define SLOW_PATH_REASONS \
40 /* These reasons are mutually exclusive. */ \
41 SPR(SLOW_CFM, "cfm", "Consists of CFM packets") \
42 SPR(SLOW_BFD, "bfd", "Consists of BFD packets") \
43 SPR(SLOW_LACP, "lacp", "Consists of LACP packets") \
44 SPR(SLOW_STP, "stp", "Consists of STP packets") \
45 SPR(SLOW_CONTROLLER, "controller", \
46 "Sends \"packet-in\" messages to the OpenFlow controller") \
47 SPR(SLOW_ACTION, "action", \
48 "Uses action(s) not supported by datapath")
50 /* Indexes for slow-path reasons. Client code uses "enum slow_path_reason"
51 * values instead of these, these are just a way to construct those. */
53 #define SPR(ENUM, STRING, EXPLANATION) ENUM##_INDEX,
58 /* Reasons why a subfacet might not be fast-pathable.
60 * Each reason is a separate bit to allow reasons to be combined. */
61 enum slow_path_reason {
62 #define SPR(ENUM, STRING, EXPLANATION) ENUM = 1 << ENUM##_INDEX,
67 const char *slow_path_reason_to_explanation(enum slow_path_reason);
69 #define ODPP_LOCAL ODP_PORT_C(OVSP_LOCAL)
70 #define ODPP_NONE ODP_PORT_C(UINT32_MAX)
72 void format_odp_actions(struct ds *, const struct nlattr *odp_actions,
74 int odp_actions_from_string(const char *, const struct simap *port_names,
75 struct ofpbuf *odp_actions);
77 /* A map from odp port number to its name. */
78 struct odp_portno_names {
79 struct hmap_node hmap_node; /* A node in a port number to name hmap. */
80 odp_port_t port_no; /* Port number in the datapath. */
81 char *name; /* Name associated with the above 'port_no'. */
84 void odp_portno_names_set(struct hmap *portno_names, odp_port_t port_no,
86 void odp_portno_names_destroy(struct hmap *portno_names);
87 /* The maximum number of bytes that odp_flow_key_from_flow() appends to a
88 * buffer. This is the upper bound on the length of a nlattr-formatted flow
89 * key that ovs-vswitchd fully understands.
91 * OVS doesn't insist that ovs-vswitchd and the datapath have exactly the same
92 * idea of a flow, so therefore this value isn't necessarily an upper bound on
93 * the length of a flow key that the datapath can pass to ovs-vswitchd.
95 * The longest nlattr-formatted flow key appended by odp_flow_key_from_flow()
98 * struct pad nl hdr total
99 * ------ --- ------ -----
100 * OVS_KEY_ATTR_PRIORITY 4 -- 4 8
101 * OVS_KEY_ATTR_TUNNEL 0 -- 4 4
102 * - OVS_TUNNEL_KEY_ATTR_ID 8 -- 4 12
103 * - OVS_TUNNEL_KEY_ATTR_IPV4_SRC 4 -- 4 8
104 * - OVS_TUNNEL_KEY_ATTR_IPV4_DST 4 -- 4 8
105 * - OVS_TUNNEL_KEY_ATTR_TOS 1 3 4 8
106 * - OVS_TUNNEL_KEY_ATTR_TTL 1 3 4 8
107 * - OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT 0 -- 4 4
108 * - OVS_TUNNEL_KEY_ATTR_CSUM 0 -- 4 4
109 * OVS_KEY_ATTR_IN_PORT 4 -- 4 8
110 * OVS_KEY_ATTR_SKB_MARK 4 -- 4 8
111 * OVS_KEY_ATTR_ETHERNET 12 -- 4 16
112 * OVS_KEY_ATTR_ETHERTYPE 2 2 4 8 (outer VLAN ethertype)
113 * OVS_KEY_ATTR_8021Q 4 -- 4 8
114 * OVS_KEY_ATTR_ENCAP 0 -- 4 4 (VLAN encapsulation)
115 * OVS_KEY_ATTR_ETHERTYPE 2 2 4 8 (inner VLAN ethertype)
116 * OVS_KEY_ATTR_IPV6 40 -- 4 44
117 * OVS_KEY_ATTR_ICMPV6 2 2 4 8
118 * OVS_KEY_ATTR_ND 28 -- 4 32
119 * ----------------------------------------------------------
122 * We include some slack space in case the calculation isn't quite right or we
123 * add another field and forget to adjust this value.
125 #define ODPUTIL_FLOW_KEY_BYTES 256
127 /* A buffer with sufficient size and alignment to hold an nlattr-formatted flow
128 * key. An array of "struct nlattr" might not, in theory, be sufficiently
129 * aligned because it only contains 16-bit types. */
130 struct odputil_keybuf {
131 uint32_t keybuf[DIV_ROUND_UP(ODPUTIL_FLOW_KEY_BYTES, 4)];
134 enum odp_key_fitness odp_tun_key_from_attr(const struct nlattr *,
137 void odp_flow_format(const struct nlattr *key, size_t key_len,
138 const struct nlattr *mask, size_t mask_len,
139 const struct hmap *portno_names, struct ds *,
141 void odp_flow_key_format(const struct nlattr *, size_t, struct ds *);
142 int odp_flow_from_string(const char *s,
143 const struct simap *port_names,
144 struct ofpbuf *, struct ofpbuf *);
146 void odp_flow_key_from_flow(struct ofpbuf *, const struct flow *,
147 odp_port_t odp_in_port);
148 void odp_flow_key_from_mask(struct ofpbuf *, const struct flow *mask,
149 const struct flow *flow, uint32_t odp_in_port,
150 size_t max_mpls_depth);
152 uint32_t odp_flow_key_hash(const struct nlattr *, size_t);
154 /* Estimated space needed for metadata. */
155 enum { ODP_KEY_METADATA_SIZE = 9 * 8 };
156 void odp_key_from_pkt_metadata(struct ofpbuf *, const struct pkt_metadata *);
157 void odp_key_to_pkt_metadata(const struct nlattr *key, size_t key_len,
158 struct pkt_metadata *md);
160 /* How well a kernel-provided flow key (a sequence of OVS_KEY_ATTR_*
161 * attributes) matches OVS userspace expectations.
163 * These values are arranged so that greater values are "more important" than
164 * lesser ones. In particular, a single flow key can fit the descriptions for
165 * both ODP_FIT_TOO_LITTLE and ODP_FIT_TOO_MUCH. Such a key is treated as
166 * ODP_FIT_TOO_LITTLE. */
167 enum odp_key_fitness {
168 ODP_FIT_PERFECT, /* The key had exactly the fields we expect. */
169 ODP_FIT_TOO_MUCH, /* The key had fields we don't understand. */
170 ODP_FIT_TOO_LITTLE, /* The key lacked fields we expected to see. */
171 ODP_FIT_ERROR, /* The key was invalid. */
173 enum odp_key_fitness odp_flow_key_to_flow(const struct nlattr *, size_t,
175 enum odp_key_fitness odp_flow_key_to_mask(const struct nlattr *key, size_t len,
177 const struct flow *flow);
178 const char *odp_key_fitness_to_string(enum odp_key_fitness);
180 void commit_odp_tunnel_action(const struct flow *, struct flow *base,
181 struct ofpbuf *odp_actions);
182 enum slow_path_reason commit_odp_actions(const struct flow *,
184 struct ofpbuf *odp_actions,
185 struct flow_wildcards *wc);
187 /* ofproto-dpif interface.
189 * The following types and functions are logically part of ofproto-dpif.
190 * ofproto-dpif puts values of these types into the flows that it installs in
191 * the kernel datapath, though, so ovs-dpctl needs to interpret them so that
192 * it can print flows in a more human-readable manner. */
194 enum user_action_cookie_type {
195 USER_ACTION_COOKIE_UNSPEC,
196 USER_ACTION_COOKIE_SFLOW, /* Packet for per-bridge sFlow sampling. */
197 USER_ACTION_COOKIE_SLOW_PATH, /* Userspace must process this flow. */
198 USER_ACTION_COOKIE_FLOW_SAMPLE, /* Packet for per-flow sampling. */
199 USER_ACTION_COOKIE_IPFIX, /* Packet for per-bridge IPFIX sampling. */
202 /* user_action_cookie is passed as argument to OVS_ACTION_ATTR_USERSPACE.
203 * Since it is passed to kernel as u64, its size has to be 8 bytes. */
204 union user_action_cookie {
205 uint16_t type; /* enum user_action_cookie_type. */
208 uint16_t type; /* USER_ACTION_COOKIE_SFLOW. */
209 ovs_be16 vlan_tci; /* Destination VLAN TCI. */
210 uint32_t output; /* SFL_FLOW_SAMPLE_TYPE 'output' value. */
214 uint16_t type; /* USER_ACTION_COOKIE_SLOW_PATH. */
216 uint32_t reason; /* enum slow_path_reason. */
220 uint16_t type; /* USER_ACTION_COOKIE_FLOW_SAMPLE. */
221 uint16_t probability; /* Sampling probability. */
222 uint32_t collector_set_id; /* ID of IPFIX collector set. */
223 uint32_t obs_domain_id; /* Observation Domain ID. */
224 uint32_t obs_point_id; /* Observation Point ID. */
228 uint16_t type; /* USER_ACTION_COOKIE_IPFIX. */
231 BUILD_ASSERT_DECL(sizeof(union user_action_cookie) == 16);
233 size_t odp_put_userspace_action(uint32_t pid,
234 const void *userdata, size_t userdata_size,
235 struct ofpbuf *odp_actions);
236 void odp_put_tunnel_action(const struct flow_tnl *tunnel,
237 struct ofpbuf *odp_actions);
238 void odp_put_pkt_mark_action(const uint32_t pkt_mark,
239 struct ofpbuf *odp_actions);
241 #endif /* odp-util.h */