2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
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 "meta-flow.h"
32 #include "multipath.h"
35 #include "ofp-actions.h"
36 #include "ofp-errors.h"
42 #include "unaligned.h"
43 #include "type-props.h"
46 VLOG_DEFINE_THIS_MODULE(ofp_util);
48 /* Rate limit for OpenFlow message parse errors. These always indicate a bug
49 * in the peer and so there's not much point in showing a lot of them. */
50 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
52 /* Given the wildcard bit count in the least-significant 6 of 'wcbits', returns
53 * an IP netmask with a 1 in each bit that must match and a 0 in each bit that
56 * The bits in 'wcbits' are in the format used in enum ofp_flow_wildcards: 0
57 * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
58 * ..., 32 and higher wildcard the entire field. This is the *opposite* of the
59 * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
62 ofputil_wcbits_to_netmask(int wcbits)
65 return wcbits < 32 ? htonl(~((1u << wcbits) - 1)) : 0;
68 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
69 * that it wildcards, that is, the number of 0-bits in 'netmask', a number
70 * between 0 and 32 inclusive.
72 * If 'netmask' is not a CIDR netmask (see ip_is_cidr()), the return value will
73 * still be in the valid range but isn't otherwise meaningful. */
75 ofputil_netmask_to_wcbits(ovs_be32 netmask)
77 return 32 - ip_count_cidr_bits(netmask);
80 /* A list of the FWW_* and OFPFW10_ bits that have the same value, meaning, and
82 #define WC_INVARIANT_LIST \
83 WC_INVARIANT_BIT(IN_PORT) \
84 WC_INVARIANT_BIT(DL_TYPE) \
85 WC_INVARIANT_BIT(NW_PROTO)
87 /* Verify that all of the invariant bits (as defined on WC_INVARIANT_LIST)
88 * actually have the same names and values. */
89 #define WC_INVARIANT_BIT(NAME) BUILD_ASSERT_DECL(FWW_##NAME == OFPFW10_##NAME);
91 #undef WC_INVARIANT_BIT
93 /* WC_INVARIANTS is the invariant bits (as defined on WC_INVARIANT_LIST) all
95 static const flow_wildcards_t WC_INVARIANTS = 0
96 #define WC_INVARIANT_BIT(NAME) | FWW_##NAME
98 #undef WC_INVARIANT_BIT
101 /* Converts the OpenFlow 1.0 wildcards in 'ofpfw' (OFPFW10_*) into a
102 * flow_wildcards in 'wc' for use in struct cls_rule. It is the caller's
103 * responsibility to handle the special case where the flow match's dl_vlan is
104 * set to OFP_VLAN_NONE. */
106 ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *wc)
108 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 14);
110 /* Initialize most of rule->wc. */
111 flow_wildcards_init_catchall(wc);
112 wc->wildcards = (OVS_FORCE flow_wildcards_t) ofpfw & WC_INVARIANTS;
114 /* Wildcard fields that aren't defined by ofp10_match. */
115 wc->wildcards |= FWW_NW_ECN | FWW_NW_TTL;
117 if (ofpfw & OFPFW10_NW_TOS) {
118 /* OpenFlow 1.0 defines a TOS wildcard, but it's much later in
119 * the enum than we can use. */
120 wc->wildcards |= FWW_NW_DSCP;
123 wc->nw_src_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW10_NW_SRC_SHIFT);
124 wc->nw_dst_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW10_NW_DST_SHIFT);
126 if (!(ofpfw & OFPFW10_TP_SRC)) {
127 wc->tp_src_mask = htons(UINT16_MAX);
129 if (!(ofpfw & OFPFW10_TP_DST)) {
130 wc->tp_dst_mask = htons(UINT16_MAX);
133 if (!(ofpfw & OFPFW10_DL_SRC)) {
134 memset(wc->dl_src_mask, 0xff, ETH_ADDR_LEN);
136 if (!(ofpfw & OFPFW10_DL_DST)) {
137 memset(wc->dl_dst_mask, 0xff, ETH_ADDR_LEN);
141 if (!(ofpfw & OFPFW10_DL_VLAN_PCP)) {
142 wc->vlan_tci_mask |= htons(VLAN_PCP_MASK | VLAN_CFI);
144 if (!(ofpfw & OFPFW10_DL_VLAN)) {
145 wc->vlan_tci_mask |= htons(VLAN_VID_MASK | VLAN_CFI);
149 /* Converts the ofp10_match in 'match' into a cls_rule in 'rule', with the
150 * given 'priority'. */
152 ofputil_cls_rule_from_ofp10_match(const struct ofp10_match *match,
153 unsigned int priority, struct cls_rule *rule)
155 uint32_t ofpfw = ntohl(match->wildcards) & OFPFW10_ALL;
157 /* Initialize rule->priority, rule->wc. */
158 rule->priority = !ofpfw ? UINT16_MAX : priority;
159 ofputil_wildcard_from_ofpfw10(ofpfw, &rule->wc);
161 /* Initialize most of rule->flow. */
162 rule->flow.nw_src = match->nw_src;
163 rule->flow.nw_dst = match->nw_dst;
164 rule->flow.in_port = ntohs(match->in_port);
165 rule->flow.dl_type = ofputil_dl_type_from_openflow(match->dl_type);
166 rule->flow.tp_src = match->tp_src;
167 rule->flow.tp_dst = match->tp_dst;
168 memcpy(rule->flow.dl_src, match->dl_src, ETH_ADDR_LEN);
169 memcpy(rule->flow.dl_dst, match->dl_dst, ETH_ADDR_LEN);
170 rule->flow.nw_tos = match->nw_tos & IP_DSCP_MASK;
171 rule->flow.nw_proto = match->nw_proto;
173 /* Translate VLANs. */
174 if (!(ofpfw & OFPFW10_DL_VLAN) &&
175 match->dl_vlan == htons(OFP10_VLAN_NONE)) {
176 /* Match only packets without 802.1Q header.
178 * When OFPFW10_DL_VLAN_PCP is wildcarded, this is obviously correct.
180 * If OFPFW10_DL_VLAN_PCP is matched, the flow match is contradictory,
181 * because we can't have a specific PCP without an 802.1Q header.
182 * However, older versions of OVS treated this as matching packets
183 * withut an 802.1Q header, so we do here too. */
184 rule->flow.vlan_tci = htons(0);
185 rule->wc.vlan_tci_mask = htons(0xffff);
187 ovs_be16 vid, pcp, tci;
189 vid = match->dl_vlan & htons(VLAN_VID_MASK);
190 pcp = htons((match->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK);
191 tci = vid | pcp | htons(VLAN_CFI);
192 rule->flow.vlan_tci = tci & rule->wc.vlan_tci_mask;
196 cls_rule_zero_wildcarded_fields(rule);
199 /* Convert 'rule' into the OpenFlow 1.0 match structure 'match'. */
201 ofputil_cls_rule_to_ofp10_match(const struct cls_rule *rule,
202 struct ofp10_match *match)
204 const struct flow_wildcards *wc = &rule->wc;
207 /* Figure out most OpenFlow wildcards. */
208 ofpfw = (OVS_FORCE uint32_t) (wc->wildcards & WC_INVARIANTS);
209 ofpfw |= (ofputil_netmask_to_wcbits(wc->nw_src_mask)
210 << OFPFW10_NW_SRC_SHIFT);
211 ofpfw |= (ofputil_netmask_to_wcbits(wc->nw_dst_mask)
212 << OFPFW10_NW_DST_SHIFT);
213 if (wc->wildcards & FWW_NW_DSCP) {
214 ofpfw |= OFPFW10_NW_TOS;
216 if (!wc->tp_src_mask) {
217 ofpfw |= OFPFW10_TP_SRC;
219 if (!wc->tp_dst_mask) {
220 ofpfw |= OFPFW10_TP_DST;
222 if (eth_addr_is_zero(wc->dl_src_mask)) {
223 ofpfw |= OFPFW10_DL_SRC;
225 if (eth_addr_is_zero(wc->dl_dst_mask)) {
226 ofpfw |= OFPFW10_DL_DST;
229 /* Translate VLANs. */
230 match->dl_vlan = htons(0);
231 match->dl_vlan_pcp = 0;
232 if (rule->wc.vlan_tci_mask == htons(0)) {
233 ofpfw |= OFPFW10_DL_VLAN | OFPFW10_DL_VLAN_PCP;
234 } else if (rule->wc.vlan_tci_mask & htons(VLAN_CFI)
235 && !(rule->flow.vlan_tci & htons(VLAN_CFI))) {
236 match->dl_vlan = htons(OFP10_VLAN_NONE);
237 ofpfw |= OFPFW10_DL_VLAN_PCP;
239 if (!(rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) {
240 ofpfw |= OFPFW10_DL_VLAN;
242 match->dl_vlan = htons(vlan_tci_to_vid(rule->flow.vlan_tci));
245 if (!(rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK))) {
246 ofpfw |= OFPFW10_DL_VLAN_PCP;
248 match->dl_vlan_pcp = vlan_tci_to_pcp(rule->flow.vlan_tci);
252 /* Compose most of the match structure. */
253 match->wildcards = htonl(ofpfw);
254 match->in_port = htons(rule->flow.in_port);
255 memcpy(match->dl_src, rule->flow.dl_src, ETH_ADDR_LEN);
256 memcpy(match->dl_dst, rule->flow.dl_dst, ETH_ADDR_LEN);
257 match->dl_type = ofputil_dl_type_to_openflow(rule->flow.dl_type);
258 match->nw_src = rule->flow.nw_src;
259 match->nw_dst = rule->flow.nw_dst;
260 match->nw_tos = rule->flow.nw_tos & IP_DSCP_MASK;
261 match->nw_proto = rule->flow.nw_proto;
262 match->tp_src = rule->flow.tp_src;
263 match->tp_dst = rule->flow.tp_dst;
264 memset(match->pad1, '\0', sizeof match->pad1);
265 memset(match->pad2, '\0', sizeof match->pad2);
269 ofputil_pull_ofp11_match(struct ofpbuf *buf, unsigned int priority,
270 struct cls_rule *rule, uint16_t *padded_match_len)
272 struct ofp11_match_header *omh = buf->data;
275 if (buf->size < sizeof *omh) {
276 return OFPERR_OFPBMC_BAD_LEN;
279 match_len = ntohs(omh->length);
281 switch (ntohs(omh->type)) {
282 case OFPMT_STANDARD: {
283 struct ofp11_match *om;
285 if (match_len != sizeof *om || buf->size < sizeof *om) {
286 return OFPERR_OFPBMC_BAD_LEN;
288 om = ofpbuf_pull(buf, sizeof *om);
289 if (padded_match_len) {
290 *padded_match_len = match_len;
292 return ofputil_cls_rule_from_ofp11_match(om, priority, rule);
296 if (padded_match_len) {
297 *padded_match_len = ROUND_UP(match_len, 8);
299 return oxm_pull_match(buf, priority, rule);
302 return OFPERR_OFPBMC_BAD_TYPE;
306 /* Converts the ofp11_match in 'match' into a cls_rule in 'rule', with the
307 * given 'priority'. Returns 0 if successful, otherwise an OFPERR_* value. */
309 ofputil_cls_rule_from_ofp11_match(const struct ofp11_match *match,
310 unsigned int priority,
311 struct cls_rule *rule)
313 uint16_t wc = ntohl(match->wildcards);
314 uint8_t dl_src_mask[ETH_ADDR_LEN];
315 uint8_t dl_dst_mask[ETH_ADDR_LEN];
319 cls_rule_init_catchall(rule, priority);
321 if (!(wc & OFPFW11_IN_PORT)) {
325 error = ofputil_port_from_ofp11(match->in_port, &ofp_port);
327 return OFPERR_OFPBMC_BAD_VALUE;
329 cls_rule_set_in_port(rule, ofp_port);
332 for (i = 0; i < ETH_ADDR_LEN; i++) {
333 dl_src_mask[i] = ~match->dl_src_mask[i];
335 cls_rule_set_dl_src_masked(rule, match->dl_src, dl_src_mask);
337 for (i = 0; i < ETH_ADDR_LEN; i++) {
338 dl_dst_mask[i] = ~match->dl_dst_mask[i];
340 cls_rule_set_dl_dst_masked(rule, match->dl_dst, dl_dst_mask);
342 if (!(wc & OFPFW11_DL_VLAN)) {
343 if (match->dl_vlan == htons(OFPVID11_NONE)) {
344 /* Match only packets without a VLAN tag. */
345 rule->flow.vlan_tci = htons(0);
346 rule->wc.vlan_tci_mask = htons(UINT16_MAX);
348 if (match->dl_vlan == htons(OFPVID11_ANY)) {
349 /* Match any packet with a VLAN tag regardless of VID. */
350 rule->flow.vlan_tci = htons(VLAN_CFI);
351 rule->wc.vlan_tci_mask = htons(VLAN_CFI);
352 } else if (ntohs(match->dl_vlan) < 4096) {
353 /* Match only packets with the specified VLAN VID. */
354 rule->flow.vlan_tci = htons(VLAN_CFI) | match->dl_vlan;
355 rule->wc.vlan_tci_mask = htons(VLAN_CFI | VLAN_VID_MASK);
358 return OFPERR_OFPBMC_BAD_VALUE;
361 if (!(wc & OFPFW11_DL_VLAN_PCP)) {
362 if (match->dl_vlan_pcp <= 7) {
363 rule->flow.vlan_tci |= htons(match->dl_vlan_pcp
365 rule->wc.vlan_tci_mask |= htons(VLAN_PCP_MASK);
368 return OFPERR_OFPBMC_BAD_VALUE;
374 if (!(wc & OFPFW11_DL_TYPE)) {
375 cls_rule_set_dl_type(rule,
376 ofputil_dl_type_from_openflow(match->dl_type));
379 ipv4 = rule->flow.dl_type == htons(ETH_TYPE_IP);
380 arp = rule->flow.dl_type == htons(ETH_TYPE_ARP);
382 if (ipv4 && !(wc & OFPFW11_NW_TOS)) {
383 if (match->nw_tos & ~IP_DSCP_MASK) {
385 return OFPERR_OFPBMC_BAD_VALUE;
388 cls_rule_set_nw_dscp(rule, match->nw_tos);
392 if (!(wc & OFPFW11_NW_PROTO)) {
393 cls_rule_set_nw_proto(rule, match->nw_proto);
395 cls_rule_set_nw_src_masked(rule, match->nw_src, ~match->nw_src_mask);
396 cls_rule_set_nw_dst_masked(rule, match->nw_dst, ~match->nw_dst_mask);
399 #define OFPFW11_TP_ALL (OFPFW11_TP_SRC | OFPFW11_TP_DST)
400 if (ipv4 && (wc & OFPFW11_TP_ALL) != OFPFW11_TP_ALL) {
401 switch (rule->flow.nw_proto) {
403 /* "A.2.3 Flow Match Structures" in OF1.1 says:
405 * The tp_src and tp_dst fields will be ignored unless the
406 * network protocol specified is as TCP, UDP or SCTP.
408 * but I'm pretty sure we should support ICMP too, otherwise
409 * that's a regression from OF1.0. */
410 if (!(wc & OFPFW11_TP_SRC)) {
411 uint16_t icmp_type = ntohs(match->tp_src);
412 if (icmp_type < 0x100) {
413 cls_rule_set_icmp_type(rule, icmp_type);
415 return OFPERR_OFPBMC_BAD_FIELD;
418 if (!(wc & OFPFW11_TP_DST)) {
419 uint16_t icmp_code = ntohs(match->tp_dst);
420 if (icmp_code < 0x100) {
421 cls_rule_set_icmp_code(rule, icmp_code);
423 return OFPERR_OFPBMC_BAD_FIELD;
430 if (!(wc & (OFPFW11_TP_SRC))) {
431 cls_rule_set_tp_src(rule, match->tp_src);
433 if (!(wc & (OFPFW11_TP_DST))) {
434 cls_rule_set_tp_dst(rule, match->tp_dst);
439 /* We don't support SCTP and it seems that we should tell the
440 * controller, since OF1.1 implementations are supposed to. */
441 return OFPERR_OFPBMC_BAD_FIELD;
444 /* OF1.1 says explicitly to ignore this. */
449 if (rule->flow.dl_type == htons(ETH_TYPE_MPLS) ||
450 rule->flow.dl_type == htons(ETH_TYPE_MPLS_MCAST)) {
451 enum { OFPFW11_MPLS_ALL = OFPFW11_MPLS_LABEL | OFPFW11_MPLS_TC };
453 if ((wc & OFPFW11_MPLS_ALL) != OFPFW11_MPLS_ALL) {
454 /* MPLS not supported. */
455 return OFPERR_OFPBMC_BAD_TAG;
459 if (match->metadata_mask != htonll(UINT64_MAX)) {
460 cls_rule_set_metadata_masked(rule, match->metadata,
461 ~match->metadata_mask);
467 /* Convert 'rule' into the OpenFlow 1.1 match structure 'match'. */
469 ofputil_cls_rule_to_ofp11_match(const struct cls_rule *rule,
470 struct ofp11_match *match)
475 memset(match, 0, sizeof *match);
476 match->omh.type = htons(OFPMT_STANDARD);
477 match->omh.length = htons(OFPMT11_STANDARD_LENGTH);
479 if (rule->wc.wildcards & FWW_IN_PORT) {
480 wc |= OFPFW11_IN_PORT;
482 match->in_port = ofputil_port_to_ofp11(rule->flow.in_port);
485 memcpy(match->dl_src, rule->flow.dl_src, ETH_ADDR_LEN);
486 for (i = 0; i < ETH_ADDR_LEN; i++) {
487 match->dl_src_mask[i] = ~rule->wc.dl_src_mask[i];
490 memcpy(match->dl_dst, rule->flow.dl_dst, ETH_ADDR_LEN);
491 for (i = 0; i < ETH_ADDR_LEN; i++) {
492 match->dl_dst_mask[i] = ~rule->wc.dl_dst_mask[i];
495 if (rule->wc.vlan_tci_mask == htons(0)) {
496 wc |= OFPFW11_DL_VLAN | OFPFW11_DL_VLAN_PCP;
497 } else if (rule->wc.vlan_tci_mask & htons(VLAN_CFI)
498 && !(rule->flow.vlan_tci & htons(VLAN_CFI))) {
499 match->dl_vlan = htons(OFPVID11_NONE);
500 wc |= OFPFW11_DL_VLAN_PCP;
502 if (!(rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) {
503 match->dl_vlan = htons(OFPVID11_ANY);
505 match->dl_vlan = htons(vlan_tci_to_vid(rule->flow.vlan_tci));
508 if (!(rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK))) {
509 wc |= OFPFW11_DL_VLAN_PCP;
511 match->dl_vlan_pcp = vlan_tci_to_pcp(rule->flow.vlan_tci);
515 if (rule->wc.wildcards & FWW_DL_TYPE) {
516 wc |= OFPFW11_DL_TYPE;
518 match->dl_type = ofputil_dl_type_to_openflow(rule->flow.dl_type);
521 if (rule->wc.wildcards & FWW_NW_DSCP) {
522 wc |= OFPFW11_NW_TOS;
524 match->nw_tos = rule->flow.nw_tos & IP_DSCP_MASK;
527 if (rule->wc.wildcards & FWW_NW_PROTO) {
528 wc |= OFPFW11_NW_PROTO;
530 match->nw_proto = rule->flow.nw_proto;
533 match->nw_src = rule->flow.nw_src;
534 match->nw_src_mask = ~rule->wc.nw_src_mask;
535 match->nw_dst = rule->flow.nw_dst;
536 match->nw_dst_mask = ~rule->wc.nw_dst_mask;
538 if (!rule->wc.tp_src_mask) {
539 wc |= OFPFW11_TP_SRC;
541 match->tp_src = rule->flow.tp_src;
544 if (!rule->wc.tp_dst_mask) {
545 wc |= OFPFW11_TP_DST;
547 match->tp_dst = rule->flow.tp_dst;
550 /* MPLS not supported. */
551 wc |= OFPFW11_MPLS_LABEL;
552 wc |= OFPFW11_MPLS_TC;
554 match->metadata = rule->flow.metadata;
555 match->metadata_mask = ~rule->wc.metadata_mask;
557 match->wildcards = htonl(wc);
560 /* Given a 'dl_type' value in the format used in struct flow, returns the
561 * corresponding 'dl_type' value for use in an ofp10_match or ofp11_match
564 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type)
566 return (flow_dl_type == htons(FLOW_DL_TYPE_NONE)
567 ? htons(OFP_DL_TYPE_NOT_ETH_TYPE)
571 /* Given a 'dl_type' value in the format used in an ofp10_match or ofp11_match
572 * structure, returns the corresponding 'dl_type' value for use in struct
575 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type)
577 return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
578 ? htons(FLOW_DL_TYPE_NONE)
584 struct proto_abbrev {
585 enum ofputil_protocol protocol;
589 /* Most users really don't care about some of the differences between
590 * protocols. These abbreviations help with that. */
591 static const struct proto_abbrev proto_abbrevs[] = {
592 { OFPUTIL_P_ANY, "any" },
593 { OFPUTIL_P_OF10_ANY, "OpenFlow10" },
594 { OFPUTIL_P_NXM_ANY, "NXM" },
596 #define N_PROTO_ABBREVS ARRAY_SIZE(proto_abbrevs)
598 enum ofputil_protocol ofputil_flow_dump_protocols[] = {
602 size_t ofputil_n_flow_dump_protocols = ARRAY_SIZE(ofputil_flow_dump_protocols);
604 /* Returns the ofputil_protocol that is initially in effect on an OpenFlow
605 * connection that has negotiated the given 'version'. 'version' should
606 * normally be an 8-bit OpenFlow version identifier (e.g. 0x01 for OpenFlow
607 * 1.0, 0x02 for OpenFlow 1.1). Returns 0 if 'version' is not supported or
608 * outside the valid range. */
609 enum ofputil_protocol
610 ofputil_protocol_from_ofp_version(enum ofp_version version)
614 return OFPUTIL_P_OF10;
616 return OFPUTIL_P_OF12;
623 /* Returns the OpenFlow protocol version number (e.g. OFP10_VERSION,
624 * OFP11_VERSION or OFP12_VERSION) that corresponds to 'protocol'. */
626 ofputil_protocol_to_ofp_version(enum ofputil_protocol protocol)
630 case OFPUTIL_P_OF10_TID:
632 case OFPUTIL_P_NXM_TID:
633 return OFP10_VERSION;
635 return OFP12_VERSION;
641 /* Returns true if 'protocol' is a single OFPUTIL_P_* value, false
644 ofputil_protocol_is_valid(enum ofputil_protocol protocol)
646 return protocol & OFPUTIL_P_ANY && is_pow2(protocol);
649 /* Returns the equivalent of 'protocol' with the Nicira flow_mod_table_id
650 * extension turned on or off if 'enable' is true or false, respectively.
652 * This extension is only useful for protocols whose "standard" version does
653 * not allow specific tables to be modified. In particular, this is true of
654 * OpenFlow 1.0. In later versions of OpenFlow, a flow_mod request always
655 * specifies a table ID and so there is no need for such an extension. When
656 * 'protocol' is such a protocol that doesn't need a flow_mod_table_id
657 * extension, this function just returns its 'protocol' argument unchanged
658 * regardless of the value of 'enable'. */
659 enum ofputil_protocol
660 ofputil_protocol_set_tid(enum ofputil_protocol protocol, bool enable)
664 case OFPUTIL_P_OF10_TID:
665 return enable ? OFPUTIL_P_OF10_TID : OFPUTIL_P_OF10;
668 case OFPUTIL_P_NXM_TID:
669 return enable ? OFPUTIL_P_NXM_TID : OFPUTIL_P_NXM;
672 return OFPUTIL_P_OF12;
679 /* Returns the "base" version of 'protocol'. That is, if 'protocol' includes
680 * some extension to a standard protocol version, the return value is the
681 * standard version of that protocol without any extension. If 'protocol' is a
682 * standard protocol version, returns 'protocol' unchanged. */
683 enum ofputil_protocol
684 ofputil_protocol_to_base(enum ofputil_protocol protocol)
686 return ofputil_protocol_set_tid(protocol, false);
689 /* Returns 'new_base' with any extensions taken from 'cur'. */
690 enum ofputil_protocol
691 ofputil_protocol_set_base(enum ofputil_protocol cur,
692 enum ofputil_protocol new_base)
694 bool tid = (cur & OFPUTIL_P_TID) != 0;
698 case OFPUTIL_P_OF10_TID:
699 return ofputil_protocol_set_tid(OFPUTIL_P_OF10, tid);
702 case OFPUTIL_P_NXM_TID:
703 return ofputil_protocol_set_tid(OFPUTIL_P_NXM, tid);
706 return ofputil_protocol_set_tid(OFPUTIL_P_OF12, tid);
713 /* Returns a string form of 'protocol', if a simple form exists (that is, if
714 * 'protocol' is either a single protocol or it is a combination of protocols
715 * that have a single abbreviation). Otherwise, returns NULL. */
717 ofputil_protocol_to_string(enum ofputil_protocol protocol)
719 const struct proto_abbrev *p;
721 /* Use a "switch" statement for single-bit names so that we get a compiler
722 * warning if we forget any. */
725 return "NXM-table_id";
727 case OFPUTIL_P_NXM_TID:
728 return "NXM+table_id";
731 return "OpenFlow10-table_id";
733 case OFPUTIL_P_OF10_TID:
734 return "OpenFlow10+table_id";
740 /* Check abbreviations. */
741 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
742 if (protocol == p->protocol) {
750 /* Returns a string that represents 'protocols'. The return value might be a
751 * comma-separated list if 'protocols' doesn't have a simple name. The return
752 * value is "none" if 'protocols' is 0.
754 * The caller must free the returned string (with free()). */
756 ofputil_protocols_to_string(enum ofputil_protocol protocols)
760 assert(!(protocols & ~OFPUTIL_P_ANY));
761 if (protocols == 0) {
762 return xstrdup("none");
767 const struct proto_abbrev *p;
771 ds_put_char(&s, ',');
774 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
775 if ((protocols & p->protocol) == p->protocol) {
776 ds_put_cstr(&s, p->name);
777 protocols &= ~p->protocol;
782 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
783 enum ofputil_protocol bit = 1u << i;
785 if (protocols & bit) {
786 ds_put_cstr(&s, ofputil_protocol_to_string(bit));
795 return ds_steal_cstr(&s);
798 static enum ofputil_protocol
799 ofputil_protocol_from_string__(const char *s, size_t n)
801 const struct proto_abbrev *p;
804 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
805 enum ofputil_protocol bit = 1u << i;
806 const char *name = ofputil_protocol_to_string(bit);
808 if (name && n == strlen(name) && !strncasecmp(s, name, n)) {
813 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
814 if (n == strlen(p->name) && !strncasecmp(s, p->name, n)) {
822 /* Returns the nonempty set of protocols represented by 's', which can be a
823 * single protocol name or abbreviation or a comma-separated list of them.
825 * Aborts the program with an error message if 's' is invalid. */
826 enum ofputil_protocol
827 ofputil_protocols_from_string(const char *s)
829 const char *orig_s = s;
830 enum ofputil_protocol protocols;
834 enum ofputil_protocol p;
843 p = ofputil_protocol_from_string__(s, n);
845 ovs_fatal(0, "%.*s: unknown flow protocol", (int) n, s);
853 ovs_fatal(0, "%s: no flow protocol specified", orig_s);
859 ofputil_packet_in_format_is_valid(enum nx_packet_in_format packet_in_format)
861 switch (packet_in_format) {
862 case NXPIF_OPENFLOW10:
871 ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format)
873 switch (packet_in_format) {
874 case NXPIF_OPENFLOW10:
884 ofputil_packet_in_format_from_string(const char *s)
886 return (!strcmp(s, "openflow10") ? NXPIF_OPENFLOW10
887 : !strcmp(s, "nxm") ? NXPIF_NXM
892 regs_fully_wildcarded(const struct flow_wildcards *wc)
896 for (i = 0; i < FLOW_N_REGS; i++) {
897 if (wc->reg_masks[i] != 0) {
904 /* Returns a bit-mask of ofputil_protocols that can be used for sending 'rule'
905 * to a switch (e.g. to add or remove a flow). Only NXM can handle tunnel IDs,
906 * registers, or fixing the Ethernet multicast bit. Otherwise, it's better to
907 * use OpenFlow 1.0 protocol for backward compatibility. */
908 enum ofputil_protocol
909 ofputil_usable_protocols(const struct cls_rule *rule)
911 const struct flow_wildcards *wc = &rule->wc;
913 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 14);
915 /* NXM and OF1.1+ supports bitwise matching on ethernet addresses. */
916 if (!eth_mask_is_exact(wc->dl_src_mask)
917 && !eth_addr_is_zero(wc->dl_src_mask)) {
918 return OFPUTIL_P_NXM_ANY;
920 if (!eth_mask_is_exact(wc->dl_dst_mask)
921 && !eth_addr_is_zero(wc->dl_dst_mask)) {
922 return OFPUTIL_P_NXM_ANY;
925 /* NXM and OF1.1+ support matching metadata. */
926 if (wc->metadata_mask != htonll(0)) {
927 return OFPUTIL_P_NXM_ANY;
930 /* Only NXM supports matching ARP hardware addresses. */
931 if (!eth_addr_is_zero(wc->arp_sha_mask) ||
932 !eth_addr_is_zero(wc->arp_tha_mask)) {
933 return OFPUTIL_P_NXM_ANY;
936 /* Only NXM supports matching IPv6 traffic. */
937 if (!(wc->wildcards & FWW_DL_TYPE)
938 && (rule->flow.dl_type == htons(ETH_TYPE_IPV6))) {
939 return OFPUTIL_P_NXM_ANY;
942 /* Only NXM supports matching registers. */
943 if (!regs_fully_wildcarded(wc)) {
944 return OFPUTIL_P_NXM_ANY;
947 /* Only NXM supports matching tun_id. */
948 if (wc->tun_id_mask != htonll(0)) {
949 return OFPUTIL_P_NXM_ANY;
952 /* Only NXM supports matching fragments. */
953 if (wc->nw_frag_mask) {
954 return OFPUTIL_P_NXM_ANY;
957 /* Only NXM supports matching IPv6 flow label. */
958 if (wc->ipv6_label_mask) {
959 return OFPUTIL_P_NXM_ANY;
962 /* Only NXM supports matching IP ECN bits. */
963 if (!(wc->wildcards & FWW_NW_ECN)) {
964 return OFPUTIL_P_NXM_ANY;
967 /* Only NXM supports matching IP TTL/hop limit. */
968 if (!(wc->wildcards & FWW_NW_TTL)) {
969 return OFPUTIL_P_NXM_ANY;
972 /* Only NXM supports non-CIDR IPv4 address masks. */
973 if (!ip_is_cidr(wc->nw_src_mask) || !ip_is_cidr(wc->nw_dst_mask)) {
974 return OFPUTIL_P_NXM_ANY;
977 /* Only NXM supports bitwise matching on transport port. */
978 if ((wc->tp_src_mask && wc->tp_src_mask != htons(UINT16_MAX)) ||
979 (wc->tp_dst_mask && wc->tp_dst_mask != htons(UINT16_MAX))) {
980 return OFPUTIL_P_NXM_ANY;
983 /* Other formats can express this rule. */
984 return OFPUTIL_P_ANY;
987 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
988 * protocol is 'current', at least partly transitions the protocol to 'want'.
989 * Stores in '*next' the protocol that will be in effect on the OpenFlow
990 * connection if the switch processes the returned message correctly. (If
991 * '*next != want' then the caller will have to iterate.)
993 * If 'current == want', returns NULL and stores 'current' in '*next'. */
995 ofputil_encode_set_protocol(enum ofputil_protocol current,
996 enum ofputil_protocol want,
997 enum ofputil_protocol *next)
999 enum ofputil_protocol cur_base, want_base;
1000 bool cur_tid, want_tid;
1002 cur_base = ofputil_protocol_to_base(current);
1003 want_base = ofputil_protocol_to_base(want);
1004 if (cur_base != want_base) {
1005 *next = ofputil_protocol_set_base(current, want_base);
1007 switch (want_base) {
1009 return ofputil_encode_nx_set_flow_format(NXFF_NXM);
1011 case OFPUTIL_P_OF10:
1012 return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10);
1014 case OFPUTIL_P_OF12:
1015 return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW12);
1017 case OFPUTIL_P_OF10_TID:
1018 case OFPUTIL_P_NXM_TID:
1023 cur_tid = (current & OFPUTIL_P_TID) != 0;
1024 want_tid = (want & OFPUTIL_P_TID) != 0;
1025 if (cur_tid != want_tid) {
1026 *next = ofputil_protocol_set_tid(current, want_tid);
1027 return ofputil_make_flow_mod_table_id(want_tid);
1030 assert(current == want);
1036 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1037 * format to 'nxff'. */
1039 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff)
1041 struct nx_set_flow_format *sff;
1044 assert(ofputil_nx_flow_format_is_valid(nxff));
1046 msg = ofpraw_alloc(OFPRAW_NXT_SET_FLOW_FORMAT, OFP10_VERSION, 0);
1047 sff = ofpbuf_put_zeros(msg, sizeof *sff);
1048 sff->format = htonl(nxff);
1053 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1055 enum ofputil_protocol
1056 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format)
1058 switch (flow_format) {
1059 case NXFF_OPENFLOW10:
1060 return OFPUTIL_P_OF10;
1063 return OFPUTIL_P_NXM;
1065 case NXFF_OPENFLOW12:
1066 return OFPUTIL_P_OF12;
1073 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1075 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format)
1077 return ofputil_nx_flow_format_to_protocol(flow_format) != 0;
1080 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1083 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format)
1085 switch (flow_format) {
1086 case NXFF_OPENFLOW10:
1087 return "openflow10";
1090 case NXFF_OPENFLOW12:
1091 return "openflow12";
1098 ofputil_make_set_packet_in_format(enum nx_packet_in_format packet_in_format)
1100 struct nx_set_packet_in_format *spif;
1103 msg = ofpraw_alloc(OFPRAW_NXT_SET_PACKET_IN_FORMAT, OFP10_VERSION, 0);
1104 spif = ofpbuf_put_zeros(msg, sizeof *spif);
1105 spif->format = htonl(packet_in_format);
1110 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1111 * extension on or off (according to 'flow_mod_table_id'). */
1113 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
1115 struct nx_flow_mod_table_id *nfmti;
1118 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION, 0);
1119 nfmti = ofpbuf_put_zeros(msg, sizeof *nfmti);
1120 nfmti->set = flow_mod_table_id;
1124 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1125 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
1128 * Uses 'ofpacts' to store the abstract OFPACT_* version of 'oh''s actions.
1129 * The caller must initialize 'ofpacts' and retains ownership of it.
1130 * 'fm->ofpacts' will point into the 'ofpacts' buffer.
1132 * Does not validate the flow_mod actions. The caller should do that, with
1133 * ofpacts_check(). */
1135 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
1136 const struct ofp_header *oh,
1137 enum ofputil_protocol protocol,
1138 struct ofpbuf *ofpacts)
1144 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1145 raw = ofpraw_pull_assert(&b);
1146 if (raw == OFPRAW_OFPT11_FLOW_MOD) {
1147 /* Standard OpenFlow 1.1 flow_mod. */
1148 const struct ofp11_flow_mod *ofm;
1151 ofm = ofpbuf_pull(&b, sizeof *ofm);
1153 error = ofputil_pull_ofp11_match(&b, ntohs(ofm->priority), &fm->cr,
1159 error = ofpacts_pull_openflow11_instructions(&b, b.size, ofpacts);
1164 /* Translate the message. */
1165 if (ofm->command == OFPFC_ADD) {
1166 fm->cookie = htonll(0);
1167 fm->cookie_mask = htonll(0);
1168 fm->new_cookie = ofm->cookie;
1171 fm->cookie = ofm->cookie;
1172 fm->cookie_mask = ofm->cookie_mask;
1173 fm->new_cookie = htonll(UINT64_MAX);
1175 fm->command = ofm->command;
1176 fm->table_id = ofm->table_id;
1177 fm->idle_timeout = ntohs(ofm->idle_timeout);
1178 fm->hard_timeout = ntohs(ofm->hard_timeout);
1179 fm->buffer_id = ntohl(ofm->buffer_id);
1180 error = ofputil_port_from_ofp11(ofm->out_port, &fm->out_port);
1184 if (ofm->out_group != htonl(OFPG_ANY)) {
1185 return OFPERR_NXFMFC_GROUPS_NOT_SUPPORTED;
1187 fm->flags = ntohs(ofm->flags);
1189 if (raw == OFPRAW_OFPT10_FLOW_MOD) {
1190 /* Standard OpenFlow 1.0 flow_mod. */
1191 const struct ofp10_flow_mod *ofm;
1195 /* Get the ofp10_flow_mod. */
1196 ofm = ofpbuf_pull(&b, sizeof *ofm);
1198 /* Set priority based on original wildcards. Normally we'd allow
1199 * ofputil_cls_rule_from_match() to do this for us, but
1200 * ofputil_normalize_rule() can put wildcards where the original
1201 * flow didn't have them. */
1202 priority = ntohs(ofm->priority);
1203 if (!(ofm->match.wildcards & htonl(OFPFW10_ALL))) {
1204 priority = UINT16_MAX;
1207 /* Translate the rule. */
1208 ofputil_cls_rule_from_ofp10_match(&ofm->match, priority, &fm->cr);
1209 ofputil_normalize_rule(&fm->cr);
1211 /* Now get the actions. */
1212 error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1217 /* Translate the message. */
1218 command = ntohs(ofm->command);
1219 fm->cookie = htonll(0);
1220 fm->cookie_mask = htonll(0);
1221 fm->new_cookie = ofm->cookie;
1222 fm->idle_timeout = ntohs(ofm->idle_timeout);
1223 fm->hard_timeout = ntohs(ofm->hard_timeout);
1224 fm->buffer_id = ntohl(ofm->buffer_id);
1225 fm->out_port = ntohs(ofm->out_port);
1226 fm->flags = ntohs(ofm->flags);
1227 } else if (raw == OFPRAW_NXT_FLOW_MOD) {
1228 /* Nicira extended flow_mod. */
1229 const struct nx_flow_mod *nfm;
1232 /* Dissect the message. */
1233 nfm = ofpbuf_pull(&b, sizeof *nfm);
1234 error = nx_pull_match(&b, ntohs(nfm->match_len), ntohs(nfm->priority),
1235 &fm->cr, &fm->cookie, &fm->cookie_mask);
1239 error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1244 /* Translate the message. */
1245 command = ntohs(nfm->command);
1246 if ((command & 0xff) == OFPFC_ADD && fm->cookie_mask) {
1247 /* Flow additions may only set a new cookie, not match an
1248 * existing cookie. */
1249 return OFPERR_NXBRC_NXM_INVALID;
1251 fm->new_cookie = nfm->cookie;
1252 fm->idle_timeout = ntohs(nfm->idle_timeout);
1253 fm->hard_timeout = ntohs(nfm->hard_timeout);
1254 fm->buffer_id = ntohl(nfm->buffer_id);
1255 fm->out_port = ntohs(nfm->out_port);
1256 fm->flags = ntohs(nfm->flags);
1261 if (protocol & OFPUTIL_P_TID) {
1262 fm->command = command & 0xff;
1263 fm->table_id = command >> 8;
1265 fm->command = command;
1266 fm->table_id = 0xff;
1270 fm->ofpacts = ofpacts->data;
1271 fm->ofpacts_len = ofpacts->size;
1277 ofputil_tid_command(const struct ofputil_flow_mod *fm,
1278 enum ofputil_protocol protocol)
1280 return htons(protocol & OFPUTIL_P_TID
1281 ? (fm->command & 0xff) | (fm->table_id << 8)
1285 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
1286 * 'protocol' and returns the message. */
1288 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
1289 enum ofputil_protocol protocol)
1294 case OFPUTIL_P_OF12: {
1295 struct ofp11_flow_mod *ofm;
1297 msg = ofpraw_alloc(OFPRAW_OFPT11_FLOW_MOD, OFP12_VERSION,
1298 NXM_TYPICAL_LEN + fm->ofpacts_len);
1299 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
1300 ofm->cookie = fm->new_cookie;
1301 ofm->cookie_mask = fm->cookie_mask;
1302 ofm->table_id = fm->table_id;
1303 ofm->command = fm->command;
1304 ofm->idle_timeout = htons(fm->idle_timeout);
1305 ofm->hard_timeout = htons(fm->hard_timeout);
1306 ofm->priority = htons(fm->cr.priority);
1307 ofm->buffer_id = htonl(fm->buffer_id);
1308 ofm->out_port = ofputil_port_to_ofp11(fm->out_port);
1309 ofm->out_group = htonl(OFPG11_ANY);
1310 ofm->flags = htons(fm->flags);
1311 oxm_put_match(msg, &fm->cr);
1313 ofpacts_put_openflow11_instructions(fm->ofpacts, fm->ofpacts_len,
1319 case OFPUTIL_P_OF10:
1320 case OFPUTIL_P_OF10_TID: {
1321 struct ofp10_flow_mod *ofm;
1323 msg = ofpraw_alloc(OFPRAW_OFPT10_FLOW_MOD, OFP10_VERSION,
1325 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
1326 ofputil_cls_rule_to_ofp10_match(&fm->cr, &ofm->match);
1327 ofm->cookie = fm->new_cookie;
1328 ofm->command = ofputil_tid_command(fm, protocol);
1329 ofm->idle_timeout = htons(fm->idle_timeout);
1330 ofm->hard_timeout = htons(fm->hard_timeout);
1331 ofm->priority = htons(fm->cr.priority);
1332 ofm->buffer_id = htonl(fm->buffer_id);
1333 ofm->out_port = htons(fm->out_port);
1334 ofm->flags = htons(fm->flags);
1336 ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
1342 case OFPUTIL_P_NXM_TID: {
1343 struct nx_flow_mod *nfm;
1346 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD, OFP10_VERSION,
1347 NXM_TYPICAL_LEN + fm->ofpacts_len);
1348 nfm = ofpbuf_put_zeros(msg, sizeof *nfm);
1349 nfm->command = ofputil_tid_command(fm, protocol);
1350 nfm->cookie = fm->new_cookie;
1351 match_len = nx_put_match(msg, &fm->cr, fm->cookie, fm->cookie_mask);
1353 nfm->idle_timeout = htons(fm->idle_timeout);
1354 nfm->hard_timeout = htons(fm->hard_timeout);
1355 nfm->priority = htons(fm->cr.priority);
1356 nfm->buffer_id = htonl(fm->buffer_id);
1357 nfm->out_port = htons(fm->out_port);
1358 nfm->flags = htons(fm->flags);
1359 nfm->match_len = htons(match_len);
1361 ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
1370 ofpmsg_update_length(msg);
1374 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1375 * send all of the 'n_fm's flow table modification requests in 'fms', and a
1376 * 0-bit for each protocol that is inadequate.
1378 * (The return value will have at least one 1-bit.) */
1379 enum ofputil_protocol
1380 ofputil_flow_mod_usable_protocols(const struct ofputil_flow_mod *fms,
1383 enum ofputil_protocol usable_protocols;
1386 usable_protocols = OFPUTIL_P_ANY;
1387 for (i = 0; i < n_fms; i++) {
1388 const struct ofputil_flow_mod *fm = &fms[i];
1390 usable_protocols &= ofputil_usable_protocols(&fm->cr);
1391 if (fm->table_id != 0xff) {
1392 usable_protocols &= OFPUTIL_P_TID;
1395 /* Matching of the cookie is only supported through NXM. */
1396 if (fm->cookie_mask != htonll(0)) {
1397 usable_protocols &= OFPUTIL_P_NXM_ANY;
1400 assert(usable_protocols);
1402 return usable_protocols;
1406 ofputil_decode_ofpst_flow_request(struct ofputil_flow_stats_request *fsr,
1407 const struct ofp10_flow_stats_request *ofsr,
1410 fsr->aggregate = aggregate;
1411 ofputil_cls_rule_from_ofp10_match(&ofsr->match, 0, &fsr->match);
1412 fsr->out_port = ntohs(ofsr->out_port);
1413 fsr->table_id = ofsr->table_id;
1414 fsr->cookie = fsr->cookie_mask = htonll(0);
1420 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
1421 struct ofpbuf *b, bool aggregate)
1423 const struct nx_flow_stats_request *nfsr;
1426 nfsr = ofpbuf_pull(b, sizeof *nfsr);
1427 error = nx_pull_match(b, ntohs(nfsr->match_len), 0, &fsr->match,
1428 &fsr->cookie, &fsr->cookie_mask);
1433 return OFPERR_OFPBRC_BAD_LEN;
1436 fsr->aggregate = aggregate;
1437 fsr->out_port = ntohs(nfsr->out_port);
1438 fsr->table_id = nfsr->table_id;
1443 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
1444 * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
1445 * successful, otherwise an OpenFlow error code. */
1447 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
1448 const struct ofp_header *oh)
1453 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1454 raw = ofpraw_pull_assert(&b);
1455 switch ((int) raw) {
1456 case OFPRAW_OFPST_FLOW_REQUEST:
1457 return ofputil_decode_ofpst_flow_request(fsr, b.data, false);
1459 case OFPRAW_OFPST_AGGREGATE_REQUEST:
1460 return ofputil_decode_ofpst_flow_request(fsr, b.data, true);
1462 case OFPRAW_NXST_FLOW_REQUEST:
1463 return ofputil_decode_nxst_flow_request(fsr, &b, false);
1465 case OFPRAW_NXST_AGGREGATE_REQUEST:
1466 return ofputil_decode_nxst_flow_request(fsr, &b, true);
1469 /* Hey, the caller lied. */
1474 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
1475 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
1476 * 'protocol', and returns the message. */
1478 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
1479 enum ofputil_protocol protocol)
1485 case OFPUTIL_P_OF12: {
1486 struct ofp11_flow_stats_request *ofsr;
1488 raw = (fsr->aggregate
1489 ? OFPRAW_OFPST_AGGREGATE_REQUEST
1490 : OFPRAW_OFPST_FLOW_REQUEST);
1491 msg = ofpraw_alloc(raw, OFP12_VERSION, NXM_TYPICAL_LEN);
1492 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
1493 ofsr->table_id = fsr->table_id;
1494 ofsr->out_port = ofputil_port_to_ofp11(fsr->out_port);
1495 ofsr->out_group = htonl(OFPG11_ANY);
1496 ofsr->cookie = fsr->cookie;
1497 ofsr->cookie_mask = fsr->cookie_mask;
1498 oxm_put_match(msg, &fsr->match);
1502 case OFPUTIL_P_OF10:
1503 case OFPUTIL_P_OF10_TID: {
1504 struct ofp10_flow_stats_request *ofsr;
1506 raw = (fsr->aggregate
1507 ? OFPRAW_OFPST_AGGREGATE_REQUEST
1508 : OFPRAW_OFPST_FLOW_REQUEST);
1509 msg = ofpraw_alloc(raw, OFP10_VERSION, 0);
1510 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
1511 ofputil_cls_rule_to_ofp10_match(&fsr->match, &ofsr->match);
1512 ofsr->table_id = fsr->table_id;
1513 ofsr->out_port = htons(fsr->out_port);
1518 case OFPUTIL_P_NXM_TID: {
1519 struct nx_flow_stats_request *nfsr;
1522 raw = (fsr->aggregate
1523 ? OFPRAW_NXST_AGGREGATE_REQUEST
1524 : OFPRAW_NXST_FLOW_REQUEST);
1525 msg = ofpraw_alloc(raw, OFP10_VERSION, NXM_TYPICAL_LEN);
1526 ofpbuf_put_zeros(msg, sizeof *nfsr);
1527 match_len = nx_put_match(msg, &fsr->match,
1528 fsr->cookie, fsr->cookie_mask);
1531 nfsr->out_port = htons(fsr->out_port);
1532 nfsr->match_len = htons(match_len);
1533 nfsr->table_id = fsr->table_id;
1544 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1545 * accurately encode 'fsr', and a 0-bit for each protocol that is inadequate.
1547 * (The return value will have at least one 1-bit.) */
1548 enum ofputil_protocol
1549 ofputil_flow_stats_request_usable_protocols(
1550 const struct ofputil_flow_stats_request *fsr)
1552 enum ofputil_protocol usable_protocols;
1554 usable_protocols = ofputil_usable_protocols(&fsr->match);
1555 if (fsr->cookie_mask != htonll(0)) {
1556 usable_protocols &= OFPUTIL_P_NXM_ANY;
1558 return usable_protocols;
1561 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
1562 * ofputil_flow_stats in 'fs'.
1564 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
1565 * OpenFlow message. Calling this function multiple times for a single 'msg'
1566 * iterates through the replies. The caller must initially leave 'msg''s layer
1567 * pointers null and not modify them between calls.
1569 * Most switches don't send the values needed to populate fs->idle_age and
1570 * fs->hard_age, so those members will usually be set to 0. If the switch from
1571 * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
1572 * 'flow_age_extension' as true so that the contents of 'msg' determine the
1573 * 'idle_age' and 'hard_age' members in 'fs'.
1575 * Uses 'ofpacts' to store the abstract OFPACT_* version of the flow stats
1576 * reply's actions. The caller must initialize 'ofpacts' and retains ownership
1577 * of it. 'fs->ofpacts' will point into the 'ofpacts' buffer.
1579 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1580 * otherwise a positive errno value. */
1582 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
1584 bool flow_age_extension,
1585 struct ofpbuf *ofpacts)
1591 ? ofpraw_decode(&raw, msg->l2)
1592 : ofpraw_pull(&raw, msg));
1599 } else if (raw == OFPRAW_OFPST_FLOW_REPLY) {
1600 const struct ofp10_flow_stats *ofs;
1603 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
1605 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
1606 "bytes at end", msg->size);
1610 length = ntohs(ofs->length);
1611 if (length < sizeof *ofs) {
1612 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
1613 "length %zu", length);
1617 if (ofpacts_pull_openflow10(msg, length - sizeof *ofs, ofpacts)) {
1621 fs->cookie = get_32aligned_be64(&ofs->cookie);
1622 ofputil_cls_rule_from_ofp10_match(&ofs->match, ntohs(ofs->priority),
1624 fs->table_id = ofs->table_id;
1625 fs->duration_sec = ntohl(ofs->duration_sec);
1626 fs->duration_nsec = ntohl(ofs->duration_nsec);
1627 fs->idle_timeout = ntohs(ofs->idle_timeout);
1628 fs->hard_timeout = ntohs(ofs->hard_timeout);
1631 fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
1632 fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
1633 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
1634 const struct nx_flow_stats *nfs;
1635 size_t match_len, actions_len, length;
1637 nfs = ofpbuf_try_pull(msg, sizeof *nfs);
1639 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
1640 "bytes at end", msg->size);
1644 length = ntohs(nfs->length);
1645 match_len = ntohs(nfs->match_len);
1646 if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
1647 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
1648 "claims invalid length %zu", match_len, length);
1651 if (nx_pull_match(msg, match_len, ntohs(nfs->priority), &fs->rule,
1656 actions_len = length - sizeof *nfs - ROUND_UP(match_len, 8);
1657 if (ofpacts_pull_openflow10(msg, actions_len, ofpacts)) {
1661 fs->cookie = nfs->cookie;
1662 fs->table_id = nfs->table_id;
1663 fs->duration_sec = ntohl(nfs->duration_sec);
1664 fs->duration_nsec = ntohl(nfs->duration_nsec);
1665 fs->idle_timeout = ntohs(nfs->idle_timeout);
1666 fs->hard_timeout = ntohs(nfs->hard_timeout);
1669 if (flow_age_extension) {
1670 if (nfs->idle_age) {
1671 fs->idle_age = ntohs(nfs->idle_age) - 1;
1673 if (nfs->hard_age) {
1674 fs->hard_age = ntohs(nfs->hard_age) - 1;
1677 fs->packet_count = ntohll(nfs->packet_count);
1678 fs->byte_count = ntohll(nfs->byte_count);
1683 fs->ofpacts = ofpacts->data;
1684 fs->ofpacts_len = ofpacts->size;
1689 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
1691 * We use this in situations where OVS internally uses UINT64_MAX to mean
1692 * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
1694 unknown_to_zero(uint64_t count)
1696 return count != UINT64_MAX ? count : 0;
1699 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
1700 * those already present in the list of ofpbufs in 'replies'. 'replies' should
1701 * have been initialized with ofputil_start_stats_reply(). */
1703 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
1704 struct list *replies)
1706 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
1707 size_t start_ofs = reply->size;
1710 ofpraw_decode_partial(&raw, reply->data, reply->size);
1711 if (raw == OFPRAW_OFPST_FLOW_REPLY) {
1712 struct ofp10_flow_stats *ofs;
1714 ofpbuf_put_uninit(reply, sizeof *ofs);
1715 ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
1717 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
1718 ofs->length = htons(reply->size - start_ofs);
1719 ofs->table_id = fs->table_id;
1721 ofputil_cls_rule_to_ofp10_match(&fs->rule, &ofs->match);
1722 ofs->duration_sec = htonl(fs->duration_sec);
1723 ofs->duration_nsec = htonl(fs->duration_nsec);
1724 ofs->priority = htons(fs->rule.priority);
1725 ofs->idle_timeout = htons(fs->idle_timeout);
1726 ofs->hard_timeout = htons(fs->hard_timeout);
1727 memset(ofs->pad2, 0, sizeof ofs->pad2);
1728 put_32aligned_be64(&ofs->cookie, fs->cookie);
1729 put_32aligned_be64(&ofs->packet_count,
1730 htonll(unknown_to_zero(fs->packet_count)));
1731 put_32aligned_be64(&ofs->byte_count,
1732 htonll(unknown_to_zero(fs->byte_count)));
1733 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
1734 struct nx_flow_stats *nfs;
1737 ofpbuf_put_uninit(reply, sizeof *nfs);
1738 match_len = nx_put_match(reply, &fs->rule, 0, 0);
1739 ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
1741 nfs = ofpbuf_at_assert(reply, start_ofs, sizeof *nfs);
1742 nfs->length = htons(reply->size - start_ofs);
1743 nfs->table_id = fs->table_id;
1745 nfs->duration_sec = htonl(fs->duration_sec);
1746 nfs->duration_nsec = htonl(fs->duration_nsec);
1747 nfs->priority = htons(fs->rule.priority);
1748 nfs->idle_timeout = htons(fs->idle_timeout);
1749 nfs->hard_timeout = htons(fs->hard_timeout);
1750 nfs->idle_age = htons(fs->idle_age < 0 ? 0
1751 : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
1753 nfs->hard_age = htons(fs->hard_age < 0 ? 0
1754 : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
1756 nfs->match_len = htons(match_len);
1757 nfs->cookie = fs->cookie;
1758 nfs->packet_count = htonll(fs->packet_count);
1759 nfs->byte_count = htonll(fs->byte_count);
1764 ofpmp_postappend(replies, start_ofs);
1767 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
1768 * NXST_AGGREGATE reply matching 'request', and returns the message. */
1770 ofputil_encode_aggregate_stats_reply(
1771 const struct ofputil_aggregate_stats *stats,
1772 const struct ofp_header *request)
1774 struct ofp_aggregate_stats_reply *asr;
1775 uint64_t packet_count;
1776 uint64_t byte_count;
1780 ofpraw_decode(&raw, request);
1781 if (raw == OFPRAW_OFPST_AGGREGATE_REQUEST) {
1782 packet_count = unknown_to_zero(stats->packet_count);
1783 byte_count = unknown_to_zero(stats->byte_count);
1785 packet_count = stats->packet_count;
1786 byte_count = stats->byte_count;
1789 msg = ofpraw_alloc_stats_reply(request, 0);
1790 asr = ofpbuf_put_zeros(msg, sizeof *asr);
1791 put_32aligned_be64(&asr->packet_count, htonll(packet_count));
1792 put_32aligned_be64(&asr->byte_count, htonll(byte_count));
1793 asr->flow_count = htonl(stats->flow_count);
1799 ofputil_decode_aggregate_stats_reply(struct ofputil_aggregate_stats *stats,
1800 const struct ofp_header *reply)
1802 struct ofp_aggregate_stats_reply *asr;
1805 ofpbuf_use_const(&msg, reply, ntohs(reply->length));
1806 ofpraw_pull_assert(&msg);
1809 stats->packet_count = ntohll(get_32aligned_be64(&asr->packet_count));
1810 stats->byte_count = ntohll(get_32aligned_be64(&asr->byte_count));
1811 stats->flow_count = ntohl(asr->flow_count);
1816 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
1817 * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
1818 * an OpenFlow error code. */
1820 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
1821 const struct ofp_header *oh)
1826 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1827 raw = ofpraw_pull_assert(&b);
1828 if (raw == OFPRAW_OFPT11_FLOW_REMOVED) {
1829 const struct ofp12_flow_removed *ofr;
1832 ofr = ofpbuf_pull(&b, sizeof *ofr);
1834 error = ofputil_pull_ofp11_match(&b, ntohs(ofr->priority),
1840 fr->cookie = ofr->cookie;
1841 fr->reason = ofr->reason;
1842 /* XXX: ofr->table_id is ignored */
1843 fr->duration_sec = ntohl(ofr->duration_sec);
1844 fr->duration_nsec = ntohl(ofr->duration_nsec);
1845 fr->idle_timeout = ntohs(ofr->idle_timeout);
1846 fr->hard_timeout = ntohs(ofr->hard_timeout);
1847 fr->packet_count = ntohll(ofr->packet_count);
1848 fr->byte_count = ntohll(ofr->byte_count);
1849 } else if (raw == OFPRAW_OFPT10_FLOW_REMOVED) {
1850 const struct ofp_flow_removed *ofr;
1852 ofr = ofpbuf_pull(&b, sizeof *ofr);
1854 ofputil_cls_rule_from_ofp10_match(&ofr->match, ntohs(ofr->priority),
1856 fr->cookie = ofr->cookie;
1857 fr->reason = ofr->reason;
1858 fr->duration_sec = ntohl(ofr->duration_sec);
1859 fr->duration_nsec = ntohl(ofr->duration_nsec);
1860 fr->idle_timeout = ntohs(ofr->idle_timeout);
1861 fr->hard_timeout = 0;
1862 fr->packet_count = ntohll(ofr->packet_count);
1863 fr->byte_count = ntohll(ofr->byte_count);
1864 } else if (raw == OFPRAW_NXT_FLOW_REMOVED) {
1865 struct nx_flow_removed *nfr;
1868 nfr = ofpbuf_pull(&b, sizeof *nfr);
1869 error = nx_pull_match(&b, ntohs(nfr->match_len), ntohs(nfr->priority),
1870 &fr->rule, NULL, NULL);
1875 return OFPERR_OFPBRC_BAD_LEN;
1878 fr->cookie = nfr->cookie;
1879 fr->reason = nfr->reason;
1880 fr->duration_sec = ntohl(nfr->duration_sec);
1881 fr->duration_nsec = ntohl(nfr->duration_nsec);
1882 fr->idle_timeout = ntohs(nfr->idle_timeout);
1883 fr->hard_timeout = 0;
1884 fr->packet_count = ntohll(nfr->packet_count);
1885 fr->byte_count = ntohll(nfr->byte_count);
1893 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
1894 * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
1897 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
1898 enum ofputil_protocol protocol)
1903 case OFPUTIL_P_OF12: {
1904 struct ofp12_flow_removed *ofr;
1906 msg = ofpraw_alloc_xid(OFPRAW_OFPT11_FLOW_REMOVED,
1907 ofputil_protocol_to_ofp_version(protocol),
1908 htonl(0), NXM_TYPICAL_LEN);
1909 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
1910 ofr->cookie = fr->cookie;
1911 ofr->priority = htons(fr->rule.priority);
1912 ofr->reason = fr->reason;
1914 ofr->duration_sec = htonl(fr->duration_sec);
1915 ofr->duration_nsec = htonl(fr->duration_nsec);
1916 ofr->idle_timeout = htons(fr->idle_timeout);
1917 ofr->hard_timeout = htons(fr->hard_timeout);
1918 ofr->packet_count = htonll(fr->packet_count);
1919 ofr->byte_count = htonll(fr->byte_count);
1920 oxm_put_match(msg, &fr->rule);
1924 case OFPUTIL_P_OF10:
1925 case OFPUTIL_P_OF10_TID: {
1926 struct ofp_flow_removed *ofr;
1928 msg = ofpraw_alloc_xid(OFPRAW_OFPT10_FLOW_REMOVED, OFP10_VERSION,
1930 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
1931 ofputil_cls_rule_to_ofp10_match(&fr->rule, &ofr->match);
1932 ofr->cookie = fr->cookie;
1933 ofr->priority = htons(fr->rule.priority);
1934 ofr->reason = fr->reason;
1935 ofr->duration_sec = htonl(fr->duration_sec);
1936 ofr->duration_nsec = htonl(fr->duration_nsec);
1937 ofr->idle_timeout = htons(fr->idle_timeout);
1938 ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
1939 ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
1944 case OFPUTIL_P_NXM_TID: {
1945 struct nx_flow_removed *nfr;
1948 msg = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_REMOVED, OFP10_VERSION,
1949 htonl(0), NXM_TYPICAL_LEN);
1950 nfr = ofpbuf_put_zeros(msg, sizeof *nfr);
1951 match_len = nx_put_match(msg, &fr->rule, 0, 0);
1954 nfr->cookie = fr->cookie;
1955 nfr->priority = htons(fr->rule.priority);
1956 nfr->reason = fr->reason;
1957 nfr->duration_sec = htonl(fr->duration_sec);
1958 nfr->duration_nsec = htonl(fr->duration_nsec);
1959 nfr->idle_timeout = htons(fr->idle_timeout);
1960 nfr->match_len = htons(match_len);
1961 nfr->packet_count = htonll(fr->packet_count);
1962 nfr->byte_count = htonll(fr->byte_count);
1974 ofputil_decode_packet_in_finish(struct ofputil_packet_in *pin,
1975 struct cls_rule *rule,
1978 pin->packet = b->data;
1979 pin->packet_len = b->size;
1981 pin->fmd.in_port = rule->flow.in_port;
1983 pin->fmd.tun_id = rule->flow.tun_id;
1984 pin->fmd.tun_id_mask = rule->wc.tun_id_mask;
1986 pin->fmd.metadata = rule->flow.metadata;
1987 pin->fmd.metadata_mask = rule->wc.metadata_mask;
1989 memcpy(pin->fmd.regs, rule->flow.regs, sizeof pin->fmd.regs);
1990 memcpy(pin->fmd.reg_masks, rule->wc.reg_masks, sizeof pin->fmd.reg_masks);
1994 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
1995 const struct ofp_header *oh)
2000 memset(pin, 0, sizeof *pin);
2002 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2003 raw = ofpraw_pull_assert(&b);
2004 if (raw == OFPRAW_OFPT12_PACKET_IN) {
2005 const struct ofp12_packet_in *opi;
2006 struct cls_rule rule;
2009 opi = ofpbuf_pull(&b, sizeof *opi);
2010 error = oxm_pull_match_loose(&b, 0, &rule);
2015 if (!ofpbuf_try_pull(&b, 2)) {
2016 return OFPERR_OFPBRC_BAD_LEN;
2019 pin->reason = opi->reason;
2020 pin->table_id = opi->table_id;
2022 pin->buffer_id = ntohl(opi->buffer_id);
2023 pin->total_len = ntohs(opi->total_len);
2025 ofputil_decode_packet_in_finish(pin, &rule, &b);
2026 } else if (raw == OFPRAW_OFPT10_PACKET_IN) {
2027 const struct ofp_packet_in *opi;
2029 opi = ofpbuf_pull(&b, offsetof(struct ofp_packet_in, data));
2031 pin->packet = opi->data;
2032 pin->packet_len = b.size;
2034 pin->fmd.in_port = ntohs(opi->in_port);
2035 pin->reason = opi->reason;
2036 pin->buffer_id = ntohl(opi->buffer_id);
2037 pin->total_len = ntohs(opi->total_len);
2038 } else if (raw == OFPRAW_NXT_PACKET_IN) {
2039 const struct nx_packet_in *npi;
2040 struct cls_rule rule;
2043 npi = ofpbuf_pull(&b, sizeof *npi);
2044 error = nx_pull_match_loose(&b, ntohs(npi->match_len), 0, &rule, NULL,
2050 if (!ofpbuf_try_pull(&b, 2)) {
2051 return OFPERR_OFPBRC_BAD_LEN;
2054 pin->reason = npi->reason;
2055 pin->table_id = npi->table_id;
2056 pin->cookie = npi->cookie;
2058 pin->buffer_id = ntohl(npi->buffer_id);
2059 pin->total_len = ntohs(npi->total_len);
2061 ofputil_decode_packet_in_finish(pin, &rule, &b);
2070 ofputil_packet_in_to_rule(const struct ofputil_packet_in *pin,
2071 struct cls_rule *rule)
2075 cls_rule_init_catchall(rule, 0);
2076 cls_rule_set_tun_id_masked(rule, pin->fmd.tun_id,
2077 pin->fmd.tun_id_mask);
2078 cls_rule_set_metadata_masked(rule, pin->fmd.metadata,
2079 pin->fmd.metadata_mask);
2081 for (i = 0; i < FLOW_N_REGS; i++) {
2082 cls_rule_set_reg_masked(rule, i, pin->fmd.regs[i],
2083 pin->fmd.reg_masks[i]);
2086 cls_rule_set_in_port(rule, pin->fmd.in_port);
2089 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
2090 * in the format specified by 'packet_in_format'. */
2092 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
2093 enum ofputil_protocol protocol,
2094 enum nx_packet_in_format packet_in_format)
2096 size_t send_len = MIN(pin->send_len, pin->packet_len);
2097 struct ofpbuf *packet;
2099 /* Add OFPT_PACKET_IN. */
2100 if (protocol == OFPUTIL_P_OF12) {
2101 struct ofp12_packet_in *opi;
2102 struct cls_rule rule;
2104 ofputil_packet_in_to_rule(pin, &rule);
2106 /* The final argument is just an estimate of the space required. */
2107 packet = ofpraw_alloc_xid(OFPRAW_OFPT12_PACKET_IN, OFP12_VERSION,
2108 htonl(0), (sizeof(struct flow_metadata) * 2
2110 ofpbuf_put_zeros(packet, sizeof *opi);
2111 oxm_put_match(packet, &rule);
2112 ofpbuf_put_zeros(packet, 2);
2113 ofpbuf_put(packet, pin->packet, send_len);
2116 opi->buffer_id = htonl(pin->buffer_id);
2117 opi->total_len = htons(pin->total_len);
2118 opi->reason = pin->reason;
2119 opi->table_id = pin->table_id;
2120 } else if (packet_in_format == NXPIF_OPENFLOW10) {
2121 struct ofp_packet_in *opi;
2123 packet = ofpraw_alloc_xid(OFPRAW_OFPT10_PACKET_IN, OFP10_VERSION,
2124 htonl(0), send_len);
2125 opi = ofpbuf_put_zeros(packet, offsetof(struct ofp_packet_in, data));
2126 opi->total_len = htons(pin->total_len);
2127 opi->in_port = htons(pin->fmd.in_port);
2128 opi->reason = pin->reason;
2129 opi->buffer_id = htonl(pin->buffer_id);
2131 ofpbuf_put(packet, pin->packet, send_len);
2132 } else if (packet_in_format == NXPIF_NXM) {
2133 struct nx_packet_in *npi;
2134 struct cls_rule rule;
2137 ofputil_packet_in_to_rule(pin, &rule);
2139 /* The final argument is just an estimate of the space required. */
2140 packet = ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN, OFP10_VERSION,
2141 htonl(0), (sizeof(struct flow_metadata) * 2
2143 ofpbuf_put_zeros(packet, sizeof *npi);
2144 match_len = nx_put_match(packet, &rule, 0, 0);
2145 ofpbuf_put_zeros(packet, 2);
2146 ofpbuf_put(packet, pin->packet, send_len);
2149 npi->buffer_id = htonl(pin->buffer_id);
2150 npi->total_len = htons(pin->total_len);
2151 npi->reason = pin->reason;
2152 npi->table_id = pin->table_id;
2153 npi->cookie = pin->cookie;
2154 npi->match_len = htons(match_len);
2158 ofpmsg_update_length(packet);
2164 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason)
2166 static char s[INT_STRLEN(int) + 1];
2173 case OFPR_INVALID_TTL:
2174 return "invalid_ttl";
2176 case OFPR_N_REASONS:
2178 sprintf(s, "%d", (int) reason);
2184 ofputil_packet_in_reason_from_string(const char *s,
2185 enum ofp_packet_in_reason *reason)
2189 for (i = 0; i < OFPR_N_REASONS; i++) {
2190 if (!strcasecmp(s, ofputil_packet_in_reason_to_string(i))) {
2198 /* Converts an OFPT_PACKET_OUT in 'opo' into an abstract ofputil_packet_out in
2201 * Uses 'ofpacts' to store the abstract OFPACT_* version of the packet out
2202 * message's actions. The caller must initialize 'ofpacts' and retains
2203 * ownership of it. 'po->ofpacts' will point into the 'ofpacts' buffer.
2205 * Returns 0 if successful, otherwise an OFPERR_* value. */
2207 ofputil_decode_packet_out(struct ofputil_packet_out *po,
2208 const struct ofp_header *oh,
2209 struct ofpbuf *ofpacts)
2211 enum ofperr bad_in_port_err;
2215 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2216 raw = ofpraw_pull_assert(&b);
2218 if (raw == OFPRAW_OFPT11_PACKET_OUT) {
2220 const struct ofp11_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
2222 po->buffer_id = ntohl(opo->buffer_id);
2223 error = ofputil_port_from_ofp11(opo->in_port, &po->in_port);
2228 error = ofpacts_pull_openflow11_actions(&b, ntohs(opo->actions_len),
2234 bad_in_port_err = OFPERR_OFPBMC_BAD_VALUE;
2235 } else if (raw == OFPRAW_OFPT10_PACKET_OUT) {
2237 const struct ofp_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
2239 po->buffer_id = ntohl(opo->buffer_id);
2240 po->in_port = ntohs(opo->in_port);
2242 error = ofpacts_pull_openflow10(&b, ntohs(opo->actions_len), ofpacts);
2247 bad_in_port_err = OFPERR_NXBRC_BAD_IN_PORT;
2252 if (po->in_port >= OFPP_MAX && po->in_port != OFPP_LOCAL
2253 && po->in_port != OFPP_NONE && po->in_port != OFPP_CONTROLLER) {
2254 VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
2256 return bad_in_port_err;
2259 po->ofpacts = ofpacts->data;
2260 po->ofpacts_len = ofpacts->size;
2262 if (po->buffer_id == UINT32_MAX) {
2263 po->packet = b.data;
2264 po->packet_len = b.size;
2273 /* ofputil_phy_port */
2275 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
2276 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
2277 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
2278 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
2279 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
2280 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
2281 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
2282 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
2284 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
2285 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
2286 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
2287 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
2288 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
2289 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
2291 static enum netdev_features
2292 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
2294 uint32_t ofp10 = ntohl(ofp10_);
2295 return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
2299 netdev_port_features_to_ofp10(enum netdev_features features)
2301 return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
2304 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
2305 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
2306 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
2307 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
2308 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
2309 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
2310 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
2311 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD == OFPPF11_40GB_FD); /* bit 7 */
2312 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD == OFPPF11_100GB_FD); /* bit 8 */
2313 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD == OFPPF11_1TB_FD); /* bit 9 */
2314 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER == OFPPF11_OTHER); /* bit 10 */
2315 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == OFPPF11_COPPER); /* bit 11 */
2316 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == OFPPF11_FIBER); /* bit 12 */
2317 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == OFPPF11_AUTONEG); /* bit 13 */
2318 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == OFPPF11_PAUSE); /* bit 14 */
2319 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
2321 static enum netdev_features
2322 netdev_port_features_from_ofp11(ovs_be32 ofp11)
2324 return ntohl(ofp11) & 0xffff;
2328 netdev_port_features_to_ofp11(enum netdev_features features)
2330 return htonl(features & 0xffff);
2334 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
2335 const struct ofp10_phy_port *opp)
2337 memset(pp, 0, sizeof *pp);
2339 pp->port_no = ntohs(opp->port_no);
2340 memcpy(pp->hw_addr, opp->hw_addr, OFP_ETH_ALEN);
2341 ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
2343 pp->config = ntohl(opp->config) & OFPPC10_ALL;
2344 pp->state = ntohl(opp->state) & OFPPS10_ALL;
2346 pp->curr = netdev_port_features_from_ofp10(opp->curr);
2347 pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
2348 pp->supported = netdev_port_features_from_ofp10(opp->supported);
2349 pp->peer = netdev_port_features_from_ofp10(opp->peer);
2351 pp->curr_speed = netdev_features_to_bps(pp->curr) / 1000;
2352 pp->max_speed = netdev_features_to_bps(pp->supported) / 1000;
2358 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
2359 const struct ofp11_port *op)
2363 memset(pp, 0, sizeof *pp);
2365 error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
2369 memcpy(pp->hw_addr, op->hw_addr, OFP_ETH_ALEN);
2370 ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
2372 pp->config = ntohl(op->config) & OFPPC11_ALL;
2373 pp->state = ntohl(op->state) & OFPPC11_ALL;
2375 pp->curr = netdev_port_features_from_ofp11(op->curr);
2376 pp->advertised = netdev_port_features_from_ofp11(op->advertised);
2377 pp->supported = netdev_port_features_from_ofp11(op->supported);
2378 pp->peer = netdev_port_features_from_ofp11(op->peer);
2380 pp->curr_speed = ntohl(op->curr_speed);
2381 pp->max_speed = ntohl(op->max_speed);
2387 ofputil_get_phy_port_size(enum ofp_version ofp_version)
2389 switch (ofp_version) {
2391 return sizeof(struct ofp10_phy_port);
2394 return sizeof(struct ofp11_port);
2401 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
2402 struct ofp10_phy_port *opp)
2404 memset(opp, 0, sizeof *opp);
2406 opp->port_no = htons(pp->port_no);
2407 memcpy(opp->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2408 ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2410 opp->config = htonl(pp->config & OFPPC10_ALL);
2411 opp->state = htonl(pp->state & OFPPS10_ALL);
2413 opp->curr = netdev_port_features_to_ofp10(pp->curr);
2414 opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
2415 opp->supported = netdev_port_features_to_ofp10(pp->supported);
2416 opp->peer = netdev_port_features_to_ofp10(pp->peer);
2420 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
2421 struct ofp11_port *op)
2423 memset(op, 0, sizeof *op);
2425 op->port_no = ofputil_port_to_ofp11(pp->port_no);
2426 memcpy(op->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2427 ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2429 op->config = htonl(pp->config & OFPPC11_ALL);
2430 op->state = htonl(pp->state & OFPPS11_ALL);
2432 op->curr = netdev_port_features_to_ofp11(pp->curr);
2433 op->advertised = netdev_port_features_to_ofp11(pp->advertised);
2434 op->supported = netdev_port_features_to_ofp11(pp->supported);
2435 op->peer = netdev_port_features_to_ofp11(pp->peer);
2437 op->curr_speed = htonl(pp->curr_speed);
2438 op->max_speed = htonl(pp->max_speed);
2442 ofputil_put_phy_port(enum ofp_version ofp_version,
2443 const struct ofputil_phy_port *pp, struct ofpbuf *b)
2445 switch (ofp_version) {
2446 case OFP10_VERSION: {
2447 struct ofp10_phy_port *opp;
2448 if (b->size + sizeof *opp <= UINT16_MAX) {
2449 opp = ofpbuf_put_uninit(b, sizeof *opp);
2450 ofputil_encode_ofp10_phy_port(pp, opp);
2456 case OFP12_VERSION: {
2457 struct ofp11_port *op;
2458 if (b->size + sizeof *op <= UINT16_MAX) {
2459 op = ofpbuf_put_uninit(b, sizeof *op);
2460 ofputil_encode_ofp11_port(pp, op);
2471 ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
2472 const struct ofputil_phy_port *pp,
2473 struct list *replies)
2475 switch (ofp_version) {
2476 case OFP10_VERSION: {
2477 struct ofp10_phy_port *opp;
2479 opp = ofpmp_append(replies, sizeof *opp);
2480 ofputil_encode_ofp10_phy_port(pp, opp);
2485 case OFP12_VERSION: {
2486 struct ofp11_port *op;
2488 op = ofpmp_append(replies, sizeof *op);
2489 ofputil_encode_ofp11_port(pp, op);
2498 /* ofputil_switch_features */
2500 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
2501 OFPC_IP_REASM | OFPC_QUEUE_STATS)
2502 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
2503 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
2504 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
2505 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
2506 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
2507 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
2509 struct ofputil_action_bit_translation {
2510 enum ofputil_action_bitmap ofputil_bit;
2514 static const struct ofputil_action_bit_translation of10_action_bits[] = {
2515 { OFPUTIL_A_OUTPUT, OFPAT10_OUTPUT },
2516 { OFPUTIL_A_SET_VLAN_VID, OFPAT10_SET_VLAN_VID },
2517 { OFPUTIL_A_SET_VLAN_PCP, OFPAT10_SET_VLAN_PCP },
2518 { OFPUTIL_A_STRIP_VLAN, OFPAT10_STRIP_VLAN },
2519 { OFPUTIL_A_SET_DL_SRC, OFPAT10_SET_DL_SRC },
2520 { OFPUTIL_A_SET_DL_DST, OFPAT10_SET_DL_DST },
2521 { OFPUTIL_A_SET_NW_SRC, OFPAT10_SET_NW_SRC },
2522 { OFPUTIL_A_SET_NW_DST, OFPAT10_SET_NW_DST },
2523 { OFPUTIL_A_SET_NW_TOS, OFPAT10_SET_NW_TOS },
2524 { OFPUTIL_A_SET_TP_SRC, OFPAT10_SET_TP_SRC },
2525 { OFPUTIL_A_SET_TP_DST, OFPAT10_SET_TP_DST },
2526 { OFPUTIL_A_ENQUEUE, OFPAT10_ENQUEUE },
2530 static enum ofputil_action_bitmap
2531 decode_action_bits(ovs_be32 of_actions,
2532 const struct ofputil_action_bit_translation *x)
2534 enum ofputil_action_bitmap ofputil_actions;
2536 ofputil_actions = 0;
2537 for (; x->ofputil_bit; x++) {
2538 if (of_actions & htonl(1u << x->of_bit)) {
2539 ofputil_actions |= x->ofputil_bit;
2542 return ofputil_actions;
2546 ofputil_capabilities_mask(enum ofp_version ofp_version)
2548 /* Handle capabilities whose bit is unique for all Open Flow versions */
2549 switch (ofp_version) {
2552 return OFPC_COMMON | OFPC_ARP_MATCH_IP;
2554 return OFPC_COMMON | OFPC12_PORT_BLOCKED;
2556 /* Caller needs to check osf->header.version itself */
2561 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
2562 * abstract representation in '*features'. Initializes '*b' to iterate over
2563 * the OpenFlow port structures following 'osf' with later calls to
2564 * ofputil_pull_phy_port(). Returns 0 if successful, otherwise an
2565 * OFPERR_* value. */
2567 ofputil_decode_switch_features(const struct ofp_header *oh,
2568 struct ofputil_switch_features *features,
2571 const struct ofp_switch_features *osf;
2574 ofpbuf_use_const(b, oh, ntohs(oh->length));
2575 raw = ofpraw_pull_assert(b);
2577 osf = ofpbuf_pull(b, sizeof *osf);
2578 features->datapath_id = ntohll(osf->datapath_id);
2579 features->n_buffers = ntohl(osf->n_buffers);
2580 features->n_tables = osf->n_tables;
2582 features->capabilities = ntohl(osf->capabilities) &
2583 ofputil_capabilities_mask(oh->version);
2585 if (b->size % ofputil_get_phy_port_size(oh->version)) {
2586 return OFPERR_OFPBRC_BAD_LEN;
2589 if (raw == OFPRAW_OFPT10_FEATURES_REPLY) {
2590 if (osf->capabilities & htonl(OFPC10_STP)) {
2591 features->capabilities |= OFPUTIL_C_STP;
2593 features->actions = decode_action_bits(osf->actions, of10_action_bits);
2594 } else if (raw == OFPRAW_OFPT11_FEATURES_REPLY) {
2595 if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
2596 features->capabilities |= OFPUTIL_C_GROUP_STATS;
2598 features->actions = 0;
2600 return OFPERR_OFPBRC_BAD_VERSION;
2606 /* Returns true if the maximum number of ports are in 'oh'. */
2608 max_ports_in_features(const struct ofp_header *oh)
2610 size_t pp_size = ofputil_get_phy_port_size(oh->version);
2611 return ntohs(oh->length) + pp_size > UINT16_MAX;
2614 /* Given a buffer 'b' that contains a Features Reply message, checks if
2615 * it contains the maximum number of ports that will fit. If so, it
2616 * returns true and removes the ports from the message. The caller
2617 * should then send an OFPST_PORT_DESC stats request to get the ports,
2618 * since the switch may have more ports than could be represented in the
2619 * Features Reply. Otherwise, returns false.
2622 ofputil_switch_features_ports_trunc(struct ofpbuf *b)
2624 struct ofp_header *oh = b->data;
2626 if (max_ports_in_features(oh)) {
2627 /* Remove all the ports. */
2628 b->size = (sizeof(struct ofp_header)
2629 + sizeof(struct ofp_switch_features));
2630 ofpmsg_update_length(b);
2639 encode_action_bits(enum ofputil_action_bitmap ofputil_actions,
2640 const struct ofputil_action_bit_translation *x)
2642 uint32_t of_actions;
2645 for (; x->ofputil_bit; x++) {
2646 if (ofputil_actions & x->ofputil_bit) {
2647 of_actions |= 1 << x->of_bit;
2650 return htonl(of_actions);
2653 /* Returns a buffer owned by the caller that encodes 'features' in the format
2654 * required by 'protocol' with the given 'xid'. The caller should append port
2655 * information to the buffer with subsequent calls to
2656 * ofputil_put_switch_features_port(). */
2658 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
2659 enum ofputil_protocol protocol, ovs_be32 xid)
2661 struct ofp_switch_features *osf;
2663 enum ofp_version version;
2666 version = ofputil_protocol_to_ofp_version(protocol);
2669 raw = OFPRAW_OFPT10_FEATURES_REPLY;
2673 raw = OFPRAW_OFPT11_FEATURES_REPLY;
2678 b = ofpraw_alloc_xid(raw, version, xid, 0);
2679 osf = ofpbuf_put_zeros(b, sizeof *osf);
2680 osf->datapath_id = htonll(features->datapath_id);
2681 osf->n_buffers = htonl(features->n_buffers);
2682 osf->n_tables = features->n_tables;
2684 osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
2685 osf->capabilities = htonl(features->capabilities &
2686 ofputil_capabilities_mask(version));
2689 if (features->capabilities & OFPUTIL_C_STP) {
2690 osf->capabilities |= htonl(OFPC10_STP);
2692 osf->actions = encode_action_bits(features->actions, of10_action_bits);
2696 if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
2697 osf->capabilities |= htonl(OFPC11_GROUP_STATS);
2707 /* Encodes 'pp' into the format required by the switch_features message already
2708 * in 'b', which should have been returned by ofputil_encode_switch_features(),
2709 * and appends the encoded version to 'b'. */
2711 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
2714 const struct ofp_header *oh = b->data;
2716 ofputil_put_phy_port(oh->version, pp, b);
2719 /* ofputil_port_status */
2721 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
2722 * in '*ps'. Returns 0 if successful, otherwise an OFPERR_* value. */
2724 ofputil_decode_port_status(const struct ofp_header *oh,
2725 struct ofputil_port_status *ps)
2727 const struct ofp_port_status *ops;
2731 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2732 ofpraw_pull_assert(&b);
2733 ops = ofpbuf_pull(&b, sizeof *ops);
2735 if (ops->reason != OFPPR_ADD &&
2736 ops->reason != OFPPR_DELETE &&
2737 ops->reason != OFPPR_MODIFY) {
2738 return OFPERR_NXBRC_BAD_REASON;
2740 ps->reason = ops->reason;
2742 retval = ofputil_pull_phy_port(oh->version, &b, &ps->desc);
2743 assert(retval != EOF);
2747 /* Converts the abstract form of a "port status" message in '*ps' into an
2748 * OpenFlow message suitable for 'protocol', and returns that encoded form in
2749 * a buffer owned by the caller. */
2751 ofputil_encode_port_status(const struct ofputil_port_status *ps,
2752 enum ofputil_protocol protocol)
2754 struct ofp_port_status *ops;
2756 enum ofp_version version;
2759 version = ofputil_protocol_to_ofp_version(protocol);
2762 raw = OFPRAW_OFPT10_PORT_STATUS;
2767 raw = OFPRAW_OFPT11_PORT_STATUS;
2774 b = ofpraw_alloc_xid(raw, version, htonl(0), 0);
2775 ops = ofpbuf_put_zeros(b, sizeof *ops);
2776 ops->reason = ps->reason;
2777 ofputil_put_phy_port(version, &ps->desc, b);
2778 ofpmsg_update_length(b);
2782 /* ofputil_port_mod */
2784 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
2785 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
2787 ofputil_decode_port_mod(const struct ofp_header *oh,
2788 struct ofputil_port_mod *pm)
2793 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2794 raw = ofpraw_pull_assert(&b);
2796 if (raw == OFPRAW_OFPT10_PORT_MOD) {
2797 const struct ofp10_port_mod *opm = b.data;
2799 pm->port_no = ntohs(opm->port_no);
2800 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
2801 pm->config = ntohl(opm->config) & OFPPC10_ALL;
2802 pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
2803 pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
2804 } else if (raw == OFPRAW_OFPT11_PORT_MOD) {
2805 const struct ofp11_port_mod *opm = b.data;
2808 error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
2813 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
2814 pm->config = ntohl(opm->config) & OFPPC11_ALL;
2815 pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
2816 pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
2818 return OFPERR_OFPBRC_BAD_TYPE;
2821 pm->config &= pm->mask;
2825 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
2826 * message suitable for 'protocol', and returns that encoded form in a buffer
2827 * owned by the caller. */
2829 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
2830 enum ofputil_protocol protocol)
2832 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
2835 switch (ofp_version) {
2836 case OFP10_VERSION: {
2837 struct ofp10_port_mod *opm;
2839 b = ofpraw_alloc(OFPRAW_OFPT10_PORT_MOD, ofp_version, 0);
2840 opm = ofpbuf_put_zeros(b, sizeof *opm);
2841 opm->port_no = htons(pm->port_no);
2842 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
2843 opm->config = htonl(pm->config & OFPPC10_ALL);
2844 opm->mask = htonl(pm->mask & OFPPC10_ALL);
2845 opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
2849 case OFP11_VERSION: {
2850 struct ofp11_port_mod *opm;
2852 b = ofpraw_alloc(OFPRAW_OFPT11_PORT_MOD, ofp_version, 0);
2853 opm = ofpbuf_put_zeros(b, sizeof *opm);
2854 opm->port_no = htonl(pm->port_no);
2855 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
2856 opm->config = htonl(pm->config & OFPPC11_ALL);
2857 opm->mask = htonl(pm->mask & OFPPC11_ALL);
2858 opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
2870 /* ofputil_flow_monitor_request */
2872 /* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract
2873 * ofputil_flow_monitor_request in 'rq'.
2875 * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow
2876 * message. Calling this function multiple times for a single 'msg' iterates
2877 * through the requests. The caller must initially leave 'msg''s layer
2878 * pointers null and not modify them between calls.
2880 * Returns 0 if successful, EOF if no requests were left in this 'msg',
2881 * otherwise an OFPERR_* value. */
2883 ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *rq,
2886 struct nx_flow_monitor_request *nfmr;
2890 msg->l2 = msg->data;
2891 ofpraw_pull_assert(msg);
2898 nfmr = ofpbuf_try_pull(msg, sizeof *nfmr);
2900 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR request has %zu "
2901 "leftover bytes at end", msg->size);
2902 return OFPERR_OFPBRC_BAD_LEN;
2905 flags = ntohs(nfmr->flags);
2906 if (!(flags & (NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY))
2907 || flags & ~(NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE
2908 | NXFMF_MODIFY | NXFMF_ACTIONS | NXFMF_OWN)) {
2909 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR has bad flags %#"PRIx16,
2911 return OFPERR_NXBRC_FM_BAD_FLAGS;
2914 if (!is_all_zeros(nfmr->zeros, sizeof nfmr->zeros)) {
2915 return OFPERR_NXBRC_MUST_BE_ZERO;
2918 rq->id = ntohl(nfmr->id);
2920 rq->out_port = ntohs(nfmr->out_port);
2921 rq->table_id = nfmr->table_id;
2923 return nx_pull_match(msg, ntohs(nfmr->match_len), OFP_DEFAULT_PRIORITY,
2924 &rq->match, NULL, NULL);
2928 ofputil_append_flow_monitor_request(
2929 const struct ofputil_flow_monitor_request *rq, struct ofpbuf *msg)
2931 struct nx_flow_monitor_request *nfmr;
2936 ofpraw_put(OFPRAW_NXST_FLOW_MONITOR_REQUEST, OFP10_VERSION, msg);
2939 start_ofs = msg->size;
2940 ofpbuf_put_zeros(msg, sizeof *nfmr);
2941 match_len = nx_put_match(msg, &rq->match, htonll(0), htonll(0));
2943 nfmr = ofpbuf_at_assert(msg, start_ofs, sizeof *nfmr);
2944 nfmr->id = htonl(rq->id);
2945 nfmr->flags = htons(rq->flags);
2946 nfmr->out_port = htons(rq->out_port);
2947 nfmr->match_len = htons(match_len);
2948 nfmr->table_id = rq->table_id;
2951 /* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg'
2952 * into an abstract ofputil_flow_update in 'update'. The caller must have
2953 * initialized update->match to point to space allocated for a cls_rule.
2955 * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's
2956 * actions (except for NXFME_ABBREV, which never includes actions). The caller
2957 * must initialize 'ofpacts' and retains ownership of it. 'update->ofpacts'
2958 * will point into the 'ofpacts' buffer.
2960 * Multiple flow updates can be packed into a single OpenFlow message. Calling
2961 * this function multiple times for a single 'msg' iterates through the
2962 * updates. The caller must initially leave 'msg''s layer pointers null and
2963 * not modify them between calls.
2965 * Returns 0 if successful, EOF if no updates were left in this 'msg',
2966 * otherwise an OFPERR_* value. */
2968 ofputil_decode_flow_update(struct ofputil_flow_update *update,
2969 struct ofpbuf *msg, struct ofpbuf *ofpacts)
2971 struct nx_flow_update_header *nfuh;
2972 unsigned int length;
2975 msg->l2 = msg->data;
2976 ofpraw_pull_assert(msg);
2983 if (msg->size < sizeof(struct nx_flow_update_header)) {
2988 update->event = ntohs(nfuh->event);
2989 length = ntohs(nfuh->length);
2990 if (length > msg->size || length % 8) {
2994 if (update->event == NXFME_ABBREV) {
2995 struct nx_flow_update_abbrev *nfua;
2997 if (length != sizeof *nfua) {
3001 nfua = ofpbuf_pull(msg, sizeof *nfua);
3002 update->xid = nfua->xid;
3004 } else if (update->event == NXFME_ADDED
3005 || update->event == NXFME_DELETED
3006 || update->event == NXFME_MODIFIED) {
3007 struct nx_flow_update_full *nfuf;
3008 unsigned int actions_len;
3009 unsigned int match_len;
3012 if (length < sizeof *nfuf) {
3016 nfuf = ofpbuf_pull(msg, sizeof *nfuf);
3017 match_len = ntohs(nfuf->match_len);
3018 if (sizeof *nfuf + match_len > length) {
3022 update->reason = ntohs(nfuf->reason);
3023 update->idle_timeout = ntohs(nfuf->idle_timeout);
3024 update->hard_timeout = ntohs(nfuf->hard_timeout);
3025 update->table_id = nfuf->table_id;
3026 update->cookie = nfuf->cookie;
3028 error = nx_pull_match(msg, match_len, ntohs(nfuf->priority),
3029 update->match, NULL, NULL);
3034 actions_len = length - sizeof *nfuf - ROUND_UP(match_len, 8);
3035 error = ofpacts_pull_openflow10(msg, actions_len, ofpacts);
3040 update->ofpacts = ofpacts->data;
3041 update->ofpacts_len = ofpacts->size;
3044 VLOG_WARN_RL(&bad_ofmsg_rl,
3045 "NXST_FLOW_MONITOR reply has bad event %"PRIu16,
3046 ntohs(nfuh->event));
3047 return OFPERR_OFPET_BAD_REQUEST;
3051 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR reply has %zu "
3052 "leftover bytes at end", msg->size);
3053 return OFPERR_OFPBRC_BAD_LEN;
3057 ofputil_decode_flow_monitor_cancel(const struct ofp_header *oh)
3059 const struct nx_flow_monitor_cancel *cancel = ofpmsg_body(oh);
3061 return ntohl(cancel->id);
3065 ofputil_encode_flow_monitor_cancel(uint32_t id)
3067 struct nx_flow_monitor_cancel *nfmc;
3070 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MONITOR_CANCEL, OFP10_VERSION, 0);
3071 nfmc = ofpbuf_put_uninit(msg, sizeof *nfmc);
3072 nfmc->id = htonl(id);
3077 ofputil_start_flow_update(struct list *replies)
3081 msg = ofpraw_alloc_xid(OFPRAW_NXST_FLOW_MONITOR_REPLY, OFP10_VERSION,
3085 list_push_back(replies, &msg->list_node);
3089 ofputil_append_flow_update(const struct ofputil_flow_update *update,
3090 struct list *replies)
3092 struct nx_flow_update_header *nfuh;
3096 msg = ofpbuf_from_list(list_back(replies));
3097 start_ofs = msg->size;
3099 if (update->event == NXFME_ABBREV) {
3100 struct nx_flow_update_abbrev *nfua;
3102 nfua = ofpbuf_put_zeros(msg, sizeof *nfua);
3103 nfua->xid = update->xid;
3105 struct nx_flow_update_full *nfuf;
3108 ofpbuf_put_zeros(msg, sizeof *nfuf);
3109 match_len = nx_put_match(msg, update->match, htonll(0), htonll(0));
3110 ofpacts_put_openflow10(update->ofpacts, update->ofpacts_len, msg);
3112 nfuf = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuf);
3113 nfuf->reason = htons(update->reason);
3114 nfuf->priority = htons(update->match->priority);
3115 nfuf->idle_timeout = htons(update->idle_timeout);
3116 nfuf->hard_timeout = htons(update->hard_timeout);
3117 nfuf->match_len = htons(match_len);
3118 nfuf->table_id = update->table_id;
3119 nfuf->cookie = update->cookie;
3122 nfuh = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuh);
3123 nfuh->length = htons(msg->size - start_ofs);
3124 nfuh->event = htons(update->event);
3126 ofpmp_postappend(replies, start_ofs);
3130 ofputil_encode_packet_out(const struct ofputil_packet_out *po,
3131 enum ofputil_protocol protocol)
3133 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
3137 size = po->ofpacts_len;
3138 if (po->buffer_id == UINT32_MAX) {
3139 size += po->packet_len;
3142 switch (ofp_version) {
3143 case OFP10_VERSION: {
3144 struct ofp_packet_out *opo;
3147 msg = ofpraw_alloc(OFPRAW_OFPT10_PACKET_OUT, OFP10_VERSION, size);
3148 ofpbuf_put_zeros(msg, sizeof *opo);
3149 actions_ofs = msg->size;
3150 ofpacts_put_openflow10(po->ofpacts, po->ofpacts_len, msg);
3153 opo->buffer_id = htonl(po->buffer_id);
3154 opo->in_port = htons(po->in_port);
3155 opo->actions_len = htons(msg->size - actions_ofs);
3160 case OFP12_VERSION: {
3161 struct ofp11_packet_out *opo;
3164 msg = ofpraw_alloc(OFPRAW_OFPT11_PACKET_OUT, ofp_version, size);
3165 ofpbuf_put_zeros(msg, sizeof *opo);
3166 len = ofpacts_put_openflow11_actions(po->ofpacts, po->ofpacts_len, msg);
3169 opo->buffer_id = htonl(po->buffer_id);
3170 opo->in_port = ofputil_port_to_ofp11(po->in_port);
3171 opo->actions_len = htons(len);
3179 if (po->buffer_id == UINT32_MAX) {
3180 ofpbuf_put(msg, po->packet, po->packet_len);
3183 ofpmsg_update_length(msg);
3188 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
3190 make_echo_request(enum ofp_version ofp_version)
3192 return ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST, ofp_version,
3196 /* Creates and returns an OFPT_ECHO_REPLY message matching the
3197 * OFPT_ECHO_REQUEST message in 'rq'. */
3199 make_echo_reply(const struct ofp_header *rq)
3201 struct ofpbuf rq_buf;
3202 struct ofpbuf *reply;
3204 ofpbuf_use_const(&rq_buf, rq, ntohs(rq->length));
3205 ofpraw_pull_assert(&rq_buf);
3207 reply = ofpraw_alloc_reply(OFPRAW_OFPT_ECHO_REPLY, rq, rq_buf.size);
3208 ofpbuf_put(reply, rq_buf.data, rq_buf.size);
3213 ofputil_encode_barrier_request(enum ofp_version ofp_version)
3217 switch (ofp_version) {
3220 type = OFPRAW_OFPT11_BARRIER_REQUEST;
3224 type = OFPRAW_OFPT10_BARRIER_REQUEST;
3231 return ofpraw_alloc(type, ofp_version, 0);
3235 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
3237 switch (flags & OFPC_FRAG_MASK) {
3238 case OFPC_FRAG_NORMAL: return "normal";
3239 case OFPC_FRAG_DROP: return "drop";
3240 case OFPC_FRAG_REASM: return "reassemble";
3241 case OFPC_FRAG_NX_MATCH: return "nx-match";
3248 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
3250 if (!strcasecmp(s, "normal")) {
3251 *flags = OFPC_FRAG_NORMAL;
3252 } else if (!strcasecmp(s, "drop")) {
3253 *flags = OFPC_FRAG_DROP;
3254 } else if (!strcasecmp(s, "reassemble")) {
3255 *flags = OFPC_FRAG_REASM;
3256 } else if (!strcasecmp(s, "nx-match")) {
3257 *flags = OFPC_FRAG_NX_MATCH;
3264 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
3265 * port number and stores the latter in '*ofp10_port', for the purpose of
3266 * decoding OpenFlow 1.1+ protocol messages. Returns 0 if successful,
3267 * otherwise an OFPERR_* number.
3269 * See the definition of OFP11_MAX for an explanation of the mapping. */
3271 ofputil_port_from_ofp11(ovs_be32 ofp11_port, uint16_t *ofp10_port)
3273 uint32_t ofp11_port_h = ntohl(ofp11_port);
3275 if (ofp11_port_h < OFPP_MAX) {
3276 *ofp10_port = ofp11_port_h;
3278 } else if (ofp11_port_h >= OFPP11_MAX) {
3279 *ofp10_port = ofp11_port_h - OFPP11_OFFSET;
3282 VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
3283 "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
3284 ofp11_port_h, OFPP_MAX - 1,
3285 (uint32_t) OFPP11_MAX, UINT32_MAX);
3286 return OFPERR_OFPBAC_BAD_OUT_PORT;
3290 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
3291 * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
3293 * See the definition of OFP11_MAX for an explanation of the mapping. */
3295 ofputil_port_to_ofp11(uint16_t ofp10_port)
3297 return htonl(ofp10_port < OFPP_MAX
3299 : ofp10_port + OFPP11_OFFSET);
3302 /* Checks that 'port' is a valid output port for the OFPAT10_OUTPUT action, given
3303 * that the switch will never have more than 'max_ports' ports. Returns 0 if
3304 * 'port' is valid, otherwise an OpenFlow return code. */
3306 ofputil_check_output_port(uint16_t port, int max_ports)
3314 case OFPP_CONTROLLER:
3320 if (port < max_ports) {
3323 return OFPERR_OFPBAC_BAD_OUT_PORT;
3327 #define OFPUTIL_NAMED_PORTS \
3328 OFPUTIL_NAMED_PORT(IN_PORT) \
3329 OFPUTIL_NAMED_PORT(TABLE) \
3330 OFPUTIL_NAMED_PORT(NORMAL) \
3331 OFPUTIL_NAMED_PORT(FLOOD) \
3332 OFPUTIL_NAMED_PORT(ALL) \
3333 OFPUTIL_NAMED_PORT(CONTROLLER) \
3334 OFPUTIL_NAMED_PORT(LOCAL) \
3335 OFPUTIL_NAMED_PORT(NONE)
3337 /* Checks whether 's' is the string representation of an OpenFlow port number,
3338 * either as an integer or a string name (e.g. "LOCAL"). If it is, stores the
3339 * number in '*port' and returns true. Otherwise, returns false. */
3341 ofputil_port_from_string(const char *name, uint16_t *port)
3347 static const struct pair pairs[] = {
3348 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
3350 #undef OFPUTIL_NAMED_PORT
3352 static const int n_pairs = ARRAY_SIZE(pairs);
3355 if (str_to_int(name, 0, &i) && i >= 0 && i < UINT16_MAX) {
3360 for (i = 0; i < n_pairs; i++) {
3361 if (!strcasecmp(name, pairs[i].name)) {
3362 *port = pairs[i].value;
3369 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
3370 * Most ports' string representation is just the port number, but for special
3371 * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
3373 ofputil_format_port(uint16_t port, struct ds *s)
3378 #define OFPUTIL_NAMED_PORT(NAME) case OFPP_##NAME: name = #NAME; break;
3380 #undef OFPUTIL_NAMED_PORT
3383 ds_put_format(s, "%"PRIu16, port);
3386 ds_put_cstr(s, name);
3389 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3390 * 'ofp_version', tries to pull the first element from the array. If
3391 * successful, initializes '*pp' with an abstract representation of the
3392 * port and returns 0. If no ports remain to be decoded, returns EOF.
3393 * On an error, returns a positive OFPERR_* value. */
3395 ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *b,
3396 struct ofputil_phy_port *pp)
3398 switch (ofp_version) {
3399 case OFP10_VERSION: {
3400 const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
3401 return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
3404 case OFP12_VERSION: {
3405 const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
3406 return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
3413 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3414 * 'ofp_version', returns the number of elements. */
3415 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *b)
3417 return b->size / ofputil_get_phy_port_size(ofp_version);
3420 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
3421 * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1 if
3422 * 'name' is not the name of any action.
3424 * ofp-util.def lists the mapping from names to action. */
3426 ofputil_action_code_from_name(const char *name)
3428 static const char *names[OFPUTIL_N_ACTIONS] = {
3430 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) NAME,
3431 #define OFPAT11_ACTION(ENUM, STRUCT, NAME) NAME,
3432 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
3433 #include "ofp-util.def"
3438 for (p = names; p < &names[ARRAY_SIZE(names)]; p++) {
3439 if (*p && !strcasecmp(name, *p)) {
3446 /* Appends an action of the type specified by 'code' to 'buf' and returns the
3447 * action. Initializes the parts of 'action' that identify it as having type
3448 * <ENUM> and length 'sizeof *action' and zeros the rest. For actions that
3449 * have variable length, the length used and cleared is that of struct
3452 ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
3455 case OFPUTIL_ACTION_INVALID:
3458 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
3459 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3460 #define OFPAT11_ACTION OFPAT10_ACTION
3461 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3462 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3463 #include "ofp-util.def"
3468 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
3470 ofputil_init_##ENUM(struct STRUCT *s) \
3472 memset(s, 0, sizeof *s); \
3473 s->type = htons(ENUM); \
3474 s->len = htons(sizeof *s); \
3478 ofputil_put_##ENUM(struct ofpbuf *buf) \
3480 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
3481 ofputil_init_##ENUM(s); \
3484 #define OFPAT11_ACTION OFPAT10_ACTION
3485 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3487 ofputil_init_##ENUM(struct STRUCT *s) \
3489 memset(s, 0, sizeof *s); \
3490 s->type = htons(OFPAT10_VENDOR); \
3491 s->len = htons(sizeof *s); \
3492 s->vendor = htonl(NX_VENDOR_ID); \
3493 s->subtype = htons(ENUM); \
3497 ofputil_put_##ENUM(struct ofpbuf *buf) \
3499 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
3500 ofputil_init_##ENUM(s); \
3503 #include "ofp-util.def"
3506 ofputil_normalize_rule__(struct cls_rule *rule, bool may_log)
3509 MAY_NW_ADDR = 1 << 0, /* nw_src, nw_dst */
3510 MAY_TP_ADDR = 1 << 1, /* tp_src, tp_dst */
3511 MAY_NW_PROTO = 1 << 2, /* nw_proto */
3512 MAY_IPVx = 1 << 3, /* tos, frag, ttl */
3513 MAY_ARP_SHA = 1 << 4, /* arp_sha */
3514 MAY_ARP_THA = 1 << 5, /* arp_tha */
3515 MAY_IPV6 = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
3516 MAY_ND_TARGET = 1 << 7 /* nd_target */
3519 struct flow_wildcards wc;
3521 /* Figure out what fields may be matched. */
3522 if (rule->flow.dl_type == htons(ETH_TYPE_IP)) {
3523 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
3524 if (rule->flow.nw_proto == IPPROTO_TCP ||
3525 rule->flow.nw_proto == IPPROTO_UDP ||
3526 rule->flow.nw_proto == IPPROTO_ICMP) {
3527 may_match |= MAY_TP_ADDR;
3529 } else if (rule->flow.dl_type == htons(ETH_TYPE_IPV6)) {
3530 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
3531 if (rule->flow.nw_proto == IPPROTO_TCP ||
3532 rule->flow.nw_proto == IPPROTO_UDP) {
3533 may_match |= MAY_TP_ADDR;
3534 } else if (rule->flow.nw_proto == IPPROTO_ICMPV6) {
3535 may_match |= MAY_TP_ADDR;
3536 if (rule->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
3537 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
3538 } else if (rule->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
3539 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
3542 } else if (rule->flow.dl_type == htons(ETH_TYPE_ARP)) {
3543 may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
3548 /* Clear the fields that may not be matched. */
3550 if (!(may_match & MAY_NW_ADDR)) {
3551 wc.nw_src_mask = wc.nw_dst_mask = htonl(0);
3553 if (!(may_match & MAY_TP_ADDR)) {
3554 wc.tp_src_mask = wc.tp_dst_mask = htons(0);
3556 if (!(may_match & MAY_NW_PROTO)) {
3557 wc.wildcards |= FWW_NW_PROTO;
3559 if (!(may_match & MAY_IPVx)) {
3560 wc.wildcards |= FWW_NW_DSCP;
3561 wc.wildcards |= FWW_NW_ECN;
3562 wc.wildcards |= FWW_NW_TTL;
3564 if (!(may_match & MAY_ARP_SHA)) {
3565 memset(wc.arp_sha_mask, 0, ETH_ADDR_LEN);
3567 if (!(may_match & MAY_ARP_THA)) {
3568 memset(wc.arp_tha_mask, 0, ETH_ADDR_LEN);
3570 if (!(may_match & MAY_IPV6)) {
3571 wc.ipv6_src_mask = wc.ipv6_dst_mask = in6addr_any;
3572 wc.ipv6_label_mask = htonl(0);
3574 if (!(may_match & MAY_ND_TARGET)) {
3575 wc.nd_target_mask = in6addr_any;
3578 /* Log any changes. */
3579 if (!flow_wildcards_equal(&wc, &rule->wc)) {
3580 bool log = may_log && !VLOG_DROP_INFO(&bad_ofmsg_rl);
3581 char *pre = log ? cls_rule_to_string(rule) : NULL;
3584 cls_rule_zero_wildcarded_fields(rule);
3587 char *post = cls_rule_to_string(rule);
3588 VLOG_INFO("normalization changed ofp_match, details:");
3589 VLOG_INFO(" pre: %s", pre);
3590 VLOG_INFO("post: %s", post);
3597 /* "Normalizes" the wildcards in 'rule'. That means:
3599 * 1. If the type of level N is known, then only the valid fields for that
3600 * level may be specified. For example, ARP does not have a TOS field,
3601 * so nw_tos must be wildcarded if 'rule' specifies an ARP flow.
3602 * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
3603 * ipv6_dst (and other fields) must be wildcarded if 'rule' specifies an
3606 * 2. If the type of level N is not known (or not understood by Open
3607 * vSwitch), then no fields at all for that level may be specified. For
3608 * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
3609 * L4 fields tp_src and tp_dst must be wildcarded if 'rule' specifies an
3612 * If this function changes 'rule', it logs a rate-limited informational
3615 ofputil_normalize_rule(struct cls_rule *rule)
3617 ofputil_normalize_rule__(rule, true);
3620 /* Same as ofputil_normalize_rule() without the logging. Thus, this function
3621 * is suitable for a program's internal use, whereas ofputil_normalize_rule()
3622 * sense for use on flows received from elsewhere (so that a bug in the program
3623 * that sent them can be reported and corrected). */
3625 ofputil_normalize_rule_quiet(struct cls_rule *rule)
3627 ofputil_normalize_rule__(rule, false);
3630 /* Parses a key or a key-value pair from '*stringp'.
3632 * On success: Stores the key into '*keyp'. Stores the value, if present, into
3633 * '*valuep', otherwise an empty string. Advances '*stringp' past the end of
3634 * the key-value pair, preparing it for another call. '*keyp' and '*valuep'
3635 * are substrings of '*stringp' created by replacing some of its bytes by null
3636 * terminators. Returns true.
3638 * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
3639 * NULL and returns false. */
3641 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
3643 char *pos, *key, *value;
3647 pos += strspn(pos, ", \t\r\n");
3649 *keyp = *valuep = NULL;
3654 key_len = strcspn(pos, ":=(, \t\r\n");
3655 if (key[key_len] == ':' || key[key_len] == '=') {
3656 /* The value can be separated by a colon. */
3659 value = key + key_len + 1;
3660 value_len = strcspn(value, ", \t\r\n");
3661 pos = value + value_len + (value[value_len] != '\0');
3662 value[value_len] = '\0';
3663 } else if (key[key_len] == '(') {
3664 /* The value can be surrounded by balanced parentheses. The outermost
3665 * set of parentheses is removed. */
3669 value = key + key_len + 1;
3670 for (value_len = 0; level > 0; value_len++) {
3671 switch (value[value_len]) {
3685 value[value_len - 1] = '\0';
3686 pos = value + value_len;
3688 /* There might be no value at all. */
3689 value = key + key_len; /* Will become the empty string below. */
3690 pos = key + key_len + (key[key_len] != '\0');
3692 key[key_len] = '\0';