2 * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
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.
18 #include "ofp-print.h"
23 #include "byte-order.h"
24 #include "classifier.h"
25 #include "dynamic-string.h"
26 #include "multipath.h"
28 #include "ofp-errors.h"
33 #include "unaligned.h"
34 #include "type-props.h"
37 VLOG_DEFINE_THIS_MODULE(ofp_util);
39 /* Rate limit for OpenFlow message parse errors. These always indicate a bug
40 * in the peer and so there's not much point in showing a lot of them. */
41 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
43 /* Given the wildcard bit count in the least-significant 6 of 'wcbits', returns
44 * an IP netmask with a 1 in each bit that must match and a 0 in each bit that
47 * The bits in 'wcbits' are in the format used in enum ofp_flow_wildcards: 0
48 * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
49 * ..., 32 and higher wildcard the entire field. This is the *opposite* of the
50 * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
53 ofputil_wcbits_to_netmask(int wcbits)
56 return wcbits < 32 ? htonl(~((1u << wcbits) - 1)) : 0;
59 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
60 * that it wildcards. 'netmask' must be a CIDR netmask (see ip_is_cidr()). */
62 ofputil_netmask_to_wcbits(ovs_be32 netmask)
64 assert(ip_is_cidr(netmask));
66 return netmask == htonl(0) ? 32 : __builtin_ctz(ntohl(netmask));
70 for (wcbits = 32; netmask; wcbits--) {
71 netmask &= netmask - 1;
78 /* A list of the FWW_* and OFPFW_ bits that have the same value, meaning, and
80 #define WC_INVARIANT_LIST \
81 WC_INVARIANT_BIT(IN_PORT) \
82 WC_INVARIANT_BIT(DL_SRC) \
83 WC_INVARIANT_BIT(DL_DST) \
84 WC_INVARIANT_BIT(DL_TYPE) \
85 WC_INVARIANT_BIT(NW_PROTO) \
86 WC_INVARIANT_BIT(TP_SRC) \
87 WC_INVARIANT_BIT(TP_DST)
89 /* Verify that all of the invariant bits (as defined on WC_INVARIANT_LIST)
90 * actually have the same names and values. */
91 #define WC_INVARIANT_BIT(NAME) BUILD_ASSERT_DECL(FWW_##NAME == OFPFW_##NAME);
93 #undef WC_INVARIANT_BIT
95 /* WC_INVARIANTS is the invariant bits (as defined on WC_INVARIANT_LIST) all
99 #define WC_INVARIANT_BIT(NAME) | FWW_##NAME
101 #undef WC_INVARIANT_BIT
104 /* Converts the ofp_match in 'match' into a cls_rule in 'rule', with the given
107 * 'flow_format' must either NXFF_OPENFLOW10 or NXFF_TUN_ID_FROM_COOKIE. In
108 * the latter case only, 'flow''s tun_id field will be taken from the high bits
109 * of 'cookie', if 'match''s wildcards do not indicate that tun_id is
112 ofputil_cls_rule_from_match(const struct ofp_match *match,
113 unsigned int priority,
114 enum nx_flow_format flow_format,
115 ovs_be64 cookie, struct cls_rule *rule)
117 struct flow_wildcards *wc = &rule->wc;
121 /* Initialize rule->priority. */
122 ofpfw = ntohl(match->wildcards);
123 ofpfw &= flow_format == NXFF_TUN_ID_FROM_COOKIE ? OVSFW_ALL : OFPFW_ALL;
124 rule->priority = !ofpfw ? UINT16_MAX : priority;
126 /* Initialize most of rule->wc. */
127 flow_wildcards_init_catchall(wc);
128 wc->wildcards = ofpfw & WC_INVARIANTS;
130 /* Wildcard fields that aren't defined by ofp_match or tun_id. */
131 wc->wildcards |= (FWW_ARP_SHA | FWW_ARP_THA | FWW_ND_TARGET);
133 if (ofpfw & OFPFW_NW_TOS) {
134 wc->wildcards |= FWW_NW_TOS;
136 wc->nw_src_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW_NW_SRC_SHIFT);
137 wc->nw_dst_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW_NW_DST_SHIFT);
139 if (flow_format == NXFF_TUN_ID_FROM_COOKIE && !(ofpfw & NXFW_TUN_ID)) {
140 cls_rule_set_tun_id(rule, htonll(ntohll(cookie) >> 32));
143 if (ofpfw & OFPFW_DL_DST) {
144 /* OpenFlow 1.0 OFPFW_DL_DST covers the whole Ethernet destination, but
145 * Open vSwitch breaks the Ethernet destination into bits as FWW_DL_DST
146 * and FWW_ETH_MCAST. */
147 wc->wildcards |= FWW_ETH_MCAST;
150 /* Initialize most of rule->flow. */
151 rule->flow.nw_src = match->nw_src;
152 rule->flow.nw_dst = match->nw_dst;
153 rule->flow.in_port = ntohs(match->in_port);
154 rule->flow.dl_type = ofputil_dl_type_from_openflow(match->dl_type);
155 rule->flow.tp_src = match->tp_src;
156 rule->flow.tp_dst = match->tp_dst;
157 memcpy(rule->flow.dl_src, match->dl_src, ETH_ADDR_LEN);
158 memcpy(rule->flow.dl_dst, match->dl_dst, ETH_ADDR_LEN);
159 rule->flow.nw_tos = match->nw_tos;
160 rule->flow.nw_proto = match->nw_proto;
162 /* Translate VLANs. */
163 vid = match->dl_vlan & htons(VLAN_VID_MASK);
164 pcp = htons((match->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK);
165 switch (ofpfw & (OFPFW_DL_VLAN | OFPFW_DL_VLAN_PCP)) {
166 case OFPFW_DL_VLAN | OFPFW_DL_VLAN_PCP:
167 /* Wildcard everything. */
168 rule->flow.vlan_tci = htons(0);
169 rule->wc.vlan_tci_mask = htons(0);
172 case OFPFW_DL_VLAN_PCP:
173 if (match->dl_vlan == htons(OFP_VLAN_NONE)) {
174 /* Match only packets without 802.1Q header. */
175 rule->flow.vlan_tci = htons(0);
176 rule->wc.vlan_tci_mask = htons(0xffff);
178 /* Wildcard PCP, specific VID. */
179 rule->flow.vlan_tci = vid | htons(VLAN_CFI);
180 rule->wc.vlan_tci_mask = htons(VLAN_VID_MASK | VLAN_CFI);
185 /* Wildcard VID, specific PCP. */
186 rule->flow.vlan_tci = pcp | htons(VLAN_CFI);
187 rule->wc.vlan_tci_mask = htons(VLAN_PCP_MASK | VLAN_CFI);
191 if (match->dl_vlan == htons(OFP_VLAN_NONE)) {
192 /* This case is odd, since we can't have a specific PCP without an
193 * 802.1Q header. However, older versions of OVS treated this as
194 * matching packets withut an 802.1Q header, so we do here too. */
195 rule->flow.vlan_tci = htons(0);
196 rule->wc.vlan_tci_mask = htons(0xffff);
198 /* Specific VID and PCP. */
199 rule->flow.vlan_tci = vid | pcp | htons(VLAN_CFI);
200 rule->wc.vlan_tci_mask = htons(0xffff);
206 cls_rule_zero_wildcarded_fields(rule);
209 /* Convert 'rule' into the OpenFlow match structure 'match'. 'flow_format'
210 * must either NXFF_OPENFLOW10 or NXFF_TUN_ID_FROM_COOKIE.
212 * The NXFF_TUN_ID_FROM_COOKIE flow format requires modifying the flow cookie.
213 * This function can help with that, if 'cookie_out' is nonnull. For
214 * NXFF_OPENFLOW10, or if the tunnel ID is wildcarded, 'cookie_in' will be
215 * copied directly to '*cookie_out'. For NXFF_TUN_ID_FROM_COOKIE when tunnel
216 * ID is matched, 'cookie_in' will be modified appropriately before setting
220 ofputil_cls_rule_to_match(const struct cls_rule *rule,
221 enum nx_flow_format flow_format,
222 struct ofp_match *match,
223 ovs_be64 cookie_in, ovs_be64 *cookie_out)
225 const struct flow_wildcards *wc = &rule->wc;
228 /* Figure out most OpenFlow wildcards. */
229 ofpfw = wc->wildcards & WC_INVARIANTS;
230 ofpfw |= ofputil_netmask_to_wcbits(wc->nw_src_mask) << OFPFW_NW_SRC_SHIFT;
231 ofpfw |= ofputil_netmask_to_wcbits(wc->nw_dst_mask) << OFPFW_NW_DST_SHIFT;
232 if (wc->wildcards & FWW_NW_TOS) {
233 ofpfw |= OFPFW_NW_TOS;
237 if (flow_format == NXFF_TUN_ID_FROM_COOKIE) {
238 if (wc->tun_id_mask == htonll(0)) {
239 ofpfw |= NXFW_TUN_ID;
241 uint32_t cookie_lo = ntohll(cookie_in);
242 uint32_t cookie_hi = ntohll(rule->flow.tun_id);
243 cookie_in = htonll(cookie_lo | ((uint64_t) cookie_hi << 32));
247 *cookie_out = cookie_in;
250 /* Translate VLANs. */
251 match->dl_vlan = htons(0);
252 match->dl_vlan_pcp = 0;
253 if (rule->wc.vlan_tci_mask == htons(0)) {
254 ofpfw |= OFPFW_DL_VLAN | OFPFW_DL_VLAN_PCP;
255 } else if (rule->wc.vlan_tci_mask & htons(VLAN_CFI)
256 && !(rule->flow.vlan_tci & htons(VLAN_CFI))) {
257 match->dl_vlan = htons(OFP_VLAN_NONE);
259 if (!(rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) {
260 ofpfw |= OFPFW_DL_VLAN;
262 match->dl_vlan = htons(vlan_tci_to_vid(rule->flow.vlan_tci));
265 if (!(rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK))) {
266 ofpfw |= OFPFW_DL_VLAN_PCP;
268 match->dl_vlan_pcp = vlan_tci_to_pcp(rule->flow.vlan_tci);
272 /* Compose most of the match structure. */
273 match->wildcards = htonl(ofpfw);
274 match->in_port = htons(rule->flow.in_port);
275 memcpy(match->dl_src, rule->flow.dl_src, ETH_ADDR_LEN);
276 memcpy(match->dl_dst, rule->flow.dl_dst, ETH_ADDR_LEN);
277 match->dl_type = ofputil_dl_type_to_openflow(rule->flow.dl_type);
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);
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. */
291 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type)
293 return (flow_dl_type == htons(FLOW_DL_TYPE_NONE)
294 ? htons(OFP_DL_TYPE_NOT_ETH_TYPE)
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
302 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type)
304 return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
305 ? htons(FLOW_DL_TYPE_NONE)
309 /* Returns a transaction ID to use for an outgoing OpenFlow message. */
313 static uint32_t next_xid = 1;
314 return htonl(next_xid++);
317 /* Basic parsing of OpenFlow messages. */
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;
329 struct ofputil_msg_category {
330 const char *name; /* e.g. "OpenFlow message" */
331 const struct ofputil_msg_type *types;
333 int missing_error; /* ofp_mkerr() value for missing type. */
337 ofputil_length_ok(const struct ofputil_msg_category *cat,
338 const struct ofputil_msg_type *type,
341 switch (type->extra_multiple) {
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);
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);
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);
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)
379 const struct ofputil_msg_type *type;
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);
391 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s of unknown type %"PRIu32,
393 return cat->missing_error;
397 ofputil_decode_vendor(const struct ofp_header *oh,
398 const struct ofputil_msg_type **typep)
400 static const struct ofputil_msg_type nxt_messages[] = {
401 { OFPUTIL_NXT_TUN_ID_FROM_COOKIE,
402 NXT_TUN_ID_FROM_COOKIE, "NXT_TUN_ID_FROM_COOKIE",
403 sizeof(struct nxt_tun_id_cookie), 0 },
405 { OFPUTIL_NXT_ROLE_REQUEST,
406 NXT_ROLE_REQUEST, "NXT_ROLE_REQUEST",
407 sizeof(struct nx_role_request), 0 },
409 { OFPUTIL_NXT_ROLE_REPLY,
410 NXT_ROLE_REPLY, "NXT_ROLE_REPLY",
411 sizeof(struct nx_role_request), 0 },
413 { OFPUTIL_NXT_SET_FLOW_FORMAT,
414 NXT_SET_FLOW_FORMAT, "NXT_SET_FLOW_FORMAT",
415 sizeof(struct nxt_set_flow_format), 0 },
417 { OFPUTIL_NXT_FLOW_MOD,
418 NXT_FLOW_MOD, "NXT_FLOW_MOD",
419 sizeof(struct nx_flow_mod), 8 },
421 { OFPUTIL_NXT_FLOW_REMOVED,
422 NXT_FLOW_REMOVED, "NXT_FLOW_REMOVED",
423 sizeof(struct nx_flow_removed), 8 },
426 static const struct ofputil_msg_category nxt_category = {
427 "Nicira extension message",
428 nxt_messages, ARRAY_SIZE(nxt_messages),
429 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE)
432 const struct ofp_vendor_header *ovh;
433 const struct nicira_header *nh;
435 ovh = (const struct ofp_vendor_header *) oh;
436 if (ovh->vendor != htonl(NX_VENDOR_ID)) {
437 VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor message for unknown "
438 "vendor %"PRIx32, ntohl(ovh->vendor));
439 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
442 if (ntohs(ovh->header.length) < sizeof(struct nicira_header)) {
443 VLOG_WARN_RL(&bad_ofmsg_rl, "received Nicira vendor message of "
444 "length %u (expected at least %zu)",
445 ntohs(ovh->header.length), sizeof(struct nicira_header));
446 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
449 nh = (const struct nicira_header *) oh;
450 return ofputil_lookup_openflow_message(&nxt_category, ntohl(nh->subtype),
451 ntohs(oh->length), typep);
455 check_nxstats_msg(const struct ofp_header *oh)
457 const struct ofp_stats_request *osr;
460 osr = (const struct ofp_stats_request *) oh;
462 memcpy(&vendor, osr->body, sizeof vendor);
463 if (vendor != htonl(NX_VENDOR_ID)) {
464 VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor stats message for "
465 "unknown vendor %"PRIx32, ntohl(vendor));
466 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
469 if (ntohs(osr->header.length) < sizeof(struct nicira_stats_msg)) {
470 VLOG_WARN_RL(&bad_ofmsg_rl, "truncated Nicira stats message");
471 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
478 ofputil_decode_nxst_request(const struct ofp_header *oh,
479 const struct ofputil_msg_type **typep)
481 static const struct ofputil_msg_type nxst_requests[] = {
482 { OFPUTIL_NXST_FLOW_REQUEST,
483 NXST_FLOW, "NXST_FLOW request",
484 sizeof(struct nx_flow_stats_request), 8 },
486 { OFPUTIL_NXST_AGGREGATE_REQUEST,
487 NXST_AGGREGATE, "NXST_AGGREGATE request",
488 sizeof(struct nx_aggregate_stats_request), 8 },
491 static const struct ofputil_msg_category nxst_request_category = {
492 "Nicira extension statistics request",
493 nxst_requests, ARRAY_SIZE(nxst_requests),
494 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE)
497 const struct nicira_stats_msg *nsm;
500 error = check_nxstats_msg(oh);
505 nsm = (struct nicira_stats_msg *) oh;
506 return ofputil_lookup_openflow_message(&nxst_request_category,
508 ntohs(oh->length), typep);
512 ofputil_decode_nxst_reply(const struct ofp_header *oh,
513 const struct ofputil_msg_type **typep)
515 static const struct ofputil_msg_type nxst_replies[] = {
516 { OFPUTIL_NXST_FLOW_REPLY,
517 NXST_FLOW, "NXST_FLOW reply",
518 sizeof(struct nicira_stats_msg), 8 },
520 { OFPUTIL_NXST_AGGREGATE_REPLY,
521 NXST_AGGREGATE, "NXST_AGGREGATE reply",
522 sizeof(struct nx_aggregate_stats_reply), 0 },
525 static const struct ofputil_msg_category nxst_reply_category = {
526 "Nicira extension statistics reply",
527 nxst_replies, ARRAY_SIZE(nxst_replies),
528 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE)
531 const struct nicira_stats_msg *nsm;
534 error = check_nxstats_msg(oh);
539 nsm = (struct nicira_stats_msg *) oh;
540 return ofputil_lookup_openflow_message(&nxst_reply_category,
542 ntohs(oh->length), typep);
546 ofputil_decode_ofpst_request(const struct ofp_header *oh,
547 const struct ofputil_msg_type **typep)
549 enum { OSR_SIZE = sizeof(struct ofp_stats_request) };
550 static const struct ofputil_msg_type ofpst_requests[] = {
551 { OFPUTIL_OFPST_DESC_REQUEST,
552 OFPST_DESC, "OFPST_DESC request",
555 { OFPUTIL_OFPST_FLOW_REQUEST,
556 OFPST_FLOW, "OFPST_FLOW request",
557 OSR_SIZE + sizeof(struct ofp_flow_stats_request), 0 },
559 { OFPUTIL_OFPST_AGGREGATE_REQUEST,
560 OFPST_AGGREGATE, "OFPST_AGGREGATE request",
561 OSR_SIZE + sizeof(struct ofp_aggregate_stats_request), 0 },
563 { OFPUTIL_OFPST_TABLE_REQUEST,
564 OFPST_TABLE, "OFPST_TABLE request",
567 { OFPUTIL_OFPST_PORT_REQUEST,
568 OFPST_PORT, "OFPST_PORT request",
569 OSR_SIZE + sizeof(struct ofp_port_stats_request), 0 },
571 { OFPUTIL_OFPST_QUEUE_REQUEST,
572 OFPST_QUEUE, "OFPST_QUEUE request",
573 OSR_SIZE + sizeof(struct ofp_queue_stats_request), 0 },
576 OFPST_VENDOR, "OFPST_VENDOR request",
577 OSR_SIZE + sizeof(uint32_t), 1 },
580 static const struct ofputil_msg_category ofpst_request_category = {
581 "OpenFlow statistics",
582 ofpst_requests, ARRAY_SIZE(ofpst_requests),
583 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT)
586 const struct ofp_stats_request *osr;
589 osr = (const struct ofp_stats_request *) oh;
590 error = ofputil_lookup_openflow_message(&ofpst_request_category,
592 ntohs(oh->length), typep);
593 if (!error && osr->type == htons(OFPST_VENDOR)) {
594 error = ofputil_decode_nxst_request(oh, typep);
600 ofputil_decode_ofpst_reply(const struct ofp_header *oh,
601 const struct ofputil_msg_type **typep)
603 enum { OSR_SIZE = sizeof(struct ofp_stats_reply) };
604 static const struct ofputil_msg_type ofpst_replies[] = {
605 { OFPUTIL_OFPST_DESC_REPLY,
606 OFPST_DESC, "OFPST_DESC reply",
607 OSR_SIZE + sizeof(struct ofp_desc_stats), 0 },
609 { OFPUTIL_OFPST_FLOW_REPLY,
610 OFPST_FLOW, "OFPST_FLOW reply",
613 { OFPUTIL_OFPST_AGGREGATE_REPLY,
614 OFPST_AGGREGATE, "OFPST_AGGREGATE reply",
615 OSR_SIZE + sizeof(struct ofp_aggregate_stats_reply), 0 },
617 { OFPUTIL_OFPST_TABLE_REPLY,
618 OFPST_TABLE, "OFPST_TABLE reply",
619 OSR_SIZE, sizeof(struct ofp_table_stats) },
621 { OFPUTIL_OFPST_PORT_REPLY,
622 OFPST_PORT, "OFPST_PORT reply",
623 OSR_SIZE, sizeof(struct ofp_port_stats) },
625 { OFPUTIL_OFPST_QUEUE_REPLY,
626 OFPST_QUEUE, "OFPST_QUEUE reply",
627 OSR_SIZE, sizeof(struct ofp_queue_stats) },
630 OFPST_VENDOR, "OFPST_VENDOR reply",
631 OSR_SIZE + sizeof(uint32_t), 1 },
634 static const struct ofputil_msg_category ofpst_reply_category = {
635 "OpenFlow statistics",
636 ofpst_replies, ARRAY_SIZE(ofpst_replies),
637 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT)
640 const struct ofp_stats_reply *osr = (const struct ofp_stats_reply *) oh;
643 error = ofputil_lookup_openflow_message(&ofpst_reply_category,
645 ntohs(oh->length), typep);
646 if (!error && osr->type == htons(OFPST_VENDOR)) {
647 error = ofputil_decode_nxst_reply(oh, typep);
652 /* Decodes the message type represented by 'oh'. Returns 0 if successful or
653 * an OpenFlow error code constructed with ofp_mkerr() on failure. Either
654 * way, stores in '*typep' a type structure that can be inspected with the
655 * ofputil_msg_type_*() functions.
657 * oh->length must indicate the correct length of the message (and must be at
658 * least sizeof(struct ofp_header)).
660 * Success indicates that 'oh' is at least as long as the minimum-length
661 * message of its type. */
663 ofputil_decode_msg_type(const struct ofp_header *oh,
664 const struct ofputil_msg_type **typep)
666 static const struct ofputil_msg_type ofpt_messages[] = {
667 { OFPUTIL_OFPT_HELLO,
668 OFPT_HELLO, "OFPT_HELLO",
669 sizeof(struct ofp_hello), 1 },
671 { OFPUTIL_OFPT_ERROR,
672 OFPT_ERROR, "OFPT_ERROR",
673 sizeof(struct ofp_error_msg), 1 },
675 { OFPUTIL_OFPT_ECHO_REQUEST,
676 OFPT_ECHO_REQUEST, "OFPT_ECHO_REQUEST",
677 sizeof(struct ofp_header), 1 },
679 { OFPUTIL_OFPT_ECHO_REPLY,
680 OFPT_ECHO_REPLY, "OFPT_ECHO_REPLY",
681 sizeof(struct ofp_header), 1 },
683 { OFPUTIL_OFPT_FEATURES_REQUEST,
684 OFPT_FEATURES_REQUEST, "OFPT_FEATURES_REQUEST",
685 sizeof(struct ofp_header), 0 },
687 { OFPUTIL_OFPT_FEATURES_REPLY,
688 OFPT_FEATURES_REPLY, "OFPT_FEATURES_REPLY",
689 sizeof(struct ofp_switch_features), sizeof(struct ofp_phy_port) },
691 { OFPUTIL_OFPT_GET_CONFIG_REQUEST,
692 OFPT_GET_CONFIG_REQUEST, "OFPT_GET_CONFIG_REQUEST",
693 sizeof(struct ofp_header), 0 },
695 { OFPUTIL_OFPT_GET_CONFIG_REPLY,
696 OFPT_GET_CONFIG_REPLY, "OFPT_GET_CONFIG_REPLY",
697 sizeof(struct ofp_switch_config), 0 },
699 { OFPUTIL_OFPT_SET_CONFIG,
700 OFPT_SET_CONFIG, "OFPT_SET_CONFIG",
701 sizeof(struct ofp_switch_config), 0 },
703 { OFPUTIL_OFPT_PACKET_IN,
704 OFPT_PACKET_IN, "OFPT_PACKET_IN",
705 offsetof(struct ofp_packet_in, data), 1 },
707 { OFPUTIL_OFPT_FLOW_REMOVED,
708 OFPT_FLOW_REMOVED, "OFPT_FLOW_REMOVED",
709 sizeof(struct ofp_flow_removed), 0 },
711 { OFPUTIL_OFPT_PORT_STATUS,
712 OFPT_PORT_STATUS, "OFPT_PORT_STATUS",
713 sizeof(struct ofp_port_status), 0 },
715 { OFPUTIL_OFPT_PACKET_OUT,
716 OFPT_PACKET_OUT, "OFPT_PACKET_OUT",
717 sizeof(struct ofp_packet_out), 1 },
719 { OFPUTIL_OFPT_FLOW_MOD,
720 OFPT_FLOW_MOD, "OFPT_FLOW_MOD",
721 sizeof(struct ofp_flow_mod), 1 },
723 { OFPUTIL_OFPT_PORT_MOD,
724 OFPT_PORT_MOD, "OFPT_PORT_MOD",
725 sizeof(struct ofp_port_mod), 0 },
728 OFPT_STATS_REQUEST, "OFPT_STATS_REQUEST",
729 sizeof(struct ofp_stats_request), 1 },
732 OFPT_STATS_REPLY, "OFPT_STATS_REPLY",
733 sizeof(struct ofp_stats_reply), 1 },
735 { OFPUTIL_OFPT_BARRIER_REQUEST,
736 OFPT_BARRIER_REQUEST, "OFPT_BARRIER_REQUEST",
737 sizeof(struct ofp_header), 0 },
739 { OFPUTIL_OFPT_BARRIER_REPLY,
740 OFPT_BARRIER_REPLY, "OFPT_BARRIER_REPLY",
741 sizeof(struct ofp_header), 0 },
744 OFPT_VENDOR, "OFPT_VENDOR",
745 sizeof(struct ofp_vendor_header), 1 },
748 static const struct ofputil_msg_category ofpt_category = {
750 ofpt_messages, ARRAY_SIZE(ofpt_messages),
751 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE)
756 error = ofputil_lookup_openflow_message(&ofpt_category, oh->type,
757 ntohs(oh->length), typep);
761 error = ofputil_decode_vendor(oh, typep);
764 case OFPT_STATS_REQUEST:
765 error = ofputil_decode_ofpst_request(oh, typep);
768 case OFPT_STATS_REPLY:
769 error = ofputil_decode_ofpst_reply(oh, typep);
776 static const struct ofputil_msg_type ofputil_invalid_type = {
778 0, "OFPUTIL_INVALID",
782 *typep = &ofputil_invalid_type;
787 /* Returns an OFPUTIL_* message type code for 'type'. */
788 enum ofputil_msg_code
789 ofputil_msg_type_code(const struct ofputil_msg_type *type)
797 ofputil_flow_format_is_valid(enum nx_flow_format flow_format)
799 switch (flow_format) {
800 case NXFF_OPENFLOW10:
801 case NXFF_TUN_ID_FROM_COOKIE:
810 ofputil_flow_format_to_string(enum nx_flow_format flow_format)
812 switch (flow_format) {
813 case NXFF_OPENFLOW10:
815 case NXFF_TUN_ID_FROM_COOKIE:
816 return "tun_id_from_cookie";
825 ofputil_flow_format_from_string(const char *s)
827 return (!strcmp(s, "openflow10") ? NXFF_OPENFLOW10
828 : !strcmp(s, "tun_id_from_cookie") ? NXFF_TUN_ID_FROM_COOKIE
829 : !strcmp(s, "nxm") ? NXFF_NXM
834 regs_fully_wildcarded(const struct flow_wildcards *wc)
838 for (i = 0; i < FLOW_N_REGS; i++) {
839 if (wc->reg_masks[i] != 0) {
847 is_nxm_required(const struct cls_rule *rule, bool cookie_support,
850 const struct flow_wildcards *wc = &rule->wc;
854 /* Only NXM supports separately wildcards the Ethernet multicast bit. */
855 if (!(wc->wildcards & FWW_DL_DST) != !(wc->wildcards & FWW_ETH_MCAST)) {
859 /* Only NXM supports matching ARP hardware addresses. */
860 if (!(wc->wildcards & FWW_ARP_SHA) || !(wc->wildcards & FWW_ARP_THA)) {
864 /* Only NXM supports matching IPv6 traffic. */
865 if (!(wc->wildcards & FWW_DL_TYPE)
866 && (rule->flow.dl_type == htons(ETH_TYPE_IPV6))) {
870 /* Only NXM supports matching registers. */
871 if (!regs_fully_wildcarded(wc)) {
875 switch (wc->tun_id_mask) {
876 case CONSTANT_HTONLL(0):
877 /* Other formats can fully wildcard tun_id. */
880 case CONSTANT_HTONLL(UINT64_MAX):
881 /* Only NXM supports tunnel ID matching without a cookie. */
882 if (!cookie_support) {
886 /* Only NXM supports 64-bit tunnel IDs. */
887 tun_id = ntohll(rule->flow.tun_id);
888 if (tun_id > UINT32_MAX) {
892 /* Only NXM supports a cookie whose top 32 bits conflict with the
894 cookie_hi = ntohll(cookie) >> 32;
895 if (cookie_hi && cookie_hi != tun_id) {
901 /* Only NXM supports partial matches on tunnel ID. */
905 /* Other formats can express this rule. */
909 /* Returns the minimum nx_flow_format to use for sending 'rule' to a switch
910 * (e.g. to add or remove a flow). 'cookie_support' should be true if the
911 * command to be sent includes a flow cookie (as OFPT_FLOW_MOD does, for
912 * example) or false if the command does not (OFPST_FLOW and OFPST_AGGREGATE do
913 * not, for example). If 'cookie_support' is true, then 'cookie' should be the
914 * cookie to be sent; otherwise its value is ignored.
916 * The "best" flow format is chosen on this basis:
918 * - It must be capable of expressing the rule. NXFF_OPENFLOW10 flows can't
919 * handle tunnel IDs. NXFF_TUN_ID_FROM_COOKIE flows can't handle registers
920 * or fixing the Ethernet multicast bit, and can't handle tunnel IDs that
921 * conflict with the high 32 bits of the cookie or commands that don't
924 * - Otherwise, the chosen format should be as backward compatible as
925 * possible. (NXFF_OPENFLOW10 is more backward compatible than
926 * NXFF_TUN_ID_FROM_COOKIE, which is more backward compatible than
930 ofputil_min_flow_format(const struct cls_rule *rule, bool cookie_support,
933 if (is_nxm_required(rule, cookie_support, cookie)) {
935 } else if (rule->wc.tun_id_mask != htonll(0)) {
936 return NXFF_TUN_ID_FROM_COOKIE;
938 return NXFF_OPENFLOW10;
942 /* Returns an OpenFlow message that can be used to set the flow format to
945 ofputil_make_set_flow_format(enum nx_flow_format flow_format)
949 if (flow_format == NXFF_OPENFLOW10
950 || flow_format == NXFF_TUN_ID_FROM_COOKIE) {
951 struct nxt_tun_id_cookie *tic;
953 tic = make_nxmsg(sizeof *tic, NXT_TUN_ID_FROM_COOKIE, &msg);
954 tic->set = flow_format == NXFF_TUN_ID_FROM_COOKIE;
956 struct nxt_set_flow_format *sff;
958 sff = make_nxmsg(sizeof *sff, NXT_SET_FLOW_FORMAT, &msg);
959 sff->format = htonl(flow_format);
965 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
966 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
969 * For OFPT_FLOW_MOD messages, 'flow_format' should be the current flow format
970 * at the time when the message was received. Otherwise 'flow_format' is
973 * Does not validate the flow_mod actions. */
975 ofputil_decode_flow_mod(struct flow_mod *fm, const struct ofp_header *oh,
976 enum nx_flow_format flow_format)
978 const struct ofputil_msg_type *type;
981 ofpbuf_use_const(&b, oh, ntohs(oh->length));
983 ofputil_decode_msg_type(oh, &type);
984 if (ofputil_msg_type_code(type) == OFPUTIL_OFPT_FLOW_MOD) {
985 /* Standard OpenFlow flow_mod. */
986 struct ofp_match match, orig_match;
987 const struct ofp_flow_mod *ofm;
990 /* Dissect the message. */
991 ofm = ofpbuf_pull(&b, sizeof *ofm);
992 error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
997 /* Normalize ofm->match. If normalization actually changes anything,
998 * then log the differences. */
1000 match.pad1[0] = match.pad2[0] = 0;
1002 normalize_match(&match);
1003 if (memcmp(&match, &orig_match, sizeof orig_match)) {
1004 if (!VLOG_DROP_INFO(&bad_ofmsg_rl)) {
1005 char *old = ofp_match_to_literal_string(&orig_match);
1006 char *new = ofp_match_to_literal_string(&match);
1007 VLOG_INFO("normalization changed ofp_match, details:");
1008 VLOG_INFO(" pre: %s", old);
1009 VLOG_INFO("post: %s", new);
1015 /* Translate the message. */
1016 ofputil_cls_rule_from_match(&match, ntohs(ofm->priority), flow_format,
1017 ofm->cookie, &fm->cr);
1018 fm->cookie = ofm->cookie;
1019 fm->command = ntohs(ofm->command);
1020 fm->idle_timeout = ntohs(ofm->idle_timeout);
1021 fm->hard_timeout = ntohs(ofm->hard_timeout);
1022 fm->buffer_id = ntohl(ofm->buffer_id);
1023 fm->out_port = ntohs(ofm->out_port);
1024 fm->flags = ntohs(ofm->flags);
1025 } else if (ofputil_msg_type_code(type) == OFPUTIL_NXT_FLOW_MOD) {
1026 /* Nicira extended flow_mod. */
1027 const struct nx_flow_mod *nfm;
1030 /* Dissect the message. */
1031 nfm = ofpbuf_pull(&b, sizeof *nfm);
1032 error = nx_pull_match(&b, ntohs(nfm->match_len), ntohs(nfm->priority),
1037 error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
1042 /* Translate the message. */
1043 fm->cookie = nfm->cookie;
1044 fm->command = ntohs(nfm->command);
1045 fm->idle_timeout = ntohs(nfm->idle_timeout);
1046 fm->hard_timeout = ntohs(nfm->hard_timeout);
1047 fm->buffer_id = ntohl(nfm->buffer_id);
1048 fm->out_port = ntohs(nfm->out_port);
1049 fm->flags = ntohs(nfm->flags);
1057 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
1058 * 'flow_format' and returns the message. */
1060 ofputil_encode_flow_mod(const struct flow_mod *fm,
1061 enum nx_flow_format flow_format)
1063 size_t actions_len = fm->n_actions * sizeof *fm->actions;
1066 if (flow_format == NXFF_OPENFLOW10
1067 || flow_format == NXFF_TUN_ID_FROM_COOKIE) {
1068 struct ofp_flow_mod *ofm;
1070 msg = ofpbuf_new(sizeof *ofm + actions_len);
1071 ofm = put_openflow(sizeof *ofm, OFPT_FLOW_MOD, msg);
1072 ofputil_cls_rule_to_match(&fm->cr, flow_format, &ofm->match,
1073 fm->cookie, &ofm->cookie);
1074 ofm->command = htons(fm->command);
1075 ofm->idle_timeout = htons(fm->idle_timeout);
1076 ofm->hard_timeout = htons(fm->hard_timeout);
1077 ofm->priority = htons(fm->cr.priority);
1078 ofm->buffer_id = htonl(fm->buffer_id);
1079 ofm->out_port = htons(fm->out_port);
1080 ofm->flags = htons(fm->flags);
1081 } else if (flow_format == NXFF_NXM) {
1082 struct nx_flow_mod *nfm;
1085 msg = ofpbuf_new(sizeof *nfm + NXM_TYPICAL_LEN + actions_len);
1086 put_nxmsg(sizeof *nfm, NXT_FLOW_MOD, msg);
1087 match_len = nx_put_match(msg, &fm->cr);
1090 nfm->cookie = fm->cookie;
1091 nfm->command = htons(fm->command);
1092 nfm->idle_timeout = htons(fm->idle_timeout);
1093 nfm->hard_timeout = htons(fm->hard_timeout);
1094 nfm->priority = htons(fm->cr.priority);
1095 nfm->buffer_id = htonl(fm->buffer_id);
1096 nfm->out_port = htons(fm->out_port);
1097 nfm->flags = htons(fm->flags);
1098 nfm->match_len = htons(match_len);
1103 ofpbuf_put(msg, fm->actions, actions_len);
1104 update_openflow_length(msg);
1109 ofputil_decode_ofpst_flow_request(struct flow_stats_request *fsr,
1110 const struct ofp_header *oh,
1111 enum nx_flow_format flow_format,
1114 const struct ofp_flow_stats_request *ofsr = ofputil_stats_body(oh);
1116 fsr->aggregate = aggregate;
1117 ofputil_cls_rule_from_match(&ofsr->match, 0, flow_format, 0, &fsr->match);
1118 fsr->out_port = ntohs(ofsr->out_port);
1119 fsr->table_id = ofsr->table_id;
1125 ofputil_decode_nxst_flow_request(struct flow_stats_request *fsr,
1126 const struct ofp_header *oh,
1129 const struct nx_flow_stats_request *nfsr;
1133 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1135 nfsr = ofpbuf_pull(&b, sizeof *nfsr);
1136 error = nx_pull_match(&b, ntohs(nfsr->match_len), 0, &fsr->match);
1141 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
1144 fsr->aggregate = aggregate;
1145 fsr->out_port = ntohs(nfsr->out_port);
1146 fsr->table_id = nfsr->table_id;
1151 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
1152 * request 'oh', received when the current flow format was 'flow_format', into
1153 * an abstract flow_stats_request in 'fsr'. Returns 0 if successful, otherwise
1154 * an OpenFlow error code.
1156 * For OFPST_FLOW and OFPST_AGGREGATE messages, 'flow_format' should be the
1157 * current flow format at the time when the message was received. Otherwise
1158 * 'flow_format' is ignored. */
1160 ofputil_decode_flow_stats_request(struct flow_stats_request *fsr,
1161 const struct ofp_header *oh,
1162 enum nx_flow_format flow_format)
1164 const struct ofputil_msg_type *type;
1168 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1170 ofputil_decode_msg_type(oh, &type);
1171 code = ofputil_msg_type_code(type);
1173 case OFPUTIL_OFPST_FLOW_REQUEST:
1174 return ofputil_decode_ofpst_flow_request(fsr, oh, flow_format, false);
1176 case OFPUTIL_OFPST_AGGREGATE_REQUEST:
1177 return ofputil_decode_ofpst_flow_request(fsr, oh, flow_format, true);
1179 case OFPUTIL_NXST_FLOW_REQUEST:
1180 return ofputil_decode_nxst_flow_request(fsr, oh, false);
1182 case OFPUTIL_NXST_AGGREGATE_REQUEST:
1183 return ofputil_decode_nxst_flow_request(fsr, oh, true);
1186 /* Hey, the caller lied. */
1191 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
1192 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
1193 * 'flow_format', and returns the message. */
1195 ofputil_encode_flow_stats_request(const struct flow_stats_request *fsr,
1196 enum nx_flow_format flow_format)
1200 if (flow_format == NXFF_OPENFLOW10
1201 || flow_format == NXFF_TUN_ID_FROM_COOKIE) {
1202 struct ofp_flow_stats_request *ofsr;
1205 BUILD_ASSERT_DECL(sizeof(struct ofp_flow_stats_request)
1206 == sizeof(struct ofp_aggregate_stats_request));
1208 type = fsr->aggregate ? OFPST_AGGREGATE : OFPST_FLOW;
1209 ofsr = ofputil_make_stats_request(sizeof *ofsr, type, &msg);
1210 ofputil_cls_rule_to_match(&fsr->match, flow_format, &ofsr->match,
1212 ofsr->table_id = fsr->table_id;
1213 ofsr->out_port = htons(fsr->out_port);
1214 } else if (flow_format == NXFF_NXM) {
1215 struct nx_flow_stats_request *nfsr;
1219 subtype = fsr->aggregate ? NXST_AGGREGATE : NXST_FLOW;
1220 ofputil_make_nxstats_request(sizeof *nfsr, subtype, &msg);
1221 match_len = nx_put_match(msg, &fsr->match);
1224 nfsr->out_port = htons(fsr->out_port);
1225 nfsr->match_len = htons(match_len);
1226 nfsr->table_id = fsr->table_id;
1234 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
1235 * ofputil_flow_stats in 'fs'. For OFPST_FLOW messages, 'flow_format' should
1236 * be the current flow format at the time when the request corresponding to the
1237 * reply in 'msg' was sent. Otherwise 'flow_format' is ignored.
1239 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
1240 * OpenFlow message. Calling this function multiple times for a single 'msg'
1241 * iterates through the replies. The caller must initially leave 'msg''s layer
1242 * pointers null and not modify them between calls.
1244 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1245 * otherwise a positive errno value. */
1247 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
1249 enum nx_flow_format flow_format)
1251 const struct ofputil_msg_type *type;
1254 ofputil_decode_msg_type(msg->l2 ? msg->l2 : msg->data, &type);
1255 code = ofputil_msg_type_code(type);
1257 msg->l2 = msg->data;
1258 if (code == OFPUTIL_OFPST_FLOW_REPLY) {
1259 ofpbuf_pull(msg, sizeof(struct ofp_stats_reply));
1260 } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
1261 ofpbuf_pull(msg, sizeof(struct nicira_stats_msg));
1269 } else if (code == OFPUTIL_OFPST_FLOW_REPLY) {
1270 const struct ofp_flow_stats *ofs;
1273 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
1275 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
1276 "bytes at end", msg->size);
1280 length = ntohs(ofs->length);
1281 if (length < sizeof *ofs) {
1282 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
1283 "length %zu", length);
1287 if (ofputil_pull_actions(msg, length - sizeof *ofs,
1288 &fs->actions, &fs->n_actions)) {
1292 fs->cookie = get_32aligned_be64(&ofs->cookie);
1293 ofputil_cls_rule_from_match(&ofs->match, ntohs(ofs->priority),
1294 flow_format, fs->cookie, &fs->rule);
1295 fs->table_id = ofs->table_id;
1296 fs->duration_sec = ntohl(ofs->duration_sec);
1297 fs->duration_nsec = ntohl(ofs->duration_nsec);
1298 fs->idle_timeout = ntohs(ofs->idle_timeout);
1299 fs->hard_timeout = ntohs(ofs->hard_timeout);
1300 fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
1301 fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
1302 } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
1303 const struct nx_flow_stats *nfs;
1304 size_t match_len, length;
1306 nfs = ofpbuf_try_pull(msg, sizeof *nfs);
1308 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
1309 "bytes at end", msg->size);
1313 length = ntohs(nfs->length);
1314 match_len = ntohs(nfs->match_len);
1315 if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
1316 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
1317 "claims invalid length %zu", match_len, length);
1320 if (nx_pull_match(msg, match_len, ntohs(nfs->priority), &fs->rule)) {
1324 if (ofputil_pull_actions(msg,
1325 length - sizeof *nfs - ROUND_UP(match_len, 8),
1326 &fs->actions, &fs->n_actions)) {
1330 fs->cookie = nfs->cookie;
1331 fs->table_id = nfs->table_id;
1332 fs->duration_sec = ntohl(nfs->duration_sec);
1333 fs->duration_nsec = ntohl(nfs->duration_nsec);
1334 fs->idle_timeout = ntohs(nfs->idle_timeout);
1335 fs->hard_timeout = ntohs(nfs->hard_timeout);
1336 fs->packet_count = ntohll(nfs->packet_count);
1337 fs->byte_count = ntohll(nfs->byte_count);
1345 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh', received
1346 * when the current flow format was 'flow_format', into an abstract
1347 * ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise an
1348 * OpenFlow error code.
1350 * For OFPT_FLOW_REMOVED messages, 'flow_format' should be the current flow
1351 * format at the time when the message was received. Otherwise 'flow_format'
1354 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
1355 const struct ofp_header *oh,
1356 enum nx_flow_format flow_format)
1358 const struct ofputil_msg_type *type;
1359 enum ofputil_msg_code code;
1361 ofputil_decode_msg_type(oh, &type);
1362 code = ofputil_msg_type_code(type);
1363 if (code == OFPUTIL_OFPT_FLOW_REMOVED) {
1364 const struct ofp_flow_removed *ofr;
1366 ofr = (const struct ofp_flow_removed *) oh;
1367 ofputil_cls_rule_from_match(&ofr->match, ntohs(ofr->priority),
1368 flow_format, ofr->cookie, &fr->rule);
1369 fr->cookie = ofr->cookie;
1370 fr->reason = ofr->reason;
1371 fr->duration_sec = ntohl(ofr->duration_sec);
1372 fr->duration_nsec = ntohl(ofr->duration_nsec);
1373 fr->idle_timeout = ntohs(ofr->idle_timeout);
1374 fr->packet_count = ntohll(ofr->packet_count);
1375 fr->byte_count = ntohll(ofr->byte_count);
1376 } else if (code == OFPUTIL_NXT_FLOW_REMOVED) {
1377 struct nx_flow_removed *nfr;
1381 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1383 nfr = ofpbuf_pull(&b, sizeof *nfr);
1384 error = nx_pull_match(&b, ntohs(nfr->match_len), ntohs(nfr->priority),
1390 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
1393 fr->cookie = nfr->cookie;
1394 fr->reason = nfr->reason;
1395 fr->duration_sec = ntohl(nfr->duration_sec);
1396 fr->duration_nsec = ntohl(nfr->duration_nsec);
1397 fr->idle_timeout = ntohs(nfr->idle_timeout);
1398 fr->packet_count = ntohll(nfr->packet_count);
1399 fr->byte_count = ntohll(nfr->byte_count);
1407 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
1408 * NXT_FLOW_REMOVED message 'oh' according to 'flow_format', and returns the
1411 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
1412 enum nx_flow_format flow_format)
1416 if (flow_format == NXFF_OPENFLOW10
1417 || flow_format == NXFF_TUN_ID_FROM_COOKIE) {
1418 struct ofp_flow_removed *ofr;
1420 ofr = make_openflow_xid(sizeof *ofr, OFPT_FLOW_REMOVED, htonl(0),
1422 ofputil_cls_rule_to_match(&fr->rule, flow_format, &ofr->match,
1423 fr->cookie, &ofr->cookie);
1424 ofr->priority = htons(fr->rule.priority);
1425 ofr->reason = fr->reason;
1426 ofr->duration_sec = htonl(fr->duration_sec);
1427 ofr->duration_nsec = htonl(fr->duration_nsec);
1428 ofr->idle_timeout = htons(fr->idle_timeout);
1429 ofr->packet_count = htonll(fr->packet_count);
1430 ofr->byte_count = htonll(fr->byte_count);
1431 } else if (flow_format == NXFF_NXM) {
1432 struct nx_flow_removed *nfr;
1435 make_nxmsg_xid(sizeof *nfr, NXT_FLOW_REMOVED, htonl(0), &msg);
1436 match_len = nx_put_match(msg, &fr->rule);
1439 nfr->cookie = fr->cookie;
1440 nfr->priority = htons(fr->rule.priority);
1441 nfr->reason = fr->reason;
1442 nfr->duration_sec = htonl(fr->duration_sec);
1443 nfr->duration_nsec = htonl(fr->duration_nsec);
1444 nfr->idle_timeout = htons(fr->idle_timeout);
1445 nfr->match_len = htons(match_len);
1446 nfr->packet_count = htonll(fr->packet_count);
1447 nfr->byte_count = htonll(fr->byte_count);
1455 /* Converts abstract ofputil_packet_in 'pin' into an OFPT_PACKET_IN message
1456 * and returns the message.
1458 * If 'rw_packet' is NULL, the caller takes ownership of the newly allocated
1461 * If 'rw_packet' is nonnull, then it must contain the same data as
1462 * pin->packet. 'rw_packet' is allowed to be the same ofpbuf as pin->packet.
1463 * It is modified in-place into an OFPT_PACKET_IN message according to 'pin',
1464 * and then ofputil_encode_packet_in() returns 'rw_packet'. If 'rw_packet' has
1465 * enough headroom to insert a "struct ofp_packet_in", this is more efficient
1466 * than ofputil_encode_packet_in() because it does not copy the packet
1469 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
1470 struct ofpbuf *rw_packet)
1472 int total_len = pin->packet->size;
1473 struct ofp_packet_in *opi;
1476 if (pin->send_len < rw_packet->size) {
1477 rw_packet->size = pin->send_len;
1480 rw_packet = ofpbuf_clone_data_with_headroom(
1481 pin->packet->data, MIN(pin->send_len, pin->packet->size),
1482 offsetof(struct ofp_packet_in, data));
1485 /* Add OFPT_PACKET_IN. */
1486 opi = ofpbuf_push_zeros(rw_packet, offsetof(struct ofp_packet_in, data));
1487 opi->header.version = OFP_VERSION;
1488 opi->header.type = OFPT_PACKET_IN;
1489 opi->total_len = htons(total_len);
1490 opi->in_port = htons(pin->in_port);
1491 opi->reason = pin->reason;
1492 opi->buffer_id = htonl(pin->buffer_id);
1493 update_openflow_length(rw_packet);
1498 /* Returns a string representing the message type of 'type'. The string is the
1499 * enumeration constant for the type, e.g. "OFPT_HELLO". For statistics
1500 * messages, the constant is followed by "request" or "reply",
1501 * e.g. "OFPST_AGGREGATE reply". */
1503 ofputil_msg_type_name(const struct ofputil_msg_type *type)
1508 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
1509 * 'openflow_len', starting with an OpenFlow header with the given 'type' and
1510 * an arbitrary transaction id. Allocated bytes beyond the header, if any, are
1513 * The caller is responsible for freeing '*bufferp' when it is no longer
1516 * The OpenFlow header length is initially set to 'openflow_len'; if the
1517 * message is later extended, the length should be updated with
1518 * update_openflow_length() before sending.
1520 * Returns the header. */
1522 make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **bufferp)
1524 *bufferp = ofpbuf_new(openflow_len);
1525 return put_openflow_xid(openflow_len, type, alloc_xid(), *bufferp);
1528 /* Similar to make_openflow() but creates a Nicira vendor extension message
1529 * with the specific 'subtype'. 'subtype' should be in host byte order. */
1531 make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **bufferp)
1533 return make_nxmsg_xid(openflow_len, subtype, alloc_xid(), bufferp);
1536 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
1537 * 'openflow_len', starting with an OpenFlow header with the given 'type' and
1538 * transaction id 'xid'. Allocated bytes beyond the header, if any, are
1541 * The caller is responsible for freeing '*bufferp' when it is no longer
1544 * The OpenFlow header length is initially set to 'openflow_len'; if the
1545 * message is later extended, the length should be updated with
1546 * update_openflow_length() before sending.
1548 * Returns the header. */
1550 make_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
1551 struct ofpbuf **bufferp)
1553 *bufferp = ofpbuf_new(openflow_len);
1554 return put_openflow_xid(openflow_len, type, xid, *bufferp);
1557 /* Similar to make_openflow_xid() but creates a Nicira vendor extension message
1558 * with the specific 'subtype'. 'subtype' should be in host byte order. */
1560 make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
1561 struct ofpbuf **bufferp)
1563 *bufferp = ofpbuf_new(openflow_len);
1564 return put_nxmsg_xid(openflow_len, subtype, xid, *bufferp);
1567 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
1568 * with the given 'type' and an arbitrary transaction id. Allocated bytes
1569 * beyond the header, if any, are zeroed.
1571 * The OpenFlow header length is initially set to 'openflow_len'; if the
1572 * message is later extended, the length should be updated with
1573 * update_openflow_length() before sending.
1575 * Returns the header. */
1577 put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *buffer)
1579 return put_openflow_xid(openflow_len, type, alloc_xid(), buffer);
1582 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
1583 * with the given 'type' and an transaction id 'xid'. Allocated bytes beyond
1584 * the header, if any, are zeroed.
1586 * The OpenFlow header length is initially set to 'openflow_len'; if the
1587 * message is later extended, the length should be updated with
1588 * update_openflow_length() before sending.
1590 * Returns the header. */
1592 put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
1593 struct ofpbuf *buffer)
1595 struct ofp_header *oh;
1597 assert(openflow_len >= sizeof *oh);
1598 assert(openflow_len <= UINT16_MAX);
1600 oh = ofpbuf_put_uninit(buffer, openflow_len);
1601 oh->version = OFP_VERSION;
1603 oh->length = htons(openflow_len);
1605 memset(oh + 1, 0, openflow_len - sizeof *oh);
1609 /* Similar to put_openflow() but append a Nicira vendor extension message with
1610 * the specific 'subtype'. 'subtype' should be in host byte order. */
1612 put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *buffer)
1614 return put_nxmsg_xid(openflow_len, subtype, alloc_xid(), buffer);
1617 /* Similar to put_openflow_xid() but append a Nicira vendor extension message
1618 * with the specific 'subtype'. 'subtype' should be in host byte order. */
1620 put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
1621 struct ofpbuf *buffer)
1623 struct nicira_header *nxh;
1625 nxh = put_openflow_xid(openflow_len, OFPT_VENDOR, xid, buffer);
1626 nxh->vendor = htonl(NX_VENDOR_ID);
1627 nxh->subtype = htonl(subtype);
1631 /* Updates the 'length' field of the OpenFlow message in 'buffer' to
1632 * 'buffer->size'. */
1634 update_openflow_length(struct ofpbuf *buffer)
1636 struct ofp_header *oh = ofpbuf_at_assert(buffer, 0, sizeof *oh);
1637 oh->length = htons(buffer->size);
1640 /* Creates an ofp_stats_request with the given 'type' and 'body_len' bytes of
1641 * space allocated for the 'body' member. Returns the first byte of the 'body'
1644 ofputil_make_stats_request(size_t body_len, uint16_t type,
1645 struct ofpbuf **bufferp)
1647 struct ofp_stats_request *osr;
1648 osr = make_openflow((offsetof(struct ofp_stats_request, body)
1649 + body_len), OFPT_STATS_REQUEST, bufferp);
1650 osr->type = htons(type);
1651 osr->flags = htons(0);
1655 /* Creates a stats request message with Nicira as vendor and the given
1656 * 'subtype', of total length 'openflow_len'. Returns the message. */
1658 ofputil_make_nxstats_request(size_t openflow_len, uint32_t subtype,
1659 struct ofpbuf **bufferp)
1661 struct nicira_stats_msg *nsm;
1663 nsm = make_openflow(openflow_len, OFPT_STATS_REQUEST, bufferp);
1664 nsm->type = htons(OFPST_VENDOR);
1665 nsm->flags = htons(0);
1666 nsm->vendor = htonl(NX_VENDOR_ID);
1667 nsm->subtype = htonl(subtype);
1671 /* Returns the first byte of the 'body' member of the ofp_stats_request or
1672 * ofp_stats_reply in 'oh'. */
1674 ofputil_stats_body(const struct ofp_header *oh)
1676 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1677 return ((const struct ofp_stats_request *) oh)->body;
1680 /* Returns the length of the 'body' member of the ofp_stats_request or
1681 * ofp_stats_reply in 'oh'. */
1683 ofputil_stats_body_len(const struct ofp_header *oh)
1685 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1686 return ntohs(oh->length) - sizeof(struct ofp_stats_request);
1689 /* Returns the first byte of the body of the nicira_stats_msg in 'oh'. */
1691 ofputil_nxstats_body(const struct ofp_header *oh)
1693 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1694 return ((const struct nicira_stats_msg *) oh) + 1;
1697 /* Returns the length of the body of the nicira_stats_msg in 'oh'. */
1699 ofputil_nxstats_body_len(const struct ofp_header *oh)
1701 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1702 return ntohs(oh->length) - sizeof(struct nicira_stats_msg);
1706 make_flow_mod(uint16_t command, const struct cls_rule *rule,
1709 struct ofp_flow_mod *ofm;
1710 size_t size = sizeof *ofm + actions_len;
1711 struct ofpbuf *out = ofpbuf_new(size);
1712 ofm = ofpbuf_put_zeros(out, sizeof *ofm);
1713 ofm->header.version = OFP_VERSION;
1714 ofm->header.type = OFPT_FLOW_MOD;
1715 ofm->header.length = htons(size);
1717 ofm->priority = htons(MIN(rule->priority, UINT16_MAX));
1718 ofputil_cls_rule_to_match(rule, NXFF_OPENFLOW10, &ofm->match, 0, NULL);
1719 ofm->command = htons(command);
1724 make_add_flow(const struct cls_rule *rule, uint32_t buffer_id,
1725 uint16_t idle_timeout, size_t actions_len)
1727 struct ofpbuf *out = make_flow_mod(OFPFC_ADD, rule, actions_len);
1728 struct ofp_flow_mod *ofm = out->data;
1729 ofm->idle_timeout = htons(idle_timeout);
1730 ofm->hard_timeout = htons(OFP_FLOW_PERMANENT);
1731 ofm->buffer_id = htonl(buffer_id);
1736 make_del_flow(const struct cls_rule *rule)
1738 struct ofpbuf *out = make_flow_mod(OFPFC_DELETE_STRICT, rule, 0);
1739 struct ofp_flow_mod *ofm = out->data;
1740 ofm->out_port = htons(OFPP_NONE);
1745 make_add_simple_flow(const struct cls_rule *rule,
1746 uint32_t buffer_id, uint16_t out_port,
1747 uint16_t idle_timeout)
1749 if (out_port != OFPP_NONE) {
1750 struct ofp_action_output *oao;
1751 struct ofpbuf *buffer;
1753 buffer = make_add_flow(rule, buffer_id, idle_timeout, sizeof *oao);
1754 oao = ofpbuf_put_zeros(buffer, sizeof *oao);
1755 oao->type = htons(OFPAT_OUTPUT);
1756 oao->len = htons(sizeof *oao);
1757 oao->port = htons(out_port);
1760 return make_add_flow(rule, buffer_id, idle_timeout, 0);
1765 make_packet_in(uint32_t buffer_id, uint16_t in_port, uint8_t reason,
1766 const struct ofpbuf *payload, int max_send_len)
1768 struct ofp_packet_in *opi;
1772 send_len = MIN(max_send_len, payload->size);
1773 buf = ofpbuf_new(sizeof *opi + send_len);
1774 opi = put_openflow_xid(offsetof(struct ofp_packet_in, data),
1775 OFPT_PACKET_IN, 0, buf);
1776 opi->buffer_id = htonl(buffer_id);
1777 opi->total_len = htons(payload->size);
1778 opi->in_port = htons(in_port);
1779 opi->reason = reason;
1780 ofpbuf_put(buf, payload->data, send_len);
1781 update_openflow_length(buf);
1787 make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
1789 const struct ofp_action_header *actions, size_t n_actions)
1791 size_t actions_len = n_actions * sizeof *actions;
1792 struct ofp_packet_out *opo;
1793 size_t size = sizeof *opo + actions_len + (packet ? packet->size : 0);
1794 struct ofpbuf *out = ofpbuf_new(size);
1796 opo = ofpbuf_put_uninit(out, sizeof *opo);
1797 opo->header.version = OFP_VERSION;
1798 opo->header.type = OFPT_PACKET_OUT;
1799 opo->header.length = htons(size);
1800 opo->header.xid = htonl(0);
1801 opo->buffer_id = htonl(buffer_id);
1802 opo->in_port = htons(in_port == ODPP_LOCAL ? OFPP_LOCAL : in_port);
1803 opo->actions_len = htons(actions_len);
1804 ofpbuf_put(out, actions, actions_len);
1806 ofpbuf_put(out, packet->data, packet->size);
1812 make_unbuffered_packet_out(const struct ofpbuf *packet,
1813 uint16_t in_port, uint16_t out_port)
1815 struct ofp_action_output action;
1816 action.type = htons(OFPAT_OUTPUT);
1817 action.len = htons(sizeof action);
1818 action.port = htons(out_port);
1819 return make_packet_out(packet, UINT32_MAX, in_port,
1820 (struct ofp_action_header *) &action, 1);
1824 make_buffered_packet_out(uint32_t buffer_id,
1825 uint16_t in_port, uint16_t out_port)
1827 if (out_port != OFPP_NONE) {
1828 struct ofp_action_output action;
1829 action.type = htons(OFPAT_OUTPUT);
1830 action.len = htons(sizeof action);
1831 action.port = htons(out_port);
1832 return make_packet_out(NULL, buffer_id, in_port,
1833 (struct ofp_action_header *) &action, 1);
1835 return make_packet_out(NULL, buffer_id, in_port, NULL, 0);
1839 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
1841 make_echo_request(void)
1843 struct ofp_header *rq;
1844 struct ofpbuf *out = ofpbuf_new(sizeof *rq);
1845 rq = ofpbuf_put_uninit(out, sizeof *rq);
1846 rq->version = OFP_VERSION;
1847 rq->type = OFPT_ECHO_REQUEST;
1848 rq->length = htons(sizeof *rq);
1853 /* Creates and returns an OFPT_ECHO_REPLY message matching the
1854 * OFPT_ECHO_REQUEST message in 'rq'. */
1856 make_echo_reply(const struct ofp_header *rq)
1858 size_t size = ntohs(rq->length);
1859 struct ofpbuf *out = ofpbuf_new(size);
1860 struct ofp_header *reply = ofpbuf_put(out, rq, size);
1861 reply->type = OFPT_ECHO_REPLY;
1866 check_action_exact_len(const union ofp_action *a, unsigned int len,
1867 unsigned int required_len)
1869 if (len != required_len) {
1870 VLOG_WARN_RL(&bad_ofmsg_rl, "action %"PRIu16" has invalid length "
1871 "%"PRIu16" (must be %u)\n",
1872 ntohs(a->type), ntohs(a->header.len), required_len);
1873 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1879 check_nx_action_exact_len(const struct nx_action_header *a,
1880 unsigned int len, unsigned int required_len)
1882 if (len != required_len) {
1883 VLOG_WARN_RL(&bad_ofmsg_rl,
1884 "Nicira action %"PRIu16" has invalid length %"PRIu16" "
1886 ntohs(a->subtype), ntohs(a->len), required_len);
1887 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1892 /* Checks that 'port' is a valid output port for the OFPAT_OUTPUT action, given
1893 * that the switch will never have more than 'max_ports' ports. Returns 0 if
1894 * 'port' is valid, otherwise an ofp_mkerr() return code. */
1896 check_output_port(uint16_t port, int max_ports)
1904 case OFPP_CONTROLLER:
1909 if (port < max_ports) {
1912 VLOG_WARN_RL(&bad_ofmsg_rl, "unknown output port %x", port);
1913 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT);
1917 /* Checks that 'action' is a valid OFPAT_ENQUEUE action, given that the switch
1918 * will never have more than 'max_ports' ports. Returns 0 if 'port' is valid,
1919 * otherwise an ofp_mkerr() return code. */
1921 check_enqueue_action(const union ofp_action *a, unsigned int len,
1924 const struct ofp_action_enqueue *oae;
1928 error = check_action_exact_len(a, len, 16);
1933 oae = (const struct ofp_action_enqueue *) a;
1934 port = ntohs(oae->port);
1935 if (port < max_ports || port == OFPP_IN_PORT) {
1938 VLOG_WARN_RL(&bad_ofmsg_rl, "unknown enqueue port %x", port);
1939 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT);
1943 check_nicira_action(const union ofp_action *a, unsigned int len,
1944 const struct flow *flow)
1946 const struct nx_action_header *nah;
1951 VLOG_WARN_RL(&bad_ofmsg_rl,
1952 "Nicira vendor action only %u bytes", len);
1953 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1955 nah = (const struct nx_action_header *) a;
1957 subtype = ntohs(nah->subtype);
1958 if (subtype > TYPE_MAXIMUM(enum nx_action_subtype)) {
1959 /* This is necessary because enum nx_action_subtype may be an
1960 * 8-bit type, so the cast below throws away the top 8 bits. */
1961 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR_TYPE);
1964 switch ((enum nx_action_subtype) subtype) {
1965 case NXAST_RESUBMIT:
1966 case NXAST_SET_TUNNEL:
1967 case NXAST_DROP_SPOOFED_ARP:
1968 case NXAST_SET_QUEUE:
1969 case NXAST_POP_QUEUE:
1970 return check_nx_action_exact_len(nah, len, 16);
1972 case NXAST_REG_MOVE:
1973 error = check_nx_action_exact_len(nah, len,
1974 sizeof(struct nx_action_reg_move));
1978 return nxm_check_reg_move((const struct nx_action_reg_move *) a, flow);
1980 case NXAST_REG_LOAD:
1981 error = check_nx_action_exact_len(nah, len,
1982 sizeof(struct nx_action_reg_load));
1986 return nxm_check_reg_load((const struct nx_action_reg_load *) a, flow);
1991 case NXAST_SET_TUNNEL64:
1992 return check_nx_action_exact_len(
1993 nah, len, sizeof(struct nx_action_set_tunnel64));
1995 case NXAST_MULTIPATH:
1996 error = check_nx_action_exact_len(
1997 nah, len, sizeof(struct nx_action_multipath));
2001 return multipath_check((const struct nx_action_multipath *) a);
2003 case NXAST_AUTOPATH:
2004 error = check_nx_action_exact_len(
2005 nah, len, sizeof(struct nx_action_autopath));
2009 return autopath_check((const struct nx_action_autopath *) a);
2011 case NXAST_SNAT__OBSOLETE:
2013 VLOG_WARN_RL(&bad_ofmsg_rl,
2014 "unknown Nicira vendor action subtype %d", subtype);
2015 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR_TYPE);
2020 check_action(const union ofp_action *a, unsigned int len,
2021 const struct flow *flow, int max_ports)
2023 enum ofp_action_type type = ntohs(a->type);
2028 error = check_action_exact_len(a, len, 8);
2032 return check_output_port(ntohs(a->output.port), max_ports);
2034 case OFPAT_SET_VLAN_VID:
2035 error = check_action_exact_len(a, len, 8);
2039 if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
2040 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
2044 case OFPAT_SET_VLAN_PCP:
2045 error = check_action_exact_len(a, len, 8);
2049 if (a->vlan_vid.vlan_vid & ~7) {
2050 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
2054 case OFPAT_STRIP_VLAN:
2055 case OFPAT_SET_NW_SRC:
2056 case OFPAT_SET_NW_DST:
2057 case OFPAT_SET_NW_TOS:
2058 case OFPAT_SET_TP_SRC:
2059 case OFPAT_SET_TP_DST:
2060 return check_action_exact_len(a, len, 8);
2062 case OFPAT_SET_DL_SRC:
2063 case OFPAT_SET_DL_DST:
2064 return check_action_exact_len(a, len, 16);
2067 return (a->vendor.vendor == htonl(NX_VENDOR_ID)
2068 ? check_nicira_action(a, len, flow)
2069 : ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR));
2072 return check_enqueue_action(a, len, max_ports);
2075 VLOG_WARN_RL(&bad_ofmsg_rl, "unknown action type %d", (int) type);
2076 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_TYPE);
2081 validate_actions(const union ofp_action *actions, size_t n_actions,
2082 const struct flow *flow, int max_ports)
2086 for (i = 0; i < n_actions; ) {
2087 const union ofp_action *a = &actions[i];
2088 unsigned int len = ntohs(a->header.len);
2089 unsigned int n_slots = len / OFP_ACTION_ALIGN;
2090 unsigned int slots_left = &actions[n_actions] - a;
2093 if (n_slots > slots_left) {
2094 VLOG_WARN_RL(&bad_ofmsg_rl,
2095 "action requires %u slots but only %u remain",
2096 n_slots, slots_left);
2097 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
2099 VLOG_WARN_RL(&bad_ofmsg_rl, "action has invalid length 0");
2100 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
2101 } else if (len % OFP_ACTION_ALIGN) {
2102 VLOG_WARN_RL(&bad_ofmsg_rl, "action length %u is not a multiple "
2103 "of %d", len, OFP_ACTION_ALIGN);
2104 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
2107 error = check_action(a, len, flow, max_ports);
2116 /* Returns true if 'action' outputs to 'port', false otherwise. */
2118 action_outputs_to_port(const union ofp_action *action, ovs_be16 port)
2120 switch (ntohs(action->type)) {
2122 return action->output.port == port;
2124 return ((const struct ofp_action_enqueue *) action)->port == port;
2130 /* The set of actions must either come from a trusted source or have been
2131 * previously validated with validate_actions(). */
2132 const union ofp_action *
2133 actions_first(struct actions_iterator *iter,
2134 const union ofp_action *oa, size_t n_actions)
2137 iter->end = oa + n_actions;
2138 return actions_next(iter);
2141 const union ofp_action *
2142 actions_next(struct actions_iterator *iter)
2144 if (iter->pos != iter->end) {
2145 const union ofp_action *a = iter->pos;
2146 unsigned int len = ntohs(a->header.len);
2147 iter->pos += len / OFP_ACTION_ALIGN;
2155 normalize_match(struct ofp_match *m)
2157 enum { OFPFW_NW = (OFPFW_NW_SRC_MASK | OFPFW_NW_DST_MASK | OFPFW_NW_PROTO
2159 enum { OFPFW_TP = OFPFW_TP_SRC | OFPFW_TP_DST };
2162 wc = ntohl(m->wildcards) & OVSFW_ALL;
2163 if (wc & OFPFW_DL_TYPE) {
2166 /* Can't sensibly match on network or transport headers if the
2167 * data link type is unknown. */
2168 wc |= OFPFW_NW | OFPFW_TP;
2169 m->nw_src = m->nw_dst = m->nw_proto = m->nw_tos = 0;
2170 m->tp_src = m->tp_dst = 0;
2171 } else if (m->dl_type == htons(ETH_TYPE_IP)) {
2172 if (wc & OFPFW_NW_PROTO) {
2175 /* Can't sensibly match on transport headers if the network
2176 * protocol is unknown. */
2178 m->tp_src = m->tp_dst = 0;
2179 } else if (m->nw_proto == IPPROTO_TCP ||
2180 m->nw_proto == IPPROTO_UDP ||
2181 m->nw_proto == IPPROTO_ICMP) {
2182 if (wc & OFPFW_TP_SRC) {
2185 if (wc & OFPFW_TP_DST) {
2189 /* Transport layer fields will always be extracted as zeros, so we
2190 * can do an exact-match on those values. */
2192 m->tp_src = m->tp_dst = 0;
2194 if (wc & OFPFW_NW_SRC_MASK) {
2195 m->nw_src &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_SRC_SHIFT);
2197 if (wc & OFPFW_NW_DST_MASK) {
2198 m->nw_dst &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_DST_SHIFT);
2200 if (wc & OFPFW_NW_TOS) {
2203 m->nw_tos &= IP_DSCP_MASK;
2205 } else if (m->dl_type == htons(ETH_TYPE_ARP)) {
2206 if (wc & OFPFW_NW_PROTO) {
2209 if (wc & OFPFW_NW_SRC_MASK) {
2210 m->nw_src &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_SRC_SHIFT);
2212 if (wc & OFPFW_NW_DST_MASK) {
2213 m->nw_dst &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_DST_SHIFT);
2215 m->tp_src = m->tp_dst = m->nw_tos = 0;
2216 } else if (m->dl_type == htons(ETH_TYPE_IPV6)) {
2217 /* Don't normalize IPv6 traffic, since OpenFlow doesn't have a
2218 * way to express it. */
2220 /* Network and transport layer fields will always be extracted as
2221 * zeros, so we can do an exact-match on those values. */
2222 wc &= ~(OFPFW_NW | OFPFW_TP);
2223 m->nw_proto = m->nw_src = m->nw_dst = m->nw_tos = 0;
2224 m->tp_src = m->tp_dst = 0;
2226 if (wc & OFPFW_DL_SRC) {
2227 memset(m->dl_src, 0, sizeof m->dl_src);
2229 if (wc & OFPFW_DL_DST) {
2230 memset(m->dl_dst, 0, sizeof m->dl_dst);
2232 m->wildcards = htonl(wc);
2235 /* Returns a string that describes 'match' in a very literal way, without
2236 * interpreting its contents except in a very basic fashion. The returned
2237 * string is intended to be fixed-length, so that it is easy to see differences
2238 * between two such strings if one is put above another. This is useful for
2239 * describing changes made by normalize_match().
2241 * The caller must free the returned string (with free()). */
2243 ofp_match_to_literal_string(const struct ofp_match *match)
2245 return xasprintf("wildcards=%#10"PRIx32" "
2246 " in_port=%5"PRId16" "
2247 " dl_src="ETH_ADDR_FMT" "
2248 " dl_dst="ETH_ADDR_FMT" "
2249 " dl_vlan=%5"PRId16" "
2250 " dl_vlan_pcp=%3"PRId8" "
2251 " dl_type=%#6"PRIx16" "
2252 " nw_tos=%#4"PRIx8" "
2253 " nw_proto=%#4"PRIx16" "
2254 " nw_src=%#10"PRIx32" "
2255 " nw_dst=%#10"PRIx32" "
2256 " tp_src=%5"PRId16" "
2258 ntohl(match->wildcards),
2259 ntohs(match->in_port),
2260 ETH_ADDR_ARGS(match->dl_src),
2261 ETH_ADDR_ARGS(match->dl_dst),
2262 ntohs(match->dl_vlan),
2264 ntohs(match->dl_type),
2267 ntohl(match->nw_src),
2268 ntohl(match->nw_dst),
2269 ntohs(match->tp_src),
2270 ntohs(match->tp_dst));
2274 vendor_code_to_id(uint8_t code)
2277 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) case NAME: return VENDOR_ID;
2279 #undef OFPUTIL_VENDOR
2286 vendor_id_to_code(uint32_t id)
2289 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) case VENDOR_ID: return NAME;
2291 #undef OFPUTIL_VENDOR
2297 /* Creates and returns an OpenFlow message of type OFPT_ERROR with the error
2298 * information taken from 'error', whose encoding must be as described in the
2299 * large comment in ofp-util.h. If 'oh' is nonnull, then the error will use
2300 * oh->xid as its transaction ID, and it will include up to the first 64 bytes
2303 * Returns NULL if 'error' is not an OpenFlow error code. */
2305 ofputil_encode_error_msg(int error, const struct ofp_header *oh)
2307 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2317 if (!is_ofp_error(error)) {
2318 /* We format 'error' with strerror() here since it seems likely to be
2319 * a system errno value. */
2320 VLOG_WARN_RL(&rl, "invalid OpenFlow error code %d (%s)",
2321 error, strerror(error));
2328 len = ntohs(oh->length);
2338 vendor = get_ofp_err_vendor(error);
2339 type = get_ofp_err_type(error);
2340 code = get_ofp_err_code(error);
2341 if (vendor == OFPUTIL_VENDOR_OPENFLOW) {
2342 struct ofp_error_msg *oem;
2344 oem = make_openflow_xid(len + sizeof *oem, OFPT_ERROR, xid, &buf);
2345 oem->type = htons(type);
2346 oem->code = htons(code);
2348 struct ofp_error_msg *oem;
2349 struct nx_vendor_error *nve;
2352 vendor_id = vendor_code_to_id(vendor);
2353 if (vendor_id == UINT32_MAX) {
2354 VLOG_WARN_RL(&rl, "error %x contains invalid vendor code %d",
2359 oem = make_openflow_xid(len + sizeof *oem + sizeof *nve,
2360 OFPT_ERROR, xid, &buf);
2361 oem->type = htons(NXET_VENDOR);
2362 oem->code = htons(NXVC_VENDOR_ERROR);
2364 nve = (struct nx_vendor_error *)oem->data;
2365 nve->vendor = htonl(vendor_id);
2366 nve->type = htons(type);
2367 nve->code = htons(code);
2372 ofpbuf_put(buf, data, len);
2378 /* Decodes 'oh', which should be an OpenFlow OFPT_ERROR message, and returns an
2379 * Open vSwitch internal error code in the format described in the large
2380 * comment in ofp-util.h.
2382 * If 'payload_ofs' is nonnull, on success '*payload_ofs' is set to the offset
2383 * to the payload starting from 'oh' and on failure it is set to 0. */
2385 ofputil_decode_error_msg(const struct ofp_header *oh, size_t *payload_ofs)
2387 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2389 const struct ofp_error_msg *oem;
2390 uint16_t type, code;
2397 if (oh->type != OFPT_ERROR) {
2401 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2402 oem = ofpbuf_try_pull(&b, sizeof *oem);
2407 type = ntohs(oem->type);
2408 code = ntohs(oem->code);
2409 if (type == NXET_VENDOR && code == NXVC_VENDOR_ERROR) {
2410 const struct nx_vendor_error *nve = ofpbuf_try_pull(&b, sizeof *nve);
2415 vendor = vendor_id_to_code(ntohl(nve->vendor));
2417 VLOG_WARN_RL(&rl, "error contains unknown vendor ID %#"PRIx32,
2418 ntohl(nve->vendor));
2421 type = ntohs(nve->type);
2422 code = ntohs(nve->code);
2424 vendor = OFPUTIL_VENDOR_OPENFLOW;
2428 VLOG_WARN_RL(&rl, "error contains type %"PRIu16" greater than "
2429 "supported maximum value 1023", type);
2434 *payload_ofs = (uint8_t *) b.data - (uint8_t *) oh;
2436 return ofp_mkerr_vendor(vendor, type, code);
2440 ofputil_format_error(struct ds *s, int error)
2442 if (is_errno(error)) {
2443 ds_put_cstr(s, strerror(error));
2445 uint16_t type = get_ofp_err_type(error);
2446 uint16_t code = get_ofp_err_code(error);
2447 const char *type_s = ofp_error_type_to_string(type);
2448 const char *code_s = ofp_error_code_to_string(type, code);
2450 ds_put_format(s, "type ");
2452 ds_put_cstr(s, type_s);
2454 ds_put_format(s, "%"PRIu16, type);
2457 ds_put_cstr(s, ", code ");
2459 ds_put_cstr(s, code_s);
2461 ds_put_format(s, "%"PRIu16, code);
2467 ofputil_error_to_string(int error)
2469 struct ds s = DS_EMPTY_INITIALIZER;
2470 ofputil_format_error(&s, error);
2471 return ds_steal_cstr(&s);
2474 /* Attempts to pull 'actions_len' bytes from the front of 'b'. Returns 0 if
2475 * successful, otherwise an OpenFlow error.
2477 * If successful, the first action is stored in '*actionsp' and the number of
2478 * "union ofp_action" size elements into '*n_actionsp'. Otherwise NULL and 0
2479 * are stored, respectively.
2481 * This function does not check that the actions are valid (the caller should
2482 * do so, with validate_actions()). The caller is also responsible for making
2483 * sure that 'b->data' is initially aligned appropriately for "union
2486 ofputil_pull_actions(struct ofpbuf *b, unsigned int actions_len,
2487 union ofp_action **actionsp, size_t *n_actionsp)
2489 if (actions_len % OFP_ACTION_ALIGN != 0) {
2490 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
2491 "is not a multiple of %d", actions_len, OFP_ACTION_ALIGN);
2495 *actionsp = ofpbuf_try_pull(b, actions_len);
2496 if (*actionsp == NULL) {
2497 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
2498 "exceeds remaining message length (%zu)",
2499 actions_len, b->size);
2503 *n_actionsp = actions_len / OFP_ACTION_ALIGN;
2509 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);