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 /* Converts the OpenFlow 1.0 wildcards in 'ofpfw' (OFPFW10_*) into a
81 * flow_wildcards in 'wc' for use in struct cls_rule. It is the caller's
82 * responsibility to handle the special case where the flow match's dl_vlan is
83 * set to OFP_VLAN_NONE. */
85 ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *wc)
87 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 17);
89 /* Initialize most of rule->wc. */
90 flow_wildcards_init_catchall(wc);
92 if (!(ofpfw & OFPFW10_IN_PORT)) {
93 wc->in_port_mask = UINT16_MAX;
96 if (!(ofpfw & OFPFW10_NW_TOS)) {
97 wc->nw_tos_mask |= IP_DSCP_MASK;
100 if (!(ofpfw & OFPFW10_NW_PROTO)) {
101 wc->nw_proto_mask = UINT8_MAX;
103 wc->nw_src_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW10_NW_SRC_SHIFT);
104 wc->nw_dst_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW10_NW_DST_SHIFT);
106 if (!(ofpfw & OFPFW10_TP_SRC)) {
107 wc->tp_src_mask = htons(UINT16_MAX);
109 if (!(ofpfw & OFPFW10_TP_DST)) {
110 wc->tp_dst_mask = htons(UINT16_MAX);
113 if (!(ofpfw & OFPFW10_DL_SRC)) {
114 memset(wc->dl_src_mask, 0xff, ETH_ADDR_LEN);
116 if (!(ofpfw & OFPFW10_DL_DST)) {
117 memset(wc->dl_dst_mask, 0xff, ETH_ADDR_LEN);
119 if (!(ofpfw & OFPFW10_DL_TYPE)) {
120 wc->dl_type_mask = htons(UINT16_MAX);
124 if (!(ofpfw & OFPFW10_DL_VLAN_PCP)) {
125 wc->vlan_tci_mask |= htons(VLAN_PCP_MASK | VLAN_CFI);
127 if (!(ofpfw & OFPFW10_DL_VLAN)) {
128 wc->vlan_tci_mask |= htons(VLAN_VID_MASK | VLAN_CFI);
132 /* Converts the ofp10_match in 'match' into a cls_rule in 'rule', with the
133 * given 'priority'. */
135 ofputil_cls_rule_from_ofp10_match(const struct ofp10_match *match,
136 unsigned int priority, struct cls_rule *rule)
138 uint32_t ofpfw = ntohl(match->wildcards) & OFPFW10_ALL;
140 /* Initialize rule->priority, rule->wc. */
141 rule->priority = !ofpfw ? UINT16_MAX : priority;
142 ofputil_wildcard_from_ofpfw10(ofpfw, &rule->wc);
144 /* Initialize most of rule->flow. */
145 rule->flow.nw_src = match->nw_src;
146 rule->flow.nw_dst = match->nw_dst;
147 rule->flow.in_port = ntohs(match->in_port);
148 rule->flow.dl_type = ofputil_dl_type_from_openflow(match->dl_type);
149 rule->flow.tp_src = match->tp_src;
150 rule->flow.tp_dst = match->tp_dst;
151 memcpy(rule->flow.dl_src, match->dl_src, ETH_ADDR_LEN);
152 memcpy(rule->flow.dl_dst, match->dl_dst, ETH_ADDR_LEN);
153 rule->flow.nw_tos = match->nw_tos & IP_DSCP_MASK;
154 rule->flow.nw_proto = match->nw_proto;
156 /* Translate VLANs. */
157 if (!(ofpfw & OFPFW10_DL_VLAN) &&
158 match->dl_vlan == htons(OFP10_VLAN_NONE)) {
159 /* Match only packets without 802.1Q header.
161 * When OFPFW10_DL_VLAN_PCP is wildcarded, this is obviously correct.
163 * If OFPFW10_DL_VLAN_PCP is matched, the flow match is contradictory,
164 * because we can't have a specific PCP without an 802.1Q header.
165 * However, older versions of OVS treated this as matching packets
166 * withut an 802.1Q header, so we do here too. */
167 rule->flow.vlan_tci = htons(0);
168 rule->wc.vlan_tci_mask = htons(0xffff);
170 ovs_be16 vid, pcp, tci;
172 vid = match->dl_vlan & htons(VLAN_VID_MASK);
173 pcp = htons((match->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK);
174 tci = vid | pcp | htons(VLAN_CFI);
175 rule->flow.vlan_tci = tci & rule->wc.vlan_tci_mask;
179 cls_rule_zero_wildcarded_fields(rule);
182 /* Convert 'rule' into the OpenFlow 1.0 match structure 'match'. */
184 ofputil_cls_rule_to_ofp10_match(const struct cls_rule *rule,
185 struct ofp10_match *match)
187 const struct flow_wildcards *wc = &rule->wc;
190 /* Figure out most OpenFlow wildcards. */
192 if (!wc->in_port_mask) {
193 ofpfw |= OFPFW10_IN_PORT;
195 if (!wc->dl_type_mask) {
196 ofpfw |= OFPFW10_DL_TYPE;
198 if (!wc->nw_proto_mask) {
199 ofpfw |= OFPFW10_NW_PROTO;
201 ofpfw |= (ofputil_netmask_to_wcbits(wc->nw_src_mask)
202 << OFPFW10_NW_SRC_SHIFT);
203 ofpfw |= (ofputil_netmask_to_wcbits(wc->nw_dst_mask)
204 << OFPFW10_NW_DST_SHIFT);
205 if (!(wc->nw_tos_mask & IP_DSCP_MASK)) {
206 ofpfw |= OFPFW10_NW_TOS;
208 if (!wc->tp_src_mask) {
209 ofpfw |= OFPFW10_TP_SRC;
211 if (!wc->tp_dst_mask) {
212 ofpfw |= OFPFW10_TP_DST;
214 if (eth_addr_is_zero(wc->dl_src_mask)) {
215 ofpfw |= OFPFW10_DL_SRC;
217 if (eth_addr_is_zero(wc->dl_dst_mask)) {
218 ofpfw |= OFPFW10_DL_DST;
221 /* Translate VLANs. */
222 match->dl_vlan = htons(0);
223 match->dl_vlan_pcp = 0;
224 if (rule->wc.vlan_tci_mask == htons(0)) {
225 ofpfw |= OFPFW10_DL_VLAN | OFPFW10_DL_VLAN_PCP;
226 } else if (rule->wc.vlan_tci_mask & htons(VLAN_CFI)
227 && !(rule->flow.vlan_tci & htons(VLAN_CFI))) {
228 match->dl_vlan = htons(OFP10_VLAN_NONE);
229 ofpfw |= OFPFW10_DL_VLAN_PCP;
231 if (!(rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) {
232 ofpfw |= OFPFW10_DL_VLAN;
234 match->dl_vlan = htons(vlan_tci_to_vid(rule->flow.vlan_tci));
237 if (!(rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK))) {
238 ofpfw |= OFPFW10_DL_VLAN_PCP;
240 match->dl_vlan_pcp = vlan_tci_to_pcp(rule->flow.vlan_tci);
244 /* Compose most of the match structure. */
245 match->wildcards = htonl(ofpfw);
246 match->in_port = htons(rule->flow.in_port);
247 memcpy(match->dl_src, rule->flow.dl_src, ETH_ADDR_LEN);
248 memcpy(match->dl_dst, rule->flow.dl_dst, ETH_ADDR_LEN);
249 match->dl_type = ofputil_dl_type_to_openflow(rule->flow.dl_type);
250 match->nw_src = rule->flow.nw_src;
251 match->nw_dst = rule->flow.nw_dst;
252 match->nw_tos = rule->flow.nw_tos & IP_DSCP_MASK;
253 match->nw_proto = rule->flow.nw_proto;
254 match->tp_src = rule->flow.tp_src;
255 match->tp_dst = rule->flow.tp_dst;
256 memset(match->pad1, '\0', sizeof match->pad1);
257 memset(match->pad2, '\0', sizeof match->pad2);
261 ofputil_pull_ofp11_match(struct ofpbuf *buf, unsigned int priority,
262 struct cls_rule *rule, uint16_t *padded_match_len)
264 struct ofp11_match_header *omh = buf->data;
267 if (buf->size < sizeof *omh) {
268 return OFPERR_OFPBMC_BAD_LEN;
271 match_len = ntohs(omh->length);
273 switch (ntohs(omh->type)) {
274 case OFPMT_STANDARD: {
275 struct ofp11_match *om;
277 if (match_len != sizeof *om || buf->size < sizeof *om) {
278 return OFPERR_OFPBMC_BAD_LEN;
280 om = ofpbuf_pull(buf, sizeof *om);
281 if (padded_match_len) {
282 *padded_match_len = match_len;
284 return ofputil_cls_rule_from_ofp11_match(om, priority, rule);
288 if (padded_match_len) {
289 *padded_match_len = ROUND_UP(match_len, 8);
291 return oxm_pull_match(buf, priority, rule);
294 return OFPERR_OFPBMC_BAD_TYPE;
298 /* Converts the ofp11_match in 'match' into a cls_rule in 'rule', with the
299 * given 'priority'. Returns 0 if successful, otherwise an OFPERR_* value. */
301 ofputil_cls_rule_from_ofp11_match(const struct ofp11_match *match,
302 unsigned int priority,
303 struct cls_rule *rule)
305 uint16_t wc = ntohl(match->wildcards);
306 uint8_t dl_src_mask[ETH_ADDR_LEN];
307 uint8_t dl_dst_mask[ETH_ADDR_LEN];
311 cls_rule_init_catchall(rule, priority);
313 if (!(wc & OFPFW11_IN_PORT)) {
317 error = ofputil_port_from_ofp11(match->in_port, &ofp_port);
319 return OFPERR_OFPBMC_BAD_VALUE;
321 cls_rule_set_in_port(rule, ofp_port);
324 for (i = 0; i < ETH_ADDR_LEN; i++) {
325 dl_src_mask[i] = ~match->dl_src_mask[i];
327 cls_rule_set_dl_src_masked(rule, match->dl_src, dl_src_mask);
329 for (i = 0; i < ETH_ADDR_LEN; i++) {
330 dl_dst_mask[i] = ~match->dl_dst_mask[i];
332 cls_rule_set_dl_dst_masked(rule, match->dl_dst, dl_dst_mask);
334 if (!(wc & OFPFW11_DL_VLAN)) {
335 if (match->dl_vlan == htons(OFPVID11_NONE)) {
336 /* Match only packets without a VLAN tag. */
337 rule->flow.vlan_tci = htons(0);
338 rule->wc.vlan_tci_mask = htons(UINT16_MAX);
340 if (match->dl_vlan == htons(OFPVID11_ANY)) {
341 /* Match any packet with a VLAN tag regardless of VID. */
342 rule->flow.vlan_tci = htons(VLAN_CFI);
343 rule->wc.vlan_tci_mask = htons(VLAN_CFI);
344 } else if (ntohs(match->dl_vlan) < 4096) {
345 /* Match only packets with the specified VLAN VID. */
346 rule->flow.vlan_tci = htons(VLAN_CFI) | match->dl_vlan;
347 rule->wc.vlan_tci_mask = htons(VLAN_CFI | VLAN_VID_MASK);
350 return OFPERR_OFPBMC_BAD_VALUE;
353 if (!(wc & OFPFW11_DL_VLAN_PCP)) {
354 if (match->dl_vlan_pcp <= 7) {
355 rule->flow.vlan_tci |= htons(match->dl_vlan_pcp
357 rule->wc.vlan_tci_mask |= htons(VLAN_PCP_MASK);
360 return OFPERR_OFPBMC_BAD_VALUE;
366 if (!(wc & OFPFW11_DL_TYPE)) {
367 cls_rule_set_dl_type(rule,
368 ofputil_dl_type_from_openflow(match->dl_type));
371 ipv4 = rule->flow.dl_type == htons(ETH_TYPE_IP);
372 arp = rule->flow.dl_type == htons(ETH_TYPE_ARP);
374 if (ipv4 && !(wc & OFPFW11_NW_TOS)) {
375 if (match->nw_tos & ~IP_DSCP_MASK) {
377 return OFPERR_OFPBMC_BAD_VALUE;
380 cls_rule_set_nw_dscp(rule, match->nw_tos);
384 if (!(wc & OFPFW11_NW_PROTO)) {
385 cls_rule_set_nw_proto(rule, match->nw_proto);
387 cls_rule_set_nw_src_masked(rule, match->nw_src, ~match->nw_src_mask);
388 cls_rule_set_nw_dst_masked(rule, match->nw_dst, ~match->nw_dst_mask);
391 #define OFPFW11_TP_ALL (OFPFW11_TP_SRC | OFPFW11_TP_DST)
392 if (ipv4 && (wc & OFPFW11_TP_ALL) != OFPFW11_TP_ALL) {
393 switch (rule->flow.nw_proto) {
395 /* "A.2.3 Flow Match Structures" in OF1.1 says:
397 * The tp_src and tp_dst fields will be ignored unless the
398 * network protocol specified is as TCP, UDP or SCTP.
400 * but I'm pretty sure we should support ICMP too, otherwise
401 * that's a regression from OF1.0. */
402 if (!(wc & OFPFW11_TP_SRC)) {
403 uint16_t icmp_type = ntohs(match->tp_src);
404 if (icmp_type < 0x100) {
405 cls_rule_set_icmp_type(rule, icmp_type);
407 return OFPERR_OFPBMC_BAD_FIELD;
410 if (!(wc & OFPFW11_TP_DST)) {
411 uint16_t icmp_code = ntohs(match->tp_dst);
412 if (icmp_code < 0x100) {
413 cls_rule_set_icmp_code(rule, icmp_code);
415 return OFPERR_OFPBMC_BAD_FIELD;
422 if (!(wc & (OFPFW11_TP_SRC))) {
423 cls_rule_set_tp_src(rule, match->tp_src);
425 if (!(wc & (OFPFW11_TP_DST))) {
426 cls_rule_set_tp_dst(rule, match->tp_dst);
431 /* We don't support SCTP and it seems that we should tell the
432 * controller, since OF1.1 implementations are supposed to. */
433 return OFPERR_OFPBMC_BAD_FIELD;
436 /* OF1.1 says explicitly to ignore this. */
441 if (rule->flow.dl_type == htons(ETH_TYPE_MPLS) ||
442 rule->flow.dl_type == htons(ETH_TYPE_MPLS_MCAST)) {
443 enum { OFPFW11_MPLS_ALL = OFPFW11_MPLS_LABEL | OFPFW11_MPLS_TC };
445 if ((wc & OFPFW11_MPLS_ALL) != OFPFW11_MPLS_ALL) {
446 /* MPLS not supported. */
447 return OFPERR_OFPBMC_BAD_TAG;
451 if (match->metadata_mask != htonll(UINT64_MAX)) {
452 cls_rule_set_metadata_masked(rule, match->metadata,
453 ~match->metadata_mask);
459 /* Convert 'rule' into the OpenFlow 1.1 match structure 'match'. */
461 ofputil_cls_rule_to_ofp11_match(const struct cls_rule *rule,
462 struct ofp11_match *match)
467 memset(match, 0, sizeof *match);
468 match->omh.type = htons(OFPMT_STANDARD);
469 match->omh.length = htons(OFPMT11_STANDARD_LENGTH);
471 if (!rule->wc.in_port_mask) {
472 wc |= OFPFW11_IN_PORT;
474 match->in_port = ofputil_port_to_ofp11(rule->flow.in_port);
477 memcpy(match->dl_src, rule->flow.dl_src, ETH_ADDR_LEN);
478 for (i = 0; i < ETH_ADDR_LEN; i++) {
479 match->dl_src_mask[i] = ~rule->wc.dl_src_mask[i];
482 memcpy(match->dl_dst, rule->flow.dl_dst, ETH_ADDR_LEN);
483 for (i = 0; i < ETH_ADDR_LEN; i++) {
484 match->dl_dst_mask[i] = ~rule->wc.dl_dst_mask[i];
487 if (rule->wc.vlan_tci_mask == htons(0)) {
488 wc |= OFPFW11_DL_VLAN | OFPFW11_DL_VLAN_PCP;
489 } else if (rule->wc.vlan_tci_mask & htons(VLAN_CFI)
490 && !(rule->flow.vlan_tci & htons(VLAN_CFI))) {
491 match->dl_vlan = htons(OFPVID11_NONE);
492 wc |= OFPFW11_DL_VLAN_PCP;
494 if (!(rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) {
495 match->dl_vlan = htons(OFPVID11_ANY);
497 match->dl_vlan = htons(vlan_tci_to_vid(rule->flow.vlan_tci));
500 if (!(rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK))) {
501 wc |= OFPFW11_DL_VLAN_PCP;
503 match->dl_vlan_pcp = vlan_tci_to_pcp(rule->flow.vlan_tci);
507 if (!rule->wc.dl_type_mask) {
508 wc |= OFPFW11_DL_TYPE;
510 match->dl_type = ofputil_dl_type_to_openflow(rule->flow.dl_type);
513 if (!(rule->wc.nw_tos_mask & IP_DSCP_MASK)) {
514 wc |= OFPFW11_NW_TOS;
516 match->nw_tos = rule->flow.nw_tos & IP_DSCP_MASK;
519 if (!rule->wc.nw_proto_mask) {
520 wc |= OFPFW11_NW_PROTO;
522 match->nw_proto = rule->flow.nw_proto;
525 match->nw_src = rule->flow.nw_src;
526 match->nw_src_mask = ~rule->wc.nw_src_mask;
527 match->nw_dst = rule->flow.nw_dst;
528 match->nw_dst_mask = ~rule->wc.nw_dst_mask;
530 if (!rule->wc.tp_src_mask) {
531 wc |= OFPFW11_TP_SRC;
533 match->tp_src = rule->flow.tp_src;
536 if (!rule->wc.tp_dst_mask) {
537 wc |= OFPFW11_TP_DST;
539 match->tp_dst = rule->flow.tp_dst;
542 /* MPLS not supported. */
543 wc |= OFPFW11_MPLS_LABEL;
544 wc |= OFPFW11_MPLS_TC;
546 match->metadata = rule->flow.metadata;
547 match->metadata_mask = ~rule->wc.metadata_mask;
549 match->wildcards = htonl(wc);
552 /* Given a 'dl_type' value in the format used in struct flow, returns the
553 * corresponding 'dl_type' value for use in an ofp10_match or ofp11_match
556 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type)
558 return (flow_dl_type == htons(FLOW_DL_TYPE_NONE)
559 ? htons(OFP_DL_TYPE_NOT_ETH_TYPE)
563 /* Given a 'dl_type' value in the format used in an ofp10_match or ofp11_match
564 * structure, returns the corresponding 'dl_type' value for use in struct
567 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type)
569 return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
570 ? htons(FLOW_DL_TYPE_NONE)
576 struct proto_abbrev {
577 enum ofputil_protocol protocol;
581 /* Most users really don't care about some of the differences between
582 * protocols. These abbreviations help with that. */
583 static const struct proto_abbrev proto_abbrevs[] = {
584 { OFPUTIL_P_ANY, "any" },
585 { OFPUTIL_P_OF10_ANY, "OpenFlow10" },
586 { OFPUTIL_P_NXM_ANY, "NXM" },
588 #define N_PROTO_ABBREVS ARRAY_SIZE(proto_abbrevs)
590 enum ofputil_protocol ofputil_flow_dump_protocols[] = {
594 size_t ofputil_n_flow_dump_protocols = ARRAY_SIZE(ofputil_flow_dump_protocols);
596 /* Returns the ofputil_protocol that is initially in effect on an OpenFlow
597 * connection that has negotiated the given 'version'. 'version' should
598 * normally be an 8-bit OpenFlow version identifier (e.g. 0x01 for OpenFlow
599 * 1.0, 0x02 for OpenFlow 1.1). Returns 0 if 'version' is not supported or
600 * outside the valid range. */
601 enum ofputil_protocol
602 ofputil_protocol_from_ofp_version(enum ofp_version version)
606 return OFPUTIL_P_OF10;
608 return OFPUTIL_P_OF12;
615 /* Returns the OpenFlow protocol version number (e.g. OFP10_VERSION,
616 * OFP11_VERSION or OFP12_VERSION) that corresponds to 'protocol'. */
618 ofputil_protocol_to_ofp_version(enum ofputil_protocol protocol)
622 case OFPUTIL_P_OF10_TID:
624 case OFPUTIL_P_NXM_TID:
625 return OFP10_VERSION;
627 return OFP12_VERSION;
633 /* Returns true if 'protocol' is a single OFPUTIL_P_* value, false
636 ofputil_protocol_is_valid(enum ofputil_protocol protocol)
638 return protocol & OFPUTIL_P_ANY && is_pow2(protocol);
641 /* Returns the equivalent of 'protocol' with the Nicira flow_mod_table_id
642 * extension turned on or off if 'enable' is true or false, respectively.
644 * This extension is only useful for protocols whose "standard" version does
645 * not allow specific tables to be modified. In particular, this is true of
646 * OpenFlow 1.0. In later versions of OpenFlow, a flow_mod request always
647 * specifies a table ID and so there is no need for such an extension. When
648 * 'protocol' is such a protocol that doesn't need a flow_mod_table_id
649 * extension, this function just returns its 'protocol' argument unchanged
650 * regardless of the value of 'enable'. */
651 enum ofputil_protocol
652 ofputil_protocol_set_tid(enum ofputil_protocol protocol, bool enable)
656 case OFPUTIL_P_OF10_TID:
657 return enable ? OFPUTIL_P_OF10_TID : OFPUTIL_P_OF10;
660 case OFPUTIL_P_NXM_TID:
661 return enable ? OFPUTIL_P_NXM_TID : OFPUTIL_P_NXM;
664 return OFPUTIL_P_OF12;
671 /* Returns the "base" version of 'protocol'. That is, if 'protocol' includes
672 * some extension to a standard protocol version, the return value is the
673 * standard version of that protocol without any extension. If 'protocol' is a
674 * standard protocol version, returns 'protocol' unchanged. */
675 enum ofputil_protocol
676 ofputil_protocol_to_base(enum ofputil_protocol protocol)
678 return ofputil_protocol_set_tid(protocol, false);
681 /* Returns 'new_base' with any extensions taken from 'cur'. */
682 enum ofputil_protocol
683 ofputil_protocol_set_base(enum ofputil_protocol cur,
684 enum ofputil_protocol new_base)
686 bool tid = (cur & OFPUTIL_P_TID) != 0;
690 case OFPUTIL_P_OF10_TID:
691 return ofputil_protocol_set_tid(OFPUTIL_P_OF10, tid);
694 case OFPUTIL_P_NXM_TID:
695 return ofputil_protocol_set_tid(OFPUTIL_P_NXM, tid);
698 return ofputil_protocol_set_tid(OFPUTIL_P_OF12, tid);
705 /* Returns a string form of 'protocol', if a simple form exists (that is, if
706 * 'protocol' is either a single protocol or it is a combination of protocols
707 * that have a single abbreviation). Otherwise, returns NULL. */
709 ofputil_protocol_to_string(enum ofputil_protocol protocol)
711 const struct proto_abbrev *p;
713 /* Use a "switch" statement for single-bit names so that we get a compiler
714 * warning if we forget any. */
717 return "NXM-table_id";
719 case OFPUTIL_P_NXM_TID:
720 return "NXM+table_id";
723 return "OpenFlow10-table_id";
725 case OFPUTIL_P_OF10_TID:
726 return "OpenFlow10+table_id";
732 /* Check abbreviations. */
733 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
734 if (protocol == p->protocol) {
742 /* Returns a string that represents 'protocols'. The return value might be a
743 * comma-separated list if 'protocols' doesn't have a simple name. The return
744 * value is "none" if 'protocols' is 0.
746 * The caller must free the returned string (with free()). */
748 ofputil_protocols_to_string(enum ofputil_protocol protocols)
752 assert(!(protocols & ~OFPUTIL_P_ANY));
753 if (protocols == 0) {
754 return xstrdup("none");
759 const struct proto_abbrev *p;
763 ds_put_char(&s, ',');
766 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
767 if ((protocols & p->protocol) == p->protocol) {
768 ds_put_cstr(&s, p->name);
769 protocols &= ~p->protocol;
774 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
775 enum ofputil_protocol bit = 1u << i;
777 if (protocols & bit) {
778 ds_put_cstr(&s, ofputil_protocol_to_string(bit));
787 return ds_steal_cstr(&s);
790 static enum ofputil_protocol
791 ofputil_protocol_from_string__(const char *s, size_t n)
793 const struct proto_abbrev *p;
796 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
797 enum ofputil_protocol bit = 1u << i;
798 const char *name = ofputil_protocol_to_string(bit);
800 if (name && n == strlen(name) && !strncasecmp(s, name, n)) {
805 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
806 if (n == strlen(p->name) && !strncasecmp(s, p->name, n)) {
814 /* Returns the nonempty set of protocols represented by 's', which can be a
815 * single protocol name or abbreviation or a comma-separated list of them.
817 * Aborts the program with an error message if 's' is invalid. */
818 enum ofputil_protocol
819 ofputil_protocols_from_string(const char *s)
821 const char *orig_s = s;
822 enum ofputil_protocol protocols;
826 enum ofputil_protocol p;
835 p = ofputil_protocol_from_string__(s, n);
837 ovs_fatal(0, "%.*s: unknown flow protocol", (int) n, s);
845 ovs_fatal(0, "%s: no flow protocol specified", orig_s);
851 ofputil_packet_in_format_is_valid(enum nx_packet_in_format packet_in_format)
853 switch (packet_in_format) {
854 case NXPIF_OPENFLOW10:
863 ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format)
865 switch (packet_in_format) {
866 case NXPIF_OPENFLOW10:
876 ofputil_packet_in_format_from_string(const char *s)
878 return (!strcmp(s, "openflow10") ? NXPIF_OPENFLOW10
879 : !strcmp(s, "nxm") ? NXPIF_NXM
884 regs_fully_wildcarded(const struct flow_wildcards *wc)
888 for (i = 0; i < FLOW_N_REGS; i++) {
889 if (wc->reg_masks[i] != 0) {
896 /* Returns a bit-mask of ofputil_protocols that can be used for sending 'rule'
897 * to a switch (e.g. to add or remove a flow). Only NXM can handle tunnel IDs,
898 * registers, or fixing the Ethernet multicast bit. Otherwise, it's better to
899 * use OpenFlow 1.0 protocol for backward compatibility. */
900 enum ofputil_protocol
901 ofputil_usable_protocols(const struct cls_rule *rule)
903 const struct flow_wildcards *wc = &rule->wc;
905 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 17);
907 /* NXM and OF1.1+ supports bitwise matching on ethernet addresses. */
908 if (!eth_mask_is_exact(wc->dl_src_mask)
909 && !eth_addr_is_zero(wc->dl_src_mask)) {
910 return OFPUTIL_P_NXM_ANY;
912 if (!eth_mask_is_exact(wc->dl_dst_mask)
913 && !eth_addr_is_zero(wc->dl_dst_mask)) {
914 return OFPUTIL_P_NXM_ANY;
917 /* NXM and OF1.1+ support matching metadata. */
918 if (wc->metadata_mask != htonll(0)) {
919 return OFPUTIL_P_NXM_ANY;
922 /* Only NXM supports matching ARP hardware addresses. */
923 if (!eth_addr_is_zero(wc->arp_sha_mask) ||
924 !eth_addr_is_zero(wc->arp_tha_mask)) {
925 return OFPUTIL_P_NXM_ANY;
928 /* Only NXM supports matching IPv6 traffic. */
929 if (rule->flow.dl_type == htons(ETH_TYPE_IPV6)) {
930 return OFPUTIL_P_NXM_ANY;
933 /* Only NXM supports matching registers. */
934 if (!regs_fully_wildcarded(wc)) {
935 return OFPUTIL_P_NXM_ANY;
938 /* Only NXM supports matching tun_id. */
939 if (wc->tun_id_mask != htonll(0)) {
940 return OFPUTIL_P_NXM_ANY;
943 /* Only NXM supports matching fragments. */
944 if (wc->nw_frag_mask) {
945 return OFPUTIL_P_NXM_ANY;
948 /* Only NXM supports matching IPv6 flow label. */
949 if (wc->ipv6_label_mask) {
950 return OFPUTIL_P_NXM_ANY;
953 /* Only NXM supports matching IP ECN bits. */
954 if (wc->nw_tos_mask & IP_ECN_MASK) {
955 return OFPUTIL_P_NXM_ANY;
958 /* Only NXM supports matching IP TTL/hop limit. */
959 if (wc->nw_ttl_mask) {
960 return OFPUTIL_P_NXM_ANY;
963 /* Only NXM supports non-CIDR IPv4 address masks. */
964 if (!ip_is_cidr(wc->nw_src_mask) || !ip_is_cidr(wc->nw_dst_mask)) {
965 return OFPUTIL_P_NXM_ANY;
968 /* Only NXM supports bitwise matching on transport port. */
969 if ((wc->tp_src_mask && wc->tp_src_mask != htons(UINT16_MAX)) ||
970 (wc->tp_dst_mask && wc->tp_dst_mask != htons(UINT16_MAX))) {
971 return OFPUTIL_P_NXM_ANY;
974 /* Other formats can express this rule. */
975 return OFPUTIL_P_ANY;
978 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
979 * protocol is 'current', at least partly transitions the protocol to 'want'.
980 * Stores in '*next' the protocol that will be in effect on the OpenFlow
981 * connection if the switch processes the returned message correctly. (If
982 * '*next != want' then the caller will have to iterate.)
984 * If 'current == want', returns NULL and stores 'current' in '*next'. */
986 ofputil_encode_set_protocol(enum ofputil_protocol current,
987 enum ofputil_protocol want,
988 enum ofputil_protocol *next)
990 enum ofputil_protocol cur_base, want_base;
991 bool cur_tid, want_tid;
993 cur_base = ofputil_protocol_to_base(current);
994 want_base = ofputil_protocol_to_base(want);
995 if (cur_base != want_base) {
996 *next = ofputil_protocol_set_base(current, want_base);
1000 return ofputil_encode_nx_set_flow_format(NXFF_NXM);
1002 case OFPUTIL_P_OF10:
1003 return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10);
1005 case OFPUTIL_P_OF12:
1006 return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW12);
1008 case OFPUTIL_P_OF10_TID:
1009 case OFPUTIL_P_NXM_TID:
1014 cur_tid = (current & OFPUTIL_P_TID) != 0;
1015 want_tid = (want & OFPUTIL_P_TID) != 0;
1016 if (cur_tid != want_tid) {
1017 *next = ofputil_protocol_set_tid(current, want_tid);
1018 return ofputil_make_flow_mod_table_id(want_tid);
1021 assert(current == want);
1027 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1028 * format to 'nxff'. */
1030 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff)
1032 struct nx_set_flow_format *sff;
1035 assert(ofputil_nx_flow_format_is_valid(nxff));
1037 msg = ofpraw_alloc(OFPRAW_NXT_SET_FLOW_FORMAT, OFP10_VERSION, 0);
1038 sff = ofpbuf_put_zeros(msg, sizeof *sff);
1039 sff->format = htonl(nxff);
1044 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1046 enum ofputil_protocol
1047 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format)
1049 switch (flow_format) {
1050 case NXFF_OPENFLOW10:
1051 return OFPUTIL_P_OF10;
1054 return OFPUTIL_P_NXM;
1056 case NXFF_OPENFLOW12:
1057 return OFPUTIL_P_OF12;
1064 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1066 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format)
1068 return ofputil_nx_flow_format_to_protocol(flow_format) != 0;
1071 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1074 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format)
1076 switch (flow_format) {
1077 case NXFF_OPENFLOW10:
1078 return "openflow10";
1081 case NXFF_OPENFLOW12:
1082 return "openflow12";
1089 ofputil_make_set_packet_in_format(enum nx_packet_in_format packet_in_format)
1091 struct nx_set_packet_in_format *spif;
1094 msg = ofpraw_alloc(OFPRAW_NXT_SET_PACKET_IN_FORMAT, OFP10_VERSION, 0);
1095 spif = ofpbuf_put_zeros(msg, sizeof *spif);
1096 spif->format = htonl(packet_in_format);
1101 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1102 * extension on or off (according to 'flow_mod_table_id'). */
1104 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
1106 struct nx_flow_mod_table_id *nfmti;
1109 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION, 0);
1110 nfmti = ofpbuf_put_zeros(msg, sizeof *nfmti);
1111 nfmti->set = flow_mod_table_id;
1115 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1116 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
1119 * Uses 'ofpacts' to store the abstract OFPACT_* version of 'oh''s actions.
1120 * The caller must initialize 'ofpacts' and retains ownership of it.
1121 * 'fm->ofpacts' will point into the 'ofpacts' buffer.
1123 * Does not validate the flow_mod actions. The caller should do that, with
1124 * ofpacts_check(). */
1126 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
1127 const struct ofp_header *oh,
1128 enum ofputil_protocol protocol,
1129 struct ofpbuf *ofpacts)
1135 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1136 raw = ofpraw_pull_assert(&b);
1137 if (raw == OFPRAW_OFPT11_FLOW_MOD) {
1138 /* Standard OpenFlow 1.1 flow_mod. */
1139 const struct ofp11_flow_mod *ofm;
1142 ofm = ofpbuf_pull(&b, sizeof *ofm);
1144 error = ofputil_pull_ofp11_match(&b, ntohs(ofm->priority), &fm->cr,
1150 error = ofpacts_pull_openflow11_instructions(&b, b.size, ofpacts);
1155 /* Translate the message. */
1156 if (ofm->command == OFPFC_ADD) {
1157 fm->cookie = htonll(0);
1158 fm->cookie_mask = htonll(0);
1159 fm->new_cookie = ofm->cookie;
1162 fm->cookie = ofm->cookie;
1163 fm->cookie_mask = ofm->cookie_mask;
1164 fm->new_cookie = htonll(UINT64_MAX);
1166 fm->command = ofm->command;
1167 fm->table_id = ofm->table_id;
1168 fm->idle_timeout = ntohs(ofm->idle_timeout);
1169 fm->hard_timeout = ntohs(ofm->hard_timeout);
1170 fm->buffer_id = ntohl(ofm->buffer_id);
1171 error = ofputil_port_from_ofp11(ofm->out_port, &fm->out_port);
1175 if (ofm->out_group != htonl(OFPG_ANY)) {
1176 return OFPERR_NXFMFC_GROUPS_NOT_SUPPORTED;
1178 fm->flags = ntohs(ofm->flags);
1180 if (raw == OFPRAW_OFPT10_FLOW_MOD) {
1181 /* Standard OpenFlow 1.0 flow_mod. */
1182 const struct ofp10_flow_mod *ofm;
1186 /* Get the ofp10_flow_mod. */
1187 ofm = ofpbuf_pull(&b, sizeof *ofm);
1189 /* Set priority based on original wildcards. Normally we'd allow
1190 * ofputil_cls_rule_from_match() to do this for us, but
1191 * ofputil_normalize_rule() can put wildcards where the original
1192 * flow didn't have them. */
1193 priority = ntohs(ofm->priority);
1194 if (!(ofm->match.wildcards & htonl(OFPFW10_ALL))) {
1195 priority = UINT16_MAX;
1198 /* Translate the rule. */
1199 ofputil_cls_rule_from_ofp10_match(&ofm->match, priority, &fm->cr);
1200 ofputil_normalize_rule(&fm->cr);
1202 /* Now get the actions. */
1203 error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1208 /* Translate the message. */
1209 command = ntohs(ofm->command);
1210 fm->cookie = htonll(0);
1211 fm->cookie_mask = htonll(0);
1212 fm->new_cookie = ofm->cookie;
1213 fm->idle_timeout = ntohs(ofm->idle_timeout);
1214 fm->hard_timeout = ntohs(ofm->hard_timeout);
1215 fm->buffer_id = ntohl(ofm->buffer_id);
1216 fm->out_port = ntohs(ofm->out_port);
1217 fm->flags = ntohs(ofm->flags);
1218 } else if (raw == OFPRAW_NXT_FLOW_MOD) {
1219 /* Nicira extended flow_mod. */
1220 const struct nx_flow_mod *nfm;
1223 /* Dissect the message. */
1224 nfm = ofpbuf_pull(&b, sizeof *nfm);
1225 error = nx_pull_match(&b, ntohs(nfm->match_len), ntohs(nfm->priority),
1226 &fm->cr, &fm->cookie, &fm->cookie_mask);
1230 error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1235 /* Translate the message. */
1236 command = ntohs(nfm->command);
1237 if ((command & 0xff) == OFPFC_ADD && fm->cookie_mask) {
1238 /* Flow additions may only set a new cookie, not match an
1239 * existing cookie. */
1240 return OFPERR_NXBRC_NXM_INVALID;
1242 fm->new_cookie = nfm->cookie;
1243 fm->idle_timeout = ntohs(nfm->idle_timeout);
1244 fm->hard_timeout = ntohs(nfm->hard_timeout);
1245 fm->buffer_id = ntohl(nfm->buffer_id);
1246 fm->out_port = ntohs(nfm->out_port);
1247 fm->flags = ntohs(nfm->flags);
1252 if (protocol & OFPUTIL_P_TID) {
1253 fm->command = command & 0xff;
1254 fm->table_id = command >> 8;
1256 fm->command = command;
1257 fm->table_id = 0xff;
1261 fm->ofpacts = ofpacts->data;
1262 fm->ofpacts_len = ofpacts->size;
1268 ofputil_tid_command(const struct ofputil_flow_mod *fm,
1269 enum ofputil_protocol protocol)
1271 return htons(protocol & OFPUTIL_P_TID
1272 ? (fm->command & 0xff) | (fm->table_id << 8)
1276 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
1277 * 'protocol' and returns the message. */
1279 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
1280 enum ofputil_protocol protocol)
1285 case OFPUTIL_P_OF12: {
1286 struct ofp11_flow_mod *ofm;
1288 msg = ofpraw_alloc(OFPRAW_OFPT11_FLOW_MOD, OFP12_VERSION,
1289 NXM_TYPICAL_LEN + fm->ofpacts_len);
1290 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
1291 ofm->cookie = fm->new_cookie;
1292 ofm->cookie_mask = fm->cookie_mask;
1293 ofm->table_id = fm->table_id;
1294 ofm->command = fm->command;
1295 ofm->idle_timeout = htons(fm->idle_timeout);
1296 ofm->hard_timeout = htons(fm->hard_timeout);
1297 ofm->priority = htons(fm->cr.priority);
1298 ofm->buffer_id = htonl(fm->buffer_id);
1299 ofm->out_port = ofputil_port_to_ofp11(fm->out_port);
1300 ofm->out_group = htonl(OFPG11_ANY);
1301 ofm->flags = htons(fm->flags);
1302 oxm_put_match(msg, &fm->cr);
1303 ofpacts_put_openflow11_instructions(fm->ofpacts, fm->ofpacts_len, msg);
1307 case OFPUTIL_P_OF10:
1308 case OFPUTIL_P_OF10_TID: {
1309 struct ofp10_flow_mod *ofm;
1311 msg = ofpraw_alloc(OFPRAW_OFPT10_FLOW_MOD, OFP10_VERSION,
1313 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
1314 ofputil_cls_rule_to_ofp10_match(&fm->cr, &ofm->match);
1315 ofm->cookie = fm->new_cookie;
1316 ofm->command = ofputil_tid_command(fm, protocol);
1317 ofm->idle_timeout = htons(fm->idle_timeout);
1318 ofm->hard_timeout = htons(fm->hard_timeout);
1319 ofm->priority = htons(fm->cr.priority);
1320 ofm->buffer_id = htonl(fm->buffer_id);
1321 ofm->out_port = htons(fm->out_port);
1322 ofm->flags = htons(fm->flags);
1323 ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
1328 case OFPUTIL_P_NXM_TID: {
1329 struct nx_flow_mod *nfm;
1332 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD, OFP10_VERSION,
1333 NXM_TYPICAL_LEN + fm->ofpacts_len);
1334 nfm = ofpbuf_put_zeros(msg, sizeof *nfm);
1335 nfm->command = ofputil_tid_command(fm, protocol);
1336 nfm->cookie = fm->new_cookie;
1337 match_len = nx_put_match(msg, &fm->cr, fm->cookie, fm->cookie_mask);
1339 nfm->idle_timeout = htons(fm->idle_timeout);
1340 nfm->hard_timeout = htons(fm->hard_timeout);
1341 nfm->priority = htons(fm->cr.priority);
1342 nfm->buffer_id = htonl(fm->buffer_id);
1343 nfm->out_port = htons(fm->out_port);
1344 nfm->flags = htons(fm->flags);
1345 nfm->match_len = htons(match_len);
1346 ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
1354 ofpmsg_update_length(msg);
1358 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1359 * send all of the 'n_fm's flow table modification requests in 'fms', and a
1360 * 0-bit for each protocol that is inadequate.
1362 * (The return value will have at least one 1-bit.) */
1363 enum ofputil_protocol
1364 ofputil_flow_mod_usable_protocols(const struct ofputil_flow_mod *fms,
1367 enum ofputil_protocol usable_protocols;
1370 usable_protocols = OFPUTIL_P_ANY;
1371 for (i = 0; i < n_fms; i++) {
1372 const struct ofputil_flow_mod *fm = &fms[i];
1374 usable_protocols &= ofputil_usable_protocols(&fm->cr);
1375 if (fm->table_id != 0xff) {
1376 usable_protocols &= OFPUTIL_P_TID;
1379 /* Matching of the cookie is only supported through NXM. */
1380 if (fm->cookie_mask != htonll(0)) {
1381 usable_protocols &= OFPUTIL_P_NXM_ANY;
1384 assert(usable_protocols);
1386 return usable_protocols;
1390 ofputil_decode_ofpst10_flow_request(struct ofputil_flow_stats_request *fsr,
1391 const struct ofp10_flow_stats_request *ofsr,
1394 fsr->aggregate = aggregate;
1395 ofputil_cls_rule_from_ofp10_match(&ofsr->match, 0, &fsr->match);
1396 fsr->out_port = ntohs(ofsr->out_port);
1397 fsr->table_id = ofsr->table_id;
1398 fsr->cookie = fsr->cookie_mask = htonll(0);
1404 ofputil_decode_ofpst11_flow_request(struct ofputil_flow_stats_request *fsr,
1405 struct ofpbuf *b, bool aggregate)
1407 const struct ofp11_flow_stats_request *ofsr;
1410 ofsr = ofpbuf_pull(b, sizeof *ofsr);
1411 fsr->aggregate = aggregate;
1412 fsr->table_id = ofsr->table_id;
1413 error = ofputil_port_from_ofp11(ofsr->out_port, &fsr->out_port);
1417 if (ofsr->out_group != htonl(OFPG11_ANY)) {
1418 return OFPERR_NXFMFC_GROUPS_NOT_SUPPORTED;
1420 fsr->cookie = ofsr->cookie;
1421 fsr->cookie_mask = ofsr->cookie_mask;
1422 error = ofputil_pull_ofp11_match(b, 0, &fsr->match, NULL);
1431 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
1432 struct ofpbuf *b, bool aggregate)
1434 const struct nx_flow_stats_request *nfsr;
1437 nfsr = ofpbuf_pull(b, sizeof *nfsr);
1438 error = nx_pull_match(b, ntohs(nfsr->match_len), 0, &fsr->match,
1439 &fsr->cookie, &fsr->cookie_mask);
1444 return OFPERR_OFPBRC_BAD_LEN;
1447 fsr->aggregate = aggregate;
1448 fsr->out_port = ntohs(nfsr->out_port);
1449 fsr->table_id = nfsr->table_id;
1454 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
1455 * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
1456 * successful, otherwise an OpenFlow error code. */
1458 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
1459 const struct ofp_header *oh)
1464 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1465 raw = ofpraw_pull_assert(&b);
1466 switch ((int) raw) {
1467 case OFPRAW_OFPST10_FLOW_REQUEST:
1468 return ofputil_decode_ofpst10_flow_request(fsr, b.data, false);
1470 case OFPRAW_OFPST10_AGGREGATE_REQUEST:
1471 return ofputil_decode_ofpst10_flow_request(fsr, b.data, true);
1473 case OFPRAW_OFPST11_FLOW_REQUEST:
1474 return ofputil_decode_ofpst11_flow_request(fsr, &b, false);
1476 case OFPRAW_OFPST11_AGGREGATE_REQUEST:
1477 return ofputil_decode_ofpst11_flow_request(fsr, &b, true);
1479 case OFPRAW_NXST_FLOW_REQUEST:
1480 return ofputil_decode_nxst_flow_request(fsr, &b, false);
1482 case OFPRAW_NXST_AGGREGATE_REQUEST:
1483 return ofputil_decode_nxst_flow_request(fsr, &b, true);
1486 /* Hey, the caller lied. */
1491 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
1492 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
1493 * 'protocol', and returns the message. */
1495 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
1496 enum ofputil_protocol protocol)
1502 case OFPUTIL_P_OF12: {
1503 struct ofp11_flow_stats_request *ofsr;
1505 raw = (fsr->aggregate
1506 ? OFPRAW_OFPST11_AGGREGATE_REQUEST
1507 : OFPRAW_OFPST11_FLOW_REQUEST);
1508 msg = ofpraw_alloc(raw, OFP12_VERSION, NXM_TYPICAL_LEN);
1509 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
1510 ofsr->table_id = fsr->table_id;
1511 ofsr->out_port = ofputil_port_to_ofp11(fsr->out_port);
1512 ofsr->out_group = htonl(OFPG11_ANY);
1513 ofsr->cookie = fsr->cookie;
1514 ofsr->cookie_mask = fsr->cookie_mask;
1515 oxm_put_match(msg, &fsr->match);
1519 case OFPUTIL_P_OF10:
1520 case OFPUTIL_P_OF10_TID: {
1521 struct ofp10_flow_stats_request *ofsr;
1523 raw = (fsr->aggregate
1524 ? OFPRAW_OFPST10_AGGREGATE_REQUEST
1525 : OFPRAW_OFPST10_FLOW_REQUEST);
1526 msg = ofpraw_alloc(raw, OFP10_VERSION, 0);
1527 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
1528 ofputil_cls_rule_to_ofp10_match(&fsr->match, &ofsr->match);
1529 ofsr->table_id = fsr->table_id;
1530 ofsr->out_port = htons(fsr->out_port);
1535 case OFPUTIL_P_NXM_TID: {
1536 struct nx_flow_stats_request *nfsr;
1539 raw = (fsr->aggregate
1540 ? OFPRAW_NXST_AGGREGATE_REQUEST
1541 : OFPRAW_NXST_FLOW_REQUEST);
1542 msg = ofpraw_alloc(raw, OFP10_VERSION, NXM_TYPICAL_LEN);
1543 ofpbuf_put_zeros(msg, sizeof *nfsr);
1544 match_len = nx_put_match(msg, &fsr->match,
1545 fsr->cookie, fsr->cookie_mask);
1548 nfsr->out_port = htons(fsr->out_port);
1549 nfsr->match_len = htons(match_len);
1550 nfsr->table_id = fsr->table_id;
1561 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1562 * accurately encode 'fsr', and a 0-bit for each protocol that is inadequate.
1564 * (The return value will have at least one 1-bit.) */
1565 enum ofputil_protocol
1566 ofputil_flow_stats_request_usable_protocols(
1567 const struct ofputil_flow_stats_request *fsr)
1569 enum ofputil_protocol usable_protocols;
1571 usable_protocols = ofputil_usable_protocols(&fsr->match);
1572 if (fsr->cookie_mask != htonll(0)) {
1573 usable_protocols &= OFPUTIL_P_NXM_ANY;
1575 return usable_protocols;
1578 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
1579 * ofputil_flow_stats in 'fs'.
1581 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
1582 * OpenFlow message. Calling this function multiple times for a single 'msg'
1583 * iterates through the replies. The caller must initially leave 'msg''s layer
1584 * pointers null and not modify them between calls.
1586 * Most switches don't send the values needed to populate fs->idle_age and
1587 * fs->hard_age, so those members will usually be set to 0. If the switch from
1588 * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
1589 * 'flow_age_extension' as true so that the contents of 'msg' determine the
1590 * 'idle_age' and 'hard_age' members in 'fs'.
1592 * Uses 'ofpacts' to store the abstract OFPACT_* version of the flow stats
1593 * reply's actions. The caller must initialize 'ofpacts' and retains ownership
1594 * of it. 'fs->ofpacts' will point into the 'ofpacts' buffer.
1596 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1597 * otherwise a positive errno value. */
1599 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
1601 bool flow_age_extension,
1602 struct ofpbuf *ofpacts)
1608 ? ofpraw_decode(&raw, msg->l2)
1609 : ofpraw_pull(&raw, msg));
1616 } else if (raw == OFPRAW_OFPST11_FLOW_REPLY) {
1617 const struct ofp11_flow_stats *ofs;
1619 uint16_t padded_match_len;
1621 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
1623 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
1624 "bytes at end", msg->size);
1628 length = ntohs(ofs->length);
1629 if (length < sizeof *ofs) {
1630 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
1631 "length %zu", length);
1635 if (ofputil_pull_ofp11_match(msg, ntohs(ofs->priority), &fs->rule,
1636 &padded_match_len)) {
1637 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad match");
1641 if (ofpacts_pull_openflow11_instructions(msg, length - sizeof *ofs -
1642 padded_match_len, ofpacts)) {
1643 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad instructions");
1647 fs->table_id = ofs->table_id;
1648 fs->duration_sec = ntohl(ofs->duration_sec);
1649 fs->duration_nsec = ntohl(ofs->duration_nsec);
1650 fs->idle_timeout = ntohs(ofs->idle_timeout);
1651 fs->hard_timeout = ntohs(ofs->hard_timeout);
1654 fs->cookie = ofs->cookie;
1655 fs->packet_count = ntohll(ofs->packet_count);
1656 fs->byte_count = ntohll(ofs->byte_count);
1657 } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
1658 const struct ofp10_flow_stats *ofs;
1661 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
1663 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
1664 "bytes at end", msg->size);
1668 length = ntohs(ofs->length);
1669 if (length < sizeof *ofs) {
1670 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
1671 "length %zu", length);
1675 if (ofpacts_pull_openflow10(msg, length - sizeof *ofs, ofpacts)) {
1679 fs->cookie = get_32aligned_be64(&ofs->cookie);
1680 ofputil_cls_rule_from_ofp10_match(&ofs->match, ntohs(ofs->priority),
1682 fs->table_id = ofs->table_id;
1683 fs->duration_sec = ntohl(ofs->duration_sec);
1684 fs->duration_nsec = ntohl(ofs->duration_nsec);
1685 fs->idle_timeout = ntohs(ofs->idle_timeout);
1686 fs->hard_timeout = ntohs(ofs->hard_timeout);
1689 fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
1690 fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
1691 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
1692 const struct nx_flow_stats *nfs;
1693 size_t match_len, actions_len, length;
1695 nfs = ofpbuf_try_pull(msg, sizeof *nfs);
1697 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
1698 "bytes at end", msg->size);
1702 length = ntohs(nfs->length);
1703 match_len = ntohs(nfs->match_len);
1704 if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
1705 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
1706 "claims invalid length %zu", match_len, length);
1709 if (nx_pull_match(msg, match_len, ntohs(nfs->priority), &fs->rule,
1714 actions_len = length - sizeof *nfs - ROUND_UP(match_len, 8);
1715 if (ofpacts_pull_openflow10(msg, actions_len, ofpacts)) {
1719 fs->cookie = nfs->cookie;
1720 fs->table_id = nfs->table_id;
1721 fs->duration_sec = ntohl(nfs->duration_sec);
1722 fs->duration_nsec = ntohl(nfs->duration_nsec);
1723 fs->idle_timeout = ntohs(nfs->idle_timeout);
1724 fs->hard_timeout = ntohs(nfs->hard_timeout);
1727 if (flow_age_extension) {
1728 if (nfs->idle_age) {
1729 fs->idle_age = ntohs(nfs->idle_age) - 1;
1731 if (nfs->hard_age) {
1732 fs->hard_age = ntohs(nfs->hard_age) - 1;
1735 fs->packet_count = ntohll(nfs->packet_count);
1736 fs->byte_count = ntohll(nfs->byte_count);
1741 fs->ofpacts = ofpacts->data;
1742 fs->ofpacts_len = ofpacts->size;
1747 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
1749 * We use this in situations where OVS internally uses UINT64_MAX to mean
1750 * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
1752 unknown_to_zero(uint64_t count)
1754 return count != UINT64_MAX ? count : 0;
1757 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
1758 * those already present in the list of ofpbufs in 'replies'. 'replies' should
1759 * have been initialized with ofputil_start_stats_reply(). */
1761 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
1762 struct list *replies)
1764 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
1765 size_t start_ofs = reply->size;
1768 ofpraw_decode_partial(&raw, reply->data, reply->size);
1769 if (raw == OFPRAW_OFPST11_FLOW_REPLY) {
1770 struct ofp11_flow_stats *ofs;
1772 ofpbuf_put_uninit(reply, sizeof *ofs);
1773 oxm_put_match(reply, &fs->rule);
1774 ofpacts_put_openflow11_instructions(fs->ofpacts, fs->ofpacts_len,
1777 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
1778 ofs->length = htons(reply->size - start_ofs);
1779 ofs->table_id = fs->table_id;
1781 ofs->duration_sec = htonl(fs->duration_sec);
1782 ofs->duration_nsec = htonl(fs->duration_nsec);
1783 ofs->priority = htons(fs->rule.priority);
1784 ofs->idle_timeout = htons(fs->idle_timeout);
1785 ofs->hard_timeout = htons(fs->hard_timeout);
1786 memset(ofs->pad2, 0, sizeof ofs->pad2);
1787 ofs->cookie = fs->cookie;
1788 ofs->packet_count = htonll(unknown_to_zero(fs->packet_count));
1789 ofs->byte_count = htonll(unknown_to_zero(fs->byte_count));
1790 } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
1791 struct ofp10_flow_stats *ofs;
1793 ofpbuf_put_uninit(reply, sizeof *ofs);
1794 ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
1796 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
1797 ofs->length = htons(reply->size - start_ofs);
1798 ofs->table_id = fs->table_id;
1800 ofputil_cls_rule_to_ofp10_match(&fs->rule, &ofs->match);
1801 ofs->duration_sec = htonl(fs->duration_sec);
1802 ofs->duration_nsec = htonl(fs->duration_nsec);
1803 ofs->priority = htons(fs->rule.priority);
1804 ofs->idle_timeout = htons(fs->idle_timeout);
1805 ofs->hard_timeout = htons(fs->hard_timeout);
1806 memset(ofs->pad2, 0, sizeof ofs->pad2);
1807 put_32aligned_be64(&ofs->cookie, fs->cookie);
1808 put_32aligned_be64(&ofs->packet_count,
1809 htonll(unknown_to_zero(fs->packet_count)));
1810 put_32aligned_be64(&ofs->byte_count,
1811 htonll(unknown_to_zero(fs->byte_count)));
1812 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
1813 struct nx_flow_stats *nfs;
1816 ofpbuf_put_uninit(reply, sizeof *nfs);
1817 match_len = nx_put_match(reply, &fs->rule, 0, 0);
1818 ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
1820 nfs = ofpbuf_at_assert(reply, start_ofs, sizeof *nfs);
1821 nfs->length = htons(reply->size - start_ofs);
1822 nfs->table_id = fs->table_id;
1824 nfs->duration_sec = htonl(fs->duration_sec);
1825 nfs->duration_nsec = htonl(fs->duration_nsec);
1826 nfs->priority = htons(fs->rule.priority);
1827 nfs->idle_timeout = htons(fs->idle_timeout);
1828 nfs->hard_timeout = htons(fs->hard_timeout);
1829 nfs->idle_age = htons(fs->idle_age < 0 ? 0
1830 : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
1832 nfs->hard_age = htons(fs->hard_age < 0 ? 0
1833 : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
1835 nfs->match_len = htons(match_len);
1836 nfs->cookie = fs->cookie;
1837 nfs->packet_count = htonll(fs->packet_count);
1838 nfs->byte_count = htonll(fs->byte_count);
1843 ofpmp_postappend(replies, start_ofs);
1846 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
1847 * NXST_AGGREGATE reply matching 'request', and returns the message. */
1849 ofputil_encode_aggregate_stats_reply(
1850 const struct ofputil_aggregate_stats *stats,
1851 const struct ofp_header *request)
1853 struct ofp_aggregate_stats_reply *asr;
1854 uint64_t packet_count;
1855 uint64_t byte_count;
1859 ofpraw_decode(&raw, request);
1860 if (raw == OFPRAW_OFPST10_AGGREGATE_REQUEST) {
1861 packet_count = unknown_to_zero(stats->packet_count);
1862 byte_count = unknown_to_zero(stats->byte_count);
1864 packet_count = stats->packet_count;
1865 byte_count = stats->byte_count;
1868 msg = ofpraw_alloc_stats_reply(request, 0);
1869 asr = ofpbuf_put_zeros(msg, sizeof *asr);
1870 put_32aligned_be64(&asr->packet_count, htonll(packet_count));
1871 put_32aligned_be64(&asr->byte_count, htonll(byte_count));
1872 asr->flow_count = htonl(stats->flow_count);
1878 ofputil_decode_aggregate_stats_reply(struct ofputil_aggregate_stats *stats,
1879 const struct ofp_header *reply)
1881 struct ofp_aggregate_stats_reply *asr;
1884 ofpbuf_use_const(&msg, reply, ntohs(reply->length));
1885 ofpraw_pull_assert(&msg);
1888 stats->packet_count = ntohll(get_32aligned_be64(&asr->packet_count));
1889 stats->byte_count = ntohll(get_32aligned_be64(&asr->byte_count));
1890 stats->flow_count = ntohl(asr->flow_count);
1895 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
1896 * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
1897 * an OpenFlow error code. */
1899 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
1900 const struct ofp_header *oh)
1905 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1906 raw = ofpraw_pull_assert(&b);
1907 if (raw == OFPRAW_OFPT11_FLOW_REMOVED) {
1908 const struct ofp12_flow_removed *ofr;
1911 ofr = ofpbuf_pull(&b, sizeof *ofr);
1913 error = ofputil_pull_ofp11_match(&b, ntohs(ofr->priority),
1919 fr->cookie = ofr->cookie;
1920 fr->reason = ofr->reason;
1921 /* XXX: ofr->table_id is ignored */
1922 fr->duration_sec = ntohl(ofr->duration_sec);
1923 fr->duration_nsec = ntohl(ofr->duration_nsec);
1924 fr->idle_timeout = ntohs(ofr->idle_timeout);
1925 fr->hard_timeout = ntohs(ofr->hard_timeout);
1926 fr->packet_count = ntohll(ofr->packet_count);
1927 fr->byte_count = ntohll(ofr->byte_count);
1928 } else if (raw == OFPRAW_OFPT10_FLOW_REMOVED) {
1929 const struct ofp_flow_removed *ofr;
1931 ofr = ofpbuf_pull(&b, sizeof *ofr);
1933 ofputil_cls_rule_from_ofp10_match(&ofr->match, ntohs(ofr->priority),
1935 fr->cookie = ofr->cookie;
1936 fr->reason = ofr->reason;
1937 fr->duration_sec = ntohl(ofr->duration_sec);
1938 fr->duration_nsec = ntohl(ofr->duration_nsec);
1939 fr->idle_timeout = ntohs(ofr->idle_timeout);
1940 fr->hard_timeout = 0;
1941 fr->packet_count = ntohll(ofr->packet_count);
1942 fr->byte_count = ntohll(ofr->byte_count);
1943 } else if (raw == OFPRAW_NXT_FLOW_REMOVED) {
1944 struct nx_flow_removed *nfr;
1947 nfr = ofpbuf_pull(&b, sizeof *nfr);
1948 error = nx_pull_match(&b, ntohs(nfr->match_len), ntohs(nfr->priority),
1949 &fr->rule, NULL, NULL);
1954 return OFPERR_OFPBRC_BAD_LEN;
1957 fr->cookie = nfr->cookie;
1958 fr->reason = nfr->reason;
1959 fr->duration_sec = ntohl(nfr->duration_sec);
1960 fr->duration_nsec = ntohl(nfr->duration_nsec);
1961 fr->idle_timeout = ntohs(nfr->idle_timeout);
1962 fr->hard_timeout = 0;
1963 fr->packet_count = ntohll(nfr->packet_count);
1964 fr->byte_count = ntohll(nfr->byte_count);
1972 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
1973 * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
1976 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
1977 enum ofputil_protocol protocol)
1982 case OFPUTIL_P_OF12: {
1983 struct ofp12_flow_removed *ofr;
1985 msg = ofpraw_alloc_xid(OFPRAW_OFPT11_FLOW_REMOVED,
1986 ofputil_protocol_to_ofp_version(protocol),
1987 htonl(0), NXM_TYPICAL_LEN);
1988 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
1989 ofr->cookie = fr->cookie;
1990 ofr->priority = htons(fr->rule.priority);
1991 ofr->reason = fr->reason;
1993 ofr->duration_sec = htonl(fr->duration_sec);
1994 ofr->duration_nsec = htonl(fr->duration_nsec);
1995 ofr->idle_timeout = htons(fr->idle_timeout);
1996 ofr->hard_timeout = htons(fr->hard_timeout);
1997 ofr->packet_count = htonll(fr->packet_count);
1998 ofr->byte_count = htonll(fr->byte_count);
1999 oxm_put_match(msg, &fr->rule);
2003 case OFPUTIL_P_OF10:
2004 case OFPUTIL_P_OF10_TID: {
2005 struct ofp_flow_removed *ofr;
2007 msg = ofpraw_alloc_xid(OFPRAW_OFPT10_FLOW_REMOVED, OFP10_VERSION,
2009 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
2010 ofputil_cls_rule_to_ofp10_match(&fr->rule, &ofr->match);
2011 ofr->cookie = fr->cookie;
2012 ofr->priority = htons(fr->rule.priority);
2013 ofr->reason = fr->reason;
2014 ofr->duration_sec = htonl(fr->duration_sec);
2015 ofr->duration_nsec = htonl(fr->duration_nsec);
2016 ofr->idle_timeout = htons(fr->idle_timeout);
2017 ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
2018 ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
2023 case OFPUTIL_P_NXM_TID: {
2024 struct nx_flow_removed *nfr;
2027 msg = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_REMOVED, OFP10_VERSION,
2028 htonl(0), NXM_TYPICAL_LEN);
2029 nfr = ofpbuf_put_zeros(msg, sizeof *nfr);
2030 match_len = nx_put_match(msg, &fr->rule, 0, 0);
2033 nfr->cookie = fr->cookie;
2034 nfr->priority = htons(fr->rule.priority);
2035 nfr->reason = fr->reason;
2036 nfr->duration_sec = htonl(fr->duration_sec);
2037 nfr->duration_nsec = htonl(fr->duration_nsec);
2038 nfr->idle_timeout = htons(fr->idle_timeout);
2039 nfr->match_len = htons(match_len);
2040 nfr->packet_count = htonll(fr->packet_count);
2041 nfr->byte_count = htonll(fr->byte_count);
2053 ofputil_decode_packet_in_finish(struct ofputil_packet_in *pin,
2054 struct cls_rule *rule,
2057 pin->packet = b->data;
2058 pin->packet_len = b->size;
2060 pin->fmd.in_port = rule->flow.in_port;
2061 pin->fmd.tun_id = rule->flow.tun_id;
2062 pin->fmd.metadata = rule->flow.metadata;
2063 memcpy(pin->fmd.regs, rule->flow.regs, sizeof pin->fmd.regs);
2067 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
2068 const struct ofp_header *oh)
2073 memset(pin, 0, sizeof *pin);
2075 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2076 raw = ofpraw_pull_assert(&b);
2077 if (raw == OFPRAW_OFPT12_PACKET_IN) {
2078 const struct ofp12_packet_in *opi;
2079 struct cls_rule rule;
2082 opi = ofpbuf_pull(&b, sizeof *opi);
2083 error = oxm_pull_match_loose(&b, 0, &rule);
2088 if (!ofpbuf_try_pull(&b, 2)) {
2089 return OFPERR_OFPBRC_BAD_LEN;
2092 pin->reason = opi->reason;
2093 pin->table_id = opi->table_id;
2095 pin->buffer_id = ntohl(opi->buffer_id);
2096 pin->total_len = ntohs(opi->total_len);
2098 ofputil_decode_packet_in_finish(pin, &rule, &b);
2099 } else if (raw == OFPRAW_OFPT10_PACKET_IN) {
2100 const struct ofp_packet_in *opi;
2102 opi = ofpbuf_pull(&b, offsetof(struct ofp_packet_in, data));
2104 pin->packet = opi->data;
2105 pin->packet_len = b.size;
2107 pin->fmd.in_port = ntohs(opi->in_port);
2108 pin->reason = opi->reason;
2109 pin->buffer_id = ntohl(opi->buffer_id);
2110 pin->total_len = ntohs(opi->total_len);
2111 } else if (raw == OFPRAW_NXT_PACKET_IN) {
2112 const struct nx_packet_in *npi;
2113 struct cls_rule rule;
2116 npi = ofpbuf_pull(&b, sizeof *npi);
2117 error = nx_pull_match_loose(&b, ntohs(npi->match_len), 0, &rule, NULL,
2123 if (!ofpbuf_try_pull(&b, 2)) {
2124 return OFPERR_OFPBRC_BAD_LEN;
2127 pin->reason = npi->reason;
2128 pin->table_id = npi->table_id;
2129 pin->cookie = npi->cookie;
2131 pin->buffer_id = ntohl(npi->buffer_id);
2132 pin->total_len = ntohs(npi->total_len);
2134 ofputil_decode_packet_in_finish(pin, &rule, &b);
2143 ofputil_packet_in_to_rule(const struct ofputil_packet_in *pin,
2144 struct cls_rule *rule)
2148 cls_rule_init_catchall(rule, 0);
2149 if (pin->fmd.tun_id != htonll(0)) {
2150 cls_rule_set_tun_id(rule, pin->fmd.tun_id);
2152 if (pin->fmd.metadata != htonll(0)) {
2153 cls_rule_set_metadata(rule, pin->fmd.metadata);
2156 for (i = 0; i < FLOW_N_REGS; i++) {
2157 if (pin->fmd.regs[i]) {
2158 cls_rule_set_reg(rule, i, pin->fmd.regs[i]);
2162 cls_rule_set_in_port(rule, pin->fmd.in_port);
2165 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
2166 * in the format specified by 'packet_in_format'. */
2168 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
2169 enum ofputil_protocol protocol,
2170 enum nx_packet_in_format packet_in_format)
2172 size_t send_len = MIN(pin->send_len, pin->packet_len);
2173 struct ofpbuf *packet;
2175 /* Add OFPT_PACKET_IN. */
2176 if (protocol == OFPUTIL_P_OF12) {
2177 struct ofp12_packet_in *opi;
2178 struct cls_rule rule;
2180 ofputil_packet_in_to_rule(pin, &rule);
2182 /* The final argument is just an estimate of the space required. */
2183 packet = ofpraw_alloc_xid(OFPRAW_OFPT12_PACKET_IN, OFP12_VERSION,
2184 htonl(0), (sizeof(struct flow_metadata) * 2
2186 ofpbuf_put_zeros(packet, sizeof *opi);
2187 oxm_put_match(packet, &rule);
2188 ofpbuf_put_zeros(packet, 2);
2189 ofpbuf_put(packet, pin->packet, send_len);
2192 opi->buffer_id = htonl(pin->buffer_id);
2193 opi->total_len = htons(pin->total_len);
2194 opi->reason = pin->reason;
2195 opi->table_id = pin->table_id;
2196 } else if (packet_in_format == NXPIF_OPENFLOW10) {
2197 struct ofp_packet_in *opi;
2199 packet = ofpraw_alloc_xid(OFPRAW_OFPT10_PACKET_IN, OFP10_VERSION,
2200 htonl(0), send_len);
2201 opi = ofpbuf_put_zeros(packet, offsetof(struct ofp_packet_in, data));
2202 opi->total_len = htons(pin->total_len);
2203 opi->in_port = htons(pin->fmd.in_port);
2204 opi->reason = pin->reason;
2205 opi->buffer_id = htonl(pin->buffer_id);
2207 ofpbuf_put(packet, pin->packet, send_len);
2208 } else if (packet_in_format == NXPIF_NXM) {
2209 struct nx_packet_in *npi;
2210 struct cls_rule rule;
2213 ofputil_packet_in_to_rule(pin, &rule);
2215 /* The final argument is just an estimate of the space required. */
2216 packet = ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN, OFP10_VERSION,
2217 htonl(0), (sizeof(struct flow_metadata) * 2
2219 ofpbuf_put_zeros(packet, sizeof *npi);
2220 match_len = nx_put_match(packet, &rule, 0, 0);
2221 ofpbuf_put_zeros(packet, 2);
2222 ofpbuf_put(packet, pin->packet, send_len);
2225 npi->buffer_id = htonl(pin->buffer_id);
2226 npi->total_len = htons(pin->total_len);
2227 npi->reason = pin->reason;
2228 npi->table_id = pin->table_id;
2229 npi->cookie = pin->cookie;
2230 npi->match_len = htons(match_len);
2234 ofpmsg_update_length(packet);
2240 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason)
2242 static char s[INT_STRLEN(int) + 1];
2249 case OFPR_INVALID_TTL:
2250 return "invalid_ttl";
2252 case OFPR_N_REASONS:
2254 sprintf(s, "%d", (int) reason);
2260 ofputil_packet_in_reason_from_string(const char *s,
2261 enum ofp_packet_in_reason *reason)
2265 for (i = 0; i < OFPR_N_REASONS; i++) {
2266 if (!strcasecmp(s, ofputil_packet_in_reason_to_string(i))) {
2274 /* Converts an OFPT_PACKET_OUT in 'opo' into an abstract ofputil_packet_out in
2277 * Uses 'ofpacts' to store the abstract OFPACT_* version of the packet out
2278 * message's actions. The caller must initialize 'ofpacts' and retains
2279 * ownership of it. 'po->ofpacts' will point into the 'ofpacts' buffer.
2281 * Returns 0 if successful, otherwise an OFPERR_* value. */
2283 ofputil_decode_packet_out(struct ofputil_packet_out *po,
2284 const struct ofp_header *oh,
2285 struct ofpbuf *ofpacts)
2287 enum ofperr bad_in_port_err;
2291 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2292 raw = ofpraw_pull_assert(&b);
2294 if (raw == OFPRAW_OFPT11_PACKET_OUT) {
2296 const struct ofp11_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
2298 po->buffer_id = ntohl(opo->buffer_id);
2299 error = ofputil_port_from_ofp11(opo->in_port, &po->in_port);
2304 error = ofpacts_pull_openflow11_actions(&b, ntohs(opo->actions_len),
2310 bad_in_port_err = OFPERR_OFPBMC_BAD_VALUE;
2311 } else if (raw == OFPRAW_OFPT10_PACKET_OUT) {
2313 const struct ofp_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
2315 po->buffer_id = ntohl(opo->buffer_id);
2316 po->in_port = ntohs(opo->in_port);
2318 error = ofpacts_pull_openflow10(&b, ntohs(opo->actions_len), ofpacts);
2323 bad_in_port_err = OFPERR_NXBRC_BAD_IN_PORT;
2328 if (po->in_port >= OFPP_MAX && po->in_port != OFPP_LOCAL
2329 && po->in_port != OFPP_NONE && po->in_port != OFPP_CONTROLLER) {
2330 VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
2332 return bad_in_port_err;
2335 po->ofpacts = ofpacts->data;
2336 po->ofpacts_len = ofpacts->size;
2338 if (po->buffer_id == UINT32_MAX) {
2339 po->packet = b.data;
2340 po->packet_len = b.size;
2349 /* ofputil_phy_port */
2351 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
2352 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
2353 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
2354 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
2355 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
2356 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
2357 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
2358 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
2360 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
2361 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
2362 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
2363 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
2364 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
2365 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
2367 static enum netdev_features
2368 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
2370 uint32_t ofp10 = ntohl(ofp10_);
2371 return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
2375 netdev_port_features_to_ofp10(enum netdev_features features)
2377 return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
2380 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
2381 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
2382 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
2383 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
2384 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
2385 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
2386 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
2387 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD == OFPPF11_40GB_FD); /* bit 7 */
2388 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD == OFPPF11_100GB_FD); /* bit 8 */
2389 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD == OFPPF11_1TB_FD); /* bit 9 */
2390 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER == OFPPF11_OTHER); /* bit 10 */
2391 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == OFPPF11_COPPER); /* bit 11 */
2392 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == OFPPF11_FIBER); /* bit 12 */
2393 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == OFPPF11_AUTONEG); /* bit 13 */
2394 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == OFPPF11_PAUSE); /* bit 14 */
2395 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
2397 static enum netdev_features
2398 netdev_port_features_from_ofp11(ovs_be32 ofp11)
2400 return ntohl(ofp11) & 0xffff;
2404 netdev_port_features_to_ofp11(enum netdev_features features)
2406 return htonl(features & 0xffff);
2410 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
2411 const struct ofp10_phy_port *opp)
2413 memset(pp, 0, sizeof *pp);
2415 pp->port_no = ntohs(opp->port_no);
2416 memcpy(pp->hw_addr, opp->hw_addr, OFP_ETH_ALEN);
2417 ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
2419 pp->config = ntohl(opp->config) & OFPPC10_ALL;
2420 pp->state = ntohl(opp->state) & OFPPS10_ALL;
2422 pp->curr = netdev_port_features_from_ofp10(opp->curr);
2423 pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
2424 pp->supported = netdev_port_features_from_ofp10(opp->supported);
2425 pp->peer = netdev_port_features_from_ofp10(opp->peer);
2427 pp->curr_speed = netdev_features_to_bps(pp->curr) / 1000;
2428 pp->max_speed = netdev_features_to_bps(pp->supported) / 1000;
2434 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
2435 const struct ofp11_port *op)
2439 memset(pp, 0, sizeof *pp);
2441 error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
2445 memcpy(pp->hw_addr, op->hw_addr, OFP_ETH_ALEN);
2446 ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
2448 pp->config = ntohl(op->config) & OFPPC11_ALL;
2449 pp->state = ntohl(op->state) & OFPPC11_ALL;
2451 pp->curr = netdev_port_features_from_ofp11(op->curr);
2452 pp->advertised = netdev_port_features_from_ofp11(op->advertised);
2453 pp->supported = netdev_port_features_from_ofp11(op->supported);
2454 pp->peer = netdev_port_features_from_ofp11(op->peer);
2456 pp->curr_speed = ntohl(op->curr_speed);
2457 pp->max_speed = ntohl(op->max_speed);
2463 ofputil_get_phy_port_size(enum ofp_version ofp_version)
2465 switch (ofp_version) {
2467 return sizeof(struct ofp10_phy_port);
2470 return sizeof(struct ofp11_port);
2477 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
2478 struct ofp10_phy_port *opp)
2480 memset(opp, 0, sizeof *opp);
2482 opp->port_no = htons(pp->port_no);
2483 memcpy(opp->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2484 ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2486 opp->config = htonl(pp->config & OFPPC10_ALL);
2487 opp->state = htonl(pp->state & OFPPS10_ALL);
2489 opp->curr = netdev_port_features_to_ofp10(pp->curr);
2490 opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
2491 opp->supported = netdev_port_features_to_ofp10(pp->supported);
2492 opp->peer = netdev_port_features_to_ofp10(pp->peer);
2496 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
2497 struct ofp11_port *op)
2499 memset(op, 0, sizeof *op);
2501 op->port_no = ofputil_port_to_ofp11(pp->port_no);
2502 memcpy(op->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2503 ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2505 op->config = htonl(pp->config & OFPPC11_ALL);
2506 op->state = htonl(pp->state & OFPPS11_ALL);
2508 op->curr = netdev_port_features_to_ofp11(pp->curr);
2509 op->advertised = netdev_port_features_to_ofp11(pp->advertised);
2510 op->supported = netdev_port_features_to_ofp11(pp->supported);
2511 op->peer = netdev_port_features_to_ofp11(pp->peer);
2513 op->curr_speed = htonl(pp->curr_speed);
2514 op->max_speed = htonl(pp->max_speed);
2518 ofputil_put_phy_port(enum ofp_version ofp_version,
2519 const struct ofputil_phy_port *pp, struct ofpbuf *b)
2521 switch (ofp_version) {
2522 case OFP10_VERSION: {
2523 struct ofp10_phy_port *opp;
2524 if (b->size + sizeof *opp <= UINT16_MAX) {
2525 opp = ofpbuf_put_uninit(b, sizeof *opp);
2526 ofputil_encode_ofp10_phy_port(pp, opp);
2532 case OFP12_VERSION: {
2533 struct ofp11_port *op;
2534 if (b->size + sizeof *op <= UINT16_MAX) {
2535 op = ofpbuf_put_uninit(b, sizeof *op);
2536 ofputil_encode_ofp11_port(pp, op);
2547 ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
2548 const struct ofputil_phy_port *pp,
2549 struct list *replies)
2551 switch (ofp_version) {
2552 case OFP10_VERSION: {
2553 struct ofp10_phy_port *opp;
2555 opp = ofpmp_append(replies, sizeof *opp);
2556 ofputil_encode_ofp10_phy_port(pp, opp);
2561 case OFP12_VERSION: {
2562 struct ofp11_port *op;
2564 op = ofpmp_append(replies, sizeof *op);
2565 ofputil_encode_ofp11_port(pp, op);
2574 /* ofputil_switch_features */
2576 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
2577 OFPC_IP_REASM | OFPC_QUEUE_STATS)
2578 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
2579 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
2580 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
2581 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
2582 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
2583 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
2585 struct ofputil_action_bit_translation {
2586 enum ofputil_action_bitmap ofputil_bit;
2590 static const struct ofputil_action_bit_translation of10_action_bits[] = {
2591 { OFPUTIL_A_OUTPUT, OFPAT10_OUTPUT },
2592 { OFPUTIL_A_SET_VLAN_VID, OFPAT10_SET_VLAN_VID },
2593 { OFPUTIL_A_SET_VLAN_PCP, OFPAT10_SET_VLAN_PCP },
2594 { OFPUTIL_A_STRIP_VLAN, OFPAT10_STRIP_VLAN },
2595 { OFPUTIL_A_SET_DL_SRC, OFPAT10_SET_DL_SRC },
2596 { OFPUTIL_A_SET_DL_DST, OFPAT10_SET_DL_DST },
2597 { OFPUTIL_A_SET_NW_SRC, OFPAT10_SET_NW_SRC },
2598 { OFPUTIL_A_SET_NW_DST, OFPAT10_SET_NW_DST },
2599 { OFPUTIL_A_SET_NW_TOS, OFPAT10_SET_NW_TOS },
2600 { OFPUTIL_A_SET_TP_SRC, OFPAT10_SET_TP_SRC },
2601 { OFPUTIL_A_SET_TP_DST, OFPAT10_SET_TP_DST },
2602 { OFPUTIL_A_ENQUEUE, OFPAT10_ENQUEUE },
2606 static enum ofputil_action_bitmap
2607 decode_action_bits(ovs_be32 of_actions,
2608 const struct ofputil_action_bit_translation *x)
2610 enum ofputil_action_bitmap ofputil_actions;
2612 ofputil_actions = 0;
2613 for (; x->ofputil_bit; x++) {
2614 if (of_actions & htonl(1u << x->of_bit)) {
2615 ofputil_actions |= x->ofputil_bit;
2618 return ofputil_actions;
2622 ofputil_capabilities_mask(enum ofp_version ofp_version)
2624 /* Handle capabilities whose bit is unique for all Open Flow versions */
2625 switch (ofp_version) {
2628 return OFPC_COMMON | OFPC_ARP_MATCH_IP;
2630 return OFPC_COMMON | OFPC12_PORT_BLOCKED;
2632 /* Caller needs to check osf->header.version itself */
2637 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
2638 * abstract representation in '*features'. Initializes '*b' to iterate over
2639 * the OpenFlow port structures following 'osf' with later calls to
2640 * ofputil_pull_phy_port(). Returns 0 if successful, otherwise an
2641 * OFPERR_* value. */
2643 ofputil_decode_switch_features(const struct ofp_header *oh,
2644 struct ofputil_switch_features *features,
2647 const struct ofp_switch_features *osf;
2650 ofpbuf_use_const(b, oh, ntohs(oh->length));
2651 raw = ofpraw_pull_assert(b);
2653 osf = ofpbuf_pull(b, sizeof *osf);
2654 features->datapath_id = ntohll(osf->datapath_id);
2655 features->n_buffers = ntohl(osf->n_buffers);
2656 features->n_tables = osf->n_tables;
2658 features->capabilities = ntohl(osf->capabilities) &
2659 ofputil_capabilities_mask(oh->version);
2661 if (b->size % ofputil_get_phy_port_size(oh->version)) {
2662 return OFPERR_OFPBRC_BAD_LEN;
2665 if (raw == OFPRAW_OFPT10_FEATURES_REPLY) {
2666 if (osf->capabilities & htonl(OFPC10_STP)) {
2667 features->capabilities |= OFPUTIL_C_STP;
2669 features->actions = decode_action_bits(osf->actions, of10_action_bits);
2670 } else if (raw == OFPRAW_OFPT11_FEATURES_REPLY) {
2671 if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
2672 features->capabilities |= OFPUTIL_C_GROUP_STATS;
2674 features->actions = 0;
2676 return OFPERR_OFPBRC_BAD_VERSION;
2682 /* Returns true if the maximum number of ports are in 'oh'. */
2684 max_ports_in_features(const struct ofp_header *oh)
2686 size_t pp_size = ofputil_get_phy_port_size(oh->version);
2687 return ntohs(oh->length) + pp_size > UINT16_MAX;
2690 /* Given a buffer 'b' that contains a Features Reply message, checks if
2691 * it contains the maximum number of ports that will fit. If so, it
2692 * returns true and removes the ports from the message. The caller
2693 * should then send an OFPST_PORT_DESC stats request to get the ports,
2694 * since the switch may have more ports than could be represented in the
2695 * Features Reply. Otherwise, returns false.
2698 ofputil_switch_features_ports_trunc(struct ofpbuf *b)
2700 struct ofp_header *oh = b->data;
2702 if (max_ports_in_features(oh)) {
2703 /* Remove all the ports. */
2704 b->size = (sizeof(struct ofp_header)
2705 + sizeof(struct ofp_switch_features));
2706 ofpmsg_update_length(b);
2715 encode_action_bits(enum ofputil_action_bitmap ofputil_actions,
2716 const struct ofputil_action_bit_translation *x)
2718 uint32_t of_actions;
2721 for (; x->ofputil_bit; x++) {
2722 if (ofputil_actions & x->ofputil_bit) {
2723 of_actions |= 1 << x->of_bit;
2726 return htonl(of_actions);
2729 /* Returns a buffer owned by the caller that encodes 'features' in the format
2730 * required by 'protocol' with the given 'xid'. The caller should append port
2731 * information to the buffer with subsequent calls to
2732 * ofputil_put_switch_features_port(). */
2734 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
2735 enum ofputil_protocol protocol, ovs_be32 xid)
2737 struct ofp_switch_features *osf;
2739 enum ofp_version version;
2742 version = ofputil_protocol_to_ofp_version(protocol);
2745 raw = OFPRAW_OFPT10_FEATURES_REPLY;
2749 raw = OFPRAW_OFPT11_FEATURES_REPLY;
2754 b = ofpraw_alloc_xid(raw, version, xid, 0);
2755 osf = ofpbuf_put_zeros(b, sizeof *osf);
2756 osf->datapath_id = htonll(features->datapath_id);
2757 osf->n_buffers = htonl(features->n_buffers);
2758 osf->n_tables = features->n_tables;
2760 osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
2761 osf->capabilities = htonl(features->capabilities &
2762 ofputil_capabilities_mask(version));
2765 if (features->capabilities & OFPUTIL_C_STP) {
2766 osf->capabilities |= htonl(OFPC10_STP);
2768 osf->actions = encode_action_bits(features->actions, of10_action_bits);
2772 if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
2773 osf->capabilities |= htonl(OFPC11_GROUP_STATS);
2783 /* Encodes 'pp' into the format required by the switch_features message already
2784 * in 'b', which should have been returned by ofputil_encode_switch_features(),
2785 * and appends the encoded version to 'b'. */
2787 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
2790 const struct ofp_header *oh = b->data;
2792 ofputil_put_phy_port(oh->version, pp, b);
2795 /* ofputil_port_status */
2797 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
2798 * in '*ps'. Returns 0 if successful, otherwise an OFPERR_* value. */
2800 ofputil_decode_port_status(const struct ofp_header *oh,
2801 struct ofputil_port_status *ps)
2803 const struct ofp_port_status *ops;
2807 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2808 ofpraw_pull_assert(&b);
2809 ops = ofpbuf_pull(&b, sizeof *ops);
2811 if (ops->reason != OFPPR_ADD &&
2812 ops->reason != OFPPR_DELETE &&
2813 ops->reason != OFPPR_MODIFY) {
2814 return OFPERR_NXBRC_BAD_REASON;
2816 ps->reason = ops->reason;
2818 retval = ofputil_pull_phy_port(oh->version, &b, &ps->desc);
2819 assert(retval != EOF);
2823 /* Converts the abstract form of a "port status" message in '*ps' into an
2824 * OpenFlow message suitable for 'protocol', and returns that encoded form in
2825 * a buffer owned by the caller. */
2827 ofputil_encode_port_status(const struct ofputil_port_status *ps,
2828 enum ofputil_protocol protocol)
2830 struct ofp_port_status *ops;
2832 enum ofp_version version;
2835 version = ofputil_protocol_to_ofp_version(protocol);
2838 raw = OFPRAW_OFPT10_PORT_STATUS;
2843 raw = OFPRAW_OFPT11_PORT_STATUS;
2850 b = ofpraw_alloc_xid(raw, version, htonl(0), 0);
2851 ops = ofpbuf_put_zeros(b, sizeof *ops);
2852 ops->reason = ps->reason;
2853 ofputil_put_phy_port(version, &ps->desc, b);
2854 ofpmsg_update_length(b);
2858 /* ofputil_port_mod */
2860 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
2861 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
2863 ofputil_decode_port_mod(const struct ofp_header *oh,
2864 struct ofputil_port_mod *pm)
2869 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2870 raw = ofpraw_pull_assert(&b);
2872 if (raw == OFPRAW_OFPT10_PORT_MOD) {
2873 const struct ofp10_port_mod *opm = b.data;
2875 pm->port_no = ntohs(opm->port_no);
2876 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
2877 pm->config = ntohl(opm->config) & OFPPC10_ALL;
2878 pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
2879 pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
2880 } else if (raw == OFPRAW_OFPT11_PORT_MOD) {
2881 const struct ofp11_port_mod *opm = b.data;
2884 error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
2889 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
2890 pm->config = ntohl(opm->config) & OFPPC11_ALL;
2891 pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
2892 pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
2894 return OFPERR_OFPBRC_BAD_TYPE;
2897 pm->config &= pm->mask;
2901 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
2902 * message suitable for 'protocol', and returns that encoded form in a buffer
2903 * owned by the caller. */
2905 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
2906 enum ofputil_protocol protocol)
2908 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
2911 switch (ofp_version) {
2912 case OFP10_VERSION: {
2913 struct ofp10_port_mod *opm;
2915 b = ofpraw_alloc(OFPRAW_OFPT10_PORT_MOD, ofp_version, 0);
2916 opm = ofpbuf_put_zeros(b, sizeof *opm);
2917 opm->port_no = htons(pm->port_no);
2918 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
2919 opm->config = htonl(pm->config & OFPPC10_ALL);
2920 opm->mask = htonl(pm->mask & OFPPC10_ALL);
2921 opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
2926 case OFP12_VERSION: {
2927 struct ofp11_port_mod *opm;
2929 b = ofpraw_alloc(OFPRAW_OFPT11_PORT_MOD, ofp_version, 0);
2930 opm = ofpbuf_put_zeros(b, sizeof *opm);
2931 opm->port_no = ofputil_port_to_ofp11(pm->port_no);
2932 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
2933 opm->config = htonl(pm->config & OFPPC11_ALL);
2934 opm->mask = htonl(pm->mask & OFPPC11_ALL);
2935 opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
2946 /* ofputil_flow_monitor_request */
2948 /* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract
2949 * ofputil_flow_monitor_request in 'rq'.
2951 * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow
2952 * message. Calling this function multiple times for a single 'msg' iterates
2953 * through the requests. The caller must initially leave 'msg''s layer
2954 * pointers null and not modify them between calls.
2956 * Returns 0 if successful, EOF if no requests were left in this 'msg',
2957 * otherwise an OFPERR_* value. */
2959 ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *rq,
2962 struct nx_flow_monitor_request *nfmr;
2966 msg->l2 = msg->data;
2967 ofpraw_pull_assert(msg);
2974 nfmr = ofpbuf_try_pull(msg, sizeof *nfmr);
2976 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR request has %zu "
2977 "leftover bytes at end", msg->size);
2978 return OFPERR_OFPBRC_BAD_LEN;
2981 flags = ntohs(nfmr->flags);
2982 if (!(flags & (NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY))
2983 || flags & ~(NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE
2984 | NXFMF_MODIFY | NXFMF_ACTIONS | NXFMF_OWN)) {
2985 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR has bad flags %#"PRIx16,
2987 return OFPERR_NXBRC_FM_BAD_FLAGS;
2990 if (!is_all_zeros(nfmr->zeros, sizeof nfmr->zeros)) {
2991 return OFPERR_NXBRC_MUST_BE_ZERO;
2994 rq->id = ntohl(nfmr->id);
2996 rq->out_port = ntohs(nfmr->out_port);
2997 rq->table_id = nfmr->table_id;
2999 return nx_pull_match(msg, ntohs(nfmr->match_len), OFP_DEFAULT_PRIORITY,
3000 &rq->match, NULL, NULL);
3004 ofputil_append_flow_monitor_request(
3005 const struct ofputil_flow_monitor_request *rq, struct ofpbuf *msg)
3007 struct nx_flow_monitor_request *nfmr;
3012 ofpraw_put(OFPRAW_NXST_FLOW_MONITOR_REQUEST, OFP10_VERSION, msg);
3015 start_ofs = msg->size;
3016 ofpbuf_put_zeros(msg, sizeof *nfmr);
3017 match_len = nx_put_match(msg, &rq->match, htonll(0), htonll(0));
3019 nfmr = ofpbuf_at_assert(msg, start_ofs, sizeof *nfmr);
3020 nfmr->id = htonl(rq->id);
3021 nfmr->flags = htons(rq->flags);
3022 nfmr->out_port = htons(rq->out_port);
3023 nfmr->match_len = htons(match_len);
3024 nfmr->table_id = rq->table_id;
3027 /* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg'
3028 * into an abstract ofputil_flow_update in 'update'. The caller must have
3029 * initialized update->match to point to space allocated for a cls_rule.
3031 * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's
3032 * actions (except for NXFME_ABBREV, which never includes actions). The caller
3033 * must initialize 'ofpacts' and retains ownership of it. 'update->ofpacts'
3034 * will point into the 'ofpacts' buffer.
3036 * Multiple flow updates can be packed into a single OpenFlow message. Calling
3037 * this function multiple times for a single 'msg' iterates through the
3038 * updates. The caller must initially leave 'msg''s layer pointers null and
3039 * not modify them between calls.
3041 * Returns 0 if successful, EOF if no updates were left in this 'msg',
3042 * otherwise an OFPERR_* value. */
3044 ofputil_decode_flow_update(struct ofputil_flow_update *update,
3045 struct ofpbuf *msg, struct ofpbuf *ofpacts)
3047 struct nx_flow_update_header *nfuh;
3048 unsigned int length;
3051 msg->l2 = msg->data;
3052 ofpraw_pull_assert(msg);
3059 if (msg->size < sizeof(struct nx_flow_update_header)) {
3064 update->event = ntohs(nfuh->event);
3065 length = ntohs(nfuh->length);
3066 if (length > msg->size || length % 8) {
3070 if (update->event == NXFME_ABBREV) {
3071 struct nx_flow_update_abbrev *nfua;
3073 if (length != sizeof *nfua) {
3077 nfua = ofpbuf_pull(msg, sizeof *nfua);
3078 update->xid = nfua->xid;
3080 } else if (update->event == NXFME_ADDED
3081 || update->event == NXFME_DELETED
3082 || update->event == NXFME_MODIFIED) {
3083 struct nx_flow_update_full *nfuf;
3084 unsigned int actions_len;
3085 unsigned int match_len;
3088 if (length < sizeof *nfuf) {
3092 nfuf = ofpbuf_pull(msg, sizeof *nfuf);
3093 match_len = ntohs(nfuf->match_len);
3094 if (sizeof *nfuf + match_len > length) {
3098 update->reason = ntohs(nfuf->reason);
3099 update->idle_timeout = ntohs(nfuf->idle_timeout);
3100 update->hard_timeout = ntohs(nfuf->hard_timeout);
3101 update->table_id = nfuf->table_id;
3102 update->cookie = nfuf->cookie;
3104 error = nx_pull_match(msg, match_len, ntohs(nfuf->priority),
3105 update->match, NULL, NULL);
3110 actions_len = length - sizeof *nfuf - ROUND_UP(match_len, 8);
3111 error = ofpacts_pull_openflow10(msg, actions_len, ofpacts);
3116 update->ofpacts = ofpacts->data;
3117 update->ofpacts_len = ofpacts->size;
3120 VLOG_WARN_RL(&bad_ofmsg_rl,
3121 "NXST_FLOW_MONITOR reply has bad event %"PRIu16,
3122 ntohs(nfuh->event));
3123 return OFPERR_OFPET_BAD_REQUEST;
3127 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR reply has %zu "
3128 "leftover bytes at end", msg->size);
3129 return OFPERR_OFPBRC_BAD_LEN;
3133 ofputil_decode_flow_monitor_cancel(const struct ofp_header *oh)
3135 const struct nx_flow_monitor_cancel *cancel = ofpmsg_body(oh);
3137 return ntohl(cancel->id);
3141 ofputil_encode_flow_monitor_cancel(uint32_t id)
3143 struct nx_flow_monitor_cancel *nfmc;
3146 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MONITOR_CANCEL, OFP10_VERSION, 0);
3147 nfmc = ofpbuf_put_uninit(msg, sizeof *nfmc);
3148 nfmc->id = htonl(id);
3153 ofputil_start_flow_update(struct list *replies)
3157 msg = ofpraw_alloc_xid(OFPRAW_NXST_FLOW_MONITOR_REPLY, OFP10_VERSION,
3161 list_push_back(replies, &msg->list_node);
3165 ofputil_append_flow_update(const struct ofputil_flow_update *update,
3166 struct list *replies)
3168 struct nx_flow_update_header *nfuh;
3172 msg = ofpbuf_from_list(list_back(replies));
3173 start_ofs = msg->size;
3175 if (update->event == NXFME_ABBREV) {
3176 struct nx_flow_update_abbrev *nfua;
3178 nfua = ofpbuf_put_zeros(msg, sizeof *nfua);
3179 nfua->xid = update->xid;
3181 struct nx_flow_update_full *nfuf;
3184 ofpbuf_put_zeros(msg, sizeof *nfuf);
3185 match_len = nx_put_match(msg, update->match, htonll(0), htonll(0));
3186 ofpacts_put_openflow10(update->ofpacts, update->ofpacts_len, msg);
3188 nfuf = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuf);
3189 nfuf->reason = htons(update->reason);
3190 nfuf->priority = htons(update->match->priority);
3191 nfuf->idle_timeout = htons(update->idle_timeout);
3192 nfuf->hard_timeout = htons(update->hard_timeout);
3193 nfuf->match_len = htons(match_len);
3194 nfuf->table_id = update->table_id;
3195 nfuf->cookie = update->cookie;
3198 nfuh = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuh);
3199 nfuh->length = htons(msg->size - start_ofs);
3200 nfuh->event = htons(update->event);
3202 ofpmp_postappend(replies, start_ofs);
3206 ofputil_encode_packet_out(const struct ofputil_packet_out *po,
3207 enum ofputil_protocol protocol)
3209 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
3213 size = po->ofpacts_len;
3214 if (po->buffer_id == UINT32_MAX) {
3215 size += po->packet_len;
3218 switch (ofp_version) {
3219 case OFP10_VERSION: {
3220 struct ofp_packet_out *opo;
3223 msg = ofpraw_alloc(OFPRAW_OFPT10_PACKET_OUT, OFP10_VERSION, size);
3224 ofpbuf_put_zeros(msg, sizeof *opo);
3225 actions_ofs = msg->size;
3226 ofpacts_put_openflow10(po->ofpacts, po->ofpacts_len, msg);
3229 opo->buffer_id = htonl(po->buffer_id);
3230 opo->in_port = htons(po->in_port);
3231 opo->actions_len = htons(msg->size - actions_ofs);
3236 case OFP12_VERSION: {
3237 struct ofp11_packet_out *opo;
3240 msg = ofpraw_alloc(OFPRAW_OFPT11_PACKET_OUT, ofp_version, size);
3241 ofpbuf_put_zeros(msg, sizeof *opo);
3242 len = ofpacts_put_openflow11_actions(po->ofpacts, po->ofpacts_len, msg);
3245 opo->buffer_id = htonl(po->buffer_id);
3246 opo->in_port = ofputil_port_to_ofp11(po->in_port);
3247 opo->actions_len = htons(len);
3255 if (po->buffer_id == UINT32_MAX) {
3256 ofpbuf_put(msg, po->packet, po->packet_len);
3259 ofpmsg_update_length(msg);
3264 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
3266 make_echo_request(enum ofp_version ofp_version)
3268 return ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST, ofp_version,
3272 /* Creates and returns an OFPT_ECHO_REPLY message matching the
3273 * OFPT_ECHO_REQUEST message in 'rq'. */
3275 make_echo_reply(const struct ofp_header *rq)
3277 struct ofpbuf rq_buf;
3278 struct ofpbuf *reply;
3280 ofpbuf_use_const(&rq_buf, rq, ntohs(rq->length));
3281 ofpraw_pull_assert(&rq_buf);
3283 reply = ofpraw_alloc_reply(OFPRAW_OFPT_ECHO_REPLY, rq, rq_buf.size);
3284 ofpbuf_put(reply, rq_buf.data, rq_buf.size);
3289 ofputil_encode_barrier_request(enum ofp_version ofp_version)
3293 switch (ofp_version) {
3296 type = OFPRAW_OFPT11_BARRIER_REQUEST;
3300 type = OFPRAW_OFPT10_BARRIER_REQUEST;
3307 return ofpraw_alloc(type, ofp_version, 0);
3311 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
3313 switch (flags & OFPC_FRAG_MASK) {
3314 case OFPC_FRAG_NORMAL: return "normal";
3315 case OFPC_FRAG_DROP: return "drop";
3316 case OFPC_FRAG_REASM: return "reassemble";
3317 case OFPC_FRAG_NX_MATCH: return "nx-match";
3324 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
3326 if (!strcasecmp(s, "normal")) {
3327 *flags = OFPC_FRAG_NORMAL;
3328 } else if (!strcasecmp(s, "drop")) {
3329 *flags = OFPC_FRAG_DROP;
3330 } else if (!strcasecmp(s, "reassemble")) {
3331 *flags = OFPC_FRAG_REASM;
3332 } else if (!strcasecmp(s, "nx-match")) {
3333 *flags = OFPC_FRAG_NX_MATCH;
3340 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
3341 * port number and stores the latter in '*ofp10_port', for the purpose of
3342 * decoding OpenFlow 1.1+ protocol messages. Returns 0 if successful,
3343 * otherwise an OFPERR_* number.
3345 * See the definition of OFP11_MAX for an explanation of the mapping. */
3347 ofputil_port_from_ofp11(ovs_be32 ofp11_port, uint16_t *ofp10_port)
3349 uint32_t ofp11_port_h = ntohl(ofp11_port);
3351 if (ofp11_port_h < OFPP_MAX) {
3352 *ofp10_port = ofp11_port_h;
3354 } else if (ofp11_port_h >= OFPP11_MAX) {
3355 *ofp10_port = ofp11_port_h - OFPP11_OFFSET;
3358 VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
3359 "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
3360 ofp11_port_h, OFPP_MAX - 1,
3361 (uint32_t) OFPP11_MAX, UINT32_MAX);
3362 return OFPERR_OFPBAC_BAD_OUT_PORT;
3366 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
3367 * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
3369 * See the definition of OFP11_MAX for an explanation of the mapping. */
3371 ofputil_port_to_ofp11(uint16_t ofp10_port)
3373 return htonl(ofp10_port < OFPP_MAX
3375 : ofp10_port + OFPP11_OFFSET);
3378 /* Checks that 'port' is a valid output port for the OFPAT10_OUTPUT action, given
3379 * that the switch will never have more than 'max_ports' ports. Returns 0 if
3380 * 'port' is valid, otherwise an OpenFlow return code. */
3382 ofputil_check_output_port(uint16_t port, int max_ports)
3390 case OFPP_CONTROLLER:
3396 if (port < max_ports) {
3399 return OFPERR_OFPBAC_BAD_OUT_PORT;
3403 #define OFPUTIL_NAMED_PORTS \
3404 OFPUTIL_NAMED_PORT(IN_PORT) \
3405 OFPUTIL_NAMED_PORT(TABLE) \
3406 OFPUTIL_NAMED_PORT(NORMAL) \
3407 OFPUTIL_NAMED_PORT(FLOOD) \
3408 OFPUTIL_NAMED_PORT(ALL) \
3409 OFPUTIL_NAMED_PORT(CONTROLLER) \
3410 OFPUTIL_NAMED_PORT(LOCAL) \
3411 OFPUTIL_NAMED_PORT(NONE)
3413 /* Checks whether 's' is the string representation of an OpenFlow port number,
3414 * either as an integer or a string name (e.g. "LOCAL"). If it is, stores the
3415 * number in '*port' and returns true. Otherwise, returns false. */
3417 ofputil_port_from_string(const char *name, uint16_t *port)
3423 static const struct pair pairs[] = {
3424 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
3426 #undef OFPUTIL_NAMED_PORT
3428 static const int n_pairs = ARRAY_SIZE(pairs);
3431 if (str_to_int(name, 0, &i) && i >= 0 && i < UINT16_MAX) {
3436 for (i = 0; i < n_pairs; i++) {
3437 if (!strcasecmp(name, pairs[i].name)) {
3438 *port = pairs[i].value;
3445 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
3446 * Most ports' string representation is just the port number, but for special
3447 * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
3449 ofputil_format_port(uint16_t port, struct ds *s)
3454 #define OFPUTIL_NAMED_PORT(NAME) case OFPP_##NAME: name = #NAME; break;
3456 #undef OFPUTIL_NAMED_PORT
3459 ds_put_format(s, "%"PRIu16, port);
3462 ds_put_cstr(s, name);
3465 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3466 * 'ofp_version', tries to pull the first element from the array. If
3467 * successful, initializes '*pp' with an abstract representation of the
3468 * port and returns 0. If no ports remain to be decoded, returns EOF.
3469 * On an error, returns a positive OFPERR_* value. */
3471 ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *b,
3472 struct ofputil_phy_port *pp)
3474 switch (ofp_version) {
3475 case OFP10_VERSION: {
3476 const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
3477 return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
3480 case OFP12_VERSION: {
3481 const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
3482 return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
3489 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3490 * 'ofp_version', returns the number of elements. */
3491 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *b)
3493 return b->size / ofputil_get_phy_port_size(ofp_version);
3496 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
3497 * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1 if
3498 * 'name' is not the name of any action.
3500 * ofp-util.def lists the mapping from names to action. */
3502 ofputil_action_code_from_name(const char *name)
3504 static const char *names[OFPUTIL_N_ACTIONS] = {
3506 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) NAME,
3507 #define OFPAT11_ACTION(ENUM, STRUCT, NAME) NAME,
3508 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
3509 #include "ofp-util.def"
3514 for (p = names; p < &names[ARRAY_SIZE(names)]; p++) {
3515 if (*p && !strcasecmp(name, *p)) {
3522 /* Appends an action of the type specified by 'code' to 'buf' and returns the
3523 * action. Initializes the parts of 'action' that identify it as having type
3524 * <ENUM> and length 'sizeof *action' and zeros the rest. For actions that
3525 * have variable length, the length used and cleared is that of struct
3528 ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
3531 case OFPUTIL_ACTION_INVALID:
3534 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
3535 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3536 #define OFPAT11_ACTION OFPAT10_ACTION
3537 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3538 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3539 #include "ofp-util.def"
3544 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
3546 ofputil_init_##ENUM(struct STRUCT *s) \
3548 memset(s, 0, sizeof *s); \
3549 s->type = htons(ENUM); \
3550 s->len = htons(sizeof *s); \
3554 ofputil_put_##ENUM(struct ofpbuf *buf) \
3556 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
3557 ofputil_init_##ENUM(s); \
3560 #define OFPAT11_ACTION OFPAT10_ACTION
3561 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3563 ofputil_init_##ENUM(struct STRUCT *s) \
3565 memset(s, 0, sizeof *s); \
3566 s->type = htons(OFPAT10_VENDOR); \
3567 s->len = htons(sizeof *s); \
3568 s->vendor = htonl(NX_VENDOR_ID); \
3569 s->subtype = htons(ENUM); \
3573 ofputil_put_##ENUM(struct ofpbuf *buf) \
3575 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
3576 ofputil_init_##ENUM(s); \
3579 #include "ofp-util.def"
3582 ofputil_normalize_rule__(struct cls_rule *rule, bool may_log)
3585 MAY_NW_ADDR = 1 << 0, /* nw_src, nw_dst */
3586 MAY_TP_ADDR = 1 << 1, /* tp_src, tp_dst */
3587 MAY_NW_PROTO = 1 << 2, /* nw_proto */
3588 MAY_IPVx = 1 << 3, /* tos, frag, ttl */
3589 MAY_ARP_SHA = 1 << 4, /* arp_sha */
3590 MAY_ARP_THA = 1 << 5, /* arp_tha */
3591 MAY_IPV6 = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
3592 MAY_ND_TARGET = 1 << 7 /* nd_target */
3595 struct flow_wildcards wc;
3597 /* Figure out what fields may be matched. */
3598 if (rule->flow.dl_type == htons(ETH_TYPE_IP)) {
3599 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
3600 if (rule->flow.nw_proto == IPPROTO_TCP ||
3601 rule->flow.nw_proto == IPPROTO_UDP ||
3602 rule->flow.nw_proto == IPPROTO_ICMP) {
3603 may_match |= MAY_TP_ADDR;
3605 } else if (rule->flow.dl_type == htons(ETH_TYPE_IPV6)) {
3606 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
3607 if (rule->flow.nw_proto == IPPROTO_TCP ||
3608 rule->flow.nw_proto == IPPROTO_UDP) {
3609 may_match |= MAY_TP_ADDR;
3610 } else if (rule->flow.nw_proto == IPPROTO_ICMPV6) {
3611 may_match |= MAY_TP_ADDR;
3612 if (rule->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
3613 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
3614 } else if (rule->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
3615 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
3618 } else if (rule->flow.dl_type == htons(ETH_TYPE_ARP)) {
3619 may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
3624 /* Clear the fields that may not be matched. */
3626 if (!(may_match & MAY_NW_ADDR)) {
3627 wc.nw_src_mask = wc.nw_dst_mask = htonl(0);
3629 if (!(may_match & MAY_TP_ADDR)) {
3630 wc.tp_src_mask = wc.tp_dst_mask = htons(0);
3632 if (!(may_match & MAY_NW_PROTO)) {
3633 wc.nw_proto_mask = 0;
3635 if (!(may_match & MAY_IPVx)) {
3639 if (!(may_match & MAY_ARP_SHA)) {
3640 memset(wc.arp_sha_mask, 0, ETH_ADDR_LEN);
3642 if (!(may_match & MAY_ARP_THA)) {
3643 memset(wc.arp_tha_mask, 0, ETH_ADDR_LEN);
3645 if (!(may_match & MAY_IPV6)) {
3646 wc.ipv6_src_mask = wc.ipv6_dst_mask = in6addr_any;
3647 wc.ipv6_label_mask = htonl(0);
3649 if (!(may_match & MAY_ND_TARGET)) {
3650 wc.nd_target_mask = in6addr_any;
3653 /* Log any changes. */
3654 if (!flow_wildcards_equal(&wc, &rule->wc)) {
3655 bool log = may_log && !VLOG_DROP_INFO(&bad_ofmsg_rl);
3656 char *pre = log ? cls_rule_to_string(rule) : NULL;
3659 cls_rule_zero_wildcarded_fields(rule);
3662 char *post = cls_rule_to_string(rule);
3663 VLOG_INFO("normalization changed ofp_match, details:");
3664 VLOG_INFO(" pre: %s", pre);
3665 VLOG_INFO("post: %s", post);
3672 /* "Normalizes" the wildcards in 'rule'. That means:
3674 * 1. If the type of level N is known, then only the valid fields for that
3675 * level may be specified. For example, ARP does not have a TOS field,
3676 * so nw_tos must be wildcarded if 'rule' specifies an ARP flow.
3677 * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
3678 * ipv6_dst (and other fields) must be wildcarded if 'rule' specifies an
3681 * 2. If the type of level N is not known (or not understood by Open
3682 * vSwitch), then no fields at all for that level may be specified. For
3683 * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
3684 * L4 fields tp_src and tp_dst must be wildcarded if 'rule' specifies an
3687 * If this function changes 'rule', it logs a rate-limited informational
3690 ofputil_normalize_rule(struct cls_rule *rule)
3692 ofputil_normalize_rule__(rule, true);
3695 /* Same as ofputil_normalize_rule() without the logging. Thus, this function
3696 * is suitable for a program's internal use, whereas ofputil_normalize_rule()
3697 * sense for use on flows received from elsewhere (so that a bug in the program
3698 * that sent them can be reported and corrected). */
3700 ofputil_normalize_rule_quiet(struct cls_rule *rule)
3702 ofputil_normalize_rule__(rule, false);
3705 /* Parses a key or a key-value pair from '*stringp'.
3707 * On success: Stores the key into '*keyp'. Stores the value, if present, into
3708 * '*valuep', otherwise an empty string. Advances '*stringp' past the end of
3709 * the key-value pair, preparing it for another call. '*keyp' and '*valuep'
3710 * are substrings of '*stringp' created by replacing some of its bytes by null
3711 * terminators. Returns true.
3713 * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
3714 * NULL and returns false. */
3716 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
3718 char *pos, *key, *value;
3722 pos += strspn(pos, ", \t\r\n");
3724 *keyp = *valuep = NULL;
3729 key_len = strcspn(pos, ":=(, \t\r\n");
3730 if (key[key_len] == ':' || key[key_len] == '=') {
3731 /* The value can be separated by a colon. */
3734 value = key + key_len + 1;
3735 value_len = strcspn(value, ", \t\r\n");
3736 pos = value + value_len + (value[value_len] != '\0');
3737 value[value_len] = '\0';
3738 } else if (key[key_len] == '(') {
3739 /* The value can be surrounded by balanced parentheses. The outermost
3740 * set of parentheses is removed. */
3744 value = key + key_len + 1;
3745 for (value_len = 0; level > 0; value_len++) {
3746 switch (value[value_len]) {
3760 value[value_len - 1] = '\0';
3761 pos = value + value_len;
3763 /* There might be no value at all. */
3764 value = key + key_len; /* Will become the empty string below. */
3765 pos = key + key_len + (key[key_len] != '\0');
3767 key[key_len] = '\0';