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"
22 #include <sys/types.h>
23 #include <netinet/in.h>
24 #include <netinet/icmp6.h>
28 #include "byte-order.h"
29 #include "classifier.h"
30 #include "dynamic-string.h"
32 #include "meta-flow.h"
33 #include "multipath.h"
36 #include "ofp-actions.h"
37 #include "ofp-errors.h"
43 #include "unaligned.h"
44 #include "type-props.h"
47 VLOG_DEFINE_THIS_MODULE(ofp_util);
49 /* Rate limit for OpenFlow message parse errors. These always indicate a bug
50 * in the peer and so there's not much point in showing a lot of them. */
51 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
53 /* Given the wildcard bit count in the least-significant 6 of 'wcbits', returns
54 * an IP netmask with a 1 in each bit that must match and a 0 in each bit that
57 * The bits in 'wcbits' are in the format used in enum ofp_flow_wildcards: 0
58 * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
59 * ..., 32 and higher wildcard the entire field. This is the *opposite* of the
60 * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
63 ofputil_wcbits_to_netmask(int wcbits)
66 return wcbits < 32 ? htonl(~((1u << wcbits) - 1)) : 0;
69 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
70 * that it wildcards, that is, the number of 0-bits in 'netmask', a number
71 * between 0 and 32 inclusive.
73 * If 'netmask' is not a CIDR netmask (see ip_is_cidr()), the return value will
74 * still be in the valid range but isn't otherwise meaningful. */
76 ofputil_netmask_to_wcbits(ovs_be32 netmask)
78 return 32 - ip_count_cidr_bits(netmask);
81 /* Converts the OpenFlow 1.0 wildcards in 'ofpfw' (OFPFW10_*) into a
82 * flow_wildcards in 'wc' for use in struct match. It is the caller's
83 * responsibility to handle the special case where the flow match's dl_vlan is
84 * set to OFP_VLAN_NONE. */
86 ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *wc)
88 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 17);
90 /* Initialize most of wc. */
91 flow_wildcards_init_catchall(wc);
93 if (!(ofpfw & OFPFW10_IN_PORT)) {
94 wc->masks.in_port = UINT16_MAX;
97 if (!(ofpfw & OFPFW10_NW_TOS)) {
98 wc->masks.nw_tos |= IP_DSCP_MASK;
101 if (!(ofpfw & OFPFW10_NW_PROTO)) {
102 wc->masks.nw_proto = UINT8_MAX;
104 wc->masks.nw_src = ofputil_wcbits_to_netmask(ofpfw
105 >> OFPFW10_NW_SRC_SHIFT);
106 wc->masks.nw_dst = ofputil_wcbits_to_netmask(ofpfw
107 >> OFPFW10_NW_DST_SHIFT);
109 if (!(ofpfw & OFPFW10_TP_SRC)) {
110 wc->masks.tp_src = htons(UINT16_MAX);
112 if (!(ofpfw & OFPFW10_TP_DST)) {
113 wc->masks.tp_dst = htons(UINT16_MAX);
116 if (!(ofpfw & OFPFW10_DL_SRC)) {
117 memset(wc->masks.dl_src, 0xff, ETH_ADDR_LEN);
119 if (!(ofpfw & OFPFW10_DL_DST)) {
120 memset(wc->masks.dl_dst, 0xff, ETH_ADDR_LEN);
122 if (!(ofpfw & OFPFW10_DL_TYPE)) {
123 wc->masks.dl_type = htons(UINT16_MAX);
127 if (!(ofpfw & OFPFW10_DL_VLAN_PCP)) {
128 wc->masks.vlan_tci |= htons(VLAN_PCP_MASK | VLAN_CFI);
130 if (!(ofpfw & OFPFW10_DL_VLAN)) {
131 wc->masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
135 /* Converts the ofp10_match in 'ofmatch' into a struct match in 'match'. */
137 ofputil_match_from_ofp10_match(const struct ofp10_match *ofmatch,
140 uint32_t ofpfw = ntohl(ofmatch->wildcards) & OFPFW10_ALL;
142 /* Initialize match->wc. */
143 memset(&match->flow, 0, sizeof match->flow);
144 ofputil_wildcard_from_ofpfw10(ofpfw, &match->wc);
146 /* Initialize most of match->flow. */
147 match->flow.nw_src = ofmatch->nw_src;
148 match->flow.nw_dst = ofmatch->nw_dst;
149 match->flow.in_port = ntohs(ofmatch->in_port);
150 match->flow.dl_type = ofputil_dl_type_from_openflow(ofmatch->dl_type);
151 match->flow.tp_src = ofmatch->tp_src;
152 match->flow.tp_dst = ofmatch->tp_dst;
153 memcpy(match->flow.dl_src, ofmatch->dl_src, ETH_ADDR_LEN);
154 memcpy(match->flow.dl_dst, ofmatch->dl_dst, ETH_ADDR_LEN);
155 match->flow.nw_tos = ofmatch->nw_tos & IP_DSCP_MASK;
156 match->flow.nw_proto = ofmatch->nw_proto;
158 /* Translate VLANs. */
159 if (!(ofpfw & OFPFW10_DL_VLAN) &&
160 ofmatch->dl_vlan == htons(OFP10_VLAN_NONE)) {
161 /* Match only packets without 802.1Q header.
163 * When OFPFW10_DL_VLAN_PCP is wildcarded, this is obviously correct.
165 * If OFPFW10_DL_VLAN_PCP is matched, the flow match is contradictory,
166 * because we can't have a specific PCP without an 802.1Q header.
167 * However, older versions of OVS treated this as matching packets
168 * withut an 802.1Q header, so we do here too. */
169 match->flow.vlan_tci = htons(0);
170 match->wc.masks.vlan_tci = htons(0xffff);
172 ovs_be16 vid, pcp, tci;
174 vid = ofmatch->dl_vlan & htons(VLAN_VID_MASK);
175 pcp = htons((ofmatch->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK);
176 tci = vid | pcp | htons(VLAN_CFI);
177 match->flow.vlan_tci = tci & match->wc.masks.vlan_tci;
181 match_zero_wildcarded_fields(match);
184 /* Convert 'match' into the OpenFlow 1.0 match structure 'ofmatch'. */
186 ofputil_match_to_ofp10_match(const struct match *match,
187 struct ofp10_match *ofmatch)
189 const struct flow_wildcards *wc = &match->wc;
192 /* Figure out most OpenFlow wildcards. */
194 if (!wc->masks.in_port) {
195 ofpfw |= OFPFW10_IN_PORT;
197 if (!wc->masks.dl_type) {
198 ofpfw |= OFPFW10_DL_TYPE;
200 if (!wc->masks.nw_proto) {
201 ofpfw |= OFPFW10_NW_PROTO;
203 ofpfw |= (ofputil_netmask_to_wcbits(wc->masks.nw_src)
204 << OFPFW10_NW_SRC_SHIFT);
205 ofpfw |= (ofputil_netmask_to_wcbits(wc->masks.nw_dst)
206 << OFPFW10_NW_DST_SHIFT);
207 if (!(wc->masks.nw_tos & IP_DSCP_MASK)) {
208 ofpfw |= OFPFW10_NW_TOS;
210 if (!wc->masks.tp_src) {
211 ofpfw |= OFPFW10_TP_SRC;
213 if (!wc->masks.tp_dst) {
214 ofpfw |= OFPFW10_TP_DST;
216 if (eth_addr_is_zero(wc->masks.dl_src)) {
217 ofpfw |= OFPFW10_DL_SRC;
219 if (eth_addr_is_zero(wc->masks.dl_dst)) {
220 ofpfw |= OFPFW10_DL_DST;
223 /* Translate VLANs. */
224 ofmatch->dl_vlan = htons(0);
225 ofmatch->dl_vlan_pcp = 0;
226 if (match->wc.masks.vlan_tci == htons(0)) {
227 ofpfw |= OFPFW10_DL_VLAN | OFPFW10_DL_VLAN_PCP;
228 } else if (match->wc.masks.vlan_tci & htons(VLAN_CFI)
229 && !(match->flow.vlan_tci & htons(VLAN_CFI))) {
230 ofmatch->dl_vlan = htons(OFP10_VLAN_NONE);
231 ofpfw |= OFPFW10_DL_VLAN_PCP;
233 if (!(match->wc.masks.vlan_tci & htons(VLAN_VID_MASK))) {
234 ofpfw |= OFPFW10_DL_VLAN;
236 ofmatch->dl_vlan = htons(vlan_tci_to_vid(match->flow.vlan_tci));
239 if (!(match->wc.masks.vlan_tci & htons(VLAN_PCP_MASK))) {
240 ofpfw |= OFPFW10_DL_VLAN_PCP;
242 ofmatch->dl_vlan_pcp = vlan_tci_to_pcp(match->flow.vlan_tci);
246 /* Compose most of the match structure. */
247 ofmatch->wildcards = htonl(ofpfw);
248 ofmatch->in_port = htons(match->flow.in_port);
249 memcpy(ofmatch->dl_src, match->flow.dl_src, ETH_ADDR_LEN);
250 memcpy(ofmatch->dl_dst, match->flow.dl_dst, ETH_ADDR_LEN);
251 ofmatch->dl_type = ofputil_dl_type_to_openflow(match->flow.dl_type);
252 ofmatch->nw_src = match->flow.nw_src;
253 ofmatch->nw_dst = match->flow.nw_dst;
254 ofmatch->nw_tos = match->flow.nw_tos & IP_DSCP_MASK;
255 ofmatch->nw_proto = match->flow.nw_proto;
256 ofmatch->tp_src = match->flow.tp_src;
257 ofmatch->tp_dst = match->flow.tp_dst;
258 memset(ofmatch->pad1, '\0', sizeof ofmatch->pad1);
259 memset(ofmatch->pad2, '\0', sizeof ofmatch->pad2);
263 ofputil_pull_ofp11_match(struct ofpbuf *buf, struct match *match,
264 uint16_t *padded_match_len)
266 struct ofp11_match_header *omh = buf->data;
269 if (buf->size < sizeof *omh) {
270 return OFPERR_OFPBMC_BAD_LEN;
273 match_len = ntohs(omh->length);
275 switch (ntohs(omh->type)) {
276 case OFPMT_STANDARD: {
277 struct ofp11_match *om;
279 if (match_len != sizeof *om || buf->size < sizeof *om) {
280 return OFPERR_OFPBMC_BAD_LEN;
282 om = ofpbuf_pull(buf, sizeof *om);
283 if (padded_match_len) {
284 *padded_match_len = match_len;
286 return ofputil_match_from_ofp11_match(om, match);
290 if (padded_match_len) {
291 *padded_match_len = ROUND_UP(match_len, 8);
293 return oxm_pull_match(buf, match);
296 return OFPERR_OFPBMC_BAD_TYPE;
300 /* Converts the ofp11_match in 'match' into a struct match in 'match. Returns
301 * 0 if successful, otherwise an OFPERR_* value. */
303 ofputil_match_from_ofp11_match(const struct ofp11_match *ofmatch,
306 uint16_t wc = ntohl(ofmatch->wildcards);
307 uint8_t dl_src_mask[ETH_ADDR_LEN];
308 uint8_t dl_dst_mask[ETH_ADDR_LEN];
309 bool ipv4, arp, rarp;
312 match_init_catchall(match);
314 if (!(wc & OFPFW11_IN_PORT)) {
318 error = ofputil_port_from_ofp11(ofmatch->in_port, &ofp_port);
320 return OFPERR_OFPBMC_BAD_VALUE;
322 match_set_in_port(match, ofp_port);
325 for (i = 0; i < ETH_ADDR_LEN; i++) {
326 dl_src_mask[i] = ~ofmatch->dl_src_mask[i];
328 match_set_dl_src_masked(match, ofmatch->dl_src, dl_src_mask);
330 for (i = 0; i < ETH_ADDR_LEN; i++) {
331 dl_dst_mask[i] = ~ofmatch->dl_dst_mask[i];
333 match_set_dl_dst_masked(match, ofmatch->dl_dst, dl_dst_mask);
335 if (!(wc & OFPFW11_DL_VLAN)) {
336 if (ofmatch->dl_vlan == htons(OFPVID11_NONE)) {
337 /* Match only packets without a VLAN tag. */
338 match->flow.vlan_tci = htons(0);
339 match->wc.masks.vlan_tci = htons(UINT16_MAX);
341 if (ofmatch->dl_vlan == htons(OFPVID11_ANY)) {
342 /* Match any packet with a VLAN tag regardless of VID. */
343 match->flow.vlan_tci = htons(VLAN_CFI);
344 match->wc.masks.vlan_tci = htons(VLAN_CFI);
345 } else if (ntohs(ofmatch->dl_vlan) < 4096) {
346 /* Match only packets with the specified VLAN VID. */
347 match->flow.vlan_tci = htons(VLAN_CFI) | ofmatch->dl_vlan;
348 match->wc.masks.vlan_tci = htons(VLAN_CFI | VLAN_VID_MASK);
351 return OFPERR_OFPBMC_BAD_VALUE;
354 if (!(wc & OFPFW11_DL_VLAN_PCP)) {
355 if (ofmatch->dl_vlan_pcp <= 7) {
356 match->flow.vlan_tci |= htons(ofmatch->dl_vlan_pcp
358 match->wc.masks.vlan_tci |= htons(VLAN_PCP_MASK);
361 return OFPERR_OFPBMC_BAD_VALUE;
367 if (!(wc & OFPFW11_DL_TYPE)) {
368 match_set_dl_type(match,
369 ofputil_dl_type_from_openflow(ofmatch->dl_type));
372 ipv4 = match->flow.dl_type == htons(ETH_TYPE_IP);
373 arp = match->flow.dl_type == htons(ETH_TYPE_ARP);
374 rarp = match->flow.dl_type == htons(ETH_TYPE_RARP);
376 if (ipv4 && !(wc & OFPFW11_NW_TOS)) {
377 if (ofmatch->nw_tos & ~IP_DSCP_MASK) {
379 return OFPERR_OFPBMC_BAD_VALUE;
382 match_set_nw_dscp(match, ofmatch->nw_tos);
385 if (ipv4 || arp || rarp) {
386 if (!(wc & OFPFW11_NW_PROTO)) {
387 match_set_nw_proto(match, ofmatch->nw_proto);
389 match_set_nw_src_masked(match, ofmatch->nw_src, ~ofmatch->nw_src_mask);
390 match_set_nw_dst_masked(match, ofmatch->nw_dst, ~ofmatch->nw_dst_mask);
393 #define OFPFW11_TP_ALL (OFPFW11_TP_SRC | OFPFW11_TP_DST)
394 if (ipv4 && (wc & OFPFW11_TP_ALL) != OFPFW11_TP_ALL) {
395 switch (match->flow.nw_proto) {
397 /* "A.2.3 Flow Match Structures" in OF1.1 says:
399 * The tp_src and tp_dst fields will be ignored unless the
400 * network protocol specified is as TCP, UDP or SCTP.
402 * but I'm pretty sure we should support ICMP too, otherwise
403 * that's a regression from OF1.0. */
404 if (!(wc & OFPFW11_TP_SRC)) {
405 uint16_t icmp_type = ntohs(ofmatch->tp_src);
406 if (icmp_type < 0x100) {
407 match_set_icmp_type(match, icmp_type);
409 return OFPERR_OFPBMC_BAD_FIELD;
412 if (!(wc & OFPFW11_TP_DST)) {
413 uint16_t icmp_code = ntohs(ofmatch->tp_dst);
414 if (icmp_code < 0x100) {
415 match_set_icmp_code(match, icmp_code);
417 return OFPERR_OFPBMC_BAD_FIELD;
424 if (!(wc & (OFPFW11_TP_SRC))) {
425 match_set_tp_src(match, ofmatch->tp_src);
427 if (!(wc & (OFPFW11_TP_DST))) {
428 match_set_tp_dst(match, ofmatch->tp_dst);
433 /* We don't support SCTP and it seems that we should tell the
434 * controller, since OF1.1 implementations are supposed to. */
435 return OFPERR_OFPBMC_BAD_FIELD;
438 /* OF1.1 says explicitly to ignore this. */
443 if (match->flow.dl_type == htons(ETH_TYPE_MPLS) ||
444 match->flow.dl_type == htons(ETH_TYPE_MPLS_MCAST)) {
445 enum { OFPFW11_MPLS_ALL = OFPFW11_MPLS_LABEL | OFPFW11_MPLS_TC };
447 if ((wc & OFPFW11_MPLS_ALL) != OFPFW11_MPLS_ALL) {
448 /* MPLS not supported. */
449 return OFPERR_OFPBMC_BAD_TAG;
453 match_set_metadata_masked(match, ofmatch->metadata,
454 ~ofmatch->metadata_mask);
459 /* Convert 'match' into the OpenFlow 1.1 match structure 'ofmatch'. */
461 ofputil_match_to_ofp11_match(const struct match *match,
462 struct ofp11_match *ofmatch)
467 memset(ofmatch, 0, sizeof *ofmatch);
468 ofmatch->omh.type = htons(OFPMT_STANDARD);
469 ofmatch->omh.length = htons(OFPMT11_STANDARD_LENGTH);
471 if (!match->wc.masks.in_port) {
472 wc |= OFPFW11_IN_PORT;
474 ofmatch->in_port = ofputil_port_to_ofp11(match->flow.in_port);
477 memcpy(ofmatch->dl_src, match->flow.dl_src, ETH_ADDR_LEN);
478 for (i = 0; i < ETH_ADDR_LEN; i++) {
479 ofmatch->dl_src_mask[i] = ~match->wc.masks.dl_src[i];
482 memcpy(ofmatch->dl_dst, match->flow.dl_dst, ETH_ADDR_LEN);
483 for (i = 0; i < ETH_ADDR_LEN; i++) {
484 ofmatch->dl_dst_mask[i] = ~match->wc.masks.dl_dst[i];
487 if (match->wc.masks.vlan_tci == htons(0)) {
488 wc |= OFPFW11_DL_VLAN | OFPFW11_DL_VLAN_PCP;
489 } else if (match->wc.masks.vlan_tci & htons(VLAN_CFI)
490 && !(match->flow.vlan_tci & htons(VLAN_CFI))) {
491 ofmatch->dl_vlan = htons(OFPVID11_NONE);
492 wc |= OFPFW11_DL_VLAN_PCP;
494 if (!(match->wc.masks.vlan_tci & htons(VLAN_VID_MASK))) {
495 ofmatch->dl_vlan = htons(OFPVID11_ANY);
497 ofmatch->dl_vlan = htons(vlan_tci_to_vid(match->flow.vlan_tci));
500 if (!(match->wc.masks.vlan_tci & htons(VLAN_PCP_MASK))) {
501 wc |= OFPFW11_DL_VLAN_PCP;
503 ofmatch->dl_vlan_pcp = vlan_tci_to_pcp(match->flow.vlan_tci);
507 if (!match->wc.masks.dl_type) {
508 wc |= OFPFW11_DL_TYPE;
510 ofmatch->dl_type = ofputil_dl_type_to_openflow(match->flow.dl_type);
513 if (!(match->wc.masks.nw_tos & IP_DSCP_MASK)) {
514 wc |= OFPFW11_NW_TOS;
516 ofmatch->nw_tos = match->flow.nw_tos & IP_DSCP_MASK;
519 if (!match->wc.masks.nw_proto) {
520 wc |= OFPFW11_NW_PROTO;
522 ofmatch->nw_proto = match->flow.nw_proto;
525 ofmatch->nw_src = match->flow.nw_src;
526 ofmatch->nw_src_mask = ~match->wc.masks.nw_src;
527 ofmatch->nw_dst = match->flow.nw_dst;
528 ofmatch->nw_dst_mask = ~match->wc.masks.nw_dst;
530 if (!match->wc.masks.tp_src) {
531 wc |= OFPFW11_TP_SRC;
533 ofmatch->tp_src = match->flow.tp_src;
536 if (!match->wc.masks.tp_dst) {
537 wc |= OFPFW11_TP_DST;
539 ofmatch->tp_dst = match->flow.tp_dst;
542 /* MPLS not supported. */
543 wc |= OFPFW11_MPLS_LABEL;
544 wc |= OFPFW11_MPLS_TC;
546 ofmatch->metadata = match->flow.metadata;
547 ofmatch->metadata_mask = ~match->wc.masks.metadata;
549 ofmatch->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_STD_ANY, "OpenFlow10" },
586 { OFPUTIL_P_OF10_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_STD;
608 return OFPUTIL_P_OF12_OXM;
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)
621 case OFPUTIL_P_OF10_STD:
622 case OFPUTIL_P_OF10_STD_TID:
623 case OFPUTIL_P_OF10_NXM:
624 case OFPUTIL_P_OF10_NXM_TID:
625 return OFP10_VERSION;
626 case OFPUTIL_P_OF12_OXM:
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)
655 case OFPUTIL_P_OF10_STD:
656 case OFPUTIL_P_OF10_STD_TID:
657 return enable ? OFPUTIL_P_OF10_STD_TID : OFPUTIL_P_OF10_STD;
659 case OFPUTIL_P_OF10_NXM:
660 case OFPUTIL_P_OF10_NXM_TID:
661 return enable ? OFPUTIL_P_OF10_NXM_TID : OFPUTIL_P_OF10_NXM;
663 case OFPUTIL_P_OF12_OXM:
664 return OFPUTIL_P_OF12_OXM;
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;
689 case OFPUTIL_P_OF10_STD:
690 case OFPUTIL_P_OF10_STD_TID:
691 return ofputil_protocol_set_tid(OFPUTIL_P_OF10_STD, tid);
693 case OFPUTIL_P_OF10_NXM:
694 case OFPUTIL_P_OF10_NXM_TID:
695 return ofputil_protocol_set_tid(OFPUTIL_P_OF10_NXM, tid);
697 case OFPUTIL_P_OF12_OXM:
698 return ofputil_protocol_set_tid(OFPUTIL_P_OF12_OXM, 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. */
716 case OFPUTIL_P_OF10_NXM:
717 return "NXM-table_id";
719 case OFPUTIL_P_OF10_NXM_TID:
720 return "NXM+table_id";
722 case OFPUTIL_P_OF10_STD:
723 return "OpenFlow10-table_id";
725 case OFPUTIL_P_OF10_STD_TID:
726 return "OpenFlow10+table_id";
728 case OFPUTIL_P_OF12_OXM:
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);
850 static enum ofp_version
851 ofputil_version_from_string(const char *s)
853 if (!strcasecmp(s, "OpenFlow10")) {
854 return OFP10_VERSION;
856 if (!strcasecmp(s, "OpenFlow11")) {
857 return OFP11_VERSION;
859 if (!strcasecmp(s, "OpenFlow12")) {
860 return OFP12_VERSION;
862 VLOG_FATAL("Unknown OpenFlow version: \"%s\"", s);
868 return isspace(c) || c == ',';
872 ofputil_versions_from_string(const char *s)
879 enum ofp_version version;
882 if (is_delimiter(s[i])) {
887 while (s[i + j] && !is_delimiter(s[i + j])) {
890 key = xmemdup0(s + i, j);
891 version = ofputil_version_from_string(key);
893 bitmap |= 1u << version;
901 ofputil_version_to_string(enum ofp_version ofp_version)
903 switch (ofp_version) {
916 ofputil_packet_in_format_is_valid(enum nx_packet_in_format packet_in_format)
918 switch (packet_in_format) {
919 case NXPIF_OPENFLOW10:
928 ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format)
930 switch (packet_in_format) {
931 case NXPIF_OPENFLOW10:
941 ofputil_packet_in_format_from_string(const char *s)
943 return (!strcmp(s, "openflow10") ? NXPIF_OPENFLOW10
944 : !strcmp(s, "nxm") ? NXPIF_NXM
949 regs_fully_wildcarded(const struct flow_wildcards *wc)
953 for (i = 0; i < FLOW_N_REGS; i++) {
954 if (wc->masks.regs[i] != 0) {
961 /* Returns a bit-mask of ofputil_protocols that can be used for sending 'match'
962 * to a switch (e.g. to add or remove a flow). Only NXM can handle tunnel IDs,
963 * registers, or fixing the Ethernet multicast bit. Otherwise, it's better to
964 * use OpenFlow 1.0 protocol for backward compatibility. */
965 enum ofputil_protocol
966 ofputil_usable_protocols(const struct match *match)
968 const struct flow_wildcards *wc = &match->wc;
970 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 17);
972 /* NXM, OXM, and OF1.1 support bitwise matching on ethernet addresses. */
973 if (!eth_mask_is_exact(wc->masks.dl_src)
974 && !eth_addr_is_zero(wc->masks.dl_src)) {
975 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
977 if (!eth_mask_is_exact(wc->masks.dl_dst)
978 && !eth_addr_is_zero(wc->masks.dl_dst)) {
979 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
982 /* NXM, OXM, and OF1.1+ support matching metadata. */
983 if (wc->masks.metadata != htonll(0)) {
984 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
987 /* NXM and OXM support matching ARP hardware addresses. */
988 if (!eth_addr_is_zero(wc->masks.arp_sha) ||
989 !eth_addr_is_zero(wc->masks.arp_tha)) {
990 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
993 /* NXM and OXM support matching IPv6 traffic. */
994 if (match->flow.dl_type == htons(ETH_TYPE_IPV6)) {
995 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
998 /* NXM and OXM support matching registers. */
999 if (!regs_fully_wildcarded(wc)) {
1000 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1003 /* NXM and OXM support matching tun_id. */
1004 if (wc->masks.tunnel.tun_id != htonll(0)) {
1005 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1008 /* NXM and OXM support matching fragments. */
1009 if (wc->masks.nw_frag) {
1010 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1013 /* NXM and OXM support matching IPv6 flow label. */
1014 if (wc->masks.ipv6_label) {
1015 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1018 /* NXM and OXM support matching IP ECN bits. */
1019 if (wc->masks.nw_tos & IP_ECN_MASK) {
1020 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1023 /* NXM and OXM support matching IP TTL/hop limit. */
1024 if (wc->masks.nw_ttl) {
1025 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1028 /* NXM and OXM support non-CIDR IPv4 address masks. */
1029 if (!ip_is_cidr(wc->masks.nw_src) || !ip_is_cidr(wc->masks.nw_dst)) {
1030 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1033 /* NXM and OXM support bitwise matching on transport port. */
1034 if ((wc->masks.tp_src && wc->masks.tp_src != htons(UINT16_MAX)) ||
1035 (wc->masks.tp_dst && wc->masks.tp_dst != htons(UINT16_MAX))) {
1036 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1039 /* Other formats can express this rule. */
1040 return OFPUTIL_P_ANY;
1044 ofputil_format_version(struct ds *msg, enum ofp_version version)
1046 ds_put_format(msg, "0x%02x", version);
1050 ofputil_format_version_name(struct ds *msg, enum ofp_version version)
1052 ds_put_cstr(msg, ofputil_version_to_string(version));
1056 ofputil_format_version_bitmap__(struct ds *msg, uint32_t bitmap,
1057 void (*format_version)(struct ds *msg,
1061 format_version(msg, raw_ctz(bitmap));
1062 bitmap = zero_rightmost_1bit(bitmap);
1064 ds_put_cstr(msg, ", ");
1070 ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap)
1072 ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version);
1076 ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap)
1078 ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version_name);
1082 ofputil_decode_hello_bitmap(const struct ofp_hello_elem_header *oheh,
1083 uint32_t *allowed_versionsp)
1085 uint16_t bitmap_len = ntohs(oheh->length) - sizeof *oheh;
1086 const ovs_be32 *bitmap = (const ovs_be32 *) (oheh + 1);
1087 uint32_t allowed_versions;
1089 if (!bitmap_len || bitmap_len % sizeof *bitmap) {
1093 /* Only use the first 32-bit element of the bitmap as that is all the
1094 * current implementation supports. Subsequent elements are ignored which
1095 * should have no effect on session negotiation until Open vSwtich supports
1096 * wire-protocol versions greater than 31.
1098 allowed_versions = ntohl(bitmap[0]);
1100 if (allowed_versions & 1) {
1101 /* There's no OpenFlow version 0. */
1102 VLOG_WARN_RL(&bad_ofmsg_rl, "peer claims to support invalid OpenFlow "
1104 allowed_versions &= ~1u;
1107 if (!allowed_versions) {
1108 VLOG_WARN_RL(&bad_ofmsg_rl, "peer does not support any OpenFlow "
1109 "version (between 0x01 and 0x1f)");
1113 *allowed_versionsp = allowed_versions;
1118 version_bitmap_from_version(uint8_t ofp_version)
1120 return ((ofp_version < 32 ? 1u << ofp_version : 0) - 1) << 1;
1123 /* Decodes OpenFlow OFPT_HELLO message 'oh', storing into '*allowed_versions'
1124 * the set of OpenFlow versions for which 'oh' announces support.
1126 * Because of how OpenFlow defines OFPT_HELLO messages, this function is always
1127 * successful, and thus '*allowed_versions' is always initialized. However, it
1128 * returns false if 'oh' contains some data that could not be fully understood,
1129 * true if 'oh' was completely parsed. */
1131 ofputil_decode_hello(const struct ofp_header *oh, uint32_t *allowed_versions)
1136 ofpbuf_use_const(&msg, oh, ntohs(oh->length));
1137 ofpbuf_pull(&msg, sizeof *oh);
1139 *allowed_versions = version_bitmap_from_version(oh->version);
1141 const struct ofp_hello_elem_header *oheh;
1144 if (msg.size < sizeof *oheh) {
1149 len = ntohs(oheh->length);
1150 if (len < sizeof *oheh || !ofpbuf_try_pull(&msg, ROUND_UP(len, 8))) {
1154 if (oheh->type != htons(OFPHET_VERSIONBITMAP)
1155 || !ofputil_decode_hello_bitmap(oheh, allowed_versions)) {
1163 /* Returns true if 'allowed_versions' needs to be accompanied by a version
1164 * bitmap to be correctly expressed in an OFPT_HELLO message. */
1166 should_send_version_bitmap(uint32_t allowed_versions)
1168 return !is_pow2((allowed_versions >> 1) + 1);
1171 /* Create an OFPT_HELLO message that expresses support for the OpenFlow
1172 * versions in the 'allowed_versions' bitmaps and returns the message. */
1174 ofputil_encode_hello(uint32_t allowed_versions)
1176 enum ofp_version ofp_version;
1179 ofp_version = leftmost_1bit_idx(allowed_versions);
1180 msg = ofpraw_alloc(OFPRAW_OFPT_HELLO, ofp_version, 0);
1182 if (should_send_version_bitmap(allowed_versions)) {
1183 struct ofp_hello_elem_header *oheh;
1186 map_len = sizeof allowed_versions;
1187 oheh = ofpbuf_put_zeros(msg, ROUND_UP(map_len + sizeof *oheh, 8));
1188 oheh->type = htons(OFPHET_VERSIONBITMAP);
1189 oheh->length = htons(map_len + sizeof *oheh);
1190 *(ovs_be32 *)(oheh + 1) = htonl(allowed_versions);
1192 ofpmsg_update_length(msg);
1198 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
1199 * protocol is 'current', at least partly transitions the protocol to 'want'.
1200 * Stores in '*next' the protocol that will be in effect on the OpenFlow
1201 * connection if the switch processes the returned message correctly. (If
1202 * '*next != want' then the caller will have to iterate.)
1204 * If 'current == want', or if it is not possible to transition from 'current'
1205 * to 'want' (because, for example, 'current' and 'want' use different OpenFlow
1206 * protocol versions), returns NULL and stores 'current' in '*next'. */
1208 ofputil_encode_set_protocol(enum ofputil_protocol current,
1209 enum ofputil_protocol want,
1210 enum ofputil_protocol *next)
1212 enum ofp_version cur_version, want_version;
1213 enum ofputil_protocol cur_base, want_base;
1214 bool cur_tid, want_tid;
1216 cur_version = ofputil_protocol_to_ofp_version(current);
1217 want_version = ofputil_protocol_to_ofp_version(want);
1218 if (cur_version != want_version) {
1223 cur_base = ofputil_protocol_to_base(current);
1224 want_base = ofputil_protocol_to_base(want);
1225 if (cur_base != want_base) {
1226 *next = ofputil_protocol_set_base(current, want_base);
1228 switch (want_base) {
1229 case OFPUTIL_P_OF10_NXM:
1230 return ofputil_encode_nx_set_flow_format(NXFF_NXM);
1232 case OFPUTIL_P_OF10_STD:
1233 return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10);
1235 case OFPUTIL_P_OF12_OXM:
1236 return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW12);
1238 case OFPUTIL_P_OF10_STD_TID:
1239 case OFPUTIL_P_OF10_NXM_TID:
1244 cur_tid = (current & OFPUTIL_P_TID) != 0;
1245 want_tid = (want & OFPUTIL_P_TID) != 0;
1246 if (cur_tid != want_tid) {
1247 *next = ofputil_protocol_set_tid(current, want_tid);
1248 return ofputil_make_flow_mod_table_id(want_tid);
1251 assert(current == want);
1257 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1258 * format to 'nxff'. */
1260 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff)
1262 struct nx_set_flow_format *sff;
1265 assert(ofputil_nx_flow_format_is_valid(nxff));
1267 msg = ofpraw_alloc(OFPRAW_NXT_SET_FLOW_FORMAT, OFP10_VERSION, 0);
1268 sff = ofpbuf_put_zeros(msg, sizeof *sff);
1269 sff->format = htonl(nxff);
1274 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1276 enum ofputil_protocol
1277 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format)
1279 switch (flow_format) {
1280 case NXFF_OPENFLOW10:
1281 return OFPUTIL_P_OF10_STD;
1284 return OFPUTIL_P_OF10_NXM;
1286 case NXFF_OPENFLOW12:
1287 return OFPUTIL_P_OF12_OXM;
1294 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1296 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format)
1298 return ofputil_nx_flow_format_to_protocol(flow_format) != 0;
1301 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1304 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format)
1306 switch (flow_format) {
1307 case NXFF_OPENFLOW10:
1308 return "openflow10";
1311 case NXFF_OPENFLOW12:
1312 return "openflow12";
1319 ofputil_make_set_packet_in_format(enum ofp_version ofp_version,
1320 enum nx_packet_in_format packet_in_format)
1322 struct nx_set_packet_in_format *spif;
1325 msg = ofpraw_alloc(OFPRAW_NXT_SET_PACKET_IN_FORMAT, ofp_version, 0);
1326 spif = ofpbuf_put_zeros(msg, sizeof *spif);
1327 spif->format = htonl(packet_in_format);
1332 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1333 * extension on or off (according to 'flow_mod_table_id'). */
1335 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
1337 struct nx_flow_mod_table_id *nfmti;
1340 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION, 0);
1341 nfmti = ofpbuf_put_zeros(msg, sizeof *nfmti);
1342 nfmti->set = flow_mod_table_id;
1346 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1347 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
1350 * Uses 'ofpacts' to store the abstract OFPACT_* version of 'oh''s actions.
1351 * The caller must initialize 'ofpacts' and retains ownership of it.
1352 * 'fm->ofpacts' will point into the 'ofpacts' buffer.
1354 * Does not validate the flow_mod actions. The caller should do that, with
1355 * ofpacts_check(). */
1357 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
1358 const struct ofp_header *oh,
1359 enum ofputil_protocol protocol,
1360 struct ofpbuf *ofpacts)
1366 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1367 raw = ofpraw_pull_assert(&b);
1368 if (raw == OFPRAW_OFPT11_FLOW_MOD) {
1369 /* Standard OpenFlow 1.1 flow_mod. */
1370 const struct ofp11_flow_mod *ofm;
1373 ofm = ofpbuf_pull(&b, sizeof *ofm);
1375 error = ofputil_pull_ofp11_match(&b, &fm->match, NULL);
1380 error = ofpacts_pull_openflow11_instructions(&b, b.size, ofpacts);
1385 /* Translate the message. */
1386 fm->priority = ntohs(ofm->priority);
1387 if (ofm->command == OFPFC_ADD) {
1388 fm->cookie = htonll(0);
1389 fm->cookie_mask = htonll(0);
1390 fm->new_cookie = ofm->cookie;
1392 fm->cookie = ofm->cookie;
1393 fm->cookie_mask = ofm->cookie_mask;
1394 fm->new_cookie = htonll(UINT64_MAX);
1396 fm->command = ofm->command;
1397 fm->table_id = ofm->table_id;
1398 fm->idle_timeout = ntohs(ofm->idle_timeout);
1399 fm->hard_timeout = ntohs(ofm->hard_timeout);
1400 fm->buffer_id = ntohl(ofm->buffer_id);
1401 error = ofputil_port_from_ofp11(ofm->out_port, &fm->out_port);
1405 if (ofm->out_group != htonl(OFPG_ANY)) {
1406 return OFPERR_OFPFMFC_UNKNOWN;
1408 fm->flags = ntohs(ofm->flags);
1410 if (raw == OFPRAW_OFPT10_FLOW_MOD) {
1411 /* Standard OpenFlow 1.0 flow_mod. */
1412 const struct ofp10_flow_mod *ofm;
1415 /* Get the ofp10_flow_mod. */
1416 ofm = ofpbuf_pull(&b, sizeof *ofm);
1418 /* Translate the rule. */
1419 ofputil_match_from_ofp10_match(&ofm->match, &fm->match);
1420 ofputil_normalize_match(&fm->match);
1422 /* Now get the actions. */
1423 error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1428 /* OpenFlow 1.0 says that exact-match rules have to have the
1429 * highest possible priority. */
1430 fm->priority = (ofm->match.wildcards & htonl(OFPFW10_ALL)
1431 ? ntohs(ofm->priority)
1434 /* Translate the message. */
1435 command = ntohs(ofm->command);
1436 fm->cookie = htonll(0);
1437 fm->cookie_mask = htonll(0);
1438 fm->new_cookie = ofm->cookie;
1439 fm->idle_timeout = ntohs(ofm->idle_timeout);
1440 fm->hard_timeout = ntohs(ofm->hard_timeout);
1441 fm->buffer_id = ntohl(ofm->buffer_id);
1442 fm->out_port = ntohs(ofm->out_port);
1443 fm->flags = ntohs(ofm->flags);
1444 } else if (raw == OFPRAW_NXT_FLOW_MOD) {
1445 /* Nicira extended flow_mod. */
1446 const struct nx_flow_mod *nfm;
1449 /* Dissect the message. */
1450 nfm = ofpbuf_pull(&b, sizeof *nfm);
1451 error = nx_pull_match(&b, ntohs(nfm->match_len),
1452 &fm->match, &fm->cookie, &fm->cookie_mask);
1456 error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1461 /* Translate the message. */
1462 command = ntohs(nfm->command);
1463 if ((command & 0xff) == OFPFC_ADD && fm->cookie_mask) {
1464 /* Flow additions may only set a new cookie, not match an
1465 * existing cookie. */
1466 return OFPERR_NXBRC_NXM_INVALID;
1468 fm->priority = ntohs(nfm->priority);
1469 fm->new_cookie = nfm->cookie;
1470 fm->idle_timeout = ntohs(nfm->idle_timeout);
1471 fm->hard_timeout = ntohs(nfm->hard_timeout);
1472 fm->buffer_id = ntohl(nfm->buffer_id);
1473 fm->out_port = ntohs(nfm->out_port);
1474 fm->flags = ntohs(nfm->flags);
1479 if (protocol & OFPUTIL_P_TID) {
1480 fm->command = command & 0xff;
1481 fm->table_id = command >> 8;
1483 fm->command = command;
1484 fm->table_id = 0xff;
1488 fm->ofpacts = ofpacts->data;
1489 fm->ofpacts_len = ofpacts->size;
1495 ofputil_tid_command(const struct ofputil_flow_mod *fm,
1496 enum ofputil_protocol protocol)
1498 return htons(protocol & OFPUTIL_P_TID
1499 ? (fm->command & 0xff) | (fm->table_id << 8)
1503 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
1504 * 'protocol' and returns the message. */
1506 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
1507 enum ofputil_protocol protocol)
1512 case OFPUTIL_P_OF12_OXM: {
1513 struct ofp11_flow_mod *ofm;
1515 msg = ofpraw_alloc(OFPRAW_OFPT11_FLOW_MOD, OFP12_VERSION,
1516 NXM_TYPICAL_LEN + fm->ofpacts_len);
1517 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
1518 if (fm->command == OFPFC_ADD) {
1519 ofm->cookie = fm->new_cookie;
1521 ofm->cookie = fm->cookie;
1523 ofm->cookie_mask = fm->cookie_mask;
1524 ofm->table_id = fm->table_id;
1525 ofm->command = fm->command;
1526 ofm->idle_timeout = htons(fm->idle_timeout);
1527 ofm->hard_timeout = htons(fm->hard_timeout);
1528 ofm->priority = htons(fm->priority);
1529 ofm->buffer_id = htonl(fm->buffer_id);
1530 ofm->out_port = ofputil_port_to_ofp11(fm->out_port);
1531 ofm->out_group = htonl(OFPG11_ANY);
1532 ofm->flags = htons(fm->flags);
1533 oxm_put_match(msg, &fm->match);
1534 ofpacts_put_openflow11_instructions(fm->ofpacts, fm->ofpacts_len, msg);
1538 case OFPUTIL_P_OF10_STD:
1539 case OFPUTIL_P_OF10_STD_TID: {
1540 struct ofp10_flow_mod *ofm;
1542 msg = ofpraw_alloc(OFPRAW_OFPT10_FLOW_MOD, OFP10_VERSION,
1544 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
1545 ofputil_match_to_ofp10_match(&fm->match, &ofm->match);
1546 ofm->cookie = fm->new_cookie;
1547 ofm->command = ofputil_tid_command(fm, protocol);
1548 ofm->idle_timeout = htons(fm->idle_timeout);
1549 ofm->hard_timeout = htons(fm->hard_timeout);
1550 ofm->priority = htons(fm->priority);
1551 ofm->buffer_id = htonl(fm->buffer_id);
1552 ofm->out_port = htons(fm->out_port);
1553 ofm->flags = htons(fm->flags);
1554 ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
1558 case OFPUTIL_P_OF10_NXM:
1559 case OFPUTIL_P_OF10_NXM_TID: {
1560 struct nx_flow_mod *nfm;
1563 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD, OFP10_VERSION,
1564 NXM_TYPICAL_LEN + fm->ofpacts_len);
1565 nfm = ofpbuf_put_zeros(msg, sizeof *nfm);
1566 nfm->command = ofputil_tid_command(fm, protocol);
1567 nfm->cookie = fm->new_cookie;
1568 match_len = nx_put_match(msg, &fm->match, fm->cookie, fm->cookie_mask);
1570 nfm->idle_timeout = htons(fm->idle_timeout);
1571 nfm->hard_timeout = htons(fm->hard_timeout);
1572 nfm->priority = htons(fm->priority);
1573 nfm->buffer_id = htonl(fm->buffer_id);
1574 nfm->out_port = htons(fm->out_port);
1575 nfm->flags = htons(fm->flags);
1576 nfm->match_len = htons(match_len);
1577 ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
1585 ofpmsg_update_length(msg);
1589 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1590 * send all of the 'n_fm's flow table modification requests in 'fms', and a
1591 * 0-bit for each protocol that is inadequate.
1593 * (The return value will have at least one 1-bit.) */
1594 enum ofputil_protocol
1595 ofputil_flow_mod_usable_protocols(const struct ofputil_flow_mod *fms,
1598 enum ofputil_protocol usable_protocols;
1601 usable_protocols = OFPUTIL_P_ANY;
1602 for (i = 0; i < n_fms; i++) {
1603 const struct ofputil_flow_mod *fm = &fms[i];
1605 usable_protocols &= ofputil_usable_protocols(&fm->match);
1606 if (fm->table_id != 0xff) {
1607 usable_protocols &= OFPUTIL_P_TID;
1610 /* Matching of the cookie is only supported through NXM or OF1.1+. */
1611 if (fm->cookie_mask != htonll(0)) {
1612 usable_protocols &= OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1615 assert(usable_protocols);
1617 return usable_protocols;
1621 ofputil_decode_ofpst10_flow_request(struct ofputil_flow_stats_request *fsr,
1622 const struct ofp10_flow_stats_request *ofsr,
1625 fsr->aggregate = aggregate;
1626 ofputil_match_from_ofp10_match(&ofsr->match, &fsr->match);
1627 fsr->out_port = ntohs(ofsr->out_port);
1628 fsr->table_id = ofsr->table_id;
1629 fsr->cookie = fsr->cookie_mask = htonll(0);
1635 ofputil_decode_ofpst11_flow_request(struct ofputil_flow_stats_request *fsr,
1636 struct ofpbuf *b, bool aggregate)
1638 const struct ofp11_flow_stats_request *ofsr;
1641 ofsr = ofpbuf_pull(b, sizeof *ofsr);
1642 fsr->aggregate = aggregate;
1643 fsr->table_id = ofsr->table_id;
1644 error = ofputil_port_from_ofp11(ofsr->out_port, &fsr->out_port);
1648 if (ofsr->out_group != htonl(OFPG11_ANY)) {
1649 return OFPERR_OFPFMFC_UNKNOWN;
1651 fsr->cookie = ofsr->cookie;
1652 fsr->cookie_mask = ofsr->cookie_mask;
1653 error = ofputil_pull_ofp11_match(b, &fsr->match, NULL);
1662 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
1663 struct ofpbuf *b, bool aggregate)
1665 const struct nx_flow_stats_request *nfsr;
1668 nfsr = ofpbuf_pull(b, sizeof *nfsr);
1669 error = nx_pull_match(b, ntohs(nfsr->match_len), &fsr->match,
1670 &fsr->cookie, &fsr->cookie_mask);
1675 return OFPERR_OFPBRC_BAD_LEN;
1678 fsr->aggregate = aggregate;
1679 fsr->out_port = ntohs(nfsr->out_port);
1680 fsr->table_id = nfsr->table_id;
1685 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
1686 * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
1687 * successful, otherwise an OpenFlow error code. */
1689 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
1690 const struct ofp_header *oh)
1695 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1696 raw = ofpraw_pull_assert(&b);
1697 switch ((int) raw) {
1698 case OFPRAW_OFPST10_FLOW_REQUEST:
1699 return ofputil_decode_ofpst10_flow_request(fsr, b.data, false);
1701 case OFPRAW_OFPST10_AGGREGATE_REQUEST:
1702 return ofputil_decode_ofpst10_flow_request(fsr, b.data, true);
1704 case OFPRAW_OFPST11_FLOW_REQUEST:
1705 return ofputil_decode_ofpst11_flow_request(fsr, &b, false);
1707 case OFPRAW_OFPST11_AGGREGATE_REQUEST:
1708 return ofputil_decode_ofpst11_flow_request(fsr, &b, true);
1710 case OFPRAW_NXST_FLOW_REQUEST:
1711 return ofputil_decode_nxst_flow_request(fsr, &b, false);
1713 case OFPRAW_NXST_AGGREGATE_REQUEST:
1714 return ofputil_decode_nxst_flow_request(fsr, &b, true);
1717 /* Hey, the caller lied. */
1722 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
1723 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
1724 * 'protocol', and returns the message. */
1726 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
1727 enum ofputil_protocol protocol)
1733 case OFPUTIL_P_OF12_OXM: {
1734 struct ofp11_flow_stats_request *ofsr;
1736 raw = (fsr->aggregate
1737 ? OFPRAW_OFPST11_AGGREGATE_REQUEST
1738 : OFPRAW_OFPST11_FLOW_REQUEST);
1739 msg = ofpraw_alloc(raw, OFP12_VERSION, NXM_TYPICAL_LEN);
1740 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
1741 ofsr->table_id = fsr->table_id;
1742 ofsr->out_port = ofputil_port_to_ofp11(fsr->out_port);
1743 ofsr->out_group = htonl(OFPG11_ANY);
1744 ofsr->cookie = fsr->cookie;
1745 ofsr->cookie_mask = fsr->cookie_mask;
1746 oxm_put_match(msg, &fsr->match);
1750 case OFPUTIL_P_OF10_STD:
1751 case OFPUTIL_P_OF10_STD_TID: {
1752 struct ofp10_flow_stats_request *ofsr;
1754 raw = (fsr->aggregate
1755 ? OFPRAW_OFPST10_AGGREGATE_REQUEST
1756 : OFPRAW_OFPST10_FLOW_REQUEST);
1757 msg = ofpraw_alloc(raw, OFP10_VERSION, 0);
1758 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
1759 ofputil_match_to_ofp10_match(&fsr->match, &ofsr->match);
1760 ofsr->table_id = fsr->table_id;
1761 ofsr->out_port = htons(fsr->out_port);
1765 case OFPUTIL_P_OF10_NXM:
1766 case OFPUTIL_P_OF10_NXM_TID: {
1767 struct nx_flow_stats_request *nfsr;
1770 raw = (fsr->aggregate
1771 ? OFPRAW_NXST_AGGREGATE_REQUEST
1772 : OFPRAW_NXST_FLOW_REQUEST);
1773 msg = ofpraw_alloc(raw, OFP10_VERSION, NXM_TYPICAL_LEN);
1774 ofpbuf_put_zeros(msg, sizeof *nfsr);
1775 match_len = nx_put_match(msg, &fsr->match,
1776 fsr->cookie, fsr->cookie_mask);
1779 nfsr->out_port = htons(fsr->out_port);
1780 nfsr->match_len = htons(match_len);
1781 nfsr->table_id = fsr->table_id;
1792 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1793 * accurately encode 'fsr', and a 0-bit for each protocol that is inadequate.
1795 * (The return value will have at least one 1-bit.) */
1796 enum ofputil_protocol
1797 ofputil_flow_stats_request_usable_protocols(
1798 const struct ofputil_flow_stats_request *fsr)
1800 enum ofputil_protocol usable_protocols;
1802 usable_protocols = ofputil_usable_protocols(&fsr->match);
1803 if (fsr->cookie_mask != htonll(0)) {
1804 usable_protocols &= OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1806 return usable_protocols;
1809 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
1810 * ofputil_flow_stats in 'fs'.
1812 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
1813 * OpenFlow message. Calling this function multiple times for a single 'msg'
1814 * iterates through the replies. The caller must initially leave 'msg''s layer
1815 * pointers null and not modify them between calls.
1817 * Most switches don't send the values needed to populate fs->idle_age and
1818 * fs->hard_age, so those members will usually be set to 0. If the switch from
1819 * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
1820 * 'flow_age_extension' as true so that the contents of 'msg' determine the
1821 * 'idle_age' and 'hard_age' members in 'fs'.
1823 * Uses 'ofpacts' to store the abstract OFPACT_* version of the flow stats
1824 * reply's actions. The caller must initialize 'ofpacts' and retains ownership
1825 * of it. 'fs->ofpacts' will point into the 'ofpacts' buffer.
1827 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1828 * otherwise a positive errno value. */
1830 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
1832 bool flow_age_extension,
1833 struct ofpbuf *ofpacts)
1839 ? ofpraw_decode(&raw, msg->l2)
1840 : ofpraw_pull(&raw, msg));
1847 } else if (raw == OFPRAW_OFPST11_FLOW_REPLY) {
1848 const struct ofp11_flow_stats *ofs;
1850 uint16_t padded_match_len;
1852 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
1854 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
1855 "bytes at end", msg->size);
1859 length = ntohs(ofs->length);
1860 if (length < sizeof *ofs) {
1861 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
1862 "length %zu", length);
1866 if (ofputil_pull_ofp11_match(msg, &fs->match, &padded_match_len)) {
1867 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad match");
1871 if (ofpacts_pull_openflow11_instructions(msg, length - sizeof *ofs -
1872 padded_match_len, ofpacts)) {
1873 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad instructions");
1877 fs->priority = ntohs(ofs->priority);
1878 fs->table_id = ofs->table_id;
1879 fs->duration_sec = ntohl(ofs->duration_sec);
1880 fs->duration_nsec = ntohl(ofs->duration_nsec);
1881 fs->idle_timeout = ntohs(ofs->idle_timeout);
1882 fs->hard_timeout = ntohs(ofs->hard_timeout);
1885 fs->cookie = ofs->cookie;
1886 fs->packet_count = ntohll(ofs->packet_count);
1887 fs->byte_count = ntohll(ofs->byte_count);
1888 } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
1889 const struct ofp10_flow_stats *ofs;
1892 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
1894 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
1895 "bytes at end", msg->size);
1899 length = ntohs(ofs->length);
1900 if (length < sizeof *ofs) {
1901 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
1902 "length %zu", length);
1906 if (ofpacts_pull_openflow10(msg, length - sizeof *ofs, ofpacts)) {
1910 fs->cookie = get_32aligned_be64(&ofs->cookie);
1911 ofputil_match_from_ofp10_match(&ofs->match, &fs->match);
1912 fs->priority = ntohs(ofs->priority);
1913 fs->table_id = ofs->table_id;
1914 fs->duration_sec = ntohl(ofs->duration_sec);
1915 fs->duration_nsec = ntohl(ofs->duration_nsec);
1916 fs->idle_timeout = ntohs(ofs->idle_timeout);
1917 fs->hard_timeout = ntohs(ofs->hard_timeout);
1920 fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
1921 fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
1922 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
1923 const struct nx_flow_stats *nfs;
1924 size_t match_len, actions_len, length;
1926 nfs = ofpbuf_try_pull(msg, sizeof *nfs);
1928 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
1929 "bytes at end", msg->size);
1933 length = ntohs(nfs->length);
1934 match_len = ntohs(nfs->match_len);
1935 if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
1936 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
1937 "claims invalid length %zu", match_len, length);
1940 if (nx_pull_match(msg, match_len, &fs->match, NULL, NULL)) {
1944 actions_len = length - sizeof *nfs - ROUND_UP(match_len, 8);
1945 if (ofpacts_pull_openflow10(msg, actions_len, ofpacts)) {
1949 fs->cookie = nfs->cookie;
1950 fs->table_id = nfs->table_id;
1951 fs->duration_sec = ntohl(nfs->duration_sec);
1952 fs->duration_nsec = ntohl(nfs->duration_nsec);
1953 fs->priority = ntohs(nfs->priority);
1954 fs->idle_timeout = ntohs(nfs->idle_timeout);
1955 fs->hard_timeout = ntohs(nfs->hard_timeout);
1958 if (flow_age_extension) {
1959 if (nfs->idle_age) {
1960 fs->idle_age = ntohs(nfs->idle_age) - 1;
1962 if (nfs->hard_age) {
1963 fs->hard_age = ntohs(nfs->hard_age) - 1;
1966 fs->packet_count = ntohll(nfs->packet_count);
1967 fs->byte_count = ntohll(nfs->byte_count);
1972 fs->ofpacts = ofpacts->data;
1973 fs->ofpacts_len = ofpacts->size;
1978 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
1980 * We use this in situations where OVS internally uses UINT64_MAX to mean
1981 * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
1983 unknown_to_zero(uint64_t count)
1985 return count != UINT64_MAX ? count : 0;
1988 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
1989 * those already present in the list of ofpbufs in 'replies'. 'replies' should
1990 * have been initialized with ofputil_start_stats_reply(). */
1992 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
1993 struct list *replies)
1995 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
1996 size_t start_ofs = reply->size;
1999 ofpraw_decode_partial(&raw, reply->data, reply->size);
2000 if (raw == OFPRAW_OFPST11_FLOW_REPLY) {
2001 struct ofp11_flow_stats *ofs;
2003 ofpbuf_put_uninit(reply, sizeof *ofs);
2004 oxm_put_match(reply, &fs->match);
2005 ofpacts_put_openflow11_instructions(fs->ofpacts, fs->ofpacts_len,
2008 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
2009 ofs->length = htons(reply->size - start_ofs);
2010 ofs->table_id = fs->table_id;
2012 ofs->duration_sec = htonl(fs->duration_sec);
2013 ofs->duration_nsec = htonl(fs->duration_nsec);
2014 ofs->priority = htons(fs->priority);
2015 ofs->idle_timeout = htons(fs->idle_timeout);
2016 ofs->hard_timeout = htons(fs->hard_timeout);
2017 memset(ofs->pad2, 0, sizeof ofs->pad2);
2018 ofs->cookie = fs->cookie;
2019 ofs->packet_count = htonll(unknown_to_zero(fs->packet_count));
2020 ofs->byte_count = htonll(unknown_to_zero(fs->byte_count));
2021 } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
2022 struct ofp10_flow_stats *ofs;
2024 ofpbuf_put_uninit(reply, sizeof *ofs);
2025 ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
2027 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
2028 ofs->length = htons(reply->size - start_ofs);
2029 ofs->table_id = fs->table_id;
2031 ofputil_match_to_ofp10_match(&fs->match, &ofs->match);
2032 ofs->duration_sec = htonl(fs->duration_sec);
2033 ofs->duration_nsec = htonl(fs->duration_nsec);
2034 ofs->priority = htons(fs->priority);
2035 ofs->idle_timeout = htons(fs->idle_timeout);
2036 ofs->hard_timeout = htons(fs->hard_timeout);
2037 memset(ofs->pad2, 0, sizeof ofs->pad2);
2038 put_32aligned_be64(&ofs->cookie, fs->cookie);
2039 put_32aligned_be64(&ofs->packet_count,
2040 htonll(unknown_to_zero(fs->packet_count)));
2041 put_32aligned_be64(&ofs->byte_count,
2042 htonll(unknown_to_zero(fs->byte_count)));
2043 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
2044 struct nx_flow_stats *nfs;
2047 ofpbuf_put_uninit(reply, sizeof *nfs);
2048 match_len = nx_put_match(reply, &fs->match, 0, 0);
2049 ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
2051 nfs = ofpbuf_at_assert(reply, start_ofs, sizeof *nfs);
2052 nfs->length = htons(reply->size - start_ofs);
2053 nfs->table_id = fs->table_id;
2055 nfs->duration_sec = htonl(fs->duration_sec);
2056 nfs->duration_nsec = htonl(fs->duration_nsec);
2057 nfs->priority = htons(fs->priority);
2058 nfs->idle_timeout = htons(fs->idle_timeout);
2059 nfs->hard_timeout = htons(fs->hard_timeout);
2060 nfs->idle_age = htons(fs->idle_age < 0 ? 0
2061 : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
2063 nfs->hard_age = htons(fs->hard_age < 0 ? 0
2064 : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
2066 nfs->match_len = htons(match_len);
2067 nfs->cookie = fs->cookie;
2068 nfs->packet_count = htonll(fs->packet_count);
2069 nfs->byte_count = htonll(fs->byte_count);
2074 ofpmp_postappend(replies, start_ofs);
2077 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
2078 * NXST_AGGREGATE reply matching 'request', and returns the message. */
2080 ofputil_encode_aggregate_stats_reply(
2081 const struct ofputil_aggregate_stats *stats,
2082 const struct ofp_header *request)
2084 struct ofp_aggregate_stats_reply *asr;
2085 uint64_t packet_count;
2086 uint64_t byte_count;
2090 ofpraw_decode(&raw, request);
2091 if (raw == OFPRAW_OFPST10_AGGREGATE_REQUEST) {
2092 packet_count = unknown_to_zero(stats->packet_count);
2093 byte_count = unknown_to_zero(stats->byte_count);
2095 packet_count = stats->packet_count;
2096 byte_count = stats->byte_count;
2099 msg = ofpraw_alloc_stats_reply(request, 0);
2100 asr = ofpbuf_put_zeros(msg, sizeof *asr);
2101 put_32aligned_be64(&asr->packet_count, htonll(packet_count));
2102 put_32aligned_be64(&asr->byte_count, htonll(byte_count));
2103 asr->flow_count = htonl(stats->flow_count);
2109 ofputil_decode_aggregate_stats_reply(struct ofputil_aggregate_stats *stats,
2110 const struct ofp_header *reply)
2112 struct ofp_aggregate_stats_reply *asr;
2115 ofpbuf_use_const(&msg, reply, ntohs(reply->length));
2116 ofpraw_pull_assert(&msg);
2119 stats->packet_count = ntohll(get_32aligned_be64(&asr->packet_count));
2120 stats->byte_count = ntohll(get_32aligned_be64(&asr->byte_count));
2121 stats->flow_count = ntohl(asr->flow_count);
2126 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
2127 * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
2128 * an OpenFlow error code. */
2130 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
2131 const struct ofp_header *oh)
2136 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2137 raw = ofpraw_pull_assert(&b);
2138 if (raw == OFPRAW_OFPT11_FLOW_REMOVED) {
2139 const struct ofp12_flow_removed *ofr;
2142 ofr = ofpbuf_pull(&b, sizeof *ofr);
2144 error = ofputil_pull_ofp11_match(&b, &fr->match, NULL);
2149 fr->priority = ntohs(ofr->priority);
2150 fr->cookie = ofr->cookie;
2151 fr->reason = ofr->reason;
2152 fr->table_id = ofr->table_id;
2153 fr->duration_sec = ntohl(ofr->duration_sec);
2154 fr->duration_nsec = ntohl(ofr->duration_nsec);
2155 fr->idle_timeout = ntohs(ofr->idle_timeout);
2156 fr->hard_timeout = ntohs(ofr->hard_timeout);
2157 fr->packet_count = ntohll(ofr->packet_count);
2158 fr->byte_count = ntohll(ofr->byte_count);
2159 } else if (raw == OFPRAW_OFPT10_FLOW_REMOVED) {
2160 const struct ofp_flow_removed *ofr;
2162 ofr = ofpbuf_pull(&b, sizeof *ofr);
2164 ofputil_match_from_ofp10_match(&ofr->match, &fr->match);
2165 fr->priority = ntohs(ofr->priority);
2166 fr->cookie = ofr->cookie;
2167 fr->reason = ofr->reason;
2169 fr->duration_sec = ntohl(ofr->duration_sec);
2170 fr->duration_nsec = ntohl(ofr->duration_nsec);
2171 fr->idle_timeout = ntohs(ofr->idle_timeout);
2172 fr->hard_timeout = 0;
2173 fr->packet_count = ntohll(ofr->packet_count);
2174 fr->byte_count = ntohll(ofr->byte_count);
2175 } else if (raw == OFPRAW_NXT_FLOW_REMOVED) {
2176 struct nx_flow_removed *nfr;
2179 nfr = ofpbuf_pull(&b, sizeof *nfr);
2180 error = nx_pull_match(&b, ntohs(nfr->match_len), &fr->match,
2186 return OFPERR_OFPBRC_BAD_LEN;
2189 fr->priority = ntohs(nfr->priority);
2190 fr->cookie = nfr->cookie;
2191 fr->reason = nfr->reason;
2193 fr->duration_sec = ntohl(nfr->duration_sec);
2194 fr->duration_nsec = ntohl(nfr->duration_nsec);
2195 fr->idle_timeout = ntohs(nfr->idle_timeout);
2196 fr->hard_timeout = 0;
2197 fr->packet_count = ntohll(nfr->packet_count);
2198 fr->byte_count = ntohll(nfr->byte_count);
2206 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
2207 * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
2210 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
2211 enum ofputil_protocol protocol)
2216 case OFPUTIL_P_OF12_OXM: {
2217 struct ofp12_flow_removed *ofr;
2219 msg = ofpraw_alloc_xid(OFPRAW_OFPT11_FLOW_REMOVED,
2220 ofputil_protocol_to_ofp_version(protocol),
2221 htonl(0), NXM_TYPICAL_LEN);
2222 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
2223 ofr->cookie = fr->cookie;
2224 ofr->priority = htons(fr->priority);
2225 ofr->reason = fr->reason;
2226 ofr->table_id = fr->table_id;
2227 ofr->duration_sec = htonl(fr->duration_sec);
2228 ofr->duration_nsec = htonl(fr->duration_nsec);
2229 ofr->idle_timeout = htons(fr->idle_timeout);
2230 ofr->hard_timeout = htons(fr->hard_timeout);
2231 ofr->packet_count = htonll(fr->packet_count);
2232 ofr->byte_count = htonll(fr->byte_count);
2233 oxm_put_match(msg, &fr->match);
2237 case OFPUTIL_P_OF10_STD:
2238 case OFPUTIL_P_OF10_STD_TID: {
2239 struct ofp_flow_removed *ofr;
2241 msg = ofpraw_alloc_xid(OFPRAW_OFPT10_FLOW_REMOVED, OFP10_VERSION,
2243 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
2244 ofputil_match_to_ofp10_match(&fr->match, &ofr->match);
2245 ofr->cookie = fr->cookie;
2246 ofr->priority = htons(fr->priority);
2247 ofr->reason = fr->reason;
2248 ofr->duration_sec = htonl(fr->duration_sec);
2249 ofr->duration_nsec = htonl(fr->duration_nsec);
2250 ofr->idle_timeout = htons(fr->idle_timeout);
2251 ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
2252 ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
2256 case OFPUTIL_P_OF10_NXM:
2257 case OFPUTIL_P_OF10_NXM_TID: {
2258 struct nx_flow_removed *nfr;
2261 msg = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_REMOVED, OFP10_VERSION,
2262 htonl(0), NXM_TYPICAL_LEN);
2263 nfr = ofpbuf_put_zeros(msg, sizeof *nfr);
2264 match_len = nx_put_match(msg, &fr->match, 0, 0);
2267 nfr->cookie = fr->cookie;
2268 nfr->priority = htons(fr->priority);
2269 nfr->reason = fr->reason;
2270 nfr->duration_sec = htonl(fr->duration_sec);
2271 nfr->duration_nsec = htonl(fr->duration_nsec);
2272 nfr->idle_timeout = htons(fr->idle_timeout);
2273 nfr->match_len = htons(match_len);
2274 nfr->packet_count = htonll(fr->packet_count);
2275 nfr->byte_count = htonll(fr->byte_count);
2287 ofputil_decode_packet_in_finish(struct ofputil_packet_in *pin,
2288 struct match *match, struct ofpbuf *b)
2290 pin->packet = b->data;
2291 pin->packet_len = b->size;
2293 pin->fmd.in_port = match->flow.in_port;
2294 pin->fmd.tun_id = match->flow.tunnel.tun_id;
2295 pin->fmd.metadata = match->flow.metadata;
2296 memcpy(pin->fmd.regs, match->flow.regs, sizeof pin->fmd.regs);
2300 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
2301 const struct ofp_header *oh)
2306 memset(pin, 0, sizeof *pin);
2308 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2309 raw = ofpraw_pull_assert(&b);
2310 if (raw == OFPRAW_OFPT12_PACKET_IN) {
2311 const struct ofp12_packet_in *opi;
2315 opi = ofpbuf_pull(&b, sizeof *opi);
2316 error = oxm_pull_match_loose(&b, &match);
2321 if (!ofpbuf_try_pull(&b, 2)) {
2322 return OFPERR_OFPBRC_BAD_LEN;
2325 pin->reason = opi->reason;
2326 pin->table_id = opi->table_id;
2328 pin->buffer_id = ntohl(opi->buffer_id);
2329 pin->total_len = ntohs(opi->total_len);
2331 ofputil_decode_packet_in_finish(pin, &match, &b);
2332 } else if (raw == OFPRAW_OFPT10_PACKET_IN) {
2333 const struct ofp_packet_in *opi;
2335 opi = ofpbuf_pull(&b, offsetof(struct ofp_packet_in, data));
2337 pin->packet = opi->data;
2338 pin->packet_len = b.size;
2340 pin->fmd.in_port = ntohs(opi->in_port);
2341 pin->reason = opi->reason;
2342 pin->buffer_id = ntohl(opi->buffer_id);
2343 pin->total_len = ntohs(opi->total_len);
2344 } else if (raw == OFPRAW_NXT_PACKET_IN) {
2345 const struct nx_packet_in *npi;
2349 npi = ofpbuf_pull(&b, sizeof *npi);
2350 error = nx_pull_match_loose(&b, ntohs(npi->match_len), &match, NULL,
2356 if (!ofpbuf_try_pull(&b, 2)) {
2357 return OFPERR_OFPBRC_BAD_LEN;
2360 pin->reason = npi->reason;
2361 pin->table_id = npi->table_id;
2362 pin->cookie = npi->cookie;
2364 pin->buffer_id = ntohl(npi->buffer_id);
2365 pin->total_len = ntohs(npi->total_len);
2367 ofputil_decode_packet_in_finish(pin, &match, &b);
2376 ofputil_packet_in_to_match(const struct ofputil_packet_in *pin,
2377 struct match *match)
2381 match_init_catchall(match);
2382 if (pin->fmd.tun_id != htonll(0)) {
2383 match_set_tun_id(match, pin->fmd.tun_id);
2385 if (pin->fmd.metadata != htonll(0)) {
2386 match_set_metadata(match, pin->fmd.metadata);
2389 for (i = 0; i < FLOW_N_REGS; i++) {
2390 if (pin->fmd.regs[i]) {
2391 match_set_reg(match, i, pin->fmd.regs[i]);
2395 match_set_in_port(match, pin->fmd.in_port);
2398 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
2399 * in the format specified by 'packet_in_format'. */
2401 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
2402 enum ofputil_protocol protocol,
2403 enum nx_packet_in_format packet_in_format)
2405 size_t send_len = MIN(pin->send_len, pin->packet_len);
2406 struct ofpbuf *packet;
2408 /* Add OFPT_PACKET_IN. */
2409 if (protocol == OFPUTIL_P_OF12_OXM) {
2410 struct ofp12_packet_in *opi;
2413 ofputil_packet_in_to_match(pin, &match);
2415 /* The final argument is just an estimate of the space required. */
2416 packet = ofpraw_alloc_xid(OFPRAW_OFPT12_PACKET_IN, OFP12_VERSION,
2417 htonl(0), (sizeof(struct flow_metadata) * 2
2419 ofpbuf_put_zeros(packet, sizeof *opi);
2420 oxm_put_match(packet, &match);
2421 ofpbuf_put_zeros(packet, 2);
2422 ofpbuf_put(packet, pin->packet, send_len);
2425 opi->buffer_id = htonl(pin->buffer_id);
2426 opi->total_len = htons(pin->total_len);
2427 opi->reason = pin->reason;
2428 opi->table_id = pin->table_id;
2429 } else if (packet_in_format == NXPIF_OPENFLOW10) {
2430 struct ofp_packet_in *opi;
2432 packet = ofpraw_alloc_xid(OFPRAW_OFPT10_PACKET_IN, OFP10_VERSION,
2433 htonl(0), send_len);
2434 opi = ofpbuf_put_zeros(packet, offsetof(struct ofp_packet_in, data));
2435 opi->total_len = htons(pin->total_len);
2436 opi->in_port = htons(pin->fmd.in_port);
2437 opi->reason = pin->reason;
2438 opi->buffer_id = htonl(pin->buffer_id);
2440 ofpbuf_put(packet, pin->packet, send_len);
2441 } else if (packet_in_format == NXPIF_NXM) {
2442 struct nx_packet_in *npi;
2446 ofputil_packet_in_to_match(pin, &match);
2448 /* The final argument is just an estimate of the space required. */
2449 packet = ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN, OFP10_VERSION,
2450 htonl(0), (sizeof(struct flow_metadata) * 2
2452 ofpbuf_put_zeros(packet, sizeof *npi);
2453 match_len = nx_put_match(packet, &match, 0, 0);
2454 ofpbuf_put_zeros(packet, 2);
2455 ofpbuf_put(packet, pin->packet, send_len);
2458 npi->buffer_id = htonl(pin->buffer_id);
2459 npi->total_len = htons(pin->total_len);
2460 npi->reason = pin->reason;
2461 npi->table_id = pin->table_id;
2462 npi->cookie = pin->cookie;
2463 npi->match_len = htons(match_len);
2467 ofpmsg_update_length(packet);
2473 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason)
2475 static char s[INT_STRLEN(int) + 1];
2482 case OFPR_INVALID_TTL:
2483 return "invalid_ttl";
2485 case OFPR_N_REASONS:
2487 sprintf(s, "%d", (int) reason);
2493 ofputil_packet_in_reason_from_string(const char *s,
2494 enum ofp_packet_in_reason *reason)
2498 for (i = 0; i < OFPR_N_REASONS; i++) {
2499 if (!strcasecmp(s, ofputil_packet_in_reason_to_string(i))) {
2507 /* Converts an OFPT_PACKET_OUT in 'opo' into an abstract ofputil_packet_out in
2510 * Uses 'ofpacts' to store the abstract OFPACT_* version of the packet out
2511 * message's actions. The caller must initialize 'ofpacts' and retains
2512 * ownership of it. 'po->ofpacts' will point into the 'ofpacts' buffer.
2514 * Returns 0 if successful, otherwise an OFPERR_* value. */
2516 ofputil_decode_packet_out(struct ofputil_packet_out *po,
2517 const struct ofp_header *oh,
2518 struct ofpbuf *ofpacts)
2523 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2524 raw = ofpraw_pull_assert(&b);
2526 if (raw == OFPRAW_OFPT11_PACKET_OUT) {
2528 const struct ofp11_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
2530 po->buffer_id = ntohl(opo->buffer_id);
2531 error = ofputil_port_from_ofp11(opo->in_port, &po->in_port);
2536 error = ofpacts_pull_openflow11_actions(&b, ntohs(opo->actions_len),
2541 } else if (raw == OFPRAW_OFPT10_PACKET_OUT) {
2543 const struct ofp_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
2545 po->buffer_id = ntohl(opo->buffer_id);
2546 po->in_port = ntohs(opo->in_port);
2548 error = ofpacts_pull_openflow10(&b, ntohs(opo->actions_len), ofpacts);
2556 if (po->in_port >= OFPP_MAX && po->in_port != OFPP_LOCAL
2557 && po->in_port != OFPP_NONE && po->in_port != OFPP_CONTROLLER) {
2558 VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
2560 return OFPERR_OFPBRC_BAD_PORT;
2563 po->ofpacts = ofpacts->data;
2564 po->ofpacts_len = ofpacts->size;
2566 if (po->buffer_id == UINT32_MAX) {
2567 po->packet = b.data;
2568 po->packet_len = b.size;
2577 /* ofputil_phy_port */
2579 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
2580 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
2581 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
2582 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
2583 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
2584 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
2585 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
2586 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
2588 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
2589 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
2590 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
2591 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
2592 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
2593 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
2595 static enum netdev_features
2596 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
2598 uint32_t ofp10 = ntohl(ofp10_);
2599 return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
2603 netdev_port_features_to_ofp10(enum netdev_features features)
2605 return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
2608 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
2609 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
2610 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
2611 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
2612 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
2613 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
2614 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
2615 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD == OFPPF11_40GB_FD); /* bit 7 */
2616 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD == OFPPF11_100GB_FD); /* bit 8 */
2617 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD == OFPPF11_1TB_FD); /* bit 9 */
2618 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER == OFPPF11_OTHER); /* bit 10 */
2619 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == OFPPF11_COPPER); /* bit 11 */
2620 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == OFPPF11_FIBER); /* bit 12 */
2621 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == OFPPF11_AUTONEG); /* bit 13 */
2622 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == OFPPF11_PAUSE); /* bit 14 */
2623 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
2625 static enum netdev_features
2626 netdev_port_features_from_ofp11(ovs_be32 ofp11)
2628 return ntohl(ofp11) & 0xffff;
2632 netdev_port_features_to_ofp11(enum netdev_features features)
2634 return htonl(features & 0xffff);
2638 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
2639 const struct ofp10_phy_port *opp)
2641 memset(pp, 0, sizeof *pp);
2643 pp->port_no = ntohs(opp->port_no);
2644 memcpy(pp->hw_addr, opp->hw_addr, OFP_ETH_ALEN);
2645 ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
2647 pp->config = ntohl(opp->config) & OFPPC10_ALL;
2648 pp->state = ntohl(opp->state) & OFPPS10_ALL;
2650 pp->curr = netdev_port_features_from_ofp10(opp->curr);
2651 pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
2652 pp->supported = netdev_port_features_from_ofp10(opp->supported);
2653 pp->peer = netdev_port_features_from_ofp10(opp->peer);
2655 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2656 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2662 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
2663 const struct ofp11_port *op)
2667 memset(pp, 0, sizeof *pp);
2669 error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
2673 memcpy(pp->hw_addr, op->hw_addr, OFP_ETH_ALEN);
2674 ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
2676 pp->config = ntohl(op->config) & OFPPC11_ALL;
2677 pp->state = ntohl(op->state) & OFPPC11_ALL;
2679 pp->curr = netdev_port_features_from_ofp11(op->curr);
2680 pp->advertised = netdev_port_features_from_ofp11(op->advertised);
2681 pp->supported = netdev_port_features_from_ofp11(op->supported);
2682 pp->peer = netdev_port_features_from_ofp11(op->peer);
2684 pp->curr_speed = ntohl(op->curr_speed);
2685 pp->max_speed = ntohl(op->max_speed);
2691 ofputil_get_phy_port_size(enum ofp_version ofp_version)
2693 switch (ofp_version) {
2695 return sizeof(struct ofp10_phy_port);
2698 return sizeof(struct ofp11_port);
2705 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
2706 struct ofp10_phy_port *opp)
2708 memset(opp, 0, sizeof *opp);
2710 opp->port_no = htons(pp->port_no);
2711 memcpy(opp->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2712 ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2714 opp->config = htonl(pp->config & OFPPC10_ALL);
2715 opp->state = htonl(pp->state & OFPPS10_ALL);
2717 opp->curr = netdev_port_features_to_ofp10(pp->curr);
2718 opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
2719 opp->supported = netdev_port_features_to_ofp10(pp->supported);
2720 opp->peer = netdev_port_features_to_ofp10(pp->peer);
2724 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
2725 struct ofp11_port *op)
2727 memset(op, 0, sizeof *op);
2729 op->port_no = ofputil_port_to_ofp11(pp->port_no);
2730 memcpy(op->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2731 ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2733 op->config = htonl(pp->config & OFPPC11_ALL);
2734 op->state = htonl(pp->state & OFPPS11_ALL);
2736 op->curr = netdev_port_features_to_ofp11(pp->curr);
2737 op->advertised = netdev_port_features_to_ofp11(pp->advertised);
2738 op->supported = netdev_port_features_to_ofp11(pp->supported);
2739 op->peer = netdev_port_features_to_ofp11(pp->peer);
2741 op->curr_speed = htonl(pp->curr_speed);
2742 op->max_speed = htonl(pp->max_speed);
2746 ofputil_put_phy_port(enum ofp_version ofp_version,
2747 const struct ofputil_phy_port *pp, struct ofpbuf *b)
2749 switch (ofp_version) {
2750 case OFP10_VERSION: {
2751 struct ofp10_phy_port *opp;
2752 if (b->size + sizeof *opp <= UINT16_MAX) {
2753 opp = ofpbuf_put_uninit(b, sizeof *opp);
2754 ofputil_encode_ofp10_phy_port(pp, opp);
2760 case OFP12_VERSION: {
2761 struct ofp11_port *op;
2762 if (b->size + sizeof *op <= UINT16_MAX) {
2763 op = ofpbuf_put_uninit(b, sizeof *op);
2764 ofputil_encode_ofp11_port(pp, op);
2775 ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
2776 const struct ofputil_phy_port *pp,
2777 struct list *replies)
2779 switch (ofp_version) {
2780 case OFP10_VERSION: {
2781 struct ofp10_phy_port *opp;
2783 opp = ofpmp_append(replies, sizeof *opp);
2784 ofputil_encode_ofp10_phy_port(pp, opp);
2789 case OFP12_VERSION: {
2790 struct ofp11_port *op;
2792 op = ofpmp_append(replies, sizeof *op);
2793 ofputil_encode_ofp11_port(pp, op);
2802 /* ofputil_switch_features */
2804 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
2805 OFPC_IP_REASM | OFPC_QUEUE_STATS)
2806 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
2807 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
2808 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
2809 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
2810 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
2811 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
2813 struct ofputil_action_bit_translation {
2814 enum ofputil_action_bitmap ofputil_bit;
2818 static const struct ofputil_action_bit_translation of10_action_bits[] = {
2819 { OFPUTIL_A_OUTPUT, OFPAT10_OUTPUT },
2820 { OFPUTIL_A_SET_VLAN_VID, OFPAT10_SET_VLAN_VID },
2821 { OFPUTIL_A_SET_VLAN_PCP, OFPAT10_SET_VLAN_PCP },
2822 { OFPUTIL_A_STRIP_VLAN, OFPAT10_STRIP_VLAN },
2823 { OFPUTIL_A_SET_DL_SRC, OFPAT10_SET_DL_SRC },
2824 { OFPUTIL_A_SET_DL_DST, OFPAT10_SET_DL_DST },
2825 { OFPUTIL_A_SET_NW_SRC, OFPAT10_SET_NW_SRC },
2826 { OFPUTIL_A_SET_NW_DST, OFPAT10_SET_NW_DST },
2827 { OFPUTIL_A_SET_NW_TOS, OFPAT10_SET_NW_TOS },
2828 { OFPUTIL_A_SET_TP_SRC, OFPAT10_SET_TP_SRC },
2829 { OFPUTIL_A_SET_TP_DST, OFPAT10_SET_TP_DST },
2830 { OFPUTIL_A_ENQUEUE, OFPAT10_ENQUEUE },
2834 static enum ofputil_action_bitmap
2835 decode_action_bits(ovs_be32 of_actions,
2836 const struct ofputil_action_bit_translation *x)
2838 enum ofputil_action_bitmap ofputil_actions;
2840 ofputil_actions = 0;
2841 for (; x->ofputil_bit; x++) {
2842 if (of_actions & htonl(1u << x->of_bit)) {
2843 ofputil_actions |= x->ofputil_bit;
2846 return ofputil_actions;
2850 ofputil_capabilities_mask(enum ofp_version ofp_version)
2852 /* Handle capabilities whose bit is unique for all Open Flow versions */
2853 switch (ofp_version) {
2856 return OFPC_COMMON | OFPC_ARP_MATCH_IP;
2858 return OFPC_COMMON | OFPC12_PORT_BLOCKED;
2860 /* Caller needs to check osf->header.version itself */
2865 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
2866 * abstract representation in '*features'. Initializes '*b' to iterate over
2867 * the OpenFlow port structures following 'osf' with later calls to
2868 * ofputil_pull_phy_port(). Returns 0 if successful, otherwise an
2869 * OFPERR_* value. */
2871 ofputil_decode_switch_features(const struct ofp_header *oh,
2872 struct ofputil_switch_features *features,
2875 const struct ofp_switch_features *osf;
2878 ofpbuf_use_const(b, oh, ntohs(oh->length));
2879 raw = ofpraw_pull_assert(b);
2881 osf = ofpbuf_pull(b, sizeof *osf);
2882 features->datapath_id = ntohll(osf->datapath_id);
2883 features->n_buffers = ntohl(osf->n_buffers);
2884 features->n_tables = osf->n_tables;
2886 features->capabilities = ntohl(osf->capabilities) &
2887 ofputil_capabilities_mask(oh->version);
2889 if (b->size % ofputil_get_phy_port_size(oh->version)) {
2890 return OFPERR_OFPBRC_BAD_LEN;
2893 if (raw == OFPRAW_OFPT10_FEATURES_REPLY) {
2894 if (osf->capabilities & htonl(OFPC10_STP)) {
2895 features->capabilities |= OFPUTIL_C_STP;
2897 features->actions = decode_action_bits(osf->actions, of10_action_bits);
2898 } else if (raw == OFPRAW_OFPT11_FEATURES_REPLY) {
2899 if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
2900 features->capabilities |= OFPUTIL_C_GROUP_STATS;
2902 features->actions = 0;
2904 return OFPERR_OFPBRC_BAD_VERSION;
2910 /* Returns true if the maximum number of ports are in 'oh'. */
2912 max_ports_in_features(const struct ofp_header *oh)
2914 size_t pp_size = ofputil_get_phy_port_size(oh->version);
2915 return ntohs(oh->length) + pp_size > UINT16_MAX;
2918 /* Given a buffer 'b' that contains a Features Reply message, checks if
2919 * it contains the maximum number of ports that will fit. If so, it
2920 * returns true and removes the ports from the message. The caller
2921 * should then send an OFPST_PORT_DESC stats request to get the ports,
2922 * since the switch may have more ports than could be represented in the
2923 * Features Reply. Otherwise, returns false.
2926 ofputil_switch_features_ports_trunc(struct ofpbuf *b)
2928 struct ofp_header *oh = b->data;
2930 if (max_ports_in_features(oh)) {
2931 /* Remove all the ports. */
2932 b->size = (sizeof(struct ofp_header)
2933 + sizeof(struct ofp_switch_features));
2934 ofpmsg_update_length(b);
2943 encode_action_bits(enum ofputil_action_bitmap ofputil_actions,
2944 const struct ofputil_action_bit_translation *x)
2946 uint32_t of_actions;
2949 for (; x->ofputil_bit; x++) {
2950 if (ofputil_actions & x->ofputil_bit) {
2951 of_actions |= 1 << x->of_bit;
2954 return htonl(of_actions);
2957 /* Returns a buffer owned by the caller that encodes 'features' in the format
2958 * required by 'protocol' with the given 'xid'. The caller should append port
2959 * information to the buffer with subsequent calls to
2960 * ofputil_put_switch_features_port(). */
2962 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
2963 enum ofputil_protocol protocol, ovs_be32 xid)
2965 struct ofp_switch_features *osf;
2967 enum ofp_version version;
2970 version = ofputil_protocol_to_ofp_version(protocol);
2973 raw = OFPRAW_OFPT10_FEATURES_REPLY;
2977 raw = OFPRAW_OFPT11_FEATURES_REPLY;
2982 b = ofpraw_alloc_xid(raw, version, xid, 0);
2983 osf = ofpbuf_put_zeros(b, sizeof *osf);
2984 osf->datapath_id = htonll(features->datapath_id);
2985 osf->n_buffers = htonl(features->n_buffers);
2986 osf->n_tables = features->n_tables;
2988 osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
2989 osf->capabilities = htonl(features->capabilities &
2990 ofputil_capabilities_mask(version));
2993 if (features->capabilities & OFPUTIL_C_STP) {
2994 osf->capabilities |= htonl(OFPC10_STP);
2996 osf->actions = encode_action_bits(features->actions, of10_action_bits);
3000 if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
3001 osf->capabilities |= htonl(OFPC11_GROUP_STATS);
3011 /* Encodes 'pp' into the format required by the switch_features message already
3012 * in 'b', which should have been returned by ofputil_encode_switch_features(),
3013 * and appends the encoded version to 'b'. */
3015 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
3018 const struct ofp_header *oh = b->data;
3020 ofputil_put_phy_port(oh->version, pp, b);
3023 /* ofputil_port_status */
3025 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
3026 * in '*ps'. Returns 0 if successful, otherwise an OFPERR_* value. */
3028 ofputil_decode_port_status(const struct ofp_header *oh,
3029 struct ofputil_port_status *ps)
3031 const struct ofp_port_status *ops;
3035 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3036 ofpraw_pull_assert(&b);
3037 ops = ofpbuf_pull(&b, sizeof *ops);
3039 if (ops->reason != OFPPR_ADD &&
3040 ops->reason != OFPPR_DELETE &&
3041 ops->reason != OFPPR_MODIFY) {
3042 return OFPERR_NXBRC_BAD_REASON;
3044 ps->reason = ops->reason;
3046 retval = ofputil_pull_phy_port(oh->version, &b, &ps->desc);
3047 assert(retval != EOF);
3051 /* Converts the abstract form of a "port status" message in '*ps' into an
3052 * OpenFlow message suitable for 'protocol', and returns that encoded form in
3053 * a buffer owned by the caller. */
3055 ofputil_encode_port_status(const struct ofputil_port_status *ps,
3056 enum ofputil_protocol protocol)
3058 struct ofp_port_status *ops;
3060 enum ofp_version version;
3063 version = ofputil_protocol_to_ofp_version(protocol);
3066 raw = OFPRAW_OFPT10_PORT_STATUS;
3071 raw = OFPRAW_OFPT11_PORT_STATUS;
3078 b = ofpraw_alloc_xid(raw, version, htonl(0), 0);
3079 ops = ofpbuf_put_zeros(b, sizeof *ops);
3080 ops->reason = ps->reason;
3081 ofputil_put_phy_port(version, &ps->desc, b);
3082 ofpmsg_update_length(b);
3086 /* ofputil_port_mod */
3088 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
3089 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
3091 ofputil_decode_port_mod(const struct ofp_header *oh,
3092 struct ofputil_port_mod *pm)
3097 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3098 raw = ofpraw_pull_assert(&b);
3100 if (raw == OFPRAW_OFPT10_PORT_MOD) {
3101 const struct ofp10_port_mod *opm = b.data;
3103 pm->port_no = ntohs(opm->port_no);
3104 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
3105 pm->config = ntohl(opm->config) & OFPPC10_ALL;
3106 pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
3107 pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
3108 } else if (raw == OFPRAW_OFPT11_PORT_MOD) {
3109 const struct ofp11_port_mod *opm = b.data;
3112 error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
3117 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
3118 pm->config = ntohl(opm->config) & OFPPC11_ALL;
3119 pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
3120 pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
3122 return OFPERR_OFPBRC_BAD_TYPE;
3125 pm->config &= pm->mask;
3129 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
3130 * message suitable for 'protocol', and returns that encoded form in a buffer
3131 * owned by the caller. */
3133 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
3134 enum ofputil_protocol protocol)
3136 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
3139 switch (ofp_version) {
3140 case OFP10_VERSION: {
3141 struct ofp10_port_mod *opm;
3143 b = ofpraw_alloc(OFPRAW_OFPT10_PORT_MOD, ofp_version, 0);
3144 opm = ofpbuf_put_zeros(b, sizeof *opm);
3145 opm->port_no = htons(pm->port_no);
3146 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
3147 opm->config = htonl(pm->config & OFPPC10_ALL);
3148 opm->mask = htonl(pm->mask & OFPPC10_ALL);
3149 opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
3154 case OFP12_VERSION: {
3155 struct ofp11_port_mod *opm;
3157 b = ofpraw_alloc(OFPRAW_OFPT11_PORT_MOD, ofp_version, 0);
3158 opm = ofpbuf_put_zeros(b, sizeof *opm);
3159 opm->port_no = ofputil_port_to_ofp11(pm->port_no);
3160 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
3161 opm->config = htonl(pm->config & OFPPC11_ALL);
3162 opm->mask = htonl(pm->mask & OFPPC11_ALL);
3163 opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
3177 ofputil_put_ofp10_table_stats(const struct ofp12_table_stats *in,
3181 enum ofp_flow_wildcards wc10;
3182 enum oxm12_ofb_match_fields mf12;
3185 static const struct wc_map wc_map[] = {
3186 { OFPFW10_IN_PORT, OFPXMT12_OFB_IN_PORT },
3187 { OFPFW10_DL_VLAN, OFPXMT12_OFB_VLAN_VID },
3188 { OFPFW10_DL_SRC, OFPXMT12_OFB_ETH_SRC },
3189 { OFPFW10_DL_DST, OFPXMT12_OFB_ETH_DST},
3190 { OFPFW10_DL_TYPE, OFPXMT12_OFB_ETH_TYPE },
3191 { OFPFW10_NW_PROTO, OFPXMT12_OFB_IP_PROTO },
3192 { OFPFW10_TP_SRC, OFPXMT12_OFB_TCP_SRC },
3193 { OFPFW10_TP_DST, OFPXMT12_OFB_TCP_DST },
3194 { OFPFW10_NW_SRC_MASK, OFPXMT12_OFB_IPV4_SRC },
3195 { OFPFW10_NW_DST_MASK, OFPXMT12_OFB_IPV4_DST },
3196 { OFPFW10_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP },
3197 { OFPFW10_NW_TOS, OFPXMT12_OFB_IP_DSCP },
3200 struct ofp10_table_stats *out;
3201 const struct wc_map *p;
3203 out = ofpbuf_put_uninit(buf, sizeof *out);
3204 out->table_id = in->table_id;
3205 strcpy(out->name, in->name);
3207 for (p = wc_map; p < &wc_map[ARRAY_SIZE(wc_map)]; p++) {
3208 if (in->wildcards & htonll(1ULL << p->mf12)) {
3209 out->wildcards |= htonl(p->wc10);
3212 out->max_entries = in->max_entries;
3213 out->active_count = in->active_count;
3214 put_32aligned_be64(&out->lookup_count, in->lookup_count);
3215 put_32aligned_be64(&out->matched_count, in->matched_count);
3219 oxm12_to_ofp11_flow_match_fields(ovs_be64 oxm12)
3222 enum ofp11_flow_match_fields fmf11;
3223 enum oxm12_ofb_match_fields mf12;
3226 static const struct map map[] = {
3227 { OFPFMF11_IN_PORT, OFPXMT12_OFB_IN_PORT },
3228 { OFPFMF11_DL_VLAN, OFPXMT12_OFB_VLAN_VID },
3229 { OFPFMF11_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP },
3230 { OFPFMF11_DL_TYPE, OFPXMT12_OFB_ETH_TYPE },
3231 { OFPFMF11_NW_TOS, OFPXMT12_OFB_IP_DSCP },
3232 { OFPFMF11_NW_PROTO, OFPXMT12_OFB_IP_PROTO },
3233 { OFPFMF11_TP_SRC, OFPXMT12_OFB_TCP_SRC },
3234 { OFPFMF11_TP_DST, OFPXMT12_OFB_TCP_DST },
3235 { OFPFMF11_MPLS_LABEL, OFPXMT12_OFB_MPLS_LABEL },
3236 { OFPFMF11_MPLS_TC, OFPXMT12_OFB_MPLS_TC },
3237 /* I don't know what OFPFMF11_TYPE means. */
3238 { OFPFMF11_DL_SRC, OFPXMT12_OFB_ETH_SRC },
3239 { OFPFMF11_DL_DST, OFPXMT12_OFB_ETH_DST },
3240 { OFPFMF11_NW_SRC, OFPXMT12_OFB_IPV4_SRC },
3241 { OFPFMF11_NW_DST, OFPXMT12_OFB_IPV4_DST },
3242 { OFPFMF11_METADATA, OFPXMT12_OFB_METADATA },
3245 const struct map *p;
3249 for (p = map; p < &map[ARRAY_SIZE(map)]; p++) {
3250 if (oxm12 & htonll(1ULL << p->mf12)) {
3254 return htonl(fmf11);
3258 ofputil_put_ofp11_table_stats(const struct ofp12_table_stats *in,
3261 struct ofp11_table_stats *out;
3263 out = ofpbuf_put_uninit(buf, sizeof *out);
3264 out->table_id = in->table_id;
3265 strcpy(out->name, in->name);
3266 out->wildcards = oxm12_to_ofp11_flow_match_fields(in->wildcards);
3267 out->match = oxm12_to_ofp11_flow_match_fields(in->match);
3268 out->instructions = in->instructions;
3269 out->write_actions = in->write_actions;
3270 out->apply_actions = in->apply_actions;
3271 out->config = in->config;
3272 out->max_entries = in->max_entries;
3273 out->active_count = in->active_count;
3274 out->lookup_count = in->lookup_count;
3275 out->matched_count = in->matched_count;
3279 ofputil_encode_table_stats_reply(const struct ofp12_table_stats stats[], int n,
3280 const struct ofp_header *request)
3282 struct ofpbuf *reply;
3285 reply = ofpraw_alloc_stats_reply(request, n * sizeof *stats);
3287 switch ((enum ofp_version) request->version) {
3289 for (i = 0; i < n; i++) {
3290 ofputil_put_ofp10_table_stats(&stats[i], reply);
3295 for (i = 0; i < n; i++) {
3296 ofputil_put_ofp11_table_stats(&stats[i], reply);
3301 ofpbuf_put(reply, stats, n * sizeof *stats);
3311 /* ofputil_flow_monitor_request */
3313 /* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract
3314 * ofputil_flow_monitor_request in 'rq'.
3316 * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow
3317 * message. Calling this function multiple times for a single 'msg' iterates
3318 * through the requests. The caller must initially leave 'msg''s layer
3319 * pointers null and not modify them between calls.
3321 * Returns 0 if successful, EOF if no requests were left in this 'msg',
3322 * otherwise an OFPERR_* value. */
3324 ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *rq,
3327 struct nx_flow_monitor_request *nfmr;
3331 msg->l2 = msg->data;
3332 ofpraw_pull_assert(msg);
3339 nfmr = ofpbuf_try_pull(msg, sizeof *nfmr);
3341 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR request has %zu "
3342 "leftover bytes at end", msg->size);
3343 return OFPERR_OFPBRC_BAD_LEN;
3346 flags = ntohs(nfmr->flags);
3347 if (!(flags & (NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY))
3348 || flags & ~(NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE
3349 | NXFMF_MODIFY | NXFMF_ACTIONS | NXFMF_OWN)) {
3350 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR has bad flags %#"PRIx16,
3352 return OFPERR_NXBRC_FM_BAD_FLAGS;
3355 if (!is_all_zeros(nfmr->zeros, sizeof nfmr->zeros)) {
3356 return OFPERR_NXBRC_MUST_BE_ZERO;
3359 rq->id = ntohl(nfmr->id);
3361 rq->out_port = ntohs(nfmr->out_port);
3362 rq->table_id = nfmr->table_id;
3364 return nx_pull_match(msg, ntohs(nfmr->match_len), &rq->match, NULL, NULL);
3368 ofputil_append_flow_monitor_request(
3369 const struct ofputil_flow_monitor_request *rq, struct ofpbuf *msg)
3371 struct nx_flow_monitor_request *nfmr;
3376 ofpraw_put(OFPRAW_NXST_FLOW_MONITOR_REQUEST, OFP10_VERSION, msg);
3379 start_ofs = msg->size;
3380 ofpbuf_put_zeros(msg, sizeof *nfmr);
3381 match_len = nx_put_match(msg, &rq->match, htonll(0), htonll(0));
3383 nfmr = ofpbuf_at_assert(msg, start_ofs, sizeof *nfmr);
3384 nfmr->id = htonl(rq->id);
3385 nfmr->flags = htons(rq->flags);
3386 nfmr->out_port = htons(rq->out_port);
3387 nfmr->match_len = htons(match_len);
3388 nfmr->table_id = rq->table_id;
3391 /* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg'
3392 * into an abstract ofputil_flow_update in 'update'. The caller must have
3393 * initialized update->match to point to space allocated for a match.
3395 * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's
3396 * actions (except for NXFME_ABBREV, which never includes actions). The caller
3397 * must initialize 'ofpacts' and retains ownership of it. 'update->ofpacts'
3398 * will point into the 'ofpacts' buffer.
3400 * Multiple flow updates can be packed into a single OpenFlow message. Calling
3401 * this function multiple times for a single 'msg' iterates through the
3402 * updates. The caller must initially leave 'msg''s layer pointers null and
3403 * not modify them between calls.
3405 * Returns 0 if successful, EOF if no updates were left in this 'msg',
3406 * otherwise an OFPERR_* value. */
3408 ofputil_decode_flow_update(struct ofputil_flow_update *update,
3409 struct ofpbuf *msg, struct ofpbuf *ofpacts)
3411 struct nx_flow_update_header *nfuh;
3412 unsigned int length;
3415 msg->l2 = msg->data;
3416 ofpraw_pull_assert(msg);
3423 if (msg->size < sizeof(struct nx_flow_update_header)) {
3428 update->event = ntohs(nfuh->event);
3429 length = ntohs(nfuh->length);
3430 if (length > msg->size || length % 8) {
3434 if (update->event == NXFME_ABBREV) {
3435 struct nx_flow_update_abbrev *nfua;
3437 if (length != sizeof *nfua) {
3441 nfua = ofpbuf_pull(msg, sizeof *nfua);
3442 update->xid = nfua->xid;
3444 } else if (update->event == NXFME_ADDED
3445 || update->event == NXFME_DELETED
3446 || update->event == NXFME_MODIFIED) {
3447 struct nx_flow_update_full *nfuf;
3448 unsigned int actions_len;
3449 unsigned int match_len;
3452 if (length < sizeof *nfuf) {
3456 nfuf = ofpbuf_pull(msg, sizeof *nfuf);
3457 match_len = ntohs(nfuf->match_len);
3458 if (sizeof *nfuf + match_len > length) {
3462 update->reason = ntohs(nfuf->reason);
3463 update->idle_timeout = ntohs(nfuf->idle_timeout);
3464 update->hard_timeout = ntohs(nfuf->hard_timeout);
3465 update->table_id = nfuf->table_id;
3466 update->cookie = nfuf->cookie;
3467 update->priority = ntohs(nfuf->priority);
3469 error = nx_pull_match(msg, match_len, update->match, NULL, NULL);
3474 actions_len = length - sizeof *nfuf - ROUND_UP(match_len, 8);
3475 error = ofpacts_pull_openflow10(msg, actions_len, ofpacts);
3480 update->ofpacts = ofpacts->data;
3481 update->ofpacts_len = ofpacts->size;
3484 VLOG_WARN_RL(&bad_ofmsg_rl,
3485 "NXST_FLOW_MONITOR reply has bad event %"PRIu16,
3486 ntohs(nfuh->event));
3487 return OFPERR_OFPET_BAD_REQUEST;
3491 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR reply has %zu "
3492 "leftover bytes at end", msg->size);
3493 return OFPERR_OFPBRC_BAD_LEN;
3497 ofputil_decode_flow_monitor_cancel(const struct ofp_header *oh)
3499 const struct nx_flow_monitor_cancel *cancel = ofpmsg_body(oh);
3501 return ntohl(cancel->id);
3505 ofputil_encode_flow_monitor_cancel(uint32_t id)
3507 struct nx_flow_monitor_cancel *nfmc;
3510 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MONITOR_CANCEL, OFP10_VERSION, 0);
3511 nfmc = ofpbuf_put_uninit(msg, sizeof *nfmc);
3512 nfmc->id = htonl(id);
3517 ofputil_start_flow_update(struct list *replies)
3521 msg = ofpraw_alloc_xid(OFPRAW_NXST_FLOW_MONITOR_REPLY, OFP10_VERSION,
3525 list_push_back(replies, &msg->list_node);
3529 ofputil_append_flow_update(const struct ofputil_flow_update *update,
3530 struct list *replies)
3532 struct nx_flow_update_header *nfuh;
3536 msg = ofpbuf_from_list(list_back(replies));
3537 start_ofs = msg->size;
3539 if (update->event == NXFME_ABBREV) {
3540 struct nx_flow_update_abbrev *nfua;
3542 nfua = ofpbuf_put_zeros(msg, sizeof *nfua);
3543 nfua->xid = update->xid;
3545 struct nx_flow_update_full *nfuf;
3548 ofpbuf_put_zeros(msg, sizeof *nfuf);
3549 match_len = nx_put_match(msg, update->match, htonll(0), htonll(0));
3550 ofpacts_put_openflow10(update->ofpacts, update->ofpacts_len, msg);
3552 nfuf = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuf);
3553 nfuf->reason = htons(update->reason);
3554 nfuf->priority = htons(update->priority);
3555 nfuf->idle_timeout = htons(update->idle_timeout);
3556 nfuf->hard_timeout = htons(update->hard_timeout);
3557 nfuf->match_len = htons(match_len);
3558 nfuf->table_id = update->table_id;
3559 nfuf->cookie = update->cookie;
3562 nfuh = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuh);
3563 nfuh->length = htons(msg->size - start_ofs);
3564 nfuh->event = htons(update->event);
3566 ofpmp_postappend(replies, start_ofs);
3570 ofputil_encode_packet_out(const struct ofputil_packet_out *po,
3571 enum ofputil_protocol protocol)
3573 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
3577 size = po->ofpacts_len;
3578 if (po->buffer_id == UINT32_MAX) {
3579 size += po->packet_len;
3582 switch (ofp_version) {
3583 case OFP10_VERSION: {
3584 struct ofp_packet_out *opo;
3587 msg = ofpraw_alloc(OFPRAW_OFPT10_PACKET_OUT, OFP10_VERSION, size);
3588 ofpbuf_put_zeros(msg, sizeof *opo);
3589 actions_ofs = msg->size;
3590 ofpacts_put_openflow10(po->ofpacts, po->ofpacts_len, msg);
3593 opo->buffer_id = htonl(po->buffer_id);
3594 opo->in_port = htons(po->in_port);
3595 opo->actions_len = htons(msg->size - actions_ofs);
3600 case OFP12_VERSION: {
3601 struct ofp11_packet_out *opo;
3604 msg = ofpraw_alloc(OFPRAW_OFPT11_PACKET_OUT, ofp_version, size);
3605 ofpbuf_put_zeros(msg, sizeof *opo);
3606 len = ofpacts_put_openflow11_actions(po->ofpacts, po->ofpacts_len, msg);
3609 opo->buffer_id = htonl(po->buffer_id);
3610 opo->in_port = ofputil_port_to_ofp11(po->in_port);
3611 opo->actions_len = htons(len);
3619 if (po->buffer_id == UINT32_MAX) {
3620 ofpbuf_put(msg, po->packet, po->packet_len);
3623 ofpmsg_update_length(msg);
3628 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
3630 make_echo_request(enum ofp_version ofp_version)
3632 return ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST, ofp_version,
3636 /* Creates and returns an OFPT_ECHO_REPLY message matching the
3637 * OFPT_ECHO_REQUEST message in 'rq'. */
3639 make_echo_reply(const struct ofp_header *rq)
3641 struct ofpbuf rq_buf;
3642 struct ofpbuf *reply;
3644 ofpbuf_use_const(&rq_buf, rq, ntohs(rq->length));
3645 ofpraw_pull_assert(&rq_buf);
3647 reply = ofpraw_alloc_reply(OFPRAW_OFPT_ECHO_REPLY, rq, rq_buf.size);
3648 ofpbuf_put(reply, rq_buf.data, rq_buf.size);
3653 ofputil_encode_barrier_request(enum ofp_version ofp_version)
3657 switch (ofp_version) {
3660 type = OFPRAW_OFPT11_BARRIER_REQUEST;
3664 type = OFPRAW_OFPT10_BARRIER_REQUEST;
3671 return ofpraw_alloc(type, ofp_version, 0);
3675 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
3677 switch (flags & OFPC_FRAG_MASK) {
3678 case OFPC_FRAG_NORMAL: return "normal";
3679 case OFPC_FRAG_DROP: return "drop";
3680 case OFPC_FRAG_REASM: return "reassemble";
3681 case OFPC_FRAG_NX_MATCH: return "nx-match";
3688 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
3690 if (!strcasecmp(s, "normal")) {
3691 *flags = OFPC_FRAG_NORMAL;
3692 } else if (!strcasecmp(s, "drop")) {
3693 *flags = OFPC_FRAG_DROP;
3694 } else if (!strcasecmp(s, "reassemble")) {
3695 *flags = OFPC_FRAG_REASM;
3696 } else if (!strcasecmp(s, "nx-match")) {
3697 *flags = OFPC_FRAG_NX_MATCH;
3704 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
3705 * port number and stores the latter in '*ofp10_port', for the purpose of
3706 * decoding OpenFlow 1.1+ protocol messages. Returns 0 if successful,
3707 * otherwise an OFPERR_* number.
3709 * See the definition of OFP11_MAX for an explanation of the mapping. */
3711 ofputil_port_from_ofp11(ovs_be32 ofp11_port, uint16_t *ofp10_port)
3713 uint32_t ofp11_port_h = ntohl(ofp11_port);
3715 if (ofp11_port_h < OFPP_MAX) {
3716 *ofp10_port = ofp11_port_h;
3718 } else if (ofp11_port_h >= OFPP11_MAX) {
3719 *ofp10_port = ofp11_port_h - OFPP11_OFFSET;
3722 VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
3723 "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
3724 ofp11_port_h, OFPP_MAX - 1,
3725 (uint32_t) OFPP11_MAX, UINT32_MAX);
3726 return OFPERR_OFPBAC_BAD_OUT_PORT;
3730 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
3731 * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
3733 * See the definition of OFP11_MAX for an explanation of the mapping. */
3735 ofputil_port_to_ofp11(uint16_t ofp10_port)
3737 return htonl(ofp10_port < OFPP_MAX
3739 : ofp10_port + OFPP11_OFFSET);
3742 /* Checks that 'port' is a valid output port for the OFPAT10_OUTPUT action, given
3743 * that the switch will never have more than 'max_ports' ports. Returns 0 if
3744 * 'port' is valid, otherwise an OpenFlow return code. */
3746 ofputil_check_output_port(uint16_t port, int max_ports)
3754 case OFPP_CONTROLLER:
3760 if (port < max_ports) {
3763 return OFPERR_OFPBAC_BAD_OUT_PORT;
3767 #define OFPUTIL_NAMED_PORTS \
3768 OFPUTIL_NAMED_PORT(IN_PORT) \
3769 OFPUTIL_NAMED_PORT(TABLE) \
3770 OFPUTIL_NAMED_PORT(NORMAL) \
3771 OFPUTIL_NAMED_PORT(FLOOD) \
3772 OFPUTIL_NAMED_PORT(ALL) \
3773 OFPUTIL_NAMED_PORT(CONTROLLER) \
3774 OFPUTIL_NAMED_PORT(LOCAL) \
3775 OFPUTIL_NAMED_PORT(NONE)
3777 /* Stores the port number represented by 's' into '*portp'. 's' may be an
3778 * integer or, for reserved ports, the standard OpenFlow name for the port
3781 * Returns true if successful, false if 's' is not a valid OpenFlow port number
3782 * or name. The caller should issue an error message in this case, because
3783 * this function usually does not. (This gives the caller an opportunity to
3784 * look up the port name another way, e.g. by contacting the switch and listing
3785 * the names of all its ports).
3787 * This function accepts OpenFlow 1.0 port numbers. It also accepts a subset
3788 * of OpenFlow 1.1+ port numbers, mapping those port numbers into the 16-bit
3789 * range as described in include/openflow/openflow-1.1.h. */
3791 ofputil_port_from_string(const char *s, uint16_t *portp)
3793 unsigned int port32;
3796 if (str_to_uint(s, 10, &port32)) {
3797 if (port32 < OFPP_MAX) {
3800 } else if (port32 < OFPP_FIRST_RESV) {
3801 VLOG_WARN("port %u is a reserved OF1.0 port number that will "
3802 "be translated to %u when talking to an OF1.1 or "
3803 "later controller", port32, port32 + OFPP11_OFFSET);
3806 } else if (port32 <= OFPP_LAST_RESV) {
3810 ofputil_format_port(port32, &s);
3811 VLOG_WARN_ONCE("referring to port %s as %u is deprecated for "
3812 "compatibility with future versions of OpenFlow",
3813 ds_cstr(&s), port32);
3818 } else if (port32 < OFPP11_MAX) {
3819 VLOG_WARN("port %u is outside the supported range 0 through "
3820 "%"PRIx16"or 0x%x through 0x%"PRIx32, port32,
3821 UINT16_MAX, (unsigned int) OFPP11_MAX, UINT32_MAX);
3824 *portp = port32 - OFPP11_OFFSET;
3832 static const struct pair pairs[] = {
3833 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
3835 #undef OFPUTIL_NAMED_PORT
3837 const struct pair *p;
3839 for (p = pairs; p < &pairs[ARRAY_SIZE(pairs)]; p++) {
3840 if (!strcasecmp(s, p->name)) {
3849 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
3850 * Most ports' string representation is just the port number, but for special
3851 * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
3853 ofputil_format_port(uint16_t port, struct ds *s)
3858 #define OFPUTIL_NAMED_PORT(NAME) case OFPP_##NAME: name = #NAME; break;
3860 #undef OFPUTIL_NAMED_PORT
3863 ds_put_format(s, "%"PRIu16, port);
3866 ds_put_cstr(s, name);
3869 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3870 * 'ofp_version', tries to pull the first element from the array. If
3871 * successful, initializes '*pp' with an abstract representation of the
3872 * port and returns 0. If no ports remain to be decoded, returns EOF.
3873 * On an error, returns a positive OFPERR_* value. */
3875 ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *b,
3876 struct ofputil_phy_port *pp)
3878 switch (ofp_version) {
3879 case OFP10_VERSION: {
3880 const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
3881 return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
3884 case OFP12_VERSION: {
3885 const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
3886 return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
3893 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3894 * 'ofp_version', returns the number of elements. */
3895 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *b)
3897 return b->size / ofputil_get_phy_port_size(ofp_version);
3900 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
3901 * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1 if
3902 * 'name' is not the name of any action.
3904 * ofp-util.def lists the mapping from names to action. */
3906 ofputil_action_code_from_name(const char *name)
3908 static const char *names[OFPUTIL_N_ACTIONS] = {
3910 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) NAME,
3911 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
3912 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
3913 #include "ofp-util.def"
3918 for (p = names; p < &names[ARRAY_SIZE(names)]; p++) {
3919 if (*p && !strcasecmp(name, *p)) {
3926 /* Appends an action of the type specified by 'code' to 'buf' and returns the
3927 * action. Initializes the parts of 'action' that identify it as having type
3928 * <ENUM> and length 'sizeof *action' and zeros the rest. For actions that
3929 * have variable length, the length used and cleared is that of struct
3932 ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
3935 case OFPUTIL_ACTION_INVALID:
3938 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
3939 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3940 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3941 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3942 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3943 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3944 #include "ofp-util.def"
3949 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
3951 ofputil_init_##ENUM(struct STRUCT *s) \
3953 memset(s, 0, sizeof *s); \
3954 s->type = htons(ENUM); \
3955 s->len = htons(sizeof *s); \
3959 ofputil_put_##ENUM(struct ofpbuf *buf) \
3961 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
3962 ofputil_init_##ENUM(s); \
3965 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3966 OFPAT10_ACTION(ENUM, STRUCT, NAME)
3967 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3969 ofputil_init_##ENUM(struct STRUCT *s) \
3971 memset(s, 0, sizeof *s); \
3972 s->type = htons(OFPAT10_VENDOR); \
3973 s->len = htons(sizeof *s); \
3974 s->vendor = htonl(NX_VENDOR_ID); \
3975 s->subtype = htons(ENUM); \
3979 ofputil_put_##ENUM(struct ofpbuf *buf) \
3981 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
3982 ofputil_init_##ENUM(s); \
3985 #include "ofp-util.def"
3988 ofputil_normalize_match__(struct match *match, bool may_log)
3991 MAY_NW_ADDR = 1 << 0, /* nw_src, nw_dst */
3992 MAY_TP_ADDR = 1 << 1, /* tp_src, tp_dst */
3993 MAY_NW_PROTO = 1 << 2, /* nw_proto */
3994 MAY_IPVx = 1 << 3, /* tos, frag, ttl */
3995 MAY_ARP_SHA = 1 << 4, /* arp_sha */
3996 MAY_ARP_THA = 1 << 5, /* arp_tha */
3997 MAY_IPV6 = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
3998 MAY_ND_TARGET = 1 << 7 /* nd_target */
4001 struct flow_wildcards wc;
4003 /* Figure out what fields may be matched. */
4004 if (match->flow.dl_type == htons(ETH_TYPE_IP)) {
4005 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
4006 if (match->flow.nw_proto == IPPROTO_TCP ||
4007 match->flow.nw_proto == IPPROTO_UDP ||
4008 match->flow.nw_proto == IPPROTO_ICMP) {
4009 may_match |= MAY_TP_ADDR;
4011 } else if (match->flow.dl_type == htons(ETH_TYPE_IPV6)) {
4012 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
4013 if (match->flow.nw_proto == IPPROTO_TCP ||
4014 match->flow.nw_proto == IPPROTO_UDP) {
4015 may_match |= MAY_TP_ADDR;
4016 } else if (match->flow.nw_proto == IPPROTO_ICMPV6) {
4017 may_match |= MAY_TP_ADDR;
4018 if (match->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
4019 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
4020 } else if (match->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
4021 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
4024 } else if (match->flow.dl_type == htons(ETH_TYPE_ARP) ||
4025 match->flow.dl_type == htons(ETH_TYPE_RARP)) {
4026 may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
4031 /* Clear the fields that may not be matched. */
4033 if (!(may_match & MAY_NW_ADDR)) {
4034 wc.masks.nw_src = wc.masks.nw_dst = htonl(0);
4036 if (!(may_match & MAY_TP_ADDR)) {
4037 wc.masks.tp_src = wc.masks.tp_dst = htons(0);
4039 if (!(may_match & MAY_NW_PROTO)) {
4040 wc.masks.nw_proto = 0;
4042 if (!(may_match & MAY_IPVx)) {
4043 wc.masks.nw_tos = 0;
4044 wc.masks.nw_ttl = 0;
4046 if (!(may_match & MAY_ARP_SHA)) {
4047 memset(wc.masks.arp_sha, 0, ETH_ADDR_LEN);
4049 if (!(may_match & MAY_ARP_THA)) {
4050 memset(wc.masks.arp_tha, 0, ETH_ADDR_LEN);
4052 if (!(may_match & MAY_IPV6)) {
4053 wc.masks.ipv6_src = wc.masks.ipv6_dst = in6addr_any;
4054 wc.masks.ipv6_label = htonl(0);
4056 if (!(may_match & MAY_ND_TARGET)) {
4057 wc.masks.nd_target = in6addr_any;
4060 /* Log any changes. */
4061 if (!flow_wildcards_equal(&wc, &match->wc)) {
4062 bool log = may_log && !VLOG_DROP_INFO(&bad_ofmsg_rl);
4063 char *pre = log ? match_to_string(match, OFP_DEFAULT_PRIORITY) : NULL;
4066 match_zero_wildcarded_fields(match);
4069 char *post = match_to_string(match, OFP_DEFAULT_PRIORITY);
4070 VLOG_INFO("normalization changed ofp_match, details:");
4071 VLOG_INFO(" pre: %s", pre);
4072 VLOG_INFO("post: %s", post);
4079 /* "Normalizes" the wildcards in 'match'. That means:
4081 * 1. If the type of level N is known, then only the valid fields for that
4082 * level may be specified. For example, ARP does not have a TOS field,
4083 * so nw_tos must be wildcarded if 'match' specifies an ARP flow.
4084 * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
4085 * ipv6_dst (and other fields) must be wildcarded if 'match' specifies an
4088 * 2. If the type of level N is not known (or not understood by Open
4089 * vSwitch), then no fields at all for that level may be specified. For
4090 * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
4091 * L4 fields tp_src and tp_dst must be wildcarded if 'match' specifies an
4094 * If this function changes 'match', it logs a rate-limited informational
4097 ofputil_normalize_match(struct match *match)
4099 ofputil_normalize_match__(match, true);
4102 /* Same as ofputil_normalize_match() without the logging. Thus, this function
4103 * is suitable for a program's internal use, whereas ofputil_normalize_match()
4104 * sense for use on flows received from elsewhere (so that a bug in the program
4105 * that sent them can be reported and corrected). */
4107 ofputil_normalize_match_quiet(struct match *match)
4109 ofputil_normalize_match__(match, false);
4112 /* Parses a key or a key-value pair from '*stringp'.
4114 * On success: Stores the key into '*keyp'. Stores the value, if present, into
4115 * '*valuep', otherwise an empty string. Advances '*stringp' past the end of
4116 * the key-value pair, preparing it for another call. '*keyp' and '*valuep'
4117 * are substrings of '*stringp' created by replacing some of its bytes by null
4118 * terminators. Returns true.
4120 * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
4121 * NULL and returns false. */
4123 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
4125 char *pos, *key, *value;
4129 pos += strspn(pos, ", \t\r\n");
4131 *keyp = *valuep = NULL;
4136 key_len = strcspn(pos, ":=(, \t\r\n");
4137 if (key[key_len] == ':' || key[key_len] == '=') {
4138 /* The value can be separated by a colon. */
4141 value = key + key_len + 1;
4142 value_len = strcspn(value, ", \t\r\n");
4143 pos = value + value_len + (value[value_len] != '\0');
4144 value[value_len] = '\0';
4145 } else if (key[key_len] == '(') {
4146 /* The value can be surrounded by balanced parentheses. The outermost
4147 * set of parentheses is removed. */
4151 value = key + key_len + 1;
4152 for (value_len = 0; level > 0; value_len++) {
4153 switch (value[value_len]) {
4167 value[value_len - 1] = '\0';
4168 pos = value + value_len;
4170 /* There might be no value at all. */
4171 value = key + key_len; /* Will become the empty string below. */
4172 pos = key + key_len + (key[key_len] != '\0');
4174 key[key_len] = '\0';
4182 /* Encode a dump ports request for 'port', the encoded message
4183 * will be fore Open Flow version 'ofp_version'. Returns message
4184 * as a struct ofpbuf. Returns encoded message on success, NULL on error */
4186 ofputil_encode_dump_ports_request(enum ofp_version ofp_version, int16_t port)
4188 struct ofpbuf *request;
4190 switch (ofp_version) {
4191 case OFP10_VERSION: {
4192 struct ofp10_port_stats_request *req;
4193 request = ofpraw_alloc(OFPRAW_OFPST10_PORT_REQUEST, ofp_version, 0);
4194 req = ofpbuf_put_zeros(request, sizeof *req);
4195 req->port_no = htons(port);
4199 case OFP12_VERSION: {
4200 struct ofp11_port_stats_request *req;
4201 request = ofpraw_alloc(OFPRAW_OFPST11_PORT_REQUEST, ofp_version, 0);
4202 req = ofpbuf_put_zeros(request, sizeof *req);
4203 req->port_no = ofputil_port_to_ofp11(port);
4214 ofputil_port_stats_to_ofp10(const struct ofputil_port_stats *ops,
4215 struct ofp10_port_stats *ps10)
4217 ps10->port_no = htons(ops->port_no);
4218 memset(ps10->pad, 0, sizeof ps10->pad);
4219 put_32aligned_be64(&ps10->rx_packets, htonll(ops->stats.rx_packets));
4220 put_32aligned_be64(&ps10->tx_packets, htonll(ops->stats.tx_packets));
4221 put_32aligned_be64(&ps10->rx_bytes, htonll(ops->stats.rx_bytes));
4222 put_32aligned_be64(&ps10->tx_bytes, htonll(ops->stats.tx_bytes));
4223 put_32aligned_be64(&ps10->rx_dropped, htonll(ops->stats.rx_dropped));
4224 put_32aligned_be64(&ps10->tx_dropped, htonll(ops->stats.tx_dropped));
4225 put_32aligned_be64(&ps10->rx_errors, htonll(ops->stats.rx_errors));
4226 put_32aligned_be64(&ps10->tx_errors, htonll(ops->stats.tx_errors));
4227 put_32aligned_be64(&ps10->rx_frame_err, htonll(ops->stats.rx_frame_errors));
4228 put_32aligned_be64(&ps10->rx_over_err, htonll(ops->stats.rx_over_errors));
4229 put_32aligned_be64(&ps10->rx_crc_err, htonll(ops->stats.rx_crc_errors));
4230 put_32aligned_be64(&ps10->collisions, htonll(ops->stats.collisions));
4234 ofputil_port_stats_to_ofp11(const struct ofputil_port_stats *ops,
4235 struct ofp11_port_stats *ps11)
4237 ps11->port_no = ofputil_port_to_ofp11(ops->port_no);
4238 memset(ps11->pad, 0, sizeof ps11->pad);
4239 ps11->rx_packets = htonll(ops->stats.rx_packets);
4240 ps11->tx_packets = htonll(ops->stats.tx_packets);
4241 ps11->rx_bytes = htonll(ops->stats.rx_bytes);
4242 ps11->tx_bytes = htonll(ops->stats.tx_bytes);
4243 ps11->rx_dropped = htonll(ops->stats.rx_dropped);
4244 ps11->tx_dropped = htonll(ops->stats.tx_dropped);
4245 ps11->rx_errors = htonll(ops->stats.rx_errors);
4246 ps11->tx_errors = htonll(ops->stats.tx_errors);
4247 ps11->rx_frame_err = htonll(ops->stats.rx_frame_errors);
4248 ps11->rx_over_err = htonll(ops->stats.rx_over_errors);
4249 ps11->rx_crc_err = htonll(ops->stats.rx_crc_errors);
4250 ps11->collisions = htonll(ops->stats.collisions);
4253 /* Encode a ports stat for 'ops' and append it to 'replies'. */
4255 ofputil_append_port_stat(struct list *replies,
4256 const struct ofputil_port_stats *ops)
4258 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
4259 struct ofp_header *oh = msg->data;
4261 switch ((enum ofp_version)oh->version) {
4263 case OFP11_VERSION: {
4264 struct ofp11_port_stats *reply = ofpmp_append(replies, sizeof *reply);
4265 ofputil_port_stats_to_ofp11(ops, reply);
4269 case OFP10_VERSION: {
4270 struct ofp10_port_stats *reply = ofpmp_append(replies, sizeof *reply);
4271 ofputil_port_stats_to_ofp10(ops, reply);
4281 ofputil_port_stats_from_ofp10(struct ofputil_port_stats *ops,
4282 const struct ofp10_port_stats *ps10)
4284 memset(ops, 0, sizeof *ops);
4286 ops->port_no = ntohs(ps10->port_no);
4287 ops->stats.rx_packets = ntohll(get_32aligned_be64(&ps10->rx_packets));
4288 ops->stats.tx_packets = ntohll(get_32aligned_be64(&ps10->tx_packets));
4289 ops->stats.rx_bytes = ntohll(get_32aligned_be64(&ps10->rx_bytes));
4290 ops->stats.tx_bytes = ntohll(get_32aligned_be64(&ps10->tx_bytes));
4291 ops->stats.rx_dropped = ntohll(get_32aligned_be64(&ps10->rx_dropped));
4292 ops->stats.tx_dropped = ntohll(get_32aligned_be64(&ps10->tx_dropped));
4293 ops->stats.rx_errors = ntohll(get_32aligned_be64(&ps10->rx_errors));
4294 ops->stats.tx_errors = ntohll(get_32aligned_be64(&ps10->tx_errors));
4295 ops->stats.rx_frame_errors =
4296 ntohll(get_32aligned_be64(&ps10->rx_frame_err));
4297 ops->stats.rx_over_errors = ntohll(get_32aligned_be64(&ps10->rx_over_err));
4298 ops->stats.rx_crc_errors = ntohll(get_32aligned_be64(&ps10->rx_crc_err));
4299 ops->stats.collisions = ntohll(get_32aligned_be64(&ps10->collisions));
4305 ofputil_port_stats_from_ofp11(struct ofputil_port_stats *ops,
4306 const struct ofp11_port_stats *ps11)
4310 memset(ops, 0, sizeof *ops);
4311 error = ofputil_port_from_ofp11(ps11->port_no, &ops->port_no);
4316 ops->stats.rx_packets = ntohll(ps11->rx_packets);
4317 ops->stats.tx_packets = ntohll(ps11->tx_packets);
4318 ops->stats.rx_bytes = ntohll(ps11->rx_bytes);
4319 ops->stats.tx_bytes = ntohll(ps11->tx_bytes);
4320 ops->stats.rx_dropped = ntohll(ps11->rx_dropped);
4321 ops->stats.tx_dropped = ntohll(ps11->tx_dropped);
4322 ops->stats.rx_errors = ntohll(ps11->rx_errors);
4323 ops->stats.tx_errors = ntohll(ps11->tx_errors);
4324 ops->stats.rx_frame_errors = ntohll(ps11->rx_frame_err);
4325 ops->stats.rx_over_errors = ntohll(ps11->rx_over_err);
4326 ops->stats.rx_crc_errors = ntohll(ps11->rx_crc_err);
4327 ops->stats.collisions = ntohll(ps11->collisions);
4332 /* Returns the number of port stats elements in OFPTYPE_PORT_STATS_REPLY
4335 ofputil_count_port_stats(const struct ofp_header *oh)
4339 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4340 ofpraw_pull_assert(&b);
4342 BUILD_ASSERT(sizeof(struct ofp10_port_stats) ==
4343 sizeof(struct ofp11_port_stats));
4344 return b.size / sizeof(struct ofp10_port_stats);
4347 /* Converts an OFPST_PORT_STATS reply in 'msg' into an abstract
4348 * ofputil_port_stats in 'ps'.
4350 * Multiple OFPST_PORT_STATS replies can be packed into a single OpenFlow
4351 * message. Calling this function multiple times for a single 'msg' iterates
4352 * through the replies. The caller must initially leave 'msg''s layer pointers
4353 * null and not modify them between calls.
4355 * Returns 0 if successful, EOF if no replies were left in this 'msg',
4356 * otherwise a positive errno value. */
4358 ofputil_decode_port_stats(struct ofputil_port_stats *ps, struct ofpbuf *msg)
4364 ? ofpraw_decode(&raw, msg->l2)
4365 : ofpraw_pull(&raw, msg));
4372 } else if (raw == OFPRAW_OFPST11_PORT_REPLY) {
4373 const struct ofp11_port_stats *ps11;
4375 ps11 = ofpbuf_try_pull(msg, sizeof *ps11);
4377 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_PORT reply has %zu leftover "
4378 "bytes at end", msg->size);
4379 return OFPERR_OFPBRC_BAD_LEN;
4381 return ofputil_port_stats_from_ofp11(ps, ps11);
4382 } else if (raw == OFPRAW_OFPST10_PORT_REPLY) {
4383 const struct ofp10_port_stats *ps10;
4385 ps10 = ofpbuf_try_pull(msg, sizeof *ps10);
4387 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_PORT reply has %zu leftover "
4388 "bytes at end", msg->size);
4389 return OFPERR_OFPBRC_BAD_LEN;
4391 return ofputil_port_stats_from_ofp10(ps, ps10);
4398 /* Parse a port status request message into a 16 bit OpenFlow 1.0
4399 * port number and stores the latter in '*ofp10_port'.
4400 * Returns 0 if successful, otherwise an OFPERR_* number. */
4402 ofputil_decode_port_stats_request(const struct ofp_header *request,
4403 uint16_t *ofp10_port)
4405 switch ((enum ofp_version)request->version) {
4407 case OFP11_VERSION: {
4408 const struct ofp11_port_stats_request *psr11 = ofpmsg_body(request);
4409 return ofputil_port_from_ofp11(psr11->port_no, ofp10_port);
4412 case OFP10_VERSION: {
4413 const struct ofp10_port_stats_request *psr10 = ofpmsg_body(request);
4414 *ofp10_port = ntohs(psr10->port_no);
4423 /* Parse a queue status request message into 'oqsr'.
4424 * Returns 0 if successful, otherwise an OFPERR_* number. */
4426 ofputil_decode_queue_stats_request(const struct ofp_header *request,
4427 struct ofputil_queue_stats_request *oqsr)
4429 switch ((enum ofp_version)request->version) {
4431 case OFP11_VERSION: {
4432 const struct ofp11_queue_stats_request *qsr11 = ofpmsg_body(request);
4433 oqsr->queue_id = ntohl(qsr11->queue_id);
4434 return ofputil_port_from_ofp11(qsr11->port_no, &oqsr->port_no);
4437 case OFP10_VERSION: {
4438 const struct ofp10_queue_stats_request *qsr11 = ofpmsg_body(request);
4439 oqsr->queue_id = ntohl(qsr11->queue_id);
4440 oqsr->port_no = ntohs(qsr11->port_no);
4449 /* Encode a queue statsrequest for 'oqsr', the encoded message
4450 * will be fore Open Flow version 'ofp_version'. Returns message
4451 * as a struct ofpbuf. Returns encoded message on success, NULL on error */
4453 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
4454 const struct ofputil_queue_stats_request *oqsr)
4456 struct ofpbuf *request;
4458 switch (ofp_version) {
4460 case OFP12_VERSION: {
4461 struct ofp11_queue_stats_request *req;
4462 request = ofpraw_alloc(OFPRAW_OFPST11_QUEUE_REQUEST, ofp_version, 0);
4463 req = ofpbuf_put_zeros(request, sizeof *req);
4464 req->port_no = ofputil_port_to_ofp11(oqsr->port_no);
4465 req->queue_id = htonl(oqsr->queue_id);
4468 case OFP10_VERSION: {
4469 struct ofp10_queue_stats_request *req;
4470 request = ofpraw_alloc(OFPRAW_OFPST10_QUEUE_REQUEST, ofp_version, 0);
4471 req = ofpbuf_put_zeros(request, sizeof *req);
4472 req->port_no = htons(oqsr->port_no);
4473 req->queue_id = htonl(oqsr->queue_id);
4483 /* Returns the number of queue stats elements in OFPTYPE_QUEUE_STATS_REPLY
4486 ofputil_count_queue_stats(const struct ofp_header *oh)
4490 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4491 ofpraw_pull_assert(&b);
4493 BUILD_ASSERT(sizeof(struct ofp10_queue_stats) ==
4494 sizeof(struct ofp11_queue_stats));
4495 return b.size / sizeof(struct ofp10_queue_stats);
4499 ofputil_queue_stats_from_ofp10(struct ofputil_queue_stats *oqs,
4500 const struct ofp10_queue_stats *qs10)
4502 oqs->port_no = ntohs(qs10->port_no);
4503 oqs->queue_id = ntohl(qs10->queue_id);
4504 oqs->stats.tx_bytes = ntohll(get_32aligned_be64(&qs10->tx_bytes));
4505 oqs->stats.tx_packets = ntohll(get_32aligned_be64(&qs10->tx_packets));
4506 oqs->stats.tx_errors = ntohll(get_32aligned_be64(&qs10->tx_errors));
4512 ofputil_queue_stats_from_ofp11(struct ofputil_queue_stats *oqs,
4513 const struct ofp11_queue_stats *qs11)
4517 error = ofputil_port_from_ofp11(qs11->port_no, &oqs->port_no);
4522 oqs->queue_id = ntohl(qs11->queue_id);
4523 oqs->stats.tx_bytes = ntohll(qs11->tx_bytes);
4524 oqs->stats.tx_packets = ntohll(qs11->tx_packets);
4525 oqs->stats.tx_errors = ntohll(qs11->tx_errors);
4530 /* Converts an OFPST_QUEUE_STATS reply in 'msg' into an abstract
4531 * ofputil_queue_stats in 'qs'.
4533 * Multiple OFPST_QUEUE_STATS replies can be packed into a single OpenFlow
4534 * message. Calling this function multiple times for a single 'msg' iterates
4535 * through the replies. The caller must initially leave 'msg''s layer pointers
4536 * null and not modify them between calls.
4538 * Returns 0 if successful, EOF if no replies were left in this 'msg',
4539 * otherwise a positive errno value. */
4541 ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg)
4547 ? ofpraw_decode(&raw, msg->l2)
4548 : ofpraw_pull(&raw, msg));
4555 } else if (raw == OFPRAW_OFPST11_QUEUE_REPLY) {
4556 const struct ofp11_queue_stats *qs11;
4558 qs11 = ofpbuf_try_pull(msg, sizeof *qs11);
4560 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_QUEUE reply has %zu leftover "
4561 "bytes at end", msg->size);
4562 return OFPERR_OFPBRC_BAD_LEN;
4564 return ofputil_queue_stats_from_ofp11(qs, qs11);
4565 } else if (raw == OFPRAW_OFPST10_QUEUE_REPLY) {
4566 const struct ofp10_queue_stats *qs10;
4568 qs10 = ofpbuf_try_pull(msg, sizeof *qs10);
4570 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_QUEUE reply has %zu leftover "
4571 "bytes at end", msg->size);
4572 return OFPERR_OFPBRC_BAD_LEN;
4574 return ofputil_queue_stats_from_ofp10(qs, qs10);
4581 ofputil_queue_stats_to_ofp10(const struct ofputil_queue_stats *oqs,
4582 struct ofp10_queue_stats *qs10)
4584 qs10->port_no = htons(oqs->port_no);
4585 memset(qs10->pad, 0, sizeof qs10->pad);
4586 qs10->queue_id = htonl(oqs->queue_id);
4587 put_32aligned_be64(&qs10->tx_bytes, htonll(oqs->stats.tx_bytes));
4588 put_32aligned_be64(&qs10->tx_packets, htonll(oqs->stats.tx_packets));
4589 put_32aligned_be64(&qs10->tx_errors, htonll(oqs->stats.tx_errors));
4593 ofputil_queue_stats_to_ofp11(const struct ofputil_queue_stats *oqs,
4594 struct ofp11_queue_stats *qs11)
4596 qs11->port_no = ofputil_port_to_ofp11(oqs->port_no);
4597 qs11->queue_id = htonl(oqs->queue_id);
4598 qs11->tx_bytes = htonll(oqs->stats.tx_bytes);
4599 qs11->tx_packets = htonll(oqs->stats.tx_packets);
4600 qs11->tx_errors = htonll(oqs->stats.tx_errors);
4603 /* Encode a queue stat for 'oqs' and append it to 'replies'. */
4605 ofputil_append_queue_stat(struct list *replies,
4606 const struct ofputil_queue_stats *oqs)
4608 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
4609 struct ofp_header *oh = msg->data;
4611 switch ((enum ofp_version)oh->version) {
4613 case OFP11_VERSION: {
4614 struct ofp11_queue_stats *reply = ofpmp_append(replies, sizeof *reply);;
4615 ofputil_queue_stats_to_ofp11(oqs, reply);
4619 case OFP10_VERSION: {
4620 struct ofp10_queue_stats *reply = ofpmp_append(replies, sizeof *reply);;
4621 ofputil_queue_stats_to_ofp10(oqs, reply);