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[] = {
595 size_t ofputil_n_flow_dump_protocols = ARRAY_SIZE(ofputil_flow_dump_protocols);
597 /* Returns the ofputil_protocol that is initially in effect on an OpenFlow
598 * connection that has negotiated the given 'version'. 'version' should
599 * normally be an 8-bit OpenFlow version identifier (e.g. 0x01 for OpenFlow
600 * 1.0, 0x02 for OpenFlow 1.1). Returns 0 if 'version' is not supported or
601 * outside the valid range. */
602 enum ofputil_protocol
603 ofputil_protocol_from_ofp_version(enum ofp_version version)
607 return OFPUTIL_P_OF10_STD;
609 return OFPUTIL_P_OF12_OXM;
616 /* Returns the OpenFlow protocol version number (e.g. OFP10_VERSION,
617 * OFP11_VERSION or OFP12_VERSION) that corresponds to 'protocol'. */
619 ofputil_protocol_to_ofp_version(enum ofputil_protocol protocol)
622 case OFPUTIL_P_OF10_STD:
623 case OFPUTIL_P_OF10_STD_TID:
624 case OFPUTIL_P_OF10_NXM:
625 case OFPUTIL_P_OF10_NXM_TID:
626 return OFP10_VERSION;
627 case OFPUTIL_P_OF12_OXM:
628 return OFP12_VERSION;
634 /* Returns true if 'protocol' is a single OFPUTIL_P_* value, false
637 ofputil_protocol_is_valid(enum ofputil_protocol protocol)
639 return protocol & OFPUTIL_P_ANY && is_pow2(protocol);
642 /* Returns the equivalent of 'protocol' with the Nicira flow_mod_table_id
643 * extension turned on or off if 'enable' is true or false, respectively.
645 * This extension is only useful for protocols whose "standard" version does
646 * not allow specific tables to be modified. In particular, this is true of
647 * OpenFlow 1.0. In later versions of OpenFlow, a flow_mod request always
648 * specifies a table ID and so there is no need for such an extension. When
649 * 'protocol' is such a protocol that doesn't need a flow_mod_table_id
650 * extension, this function just returns its 'protocol' argument unchanged
651 * regardless of the value of 'enable'. */
652 enum ofputil_protocol
653 ofputil_protocol_set_tid(enum ofputil_protocol protocol, bool enable)
656 case OFPUTIL_P_OF10_STD:
657 case OFPUTIL_P_OF10_STD_TID:
658 return enable ? OFPUTIL_P_OF10_STD_TID : OFPUTIL_P_OF10_STD;
660 case OFPUTIL_P_OF10_NXM:
661 case OFPUTIL_P_OF10_NXM_TID:
662 return enable ? OFPUTIL_P_OF10_NXM_TID : OFPUTIL_P_OF10_NXM;
664 case OFPUTIL_P_OF12_OXM:
665 return OFPUTIL_P_OF12_OXM;
672 /* Returns the "base" version of 'protocol'. That is, if 'protocol' includes
673 * some extension to a standard protocol version, the return value is the
674 * standard version of that protocol without any extension. If 'protocol' is a
675 * standard protocol version, returns 'protocol' unchanged. */
676 enum ofputil_protocol
677 ofputil_protocol_to_base(enum ofputil_protocol protocol)
679 return ofputil_protocol_set_tid(protocol, false);
682 /* Returns 'new_base' with any extensions taken from 'cur'. */
683 enum ofputil_protocol
684 ofputil_protocol_set_base(enum ofputil_protocol cur,
685 enum ofputil_protocol new_base)
687 bool tid = (cur & OFPUTIL_P_TID) != 0;
690 case OFPUTIL_P_OF10_STD:
691 case OFPUTIL_P_OF10_STD_TID:
692 return ofputil_protocol_set_tid(OFPUTIL_P_OF10_STD, tid);
694 case OFPUTIL_P_OF10_NXM:
695 case OFPUTIL_P_OF10_NXM_TID:
696 return ofputil_protocol_set_tid(OFPUTIL_P_OF10_NXM, tid);
698 case OFPUTIL_P_OF12_OXM:
699 return ofputil_protocol_set_tid(OFPUTIL_P_OF12_OXM, tid);
706 /* Returns a string form of 'protocol', if a simple form exists (that is, if
707 * 'protocol' is either a single protocol or it is a combination of protocols
708 * that have a single abbreviation). Otherwise, returns NULL. */
710 ofputil_protocol_to_string(enum ofputil_protocol protocol)
712 const struct proto_abbrev *p;
714 /* Use a "switch" statement for single-bit names so that we get a compiler
715 * warning if we forget any. */
717 case OFPUTIL_P_OF10_NXM:
718 return "NXM-table_id";
720 case OFPUTIL_P_OF10_NXM_TID:
721 return "NXM+table_id";
723 case OFPUTIL_P_OF10_STD:
724 return "OpenFlow10-table_id";
726 case OFPUTIL_P_OF10_STD_TID:
727 return "OpenFlow10+table_id";
729 case OFPUTIL_P_OF12_OXM:
733 /* Check abbreviations. */
734 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
735 if (protocol == p->protocol) {
743 /* Returns a string that represents 'protocols'. The return value might be a
744 * comma-separated list if 'protocols' doesn't have a simple name. The return
745 * value is "none" if 'protocols' is 0.
747 * The caller must free the returned string (with free()). */
749 ofputil_protocols_to_string(enum ofputil_protocol protocols)
753 assert(!(protocols & ~OFPUTIL_P_ANY));
754 if (protocols == 0) {
755 return xstrdup("none");
760 const struct proto_abbrev *p;
764 ds_put_char(&s, ',');
767 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
768 if ((protocols & p->protocol) == p->protocol) {
769 ds_put_cstr(&s, p->name);
770 protocols &= ~p->protocol;
775 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
776 enum ofputil_protocol bit = 1u << i;
778 if (protocols & bit) {
779 ds_put_cstr(&s, ofputil_protocol_to_string(bit));
788 return ds_steal_cstr(&s);
791 static enum ofputil_protocol
792 ofputil_protocol_from_string__(const char *s, size_t n)
794 const struct proto_abbrev *p;
797 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
798 enum ofputil_protocol bit = 1u << i;
799 const char *name = ofputil_protocol_to_string(bit);
801 if (name && n == strlen(name) && !strncasecmp(s, name, n)) {
806 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
807 if (n == strlen(p->name) && !strncasecmp(s, p->name, n)) {
815 /* Returns the nonempty set of protocols represented by 's', which can be a
816 * single protocol name or abbreviation or a comma-separated list of them.
818 * Aborts the program with an error message if 's' is invalid. */
819 enum ofputil_protocol
820 ofputil_protocols_from_string(const char *s)
822 const char *orig_s = s;
823 enum ofputil_protocol protocols;
827 enum ofputil_protocol p;
836 p = ofputil_protocol_from_string__(s, n);
838 ovs_fatal(0, "%.*s: unknown flow protocol", (int) n, s);
846 ovs_fatal(0, "%s: no flow protocol specified", orig_s);
852 ofputil_version_from_string(const char *s)
854 if (!strcasecmp(s, "OpenFlow10")) {
855 return OFP10_VERSION;
857 if (!strcasecmp(s, "OpenFlow11")) {
858 return OFP11_VERSION;
860 if (!strcasecmp(s, "OpenFlow12")) {
861 return OFP12_VERSION;
869 return isspace(c) || c == ',';
873 ofputil_versions_from_string(const char *s)
883 if (is_delimiter(s[i])) {
888 while (s[i + j] && !is_delimiter(s[i + j])) {
891 key = xmemdup0(s + i, j);
892 version = ofputil_version_from_string(key);
894 VLOG_FATAL("Unknown OpenFlow version: \"%s\"", key);
897 bitmap |= 1u << version;
905 ofputil_versions_from_strings(char ** const s, size_t count)
910 int version = ofputil_version_from_string(s[count]);
912 VLOG_WARN("Unknown OpenFlow version: \"%s\"", s[count]);
914 bitmap |= 1u << version;
922 ofputil_version_to_string(enum ofp_version ofp_version)
924 switch (ofp_version) {
937 ofputil_packet_in_format_is_valid(enum nx_packet_in_format packet_in_format)
939 switch (packet_in_format) {
940 case NXPIF_OPENFLOW10:
949 ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format)
951 switch (packet_in_format) {
952 case NXPIF_OPENFLOW10:
962 ofputil_packet_in_format_from_string(const char *s)
964 return (!strcmp(s, "openflow10") ? NXPIF_OPENFLOW10
965 : !strcmp(s, "nxm") ? NXPIF_NXM
970 regs_fully_wildcarded(const struct flow_wildcards *wc)
974 for (i = 0; i < FLOW_N_REGS; i++) {
975 if (wc->masks.regs[i] != 0) {
982 /* Returns a bit-mask of ofputil_protocols that can be used for sending 'match'
983 * to a switch (e.g. to add or remove a flow). Only NXM can handle tunnel IDs,
984 * registers, or fixing the Ethernet multicast bit. Otherwise, it's better to
985 * use OpenFlow 1.0 protocol for backward compatibility. */
986 enum ofputil_protocol
987 ofputil_usable_protocols(const struct match *match)
989 const struct flow_wildcards *wc = &match->wc;
991 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 17);
993 /* NXM, OXM, and OF1.1 support bitwise matching on ethernet addresses. */
994 if (!eth_mask_is_exact(wc->masks.dl_src)
995 && !eth_addr_is_zero(wc->masks.dl_src)) {
996 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
998 if (!eth_mask_is_exact(wc->masks.dl_dst)
999 && !eth_addr_is_zero(wc->masks.dl_dst)) {
1000 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1003 /* NXM, OXM, and OF1.1+ support matching metadata. */
1004 if (wc->masks.metadata != htonll(0)) {
1005 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1008 /* NXM and OXM support matching ARP hardware addresses. */
1009 if (!eth_addr_is_zero(wc->masks.arp_sha) ||
1010 !eth_addr_is_zero(wc->masks.arp_tha)) {
1011 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1014 /* NXM and OXM support matching IPv6 traffic. */
1015 if (match->flow.dl_type == htons(ETH_TYPE_IPV6)) {
1016 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1019 /* NXM and OXM support matching registers. */
1020 if (!regs_fully_wildcarded(wc)) {
1021 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1024 /* NXM and OXM support matching tun_id. */
1025 if (wc->masks.tunnel.tun_id != htonll(0)) {
1026 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1029 /* NXM and OXM support matching fragments. */
1030 if (wc->masks.nw_frag) {
1031 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1034 /* NXM and OXM support matching IPv6 flow label. */
1035 if (wc->masks.ipv6_label) {
1036 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1039 /* NXM and OXM support matching IP ECN bits. */
1040 if (wc->masks.nw_tos & IP_ECN_MASK) {
1041 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1044 /* NXM and OXM support matching IP TTL/hop limit. */
1045 if (wc->masks.nw_ttl) {
1046 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1049 /* NXM and OXM support non-CIDR IPv4 address masks. */
1050 if (!ip_is_cidr(wc->masks.nw_src) || !ip_is_cidr(wc->masks.nw_dst)) {
1051 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1054 /* NXM and OXM support bitwise matching on transport port. */
1055 if ((wc->masks.tp_src && wc->masks.tp_src != htons(UINT16_MAX)) ||
1056 (wc->masks.tp_dst && wc->masks.tp_dst != htons(UINT16_MAX))) {
1057 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1060 /* Other formats can express this rule. */
1061 return OFPUTIL_P_ANY;
1065 ofputil_format_version(struct ds *msg, enum ofp_version version)
1067 ds_put_format(msg, "0x%02x", version);
1071 ofputil_format_version_name(struct ds *msg, enum ofp_version version)
1073 ds_put_cstr(msg, ofputil_version_to_string(version));
1077 ofputil_format_version_bitmap__(struct ds *msg, uint32_t bitmap,
1078 void (*format_version)(struct ds *msg,
1082 format_version(msg, raw_ctz(bitmap));
1083 bitmap = zero_rightmost_1bit(bitmap);
1085 ds_put_cstr(msg, ", ");
1091 ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap)
1093 ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version);
1097 ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap)
1099 ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version_name);
1103 ofputil_decode_hello_bitmap(const struct ofp_hello_elem_header *oheh,
1104 uint32_t *allowed_versionsp)
1106 uint16_t bitmap_len = ntohs(oheh->length) - sizeof *oheh;
1107 const ovs_be32 *bitmap = (const ovs_be32 *) (oheh + 1);
1108 uint32_t allowed_versions;
1110 if (!bitmap_len || bitmap_len % sizeof *bitmap) {
1114 /* Only use the first 32-bit element of the bitmap as that is all the
1115 * current implementation supports. Subsequent elements are ignored which
1116 * should have no effect on session negotiation until Open vSwtich supports
1117 * wire-protocol versions greater than 31.
1119 allowed_versions = ntohl(bitmap[0]);
1121 if (allowed_versions & 1) {
1122 /* There's no OpenFlow version 0. */
1123 VLOG_WARN_RL(&bad_ofmsg_rl, "peer claims to support invalid OpenFlow "
1125 allowed_versions &= ~1u;
1128 if (!allowed_versions) {
1129 VLOG_WARN_RL(&bad_ofmsg_rl, "peer does not support any OpenFlow "
1130 "version (between 0x01 and 0x1f)");
1134 *allowed_versionsp = allowed_versions;
1139 version_bitmap_from_version(uint8_t ofp_version)
1141 return ((ofp_version < 32 ? 1u << ofp_version : 0) - 1) << 1;
1144 /* Decodes OpenFlow OFPT_HELLO message 'oh', storing into '*allowed_versions'
1145 * the set of OpenFlow versions for which 'oh' announces support.
1147 * Because of how OpenFlow defines OFPT_HELLO messages, this function is always
1148 * successful, and thus '*allowed_versions' is always initialized. However, it
1149 * returns false if 'oh' contains some data that could not be fully understood,
1150 * true if 'oh' was completely parsed. */
1152 ofputil_decode_hello(const struct ofp_header *oh, uint32_t *allowed_versions)
1157 ofpbuf_use_const(&msg, oh, ntohs(oh->length));
1158 ofpbuf_pull(&msg, sizeof *oh);
1160 *allowed_versions = version_bitmap_from_version(oh->version);
1162 const struct ofp_hello_elem_header *oheh;
1165 if (msg.size < sizeof *oheh) {
1170 len = ntohs(oheh->length);
1171 if (len < sizeof *oheh || !ofpbuf_try_pull(&msg, ROUND_UP(len, 8))) {
1175 if (oheh->type != htons(OFPHET_VERSIONBITMAP)
1176 || !ofputil_decode_hello_bitmap(oheh, allowed_versions)) {
1184 /* Returns true if 'allowed_versions' needs to be accompanied by a version
1185 * bitmap to be correctly expressed in an OFPT_HELLO message. */
1187 should_send_version_bitmap(uint32_t allowed_versions)
1189 return !is_pow2((allowed_versions >> 1) + 1);
1192 /* Create an OFPT_HELLO message that expresses support for the OpenFlow
1193 * versions in the 'allowed_versions' bitmaps and returns the message. */
1195 ofputil_encode_hello(uint32_t allowed_versions)
1197 enum ofp_version ofp_version;
1200 ofp_version = leftmost_1bit_idx(allowed_versions);
1201 msg = ofpraw_alloc(OFPRAW_OFPT_HELLO, ofp_version, 0);
1203 if (should_send_version_bitmap(allowed_versions)) {
1204 struct ofp_hello_elem_header *oheh;
1207 map_len = sizeof allowed_versions;
1208 oheh = ofpbuf_put_zeros(msg, ROUND_UP(map_len + sizeof *oheh, 8));
1209 oheh->type = htons(OFPHET_VERSIONBITMAP);
1210 oheh->length = htons(map_len + sizeof *oheh);
1211 *(ovs_be32 *)(oheh + 1) = htonl(allowed_versions);
1213 ofpmsg_update_length(msg);
1219 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
1220 * protocol is 'current', at least partly transitions the protocol to 'want'.
1221 * Stores in '*next' the protocol that will be in effect on the OpenFlow
1222 * connection if the switch processes the returned message correctly. (If
1223 * '*next != want' then the caller will have to iterate.)
1225 * If 'current == want', or if it is not possible to transition from 'current'
1226 * to 'want' (because, for example, 'current' and 'want' use different OpenFlow
1227 * protocol versions), returns NULL and stores 'current' in '*next'. */
1229 ofputil_encode_set_protocol(enum ofputil_protocol current,
1230 enum ofputil_protocol want,
1231 enum ofputil_protocol *next)
1233 enum ofp_version cur_version, want_version;
1234 enum ofputil_protocol cur_base, want_base;
1235 bool cur_tid, want_tid;
1237 cur_version = ofputil_protocol_to_ofp_version(current);
1238 want_version = ofputil_protocol_to_ofp_version(want);
1239 if (cur_version != want_version) {
1244 cur_base = ofputil_protocol_to_base(current);
1245 want_base = ofputil_protocol_to_base(want);
1246 if (cur_base != want_base) {
1247 *next = ofputil_protocol_set_base(current, want_base);
1249 switch (want_base) {
1250 case OFPUTIL_P_OF10_NXM:
1251 return ofputil_encode_nx_set_flow_format(NXFF_NXM);
1253 case OFPUTIL_P_OF10_STD:
1254 return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10);
1256 case OFPUTIL_P_OF12_OXM:
1257 /* There's only one OpenFlow 1.2 protocol and we already verified
1258 * above that we're not trying to change versions. */
1261 case OFPUTIL_P_OF10_STD_TID:
1262 case OFPUTIL_P_OF10_NXM_TID:
1267 cur_tid = (current & OFPUTIL_P_TID) != 0;
1268 want_tid = (want & OFPUTIL_P_TID) != 0;
1269 if (cur_tid != want_tid) {
1270 *next = ofputil_protocol_set_tid(current, want_tid);
1271 return ofputil_make_flow_mod_table_id(want_tid);
1274 assert(current == want);
1280 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1281 * format to 'nxff'. */
1283 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff)
1285 struct nx_set_flow_format *sff;
1288 assert(ofputil_nx_flow_format_is_valid(nxff));
1290 msg = ofpraw_alloc(OFPRAW_NXT_SET_FLOW_FORMAT, OFP10_VERSION, 0);
1291 sff = ofpbuf_put_zeros(msg, sizeof *sff);
1292 sff->format = htonl(nxff);
1297 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1299 enum ofputil_protocol
1300 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format)
1302 switch (flow_format) {
1303 case NXFF_OPENFLOW10:
1304 return OFPUTIL_P_OF10_STD;
1307 return OFPUTIL_P_OF10_NXM;
1314 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1316 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format)
1318 return ofputil_nx_flow_format_to_protocol(flow_format) != 0;
1321 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1324 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format)
1326 switch (flow_format) {
1327 case NXFF_OPENFLOW10:
1328 return "openflow10";
1337 ofputil_make_set_packet_in_format(enum ofp_version ofp_version,
1338 enum nx_packet_in_format packet_in_format)
1340 struct nx_set_packet_in_format *spif;
1343 msg = ofpraw_alloc(OFPRAW_NXT_SET_PACKET_IN_FORMAT, ofp_version, 0);
1344 spif = ofpbuf_put_zeros(msg, sizeof *spif);
1345 spif->format = htonl(packet_in_format);
1350 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1351 * extension on or off (according to 'flow_mod_table_id'). */
1353 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
1355 struct nx_flow_mod_table_id *nfmti;
1358 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION, 0);
1359 nfmti = ofpbuf_put_zeros(msg, sizeof *nfmti);
1360 nfmti->set = flow_mod_table_id;
1364 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1365 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
1368 * Uses 'ofpacts' to store the abstract OFPACT_* version of 'oh''s actions.
1369 * The caller must initialize 'ofpacts' and retains ownership of it.
1370 * 'fm->ofpacts' will point into the 'ofpacts' buffer.
1372 * Does not validate the flow_mod actions. The caller should do that, with
1373 * ofpacts_check(). */
1375 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
1376 const struct ofp_header *oh,
1377 enum ofputil_protocol protocol,
1378 struct ofpbuf *ofpacts)
1384 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1385 raw = ofpraw_pull_assert(&b);
1386 if (raw == OFPRAW_OFPT11_FLOW_MOD) {
1387 /* Standard OpenFlow 1.1 flow_mod. */
1388 const struct ofp11_flow_mod *ofm;
1391 ofm = ofpbuf_pull(&b, sizeof *ofm);
1393 error = ofputil_pull_ofp11_match(&b, &fm->match, NULL);
1398 error = ofpacts_pull_openflow11_instructions(&b, b.size, ofpacts);
1403 /* Translate the message. */
1404 fm->priority = ntohs(ofm->priority);
1405 if (ofm->command == OFPFC_ADD) {
1406 fm->cookie = htonll(0);
1407 fm->cookie_mask = htonll(0);
1408 fm->new_cookie = ofm->cookie;
1410 fm->cookie = ofm->cookie;
1411 fm->cookie_mask = ofm->cookie_mask;
1412 fm->new_cookie = htonll(UINT64_MAX);
1414 fm->command = ofm->command;
1415 fm->table_id = ofm->table_id;
1416 fm->idle_timeout = ntohs(ofm->idle_timeout);
1417 fm->hard_timeout = ntohs(ofm->hard_timeout);
1418 fm->buffer_id = ntohl(ofm->buffer_id);
1419 error = ofputil_port_from_ofp11(ofm->out_port, &fm->out_port);
1423 if (ofm->out_group != htonl(OFPG_ANY)) {
1424 return OFPERR_OFPFMFC_UNKNOWN;
1426 fm->flags = ntohs(ofm->flags);
1428 if (raw == OFPRAW_OFPT10_FLOW_MOD) {
1429 /* Standard OpenFlow 1.0 flow_mod. */
1430 const struct ofp10_flow_mod *ofm;
1433 /* Get the ofp10_flow_mod. */
1434 ofm = ofpbuf_pull(&b, sizeof *ofm);
1436 /* Translate the rule. */
1437 ofputil_match_from_ofp10_match(&ofm->match, &fm->match);
1438 ofputil_normalize_match(&fm->match);
1440 /* Now get the actions. */
1441 error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1446 /* OpenFlow 1.0 says that exact-match rules have to have the
1447 * highest possible priority. */
1448 fm->priority = (ofm->match.wildcards & htonl(OFPFW10_ALL)
1449 ? ntohs(ofm->priority)
1452 /* Translate the message. */
1453 command = ntohs(ofm->command);
1454 fm->cookie = htonll(0);
1455 fm->cookie_mask = htonll(0);
1456 fm->new_cookie = ofm->cookie;
1457 fm->idle_timeout = ntohs(ofm->idle_timeout);
1458 fm->hard_timeout = ntohs(ofm->hard_timeout);
1459 fm->buffer_id = ntohl(ofm->buffer_id);
1460 fm->out_port = ntohs(ofm->out_port);
1461 fm->flags = ntohs(ofm->flags);
1462 } else if (raw == OFPRAW_NXT_FLOW_MOD) {
1463 /* Nicira extended flow_mod. */
1464 const struct nx_flow_mod *nfm;
1467 /* Dissect the message. */
1468 nfm = ofpbuf_pull(&b, sizeof *nfm);
1469 error = nx_pull_match(&b, ntohs(nfm->match_len),
1470 &fm->match, &fm->cookie, &fm->cookie_mask);
1474 error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1479 /* Translate the message. */
1480 command = ntohs(nfm->command);
1481 if ((command & 0xff) == OFPFC_ADD && fm->cookie_mask) {
1482 /* Flow additions may only set a new cookie, not match an
1483 * existing cookie. */
1484 return OFPERR_NXBRC_NXM_INVALID;
1486 fm->priority = ntohs(nfm->priority);
1487 fm->new_cookie = nfm->cookie;
1488 fm->idle_timeout = ntohs(nfm->idle_timeout);
1489 fm->hard_timeout = ntohs(nfm->hard_timeout);
1490 fm->buffer_id = ntohl(nfm->buffer_id);
1491 fm->out_port = ntohs(nfm->out_port);
1492 fm->flags = ntohs(nfm->flags);
1497 if (protocol & OFPUTIL_P_TID) {
1498 fm->command = command & 0xff;
1499 fm->table_id = command >> 8;
1501 fm->command = command;
1502 fm->table_id = 0xff;
1506 fm->ofpacts = ofpacts->data;
1507 fm->ofpacts_len = ofpacts->size;
1513 ofputil_tid_command(const struct ofputil_flow_mod *fm,
1514 enum ofputil_protocol protocol)
1516 return htons(protocol & OFPUTIL_P_TID
1517 ? (fm->command & 0xff) | (fm->table_id << 8)
1521 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
1522 * 'protocol' and returns the message. */
1524 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
1525 enum ofputil_protocol protocol)
1530 case OFPUTIL_P_OF12_OXM: {
1531 struct ofp11_flow_mod *ofm;
1533 msg = ofpraw_alloc(OFPRAW_OFPT11_FLOW_MOD, OFP12_VERSION,
1534 NXM_TYPICAL_LEN + fm->ofpacts_len);
1535 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
1536 if (fm->command == OFPFC_ADD) {
1537 ofm->cookie = fm->new_cookie;
1539 ofm->cookie = fm->cookie;
1541 ofm->cookie_mask = fm->cookie_mask;
1542 ofm->table_id = fm->table_id;
1543 ofm->command = fm->command;
1544 ofm->idle_timeout = htons(fm->idle_timeout);
1545 ofm->hard_timeout = htons(fm->hard_timeout);
1546 ofm->priority = htons(fm->priority);
1547 ofm->buffer_id = htonl(fm->buffer_id);
1548 ofm->out_port = ofputil_port_to_ofp11(fm->out_port);
1549 ofm->out_group = htonl(OFPG11_ANY);
1550 ofm->flags = htons(fm->flags);
1551 oxm_put_match(msg, &fm->match);
1552 ofpacts_put_openflow11_instructions(fm->ofpacts, fm->ofpacts_len, msg);
1556 case OFPUTIL_P_OF10_STD:
1557 case OFPUTIL_P_OF10_STD_TID: {
1558 struct ofp10_flow_mod *ofm;
1560 msg = ofpraw_alloc(OFPRAW_OFPT10_FLOW_MOD, OFP10_VERSION,
1562 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
1563 ofputil_match_to_ofp10_match(&fm->match, &ofm->match);
1564 ofm->cookie = fm->new_cookie;
1565 ofm->command = ofputil_tid_command(fm, protocol);
1566 ofm->idle_timeout = htons(fm->idle_timeout);
1567 ofm->hard_timeout = htons(fm->hard_timeout);
1568 ofm->priority = htons(fm->priority);
1569 ofm->buffer_id = htonl(fm->buffer_id);
1570 ofm->out_port = htons(fm->out_port);
1571 ofm->flags = htons(fm->flags);
1572 ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
1576 case OFPUTIL_P_OF10_NXM:
1577 case OFPUTIL_P_OF10_NXM_TID: {
1578 struct nx_flow_mod *nfm;
1581 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD, OFP10_VERSION,
1582 NXM_TYPICAL_LEN + fm->ofpacts_len);
1583 nfm = ofpbuf_put_zeros(msg, sizeof *nfm);
1584 nfm->command = ofputil_tid_command(fm, protocol);
1585 nfm->cookie = fm->new_cookie;
1586 match_len = nx_put_match(msg, &fm->match, fm->cookie, fm->cookie_mask);
1588 nfm->idle_timeout = htons(fm->idle_timeout);
1589 nfm->hard_timeout = htons(fm->hard_timeout);
1590 nfm->priority = htons(fm->priority);
1591 nfm->buffer_id = htonl(fm->buffer_id);
1592 nfm->out_port = htons(fm->out_port);
1593 nfm->flags = htons(fm->flags);
1594 nfm->match_len = htons(match_len);
1595 ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
1603 ofpmsg_update_length(msg);
1607 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1608 * send all of the 'n_fm's flow table modification requests in 'fms', and a
1609 * 0-bit for each protocol that is inadequate.
1611 * (The return value will have at least one 1-bit.) */
1612 enum ofputil_protocol
1613 ofputil_flow_mod_usable_protocols(const struct ofputil_flow_mod *fms,
1616 enum ofputil_protocol usable_protocols;
1619 usable_protocols = OFPUTIL_P_ANY;
1620 for (i = 0; i < n_fms; i++) {
1621 const struct ofputil_flow_mod *fm = &fms[i];
1623 usable_protocols &= ofputil_usable_protocols(&fm->match);
1624 if (fm->table_id != 0xff) {
1625 usable_protocols &= OFPUTIL_P_TID;
1628 /* Matching of the cookie is only supported through NXM or OF1.1+. */
1629 if (fm->cookie_mask != htonll(0)) {
1630 usable_protocols &= OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1633 assert(usable_protocols);
1635 return usable_protocols;
1639 ofputil_decode_ofpst10_flow_request(struct ofputil_flow_stats_request *fsr,
1640 const struct ofp10_flow_stats_request *ofsr,
1643 fsr->aggregate = aggregate;
1644 ofputil_match_from_ofp10_match(&ofsr->match, &fsr->match);
1645 fsr->out_port = ntohs(ofsr->out_port);
1646 fsr->table_id = ofsr->table_id;
1647 fsr->cookie = fsr->cookie_mask = htonll(0);
1653 ofputil_decode_ofpst11_flow_request(struct ofputil_flow_stats_request *fsr,
1654 struct ofpbuf *b, bool aggregate)
1656 const struct ofp11_flow_stats_request *ofsr;
1659 ofsr = ofpbuf_pull(b, sizeof *ofsr);
1660 fsr->aggregate = aggregate;
1661 fsr->table_id = ofsr->table_id;
1662 error = ofputil_port_from_ofp11(ofsr->out_port, &fsr->out_port);
1666 if (ofsr->out_group != htonl(OFPG11_ANY)) {
1667 return OFPERR_OFPFMFC_UNKNOWN;
1669 fsr->cookie = ofsr->cookie;
1670 fsr->cookie_mask = ofsr->cookie_mask;
1671 error = ofputil_pull_ofp11_match(b, &fsr->match, NULL);
1680 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
1681 struct ofpbuf *b, bool aggregate)
1683 const struct nx_flow_stats_request *nfsr;
1686 nfsr = ofpbuf_pull(b, sizeof *nfsr);
1687 error = nx_pull_match(b, ntohs(nfsr->match_len), &fsr->match,
1688 &fsr->cookie, &fsr->cookie_mask);
1693 return OFPERR_OFPBRC_BAD_LEN;
1696 fsr->aggregate = aggregate;
1697 fsr->out_port = ntohs(nfsr->out_port);
1698 fsr->table_id = nfsr->table_id;
1703 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
1704 * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
1705 * successful, otherwise an OpenFlow error code. */
1707 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
1708 const struct ofp_header *oh)
1713 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1714 raw = ofpraw_pull_assert(&b);
1715 switch ((int) raw) {
1716 case OFPRAW_OFPST10_FLOW_REQUEST:
1717 return ofputil_decode_ofpst10_flow_request(fsr, b.data, false);
1719 case OFPRAW_OFPST10_AGGREGATE_REQUEST:
1720 return ofputil_decode_ofpst10_flow_request(fsr, b.data, true);
1722 case OFPRAW_OFPST11_FLOW_REQUEST:
1723 return ofputil_decode_ofpst11_flow_request(fsr, &b, false);
1725 case OFPRAW_OFPST11_AGGREGATE_REQUEST:
1726 return ofputil_decode_ofpst11_flow_request(fsr, &b, true);
1728 case OFPRAW_NXST_FLOW_REQUEST:
1729 return ofputil_decode_nxst_flow_request(fsr, &b, false);
1731 case OFPRAW_NXST_AGGREGATE_REQUEST:
1732 return ofputil_decode_nxst_flow_request(fsr, &b, true);
1735 /* Hey, the caller lied. */
1740 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
1741 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
1742 * 'protocol', and returns the message. */
1744 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
1745 enum ofputil_protocol protocol)
1751 case OFPUTIL_P_OF12_OXM: {
1752 struct ofp11_flow_stats_request *ofsr;
1754 raw = (fsr->aggregate
1755 ? OFPRAW_OFPST11_AGGREGATE_REQUEST
1756 : OFPRAW_OFPST11_FLOW_REQUEST);
1757 msg = ofpraw_alloc(raw, OFP12_VERSION, NXM_TYPICAL_LEN);
1758 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
1759 ofsr->table_id = fsr->table_id;
1760 ofsr->out_port = ofputil_port_to_ofp11(fsr->out_port);
1761 ofsr->out_group = htonl(OFPG11_ANY);
1762 ofsr->cookie = fsr->cookie;
1763 ofsr->cookie_mask = fsr->cookie_mask;
1764 oxm_put_match(msg, &fsr->match);
1768 case OFPUTIL_P_OF10_STD:
1769 case OFPUTIL_P_OF10_STD_TID: {
1770 struct ofp10_flow_stats_request *ofsr;
1772 raw = (fsr->aggregate
1773 ? OFPRAW_OFPST10_AGGREGATE_REQUEST
1774 : OFPRAW_OFPST10_FLOW_REQUEST);
1775 msg = ofpraw_alloc(raw, OFP10_VERSION, 0);
1776 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
1777 ofputil_match_to_ofp10_match(&fsr->match, &ofsr->match);
1778 ofsr->table_id = fsr->table_id;
1779 ofsr->out_port = htons(fsr->out_port);
1783 case OFPUTIL_P_OF10_NXM:
1784 case OFPUTIL_P_OF10_NXM_TID: {
1785 struct nx_flow_stats_request *nfsr;
1788 raw = (fsr->aggregate
1789 ? OFPRAW_NXST_AGGREGATE_REQUEST
1790 : OFPRAW_NXST_FLOW_REQUEST);
1791 msg = ofpraw_alloc(raw, OFP10_VERSION, NXM_TYPICAL_LEN);
1792 ofpbuf_put_zeros(msg, sizeof *nfsr);
1793 match_len = nx_put_match(msg, &fsr->match,
1794 fsr->cookie, fsr->cookie_mask);
1797 nfsr->out_port = htons(fsr->out_port);
1798 nfsr->match_len = htons(match_len);
1799 nfsr->table_id = fsr->table_id;
1810 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1811 * accurately encode 'fsr', and a 0-bit for each protocol that is inadequate.
1813 * (The return value will have at least one 1-bit.) */
1814 enum ofputil_protocol
1815 ofputil_flow_stats_request_usable_protocols(
1816 const struct ofputil_flow_stats_request *fsr)
1818 enum ofputil_protocol usable_protocols;
1820 usable_protocols = ofputil_usable_protocols(&fsr->match);
1821 if (fsr->cookie_mask != htonll(0)) {
1822 usable_protocols &= OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1824 return usable_protocols;
1827 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
1828 * ofputil_flow_stats in 'fs'.
1830 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
1831 * OpenFlow message. Calling this function multiple times for a single 'msg'
1832 * iterates through the replies. The caller must initially leave 'msg''s layer
1833 * pointers null and not modify them between calls.
1835 * Most switches don't send the values needed to populate fs->idle_age and
1836 * fs->hard_age, so those members will usually be set to 0. If the switch from
1837 * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
1838 * 'flow_age_extension' as true so that the contents of 'msg' determine the
1839 * 'idle_age' and 'hard_age' members in 'fs'.
1841 * Uses 'ofpacts' to store the abstract OFPACT_* version of the flow stats
1842 * reply's actions. The caller must initialize 'ofpacts' and retains ownership
1843 * of it. 'fs->ofpacts' will point into the 'ofpacts' buffer.
1845 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1846 * otherwise a positive errno value. */
1848 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
1850 bool flow_age_extension,
1851 struct ofpbuf *ofpacts)
1857 ? ofpraw_decode(&raw, msg->l2)
1858 : ofpraw_pull(&raw, msg));
1865 } else if (raw == OFPRAW_OFPST11_FLOW_REPLY) {
1866 const struct ofp11_flow_stats *ofs;
1868 uint16_t padded_match_len;
1870 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
1872 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
1873 "bytes at end", msg->size);
1877 length = ntohs(ofs->length);
1878 if (length < sizeof *ofs) {
1879 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
1880 "length %zu", length);
1884 if (ofputil_pull_ofp11_match(msg, &fs->match, &padded_match_len)) {
1885 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad match");
1889 if (ofpacts_pull_openflow11_instructions(msg, length - sizeof *ofs -
1890 padded_match_len, ofpacts)) {
1891 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad instructions");
1895 fs->priority = ntohs(ofs->priority);
1896 fs->table_id = ofs->table_id;
1897 fs->duration_sec = ntohl(ofs->duration_sec);
1898 fs->duration_nsec = ntohl(ofs->duration_nsec);
1899 fs->idle_timeout = ntohs(ofs->idle_timeout);
1900 fs->hard_timeout = ntohs(ofs->hard_timeout);
1903 fs->cookie = ofs->cookie;
1904 fs->packet_count = ntohll(ofs->packet_count);
1905 fs->byte_count = ntohll(ofs->byte_count);
1906 } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
1907 const struct ofp10_flow_stats *ofs;
1910 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
1912 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
1913 "bytes at end", msg->size);
1917 length = ntohs(ofs->length);
1918 if (length < sizeof *ofs) {
1919 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
1920 "length %zu", length);
1924 if (ofpacts_pull_openflow10(msg, length - sizeof *ofs, ofpacts)) {
1928 fs->cookie = get_32aligned_be64(&ofs->cookie);
1929 ofputil_match_from_ofp10_match(&ofs->match, &fs->match);
1930 fs->priority = ntohs(ofs->priority);
1931 fs->table_id = ofs->table_id;
1932 fs->duration_sec = ntohl(ofs->duration_sec);
1933 fs->duration_nsec = ntohl(ofs->duration_nsec);
1934 fs->idle_timeout = ntohs(ofs->idle_timeout);
1935 fs->hard_timeout = ntohs(ofs->hard_timeout);
1938 fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
1939 fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
1940 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
1941 const struct nx_flow_stats *nfs;
1942 size_t match_len, actions_len, length;
1944 nfs = ofpbuf_try_pull(msg, sizeof *nfs);
1946 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
1947 "bytes at end", msg->size);
1951 length = ntohs(nfs->length);
1952 match_len = ntohs(nfs->match_len);
1953 if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
1954 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
1955 "claims invalid length %zu", match_len, length);
1958 if (nx_pull_match(msg, match_len, &fs->match, NULL, NULL)) {
1962 actions_len = length - sizeof *nfs - ROUND_UP(match_len, 8);
1963 if (ofpacts_pull_openflow10(msg, actions_len, ofpacts)) {
1967 fs->cookie = nfs->cookie;
1968 fs->table_id = nfs->table_id;
1969 fs->duration_sec = ntohl(nfs->duration_sec);
1970 fs->duration_nsec = ntohl(nfs->duration_nsec);
1971 fs->priority = ntohs(nfs->priority);
1972 fs->idle_timeout = ntohs(nfs->idle_timeout);
1973 fs->hard_timeout = ntohs(nfs->hard_timeout);
1976 if (flow_age_extension) {
1977 if (nfs->idle_age) {
1978 fs->idle_age = ntohs(nfs->idle_age) - 1;
1980 if (nfs->hard_age) {
1981 fs->hard_age = ntohs(nfs->hard_age) - 1;
1984 fs->packet_count = ntohll(nfs->packet_count);
1985 fs->byte_count = ntohll(nfs->byte_count);
1990 fs->ofpacts = ofpacts->data;
1991 fs->ofpacts_len = ofpacts->size;
1996 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
1998 * We use this in situations where OVS internally uses UINT64_MAX to mean
1999 * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
2001 unknown_to_zero(uint64_t count)
2003 return count != UINT64_MAX ? count : 0;
2006 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
2007 * those already present in the list of ofpbufs in 'replies'. 'replies' should
2008 * have been initialized with ofputil_start_stats_reply(). */
2010 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
2011 struct list *replies)
2013 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
2014 size_t start_ofs = reply->size;
2017 ofpraw_decode_partial(&raw, reply->data, reply->size);
2018 if (raw == OFPRAW_OFPST11_FLOW_REPLY) {
2019 struct ofp11_flow_stats *ofs;
2021 ofpbuf_put_uninit(reply, sizeof *ofs);
2022 oxm_put_match(reply, &fs->match);
2023 ofpacts_put_openflow11_instructions(fs->ofpacts, fs->ofpacts_len,
2026 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
2027 ofs->length = htons(reply->size - start_ofs);
2028 ofs->table_id = fs->table_id;
2030 ofs->duration_sec = htonl(fs->duration_sec);
2031 ofs->duration_nsec = htonl(fs->duration_nsec);
2032 ofs->priority = htons(fs->priority);
2033 ofs->idle_timeout = htons(fs->idle_timeout);
2034 ofs->hard_timeout = htons(fs->hard_timeout);
2035 memset(ofs->pad2, 0, sizeof ofs->pad2);
2036 ofs->cookie = fs->cookie;
2037 ofs->packet_count = htonll(unknown_to_zero(fs->packet_count));
2038 ofs->byte_count = htonll(unknown_to_zero(fs->byte_count));
2039 } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
2040 struct ofp10_flow_stats *ofs;
2042 ofpbuf_put_uninit(reply, sizeof *ofs);
2043 ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
2045 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
2046 ofs->length = htons(reply->size - start_ofs);
2047 ofs->table_id = fs->table_id;
2049 ofputil_match_to_ofp10_match(&fs->match, &ofs->match);
2050 ofs->duration_sec = htonl(fs->duration_sec);
2051 ofs->duration_nsec = htonl(fs->duration_nsec);
2052 ofs->priority = htons(fs->priority);
2053 ofs->idle_timeout = htons(fs->idle_timeout);
2054 ofs->hard_timeout = htons(fs->hard_timeout);
2055 memset(ofs->pad2, 0, sizeof ofs->pad2);
2056 put_32aligned_be64(&ofs->cookie, fs->cookie);
2057 put_32aligned_be64(&ofs->packet_count,
2058 htonll(unknown_to_zero(fs->packet_count)));
2059 put_32aligned_be64(&ofs->byte_count,
2060 htonll(unknown_to_zero(fs->byte_count)));
2061 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
2062 struct nx_flow_stats *nfs;
2065 ofpbuf_put_uninit(reply, sizeof *nfs);
2066 match_len = nx_put_match(reply, &fs->match, 0, 0);
2067 ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
2069 nfs = ofpbuf_at_assert(reply, start_ofs, sizeof *nfs);
2070 nfs->length = htons(reply->size - start_ofs);
2071 nfs->table_id = fs->table_id;
2073 nfs->duration_sec = htonl(fs->duration_sec);
2074 nfs->duration_nsec = htonl(fs->duration_nsec);
2075 nfs->priority = htons(fs->priority);
2076 nfs->idle_timeout = htons(fs->idle_timeout);
2077 nfs->hard_timeout = htons(fs->hard_timeout);
2078 nfs->idle_age = htons(fs->idle_age < 0 ? 0
2079 : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
2081 nfs->hard_age = htons(fs->hard_age < 0 ? 0
2082 : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
2084 nfs->match_len = htons(match_len);
2085 nfs->cookie = fs->cookie;
2086 nfs->packet_count = htonll(fs->packet_count);
2087 nfs->byte_count = htonll(fs->byte_count);
2092 ofpmp_postappend(replies, start_ofs);
2095 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
2096 * NXST_AGGREGATE reply matching 'request', and returns the message. */
2098 ofputil_encode_aggregate_stats_reply(
2099 const struct ofputil_aggregate_stats *stats,
2100 const struct ofp_header *request)
2102 struct ofp_aggregate_stats_reply *asr;
2103 uint64_t packet_count;
2104 uint64_t byte_count;
2108 ofpraw_decode(&raw, request);
2109 if (raw == OFPRAW_OFPST10_AGGREGATE_REQUEST) {
2110 packet_count = unknown_to_zero(stats->packet_count);
2111 byte_count = unknown_to_zero(stats->byte_count);
2113 packet_count = stats->packet_count;
2114 byte_count = stats->byte_count;
2117 msg = ofpraw_alloc_stats_reply(request, 0);
2118 asr = ofpbuf_put_zeros(msg, sizeof *asr);
2119 put_32aligned_be64(&asr->packet_count, htonll(packet_count));
2120 put_32aligned_be64(&asr->byte_count, htonll(byte_count));
2121 asr->flow_count = htonl(stats->flow_count);
2127 ofputil_decode_aggregate_stats_reply(struct ofputil_aggregate_stats *stats,
2128 const struct ofp_header *reply)
2130 struct ofp_aggregate_stats_reply *asr;
2133 ofpbuf_use_const(&msg, reply, ntohs(reply->length));
2134 ofpraw_pull_assert(&msg);
2137 stats->packet_count = ntohll(get_32aligned_be64(&asr->packet_count));
2138 stats->byte_count = ntohll(get_32aligned_be64(&asr->byte_count));
2139 stats->flow_count = ntohl(asr->flow_count);
2144 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
2145 * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
2146 * an OpenFlow error code. */
2148 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
2149 const struct ofp_header *oh)
2154 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2155 raw = ofpraw_pull_assert(&b);
2156 if (raw == OFPRAW_OFPT11_FLOW_REMOVED) {
2157 const struct ofp12_flow_removed *ofr;
2160 ofr = ofpbuf_pull(&b, sizeof *ofr);
2162 error = ofputil_pull_ofp11_match(&b, &fr->match, NULL);
2167 fr->priority = ntohs(ofr->priority);
2168 fr->cookie = ofr->cookie;
2169 fr->reason = ofr->reason;
2170 fr->table_id = ofr->table_id;
2171 fr->duration_sec = ntohl(ofr->duration_sec);
2172 fr->duration_nsec = ntohl(ofr->duration_nsec);
2173 fr->idle_timeout = ntohs(ofr->idle_timeout);
2174 fr->hard_timeout = ntohs(ofr->hard_timeout);
2175 fr->packet_count = ntohll(ofr->packet_count);
2176 fr->byte_count = ntohll(ofr->byte_count);
2177 } else if (raw == OFPRAW_OFPT10_FLOW_REMOVED) {
2178 const struct ofp_flow_removed *ofr;
2180 ofr = ofpbuf_pull(&b, sizeof *ofr);
2182 ofputil_match_from_ofp10_match(&ofr->match, &fr->match);
2183 fr->priority = ntohs(ofr->priority);
2184 fr->cookie = ofr->cookie;
2185 fr->reason = ofr->reason;
2187 fr->duration_sec = ntohl(ofr->duration_sec);
2188 fr->duration_nsec = ntohl(ofr->duration_nsec);
2189 fr->idle_timeout = ntohs(ofr->idle_timeout);
2190 fr->hard_timeout = 0;
2191 fr->packet_count = ntohll(ofr->packet_count);
2192 fr->byte_count = ntohll(ofr->byte_count);
2193 } else if (raw == OFPRAW_NXT_FLOW_REMOVED) {
2194 struct nx_flow_removed *nfr;
2197 nfr = ofpbuf_pull(&b, sizeof *nfr);
2198 error = nx_pull_match(&b, ntohs(nfr->match_len), &fr->match,
2204 return OFPERR_OFPBRC_BAD_LEN;
2207 fr->priority = ntohs(nfr->priority);
2208 fr->cookie = nfr->cookie;
2209 fr->reason = nfr->reason;
2211 fr->duration_sec = ntohl(nfr->duration_sec);
2212 fr->duration_nsec = ntohl(nfr->duration_nsec);
2213 fr->idle_timeout = ntohs(nfr->idle_timeout);
2214 fr->hard_timeout = 0;
2215 fr->packet_count = ntohll(nfr->packet_count);
2216 fr->byte_count = ntohll(nfr->byte_count);
2224 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
2225 * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
2228 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
2229 enum ofputil_protocol protocol)
2234 case OFPUTIL_P_OF12_OXM: {
2235 struct ofp12_flow_removed *ofr;
2237 msg = ofpraw_alloc_xid(OFPRAW_OFPT11_FLOW_REMOVED,
2238 ofputil_protocol_to_ofp_version(protocol),
2239 htonl(0), NXM_TYPICAL_LEN);
2240 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
2241 ofr->cookie = fr->cookie;
2242 ofr->priority = htons(fr->priority);
2243 ofr->reason = fr->reason;
2244 ofr->table_id = fr->table_id;
2245 ofr->duration_sec = htonl(fr->duration_sec);
2246 ofr->duration_nsec = htonl(fr->duration_nsec);
2247 ofr->idle_timeout = htons(fr->idle_timeout);
2248 ofr->hard_timeout = htons(fr->hard_timeout);
2249 ofr->packet_count = htonll(fr->packet_count);
2250 ofr->byte_count = htonll(fr->byte_count);
2251 oxm_put_match(msg, &fr->match);
2255 case OFPUTIL_P_OF10_STD:
2256 case OFPUTIL_P_OF10_STD_TID: {
2257 struct ofp_flow_removed *ofr;
2259 msg = ofpraw_alloc_xid(OFPRAW_OFPT10_FLOW_REMOVED, OFP10_VERSION,
2261 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
2262 ofputil_match_to_ofp10_match(&fr->match, &ofr->match);
2263 ofr->cookie = fr->cookie;
2264 ofr->priority = htons(fr->priority);
2265 ofr->reason = fr->reason;
2266 ofr->duration_sec = htonl(fr->duration_sec);
2267 ofr->duration_nsec = htonl(fr->duration_nsec);
2268 ofr->idle_timeout = htons(fr->idle_timeout);
2269 ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
2270 ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
2274 case OFPUTIL_P_OF10_NXM:
2275 case OFPUTIL_P_OF10_NXM_TID: {
2276 struct nx_flow_removed *nfr;
2279 msg = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_REMOVED, OFP10_VERSION,
2280 htonl(0), NXM_TYPICAL_LEN);
2281 nfr = ofpbuf_put_zeros(msg, sizeof *nfr);
2282 match_len = nx_put_match(msg, &fr->match, 0, 0);
2285 nfr->cookie = fr->cookie;
2286 nfr->priority = htons(fr->priority);
2287 nfr->reason = fr->reason;
2288 nfr->duration_sec = htonl(fr->duration_sec);
2289 nfr->duration_nsec = htonl(fr->duration_nsec);
2290 nfr->idle_timeout = htons(fr->idle_timeout);
2291 nfr->match_len = htons(match_len);
2292 nfr->packet_count = htonll(fr->packet_count);
2293 nfr->byte_count = htonll(fr->byte_count);
2305 ofputil_decode_packet_in_finish(struct ofputil_packet_in *pin,
2306 struct match *match, struct ofpbuf *b)
2308 pin->packet = b->data;
2309 pin->packet_len = b->size;
2311 pin->fmd.in_port = match->flow.in_port;
2312 pin->fmd.tun_id = match->flow.tunnel.tun_id;
2313 pin->fmd.metadata = match->flow.metadata;
2314 memcpy(pin->fmd.regs, match->flow.regs, sizeof pin->fmd.regs);
2318 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
2319 const struct ofp_header *oh)
2324 memset(pin, 0, sizeof *pin);
2326 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2327 raw = ofpraw_pull_assert(&b);
2328 if (raw == OFPRAW_OFPT12_PACKET_IN) {
2329 const struct ofp12_packet_in *opi;
2333 opi = ofpbuf_pull(&b, sizeof *opi);
2334 error = oxm_pull_match_loose(&b, &match);
2339 if (!ofpbuf_try_pull(&b, 2)) {
2340 return OFPERR_OFPBRC_BAD_LEN;
2343 pin->reason = opi->reason;
2344 pin->table_id = opi->table_id;
2346 pin->buffer_id = ntohl(opi->buffer_id);
2347 pin->total_len = ntohs(opi->total_len);
2349 ofputil_decode_packet_in_finish(pin, &match, &b);
2350 } else if (raw == OFPRAW_OFPT10_PACKET_IN) {
2351 const struct ofp_packet_in *opi;
2353 opi = ofpbuf_pull(&b, offsetof(struct ofp_packet_in, data));
2355 pin->packet = opi->data;
2356 pin->packet_len = b.size;
2358 pin->fmd.in_port = ntohs(opi->in_port);
2359 pin->reason = opi->reason;
2360 pin->buffer_id = ntohl(opi->buffer_id);
2361 pin->total_len = ntohs(opi->total_len);
2362 } else if (raw == OFPRAW_NXT_PACKET_IN) {
2363 const struct nx_packet_in *npi;
2367 npi = ofpbuf_pull(&b, sizeof *npi);
2368 error = nx_pull_match_loose(&b, ntohs(npi->match_len), &match, NULL,
2374 if (!ofpbuf_try_pull(&b, 2)) {
2375 return OFPERR_OFPBRC_BAD_LEN;
2378 pin->reason = npi->reason;
2379 pin->table_id = npi->table_id;
2380 pin->cookie = npi->cookie;
2382 pin->buffer_id = ntohl(npi->buffer_id);
2383 pin->total_len = ntohs(npi->total_len);
2385 ofputil_decode_packet_in_finish(pin, &match, &b);
2394 ofputil_packet_in_to_match(const struct ofputil_packet_in *pin,
2395 struct match *match)
2399 match_init_catchall(match);
2400 if (pin->fmd.tun_id != htonll(0)) {
2401 match_set_tun_id(match, pin->fmd.tun_id);
2403 if (pin->fmd.metadata != htonll(0)) {
2404 match_set_metadata(match, pin->fmd.metadata);
2407 for (i = 0; i < FLOW_N_REGS; i++) {
2408 if (pin->fmd.regs[i]) {
2409 match_set_reg(match, i, pin->fmd.regs[i]);
2413 match_set_in_port(match, pin->fmd.in_port);
2416 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
2417 * in the format specified by 'packet_in_format'. */
2419 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
2420 enum ofputil_protocol protocol,
2421 enum nx_packet_in_format packet_in_format)
2423 size_t send_len = MIN(pin->send_len, pin->packet_len);
2424 struct ofpbuf *packet;
2426 /* Add OFPT_PACKET_IN. */
2427 if (protocol == OFPUTIL_P_OF12_OXM) {
2428 struct ofp12_packet_in *opi;
2431 ofputil_packet_in_to_match(pin, &match);
2433 /* The final argument is just an estimate of the space required. */
2434 packet = ofpraw_alloc_xid(OFPRAW_OFPT12_PACKET_IN, OFP12_VERSION,
2435 htonl(0), (sizeof(struct flow_metadata) * 2
2437 ofpbuf_put_zeros(packet, sizeof *opi);
2438 oxm_put_match(packet, &match);
2439 ofpbuf_put_zeros(packet, 2);
2440 ofpbuf_put(packet, pin->packet, send_len);
2443 opi->buffer_id = htonl(pin->buffer_id);
2444 opi->total_len = htons(pin->total_len);
2445 opi->reason = pin->reason;
2446 opi->table_id = pin->table_id;
2447 } else if (packet_in_format == NXPIF_OPENFLOW10) {
2448 struct ofp_packet_in *opi;
2450 packet = ofpraw_alloc_xid(OFPRAW_OFPT10_PACKET_IN, OFP10_VERSION,
2451 htonl(0), send_len);
2452 opi = ofpbuf_put_zeros(packet, offsetof(struct ofp_packet_in, data));
2453 opi->total_len = htons(pin->total_len);
2454 opi->in_port = htons(pin->fmd.in_port);
2455 opi->reason = pin->reason;
2456 opi->buffer_id = htonl(pin->buffer_id);
2458 ofpbuf_put(packet, pin->packet, send_len);
2459 } else if (packet_in_format == NXPIF_NXM) {
2460 struct nx_packet_in *npi;
2464 ofputil_packet_in_to_match(pin, &match);
2466 /* The final argument is just an estimate of the space required. */
2467 packet = ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN, OFP10_VERSION,
2468 htonl(0), (sizeof(struct flow_metadata) * 2
2470 ofpbuf_put_zeros(packet, sizeof *npi);
2471 match_len = nx_put_match(packet, &match, 0, 0);
2472 ofpbuf_put_zeros(packet, 2);
2473 ofpbuf_put(packet, pin->packet, send_len);
2476 npi->buffer_id = htonl(pin->buffer_id);
2477 npi->total_len = htons(pin->total_len);
2478 npi->reason = pin->reason;
2479 npi->table_id = pin->table_id;
2480 npi->cookie = pin->cookie;
2481 npi->match_len = htons(match_len);
2485 ofpmsg_update_length(packet);
2491 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason)
2493 static char s[INT_STRLEN(int) + 1];
2500 case OFPR_INVALID_TTL:
2501 return "invalid_ttl";
2503 case OFPR_N_REASONS:
2505 sprintf(s, "%d", (int) reason);
2511 ofputil_packet_in_reason_from_string(const char *s,
2512 enum ofp_packet_in_reason *reason)
2516 for (i = 0; i < OFPR_N_REASONS; i++) {
2517 if (!strcasecmp(s, ofputil_packet_in_reason_to_string(i))) {
2525 /* Converts an OFPT_PACKET_OUT in 'opo' into an abstract ofputil_packet_out in
2528 * Uses 'ofpacts' to store the abstract OFPACT_* version of the packet out
2529 * message's actions. The caller must initialize 'ofpacts' and retains
2530 * ownership of it. 'po->ofpacts' will point into the 'ofpacts' buffer.
2532 * Returns 0 if successful, otherwise an OFPERR_* value. */
2534 ofputil_decode_packet_out(struct ofputil_packet_out *po,
2535 const struct ofp_header *oh,
2536 struct ofpbuf *ofpacts)
2541 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2542 raw = ofpraw_pull_assert(&b);
2544 if (raw == OFPRAW_OFPT11_PACKET_OUT) {
2546 const struct ofp11_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
2548 po->buffer_id = ntohl(opo->buffer_id);
2549 error = ofputil_port_from_ofp11(opo->in_port, &po->in_port);
2554 error = ofpacts_pull_openflow11_actions(&b, ntohs(opo->actions_len),
2559 } else if (raw == OFPRAW_OFPT10_PACKET_OUT) {
2561 const struct ofp_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
2563 po->buffer_id = ntohl(opo->buffer_id);
2564 po->in_port = ntohs(opo->in_port);
2566 error = ofpacts_pull_openflow10(&b, ntohs(opo->actions_len), ofpacts);
2574 if (po->in_port >= OFPP_MAX && po->in_port != OFPP_LOCAL
2575 && po->in_port != OFPP_NONE && po->in_port != OFPP_CONTROLLER) {
2576 VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
2578 return OFPERR_OFPBRC_BAD_PORT;
2581 po->ofpacts = ofpacts->data;
2582 po->ofpacts_len = ofpacts->size;
2584 if (po->buffer_id == UINT32_MAX) {
2585 po->packet = b.data;
2586 po->packet_len = b.size;
2595 /* ofputil_phy_port */
2597 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
2598 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
2599 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
2600 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
2601 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
2602 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
2603 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
2604 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
2606 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
2607 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
2608 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
2609 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
2610 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
2611 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
2613 static enum netdev_features
2614 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
2616 uint32_t ofp10 = ntohl(ofp10_);
2617 return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
2621 netdev_port_features_to_ofp10(enum netdev_features features)
2623 return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
2626 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
2627 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
2628 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
2629 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
2630 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
2631 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
2632 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
2633 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD == OFPPF11_40GB_FD); /* bit 7 */
2634 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD == OFPPF11_100GB_FD); /* bit 8 */
2635 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD == OFPPF11_1TB_FD); /* bit 9 */
2636 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER == OFPPF11_OTHER); /* bit 10 */
2637 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == OFPPF11_COPPER); /* bit 11 */
2638 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == OFPPF11_FIBER); /* bit 12 */
2639 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == OFPPF11_AUTONEG); /* bit 13 */
2640 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == OFPPF11_PAUSE); /* bit 14 */
2641 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
2643 static enum netdev_features
2644 netdev_port_features_from_ofp11(ovs_be32 ofp11)
2646 return ntohl(ofp11) & 0xffff;
2650 netdev_port_features_to_ofp11(enum netdev_features features)
2652 return htonl(features & 0xffff);
2656 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
2657 const struct ofp10_phy_port *opp)
2659 memset(pp, 0, sizeof *pp);
2661 pp->port_no = ntohs(opp->port_no);
2662 memcpy(pp->hw_addr, opp->hw_addr, OFP_ETH_ALEN);
2663 ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
2665 pp->config = ntohl(opp->config) & OFPPC10_ALL;
2666 pp->state = ntohl(opp->state) & OFPPS10_ALL;
2668 pp->curr = netdev_port_features_from_ofp10(opp->curr);
2669 pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
2670 pp->supported = netdev_port_features_from_ofp10(opp->supported);
2671 pp->peer = netdev_port_features_from_ofp10(opp->peer);
2673 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2674 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2680 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
2681 const struct ofp11_port *op)
2685 memset(pp, 0, sizeof *pp);
2687 error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
2691 memcpy(pp->hw_addr, op->hw_addr, OFP_ETH_ALEN);
2692 ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
2694 pp->config = ntohl(op->config) & OFPPC11_ALL;
2695 pp->state = ntohl(op->state) & OFPPC11_ALL;
2697 pp->curr = netdev_port_features_from_ofp11(op->curr);
2698 pp->advertised = netdev_port_features_from_ofp11(op->advertised);
2699 pp->supported = netdev_port_features_from_ofp11(op->supported);
2700 pp->peer = netdev_port_features_from_ofp11(op->peer);
2702 pp->curr_speed = ntohl(op->curr_speed);
2703 pp->max_speed = ntohl(op->max_speed);
2709 ofputil_get_phy_port_size(enum ofp_version ofp_version)
2711 switch (ofp_version) {
2713 return sizeof(struct ofp10_phy_port);
2716 return sizeof(struct ofp11_port);
2723 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
2724 struct ofp10_phy_port *opp)
2726 memset(opp, 0, sizeof *opp);
2728 opp->port_no = htons(pp->port_no);
2729 memcpy(opp->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2730 ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2732 opp->config = htonl(pp->config & OFPPC10_ALL);
2733 opp->state = htonl(pp->state & OFPPS10_ALL);
2735 opp->curr = netdev_port_features_to_ofp10(pp->curr);
2736 opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
2737 opp->supported = netdev_port_features_to_ofp10(pp->supported);
2738 opp->peer = netdev_port_features_to_ofp10(pp->peer);
2742 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
2743 struct ofp11_port *op)
2745 memset(op, 0, sizeof *op);
2747 op->port_no = ofputil_port_to_ofp11(pp->port_no);
2748 memcpy(op->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2749 ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2751 op->config = htonl(pp->config & OFPPC11_ALL);
2752 op->state = htonl(pp->state & OFPPS11_ALL);
2754 op->curr = netdev_port_features_to_ofp11(pp->curr);
2755 op->advertised = netdev_port_features_to_ofp11(pp->advertised);
2756 op->supported = netdev_port_features_to_ofp11(pp->supported);
2757 op->peer = netdev_port_features_to_ofp11(pp->peer);
2759 op->curr_speed = htonl(pp->curr_speed);
2760 op->max_speed = htonl(pp->max_speed);
2764 ofputil_put_phy_port(enum ofp_version ofp_version,
2765 const struct ofputil_phy_port *pp, struct ofpbuf *b)
2767 switch (ofp_version) {
2768 case OFP10_VERSION: {
2769 struct ofp10_phy_port *opp;
2770 if (b->size + sizeof *opp <= UINT16_MAX) {
2771 opp = ofpbuf_put_uninit(b, sizeof *opp);
2772 ofputil_encode_ofp10_phy_port(pp, opp);
2778 case OFP12_VERSION: {
2779 struct ofp11_port *op;
2780 if (b->size + sizeof *op <= UINT16_MAX) {
2781 op = ofpbuf_put_uninit(b, sizeof *op);
2782 ofputil_encode_ofp11_port(pp, op);
2793 ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
2794 const struct ofputil_phy_port *pp,
2795 struct list *replies)
2797 switch (ofp_version) {
2798 case OFP10_VERSION: {
2799 struct ofp10_phy_port *opp;
2801 opp = ofpmp_append(replies, sizeof *opp);
2802 ofputil_encode_ofp10_phy_port(pp, opp);
2807 case OFP12_VERSION: {
2808 struct ofp11_port *op;
2810 op = ofpmp_append(replies, sizeof *op);
2811 ofputil_encode_ofp11_port(pp, op);
2820 /* ofputil_switch_features */
2822 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
2823 OFPC_IP_REASM | OFPC_QUEUE_STATS)
2824 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
2825 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
2826 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
2827 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
2828 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
2829 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
2831 struct ofputil_action_bit_translation {
2832 enum ofputil_action_bitmap ofputil_bit;
2836 static const struct ofputil_action_bit_translation of10_action_bits[] = {
2837 { OFPUTIL_A_OUTPUT, OFPAT10_OUTPUT },
2838 { OFPUTIL_A_SET_VLAN_VID, OFPAT10_SET_VLAN_VID },
2839 { OFPUTIL_A_SET_VLAN_PCP, OFPAT10_SET_VLAN_PCP },
2840 { OFPUTIL_A_STRIP_VLAN, OFPAT10_STRIP_VLAN },
2841 { OFPUTIL_A_SET_DL_SRC, OFPAT10_SET_DL_SRC },
2842 { OFPUTIL_A_SET_DL_DST, OFPAT10_SET_DL_DST },
2843 { OFPUTIL_A_SET_NW_SRC, OFPAT10_SET_NW_SRC },
2844 { OFPUTIL_A_SET_NW_DST, OFPAT10_SET_NW_DST },
2845 { OFPUTIL_A_SET_NW_TOS, OFPAT10_SET_NW_TOS },
2846 { OFPUTIL_A_SET_TP_SRC, OFPAT10_SET_TP_SRC },
2847 { OFPUTIL_A_SET_TP_DST, OFPAT10_SET_TP_DST },
2848 { OFPUTIL_A_ENQUEUE, OFPAT10_ENQUEUE },
2852 static enum ofputil_action_bitmap
2853 decode_action_bits(ovs_be32 of_actions,
2854 const struct ofputil_action_bit_translation *x)
2856 enum ofputil_action_bitmap ofputil_actions;
2858 ofputil_actions = 0;
2859 for (; x->ofputil_bit; x++) {
2860 if (of_actions & htonl(1u << x->of_bit)) {
2861 ofputil_actions |= x->ofputil_bit;
2864 return ofputil_actions;
2868 ofputil_capabilities_mask(enum ofp_version ofp_version)
2870 /* Handle capabilities whose bit is unique for all Open Flow versions */
2871 switch (ofp_version) {
2874 return OFPC_COMMON | OFPC_ARP_MATCH_IP;
2876 return OFPC_COMMON | OFPC12_PORT_BLOCKED;
2878 /* Caller needs to check osf->header.version itself */
2883 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
2884 * abstract representation in '*features'. Initializes '*b' to iterate over
2885 * the OpenFlow port structures following 'osf' with later calls to
2886 * ofputil_pull_phy_port(). Returns 0 if successful, otherwise an
2887 * OFPERR_* value. */
2889 ofputil_decode_switch_features(const struct ofp_header *oh,
2890 struct ofputil_switch_features *features,
2893 const struct ofp_switch_features *osf;
2896 ofpbuf_use_const(b, oh, ntohs(oh->length));
2897 raw = ofpraw_pull_assert(b);
2899 osf = ofpbuf_pull(b, sizeof *osf);
2900 features->datapath_id = ntohll(osf->datapath_id);
2901 features->n_buffers = ntohl(osf->n_buffers);
2902 features->n_tables = osf->n_tables;
2904 features->capabilities = ntohl(osf->capabilities) &
2905 ofputil_capabilities_mask(oh->version);
2907 if (b->size % ofputil_get_phy_port_size(oh->version)) {
2908 return OFPERR_OFPBRC_BAD_LEN;
2911 if (raw == OFPRAW_OFPT10_FEATURES_REPLY) {
2912 if (osf->capabilities & htonl(OFPC10_STP)) {
2913 features->capabilities |= OFPUTIL_C_STP;
2915 features->actions = decode_action_bits(osf->actions, of10_action_bits);
2916 } else if (raw == OFPRAW_OFPT11_FEATURES_REPLY) {
2917 if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
2918 features->capabilities |= OFPUTIL_C_GROUP_STATS;
2920 features->actions = 0;
2922 return OFPERR_OFPBRC_BAD_VERSION;
2928 /* Returns true if the maximum number of ports are in 'oh'. */
2930 max_ports_in_features(const struct ofp_header *oh)
2932 size_t pp_size = ofputil_get_phy_port_size(oh->version);
2933 return ntohs(oh->length) + pp_size > UINT16_MAX;
2936 /* Given a buffer 'b' that contains a Features Reply message, checks if
2937 * it contains the maximum number of ports that will fit. If so, it
2938 * returns true and removes the ports from the message. The caller
2939 * should then send an OFPST_PORT_DESC stats request to get the ports,
2940 * since the switch may have more ports than could be represented in the
2941 * Features Reply. Otherwise, returns false.
2944 ofputil_switch_features_ports_trunc(struct ofpbuf *b)
2946 struct ofp_header *oh = b->data;
2948 if (max_ports_in_features(oh)) {
2949 /* Remove all the ports. */
2950 b->size = (sizeof(struct ofp_header)
2951 + sizeof(struct ofp_switch_features));
2952 ofpmsg_update_length(b);
2961 encode_action_bits(enum ofputil_action_bitmap ofputil_actions,
2962 const struct ofputil_action_bit_translation *x)
2964 uint32_t of_actions;
2967 for (; x->ofputil_bit; x++) {
2968 if (ofputil_actions & x->ofputil_bit) {
2969 of_actions |= 1 << x->of_bit;
2972 return htonl(of_actions);
2975 /* Returns a buffer owned by the caller that encodes 'features' in the format
2976 * required by 'protocol' with the given 'xid'. The caller should append port
2977 * information to the buffer with subsequent calls to
2978 * ofputil_put_switch_features_port(). */
2980 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
2981 enum ofputil_protocol protocol, ovs_be32 xid)
2983 struct ofp_switch_features *osf;
2985 enum ofp_version version;
2988 version = ofputil_protocol_to_ofp_version(protocol);
2991 raw = OFPRAW_OFPT10_FEATURES_REPLY;
2995 raw = OFPRAW_OFPT11_FEATURES_REPLY;
3000 b = ofpraw_alloc_xid(raw, version, xid, 0);
3001 osf = ofpbuf_put_zeros(b, sizeof *osf);
3002 osf->datapath_id = htonll(features->datapath_id);
3003 osf->n_buffers = htonl(features->n_buffers);
3004 osf->n_tables = features->n_tables;
3006 osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
3007 osf->capabilities = htonl(features->capabilities &
3008 ofputil_capabilities_mask(version));
3011 if (features->capabilities & OFPUTIL_C_STP) {
3012 osf->capabilities |= htonl(OFPC10_STP);
3014 osf->actions = encode_action_bits(features->actions, of10_action_bits);
3018 if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
3019 osf->capabilities |= htonl(OFPC11_GROUP_STATS);
3029 /* Encodes 'pp' into the format required by the switch_features message already
3030 * in 'b', which should have been returned by ofputil_encode_switch_features(),
3031 * and appends the encoded version to 'b'. */
3033 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
3036 const struct ofp_header *oh = b->data;
3038 ofputil_put_phy_port(oh->version, pp, b);
3041 /* ofputil_port_status */
3043 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
3044 * in '*ps'. Returns 0 if successful, otherwise an OFPERR_* value. */
3046 ofputil_decode_port_status(const struct ofp_header *oh,
3047 struct ofputil_port_status *ps)
3049 const struct ofp_port_status *ops;
3053 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3054 ofpraw_pull_assert(&b);
3055 ops = ofpbuf_pull(&b, sizeof *ops);
3057 if (ops->reason != OFPPR_ADD &&
3058 ops->reason != OFPPR_DELETE &&
3059 ops->reason != OFPPR_MODIFY) {
3060 return OFPERR_NXBRC_BAD_REASON;
3062 ps->reason = ops->reason;
3064 retval = ofputil_pull_phy_port(oh->version, &b, &ps->desc);
3065 assert(retval != EOF);
3069 /* Converts the abstract form of a "port status" message in '*ps' into an
3070 * OpenFlow message suitable for 'protocol', and returns that encoded form in
3071 * a buffer owned by the caller. */
3073 ofputil_encode_port_status(const struct ofputil_port_status *ps,
3074 enum ofputil_protocol protocol)
3076 struct ofp_port_status *ops;
3078 enum ofp_version version;
3081 version = ofputil_protocol_to_ofp_version(protocol);
3084 raw = OFPRAW_OFPT10_PORT_STATUS;
3089 raw = OFPRAW_OFPT11_PORT_STATUS;
3096 b = ofpraw_alloc_xid(raw, version, htonl(0), 0);
3097 ops = ofpbuf_put_zeros(b, sizeof *ops);
3098 ops->reason = ps->reason;
3099 ofputil_put_phy_port(version, &ps->desc, b);
3100 ofpmsg_update_length(b);
3104 /* ofputil_port_mod */
3106 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
3107 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
3109 ofputil_decode_port_mod(const struct ofp_header *oh,
3110 struct ofputil_port_mod *pm)
3115 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3116 raw = ofpraw_pull_assert(&b);
3118 if (raw == OFPRAW_OFPT10_PORT_MOD) {
3119 const struct ofp10_port_mod *opm = b.data;
3121 pm->port_no = ntohs(opm->port_no);
3122 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
3123 pm->config = ntohl(opm->config) & OFPPC10_ALL;
3124 pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
3125 pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
3126 } else if (raw == OFPRAW_OFPT11_PORT_MOD) {
3127 const struct ofp11_port_mod *opm = b.data;
3130 error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
3135 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
3136 pm->config = ntohl(opm->config) & OFPPC11_ALL;
3137 pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
3138 pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
3140 return OFPERR_OFPBRC_BAD_TYPE;
3143 pm->config &= pm->mask;
3147 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
3148 * message suitable for 'protocol', and returns that encoded form in a buffer
3149 * owned by the caller. */
3151 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
3152 enum ofputil_protocol protocol)
3154 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
3157 switch (ofp_version) {
3158 case OFP10_VERSION: {
3159 struct ofp10_port_mod *opm;
3161 b = ofpraw_alloc(OFPRAW_OFPT10_PORT_MOD, ofp_version, 0);
3162 opm = ofpbuf_put_zeros(b, sizeof *opm);
3163 opm->port_no = htons(pm->port_no);
3164 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
3165 opm->config = htonl(pm->config & OFPPC10_ALL);
3166 opm->mask = htonl(pm->mask & OFPPC10_ALL);
3167 opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
3172 case OFP12_VERSION: {
3173 struct ofp11_port_mod *opm;
3175 b = ofpraw_alloc(OFPRAW_OFPT11_PORT_MOD, ofp_version, 0);
3176 opm = ofpbuf_put_zeros(b, sizeof *opm);
3177 opm->port_no = ofputil_port_to_ofp11(pm->port_no);
3178 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
3179 opm->config = htonl(pm->config & OFPPC11_ALL);
3180 opm->mask = htonl(pm->mask & OFPPC11_ALL);
3181 opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
3195 ofputil_put_ofp10_table_stats(const struct ofp12_table_stats *in,
3199 enum ofp_flow_wildcards wc10;
3200 enum oxm12_ofb_match_fields mf12;
3203 static const struct wc_map wc_map[] = {
3204 { OFPFW10_IN_PORT, OFPXMT12_OFB_IN_PORT },
3205 { OFPFW10_DL_VLAN, OFPXMT12_OFB_VLAN_VID },
3206 { OFPFW10_DL_SRC, OFPXMT12_OFB_ETH_SRC },
3207 { OFPFW10_DL_DST, OFPXMT12_OFB_ETH_DST},
3208 { OFPFW10_DL_TYPE, OFPXMT12_OFB_ETH_TYPE },
3209 { OFPFW10_NW_PROTO, OFPXMT12_OFB_IP_PROTO },
3210 { OFPFW10_TP_SRC, OFPXMT12_OFB_TCP_SRC },
3211 { OFPFW10_TP_DST, OFPXMT12_OFB_TCP_DST },
3212 { OFPFW10_NW_SRC_MASK, OFPXMT12_OFB_IPV4_SRC },
3213 { OFPFW10_NW_DST_MASK, OFPXMT12_OFB_IPV4_DST },
3214 { OFPFW10_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP },
3215 { OFPFW10_NW_TOS, OFPXMT12_OFB_IP_DSCP },
3218 struct ofp10_table_stats *out;
3219 const struct wc_map *p;
3221 out = ofpbuf_put_uninit(buf, sizeof *out);
3222 out->table_id = in->table_id;
3223 strcpy(out->name, in->name);
3225 for (p = wc_map; p < &wc_map[ARRAY_SIZE(wc_map)]; p++) {
3226 if (in->wildcards & htonll(1ULL << p->mf12)) {
3227 out->wildcards |= htonl(p->wc10);
3230 out->max_entries = in->max_entries;
3231 out->active_count = in->active_count;
3232 put_32aligned_be64(&out->lookup_count, in->lookup_count);
3233 put_32aligned_be64(&out->matched_count, in->matched_count);
3237 oxm12_to_ofp11_flow_match_fields(ovs_be64 oxm12)
3240 enum ofp11_flow_match_fields fmf11;
3241 enum oxm12_ofb_match_fields mf12;
3244 static const struct map map[] = {
3245 { OFPFMF11_IN_PORT, OFPXMT12_OFB_IN_PORT },
3246 { OFPFMF11_DL_VLAN, OFPXMT12_OFB_VLAN_VID },
3247 { OFPFMF11_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP },
3248 { OFPFMF11_DL_TYPE, OFPXMT12_OFB_ETH_TYPE },
3249 { OFPFMF11_NW_TOS, OFPXMT12_OFB_IP_DSCP },
3250 { OFPFMF11_NW_PROTO, OFPXMT12_OFB_IP_PROTO },
3251 { OFPFMF11_TP_SRC, OFPXMT12_OFB_TCP_SRC },
3252 { OFPFMF11_TP_DST, OFPXMT12_OFB_TCP_DST },
3253 { OFPFMF11_MPLS_LABEL, OFPXMT12_OFB_MPLS_LABEL },
3254 { OFPFMF11_MPLS_TC, OFPXMT12_OFB_MPLS_TC },
3255 /* I don't know what OFPFMF11_TYPE means. */
3256 { OFPFMF11_DL_SRC, OFPXMT12_OFB_ETH_SRC },
3257 { OFPFMF11_DL_DST, OFPXMT12_OFB_ETH_DST },
3258 { OFPFMF11_NW_SRC, OFPXMT12_OFB_IPV4_SRC },
3259 { OFPFMF11_NW_DST, OFPXMT12_OFB_IPV4_DST },
3260 { OFPFMF11_METADATA, OFPXMT12_OFB_METADATA },
3263 const struct map *p;
3267 for (p = map; p < &map[ARRAY_SIZE(map)]; p++) {
3268 if (oxm12 & htonll(1ULL << p->mf12)) {
3272 return htonl(fmf11);
3276 ofputil_put_ofp11_table_stats(const struct ofp12_table_stats *in,
3279 struct ofp11_table_stats *out;
3281 out = ofpbuf_put_uninit(buf, sizeof *out);
3282 out->table_id = in->table_id;
3283 strcpy(out->name, in->name);
3284 out->wildcards = oxm12_to_ofp11_flow_match_fields(in->wildcards);
3285 out->match = oxm12_to_ofp11_flow_match_fields(in->match);
3286 out->instructions = in->instructions;
3287 out->write_actions = in->write_actions;
3288 out->apply_actions = in->apply_actions;
3289 out->config = in->config;
3290 out->max_entries = in->max_entries;
3291 out->active_count = in->active_count;
3292 out->lookup_count = in->lookup_count;
3293 out->matched_count = in->matched_count;
3297 ofputil_encode_table_stats_reply(const struct ofp12_table_stats stats[], int n,
3298 const struct ofp_header *request)
3300 struct ofpbuf *reply;
3303 reply = ofpraw_alloc_stats_reply(request, n * sizeof *stats);
3305 switch ((enum ofp_version) request->version) {
3307 for (i = 0; i < n; i++) {
3308 ofputil_put_ofp10_table_stats(&stats[i], reply);
3313 for (i = 0; i < n; i++) {
3314 ofputil_put_ofp11_table_stats(&stats[i], reply);
3319 ofpbuf_put(reply, stats, n * sizeof *stats);
3329 /* ofputil_flow_monitor_request */
3331 /* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract
3332 * ofputil_flow_monitor_request in 'rq'.
3334 * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow
3335 * message. Calling this function multiple times for a single 'msg' iterates
3336 * through the requests. The caller must initially leave 'msg''s layer
3337 * pointers null and not modify them between calls.
3339 * Returns 0 if successful, EOF if no requests were left in this 'msg',
3340 * otherwise an OFPERR_* value. */
3342 ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *rq,
3345 struct nx_flow_monitor_request *nfmr;
3349 msg->l2 = msg->data;
3350 ofpraw_pull_assert(msg);
3357 nfmr = ofpbuf_try_pull(msg, sizeof *nfmr);
3359 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR request has %zu "
3360 "leftover bytes at end", msg->size);
3361 return OFPERR_OFPBRC_BAD_LEN;
3364 flags = ntohs(nfmr->flags);
3365 if (!(flags & (NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY))
3366 || flags & ~(NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE
3367 | NXFMF_MODIFY | NXFMF_ACTIONS | NXFMF_OWN)) {
3368 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR has bad flags %#"PRIx16,
3370 return OFPERR_NXBRC_FM_BAD_FLAGS;
3373 if (!is_all_zeros(nfmr->zeros, sizeof nfmr->zeros)) {
3374 return OFPERR_NXBRC_MUST_BE_ZERO;
3377 rq->id = ntohl(nfmr->id);
3379 rq->out_port = ntohs(nfmr->out_port);
3380 rq->table_id = nfmr->table_id;
3382 return nx_pull_match(msg, ntohs(nfmr->match_len), &rq->match, NULL, NULL);
3386 ofputil_append_flow_monitor_request(
3387 const struct ofputil_flow_monitor_request *rq, struct ofpbuf *msg)
3389 struct nx_flow_monitor_request *nfmr;
3394 ofpraw_put(OFPRAW_NXST_FLOW_MONITOR_REQUEST, OFP10_VERSION, msg);
3397 start_ofs = msg->size;
3398 ofpbuf_put_zeros(msg, sizeof *nfmr);
3399 match_len = nx_put_match(msg, &rq->match, htonll(0), htonll(0));
3401 nfmr = ofpbuf_at_assert(msg, start_ofs, sizeof *nfmr);
3402 nfmr->id = htonl(rq->id);
3403 nfmr->flags = htons(rq->flags);
3404 nfmr->out_port = htons(rq->out_port);
3405 nfmr->match_len = htons(match_len);
3406 nfmr->table_id = rq->table_id;
3409 /* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg'
3410 * into an abstract ofputil_flow_update in 'update'. The caller must have
3411 * initialized update->match to point to space allocated for a match.
3413 * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's
3414 * actions (except for NXFME_ABBREV, which never includes actions). The caller
3415 * must initialize 'ofpacts' and retains ownership of it. 'update->ofpacts'
3416 * will point into the 'ofpacts' buffer.
3418 * Multiple flow updates can be packed into a single OpenFlow message. Calling
3419 * this function multiple times for a single 'msg' iterates through the
3420 * updates. The caller must initially leave 'msg''s layer pointers null and
3421 * not modify them between calls.
3423 * Returns 0 if successful, EOF if no updates were left in this 'msg',
3424 * otherwise an OFPERR_* value. */
3426 ofputil_decode_flow_update(struct ofputil_flow_update *update,
3427 struct ofpbuf *msg, struct ofpbuf *ofpacts)
3429 struct nx_flow_update_header *nfuh;
3430 unsigned int length;
3433 msg->l2 = msg->data;
3434 ofpraw_pull_assert(msg);
3441 if (msg->size < sizeof(struct nx_flow_update_header)) {
3446 update->event = ntohs(nfuh->event);
3447 length = ntohs(nfuh->length);
3448 if (length > msg->size || length % 8) {
3452 if (update->event == NXFME_ABBREV) {
3453 struct nx_flow_update_abbrev *nfua;
3455 if (length != sizeof *nfua) {
3459 nfua = ofpbuf_pull(msg, sizeof *nfua);
3460 update->xid = nfua->xid;
3462 } else if (update->event == NXFME_ADDED
3463 || update->event == NXFME_DELETED
3464 || update->event == NXFME_MODIFIED) {
3465 struct nx_flow_update_full *nfuf;
3466 unsigned int actions_len;
3467 unsigned int match_len;
3470 if (length < sizeof *nfuf) {
3474 nfuf = ofpbuf_pull(msg, sizeof *nfuf);
3475 match_len = ntohs(nfuf->match_len);
3476 if (sizeof *nfuf + match_len > length) {
3480 update->reason = ntohs(nfuf->reason);
3481 update->idle_timeout = ntohs(nfuf->idle_timeout);
3482 update->hard_timeout = ntohs(nfuf->hard_timeout);
3483 update->table_id = nfuf->table_id;
3484 update->cookie = nfuf->cookie;
3485 update->priority = ntohs(nfuf->priority);
3487 error = nx_pull_match(msg, match_len, update->match, NULL, NULL);
3492 actions_len = length - sizeof *nfuf - ROUND_UP(match_len, 8);
3493 error = ofpacts_pull_openflow10(msg, actions_len, ofpacts);
3498 update->ofpacts = ofpacts->data;
3499 update->ofpacts_len = ofpacts->size;
3502 VLOG_WARN_RL(&bad_ofmsg_rl,
3503 "NXST_FLOW_MONITOR reply has bad event %"PRIu16,
3504 ntohs(nfuh->event));
3505 return OFPERR_OFPET_BAD_REQUEST;
3509 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR reply has %zu "
3510 "leftover bytes at end", msg->size);
3511 return OFPERR_OFPBRC_BAD_LEN;
3515 ofputil_decode_flow_monitor_cancel(const struct ofp_header *oh)
3517 const struct nx_flow_monitor_cancel *cancel = ofpmsg_body(oh);
3519 return ntohl(cancel->id);
3523 ofputil_encode_flow_monitor_cancel(uint32_t id)
3525 struct nx_flow_monitor_cancel *nfmc;
3528 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MONITOR_CANCEL, OFP10_VERSION, 0);
3529 nfmc = ofpbuf_put_uninit(msg, sizeof *nfmc);
3530 nfmc->id = htonl(id);
3535 ofputil_start_flow_update(struct list *replies)
3539 msg = ofpraw_alloc_xid(OFPRAW_NXST_FLOW_MONITOR_REPLY, OFP10_VERSION,
3543 list_push_back(replies, &msg->list_node);
3547 ofputil_append_flow_update(const struct ofputil_flow_update *update,
3548 struct list *replies)
3550 struct nx_flow_update_header *nfuh;
3554 msg = ofpbuf_from_list(list_back(replies));
3555 start_ofs = msg->size;
3557 if (update->event == NXFME_ABBREV) {
3558 struct nx_flow_update_abbrev *nfua;
3560 nfua = ofpbuf_put_zeros(msg, sizeof *nfua);
3561 nfua->xid = update->xid;
3563 struct nx_flow_update_full *nfuf;
3566 ofpbuf_put_zeros(msg, sizeof *nfuf);
3567 match_len = nx_put_match(msg, update->match, htonll(0), htonll(0));
3568 ofpacts_put_openflow10(update->ofpacts, update->ofpacts_len, msg);
3570 nfuf = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuf);
3571 nfuf->reason = htons(update->reason);
3572 nfuf->priority = htons(update->priority);
3573 nfuf->idle_timeout = htons(update->idle_timeout);
3574 nfuf->hard_timeout = htons(update->hard_timeout);
3575 nfuf->match_len = htons(match_len);
3576 nfuf->table_id = update->table_id;
3577 nfuf->cookie = update->cookie;
3580 nfuh = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuh);
3581 nfuh->length = htons(msg->size - start_ofs);
3582 nfuh->event = htons(update->event);
3584 ofpmp_postappend(replies, start_ofs);
3588 ofputil_encode_packet_out(const struct ofputil_packet_out *po,
3589 enum ofputil_protocol protocol)
3591 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
3595 size = po->ofpacts_len;
3596 if (po->buffer_id == UINT32_MAX) {
3597 size += po->packet_len;
3600 switch (ofp_version) {
3601 case OFP10_VERSION: {
3602 struct ofp_packet_out *opo;
3605 msg = ofpraw_alloc(OFPRAW_OFPT10_PACKET_OUT, OFP10_VERSION, size);
3606 ofpbuf_put_zeros(msg, sizeof *opo);
3607 actions_ofs = msg->size;
3608 ofpacts_put_openflow10(po->ofpacts, po->ofpacts_len, msg);
3611 opo->buffer_id = htonl(po->buffer_id);
3612 opo->in_port = htons(po->in_port);
3613 opo->actions_len = htons(msg->size - actions_ofs);
3618 case OFP12_VERSION: {
3619 struct ofp11_packet_out *opo;
3622 msg = ofpraw_alloc(OFPRAW_OFPT11_PACKET_OUT, ofp_version, size);
3623 ofpbuf_put_zeros(msg, sizeof *opo);
3624 len = ofpacts_put_openflow11_actions(po->ofpacts, po->ofpacts_len, msg);
3627 opo->buffer_id = htonl(po->buffer_id);
3628 opo->in_port = ofputil_port_to_ofp11(po->in_port);
3629 opo->actions_len = htons(len);
3637 if (po->buffer_id == UINT32_MAX) {
3638 ofpbuf_put(msg, po->packet, po->packet_len);
3641 ofpmsg_update_length(msg);
3646 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
3648 make_echo_request(enum ofp_version ofp_version)
3650 return ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST, ofp_version,
3654 /* Creates and returns an OFPT_ECHO_REPLY message matching the
3655 * OFPT_ECHO_REQUEST message in 'rq'. */
3657 make_echo_reply(const struct ofp_header *rq)
3659 struct ofpbuf rq_buf;
3660 struct ofpbuf *reply;
3662 ofpbuf_use_const(&rq_buf, rq, ntohs(rq->length));
3663 ofpraw_pull_assert(&rq_buf);
3665 reply = ofpraw_alloc_reply(OFPRAW_OFPT_ECHO_REPLY, rq, rq_buf.size);
3666 ofpbuf_put(reply, rq_buf.data, rq_buf.size);
3671 ofputil_encode_barrier_request(enum ofp_version ofp_version)
3675 switch (ofp_version) {
3678 type = OFPRAW_OFPT11_BARRIER_REQUEST;
3682 type = OFPRAW_OFPT10_BARRIER_REQUEST;
3689 return ofpraw_alloc(type, ofp_version, 0);
3693 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
3695 switch (flags & OFPC_FRAG_MASK) {
3696 case OFPC_FRAG_NORMAL: return "normal";
3697 case OFPC_FRAG_DROP: return "drop";
3698 case OFPC_FRAG_REASM: return "reassemble";
3699 case OFPC_FRAG_NX_MATCH: return "nx-match";
3706 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
3708 if (!strcasecmp(s, "normal")) {
3709 *flags = OFPC_FRAG_NORMAL;
3710 } else if (!strcasecmp(s, "drop")) {
3711 *flags = OFPC_FRAG_DROP;
3712 } else if (!strcasecmp(s, "reassemble")) {
3713 *flags = OFPC_FRAG_REASM;
3714 } else if (!strcasecmp(s, "nx-match")) {
3715 *flags = OFPC_FRAG_NX_MATCH;
3722 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
3723 * port number and stores the latter in '*ofp10_port', for the purpose of
3724 * decoding OpenFlow 1.1+ protocol messages. Returns 0 if successful,
3725 * otherwise an OFPERR_* number.
3727 * See the definition of OFP11_MAX for an explanation of the mapping. */
3729 ofputil_port_from_ofp11(ovs_be32 ofp11_port, uint16_t *ofp10_port)
3731 uint32_t ofp11_port_h = ntohl(ofp11_port);
3733 if (ofp11_port_h < OFPP_MAX) {
3734 *ofp10_port = ofp11_port_h;
3736 } else if (ofp11_port_h >= OFPP11_MAX) {
3737 *ofp10_port = ofp11_port_h - OFPP11_OFFSET;
3740 VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
3741 "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
3742 ofp11_port_h, OFPP_MAX - 1,
3743 (uint32_t) OFPP11_MAX, UINT32_MAX);
3744 return OFPERR_OFPBAC_BAD_OUT_PORT;
3748 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
3749 * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
3751 * See the definition of OFP11_MAX for an explanation of the mapping. */
3753 ofputil_port_to_ofp11(uint16_t ofp10_port)
3755 return htonl(ofp10_port < OFPP_MAX
3757 : ofp10_port + OFPP11_OFFSET);
3760 /* Checks that 'port' is a valid output port for the OFPAT10_OUTPUT action, given
3761 * that the switch will never have more than 'max_ports' ports. Returns 0 if
3762 * 'port' is valid, otherwise an OpenFlow return code. */
3764 ofputil_check_output_port(uint16_t port, int max_ports)
3772 case OFPP_CONTROLLER:
3778 if (port < max_ports) {
3781 return OFPERR_OFPBAC_BAD_OUT_PORT;
3785 #define OFPUTIL_NAMED_PORTS \
3786 OFPUTIL_NAMED_PORT(IN_PORT) \
3787 OFPUTIL_NAMED_PORT(TABLE) \
3788 OFPUTIL_NAMED_PORT(NORMAL) \
3789 OFPUTIL_NAMED_PORT(FLOOD) \
3790 OFPUTIL_NAMED_PORT(ALL) \
3791 OFPUTIL_NAMED_PORT(CONTROLLER) \
3792 OFPUTIL_NAMED_PORT(LOCAL) \
3793 OFPUTIL_NAMED_PORT(NONE)
3795 /* Stores the port number represented by 's' into '*portp'. 's' may be an
3796 * integer or, for reserved ports, the standard OpenFlow name for the port
3799 * Returns true if successful, false if 's' is not a valid OpenFlow port number
3800 * or name. The caller should issue an error message in this case, because
3801 * this function usually does not. (This gives the caller an opportunity to
3802 * look up the port name another way, e.g. by contacting the switch and listing
3803 * the names of all its ports).
3805 * This function accepts OpenFlow 1.0 port numbers. It also accepts a subset
3806 * of OpenFlow 1.1+ port numbers, mapping those port numbers into the 16-bit
3807 * range as described in include/openflow/openflow-1.1.h. */
3809 ofputil_port_from_string(const char *s, uint16_t *portp)
3811 unsigned int port32;
3814 if (str_to_uint(s, 10, &port32)) {
3815 if (port32 < OFPP_MAX) {
3818 } else if (port32 < OFPP_FIRST_RESV) {
3819 VLOG_WARN("port %u is a reserved OF1.0 port number that will "
3820 "be translated to %u when talking to an OF1.1 or "
3821 "later controller", port32, port32 + OFPP11_OFFSET);
3824 } else if (port32 <= OFPP_LAST_RESV) {
3828 ofputil_format_port(port32, &s);
3829 VLOG_WARN_ONCE("referring to port %s as %u is deprecated for "
3830 "compatibility with future versions of OpenFlow",
3831 ds_cstr(&s), port32);
3836 } else if (port32 < OFPP11_MAX) {
3837 VLOG_WARN("port %u is outside the supported range 0 through "
3838 "%"PRIx16"or 0x%x through 0x%"PRIx32, port32,
3839 UINT16_MAX, (unsigned int) OFPP11_MAX, UINT32_MAX);
3842 *portp = port32 - OFPP11_OFFSET;
3850 static const struct pair pairs[] = {
3851 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
3853 #undef OFPUTIL_NAMED_PORT
3855 const struct pair *p;
3857 for (p = pairs; p < &pairs[ARRAY_SIZE(pairs)]; p++) {
3858 if (!strcasecmp(s, p->name)) {
3867 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
3868 * Most ports' string representation is just the port number, but for special
3869 * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
3871 ofputil_format_port(uint16_t port, struct ds *s)
3876 #define OFPUTIL_NAMED_PORT(NAME) case OFPP_##NAME: name = #NAME; break;
3878 #undef OFPUTIL_NAMED_PORT
3881 ds_put_format(s, "%"PRIu16, port);
3884 ds_put_cstr(s, name);
3887 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3888 * 'ofp_version', tries to pull the first element from the array. If
3889 * successful, initializes '*pp' with an abstract representation of the
3890 * port and returns 0. If no ports remain to be decoded, returns EOF.
3891 * On an error, returns a positive OFPERR_* value. */
3893 ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *b,
3894 struct ofputil_phy_port *pp)
3896 switch (ofp_version) {
3897 case OFP10_VERSION: {
3898 const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
3899 return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
3902 case OFP12_VERSION: {
3903 const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
3904 return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
3911 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3912 * 'ofp_version', returns the number of elements. */
3913 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *b)
3915 return b->size / ofputil_get_phy_port_size(ofp_version);
3918 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
3919 * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1 if
3920 * 'name' is not the name of any action.
3922 * ofp-util.def lists the mapping from names to action. */
3924 ofputil_action_code_from_name(const char *name)
3926 static const char *names[OFPUTIL_N_ACTIONS] = {
3928 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) NAME,
3929 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
3930 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
3931 #include "ofp-util.def"
3936 for (p = names; p < &names[ARRAY_SIZE(names)]; p++) {
3937 if (*p && !strcasecmp(name, *p)) {
3944 /* Appends an action of the type specified by 'code' to 'buf' and returns the
3945 * action. Initializes the parts of 'action' that identify it as having type
3946 * <ENUM> and length 'sizeof *action' and zeros the rest. For actions that
3947 * have variable length, the length used and cleared is that of struct
3950 ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
3953 case OFPUTIL_ACTION_INVALID:
3956 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
3957 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3958 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3959 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3960 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3961 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3962 #include "ofp-util.def"
3967 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
3969 ofputil_init_##ENUM(struct STRUCT *s) \
3971 memset(s, 0, sizeof *s); \
3972 s->type = htons(ENUM); \
3973 s->len = htons(sizeof *s); \
3977 ofputil_put_##ENUM(struct ofpbuf *buf) \
3979 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
3980 ofputil_init_##ENUM(s); \
3983 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3984 OFPAT10_ACTION(ENUM, STRUCT, NAME)
3985 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3987 ofputil_init_##ENUM(struct STRUCT *s) \
3989 memset(s, 0, sizeof *s); \
3990 s->type = htons(OFPAT10_VENDOR); \
3991 s->len = htons(sizeof *s); \
3992 s->vendor = htonl(NX_VENDOR_ID); \
3993 s->subtype = htons(ENUM); \
3997 ofputil_put_##ENUM(struct ofpbuf *buf) \
3999 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
4000 ofputil_init_##ENUM(s); \
4003 #include "ofp-util.def"
4006 ofputil_normalize_match__(struct match *match, bool may_log)
4009 MAY_NW_ADDR = 1 << 0, /* nw_src, nw_dst */
4010 MAY_TP_ADDR = 1 << 1, /* tp_src, tp_dst */
4011 MAY_NW_PROTO = 1 << 2, /* nw_proto */
4012 MAY_IPVx = 1 << 3, /* tos, frag, ttl */
4013 MAY_ARP_SHA = 1 << 4, /* arp_sha */
4014 MAY_ARP_THA = 1 << 5, /* arp_tha */
4015 MAY_IPV6 = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
4016 MAY_ND_TARGET = 1 << 7 /* nd_target */
4019 struct flow_wildcards wc;
4021 /* Figure out what fields may be matched. */
4022 if (match->flow.dl_type == htons(ETH_TYPE_IP)) {
4023 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
4024 if (match->flow.nw_proto == IPPROTO_TCP ||
4025 match->flow.nw_proto == IPPROTO_UDP ||
4026 match->flow.nw_proto == IPPROTO_ICMP) {
4027 may_match |= MAY_TP_ADDR;
4029 } else if (match->flow.dl_type == htons(ETH_TYPE_IPV6)) {
4030 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
4031 if (match->flow.nw_proto == IPPROTO_TCP ||
4032 match->flow.nw_proto == IPPROTO_UDP) {
4033 may_match |= MAY_TP_ADDR;
4034 } else if (match->flow.nw_proto == IPPROTO_ICMPV6) {
4035 may_match |= MAY_TP_ADDR;
4036 if (match->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
4037 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
4038 } else if (match->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
4039 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
4042 } else if (match->flow.dl_type == htons(ETH_TYPE_ARP) ||
4043 match->flow.dl_type == htons(ETH_TYPE_RARP)) {
4044 may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
4049 /* Clear the fields that may not be matched. */
4051 if (!(may_match & MAY_NW_ADDR)) {
4052 wc.masks.nw_src = wc.masks.nw_dst = htonl(0);
4054 if (!(may_match & MAY_TP_ADDR)) {
4055 wc.masks.tp_src = wc.masks.tp_dst = htons(0);
4057 if (!(may_match & MAY_NW_PROTO)) {
4058 wc.masks.nw_proto = 0;
4060 if (!(may_match & MAY_IPVx)) {
4061 wc.masks.nw_tos = 0;
4062 wc.masks.nw_ttl = 0;
4064 if (!(may_match & MAY_ARP_SHA)) {
4065 memset(wc.masks.arp_sha, 0, ETH_ADDR_LEN);
4067 if (!(may_match & MAY_ARP_THA)) {
4068 memset(wc.masks.arp_tha, 0, ETH_ADDR_LEN);
4070 if (!(may_match & MAY_IPV6)) {
4071 wc.masks.ipv6_src = wc.masks.ipv6_dst = in6addr_any;
4072 wc.masks.ipv6_label = htonl(0);
4074 if (!(may_match & MAY_ND_TARGET)) {
4075 wc.masks.nd_target = in6addr_any;
4078 /* Log any changes. */
4079 if (!flow_wildcards_equal(&wc, &match->wc)) {
4080 bool log = may_log && !VLOG_DROP_INFO(&bad_ofmsg_rl);
4081 char *pre = log ? match_to_string(match, OFP_DEFAULT_PRIORITY) : NULL;
4084 match_zero_wildcarded_fields(match);
4087 char *post = match_to_string(match, OFP_DEFAULT_PRIORITY);
4088 VLOG_INFO("normalization changed ofp_match, details:");
4089 VLOG_INFO(" pre: %s", pre);
4090 VLOG_INFO("post: %s", post);
4097 /* "Normalizes" the wildcards in 'match'. That means:
4099 * 1. If the type of level N is known, then only the valid fields for that
4100 * level may be specified. For example, ARP does not have a TOS field,
4101 * so nw_tos must be wildcarded if 'match' specifies an ARP flow.
4102 * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
4103 * ipv6_dst (and other fields) must be wildcarded if 'match' specifies an
4106 * 2. If the type of level N is not known (or not understood by Open
4107 * vSwitch), then no fields at all for that level may be specified. For
4108 * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
4109 * L4 fields tp_src and tp_dst must be wildcarded if 'match' specifies an
4112 * If this function changes 'match', it logs a rate-limited informational
4115 ofputil_normalize_match(struct match *match)
4117 ofputil_normalize_match__(match, true);
4120 /* Same as ofputil_normalize_match() without the logging. Thus, this function
4121 * is suitable for a program's internal use, whereas ofputil_normalize_match()
4122 * sense for use on flows received from elsewhere (so that a bug in the program
4123 * that sent them can be reported and corrected). */
4125 ofputil_normalize_match_quiet(struct match *match)
4127 ofputil_normalize_match__(match, false);
4130 /* Parses a key or a key-value pair from '*stringp'.
4132 * On success: Stores the key into '*keyp'. Stores the value, if present, into
4133 * '*valuep', otherwise an empty string. Advances '*stringp' past the end of
4134 * the key-value pair, preparing it for another call. '*keyp' and '*valuep'
4135 * are substrings of '*stringp' created by replacing some of its bytes by null
4136 * terminators. Returns true.
4138 * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
4139 * NULL and returns false. */
4141 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
4143 char *pos, *key, *value;
4147 pos += strspn(pos, ", \t\r\n");
4149 *keyp = *valuep = NULL;
4154 key_len = strcspn(pos, ":=(, \t\r\n");
4155 if (key[key_len] == ':' || key[key_len] == '=') {
4156 /* The value can be separated by a colon. */
4159 value = key + key_len + 1;
4160 value_len = strcspn(value, ", \t\r\n");
4161 pos = value + value_len + (value[value_len] != '\0');
4162 value[value_len] = '\0';
4163 } else if (key[key_len] == '(') {
4164 /* The value can be surrounded by balanced parentheses. The outermost
4165 * set of parentheses is removed. */
4169 value = key + key_len + 1;
4170 for (value_len = 0; level > 0; value_len++) {
4171 switch (value[value_len]) {
4185 value[value_len - 1] = '\0';
4186 pos = value + value_len;
4188 /* There might be no value at all. */
4189 value = key + key_len; /* Will become the empty string below. */
4190 pos = key + key_len + (key[key_len] != '\0');
4192 key[key_len] = '\0';
4200 /* Encode a dump ports request for 'port', the encoded message
4201 * will be fore Open Flow version 'ofp_version'. Returns message
4202 * as a struct ofpbuf. Returns encoded message on success, NULL on error */
4204 ofputil_encode_dump_ports_request(enum ofp_version ofp_version, int16_t port)
4206 struct ofpbuf *request;
4208 switch (ofp_version) {
4209 case OFP10_VERSION: {
4210 struct ofp10_port_stats_request *req;
4211 request = ofpraw_alloc(OFPRAW_OFPST10_PORT_REQUEST, ofp_version, 0);
4212 req = ofpbuf_put_zeros(request, sizeof *req);
4213 req->port_no = htons(port);
4217 case OFP12_VERSION: {
4218 struct ofp11_port_stats_request *req;
4219 request = ofpraw_alloc(OFPRAW_OFPST11_PORT_REQUEST, ofp_version, 0);
4220 req = ofpbuf_put_zeros(request, sizeof *req);
4221 req->port_no = ofputil_port_to_ofp11(port);
4232 ofputil_port_stats_to_ofp10(const struct ofputil_port_stats *ops,
4233 struct ofp10_port_stats *ps10)
4235 ps10->port_no = htons(ops->port_no);
4236 memset(ps10->pad, 0, sizeof ps10->pad);
4237 put_32aligned_be64(&ps10->rx_packets, htonll(ops->stats.rx_packets));
4238 put_32aligned_be64(&ps10->tx_packets, htonll(ops->stats.tx_packets));
4239 put_32aligned_be64(&ps10->rx_bytes, htonll(ops->stats.rx_bytes));
4240 put_32aligned_be64(&ps10->tx_bytes, htonll(ops->stats.tx_bytes));
4241 put_32aligned_be64(&ps10->rx_dropped, htonll(ops->stats.rx_dropped));
4242 put_32aligned_be64(&ps10->tx_dropped, htonll(ops->stats.tx_dropped));
4243 put_32aligned_be64(&ps10->rx_errors, htonll(ops->stats.rx_errors));
4244 put_32aligned_be64(&ps10->tx_errors, htonll(ops->stats.tx_errors));
4245 put_32aligned_be64(&ps10->rx_frame_err, htonll(ops->stats.rx_frame_errors));
4246 put_32aligned_be64(&ps10->rx_over_err, htonll(ops->stats.rx_over_errors));
4247 put_32aligned_be64(&ps10->rx_crc_err, htonll(ops->stats.rx_crc_errors));
4248 put_32aligned_be64(&ps10->collisions, htonll(ops->stats.collisions));
4252 ofputil_port_stats_to_ofp11(const struct ofputil_port_stats *ops,
4253 struct ofp11_port_stats *ps11)
4255 ps11->port_no = ofputil_port_to_ofp11(ops->port_no);
4256 memset(ps11->pad, 0, sizeof ps11->pad);
4257 ps11->rx_packets = htonll(ops->stats.rx_packets);
4258 ps11->tx_packets = htonll(ops->stats.tx_packets);
4259 ps11->rx_bytes = htonll(ops->stats.rx_bytes);
4260 ps11->tx_bytes = htonll(ops->stats.tx_bytes);
4261 ps11->rx_dropped = htonll(ops->stats.rx_dropped);
4262 ps11->tx_dropped = htonll(ops->stats.tx_dropped);
4263 ps11->rx_errors = htonll(ops->stats.rx_errors);
4264 ps11->tx_errors = htonll(ops->stats.tx_errors);
4265 ps11->rx_frame_err = htonll(ops->stats.rx_frame_errors);
4266 ps11->rx_over_err = htonll(ops->stats.rx_over_errors);
4267 ps11->rx_crc_err = htonll(ops->stats.rx_crc_errors);
4268 ps11->collisions = htonll(ops->stats.collisions);
4271 /* Encode a ports stat for 'ops' and append it to 'replies'. */
4273 ofputil_append_port_stat(struct list *replies,
4274 const struct ofputil_port_stats *ops)
4276 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
4277 struct ofp_header *oh = msg->data;
4279 switch ((enum ofp_version)oh->version) {
4281 case OFP11_VERSION: {
4282 struct ofp11_port_stats *reply = ofpmp_append(replies, sizeof *reply);
4283 ofputil_port_stats_to_ofp11(ops, reply);
4287 case OFP10_VERSION: {
4288 struct ofp10_port_stats *reply = ofpmp_append(replies, sizeof *reply);
4289 ofputil_port_stats_to_ofp10(ops, reply);
4299 ofputil_port_stats_from_ofp10(struct ofputil_port_stats *ops,
4300 const struct ofp10_port_stats *ps10)
4302 memset(ops, 0, sizeof *ops);
4304 ops->port_no = ntohs(ps10->port_no);
4305 ops->stats.rx_packets = ntohll(get_32aligned_be64(&ps10->rx_packets));
4306 ops->stats.tx_packets = ntohll(get_32aligned_be64(&ps10->tx_packets));
4307 ops->stats.rx_bytes = ntohll(get_32aligned_be64(&ps10->rx_bytes));
4308 ops->stats.tx_bytes = ntohll(get_32aligned_be64(&ps10->tx_bytes));
4309 ops->stats.rx_dropped = ntohll(get_32aligned_be64(&ps10->rx_dropped));
4310 ops->stats.tx_dropped = ntohll(get_32aligned_be64(&ps10->tx_dropped));
4311 ops->stats.rx_errors = ntohll(get_32aligned_be64(&ps10->rx_errors));
4312 ops->stats.tx_errors = ntohll(get_32aligned_be64(&ps10->tx_errors));
4313 ops->stats.rx_frame_errors =
4314 ntohll(get_32aligned_be64(&ps10->rx_frame_err));
4315 ops->stats.rx_over_errors = ntohll(get_32aligned_be64(&ps10->rx_over_err));
4316 ops->stats.rx_crc_errors = ntohll(get_32aligned_be64(&ps10->rx_crc_err));
4317 ops->stats.collisions = ntohll(get_32aligned_be64(&ps10->collisions));
4323 ofputil_port_stats_from_ofp11(struct ofputil_port_stats *ops,
4324 const struct ofp11_port_stats *ps11)
4328 memset(ops, 0, sizeof *ops);
4329 error = ofputil_port_from_ofp11(ps11->port_no, &ops->port_no);
4334 ops->stats.rx_packets = ntohll(ps11->rx_packets);
4335 ops->stats.tx_packets = ntohll(ps11->tx_packets);
4336 ops->stats.rx_bytes = ntohll(ps11->rx_bytes);
4337 ops->stats.tx_bytes = ntohll(ps11->tx_bytes);
4338 ops->stats.rx_dropped = ntohll(ps11->rx_dropped);
4339 ops->stats.tx_dropped = ntohll(ps11->tx_dropped);
4340 ops->stats.rx_errors = ntohll(ps11->rx_errors);
4341 ops->stats.tx_errors = ntohll(ps11->tx_errors);
4342 ops->stats.rx_frame_errors = ntohll(ps11->rx_frame_err);
4343 ops->stats.rx_over_errors = ntohll(ps11->rx_over_err);
4344 ops->stats.rx_crc_errors = ntohll(ps11->rx_crc_err);
4345 ops->stats.collisions = ntohll(ps11->collisions);
4350 /* Returns the number of port stats elements in OFPTYPE_PORT_STATS_REPLY
4353 ofputil_count_port_stats(const struct ofp_header *oh)
4357 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4358 ofpraw_pull_assert(&b);
4360 BUILD_ASSERT(sizeof(struct ofp10_port_stats) ==
4361 sizeof(struct ofp11_port_stats));
4362 return b.size / sizeof(struct ofp10_port_stats);
4365 /* Converts an OFPST_PORT_STATS reply in 'msg' into an abstract
4366 * ofputil_port_stats in 'ps'.
4368 * Multiple OFPST_PORT_STATS replies can be packed into a single OpenFlow
4369 * message. Calling this function multiple times for a single 'msg' iterates
4370 * through the replies. The caller must initially leave 'msg''s layer pointers
4371 * null and not modify them between calls.
4373 * Returns 0 if successful, EOF if no replies were left in this 'msg',
4374 * otherwise a positive errno value. */
4376 ofputil_decode_port_stats(struct ofputil_port_stats *ps, struct ofpbuf *msg)
4382 ? ofpraw_decode(&raw, msg->l2)
4383 : ofpraw_pull(&raw, msg));
4390 } else if (raw == OFPRAW_OFPST11_PORT_REPLY) {
4391 const struct ofp11_port_stats *ps11;
4393 ps11 = ofpbuf_try_pull(msg, sizeof *ps11);
4395 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_PORT reply has %zu leftover "
4396 "bytes at end", msg->size);
4397 return OFPERR_OFPBRC_BAD_LEN;
4399 return ofputil_port_stats_from_ofp11(ps, ps11);
4400 } else if (raw == OFPRAW_OFPST10_PORT_REPLY) {
4401 const struct ofp10_port_stats *ps10;
4403 ps10 = ofpbuf_try_pull(msg, sizeof *ps10);
4405 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_PORT reply has %zu leftover "
4406 "bytes at end", msg->size);
4407 return OFPERR_OFPBRC_BAD_LEN;
4409 return ofputil_port_stats_from_ofp10(ps, ps10);
4416 /* Parse a port status request message into a 16 bit OpenFlow 1.0
4417 * port number and stores the latter in '*ofp10_port'.
4418 * Returns 0 if successful, otherwise an OFPERR_* number. */
4420 ofputil_decode_port_stats_request(const struct ofp_header *request,
4421 uint16_t *ofp10_port)
4423 switch ((enum ofp_version)request->version) {
4425 case OFP11_VERSION: {
4426 const struct ofp11_port_stats_request *psr11 = ofpmsg_body(request);
4427 return ofputil_port_from_ofp11(psr11->port_no, ofp10_port);
4430 case OFP10_VERSION: {
4431 const struct ofp10_port_stats_request *psr10 = ofpmsg_body(request);
4432 *ofp10_port = ntohs(psr10->port_no);
4441 /* Parse a queue status request message into 'oqsr'.
4442 * Returns 0 if successful, otherwise an OFPERR_* number. */
4444 ofputil_decode_queue_stats_request(const struct ofp_header *request,
4445 struct ofputil_queue_stats_request *oqsr)
4447 switch ((enum ofp_version)request->version) {
4449 case OFP11_VERSION: {
4450 const struct ofp11_queue_stats_request *qsr11 = ofpmsg_body(request);
4451 oqsr->queue_id = ntohl(qsr11->queue_id);
4452 return ofputil_port_from_ofp11(qsr11->port_no, &oqsr->port_no);
4455 case OFP10_VERSION: {
4456 const struct ofp10_queue_stats_request *qsr11 = ofpmsg_body(request);
4457 oqsr->queue_id = ntohl(qsr11->queue_id);
4458 oqsr->port_no = ntohs(qsr11->port_no);
4467 /* Encode a queue statsrequest for 'oqsr', the encoded message
4468 * will be fore Open Flow version 'ofp_version'. Returns message
4469 * as a struct ofpbuf. Returns encoded message on success, NULL on error */
4471 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
4472 const struct ofputil_queue_stats_request *oqsr)
4474 struct ofpbuf *request;
4476 switch (ofp_version) {
4478 case OFP12_VERSION: {
4479 struct ofp11_queue_stats_request *req;
4480 request = ofpraw_alloc(OFPRAW_OFPST11_QUEUE_REQUEST, ofp_version, 0);
4481 req = ofpbuf_put_zeros(request, sizeof *req);
4482 req->port_no = ofputil_port_to_ofp11(oqsr->port_no);
4483 req->queue_id = htonl(oqsr->queue_id);
4486 case OFP10_VERSION: {
4487 struct ofp10_queue_stats_request *req;
4488 request = ofpraw_alloc(OFPRAW_OFPST10_QUEUE_REQUEST, ofp_version, 0);
4489 req = ofpbuf_put_zeros(request, sizeof *req);
4490 req->port_no = htons(oqsr->port_no);
4491 req->queue_id = htonl(oqsr->queue_id);
4501 /* Returns the number of queue stats elements in OFPTYPE_QUEUE_STATS_REPLY
4504 ofputil_count_queue_stats(const struct ofp_header *oh)
4508 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4509 ofpraw_pull_assert(&b);
4511 BUILD_ASSERT(sizeof(struct ofp10_queue_stats) ==
4512 sizeof(struct ofp11_queue_stats));
4513 return b.size / sizeof(struct ofp10_queue_stats);
4517 ofputil_queue_stats_from_ofp10(struct ofputil_queue_stats *oqs,
4518 const struct ofp10_queue_stats *qs10)
4520 oqs->port_no = ntohs(qs10->port_no);
4521 oqs->queue_id = ntohl(qs10->queue_id);
4522 oqs->stats.tx_bytes = ntohll(get_32aligned_be64(&qs10->tx_bytes));
4523 oqs->stats.tx_packets = ntohll(get_32aligned_be64(&qs10->tx_packets));
4524 oqs->stats.tx_errors = ntohll(get_32aligned_be64(&qs10->tx_errors));
4530 ofputil_queue_stats_from_ofp11(struct ofputil_queue_stats *oqs,
4531 const struct ofp11_queue_stats *qs11)
4535 error = ofputil_port_from_ofp11(qs11->port_no, &oqs->port_no);
4540 oqs->queue_id = ntohl(qs11->queue_id);
4541 oqs->stats.tx_bytes = ntohll(qs11->tx_bytes);
4542 oqs->stats.tx_packets = ntohll(qs11->tx_packets);
4543 oqs->stats.tx_errors = ntohll(qs11->tx_errors);
4548 /* Converts an OFPST_QUEUE_STATS reply in 'msg' into an abstract
4549 * ofputil_queue_stats in 'qs'.
4551 * Multiple OFPST_QUEUE_STATS replies can be packed into a single OpenFlow
4552 * message. Calling this function multiple times for a single 'msg' iterates
4553 * through the replies. The caller must initially leave 'msg''s layer pointers
4554 * null and not modify them between calls.
4556 * Returns 0 if successful, EOF if no replies were left in this 'msg',
4557 * otherwise a positive errno value. */
4559 ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg)
4565 ? ofpraw_decode(&raw, msg->l2)
4566 : ofpraw_pull(&raw, msg));
4573 } else if (raw == OFPRAW_OFPST11_QUEUE_REPLY) {
4574 const struct ofp11_queue_stats *qs11;
4576 qs11 = ofpbuf_try_pull(msg, sizeof *qs11);
4578 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_QUEUE reply has %zu leftover "
4579 "bytes at end", msg->size);
4580 return OFPERR_OFPBRC_BAD_LEN;
4582 return ofputil_queue_stats_from_ofp11(qs, qs11);
4583 } else if (raw == OFPRAW_OFPST10_QUEUE_REPLY) {
4584 const struct ofp10_queue_stats *qs10;
4586 qs10 = ofpbuf_try_pull(msg, sizeof *qs10);
4588 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_QUEUE reply has %zu leftover "
4589 "bytes at end", msg->size);
4590 return OFPERR_OFPBRC_BAD_LEN;
4592 return ofputil_queue_stats_from_ofp10(qs, qs10);
4599 ofputil_queue_stats_to_ofp10(const struct ofputil_queue_stats *oqs,
4600 struct ofp10_queue_stats *qs10)
4602 qs10->port_no = htons(oqs->port_no);
4603 memset(qs10->pad, 0, sizeof qs10->pad);
4604 qs10->queue_id = htonl(oqs->queue_id);
4605 put_32aligned_be64(&qs10->tx_bytes, htonll(oqs->stats.tx_bytes));
4606 put_32aligned_be64(&qs10->tx_packets, htonll(oqs->stats.tx_packets));
4607 put_32aligned_be64(&qs10->tx_errors, htonll(oqs->stats.tx_errors));
4611 ofputil_queue_stats_to_ofp11(const struct ofputil_queue_stats *oqs,
4612 struct ofp11_queue_stats *qs11)
4614 qs11->port_no = ofputil_port_to_ofp11(oqs->port_no);
4615 qs11->queue_id = htonl(oqs->queue_id);
4616 qs11->tx_bytes = htonll(oqs->stats.tx_bytes);
4617 qs11->tx_packets = htonll(oqs->stats.tx_packets);
4618 qs11->tx_errors = htonll(oqs->stats.tx_errors);
4621 /* Encode a queue stat for 'oqs' and append it to 'replies'. */
4623 ofputil_append_queue_stat(struct list *replies,
4624 const struct ofputil_queue_stats *oqs)
4626 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
4627 struct ofp_header *oh = msg->data;
4629 switch ((enum ofp_version)oh->version) {
4631 case OFP11_VERSION: {
4632 struct ofp11_queue_stats *reply = ofpmp_append(replies, sizeof *reply);;
4633 ofputil_queue_stats_to_ofp11(oqs, reply);
4637 case OFP10_VERSION: {
4638 struct ofp10_queue_stats *reply = ofpmp_append(replies, sizeof *reply);;
4639 ofputil_queue_stats_to_ofp10(oqs, reply);