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>
26 #include "openflow/openflow.h"
36 #define OVSP_NONE UINT32_MAX
38 void format_odp_actions(struct ds *, const struct nlattr *odp_actions,
40 int odp_actions_from_string(const char *, const struct simap *port_names,
41 struct ofpbuf *odp_actions);
43 /* The maximum number of bytes that odp_flow_key_from_flow() appends to a
44 * buffer. This is the upper bound on the length of a nlattr-formatted flow
45 * key that ovs-vswitchd fully understands.
47 * OVS doesn't insist that ovs-vswitchd and the datapath have exactly the same
48 * idea of a flow, so therefore this value isn't necessarily an upper bound on
49 * the length of a flow key that the datapath can pass to ovs-vswitchd.
51 * The longest nlattr-formatted flow key appended by odp_flow_key_from_flow()
54 * struct pad nl hdr total
55 * ------ --- ------ -----
56 * OVS_KEY_ATTR_PRIORITY 4 -- 4 8
57 * OVS_KEY_ATTR_TUN_ID 8 -- 4 12
58 * OVS_KEY_ATTR_TUNNEL 0 -- 4 4
59 * - OVS_TUNNEL_KEY_ATTR_ID 8 -- 4 12
60 * - OVS_TUNNEL_KEY_ATTR_IPV4_SRC 4 -- 4 8
61 * - OVS_TUNNEL_KEY_ATTR_IPV4_DST 4 -- 4 8
62 * - OVS_TUNNEL_KEY_ATTR_TOS 1 3 4 8
63 * - OVS_TUNNEL_KEY_ATTR_TTL 1 3 4 8
64 * - OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT 0 -- 4 4
65 * - OVS_TUNNEL_KEY_ATTR_CSUM 0 -- 4 4
66 * OVS_KEY_ATTR_IN_PORT 4 -- 4 8
67 * OVS_KEY_ATTR_SKB_MARK 4 -- 4 8
68 * OVS_KEY_ATTR_ETHERNET 12 -- 4 16
69 * OVS_KEY_ATTR_ETHERTYPE 2 2 4 8 (outer VLAN ethertype)
70 * OVS_KEY_ATTR_8021Q 4 -- 4 8
71 * OVS_KEY_ATTR_ENCAP 0 -- 4 4 (VLAN encapsulation)
72 * OVS_KEY_ATTR_ETHERTYPE 2 2 4 8 (inner VLAN ethertype)
73 * OVS_KEY_ATTR_IPV6 40 -- 4 44
74 * OVS_KEY_ATTR_ICMPV6 2 2 4 8
75 * OVS_KEY_ATTR_ND 28 -- 4 32
76 * ----------------------------------------------------------
79 * We include some slack space in case the calculation isn't quite right or we
80 * add another field and forget to adjust this value.
82 #define ODPUTIL_FLOW_KEY_BYTES 256
84 /* A buffer with sufficient size and alignment to hold an nlattr-formatted flow
85 * key. An array of "struct nlattr" might not, in theory, be sufficiently
86 * aligned because it only contains 16-bit types. */
87 struct odputil_keybuf {
88 uint32_t keybuf[DIV_ROUND_UP(ODPUTIL_FLOW_KEY_BYTES, 4)];
91 void odp_flow_key_format(const struct nlattr *, size_t, struct ds *);
92 int odp_flow_key_from_string(const char *s, const struct simap *port_names,
95 void odp_flow_key_from_flow(struct ofpbuf *, const struct flow *,
96 uint32_t odp_in_port);
98 uint32_t odp_flow_key_hash(const struct nlattr *, size_t);
100 /* How well a kernel-provided flow key (a sequence of OVS_KEY_ATTR_*
101 * attributes) matches OVS userspace expectations.
103 * These values are arranged so that greater values are "more important" than
104 * lesser ones. In particular, a single flow key can fit the descriptions for
105 * both ODP_FIT_TOO_LITTLE and ODP_FIT_TOO_MUCH. Such a key is treated as
106 * ODP_FIT_TOO_LITTLE. */
107 enum odp_key_fitness {
108 ODP_FIT_PERFECT, /* The key had exactly the fields we expect. */
109 ODP_FIT_TOO_MUCH, /* The key had fields we don't understand. */
110 ODP_FIT_TOO_LITTLE, /* The key lacked fields we expected to see. */
111 ODP_FIT_ERROR, /* The key was invalid. */
113 enum odp_key_fitness odp_flow_key_to_flow(const struct nlattr *, size_t,
115 const char *odp_key_fitness_to_string(enum odp_key_fitness);
117 void commit_odp_tunnel_action(const struct flow *, struct flow *base,
118 struct ofpbuf *odp_actions);
119 void commit_odp_actions(const struct flow *, struct flow *base,
120 struct ofpbuf *odp_actions);
122 /* ofproto-dpif interface.
124 * The following types and functions are logically part of ofproto-dpif.
125 * ofproto-dpif puts values of these types into the flows that it installs in
126 * the kernel datapath, though, so ovs-dpctl needs to interpret them so that
127 * it can print flows in a more human-readable manner. */
129 enum user_action_cookie_type {
130 USER_ACTION_COOKIE_UNSPEC,
131 USER_ACTION_COOKIE_SFLOW, /* Packet for sFlow sampling. */
132 USER_ACTION_COOKIE_SLOW_PATH /* Userspace must process this flow. */
135 /* user_action_cookie is passed as argument to OVS_ACTION_ATTR_USERSPACE.
136 * Since it is passed to kernel as u64, its size has to be 8 bytes. */
137 union user_action_cookie {
138 uint16_t type; /* enum user_action_cookie_type. */
141 uint16_t type; /* USER_ACTION_COOKIE_SFLOW. */
142 ovs_be16 vlan_tci; /* Destination VLAN TCI. */
143 uint32_t output; /* SFL_FLOW_SAMPLE_TYPE 'output' value. */
147 uint16_t type; /* USER_ACTION_COOKIE_SLOW_PATH. */
149 uint32_t reason; /* enum slow_path_reason. */
152 BUILD_ASSERT_DECL(sizeof(union user_action_cookie) == 8);
154 size_t odp_put_userspace_action(uint32_t pid,
155 const union user_action_cookie *,
156 struct ofpbuf *odp_actions);
157 void odp_put_tunnel_action(const struct flow_tnl *tunnel,
158 struct ofpbuf *odp_actions);
160 /* Reasons why a subfacet might not be fast-pathable. */
161 enum slow_path_reason {
162 /* These reasons are mutually exclusive. */
163 SLOW_CFM = 1 << 0, /* CFM packets need per-packet processing. */
164 SLOW_LACP = 1 << 1, /* LACP packets need per-packet processing. */
165 SLOW_STP = 1 << 2, /* STP packets need per-packet processing. */
166 SLOW_IN_BAND = 1 << 3, /* In-band control needs every packet. */
168 /* Mutually exclusive with SLOW_CFM, SLOW_LACP, SLOW_STP.
169 * Could possibly appear with SLOW_IN_BAND. */
170 SLOW_CONTROLLER = 1 << 4, /* Packets must go to OpenFlow controller. */
172 /* This can appear on its own, or, theoretically at least, along with any
173 * other combination of reasons. */
174 SLOW_MATCH = 1 << 5, /* Datapath can't match specifically enough. */
177 #endif /* odp-util.h */