2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 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"
21 #include <sys/types.h>
22 #include <netinet/in.h>
23 #include <netinet/icmp6.h>
27 #include "byte-order.h"
28 #include "classifier.h"
29 #include "dynamic-string.h"
31 #include "multipath.h"
33 #include "ofp-errors.h"
38 #include "unaligned.h"
39 #include "type-props.h"
42 VLOG_DEFINE_THIS_MODULE(ofp_util);
44 /* Rate limit for OpenFlow message parse errors. These always indicate a bug
45 * in the peer and so there's not much point in showing a lot of them. */
46 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
48 /* Given the wildcard bit count in the least-significant 6 of 'wcbits', returns
49 * an IP netmask with a 1 in each bit that must match and a 0 in each bit that
52 * The bits in 'wcbits' are in the format used in enum ofp_flow_wildcards: 0
53 * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
54 * ..., 32 and higher wildcard the entire field. This is the *opposite* of the
55 * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
58 ofputil_wcbits_to_netmask(int wcbits)
61 return wcbits < 32 ? htonl(~((1u << wcbits) - 1)) : 0;
64 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
65 * that it wildcards, that is, the number of 0-bits in 'netmask'. 'netmask'
66 * must be a CIDR netmask (see ip_is_cidr()). */
68 ofputil_netmask_to_wcbits(ovs_be32 netmask)
70 return 32 - ip_count_cidr_bits(netmask);
73 /* A list of the FWW_* and OFPFW_ bits that have the same value, meaning, and
75 #define WC_INVARIANT_LIST \
76 WC_INVARIANT_BIT(IN_PORT) \
77 WC_INVARIANT_BIT(DL_SRC) \
78 WC_INVARIANT_BIT(DL_DST) \
79 WC_INVARIANT_BIT(DL_TYPE) \
80 WC_INVARIANT_BIT(NW_PROTO) \
81 WC_INVARIANT_BIT(TP_SRC) \
82 WC_INVARIANT_BIT(TP_DST)
84 /* Verify that all of the invariant bits (as defined on WC_INVARIANT_LIST)
85 * actually have the same names and values. */
86 #define WC_INVARIANT_BIT(NAME) BUILD_ASSERT_DECL(FWW_##NAME == OFPFW_##NAME);
88 #undef WC_INVARIANT_BIT
90 /* WC_INVARIANTS is the invariant bits (as defined on WC_INVARIANT_LIST) all
92 static const flow_wildcards_t WC_INVARIANTS = 0
93 #define WC_INVARIANT_BIT(NAME) | FWW_##NAME
95 #undef WC_INVARIANT_BIT
98 /* Converts the wildcard in 'ofpfw' into a flow_wildcards in 'wc' for use in
99 * struct cls_rule. It is the caller's responsibility to handle the special
100 * case where the flow match's dl_vlan is set to OFP_VLAN_NONE. */
102 ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *wc)
104 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 7);
106 /* Initialize most of rule->wc. */
107 flow_wildcards_init_catchall(wc);
108 wc->wildcards = (OVS_FORCE flow_wildcards_t) ofpfw & WC_INVARIANTS;
110 /* Wildcard fields that aren't defined by ofp_match or tun_id. */
111 wc->wildcards |= (FWW_ARP_SHA | FWW_ARP_THA | FWW_NW_ECN | FWW_NW_TTL
112 | FWW_ND_TARGET | FWW_IPV6_LABEL);
114 if (ofpfw & OFPFW_NW_TOS) {
115 /* OpenFlow 1.0 defines a TOS wildcard, but it's much later in
116 * the enum than we can use. */
117 wc->wildcards |= FWW_NW_DSCP;
120 wc->nw_src_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW_NW_SRC_SHIFT);
121 wc->nw_dst_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW_NW_DST_SHIFT);
123 if (ofpfw & OFPFW_DL_DST) {
124 /* OpenFlow 1.0 OFPFW_DL_DST covers the whole Ethernet destination, but
125 * Open vSwitch breaks the Ethernet destination into bits as FWW_DL_DST
126 * and FWW_ETH_MCAST. */
127 wc->wildcards |= FWW_ETH_MCAST;
131 if (!(ofpfw & OFPFW_DL_VLAN_PCP)) {
132 wc->vlan_tci_mask |= htons(VLAN_PCP_MASK | VLAN_CFI);
134 if (!(ofpfw & OFPFW_DL_VLAN)) {
135 wc->vlan_tci_mask |= htons(VLAN_VID_MASK | VLAN_CFI);
139 /* Converts the ofp_match in 'match' into a cls_rule in 'rule', with the given
142 ofputil_cls_rule_from_match(const struct ofp_match *match,
143 unsigned int priority, struct cls_rule *rule)
145 uint32_t ofpfw = ntohl(match->wildcards) & OFPFW_ALL;
147 /* Initialize rule->priority, rule->wc. */
148 rule->priority = !ofpfw ? UINT16_MAX : priority;
149 ofputil_wildcard_from_openflow(ofpfw, &rule->wc);
151 /* Initialize most of rule->flow. */
152 rule->flow.nw_src = match->nw_src;
153 rule->flow.nw_dst = match->nw_dst;
154 rule->flow.in_port = ntohs(match->in_port);
155 rule->flow.dl_type = ofputil_dl_type_from_openflow(match->dl_type);
156 rule->flow.tp_src = match->tp_src;
157 rule->flow.tp_dst = match->tp_dst;
158 memcpy(rule->flow.dl_src, match->dl_src, ETH_ADDR_LEN);
159 memcpy(rule->flow.dl_dst, match->dl_dst, ETH_ADDR_LEN);
160 rule->flow.nw_tos = match->nw_tos & IP_DSCP_MASK;
161 rule->flow.nw_proto = match->nw_proto;
163 /* Translate VLANs. */
164 if (!(ofpfw & OFPFW_DL_VLAN) && match->dl_vlan == htons(OFP_VLAN_NONE)) {
165 /* Match only packets without 802.1Q header.
167 * When OFPFW_DL_VLAN_PCP is wildcarded, this is obviously correct.
169 * If OFPFW_DL_VLAN_PCP is matched, the flow match is contradictory,
170 * because we can't have a specific PCP without an 802.1Q header.
171 * However, older versions of OVS treated this as matching packets
172 * withut an 802.1Q header, so we do here too. */
173 rule->flow.vlan_tci = htons(0);
174 rule->wc.vlan_tci_mask = htons(0xffff);
176 ovs_be16 vid, pcp, tci;
178 vid = match->dl_vlan & htons(VLAN_VID_MASK);
179 pcp = htons((match->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK);
180 tci = vid | pcp | htons(VLAN_CFI);
181 rule->flow.vlan_tci = tci & rule->wc.vlan_tci_mask;
185 cls_rule_zero_wildcarded_fields(rule);
188 /* Convert 'rule' into the OpenFlow match structure 'match'. */
190 ofputil_cls_rule_to_match(const struct cls_rule *rule, struct ofp_match *match)
192 const struct flow_wildcards *wc = &rule->wc;
195 /* Figure out most OpenFlow wildcards. */
196 ofpfw = (OVS_FORCE uint32_t) (wc->wildcards & WC_INVARIANTS);
197 ofpfw |= ofputil_netmask_to_wcbits(wc->nw_src_mask) << OFPFW_NW_SRC_SHIFT;
198 ofpfw |= ofputil_netmask_to_wcbits(wc->nw_dst_mask) << OFPFW_NW_DST_SHIFT;
199 if (wc->wildcards & FWW_NW_DSCP) {
200 ofpfw |= OFPFW_NW_TOS;
203 /* Translate VLANs. */
204 match->dl_vlan = htons(0);
205 match->dl_vlan_pcp = 0;
206 if (rule->wc.vlan_tci_mask == htons(0)) {
207 ofpfw |= OFPFW_DL_VLAN | OFPFW_DL_VLAN_PCP;
208 } else if (rule->wc.vlan_tci_mask & htons(VLAN_CFI)
209 && !(rule->flow.vlan_tci & htons(VLAN_CFI))) {
210 match->dl_vlan = htons(OFP_VLAN_NONE);
212 if (!(rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) {
213 ofpfw |= OFPFW_DL_VLAN;
215 match->dl_vlan = htons(vlan_tci_to_vid(rule->flow.vlan_tci));
218 if (!(rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK))) {
219 ofpfw |= OFPFW_DL_VLAN_PCP;
221 match->dl_vlan_pcp = vlan_tci_to_pcp(rule->flow.vlan_tci);
225 /* Compose most of the match structure. */
226 match->wildcards = htonl(ofpfw);
227 match->in_port = htons(rule->flow.in_port);
228 memcpy(match->dl_src, rule->flow.dl_src, ETH_ADDR_LEN);
229 memcpy(match->dl_dst, rule->flow.dl_dst, ETH_ADDR_LEN);
230 match->dl_type = ofputil_dl_type_to_openflow(rule->flow.dl_type);
231 match->nw_src = rule->flow.nw_src;
232 match->nw_dst = rule->flow.nw_dst;
233 match->nw_tos = rule->flow.nw_tos & IP_DSCP_MASK;
234 match->nw_proto = rule->flow.nw_proto;
235 match->tp_src = rule->flow.tp_src;
236 match->tp_dst = rule->flow.tp_dst;
237 memset(match->pad1, '\0', sizeof match->pad1);
238 memset(match->pad2, '\0', sizeof match->pad2);
241 /* Given a 'dl_type' value in the format used in struct flow, returns the
242 * corresponding 'dl_type' value for use in an OpenFlow ofp_match structure. */
244 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type)
246 return (flow_dl_type == htons(FLOW_DL_TYPE_NONE)
247 ? htons(OFP_DL_TYPE_NOT_ETH_TYPE)
251 /* Given a 'dl_type' value in the format used in an OpenFlow ofp_match
252 * structure, returns the corresponding 'dl_type' value for use in struct
255 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type)
257 return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
258 ? htons(FLOW_DL_TYPE_NONE)
262 /* Returns a transaction ID to use for an outgoing OpenFlow message. */
266 static uint32_t next_xid = 1;
267 return htonl(next_xid++);
270 /* Basic parsing of OpenFlow messages. */
272 struct ofputil_msg_type {
273 enum ofputil_msg_code code; /* OFPUTIL_*. */
274 uint8_t ofp_version; /* An OpenFlow version or 0 for "any". */
275 uint32_t value; /* OFPT_*, OFPST_*, NXT_*, or NXST_*. */
276 const char *name; /* e.g. "OFPT_FLOW_REMOVED". */
277 unsigned int min_size; /* Minimum total message size in bytes. */
278 /* 0 if 'min_size' is the exact size that the message must be. Otherwise,
279 * the message may exceed 'min_size' by an even multiple of this value. */
280 unsigned int extra_multiple;
283 /* Represents a malformed OpenFlow message. */
284 static const struct ofputil_msg_type ofputil_invalid_type = {
285 OFPUTIL_MSG_INVALID, 0, 0, "OFPUTIL_MSG_INVALID", 0, 0
288 struct ofputil_msg_category {
289 const char *name; /* e.g. "OpenFlow message" */
290 const struct ofputil_msg_type *types;
292 enum ofperr missing_error; /* Error value for missing type. */
296 ofputil_check_length(const struct ofputil_msg_type *type, unsigned int size)
298 switch (type->extra_multiple) {
300 if (size != type->min_size) {
301 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s with incorrect "
302 "length %u (expected length %u)",
303 type->name, size, type->min_size);
304 return OFPERR_OFPBRC_BAD_LEN;
309 if (size < type->min_size) {
310 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s with incorrect "
311 "length %u (expected length at least %u bytes)",
312 type->name, size, type->min_size);
313 return OFPERR_OFPBRC_BAD_LEN;
318 if (size < type->min_size
319 || (size - type->min_size) % type->extra_multiple) {
320 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s with incorrect "
321 "length %u (must be exactly %u bytes or longer "
322 "by an integer multiple of %u bytes)",
324 type->min_size, type->extra_multiple);
325 return OFPERR_OFPBRC_BAD_LEN;
332 ofputil_lookup_openflow_message(const struct ofputil_msg_category *cat,
333 uint8_t version, uint32_t value,
334 const struct ofputil_msg_type **typep)
336 const struct ofputil_msg_type *type;
338 for (type = cat->types; type < &cat->types[cat->n_types]; type++) {
339 if (type->value == value
340 && (!type->ofp_version || version == type->ofp_version)) {
346 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s of unknown type %"PRIu32,
348 return cat->missing_error;
352 ofputil_decode_vendor(const struct ofp_header *oh, size_t length,
353 const struct ofputil_msg_type **typep)
355 static const struct ofputil_msg_type nxt_messages[] = {
356 { OFPUTIL_NXT_ROLE_REQUEST, OFP10_VERSION,
357 NXT_ROLE_REQUEST, "NXT_ROLE_REQUEST",
358 sizeof(struct nx_role_request), 0 },
360 { OFPUTIL_NXT_ROLE_REPLY, OFP10_VERSION,
361 NXT_ROLE_REPLY, "NXT_ROLE_REPLY",
362 sizeof(struct nx_role_request), 0 },
364 { OFPUTIL_NXT_SET_FLOW_FORMAT, OFP10_VERSION,
365 NXT_SET_FLOW_FORMAT, "NXT_SET_FLOW_FORMAT",
366 sizeof(struct nx_set_flow_format), 0 },
368 { OFPUTIL_NXT_SET_PACKET_IN_FORMAT, OFP10_VERSION,
369 NXT_SET_PACKET_IN_FORMAT, "NXT_SET_PACKET_IN_FORMAT",
370 sizeof(struct nx_set_packet_in_format), 0 },
372 { OFPUTIL_NXT_PACKET_IN, OFP10_VERSION,
373 NXT_PACKET_IN, "NXT_PACKET_IN",
374 sizeof(struct nx_packet_in), 1 },
376 { OFPUTIL_NXT_FLOW_MOD, OFP10_VERSION,
377 NXT_FLOW_MOD, "NXT_FLOW_MOD",
378 sizeof(struct nx_flow_mod), 8 },
380 { OFPUTIL_NXT_FLOW_REMOVED, OFP10_VERSION,
381 NXT_FLOW_REMOVED, "NXT_FLOW_REMOVED",
382 sizeof(struct nx_flow_removed), 8 },
384 { OFPUTIL_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION,
385 NXT_FLOW_MOD_TABLE_ID, "NXT_FLOW_MOD_TABLE_ID",
386 sizeof(struct nx_flow_mod_table_id), 0 },
389 static const struct ofputil_msg_category nxt_category = {
390 "Nicira extension message",
391 nxt_messages, ARRAY_SIZE(nxt_messages),
392 OFPERR_OFPBRC_BAD_SUBTYPE
395 const struct ofp_vendor_header *ovh;
396 const struct nicira_header *nh;
398 if (length < sizeof(struct ofp_vendor_header)) {
399 if (length == ntohs(oh->length)) {
400 VLOG_WARN_RL(&bad_ofmsg_rl, "truncated vendor message");
402 return OFPERR_OFPBRC_BAD_LEN;
405 ovh = (const struct ofp_vendor_header *) oh;
406 if (ovh->vendor != htonl(NX_VENDOR_ID)) {
407 VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor message for unknown "
408 "vendor %"PRIx32, ntohl(ovh->vendor));
409 return OFPERR_OFPBRC_BAD_VENDOR;
412 if (length < sizeof(struct nicira_header)) {
413 if (length == ntohs(oh->length)) {
414 VLOG_WARN_RL(&bad_ofmsg_rl, "received Nicira vendor message of "
415 "length %u (expected at least %zu)",
416 ntohs(ovh->header.length),
417 sizeof(struct nicira_header));
419 return OFPERR_OFPBRC_BAD_LEN;
422 nh = (const struct nicira_header *) oh;
423 return ofputil_lookup_openflow_message(&nxt_category, oh->version,
424 ntohl(nh->subtype), typep);
428 check_nxstats_msg(const struct ofp_header *oh, size_t length)
430 const struct ofp_stats_msg *osm = (const struct ofp_stats_msg *) oh;
433 if (length < sizeof(struct ofp_vendor_stats_msg)) {
434 if (length == ntohs(oh->length)) {
435 VLOG_WARN_RL(&bad_ofmsg_rl, "truncated vendor stats message");
437 return OFPERR_OFPBRC_BAD_LEN;
440 memcpy(&vendor, osm + 1, sizeof vendor);
441 if (vendor != htonl(NX_VENDOR_ID)) {
442 VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor stats message for "
443 "unknown vendor %"PRIx32, ntohl(vendor));
444 return OFPERR_OFPBRC_BAD_VENDOR;
447 if (length < sizeof(struct nicira_stats_msg)) {
448 if (length == ntohs(osm->header.length)) {
449 VLOG_WARN_RL(&bad_ofmsg_rl, "truncated Nicira stats message");
451 return OFPERR_OFPBRC_BAD_LEN;
458 ofputil_decode_nxst_request(const struct ofp_header *oh, size_t length,
459 const struct ofputil_msg_type **typep)
461 static const struct ofputil_msg_type nxst_requests[] = {
462 { OFPUTIL_NXST_FLOW_REQUEST, OFP10_VERSION,
463 NXST_FLOW, "NXST_FLOW request",
464 sizeof(struct nx_flow_stats_request), 8 },
466 { OFPUTIL_NXST_AGGREGATE_REQUEST, OFP10_VERSION,
467 NXST_AGGREGATE, "NXST_AGGREGATE request",
468 sizeof(struct nx_aggregate_stats_request), 8 },
471 static const struct ofputil_msg_category nxst_request_category = {
472 "Nicira extension statistics request",
473 nxst_requests, ARRAY_SIZE(nxst_requests),
474 OFPERR_OFPBRC_BAD_SUBTYPE
477 const struct nicira_stats_msg *nsm;
480 error = check_nxstats_msg(oh, length);
485 nsm = (struct nicira_stats_msg *) oh;
486 return ofputil_lookup_openflow_message(&nxst_request_category, oh->version,
487 ntohl(nsm->subtype), typep);
491 ofputil_decode_nxst_reply(const struct ofp_header *oh, size_t length,
492 const struct ofputil_msg_type **typep)
494 static const struct ofputil_msg_type nxst_replies[] = {
495 { OFPUTIL_NXST_FLOW_REPLY, OFP10_VERSION,
496 NXST_FLOW, "NXST_FLOW reply",
497 sizeof(struct nicira_stats_msg), 8 },
499 { OFPUTIL_NXST_AGGREGATE_REPLY, OFP10_VERSION,
500 NXST_AGGREGATE, "NXST_AGGREGATE reply",
501 sizeof(struct nx_aggregate_stats_reply), 0 },
504 static const struct ofputil_msg_category nxst_reply_category = {
505 "Nicira extension statistics reply",
506 nxst_replies, ARRAY_SIZE(nxst_replies),
507 OFPERR_OFPBRC_BAD_SUBTYPE
510 const struct nicira_stats_msg *nsm;
513 error = check_nxstats_msg(oh, length);
518 nsm = (struct nicira_stats_msg *) oh;
519 return ofputil_lookup_openflow_message(&nxst_reply_category, oh->version,
520 ntohl(nsm->subtype), typep);
524 check_stats_msg(const struct ofp_header *oh, size_t length)
526 if (length < sizeof(struct ofp_stats_msg)) {
527 if (length == ntohs(oh->length)) {
528 VLOG_WARN_RL(&bad_ofmsg_rl, "truncated stats message");
530 return OFPERR_OFPBRC_BAD_LEN;
537 ofputil_decode_ofpst_request(const struct ofp_header *oh, size_t length,
538 const struct ofputil_msg_type **typep)
540 static const struct ofputil_msg_type ofpst_requests[] = {
541 { OFPUTIL_OFPST_DESC_REQUEST, OFP10_VERSION,
542 OFPST_DESC, "OFPST_DESC request",
543 sizeof(struct ofp_stats_msg), 0 },
545 { OFPUTIL_OFPST_FLOW_REQUEST, OFP10_VERSION,
546 OFPST_FLOW, "OFPST_FLOW request",
547 sizeof(struct ofp_flow_stats_request), 0 },
549 { OFPUTIL_OFPST_AGGREGATE_REQUEST, OFP10_VERSION,
550 OFPST_AGGREGATE, "OFPST_AGGREGATE request",
551 sizeof(struct ofp_flow_stats_request), 0 },
553 { OFPUTIL_OFPST_TABLE_REQUEST, OFP10_VERSION,
554 OFPST_TABLE, "OFPST_TABLE request",
555 sizeof(struct ofp_stats_msg), 0 },
557 { OFPUTIL_OFPST_PORT_REQUEST, OFP10_VERSION,
558 OFPST_PORT, "OFPST_PORT request",
559 sizeof(struct ofp_port_stats_request), 0 },
561 { OFPUTIL_OFPST_QUEUE_REQUEST, OFP10_VERSION,
562 OFPST_QUEUE, "OFPST_QUEUE request",
563 sizeof(struct ofp_queue_stats_request), 0 },
566 OFPST_VENDOR, "OFPST_VENDOR request",
567 sizeof(struct ofp_vendor_stats_msg), 1 },
570 static const struct ofputil_msg_category ofpst_request_category = {
571 "OpenFlow statistics",
572 ofpst_requests, ARRAY_SIZE(ofpst_requests),
573 OFPERR_OFPBRC_BAD_STAT
576 const struct ofp_stats_msg *request = (const struct ofp_stats_msg *) oh;
579 error = check_stats_msg(oh, length);
584 error = ofputil_lookup_openflow_message(&ofpst_request_category,
585 oh->version, ntohs(request->type),
587 if (!error && request->type == htons(OFPST_VENDOR)) {
588 error = ofputil_decode_nxst_request(oh, length, typep);
594 ofputil_decode_ofpst_reply(const struct ofp_header *oh, size_t length,
595 const struct ofputil_msg_type **typep)
597 static const struct ofputil_msg_type ofpst_replies[] = {
598 { OFPUTIL_OFPST_DESC_REPLY, OFP10_VERSION,
599 OFPST_DESC, "OFPST_DESC reply",
600 sizeof(struct ofp_desc_stats), 0 },
602 { OFPUTIL_OFPST_FLOW_REPLY, OFP10_VERSION,
603 OFPST_FLOW, "OFPST_FLOW reply",
604 sizeof(struct ofp_stats_msg), 1 },
606 { OFPUTIL_OFPST_AGGREGATE_REPLY, OFP10_VERSION,
607 OFPST_AGGREGATE, "OFPST_AGGREGATE reply",
608 sizeof(struct ofp_aggregate_stats_reply), 0 },
610 { OFPUTIL_OFPST_TABLE_REPLY, OFP10_VERSION,
611 OFPST_TABLE, "OFPST_TABLE reply",
612 sizeof(struct ofp_stats_msg), sizeof(struct ofp_table_stats) },
614 { OFPUTIL_OFPST_PORT_REPLY, OFP10_VERSION,
615 OFPST_PORT, "OFPST_PORT reply",
616 sizeof(struct ofp_stats_msg), sizeof(struct ofp_port_stats) },
618 { OFPUTIL_OFPST_QUEUE_REPLY, OFP10_VERSION,
619 OFPST_QUEUE, "OFPST_QUEUE reply",
620 sizeof(struct ofp_stats_msg), sizeof(struct ofp_queue_stats) },
623 OFPST_VENDOR, "OFPST_VENDOR reply",
624 sizeof(struct ofp_vendor_stats_msg), 1 },
627 static const struct ofputil_msg_category ofpst_reply_category = {
628 "OpenFlow statistics",
629 ofpst_replies, ARRAY_SIZE(ofpst_replies),
630 OFPERR_OFPBRC_BAD_STAT
633 const struct ofp_stats_msg *reply = (const struct ofp_stats_msg *) oh;
636 error = check_stats_msg(oh, length);
641 error = ofputil_lookup_openflow_message(&ofpst_reply_category, oh->version,
642 ntohs(reply->type), typep);
643 if (!error && reply->type == htons(OFPST_VENDOR)) {
644 error = ofputil_decode_nxst_reply(oh, length, typep);
650 ofputil_decode_msg_type__(const struct ofp_header *oh, size_t length,
651 const struct ofputil_msg_type **typep)
653 static const struct ofputil_msg_type ofpt_messages[] = {
654 { OFPUTIL_OFPT_HELLO, OFP10_VERSION,
655 OFPT_HELLO, "OFPT_HELLO",
656 sizeof(struct ofp_hello), 1 },
658 { OFPUTIL_OFPT_ERROR, 0,
659 OFPT_ERROR, "OFPT_ERROR",
660 sizeof(struct ofp_error_msg), 1 },
662 { OFPUTIL_OFPT_ECHO_REQUEST, OFP10_VERSION,
663 OFPT_ECHO_REQUEST, "OFPT_ECHO_REQUEST",
664 sizeof(struct ofp_header), 1 },
666 { OFPUTIL_OFPT_ECHO_REPLY, OFP10_VERSION,
667 OFPT_ECHO_REPLY, "OFPT_ECHO_REPLY",
668 sizeof(struct ofp_header), 1 },
670 { OFPUTIL_OFPT_FEATURES_REQUEST, OFP10_VERSION,
671 OFPT_FEATURES_REQUEST, "OFPT_FEATURES_REQUEST",
672 sizeof(struct ofp_header), 0 },
674 { OFPUTIL_OFPT_FEATURES_REPLY, OFP10_VERSION,
675 OFPT_FEATURES_REPLY, "OFPT_FEATURES_REPLY",
676 sizeof(struct ofp_switch_features), sizeof(struct ofp_phy_port) },
678 { OFPUTIL_OFPT_GET_CONFIG_REQUEST, OFP10_VERSION,
679 OFPT_GET_CONFIG_REQUEST, "OFPT_GET_CONFIG_REQUEST",
680 sizeof(struct ofp_header), 0 },
682 { OFPUTIL_OFPT_GET_CONFIG_REPLY, OFP10_VERSION,
683 OFPT_GET_CONFIG_REPLY, "OFPT_GET_CONFIG_REPLY",
684 sizeof(struct ofp_switch_config), 0 },
686 { OFPUTIL_OFPT_SET_CONFIG, OFP10_VERSION,
687 OFPT_SET_CONFIG, "OFPT_SET_CONFIG",
688 sizeof(struct ofp_switch_config), 0 },
690 { OFPUTIL_OFPT_PACKET_IN, OFP10_VERSION,
691 OFPT_PACKET_IN, "OFPT_PACKET_IN",
692 offsetof(struct ofp_packet_in, data), 1 },
694 { OFPUTIL_OFPT_FLOW_REMOVED, OFP10_VERSION,
695 OFPT_FLOW_REMOVED, "OFPT_FLOW_REMOVED",
696 sizeof(struct ofp_flow_removed), 0 },
698 { OFPUTIL_OFPT_PORT_STATUS, OFP10_VERSION,
699 OFPT_PORT_STATUS, "OFPT_PORT_STATUS",
700 sizeof(struct ofp_port_status), 0 },
702 { OFPUTIL_OFPT_PACKET_OUT, OFP10_VERSION,
703 OFPT_PACKET_OUT, "OFPT_PACKET_OUT",
704 sizeof(struct ofp_packet_out), 1 },
706 { OFPUTIL_OFPT_FLOW_MOD, OFP10_VERSION,
707 OFPT_FLOW_MOD, "OFPT_FLOW_MOD",
708 sizeof(struct ofp_flow_mod), 1 },
710 { OFPUTIL_OFPT_PORT_MOD, OFP10_VERSION,
711 OFPT_PORT_MOD, "OFPT_PORT_MOD",
712 sizeof(struct ofp_port_mod), 0 },
715 OFPT_STATS_REQUEST, "OFPT_STATS_REQUEST",
716 sizeof(struct ofp_stats_msg), 1 },
719 OFPT_STATS_REPLY, "OFPT_STATS_REPLY",
720 sizeof(struct ofp_stats_msg), 1 },
722 { OFPUTIL_OFPT_BARRIER_REQUEST, OFP10_VERSION,
723 OFPT_BARRIER_REQUEST, "OFPT_BARRIER_REQUEST",
724 sizeof(struct ofp_header), 0 },
726 { OFPUTIL_OFPT_BARRIER_REPLY, OFP10_VERSION,
727 OFPT_BARRIER_REPLY, "OFPT_BARRIER_REPLY",
728 sizeof(struct ofp_header), 0 },
731 OFPT_VENDOR, "OFPT_VENDOR",
732 sizeof(struct ofp_vendor_header), 1 },
735 static const struct ofputil_msg_category ofpt_category = {
737 ofpt_messages, ARRAY_SIZE(ofpt_messages),
738 OFPERR_OFPBRC_BAD_TYPE
743 error = ofputil_lookup_openflow_message(&ofpt_category, oh->version,
748 error = ofputil_decode_vendor(oh, length, typep);
751 case OFPT_STATS_REQUEST:
752 error = ofputil_decode_ofpst_request(oh, length, typep);
755 case OFPT_STATS_REPLY:
756 error = ofputil_decode_ofpst_reply(oh, length, typep);
765 /* Decodes the message type represented by 'oh'. Returns 0 if successful or an
766 * OpenFlow error code on failure. Either way, stores in '*typep' a type
767 * structure that can be inspected with the ofputil_msg_type_*() functions.
769 * oh->length must indicate the correct length of the message (and must be at
770 * least sizeof(struct ofp_header)).
772 * Success indicates that 'oh' is at least as long as the minimum-length
773 * message of its type. */
775 ofputil_decode_msg_type(const struct ofp_header *oh,
776 const struct ofputil_msg_type **typep)
778 size_t length = ntohs(oh->length);
781 error = ofputil_decode_msg_type__(oh, length, typep);
783 error = ofputil_check_length(*typep, length);
786 *typep = &ofputil_invalid_type;
791 /* Decodes the message type represented by 'oh', of which only the first
792 * 'length' bytes are available. Returns 0 if successful or an OpenFlow error
793 * code on failure. Either way, stores in '*typep' a type structure that can
794 * be inspected with the ofputil_msg_type_*() functions. */
796 ofputil_decode_msg_type_partial(const struct ofp_header *oh, size_t length,
797 const struct ofputil_msg_type **typep)
801 error = (length >= sizeof *oh
802 ? ofputil_decode_msg_type__(oh, length, typep)
803 : OFPERR_OFPBRC_BAD_LEN);
805 *typep = &ofputil_invalid_type;
810 /* Returns an OFPUTIL_* message type code for 'type'. */
811 enum ofputil_msg_code
812 ofputil_msg_type_code(const struct ofputil_msg_type *type)
820 ofputil_flow_format_is_valid(enum nx_flow_format flow_format)
822 switch (flow_format) {
823 case NXFF_OPENFLOW10:
832 ofputil_flow_format_to_string(enum nx_flow_format flow_format)
834 switch (flow_format) {
835 case NXFF_OPENFLOW10:
845 ofputil_flow_format_from_string(const char *s)
847 return (!strcmp(s, "openflow10") ? NXFF_OPENFLOW10
848 : !strcmp(s, "nxm") ? NXFF_NXM
853 ofputil_packet_in_format_is_valid(enum nx_packet_in_format packet_in_format)
855 switch (packet_in_format) {
856 case NXPIF_OPENFLOW10:
865 ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format)
867 switch (packet_in_format) {
868 case NXPIF_OPENFLOW10:
878 ofputil_packet_in_format_from_string(const char *s)
880 return (!strcmp(s, "openflow10") ? NXPIF_OPENFLOW10
881 : !strcmp(s, "nxm") ? NXPIF_NXM
886 regs_fully_wildcarded(const struct flow_wildcards *wc)
890 for (i = 0; i < FLOW_N_REGS; i++) {
891 if (wc->reg_masks[i] != 0) {
898 /* Returns the minimum nx_flow_format to use for sending 'rule' to a switch
899 * (e.g. to add or remove a flow). Only NXM can handle tunnel IDs, registers,
900 * or fixing the Ethernet multicast bit. Otherwise, it's better to use
901 * NXFF_OPENFLOW10 for backward compatibility. */
903 ofputil_min_flow_format(const struct cls_rule *rule)
905 const struct flow_wildcards *wc = &rule->wc;
907 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 7);
909 /* Only NXM supports separately wildcards the Ethernet multicast bit. */
910 if (!(wc->wildcards & FWW_DL_DST) != !(wc->wildcards & FWW_ETH_MCAST)) {
914 /* Only NXM supports matching ARP hardware addresses. */
915 if (!(wc->wildcards & FWW_ARP_SHA) || !(wc->wildcards & FWW_ARP_THA)) {
919 /* Only NXM supports matching IPv6 traffic. */
920 if (!(wc->wildcards & FWW_DL_TYPE)
921 && (rule->flow.dl_type == htons(ETH_TYPE_IPV6))) {
925 /* Only NXM supports matching registers. */
926 if (!regs_fully_wildcarded(wc)) {
930 /* Only NXM supports matching tun_id. */
931 if (wc->tun_id_mask != htonll(0)) {
935 /* Only NXM supports matching fragments. */
936 if (wc->nw_frag_mask) {
940 /* Only NXM supports matching IPv6 flow label. */
941 if (!(wc->wildcards & FWW_IPV6_LABEL)) {
945 /* Only NXM supports matching IP ECN bits. */
946 if (!(wc->wildcards & FWW_NW_ECN)) {
950 /* Only NXM supports matching IP TTL/hop limit. */
951 if (!(wc->wildcards & FWW_NW_TTL)) {
955 /* Other formats can express this rule. */
956 return NXFF_OPENFLOW10;
959 /* Returns an OpenFlow message that can be used to set the flow format to
962 ofputil_make_set_flow_format(enum nx_flow_format flow_format)
964 struct nx_set_flow_format *sff;
967 sff = make_nxmsg(sizeof *sff, NXT_SET_FLOW_FORMAT, &msg);
968 sff->format = htonl(flow_format);
974 ofputil_make_set_packet_in_format(enum nx_packet_in_format packet_in_format)
976 struct nx_set_packet_in_format *spif;
979 spif = make_nxmsg(sizeof *spif, NXT_SET_PACKET_IN_FORMAT, &msg);
980 spif->format = htonl(packet_in_format);
985 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
986 * extension on or off (according to 'flow_mod_table_id'). */
988 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
990 struct nx_flow_mod_table_id *nfmti;
993 nfmti = make_nxmsg(sizeof *nfmti, NXT_FLOW_MOD_TABLE_ID, &msg);
994 nfmti->set = flow_mod_table_id;
998 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
999 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
1002 * 'flow_mod_table_id' should be true if the NXT_FLOW_MOD_TABLE_ID extension is
1003 * enabled, false otherwise.
1005 * Does not validate the flow_mod actions. */
1007 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
1008 const struct ofp_header *oh, bool flow_mod_table_id)
1010 const struct ofputil_msg_type *type;
1014 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1016 ofputil_decode_msg_type(oh, &type);
1017 if (ofputil_msg_type_code(type) == OFPUTIL_OFPT_FLOW_MOD) {
1018 /* Standard OpenFlow flow_mod. */
1019 const struct ofp_flow_mod *ofm;
1023 /* Dissect the message. */
1024 ofm = ofpbuf_pull(&b, sizeof *ofm);
1025 error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
1030 /* Set priority based on original wildcards. Normally we'd allow
1031 * ofputil_cls_rule_from_match() to do this for us, but
1032 * ofputil_normalize_rule() can put wildcards where the original flow
1033 * didn't have them. */
1034 priority = ntohs(ofm->priority);
1035 if (!(ofm->match.wildcards & htonl(OFPFW_ALL))) {
1036 priority = UINT16_MAX;
1039 /* Translate the rule. */
1040 ofputil_cls_rule_from_match(&ofm->match, priority, &fm->cr);
1041 ofputil_normalize_rule(&fm->cr, NXFF_OPENFLOW10);
1043 /* Translate the message. */
1044 fm->cookie = ofm->cookie;
1045 fm->cookie_mask = htonll(UINT64_MAX);
1046 command = ntohs(ofm->command);
1047 fm->idle_timeout = ntohs(ofm->idle_timeout);
1048 fm->hard_timeout = ntohs(ofm->hard_timeout);
1049 fm->buffer_id = ntohl(ofm->buffer_id);
1050 fm->out_port = ntohs(ofm->out_port);
1051 fm->flags = ntohs(ofm->flags);
1052 } else if (ofputil_msg_type_code(type) == OFPUTIL_NXT_FLOW_MOD) {
1053 /* Nicira extended flow_mod. */
1054 const struct nx_flow_mod *nfm;
1057 /* Dissect the message. */
1058 nfm = ofpbuf_pull(&b, sizeof *nfm);
1059 error = nx_pull_match(&b, ntohs(nfm->match_len), ntohs(nfm->priority),
1060 &fm->cr, &fm->cookie, &fm->cookie_mask);
1064 error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
1069 /* Translate the message. */
1070 command = ntohs(nfm->command);
1071 if (command == OFPFC_ADD) {
1072 if (fm->cookie_mask) {
1073 /* The "NXM_NX_COOKIE*" matches are not valid for flow
1074 * additions. Additions must use the "cookie" field of
1075 * the "nx_flow_mod" structure. */
1076 return OFPERR_NXBRC_NXM_INVALID;
1078 fm->cookie = nfm->cookie;
1079 fm->cookie_mask = htonll(UINT64_MAX);
1082 fm->idle_timeout = ntohs(nfm->idle_timeout);
1083 fm->hard_timeout = ntohs(nfm->hard_timeout);
1084 fm->buffer_id = ntohl(nfm->buffer_id);
1085 fm->out_port = ntohs(nfm->out_port);
1086 fm->flags = ntohs(nfm->flags);
1091 if (flow_mod_table_id) {
1092 fm->command = command & 0xff;
1093 fm->table_id = command >> 8;
1095 fm->command = command;
1096 fm->table_id = 0xff;
1102 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
1103 * 'flow_format' and returns the message.
1105 * 'flow_mod_table_id' should be true if the NXT_FLOW_MOD_TABLE_ID extension is
1106 * enabled, false otherwise. */
1108 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
1109 enum nx_flow_format flow_format,
1110 bool flow_mod_table_id)
1112 size_t actions_len = fm->n_actions * sizeof *fm->actions;
1116 command = (flow_mod_table_id
1117 ? (fm->command & 0xff) | (fm->table_id << 8)
1120 if (flow_format == NXFF_OPENFLOW10) {
1121 struct ofp_flow_mod *ofm;
1123 msg = ofpbuf_new(sizeof *ofm + actions_len);
1124 ofm = put_openflow(sizeof *ofm, OFPT_FLOW_MOD, msg);
1125 ofputil_cls_rule_to_match(&fm->cr, &ofm->match);
1126 ofm->cookie = fm->cookie;
1127 ofm->command = htons(command);
1128 ofm->idle_timeout = htons(fm->idle_timeout);
1129 ofm->hard_timeout = htons(fm->hard_timeout);
1130 ofm->priority = htons(fm->cr.priority);
1131 ofm->buffer_id = htonl(fm->buffer_id);
1132 ofm->out_port = htons(fm->out_port);
1133 ofm->flags = htons(fm->flags);
1134 } else if (flow_format == NXFF_NXM) {
1135 struct nx_flow_mod *nfm;
1138 msg = ofpbuf_new(sizeof *nfm + NXM_TYPICAL_LEN + actions_len);
1139 put_nxmsg(sizeof *nfm, NXT_FLOW_MOD, msg);
1141 nfm->command = htons(command);
1142 if (command == OFPFC_ADD) {
1143 nfm->cookie = fm->cookie;
1144 match_len = nx_put_match(msg, &fm->cr, 0, 0);
1147 match_len = nx_put_match(msg, &fm->cr,
1148 fm->cookie, fm->cookie_mask);
1150 nfm->idle_timeout = htons(fm->idle_timeout);
1151 nfm->hard_timeout = htons(fm->hard_timeout);
1152 nfm->priority = htons(fm->cr.priority);
1153 nfm->buffer_id = htonl(fm->buffer_id);
1154 nfm->out_port = htons(fm->out_port);
1155 nfm->flags = htons(fm->flags);
1156 nfm->match_len = htons(match_len);
1161 ofpbuf_put(msg, fm->actions, actions_len);
1162 update_openflow_length(msg);
1167 ofputil_decode_ofpst_flow_request(struct ofputil_flow_stats_request *fsr,
1168 const struct ofp_header *oh,
1171 const struct ofp_flow_stats_request *ofsr =
1172 (const struct ofp_flow_stats_request *) oh;
1174 fsr->aggregate = aggregate;
1175 ofputil_cls_rule_from_match(&ofsr->match, 0, &fsr->match);
1176 fsr->out_port = ntohs(ofsr->out_port);
1177 fsr->table_id = ofsr->table_id;
1178 fsr->cookie = fsr->cookie_mask = htonll(0);
1184 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
1185 const struct ofp_header *oh,
1188 const struct nx_flow_stats_request *nfsr;
1192 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1194 nfsr = ofpbuf_pull(&b, sizeof *nfsr);
1195 error = nx_pull_match(&b, ntohs(nfsr->match_len), 0, &fsr->match,
1196 &fsr->cookie, &fsr->cookie_mask);
1201 return OFPERR_OFPBRC_BAD_LEN;
1204 fsr->aggregate = aggregate;
1205 fsr->out_port = ntohs(nfsr->out_port);
1206 fsr->table_id = nfsr->table_id;
1211 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
1212 * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
1213 * successful, otherwise an OpenFlow error code. */
1215 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
1216 const struct ofp_header *oh)
1218 const struct ofputil_msg_type *type;
1222 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1224 ofputil_decode_msg_type(oh, &type);
1225 code = ofputil_msg_type_code(type);
1227 case OFPUTIL_OFPST_FLOW_REQUEST:
1228 return ofputil_decode_ofpst_flow_request(fsr, oh, false);
1230 case OFPUTIL_OFPST_AGGREGATE_REQUEST:
1231 return ofputil_decode_ofpst_flow_request(fsr, oh, true);
1233 case OFPUTIL_NXST_FLOW_REQUEST:
1234 return ofputil_decode_nxst_flow_request(fsr, oh, false);
1236 case OFPUTIL_NXST_AGGREGATE_REQUEST:
1237 return ofputil_decode_nxst_flow_request(fsr, oh, true);
1240 /* Hey, the caller lied. */
1245 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
1246 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
1247 * 'flow_format', and returns the message. */
1249 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
1250 enum nx_flow_format flow_format)
1254 if (flow_format == NXFF_OPENFLOW10) {
1255 struct ofp_flow_stats_request *ofsr;
1258 type = fsr->aggregate ? OFPST_AGGREGATE : OFPST_FLOW;
1259 ofsr = ofputil_make_stats_request(sizeof *ofsr, type, 0, &msg);
1260 ofputil_cls_rule_to_match(&fsr->match, &ofsr->match);
1261 ofsr->table_id = fsr->table_id;
1262 ofsr->out_port = htons(fsr->out_port);
1263 } else if (flow_format == NXFF_NXM) {
1264 struct nx_flow_stats_request *nfsr;
1268 subtype = fsr->aggregate ? NXST_AGGREGATE : NXST_FLOW;
1269 ofputil_make_stats_request(sizeof *nfsr, OFPST_VENDOR, subtype, &msg);
1270 match_len = nx_put_match(msg, &fsr->match,
1271 fsr->cookie, fsr->cookie_mask);
1274 nfsr->out_port = htons(fsr->out_port);
1275 nfsr->match_len = htons(match_len);
1276 nfsr->table_id = fsr->table_id;
1284 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
1285 * ofputil_flow_stats in 'fs'.
1287 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
1288 * OpenFlow message. Calling this function multiple times for a single 'msg'
1289 * iterates through the replies. The caller must initially leave 'msg''s layer
1290 * pointers null and not modify them between calls.
1292 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1293 * otherwise a positive errno value. */
1295 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
1298 const struct ofputil_msg_type *type;
1301 ofputil_decode_msg_type(msg->l2 ? msg->l2 : msg->data, &type);
1302 code = ofputil_msg_type_code(type);
1304 msg->l2 = msg->data;
1305 if (code == OFPUTIL_OFPST_FLOW_REPLY) {
1306 ofpbuf_pull(msg, sizeof(struct ofp_stats_msg));
1307 } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
1308 ofpbuf_pull(msg, sizeof(struct nicira_stats_msg));
1316 } else if (code == OFPUTIL_OFPST_FLOW_REPLY) {
1317 const struct ofp_flow_stats *ofs;
1320 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
1322 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
1323 "bytes at end", msg->size);
1327 length = ntohs(ofs->length);
1328 if (length < sizeof *ofs) {
1329 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
1330 "length %zu", length);
1334 if (ofputil_pull_actions(msg, length - sizeof *ofs,
1335 &fs->actions, &fs->n_actions)) {
1339 fs->cookie = get_32aligned_be64(&ofs->cookie);
1340 ofputil_cls_rule_from_match(&ofs->match, ntohs(ofs->priority),
1342 fs->table_id = ofs->table_id;
1343 fs->duration_sec = ntohl(ofs->duration_sec);
1344 fs->duration_nsec = ntohl(ofs->duration_nsec);
1345 fs->idle_timeout = ntohs(ofs->idle_timeout);
1346 fs->hard_timeout = ntohs(ofs->hard_timeout);
1347 fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
1348 fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
1349 } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
1350 const struct nx_flow_stats *nfs;
1351 size_t match_len, length;
1353 nfs = ofpbuf_try_pull(msg, sizeof *nfs);
1355 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
1356 "bytes at end", msg->size);
1360 length = ntohs(nfs->length);
1361 match_len = ntohs(nfs->match_len);
1362 if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
1363 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
1364 "claims invalid length %zu", match_len, length);
1367 if (nx_pull_match(msg, match_len, ntohs(nfs->priority), &fs->rule,
1372 if (ofputil_pull_actions(msg,
1373 length - sizeof *nfs - ROUND_UP(match_len, 8),
1374 &fs->actions, &fs->n_actions)) {
1378 fs->cookie = nfs->cookie;
1379 fs->table_id = nfs->table_id;
1380 fs->duration_sec = ntohl(nfs->duration_sec);
1381 fs->duration_nsec = ntohl(nfs->duration_nsec);
1382 fs->idle_timeout = ntohs(nfs->idle_timeout);
1383 fs->hard_timeout = ntohs(nfs->hard_timeout);
1384 fs->packet_count = ntohll(nfs->packet_count);
1385 fs->byte_count = ntohll(nfs->byte_count);
1393 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
1395 * We use this in situations where OVS internally uses UINT64_MAX to mean
1396 * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
1398 unknown_to_zero(uint64_t count)
1400 return count != UINT64_MAX ? count : 0;
1403 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
1404 * those already present in the list of ofpbufs in 'replies'. 'replies' should
1405 * have been initialized with ofputil_start_stats_reply(). */
1407 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
1408 struct list *replies)
1410 size_t act_len = fs->n_actions * sizeof *fs->actions;
1411 const struct ofp_stats_msg *osm;
1413 osm = ofpbuf_from_list(list_back(replies))->data;
1414 if (osm->type == htons(OFPST_FLOW)) {
1415 size_t len = offsetof(struct ofp_flow_stats, actions) + act_len;
1416 struct ofp_flow_stats *ofs;
1418 ofs = ofputil_append_stats_reply(len, replies);
1419 ofs->length = htons(len);
1420 ofs->table_id = fs->table_id;
1422 ofputil_cls_rule_to_match(&fs->rule, &ofs->match);
1423 ofs->duration_sec = htonl(fs->duration_sec);
1424 ofs->duration_nsec = htonl(fs->duration_nsec);
1425 ofs->priority = htons(fs->rule.priority);
1426 ofs->idle_timeout = htons(fs->idle_timeout);
1427 ofs->hard_timeout = htons(fs->hard_timeout);
1428 memset(ofs->pad2, 0, sizeof ofs->pad2);
1429 put_32aligned_be64(&ofs->cookie, fs->cookie);
1430 put_32aligned_be64(&ofs->packet_count,
1431 htonll(unknown_to_zero(fs->packet_count)));
1432 put_32aligned_be64(&ofs->byte_count,
1433 htonll(unknown_to_zero(fs->byte_count)));
1434 memcpy(ofs->actions, fs->actions, act_len);
1435 } else if (osm->type == htons(OFPST_VENDOR)) {
1436 struct nx_flow_stats *nfs;
1440 msg = ofputil_reserve_stats_reply(
1441 sizeof *nfs + NXM_MAX_LEN + act_len, replies);
1442 start_len = msg->size;
1444 nfs = ofpbuf_put_uninit(msg, sizeof *nfs);
1445 nfs->table_id = fs->table_id;
1447 nfs->duration_sec = htonl(fs->duration_sec);
1448 nfs->duration_nsec = htonl(fs->duration_nsec);
1449 nfs->priority = htons(fs->rule.priority);
1450 nfs->idle_timeout = htons(fs->idle_timeout);
1451 nfs->hard_timeout = htons(fs->hard_timeout);
1452 nfs->match_len = htons(nx_put_match(msg, &fs->rule, 0, 0));
1453 memset(nfs->pad2, 0, sizeof nfs->pad2);
1454 nfs->cookie = fs->cookie;
1455 nfs->packet_count = htonll(fs->packet_count);
1456 nfs->byte_count = htonll(fs->byte_count);
1457 ofpbuf_put(msg, fs->actions, act_len);
1458 nfs->length = htons(msg->size - start_len);
1464 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
1465 * NXST_AGGREGATE reply according to 'flow_format', and returns the message. */
1467 ofputil_encode_aggregate_stats_reply(
1468 const struct ofputil_aggregate_stats *stats,
1469 const struct ofp_stats_msg *request)
1473 if (request->type == htons(OFPST_AGGREGATE)) {
1474 struct ofp_aggregate_stats_reply *asr;
1476 asr = ofputil_make_stats_reply(sizeof *asr, request, &msg);
1477 put_32aligned_be64(&asr->packet_count,
1478 htonll(unknown_to_zero(stats->packet_count)));
1479 put_32aligned_be64(&asr->byte_count,
1480 htonll(unknown_to_zero(stats->byte_count)));
1481 asr->flow_count = htonl(stats->flow_count);
1482 } else if (request->type == htons(OFPST_VENDOR)) {
1483 struct nx_aggregate_stats_reply *nasr;
1485 nasr = ofputil_make_stats_reply(sizeof *nasr, request, &msg);
1486 assert(nasr->nsm.subtype == htonl(NXST_AGGREGATE));
1487 nasr->packet_count = htonll(stats->packet_count);
1488 nasr->byte_count = htonll(stats->byte_count);
1489 nasr->flow_count = htonl(stats->flow_count);
1497 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
1498 * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
1499 * an OpenFlow error code. */
1501 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
1502 const struct ofp_header *oh)
1504 const struct ofputil_msg_type *type;
1505 enum ofputil_msg_code code;
1507 ofputil_decode_msg_type(oh, &type);
1508 code = ofputil_msg_type_code(type);
1509 if (code == OFPUTIL_OFPT_FLOW_REMOVED) {
1510 const struct ofp_flow_removed *ofr;
1512 ofr = (const struct ofp_flow_removed *) oh;
1513 ofputil_cls_rule_from_match(&ofr->match, ntohs(ofr->priority),
1515 fr->cookie = ofr->cookie;
1516 fr->reason = ofr->reason;
1517 fr->duration_sec = ntohl(ofr->duration_sec);
1518 fr->duration_nsec = ntohl(ofr->duration_nsec);
1519 fr->idle_timeout = ntohs(ofr->idle_timeout);
1520 fr->packet_count = ntohll(ofr->packet_count);
1521 fr->byte_count = ntohll(ofr->byte_count);
1522 } else if (code == OFPUTIL_NXT_FLOW_REMOVED) {
1523 struct nx_flow_removed *nfr;
1527 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1529 nfr = ofpbuf_pull(&b, sizeof *nfr);
1530 error = nx_pull_match(&b, ntohs(nfr->match_len), ntohs(nfr->priority),
1531 &fr->rule, NULL, NULL);
1536 return OFPERR_OFPBRC_BAD_LEN;
1539 fr->cookie = nfr->cookie;
1540 fr->reason = nfr->reason;
1541 fr->duration_sec = ntohl(nfr->duration_sec);
1542 fr->duration_nsec = ntohl(nfr->duration_nsec);
1543 fr->idle_timeout = ntohs(nfr->idle_timeout);
1544 fr->packet_count = ntohll(nfr->packet_count);
1545 fr->byte_count = ntohll(nfr->byte_count);
1553 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
1554 * NXT_FLOW_REMOVED message 'oh' according to 'flow_format', and returns the
1557 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
1558 enum nx_flow_format flow_format)
1562 if (flow_format == NXFF_OPENFLOW10) {
1563 struct ofp_flow_removed *ofr;
1565 ofr = make_openflow_xid(sizeof *ofr, OFPT_FLOW_REMOVED, htonl(0),
1567 ofputil_cls_rule_to_match(&fr->rule, &ofr->match);
1568 ofr->cookie = fr->cookie;
1569 ofr->priority = htons(fr->rule.priority);
1570 ofr->reason = fr->reason;
1571 ofr->duration_sec = htonl(fr->duration_sec);
1572 ofr->duration_nsec = htonl(fr->duration_nsec);
1573 ofr->idle_timeout = htons(fr->idle_timeout);
1574 ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
1575 ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
1576 } else if (flow_format == NXFF_NXM) {
1577 struct nx_flow_removed *nfr;
1580 make_nxmsg_xid(sizeof *nfr, NXT_FLOW_REMOVED, htonl(0), &msg);
1581 match_len = nx_put_match(msg, &fr->rule, 0, 0);
1584 nfr->cookie = fr->cookie;
1585 nfr->priority = htons(fr->rule.priority);
1586 nfr->reason = fr->reason;
1587 nfr->duration_sec = htonl(fr->duration_sec);
1588 nfr->duration_nsec = htonl(fr->duration_nsec);
1589 nfr->idle_timeout = htons(fr->idle_timeout);
1590 nfr->match_len = htons(match_len);
1591 nfr->packet_count = htonll(fr->packet_count);
1592 nfr->byte_count = htonll(fr->byte_count);
1601 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
1602 const struct ofp_header *oh)
1604 const struct ofputil_msg_type *type;
1605 enum ofputil_msg_code code;
1607 ofputil_decode_msg_type(oh, &type);
1608 code = ofputil_msg_type_code(type);
1609 memset(pin, 0, sizeof *pin);
1611 if (code == OFPUTIL_OFPT_PACKET_IN) {
1612 const struct ofp_packet_in *opi = (const struct ofp_packet_in *) oh;
1614 pin->packet = opi->data;
1615 pin->packet_len = ntohs(opi->header.length)
1616 - offsetof(struct ofp_packet_in, data);
1618 pin->fmd.in_port = ntohs(opi->in_port);
1619 pin->reason = opi->reason;
1620 pin->buffer_id = ntohl(opi->buffer_id);
1621 pin->total_len = ntohs(opi->total_len);
1622 } else if (code == OFPUTIL_NXT_PACKET_IN) {
1623 const struct nx_packet_in *npi;
1624 struct cls_rule rule;
1628 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1630 npi = ofpbuf_pull(&b, sizeof *npi);
1631 error = nx_pull_match_loose(&b, ntohs(npi->match_len), 0, &rule, NULL,
1637 if (!ofpbuf_try_pull(&b, 2)) {
1638 return OFPERR_OFPBRC_BAD_LEN;
1641 pin->packet = b.data;
1642 pin->packet_len = b.size;
1643 pin->reason = npi->reason;
1644 pin->table_id = npi->table_id;
1645 pin->cookie = npi->cookie;
1647 pin->fmd.in_port = rule.flow.in_port;
1649 pin->fmd.tun_id = rule.flow.tun_id;
1650 pin->fmd.tun_id_mask = rule.wc.tun_id_mask;
1652 memcpy(pin->fmd.regs, rule.flow.regs, sizeof pin->fmd.regs);
1653 memcpy(pin->fmd.reg_masks, rule.wc.reg_masks,
1654 sizeof pin->fmd.reg_masks);
1656 pin->buffer_id = ntohl(npi->buffer_id);
1657 pin->total_len = ntohs(npi->total_len);
1665 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
1666 * in the format specified by 'packet_in_format'. */
1668 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
1669 enum nx_packet_in_format packet_in_format)
1671 size_t send_len = MIN(pin->send_len, pin->packet_len);
1672 struct ofpbuf *packet;
1674 /* Add OFPT_PACKET_IN. */
1675 if (packet_in_format == NXPIF_OPENFLOW10) {
1676 size_t header_len = offsetof(struct ofp_packet_in, data);
1677 struct ofp_packet_in *opi;
1679 packet = ofpbuf_new(send_len + header_len);
1680 opi = ofpbuf_put_zeros(packet, header_len);
1681 opi->header.version = OFP_VERSION;
1682 opi->header.type = OFPT_PACKET_IN;
1683 opi->total_len = htons(pin->total_len);
1684 opi->in_port = htons(pin->fmd.in_port);
1685 opi->reason = pin->reason;
1686 opi->buffer_id = htonl(pin->buffer_id);
1688 ofpbuf_put(packet, pin->packet, send_len);
1689 } else if (packet_in_format == NXPIF_NXM) {
1690 struct nx_packet_in *npi;
1691 struct cls_rule rule;
1695 /* Estimate of required PACKET_IN length includes the NPI header, space
1696 * for the match (2 times sizeof the metadata seems like enough), 2
1697 * bytes for padding, and the packet length. */
1698 packet = ofpbuf_new(sizeof *npi + sizeof(struct flow_metadata) * 2
1701 cls_rule_init_catchall(&rule, 0);
1702 cls_rule_set_tun_id_masked(&rule, pin->fmd.tun_id,
1703 pin->fmd.tun_id_mask);
1705 for (i = 0; i < FLOW_N_REGS; i++) {
1706 cls_rule_set_reg_masked(&rule, i, pin->fmd.regs[i],
1707 pin->fmd.reg_masks[i]);
1710 cls_rule_set_in_port(&rule, pin->fmd.in_port);
1712 ofpbuf_put_zeros(packet, sizeof *npi);
1713 match_len = nx_put_match(packet, &rule, 0, 0);
1714 ofpbuf_put_zeros(packet, 2);
1715 ofpbuf_put(packet, pin->packet, send_len);
1718 npi->nxh.header.version = OFP_VERSION;
1719 npi->nxh.header.type = OFPT_VENDOR;
1720 npi->nxh.vendor = htonl(NX_VENDOR_ID);
1721 npi->nxh.subtype = htonl(NXT_PACKET_IN);
1723 npi->buffer_id = htonl(pin->buffer_id);
1724 npi->total_len = htons(pin->total_len);
1725 npi->reason = pin->reason;
1726 npi->table_id = pin->table_id;
1727 npi->cookie = pin->cookie;
1728 npi->match_len = htons(match_len);
1732 update_openflow_length(packet);
1737 /* Returns a string representing the message type of 'type'. The string is the
1738 * enumeration constant for the type, e.g. "OFPT_HELLO". For statistics
1739 * messages, the constant is followed by "request" or "reply",
1740 * e.g. "OFPST_AGGREGATE reply". */
1742 ofputil_msg_type_name(const struct ofputil_msg_type *type)
1747 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
1748 * 'openflow_len', starting with an OpenFlow header with the given 'type' and
1749 * an arbitrary transaction id. Allocated bytes beyond the header, if any, are
1752 * The caller is responsible for freeing '*bufferp' when it is no longer
1755 * The OpenFlow header length is initially set to 'openflow_len'; if the
1756 * message is later extended, the length should be updated with
1757 * update_openflow_length() before sending.
1759 * Returns the header. */
1761 make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **bufferp)
1763 *bufferp = ofpbuf_new(openflow_len);
1764 return put_openflow_xid(openflow_len, type, alloc_xid(), *bufferp);
1767 /* Similar to make_openflow() but creates a Nicira vendor extension message
1768 * with the specific 'subtype'. 'subtype' should be in host byte order. */
1770 make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **bufferp)
1772 return make_nxmsg_xid(openflow_len, subtype, alloc_xid(), bufferp);
1775 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
1776 * 'openflow_len', starting with an OpenFlow header with the given 'type' and
1777 * transaction id 'xid'. Allocated bytes beyond the header, if any, are
1780 * The caller is responsible for freeing '*bufferp' when it is no longer
1783 * The OpenFlow header length is initially set to 'openflow_len'; if the
1784 * message is later extended, the length should be updated with
1785 * update_openflow_length() before sending.
1787 * Returns the header. */
1789 make_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
1790 struct ofpbuf **bufferp)
1792 *bufferp = ofpbuf_new(openflow_len);
1793 return put_openflow_xid(openflow_len, type, xid, *bufferp);
1796 /* Similar to make_openflow_xid() but creates a Nicira vendor extension message
1797 * with the specific 'subtype'. 'subtype' should be in host byte order. */
1799 make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
1800 struct ofpbuf **bufferp)
1802 *bufferp = ofpbuf_new(openflow_len);
1803 return put_nxmsg_xid(openflow_len, subtype, xid, *bufferp);
1806 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
1807 * with the given 'type' and an arbitrary transaction id. Allocated bytes
1808 * beyond the header, if any, are zeroed.
1810 * The OpenFlow header length is initially set to 'openflow_len'; if the
1811 * message is later extended, the length should be updated with
1812 * update_openflow_length() before sending.
1814 * Returns the header. */
1816 put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *buffer)
1818 return put_openflow_xid(openflow_len, type, alloc_xid(), buffer);
1821 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
1822 * with the given 'type' and an transaction id 'xid'. Allocated bytes beyond
1823 * the header, if any, are zeroed.
1825 * The OpenFlow header length is initially set to 'openflow_len'; if the
1826 * message is later extended, the length should be updated with
1827 * update_openflow_length() before sending.
1829 * Returns the header. */
1831 put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
1832 struct ofpbuf *buffer)
1834 struct ofp_header *oh;
1836 assert(openflow_len >= sizeof *oh);
1837 assert(openflow_len <= UINT16_MAX);
1839 oh = ofpbuf_put_uninit(buffer, openflow_len);
1840 oh->version = OFP_VERSION;
1842 oh->length = htons(openflow_len);
1844 memset(oh + 1, 0, openflow_len - sizeof *oh);
1848 /* Similar to put_openflow() but append a Nicira vendor extension message with
1849 * the specific 'subtype'. 'subtype' should be in host byte order. */
1851 put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *buffer)
1853 return put_nxmsg_xid(openflow_len, subtype, alloc_xid(), buffer);
1856 /* Similar to put_openflow_xid() but append a Nicira vendor extension message
1857 * with the specific 'subtype'. 'subtype' should be in host byte order. */
1859 put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
1860 struct ofpbuf *buffer)
1862 struct nicira_header *nxh;
1864 nxh = put_openflow_xid(openflow_len, OFPT_VENDOR, xid, buffer);
1865 nxh->vendor = htonl(NX_VENDOR_ID);
1866 nxh->subtype = htonl(subtype);
1870 /* Updates the 'length' field of the OpenFlow message in 'buffer' to
1871 * 'buffer->size'. */
1873 update_openflow_length(struct ofpbuf *buffer)
1875 struct ofp_header *oh = ofpbuf_at_assert(buffer, 0, sizeof *oh);
1876 oh->length = htons(buffer->size);
1880 put_stats__(ovs_be32 xid, uint8_t ofp_type,
1881 ovs_be16 ofpst_type, ovs_be32 nxst_subtype,
1884 if (ofpst_type == htons(OFPST_VENDOR)) {
1885 struct nicira_stats_msg *nsm;
1887 nsm = put_openflow_xid(sizeof *nsm, ofp_type, xid, msg);
1888 nsm->vsm.osm.type = ofpst_type;
1889 nsm->vsm.vendor = htonl(NX_VENDOR_ID);
1890 nsm->subtype = nxst_subtype;
1892 struct ofp_stats_msg *osm;
1894 osm = put_openflow_xid(sizeof *osm, ofp_type, xid, msg);
1895 osm->type = ofpst_type;
1899 /* Creates a statistics request message with total length 'openflow_len'
1900 * (including all headers) and the given 'ofpst_type', and stores the buffer
1901 * containing the new message in '*bufferp'. If 'ofpst_type' is OFPST_VENDOR
1902 * then 'nxst_subtype' is used as the Nicira vendor extension statistics
1903 * subtype (otherwise 'nxst_subtype' is ignored).
1905 * Initializes bytes following the headers to all-bits-zero.
1907 * Returns the first byte of the new message. */
1909 ofputil_make_stats_request(size_t openflow_len, uint16_t ofpst_type,
1910 uint32_t nxst_subtype, struct ofpbuf **bufferp)
1914 msg = *bufferp = ofpbuf_new(openflow_len);
1915 put_stats__(alloc_xid(), OFPT_STATS_REQUEST,
1916 htons(ofpst_type), htonl(nxst_subtype), msg);
1917 ofpbuf_padto(msg, openflow_len);
1923 put_stats_reply__(const struct ofp_stats_msg *request, struct ofpbuf *msg)
1925 assert(request->header.type == OFPT_STATS_REQUEST ||
1926 request->header.type == OFPT_STATS_REPLY);
1927 put_stats__(request->header.xid, OFPT_STATS_REPLY, request->type,
1928 (request->type != htons(OFPST_VENDOR)
1930 : ((const struct nicira_stats_msg *) request)->subtype),
1934 /* Creates a statistics reply message with total length 'openflow_len'
1935 * (including all headers) and the same type (either a standard OpenFlow
1936 * statistics type or a Nicira extension type and subtype) as 'request', and
1937 * stores the buffer containing the new message in '*bufferp'.
1939 * Initializes bytes following the headers to all-bits-zero.
1941 * Returns the first byte of the new message. */
1943 ofputil_make_stats_reply(size_t openflow_len,
1944 const struct ofp_stats_msg *request,
1945 struct ofpbuf **bufferp)
1949 msg = *bufferp = ofpbuf_new(openflow_len);
1950 put_stats_reply__(request, msg);
1951 ofpbuf_padto(msg, openflow_len);
1956 /* Initializes 'replies' as a list of ofpbufs that will contain a series of
1957 * replies to 'request', which should be an OpenFlow or Nicira extension
1958 * statistics request. Initially 'replies' will have a single reply message
1959 * that has only a header. The functions ofputil_reserve_stats_reply() and
1960 * ofputil_append_stats_reply() may be used to add to the reply. */
1962 ofputil_start_stats_reply(const struct ofp_stats_msg *request,
1963 struct list *replies)
1967 msg = ofpbuf_new(1024);
1968 put_stats_reply__(request, msg);
1971 list_push_back(replies, &msg->list_node);
1974 /* Prepares to append up to 'len' bytes to the series of statistics replies in
1975 * 'replies', which should have been initialized with
1976 * ofputil_start_stats_reply(). Returns an ofpbuf with at least 'len' bytes of
1977 * tailroom. (The 'len' bytes have not actually be allocated; the caller must
1978 * do so with e.g. ofpbuf_put_uninit().) */
1980 ofputil_reserve_stats_reply(size_t len, struct list *replies)
1982 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
1983 struct ofp_stats_msg *osm = msg->data;
1985 if (msg->size + len <= UINT16_MAX) {
1986 ofpbuf_prealloc_tailroom(msg, len);
1988 osm->flags |= htons(OFPSF_REPLY_MORE);
1990 msg = ofpbuf_new(MAX(1024, sizeof(struct nicira_stats_msg) + len));
1991 put_stats_reply__(osm, msg);
1992 list_push_back(replies, &msg->list_node);
1997 /* Appends 'len' bytes to the series of statistics replies in 'replies', and
1998 * returns the first byte. */
2000 ofputil_append_stats_reply(size_t len, struct list *replies)
2002 return ofpbuf_put_uninit(ofputil_reserve_stats_reply(len, replies), len);
2005 /* Returns the first byte past the ofp_stats_msg header in 'oh'. */
2007 ofputil_stats_body(const struct ofp_header *oh)
2009 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
2010 return (const struct ofp_stats_msg *) oh + 1;
2013 /* Returns the number of bytes past the ofp_stats_msg header in 'oh'. */
2015 ofputil_stats_body_len(const struct ofp_header *oh)
2017 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
2018 return ntohs(oh->length) - sizeof(struct ofp_stats_msg);
2021 /* Returns the first byte past the nicira_stats_msg header in 'oh'. */
2023 ofputil_nxstats_body(const struct ofp_header *oh)
2025 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
2026 return ((const struct nicira_stats_msg *) oh) + 1;
2029 /* Returns the number of bytes past the nicira_stats_msg header in 'oh'. */
2031 ofputil_nxstats_body_len(const struct ofp_header *oh)
2033 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
2034 return ntohs(oh->length) - sizeof(struct nicira_stats_msg);
2038 make_flow_mod(uint16_t command, const struct cls_rule *rule,
2041 struct ofp_flow_mod *ofm;
2042 size_t size = sizeof *ofm + actions_len;
2043 struct ofpbuf *out = ofpbuf_new(size);
2044 ofm = ofpbuf_put_zeros(out, sizeof *ofm);
2045 ofm->header.version = OFP_VERSION;
2046 ofm->header.type = OFPT_FLOW_MOD;
2047 ofm->header.length = htons(size);
2049 ofm->priority = htons(MIN(rule->priority, UINT16_MAX));
2050 ofputil_cls_rule_to_match(rule, &ofm->match);
2051 ofm->command = htons(command);
2056 make_add_flow(const struct cls_rule *rule, uint32_t buffer_id,
2057 uint16_t idle_timeout, size_t actions_len)
2059 struct ofpbuf *out = make_flow_mod(OFPFC_ADD, rule, actions_len);
2060 struct ofp_flow_mod *ofm = out->data;
2061 ofm->idle_timeout = htons(idle_timeout);
2062 ofm->hard_timeout = htons(OFP_FLOW_PERMANENT);
2063 ofm->buffer_id = htonl(buffer_id);
2068 make_del_flow(const struct cls_rule *rule)
2070 struct ofpbuf *out = make_flow_mod(OFPFC_DELETE_STRICT, rule, 0);
2071 struct ofp_flow_mod *ofm = out->data;
2072 ofm->out_port = htons(OFPP_NONE);
2077 make_add_simple_flow(const struct cls_rule *rule,
2078 uint32_t buffer_id, uint16_t out_port,
2079 uint16_t idle_timeout)
2081 if (out_port != OFPP_NONE) {
2082 struct ofp_action_output *oao;
2083 struct ofpbuf *buffer;
2085 buffer = make_add_flow(rule, buffer_id, idle_timeout, sizeof *oao);
2086 ofputil_put_OFPAT_OUTPUT(buffer)->port = htons(out_port);
2089 return make_add_flow(rule, buffer_id, idle_timeout, 0);
2094 make_packet_in(uint32_t buffer_id, uint16_t in_port, uint8_t reason,
2095 const struct ofpbuf *payload, int max_send_len)
2097 struct ofp_packet_in *opi;
2101 send_len = MIN(max_send_len, payload->size);
2102 buf = ofpbuf_new(sizeof *opi + send_len);
2103 opi = put_openflow_xid(offsetof(struct ofp_packet_in, data),
2104 OFPT_PACKET_IN, 0, buf);
2105 opi->buffer_id = htonl(buffer_id);
2106 opi->total_len = htons(payload->size);
2107 opi->in_port = htons(in_port);
2108 opi->reason = reason;
2109 ofpbuf_put(buf, payload->data, send_len);
2110 update_openflow_length(buf);
2116 make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
2118 const struct ofp_action_header *actions, size_t n_actions)
2120 size_t actions_len = n_actions * sizeof *actions;
2121 struct ofp_packet_out *opo;
2122 size_t size = sizeof *opo + actions_len + (packet ? packet->size : 0);
2123 struct ofpbuf *out = ofpbuf_new(size);
2125 opo = ofpbuf_put_uninit(out, sizeof *opo);
2126 opo->header.version = OFP_VERSION;
2127 opo->header.type = OFPT_PACKET_OUT;
2128 opo->header.length = htons(size);
2129 opo->header.xid = htonl(0);
2130 opo->buffer_id = htonl(buffer_id);
2131 opo->in_port = htons(in_port);
2132 opo->actions_len = htons(actions_len);
2133 ofpbuf_put(out, actions, actions_len);
2135 ofpbuf_put(out, packet->data, packet->size);
2141 make_unbuffered_packet_out(const struct ofpbuf *packet,
2142 uint16_t in_port, uint16_t out_port)
2144 struct ofp_action_output action;
2145 action.type = htons(OFPAT_OUTPUT);
2146 action.len = htons(sizeof action);
2147 action.port = htons(out_port);
2148 return make_packet_out(packet, UINT32_MAX, in_port,
2149 (struct ofp_action_header *) &action, 1);
2153 make_buffered_packet_out(uint32_t buffer_id,
2154 uint16_t in_port, uint16_t out_port)
2156 if (out_port != OFPP_NONE) {
2157 struct ofp_action_output action;
2158 action.type = htons(OFPAT_OUTPUT);
2159 action.len = htons(sizeof action);
2160 action.port = htons(out_port);
2161 return make_packet_out(NULL, buffer_id, in_port,
2162 (struct ofp_action_header *) &action, 1);
2164 return make_packet_out(NULL, buffer_id, in_port, NULL, 0);
2168 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
2170 make_echo_request(void)
2172 struct ofp_header *rq;
2173 struct ofpbuf *out = ofpbuf_new(sizeof *rq);
2174 rq = ofpbuf_put_uninit(out, sizeof *rq);
2175 rq->version = OFP_VERSION;
2176 rq->type = OFPT_ECHO_REQUEST;
2177 rq->length = htons(sizeof *rq);
2182 /* Creates and returns an OFPT_ECHO_REPLY message matching the
2183 * OFPT_ECHO_REQUEST message in 'rq'. */
2185 make_echo_reply(const struct ofp_header *rq)
2187 size_t size = ntohs(rq->length);
2188 struct ofpbuf *out = ofpbuf_new(size);
2189 struct ofp_header *reply = ofpbuf_put(out, rq, size);
2190 reply->type = OFPT_ECHO_REPLY;
2195 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
2197 switch (flags & OFPC_FRAG_MASK) {
2198 case OFPC_FRAG_NORMAL: return "normal";
2199 case OFPC_FRAG_DROP: return "drop";
2200 case OFPC_FRAG_REASM: return "reassemble";
2201 case OFPC_FRAG_NX_MATCH: return "nx-match";
2208 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
2210 if (!strcasecmp(s, "normal")) {
2211 *flags = OFPC_FRAG_NORMAL;
2212 } else if (!strcasecmp(s, "drop")) {
2213 *flags = OFPC_FRAG_DROP;
2214 } else if (!strcasecmp(s, "reassemble")) {
2215 *flags = OFPC_FRAG_REASM;
2216 } else if (!strcasecmp(s, "nx-match")) {
2217 *flags = OFPC_FRAG_NX_MATCH;
2224 /* Checks that 'port' is a valid output port for the OFPAT_OUTPUT action, given
2225 * that the switch will never have more than 'max_ports' ports. Returns 0 if
2226 * 'port' is valid, otherwise an OpenFlow return code. */
2228 ofputil_check_output_port(uint16_t port, int max_ports)
2236 case OFPP_CONTROLLER:
2241 if (port < max_ports) {
2244 return OFPERR_OFPBAC_BAD_OUT_PORT;
2248 #define OFPUTIL_NAMED_PORTS \
2249 OFPUTIL_NAMED_PORT(IN_PORT) \
2250 OFPUTIL_NAMED_PORT(TABLE) \
2251 OFPUTIL_NAMED_PORT(NORMAL) \
2252 OFPUTIL_NAMED_PORT(FLOOD) \
2253 OFPUTIL_NAMED_PORT(ALL) \
2254 OFPUTIL_NAMED_PORT(CONTROLLER) \
2255 OFPUTIL_NAMED_PORT(LOCAL) \
2256 OFPUTIL_NAMED_PORT(NONE)
2258 /* Checks whether 's' is the string representation of an OpenFlow port number,
2259 * either as an integer or a string name (e.g. "LOCAL"). If it is, stores the
2260 * number in '*port' and returns true. Otherwise, returns false. */
2262 ofputil_port_from_string(const char *name, uint16_t *port)
2268 static const struct pair pairs[] = {
2269 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
2271 #undef OFPUTIL_NAMED_PORT
2273 static const int n_pairs = ARRAY_SIZE(pairs);
2276 if (str_to_int(name, 0, &i) && i >= 0 && i < UINT16_MAX) {
2281 for (i = 0; i < n_pairs; i++) {
2282 if (!strcasecmp(name, pairs[i].name)) {
2283 *port = pairs[i].value;
2290 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
2291 * Most ports' string representation is just the port number, but for special
2292 * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
2294 ofputil_format_port(uint16_t port, struct ds *s)
2299 #define OFPUTIL_NAMED_PORT(NAME) case OFPP_##NAME: name = #NAME; break;
2301 #undef OFPUTIL_NAMED_PORT
2304 ds_put_format(s, "%"PRIu16, port);
2307 ds_put_cstr(s, name);
2311 check_resubmit_table(const struct nx_action_resubmit *nar)
2313 if (nar->pad[0] || nar->pad[1] || nar->pad[2]) {
2314 return OFPERR_OFPBAC_BAD_ARGUMENT;
2320 check_output_reg(const struct nx_action_output_reg *naor,
2321 const struct flow *flow)
2325 for (i = 0; i < sizeof naor->zero; i++) {
2326 if (naor->zero[i]) {
2327 return OFPERR_OFPBAC_BAD_ARGUMENT;
2331 return nxm_src_check(naor->src, nxm_decode_ofs(naor->ofs_nbits),
2332 nxm_decode_n_bits(naor->ofs_nbits), flow);
2336 validate_actions(const union ofp_action *actions, size_t n_actions,
2337 const struct flow *flow, int max_ports)
2339 const union ofp_action *a;
2342 OFPUTIL_ACTION_FOR_EACH (a, left, actions, n_actions) {
2347 code = ofputil_decode_action(a);
2350 VLOG_WARN_RL(&bad_ofmsg_rl,
2351 "action decoding error at offset %td (%s)",
2352 (a - actions) * sizeof *a, ofperr_get_name(error));
2358 switch ((enum ofputil_action_code) code) {
2359 case OFPUTIL_OFPAT_OUTPUT:
2360 error = ofputil_check_output_port(ntohs(a->output.port),
2364 case OFPUTIL_OFPAT_SET_VLAN_VID:
2365 if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
2366 error = OFPERR_OFPBAC_BAD_ARGUMENT;
2370 case OFPUTIL_OFPAT_SET_VLAN_PCP:
2371 if (a->vlan_pcp.vlan_pcp & ~7) {
2372 error = OFPERR_OFPBAC_BAD_ARGUMENT;
2376 case OFPUTIL_OFPAT_ENQUEUE:
2377 port = ntohs(((const struct ofp_action_enqueue *) a)->port);
2378 if (port >= max_ports && port != OFPP_IN_PORT
2379 && port != OFPP_LOCAL) {
2380 error = OFPERR_OFPBAC_BAD_OUT_PORT;
2384 case OFPUTIL_NXAST_REG_MOVE:
2385 error = nxm_check_reg_move((const struct nx_action_reg_move *) a,
2389 case OFPUTIL_NXAST_REG_LOAD:
2390 error = nxm_check_reg_load((const struct nx_action_reg_load *) a,
2394 case OFPUTIL_NXAST_MULTIPATH:
2395 error = multipath_check((const struct nx_action_multipath *) a,
2399 case OFPUTIL_NXAST_AUTOPATH:
2400 error = autopath_check((const struct nx_action_autopath *) a,
2404 case OFPUTIL_NXAST_BUNDLE:
2405 case OFPUTIL_NXAST_BUNDLE_LOAD:
2406 error = bundle_check((const struct nx_action_bundle *) a,
2410 case OFPUTIL_NXAST_OUTPUT_REG:
2411 error = check_output_reg((const struct nx_action_output_reg *) a,
2415 case OFPUTIL_NXAST_RESUBMIT_TABLE:
2416 error = check_resubmit_table(
2417 (const struct nx_action_resubmit *) a);
2420 case OFPUTIL_NXAST_LEARN:
2421 error = learn_check((const struct nx_action_learn *) a, flow);
2424 case OFPUTIL_OFPAT_STRIP_VLAN:
2425 case OFPUTIL_OFPAT_SET_NW_SRC:
2426 case OFPUTIL_OFPAT_SET_NW_DST:
2427 case OFPUTIL_OFPAT_SET_NW_TOS:
2428 case OFPUTIL_OFPAT_SET_TP_SRC:
2429 case OFPUTIL_OFPAT_SET_TP_DST:
2430 case OFPUTIL_OFPAT_SET_DL_SRC:
2431 case OFPUTIL_OFPAT_SET_DL_DST:
2432 case OFPUTIL_NXAST_RESUBMIT:
2433 case OFPUTIL_NXAST_SET_TUNNEL:
2434 case OFPUTIL_NXAST_SET_QUEUE:
2435 case OFPUTIL_NXAST_POP_QUEUE:
2436 case OFPUTIL_NXAST_NOTE:
2437 case OFPUTIL_NXAST_SET_TUNNEL64:
2438 case OFPUTIL_NXAST_EXIT:
2443 VLOG_WARN_RL(&bad_ofmsg_rl, "bad action at offset %td (%s)",
2444 (a - actions) * sizeof *a, ofperr_get_name(error));
2449 VLOG_WARN_RL(&bad_ofmsg_rl, "bad action format at offset %zu",
2450 (n_actions - left) * sizeof *a);
2451 return OFPERR_OFPBAC_BAD_LEN;
2456 struct ofputil_action {
2458 unsigned int min_len;
2459 unsigned int max_len;
2462 static const struct ofputil_action action_bad_type
2463 = { -OFPERR_OFPBAC_BAD_TYPE, 0, UINT_MAX };
2464 static const struct ofputil_action action_bad_len
2465 = { -OFPERR_OFPBAC_BAD_LEN, 0, UINT_MAX };
2466 static const struct ofputil_action action_bad_vendor
2467 = { -OFPERR_OFPBAC_BAD_VENDOR, 0, UINT_MAX };
2469 static const struct ofputil_action *
2470 ofputil_decode_ofpat_action(const union ofp_action *a)
2472 enum ofp_action_type type = ntohs(a->type);
2475 #define OFPAT_ACTION(ENUM, STRUCT, NAME) \
2477 static const struct ofputil_action action = { \
2479 sizeof(struct STRUCT), \
2480 sizeof(struct STRUCT) \
2484 #include "ofp-util.def"
2488 return &action_bad_type;
2492 static const struct ofputil_action *
2493 ofputil_decode_nxast_action(const union ofp_action *a)
2495 const struct nx_action_header *nah = (const struct nx_action_header *) a;
2496 enum nx_action_subtype subtype = ntohs(nah->subtype);
2499 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
2501 static const struct ofputil_action action = { \
2503 sizeof(struct STRUCT), \
2504 EXTENSIBLE ? UINT_MAX : sizeof(struct STRUCT) \
2508 #include "ofp-util.def"
2510 case NXAST_SNAT__OBSOLETE:
2511 case NXAST_DROP_SPOOFED_ARP__OBSOLETE:
2513 return &action_bad_type;
2517 /* Parses 'a' to determine its type. Returns a nonnegative OFPUTIL_OFPAT_* or
2518 * OFPUTIL_NXAST_* constant if successful, otherwise a negative OFPERR_* error
2521 * The caller must have already verified that 'a''s length is correct (that is,
2522 * a->header.len is nonzero and a multiple of sizeof(union ofp_action) and no
2523 * longer than the amount of space allocated to 'a').
2525 * This function verifies that 'a''s length is correct for the type of action
2526 * that it represents. */
2528 ofputil_decode_action(const union ofp_action *a)
2530 const struct ofputil_action *action;
2531 uint16_t len = ntohs(a->header.len);
2533 if (a->type != htons(OFPAT_VENDOR)) {
2534 action = ofputil_decode_ofpat_action(a);
2536 switch (ntohl(a->vendor.vendor)) {
2538 if (len < sizeof(struct nx_action_header)) {
2539 return -OFPERR_OFPBAC_BAD_LEN;
2541 action = ofputil_decode_nxast_action(a);
2544 action = &action_bad_vendor;
2549 return (len >= action->min_len && len <= action->max_len
2551 : -OFPERR_OFPBAC_BAD_LEN);
2554 /* Parses 'a' and returns its type as an OFPUTIL_OFPAT_* or OFPUTIL_NXAST_*
2555 * constant. The caller must have already validated that 'a' is a valid action
2556 * understood by Open vSwitch (e.g. by a previous successful call to
2557 * ofputil_decode_action()). */
2558 enum ofputil_action_code
2559 ofputil_decode_action_unsafe(const union ofp_action *a)
2561 const struct ofputil_action *action;
2563 if (a->type != htons(OFPAT_VENDOR)) {
2564 action = ofputil_decode_ofpat_action(a);
2566 action = ofputil_decode_nxast_action(a);
2569 return action->code;
2572 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
2573 * 'name' is "output" then the return value is OFPUTIL_OFPAT_OUTPUT), or -1 if
2574 * 'name' is not the name of any action.
2576 * ofp-util.def lists the mapping from names to action. */
2578 ofputil_action_code_from_name(const char *name)
2580 static const char *names[OFPUTIL_N_ACTIONS] = {
2581 #define OFPAT_ACTION(ENUM, STRUCT, NAME) NAME,
2582 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
2583 #include "ofp-util.def"
2588 for (p = names; p < &names[ARRAY_SIZE(names)]; p++) {
2589 if (*p && !strcasecmp(name, *p)) {
2596 /* Appends an action of the type specified by 'code' to 'buf' and returns the
2597 * action. Initializes the parts of 'action' that identify it as having type
2598 * <ENUM> and length 'sizeof *action' and zeros the rest. For actions that
2599 * have variable length, the length used and cleared is that of struct
2602 ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
2605 #define OFPAT_ACTION(ENUM, STRUCT, NAME) \
2606 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
2607 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
2608 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
2609 #include "ofp-util.def"
2614 #define OFPAT_ACTION(ENUM, STRUCT, NAME) \
2616 ofputil_init_##ENUM(struct STRUCT *s) \
2618 memset(s, 0, sizeof *s); \
2619 s->type = htons(ENUM); \
2620 s->len = htons(sizeof *s); \
2624 ofputil_put_##ENUM(struct ofpbuf *buf) \
2626 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
2627 ofputil_init_##ENUM(s); \
2630 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
2632 ofputil_init_##ENUM(struct STRUCT *s) \
2634 memset(s, 0, sizeof *s); \
2635 s->type = htons(OFPAT_VENDOR); \
2636 s->len = htons(sizeof *s); \
2637 s->vendor = htonl(NX_VENDOR_ID); \
2638 s->subtype = htons(ENUM); \
2642 ofputil_put_##ENUM(struct ofpbuf *buf) \
2644 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
2645 ofputil_init_##ENUM(s); \
2648 #include "ofp-util.def"
2650 /* Returns true if 'action' outputs to 'port', false otherwise. */
2652 action_outputs_to_port(const union ofp_action *action, ovs_be16 port)
2654 switch (ntohs(action->type)) {
2656 return action->output.port == port;
2658 return ((const struct ofp_action_enqueue *) action)->port == port;
2664 /* "Normalizes" the wildcards in 'rule'. That means:
2666 * 1. If the type of level N is known, then only the valid fields for that
2667 * level may be specified. For example, ARP does not have a TOS field,
2668 * so nw_tos must be wildcarded if 'rule' specifies an ARP flow.
2669 * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
2670 * ipv6_dst (and other fields) must be wildcarded if 'rule' specifies an
2673 * 2. If the type of level N is not known (or not understood by Open
2674 * vSwitch), then no fields at all for that level may be specified. For
2675 * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
2676 * L4 fields tp_src and tp_dst must be wildcarded if 'rule' specifies an
2679 * 'flow_format' specifies the format of the flow as received or as intended to
2680 * be sent. This is important for IPv6 and ARP, for which NXM supports more
2681 * detailed matching. */
2683 ofputil_normalize_rule(struct cls_rule *rule, enum nx_flow_format flow_format)
2686 MAY_NW_ADDR = 1 << 0, /* nw_src, nw_dst */
2687 MAY_TP_ADDR = 1 << 1, /* tp_src, tp_dst */
2688 MAY_NW_PROTO = 1 << 2, /* nw_proto */
2689 MAY_IPVx = 1 << 3, /* tos, frag, ttl */
2690 MAY_ARP_SHA = 1 << 4, /* arp_sha */
2691 MAY_ARP_THA = 1 << 5, /* arp_tha */
2692 MAY_IPV6 = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
2693 MAY_ND_TARGET = 1 << 7 /* nd_target */
2696 struct flow_wildcards wc;
2698 /* Figure out what fields may be matched. */
2699 if (rule->flow.dl_type == htons(ETH_TYPE_IP)) {
2700 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
2701 if (rule->flow.nw_proto == IPPROTO_TCP ||
2702 rule->flow.nw_proto == IPPROTO_UDP ||
2703 rule->flow.nw_proto == IPPROTO_ICMP) {
2704 may_match |= MAY_TP_ADDR;
2706 } else if (rule->flow.dl_type == htons(ETH_TYPE_IPV6)
2707 && flow_format == NXFF_NXM) {
2708 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
2709 if (rule->flow.nw_proto == IPPROTO_TCP ||
2710 rule->flow.nw_proto == IPPROTO_UDP) {
2711 may_match |= MAY_TP_ADDR;
2712 } else if (rule->flow.nw_proto == IPPROTO_ICMPV6) {
2713 may_match |= MAY_TP_ADDR;
2714 if (rule->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
2715 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
2716 } else if (rule->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
2717 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
2720 } else if (rule->flow.dl_type == htons(ETH_TYPE_ARP)) {
2721 may_match = MAY_NW_PROTO | MAY_NW_ADDR;
2722 if (flow_format == NXFF_NXM) {
2723 may_match |= MAY_ARP_SHA | MAY_ARP_THA;
2729 /* Clear the fields that may not be matched. */
2731 if (!(may_match & MAY_NW_ADDR)) {
2732 wc.nw_src_mask = wc.nw_dst_mask = htonl(0);
2734 if (!(may_match & MAY_TP_ADDR)) {
2735 wc.wildcards |= FWW_TP_SRC | FWW_TP_DST;
2737 if (!(may_match & MAY_NW_PROTO)) {
2738 wc.wildcards |= FWW_NW_PROTO;
2740 if (!(may_match & MAY_IPVx)) {
2741 wc.wildcards |= FWW_NW_DSCP;
2742 wc.wildcards |= FWW_NW_ECN;
2743 wc.wildcards |= FWW_NW_TTL;
2745 if (!(may_match & MAY_ARP_SHA)) {
2746 wc.wildcards |= FWW_ARP_SHA;
2748 if (!(may_match & MAY_ARP_THA)) {
2749 wc.wildcards |= FWW_ARP_THA;
2751 if (!(may_match & MAY_IPV6)) {
2752 wc.ipv6_src_mask = wc.ipv6_dst_mask = in6addr_any;
2753 wc.wildcards |= FWW_IPV6_LABEL;
2755 if (!(may_match & MAY_ND_TARGET)) {
2756 wc.wildcards |= FWW_ND_TARGET;
2759 /* Log any changes. */
2760 if (!flow_wildcards_equal(&wc, &rule->wc)) {
2761 bool log = !VLOG_DROP_INFO(&bad_ofmsg_rl);
2762 char *pre = log ? cls_rule_to_string(rule) : NULL;
2765 cls_rule_zero_wildcarded_fields(rule);
2768 char *post = cls_rule_to_string(rule);
2769 VLOG_INFO("normalization changed ofp_match, details:");
2770 VLOG_INFO(" pre: %s", pre);
2771 VLOG_INFO("post: %s", post);
2778 /* Attempts to pull 'actions_len' bytes from the front of 'b'. Returns 0 if
2779 * successful, otherwise an OpenFlow error.
2781 * If successful, the first action is stored in '*actionsp' and the number of
2782 * "union ofp_action" size elements into '*n_actionsp'. Otherwise NULL and 0
2783 * are stored, respectively.
2785 * This function does not check that the actions are valid (the caller should
2786 * do so, with validate_actions()). The caller is also responsible for making
2787 * sure that 'b->data' is initially aligned appropriately for "union
2790 ofputil_pull_actions(struct ofpbuf *b, unsigned int actions_len,
2791 union ofp_action **actionsp, size_t *n_actionsp)
2793 if (actions_len % OFP_ACTION_ALIGN != 0) {
2794 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
2795 "is not a multiple of %d", actions_len, OFP_ACTION_ALIGN);
2799 *actionsp = ofpbuf_try_pull(b, actions_len);
2800 if (*actionsp == NULL) {
2801 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
2802 "exceeds remaining message length (%zu)",
2803 actions_len, b->size);
2807 *n_actionsp = actions_len / OFP_ACTION_ALIGN;
2813 return OFPERR_OFPBRC_BAD_LEN;
2817 ofputil_actions_equal(const union ofp_action *a, size_t n_a,
2818 const union ofp_action *b, size_t n_b)
2820 return n_a == n_b && (!n_a || !memcmp(a, b, n_a * sizeof *a));
2824 ofputil_actions_clone(const union ofp_action *actions, size_t n)
2826 return n ? xmemdup(actions, n * sizeof *actions) : NULL;
2829 /* Parses a key or a key-value pair from '*stringp'.
2831 * On success: Stores the key into '*keyp'. Stores the value, if present, into
2832 * '*valuep', otherwise an empty string. Advances '*stringp' past the end of
2833 * the key-value pair, preparing it for another call. '*keyp' and '*valuep'
2834 * are substrings of '*stringp' created by replacing some of its bytes by null
2835 * terminators. Returns true.
2837 * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
2838 * NULL and returns false. */
2840 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
2842 char *pos, *key, *value;
2846 pos += strspn(pos, ", \t\r\n");
2848 *keyp = *valuep = NULL;
2853 key_len = strcspn(pos, ":=(, \t\r\n");
2854 if (key[key_len] == ':' || key[key_len] == '=') {
2855 /* The value can be separated by a colon. */
2858 value = key + key_len + 1;
2859 value_len = strcspn(value, ", \t\r\n");
2860 pos = value + value_len + (value[value_len] != '\0');
2861 value[value_len] = '\0';
2862 } else if (key[key_len] == '(') {
2863 /* The value can be surrounded by balanced parentheses. The outermost
2864 * set of parentheses is removed. */
2868 value = key + key_len + 1;
2869 for (value_len = 0; level > 0; value_len++) {
2870 switch (value[value_len]) {
2872 ovs_fatal(0, "unbalanced parentheses in argument to %s", key);
2883 value[value_len - 1] = '\0';
2884 pos = value + value_len;
2886 /* There might be no value at all. */
2887 value = key + key_len; /* Will become the empty string below. */
2888 pos = key + key_len + (key[key_len] != '\0');
2890 key[key_len] = '\0';