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)
272 struct ofp11_match_header *omh;
273 struct ofp11_match *om;
275 if (buf->size < sizeof(struct ofp11_match_header)) {
276 return OFPERR_OFPBMC_BAD_LEN;
280 switch (ntohs(omh->type)) {
282 if (omh->length != htons(sizeof *om) || buf->size < sizeof *om) {
283 return OFPERR_OFPBMC_BAD_LEN;
285 om = ofpbuf_pull(buf, sizeof *om);
286 return ofputil_cls_rule_from_ofp11_match(om, priority, rule);
289 return OFPERR_OFPBMC_BAD_TYPE;
293 /* Converts the ofp11_match in 'match' into a cls_rule in 'rule', with the
294 * given 'priority'. Returns 0 if successful, otherwise an OFPERR_* value. */
296 ofputil_cls_rule_from_ofp11_match(const struct ofp11_match *match,
297 unsigned int priority,
298 struct cls_rule *rule)
300 uint16_t wc = ntohl(match->wildcards);
301 uint8_t dl_src_mask[ETH_ADDR_LEN];
302 uint8_t dl_dst_mask[ETH_ADDR_LEN];
306 cls_rule_init_catchall(rule, priority);
308 if (!(wc & OFPFW11_IN_PORT)) {
312 error = ofputil_port_from_ofp11(match->in_port, &ofp_port);
314 return OFPERR_OFPBMC_BAD_VALUE;
316 cls_rule_set_in_port(rule, ofp_port);
319 for (i = 0; i < ETH_ADDR_LEN; i++) {
320 dl_src_mask[i] = ~match->dl_src_mask[i];
322 cls_rule_set_dl_src_masked(rule, match->dl_src, dl_src_mask);
324 for (i = 0; i < ETH_ADDR_LEN; i++) {
325 dl_dst_mask[i] = ~match->dl_dst_mask[i];
327 cls_rule_set_dl_dst_masked(rule, match->dl_dst, dl_dst_mask);
329 if (!(wc & OFPFW11_DL_VLAN)) {
330 if (match->dl_vlan == htons(OFPVID11_NONE)) {
331 /* Match only packets without a VLAN tag. */
332 rule->flow.vlan_tci = htons(0);
333 rule->wc.vlan_tci_mask = htons(UINT16_MAX);
335 if (match->dl_vlan == htons(OFPVID11_ANY)) {
336 /* Match any packet with a VLAN tag regardless of VID. */
337 rule->flow.vlan_tci = htons(VLAN_CFI);
338 rule->wc.vlan_tci_mask = htons(VLAN_CFI);
339 } else if (ntohs(match->dl_vlan) < 4096) {
340 /* Match only packets with the specified VLAN VID. */
341 rule->flow.vlan_tci = htons(VLAN_CFI) | match->dl_vlan;
342 rule->wc.vlan_tci_mask = htons(VLAN_CFI | VLAN_VID_MASK);
345 return OFPERR_OFPBMC_BAD_VALUE;
348 if (!(wc & OFPFW11_DL_VLAN_PCP)) {
349 if (match->dl_vlan_pcp <= 7) {
350 rule->flow.vlan_tci |= htons(match->dl_vlan_pcp
352 rule->wc.vlan_tci_mask |= htons(VLAN_PCP_MASK);
355 return OFPERR_OFPBMC_BAD_VALUE;
361 if (!(wc & OFPFW11_DL_TYPE)) {
362 cls_rule_set_dl_type(rule,
363 ofputil_dl_type_from_openflow(match->dl_type));
366 ipv4 = rule->flow.dl_type == htons(ETH_TYPE_IP);
367 arp = rule->flow.dl_type == htons(ETH_TYPE_ARP);
369 if (ipv4 && !(wc & OFPFW11_NW_TOS)) {
370 if (match->nw_tos & ~IP_DSCP_MASK) {
372 return OFPERR_OFPBMC_BAD_VALUE;
375 cls_rule_set_nw_dscp(rule, match->nw_tos);
379 if (!(wc & OFPFW11_NW_PROTO)) {
380 cls_rule_set_nw_proto(rule, match->nw_proto);
382 cls_rule_set_nw_src_masked(rule, match->nw_src, ~match->nw_src_mask);
383 cls_rule_set_nw_dst_masked(rule, match->nw_dst, ~match->nw_dst_mask);
386 #define OFPFW11_TP_ALL (OFPFW11_TP_SRC | OFPFW11_TP_DST)
387 if (ipv4 && (wc & OFPFW11_TP_ALL) != OFPFW11_TP_ALL) {
388 switch (rule->flow.nw_proto) {
390 /* "A.2.3 Flow Match Structures" in OF1.1 says:
392 * The tp_src and tp_dst fields will be ignored unless the
393 * network protocol specified is as TCP, UDP or SCTP.
395 * but I'm pretty sure we should support ICMP too, otherwise
396 * that's a regression from OF1.0. */
397 if (!(wc & OFPFW11_TP_SRC)) {
398 uint16_t icmp_type = ntohs(match->tp_src);
399 if (icmp_type < 0x100) {
400 cls_rule_set_icmp_type(rule, icmp_type);
402 return OFPERR_OFPBMC_BAD_FIELD;
405 if (!(wc & OFPFW11_TP_DST)) {
406 uint16_t icmp_code = ntohs(match->tp_dst);
407 if (icmp_code < 0x100) {
408 cls_rule_set_icmp_code(rule, icmp_code);
410 return OFPERR_OFPBMC_BAD_FIELD;
417 if (!(wc & (OFPFW11_TP_SRC))) {
418 cls_rule_set_tp_src(rule, match->tp_src);
420 if (!(wc & (OFPFW11_TP_DST))) {
421 cls_rule_set_tp_dst(rule, match->tp_dst);
426 /* We don't support SCTP and it seems that we should tell the
427 * controller, since OF1.1 implementations are supposed to. */
428 return OFPERR_OFPBMC_BAD_FIELD;
431 /* OF1.1 says explicitly to ignore this. */
436 if (rule->flow.dl_type == htons(ETH_TYPE_MPLS) ||
437 rule->flow.dl_type == htons(ETH_TYPE_MPLS_MCAST)) {
438 enum { OFPFW11_MPLS_ALL = OFPFW11_MPLS_LABEL | OFPFW11_MPLS_TC };
440 if ((wc & OFPFW11_MPLS_ALL) != OFPFW11_MPLS_ALL) {
441 /* MPLS not supported. */
442 return OFPERR_OFPBMC_BAD_TAG;
446 if (match->metadata_mask != htonll(UINT64_MAX)) {
447 cls_rule_set_metadata_masked(rule, match->metadata,
448 ~match->metadata_mask);
454 /* Convert 'rule' into the OpenFlow 1.1 match structure 'match'. */
456 ofputil_cls_rule_to_ofp11_match(const struct cls_rule *rule,
457 struct ofp11_match *match)
462 memset(match, 0, sizeof *match);
463 match->omh.type = htons(OFPMT_STANDARD);
464 match->omh.length = htons(OFPMT11_STANDARD_LENGTH);
466 if (rule->wc.wildcards & FWW_IN_PORT) {
467 wc |= OFPFW11_IN_PORT;
469 match->in_port = ofputil_port_to_ofp11(rule->flow.in_port);
472 memcpy(match->dl_src, rule->flow.dl_src, ETH_ADDR_LEN);
473 for (i = 0; i < ETH_ADDR_LEN; i++) {
474 match->dl_src_mask[i] = ~rule->wc.dl_src_mask[i];
477 memcpy(match->dl_dst, rule->flow.dl_dst, ETH_ADDR_LEN);
478 for (i = 0; i < ETH_ADDR_LEN; i++) {
479 match->dl_dst_mask[i] = ~rule->wc.dl_dst_mask[i];
482 if (rule->wc.vlan_tci_mask == htons(0)) {
483 wc |= OFPFW11_DL_VLAN | OFPFW11_DL_VLAN_PCP;
484 } else if (rule->wc.vlan_tci_mask & htons(VLAN_CFI)
485 && !(rule->flow.vlan_tci & htons(VLAN_CFI))) {
486 match->dl_vlan = htons(OFPVID11_NONE);
487 wc |= OFPFW11_DL_VLAN_PCP;
489 if (!(rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) {
490 match->dl_vlan = htons(OFPVID11_ANY);
492 match->dl_vlan = htons(vlan_tci_to_vid(rule->flow.vlan_tci));
495 if (!(rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK))) {
496 wc |= OFPFW11_DL_VLAN_PCP;
498 match->dl_vlan_pcp = vlan_tci_to_pcp(rule->flow.vlan_tci);
502 if (rule->wc.wildcards & FWW_DL_TYPE) {
503 wc |= OFPFW11_DL_TYPE;
505 match->dl_type = ofputil_dl_type_to_openflow(rule->flow.dl_type);
508 if (rule->wc.wildcards & FWW_NW_DSCP) {
509 wc |= OFPFW11_NW_TOS;
511 match->nw_tos = rule->flow.nw_tos & IP_DSCP_MASK;
514 if (rule->wc.wildcards & FWW_NW_PROTO) {
515 wc |= OFPFW11_NW_PROTO;
517 match->nw_proto = rule->flow.nw_proto;
520 match->nw_src = rule->flow.nw_src;
521 match->nw_src_mask = ~rule->wc.nw_src_mask;
522 match->nw_dst = rule->flow.nw_dst;
523 match->nw_dst_mask = ~rule->wc.nw_dst_mask;
525 if (!rule->wc.tp_src_mask) {
526 wc |= OFPFW11_TP_SRC;
528 match->tp_src = rule->flow.tp_src;
531 if (!rule->wc.tp_dst_mask) {
532 wc |= OFPFW11_TP_DST;
534 match->tp_dst = rule->flow.tp_dst;
537 /* MPLS not supported. */
538 wc |= OFPFW11_MPLS_LABEL;
539 wc |= OFPFW11_MPLS_TC;
541 match->metadata = rule->flow.metadata;
542 match->metadata_mask = ~rule->wc.metadata_mask;
544 match->wildcards = htonl(wc);
547 /* Given a 'dl_type' value in the format used in struct flow, returns the
548 * corresponding 'dl_type' value for use in an ofp10_match or ofp11_match
551 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type)
553 return (flow_dl_type == htons(FLOW_DL_TYPE_NONE)
554 ? htons(OFP_DL_TYPE_NOT_ETH_TYPE)
558 /* Given a 'dl_type' value in the format used in an ofp10_match or ofp11_match
559 * structure, returns the corresponding 'dl_type' value for use in struct
562 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type)
564 return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
565 ? htons(FLOW_DL_TYPE_NONE)
571 struct proto_abbrev {
572 enum ofputil_protocol protocol;
576 /* Most users really don't care about some of the differences between
577 * protocols. These abbreviations help with that. */
578 static const struct proto_abbrev proto_abbrevs[] = {
579 { OFPUTIL_P_ANY, "any" },
580 { OFPUTIL_P_OF10_ANY, "OpenFlow10" },
581 { OFPUTIL_P_NXM_ANY, "NXM" },
583 #define N_PROTO_ABBREVS ARRAY_SIZE(proto_abbrevs)
585 enum ofputil_protocol ofputil_flow_dump_protocols[] = {
589 size_t ofputil_n_flow_dump_protocols = ARRAY_SIZE(ofputil_flow_dump_protocols);
591 /* Returns the ofputil_protocol that is initially in effect on an OpenFlow
592 * connection that has negotiated the given 'version'. 'version' should
593 * normally be an 8-bit OpenFlow version identifier (e.g. 0x01 for OpenFlow
594 * 1.0, 0x02 for OpenFlow 1.1). Returns 0 if 'version' is not supported or
595 * outside the valid range. */
596 enum ofputil_protocol
597 ofputil_protocol_from_ofp_version(enum ofp_version version)
601 return OFPUTIL_P_OF10;
603 return OFPUTIL_P_OF12;
610 /* Returns the OpenFlow protocol version number (e.g. OFP10_VERSION,
611 * OFP11_VERSION or OFP12_VERSION) that corresponds to 'protocol'. */
613 ofputil_protocol_to_ofp_version(enum ofputil_protocol protocol)
617 case OFPUTIL_P_OF10_TID:
619 case OFPUTIL_P_NXM_TID:
620 return OFP10_VERSION;
622 return OFP12_VERSION;
628 /* Returns true if 'protocol' is a single OFPUTIL_P_* value, false
631 ofputil_protocol_is_valid(enum ofputil_protocol protocol)
633 return protocol & OFPUTIL_P_ANY && is_pow2(protocol);
636 /* Returns the equivalent of 'protocol' with the Nicira flow_mod_table_id
637 * extension turned on or off if 'enable' is true or false, respectively.
639 * This extension is only useful for protocols whose "standard" version does
640 * not allow specific tables to be modified. In particular, this is true of
641 * OpenFlow 1.0. In later versions of OpenFlow, a flow_mod request always
642 * specifies a table ID and so there is no need for such an extension. When
643 * 'protocol' is such a protocol that doesn't need a flow_mod_table_id
644 * extension, this function just returns its 'protocol' argument unchanged
645 * regardless of the value of 'enable'. */
646 enum ofputil_protocol
647 ofputil_protocol_set_tid(enum ofputil_protocol protocol, bool enable)
651 case OFPUTIL_P_OF10_TID:
652 return enable ? OFPUTIL_P_OF10_TID : OFPUTIL_P_OF10;
655 case OFPUTIL_P_NXM_TID:
656 return enable ? OFPUTIL_P_NXM_TID : OFPUTIL_P_NXM;
659 return OFPUTIL_P_OF12;
666 /* Returns the "base" version of 'protocol'. That is, if 'protocol' includes
667 * some extension to a standard protocol version, the return value is the
668 * standard version of that protocol without any extension. If 'protocol' is a
669 * standard protocol version, returns 'protocol' unchanged. */
670 enum ofputil_protocol
671 ofputil_protocol_to_base(enum ofputil_protocol protocol)
673 return ofputil_protocol_set_tid(protocol, false);
676 /* Returns 'new_base' with any extensions taken from 'cur'. */
677 enum ofputil_protocol
678 ofputil_protocol_set_base(enum ofputil_protocol cur,
679 enum ofputil_protocol new_base)
681 bool tid = (cur & OFPUTIL_P_TID) != 0;
685 case OFPUTIL_P_OF10_TID:
686 return ofputil_protocol_set_tid(OFPUTIL_P_OF10, tid);
689 case OFPUTIL_P_NXM_TID:
690 return ofputil_protocol_set_tid(OFPUTIL_P_NXM, tid);
693 return ofputil_protocol_set_tid(OFPUTIL_P_OF12, tid);
700 /* Returns a string form of 'protocol', if a simple form exists (that is, if
701 * 'protocol' is either a single protocol or it is a combination of protocols
702 * that have a single abbreviation). Otherwise, returns NULL. */
704 ofputil_protocol_to_string(enum ofputil_protocol protocol)
706 const struct proto_abbrev *p;
708 /* Use a "switch" statement for single-bit names so that we get a compiler
709 * warning if we forget any. */
712 return "NXM-table_id";
714 case OFPUTIL_P_NXM_TID:
715 return "NXM+table_id";
718 return "OpenFlow10-table_id";
720 case OFPUTIL_P_OF10_TID:
721 return "OpenFlow10+table_id";
727 /* Check abbreviations. */
728 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
729 if (protocol == p->protocol) {
737 /* Returns a string that represents 'protocols'. The return value might be a
738 * comma-separated list if 'protocols' doesn't have a simple name. The return
739 * value is "none" if 'protocols' is 0.
741 * The caller must free the returned string (with free()). */
743 ofputil_protocols_to_string(enum ofputil_protocol protocols)
747 assert(!(protocols & ~OFPUTIL_P_ANY));
748 if (protocols == 0) {
749 return xstrdup("none");
754 const struct proto_abbrev *p;
758 ds_put_char(&s, ',');
761 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
762 if ((protocols & p->protocol) == p->protocol) {
763 ds_put_cstr(&s, p->name);
764 protocols &= ~p->protocol;
769 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
770 enum ofputil_protocol bit = 1u << i;
772 if (protocols & bit) {
773 ds_put_cstr(&s, ofputil_protocol_to_string(bit));
782 return ds_steal_cstr(&s);
785 static enum ofputil_protocol
786 ofputil_protocol_from_string__(const char *s, size_t n)
788 const struct proto_abbrev *p;
791 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
792 enum ofputil_protocol bit = 1u << i;
793 const char *name = ofputil_protocol_to_string(bit);
795 if (name && n == strlen(name) && !strncasecmp(s, name, n)) {
800 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
801 if (n == strlen(p->name) && !strncasecmp(s, p->name, n)) {
809 /* Returns the nonempty set of protocols represented by 's', which can be a
810 * single protocol name or abbreviation or a comma-separated list of them.
812 * Aborts the program with an error message if 's' is invalid. */
813 enum ofputil_protocol
814 ofputil_protocols_from_string(const char *s)
816 const char *orig_s = s;
817 enum ofputil_protocol protocols;
821 enum ofputil_protocol p;
830 p = ofputil_protocol_from_string__(s, n);
832 ovs_fatal(0, "%.*s: unknown flow protocol", (int) n, s);
840 ovs_fatal(0, "%s: no flow protocol specified", orig_s);
846 ofputil_packet_in_format_is_valid(enum nx_packet_in_format packet_in_format)
848 switch (packet_in_format) {
849 case NXPIF_OPENFLOW10:
858 ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format)
860 switch (packet_in_format) {
861 case NXPIF_OPENFLOW10:
871 ofputil_packet_in_format_from_string(const char *s)
873 return (!strcmp(s, "openflow10") ? NXPIF_OPENFLOW10
874 : !strcmp(s, "nxm") ? NXPIF_NXM
879 regs_fully_wildcarded(const struct flow_wildcards *wc)
883 for (i = 0; i < FLOW_N_REGS; i++) {
884 if (wc->reg_masks[i] != 0) {
891 /* Returns a bit-mask of ofputil_protocols that can be used for sending 'rule'
892 * to a switch (e.g. to add or remove a flow). Only NXM can handle tunnel IDs,
893 * registers, or fixing the Ethernet multicast bit. Otherwise, it's better to
894 * use OpenFlow 1.0 protocol for backward compatibility. */
895 enum ofputil_protocol
896 ofputil_usable_protocols(const struct cls_rule *rule)
898 const struct flow_wildcards *wc = &rule->wc;
900 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 14);
902 /* NXM and OF1.1+ supports bitwise matching on ethernet addresses. */
903 if (!eth_mask_is_exact(wc->dl_src_mask)
904 && !eth_addr_is_zero(wc->dl_src_mask)) {
905 return OFPUTIL_P_NXM_ANY;
907 if (!eth_mask_is_exact(wc->dl_dst_mask)
908 && !eth_addr_is_zero(wc->dl_dst_mask)) {
909 return OFPUTIL_P_NXM_ANY;
912 /* NXM and OF1.1+ support matching metadata. */
913 if (wc->metadata_mask != htonll(0)) {
914 return OFPUTIL_P_NXM_ANY;
917 /* Only NXM supports matching ARP hardware addresses. */
918 if (!eth_addr_is_zero(wc->arp_sha_mask) ||
919 !eth_addr_is_zero(wc->arp_tha_mask)) {
920 return OFPUTIL_P_NXM_ANY;
923 /* Only NXM supports matching IPv6 traffic. */
924 if (!(wc->wildcards & FWW_DL_TYPE)
925 && (rule->flow.dl_type == htons(ETH_TYPE_IPV6))) {
926 return OFPUTIL_P_NXM_ANY;
929 /* Only NXM supports matching registers. */
930 if (!regs_fully_wildcarded(wc)) {
931 return OFPUTIL_P_NXM_ANY;
934 /* Only NXM supports matching tun_id. */
935 if (wc->tun_id_mask != htonll(0)) {
936 return OFPUTIL_P_NXM_ANY;
939 /* Only NXM supports matching fragments. */
940 if (wc->nw_frag_mask) {
941 return OFPUTIL_P_NXM_ANY;
944 /* Only NXM supports matching IPv6 flow label. */
945 if (wc->ipv6_label_mask) {
946 return OFPUTIL_P_NXM_ANY;
949 /* Only NXM supports matching IP ECN bits. */
950 if (!(wc->wildcards & FWW_NW_ECN)) {
951 return OFPUTIL_P_NXM_ANY;
954 /* Only NXM supports matching IP TTL/hop limit. */
955 if (!(wc->wildcards & FWW_NW_TTL)) {
956 return OFPUTIL_P_NXM_ANY;
959 /* Only NXM supports non-CIDR IPv4 address masks. */
960 if (!ip_is_cidr(wc->nw_src_mask) || !ip_is_cidr(wc->nw_dst_mask)) {
961 return OFPUTIL_P_NXM_ANY;
964 /* Only NXM supports bitwise matching on transport port. */
965 if ((wc->tp_src_mask && wc->tp_src_mask != htons(UINT16_MAX)) ||
966 (wc->tp_dst_mask && wc->tp_dst_mask != htons(UINT16_MAX))) {
967 return OFPUTIL_P_NXM_ANY;
970 /* Other formats can express this rule. */
971 return OFPUTIL_P_ANY;
974 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
975 * protocol is 'current', at least partly transitions the protocol to 'want'.
976 * Stores in '*next' the protocol that will be in effect on the OpenFlow
977 * connection if the switch processes the returned message correctly. (If
978 * '*next != want' then the caller will have to iterate.)
980 * If 'current == want', returns NULL and stores 'current' in '*next'. */
982 ofputil_encode_set_protocol(enum ofputil_protocol current,
983 enum ofputil_protocol want,
984 enum ofputil_protocol *next)
986 enum ofputil_protocol cur_base, want_base;
987 bool cur_tid, want_tid;
989 cur_base = ofputil_protocol_to_base(current);
990 want_base = ofputil_protocol_to_base(want);
991 if (cur_base != want_base) {
992 *next = ofputil_protocol_set_base(current, want_base);
996 return ofputil_encode_nx_set_flow_format(NXFF_NXM);
999 return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10);
1001 case OFPUTIL_P_OF12:
1002 return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW12);
1004 case OFPUTIL_P_OF10_TID:
1005 case OFPUTIL_P_NXM_TID:
1010 cur_tid = (current & OFPUTIL_P_TID) != 0;
1011 want_tid = (want & OFPUTIL_P_TID) != 0;
1012 if (cur_tid != want_tid) {
1013 *next = ofputil_protocol_set_tid(current, want_tid);
1014 return ofputil_make_flow_mod_table_id(want_tid);
1017 assert(current == want);
1023 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1024 * format to 'nxff'. */
1026 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff)
1028 struct nx_set_flow_format *sff;
1031 assert(ofputil_nx_flow_format_is_valid(nxff));
1033 msg = ofpraw_alloc(OFPRAW_NXT_SET_FLOW_FORMAT, OFP10_VERSION, 0);
1034 sff = ofpbuf_put_zeros(msg, sizeof *sff);
1035 sff->format = htonl(nxff);
1040 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1042 enum ofputil_protocol
1043 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format)
1045 switch (flow_format) {
1046 case NXFF_OPENFLOW10:
1047 return OFPUTIL_P_OF10;
1050 return OFPUTIL_P_NXM;
1052 case NXFF_OPENFLOW12:
1053 return OFPUTIL_P_OF12;
1060 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1062 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format)
1064 return ofputil_nx_flow_format_to_protocol(flow_format) != 0;
1067 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1070 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format)
1072 switch (flow_format) {
1073 case NXFF_OPENFLOW10:
1074 return "openflow10";
1077 case NXFF_OPENFLOW12:
1078 return "openflow12";
1085 ofputil_make_set_packet_in_format(enum nx_packet_in_format packet_in_format)
1087 struct nx_set_packet_in_format *spif;
1090 msg = ofpraw_alloc(OFPRAW_NXT_SET_PACKET_IN_FORMAT, OFP10_VERSION, 0);
1091 spif = ofpbuf_put_zeros(msg, sizeof *spif);
1092 spif->format = htonl(packet_in_format);
1097 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1098 * extension on or off (according to 'flow_mod_table_id'). */
1100 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
1102 struct nx_flow_mod_table_id *nfmti;
1105 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION, 0);
1106 nfmti = ofpbuf_put_zeros(msg, sizeof *nfmti);
1107 nfmti->set = flow_mod_table_id;
1111 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1112 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
1115 * Uses 'ofpacts' to store the abstract OFPACT_* version of 'oh''s actions.
1116 * The caller must initialize 'ofpacts' and retains ownership of it.
1117 * 'fm->ofpacts' will point into the 'ofpacts' buffer.
1119 * Does not validate the flow_mod actions. The caller should do that, with
1120 * ofpacts_check(). */
1122 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
1123 const struct ofp_header *oh,
1124 enum ofputil_protocol protocol,
1125 struct ofpbuf *ofpacts)
1131 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1132 raw = ofpraw_pull_assert(&b);
1133 if (raw == OFPRAW_OFPT11_FLOW_MOD) {
1134 /* Standard OpenFlow 1.1 flow_mod. */
1135 const struct ofp11_flow_mod *ofm;
1138 ofm = ofpbuf_pull(&b, sizeof *ofm);
1140 error = ofputil_pull_ofp11_match(&b, ntohs(ofm->priority), &fm->cr);
1145 error = ofpacts_pull_openflow11_instructions(&b, b.size, ofpacts);
1150 /* Translate the message. */
1151 if (ofm->command == OFPFC_ADD) {
1152 fm->cookie = htonll(0);
1153 fm->cookie_mask = htonll(0);
1154 fm->new_cookie = ofm->cookie;
1157 fm->cookie = ofm->cookie;
1158 fm->cookie_mask = ofm->cookie_mask;
1159 fm->new_cookie = htonll(UINT64_MAX);
1161 fm->command = ofm->command;
1162 fm->table_id = ofm->table_id;
1163 fm->idle_timeout = ntohs(ofm->idle_timeout);
1164 fm->hard_timeout = ntohs(ofm->hard_timeout);
1165 fm->buffer_id = ntohl(ofm->buffer_id);
1166 error = ofputil_port_from_ofp11(ofm->out_port, &fm->out_port);
1170 if (ofm->out_group != htonl(OFPG_ANY)) {
1171 return OFPERR_NXFMFC_GROUPS_NOT_SUPPORTED;
1173 fm->flags = ntohs(ofm->flags);
1175 if (raw == OFPRAW_OFPT10_FLOW_MOD) {
1176 /* Standard OpenFlow 1.0 flow_mod. */
1177 const struct ofp10_flow_mod *ofm;
1181 /* Get the ofp10_flow_mod. */
1182 ofm = ofpbuf_pull(&b, sizeof *ofm);
1184 /* Set priority based on original wildcards. Normally we'd allow
1185 * ofputil_cls_rule_from_match() to do this for us, but
1186 * ofputil_normalize_rule() can put wildcards where the original
1187 * flow didn't have them. */
1188 priority = ntohs(ofm->priority);
1189 if (!(ofm->match.wildcards & htonl(OFPFW10_ALL))) {
1190 priority = UINT16_MAX;
1193 /* Translate the rule. */
1194 ofputil_cls_rule_from_ofp10_match(&ofm->match, priority, &fm->cr);
1195 ofputil_normalize_rule(&fm->cr);
1197 /* Now get the actions. */
1198 error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1203 /* Translate the message. */
1204 command = ntohs(ofm->command);
1205 fm->cookie = htonll(0);
1206 fm->cookie_mask = htonll(0);
1207 fm->new_cookie = ofm->cookie;
1208 fm->idle_timeout = ntohs(ofm->idle_timeout);
1209 fm->hard_timeout = ntohs(ofm->hard_timeout);
1210 fm->buffer_id = ntohl(ofm->buffer_id);
1211 fm->out_port = ntohs(ofm->out_port);
1212 fm->flags = ntohs(ofm->flags);
1213 } else if (raw == OFPRAW_NXT_FLOW_MOD) {
1214 /* Nicira extended flow_mod. */
1215 const struct nx_flow_mod *nfm;
1218 /* Dissect the message. */
1219 nfm = ofpbuf_pull(&b, sizeof *nfm);
1220 error = nx_pull_match(&b, ntohs(nfm->match_len), ntohs(nfm->priority),
1221 &fm->cr, &fm->cookie, &fm->cookie_mask);
1225 error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1230 /* Translate the message. */
1231 command = ntohs(nfm->command);
1232 if ((command & 0xff) == OFPFC_ADD && fm->cookie_mask) {
1233 /* Flow additions may only set a new cookie, not match an
1234 * existing cookie. */
1235 return OFPERR_NXBRC_NXM_INVALID;
1237 fm->new_cookie = nfm->cookie;
1238 fm->idle_timeout = ntohs(nfm->idle_timeout);
1239 fm->hard_timeout = ntohs(nfm->hard_timeout);
1240 fm->buffer_id = ntohl(nfm->buffer_id);
1241 fm->out_port = ntohs(nfm->out_port);
1242 fm->flags = ntohs(nfm->flags);
1247 if (protocol & OFPUTIL_P_TID) {
1248 fm->command = command & 0xff;
1249 fm->table_id = command >> 8;
1251 fm->command = command;
1252 fm->table_id = 0xff;
1256 fm->ofpacts = ofpacts->data;
1257 fm->ofpacts_len = ofpacts->size;
1262 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
1263 * 'protocol' and returns the message. */
1265 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
1266 enum ofputil_protocol protocol)
1271 command = (protocol & OFPUTIL_P_TID
1272 ? (fm->command & 0xff) | (fm->table_id << 8)
1276 case OFPUTIL_P_OF10:
1277 case OFPUTIL_P_OF10_TID: {
1278 struct ofp10_flow_mod *ofm;
1280 msg = ofpraw_alloc(OFPRAW_OFPT10_FLOW_MOD, OFP10_VERSION,
1282 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
1283 ofputil_cls_rule_to_ofp10_match(&fm->cr, &ofm->match);
1284 ofm->cookie = fm->new_cookie;
1285 ofm->command = htons(command);
1286 ofm->idle_timeout = htons(fm->idle_timeout);
1287 ofm->hard_timeout = htons(fm->hard_timeout);
1288 ofm->priority = htons(fm->cr.priority);
1289 ofm->buffer_id = htonl(fm->buffer_id);
1290 ofm->out_port = htons(fm->out_port);
1291 ofm->flags = htons(fm->flags);
1296 case OFPUTIL_P_NXM_TID: {
1297 struct nx_flow_mod *nfm;
1300 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD, OFP10_VERSION,
1301 NXM_TYPICAL_LEN + fm->ofpacts_len);
1302 nfm = ofpbuf_put_zeros(msg, sizeof *nfm);
1303 nfm->command = htons(command);
1304 nfm->cookie = fm->new_cookie;
1305 match_len = nx_put_match(msg, false, &fm->cr,
1306 fm->cookie, fm->cookie_mask);
1308 nfm->idle_timeout = htons(fm->idle_timeout);
1309 nfm->hard_timeout = htons(fm->hard_timeout);
1310 nfm->priority = htons(fm->cr.priority);
1311 nfm->buffer_id = htonl(fm->buffer_id);
1312 nfm->out_port = htons(fm->out_port);
1313 nfm->flags = htons(fm->flags);
1314 nfm->match_len = htons(match_len);
1318 case OFPUTIL_P_OF12:
1324 ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
1326 ofpmsg_update_length(msg);
1330 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1331 * send all of the 'n_fm's flow table modification requests in 'fms', and a
1332 * 0-bit for each protocol that is inadequate.
1334 * (The return value will have at least one 1-bit.) */
1335 enum ofputil_protocol
1336 ofputil_flow_mod_usable_protocols(const struct ofputil_flow_mod *fms,
1339 enum ofputil_protocol usable_protocols;
1342 usable_protocols = OFPUTIL_P_ANY;
1343 for (i = 0; i < n_fms; i++) {
1344 const struct ofputil_flow_mod *fm = &fms[i];
1346 usable_protocols &= ofputil_usable_protocols(&fm->cr);
1347 if (fm->table_id != 0xff) {
1348 usable_protocols &= OFPUTIL_P_TID;
1351 /* Matching of the cookie is only supported through NXM. */
1352 if (fm->cookie_mask != htonll(0)) {
1353 usable_protocols &= OFPUTIL_P_NXM_ANY;
1356 assert(usable_protocols);
1358 return usable_protocols;
1362 ofputil_decode_ofpst_flow_request(struct ofputil_flow_stats_request *fsr,
1363 const struct ofp10_flow_stats_request *ofsr,
1366 fsr->aggregate = aggregate;
1367 ofputil_cls_rule_from_ofp10_match(&ofsr->match, 0, &fsr->match);
1368 fsr->out_port = ntohs(ofsr->out_port);
1369 fsr->table_id = ofsr->table_id;
1370 fsr->cookie = fsr->cookie_mask = htonll(0);
1376 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
1377 struct ofpbuf *b, bool aggregate)
1379 const struct nx_flow_stats_request *nfsr;
1382 nfsr = ofpbuf_pull(b, sizeof *nfsr);
1383 error = nx_pull_match(b, ntohs(nfsr->match_len), 0, &fsr->match,
1384 &fsr->cookie, &fsr->cookie_mask);
1389 return OFPERR_OFPBRC_BAD_LEN;
1392 fsr->aggregate = aggregate;
1393 fsr->out_port = ntohs(nfsr->out_port);
1394 fsr->table_id = nfsr->table_id;
1399 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
1400 * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
1401 * successful, otherwise an OpenFlow error code. */
1403 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
1404 const struct ofp_header *oh)
1409 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1410 raw = ofpraw_pull_assert(&b);
1411 switch ((int) raw) {
1412 case OFPRAW_OFPST_FLOW_REQUEST:
1413 return ofputil_decode_ofpst_flow_request(fsr, b.data, false);
1415 case OFPRAW_OFPST_AGGREGATE_REQUEST:
1416 return ofputil_decode_ofpst_flow_request(fsr, b.data, true);
1418 case OFPRAW_NXST_FLOW_REQUEST:
1419 return ofputil_decode_nxst_flow_request(fsr, &b, false);
1421 case OFPRAW_NXST_AGGREGATE_REQUEST:
1422 return ofputil_decode_nxst_flow_request(fsr, &b, true);
1425 /* Hey, the caller lied. */
1430 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
1431 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
1432 * 'protocol', and returns the message. */
1434 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
1435 enum ofputil_protocol protocol)
1441 case OFPUTIL_P_OF10:
1442 case OFPUTIL_P_OF10_TID: {
1443 struct ofp10_flow_stats_request *ofsr;
1445 raw = (fsr->aggregate
1446 ? OFPRAW_OFPST_AGGREGATE_REQUEST
1447 : OFPRAW_OFPST_FLOW_REQUEST);
1448 msg = ofpraw_alloc(raw, OFP10_VERSION, 0);
1449 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
1450 ofputil_cls_rule_to_ofp10_match(&fsr->match, &ofsr->match);
1451 ofsr->table_id = fsr->table_id;
1452 ofsr->out_port = htons(fsr->out_port);
1457 case OFPUTIL_P_NXM_TID: {
1458 struct nx_flow_stats_request *nfsr;
1461 raw = (fsr->aggregate
1462 ? OFPRAW_NXST_AGGREGATE_REQUEST
1463 : OFPRAW_NXST_FLOW_REQUEST);
1464 msg = ofpraw_alloc(raw, OFP10_VERSION, 0);
1465 ofpbuf_put_zeros(msg, sizeof *nfsr);
1466 match_len = nx_put_match(msg, false, &fsr->match,
1467 fsr->cookie, fsr->cookie_mask);
1470 nfsr->out_port = htons(fsr->out_port);
1471 nfsr->match_len = htons(match_len);
1472 nfsr->table_id = fsr->table_id;
1476 case OFPUTIL_P_OF12:
1484 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1485 * accurately encode 'fsr', and a 0-bit for each protocol that is inadequate.
1487 * (The return value will have at least one 1-bit.) */
1488 enum ofputil_protocol
1489 ofputil_flow_stats_request_usable_protocols(
1490 const struct ofputil_flow_stats_request *fsr)
1492 enum ofputil_protocol usable_protocols;
1494 usable_protocols = ofputil_usable_protocols(&fsr->match);
1495 if (fsr->cookie_mask != htonll(0)) {
1496 usable_protocols &= OFPUTIL_P_NXM_ANY;
1498 return usable_protocols;
1501 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
1502 * ofputil_flow_stats in 'fs'.
1504 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
1505 * OpenFlow message. Calling this function multiple times for a single 'msg'
1506 * iterates through the replies. The caller must initially leave 'msg''s layer
1507 * pointers null and not modify them between calls.
1509 * Most switches don't send the values needed to populate fs->idle_age and
1510 * fs->hard_age, so those members will usually be set to 0. If the switch from
1511 * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
1512 * 'flow_age_extension' as true so that the contents of 'msg' determine the
1513 * 'idle_age' and 'hard_age' members in 'fs'.
1515 * Uses 'ofpacts' to store the abstract OFPACT_* version of the flow stats
1516 * reply's actions. The caller must initialize 'ofpacts' and retains ownership
1517 * of it. 'fs->ofpacts' will point into the 'ofpacts' buffer.
1519 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1520 * otherwise a positive errno value. */
1522 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
1524 bool flow_age_extension,
1525 struct ofpbuf *ofpacts)
1531 ? ofpraw_decode(&raw, msg->l2)
1532 : ofpraw_pull(&raw, msg));
1539 } else if (raw == OFPRAW_OFPST_FLOW_REPLY) {
1540 const struct ofp10_flow_stats *ofs;
1543 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
1545 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
1546 "bytes at end", msg->size);
1550 length = ntohs(ofs->length);
1551 if (length < sizeof *ofs) {
1552 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
1553 "length %zu", length);
1557 if (ofpacts_pull_openflow10(msg, length - sizeof *ofs, ofpacts)) {
1561 fs->cookie = get_32aligned_be64(&ofs->cookie);
1562 ofputil_cls_rule_from_ofp10_match(&ofs->match, ntohs(ofs->priority),
1564 fs->table_id = ofs->table_id;
1565 fs->duration_sec = ntohl(ofs->duration_sec);
1566 fs->duration_nsec = ntohl(ofs->duration_nsec);
1567 fs->idle_timeout = ntohs(ofs->idle_timeout);
1568 fs->hard_timeout = ntohs(ofs->hard_timeout);
1571 fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
1572 fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
1573 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
1574 const struct nx_flow_stats *nfs;
1575 size_t match_len, actions_len, length;
1577 nfs = ofpbuf_try_pull(msg, sizeof *nfs);
1579 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
1580 "bytes at end", msg->size);
1584 length = ntohs(nfs->length);
1585 match_len = ntohs(nfs->match_len);
1586 if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
1587 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
1588 "claims invalid length %zu", match_len, length);
1591 if (nx_pull_match(msg, match_len, ntohs(nfs->priority), &fs->rule,
1596 actions_len = length - sizeof *nfs - ROUND_UP(match_len, 8);
1597 if (ofpacts_pull_openflow10(msg, actions_len, ofpacts)) {
1601 fs->cookie = nfs->cookie;
1602 fs->table_id = nfs->table_id;
1603 fs->duration_sec = ntohl(nfs->duration_sec);
1604 fs->duration_nsec = ntohl(nfs->duration_nsec);
1605 fs->idle_timeout = ntohs(nfs->idle_timeout);
1606 fs->hard_timeout = ntohs(nfs->hard_timeout);
1609 if (flow_age_extension) {
1610 if (nfs->idle_age) {
1611 fs->idle_age = ntohs(nfs->idle_age) - 1;
1613 if (nfs->hard_age) {
1614 fs->hard_age = ntohs(nfs->hard_age) - 1;
1617 fs->packet_count = ntohll(nfs->packet_count);
1618 fs->byte_count = ntohll(nfs->byte_count);
1623 fs->ofpacts = ofpacts->data;
1624 fs->ofpacts_len = ofpacts->size;
1629 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
1631 * We use this in situations where OVS internally uses UINT64_MAX to mean
1632 * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
1634 unknown_to_zero(uint64_t count)
1636 return count != UINT64_MAX ? count : 0;
1639 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
1640 * those already present in the list of ofpbufs in 'replies'. 'replies' should
1641 * have been initialized with ofputil_start_stats_reply(). */
1643 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
1644 struct list *replies)
1646 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
1647 size_t start_ofs = reply->size;
1650 ofpraw_decode_partial(&raw, reply->data, reply->size);
1651 if (raw == OFPRAW_OFPST_FLOW_REPLY) {
1652 struct ofp10_flow_stats *ofs;
1654 ofpbuf_put_uninit(reply, sizeof *ofs);
1655 ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
1657 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
1658 ofs->length = htons(reply->size - start_ofs);
1659 ofs->table_id = fs->table_id;
1661 ofputil_cls_rule_to_ofp10_match(&fs->rule, &ofs->match);
1662 ofs->duration_sec = htonl(fs->duration_sec);
1663 ofs->duration_nsec = htonl(fs->duration_nsec);
1664 ofs->priority = htons(fs->rule.priority);
1665 ofs->idle_timeout = htons(fs->idle_timeout);
1666 ofs->hard_timeout = htons(fs->hard_timeout);
1667 memset(ofs->pad2, 0, sizeof ofs->pad2);
1668 put_32aligned_be64(&ofs->cookie, fs->cookie);
1669 put_32aligned_be64(&ofs->packet_count,
1670 htonll(unknown_to_zero(fs->packet_count)));
1671 put_32aligned_be64(&ofs->byte_count,
1672 htonll(unknown_to_zero(fs->byte_count)));
1673 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
1674 struct nx_flow_stats *nfs;
1677 ofpbuf_put_uninit(reply, sizeof *nfs);
1678 match_len = nx_put_match(reply, false, &fs->rule, 0, 0);
1679 ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
1681 nfs = ofpbuf_at_assert(reply, start_ofs, sizeof *nfs);
1682 nfs->length = htons(reply->size - start_ofs);
1683 nfs->table_id = fs->table_id;
1685 nfs->duration_sec = htonl(fs->duration_sec);
1686 nfs->duration_nsec = htonl(fs->duration_nsec);
1687 nfs->priority = htons(fs->rule.priority);
1688 nfs->idle_timeout = htons(fs->idle_timeout);
1689 nfs->hard_timeout = htons(fs->hard_timeout);
1690 nfs->idle_age = htons(fs->idle_age < 0 ? 0
1691 : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
1693 nfs->hard_age = htons(fs->hard_age < 0 ? 0
1694 : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
1696 nfs->match_len = htons(match_len);
1697 nfs->cookie = fs->cookie;
1698 nfs->packet_count = htonll(fs->packet_count);
1699 nfs->byte_count = htonll(fs->byte_count);
1704 ofpmp_postappend(replies, start_ofs);
1707 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
1708 * NXST_AGGREGATE reply matching 'request', and returns the message. */
1710 ofputil_encode_aggregate_stats_reply(
1711 const struct ofputil_aggregate_stats *stats,
1712 const struct ofp_header *request)
1714 struct ofp_aggregate_stats_reply *asr;
1715 uint64_t packet_count;
1716 uint64_t byte_count;
1720 ofpraw_decode(&raw, request);
1721 if (raw == OFPRAW_OFPST_AGGREGATE_REQUEST) {
1722 packet_count = unknown_to_zero(stats->packet_count);
1723 byte_count = unknown_to_zero(stats->byte_count);
1725 packet_count = stats->packet_count;
1726 byte_count = stats->byte_count;
1729 msg = ofpraw_alloc_stats_reply(request, 0);
1730 asr = ofpbuf_put_zeros(msg, sizeof *asr);
1731 put_32aligned_be64(&asr->packet_count, htonll(packet_count));
1732 put_32aligned_be64(&asr->byte_count, htonll(byte_count));
1733 asr->flow_count = htonl(stats->flow_count);
1739 ofputil_decode_aggregate_stats_reply(struct ofputil_aggregate_stats *stats,
1740 const struct ofp_header *reply)
1742 struct ofp_aggregate_stats_reply *asr;
1745 ofpbuf_use_const(&msg, reply, ntohs(reply->length));
1746 ofpraw_pull_assert(&msg);
1749 stats->packet_count = ntohll(get_32aligned_be64(&asr->packet_count));
1750 stats->byte_count = ntohll(get_32aligned_be64(&asr->byte_count));
1751 stats->flow_count = ntohl(asr->flow_count);
1756 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
1757 * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
1758 * an OpenFlow error code. */
1760 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
1761 const struct ofp_header *oh)
1766 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1767 raw = ofpraw_pull_assert(&b);
1768 if (raw == OFPRAW_OFPT10_FLOW_REMOVED) {
1769 const struct ofp_flow_removed *ofr;
1771 ofr = ofpbuf_pull(&b, sizeof *ofr);
1773 ofputil_cls_rule_from_ofp10_match(&ofr->match, ntohs(ofr->priority),
1775 fr->cookie = ofr->cookie;
1776 fr->reason = ofr->reason;
1777 fr->duration_sec = ntohl(ofr->duration_sec);
1778 fr->duration_nsec = ntohl(ofr->duration_nsec);
1779 fr->idle_timeout = ntohs(ofr->idle_timeout);
1780 fr->packet_count = ntohll(ofr->packet_count);
1781 fr->byte_count = ntohll(ofr->byte_count);
1782 } else if (raw == OFPRAW_NXT_FLOW_REMOVED) {
1783 struct nx_flow_removed *nfr;
1786 nfr = ofpbuf_pull(&b, sizeof *nfr);
1787 error = nx_pull_match(&b, ntohs(nfr->match_len), ntohs(nfr->priority),
1788 &fr->rule, NULL, NULL);
1793 return OFPERR_OFPBRC_BAD_LEN;
1796 fr->cookie = nfr->cookie;
1797 fr->reason = nfr->reason;
1798 fr->duration_sec = ntohl(nfr->duration_sec);
1799 fr->duration_nsec = ntohl(nfr->duration_nsec);
1800 fr->idle_timeout = ntohs(nfr->idle_timeout);
1801 fr->packet_count = ntohll(nfr->packet_count);
1802 fr->byte_count = ntohll(nfr->byte_count);
1810 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
1811 * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
1814 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
1815 enum ofputil_protocol protocol)
1820 case OFPUTIL_P_OF10:
1821 case OFPUTIL_P_OF10_TID: {
1822 struct ofp_flow_removed *ofr;
1824 msg = ofpraw_alloc_xid(OFPRAW_OFPT10_FLOW_REMOVED, OFP10_VERSION,
1826 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
1827 ofputil_cls_rule_to_ofp10_match(&fr->rule, &ofr->match);
1828 ofr->cookie = fr->cookie;
1829 ofr->priority = htons(fr->rule.priority);
1830 ofr->reason = fr->reason;
1831 ofr->duration_sec = htonl(fr->duration_sec);
1832 ofr->duration_nsec = htonl(fr->duration_nsec);
1833 ofr->idle_timeout = htons(fr->idle_timeout);
1834 ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
1835 ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
1840 case OFPUTIL_P_NXM_TID: {
1841 struct nx_flow_removed *nfr;
1844 msg = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_REMOVED, OFP10_VERSION,
1845 htonl(0), NXM_TYPICAL_LEN);
1846 nfr = ofpbuf_put_zeros(msg, sizeof *nfr);
1847 match_len = nx_put_match(msg, false, &fr->rule, 0, 0);
1850 nfr->cookie = fr->cookie;
1851 nfr->priority = htons(fr->rule.priority);
1852 nfr->reason = fr->reason;
1853 nfr->duration_sec = htonl(fr->duration_sec);
1854 nfr->duration_nsec = htonl(fr->duration_nsec);
1855 nfr->idle_timeout = htons(fr->idle_timeout);
1856 nfr->match_len = htons(match_len);
1857 nfr->packet_count = htonll(fr->packet_count);
1858 nfr->byte_count = htonll(fr->byte_count);
1862 case OFPUTIL_P_OF12:
1871 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
1872 const struct ofp_header *oh)
1877 memset(pin, 0, sizeof *pin);
1879 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1880 raw = ofpraw_pull_assert(&b);
1881 if (raw == OFPRAW_OFPT10_PACKET_IN) {
1882 const struct ofp_packet_in *opi;
1884 opi = ofpbuf_pull(&b, offsetof(struct ofp_packet_in, data));
1886 pin->packet = opi->data;
1887 pin->packet_len = b.size;
1889 pin->fmd.in_port = ntohs(opi->in_port);
1890 pin->reason = opi->reason;
1891 pin->buffer_id = ntohl(opi->buffer_id);
1892 pin->total_len = ntohs(opi->total_len);
1893 } else if (raw == OFPRAW_NXT_PACKET_IN) {
1894 const struct nx_packet_in *npi;
1895 struct cls_rule rule;
1898 npi = ofpbuf_pull(&b, sizeof *npi);
1899 error = nx_pull_match_loose(&b, ntohs(npi->match_len), 0, &rule, NULL,
1905 if (!ofpbuf_try_pull(&b, 2)) {
1906 return OFPERR_OFPBRC_BAD_LEN;
1909 pin->packet = b.data;
1910 pin->packet_len = b.size;
1911 pin->reason = npi->reason;
1912 pin->table_id = npi->table_id;
1913 pin->cookie = npi->cookie;
1915 pin->fmd.in_port = rule.flow.in_port;
1917 pin->fmd.tun_id = rule.flow.tun_id;
1918 pin->fmd.tun_id_mask = rule.wc.tun_id_mask;
1920 pin->fmd.metadata = rule.flow.metadata;
1921 pin->fmd.metadata_mask = rule.wc.metadata_mask;
1923 memcpy(pin->fmd.regs, rule.flow.regs, sizeof pin->fmd.regs);
1924 memcpy(pin->fmd.reg_masks, rule.wc.reg_masks,
1925 sizeof pin->fmd.reg_masks);
1927 pin->buffer_id = ntohl(npi->buffer_id);
1928 pin->total_len = ntohs(npi->total_len);
1936 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
1937 * in the format specified by 'packet_in_format'. */
1939 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
1940 enum nx_packet_in_format packet_in_format)
1942 size_t send_len = MIN(pin->send_len, pin->packet_len);
1943 struct ofpbuf *packet;
1945 /* Add OFPT_PACKET_IN. */
1946 if (packet_in_format == NXPIF_OPENFLOW10) {
1947 struct ofp_packet_in *opi;
1949 packet = ofpraw_alloc_xid(OFPRAW_OFPT10_PACKET_IN, OFP10_VERSION,
1950 htonl(0), send_len);
1951 opi = ofpbuf_put_zeros(packet, offsetof(struct ofp_packet_in, data));
1952 opi->total_len = htons(pin->total_len);
1953 opi->in_port = htons(pin->fmd.in_port);
1954 opi->reason = pin->reason;
1955 opi->buffer_id = htonl(pin->buffer_id);
1957 ofpbuf_put(packet, pin->packet, send_len);
1958 } else if (packet_in_format == NXPIF_NXM) {
1959 struct nx_packet_in *npi;
1960 struct cls_rule rule;
1964 cls_rule_init_catchall(&rule, 0);
1965 cls_rule_set_tun_id_masked(&rule, pin->fmd.tun_id,
1966 pin->fmd.tun_id_mask);
1967 cls_rule_set_metadata_masked(&rule, pin->fmd.metadata,
1968 pin->fmd.metadata_mask);
1971 for (i = 0; i < FLOW_N_REGS; i++) {
1972 cls_rule_set_reg_masked(&rule, i, pin->fmd.regs[i],
1973 pin->fmd.reg_masks[i]);
1976 cls_rule_set_in_port(&rule, pin->fmd.in_port);
1978 /* The final argument is just an estimate of the space required. */
1979 packet = ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN, OFP10_VERSION,
1980 htonl(0), (sizeof(struct flow_metadata) * 2
1982 ofpbuf_put_zeros(packet, sizeof *npi);
1983 match_len = nx_put_match(packet, false, &rule, 0, 0);
1984 ofpbuf_put_zeros(packet, 2);
1985 ofpbuf_put(packet, pin->packet, send_len);
1988 npi->buffer_id = htonl(pin->buffer_id);
1989 npi->total_len = htons(pin->total_len);
1990 npi->reason = pin->reason;
1991 npi->table_id = pin->table_id;
1992 npi->cookie = pin->cookie;
1993 npi->match_len = htons(match_len);
1997 ofpmsg_update_length(packet);
2003 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason)
2005 static char s[INT_STRLEN(int) + 1];
2012 case OFPR_INVALID_TTL:
2013 return "invalid_ttl";
2015 case OFPR_N_REASONS:
2017 sprintf(s, "%d", (int) reason);
2023 ofputil_packet_in_reason_from_string(const char *s,
2024 enum ofp_packet_in_reason *reason)
2028 for (i = 0; i < OFPR_N_REASONS; i++) {
2029 if (!strcasecmp(s, ofputil_packet_in_reason_to_string(i))) {
2037 /* Converts an OFPT_PACKET_OUT in 'opo' into an abstract ofputil_packet_out in
2040 * Uses 'ofpacts' to store the abstract OFPACT_* version of the packet out
2041 * message's actions. The caller must initialize 'ofpacts' and retains
2042 * ownership of it. 'po->ofpacts' will point into the 'ofpacts' buffer.
2044 * Returns 0 if successful, otherwise an OFPERR_* value. */
2046 ofputil_decode_packet_out(struct ofputil_packet_out *po,
2047 const struct ofp_header *oh,
2048 struct ofpbuf *ofpacts)
2050 const struct ofp_packet_out *opo;
2055 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2056 raw = ofpraw_pull_assert(&b);
2057 assert(raw == OFPRAW_OFPT10_PACKET_OUT);
2059 opo = ofpbuf_pull(&b, sizeof *opo);
2060 po->buffer_id = ntohl(opo->buffer_id);
2061 po->in_port = ntohs(opo->in_port);
2062 if (po->in_port >= OFPP_MAX && po->in_port != OFPP_LOCAL
2063 && po->in_port != OFPP_NONE && po->in_port != OFPP_CONTROLLER) {
2064 VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
2066 return OFPERR_NXBRC_BAD_IN_PORT;
2069 error = ofpacts_pull_openflow10(&b, ntohs(opo->actions_len), ofpacts);
2073 po->ofpacts = ofpacts->data;
2074 po->ofpacts_len = ofpacts->size;
2076 if (po->buffer_id == UINT32_MAX) {
2077 po->packet = b.data;
2078 po->packet_len = b.size;
2087 /* ofputil_phy_port */
2089 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
2090 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
2091 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
2092 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
2093 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
2094 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
2095 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
2096 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
2098 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
2099 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
2100 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
2101 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
2102 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
2103 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
2105 static enum netdev_features
2106 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
2108 uint32_t ofp10 = ntohl(ofp10_);
2109 return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
2113 netdev_port_features_to_ofp10(enum netdev_features features)
2115 return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
2118 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
2119 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
2120 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
2121 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
2122 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
2123 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
2124 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
2125 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD == OFPPF11_40GB_FD); /* bit 7 */
2126 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD == OFPPF11_100GB_FD); /* bit 8 */
2127 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD == OFPPF11_1TB_FD); /* bit 9 */
2128 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER == OFPPF11_OTHER); /* bit 10 */
2129 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == OFPPF11_COPPER); /* bit 11 */
2130 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == OFPPF11_FIBER); /* bit 12 */
2131 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == OFPPF11_AUTONEG); /* bit 13 */
2132 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == OFPPF11_PAUSE); /* bit 14 */
2133 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
2135 static enum netdev_features
2136 netdev_port_features_from_ofp11(ovs_be32 ofp11)
2138 return ntohl(ofp11) & 0xffff;
2142 netdev_port_features_to_ofp11(enum netdev_features features)
2144 return htonl(features & 0xffff);
2148 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
2149 const struct ofp10_phy_port *opp)
2151 memset(pp, 0, sizeof *pp);
2153 pp->port_no = ntohs(opp->port_no);
2154 memcpy(pp->hw_addr, opp->hw_addr, OFP_ETH_ALEN);
2155 ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
2157 pp->config = ntohl(opp->config) & OFPPC10_ALL;
2158 pp->state = ntohl(opp->state) & OFPPS10_ALL;
2160 pp->curr = netdev_port_features_from_ofp10(opp->curr);
2161 pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
2162 pp->supported = netdev_port_features_from_ofp10(opp->supported);
2163 pp->peer = netdev_port_features_from_ofp10(opp->peer);
2165 pp->curr_speed = netdev_features_to_bps(pp->curr) / 1000;
2166 pp->max_speed = netdev_features_to_bps(pp->supported) / 1000;
2172 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
2173 const struct ofp11_port *op)
2177 memset(pp, 0, sizeof *pp);
2179 error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
2183 memcpy(pp->hw_addr, op->hw_addr, OFP_ETH_ALEN);
2184 ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
2186 pp->config = ntohl(op->config) & OFPPC11_ALL;
2187 pp->state = ntohl(op->state) & OFPPC11_ALL;
2189 pp->curr = netdev_port_features_from_ofp11(op->curr);
2190 pp->advertised = netdev_port_features_from_ofp11(op->advertised);
2191 pp->supported = netdev_port_features_from_ofp11(op->supported);
2192 pp->peer = netdev_port_features_from_ofp11(op->peer);
2194 pp->curr_speed = ntohl(op->curr_speed);
2195 pp->max_speed = ntohl(op->max_speed);
2201 ofputil_get_phy_port_size(enum ofp_version ofp_version)
2203 switch (ofp_version) {
2205 return sizeof(struct ofp10_phy_port);
2208 return sizeof(struct ofp11_port);
2215 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
2216 struct ofp10_phy_port *opp)
2218 memset(opp, 0, sizeof *opp);
2220 opp->port_no = htons(pp->port_no);
2221 memcpy(opp->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2222 ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2224 opp->config = htonl(pp->config & OFPPC10_ALL);
2225 opp->state = htonl(pp->state & OFPPS10_ALL);
2227 opp->curr = netdev_port_features_to_ofp10(pp->curr);
2228 opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
2229 opp->supported = netdev_port_features_to_ofp10(pp->supported);
2230 opp->peer = netdev_port_features_to_ofp10(pp->peer);
2234 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
2235 struct ofp11_port *op)
2237 memset(op, 0, sizeof *op);
2239 op->port_no = ofputil_port_to_ofp11(pp->port_no);
2240 memcpy(op->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2241 ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2243 op->config = htonl(pp->config & OFPPC11_ALL);
2244 op->state = htonl(pp->state & OFPPS11_ALL);
2246 op->curr = netdev_port_features_to_ofp11(pp->curr);
2247 op->advertised = netdev_port_features_to_ofp11(pp->advertised);
2248 op->supported = netdev_port_features_to_ofp11(pp->supported);
2249 op->peer = netdev_port_features_to_ofp11(pp->peer);
2251 op->curr_speed = htonl(pp->curr_speed);
2252 op->max_speed = htonl(pp->max_speed);
2256 ofputil_put_phy_port(enum ofp_version ofp_version,
2257 const struct ofputil_phy_port *pp, struct ofpbuf *b)
2259 switch (ofp_version) {
2260 case OFP10_VERSION: {
2261 struct ofp10_phy_port *opp;
2262 if (b->size + sizeof *opp <= UINT16_MAX) {
2263 opp = ofpbuf_put_uninit(b, sizeof *opp);
2264 ofputil_encode_ofp10_phy_port(pp, opp);
2270 case OFP12_VERSION: {
2271 struct ofp11_port *op;
2272 if (b->size + sizeof *op <= UINT16_MAX) {
2273 op = ofpbuf_put_uninit(b, sizeof *op);
2274 ofputil_encode_ofp11_port(pp, op);
2285 ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
2286 const struct ofputil_phy_port *pp,
2287 struct list *replies)
2289 switch (ofp_version) {
2290 case OFP10_VERSION: {
2291 struct ofp10_phy_port *opp;
2293 opp = ofpmp_append(replies, sizeof *opp);
2294 ofputil_encode_ofp10_phy_port(pp, opp);
2299 case OFP12_VERSION: {
2300 struct ofp11_port *op;
2302 op = ofpmp_append(replies, sizeof *op);
2303 ofputil_encode_ofp11_port(pp, op);
2312 /* ofputil_switch_features */
2314 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
2315 OFPC_IP_REASM | OFPC_QUEUE_STATS)
2316 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
2317 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
2318 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
2319 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
2320 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
2321 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
2323 struct ofputil_action_bit_translation {
2324 enum ofputil_action_bitmap ofputil_bit;
2328 static const struct ofputil_action_bit_translation of10_action_bits[] = {
2329 { OFPUTIL_A_OUTPUT, OFPAT10_OUTPUT },
2330 { OFPUTIL_A_SET_VLAN_VID, OFPAT10_SET_VLAN_VID },
2331 { OFPUTIL_A_SET_VLAN_PCP, OFPAT10_SET_VLAN_PCP },
2332 { OFPUTIL_A_STRIP_VLAN, OFPAT10_STRIP_VLAN },
2333 { OFPUTIL_A_SET_DL_SRC, OFPAT10_SET_DL_SRC },
2334 { OFPUTIL_A_SET_DL_DST, OFPAT10_SET_DL_DST },
2335 { OFPUTIL_A_SET_NW_SRC, OFPAT10_SET_NW_SRC },
2336 { OFPUTIL_A_SET_NW_DST, OFPAT10_SET_NW_DST },
2337 { OFPUTIL_A_SET_NW_TOS, OFPAT10_SET_NW_TOS },
2338 { OFPUTIL_A_SET_TP_SRC, OFPAT10_SET_TP_SRC },
2339 { OFPUTIL_A_SET_TP_DST, OFPAT10_SET_TP_DST },
2340 { OFPUTIL_A_ENQUEUE, OFPAT10_ENQUEUE },
2344 static enum ofputil_action_bitmap
2345 decode_action_bits(ovs_be32 of_actions,
2346 const struct ofputil_action_bit_translation *x)
2348 enum ofputil_action_bitmap ofputil_actions;
2350 ofputil_actions = 0;
2351 for (; x->ofputil_bit; x++) {
2352 if (of_actions & htonl(1u << x->of_bit)) {
2353 ofputil_actions |= x->ofputil_bit;
2356 return ofputil_actions;
2360 ofputil_capabilities_mask(enum ofp_version ofp_version)
2362 /* Handle capabilities whose bit is unique for all Open Flow versions */
2363 switch (ofp_version) {
2366 return OFPC_COMMON | OFPC_ARP_MATCH_IP;
2368 return OFPC_COMMON | OFPC12_PORT_BLOCKED;
2370 /* Caller needs to check osf->header.version itself */
2375 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
2376 * abstract representation in '*features'. Initializes '*b' to iterate over
2377 * the OpenFlow port structures following 'osf' with later calls to
2378 * ofputil_pull_phy_port(). Returns 0 if successful, otherwise an
2379 * OFPERR_* value. */
2381 ofputil_decode_switch_features(const struct ofp_header *oh,
2382 struct ofputil_switch_features *features,
2385 const struct ofp_switch_features *osf;
2388 ofpbuf_use_const(b, oh, ntohs(oh->length));
2389 raw = ofpraw_pull_assert(b);
2391 osf = ofpbuf_pull(b, sizeof *osf);
2392 features->datapath_id = ntohll(osf->datapath_id);
2393 features->n_buffers = ntohl(osf->n_buffers);
2394 features->n_tables = osf->n_tables;
2396 features->capabilities = ntohl(osf->capabilities) &
2397 ofputil_capabilities_mask(oh->version);
2399 if (b->size % ofputil_get_phy_port_size(oh->version)) {
2400 return OFPERR_OFPBRC_BAD_LEN;
2403 if (raw == OFPRAW_OFPT10_FEATURES_REPLY) {
2404 if (osf->capabilities & htonl(OFPC10_STP)) {
2405 features->capabilities |= OFPUTIL_C_STP;
2407 features->actions = decode_action_bits(osf->actions, of10_action_bits);
2408 } else if (raw == OFPRAW_OFPT11_FEATURES_REPLY) {
2409 if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
2410 features->capabilities |= OFPUTIL_C_GROUP_STATS;
2412 features->actions = 0;
2414 return OFPERR_OFPBRC_BAD_VERSION;
2420 /* Returns true if the maximum number of ports are in 'oh'. */
2422 max_ports_in_features(const struct ofp_header *oh)
2424 size_t pp_size = ofputil_get_phy_port_size(oh->version);
2425 return ntohs(oh->length) + pp_size > UINT16_MAX;
2428 /* Given a buffer 'b' that contains a Features Reply message, checks if
2429 * it contains the maximum number of ports that will fit. If so, it
2430 * returns true and removes the ports from the message. The caller
2431 * should then send an OFPST_PORT_DESC stats request to get the ports,
2432 * since the switch may have more ports than could be represented in the
2433 * Features Reply. Otherwise, returns false.
2436 ofputil_switch_features_ports_trunc(struct ofpbuf *b)
2438 struct ofp_header *oh = b->data;
2440 if (max_ports_in_features(oh)) {
2441 /* Remove all the ports. */
2442 b->size = (sizeof(struct ofp_header)
2443 + sizeof(struct ofp_switch_features));
2444 ofpmsg_update_length(b);
2453 encode_action_bits(enum ofputil_action_bitmap ofputil_actions,
2454 const struct ofputil_action_bit_translation *x)
2456 uint32_t of_actions;
2459 for (; x->ofputil_bit; x++) {
2460 if (ofputil_actions & x->ofputil_bit) {
2461 of_actions |= 1 << x->of_bit;
2464 return htonl(of_actions);
2467 /* Returns a buffer owned by the caller that encodes 'features' in the format
2468 * required by 'protocol' with the given 'xid'. The caller should append port
2469 * information to the buffer with subsequent calls to
2470 * ofputil_put_switch_features_port(). */
2472 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
2473 enum ofputil_protocol protocol, ovs_be32 xid)
2475 struct ofp_switch_features *osf;
2477 enum ofp_version version;
2480 version = ofputil_protocol_to_ofp_version(protocol);
2483 raw = OFPRAW_OFPT10_FEATURES_REPLY;
2487 raw = OFPRAW_OFPT11_FEATURES_REPLY;
2492 b = ofpraw_alloc_xid(raw, version, xid, 0);
2493 osf = ofpbuf_put_zeros(b, sizeof *osf);
2494 osf->datapath_id = htonll(features->datapath_id);
2495 osf->n_buffers = htonl(features->n_buffers);
2496 osf->n_tables = features->n_tables;
2498 osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
2499 osf->capabilities = htonl(features->capabilities &
2500 ofputil_capabilities_mask(version));
2503 if (features->capabilities & OFPUTIL_C_STP) {
2504 osf->capabilities |= htonl(OFPC10_STP);
2506 osf->actions = encode_action_bits(features->actions, of10_action_bits);
2510 if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
2511 osf->capabilities |= htonl(OFPC11_GROUP_STATS);
2521 /* Encodes 'pp' into the format required by the switch_features message already
2522 * in 'b', which should have been returned by ofputil_encode_switch_features(),
2523 * and appends the encoded version to 'b'. */
2525 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
2528 const struct ofp_header *oh = b->data;
2530 ofputil_put_phy_port(oh->version, pp, b);
2533 /* ofputil_port_status */
2535 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
2536 * in '*ps'. Returns 0 if successful, otherwise an OFPERR_* value. */
2538 ofputil_decode_port_status(const struct ofp_header *oh,
2539 struct ofputil_port_status *ps)
2541 const struct ofp_port_status *ops;
2545 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2546 ofpraw_pull_assert(&b);
2547 ops = ofpbuf_pull(&b, sizeof *ops);
2549 if (ops->reason != OFPPR_ADD &&
2550 ops->reason != OFPPR_DELETE &&
2551 ops->reason != OFPPR_MODIFY) {
2552 return OFPERR_NXBRC_BAD_REASON;
2554 ps->reason = ops->reason;
2556 retval = ofputil_pull_phy_port(oh->version, &b, &ps->desc);
2557 assert(retval != EOF);
2561 /* Converts the abstract form of a "port status" message in '*ps' into an
2562 * OpenFlow message suitable for 'protocol', and returns that encoded form in
2563 * a buffer owned by the caller. */
2565 ofputil_encode_port_status(const struct ofputil_port_status *ps,
2566 enum ofputil_protocol protocol)
2568 struct ofp_port_status *ops;
2570 enum ofp_version version;
2573 version = ofputil_protocol_to_ofp_version(protocol);
2576 raw = OFPRAW_OFPT10_PORT_STATUS;
2581 raw = OFPRAW_OFPT11_PORT_STATUS;
2588 b = ofpraw_alloc_xid(raw, version, htonl(0), 0);
2589 ops = ofpbuf_put_zeros(b, sizeof *ops);
2590 ops->reason = ps->reason;
2591 ofputil_put_phy_port(version, &ps->desc, b);
2592 ofpmsg_update_length(b);
2596 /* ofputil_port_mod */
2598 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
2599 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
2601 ofputil_decode_port_mod(const struct ofp_header *oh,
2602 struct ofputil_port_mod *pm)
2607 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2608 raw = ofpraw_pull_assert(&b);
2610 if (raw == OFPRAW_OFPT10_PORT_MOD) {
2611 const struct ofp10_port_mod *opm = b.data;
2613 pm->port_no = ntohs(opm->port_no);
2614 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
2615 pm->config = ntohl(opm->config) & OFPPC10_ALL;
2616 pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
2617 pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
2618 } else if (raw == OFPRAW_OFPT11_PORT_MOD) {
2619 const struct ofp11_port_mod *opm = b.data;
2622 error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
2627 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
2628 pm->config = ntohl(opm->config) & OFPPC11_ALL;
2629 pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
2630 pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
2632 return OFPERR_OFPBRC_BAD_TYPE;
2635 pm->config &= pm->mask;
2639 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
2640 * message suitable for 'protocol', and returns that encoded form in a buffer
2641 * owned by the caller. */
2643 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
2644 enum ofputil_protocol protocol)
2646 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
2649 switch (ofp_version) {
2650 case OFP10_VERSION: {
2651 struct ofp10_port_mod *opm;
2653 b = ofpraw_alloc(OFPRAW_OFPT10_PORT_MOD, ofp_version, 0);
2654 opm = ofpbuf_put_zeros(b, sizeof *opm);
2655 opm->port_no = htons(pm->port_no);
2656 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
2657 opm->config = htonl(pm->config & OFPPC10_ALL);
2658 opm->mask = htonl(pm->mask & OFPPC10_ALL);
2659 opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
2663 case OFP11_VERSION: {
2664 struct ofp11_port_mod *opm;
2666 b = ofpraw_alloc(OFPRAW_OFPT11_PORT_MOD, ofp_version, 0);
2667 opm = ofpbuf_put_zeros(b, sizeof *opm);
2668 opm->port_no = htonl(pm->port_no);
2669 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
2670 opm->config = htonl(pm->config & OFPPC11_ALL);
2671 opm->mask = htonl(pm->mask & OFPPC11_ALL);
2672 opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
2684 /* ofputil_flow_monitor_request */
2686 /* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract
2687 * ofputil_flow_monitor_request in 'rq'.
2689 * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow
2690 * message. Calling this function multiple times for a single 'msg' iterates
2691 * through the requests. The caller must initially leave 'msg''s layer
2692 * pointers null and not modify them between calls.
2694 * Returns 0 if successful, EOF if no requests were left in this 'msg',
2695 * otherwise an OFPERR_* value. */
2697 ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *rq,
2700 struct nx_flow_monitor_request *nfmr;
2704 msg->l2 = msg->data;
2705 ofpraw_pull_assert(msg);
2712 nfmr = ofpbuf_try_pull(msg, sizeof *nfmr);
2714 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR request has %zu "
2715 "leftover bytes at end", msg->size);
2716 return OFPERR_OFPBRC_BAD_LEN;
2719 flags = ntohs(nfmr->flags);
2720 if (!(flags & (NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY))
2721 || flags & ~(NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE
2722 | NXFMF_MODIFY | NXFMF_ACTIONS | NXFMF_OWN)) {
2723 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR has bad flags %#"PRIx16,
2725 return OFPERR_NXBRC_FM_BAD_FLAGS;
2728 if (!is_all_zeros(nfmr->zeros, sizeof nfmr->zeros)) {
2729 return OFPERR_NXBRC_MUST_BE_ZERO;
2732 rq->id = ntohl(nfmr->id);
2734 rq->out_port = ntohs(nfmr->out_port);
2735 rq->table_id = nfmr->table_id;
2737 return nx_pull_match(msg, ntohs(nfmr->match_len), OFP_DEFAULT_PRIORITY,
2738 &rq->match, NULL, NULL);
2742 ofputil_append_flow_monitor_request(
2743 const struct ofputil_flow_monitor_request *rq, struct ofpbuf *msg)
2745 struct nx_flow_monitor_request *nfmr;
2750 ofpraw_put(OFPRAW_NXST_FLOW_MONITOR_REQUEST, OFP10_VERSION, msg);
2753 start_ofs = msg->size;
2754 ofpbuf_put_zeros(msg, sizeof *nfmr);
2755 match_len = nx_put_match(msg, false, &rq->match, htonll(0), htonll(0));
2757 nfmr = ofpbuf_at_assert(msg, start_ofs, sizeof *nfmr);
2758 nfmr->id = htonl(rq->id);
2759 nfmr->flags = htons(rq->flags);
2760 nfmr->out_port = htons(rq->out_port);
2761 nfmr->match_len = htons(match_len);
2762 nfmr->table_id = rq->table_id;
2765 /* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg'
2766 * into an abstract ofputil_flow_update in 'update'. The caller must have
2767 * initialized update->match to point to space allocated for a cls_rule.
2769 * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's
2770 * actions (except for NXFME_ABBREV, which never includes actions). The caller
2771 * must initialize 'ofpacts' and retains ownership of it. 'update->ofpacts'
2772 * will point into the 'ofpacts' buffer.
2774 * Multiple flow updates can be packed into a single OpenFlow message. Calling
2775 * this function multiple times for a single 'msg' iterates through the
2776 * updates. The caller must initially leave 'msg''s layer pointers null and
2777 * not modify them between calls.
2779 * Returns 0 if successful, EOF if no updates were left in this 'msg',
2780 * otherwise an OFPERR_* value. */
2782 ofputil_decode_flow_update(struct ofputil_flow_update *update,
2783 struct ofpbuf *msg, struct ofpbuf *ofpacts)
2785 struct nx_flow_update_header *nfuh;
2786 unsigned int length;
2789 msg->l2 = msg->data;
2790 ofpraw_pull_assert(msg);
2797 if (msg->size < sizeof(struct nx_flow_update_header)) {
2802 update->event = ntohs(nfuh->event);
2803 length = ntohs(nfuh->length);
2804 if (length > msg->size || length % 8) {
2808 if (update->event == NXFME_ABBREV) {
2809 struct nx_flow_update_abbrev *nfua;
2811 if (length != sizeof *nfua) {
2815 nfua = ofpbuf_pull(msg, sizeof *nfua);
2816 update->xid = nfua->xid;
2818 } else if (update->event == NXFME_ADDED
2819 || update->event == NXFME_DELETED
2820 || update->event == NXFME_MODIFIED) {
2821 struct nx_flow_update_full *nfuf;
2822 unsigned int actions_len;
2823 unsigned int match_len;
2826 if (length < sizeof *nfuf) {
2830 nfuf = ofpbuf_pull(msg, sizeof *nfuf);
2831 match_len = ntohs(nfuf->match_len);
2832 if (sizeof *nfuf + match_len > length) {
2836 update->reason = ntohs(nfuf->reason);
2837 update->idle_timeout = ntohs(nfuf->idle_timeout);
2838 update->hard_timeout = ntohs(nfuf->hard_timeout);
2839 update->table_id = nfuf->table_id;
2840 update->cookie = nfuf->cookie;
2842 error = nx_pull_match(msg, match_len, ntohs(nfuf->priority),
2843 update->match, NULL, NULL);
2848 actions_len = length - sizeof *nfuf - ROUND_UP(match_len, 8);
2849 error = ofpacts_pull_openflow10(msg, actions_len, ofpacts);
2854 update->ofpacts = ofpacts->data;
2855 update->ofpacts_len = ofpacts->size;
2858 VLOG_WARN_RL(&bad_ofmsg_rl,
2859 "NXST_FLOW_MONITOR reply has bad event %"PRIu16,
2860 ntohs(nfuh->event));
2861 return OFPERR_OFPET_BAD_REQUEST;
2865 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR reply has %zu "
2866 "leftover bytes at end", msg->size);
2867 return OFPERR_OFPBRC_BAD_LEN;
2871 ofputil_decode_flow_monitor_cancel(const struct ofp_header *oh)
2873 const struct nx_flow_monitor_cancel *cancel = ofpmsg_body(oh);
2875 return ntohl(cancel->id);
2879 ofputil_encode_flow_monitor_cancel(uint32_t id)
2881 struct nx_flow_monitor_cancel *nfmc;
2884 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MONITOR_CANCEL, OFP10_VERSION, 0);
2885 nfmc = ofpbuf_put_uninit(msg, sizeof *nfmc);
2886 nfmc->id = htonl(id);
2891 ofputil_start_flow_update(struct list *replies)
2895 msg = ofpraw_alloc_xid(OFPRAW_NXST_FLOW_MONITOR_REPLY, OFP10_VERSION,
2899 list_push_back(replies, &msg->list_node);
2903 ofputil_append_flow_update(const struct ofputil_flow_update *update,
2904 struct list *replies)
2906 struct nx_flow_update_header *nfuh;
2910 msg = ofpbuf_from_list(list_back(replies));
2911 start_ofs = msg->size;
2913 if (update->event == NXFME_ABBREV) {
2914 struct nx_flow_update_abbrev *nfua;
2916 nfua = ofpbuf_put_zeros(msg, sizeof *nfua);
2917 nfua->xid = update->xid;
2919 struct nx_flow_update_full *nfuf;
2922 ofpbuf_put_zeros(msg, sizeof *nfuf);
2923 match_len = nx_put_match(msg, false, update->match,
2924 htonll(0), htonll(0));
2925 ofpacts_put_openflow10(update->ofpacts, update->ofpacts_len, msg);
2927 nfuf = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuf);
2928 nfuf->reason = htons(update->reason);
2929 nfuf->priority = htons(update->match->priority);
2930 nfuf->idle_timeout = htons(update->idle_timeout);
2931 nfuf->hard_timeout = htons(update->hard_timeout);
2932 nfuf->match_len = htons(match_len);
2933 nfuf->table_id = update->table_id;
2934 nfuf->cookie = update->cookie;
2937 nfuh = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuh);
2938 nfuh->length = htons(msg->size - start_ofs);
2939 nfuh->event = htons(update->event);
2941 ofpmp_postappend(replies, start_ofs);
2945 ofputil_encode_packet_out(const struct ofputil_packet_out *po)
2947 struct ofp_packet_out *opo;
2952 size = po->ofpacts_len;
2953 if (po->buffer_id == UINT32_MAX) {
2954 size += po->packet_len;
2957 msg = ofpraw_alloc(OFPRAW_OFPT10_PACKET_OUT, OFP10_VERSION, size);
2958 ofpbuf_put_zeros(msg, sizeof *opo);
2959 actions_ofs = msg->size;
2960 ofpacts_put_openflow10(po->ofpacts, po->ofpacts_len, msg);
2963 opo->buffer_id = htonl(po->buffer_id);
2964 opo->in_port = htons(po->in_port);
2965 opo->actions_len = htons(msg->size - actions_ofs);
2967 if (po->buffer_id == UINT32_MAX) {
2968 ofpbuf_put(msg, po->packet, po->packet_len);
2971 ofpmsg_update_length(msg);
2976 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
2978 make_echo_request(void)
2980 return ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST, OFP10_VERSION,
2984 /* Creates and returns an OFPT_ECHO_REPLY message matching the
2985 * OFPT_ECHO_REQUEST message in 'rq'. */
2987 make_echo_reply(const struct ofp_header *rq)
2989 struct ofpbuf rq_buf;
2990 struct ofpbuf *reply;
2992 ofpbuf_use_const(&rq_buf, rq, ntohs(rq->length));
2993 ofpraw_pull_assert(&rq_buf);
2995 reply = ofpraw_alloc_reply(OFPRAW_OFPT_ECHO_REPLY, rq, rq_buf.size);
2996 ofpbuf_put(reply, rq_buf.data, rq_buf.size);
3001 ofputil_encode_barrier_request(void)
3003 return ofpraw_alloc(OFPRAW_OFPT10_BARRIER_REQUEST, OFP10_VERSION, 0);
3007 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
3009 switch (flags & OFPC_FRAG_MASK) {
3010 case OFPC_FRAG_NORMAL: return "normal";
3011 case OFPC_FRAG_DROP: return "drop";
3012 case OFPC_FRAG_REASM: return "reassemble";
3013 case OFPC_FRAG_NX_MATCH: return "nx-match";
3020 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
3022 if (!strcasecmp(s, "normal")) {
3023 *flags = OFPC_FRAG_NORMAL;
3024 } else if (!strcasecmp(s, "drop")) {
3025 *flags = OFPC_FRAG_DROP;
3026 } else if (!strcasecmp(s, "reassemble")) {
3027 *flags = OFPC_FRAG_REASM;
3028 } else if (!strcasecmp(s, "nx-match")) {
3029 *flags = OFPC_FRAG_NX_MATCH;
3036 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
3037 * port number and stores the latter in '*ofp10_port', for the purpose of
3038 * decoding OpenFlow 1.1+ protocol messages. Returns 0 if successful,
3039 * otherwise an OFPERR_* number.
3041 * See the definition of OFP11_MAX for an explanation of the mapping. */
3043 ofputil_port_from_ofp11(ovs_be32 ofp11_port, uint16_t *ofp10_port)
3045 uint32_t ofp11_port_h = ntohl(ofp11_port);
3047 if (ofp11_port_h < OFPP_MAX) {
3048 *ofp10_port = ofp11_port_h;
3050 } else if (ofp11_port_h >= OFPP11_MAX) {
3051 *ofp10_port = ofp11_port_h - OFPP11_OFFSET;
3054 VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
3055 "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
3056 ofp11_port_h, OFPP_MAX - 1,
3057 (uint32_t) OFPP11_MAX, UINT32_MAX);
3058 return OFPERR_OFPBAC_BAD_OUT_PORT;
3062 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
3063 * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
3065 * See the definition of OFP11_MAX for an explanation of the mapping. */
3067 ofputil_port_to_ofp11(uint16_t ofp10_port)
3069 return htonl(ofp10_port < OFPP_MAX
3071 : ofp10_port + OFPP11_OFFSET);
3074 /* Checks that 'port' is a valid output port for the OFPAT10_OUTPUT action, given
3075 * that the switch will never have more than 'max_ports' ports. Returns 0 if
3076 * 'port' is valid, otherwise an OpenFlow return code. */
3078 ofputil_check_output_port(uint16_t port, int max_ports)
3086 case OFPP_CONTROLLER:
3092 if (port < max_ports) {
3095 return OFPERR_OFPBAC_BAD_OUT_PORT;
3099 #define OFPUTIL_NAMED_PORTS \
3100 OFPUTIL_NAMED_PORT(IN_PORT) \
3101 OFPUTIL_NAMED_PORT(TABLE) \
3102 OFPUTIL_NAMED_PORT(NORMAL) \
3103 OFPUTIL_NAMED_PORT(FLOOD) \
3104 OFPUTIL_NAMED_PORT(ALL) \
3105 OFPUTIL_NAMED_PORT(CONTROLLER) \
3106 OFPUTIL_NAMED_PORT(LOCAL) \
3107 OFPUTIL_NAMED_PORT(NONE)
3109 /* Checks whether 's' is the string representation of an OpenFlow port number,
3110 * either as an integer or a string name (e.g. "LOCAL"). If it is, stores the
3111 * number in '*port' and returns true. Otherwise, returns false. */
3113 ofputil_port_from_string(const char *name, uint16_t *port)
3119 static const struct pair pairs[] = {
3120 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
3122 #undef OFPUTIL_NAMED_PORT
3124 static const int n_pairs = ARRAY_SIZE(pairs);
3127 if (str_to_int(name, 0, &i) && i >= 0 && i < UINT16_MAX) {
3132 for (i = 0; i < n_pairs; i++) {
3133 if (!strcasecmp(name, pairs[i].name)) {
3134 *port = pairs[i].value;
3141 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
3142 * Most ports' string representation is just the port number, but for special
3143 * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
3145 ofputil_format_port(uint16_t port, struct ds *s)
3150 #define OFPUTIL_NAMED_PORT(NAME) case OFPP_##NAME: name = #NAME; break;
3152 #undef OFPUTIL_NAMED_PORT
3155 ds_put_format(s, "%"PRIu16, port);
3158 ds_put_cstr(s, name);
3161 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3162 * 'ofp_version', tries to pull the first element from the array. If
3163 * successful, initializes '*pp' with an abstract representation of the
3164 * port and returns 0. If no ports remain to be decoded, returns EOF.
3165 * On an error, returns a positive OFPERR_* value. */
3167 ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *b,
3168 struct ofputil_phy_port *pp)
3170 switch (ofp_version) {
3171 case OFP10_VERSION: {
3172 const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
3173 return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
3176 case OFP12_VERSION: {
3177 const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
3178 return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
3185 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3186 * 'ofp_version', returns the number of elements. */
3187 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *b)
3189 return b->size / ofputil_get_phy_port_size(ofp_version);
3192 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
3193 * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1 if
3194 * 'name' is not the name of any action.
3196 * ofp-util.def lists the mapping from names to action. */
3198 ofputil_action_code_from_name(const char *name)
3200 static const char *names[OFPUTIL_N_ACTIONS] = {
3202 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) NAME,
3203 #define OFPAT11_ACTION(ENUM, STRUCT, NAME) NAME,
3204 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
3205 #include "ofp-util.def"
3210 for (p = names; p < &names[ARRAY_SIZE(names)]; p++) {
3211 if (*p && !strcasecmp(name, *p)) {
3218 /* Appends an action of the type specified by 'code' to 'buf' and returns the
3219 * action. Initializes the parts of 'action' that identify it as having type
3220 * <ENUM> and length 'sizeof *action' and zeros the rest. For actions that
3221 * have variable length, the length used and cleared is that of struct
3224 ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
3227 case OFPUTIL_ACTION_INVALID:
3230 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
3231 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3232 #define OFPAT11_ACTION OFPAT10_ACTION
3233 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3234 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3235 #include "ofp-util.def"
3240 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
3242 ofputil_init_##ENUM(struct STRUCT *s) \
3244 memset(s, 0, sizeof *s); \
3245 s->type = htons(ENUM); \
3246 s->len = htons(sizeof *s); \
3250 ofputil_put_##ENUM(struct ofpbuf *buf) \
3252 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
3253 ofputil_init_##ENUM(s); \
3256 #define OFPAT11_ACTION OFPAT10_ACTION
3257 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3259 ofputil_init_##ENUM(struct STRUCT *s) \
3261 memset(s, 0, sizeof *s); \
3262 s->type = htons(OFPAT10_VENDOR); \
3263 s->len = htons(sizeof *s); \
3264 s->vendor = htonl(NX_VENDOR_ID); \
3265 s->subtype = htons(ENUM); \
3269 ofputil_put_##ENUM(struct ofpbuf *buf) \
3271 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
3272 ofputil_init_##ENUM(s); \
3275 #include "ofp-util.def"
3277 /* "Normalizes" the wildcards in 'rule'. That means:
3279 * 1. If the type of level N is known, then only the valid fields for that
3280 * level may be specified. For example, ARP does not have a TOS field,
3281 * so nw_tos must be wildcarded if 'rule' specifies an ARP flow.
3282 * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
3283 * ipv6_dst (and other fields) must be wildcarded if 'rule' specifies an
3286 * 2. If the type of level N is not known (or not understood by Open
3287 * vSwitch), then no fields at all for that level may be specified. For
3288 * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
3289 * L4 fields tp_src and tp_dst must be wildcarded if 'rule' specifies an
3293 ofputil_normalize_rule(struct cls_rule *rule)
3296 MAY_NW_ADDR = 1 << 0, /* nw_src, nw_dst */
3297 MAY_TP_ADDR = 1 << 1, /* tp_src, tp_dst */
3298 MAY_NW_PROTO = 1 << 2, /* nw_proto */
3299 MAY_IPVx = 1 << 3, /* tos, frag, ttl */
3300 MAY_ARP_SHA = 1 << 4, /* arp_sha */
3301 MAY_ARP_THA = 1 << 5, /* arp_tha */
3302 MAY_IPV6 = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
3303 MAY_ND_TARGET = 1 << 7 /* nd_target */
3306 struct flow_wildcards wc;
3308 /* Figure out what fields may be matched. */
3309 if (rule->flow.dl_type == htons(ETH_TYPE_IP)) {
3310 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
3311 if (rule->flow.nw_proto == IPPROTO_TCP ||
3312 rule->flow.nw_proto == IPPROTO_UDP ||
3313 rule->flow.nw_proto == IPPROTO_ICMP) {
3314 may_match |= MAY_TP_ADDR;
3316 } else if (rule->flow.dl_type == htons(ETH_TYPE_IPV6)) {
3317 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
3318 if (rule->flow.nw_proto == IPPROTO_TCP ||
3319 rule->flow.nw_proto == IPPROTO_UDP) {
3320 may_match |= MAY_TP_ADDR;
3321 } else if (rule->flow.nw_proto == IPPROTO_ICMPV6) {
3322 may_match |= MAY_TP_ADDR;
3323 if (rule->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
3324 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
3325 } else if (rule->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
3326 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
3329 } else if (rule->flow.dl_type == htons(ETH_TYPE_ARP)) {
3330 may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
3335 /* Clear the fields that may not be matched. */
3337 if (!(may_match & MAY_NW_ADDR)) {
3338 wc.nw_src_mask = wc.nw_dst_mask = htonl(0);
3340 if (!(may_match & MAY_TP_ADDR)) {
3341 wc.tp_src_mask = wc.tp_dst_mask = htons(0);
3343 if (!(may_match & MAY_NW_PROTO)) {
3344 wc.wildcards |= FWW_NW_PROTO;
3346 if (!(may_match & MAY_IPVx)) {
3347 wc.wildcards |= FWW_NW_DSCP;
3348 wc.wildcards |= FWW_NW_ECN;
3349 wc.wildcards |= FWW_NW_TTL;
3351 if (!(may_match & MAY_ARP_SHA)) {
3352 memset(wc.arp_sha_mask, 0, ETH_ADDR_LEN);
3354 if (!(may_match & MAY_ARP_THA)) {
3355 memset(wc.arp_tha_mask, 0, ETH_ADDR_LEN);
3357 if (!(may_match & MAY_IPV6)) {
3358 wc.ipv6_src_mask = wc.ipv6_dst_mask = in6addr_any;
3359 wc.ipv6_label_mask = htonl(0);
3361 if (!(may_match & MAY_ND_TARGET)) {
3362 wc.nd_target_mask = in6addr_any;
3365 /* Log any changes. */
3366 if (!flow_wildcards_equal(&wc, &rule->wc)) {
3367 bool log = !VLOG_DROP_INFO(&bad_ofmsg_rl);
3368 char *pre = log ? cls_rule_to_string(rule) : NULL;
3371 cls_rule_zero_wildcarded_fields(rule);
3374 char *post = cls_rule_to_string(rule);
3375 VLOG_INFO("normalization changed ofp_match, details:");
3376 VLOG_INFO(" pre: %s", pre);
3377 VLOG_INFO("post: %s", post);
3384 /* Parses a key or a key-value pair from '*stringp'.
3386 * On success: Stores the key into '*keyp'. Stores the value, if present, into
3387 * '*valuep', otherwise an empty string. Advances '*stringp' past the end of
3388 * the key-value pair, preparing it for another call. '*keyp' and '*valuep'
3389 * are substrings of '*stringp' created by replacing some of its bytes by null
3390 * terminators. Returns true.
3392 * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
3393 * NULL and returns false. */
3395 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
3397 char *pos, *key, *value;
3401 pos += strspn(pos, ", \t\r\n");
3403 *keyp = *valuep = NULL;
3408 key_len = strcspn(pos, ":=(, \t\r\n");
3409 if (key[key_len] == ':' || key[key_len] == '=') {
3410 /* The value can be separated by a colon. */
3413 value = key + key_len + 1;
3414 value_len = strcspn(value, ", \t\r\n");
3415 pos = value + value_len + (value[value_len] != '\0');
3416 value[value_len] = '\0';
3417 } else if (key[key_len] == '(') {
3418 /* The value can be surrounded by balanced parentheses. The outermost
3419 * set of parentheses is removed. */
3423 value = key + key_len + 1;
3424 for (value_len = 0; level > 0; value_len++) {
3425 switch (value[value_len]) {
3439 value[value_len - 1] = '\0';
3440 pos = value + value_len;
3442 /* There might be no value at all. */
3443 value = key + key_len; /* Will become the empty string below. */
3444 pos = key + key_len + (key[key_len] != '\0');
3446 key[key_len] = '\0';