]>
Commit | Line | Data |
---|---|---|
fa37b408 | 1 | /* |
dc4762ed | 2 | * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks. |
fa37b408 BP |
3 | * |
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: | |
7 | * | |
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. | |
15 | */ | |
16 | ||
17 | #include <config.h> | |
18 | #include "ofp-print.h" | |
dc4762ed | 19 | #include <errno.h> |
fa37b408 BP |
20 | #include <inttypes.h> |
21 | #include <stdlib.h> | |
10a24935 | 22 | #include "byte-order.h" |
d8ae4d67 | 23 | #include "classifier.h" |
dc4762ed | 24 | #include "dynamic-string.h" |
53ddd40a | 25 | #include "multipath.h" |
b6c9e612 | 26 | #include "nx-match.h" |
dc4762ed | 27 | #include "ofp-errors.h" |
fa37b408 BP |
28 | #include "ofp-util.h" |
29 | #include "ofpbuf.h" | |
30 | #include "packets.h" | |
31 | #include "random.h" | |
e41a9130 | 32 | #include "type-props.h" |
5136ce49 | 33 | #include "vlog.h" |
fa37b408 | 34 | |
d98e6007 | 35 | VLOG_DEFINE_THIS_MODULE(ofp_util); |
fa37b408 BP |
36 | |
37 | /* Rate limit for OpenFlow message parse errors. These always indicate a bug | |
38 | * in the peer and so there's not much point in showing a lot of them. */ | |
39 | static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5); | |
40 | ||
0596e897 BP |
41 | /* Given the wildcard bit count in the least-significant 6 of 'wcbits', returns |
42 | * an IP netmask with a 1 in each bit that must match and a 0 in each bit that | |
43 | * is wildcarded. | |
44 | * | |
45 | * The bits in 'wcbits' are in the format used in enum ofp_flow_wildcards: 0 | |
46 | * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits, | |
47 | * ..., 32 and higher wildcard the entire field. This is the *opposite* of the | |
48 | * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are | |
49 | * wildcarded. */ | |
50 | ovs_be32 | |
51 | ofputil_wcbits_to_netmask(int wcbits) | |
52 | { | |
53 | wcbits &= 0x3f; | |
54 | return wcbits < 32 ? htonl(~((1u << wcbits) - 1)) : 0; | |
55 | } | |
56 | ||
57 | /* Given the IP netmask 'netmask', returns the number of bits of the IP address | |
58 | * that it wildcards. 'netmask' must be a CIDR netmask (see ip_is_cidr()). */ | |
59 | int | |
60 | ofputil_netmask_to_wcbits(ovs_be32 netmask) | |
61 | { | |
62 | assert(ip_is_cidr(netmask)); | |
63 | #if __GNUC__ >= 4 | |
64 | return netmask == htonl(0) ? 32 : __builtin_ctz(ntohl(netmask)); | |
65 | #else | |
66 | int wcbits; | |
67 | ||
68 | for (wcbits = 32; netmask; wcbits--) { | |
69 | netmask &= netmask - 1; | |
70 | } | |
71 | ||
72 | return wcbits; | |
73 | #endif | |
74 | } | |
75 | ||
d8ae4d67 BP |
76 | /* A list of the FWW_* and OFPFW_ bits that have the same value, meaning, and |
77 | * name. */ | |
78 | #define WC_INVARIANT_LIST \ | |
79 | WC_INVARIANT_BIT(IN_PORT) \ | |
d8ae4d67 BP |
80 | WC_INVARIANT_BIT(DL_SRC) \ |
81 | WC_INVARIANT_BIT(DL_DST) \ | |
82 | WC_INVARIANT_BIT(DL_TYPE) \ | |
83 | WC_INVARIANT_BIT(NW_PROTO) \ | |
84 | WC_INVARIANT_BIT(TP_SRC) \ | |
85 | WC_INVARIANT_BIT(TP_DST) | |
86 | ||
87 | /* Verify that all of the invariant bits (as defined on WC_INVARIANT_LIST) | |
88 | * actually have the same names and values. */ | |
89 | #define WC_INVARIANT_BIT(NAME) BUILD_ASSERT_DECL(FWW_##NAME == OFPFW_##NAME); | |
90 | WC_INVARIANT_LIST | |
91 | #undef WC_INVARIANT_BIT | |
92 | ||
93 | /* WC_INVARIANTS is the invariant bits (as defined on WC_INVARIANT_LIST) all | |
94 | * OR'd together. */ | |
95 | enum { | |
96 | WC_INVARIANTS = 0 | |
97 | #define WC_INVARIANT_BIT(NAME) | FWW_##NAME | |
98 | WC_INVARIANT_LIST | |
99 | #undef WC_INVARIANT_BIT | |
100 | }; | |
101 | ||
102 | /* Converts the ofp_match in 'match' into a cls_rule in 'rule', with the given | |
103 | * 'priority'. | |
104 | * | |
105 | * 'flow_format' must either NXFF_OPENFLOW10 or NXFF_TUN_ID_FROM_COOKIE. In | |
106 | * the latter case only, 'flow''s tun_id field will be taken from the high bits | |
107 | * of 'cookie', if 'match''s wildcards do not indicate that tun_id is | |
108 | * wildcarded. */ | |
109 | void | |
110 | ofputil_cls_rule_from_match(const struct ofp_match *match, | |
492f7572 BP |
111 | unsigned int priority, |
112 | enum nx_flow_format flow_format, | |
8d7fb7ee | 113 | ovs_be64 cookie, struct cls_rule *rule) |
d8ae4d67 BP |
114 | { |
115 | struct flow_wildcards *wc = &rule->wc; | |
116 | unsigned int ofpfw; | |
66642cb4 | 117 | ovs_be16 vid, pcp; |
d8ae4d67 BP |
118 | |
119 | /* Initialize rule->priority. */ | |
120 | ofpfw = ntohl(match->wildcards); | |
121 | ofpfw &= flow_format == NXFF_TUN_ID_FROM_COOKIE ? OVSFW_ALL : OFPFW_ALL; | |
122 | rule->priority = !ofpfw ? UINT16_MAX : priority; | |
123 | ||
124 | /* Initialize most of rule->wc. */ | |
f9ba8dad | 125 | flow_wildcards_init_catchall(wc); |
d8ae4d67 | 126 | wc->wildcards = ofpfw & WC_INVARIANTS; |
bad68a99 JP |
127 | |
128 | /* Wildcard fields that aren't defined by ofp_match or tun_id. */ | |
129 | wc->wildcards |= (FWW_ARP_SHA | FWW_ARP_THA); | |
130 | ||
d8ae4d67 BP |
131 | if (ofpfw & OFPFW_NW_TOS) { |
132 | wc->wildcards |= FWW_NW_TOS; | |
133 | } | |
d8ae4d67 BP |
134 | wc->nw_src_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW_NW_SRC_SHIFT); |
135 | wc->nw_dst_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW_NW_DST_SHIFT); | |
136 | ||
7045a624 | 137 | if (flow_format == NXFF_TUN_ID_FROM_COOKIE && !(ofpfw & NXFW_TUN_ID)) { |
b9298d3f | 138 | rule->flow.tun_id = htonll(ntohll(cookie) >> 32); |
d8ae4d67 BP |
139 | } |
140 | ||
141 | if (ofpfw & OFPFW_DL_DST) { | |
142 | /* OpenFlow 1.0 OFPFW_DL_DST covers the whole Ethernet destination, but | |
143 | * Open vSwitch breaks the Ethernet destination into bits as FWW_DL_DST | |
144 | * and FWW_ETH_MCAST. */ | |
145 | wc->wildcards |= FWW_ETH_MCAST; | |
146 | } | |
147 | ||
66642cb4 | 148 | /* Initialize most of rule->flow. */ |
d8ae4d67 BP |
149 | rule->flow.nw_src = match->nw_src; |
150 | rule->flow.nw_dst = match->nw_dst; | |
151 | rule->flow.in_port = (match->in_port == htons(OFPP_LOCAL) ? ODPP_LOCAL | |
152 | : ntohs(match->in_port)); | |
36956a7d | 153 | rule->flow.dl_type = ofputil_dl_type_from_openflow(match->dl_type); |
d8ae4d67 BP |
154 | rule->flow.tp_src = match->tp_src; |
155 | rule->flow.tp_dst = match->tp_dst; | |
156 | memcpy(rule->flow.dl_src, match->dl_src, ETH_ADDR_LEN); | |
157 | memcpy(rule->flow.dl_dst, match->dl_dst, ETH_ADDR_LEN); | |
158 | rule->flow.nw_tos = match->nw_tos; | |
159 | rule->flow.nw_proto = match->nw_proto; | |
160 | ||
66642cb4 BP |
161 | /* Translate VLANs. */ |
162 | vid = match->dl_vlan & htons(VLAN_VID_MASK); | |
163 | pcp = htons((match->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK); | |
164 | switch (ofpfw & (OFPFW_DL_VLAN | OFPFW_DL_VLAN_PCP)) { | |
165 | case OFPFW_DL_VLAN | OFPFW_DL_VLAN_PCP: | |
166 | /* Wildcard everything. */ | |
167 | rule->flow.vlan_tci = htons(0); | |
168 | rule->wc.vlan_tci_mask = htons(0); | |
169 | break; | |
170 | ||
171 | case OFPFW_DL_VLAN_PCP: | |
172 | if (match->dl_vlan == htons(OFP_VLAN_NONE)) { | |
173 | /* Match only packets without 802.1Q header. */ | |
174 | rule->flow.vlan_tci = htons(0); | |
175 | rule->wc.vlan_tci_mask = htons(0xffff); | |
176 | } else { | |
177 | /* Wildcard PCP, specific VID. */ | |
178 | rule->flow.vlan_tci = vid | htons(VLAN_CFI); | |
179 | rule->wc.vlan_tci_mask = htons(VLAN_VID_MASK | VLAN_CFI); | |
180 | } | |
181 | break; | |
182 | ||
183 | case OFPFW_DL_VLAN: | |
184 | /* Wildcard VID, specific PCP. */ | |
185 | rule->flow.vlan_tci = pcp | htons(VLAN_CFI); | |
186 | rule->wc.vlan_tci_mask = htons(VLAN_PCP_MASK | VLAN_CFI); | |
187 | break; | |
188 | ||
189 | case 0: | |
190 | if (match->dl_vlan == htons(OFP_VLAN_NONE)) { | |
191 | /* This case is odd, since we can't have a specific PCP without an | |
192 | * 802.1Q header. However, older versions of OVS treated this as | |
193 | * matching packets withut an 802.1Q header, so we do here too. */ | |
194 | rule->flow.vlan_tci = htons(0); | |
195 | rule->wc.vlan_tci_mask = htons(0xffff); | |
196 | } else { | |
197 | /* Specific VID and PCP. */ | |
198 | rule->flow.vlan_tci = vid | pcp | htons(VLAN_CFI); | |
199 | rule->wc.vlan_tci_mask = htons(0xffff); | |
200 | } | |
201 | break; | |
202 | } | |
203 | ||
d8ae4d67 BP |
204 | /* Clean up. */ |
205 | cls_rule_zero_wildcarded_fields(rule); | |
206 | } | |
207 | ||
ff9d3826 BP |
208 | /* Convert 'rule' into the OpenFlow match structure 'match'. 'flow_format' |
209 | * must either NXFF_OPENFLOW10 or NXFF_TUN_ID_FROM_COOKIE. | |
d8ae4d67 | 210 | * |
ff9d3826 BP |
211 | * The NXFF_TUN_ID_FROM_COOKIE flow format requires modifying the flow cookie. |
212 | * This function can help with that, if 'cookie_out' is nonnull. For | |
213 | * NXFF_OPENFLOW10, or if the tunnel ID is wildcarded, 'cookie_in' will be | |
214 | * copied directly to '*cookie_out'. For NXFF_TUN_ID_FROM_COOKIE when tunnel | |
215 | * ID is matched, 'cookie_in' will be modified appropriately before setting | |
216 | * '*cookie_out'. | |
217 | */ | |
d8ae4d67 | 218 | void |
492f7572 BP |
219 | ofputil_cls_rule_to_match(const struct cls_rule *rule, |
220 | enum nx_flow_format flow_format, | |
ff9d3826 BP |
221 | struct ofp_match *match, |
222 | ovs_be64 cookie_in, ovs_be64 *cookie_out) | |
d8ae4d67 BP |
223 | { |
224 | const struct flow_wildcards *wc = &rule->wc; | |
225 | unsigned int ofpfw; | |
226 | ||
66642cb4 | 227 | /* Figure out most OpenFlow wildcards. */ |
d8ae4d67 BP |
228 | ofpfw = wc->wildcards & WC_INVARIANTS; |
229 | ofpfw |= ofputil_netmask_to_wcbits(wc->nw_src_mask) << OFPFW_NW_SRC_SHIFT; | |
230 | ofpfw |= ofputil_netmask_to_wcbits(wc->nw_dst_mask) << OFPFW_NW_DST_SHIFT; | |
d8ae4d67 BP |
231 | if (wc->wildcards & FWW_NW_TOS) { |
232 | ofpfw |= OFPFW_NW_TOS; | |
233 | } | |
ff9d3826 BP |
234 | |
235 | /* Tunnel ID. */ | |
236 | if (flow_format == NXFF_TUN_ID_FROM_COOKIE) { | |
8368c090 | 237 | if (wc->tun_id_mask == htonll(0)) { |
ff9d3826 BP |
238 | ofpfw |= NXFW_TUN_ID; |
239 | } else { | |
240 | uint32_t cookie_lo = ntohll(cookie_in); | |
b9298d3f | 241 | uint32_t cookie_hi = ntohll(rule->flow.tun_id); |
ff9d3826 BP |
242 | cookie_in = htonll(cookie_lo | ((uint64_t) cookie_hi << 32)); |
243 | } | |
244 | } | |
245 | if (cookie_out) { | |
246 | *cookie_out = cookie_in; | |
d8ae4d67 BP |
247 | } |
248 | ||
66642cb4 BP |
249 | /* Translate VLANs. */ |
250 | match->dl_vlan = htons(0); | |
251 | match->dl_vlan_pcp = 0; | |
252 | if (rule->wc.vlan_tci_mask == htons(0)) { | |
253 | ofpfw |= OFPFW_DL_VLAN | OFPFW_DL_VLAN_PCP; | |
254 | } else if (rule->wc.vlan_tci_mask & htons(VLAN_CFI) | |
255 | && !(rule->flow.vlan_tci & htons(VLAN_CFI))) { | |
256 | match->dl_vlan = htons(OFP_VLAN_NONE); | |
257 | } else { | |
258 | if (!(rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) { | |
259 | ofpfw |= OFPFW_DL_VLAN; | |
260 | } else { | |
261 | match->dl_vlan = htons(vlan_tci_to_vid(rule->flow.vlan_tci)); | |
262 | } | |
263 | ||
264 | if (!(rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK))) { | |
265 | ofpfw |= OFPFW_DL_VLAN_PCP; | |
266 | } else { | |
267 | match->dl_vlan_pcp = vlan_tci_to_pcp(rule->flow.vlan_tci); | |
268 | } | |
269 | } | |
270 | ||
271 | /* Compose most of the match structure. */ | |
d8ae4d67 BP |
272 | match->wildcards = htonl(ofpfw); |
273 | match->in_port = htons(rule->flow.in_port == ODPP_LOCAL ? OFPP_LOCAL | |
274 | : rule->flow.in_port); | |
d8ae4d67 BP |
275 | memcpy(match->dl_src, rule->flow.dl_src, ETH_ADDR_LEN); |
276 | memcpy(match->dl_dst, rule->flow.dl_dst, ETH_ADDR_LEN); | |
36956a7d | 277 | match->dl_type = ofputil_dl_type_to_openflow(rule->flow.dl_type); |
d8ae4d67 BP |
278 | match->nw_src = rule->flow.nw_src; |
279 | match->nw_dst = rule->flow.nw_dst; | |
280 | match->nw_tos = rule->flow.nw_tos; | |
281 | match->nw_proto = rule->flow.nw_proto; | |
282 | match->tp_src = rule->flow.tp_src; | |
283 | match->tp_dst = rule->flow.tp_dst; | |
284 | memset(match->pad1, '\0', sizeof match->pad1); | |
285 | memset(match->pad2, '\0', sizeof match->pad2); | |
286 | } | |
287 | ||
36956a7d BP |
288 | /* Given a 'dl_type' value in the format used in struct flow, returns the |
289 | * corresponding 'dl_type' value for use in an OpenFlow ofp_match structure. */ | |
290 | ovs_be16 | |
291 | ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type) | |
292 | { | |
293 | return (flow_dl_type == htons(FLOW_DL_TYPE_NONE) | |
294 | ? htons(OFP_DL_TYPE_NOT_ETH_TYPE) | |
295 | : flow_dl_type); | |
296 | } | |
297 | ||
298 | /* Given a 'dl_type' value in the format used in an OpenFlow ofp_match | |
299 | * structure, returns the corresponding 'dl_type' value for use in struct | |
300 | * flow. */ | |
301 | ovs_be16 | |
302 | ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type) | |
303 | { | |
304 | return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE) | |
305 | ? htons(FLOW_DL_TYPE_NONE) | |
306 | : ofp_dl_type); | |
307 | } | |
308 | ||
72fae175 | 309 | /* Returns a transaction ID to use for an outgoing OpenFlow message. */ |
44381c1b | 310 | static ovs_be32 |
fa37b408 BP |
311 | alloc_xid(void) |
312 | { | |
72fae175 | 313 | static uint32_t next_xid = 1; |
44381c1b | 314 | return htonl(next_xid++); |
fa37b408 | 315 | } |
d1e2cf21 BP |
316 | \f |
317 | /* Basic parsing of OpenFlow messages. */ | |
fa37b408 | 318 | |
d1e2cf21 BP |
319 | struct ofputil_msg_type { |
320 | enum ofputil_msg_code code; /* OFPUTIL_*. */ | |
321 | uint32_t value; /* OFPT_*, OFPST_*, NXT_*, or NXST_*. */ | |
322 | const char *name; /* e.g. "OFPT_FLOW_REMOVED". */ | |
323 | unsigned int min_size; /* Minimum total message size in bytes. */ | |
324 | /* 0 if 'min_size' is the exact size that the message must be. Otherwise, | |
325 | * the message may exceed 'min_size' by an even multiple of this value. */ | |
326 | unsigned int extra_multiple; | |
327 | }; | |
328 | ||
329 | struct ofputil_msg_category { | |
330 | const char *name; /* e.g. "OpenFlow message" */ | |
331 | const struct ofputil_msg_type *types; | |
332 | size_t n_types; | |
333 | int missing_error; /* ofp_mkerr() value for missing type. */ | |
334 | }; | |
335 | ||
336 | static bool | |
337 | ofputil_length_ok(const struct ofputil_msg_category *cat, | |
338 | const struct ofputil_msg_type *type, | |
339 | unsigned int size) | |
340 | { | |
341 | switch (type->extra_multiple) { | |
342 | case 0: | |
343 | if (size != type->min_size) { | |
344 | VLOG_WARN_RL(&bad_ofmsg_rl, "received %s %s with incorrect " | |
345 | "length %u (expected length %u)", | |
346 | cat->name, type->name, size, type->min_size); | |
347 | return false; | |
348 | } | |
349 | return true; | |
350 | ||
351 | case 1: | |
352 | if (size < type->min_size) { | |
353 | VLOG_WARN_RL(&bad_ofmsg_rl, "received %s %s with incorrect " | |
354 | "length %u (expected length at least %u bytes)", | |
355 | cat->name, type->name, size, type->min_size); | |
356 | return false; | |
357 | } | |
358 | return true; | |
359 | ||
360 | default: | |
361 | if (size < type->min_size | |
362 | || (size - type->min_size) % type->extra_multiple) { | |
363 | VLOG_WARN_RL(&bad_ofmsg_rl, "received %s %s with incorrect " | |
364 | "length %u (must be exactly %u bytes or longer " | |
365 | "by an integer multiple of %u bytes)", | |
366 | cat->name, type->name, size, | |
367 | type->min_size, type->extra_multiple); | |
368 | return false; | |
369 | } | |
370 | return true; | |
371 | } | |
372 | } | |
373 | ||
374 | static int | |
375 | ofputil_lookup_openflow_message(const struct ofputil_msg_category *cat, | |
376 | uint32_t value, unsigned int size, | |
377 | const struct ofputil_msg_type **typep) | |
378 | { | |
379 | const struct ofputil_msg_type *type; | |
380 | ||
381 | for (type = cat->types; type < &cat->types[cat->n_types]; type++) { | |
382 | if (type->value == value) { | |
383 | if (!ofputil_length_ok(cat, type, size)) { | |
384 | return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN); | |
385 | } | |
386 | *typep = type; | |
387 | return 0; | |
388 | } | |
389 | } | |
390 | ||
5c47debb | 391 | VLOG_WARN_RL(&bad_ofmsg_rl, "received %s of unknown type %"PRIu32, |
d1e2cf21 BP |
392 | cat->name, value); |
393 | return cat->missing_error; | |
394 | } | |
395 | ||
396 | static int | |
397 | ofputil_decode_vendor(const struct ofp_header *oh, | |
398 | const struct ofputil_msg_type **typep) | |
399 | { | |
400 | static const struct ofputil_msg_type nxt_messages[] = { | |
401 | { OFPUTIL_NXT_STATUS_REQUEST, | |
402 | NXT_STATUS_REQUEST, "NXT_STATUS_REQUEST", | |
403 | sizeof(struct nicira_header), 1 }, | |
404 | ||
405 | { OFPUTIL_NXT_STATUS_REPLY, | |
406 | NXT_STATUS_REPLY, "NXT_STATUS_REPLY", | |
407 | sizeof(struct nicira_header), 1 }, | |
408 | ||
409 | { OFPUTIL_NXT_TUN_ID_FROM_COOKIE, | |
410 | NXT_TUN_ID_FROM_COOKIE, "NXT_TUN_ID_FROM_COOKIE", | |
411 | sizeof(struct nxt_tun_id_cookie), 0 }, | |
412 | ||
413 | { OFPUTIL_NXT_ROLE_REQUEST, | |
414 | NXT_ROLE_REQUEST, "NXT_ROLE_REQUEST", | |
415 | sizeof(struct nx_role_request), 0 }, | |
416 | ||
417 | { OFPUTIL_NXT_ROLE_REPLY, | |
418 | NXT_ROLE_REPLY, "NXT_ROLE_REPLY", | |
419 | sizeof(struct nx_role_request), 0 }, | |
420 | ||
421 | { OFPUTIL_NXT_SET_FLOW_FORMAT, | |
422 | NXT_SET_FLOW_FORMAT, "NXT_SET_FLOW_FORMAT", | |
423 | sizeof(struct nxt_set_flow_format), 0 }, | |
424 | ||
425 | { OFPUTIL_NXT_FLOW_MOD, | |
426 | NXT_FLOW_MOD, "NXT_FLOW_MOD", | |
427 | sizeof(struct nx_flow_mod), 8 }, | |
428 | ||
429 | { OFPUTIL_NXT_FLOW_REMOVED, | |
430 | NXT_FLOW_REMOVED, "NXT_FLOW_REMOVED", | |
431 | sizeof(struct nx_flow_removed), 8 }, | |
432 | }; | |
433 | ||
434 | static const struct ofputil_msg_category nxt_category = { | |
435 | "Nicira extension message", | |
436 | nxt_messages, ARRAY_SIZE(nxt_messages), | |
437 | OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE) | |
438 | }; | |
439 | ||
440 | const struct ofp_vendor_header *ovh; | |
441 | const struct nicira_header *nh; | |
442 | ||
443 | ovh = (const struct ofp_vendor_header *) oh; | |
444 | if (ovh->vendor != htonl(NX_VENDOR_ID)) { | |
445 | VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor message for unknown " | |
446 | "vendor %"PRIx32, ntohl(ovh->vendor)); | |
447 | return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR); | |
448 | } | |
449 | ||
450 | if (ntohs(ovh->header.length) < sizeof(struct nicira_header)) { | |
451 | VLOG_WARN_RL(&bad_ofmsg_rl, "received Nicira vendor message of " | |
452 | "length %u (expected at least %zu)", | |
453 | ntohs(ovh->header.length), sizeof(struct nicira_header)); | |
454 | return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN); | |
455 | } | |
456 | ||
457 | nh = (const struct nicira_header *) oh; | |
458 | return ofputil_lookup_openflow_message(&nxt_category, ntohl(nh->subtype), | |
459 | ntohs(oh->length), typep); | |
460 | } | |
461 | ||
462 | static int | |
463 | check_nxstats_msg(const struct ofp_header *oh) | |
464 | { | |
465 | const struct ofp_stats_request *osr; | |
466 | ovs_be32 vendor; | |
467 | ||
468 | osr = (const struct ofp_stats_request *) oh; | |
469 | ||
470 | memcpy(&vendor, osr->body, sizeof vendor); | |
471 | if (vendor != htonl(NX_VENDOR_ID)) { | |
472 | VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor stats message for " | |
473 | "unknown vendor %"PRIx32, ntohl(vendor)); | |
474 | return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR); | |
475 | } | |
476 | ||
477 | if (ntohs(osr->header.length) < sizeof(struct nicira_stats_msg)) { | |
478 | VLOG_WARN_RL(&bad_ofmsg_rl, "truncated Nicira stats message"); | |
479 | return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN); | |
480 | } | |
481 | ||
482 | return 0; | |
483 | } | |
484 | ||
485 | static int | |
486 | ofputil_decode_nxst_request(const struct ofp_header *oh, | |
487 | const struct ofputil_msg_type **typep) | |
488 | { | |
489 | static const struct ofputil_msg_type nxst_requests[] = { | |
490 | { OFPUTIL_NXST_FLOW_REQUEST, | |
491 | NXST_FLOW, "NXST_FLOW request", | |
492 | sizeof(struct nx_flow_stats_request), 8 }, | |
493 | ||
494 | { OFPUTIL_NXST_AGGREGATE_REQUEST, | |
495 | NXST_AGGREGATE, "NXST_AGGREGATE request", | |
496 | sizeof(struct nx_aggregate_stats_request), 8 }, | |
497 | }; | |
498 | ||
499 | static const struct ofputil_msg_category nxst_request_category = { | |
08717852 | 500 | "Nicira extension statistics request", |
d1e2cf21 BP |
501 | nxst_requests, ARRAY_SIZE(nxst_requests), |
502 | OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE) | |
503 | }; | |
504 | ||
505 | const struct nicira_stats_msg *nsm; | |
506 | int error; | |
507 | ||
508 | error = check_nxstats_msg(oh); | |
509 | if (error) { | |
510 | return error; | |
511 | } | |
512 | ||
513 | nsm = (struct nicira_stats_msg *) oh; | |
514 | return ofputil_lookup_openflow_message(&nxst_request_category, | |
515 | ntohl(nsm->subtype), | |
516 | ntohs(oh->length), typep); | |
517 | } | |
518 | ||
519 | static int | |
520 | ofputil_decode_nxst_reply(const struct ofp_header *oh, | |
521 | const struct ofputil_msg_type **typep) | |
522 | { | |
523 | static const struct ofputil_msg_type nxst_replies[] = { | |
524 | { OFPUTIL_NXST_FLOW_REPLY, | |
525 | NXST_FLOW, "NXST_FLOW reply", | |
526 | sizeof(struct nicira_stats_msg), 8 }, | |
527 | ||
528 | { OFPUTIL_NXST_AGGREGATE_REPLY, | |
529 | NXST_AGGREGATE, "NXST_AGGREGATE reply", | |
530 | sizeof(struct nx_aggregate_stats_reply), 0 }, | |
531 | }; | |
532 | ||
533 | static const struct ofputil_msg_category nxst_reply_category = { | |
08717852 | 534 | "Nicira extension statistics reply", |
d1e2cf21 BP |
535 | nxst_replies, ARRAY_SIZE(nxst_replies), |
536 | OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE) | |
537 | }; | |
538 | ||
539 | const struct nicira_stats_msg *nsm; | |
540 | int error; | |
541 | ||
542 | error = check_nxstats_msg(oh); | |
543 | if (error) { | |
544 | return error; | |
545 | } | |
546 | ||
547 | nsm = (struct nicira_stats_msg *) oh; | |
548 | return ofputil_lookup_openflow_message(&nxst_reply_category, | |
549 | ntohl(nsm->subtype), | |
550 | ntohs(oh->length), typep); | |
551 | } | |
552 | ||
553 | static int | |
554 | ofputil_decode_ofpst_request(const struct ofp_header *oh, | |
555 | const struct ofputil_msg_type **typep) | |
556 | { | |
557 | enum { OSR_SIZE = sizeof(struct ofp_stats_request) }; | |
558 | static const struct ofputil_msg_type ofpst_requests[] = { | |
559 | { OFPUTIL_OFPST_DESC_REQUEST, | |
560 | OFPST_DESC, "OFPST_DESC request", | |
561 | OSR_SIZE, 0 }, | |
562 | ||
563 | { OFPUTIL_OFPST_FLOW_REQUEST, | |
564 | OFPST_FLOW, "OFPST_FLOW request", | |
565 | OSR_SIZE + sizeof(struct ofp_flow_stats_request), 0 }, | |
566 | ||
567 | { OFPUTIL_OFPST_AGGREGATE_REQUEST, | |
568 | OFPST_AGGREGATE, "OFPST_AGGREGATE request", | |
569 | OSR_SIZE + sizeof(struct ofp_aggregate_stats_request), 0 }, | |
570 | ||
571 | { OFPUTIL_OFPST_TABLE_REQUEST, | |
572 | OFPST_TABLE, "OFPST_TABLE request", | |
573 | OSR_SIZE, 0 }, | |
574 | ||
575 | { OFPUTIL_OFPST_PORT_REQUEST, | |
576 | OFPST_PORT, "OFPST_PORT request", | |
577 | OSR_SIZE + sizeof(struct ofp_port_stats_request), 0 }, | |
578 | ||
579 | { OFPUTIL_OFPST_QUEUE_REQUEST, | |
580 | OFPST_QUEUE, "OFPST_QUEUE request", | |
581 | OSR_SIZE + sizeof(struct ofp_queue_stats_request), 0 }, | |
582 | ||
583 | { 0, | |
584 | OFPST_VENDOR, "OFPST_VENDOR request", | |
585 | OSR_SIZE + sizeof(uint32_t), 1 }, | |
586 | }; | |
587 | ||
588 | static const struct ofputil_msg_category ofpst_request_category = { | |
589 | "OpenFlow statistics", | |
590 | ofpst_requests, ARRAY_SIZE(ofpst_requests), | |
591 | OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT) | |
592 | }; | |
593 | ||
594 | const struct ofp_stats_request *osr; | |
595 | int error; | |
596 | ||
597 | osr = (const struct ofp_stats_request *) oh; | |
598 | error = ofputil_lookup_openflow_message(&ofpst_request_category, | |
599 | ntohs(osr->type), | |
600 | ntohs(oh->length), typep); | |
601 | if (!error && osr->type == htons(OFPST_VENDOR)) { | |
602 | error = ofputil_decode_nxst_request(oh, typep); | |
603 | } | |
604 | return error; | |
605 | } | |
606 | ||
607 | static int | |
608 | ofputil_decode_ofpst_reply(const struct ofp_header *oh, | |
609 | const struct ofputil_msg_type **typep) | |
610 | { | |
611 | enum { OSR_SIZE = sizeof(struct ofp_stats_reply) }; | |
612 | static const struct ofputil_msg_type ofpst_replies[] = { | |
613 | { OFPUTIL_OFPST_DESC_REPLY, | |
614 | OFPST_DESC, "OFPST_DESC reply", | |
615 | OSR_SIZE + sizeof(struct ofp_desc_stats), 0 }, | |
616 | ||
617 | { OFPUTIL_OFPST_FLOW_REPLY, | |
618 | OFPST_FLOW, "OFPST_FLOW reply", | |
619 | OSR_SIZE, 1 }, | |
620 | ||
621 | { OFPUTIL_OFPST_AGGREGATE_REPLY, | |
622 | OFPST_AGGREGATE, "OFPST_AGGREGATE reply", | |
623 | OSR_SIZE + sizeof(struct ofp_aggregate_stats_reply), 0 }, | |
624 | ||
625 | { OFPUTIL_OFPST_TABLE_REPLY, | |
626 | OFPST_TABLE, "OFPST_TABLE reply", | |
627 | OSR_SIZE, sizeof(struct ofp_table_stats) }, | |
628 | ||
629 | { OFPUTIL_OFPST_PORT_REPLY, | |
630 | OFPST_PORT, "OFPST_PORT reply", | |
631 | OSR_SIZE, sizeof(struct ofp_port_stats) }, | |
632 | ||
633 | { OFPUTIL_OFPST_QUEUE_REPLY, | |
634 | OFPST_QUEUE, "OFPST_QUEUE reply", | |
635 | OSR_SIZE, sizeof(struct ofp_queue_stats) }, | |
636 | ||
637 | { 0, | |
638 | OFPST_VENDOR, "OFPST_VENDOR reply", | |
639 | OSR_SIZE + sizeof(uint32_t), 1 }, | |
640 | }; | |
641 | ||
642 | static const struct ofputil_msg_category ofpst_reply_category = { | |
643 | "OpenFlow statistics", | |
644 | ofpst_replies, ARRAY_SIZE(ofpst_replies), | |
645 | OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT) | |
646 | }; | |
647 | ||
648 | const struct ofp_stats_reply *osr = (const struct ofp_stats_reply *) oh; | |
649 | int error; | |
650 | ||
651 | error = ofputil_lookup_openflow_message(&ofpst_reply_category, | |
652 | ntohs(osr->type), | |
653 | ntohs(oh->length), typep); | |
654 | if (!error && osr->type == htons(OFPST_VENDOR)) { | |
655 | error = ofputil_decode_nxst_reply(oh, typep); | |
656 | } | |
657 | return error; | |
658 | } | |
659 | ||
660 | /* Decodes the message type represented by 'oh'. Returns 0 if successful or | |
661 | * an OpenFlow error code constructed with ofp_mkerr() on failure. Either | |
662 | * way, stores in '*typep' a type structure that can be inspected with the | |
663 | * ofputil_msg_type_*() functions. | |
664 | * | |
665 | * oh->length must indicate the correct length of the message (and must be at | |
666 | * least sizeof(struct ofp_header)). | |
667 | * | |
668 | * Success indicates that 'oh' is at least as long as the minimum-length | |
669 | * message of its type. */ | |
670 | int | |
671 | ofputil_decode_msg_type(const struct ofp_header *oh, | |
672 | const struct ofputil_msg_type **typep) | |
673 | { | |
674 | static const struct ofputil_msg_type ofpt_messages[] = { | |
675 | { OFPUTIL_OFPT_HELLO, | |
676 | OFPT_HELLO, "OFPT_HELLO", | |
677 | sizeof(struct ofp_hello), 1 }, | |
678 | ||
679 | { OFPUTIL_OFPT_ERROR, | |
680 | OFPT_ERROR, "OFPT_ERROR", | |
681 | sizeof(struct ofp_error_msg), 1 }, | |
682 | ||
683 | { OFPUTIL_OFPT_ECHO_REQUEST, | |
684 | OFPT_ECHO_REQUEST, "OFPT_ECHO_REQUEST", | |
685 | sizeof(struct ofp_header), 1 }, | |
686 | ||
687 | { OFPUTIL_OFPT_ECHO_REPLY, | |
688 | OFPT_ECHO_REPLY, "OFPT_ECHO_REPLY", | |
689 | sizeof(struct ofp_header), 1 }, | |
690 | ||
691 | { OFPUTIL_OFPT_FEATURES_REQUEST, | |
692 | OFPT_FEATURES_REQUEST, "OFPT_FEATURES_REQUEST", | |
693 | sizeof(struct ofp_header), 0 }, | |
694 | ||
695 | { OFPUTIL_OFPT_FEATURES_REPLY, | |
696 | OFPT_FEATURES_REPLY, "OFPT_FEATURES_REPLY", | |
697 | sizeof(struct ofp_switch_features), sizeof(struct ofp_phy_port) }, | |
698 | ||
699 | { OFPUTIL_OFPT_GET_CONFIG_REQUEST, | |
700 | OFPT_GET_CONFIG_REQUEST, "OFPT_GET_CONFIG_REQUEST", | |
701 | sizeof(struct ofp_header), 0 }, | |
702 | ||
703 | { OFPUTIL_OFPT_GET_CONFIG_REPLY, | |
704 | OFPT_GET_CONFIG_REPLY, "OFPT_GET_CONFIG_REPLY", | |
705 | sizeof(struct ofp_switch_config), 0 }, | |
706 | ||
707 | { OFPUTIL_OFPT_SET_CONFIG, | |
708 | OFPT_SET_CONFIG, "OFPT_SET_CONFIG", | |
709 | sizeof(struct ofp_switch_config), 0 }, | |
710 | ||
711 | { OFPUTIL_OFPT_PACKET_IN, | |
712 | OFPT_PACKET_IN, "OFPT_PACKET_IN", | |
713 | offsetof(struct ofp_packet_in, data), 1 }, | |
714 | ||
715 | { OFPUTIL_OFPT_FLOW_REMOVED, | |
716 | OFPT_FLOW_REMOVED, "OFPT_FLOW_REMOVED", | |
717 | sizeof(struct ofp_flow_removed), 0 }, | |
718 | ||
719 | { OFPUTIL_OFPT_PORT_STATUS, | |
720 | OFPT_PORT_STATUS, "OFPT_PORT_STATUS", | |
721 | sizeof(struct ofp_port_status), 0 }, | |
722 | ||
723 | { OFPUTIL_OFPT_PACKET_OUT, | |
724 | OFPT_PACKET_OUT, "OFPT_PACKET_OUT", | |
725 | sizeof(struct ofp_packet_out), 1 }, | |
726 | ||
727 | { OFPUTIL_OFPT_FLOW_MOD, | |
728 | OFPT_FLOW_MOD, "OFPT_FLOW_MOD", | |
729 | sizeof(struct ofp_flow_mod), 1 }, | |
730 | ||
731 | { OFPUTIL_OFPT_PORT_MOD, | |
732 | OFPT_PORT_MOD, "OFPT_PORT_MOD", | |
733 | sizeof(struct ofp_port_mod), 0 }, | |
734 | ||
735 | { 0, | |
736 | OFPT_STATS_REQUEST, "OFPT_STATS_REQUEST", | |
737 | sizeof(struct ofp_stats_request), 1 }, | |
738 | ||
739 | { 0, | |
740 | OFPT_STATS_REPLY, "OFPT_STATS_REPLY", | |
741 | sizeof(struct ofp_stats_reply), 1 }, | |
742 | ||
743 | { OFPUTIL_OFPT_BARRIER_REQUEST, | |
744 | OFPT_BARRIER_REQUEST, "OFPT_BARRIER_REQUEST", | |
745 | sizeof(struct ofp_header), 0 }, | |
746 | ||
747 | { OFPUTIL_OFPT_BARRIER_REPLY, | |
748 | OFPT_BARRIER_REPLY, "OFPT_BARRIER_REPLY", | |
749 | sizeof(struct ofp_header), 0 }, | |
750 | ||
751 | { 0, | |
752 | OFPT_VENDOR, "OFPT_VENDOR", | |
753 | sizeof(struct ofp_vendor_header), 1 }, | |
754 | }; | |
755 | ||
756 | static const struct ofputil_msg_category ofpt_category = { | |
757 | "OpenFlow message", | |
758 | ofpt_messages, ARRAY_SIZE(ofpt_messages), | |
759 | OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE) | |
760 | }; | |
761 | ||
762 | int error; | |
763 | ||
764 | error = ofputil_lookup_openflow_message(&ofpt_category, oh->type, | |
765 | ntohs(oh->length), typep); | |
766 | if (!error) { | |
767 | switch (oh->type) { | |
768 | case OFPT_VENDOR: | |
769 | error = ofputil_decode_vendor(oh, typep); | |
770 | break; | |
771 | ||
772 | case OFPT_STATS_REQUEST: | |
773 | error = ofputil_decode_ofpst_request(oh, typep); | |
774 | break; | |
775 | ||
776 | case OFPT_STATS_REPLY: | |
777 | error = ofputil_decode_ofpst_reply(oh, typep); | |
778 | ||
779 | default: | |
780 | break; | |
781 | } | |
782 | } | |
783 | if (error) { | |
784 | static const struct ofputil_msg_type ofputil_invalid_type = { | |
785 | OFPUTIL_INVALID, | |
786 | 0, "OFPUTIL_INVALID", | |
787 | 0, 0 | |
788 | }; | |
789 | ||
790 | *typep = &ofputil_invalid_type; | |
791 | } | |
792 | return error; | |
793 | } | |
794 | ||
795 | /* Returns an OFPUTIL_* message type code for 'type'. */ | |
796 | enum ofputil_msg_code | |
797 | ofputil_msg_type_code(const struct ofputil_msg_type *type) | |
798 | { | |
799 | return type->code; | |
800 | } | |
2e4f5fcf | 801 | \f |
7fa91113 BP |
802 | /* Flow formats. */ |
803 | ||
804 | bool | |
805 | ofputil_flow_format_is_valid(enum nx_flow_format flow_format) | |
806 | { | |
807 | switch (flow_format) { | |
808 | case NXFF_OPENFLOW10: | |
809 | case NXFF_TUN_ID_FROM_COOKIE: | |
810 | case NXFF_NXM: | |
811 | return true; | |
812 | } | |
813 | ||
814 | return false; | |
815 | } | |
816 | ||
817 | const char * | |
818 | ofputil_flow_format_to_string(enum nx_flow_format flow_format) | |
819 | { | |
820 | switch (flow_format) { | |
821 | case NXFF_OPENFLOW10: | |
822 | return "openflow10"; | |
823 | case NXFF_TUN_ID_FROM_COOKIE: | |
824 | return "tun_id_from_cookie"; | |
825 | case NXFF_NXM: | |
826 | return "nxm"; | |
827 | default: | |
828 | NOT_REACHED(); | |
829 | } | |
830 | } | |
831 | ||
88ca35ee BP |
832 | int |
833 | ofputil_flow_format_from_string(const char *s) | |
834 | { | |
835 | return (!strcmp(s, "openflow10") ? NXFF_OPENFLOW10 | |
836 | : !strcmp(s, "tun_id_from_cookie") ? NXFF_TUN_ID_FROM_COOKIE | |
837 | : !strcmp(s, "nxm") ? NXFF_NXM | |
838 | : -1); | |
839 | } | |
840 | ||
841 | static bool | |
842 | regs_fully_wildcarded(const struct flow_wildcards *wc) | |
843 | { | |
844 | int i; | |
845 | ||
846 | for (i = 0; i < FLOW_N_REGS; i++) { | |
847 | if (wc->reg_masks[i] != 0) { | |
848 | return false; | |
849 | } | |
850 | } | |
851 | return true; | |
852 | } | |
853 | ||
8368c090 BP |
854 | static inline bool |
855 | is_nxm_required(const struct cls_rule *rule, bool cookie_support, | |
856 | ovs_be64 cookie) | |
857 | { | |
858 | const struct flow_wildcards *wc = &rule->wc; | |
859 | ovs_be32 cookie_hi; | |
860 | ||
861 | /* Only NXM supports separately wildcards the Ethernet multicast bit. */ | |
862 | if (!(wc->wildcards & FWW_DL_DST) != !(wc->wildcards & FWW_ETH_MCAST)) { | |
863 | return true; | |
864 | } | |
865 | ||
bad68a99 JP |
866 | /* Only NXM supports matching ARP hardware addresses. */ |
867 | if (!(wc->wildcards & FWW_ARP_SHA) || !(wc->wildcards & FWW_ARP_THA)) { | |
868 | return true; | |
869 | } | |
870 | ||
8368c090 BP |
871 | /* Only NXM supports matching registers. */ |
872 | if (!regs_fully_wildcarded(wc)) { | |
873 | return true; | |
874 | } | |
875 | ||
876 | switch (wc->tun_id_mask) { | |
877 | case CONSTANT_HTONLL(0): | |
878 | /* Other formats can fully wildcard tun_id. */ | |
879 | break; | |
880 | ||
881 | case CONSTANT_HTONLL(UINT64_MAX): | |
882 | /* Only NXM supports matching tunnel ID, unless there is a cookie and | |
883 | * the top 32 bits of the cookie are the desired tunnel ID value. */ | |
884 | cookie_hi = htonl(ntohll(cookie) >> 32); | |
885 | if (!cookie_support | |
886 | || (cookie_hi && cookie_hi != ntohll(rule->flow.tun_id))) { | |
887 | return true; | |
888 | } | |
889 | break; | |
890 | ||
891 | default: | |
892 | /* Only NXM supports partial matches on tunnel ID. */ | |
893 | return true; | |
894 | } | |
895 | ||
896 | /* Other formats can express this rule. */ | |
897 | return false; | |
898 | } | |
899 | ||
88ca35ee BP |
900 | /* Returns the minimum nx_flow_format to use for sending 'rule' to a switch |
901 | * (e.g. to add or remove a flow). 'cookie_support' should be true if the | |
902 | * command to be sent includes a flow cookie (as OFPT_FLOW_MOD does, for | |
903 | * example) or false if the command does not (OFPST_FLOW and OFPST_AGGREGATE do | |
904 | * not, for example). If 'cookie_support' is true, then 'cookie' should be the | |
905 | * cookie to be sent; otherwise its value is ignored. | |
906 | * | |
907 | * The "best" flow format is chosen on this basis: | |
908 | * | |
909 | * - It must be capable of expressing the rule. NXFF_OPENFLOW10 flows can't | |
910 | * handle tunnel IDs. NXFF_TUN_ID_FROM_COOKIE flows can't handle registers | |
911 | * or fixing the Ethernet multicast bit, and can't handle tunnel IDs that | |
912 | * conflict with the high 32 bits of the cookie or commands that don't | |
913 | * support cookies. | |
914 | * | |
915 | * - Otherwise, the chosen format should be as backward compatible as | |
916 | * possible. (NXFF_OPENFLOW10 is more backward compatible than | |
917 | * NXFF_TUN_ID_FROM_COOKIE, which is more backward compatible than | |
918 | * NXFF_NXM.) | |
919 | */ | |
920 | enum nx_flow_format | |
921 | ofputil_min_flow_format(const struct cls_rule *rule, bool cookie_support, | |
922 | ovs_be64 cookie) | |
923 | { | |
8368c090 | 924 | if (is_nxm_required(rule, cookie_support, cookie)) { |
88ca35ee | 925 | return NXFF_NXM; |
8368c090 | 926 | } else if (rule->wc.tun_id_mask != htonll(0)) { |
88ca35ee BP |
927 | return NXFF_TUN_ID_FROM_COOKIE; |
928 | } else { | |
929 | return NXFF_OPENFLOW10; | |
930 | } | |
931 | } | |
932 | ||
933 | /* Returns an OpenFlow message that can be used to set the flow format to | |
934 | * 'flow_format'. */ | |
935 | struct ofpbuf * | |
936 | ofputil_make_set_flow_format(enum nx_flow_format flow_format) | |
937 | { | |
938 | struct ofpbuf *msg; | |
939 | ||
940 | if (flow_format == NXFF_OPENFLOW10 | |
941 | || flow_format == NXFF_TUN_ID_FROM_COOKIE) { | |
942 | struct nxt_tun_id_cookie *tic; | |
943 | ||
944 | tic = make_nxmsg(sizeof *tic, NXT_TUN_ID_FROM_COOKIE, &msg); | |
945 | tic->set = flow_format == NXFF_TUN_ID_FROM_COOKIE; | |
946 | } else { | |
947 | struct nxt_set_flow_format *sff; | |
948 | ||
949 | sff = make_nxmsg(sizeof *sff, NXT_SET_FLOW_FORMAT, &msg); | |
950 | sff->format = htonl(flow_format); | |
951 | } | |
952 | ||
953 | return msg; | |
954 | } | |
955 | ||
7fa91113 BP |
956 | /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract |
957 | * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error | |
958 | * code. | |
959 | * | |
960 | * For OFPT_FLOW_MOD messages, 'flow_format' should be the current flow format | |
961 | * at the time when the message was received. Otherwise 'flow_format' is | |
962 | * ignored. | |
2e4f5fcf BP |
963 | * |
964 | * Does not validate the flow_mod actions. */ | |
965 | int | |
966 | ofputil_decode_flow_mod(struct flow_mod *fm, const struct ofp_header *oh, | |
967 | enum nx_flow_format flow_format) | |
968 | { | |
969 | const struct ofputil_msg_type *type; | |
970 | struct ofpbuf b; | |
971 | ||
2013493b | 972 | ofpbuf_use_const(&b, oh, ntohs(oh->length)); |
2e4f5fcf BP |
973 | |
974 | ofputil_decode_msg_type(oh, &type); | |
975 | if (ofputil_msg_type_code(type) == OFPUTIL_OFPT_FLOW_MOD) { | |
976 | /* Standard OpenFlow flow_mod. */ | |
977 | struct ofp_match match, orig_match; | |
978 | const struct ofp_flow_mod *ofm; | |
979 | int error; | |
980 | ||
981 | /* Dissect the message. */ | |
bbc32a88 | 982 | ofm = ofpbuf_pull(&b, sizeof *ofm); |
2e4f5fcf BP |
983 | error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions); |
984 | if (error) { | |
985 | return error; | |
986 | } | |
987 | ||
988 | /* Normalize ofm->match. If normalization actually changes anything, | |
989 | * then log the differences. */ | |
990 | match = ofm->match; | |
991 | match.pad1[0] = match.pad2[0] = 0; | |
992 | orig_match = match; | |
993 | normalize_match(&match); | |
994 | if (memcmp(&match, &orig_match, sizeof orig_match)) { | |
995 | if (!VLOG_DROP_INFO(&bad_ofmsg_rl)) { | |
996 | char *old = ofp_match_to_literal_string(&orig_match); | |
997 | char *new = ofp_match_to_literal_string(&match); | |
998 | VLOG_INFO("normalization changed ofp_match, details:"); | |
999 | VLOG_INFO(" pre: %s", old); | |
1000 | VLOG_INFO("post: %s", new); | |
1001 | free(old); | |
1002 | free(new); | |
1003 | } | |
1004 | } | |
1005 | ||
1006 | /* Translate the message. */ | |
1007 | ofputil_cls_rule_from_match(&match, ntohs(ofm->priority), flow_format, | |
1008 | ofm->cookie, &fm->cr); | |
1009 | fm->cookie = ofm->cookie; | |
1010 | fm->command = ntohs(ofm->command); | |
1011 | fm->idle_timeout = ntohs(ofm->idle_timeout); | |
1012 | fm->hard_timeout = ntohs(ofm->hard_timeout); | |
1013 | fm->buffer_id = ntohl(ofm->buffer_id); | |
1014 | fm->out_port = ntohs(ofm->out_port); | |
1015 | fm->flags = ntohs(ofm->flags); | |
1016 | } else if (ofputil_msg_type_code(type) == OFPUTIL_NXT_FLOW_MOD) { | |
1017 | /* Nicira extended flow_mod. */ | |
1018 | const struct nx_flow_mod *nfm; | |
1019 | int error; | |
1020 | ||
1021 | /* Dissect the message. */ | |
bbc32a88 | 1022 | nfm = ofpbuf_pull(&b, sizeof *nfm); |
2e4f5fcf BP |
1023 | error = nx_pull_match(&b, ntohs(nfm->match_len), ntohs(nfm->priority), |
1024 | &fm->cr); | |
1025 | if (error) { | |
1026 | return error; | |
1027 | } | |
1028 | error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions); | |
1029 | if (error) { | |
1030 | return error; | |
1031 | } | |
1032 | ||
1033 | /* Translate the message. */ | |
1034 | fm->cookie = nfm->cookie; | |
1035 | fm->command = ntohs(nfm->command); | |
1036 | fm->idle_timeout = ntohs(nfm->idle_timeout); | |
1037 | fm->hard_timeout = ntohs(nfm->hard_timeout); | |
1038 | fm->buffer_id = ntohl(nfm->buffer_id); | |
1039 | fm->out_port = ntohs(nfm->out_port); | |
1040 | fm->flags = ntohs(nfm->flags); | |
1041 | } else { | |
1042 | NOT_REACHED(); | |
1043 | } | |
1044 | ||
1045 | return 0; | |
1046 | } | |
1047 | ||
1048 | /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to | |
1049 | * 'flow_format' and returns the message. */ | |
1050 | struct ofpbuf * | |
1051 | ofputil_encode_flow_mod(const struct flow_mod *fm, | |
1052 | enum nx_flow_format flow_format) | |
1053 | { | |
1054 | size_t actions_len = fm->n_actions * sizeof *fm->actions; | |
1055 | struct ofpbuf *msg; | |
1056 | ||
1057 | if (flow_format == NXFF_OPENFLOW10 | |
1058 | || flow_format == NXFF_TUN_ID_FROM_COOKIE) { | |
1059 | struct ofp_flow_mod *ofm; | |
1060 | ||
1061 | msg = ofpbuf_new(sizeof *ofm + actions_len); | |
1062 | ofm = put_openflow(sizeof *ofm, OFPT_FLOW_MOD, msg); | |
ff9d3826 BP |
1063 | ofputil_cls_rule_to_match(&fm->cr, flow_format, &ofm->match, |
1064 | fm->cookie, &ofm->cookie); | |
2e4f5fcf BP |
1065 | ofm->command = htons(fm->command); |
1066 | ofm->idle_timeout = htons(fm->idle_timeout); | |
1067 | ofm->hard_timeout = htons(fm->hard_timeout); | |
1068 | ofm->priority = htons(fm->cr.priority); | |
1069 | ofm->buffer_id = htonl(fm->buffer_id); | |
1070 | ofm->out_port = htons(fm->out_port); | |
1071 | ofm->flags = htons(fm->flags); | |
1072 | } else if (flow_format == NXFF_NXM) { | |
1073 | struct nx_flow_mod *nfm; | |
1074 | int match_len; | |
1075 | ||
1076 | msg = ofpbuf_new(sizeof *nfm + NXM_TYPICAL_LEN + actions_len); | |
1077 | put_nxmsg(sizeof *nfm, NXT_FLOW_MOD, msg); | |
1078 | match_len = nx_put_match(msg, &fm->cr); | |
1079 | ||
1080 | nfm = msg->data; | |
1081 | nfm->cookie = fm->cookie; | |
1082 | nfm->command = htons(fm->command); | |
1083 | nfm->idle_timeout = htons(fm->idle_timeout); | |
1084 | nfm->hard_timeout = htons(fm->hard_timeout); | |
1085 | nfm->priority = htons(fm->cr.priority); | |
1086 | nfm->buffer_id = htonl(fm->buffer_id); | |
1087 | nfm->out_port = htons(fm->out_port); | |
1088 | nfm->flags = htons(fm->flags); | |
1089 | nfm->match_len = htons(match_len); | |
1090 | } else { | |
1091 | NOT_REACHED(); | |
1092 | } | |
1093 | ||
1094 | ofpbuf_put(msg, fm->actions, actions_len); | |
1095 | update_openflow_length(msg); | |
1096 | return msg; | |
1097 | } | |
1098 | ||
1099 | static int | |
1100 | ofputil_decode_ofpst_flow_request(struct flow_stats_request *fsr, | |
1101 | const struct ofp_header *oh, | |
1102 | enum nx_flow_format flow_format, | |
1103 | bool aggregate) | |
1104 | { | |
1105 | const struct ofp_flow_stats_request *ofsr = ofputil_stats_body(oh); | |
1106 | ||
1107 | fsr->aggregate = aggregate; | |
1108 | ofputil_cls_rule_from_match(&ofsr->match, 0, flow_format, 0, &fsr->match); | |
1109 | fsr->out_port = ntohs(ofsr->out_port); | |
1110 | fsr->table_id = ofsr->table_id; | |
1111 | ||
1112 | return 0; | |
1113 | } | |
1114 | ||
1115 | static int | |
1116 | ofputil_decode_nxst_flow_request(struct flow_stats_request *fsr, | |
1117 | const struct ofp_header *oh, | |
1118 | bool aggregate) | |
1119 | { | |
1120 | const struct nx_flow_stats_request *nfsr; | |
1121 | struct ofpbuf b; | |
1122 | int error; | |
1123 | ||
2013493b | 1124 | ofpbuf_use_const(&b, oh, ntohs(oh->length)); |
2e4f5fcf | 1125 | |
bbc32a88 | 1126 | nfsr = ofpbuf_pull(&b, sizeof *nfsr); |
2e4f5fcf BP |
1127 | error = nx_pull_match(&b, ntohs(nfsr->match_len), 0, &fsr->match); |
1128 | if (error) { | |
1129 | return error; | |
1130 | } | |
1131 | if (b.size) { | |
1132 | return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN); | |
1133 | } | |
1134 | ||
1135 | fsr->aggregate = aggregate; | |
1136 | fsr->out_port = ntohs(nfsr->out_port); | |
1137 | fsr->table_id = nfsr->table_id; | |
1138 | ||
1139 | return 0; | |
1140 | } | |
1141 | ||
1142 | /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE | |
1143 | * message 'oh', received when the current flow format was 'flow_format', into | |
1144 | * an abstract flow_stats_request in 'fsr'. Returns 0 if successful, otherwise | |
9b045a0c BP |
1145 | * an OpenFlow error code. |
1146 | * | |
1147 | * For OFPST_FLOW and OFPST_AGGREGATE messages, 'flow_format' should be the | |
1148 | * current flow format at the time when the message was received. Otherwise | |
1149 | * 'flow_format' is ignored. */ | |
2e4f5fcf BP |
1150 | int |
1151 | ofputil_decode_flow_stats_request(struct flow_stats_request *fsr, | |
1152 | const struct ofp_header *oh, | |
1153 | enum nx_flow_format flow_format) | |
1154 | { | |
1155 | const struct ofputil_msg_type *type; | |
1156 | struct ofpbuf b; | |
1157 | int code; | |
1158 | ||
2013493b | 1159 | ofpbuf_use_const(&b, oh, ntohs(oh->length)); |
2e4f5fcf BP |
1160 | |
1161 | ofputil_decode_msg_type(oh, &type); | |
1162 | code = ofputil_msg_type_code(type); | |
1163 | switch (code) { | |
1164 | case OFPUTIL_OFPST_FLOW_REQUEST: | |
1165 | return ofputil_decode_ofpst_flow_request(fsr, oh, flow_format, false); | |
1166 | ||
1167 | case OFPUTIL_OFPST_AGGREGATE_REQUEST: | |
1168 | return ofputil_decode_ofpst_flow_request(fsr, oh, flow_format, true); | |
1169 | ||
1170 | case OFPUTIL_NXST_FLOW_REQUEST: | |
1171 | return ofputil_decode_nxst_flow_request(fsr, oh, false); | |
1172 | ||
1173 | case OFPUTIL_NXST_AGGREGATE_REQUEST: | |
1174 | return ofputil_decode_nxst_flow_request(fsr, oh, true); | |
1175 | ||
1176 | default: | |
1177 | /* Hey, the caller lied. */ | |
1178 | NOT_REACHED(); | |
1179 | } | |
1180 | } | |
1181 | ||
1182 | /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW, | |
1183 | * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE message 'oh' according to | |
1184 | * 'flow_format', and returns the message. */ | |
1185 | struct ofpbuf * | |
1186 | ofputil_encode_flow_stats_request(const struct flow_stats_request *fsr, | |
1187 | enum nx_flow_format flow_format) | |
1188 | { | |
1189 | struct ofpbuf *msg; | |
1190 | ||
1191 | if (flow_format == NXFF_OPENFLOW10 | |
1192 | || flow_format == NXFF_TUN_ID_FROM_COOKIE) { | |
1193 | struct ofp_flow_stats_request *ofsr; | |
1194 | int type; | |
1195 | ||
1196 | BUILD_ASSERT_DECL(sizeof(struct ofp_flow_stats_request) | |
1197 | == sizeof(struct ofp_aggregate_stats_request)); | |
1198 | ||
1199 | type = fsr->aggregate ? OFPST_AGGREGATE : OFPST_FLOW; | |
1200 | ofsr = ofputil_make_stats_request(sizeof *ofsr, type, &msg); | |
ff9d3826 BP |
1201 | ofputil_cls_rule_to_match(&fsr->match, flow_format, &ofsr->match, |
1202 | 0, NULL); | |
2e4f5fcf BP |
1203 | ofsr->table_id = fsr->table_id; |
1204 | ofsr->out_port = htons(fsr->out_port); | |
1205 | } else if (flow_format == NXFF_NXM) { | |
1206 | struct nx_flow_stats_request *nfsr; | |
1207 | int match_len; | |
9fb7fa87 | 1208 | int subtype; |
2e4f5fcf | 1209 | |
9fb7fa87 BP |
1210 | subtype = fsr->aggregate ? NXST_AGGREGATE : NXST_FLOW; |
1211 | ofputil_make_nxstats_request(sizeof *nfsr, subtype, &msg); | |
2e4f5fcf BP |
1212 | match_len = nx_put_match(msg, &fsr->match); |
1213 | ||
1214 | nfsr = msg->data; | |
1215 | nfsr->out_port = htons(fsr->out_port); | |
1216 | nfsr->match_len = htons(match_len); | |
1217 | nfsr->table_id = fsr->table_id; | |
1218 | } else { | |
1219 | NOT_REACHED(); | |
1220 | } | |
1221 | ||
1222 | return msg; | |
1223 | } | |
d1e2cf21 | 1224 | |
9b045a0c BP |
1225 | /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh', received |
1226 | * when the current flow format was 'flow_format', into an abstract | |
1227 | * ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise an | |
1228 | * OpenFlow error code. | |
1229 | * | |
1230 | * For OFPT_FLOW_REMOVED messages, 'flow_format' should be the current flow | |
1231 | * format at the time when the message was received. Otherwise 'flow_format' | |
1232 | * is ignored. */ | |
1233 | int | |
1234 | ofputil_decode_flow_removed(struct ofputil_flow_removed *fr, | |
1235 | const struct ofp_header *oh, | |
1236 | enum nx_flow_format flow_format) | |
1237 | { | |
1238 | const struct ofputil_msg_type *type; | |
1239 | enum ofputil_msg_code code; | |
1240 | ||
1241 | ofputil_decode_msg_type(oh, &type); | |
1242 | code = ofputil_msg_type_code(type); | |
1243 | if (code == OFPUTIL_OFPT_FLOW_REMOVED) { | |
1244 | const struct ofp_flow_removed *ofr; | |
1245 | ||
1246 | ofr = (const struct ofp_flow_removed *) oh; | |
1247 | ofputil_cls_rule_from_match(&ofr->match, ntohs(ofr->priority), | |
1248 | flow_format, ofr->cookie, &fr->rule); | |
1249 | fr->cookie = ofr->cookie; | |
1250 | fr->reason = ofr->reason; | |
1251 | fr->duration_sec = ntohl(ofr->duration_sec); | |
1252 | fr->duration_nsec = ntohl(ofr->duration_nsec); | |
1253 | fr->idle_timeout = ntohs(ofr->idle_timeout); | |
1254 | fr->packet_count = ntohll(ofr->packet_count); | |
1255 | fr->byte_count = ntohll(ofr->byte_count); | |
1256 | } else if (code == OFPUTIL_NXT_FLOW_REMOVED) { | |
1257 | struct nx_flow_removed *nfr; | |
1258 | struct ofpbuf b; | |
1259 | int error; | |
1260 | ||
1261 | ofpbuf_use_const(&b, oh, ntohs(oh->length)); | |
1262 | ||
1263 | nfr = ofpbuf_pull(&b, sizeof *nfr); | |
1264 | error = nx_pull_match(&b, ntohs(nfr->match_len), ntohs(nfr->priority), | |
1265 | &fr->rule); | |
1266 | if (error) { | |
1267 | return error; | |
1268 | } | |
1269 | if (b.size) { | |
1270 | return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN); | |
1271 | } | |
1272 | ||
1273 | fr->cookie = nfr->cookie; | |
1274 | fr->reason = nfr->reason; | |
1275 | fr->duration_sec = ntohl(nfr->duration_sec); | |
1276 | fr->duration_nsec = ntohl(nfr->duration_nsec); | |
1277 | fr->idle_timeout = ntohs(nfr->idle_timeout); | |
1278 | fr->packet_count = ntohll(nfr->packet_count); | |
1279 | fr->byte_count = ntohll(nfr->byte_count); | |
1280 | } else { | |
1281 | NOT_REACHED(); | |
1282 | } | |
1283 | ||
1284 | return 0; | |
1285 | } | |
1286 | ||
d1e2cf21 BP |
1287 | /* Returns a string representing the message type of 'type'. The string is the |
1288 | * enumeration constant for the type, e.g. "OFPT_HELLO". For statistics | |
1289 | * messages, the constant is followed by "request" or "reply", | |
1290 | * e.g. "OFPST_AGGREGATE reply". */ | |
1291 | const char * | |
1292 | ofputil_msg_type_name(const struct ofputil_msg_type *type) | |
1293 | { | |
1294 | return type->name; | |
1295 | } | |
1296 | \f | |
fa37b408 BP |
1297 | /* Allocates and stores in '*bufferp' a new ofpbuf with a size of |
1298 | * 'openflow_len', starting with an OpenFlow header with the given 'type' and | |
1299 | * an arbitrary transaction id. Allocated bytes beyond the header, if any, are | |
1300 | * zeroed. | |
1301 | * | |
1302 | * The caller is responsible for freeing '*bufferp' when it is no longer | |
1303 | * needed. | |
1304 | * | |
1305 | * The OpenFlow header length is initially set to 'openflow_len'; if the | |
1306 | * message is later extended, the length should be updated with | |
1307 | * update_openflow_length() before sending. | |
1308 | * | |
1309 | * Returns the header. */ | |
1310 | void * | |
1311 | make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **bufferp) | |
1312 | { | |
1313 | *bufferp = ofpbuf_new(openflow_len); | |
1314 | return put_openflow_xid(openflow_len, type, alloc_xid(), *bufferp); | |
1315 | } | |
1316 | ||
0bd0c660 BP |
1317 | /* Similar to make_openflow() but creates a Nicira vendor extension message |
1318 | * with the specific 'subtype'. 'subtype' should be in host byte order. */ | |
1319 | void * | |
1320 | make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **bufferp) | |
1321 | { | |
1322 | return make_nxmsg_xid(openflow_len, subtype, alloc_xid(), bufferp); | |
1323 | } | |
1324 | ||
fa37b408 BP |
1325 | /* Allocates and stores in '*bufferp' a new ofpbuf with a size of |
1326 | * 'openflow_len', starting with an OpenFlow header with the given 'type' and | |
1327 | * transaction id 'xid'. Allocated bytes beyond the header, if any, are | |
1328 | * zeroed. | |
1329 | * | |
1330 | * The caller is responsible for freeing '*bufferp' when it is no longer | |
1331 | * needed. | |
1332 | * | |
1333 | * The OpenFlow header length is initially set to 'openflow_len'; if the | |
1334 | * message is later extended, the length should be updated with | |
1335 | * update_openflow_length() before sending. | |
1336 | * | |
1337 | * Returns the header. */ | |
1338 | void * | |
44381c1b | 1339 | make_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid, |
fa37b408 BP |
1340 | struct ofpbuf **bufferp) |
1341 | { | |
1342 | *bufferp = ofpbuf_new(openflow_len); | |
1343 | return put_openflow_xid(openflow_len, type, xid, *bufferp); | |
1344 | } | |
1345 | ||
0bd0c660 BP |
1346 | /* Similar to make_openflow_xid() but creates a Nicira vendor extension message |
1347 | * with the specific 'subtype'. 'subtype' should be in host byte order. */ | |
1348 | void * | |
44381c1b | 1349 | make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid, |
0bd0c660 BP |
1350 | struct ofpbuf **bufferp) |
1351 | { | |
dfdfc8d4 BP |
1352 | *bufferp = ofpbuf_new(openflow_len); |
1353 | return put_nxmsg_xid(openflow_len, subtype, xid, *bufferp); | |
0bd0c660 BP |
1354 | } |
1355 | ||
fa37b408 BP |
1356 | /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header |
1357 | * with the given 'type' and an arbitrary transaction id. Allocated bytes | |
1358 | * beyond the header, if any, are zeroed. | |
1359 | * | |
1360 | * The OpenFlow header length is initially set to 'openflow_len'; if the | |
1361 | * message is later extended, the length should be updated with | |
1362 | * update_openflow_length() before sending. | |
1363 | * | |
1364 | * Returns the header. */ | |
1365 | void * | |
1366 | put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *buffer) | |
1367 | { | |
1368 | return put_openflow_xid(openflow_len, type, alloc_xid(), buffer); | |
1369 | } | |
1370 | ||
1371 | /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header | |
1372 | * with the given 'type' and an transaction id 'xid'. Allocated bytes beyond | |
1373 | * the header, if any, are zeroed. | |
1374 | * | |
1375 | * The OpenFlow header length is initially set to 'openflow_len'; if the | |
1376 | * message is later extended, the length should be updated with | |
1377 | * update_openflow_length() before sending. | |
1378 | * | |
1379 | * Returns the header. */ | |
1380 | void * | |
44381c1b | 1381 | put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid, |
fa37b408 BP |
1382 | struct ofpbuf *buffer) |
1383 | { | |
1384 | struct ofp_header *oh; | |
1385 | ||
1386 | assert(openflow_len >= sizeof *oh); | |
1387 | assert(openflow_len <= UINT16_MAX); | |
1388 | ||
1389 | oh = ofpbuf_put_uninit(buffer, openflow_len); | |
1390 | oh->version = OFP_VERSION; | |
1391 | oh->type = type; | |
1392 | oh->length = htons(openflow_len); | |
1393 | oh->xid = xid; | |
1394 | memset(oh + 1, 0, openflow_len - sizeof *oh); | |
1395 | return oh; | |
1396 | } | |
1397 | ||
dfdfc8d4 BP |
1398 | /* Similar to put_openflow() but append a Nicira vendor extension message with |
1399 | * the specific 'subtype'. 'subtype' should be in host byte order. */ | |
1400 | void * | |
1401 | put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *buffer) | |
1402 | { | |
1403 | return put_nxmsg_xid(openflow_len, subtype, alloc_xid(), buffer); | |
1404 | } | |
1405 | ||
1406 | /* Similar to put_openflow_xid() but append a Nicira vendor extension message | |
1407 | * with the specific 'subtype'. 'subtype' should be in host byte order. */ | |
1408 | void * | |
1409 | put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid, | |
1410 | struct ofpbuf *buffer) | |
1411 | { | |
1412 | struct nicira_header *nxh; | |
1413 | ||
1414 | nxh = put_openflow_xid(openflow_len, OFPT_VENDOR, xid, buffer); | |
1415 | nxh->vendor = htonl(NX_VENDOR_ID); | |
1416 | nxh->subtype = htonl(subtype); | |
1417 | return nxh; | |
1418 | } | |
1419 | ||
fa37b408 BP |
1420 | /* Updates the 'length' field of the OpenFlow message in 'buffer' to |
1421 | * 'buffer->size'. */ | |
1422 | void | |
d295e8e9 | 1423 | update_openflow_length(struct ofpbuf *buffer) |
fa37b408 BP |
1424 | { |
1425 | struct ofp_header *oh = ofpbuf_at_assert(buffer, 0, sizeof *oh); | |
d295e8e9 | 1426 | oh->length = htons(buffer->size); |
fa37b408 BP |
1427 | } |
1428 | ||
dfdfc8d4 BP |
1429 | /* Creates an ofp_stats_request with the given 'type' and 'body_len' bytes of |
1430 | * space allocated for the 'body' member. Returns the first byte of the 'body' | |
1431 | * member. */ | |
1432 | void * | |
1433 | ofputil_make_stats_request(size_t body_len, uint16_t type, | |
1434 | struct ofpbuf **bufferp) | |
1435 | { | |
1436 | struct ofp_stats_request *osr; | |
1437 | osr = make_openflow((offsetof(struct ofp_stats_request, body) | |
1438 | + body_len), OFPT_STATS_REQUEST, bufferp); | |
1439 | osr->type = htons(type); | |
1440 | osr->flags = htons(0); | |
1441 | return osr->body; | |
1442 | } | |
1443 | ||
1444 | /* Creates a stats request message with Nicira as vendor and the given | |
1445 | * 'subtype', of total length 'openflow_len'. Returns the message. */ | |
1446 | void * | |
1447 | ofputil_make_nxstats_request(size_t openflow_len, uint32_t subtype, | |
1448 | struct ofpbuf **bufferp) | |
1449 | { | |
1450 | struct nicira_stats_msg *nsm; | |
1451 | ||
1452 | nsm = make_openflow(openflow_len, OFPT_STATS_REQUEST, bufferp); | |
1453 | nsm->type = htons(OFPST_VENDOR); | |
1454 | nsm->flags = htons(0); | |
1455 | nsm->vendor = htonl(NX_VENDOR_ID); | |
1456 | nsm->subtype = htonl(subtype); | |
1457 | return nsm; | |
1458 | } | |
1459 | ||
d1e2cf21 BP |
1460 | /* Returns the first byte of the 'body' member of the ofp_stats_request or |
1461 | * ofp_stats_reply in 'oh'. */ | |
1462 | const void * | |
1463 | ofputil_stats_body(const struct ofp_header *oh) | |
1464 | { | |
1465 | assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY); | |
1466 | return ((const struct ofp_stats_request *) oh)->body; | |
1467 | } | |
1468 | ||
1469 | /* Returns the length of the 'body' member of the ofp_stats_request or | |
1470 | * ofp_stats_reply in 'oh'. */ | |
1471 | size_t | |
1472 | ofputil_stats_body_len(const struct ofp_header *oh) | |
1473 | { | |
1474 | assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY); | |
1475 | return ntohs(oh->length) - sizeof(struct ofp_stats_request); | |
1476 | } | |
1477 | ||
c6430da5 BP |
1478 | /* Returns the first byte of the body of the nicira_stats_msg in 'oh'. */ |
1479 | const void * | |
1480 | ofputil_nxstats_body(const struct ofp_header *oh) | |
1481 | { | |
1482 | assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY); | |
1483 | return ((const struct nicira_stats_msg *) oh) + 1; | |
1484 | } | |
1485 | ||
1486 | /* Returns the length of the body of the nicira_stats_msg in 'oh'. */ | |
1487 | size_t | |
1488 | ofputil_nxstats_body_len(const struct ofp_header *oh) | |
1489 | { | |
1490 | assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY); | |
1491 | return ntohs(oh->length) - sizeof(struct nicira_stats_msg); | |
1492 | } | |
1493 | ||
fa37b408 | 1494 | struct ofpbuf * |
daa68e9f BP |
1495 | make_flow_mod(uint16_t command, const struct cls_rule *rule, |
1496 | size_t actions_len) | |
fa37b408 BP |
1497 | { |
1498 | struct ofp_flow_mod *ofm; | |
1499 | size_t size = sizeof *ofm + actions_len; | |
1500 | struct ofpbuf *out = ofpbuf_new(size); | |
1501 | ofm = ofpbuf_put_zeros(out, sizeof *ofm); | |
1502 | ofm->header.version = OFP_VERSION; | |
1503 | ofm->header.type = OFPT_FLOW_MOD; | |
1504 | ofm->header.length = htons(size); | |
1505 | ofm->cookie = 0; | |
daa68e9f | 1506 | ofm->priority = htons(MIN(rule->priority, UINT16_MAX)); |
ff9d3826 | 1507 | ofputil_cls_rule_to_match(rule, NXFF_OPENFLOW10, &ofm->match, 0, NULL); |
fa37b408 BP |
1508 | ofm->command = htons(command); |
1509 | return out; | |
1510 | } | |
1511 | ||
1512 | struct ofpbuf * | |
daa68e9f | 1513 | make_add_flow(const struct cls_rule *rule, uint32_t buffer_id, |
fa37b408 BP |
1514 | uint16_t idle_timeout, size_t actions_len) |
1515 | { | |
daa68e9f | 1516 | struct ofpbuf *out = make_flow_mod(OFPFC_ADD, rule, actions_len); |
fa37b408 BP |
1517 | struct ofp_flow_mod *ofm = out->data; |
1518 | ofm->idle_timeout = htons(idle_timeout); | |
1519 | ofm->hard_timeout = htons(OFP_FLOW_PERMANENT); | |
1520 | ofm->buffer_id = htonl(buffer_id); | |
1521 | return out; | |
1522 | } | |
1523 | ||
1524 | struct ofpbuf * | |
daa68e9f | 1525 | make_del_flow(const struct cls_rule *rule) |
fa37b408 | 1526 | { |
daa68e9f | 1527 | struct ofpbuf *out = make_flow_mod(OFPFC_DELETE_STRICT, rule, 0); |
fa37b408 BP |
1528 | struct ofp_flow_mod *ofm = out->data; |
1529 | ofm->out_port = htons(OFPP_NONE); | |
1530 | return out; | |
1531 | } | |
1532 | ||
1533 | struct ofpbuf * | |
daa68e9f | 1534 | make_add_simple_flow(const struct cls_rule *rule, |
fa37b408 BP |
1535 | uint32_t buffer_id, uint16_t out_port, |
1536 | uint16_t idle_timeout) | |
1537 | { | |
81f3cad4 BP |
1538 | if (out_port != OFPP_NONE) { |
1539 | struct ofp_action_output *oao; | |
1540 | struct ofpbuf *buffer; | |
1541 | ||
daa68e9f | 1542 | buffer = make_add_flow(rule, buffer_id, idle_timeout, sizeof *oao); |
81f3cad4 BP |
1543 | oao = ofpbuf_put_zeros(buffer, sizeof *oao); |
1544 | oao->type = htons(OFPAT_OUTPUT); | |
1545 | oao->len = htons(sizeof *oao); | |
1546 | oao->port = htons(out_port); | |
1547 | return buffer; | |
1548 | } else { | |
daa68e9f | 1549 | return make_add_flow(rule, buffer_id, idle_timeout, 0); |
81f3cad4 | 1550 | } |
fa37b408 BP |
1551 | } |
1552 | ||
1553 | struct ofpbuf * | |
1554 | make_packet_in(uint32_t buffer_id, uint16_t in_port, uint8_t reason, | |
1555 | const struct ofpbuf *payload, int max_send_len) | |
1556 | { | |
1557 | struct ofp_packet_in *opi; | |
1558 | struct ofpbuf *buf; | |
1559 | int send_len; | |
1560 | ||
1561 | send_len = MIN(max_send_len, payload->size); | |
1562 | buf = ofpbuf_new(sizeof *opi + send_len); | |
1563 | opi = put_openflow_xid(offsetof(struct ofp_packet_in, data), | |
1564 | OFPT_PACKET_IN, 0, buf); | |
1565 | opi->buffer_id = htonl(buffer_id); | |
1566 | opi->total_len = htons(payload->size); | |
1567 | opi->in_port = htons(in_port); | |
1568 | opi->reason = reason; | |
1569 | ofpbuf_put(buf, payload->data, send_len); | |
1570 | update_openflow_length(buf); | |
1571 | ||
1572 | return buf; | |
1573 | } | |
1574 | ||
1575 | struct ofpbuf * | |
1576 | make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id, | |
1577 | uint16_t in_port, | |
1578 | const struct ofp_action_header *actions, size_t n_actions) | |
1579 | { | |
1580 | size_t actions_len = n_actions * sizeof *actions; | |
1581 | struct ofp_packet_out *opo; | |
1582 | size_t size = sizeof *opo + actions_len + (packet ? packet->size : 0); | |
1583 | struct ofpbuf *out = ofpbuf_new(size); | |
1584 | ||
1585 | opo = ofpbuf_put_uninit(out, sizeof *opo); | |
1586 | opo->header.version = OFP_VERSION; | |
1587 | opo->header.type = OFPT_PACKET_OUT; | |
1588 | opo->header.length = htons(size); | |
1589 | opo->header.xid = htonl(0); | |
1590 | opo->buffer_id = htonl(buffer_id); | |
1591 | opo->in_port = htons(in_port == ODPP_LOCAL ? OFPP_LOCAL : in_port); | |
1592 | opo->actions_len = htons(actions_len); | |
1593 | ofpbuf_put(out, actions, actions_len); | |
1594 | if (packet) { | |
1595 | ofpbuf_put(out, packet->data, packet->size); | |
1596 | } | |
1597 | return out; | |
1598 | } | |
1599 | ||
1600 | struct ofpbuf * | |
1601 | make_unbuffered_packet_out(const struct ofpbuf *packet, | |
1602 | uint16_t in_port, uint16_t out_port) | |
1603 | { | |
1604 | struct ofp_action_output action; | |
1605 | action.type = htons(OFPAT_OUTPUT); | |
1606 | action.len = htons(sizeof action); | |
1607 | action.port = htons(out_port); | |
1608 | return make_packet_out(packet, UINT32_MAX, in_port, | |
1609 | (struct ofp_action_header *) &action, 1); | |
1610 | } | |
1611 | ||
1612 | struct ofpbuf * | |
1613 | make_buffered_packet_out(uint32_t buffer_id, | |
1614 | uint16_t in_port, uint16_t out_port) | |
1615 | { | |
81f3cad4 BP |
1616 | if (out_port != OFPP_NONE) { |
1617 | struct ofp_action_output action; | |
1618 | action.type = htons(OFPAT_OUTPUT); | |
1619 | action.len = htons(sizeof action); | |
1620 | action.port = htons(out_port); | |
1621 | return make_packet_out(NULL, buffer_id, in_port, | |
1622 | (struct ofp_action_header *) &action, 1); | |
1623 | } else { | |
1624 | return make_packet_out(NULL, buffer_id, in_port, NULL, 0); | |
1625 | } | |
fa37b408 BP |
1626 | } |
1627 | ||
1628 | /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */ | |
1629 | struct ofpbuf * | |
1630 | make_echo_request(void) | |
1631 | { | |
1632 | struct ofp_header *rq; | |
1633 | struct ofpbuf *out = ofpbuf_new(sizeof *rq); | |
1634 | rq = ofpbuf_put_uninit(out, sizeof *rq); | |
1635 | rq->version = OFP_VERSION; | |
1636 | rq->type = OFPT_ECHO_REQUEST; | |
1637 | rq->length = htons(sizeof *rq); | |
44381c1b | 1638 | rq->xid = htonl(0); |
fa37b408 BP |
1639 | return out; |
1640 | } | |
1641 | ||
1642 | /* Creates and returns an OFPT_ECHO_REPLY message matching the | |
1643 | * OFPT_ECHO_REQUEST message in 'rq'. */ | |
1644 | struct ofpbuf * | |
1645 | make_echo_reply(const struct ofp_header *rq) | |
1646 | { | |
1647 | size_t size = ntohs(rq->length); | |
1648 | struct ofpbuf *out = ofpbuf_new(size); | |
1649 | struct ofp_header *reply = ofpbuf_put(out, rq, size); | |
1650 | reply->type = OFPT_ECHO_REPLY; | |
1651 | return out; | |
1652 | } | |
1653 | ||
fa37b408 BP |
1654 | const struct ofp_flow_stats * |
1655 | flow_stats_first(struct flow_stats_iterator *iter, | |
1656 | const struct ofp_stats_reply *osr) | |
1657 | { | |
1658 | iter->pos = osr->body; | |
1659 | iter->end = osr->body + (ntohs(osr->header.length) | |
1660 | - offsetof(struct ofp_stats_reply, body)); | |
1661 | return flow_stats_next(iter); | |
1662 | } | |
1663 | ||
1664 | const struct ofp_flow_stats * | |
1665 | flow_stats_next(struct flow_stats_iterator *iter) | |
1666 | { | |
1667 | ptrdiff_t bytes_left = iter->end - iter->pos; | |
1668 | const struct ofp_flow_stats *fs; | |
1669 | size_t length; | |
1670 | ||
1671 | if (bytes_left < sizeof *fs) { | |
1672 | if (bytes_left != 0) { | |
1673 | VLOG_WARN_RL(&bad_ofmsg_rl, | |
1674 | "%td leftover bytes in flow stats reply", bytes_left); | |
1675 | } | |
1676 | return NULL; | |
1677 | } | |
1678 | ||
1679 | fs = (const void *) iter->pos; | |
1680 | length = ntohs(fs->length); | |
1681 | if (length < sizeof *fs) { | |
1682 | VLOG_WARN_RL(&bad_ofmsg_rl, "flow stats length %zu is shorter than " | |
1683 | "min %zu", length, sizeof *fs); | |
1684 | return NULL; | |
1685 | } else if (length > bytes_left) { | |
1686 | VLOG_WARN_RL(&bad_ofmsg_rl, "flow stats length %zu but only %td " | |
1687 | "bytes left", length, bytes_left); | |
1688 | return NULL; | |
1689 | } else if ((length - sizeof *fs) % sizeof fs->actions[0]) { | |
1690 | VLOG_WARN_RL(&bad_ofmsg_rl, "flow stats length %zu has %zu bytes " | |
1691 | "left over in final action", length, | |
1692 | (length - sizeof *fs) % sizeof fs->actions[0]); | |
1693 | return NULL; | |
1694 | } | |
1695 | iter->pos += length; | |
1696 | return fs; | |
1697 | } | |
1698 | ||
fa37b408 BP |
1699 | static int |
1700 | check_action_exact_len(const union ofp_action *a, unsigned int len, | |
1701 | unsigned int required_len) | |
1702 | { | |
1703 | if (len != required_len) { | |
35c4693a BP |
1704 | VLOG_WARN_RL(&bad_ofmsg_rl, "action %"PRIu16" has invalid length " |
1705 | "%"PRIu16" (must be %u)\n", | |
1706 | ntohs(a->type), ntohs(a->header.len), required_len); | |
fa37b408 BP |
1707 | return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN); |
1708 | } | |
1709 | return 0; | |
1710 | } | |
1711 | ||
abcf9134 BP |
1712 | static int |
1713 | check_nx_action_exact_len(const struct nx_action_header *a, | |
1714 | unsigned int len, unsigned int required_len) | |
1715 | { | |
1716 | if (len != required_len) { | |
1717 | VLOG_WARN_RL(&bad_ofmsg_rl, | |
1718 | "Nicira action %"PRIu16" has invalid length %"PRIu16" " | |
1719 | "(must be %u)\n", | |
1720 | ntohs(a->subtype), ntohs(a->len), required_len); | |
1721 | return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN); | |
1722 | } | |
1723 | return 0; | |
1724 | } | |
1725 | ||
c1c9c9c4 BP |
1726 | /* Checks that 'port' is a valid output port for the OFPAT_OUTPUT action, given |
1727 | * that the switch will never have more than 'max_ports' ports. Returns 0 if | |
1728 | * 'port' is valid, otherwise an ofp_mkerr() return code. */ | |
fa37b408 | 1729 | static int |
c1c9c9c4 | 1730 | check_output_port(uint16_t port, int max_ports) |
fa37b408 BP |
1731 | { |
1732 | switch (port) { | |
1733 | case OFPP_IN_PORT: | |
1734 | case OFPP_TABLE: | |
1735 | case OFPP_NORMAL: | |
1736 | case OFPP_FLOOD: | |
1737 | case OFPP_ALL: | |
1738 | case OFPP_CONTROLLER: | |
1739 | case OFPP_LOCAL: | |
1740 | return 0; | |
1741 | ||
1742 | default: | |
c1c9c9c4 | 1743 | if (port < max_ports) { |
fa37b408 BP |
1744 | return 0; |
1745 | } | |
1746 | VLOG_WARN_RL(&bad_ofmsg_rl, "unknown output port %x", port); | |
1747 | return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT); | |
1748 | } | |
1749 | } | |
1750 | ||
c1c9c9c4 BP |
1751 | /* Checks that 'action' is a valid OFPAT_ENQUEUE action, given that the switch |
1752 | * will never have more than 'max_ports' ports. Returns 0 if 'port' is valid, | |
1753 | * otherwise an ofp_mkerr() return code. */ | |
1754 | static int | |
1755 | check_enqueue_action(const union ofp_action *a, unsigned int len, | |
1756 | int max_ports) | |
1757 | { | |
1758 | const struct ofp_action_enqueue *oae; | |
1759 | uint16_t port; | |
1760 | int error; | |
1761 | ||
1762 | error = check_action_exact_len(a, len, 16); | |
1763 | if (error) { | |
1764 | return error; | |
1765 | } | |
1766 | ||
1767 | oae = (const struct ofp_action_enqueue *) a; | |
1768 | port = ntohs(oae->port); | |
1769 | if (port < max_ports || port == OFPP_IN_PORT) { | |
1770 | return 0; | |
1771 | } | |
1772 | VLOG_WARN_RL(&bad_ofmsg_rl, "unknown enqueue port %x", port); | |
1773 | return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT); | |
1774 | } | |
1775 | ||
fa37b408 | 1776 | static int |
b6c9e612 BP |
1777 | check_nicira_action(const union ofp_action *a, unsigned int len, |
1778 | const struct flow *flow) | |
fa37b408 BP |
1779 | { |
1780 | const struct nx_action_header *nah; | |
e41a9130 | 1781 | uint16_t subtype; |
b6c9e612 | 1782 | int error; |
fa37b408 BP |
1783 | |
1784 | if (len < 16) { | |
f4350529 BP |
1785 | VLOG_WARN_RL(&bad_ofmsg_rl, |
1786 | "Nicira vendor action only %u bytes", len); | |
fa37b408 BP |
1787 | return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN); |
1788 | } | |
1789 | nah = (const struct nx_action_header *) a; | |
1790 | ||
e41a9130 BP |
1791 | subtype = ntohs(nah->subtype); |
1792 | if (subtype > TYPE_MAXIMUM(enum nx_action_subtype)) { | |
1793 | /* This is necessary because enum nx_action_subtype is probably an | |
1794 | * 8-bit type, so the cast below throws away the top 8 bits. */ | |
1795 | return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR_TYPE); | |
1796 | } | |
1797 | ||
1798 | switch ((enum nx_action_subtype) subtype) { | |
fa37b408 BP |
1799 | case NXAST_RESUBMIT: |
1800 | case NXAST_SET_TUNNEL: | |
92467099 | 1801 | case NXAST_DROP_SPOOFED_ARP: |
eedc0097 JP |
1802 | case NXAST_SET_QUEUE: |
1803 | case NXAST_POP_QUEUE: | |
abcf9134 | 1804 | return check_nx_action_exact_len(nah, len, 16); |
96fc46e8 | 1805 | |
b6c9e612 | 1806 | case NXAST_REG_MOVE: |
abcf9134 BP |
1807 | error = check_nx_action_exact_len(nah, len, |
1808 | sizeof(struct nx_action_reg_move)); | |
b6c9e612 BP |
1809 | if (error) { |
1810 | return error; | |
1811 | } | |
1812 | return nxm_check_reg_move((const struct nx_action_reg_move *) a, flow); | |
96fc46e8 | 1813 | |
b6c9e612 | 1814 | case NXAST_REG_LOAD: |
abcf9134 BP |
1815 | error = check_nx_action_exact_len(nah, len, |
1816 | sizeof(struct nx_action_reg_load)); | |
b6c9e612 BP |
1817 | if (error) { |
1818 | return error; | |
1819 | } | |
1820 | return nxm_check_reg_load((const struct nx_action_reg_load *) a, flow); | |
96fc46e8 BP |
1821 | |
1822 | case NXAST_NOTE: | |
1823 | return 0; | |
1824 | ||
b9298d3f | 1825 | case NXAST_SET_TUNNEL64: |
abcf9134 BP |
1826 | return check_nx_action_exact_len( |
1827 | nah, len, sizeof(struct nx_action_set_tunnel64)); | |
b9298d3f | 1828 | |
53ddd40a | 1829 | case NXAST_MULTIPATH: |
abcf9134 BP |
1830 | error = check_nx_action_exact_len( |
1831 | nah, len, sizeof(struct nx_action_multipath)); | |
53ddd40a BP |
1832 | if (error) { |
1833 | return error; | |
1834 | } | |
1835 | return multipath_check((const struct nx_action_multipath *) a); | |
1836 | ||
e41a9130 | 1837 | case NXAST_SNAT__OBSOLETE: |
fa37b408 | 1838 | default: |
abcf9134 BP |
1839 | VLOG_WARN_RL(&bad_ofmsg_rl, |
1840 | "unknown Nicira vendor action subtype %"PRIu16, | |
1841 | ntohs(nah->subtype)); | |
fa37b408 BP |
1842 | return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR_TYPE); |
1843 | } | |
1844 | } | |
1845 | ||
1846 | static int | |
b6c9e612 BP |
1847 | check_action(const union ofp_action *a, unsigned int len, |
1848 | const struct flow *flow, int max_ports) | |
fa37b408 | 1849 | { |
e41a9130 | 1850 | enum ofp_action_type type = ntohs(a->type); |
fa37b408 BP |
1851 | int error; |
1852 | ||
e41a9130 | 1853 | switch (type) { |
fa37b408 | 1854 | case OFPAT_OUTPUT: |
c1c9c9c4 BP |
1855 | error = check_action_exact_len(a, len, 8); |
1856 | if (error) { | |
1857 | return error; | |
1858 | } | |
1859 | return check_output_port(ntohs(a->output.port), max_ports); | |
fa37b408 BP |
1860 | |
1861 | case OFPAT_SET_VLAN_VID: | |
27bcf966 BP |
1862 | error = check_action_exact_len(a, len, 8); |
1863 | if (error) { | |
1864 | return error; | |
1865 | } | |
1866 | if (a->vlan_vid.vlan_vid & ~htons(0xfff)) { | |
1867 | return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT); | |
1868 | } | |
1869 | return 0; | |
1870 | ||
fa37b408 | 1871 | case OFPAT_SET_VLAN_PCP: |
27bcf966 BP |
1872 | error = check_action_exact_len(a, len, 8); |
1873 | if (error) { | |
1874 | return error; | |
1875 | } | |
1876 | if (a->vlan_vid.vlan_vid & ~7) { | |
1877 | return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT); | |
1878 | } | |
1879 | return 0; | |
1880 | ||
fa37b408 BP |
1881 | case OFPAT_STRIP_VLAN: |
1882 | case OFPAT_SET_NW_SRC: | |
1883 | case OFPAT_SET_NW_DST: | |
1884 | case OFPAT_SET_NW_TOS: | |
1885 | case OFPAT_SET_TP_SRC: | |
1886 | case OFPAT_SET_TP_DST: | |
1887 | return check_action_exact_len(a, len, 8); | |
1888 | ||
1889 | case OFPAT_SET_DL_SRC: | |
1890 | case OFPAT_SET_DL_DST: | |
1891 | return check_action_exact_len(a, len, 16); | |
1892 | ||
1893 | case OFPAT_VENDOR: | |
1894 | return (a->vendor.vendor == htonl(NX_VENDOR_ID) | |
b6c9e612 | 1895 | ? check_nicira_action(a, len, flow) |
fa37b408 BP |
1896 | : ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR)); |
1897 | ||
c1c9c9c4 BP |
1898 | case OFPAT_ENQUEUE: |
1899 | return check_enqueue_action(a, len, max_ports); | |
1900 | ||
fa37b408 | 1901 | default: |
e41a9130 | 1902 | VLOG_WARN_RL(&bad_ofmsg_rl, "unknown action type %d", (int) type); |
fa37b408 BP |
1903 | return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_TYPE); |
1904 | } | |
1905 | } | |
1906 | ||
1907 | int | |
1908 | validate_actions(const union ofp_action *actions, size_t n_actions, | |
b6c9e612 | 1909 | const struct flow *flow, int max_ports) |
fa37b408 | 1910 | { |
3dffcf07 | 1911 | size_t i; |
fa37b408 | 1912 | |
3dffcf07 BP |
1913 | for (i = 0; i < n_actions; ) { |
1914 | const union ofp_action *a = &actions[i]; | |
fa37b408 | 1915 | unsigned int len = ntohs(a->header.len); |
69b6be19 | 1916 | unsigned int n_slots = len / OFP_ACTION_ALIGN; |
fa37b408 BP |
1917 | unsigned int slots_left = &actions[n_actions] - a; |
1918 | int error; | |
1919 | ||
1920 | if (n_slots > slots_left) { | |
f4350529 BP |
1921 | VLOG_WARN_RL(&bad_ofmsg_rl, |
1922 | "action requires %u slots but only %u remain", | |
1923 | n_slots, slots_left); | |
fa37b408 BP |
1924 | return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN); |
1925 | } else if (!len) { | |
f4350529 | 1926 | VLOG_WARN_RL(&bad_ofmsg_rl, "action has invalid length 0"); |
fa37b408 | 1927 | return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN); |
69b6be19 | 1928 | } else if (len % OFP_ACTION_ALIGN) { |
f4350529 BP |
1929 | VLOG_WARN_RL(&bad_ofmsg_rl, "action length %u is not a multiple " |
1930 | "of %d", len, OFP_ACTION_ALIGN); | |
fa37b408 BP |
1931 | return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN); |
1932 | } | |
1933 | ||
b6c9e612 | 1934 | error = check_action(a, len, flow, max_ports); |
fa37b408 BP |
1935 | if (error) { |
1936 | return error; | |
1937 | } | |
3dffcf07 | 1938 | i += n_slots; |
fa37b408 BP |
1939 | } |
1940 | return 0; | |
1941 | } | |
1942 | ||
c1c9c9c4 BP |
1943 | /* Returns true if 'action' outputs to 'port' (which must be in network byte |
1944 | * order), false otherwise. */ | |
1945 | bool | |
1946 | action_outputs_to_port(const union ofp_action *action, uint16_t port) | |
1947 | { | |
1948 | switch (ntohs(action->type)) { | |
1949 | case OFPAT_OUTPUT: | |
1950 | return action->output.port == port; | |
1951 | case OFPAT_ENQUEUE: | |
1952 | return ((const struct ofp_action_enqueue *) action)->port == port; | |
1953 | default: | |
1954 | return false; | |
1955 | } | |
1956 | } | |
1957 | ||
fa37b408 BP |
1958 | /* The set of actions must either come from a trusted source or have been |
1959 | * previously validated with validate_actions(). */ | |
1960 | const union ofp_action * | |
1961 | actions_first(struct actions_iterator *iter, | |
1962 | const union ofp_action *oa, size_t n_actions) | |
1963 | { | |
1964 | iter->pos = oa; | |
1965 | iter->end = oa + n_actions; | |
1966 | return actions_next(iter); | |
1967 | } | |
1968 | ||
1969 | const union ofp_action * | |
1970 | actions_next(struct actions_iterator *iter) | |
1971 | { | |
3dffcf07 | 1972 | if (iter->pos != iter->end) { |
fa37b408 BP |
1973 | const union ofp_action *a = iter->pos; |
1974 | unsigned int len = ntohs(a->header.len); | |
69b6be19 | 1975 | iter->pos += len / OFP_ACTION_ALIGN; |
fa37b408 BP |
1976 | return a; |
1977 | } else { | |
1978 | return NULL; | |
1979 | } | |
1980 | } | |
1981 | ||
1982 | void | |
1983 | normalize_match(struct ofp_match *m) | |
1984 | { | |
371e4acc JT |
1985 | enum { OFPFW_NW = (OFPFW_NW_SRC_MASK | OFPFW_NW_DST_MASK | OFPFW_NW_PROTO |
1986 | | OFPFW_NW_TOS) }; | |
fa37b408 BP |
1987 | enum { OFPFW_TP = OFPFW_TP_SRC | OFPFW_TP_DST }; |
1988 | uint32_t wc; | |
1989 | ||
1990 | wc = ntohl(m->wildcards) & OVSFW_ALL; | |
1991 | if (wc & OFPFW_DL_TYPE) { | |
1992 | m->dl_type = 0; | |
1993 | ||
1994 | /* Can't sensibly match on network or transport headers if the | |
1995 | * data link type is unknown. */ | |
1996 | wc |= OFPFW_NW | OFPFW_TP; | |
4d326add | 1997 | m->nw_src = m->nw_dst = m->nw_proto = m->nw_tos = 0; |
fa37b408 BP |
1998 | m->tp_src = m->tp_dst = 0; |
1999 | } else if (m->dl_type == htons(ETH_TYPE_IP)) { | |
2000 | if (wc & OFPFW_NW_PROTO) { | |
2001 | m->nw_proto = 0; | |
2002 | ||
2003 | /* Can't sensibly match on transport headers if the network | |
2004 | * protocol is unknown. */ | |
2005 | wc |= OFPFW_TP; | |
2006 | m->tp_src = m->tp_dst = 0; | |
2007 | } else if (m->nw_proto == IPPROTO_TCP || | |
2008 | m->nw_proto == IPPROTO_UDP || | |
2009 | m->nw_proto == IPPROTO_ICMP) { | |
2010 | if (wc & OFPFW_TP_SRC) { | |
2011 | m->tp_src = 0; | |
2012 | } | |
2013 | if (wc & OFPFW_TP_DST) { | |
2014 | m->tp_dst = 0; | |
2015 | } | |
2016 | } else { | |
2017 | /* Transport layer fields will always be extracted as zeros, so we | |
2018 | * can do an exact-match on those values. */ | |
2019 | wc &= ~OFPFW_TP; | |
2020 | m->tp_src = m->tp_dst = 0; | |
2021 | } | |
2022 | if (wc & OFPFW_NW_SRC_MASK) { | |
0596e897 | 2023 | m->nw_src &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_SRC_SHIFT); |
fa37b408 BP |
2024 | } |
2025 | if (wc & OFPFW_NW_DST_MASK) { | |
0596e897 | 2026 | m->nw_dst &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_DST_SHIFT); |
fa37b408 | 2027 | } |
4d326add BP |
2028 | if (wc & OFPFW_NW_TOS) { |
2029 | m->nw_tos = 0; | |
2030 | } else { | |
2031 | m->nw_tos &= IP_DSCP_MASK; | |
2032 | } | |
fa37b408 BP |
2033 | } else if (m->dl_type == htons(ETH_TYPE_ARP)) { |
2034 | if (wc & OFPFW_NW_PROTO) { | |
2035 | m->nw_proto = 0; | |
2036 | } | |
2037 | if (wc & OFPFW_NW_SRC_MASK) { | |
0596e897 | 2038 | m->nw_src &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_SRC_SHIFT); |
fa37b408 BP |
2039 | } |
2040 | if (wc & OFPFW_NW_DST_MASK) { | |
0596e897 | 2041 | m->nw_dst &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_DST_SHIFT); |
fa37b408 | 2042 | } |
4d326add | 2043 | m->tp_src = m->tp_dst = m->nw_tos = 0; |
fa37b408 BP |
2044 | } else { |
2045 | /* Network and transport layer fields will always be extracted as | |
2046 | * zeros, so we can do an exact-match on those values. */ | |
2047 | wc &= ~(OFPFW_NW | OFPFW_TP); | |
4d326add | 2048 | m->nw_proto = m->nw_src = m->nw_dst = m->nw_tos = 0; |
fa37b408 BP |
2049 | m->tp_src = m->tp_dst = 0; |
2050 | } | |
2051 | if (wc & OFPFW_DL_SRC) { | |
2052 | memset(m->dl_src, 0, sizeof m->dl_src); | |
2053 | } | |
2054 | if (wc & OFPFW_DL_DST) { | |
2055 | memset(m->dl_dst, 0, sizeof m->dl_dst); | |
2056 | } | |
2057 | m->wildcards = htonl(wc); | |
2058 | } | |
2059 | ||
3f09c339 BP |
2060 | /* Returns a string that describes 'match' in a very literal way, without |
2061 | * interpreting its contents except in a very basic fashion. The returned | |
2062 | * string is intended to be fixed-length, so that it is easy to see differences | |
2063 | * between two such strings if one is put above another. This is useful for | |
2064 | * describing changes made by normalize_match(). | |
2065 | * | |
2066 | * The caller must free the returned string (with free()). */ | |
2067 | char * | |
2068 | ofp_match_to_literal_string(const struct ofp_match *match) | |
2069 | { | |
2070 | return xasprintf("wildcards=%#10"PRIx32" " | |
2071 | " in_port=%5"PRId16" " | |
2072 | " dl_src="ETH_ADDR_FMT" " | |
2073 | " dl_dst="ETH_ADDR_FMT" " | |
2074 | " dl_vlan=%5"PRId16" " | |
2075 | " dl_vlan_pcp=%3"PRId8" " | |
2076 | " dl_type=%#6"PRIx16" " | |
2077 | " nw_tos=%#4"PRIx8" " | |
2078 | " nw_proto=%#4"PRIx16" " | |
2079 | " nw_src=%#10"PRIx32" " | |
2080 | " nw_dst=%#10"PRIx32" " | |
2081 | " tp_src=%5"PRId16" " | |
2082 | " tp_dst=%5"PRId16, | |
2083 | ntohl(match->wildcards), | |
2084 | ntohs(match->in_port), | |
2085 | ETH_ADDR_ARGS(match->dl_src), | |
2086 | ETH_ADDR_ARGS(match->dl_dst), | |
2087 | ntohs(match->dl_vlan), | |
2088 | match->dl_vlan_pcp, | |
2089 | ntohs(match->dl_type), | |
2090 | match->nw_tos, | |
2091 | match->nw_proto, | |
2092 | ntohl(match->nw_src), | |
2093 | ntohl(match->nw_dst), | |
2094 | ntohs(match->tp_src), | |
2095 | ntohs(match->tp_dst)); | |
2096 | } | |
26c112c2 BP |
2097 | |
2098 | static uint32_t | |
2099 | vendor_code_to_id(uint8_t code) | |
2100 | { | |
2101 | switch (code) { | |
2102 | #define OFPUTIL_VENDOR(NAME, VENDOR_ID) case NAME: return VENDOR_ID; | |
3a75cda9 BP |
2103 | OFPUTIL_VENDORS |
2104 | #undef OFPUTIL_VENDOR | |
26c112c2 BP |
2105 | default: |
2106 | return UINT32_MAX; | |
2107 | } | |
2108 | } | |
2109 | ||
dc4762ed BP |
2110 | static int |
2111 | vendor_id_to_code(uint32_t id) | |
2112 | { | |
2113 | switch (id) { | |
2114 | #define OFPUTIL_VENDOR(NAME, VENDOR_ID) case VENDOR_ID: return NAME; | |
2115 | OFPUTIL_VENDORS | |
2116 | #undef OFPUTIL_VENDOR | |
2117 | default: | |
2118 | return -1; | |
2119 | } | |
2120 | } | |
2121 | ||
26c112c2 BP |
2122 | /* Creates and returns an OpenFlow message of type OFPT_ERROR with the error |
2123 | * information taken from 'error', whose encoding must be as described in the | |
2124 | * large comment in ofp-util.h. If 'oh' is nonnull, then the error will use | |
2125 | * oh->xid as its transaction ID, and it will include up to the first 64 bytes | |
2126 | * of 'oh'. | |
2127 | * | |
2128 | * Returns NULL if 'error' is not an OpenFlow error code. */ | |
2129 | struct ofpbuf * | |
dc4762ed | 2130 | ofputil_encode_error_msg(int error, const struct ofp_header *oh) |
26c112c2 BP |
2131 | { |
2132 | static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5); | |
2133 | ||
2134 | struct ofpbuf *buf; | |
2135 | const void *data; | |
2136 | size_t len; | |
2137 | uint8_t vendor; | |
2138 | uint16_t type; | |
2139 | uint16_t code; | |
44381c1b | 2140 | ovs_be32 xid; |
26c112c2 BP |
2141 | |
2142 | if (!is_ofp_error(error)) { | |
2143 | /* We format 'error' with strerror() here since it seems likely to be | |
2144 | * a system errno value. */ | |
2145 | VLOG_WARN_RL(&rl, "invalid OpenFlow error code %d (%s)", | |
2146 | error, strerror(error)); | |
2147 | return NULL; | |
2148 | } | |
2149 | ||
2150 | if (oh) { | |
2151 | xid = oh->xid; | |
2152 | data = oh; | |
2153 | len = ntohs(oh->length); | |
2154 | if (len > 64) { | |
2155 | len = 64; | |
2156 | } | |
2157 | } else { | |
2158 | xid = 0; | |
2159 | data = NULL; | |
2160 | len = 0; | |
2161 | } | |
2162 | ||
2163 | vendor = get_ofp_err_vendor(error); | |
2164 | type = get_ofp_err_type(error); | |
2165 | code = get_ofp_err_code(error); | |
2166 | if (vendor == OFPUTIL_VENDOR_OPENFLOW) { | |
2167 | struct ofp_error_msg *oem; | |
2168 | ||
2169 | oem = make_openflow_xid(len + sizeof *oem, OFPT_ERROR, xid, &buf); | |
2170 | oem->type = htons(type); | |
2171 | oem->code = htons(code); | |
2172 | } else { | |
2173 | struct ofp_error_msg *oem; | |
217f48c6 | 2174 | struct nx_vendor_error *nve; |
26c112c2 BP |
2175 | uint32_t vendor_id; |
2176 | ||
2177 | vendor_id = vendor_code_to_id(vendor); | |
2178 | if (vendor_id == UINT32_MAX) { | |
2179 | VLOG_WARN_RL(&rl, "error %x contains invalid vendor code %d", | |
2180 | error, vendor); | |
2181 | return NULL; | |
2182 | } | |
2183 | ||
217f48c6 | 2184 | oem = make_openflow_xid(len + sizeof *oem + sizeof *nve, |
26c112c2 BP |
2185 | OFPT_ERROR, xid, &buf); |
2186 | oem->type = htons(NXET_VENDOR); | |
2187 | oem->code = htons(NXVC_VENDOR_ERROR); | |
2188 | ||
17764fb2 | 2189 | nve = (struct nx_vendor_error *)oem->data; |
217f48c6 BP |
2190 | nve->vendor = htonl(vendor_id); |
2191 | nve->type = htons(type); | |
2192 | nve->code = htons(code); | |
26c112c2 BP |
2193 | } |
2194 | ||
2195 | if (len) { | |
59edb09c | 2196 | buf->size -= len; |
26c112c2 BP |
2197 | ofpbuf_put(buf, data, len); |
2198 | } | |
2199 | ||
2200 | return buf; | |
2201 | } | |
3052b0c5 | 2202 | |
dc4762ed BP |
2203 | /* Decodes 'oh', which should be an OpenFlow OFPT_ERROR message, and returns an |
2204 | * Open vSwitch internal error code in the format described in the large | |
2205 | * comment in ofp-util.h. | |
2206 | * | |
2207 | * If 'payload_ofs' is nonnull, on success '*payload_ofs' is set to the offset | |
2208 | * to the payload starting from 'oh' and on failure it is set to 0. */ | |
2209 | int | |
2210 | ofputil_decode_error_msg(const struct ofp_header *oh, size_t *payload_ofs) | |
2211 | { | |
2212 | static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5); | |
2213 | ||
2214 | const struct ofp_error_msg *oem; | |
2215 | uint16_t type, code; | |
2216 | struct ofpbuf b; | |
2217 | int vendor; | |
2218 | ||
2219 | if (payload_ofs) { | |
2220 | *payload_ofs = 0; | |
2221 | } | |
2222 | if (oh->type != OFPT_ERROR) { | |
2223 | return EPROTO; | |
2224 | } | |
2225 | ||
2226 | ofpbuf_use_const(&b, oh, ntohs(oh->length)); | |
2227 | oem = ofpbuf_try_pull(&b, sizeof *oem); | |
2228 | if (!oem) { | |
2229 | return EPROTO; | |
2230 | } | |
2231 | ||
2232 | type = ntohs(oem->type); | |
2233 | code = ntohs(oem->code); | |
2234 | if (type == NXET_VENDOR && code == NXVC_VENDOR_ERROR) { | |
2235 | const struct nx_vendor_error *nve = ofpbuf_try_pull(&b, sizeof *nve); | |
2236 | if (!nve) { | |
2237 | return EPROTO; | |
2238 | } | |
2239 | ||
2240 | vendor = vendor_id_to_code(ntohl(nve->vendor)); | |
2241 | if (vendor < 0) { | |
2242 | VLOG_WARN_RL(&rl, "error contains unknown vendor ID %#"PRIx32, | |
2243 | ntohl(nve->vendor)); | |
2244 | return EPROTO; | |
2245 | } | |
2246 | type = ntohs(nve->type); | |
2247 | code = ntohs(nve->code); | |
2248 | } else { | |
2249 | vendor = OFPUTIL_VENDOR_OPENFLOW; | |
2250 | } | |
2251 | ||
2252 | if (type >= 1024) { | |
2253 | VLOG_WARN_RL(&rl, "error contains type %"PRIu16" greater than " | |
2254 | "supported maximum value 1023", type); | |
2255 | return EPROTO; | |
2256 | } | |
2257 | ||
2258 | if (payload_ofs) { | |
2259 | *payload_ofs = (uint8_t *) b.data - (uint8_t *) oh; | |
2260 | } | |
2261 | return ofp_mkerr_vendor(vendor, type, code); | |
2262 | } | |
2263 | ||
2264 | void | |
2265 | ofputil_format_error(struct ds *s, int error) | |
2266 | { | |
2267 | if (is_errno(error)) { | |
2268 | ds_put_cstr(s, strerror(error)); | |
2269 | } else { | |
2270 | uint16_t type = get_ofp_err_type(error); | |
2271 | uint16_t code = get_ofp_err_code(error); | |
2272 | const char *type_s = ofp_error_type_to_string(type); | |
2273 | const char *code_s = ofp_error_code_to_string(type, code); | |
2274 | ||
2275 | ds_put_format(s, "type "); | |
2276 | if (type_s) { | |
2277 | ds_put_cstr(s, type_s); | |
2278 | } else { | |
2279 | ds_put_format(s, "%"PRIu16, type); | |
2280 | } | |
2281 | ||
2282 | ds_put_cstr(s, ", code "); | |
2283 | if (code_s) { | |
2284 | ds_put_cstr(s, code_s); | |
2285 | } else { | |
2286 | ds_put_format(s, "%"PRIu16, code); | |
2287 | } | |
2288 | } | |
2289 | } | |
2290 | ||
2291 | char * | |
2292 | ofputil_error_to_string(int error) | |
2293 | { | |
2294 | struct ds s = DS_EMPTY_INITIALIZER; | |
2295 | ofputil_format_error(&s, error); | |
2296 | return ds_steal_cstr(&s); | |
2297 | } | |
2298 | ||
3052b0c5 BP |
2299 | /* Attempts to pull 'actions_len' bytes from the front of 'b'. Returns 0 if |
2300 | * successful, otherwise an OpenFlow error. | |
2301 | * | |
2302 | * If successful, the first action is stored in '*actionsp' and the number of | |
2303 | * "union ofp_action" size elements into '*n_actionsp'. Otherwise NULL and 0 | |
2304 | * are stored, respectively. | |
2305 | * | |
2306 | * This function does not check that the actions are valid (the caller should | |
2307 | * do so, with validate_actions()). The caller is also responsible for making | |
2308 | * sure that 'b->data' is initially aligned appropriately for "union | |
2309 | * ofp_action". */ | |
2310 | int | |
2311 | ofputil_pull_actions(struct ofpbuf *b, unsigned int actions_len, | |
2312 | union ofp_action **actionsp, size_t *n_actionsp) | |
2313 | { | |
69b6be19 | 2314 | if (actions_len % OFP_ACTION_ALIGN != 0) { |
f4350529 BP |
2315 | VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u " |
2316 | "is not a multiple of %d", actions_len, OFP_ACTION_ALIGN); | |
3052b0c5 BP |
2317 | goto error; |
2318 | } | |
2319 | ||
2320 | *actionsp = ofpbuf_try_pull(b, actions_len); | |
2321 | if (*actionsp == NULL) { | |
f4350529 BP |
2322 | VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u " |
2323 | "exceeds remaining message length (%zu)", | |
2324 | actions_len, b->size); | |
3052b0c5 BP |
2325 | goto error; |
2326 | } | |
2327 | ||
69b6be19 | 2328 | *n_actionsp = actions_len / OFP_ACTION_ALIGN; |
3052b0c5 BP |
2329 | return 0; |
2330 | ||
2331 | error: | |
2332 | *actionsp = NULL; | |
2333 | *n_actionsp = 0; | |
2334 | return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN); | |
2335 | } |