2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 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>
27 #include "byte-order.h"
28 #include "classifier.h"
29 #include "dynamic-string.h"
31 #include "meta-flow.h"
32 #include "multipath.h"
35 #include "ofp-actions.h"
36 #include "ofp-errors.h"
42 #include "unaligned.h"
43 #include "type-props.h"
46 VLOG_DEFINE_THIS_MODULE(ofp_util);
48 /* Rate limit for OpenFlow message parse errors. These always indicate a bug
49 * in the peer and so there's not much point in showing a lot of them. */
50 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
52 /* Given the wildcard bit count in the least-significant 6 of 'wcbits', returns
53 * an IP netmask with a 1 in each bit that must match and a 0 in each bit that
56 * The bits in 'wcbits' are in the format used in enum ofp_flow_wildcards: 0
57 * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
58 * ..., 32 and higher wildcard the entire field. This is the *opposite* of the
59 * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
62 ofputil_wcbits_to_netmask(int wcbits)
65 return wcbits < 32 ? htonl(~((1u << wcbits) - 1)) : 0;
68 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
69 * that it wildcards, that is, the number of 0-bits in 'netmask', a number
70 * between 0 and 32 inclusive.
72 * If 'netmask' is not a CIDR netmask (see ip_is_cidr()), the return value will
73 * still be in the valid range but isn't otherwise meaningful. */
75 ofputil_netmask_to_wcbits(ovs_be32 netmask)
77 return 32 - ip_count_cidr_bits(netmask);
80 /* Converts the OpenFlow 1.0 wildcards in 'ofpfw' (OFPFW10_*) into a
81 * flow_wildcards in 'wc' for use in struct match. It is the caller's
82 * responsibility to handle the special case where the flow match's dl_vlan is
83 * set to OFP_VLAN_NONE. */
85 ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *wc)
87 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 20);
89 /* Initialize most of wc. */
90 flow_wildcards_init_catchall(wc);
92 if (!(ofpfw & OFPFW10_IN_PORT)) {
93 wc->masks.in_port = UINT16_MAX;
96 if (!(ofpfw & OFPFW10_NW_TOS)) {
97 wc->masks.nw_tos |= IP_DSCP_MASK;
100 if (!(ofpfw & OFPFW10_NW_PROTO)) {
101 wc->masks.nw_proto = UINT8_MAX;
103 wc->masks.nw_src = ofputil_wcbits_to_netmask(ofpfw
104 >> OFPFW10_NW_SRC_SHIFT);
105 wc->masks.nw_dst = ofputil_wcbits_to_netmask(ofpfw
106 >> OFPFW10_NW_DST_SHIFT);
108 if (!(ofpfw & OFPFW10_TP_SRC)) {
109 wc->masks.tp_src = htons(UINT16_MAX);
111 if (!(ofpfw & OFPFW10_TP_DST)) {
112 wc->masks.tp_dst = htons(UINT16_MAX);
115 if (!(ofpfw & OFPFW10_DL_SRC)) {
116 memset(wc->masks.dl_src, 0xff, ETH_ADDR_LEN);
118 if (!(ofpfw & OFPFW10_DL_DST)) {
119 memset(wc->masks.dl_dst, 0xff, ETH_ADDR_LEN);
121 if (!(ofpfw & OFPFW10_DL_TYPE)) {
122 wc->masks.dl_type = htons(UINT16_MAX);
126 if (!(ofpfw & OFPFW10_DL_VLAN_PCP)) {
127 wc->masks.vlan_tci |= htons(VLAN_PCP_MASK | VLAN_CFI);
129 if (!(ofpfw & OFPFW10_DL_VLAN)) {
130 wc->masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
134 /* Converts the ofp10_match in 'ofmatch' into a struct match in 'match'. */
136 ofputil_match_from_ofp10_match(const struct ofp10_match *ofmatch,
139 uint32_t ofpfw = ntohl(ofmatch->wildcards) & OFPFW10_ALL;
141 /* Initialize match->wc. */
142 memset(&match->flow, 0, sizeof match->flow);
143 ofputil_wildcard_from_ofpfw10(ofpfw, &match->wc);
145 /* Initialize most of match->flow. */
146 match->flow.nw_src = ofmatch->nw_src;
147 match->flow.nw_dst = ofmatch->nw_dst;
148 match->flow.in_port = ntohs(ofmatch->in_port);
149 match->flow.dl_type = ofputil_dl_type_from_openflow(ofmatch->dl_type);
150 match->flow.tp_src = ofmatch->tp_src;
151 match->flow.tp_dst = ofmatch->tp_dst;
152 memcpy(match->flow.dl_src, ofmatch->dl_src, ETH_ADDR_LEN);
153 memcpy(match->flow.dl_dst, ofmatch->dl_dst, ETH_ADDR_LEN);
154 match->flow.nw_tos = ofmatch->nw_tos & IP_DSCP_MASK;
155 match->flow.nw_proto = ofmatch->nw_proto;
157 /* Translate VLANs. */
158 if (!(ofpfw & OFPFW10_DL_VLAN) &&
159 ofmatch->dl_vlan == htons(OFP10_VLAN_NONE)) {
160 /* Match only packets without 802.1Q header.
162 * When OFPFW10_DL_VLAN_PCP is wildcarded, this is obviously correct.
164 * If OFPFW10_DL_VLAN_PCP is matched, the flow match is contradictory,
165 * because we can't have a specific PCP without an 802.1Q header.
166 * However, older versions of OVS treated this as matching packets
167 * withut an 802.1Q header, so we do here too. */
168 match->flow.vlan_tci = htons(0);
169 match->wc.masks.vlan_tci = htons(0xffff);
171 ovs_be16 vid, pcp, tci;
173 vid = ofmatch->dl_vlan & htons(VLAN_VID_MASK);
174 pcp = htons((ofmatch->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK);
175 tci = vid | pcp | htons(VLAN_CFI);
176 match->flow.vlan_tci = tci & match->wc.masks.vlan_tci;
180 match_zero_wildcarded_fields(match);
183 /* Convert 'match' into the OpenFlow 1.0 match structure 'ofmatch'. */
185 ofputil_match_to_ofp10_match(const struct match *match,
186 struct ofp10_match *ofmatch)
188 const struct flow_wildcards *wc = &match->wc;
191 /* Figure out most OpenFlow wildcards. */
193 if (!wc->masks.in_port) {
194 ofpfw |= OFPFW10_IN_PORT;
196 if (!wc->masks.dl_type) {
197 ofpfw |= OFPFW10_DL_TYPE;
199 if (!wc->masks.nw_proto) {
200 ofpfw |= OFPFW10_NW_PROTO;
202 ofpfw |= (ofputil_netmask_to_wcbits(wc->masks.nw_src)
203 << OFPFW10_NW_SRC_SHIFT);
204 ofpfw |= (ofputil_netmask_to_wcbits(wc->masks.nw_dst)
205 << OFPFW10_NW_DST_SHIFT);
206 if (!(wc->masks.nw_tos & IP_DSCP_MASK)) {
207 ofpfw |= OFPFW10_NW_TOS;
209 if (!wc->masks.tp_src) {
210 ofpfw |= OFPFW10_TP_SRC;
212 if (!wc->masks.tp_dst) {
213 ofpfw |= OFPFW10_TP_DST;
215 if (eth_addr_is_zero(wc->masks.dl_src)) {
216 ofpfw |= OFPFW10_DL_SRC;
218 if (eth_addr_is_zero(wc->masks.dl_dst)) {
219 ofpfw |= OFPFW10_DL_DST;
222 /* Translate VLANs. */
223 ofmatch->dl_vlan = htons(0);
224 ofmatch->dl_vlan_pcp = 0;
225 if (match->wc.masks.vlan_tci == htons(0)) {
226 ofpfw |= OFPFW10_DL_VLAN | OFPFW10_DL_VLAN_PCP;
227 } else if (match->wc.masks.vlan_tci & htons(VLAN_CFI)
228 && !(match->flow.vlan_tci & htons(VLAN_CFI))) {
229 ofmatch->dl_vlan = htons(OFP10_VLAN_NONE);
230 ofpfw |= OFPFW10_DL_VLAN_PCP;
232 if (!(match->wc.masks.vlan_tci & htons(VLAN_VID_MASK))) {
233 ofpfw |= OFPFW10_DL_VLAN;
235 ofmatch->dl_vlan = htons(vlan_tci_to_vid(match->flow.vlan_tci));
238 if (!(match->wc.masks.vlan_tci & htons(VLAN_PCP_MASK))) {
239 ofpfw |= OFPFW10_DL_VLAN_PCP;
241 ofmatch->dl_vlan_pcp = vlan_tci_to_pcp(match->flow.vlan_tci);
245 /* Compose most of the match structure. */
246 ofmatch->wildcards = htonl(ofpfw);
247 ofmatch->in_port = htons(match->flow.in_port);
248 memcpy(ofmatch->dl_src, match->flow.dl_src, ETH_ADDR_LEN);
249 memcpy(ofmatch->dl_dst, match->flow.dl_dst, ETH_ADDR_LEN);
250 ofmatch->dl_type = ofputil_dl_type_to_openflow(match->flow.dl_type);
251 ofmatch->nw_src = match->flow.nw_src;
252 ofmatch->nw_dst = match->flow.nw_dst;
253 ofmatch->nw_tos = match->flow.nw_tos & IP_DSCP_MASK;
254 ofmatch->nw_proto = match->flow.nw_proto;
255 ofmatch->tp_src = match->flow.tp_src;
256 ofmatch->tp_dst = match->flow.tp_dst;
257 memset(ofmatch->pad1, '\0', sizeof ofmatch->pad1);
258 memset(ofmatch->pad2, '\0', sizeof ofmatch->pad2);
262 ofputil_pull_ofp11_match(struct ofpbuf *buf, struct match *match,
263 uint16_t *padded_match_len)
265 struct ofp11_match_header *omh = buf->data;
268 if (buf->size < sizeof *omh) {
269 return OFPERR_OFPBMC_BAD_LEN;
272 match_len = ntohs(omh->length);
274 switch (ntohs(omh->type)) {
275 case OFPMT_STANDARD: {
276 struct ofp11_match *om;
278 if (match_len != sizeof *om || buf->size < sizeof *om) {
279 return OFPERR_OFPBMC_BAD_LEN;
281 om = ofpbuf_pull(buf, sizeof *om);
282 if (padded_match_len) {
283 *padded_match_len = match_len;
285 return ofputil_match_from_ofp11_match(om, match);
289 if (padded_match_len) {
290 *padded_match_len = ROUND_UP(match_len, 8);
292 return oxm_pull_match(buf, match);
295 return OFPERR_OFPBMC_BAD_TYPE;
299 /* Converts the ofp11_match in 'match' into a struct match in 'match. Returns
300 * 0 if successful, otherwise an OFPERR_* value. */
302 ofputil_match_from_ofp11_match(const struct ofp11_match *ofmatch,
305 uint16_t wc = ntohl(ofmatch->wildcards);
306 uint8_t dl_src_mask[ETH_ADDR_LEN];
307 uint8_t dl_dst_mask[ETH_ADDR_LEN];
308 bool ipv4, arp, rarp;
311 match_init_catchall(match);
313 if (!(wc & OFPFW11_IN_PORT)) {
317 error = ofputil_port_from_ofp11(ofmatch->in_port, &ofp_port);
319 return OFPERR_OFPBMC_BAD_VALUE;
321 match_set_in_port(match, ofp_port);
324 for (i = 0; i < ETH_ADDR_LEN; i++) {
325 dl_src_mask[i] = ~ofmatch->dl_src_mask[i];
327 match_set_dl_src_masked(match, ofmatch->dl_src, dl_src_mask);
329 for (i = 0; i < ETH_ADDR_LEN; i++) {
330 dl_dst_mask[i] = ~ofmatch->dl_dst_mask[i];
332 match_set_dl_dst_masked(match, ofmatch->dl_dst, dl_dst_mask);
334 if (!(wc & OFPFW11_DL_VLAN)) {
335 if (ofmatch->dl_vlan == htons(OFPVID11_NONE)) {
336 /* Match only packets without a VLAN tag. */
337 match->flow.vlan_tci = htons(0);
338 match->wc.masks.vlan_tci = htons(UINT16_MAX);
340 if (ofmatch->dl_vlan == htons(OFPVID11_ANY)) {
341 /* Match any packet with a VLAN tag regardless of VID. */
342 match->flow.vlan_tci = htons(VLAN_CFI);
343 match->wc.masks.vlan_tci = htons(VLAN_CFI);
344 } else if (ntohs(ofmatch->dl_vlan) < 4096) {
345 /* Match only packets with the specified VLAN VID. */
346 match->flow.vlan_tci = htons(VLAN_CFI) | ofmatch->dl_vlan;
347 match->wc.masks.vlan_tci = htons(VLAN_CFI | VLAN_VID_MASK);
350 return OFPERR_OFPBMC_BAD_VALUE;
353 if (!(wc & OFPFW11_DL_VLAN_PCP)) {
354 if (ofmatch->dl_vlan_pcp <= 7) {
355 match->flow.vlan_tci |= htons(ofmatch->dl_vlan_pcp
357 match->wc.masks.vlan_tci |= htons(VLAN_PCP_MASK);
360 return OFPERR_OFPBMC_BAD_VALUE;
366 if (!(wc & OFPFW11_DL_TYPE)) {
367 match_set_dl_type(match,
368 ofputil_dl_type_from_openflow(ofmatch->dl_type));
371 ipv4 = match->flow.dl_type == htons(ETH_TYPE_IP);
372 arp = match->flow.dl_type == htons(ETH_TYPE_ARP);
373 rarp = match->flow.dl_type == htons(ETH_TYPE_RARP);
375 if (ipv4 && !(wc & OFPFW11_NW_TOS)) {
376 if (ofmatch->nw_tos & ~IP_DSCP_MASK) {
378 return OFPERR_OFPBMC_BAD_VALUE;
381 match_set_nw_dscp(match, ofmatch->nw_tos);
384 if (ipv4 || arp || rarp) {
385 if (!(wc & OFPFW11_NW_PROTO)) {
386 match_set_nw_proto(match, ofmatch->nw_proto);
388 match_set_nw_src_masked(match, ofmatch->nw_src, ~ofmatch->nw_src_mask);
389 match_set_nw_dst_masked(match, ofmatch->nw_dst, ~ofmatch->nw_dst_mask);
392 #define OFPFW11_TP_ALL (OFPFW11_TP_SRC | OFPFW11_TP_DST)
393 if (ipv4 && (wc & OFPFW11_TP_ALL) != OFPFW11_TP_ALL) {
394 switch (match->flow.nw_proto) {
396 /* "A.2.3 Flow Match Structures" in OF1.1 says:
398 * The tp_src and tp_dst fields will be ignored unless the
399 * network protocol specified is as TCP, UDP or SCTP.
401 * but I'm pretty sure we should support ICMP too, otherwise
402 * that's a regression from OF1.0. */
403 if (!(wc & OFPFW11_TP_SRC)) {
404 uint16_t icmp_type = ntohs(ofmatch->tp_src);
405 if (icmp_type < 0x100) {
406 match_set_icmp_type(match, icmp_type);
408 return OFPERR_OFPBMC_BAD_FIELD;
411 if (!(wc & OFPFW11_TP_DST)) {
412 uint16_t icmp_code = ntohs(ofmatch->tp_dst);
413 if (icmp_code < 0x100) {
414 match_set_icmp_code(match, icmp_code);
416 return OFPERR_OFPBMC_BAD_FIELD;
423 if (!(wc & (OFPFW11_TP_SRC))) {
424 match_set_tp_src(match, ofmatch->tp_src);
426 if (!(wc & (OFPFW11_TP_DST))) {
427 match_set_tp_dst(match, ofmatch->tp_dst);
432 /* We don't support SCTP and it seems that we should tell the
433 * controller, since OF1.1 implementations are supposed to. */
434 return OFPERR_OFPBMC_BAD_FIELD;
437 /* OF1.1 says explicitly to ignore this. */
442 if (eth_type_mpls(match->flow.dl_type)) {
443 enum { OFPFW11_MPLS_ALL = OFPFW11_MPLS_LABEL | OFPFW11_MPLS_TC };
445 if ((wc & OFPFW11_MPLS_ALL) != OFPFW11_MPLS_ALL) {
446 /* MPLS not supported. */
447 return OFPERR_OFPBMC_BAD_TAG;
451 match_set_metadata_masked(match, ofmatch->metadata,
452 ~ofmatch->metadata_mask);
457 /* Convert 'match' into the OpenFlow 1.1 match structure 'ofmatch'. */
459 ofputil_match_to_ofp11_match(const struct match *match,
460 struct ofp11_match *ofmatch)
465 memset(ofmatch, 0, sizeof *ofmatch);
466 ofmatch->omh.type = htons(OFPMT_STANDARD);
467 ofmatch->omh.length = htons(OFPMT11_STANDARD_LENGTH);
469 if (!match->wc.masks.in_port) {
470 wc |= OFPFW11_IN_PORT;
472 ofmatch->in_port = ofputil_port_to_ofp11(match->flow.in_port);
475 memcpy(ofmatch->dl_src, match->flow.dl_src, ETH_ADDR_LEN);
476 for (i = 0; i < ETH_ADDR_LEN; i++) {
477 ofmatch->dl_src_mask[i] = ~match->wc.masks.dl_src[i];
480 memcpy(ofmatch->dl_dst, match->flow.dl_dst, ETH_ADDR_LEN);
481 for (i = 0; i < ETH_ADDR_LEN; i++) {
482 ofmatch->dl_dst_mask[i] = ~match->wc.masks.dl_dst[i];
485 if (match->wc.masks.vlan_tci == htons(0)) {
486 wc |= OFPFW11_DL_VLAN | OFPFW11_DL_VLAN_PCP;
487 } else if (match->wc.masks.vlan_tci & htons(VLAN_CFI)
488 && !(match->flow.vlan_tci & htons(VLAN_CFI))) {
489 ofmatch->dl_vlan = htons(OFPVID11_NONE);
490 wc |= OFPFW11_DL_VLAN_PCP;
492 if (!(match->wc.masks.vlan_tci & htons(VLAN_VID_MASK))) {
493 ofmatch->dl_vlan = htons(OFPVID11_ANY);
495 ofmatch->dl_vlan = htons(vlan_tci_to_vid(match->flow.vlan_tci));
498 if (!(match->wc.masks.vlan_tci & htons(VLAN_PCP_MASK))) {
499 wc |= OFPFW11_DL_VLAN_PCP;
501 ofmatch->dl_vlan_pcp = vlan_tci_to_pcp(match->flow.vlan_tci);
505 if (!match->wc.masks.dl_type) {
506 wc |= OFPFW11_DL_TYPE;
508 ofmatch->dl_type = ofputil_dl_type_to_openflow(match->flow.dl_type);
511 if (!(match->wc.masks.nw_tos & IP_DSCP_MASK)) {
512 wc |= OFPFW11_NW_TOS;
514 ofmatch->nw_tos = match->flow.nw_tos & IP_DSCP_MASK;
517 if (!match->wc.masks.nw_proto) {
518 wc |= OFPFW11_NW_PROTO;
520 ofmatch->nw_proto = match->flow.nw_proto;
523 ofmatch->nw_src = match->flow.nw_src;
524 ofmatch->nw_src_mask = ~match->wc.masks.nw_src;
525 ofmatch->nw_dst = match->flow.nw_dst;
526 ofmatch->nw_dst_mask = ~match->wc.masks.nw_dst;
528 if (!match->wc.masks.tp_src) {
529 wc |= OFPFW11_TP_SRC;
531 ofmatch->tp_src = match->flow.tp_src;
534 if (!match->wc.masks.tp_dst) {
535 wc |= OFPFW11_TP_DST;
537 ofmatch->tp_dst = match->flow.tp_dst;
540 /* MPLS not supported. */
541 wc |= OFPFW11_MPLS_LABEL;
542 wc |= OFPFW11_MPLS_TC;
544 ofmatch->metadata = match->flow.metadata;
545 ofmatch->metadata_mask = ~match->wc.masks.metadata;
547 ofmatch->wildcards = htonl(wc);
550 /* Given a 'dl_type' value in the format used in struct flow, returns the
551 * corresponding 'dl_type' value for use in an ofp10_match or ofp11_match
554 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type)
556 return (flow_dl_type == htons(FLOW_DL_TYPE_NONE)
557 ? htons(OFP_DL_TYPE_NOT_ETH_TYPE)
561 /* Given a 'dl_type' value in the format used in an ofp10_match or ofp11_match
562 * structure, returns the corresponding 'dl_type' value for use in struct
565 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type)
567 return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
568 ? htons(FLOW_DL_TYPE_NONE)
574 struct proto_abbrev {
575 enum ofputil_protocol protocol;
579 /* Most users really don't care about some of the differences between
580 * protocols. These abbreviations help with that. */
581 static const struct proto_abbrev proto_abbrevs[] = {
582 { OFPUTIL_P_ANY, "any" },
583 { OFPUTIL_P_OF10_STD_ANY, "OpenFlow10" },
584 { OFPUTIL_P_OF10_NXM_ANY, "NXM" },
585 { OFPUTIL_P_ANY_OXM, "OXM" },
587 #define N_PROTO_ABBREVS ARRAY_SIZE(proto_abbrevs)
589 enum ofputil_protocol ofputil_flow_dump_protocols[] = {
595 size_t ofputil_n_flow_dump_protocols = ARRAY_SIZE(ofputil_flow_dump_protocols);
597 /* Returns the set of ofputil_protocols that are supported with the given
598 * OpenFlow 'version'. 'version' should normally be an 8-bit OpenFlow version
599 * identifier (e.g. 0x01 for OpenFlow 1.0, 0x02 for OpenFlow 1.1). Returns 0
600 * if 'version' is not supported or outside the valid range. */
601 enum ofputil_protocol
602 ofputil_protocols_from_ofp_version(enum ofp_version version)
606 return OFPUTIL_P_OF10_STD_ANY | OFPUTIL_P_OF10_NXM_ANY;
608 return OFPUTIL_P_OF12_OXM;
610 return OFPUTIL_P_OF13_OXM;
617 /* Returns the ofputil_protocol that is initially in effect on an OpenFlow
618 * connection that has negotiated the given 'version'. 'version' should
619 * normally be an 8-bit OpenFlow version identifier (e.g. 0x01 for OpenFlow
620 * 1.0, 0x02 for OpenFlow 1.1). Returns 0 if 'version' is not supported or
621 * outside the valid range. */
622 enum ofputil_protocol
623 ofputil_protocol_from_ofp_version(enum ofp_version version)
625 return rightmost_1bit(ofputil_protocols_from_ofp_version(version));
628 /* Returns the OpenFlow protocol version number (e.g. OFP10_VERSION,
629 * etc.) that corresponds to 'protocol'. */
631 ofputil_protocol_to_ofp_version(enum ofputil_protocol protocol)
634 case OFPUTIL_P_OF10_STD:
635 case OFPUTIL_P_OF10_STD_TID:
636 case OFPUTIL_P_OF10_NXM:
637 case OFPUTIL_P_OF10_NXM_TID:
638 return OFP10_VERSION;
639 case OFPUTIL_P_OF12_OXM:
640 return OFP12_VERSION;
641 case OFPUTIL_P_OF13_OXM:
642 return OFP13_VERSION;
648 /* Returns a bitmap of OpenFlow versions that are supported by at
649 * least one of the 'protocols'. */
651 ofputil_protocols_to_version_bitmap(enum ofputil_protocol protocols)
655 for (; protocols; protocols = zero_rightmost_1bit(protocols)) {
656 enum ofputil_protocol protocol = rightmost_1bit(protocols);
658 bitmap |= 1u << ofputil_protocol_to_ofp_version(protocol);
664 /* Returns the set of protocols that are supported on top of the
665 * OpenFlow versions included in 'bitmap'. */
666 enum ofputil_protocol
667 ofputil_protocols_from_version_bitmap(uint32_t bitmap)
669 enum ofputil_protocol protocols = 0;
671 for (; bitmap; bitmap = zero_rightmost_1bit(bitmap)) {
672 enum ofp_version version = rightmost_1bit_idx(bitmap);
674 protocols |= ofputil_protocols_from_ofp_version(version);
680 /* Returns true if 'protocol' is a single OFPUTIL_P_* value, false
683 ofputil_protocol_is_valid(enum ofputil_protocol protocol)
685 return protocol & OFPUTIL_P_ANY && is_pow2(protocol);
688 /* Returns the equivalent of 'protocol' with the Nicira flow_mod_table_id
689 * extension turned on or off if 'enable' is true or false, respectively.
691 * This extension is only useful for protocols whose "standard" version does
692 * not allow specific tables to be modified. In particular, this is true of
693 * OpenFlow 1.0. In later versions of OpenFlow, a flow_mod request always
694 * specifies a table ID and so there is no need for such an extension. When
695 * 'protocol' is such a protocol that doesn't need a flow_mod_table_id
696 * extension, this function just returns its 'protocol' argument unchanged
697 * regardless of the value of 'enable'. */
698 enum ofputil_protocol
699 ofputil_protocol_set_tid(enum ofputil_protocol protocol, bool enable)
702 case OFPUTIL_P_OF10_STD:
703 case OFPUTIL_P_OF10_STD_TID:
704 return enable ? OFPUTIL_P_OF10_STD_TID : OFPUTIL_P_OF10_STD;
706 case OFPUTIL_P_OF10_NXM:
707 case OFPUTIL_P_OF10_NXM_TID:
708 return enable ? OFPUTIL_P_OF10_NXM_TID : OFPUTIL_P_OF10_NXM;
710 case OFPUTIL_P_OF12_OXM:
711 return OFPUTIL_P_OF12_OXM;
713 case OFPUTIL_P_OF13_OXM:
714 return OFPUTIL_P_OF13_OXM;
721 /* Returns the "base" version of 'protocol'. That is, if 'protocol' includes
722 * some extension to a standard protocol version, the return value is the
723 * standard version of that protocol without any extension. If 'protocol' is a
724 * standard protocol version, returns 'protocol' unchanged. */
725 enum ofputil_protocol
726 ofputil_protocol_to_base(enum ofputil_protocol protocol)
728 return ofputil_protocol_set_tid(protocol, false);
731 /* Returns 'new_base' with any extensions taken from 'cur'. */
732 enum ofputil_protocol
733 ofputil_protocol_set_base(enum ofputil_protocol cur,
734 enum ofputil_protocol new_base)
736 bool tid = (cur & OFPUTIL_P_TID) != 0;
739 case OFPUTIL_P_OF10_STD:
740 case OFPUTIL_P_OF10_STD_TID:
741 return ofputil_protocol_set_tid(OFPUTIL_P_OF10_STD, tid);
743 case OFPUTIL_P_OF10_NXM:
744 case OFPUTIL_P_OF10_NXM_TID:
745 return ofputil_protocol_set_tid(OFPUTIL_P_OF10_NXM, tid);
747 case OFPUTIL_P_OF12_OXM:
748 return ofputil_protocol_set_tid(OFPUTIL_P_OF12_OXM, tid);
750 case OFPUTIL_P_OF13_OXM:
751 return ofputil_protocol_set_tid(OFPUTIL_P_OF13_OXM, tid);
758 /* Returns a string form of 'protocol', if a simple form exists (that is, if
759 * 'protocol' is either a single protocol or it is a combination of protocols
760 * that have a single abbreviation). Otherwise, returns NULL. */
762 ofputil_protocol_to_string(enum ofputil_protocol protocol)
764 const struct proto_abbrev *p;
766 /* Use a "switch" statement for single-bit names so that we get a compiler
767 * warning if we forget any. */
769 case OFPUTIL_P_OF10_NXM:
770 return "NXM-table_id";
772 case OFPUTIL_P_OF10_NXM_TID:
773 return "NXM+table_id";
775 case OFPUTIL_P_OF10_STD:
776 return "OpenFlow10-table_id";
778 case OFPUTIL_P_OF10_STD_TID:
779 return "OpenFlow10+table_id";
781 case OFPUTIL_P_OF12_OXM:
782 return "OXM-OpenFlow12";
784 case OFPUTIL_P_OF13_OXM:
785 return "OXM-OpenFlow13";
788 /* Check abbreviations. */
789 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
790 if (protocol == p->protocol) {
798 /* Returns a string that represents 'protocols'. The return value might be a
799 * comma-separated list if 'protocols' doesn't have a simple name. The return
800 * value is "none" if 'protocols' is 0.
802 * The caller must free the returned string (with free()). */
804 ofputil_protocols_to_string(enum ofputil_protocol protocols)
808 ovs_assert(!(protocols & ~OFPUTIL_P_ANY));
809 if (protocols == 0) {
810 return xstrdup("none");
815 const struct proto_abbrev *p;
819 ds_put_char(&s, ',');
822 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
823 if ((protocols & p->protocol) == p->protocol) {
824 ds_put_cstr(&s, p->name);
825 protocols &= ~p->protocol;
830 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
831 enum ofputil_protocol bit = 1u << i;
833 if (protocols & bit) {
834 ds_put_cstr(&s, ofputil_protocol_to_string(bit));
843 return ds_steal_cstr(&s);
846 static enum ofputil_protocol
847 ofputil_protocol_from_string__(const char *s, size_t n)
849 const struct proto_abbrev *p;
852 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
853 enum ofputil_protocol bit = 1u << i;
854 const char *name = ofputil_protocol_to_string(bit);
856 if (name && n == strlen(name) && !strncasecmp(s, name, n)) {
861 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
862 if (n == strlen(p->name) && !strncasecmp(s, p->name, n)) {
870 /* Returns the nonempty set of protocols represented by 's', which can be a
871 * single protocol name or abbreviation or a comma-separated list of them.
873 * Aborts the program with an error message if 's' is invalid. */
874 enum ofputil_protocol
875 ofputil_protocols_from_string(const char *s)
877 const char *orig_s = s;
878 enum ofputil_protocol protocols;
882 enum ofputil_protocol p;
891 p = ofputil_protocol_from_string__(s, n);
893 ovs_fatal(0, "%.*s: unknown flow protocol", (int) n, s);
901 ovs_fatal(0, "%s: no flow protocol specified", orig_s);
907 ofputil_version_from_string(const char *s)
909 if (!strcasecmp(s, "OpenFlow10")) {
910 return OFP10_VERSION;
912 if (!strcasecmp(s, "OpenFlow11")) {
913 return OFP11_VERSION;
915 if (!strcasecmp(s, "OpenFlow12")) {
916 return OFP12_VERSION;
918 if (!strcasecmp(s, "OpenFlow13")) {
919 return OFP13_VERSION;
925 is_delimiter(unsigned char c)
927 return isspace(c) || c == ',';
931 ofputil_versions_from_string(const char *s)
941 if (is_delimiter(s[i])) {
946 while (s[i + j] && !is_delimiter(s[i + j])) {
949 key = xmemdup0(s + i, j);
950 version = ofputil_version_from_string(key);
952 VLOG_FATAL("Unknown OpenFlow version: \"%s\"", key);
955 bitmap |= 1u << version;
963 ofputil_versions_from_strings(char ** const s, size_t count)
968 int version = ofputil_version_from_string(s[count]);
970 VLOG_WARN("Unknown OpenFlow version: \"%s\"", s[count]);
972 bitmap |= 1u << version;
980 ofputil_version_to_string(enum ofp_version ofp_version)
982 switch (ofp_version) {
997 ofputil_packet_in_format_is_valid(enum nx_packet_in_format packet_in_format)
999 switch (packet_in_format) {
1000 case NXPIF_OPENFLOW10:
1009 ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format)
1011 switch (packet_in_format) {
1012 case NXPIF_OPENFLOW10:
1013 return "openflow10";
1022 ofputil_packet_in_format_from_string(const char *s)
1024 return (!strcmp(s, "openflow10") ? NXPIF_OPENFLOW10
1025 : !strcmp(s, "nxm") ? NXPIF_NXM
1030 regs_fully_wildcarded(const struct flow_wildcards *wc)
1034 for (i = 0; i < FLOW_N_REGS; i++) {
1035 if (wc->masks.regs[i] != 0) {
1043 tun_parms_fully_wildcarded(const struct flow_wildcards *wc)
1045 return (!wc->masks.tunnel.ip_src &&
1046 !wc->masks.tunnel.ip_dst &&
1047 !wc->masks.tunnel.ip_ttl &&
1048 !wc->masks.tunnel.ip_tos &&
1049 !wc->masks.tunnel.flags);
1052 /* Returns a bit-mask of ofputil_protocols that can be used for sending 'match'
1053 * to a switch (e.g. to add or remove a flow). Only NXM can handle tunnel IDs,
1054 * registers, or fixing the Ethernet multicast bit. Otherwise, it's better to
1055 * use OpenFlow 1.0 protocol for backward compatibility. */
1056 enum ofputil_protocol
1057 ofputil_usable_protocols(const struct match *match)
1059 const struct flow_wildcards *wc = &match->wc;
1061 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 20);
1063 /* tunnel params other than tun_id can't be sent in a flow_mod */
1064 if (!tun_parms_fully_wildcarded(wc)) {
1065 return OFPUTIL_P_NONE;
1068 /* skb_mark and skb_priority can't be sent in a flow_mod */
1069 if (wc->masks.skb_mark || wc->masks.skb_priority) {
1070 return OFPUTIL_P_NONE;
1073 /* NXM, OXM, and OF1.1 support bitwise matching on ethernet addresses. */
1074 if (!eth_mask_is_exact(wc->masks.dl_src)
1075 && !eth_addr_is_zero(wc->masks.dl_src)) {
1076 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1077 | OFPUTIL_P_OF13_OXM;
1079 if (!eth_mask_is_exact(wc->masks.dl_dst)
1080 && !eth_addr_is_zero(wc->masks.dl_dst)) {
1081 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1082 | OFPUTIL_P_OF13_OXM;
1085 /* NXM, OXM, and OF1.1+ support matching metadata. */
1086 if (wc->masks.metadata != htonll(0)) {
1087 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1088 | OFPUTIL_P_OF13_OXM;
1091 /* NXM and OXM support matching ARP hardware addresses. */
1092 if (!eth_addr_is_zero(wc->masks.arp_sha) ||
1093 !eth_addr_is_zero(wc->masks.arp_tha)) {
1094 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1095 | OFPUTIL_P_OF13_OXM;
1098 /* NXM and OXM support matching IPv6 traffic. */
1099 if (match->flow.dl_type == htons(ETH_TYPE_IPV6)) {
1100 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1101 | OFPUTIL_P_OF13_OXM;
1104 /* NXM and OXM support matching registers. */
1105 if (!regs_fully_wildcarded(wc)) {
1106 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1107 | OFPUTIL_P_OF13_OXM;
1110 /* NXM and OXM support matching tun_id. */
1111 if (wc->masks.tunnel.tun_id != htonll(0)) {
1112 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1113 | OFPUTIL_P_OF13_OXM;
1116 /* NXM and OXM support matching fragments. */
1117 if (wc->masks.nw_frag) {
1118 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1119 | OFPUTIL_P_OF13_OXM;
1122 /* NXM and OXM support matching IPv6 flow label. */
1123 if (wc->masks.ipv6_label) {
1124 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1125 | OFPUTIL_P_OF13_OXM;
1128 /* NXM and OXM support matching IP ECN bits. */
1129 if (wc->masks.nw_tos & IP_ECN_MASK) {
1130 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1131 | OFPUTIL_P_OF13_OXM;
1134 /* NXM and OXM support matching IP TTL/hop limit. */
1135 if (wc->masks.nw_ttl) {
1136 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1137 | OFPUTIL_P_OF13_OXM;
1140 /* NXM and OXM support non-CIDR IPv4 address masks. */
1141 if (!ip_is_cidr(wc->masks.nw_src) || !ip_is_cidr(wc->masks.nw_dst)) {
1142 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1143 | OFPUTIL_P_OF13_OXM;
1146 /* NXM and OXM support bitwise matching on transport port. */
1147 if ((wc->masks.tp_src && wc->masks.tp_src != htons(UINT16_MAX)) ||
1148 (wc->masks.tp_dst && wc->masks.tp_dst != htons(UINT16_MAX))) {
1149 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1150 | OFPUTIL_P_OF13_OXM;
1153 /* NXM and OF1.1+ support matching MPLS label */
1154 if (wc->masks.mpls_lse & htonl(MPLS_LABEL_MASK)) {
1155 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1156 | OFPUTIL_P_OF13_OXM;
1159 /* NXM and OF1.1+ support matching MPLS TC */
1160 if (wc->masks.mpls_lse & htonl(MPLS_TC_MASK)) {
1161 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1162 | OFPUTIL_P_OF13_OXM;
1165 /* NXM and OF1.3+ support matching MPLS stack flag */
1166 /* Allow for OF1.2 as there doesn't seem to be a
1167 * particularly good reason not to */
1168 if (wc->masks.mpls_lse & htonl(MPLS_BOS_MASK)) {
1169 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1170 | OFPUTIL_P_OF13_OXM;
1173 /* Other formats can express this rule. */
1174 return OFPUTIL_P_ANY;
1178 ofputil_format_version(struct ds *msg, enum ofp_version version)
1180 ds_put_format(msg, "0x%02x", version);
1184 ofputil_format_version_name(struct ds *msg, enum ofp_version version)
1186 ds_put_cstr(msg, ofputil_version_to_string(version));
1190 ofputil_format_version_bitmap__(struct ds *msg, uint32_t bitmap,
1191 void (*format_version)(struct ds *msg,
1195 format_version(msg, raw_ctz(bitmap));
1196 bitmap = zero_rightmost_1bit(bitmap);
1198 ds_put_cstr(msg, ", ");
1204 ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap)
1206 ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version);
1210 ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap)
1212 ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version_name);
1216 ofputil_decode_hello_bitmap(const struct ofp_hello_elem_header *oheh,
1217 uint32_t *allowed_versionsp)
1219 uint16_t bitmap_len = ntohs(oheh->length) - sizeof *oheh;
1220 const ovs_be32 *bitmap = (const ovs_be32 *) (oheh + 1);
1221 uint32_t allowed_versions;
1223 if (!bitmap_len || bitmap_len % sizeof *bitmap) {
1227 /* Only use the first 32-bit element of the bitmap as that is all the
1228 * current implementation supports. Subsequent elements are ignored which
1229 * should have no effect on session negotiation until Open vSwtich supports
1230 * wire-protocol versions greater than 31.
1232 allowed_versions = ntohl(bitmap[0]);
1234 if (allowed_versions & 1) {
1235 /* There's no OpenFlow version 0. */
1236 VLOG_WARN_RL(&bad_ofmsg_rl, "peer claims to support invalid OpenFlow "
1238 allowed_versions &= ~1u;
1241 if (!allowed_versions) {
1242 VLOG_WARN_RL(&bad_ofmsg_rl, "peer does not support any OpenFlow "
1243 "version (between 0x01 and 0x1f)");
1247 *allowed_versionsp = allowed_versions;
1252 version_bitmap_from_version(uint8_t ofp_version)
1254 return ((ofp_version < 32 ? 1u << ofp_version : 0) - 1) << 1;
1257 /* Decodes OpenFlow OFPT_HELLO message 'oh', storing into '*allowed_versions'
1258 * the set of OpenFlow versions for which 'oh' announces support.
1260 * Because of how OpenFlow defines OFPT_HELLO messages, this function is always
1261 * successful, and thus '*allowed_versions' is always initialized. However, it
1262 * returns false if 'oh' contains some data that could not be fully understood,
1263 * true if 'oh' was completely parsed. */
1265 ofputil_decode_hello(const struct ofp_header *oh, uint32_t *allowed_versions)
1270 ofpbuf_use_const(&msg, oh, ntohs(oh->length));
1271 ofpbuf_pull(&msg, sizeof *oh);
1273 *allowed_versions = version_bitmap_from_version(oh->version);
1275 const struct ofp_hello_elem_header *oheh;
1278 if (msg.size < sizeof *oheh) {
1283 len = ntohs(oheh->length);
1284 if (len < sizeof *oheh || !ofpbuf_try_pull(&msg, ROUND_UP(len, 8))) {
1288 if (oheh->type != htons(OFPHET_VERSIONBITMAP)
1289 || !ofputil_decode_hello_bitmap(oheh, allowed_versions)) {
1297 /* Returns true if 'allowed_versions' needs to be accompanied by a version
1298 * bitmap to be correctly expressed in an OFPT_HELLO message. */
1300 should_send_version_bitmap(uint32_t allowed_versions)
1302 return !is_pow2((allowed_versions >> 1) + 1);
1305 /* Create an OFPT_HELLO message that expresses support for the OpenFlow
1306 * versions in the 'allowed_versions' bitmaps and returns the message. */
1308 ofputil_encode_hello(uint32_t allowed_versions)
1310 enum ofp_version ofp_version;
1313 ofp_version = leftmost_1bit_idx(allowed_versions);
1314 msg = ofpraw_alloc(OFPRAW_OFPT_HELLO, ofp_version, 0);
1316 if (should_send_version_bitmap(allowed_versions)) {
1317 struct ofp_hello_elem_header *oheh;
1320 map_len = sizeof allowed_versions;
1321 oheh = ofpbuf_put_zeros(msg, ROUND_UP(map_len + sizeof *oheh, 8));
1322 oheh->type = htons(OFPHET_VERSIONBITMAP);
1323 oheh->length = htons(map_len + sizeof *oheh);
1324 *(ovs_be32 *)(oheh + 1) = htonl(allowed_versions);
1326 ofpmsg_update_length(msg);
1332 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
1333 * protocol is 'current', at least partly transitions the protocol to 'want'.
1334 * Stores in '*next' the protocol that will be in effect on the OpenFlow
1335 * connection if the switch processes the returned message correctly. (If
1336 * '*next != want' then the caller will have to iterate.)
1338 * If 'current == want', or if it is not possible to transition from 'current'
1339 * to 'want' (because, for example, 'current' and 'want' use different OpenFlow
1340 * protocol versions), returns NULL and stores 'current' in '*next'. */
1342 ofputil_encode_set_protocol(enum ofputil_protocol current,
1343 enum ofputil_protocol want,
1344 enum ofputil_protocol *next)
1346 enum ofp_version cur_version, want_version;
1347 enum ofputil_protocol cur_base, want_base;
1348 bool cur_tid, want_tid;
1350 cur_version = ofputil_protocol_to_ofp_version(current);
1351 want_version = ofputil_protocol_to_ofp_version(want);
1352 if (cur_version != want_version) {
1357 cur_base = ofputil_protocol_to_base(current);
1358 want_base = ofputil_protocol_to_base(want);
1359 if (cur_base != want_base) {
1360 *next = ofputil_protocol_set_base(current, want_base);
1362 switch (want_base) {
1363 case OFPUTIL_P_OF10_NXM:
1364 return ofputil_encode_nx_set_flow_format(NXFF_NXM);
1366 case OFPUTIL_P_OF10_STD:
1367 return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10);
1369 case OFPUTIL_P_OF12_OXM:
1370 case OFPUTIL_P_OF13_OXM:
1371 /* There are only one of each OpenFlow 1.2+ protocols and we already
1372 * verified above that we're not trying to change versions. */
1375 case OFPUTIL_P_OF10_STD_TID:
1376 case OFPUTIL_P_OF10_NXM_TID:
1381 cur_tid = (current & OFPUTIL_P_TID) != 0;
1382 want_tid = (want & OFPUTIL_P_TID) != 0;
1383 if (cur_tid != want_tid) {
1384 *next = ofputil_protocol_set_tid(current, want_tid);
1385 return ofputil_make_flow_mod_table_id(want_tid);
1388 ovs_assert(current == want);
1394 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1395 * format to 'nxff'. */
1397 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff)
1399 struct nx_set_flow_format *sff;
1402 ovs_assert(ofputil_nx_flow_format_is_valid(nxff));
1404 msg = ofpraw_alloc(OFPRAW_NXT_SET_FLOW_FORMAT, OFP10_VERSION, 0);
1405 sff = ofpbuf_put_zeros(msg, sizeof *sff);
1406 sff->format = htonl(nxff);
1411 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1413 enum ofputil_protocol
1414 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format)
1416 switch (flow_format) {
1417 case NXFF_OPENFLOW10:
1418 return OFPUTIL_P_OF10_STD;
1421 return OFPUTIL_P_OF10_NXM;
1428 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1430 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format)
1432 return ofputil_nx_flow_format_to_protocol(flow_format) != 0;
1435 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1438 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format)
1440 switch (flow_format) {
1441 case NXFF_OPENFLOW10:
1442 return "openflow10";
1451 ofputil_make_set_packet_in_format(enum ofp_version ofp_version,
1452 enum nx_packet_in_format packet_in_format)
1454 struct nx_set_packet_in_format *spif;
1457 msg = ofpraw_alloc(OFPRAW_NXT_SET_PACKET_IN_FORMAT, ofp_version, 0);
1458 spif = ofpbuf_put_zeros(msg, sizeof *spif);
1459 spif->format = htonl(packet_in_format);
1464 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1465 * extension on or off (according to 'flow_mod_table_id'). */
1467 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
1469 struct nx_flow_mod_table_id *nfmti;
1472 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION, 0);
1473 nfmti = ofpbuf_put_zeros(msg, sizeof *nfmti);
1474 nfmti->set = flow_mod_table_id;
1478 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1479 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
1482 * Uses 'ofpacts' to store the abstract OFPACT_* version of 'oh''s actions.
1483 * The caller must initialize 'ofpacts' and retains ownership of it.
1484 * 'fm->ofpacts' will point into the 'ofpacts' buffer.
1486 * Does not validate the flow_mod actions. The caller should do that, with
1487 * ofpacts_check(). */
1489 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
1490 const struct ofp_header *oh,
1491 enum ofputil_protocol protocol,
1492 struct ofpbuf *ofpacts)
1498 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1499 raw = ofpraw_pull_assert(&b);
1500 if (raw == OFPRAW_OFPT11_FLOW_MOD) {
1501 /* Standard OpenFlow 1.1 flow_mod. */
1502 const struct ofp11_flow_mod *ofm;
1505 ofm = ofpbuf_pull(&b, sizeof *ofm);
1507 error = ofputil_pull_ofp11_match(&b, &fm->match, NULL);
1512 error = ofpacts_pull_openflow11_instructions(&b, b.size, ofpacts);
1517 /* Translate the message. */
1518 fm->priority = ntohs(ofm->priority);
1519 if (ofm->command == OFPFC_ADD) {
1520 fm->cookie = htonll(0);
1521 fm->cookie_mask = htonll(0);
1522 fm->new_cookie = ofm->cookie;
1524 fm->cookie = ofm->cookie;
1525 fm->cookie_mask = ofm->cookie_mask;
1526 fm->new_cookie = htonll(UINT64_MAX);
1528 fm->command = ofm->command;
1529 fm->table_id = ofm->table_id;
1530 fm->idle_timeout = ntohs(ofm->idle_timeout);
1531 fm->hard_timeout = ntohs(ofm->hard_timeout);
1532 fm->buffer_id = ntohl(ofm->buffer_id);
1533 error = ofputil_port_from_ofp11(ofm->out_port, &fm->out_port);
1537 if ((ofm->command == OFPFC_DELETE
1538 || ofm->command == OFPFC_DELETE_STRICT)
1539 && ofm->out_group != htonl(OFPG_ANY)) {
1540 return OFPERR_OFPFMFC_UNKNOWN;
1542 fm->flags = ntohs(ofm->flags);
1544 if (raw == OFPRAW_OFPT10_FLOW_MOD) {
1545 /* Standard OpenFlow 1.0 flow_mod. */
1546 const struct ofp10_flow_mod *ofm;
1549 /* Get the ofp10_flow_mod. */
1550 ofm = ofpbuf_pull(&b, sizeof *ofm);
1552 /* Translate the rule. */
1553 ofputil_match_from_ofp10_match(&ofm->match, &fm->match);
1554 ofputil_normalize_match(&fm->match);
1556 /* Now get the actions. */
1557 error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1562 /* OpenFlow 1.0 says that exact-match rules have to have the
1563 * highest possible priority. */
1564 fm->priority = (ofm->match.wildcards & htonl(OFPFW10_ALL)
1565 ? ntohs(ofm->priority)
1568 /* Translate the message. */
1569 command = ntohs(ofm->command);
1570 fm->cookie = htonll(0);
1571 fm->cookie_mask = htonll(0);
1572 fm->new_cookie = ofm->cookie;
1573 fm->idle_timeout = ntohs(ofm->idle_timeout);
1574 fm->hard_timeout = ntohs(ofm->hard_timeout);
1575 fm->buffer_id = ntohl(ofm->buffer_id);
1576 fm->out_port = ntohs(ofm->out_port);
1577 fm->flags = ntohs(ofm->flags);
1578 } else if (raw == OFPRAW_NXT_FLOW_MOD) {
1579 /* Nicira extended flow_mod. */
1580 const struct nx_flow_mod *nfm;
1583 /* Dissect the message. */
1584 nfm = ofpbuf_pull(&b, sizeof *nfm);
1585 error = nx_pull_match(&b, ntohs(nfm->match_len),
1586 &fm->match, &fm->cookie, &fm->cookie_mask);
1590 error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1595 /* Translate the message. */
1596 command = ntohs(nfm->command);
1597 if ((command & 0xff) == OFPFC_ADD && fm->cookie_mask) {
1598 /* Flow additions may only set a new cookie, not match an
1599 * existing cookie. */
1600 return OFPERR_NXBRC_NXM_INVALID;
1602 fm->priority = ntohs(nfm->priority);
1603 fm->new_cookie = nfm->cookie;
1604 fm->idle_timeout = ntohs(nfm->idle_timeout);
1605 fm->hard_timeout = ntohs(nfm->hard_timeout);
1606 fm->buffer_id = ntohl(nfm->buffer_id);
1607 fm->out_port = ntohs(nfm->out_port);
1608 fm->flags = ntohs(nfm->flags);
1613 if (fm->flags & OFPFF10_EMERG) {
1614 /* We do not support the OpenFlow 1.0 emergency flow cache, which
1615 * is not required in OpenFlow 1.0.1 and removed from OpenFlow 1.1.
1617 * OpenFlow 1.0 specifies the error code to use when idle_timeout
1618 * or hard_timeout is nonzero. Otherwise, there is no good error
1619 * code, so just state that the flow table is full. */
1620 return (fm->hard_timeout || fm->idle_timeout
1621 ? OFPERR_OFPFMFC_BAD_EMERG_TIMEOUT
1622 : OFPERR_OFPFMFC_TABLE_FULL);
1625 if (protocol & OFPUTIL_P_TID) {
1626 fm->command = command & 0xff;
1627 fm->table_id = command >> 8;
1629 fm->command = command;
1630 fm->table_id = 0xff;
1634 fm->ofpacts = ofpacts->data;
1635 fm->ofpacts_len = ofpacts->size;
1641 ofputil_tid_command(const struct ofputil_flow_mod *fm,
1642 enum ofputil_protocol protocol)
1644 return htons(protocol & OFPUTIL_P_TID
1645 ? (fm->command & 0xff) | (fm->table_id << 8)
1649 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
1650 * 'protocol' and returns the message. */
1652 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
1653 enum ofputil_protocol protocol)
1658 case OFPUTIL_P_OF12_OXM:
1659 case OFPUTIL_P_OF13_OXM: {
1660 struct ofp11_flow_mod *ofm;
1662 msg = ofpraw_alloc(OFPRAW_OFPT11_FLOW_MOD,
1663 ofputil_protocol_to_ofp_version(protocol),
1664 NXM_TYPICAL_LEN + fm->ofpacts_len);
1665 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
1666 if (fm->command == OFPFC_ADD) {
1667 ofm->cookie = fm->new_cookie;
1669 ofm->cookie = fm->cookie;
1671 ofm->cookie_mask = fm->cookie_mask;
1672 ofm->table_id = fm->table_id;
1673 ofm->command = fm->command;
1674 ofm->idle_timeout = htons(fm->idle_timeout);
1675 ofm->hard_timeout = htons(fm->hard_timeout);
1676 ofm->priority = htons(fm->priority);
1677 ofm->buffer_id = htonl(fm->buffer_id);
1678 ofm->out_port = ofputil_port_to_ofp11(fm->out_port);
1679 ofm->out_group = htonl(OFPG11_ANY);
1680 ofm->flags = htons(fm->flags);
1681 oxm_put_match(msg, &fm->match);
1682 ofpacts_put_openflow11_instructions(fm->ofpacts, fm->ofpacts_len, msg);
1686 case OFPUTIL_P_OF10_STD:
1687 case OFPUTIL_P_OF10_STD_TID: {
1688 struct ofp10_flow_mod *ofm;
1690 msg = ofpraw_alloc(OFPRAW_OFPT10_FLOW_MOD, OFP10_VERSION,
1692 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
1693 ofputil_match_to_ofp10_match(&fm->match, &ofm->match);
1694 ofm->cookie = fm->new_cookie;
1695 ofm->command = ofputil_tid_command(fm, protocol);
1696 ofm->idle_timeout = htons(fm->idle_timeout);
1697 ofm->hard_timeout = htons(fm->hard_timeout);
1698 ofm->priority = htons(fm->priority);
1699 ofm->buffer_id = htonl(fm->buffer_id);
1700 ofm->out_port = htons(fm->out_port);
1701 ofm->flags = htons(fm->flags);
1702 ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
1706 case OFPUTIL_P_OF10_NXM:
1707 case OFPUTIL_P_OF10_NXM_TID: {
1708 struct nx_flow_mod *nfm;
1711 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD, OFP10_VERSION,
1712 NXM_TYPICAL_LEN + fm->ofpacts_len);
1713 nfm = ofpbuf_put_zeros(msg, sizeof *nfm);
1714 nfm->command = ofputil_tid_command(fm, protocol);
1715 nfm->cookie = fm->new_cookie;
1716 match_len = nx_put_match(msg, &fm->match, fm->cookie, fm->cookie_mask);
1718 nfm->idle_timeout = htons(fm->idle_timeout);
1719 nfm->hard_timeout = htons(fm->hard_timeout);
1720 nfm->priority = htons(fm->priority);
1721 nfm->buffer_id = htonl(fm->buffer_id);
1722 nfm->out_port = htons(fm->out_port);
1723 nfm->flags = htons(fm->flags);
1724 nfm->match_len = htons(match_len);
1725 ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
1733 ofpmsg_update_length(msg);
1737 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1738 * send all of the 'n_fm's flow table modification requests in 'fms', and a
1739 * 0-bit for each protocol that is inadequate.
1741 * (The return value will have at least one 1-bit.) */
1742 enum ofputil_protocol
1743 ofputil_flow_mod_usable_protocols(const struct ofputil_flow_mod *fms,
1746 enum ofputil_protocol usable_protocols;
1749 usable_protocols = OFPUTIL_P_ANY;
1750 for (i = 0; i < n_fms; i++) {
1751 const struct ofputil_flow_mod *fm = &fms[i];
1753 usable_protocols &= ofputil_usable_protocols(&fm->match);
1754 if (fm->table_id != 0xff) {
1755 usable_protocols &= OFPUTIL_P_TID;
1758 /* Matching of the cookie is only supported through NXM or OF1.1+. */
1759 if (fm->cookie_mask != htonll(0)) {
1760 usable_protocols &= OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1761 | OFPUTIL_P_OF13_OXM;
1765 return usable_protocols;
1769 ofputil_decode_ofpst10_flow_request(struct ofputil_flow_stats_request *fsr,
1770 const struct ofp10_flow_stats_request *ofsr,
1773 fsr->aggregate = aggregate;
1774 ofputil_match_from_ofp10_match(&ofsr->match, &fsr->match);
1775 fsr->out_port = ntohs(ofsr->out_port);
1776 fsr->table_id = ofsr->table_id;
1777 fsr->cookie = fsr->cookie_mask = htonll(0);
1783 ofputil_decode_ofpst11_flow_request(struct ofputil_flow_stats_request *fsr,
1784 struct ofpbuf *b, bool aggregate)
1786 const struct ofp11_flow_stats_request *ofsr;
1789 ofsr = ofpbuf_pull(b, sizeof *ofsr);
1790 fsr->aggregate = aggregate;
1791 fsr->table_id = ofsr->table_id;
1792 error = ofputil_port_from_ofp11(ofsr->out_port, &fsr->out_port);
1796 if (ofsr->out_group != htonl(OFPG11_ANY)) {
1797 return OFPERR_OFPFMFC_UNKNOWN;
1799 fsr->cookie = ofsr->cookie;
1800 fsr->cookie_mask = ofsr->cookie_mask;
1801 error = ofputil_pull_ofp11_match(b, &fsr->match, NULL);
1810 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
1811 struct ofpbuf *b, bool aggregate)
1813 const struct nx_flow_stats_request *nfsr;
1816 nfsr = ofpbuf_pull(b, sizeof *nfsr);
1817 error = nx_pull_match(b, ntohs(nfsr->match_len), &fsr->match,
1818 &fsr->cookie, &fsr->cookie_mask);
1823 return OFPERR_OFPBRC_BAD_LEN;
1826 fsr->aggregate = aggregate;
1827 fsr->out_port = ntohs(nfsr->out_port);
1828 fsr->table_id = nfsr->table_id;
1833 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
1834 * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
1835 * successful, otherwise an OpenFlow error code. */
1837 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
1838 const struct ofp_header *oh)
1843 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1844 raw = ofpraw_pull_assert(&b);
1845 switch ((int) raw) {
1846 case OFPRAW_OFPST10_FLOW_REQUEST:
1847 return ofputil_decode_ofpst10_flow_request(fsr, b.data, false);
1849 case OFPRAW_OFPST10_AGGREGATE_REQUEST:
1850 return ofputil_decode_ofpst10_flow_request(fsr, b.data, true);
1852 case OFPRAW_OFPST11_FLOW_REQUEST:
1853 return ofputil_decode_ofpst11_flow_request(fsr, &b, false);
1855 case OFPRAW_OFPST11_AGGREGATE_REQUEST:
1856 return ofputil_decode_ofpst11_flow_request(fsr, &b, true);
1858 case OFPRAW_NXST_FLOW_REQUEST:
1859 return ofputil_decode_nxst_flow_request(fsr, &b, false);
1861 case OFPRAW_NXST_AGGREGATE_REQUEST:
1862 return ofputil_decode_nxst_flow_request(fsr, &b, true);
1865 /* Hey, the caller lied. */
1870 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
1871 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
1872 * 'protocol', and returns the message. */
1874 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
1875 enum ofputil_protocol protocol)
1881 case OFPUTIL_P_OF12_OXM:
1882 case OFPUTIL_P_OF13_OXM: {
1883 struct ofp11_flow_stats_request *ofsr;
1885 raw = (fsr->aggregate
1886 ? OFPRAW_OFPST11_AGGREGATE_REQUEST
1887 : OFPRAW_OFPST11_FLOW_REQUEST);
1888 msg = ofpraw_alloc(raw, ofputil_protocol_to_ofp_version(protocol),
1890 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
1891 ofsr->table_id = fsr->table_id;
1892 ofsr->out_port = ofputil_port_to_ofp11(fsr->out_port);
1893 ofsr->out_group = htonl(OFPG11_ANY);
1894 ofsr->cookie = fsr->cookie;
1895 ofsr->cookie_mask = fsr->cookie_mask;
1896 oxm_put_match(msg, &fsr->match);
1900 case OFPUTIL_P_OF10_STD:
1901 case OFPUTIL_P_OF10_STD_TID: {
1902 struct ofp10_flow_stats_request *ofsr;
1904 raw = (fsr->aggregate
1905 ? OFPRAW_OFPST10_AGGREGATE_REQUEST
1906 : OFPRAW_OFPST10_FLOW_REQUEST);
1907 msg = ofpraw_alloc(raw, OFP10_VERSION, 0);
1908 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
1909 ofputil_match_to_ofp10_match(&fsr->match, &ofsr->match);
1910 ofsr->table_id = fsr->table_id;
1911 ofsr->out_port = htons(fsr->out_port);
1915 case OFPUTIL_P_OF10_NXM:
1916 case OFPUTIL_P_OF10_NXM_TID: {
1917 struct nx_flow_stats_request *nfsr;
1920 raw = (fsr->aggregate
1921 ? OFPRAW_NXST_AGGREGATE_REQUEST
1922 : OFPRAW_NXST_FLOW_REQUEST);
1923 msg = ofpraw_alloc(raw, OFP10_VERSION, NXM_TYPICAL_LEN);
1924 ofpbuf_put_zeros(msg, sizeof *nfsr);
1925 match_len = nx_put_match(msg, &fsr->match,
1926 fsr->cookie, fsr->cookie_mask);
1929 nfsr->out_port = htons(fsr->out_port);
1930 nfsr->match_len = htons(match_len);
1931 nfsr->table_id = fsr->table_id;
1942 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1943 * accurately encode 'fsr', and a 0-bit for each protocol that is inadequate.
1945 * (The return value will have at least one 1-bit.) */
1946 enum ofputil_protocol
1947 ofputil_flow_stats_request_usable_protocols(
1948 const struct ofputil_flow_stats_request *fsr)
1950 enum ofputil_protocol usable_protocols;
1952 usable_protocols = ofputil_usable_protocols(&fsr->match);
1953 if (fsr->cookie_mask != htonll(0)) {
1954 usable_protocols &= OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1955 | OFPUTIL_P_OF13_OXM;
1957 return usable_protocols;
1960 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
1961 * ofputil_flow_stats in 'fs'.
1963 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
1964 * OpenFlow message. Calling this function multiple times for a single 'msg'
1965 * iterates through the replies. The caller must initially leave 'msg''s layer
1966 * pointers null and not modify them between calls.
1968 * Most switches don't send the values needed to populate fs->idle_age and
1969 * fs->hard_age, so those members will usually be set to 0. If the switch from
1970 * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
1971 * 'flow_age_extension' as true so that the contents of 'msg' determine the
1972 * 'idle_age' and 'hard_age' members in 'fs'.
1974 * Uses 'ofpacts' to store the abstract OFPACT_* version of the flow stats
1975 * reply's actions. The caller must initialize 'ofpacts' and retains ownership
1976 * of it. 'fs->ofpacts' will point into the 'ofpacts' buffer.
1978 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1979 * otherwise a positive errno value. */
1981 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
1983 bool flow_age_extension,
1984 struct ofpbuf *ofpacts)
1990 ? ofpraw_decode(&raw, msg->l2)
1991 : ofpraw_pull(&raw, msg));
1998 } else if (raw == OFPRAW_OFPST11_FLOW_REPLY
1999 || raw == OFPRAW_OFPST13_FLOW_REPLY) {
2000 const struct ofp11_flow_stats *ofs;
2002 uint16_t padded_match_len;
2004 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2006 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
2007 "bytes at end", msg->size);
2011 length = ntohs(ofs->length);
2012 if (length < sizeof *ofs) {
2013 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2014 "length %zu", length);
2018 if (ofputil_pull_ofp11_match(msg, &fs->match, &padded_match_len)) {
2019 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad match");
2023 if (ofpacts_pull_openflow11_instructions(msg, length - sizeof *ofs -
2024 padded_match_len, ofpacts)) {
2025 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad instructions");
2029 fs->priority = ntohs(ofs->priority);
2030 fs->table_id = ofs->table_id;
2031 fs->duration_sec = ntohl(ofs->duration_sec);
2032 fs->duration_nsec = ntohl(ofs->duration_nsec);
2033 fs->idle_timeout = ntohs(ofs->idle_timeout);
2034 fs->hard_timeout = ntohs(ofs->hard_timeout);
2035 fs->flags = (raw == OFPRAW_OFPST13_FLOW_REPLY) ? ntohs(ofs->flags) : 0;
2038 fs->cookie = ofs->cookie;
2039 fs->packet_count = ntohll(ofs->packet_count);
2040 fs->byte_count = ntohll(ofs->byte_count);
2041 } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
2042 const struct ofp10_flow_stats *ofs;
2045 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2047 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
2048 "bytes at end", msg->size);
2052 length = ntohs(ofs->length);
2053 if (length < sizeof *ofs) {
2054 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2055 "length %zu", length);
2059 if (ofpacts_pull_openflow10(msg, length - sizeof *ofs, ofpacts)) {
2063 fs->cookie = get_32aligned_be64(&ofs->cookie);
2064 ofputil_match_from_ofp10_match(&ofs->match, &fs->match);
2065 fs->priority = ntohs(ofs->priority);
2066 fs->table_id = ofs->table_id;
2067 fs->duration_sec = ntohl(ofs->duration_sec);
2068 fs->duration_nsec = ntohl(ofs->duration_nsec);
2069 fs->idle_timeout = ntohs(ofs->idle_timeout);
2070 fs->hard_timeout = ntohs(ofs->hard_timeout);
2073 fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
2074 fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
2076 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
2077 const struct nx_flow_stats *nfs;
2078 size_t match_len, actions_len, length;
2080 nfs = ofpbuf_try_pull(msg, sizeof *nfs);
2082 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
2083 "bytes at end", msg->size);
2087 length = ntohs(nfs->length);
2088 match_len = ntohs(nfs->match_len);
2089 if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
2090 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
2091 "claims invalid length %zu", match_len, length);
2094 if (nx_pull_match(msg, match_len, &fs->match, NULL, NULL)) {
2098 actions_len = length - sizeof *nfs - ROUND_UP(match_len, 8);
2099 if (ofpacts_pull_openflow10(msg, actions_len, ofpacts)) {
2103 fs->cookie = nfs->cookie;
2104 fs->table_id = nfs->table_id;
2105 fs->duration_sec = ntohl(nfs->duration_sec);
2106 fs->duration_nsec = ntohl(nfs->duration_nsec);
2107 fs->priority = ntohs(nfs->priority);
2108 fs->idle_timeout = ntohs(nfs->idle_timeout);
2109 fs->hard_timeout = ntohs(nfs->hard_timeout);
2112 if (flow_age_extension) {
2113 if (nfs->idle_age) {
2114 fs->idle_age = ntohs(nfs->idle_age) - 1;
2116 if (nfs->hard_age) {
2117 fs->hard_age = ntohs(nfs->hard_age) - 1;
2120 fs->packet_count = ntohll(nfs->packet_count);
2121 fs->byte_count = ntohll(nfs->byte_count);
2127 fs->ofpacts = ofpacts->data;
2128 fs->ofpacts_len = ofpacts->size;
2133 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
2135 * We use this in situations where OVS internally uses UINT64_MAX to mean
2136 * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
2138 unknown_to_zero(uint64_t count)
2140 return count != UINT64_MAX ? count : 0;
2143 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
2144 * those already present in the list of ofpbufs in 'replies'. 'replies' should
2145 * have been initialized with ofputil_start_stats_reply(). */
2147 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
2148 struct list *replies)
2150 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
2151 size_t start_ofs = reply->size;
2154 ofpraw_decode_partial(&raw, reply->data, reply->size);
2155 if (raw == OFPRAW_OFPST11_FLOW_REPLY || raw == OFPRAW_OFPST13_FLOW_REPLY) {
2156 struct ofp11_flow_stats *ofs;
2158 ofpbuf_put_uninit(reply, sizeof *ofs);
2159 oxm_put_match(reply, &fs->match);
2160 ofpacts_put_openflow11_instructions(fs->ofpacts, fs->ofpacts_len,
2163 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
2164 ofs->length = htons(reply->size - start_ofs);
2165 ofs->table_id = fs->table_id;
2167 ofs->duration_sec = htonl(fs->duration_sec);
2168 ofs->duration_nsec = htonl(fs->duration_nsec);
2169 ofs->priority = htons(fs->priority);
2170 ofs->idle_timeout = htons(fs->idle_timeout);
2171 ofs->hard_timeout = htons(fs->hard_timeout);
2172 ofs->flags = (raw == OFPRAW_OFPST13_FLOW_REPLY) ? htons(fs->flags) : 0;
2173 memset(ofs->pad2, 0, sizeof ofs->pad2);
2174 ofs->cookie = fs->cookie;
2175 ofs->packet_count = htonll(unknown_to_zero(fs->packet_count));
2176 ofs->byte_count = htonll(unknown_to_zero(fs->byte_count));
2177 } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
2178 struct ofp10_flow_stats *ofs;
2180 ofpbuf_put_uninit(reply, sizeof *ofs);
2181 ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
2183 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
2184 ofs->length = htons(reply->size - start_ofs);
2185 ofs->table_id = fs->table_id;
2187 ofputil_match_to_ofp10_match(&fs->match, &ofs->match);
2188 ofs->duration_sec = htonl(fs->duration_sec);
2189 ofs->duration_nsec = htonl(fs->duration_nsec);
2190 ofs->priority = htons(fs->priority);
2191 ofs->idle_timeout = htons(fs->idle_timeout);
2192 ofs->hard_timeout = htons(fs->hard_timeout);
2193 memset(ofs->pad2, 0, sizeof ofs->pad2);
2194 put_32aligned_be64(&ofs->cookie, fs->cookie);
2195 put_32aligned_be64(&ofs->packet_count,
2196 htonll(unknown_to_zero(fs->packet_count)));
2197 put_32aligned_be64(&ofs->byte_count,
2198 htonll(unknown_to_zero(fs->byte_count)));
2199 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
2200 struct nx_flow_stats *nfs;
2203 ofpbuf_put_uninit(reply, sizeof *nfs);
2204 match_len = nx_put_match(reply, &fs->match, 0, 0);
2205 ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
2207 nfs = ofpbuf_at_assert(reply, start_ofs, sizeof *nfs);
2208 nfs->length = htons(reply->size - start_ofs);
2209 nfs->table_id = fs->table_id;
2211 nfs->duration_sec = htonl(fs->duration_sec);
2212 nfs->duration_nsec = htonl(fs->duration_nsec);
2213 nfs->priority = htons(fs->priority);
2214 nfs->idle_timeout = htons(fs->idle_timeout);
2215 nfs->hard_timeout = htons(fs->hard_timeout);
2216 nfs->idle_age = htons(fs->idle_age < 0 ? 0
2217 : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
2219 nfs->hard_age = htons(fs->hard_age < 0 ? 0
2220 : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
2222 nfs->match_len = htons(match_len);
2223 nfs->cookie = fs->cookie;
2224 nfs->packet_count = htonll(fs->packet_count);
2225 nfs->byte_count = htonll(fs->byte_count);
2230 ofpmp_postappend(replies, start_ofs);
2233 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
2234 * NXST_AGGREGATE reply matching 'request', and returns the message. */
2236 ofputil_encode_aggregate_stats_reply(
2237 const struct ofputil_aggregate_stats *stats,
2238 const struct ofp_header *request)
2240 struct ofp_aggregate_stats_reply *asr;
2241 uint64_t packet_count;
2242 uint64_t byte_count;
2246 ofpraw_decode(&raw, request);
2247 if (raw == OFPRAW_OFPST10_AGGREGATE_REQUEST) {
2248 packet_count = unknown_to_zero(stats->packet_count);
2249 byte_count = unknown_to_zero(stats->byte_count);
2251 packet_count = stats->packet_count;
2252 byte_count = stats->byte_count;
2255 msg = ofpraw_alloc_stats_reply(request, 0);
2256 asr = ofpbuf_put_zeros(msg, sizeof *asr);
2257 put_32aligned_be64(&asr->packet_count, htonll(packet_count));
2258 put_32aligned_be64(&asr->byte_count, htonll(byte_count));
2259 asr->flow_count = htonl(stats->flow_count);
2265 ofputil_decode_aggregate_stats_reply(struct ofputil_aggregate_stats *stats,
2266 const struct ofp_header *reply)
2268 struct ofp_aggregate_stats_reply *asr;
2271 ofpbuf_use_const(&msg, reply, ntohs(reply->length));
2272 ofpraw_pull_assert(&msg);
2275 stats->packet_count = ntohll(get_32aligned_be64(&asr->packet_count));
2276 stats->byte_count = ntohll(get_32aligned_be64(&asr->byte_count));
2277 stats->flow_count = ntohl(asr->flow_count);
2282 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
2283 * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
2284 * an OpenFlow error code. */
2286 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
2287 const struct ofp_header *oh)
2292 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2293 raw = ofpraw_pull_assert(&b);
2294 if (raw == OFPRAW_OFPT11_FLOW_REMOVED) {
2295 const struct ofp12_flow_removed *ofr;
2298 ofr = ofpbuf_pull(&b, sizeof *ofr);
2300 error = ofputil_pull_ofp11_match(&b, &fr->match, NULL);
2305 fr->priority = ntohs(ofr->priority);
2306 fr->cookie = ofr->cookie;
2307 fr->reason = ofr->reason;
2308 fr->table_id = ofr->table_id;
2309 fr->duration_sec = ntohl(ofr->duration_sec);
2310 fr->duration_nsec = ntohl(ofr->duration_nsec);
2311 fr->idle_timeout = ntohs(ofr->idle_timeout);
2312 fr->hard_timeout = ntohs(ofr->hard_timeout);
2313 fr->packet_count = ntohll(ofr->packet_count);
2314 fr->byte_count = ntohll(ofr->byte_count);
2315 } else if (raw == OFPRAW_OFPT10_FLOW_REMOVED) {
2316 const struct ofp10_flow_removed *ofr;
2318 ofr = ofpbuf_pull(&b, sizeof *ofr);
2320 ofputil_match_from_ofp10_match(&ofr->match, &fr->match);
2321 fr->priority = ntohs(ofr->priority);
2322 fr->cookie = ofr->cookie;
2323 fr->reason = ofr->reason;
2325 fr->duration_sec = ntohl(ofr->duration_sec);
2326 fr->duration_nsec = ntohl(ofr->duration_nsec);
2327 fr->idle_timeout = ntohs(ofr->idle_timeout);
2328 fr->hard_timeout = 0;
2329 fr->packet_count = ntohll(ofr->packet_count);
2330 fr->byte_count = ntohll(ofr->byte_count);
2331 } else if (raw == OFPRAW_NXT_FLOW_REMOVED) {
2332 struct nx_flow_removed *nfr;
2335 nfr = ofpbuf_pull(&b, sizeof *nfr);
2336 error = nx_pull_match(&b, ntohs(nfr->match_len), &fr->match,
2342 return OFPERR_OFPBRC_BAD_LEN;
2345 fr->priority = ntohs(nfr->priority);
2346 fr->cookie = nfr->cookie;
2347 fr->reason = nfr->reason;
2348 fr->table_id = nfr->table_id ? nfr->table_id - 1 : 255;
2349 fr->duration_sec = ntohl(nfr->duration_sec);
2350 fr->duration_nsec = ntohl(nfr->duration_nsec);
2351 fr->idle_timeout = ntohs(nfr->idle_timeout);
2352 fr->hard_timeout = 0;
2353 fr->packet_count = ntohll(nfr->packet_count);
2354 fr->byte_count = ntohll(nfr->byte_count);
2362 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
2363 * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
2366 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
2367 enum ofputil_protocol protocol)
2372 case OFPUTIL_P_OF12_OXM:
2373 case OFPUTIL_P_OF13_OXM: {
2374 struct ofp12_flow_removed *ofr;
2376 msg = ofpraw_alloc_xid(OFPRAW_OFPT11_FLOW_REMOVED,
2377 ofputil_protocol_to_ofp_version(protocol),
2378 htonl(0), NXM_TYPICAL_LEN);
2379 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
2380 ofr->cookie = fr->cookie;
2381 ofr->priority = htons(fr->priority);
2382 ofr->reason = fr->reason;
2383 ofr->table_id = fr->table_id;
2384 ofr->duration_sec = htonl(fr->duration_sec);
2385 ofr->duration_nsec = htonl(fr->duration_nsec);
2386 ofr->idle_timeout = htons(fr->idle_timeout);
2387 ofr->hard_timeout = htons(fr->hard_timeout);
2388 ofr->packet_count = htonll(fr->packet_count);
2389 ofr->byte_count = htonll(fr->byte_count);
2390 oxm_put_match(msg, &fr->match);
2394 case OFPUTIL_P_OF10_STD:
2395 case OFPUTIL_P_OF10_STD_TID: {
2396 struct ofp10_flow_removed *ofr;
2398 msg = ofpraw_alloc_xid(OFPRAW_OFPT10_FLOW_REMOVED, OFP10_VERSION,
2400 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
2401 ofputil_match_to_ofp10_match(&fr->match, &ofr->match);
2402 ofr->cookie = fr->cookie;
2403 ofr->priority = htons(fr->priority);
2404 ofr->reason = fr->reason;
2405 ofr->duration_sec = htonl(fr->duration_sec);
2406 ofr->duration_nsec = htonl(fr->duration_nsec);
2407 ofr->idle_timeout = htons(fr->idle_timeout);
2408 ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
2409 ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
2413 case OFPUTIL_P_OF10_NXM:
2414 case OFPUTIL_P_OF10_NXM_TID: {
2415 struct nx_flow_removed *nfr;
2418 msg = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_REMOVED, OFP10_VERSION,
2419 htonl(0), NXM_TYPICAL_LEN);
2420 nfr = ofpbuf_put_zeros(msg, sizeof *nfr);
2421 match_len = nx_put_match(msg, &fr->match, 0, 0);
2424 nfr->cookie = fr->cookie;
2425 nfr->priority = htons(fr->priority);
2426 nfr->reason = fr->reason;
2427 nfr->table_id = fr->table_id + 1;
2428 nfr->duration_sec = htonl(fr->duration_sec);
2429 nfr->duration_nsec = htonl(fr->duration_nsec);
2430 nfr->idle_timeout = htons(fr->idle_timeout);
2431 nfr->match_len = htons(match_len);
2432 nfr->packet_count = htonll(fr->packet_count);
2433 nfr->byte_count = htonll(fr->byte_count);
2445 ofputil_decode_packet_in_finish(struct ofputil_packet_in *pin,
2446 struct match *match, struct ofpbuf *b)
2448 pin->packet = b->data;
2449 pin->packet_len = b->size;
2451 pin->fmd.in_port = match->flow.in_port;
2452 pin->fmd.tun_id = match->flow.tunnel.tun_id;
2453 pin->fmd.metadata = match->flow.metadata;
2454 memcpy(pin->fmd.regs, match->flow.regs, sizeof pin->fmd.regs);
2458 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
2459 const struct ofp_header *oh)
2464 memset(pin, 0, sizeof *pin);
2466 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2467 raw = ofpraw_pull_assert(&b);
2468 if (raw == OFPRAW_OFPT13_PACKET_IN || raw == OFPRAW_OFPT12_PACKET_IN) {
2469 const struct ofp13_packet_in *opi;
2472 size_t packet_in_size;
2474 if (raw == OFPRAW_OFPT12_PACKET_IN) {
2475 packet_in_size = sizeof (struct ofp12_packet_in);
2477 packet_in_size = sizeof (struct ofp13_packet_in);
2480 opi = ofpbuf_pull(&b, packet_in_size);
2481 error = oxm_pull_match_loose(&b, &match);
2486 if (!ofpbuf_try_pull(&b, 2)) {
2487 return OFPERR_OFPBRC_BAD_LEN;
2490 pin->reason = opi->pi.reason;
2491 pin->table_id = opi->pi.table_id;
2492 pin->buffer_id = ntohl(opi->pi.buffer_id);
2493 pin->total_len = ntohs(opi->pi.total_len);
2495 if (raw == OFPRAW_OFPT13_PACKET_IN) {
2496 pin->cookie = opi->cookie;
2499 ofputil_decode_packet_in_finish(pin, &match, &b);
2500 } else if (raw == OFPRAW_OFPT10_PACKET_IN) {
2501 const struct ofp10_packet_in *opi;
2503 opi = ofpbuf_pull(&b, offsetof(struct ofp10_packet_in, data));
2505 pin->packet = opi->data;
2506 pin->packet_len = b.size;
2508 pin->fmd.in_port = ntohs(opi->in_port);
2509 pin->reason = opi->reason;
2510 pin->buffer_id = ntohl(opi->buffer_id);
2511 pin->total_len = ntohs(opi->total_len);
2512 } else if (raw == OFPRAW_NXT_PACKET_IN) {
2513 const struct nx_packet_in *npi;
2517 npi = ofpbuf_pull(&b, sizeof *npi);
2518 error = nx_pull_match_loose(&b, ntohs(npi->match_len), &match, NULL,
2524 if (!ofpbuf_try_pull(&b, 2)) {
2525 return OFPERR_OFPBRC_BAD_LEN;
2528 pin->reason = npi->reason;
2529 pin->table_id = npi->table_id;
2530 pin->cookie = npi->cookie;
2532 pin->buffer_id = ntohl(npi->buffer_id);
2533 pin->total_len = ntohs(npi->total_len);
2535 ofputil_decode_packet_in_finish(pin, &match, &b);
2544 ofputil_packet_in_to_match(const struct ofputil_packet_in *pin,
2545 struct match *match)
2549 match_init_catchall(match);
2550 if (pin->fmd.tun_id != htonll(0)) {
2551 match_set_tun_id(match, pin->fmd.tun_id);
2553 if (pin->fmd.metadata != htonll(0)) {
2554 match_set_metadata(match, pin->fmd.metadata);
2557 for (i = 0; i < FLOW_N_REGS; i++) {
2558 if (pin->fmd.regs[i]) {
2559 match_set_reg(match, i, pin->fmd.regs[i]);
2563 match_set_in_port(match, pin->fmd.in_port);
2566 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
2567 * in the format specified by 'packet_in_format'. */
2569 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
2570 enum ofputil_protocol protocol,
2571 enum nx_packet_in_format packet_in_format)
2573 size_t send_len = MIN(pin->send_len, pin->packet_len);
2574 struct ofpbuf *packet;
2576 /* Add OFPT_PACKET_IN. */
2577 if (protocol == OFPUTIL_P_OF13_OXM || protocol == OFPUTIL_P_OF12_OXM) {
2578 struct ofp13_packet_in *opi;
2580 enum ofpraw packet_in_raw;
2581 enum ofp_version packet_in_version;
2582 size_t packet_in_size;
2584 if (protocol == OFPUTIL_P_OF12_OXM) {
2585 packet_in_raw = OFPRAW_OFPT12_PACKET_IN;
2586 packet_in_version = OFP12_VERSION;
2587 packet_in_size = sizeof (struct ofp12_packet_in);
2589 packet_in_raw = OFPRAW_OFPT13_PACKET_IN;
2590 packet_in_version = OFP13_VERSION;
2591 packet_in_size = sizeof (struct ofp13_packet_in);
2594 ofputil_packet_in_to_match(pin, &match);
2596 /* The final argument is just an estimate of the space required. */
2597 packet = ofpraw_alloc_xid(packet_in_raw, packet_in_version,
2598 htonl(0), (sizeof(struct flow_metadata) * 2
2600 ofpbuf_put_zeros(packet, packet_in_size);
2601 oxm_put_match(packet, &match);
2602 ofpbuf_put_zeros(packet, 2);
2603 ofpbuf_put(packet, pin->packet, send_len);
2606 opi->pi.buffer_id = htonl(pin->buffer_id);
2607 opi->pi.total_len = htons(pin->total_len);
2608 opi->pi.reason = pin->reason;
2609 opi->pi.table_id = pin->table_id;
2610 if (protocol == OFPUTIL_P_OF13_OXM) {
2611 opi->cookie = pin->cookie;
2613 } else if (packet_in_format == NXPIF_OPENFLOW10) {
2614 struct ofp10_packet_in *opi;
2616 packet = ofpraw_alloc_xid(OFPRAW_OFPT10_PACKET_IN, OFP10_VERSION,
2617 htonl(0), send_len);
2618 opi = ofpbuf_put_zeros(packet, offsetof(struct ofp10_packet_in, data));
2619 opi->total_len = htons(pin->total_len);
2620 opi->in_port = htons(pin->fmd.in_port);
2621 opi->reason = pin->reason;
2622 opi->buffer_id = htonl(pin->buffer_id);
2624 ofpbuf_put(packet, pin->packet, send_len);
2625 } else if (packet_in_format == NXPIF_NXM) {
2626 struct nx_packet_in *npi;
2630 ofputil_packet_in_to_match(pin, &match);
2632 /* The final argument is just an estimate of the space required. */
2633 packet = ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN, OFP10_VERSION,
2634 htonl(0), (sizeof(struct flow_metadata) * 2
2636 ofpbuf_put_zeros(packet, sizeof *npi);
2637 match_len = nx_put_match(packet, &match, 0, 0);
2638 ofpbuf_put_zeros(packet, 2);
2639 ofpbuf_put(packet, pin->packet, send_len);
2642 npi->buffer_id = htonl(pin->buffer_id);
2643 npi->total_len = htons(pin->total_len);
2644 npi->reason = pin->reason;
2645 npi->table_id = pin->table_id;
2646 npi->cookie = pin->cookie;
2647 npi->match_len = htons(match_len);
2651 ofpmsg_update_length(packet);
2657 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason)
2659 static char s[INT_STRLEN(int) + 1];
2666 case OFPR_INVALID_TTL:
2667 return "invalid_ttl";
2669 case OFPR_N_REASONS:
2671 sprintf(s, "%d", (int) reason);
2677 ofputil_packet_in_reason_from_string(const char *s,
2678 enum ofp_packet_in_reason *reason)
2682 for (i = 0; i < OFPR_N_REASONS; i++) {
2683 if (!strcasecmp(s, ofputil_packet_in_reason_to_string(i))) {
2691 /* Converts an OFPT_PACKET_OUT in 'opo' into an abstract ofputil_packet_out in
2694 * Uses 'ofpacts' to store the abstract OFPACT_* version of the packet out
2695 * message's actions. The caller must initialize 'ofpacts' and retains
2696 * ownership of it. 'po->ofpacts' will point into the 'ofpacts' buffer.
2698 * Returns 0 if successful, otherwise an OFPERR_* value. */
2700 ofputil_decode_packet_out(struct ofputil_packet_out *po,
2701 const struct ofp_header *oh,
2702 struct ofpbuf *ofpacts)
2707 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2708 raw = ofpraw_pull_assert(&b);
2710 if (raw == OFPRAW_OFPT11_PACKET_OUT) {
2712 const struct ofp11_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
2714 po->buffer_id = ntohl(opo->buffer_id);
2715 error = ofputil_port_from_ofp11(opo->in_port, &po->in_port);
2720 error = ofpacts_pull_openflow11_actions(&b, ntohs(opo->actions_len),
2725 } else if (raw == OFPRAW_OFPT10_PACKET_OUT) {
2727 const struct ofp10_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
2729 po->buffer_id = ntohl(opo->buffer_id);
2730 po->in_port = ntohs(opo->in_port);
2732 error = ofpacts_pull_openflow10(&b, ntohs(opo->actions_len), ofpacts);
2740 if (po->in_port >= OFPP_MAX && po->in_port != OFPP_LOCAL
2741 && po->in_port != OFPP_NONE && po->in_port != OFPP_CONTROLLER) {
2742 VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
2744 return OFPERR_OFPBRC_BAD_PORT;
2747 po->ofpacts = ofpacts->data;
2748 po->ofpacts_len = ofpacts->size;
2750 if (po->buffer_id == UINT32_MAX) {
2751 po->packet = b.data;
2752 po->packet_len = b.size;
2761 /* ofputil_phy_port */
2763 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
2764 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
2765 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
2766 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
2767 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
2768 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
2769 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
2770 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
2772 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
2773 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
2774 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
2775 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
2776 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
2777 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
2779 static enum netdev_features
2780 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
2782 uint32_t ofp10 = ntohl(ofp10_);
2783 return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
2787 netdev_port_features_to_ofp10(enum netdev_features features)
2789 return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
2792 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
2793 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
2794 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
2795 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
2796 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
2797 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
2798 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
2799 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD == OFPPF11_40GB_FD); /* bit 7 */
2800 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD == OFPPF11_100GB_FD); /* bit 8 */
2801 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD == OFPPF11_1TB_FD); /* bit 9 */
2802 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER == OFPPF11_OTHER); /* bit 10 */
2803 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == OFPPF11_COPPER); /* bit 11 */
2804 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == OFPPF11_FIBER); /* bit 12 */
2805 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == OFPPF11_AUTONEG); /* bit 13 */
2806 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == OFPPF11_PAUSE); /* bit 14 */
2807 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
2809 static enum netdev_features
2810 netdev_port_features_from_ofp11(ovs_be32 ofp11)
2812 return ntohl(ofp11) & 0xffff;
2816 netdev_port_features_to_ofp11(enum netdev_features features)
2818 return htonl(features & 0xffff);
2822 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
2823 const struct ofp10_phy_port *opp)
2825 memset(pp, 0, sizeof *pp);
2827 pp->port_no = ntohs(opp->port_no);
2828 memcpy(pp->hw_addr, opp->hw_addr, OFP_ETH_ALEN);
2829 ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
2831 pp->config = ntohl(opp->config) & OFPPC10_ALL;
2832 pp->state = ntohl(opp->state) & OFPPS10_ALL;
2834 pp->curr = netdev_port_features_from_ofp10(opp->curr);
2835 pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
2836 pp->supported = netdev_port_features_from_ofp10(opp->supported);
2837 pp->peer = netdev_port_features_from_ofp10(opp->peer);
2839 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2840 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2846 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
2847 const struct ofp11_port *op)
2851 memset(pp, 0, sizeof *pp);
2853 error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
2857 memcpy(pp->hw_addr, op->hw_addr, OFP_ETH_ALEN);
2858 ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
2860 pp->config = ntohl(op->config) & OFPPC11_ALL;
2861 pp->state = ntohl(op->state) & OFPPC11_ALL;
2863 pp->curr = netdev_port_features_from_ofp11(op->curr);
2864 pp->advertised = netdev_port_features_from_ofp11(op->advertised);
2865 pp->supported = netdev_port_features_from_ofp11(op->supported);
2866 pp->peer = netdev_port_features_from_ofp11(op->peer);
2868 pp->curr_speed = ntohl(op->curr_speed);
2869 pp->max_speed = ntohl(op->max_speed);
2875 ofputil_get_phy_port_size(enum ofp_version ofp_version)
2877 switch (ofp_version) {
2879 return sizeof(struct ofp10_phy_port);
2883 return sizeof(struct ofp11_port);
2890 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
2891 struct ofp10_phy_port *opp)
2893 memset(opp, 0, sizeof *opp);
2895 opp->port_no = htons(pp->port_no);
2896 memcpy(opp->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2897 ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2899 opp->config = htonl(pp->config & OFPPC10_ALL);
2900 opp->state = htonl(pp->state & OFPPS10_ALL);
2902 opp->curr = netdev_port_features_to_ofp10(pp->curr);
2903 opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
2904 opp->supported = netdev_port_features_to_ofp10(pp->supported);
2905 opp->peer = netdev_port_features_to_ofp10(pp->peer);
2909 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
2910 struct ofp11_port *op)
2912 memset(op, 0, sizeof *op);
2914 op->port_no = ofputil_port_to_ofp11(pp->port_no);
2915 memcpy(op->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2916 ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2918 op->config = htonl(pp->config & OFPPC11_ALL);
2919 op->state = htonl(pp->state & OFPPS11_ALL);
2921 op->curr = netdev_port_features_to_ofp11(pp->curr);
2922 op->advertised = netdev_port_features_to_ofp11(pp->advertised);
2923 op->supported = netdev_port_features_to_ofp11(pp->supported);
2924 op->peer = netdev_port_features_to_ofp11(pp->peer);
2926 op->curr_speed = htonl(pp->curr_speed);
2927 op->max_speed = htonl(pp->max_speed);
2931 ofputil_put_phy_port(enum ofp_version ofp_version,
2932 const struct ofputil_phy_port *pp, struct ofpbuf *b)
2934 switch (ofp_version) {
2935 case OFP10_VERSION: {
2936 struct ofp10_phy_port *opp;
2937 if (b->size + sizeof *opp <= UINT16_MAX) {
2938 opp = ofpbuf_put_uninit(b, sizeof *opp);
2939 ofputil_encode_ofp10_phy_port(pp, opp);
2946 case OFP13_VERSION: {
2947 struct ofp11_port *op;
2948 if (b->size + sizeof *op <= UINT16_MAX) {
2949 op = ofpbuf_put_uninit(b, sizeof *op);
2950 ofputil_encode_ofp11_port(pp, op);
2961 ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
2962 const struct ofputil_phy_port *pp,
2963 struct list *replies)
2965 switch (ofp_version) {
2966 case OFP10_VERSION: {
2967 struct ofp10_phy_port *opp;
2969 opp = ofpmp_append(replies, sizeof *opp);
2970 ofputil_encode_ofp10_phy_port(pp, opp);
2976 case OFP13_VERSION: {
2977 struct ofp11_port *op;
2979 op = ofpmp_append(replies, sizeof *op);
2980 ofputil_encode_ofp11_port(pp, op);
2989 /* ofputil_switch_features */
2991 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
2992 OFPC_IP_REASM | OFPC_QUEUE_STATS)
2993 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
2994 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
2995 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
2996 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
2997 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
2998 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
3000 struct ofputil_action_bit_translation {
3001 enum ofputil_action_bitmap ofputil_bit;
3005 static const struct ofputil_action_bit_translation of10_action_bits[] = {
3006 { OFPUTIL_A_OUTPUT, OFPAT10_OUTPUT },
3007 { OFPUTIL_A_SET_VLAN_VID, OFPAT10_SET_VLAN_VID },
3008 { OFPUTIL_A_SET_VLAN_PCP, OFPAT10_SET_VLAN_PCP },
3009 { OFPUTIL_A_STRIP_VLAN, OFPAT10_STRIP_VLAN },
3010 { OFPUTIL_A_SET_DL_SRC, OFPAT10_SET_DL_SRC },
3011 { OFPUTIL_A_SET_DL_DST, OFPAT10_SET_DL_DST },
3012 { OFPUTIL_A_SET_NW_SRC, OFPAT10_SET_NW_SRC },
3013 { OFPUTIL_A_SET_NW_DST, OFPAT10_SET_NW_DST },
3014 { OFPUTIL_A_SET_NW_TOS, OFPAT10_SET_NW_TOS },
3015 { OFPUTIL_A_SET_TP_SRC, OFPAT10_SET_TP_SRC },
3016 { OFPUTIL_A_SET_TP_DST, OFPAT10_SET_TP_DST },
3017 { OFPUTIL_A_ENQUEUE, OFPAT10_ENQUEUE },
3021 static enum ofputil_action_bitmap
3022 decode_action_bits(ovs_be32 of_actions,
3023 const struct ofputil_action_bit_translation *x)
3025 enum ofputil_action_bitmap ofputil_actions;
3027 ofputil_actions = 0;
3028 for (; x->ofputil_bit; x++) {
3029 if (of_actions & htonl(1u << x->of_bit)) {
3030 ofputil_actions |= x->ofputil_bit;
3033 return ofputil_actions;
3037 ofputil_capabilities_mask(enum ofp_version ofp_version)
3039 /* Handle capabilities whose bit is unique for all Open Flow versions */
3040 switch (ofp_version) {
3043 return OFPC_COMMON | OFPC_ARP_MATCH_IP;
3046 return OFPC_COMMON | OFPC12_PORT_BLOCKED;
3048 /* Caller needs to check osf->header.version itself */
3053 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
3054 * abstract representation in '*features'. Initializes '*b' to iterate over
3055 * the OpenFlow port structures following 'osf' with later calls to
3056 * ofputil_pull_phy_port(). Returns 0 if successful, otherwise an
3057 * OFPERR_* value. */
3059 ofputil_decode_switch_features(const struct ofp_header *oh,
3060 struct ofputil_switch_features *features,
3063 const struct ofp_switch_features *osf;
3066 ofpbuf_use_const(b, oh, ntohs(oh->length));
3067 raw = ofpraw_pull_assert(b);
3069 osf = ofpbuf_pull(b, sizeof *osf);
3070 features->datapath_id = ntohll(osf->datapath_id);
3071 features->n_buffers = ntohl(osf->n_buffers);
3072 features->n_tables = osf->n_tables;
3073 features->auxiliary_id = 0;
3075 features->capabilities = ntohl(osf->capabilities) &
3076 ofputil_capabilities_mask(oh->version);
3078 if (b->size % ofputil_get_phy_port_size(oh->version)) {
3079 return OFPERR_OFPBRC_BAD_LEN;
3082 if (raw == OFPRAW_OFPT10_FEATURES_REPLY) {
3083 if (osf->capabilities & htonl(OFPC10_STP)) {
3084 features->capabilities |= OFPUTIL_C_STP;
3086 features->actions = decode_action_bits(osf->actions, of10_action_bits);
3087 } else if (raw == OFPRAW_OFPT11_FEATURES_REPLY
3088 || raw == OFPRAW_OFPT13_FEATURES_REPLY) {
3089 if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
3090 features->capabilities |= OFPUTIL_C_GROUP_STATS;
3092 features->actions = 0;
3093 if (raw == OFPRAW_OFPT13_FEATURES_REPLY) {
3094 features->auxiliary_id = osf->auxiliary_id;
3097 return OFPERR_OFPBRC_BAD_VERSION;
3103 /* Returns true if the maximum number of ports are in 'oh'. */
3105 max_ports_in_features(const struct ofp_header *oh)
3107 size_t pp_size = ofputil_get_phy_port_size(oh->version);
3108 return ntohs(oh->length) + pp_size > UINT16_MAX;
3111 /* Given a buffer 'b' that contains a Features Reply message, checks if
3112 * it contains the maximum number of ports that will fit. If so, it
3113 * returns true and removes the ports from the message. The caller
3114 * should then send an OFPST_PORT_DESC stats request to get the ports,
3115 * since the switch may have more ports than could be represented in the
3116 * Features Reply. Otherwise, returns false.
3119 ofputil_switch_features_ports_trunc(struct ofpbuf *b)
3121 struct ofp_header *oh = b->data;
3123 if (max_ports_in_features(oh)) {
3124 /* Remove all the ports. */
3125 b->size = (sizeof(struct ofp_header)
3126 + sizeof(struct ofp_switch_features));
3127 ofpmsg_update_length(b);
3136 encode_action_bits(enum ofputil_action_bitmap ofputil_actions,
3137 const struct ofputil_action_bit_translation *x)
3139 uint32_t of_actions;
3142 for (; x->ofputil_bit; x++) {
3143 if (ofputil_actions & x->ofputil_bit) {
3144 of_actions |= 1 << x->of_bit;
3147 return htonl(of_actions);
3150 /* Returns a buffer owned by the caller that encodes 'features' in the format
3151 * required by 'protocol' with the given 'xid'. The caller should append port
3152 * information to the buffer with subsequent calls to
3153 * ofputil_put_switch_features_port(). */
3155 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
3156 enum ofputil_protocol protocol, ovs_be32 xid)
3158 struct ofp_switch_features *osf;
3160 enum ofp_version version;
3163 version = ofputil_protocol_to_ofp_version(protocol);
3166 raw = OFPRAW_OFPT10_FEATURES_REPLY;
3170 raw = OFPRAW_OFPT11_FEATURES_REPLY;
3173 raw = OFPRAW_OFPT13_FEATURES_REPLY;
3178 b = ofpraw_alloc_xid(raw, version, xid, 0);
3179 osf = ofpbuf_put_zeros(b, sizeof *osf);
3180 osf->datapath_id = htonll(features->datapath_id);
3181 osf->n_buffers = htonl(features->n_buffers);
3182 osf->n_tables = features->n_tables;
3184 osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
3185 osf->capabilities = htonl(features->capabilities &
3186 ofputil_capabilities_mask(version));
3189 if (features->capabilities & OFPUTIL_C_STP) {
3190 osf->capabilities |= htonl(OFPC10_STP);
3192 osf->actions = encode_action_bits(features->actions, of10_action_bits);
3195 osf->auxiliary_id = features->auxiliary_id;
3199 if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
3200 osf->capabilities |= htonl(OFPC11_GROUP_STATS);
3210 /* Encodes 'pp' into the format required by the switch_features message already
3211 * in 'b', which should have been returned by ofputil_encode_switch_features(),
3212 * and appends the encoded version to 'b'. */
3214 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
3217 const struct ofp_header *oh = b->data;
3219 if (oh->version < OFP13_VERSION) {
3220 ofputil_put_phy_port(oh->version, pp, b);
3224 /* ofputil_port_status */
3226 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
3227 * in '*ps'. Returns 0 if successful, otherwise an OFPERR_* value. */
3229 ofputil_decode_port_status(const struct ofp_header *oh,
3230 struct ofputil_port_status *ps)
3232 const struct ofp_port_status *ops;
3236 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3237 ofpraw_pull_assert(&b);
3238 ops = ofpbuf_pull(&b, sizeof *ops);
3240 if (ops->reason != OFPPR_ADD &&
3241 ops->reason != OFPPR_DELETE &&
3242 ops->reason != OFPPR_MODIFY) {
3243 return OFPERR_NXBRC_BAD_REASON;
3245 ps->reason = ops->reason;
3247 retval = ofputil_pull_phy_port(oh->version, &b, &ps->desc);
3248 ovs_assert(retval != EOF);
3252 /* Converts the abstract form of a "port status" message in '*ps' into an
3253 * OpenFlow message suitable for 'protocol', and returns that encoded form in
3254 * a buffer owned by the caller. */
3256 ofputil_encode_port_status(const struct ofputil_port_status *ps,
3257 enum ofputil_protocol protocol)
3259 struct ofp_port_status *ops;
3261 enum ofp_version version;
3264 version = ofputil_protocol_to_ofp_version(protocol);
3267 raw = OFPRAW_OFPT10_PORT_STATUS;
3273 raw = OFPRAW_OFPT11_PORT_STATUS;
3280 b = ofpraw_alloc_xid(raw, version, htonl(0), 0);
3281 ops = ofpbuf_put_zeros(b, sizeof *ops);
3282 ops->reason = ps->reason;
3283 ofputil_put_phy_port(version, &ps->desc, b);
3284 ofpmsg_update_length(b);
3288 /* ofputil_port_mod */
3290 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
3291 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
3293 ofputil_decode_port_mod(const struct ofp_header *oh,
3294 struct ofputil_port_mod *pm)
3299 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3300 raw = ofpraw_pull_assert(&b);
3302 if (raw == OFPRAW_OFPT10_PORT_MOD) {
3303 const struct ofp10_port_mod *opm = b.data;
3305 pm->port_no = ntohs(opm->port_no);
3306 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
3307 pm->config = ntohl(opm->config) & OFPPC10_ALL;
3308 pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
3309 pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
3310 } else if (raw == OFPRAW_OFPT11_PORT_MOD) {
3311 const struct ofp11_port_mod *opm = b.data;
3314 error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
3319 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
3320 pm->config = ntohl(opm->config) & OFPPC11_ALL;
3321 pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
3322 pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
3324 return OFPERR_OFPBRC_BAD_TYPE;
3327 pm->config &= pm->mask;
3331 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
3332 * message suitable for 'protocol', and returns that encoded form in a buffer
3333 * owned by the caller. */
3335 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
3336 enum ofputil_protocol protocol)
3338 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
3341 switch (ofp_version) {
3342 case OFP10_VERSION: {
3343 struct ofp10_port_mod *opm;
3345 b = ofpraw_alloc(OFPRAW_OFPT10_PORT_MOD, ofp_version, 0);
3346 opm = ofpbuf_put_zeros(b, sizeof *opm);
3347 opm->port_no = htons(pm->port_no);
3348 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
3349 opm->config = htonl(pm->config & OFPPC10_ALL);
3350 opm->mask = htonl(pm->mask & OFPPC10_ALL);
3351 opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
3357 case OFP13_VERSION: {
3358 struct ofp11_port_mod *opm;
3360 b = ofpraw_alloc(OFPRAW_OFPT11_PORT_MOD, ofp_version, 0);
3361 opm = ofpbuf_put_zeros(b, sizeof *opm);
3362 opm->port_no = ofputil_port_to_ofp11(pm->port_no);
3363 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
3364 opm->config = htonl(pm->config & OFPPC11_ALL);
3365 opm->mask = htonl(pm->mask & OFPPC11_ALL);
3366 opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
3377 /* ofputil_role_request */
3379 /* Decodes the OpenFlow "role request" or "role reply" message in '*oh' into
3380 * an abstract form in '*rr'. Returns 0 if successful, otherwise an
3381 * OFPERR_* value. */
3383 ofputil_decode_role_message(const struct ofp_header *oh,
3384 struct ofputil_role_request *rr)
3389 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3390 raw = ofpraw_pull_assert(&b);
3392 if (raw == OFPRAW_OFPT12_ROLE_REQUEST ||
3393 raw == OFPRAW_OFPT12_ROLE_REPLY) {
3394 const struct ofp12_role_request *orr = b.l3;
3396 if (orr->role != htonl(OFPCR12_ROLE_NOCHANGE) &&
3397 orr->role != htonl(OFPCR12_ROLE_EQUAL) &&
3398 orr->role != htonl(OFPCR12_ROLE_MASTER) &&
3399 orr->role != htonl(OFPCR12_ROLE_SLAVE)) {
3400 return OFPERR_OFPRRFC_BAD_ROLE;
3403 rr->role = ntohl(orr->role);
3404 if (raw == OFPRAW_OFPT12_ROLE_REQUEST
3405 ? orr->role == htonl(OFPCR12_ROLE_NOCHANGE)
3406 : orr->generation_id == htonll(UINT64_MAX)) {
3407 rr->have_generation_id = false;
3408 rr->generation_id = 0;
3410 rr->have_generation_id = true;
3411 rr->generation_id = ntohll(orr->generation_id);
3413 } else if (raw == OFPRAW_NXT_ROLE_REQUEST ||
3414 raw == OFPRAW_NXT_ROLE_REPLY) {
3415 const struct nx_role_request *nrr = b.l3;
3417 BUILD_ASSERT(NX_ROLE_OTHER + 1 == OFPCR12_ROLE_EQUAL);
3418 BUILD_ASSERT(NX_ROLE_MASTER + 1 == OFPCR12_ROLE_MASTER);
3419 BUILD_ASSERT(NX_ROLE_SLAVE + 1 == OFPCR12_ROLE_SLAVE);
3421 if (nrr->role != htonl(NX_ROLE_OTHER) &&
3422 nrr->role != htonl(NX_ROLE_MASTER) &&
3423 nrr->role != htonl(NX_ROLE_SLAVE)) {
3424 return OFPERR_OFPRRFC_BAD_ROLE;
3427 rr->role = ntohl(nrr->role) + 1;
3428 rr->have_generation_id = false;
3429 rr->generation_id = 0;
3437 /* Returns an encoded form of a role reply suitable for the "request" in a
3438 * buffer owned by the caller. */
3440 ofputil_encode_role_reply(const struct ofp_header *request,
3441 const struct ofputil_role_request *rr)
3446 raw = ofpraw_decode_assert(request);
3447 if (raw == OFPRAW_OFPT12_ROLE_REQUEST) {
3448 struct ofp12_role_request *orr;
3450 buf = ofpraw_alloc_reply(OFPRAW_OFPT12_ROLE_REPLY, request, 0);
3451 orr = ofpbuf_put_zeros(buf, sizeof *orr);
3453 orr->role = htonl(rr->role);
3454 orr->generation_id = htonll(rr->have_generation_id
3457 } else if (raw == OFPRAW_NXT_ROLE_REQUEST) {
3458 struct nx_role_request *nrr;
3460 BUILD_ASSERT(NX_ROLE_OTHER == OFPCR12_ROLE_EQUAL - 1);
3461 BUILD_ASSERT(NX_ROLE_MASTER == OFPCR12_ROLE_MASTER - 1);
3462 BUILD_ASSERT(NX_ROLE_SLAVE == OFPCR12_ROLE_SLAVE - 1);
3464 buf = ofpraw_alloc_reply(OFPRAW_NXT_ROLE_REPLY, request, 0);
3465 nrr = ofpbuf_put_zeros(buf, sizeof *nrr);
3466 nrr->role = htonl(rr->role - 1);
3477 ofputil_put_ofp10_table_stats(const struct ofp12_table_stats *in,
3481 enum ofp10_flow_wildcards wc10;
3482 enum oxm12_ofb_match_fields mf12;
3485 static const struct wc_map wc_map[] = {
3486 { OFPFW10_IN_PORT, OFPXMT12_OFB_IN_PORT },
3487 { OFPFW10_DL_VLAN, OFPXMT12_OFB_VLAN_VID },
3488 { OFPFW10_DL_SRC, OFPXMT12_OFB_ETH_SRC },
3489 { OFPFW10_DL_DST, OFPXMT12_OFB_ETH_DST},
3490 { OFPFW10_DL_TYPE, OFPXMT12_OFB_ETH_TYPE },
3491 { OFPFW10_NW_PROTO, OFPXMT12_OFB_IP_PROTO },
3492 { OFPFW10_TP_SRC, OFPXMT12_OFB_TCP_SRC },
3493 { OFPFW10_TP_DST, OFPXMT12_OFB_TCP_DST },
3494 { OFPFW10_NW_SRC_MASK, OFPXMT12_OFB_IPV4_SRC },
3495 { OFPFW10_NW_DST_MASK, OFPXMT12_OFB_IPV4_DST },
3496 { OFPFW10_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP },
3497 { OFPFW10_NW_TOS, OFPXMT12_OFB_IP_DSCP },
3500 struct ofp10_table_stats *out;
3501 const struct wc_map *p;
3503 out = ofpbuf_put_zeros(buf, sizeof *out);
3504 out->table_id = in->table_id;
3505 ovs_strlcpy(out->name, in->name, sizeof out->name);
3507 for (p = wc_map; p < &wc_map[ARRAY_SIZE(wc_map)]; p++) {
3508 if (in->wildcards & htonll(1ULL << p->mf12)) {
3509 out->wildcards |= htonl(p->wc10);
3512 out->max_entries = in->max_entries;
3513 out->active_count = in->active_count;
3514 put_32aligned_be64(&out->lookup_count, in->lookup_count);
3515 put_32aligned_be64(&out->matched_count, in->matched_count);
3519 oxm12_to_ofp11_flow_match_fields(ovs_be64 oxm12)
3522 enum ofp11_flow_match_fields fmf11;
3523 enum oxm12_ofb_match_fields mf12;
3526 static const struct map map[] = {
3527 { OFPFMF11_IN_PORT, OFPXMT12_OFB_IN_PORT },
3528 { OFPFMF11_DL_VLAN, OFPXMT12_OFB_VLAN_VID },
3529 { OFPFMF11_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP },
3530 { OFPFMF11_DL_TYPE, OFPXMT12_OFB_ETH_TYPE },
3531 { OFPFMF11_NW_TOS, OFPXMT12_OFB_IP_DSCP },
3532 { OFPFMF11_NW_PROTO, OFPXMT12_OFB_IP_PROTO },
3533 { OFPFMF11_TP_SRC, OFPXMT12_OFB_TCP_SRC },
3534 { OFPFMF11_TP_DST, OFPXMT12_OFB_TCP_DST },
3535 { OFPFMF11_MPLS_LABEL, OFPXMT12_OFB_MPLS_LABEL },
3536 { OFPFMF11_MPLS_TC, OFPXMT12_OFB_MPLS_TC },
3537 /* I don't know what OFPFMF11_TYPE means. */
3538 { OFPFMF11_DL_SRC, OFPXMT12_OFB_ETH_SRC },
3539 { OFPFMF11_DL_DST, OFPXMT12_OFB_ETH_DST },
3540 { OFPFMF11_NW_SRC, OFPXMT12_OFB_IPV4_SRC },
3541 { OFPFMF11_NW_DST, OFPXMT12_OFB_IPV4_DST },
3542 { OFPFMF11_METADATA, OFPXMT12_OFB_METADATA },
3545 const struct map *p;
3549 for (p = map; p < &map[ARRAY_SIZE(map)]; p++) {
3550 if (oxm12 & htonll(1ULL << p->mf12)) {
3554 return htonl(fmf11);
3558 ofputil_put_ofp11_table_stats(const struct ofp12_table_stats *in,
3561 struct ofp11_table_stats *out;
3563 out = ofpbuf_put_zeros(buf, sizeof *out);
3564 out->table_id = in->table_id;
3565 ovs_strlcpy(out->name, in->name, sizeof out->name);
3566 out->wildcards = oxm12_to_ofp11_flow_match_fields(in->wildcards);
3567 out->match = oxm12_to_ofp11_flow_match_fields(in->match);
3568 out->instructions = in->instructions;
3569 out->write_actions = in->write_actions;
3570 out->apply_actions = in->apply_actions;
3571 out->config = in->config;
3572 out->max_entries = in->max_entries;
3573 out->active_count = in->active_count;
3574 out->lookup_count = in->lookup_count;
3575 out->matched_count = in->matched_count;
3579 ofputil_put_ofp13_table_stats(const struct ofp12_table_stats *in,
3582 struct ofp13_table_stats *out;
3584 /* OF 1.3 splits table features off the ofp_table_stats,
3585 * so there is not much here. */
3587 out = ofpbuf_put_uninit(buf, sizeof *out);
3588 out->table_id = in->table_id;
3589 out->active_count = in->active_count;
3590 out->lookup_count = in->lookup_count;
3591 out->matched_count = in->matched_count;
3595 ofputil_encode_table_stats_reply(const struct ofp12_table_stats stats[], int n,
3596 const struct ofp_header *request)
3598 struct ofpbuf *reply;
3601 reply = ofpraw_alloc_stats_reply(request, n * sizeof *stats);
3603 switch ((enum ofp_version) request->version) {
3605 for (i = 0; i < n; i++) {
3606 ofputil_put_ofp10_table_stats(&stats[i], reply);
3611 for (i = 0; i < n; i++) {
3612 ofputil_put_ofp11_table_stats(&stats[i], reply);
3617 ofpbuf_put(reply, stats, n * sizeof *stats);
3621 for (i = 0; i < n; i++) {
3622 ofputil_put_ofp13_table_stats(&stats[i], reply);
3633 /* ofputil_flow_monitor_request */
3635 /* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract
3636 * ofputil_flow_monitor_request in 'rq'.
3638 * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow
3639 * message. Calling this function multiple times for a single 'msg' iterates
3640 * through the requests. The caller must initially leave 'msg''s layer
3641 * pointers null and not modify them between calls.
3643 * Returns 0 if successful, EOF if no requests were left in this 'msg',
3644 * otherwise an OFPERR_* value. */
3646 ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *rq,
3649 struct nx_flow_monitor_request *nfmr;
3653 msg->l2 = msg->data;
3654 ofpraw_pull_assert(msg);
3661 nfmr = ofpbuf_try_pull(msg, sizeof *nfmr);
3663 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR request has %zu "
3664 "leftover bytes at end", msg->size);
3665 return OFPERR_OFPBRC_BAD_LEN;
3668 flags = ntohs(nfmr->flags);
3669 if (!(flags & (NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY))
3670 || flags & ~(NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE
3671 | NXFMF_MODIFY | NXFMF_ACTIONS | NXFMF_OWN)) {
3672 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR has bad flags %#"PRIx16,
3674 return OFPERR_NXBRC_FM_BAD_FLAGS;
3677 if (!is_all_zeros(nfmr->zeros, sizeof nfmr->zeros)) {
3678 return OFPERR_NXBRC_MUST_BE_ZERO;
3681 rq->id = ntohl(nfmr->id);
3683 rq->out_port = ntohs(nfmr->out_port);
3684 rq->table_id = nfmr->table_id;
3686 return nx_pull_match(msg, ntohs(nfmr->match_len), &rq->match, NULL, NULL);
3690 ofputil_append_flow_monitor_request(
3691 const struct ofputil_flow_monitor_request *rq, struct ofpbuf *msg)
3693 struct nx_flow_monitor_request *nfmr;
3698 ofpraw_put(OFPRAW_NXST_FLOW_MONITOR_REQUEST, OFP10_VERSION, msg);
3701 start_ofs = msg->size;
3702 ofpbuf_put_zeros(msg, sizeof *nfmr);
3703 match_len = nx_put_match(msg, &rq->match, htonll(0), htonll(0));
3705 nfmr = ofpbuf_at_assert(msg, start_ofs, sizeof *nfmr);
3706 nfmr->id = htonl(rq->id);
3707 nfmr->flags = htons(rq->flags);
3708 nfmr->out_port = htons(rq->out_port);
3709 nfmr->match_len = htons(match_len);
3710 nfmr->table_id = rq->table_id;
3713 /* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg'
3714 * into an abstract ofputil_flow_update in 'update'. The caller must have
3715 * initialized update->match to point to space allocated for a match.
3717 * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's
3718 * actions (except for NXFME_ABBREV, which never includes actions). The caller
3719 * must initialize 'ofpacts' and retains ownership of it. 'update->ofpacts'
3720 * will point into the 'ofpacts' buffer.
3722 * Multiple flow updates can be packed into a single OpenFlow message. Calling
3723 * this function multiple times for a single 'msg' iterates through the
3724 * updates. The caller must initially leave 'msg''s layer pointers null and
3725 * not modify them between calls.
3727 * Returns 0 if successful, EOF if no updates were left in this 'msg',
3728 * otherwise an OFPERR_* value. */
3730 ofputil_decode_flow_update(struct ofputil_flow_update *update,
3731 struct ofpbuf *msg, struct ofpbuf *ofpacts)
3733 struct nx_flow_update_header *nfuh;
3734 unsigned int length;
3737 msg->l2 = msg->data;
3738 ofpraw_pull_assert(msg);
3745 if (msg->size < sizeof(struct nx_flow_update_header)) {
3750 update->event = ntohs(nfuh->event);
3751 length = ntohs(nfuh->length);
3752 if (length > msg->size || length % 8) {
3756 if (update->event == NXFME_ABBREV) {
3757 struct nx_flow_update_abbrev *nfua;
3759 if (length != sizeof *nfua) {
3763 nfua = ofpbuf_pull(msg, sizeof *nfua);
3764 update->xid = nfua->xid;
3766 } else if (update->event == NXFME_ADDED
3767 || update->event == NXFME_DELETED
3768 || update->event == NXFME_MODIFIED) {
3769 struct nx_flow_update_full *nfuf;
3770 unsigned int actions_len;
3771 unsigned int match_len;
3774 if (length < sizeof *nfuf) {
3778 nfuf = ofpbuf_pull(msg, sizeof *nfuf);
3779 match_len = ntohs(nfuf->match_len);
3780 if (sizeof *nfuf + match_len > length) {
3784 update->reason = ntohs(nfuf->reason);
3785 update->idle_timeout = ntohs(nfuf->idle_timeout);
3786 update->hard_timeout = ntohs(nfuf->hard_timeout);
3787 update->table_id = nfuf->table_id;
3788 update->cookie = nfuf->cookie;
3789 update->priority = ntohs(nfuf->priority);
3791 error = nx_pull_match(msg, match_len, update->match, NULL, NULL);
3796 actions_len = length - sizeof *nfuf - ROUND_UP(match_len, 8);
3797 error = ofpacts_pull_openflow10(msg, actions_len, ofpacts);
3802 update->ofpacts = ofpacts->data;
3803 update->ofpacts_len = ofpacts->size;
3806 VLOG_WARN_RL(&bad_ofmsg_rl,
3807 "NXST_FLOW_MONITOR reply has bad event %"PRIu16,
3808 ntohs(nfuh->event));
3809 return OFPERR_NXBRC_FM_BAD_EVENT;
3813 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR reply has %zu "
3814 "leftover bytes at end", msg->size);
3815 return OFPERR_OFPBRC_BAD_LEN;
3819 ofputil_decode_flow_monitor_cancel(const struct ofp_header *oh)
3821 const struct nx_flow_monitor_cancel *cancel = ofpmsg_body(oh);
3823 return ntohl(cancel->id);
3827 ofputil_encode_flow_monitor_cancel(uint32_t id)
3829 struct nx_flow_monitor_cancel *nfmc;
3832 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MONITOR_CANCEL, OFP10_VERSION, 0);
3833 nfmc = ofpbuf_put_uninit(msg, sizeof *nfmc);
3834 nfmc->id = htonl(id);
3839 ofputil_start_flow_update(struct list *replies)
3843 msg = ofpraw_alloc_xid(OFPRAW_NXST_FLOW_MONITOR_REPLY, OFP10_VERSION,
3847 list_push_back(replies, &msg->list_node);
3851 ofputil_append_flow_update(const struct ofputil_flow_update *update,
3852 struct list *replies)
3854 struct nx_flow_update_header *nfuh;
3858 msg = ofpbuf_from_list(list_back(replies));
3859 start_ofs = msg->size;
3861 if (update->event == NXFME_ABBREV) {
3862 struct nx_flow_update_abbrev *nfua;
3864 nfua = ofpbuf_put_zeros(msg, sizeof *nfua);
3865 nfua->xid = update->xid;
3867 struct nx_flow_update_full *nfuf;
3870 ofpbuf_put_zeros(msg, sizeof *nfuf);
3871 match_len = nx_put_match(msg, update->match, htonll(0), htonll(0));
3872 ofpacts_put_openflow10(update->ofpacts, update->ofpacts_len, msg);
3874 nfuf = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuf);
3875 nfuf->reason = htons(update->reason);
3876 nfuf->priority = htons(update->priority);
3877 nfuf->idle_timeout = htons(update->idle_timeout);
3878 nfuf->hard_timeout = htons(update->hard_timeout);
3879 nfuf->match_len = htons(match_len);
3880 nfuf->table_id = update->table_id;
3881 nfuf->cookie = update->cookie;
3884 nfuh = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuh);
3885 nfuh->length = htons(msg->size - start_ofs);
3886 nfuh->event = htons(update->event);
3888 ofpmp_postappend(replies, start_ofs);
3892 ofputil_encode_packet_out(const struct ofputil_packet_out *po,
3893 enum ofputil_protocol protocol)
3895 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
3899 size = po->ofpacts_len;
3900 if (po->buffer_id == UINT32_MAX) {
3901 size += po->packet_len;
3904 switch (ofp_version) {
3905 case OFP10_VERSION: {
3906 struct ofp10_packet_out *opo;
3909 msg = ofpraw_alloc(OFPRAW_OFPT10_PACKET_OUT, OFP10_VERSION, size);
3910 ofpbuf_put_zeros(msg, sizeof *opo);
3911 actions_ofs = msg->size;
3912 ofpacts_put_openflow10(po->ofpacts, po->ofpacts_len, msg);
3915 opo->buffer_id = htonl(po->buffer_id);
3916 opo->in_port = htons(po->in_port);
3917 opo->actions_len = htons(msg->size - actions_ofs);
3923 case OFP13_VERSION: {
3924 struct ofp11_packet_out *opo;
3927 msg = ofpraw_alloc(OFPRAW_OFPT11_PACKET_OUT, ofp_version, size);
3928 ofpbuf_put_zeros(msg, sizeof *opo);
3929 len = ofpacts_put_openflow11_actions(po->ofpacts, po->ofpacts_len, msg);
3932 opo->buffer_id = htonl(po->buffer_id);
3933 opo->in_port = ofputil_port_to_ofp11(po->in_port);
3934 opo->actions_len = htons(len);
3942 if (po->buffer_id == UINT32_MAX) {
3943 ofpbuf_put(msg, po->packet, po->packet_len);
3946 ofpmsg_update_length(msg);
3951 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
3953 make_echo_request(enum ofp_version ofp_version)
3955 return ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST, ofp_version,
3959 /* Creates and returns an OFPT_ECHO_REPLY message matching the
3960 * OFPT_ECHO_REQUEST message in 'rq'. */
3962 make_echo_reply(const struct ofp_header *rq)
3964 struct ofpbuf rq_buf;
3965 struct ofpbuf *reply;
3967 ofpbuf_use_const(&rq_buf, rq, ntohs(rq->length));
3968 ofpraw_pull_assert(&rq_buf);
3970 reply = ofpraw_alloc_reply(OFPRAW_OFPT_ECHO_REPLY, rq, rq_buf.size);
3971 ofpbuf_put(reply, rq_buf.data, rq_buf.size);
3976 ofputil_encode_barrier_request(enum ofp_version ofp_version)
3980 switch (ofp_version) {
3984 type = OFPRAW_OFPT11_BARRIER_REQUEST;
3988 type = OFPRAW_OFPT10_BARRIER_REQUEST;
3995 return ofpraw_alloc(type, ofp_version, 0);
3999 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
4001 switch (flags & OFPC_FRAG_MASK) {
4002 case OFPC_FRAG_NORMAL: return "normal";
4003 case OFPC_FRAG_DROP: return "drop";
4004 case OFPC_FRAG_REASM: return "reassemble";
4005 case OFPC_FRAG_NX_MATCH: return "nx-match";
4012 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
4014 if (!strcasecmp(s, "normal")) {
4015 *flags = OFPC_FRAG_NORMAL;
4016 } else if (!strcasecmp(s, "drop")) {
4017 *flags = OFPC_FRAG_DROP;
4018 } else if (!strcasecmp(s, "reassemble")) {
4019 *flags = OFPC_FRAG_REASM;
4020 } else if (!strcasecmp(s, "nx-match")) {
4021 *flags = OFPC_FRAG_NX_MATCH;
4028 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
4029 * port number and stores the latter in '*ofp10_port', for the purpose of
4030 * decoding OpenFlow 1.1+ protocol messages. Returns 0 if successful,
4031 * otherwise an OFPERR_* number.
4033 * See the definition of OFP11_MAX for an explanation of the mapping. */
4035 ofputil_port_from_ofp11(ovs_be32 ofp11_port, uint16_t *ofp10_port)
4037 uint32_t ofp11_port_h = ntohl(ofp11_port);
4039 if (ofp11_port_h < OFPP_MAX) {
4040 *ofp10_port = ofp11_port_h;
4042 } else if (ofp11_port_h >= OFPP11_MAX) {
4043 *ofp10_port = ofp11_port_h - OFPP11_OFFSET;
4046 VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
4047 "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
4048 ofp11_port_h, OFPP_MAX - 1,
4049 (uint32_t) OFPP11_MAX, UINT32_MAX);
4050 return OFPERR_OFPBAC_BAD_OUT_PORT;
4054 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
4055 * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
4057 * See the definition of OFP11_MAX for an explanation of the mapping. */
4059 ofputil_port_to_ofp11(uint16_t ofp10_port)
4061 return htonl(ofp10_port < OFPP_MAX
4063 : ofp10_port + OFPP11_OFFSET);
4066 /* Checks that 'port' is a valid output port for the OFPAT10_OUTPUT action, given
4067 * that the switch will never have more than 'max_ports' ports. Returns 0 if
4068 * 'port' is valid, otherwise an OpenFlow return code. */
4070 ofputil_check_output_port(uint16_t port, int max_ports)
4078 case OFPP_CONTROLLER:
4084 if (port < max_ports) {
4087 return OFPERR_OFPBAC_BAD_OUT_PORT;
4091 #define OFPUTIL_NAMED_PORTS \
4092 OFPUTIL_NAMED_PORT(IN_PORT) \
4093 OFPUTIL_NAMED_PORT(TABLE) \
4094 OFPUTIL_NAMED_PORT(NORMAL) \
4095 OFPUTIL_NAMED_PORT(FLOOD) \
4096 OFPUTIL_NAMED_PORT(ALL) \
4097 OFPUTIL_NAMED_PORT(CONTROLLER) \
4098 OFPUTIL_NAMED_PORT(LOCAL) \
4099 OFPUTIL_NAMED_PORT(ANY)
4101 /* For backwards compatibility, so that "none" is recognized as OFPP_ANY */
4102 #define OFPUTIL_NAMED_PORTS_WITH_NONE \
4103 OFPUTIL_NAMED_PORTS \
4104 OFPUTIL_NAMED_PORT(NONE)
4106 /* Stores the port number represented by 's' into '*portp'. 's' may be an
4107 * integer or, for reserved ports, the standard OpenFlow name for the port
4110 * Returns true if successful, false if 's' is not a valid OpenFlow port number
4111 * or name. The caller should issue an error message in this case, because
4112 * this function usually does not. (This gives the caller an opportunity to
4113 * look up the port name another way, e.g. by contacting the switch and listing
4114 * the names of all its ports).
4116 * This function accepts OpenFlow 1.0 port numbers. It also accepts a subset
4117 * of OpenFlow 1.1+ port numbers, mapping those port numbers into the 16-bit
4118 * range as described in include/openflow/openflow-1.1.h. */
4120 ofputil_port_from_string(const char *s, uint16_t *portp)
4122 unsigned int port32;
4125 if (str_to_uint(s, 10, &port32)) {
4126 if (port32 < OFPP_MAX) {
4129 } else if (port32 < OFPP_FIRST_RESV) {
4130 VLOG_WARN("port %u is a reserved OF1.0 port number that will "
4131 "be translated to %u when talking to an OF1.1 or "
4132 "later controller", port32, port32 + OFPP11_OFFSET);
4135 } else if (port32 <= OFPP_LAST_RESV) {
4139 ofputil_format_port(port32, &msg);
4140 VLOG_WARN_ONCE("referring to port %s as %u is deprecated for "
4141 "compatibility with future versions of OpenFlow",
4142 ds_cstr(&msg), port32);
4147 } else if (port32 < OFPP11_MAX) {
4148 VLOG_WARN("port %u is outside the supported range 0 through "
4149 "%"PRIx16" or 0x%x through 0x%"PRIx32, port32,
4150 UINT16_MAX, (unsigned int) OFPP11_MAX, UINT32_MAX);
4153 *portp = port32 - OFPP11_OFFSET;
4161 static const struct pair pairs[] = {
4162 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
4163 OFPUTIL_NAMED_PORTS_WITH_NONE
4164 #undef OFPUTIL_NAMED_PORT
4166 const struct pair *p;
4168 for (p = pairs; p < &pairs[ARRAY_SIZE(pairs)]; p++) {
4169 if (!strcasecmp(s, p->name)) {
4178 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
4179 * Most ports' string representation is just the port number, but for special
4180 * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
4182 ofputil_format_port(uint16_t port, struct ds *s)
4187 #define OFPUTIL_NAMED_PORT(NAME) case OFPP_##NAME: name = #NAME; break;
4189 #undef OFPUTIL_NAMED_PORT
4192 ds_put_format(s, "%"PRIu16, port);
4195 ds_put_cstr(s, name);
4198 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
4199 * 'ofp_version', tries to pull the first element from the array. If
4200 * successful, initializes '*pp' with an abstract representation of the
4201 * port and returns 0. If no ports remain to be decoded, returns EOF.
4202 * On an error, returns a positive OFPERR_* value. */
4204 ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *b,
4205 struct ofputil_phy_port *pp)
4207 switch (ofp_version) {
4208 case OFP10_VERSION: {
4209 const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
4210 return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
4214 case OFP13_VERSION: {
4215 const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
4216 return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
4223 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
4224 * 'ofp_version', returns the number of elements. */
4225 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *b)
4227 return b->size / ofputil_get_phy_port_size(ofp_version);
4230 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
4231 * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1 if
4232 * 'name' is not the name of any action.
4234 * ofp-util.def lists the mapping from names to action. */
4236 ofputil_action_code_from_name(const char *name)
4238 static const char *names[OFPUTIL_N_ACTIONS] = {
4240 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) NAME,
4241 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
4242 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
4243 #include "ofp-util.def"
4248 for (p = names; p < &names[ARRAY_SIZE(names)]; p++) {
4249 if (*p && !strcasecmp(name, *p)) {
4256 /* Appends an action of the type specified by 'code' to 'buf' and returns the
4257 * action. Initializes the parts of 'action' that identify it as having type
4258 * <ENUM> and length 'sizeof *action' and zeros the rest. For actions that
4259 * have variable length, the length used and cleared is that of struct
4262 ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
4265 case OFPUTIL_ACTION_INVALID:
4268 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
4269 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
4270 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
4271 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
4272 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
4273 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
4274 #include "ofp-util.def"
4279 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
4281 ofputil_init_##ENUM(struct STRUCT *s) \
4283 memset(s, 0, sizeof *s); \
4284 s->type = htons(ENUM); \
4285 s->len = htons(sizeof *s); \
4289 ofputil_put_##ENUM(struct ofpbuf *buf) \
4291 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
4292 ofputil_init_##ENUM(s); \
4295 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
4296 OFPAT10_ACTION(ENUM, STRUCT, NAME)
4297 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
4299 ofputil_init_##ENUM(struct STRUCT *s) \
4301 memset(s, 0, sizeof *s); \
4302 s->type = htons(OFPAT10_VENDOR); \
4303 s->len = htons(sizeof *s); \
4304 s->vendor = htonl(NX_VENDOR_ID); \
4305 s->subtype = htons(ENUM); \
4309 ofputil_put_##ENUM(struct ofpbuf *buf) \
4311 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
4312 ofputil_init_##ENUM(s); \
4315 #include "ofp-util.def"
4318 ofputil_normalize_match__(struct match *match, bool may_log)
4321 MAY_NW_ADDR = 1 << 0, /* nw_src, nw_dst */
4322 MAY_TP_ADDR = 1 << 1, /* tp_src, tp_dst */
4323 MAY_NW_PROTO = 1 << 2, /* nw_proto */
4324 MAY_IPVx = 1 << 3, /* tos, frag, ttl */
4325 MAY_ARP_SHA = 1 << 4, /* arp_sha */
4326 MAY_ARP_THA = 1 << 5, /* arp_tha */
4327 MAY_IPV6 = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
4328 MAY_ND_TARGET = 1 << 7, /* nd_target */
4329 MAY_MPLS = 1 << 8, /* mpls label and tc */
4332 struct flow_wildcards wc;
4334 /* Figure out what fields may be matched. */
4335 if (match->flow.dl_type == htons(ETH_TYPE_IP)) {
4336 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
4337 if (match->flow.nw_proto == IPPROTO_TCP ||
4338 match->flow.nw_proto == IPPROTO_UDP ||
4339 match->flow.nw_proto == IPPROTO_ICMP) {
4340 may_match |= MAY_TP_ADDR;
4342 } else if (match->flow.dl_type == htons(ETH_TYPE_IPV6)) {
4343 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
4344 if (match->flow.nw_proto == IPPROTO_TCP ||
4345 match->flow.nw_proto == IPPROTO_UDP) {
4346 may_match |= MAY_TP_ADDR;
4347 } else if (match->flow.nw_proto == IPPROTO_ICMPV6) {
4348 may_match |= MAY_TP_ADDR;
4349 if (match->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
4350 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
4351 } else if (match->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
4352 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
4355 } else if (match->flow.dl_type == htons(ETH_TYPE_ARP) ||
4356 match->flow.dl_type == htons(ETH_TYPE_RARP)) {
4357 may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
4358 } else if (eth_type_mpls(match->flow.dl_type)) {
4359 may_match = MAY_MPLS;
4364 /* Clear the fields that may not be matched. */
4366 if (!(may_match & MAY_NW_ADDR)) {
4367 wc.masks.nw_src = wc.masks.nw_dst = htonl(0);
4369 if (!(may_match & MAY_TP_ADDR)) {
4370 wc.masks.tp_src = wc.masks.tp_dst = htons(0);
4372 if (!(may_match & MAY_NW_PROTO)) {
4373 wc.masks.nw_proto = 0;
4375 if (!(may_match & MAY_IPVx)) {
4376 wc.masks.nw_tos = 0;
4377 wc.masks.nw_ttl = 0;
4379 if (!(may_match & MAY_ARP_SHA)) {
4380 memset(wc.masks.arp_sha, 0, ETH_ADDR_LEN);
4382 if (!(may_match & MAY_ARP_THA)) {
4383 memset(wc.masks.arp_tha, 0, ETH_ADDR_LEN);
4385 if (!(may_match & MAY_IPV6)) {
4386 wc.masks.ipv6_src = wc.masks.ipv6_dst = in6addr_any;
4387 wc.masks.ipv6_label = htonl(0);
4389 if (!(may_match & MAY_ND_TARGET)) {
4390 wc.masks.nd_target = in6addr_any;
4392 if (!(may_match & MAY_MPLS)) {
4393 wc.masks.mpls_lse = htonl(0);
4394 wc.masks.mpls_depth = 0;
4397 /* Log any changes. */
4398 if (!flow_wildcards_equal(&wc, &match->wc)) {
4399 bool log = may_log && !VLOG_DROP_INFO(&bad_ofmsg_rl);
4400 char *pre = log ? match_to_string(match, OFP_DEFAULT_PRIORITY) : NULL;
4403 match_zero_wildcarded_fields(match);
4406 char *post = match_to_string(match, OFP_DEFAULT_PRIORITY);
4407 VLOG_INFO("normalization changed ofp_match, details:");
4408 VLOG_INFO(" pre: %s", pre);
4409 VLOG_INFO("post: %s", post);
4416 /* "Normalizes" the wildcards in 'match'. That means:
4418 * 1. If the type of level N is known, then only the valid fields for that
4419 * level may be specified. For example, ARP does not have a TOS field,
4420 * so nw_tos must be wildcarded if 'match' specifies an ARP flow.
4421 * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
4422 * ipv6_dst (and other fields) must be wildcarded if 'match' specifies an
4425 * 2. If the type of level N is not known (or not understood by Open
4426 * vSwitch), then no fields at all for that level may be specified. For
4427 * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
4428 * L4 fields tp_src and tp_dst must be wildcarded if 'match' specifies an
4431 * If this function changes 'match', it logs a rate-limited informational
4434 ofputil_normalize_match(struct match *match)
4436 ofputil_normalize_match__(match, true);
4439 /* Same as ofputil_normalize_match() without the logging. Thus, this function
4440 * is suitable for a program's internal use, whereas ofputil_normalize_match()
4441 * sense for use on flows received from elsewhere (so that a bug in the program
4442 * that sent them can be reported and corrected). */
4444 ofputil_normalize_match_quiet(struct match *match)
4446 ofputil_normalize_match__(match, false);
4449 /* Parses a key or a key-value pair from '*stringp'.
4451 * On success: Stores the key into '*keyp'. Stores the value, if present, into
4452 * '*valuep', otherwise an empty string. Advances '*stringp' past the end of
4453 * the key-value pair, preparing it for another call. '*keyp' and '*valuep'
4454 * are substrings of '*stringp' created by replacing some of its bytes by null
4455 * terminators. Returns true.
4457 * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
4458 * NULL and returns false. */
4460 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
4462 char *pos, *key, *value;
4466 pos += strspn(pos, ", \t\r\n");
4468 *keyp = *valuep = NULL;
4473 key_len = strcspn(pos, ":=(, \t\r\n");
4474 if (key[key_len] == ':' || key[key_len] == '=') {
4475 /* The value can be separated by a colon. */
4478 value = key + key_len + 1;
4479 value_len = strcspn(value, ", \t\r\n");
4480 pos = value + value_len + (value[value_len] != '\0');
4481 value[value_len] = '\0';
4482 } else if (key[key_len] == '(') {
4483 /* The value can be surrounded by balanced parentheses. The outermost
4484 * set of parentheses is removed. */
4488 value = key + key_len + 1;
4489 for (value_len = 0; level > 0; value_len++) {
4490 switch (value[value_len]) {
4504 value[value_len - 1] = '\0';
4505 pos = value + value_len;
4507 /* There might be no value at all. */
4508 value = key + key_len; /* Will become the empty string below. */
4509 pos = key + key_len + (key[key_len] != '\0');
4511 key[key_len] = '\0';
4519 /* Encode a dump ports request for 'port', the encoded message
4520 * will be for Open Flow version 'ofp_version'. Returns message
4521 * as a struct ofpbuf. Returns encoded message on success, NULL on error */
4523 ofputil_encode_dump_ports_request(enum ofp_version ofp_version, int16_t port)
4525 struct ofpbuf *request;
4527 switch (ofp_version) {
4528 case OFP10_VERSION: {
4529 struct ofp10_port_stats_request *req;
4530 request = ofpraw_alloc(OFPRAW_OFPST10_PORT_REQUEST, ofp_version, 0);
4531 req = ofpbuf_put_zeros(request, sizeof *req);
4532 req->port_no = htons(port);
4537 case OFP13_VERSION: {
4538 struct ofp11_port_stats_request *req;
4539 request = ofpraw_alloc(OFPRAW_OFPST11_PORT_REQUEST, ofp_version, 0);
4540 req = ofpbuf_put_zeros(request, sizeof *req);
4541 req->port_no = ofputil_port_to_ofp11(port);
4552 ofputil_port_stats_to_ofp10(const struct ofputil_port_stats *ops,
4553 struct ofp10_port_stats *ps10)
4555 ps10->port_no = htons(ops->port_no);
4556 memset(ps10->pad, 0, sizeof ps10->pad);
4557 put_32aligned_be64(&ps10->rx_packets, htonll(ops->stats.rx_packets));
4558 put_32aligned_be64(&ps10->tx_packets, htonll(ops->stats.tx_packets));
4559 put_32aligned_be64(&ps10->rx_bytes, htonll(ops->stats.rx_bytes));
4560 put_32aligned_be64(&ps10->tx_bytes, htonll(ops->stats.tx_bytes));
4561 put_32aligned_be64(&ps10->rx_dropped, htonll(ops->stats.rx_dropped));
4562 put_32aligned_be64(&ps10->tx_dropped, htonll(ops->stats.tx_dropped));
4563 put_32aligned_be64(&ps10->rx_errors, htonll(ops->stats.rx_errors));
4564 put_32aligned_be64(&ps10->tx_errors, htonll(ops->stats.tx_errors));
4565 put_32aligned_be64(&ps10->rx_frame_err, htonll(ops->stats.rx_frame_errors));
4566 put_32aligned_be64(&ps10->rx_over_err, htonll(ops->stats.rx_over_errors));
4567 put_32aligned_be64(&ps10->rx_crc_err, htonll(ops->stats.rx_crc_errors));
4568 put_32aligned_be64(&ps10->collisions, htonll(ops->stats.collisions));
4572 ofputil_port_stats_to_ofp11(const struct ofputil_port_stats *ops,
4573 struct ofp11_port_stats *ps11)
4575 ps11->port_no = ofputil_port_to_ofp11(ops->port_no);
4576 memset(ps11->pad, 0, sizeof ps11->pad);
4577 ps11->rx_packets = htonll(ops->stats.rx_packets);
4578 ps11->tx_packets = htonll(ops->stats.tx_packets);
4579 ps11->rx_bytes = htonll(ops->stats.rx_bytes);
4580 ps11->tx_bytes = htonll(ops->stats.tx_bytes);
4581 ps11->rx_dropped = htonll(ops->stats.rx_dropped);
4582 ps11->tx_dropped = htonll(ops->stats.tx_dropped);
4583 ps11->rx_errors = htonll(ops->stats.rx_errors);
4584 ps11->tx_errors = htonll(ops->stats.tx_errors);
4585 ps11->rx_frame_err = htonll(ops->stats.rx_frame_errors);
4586 ps11->rx_over_err = htonll(ops->stats.rx_over_errors);
4587 ps11->rx_crc_err = htonll(ops->stats.rx_crc_errors);
4588 ps11->collisions = htonll(ops->stats.collisions);
4592 ofputil_port_stats_to_ofp13(const struct ofputil_port_stats *ops,
4593 struct ofp13_port_stats *ps13)
4595 ofputil_port_stats_to_ofp11(ops, &ps13->ps);
4597 /* OF 1.3 adds duration fields */
4598 /* FIXME: Need to implement port alive duration (sec + nsec) */
4599 ps13->duration_sec = htonl(~0);
4600 ps13->duration_nsec = htonl(~0);
4604 /* Encode a ports stat for 'ops' and append it to 'replies'. */
4606 ofputil_append_port_stat(struct list *replies,
4607 const struct ofputil_port_stats *ops)
4609 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
4610 struct ofp_header *oh = msg->data;
4612 switch ((enum ofp_version)oh->version) {
4613 case OFP13_VERSION: {
4614 struct ofp13_port_stats *reply = ofpmp_append(replies, sizeof *reply);
4615 ofputil_port_stats_to_ofp13(ops, reply);
4619 case OFP11_VERSION: {
4620 struct ofp11_port_stats *reply = ofpmp_append(replies, sizeof *reply);
4621 ofputil_port_stats_to_ofp11(ops, reply);
4625 case OFP10_VERSION: {
4626 struct ofp10_port_stats *reply = ofpmp_append(replies, sizeof *reply);
4627 ofputil_port_stats_to_ofp10(ops, reply);
4637 ofputil_port_stats_from_ofp10(struct ofputil_port_stats *ops,
4638 const struct ofp10_port_stats *ps10)
4640 memset(ops, 0, sizeof *ops);
4642 ops->port_no = ntohs(ps10->port_no);
4643 ops->stats.rx_packets = ntohll(get_32aligned_be64(&ps10->rx_packets));
4644 ops->stats.tx_packets = ntohll(get_32aligned_be64(&ps10->tx_packets));
4645 ops->stats.rx_bytes = ntohll(get_32aligned_be64(&ps10->rx_bytes));
4646 ops->stats.tx_bytes = ntohll(get_32aligned_be64(&ps10->tx_bytes));
4647 ops->stats.rx_dropped = ntohll(get_32aligned_be64(&ps10->rx_dropped));
4648 ops->stats.tx_dropped = ntohll(get_32aligned_be64(&ps10->tx_dropped));
4649 ops->stats.rx_errors = ntohll(get_32aligned_be64(&ps10->rx_errors));
4650 ops->stats.tx_errors = ntohll(get_32aligned_be64(&ps10->tx_errors));
4651 ops->stats.rx_frame_errors =
4652 ntohll(get_32aligned_be64(&ps10->rx_frame_err));
4653 ops->stats.rx_over_errors = ntohll(get_32aligned_be64(&ps10->rx_over_err));
4654 ops->stats.rx_crc_errors = ntohll(get_32aligned_be64(&ps10->rx_crc_err));
4655 ops->stats.collisions = ntohll(get_32aligned_be64(&ps10->collisions));
4661 ofputil_port_stats_from_ofp11(struct ofputil_port_stats *ops,
4662 const struct ofp11_port_stats *ps11)
4666 memset(ops, 0, sizeof *ops);
4667 error = ofputil_port_from_ofp11(ps11->port_no, &ops->port_no);
4672 ops->stats.rx_packets = ntohll(ps11->rx_packets);
4673 ops->stats.tx_packets = ntohll(ps11->tx_packets);
4674 ops->stats.rx_bytes = ntohll(ps11->rx_bytes);
4675 ops->stats.tx_bytes = ntohll(ps11->tx_bytes);
4676 ops->stats.rx_dropped = ntohll(ps11->rx_dropped);
4677 ops->stats.tx_dropped = ntohll(ps11->tx_dropped);
4678 ops->stats.rx_errors = ntohll(ps11->rx_errors);
4679 ops->stats.tx_errors = ntohll(ps11->tx_errors);
4680 ops->stats.rx_frame_errors = ntohll(ps11->rx_frame_err);
4681 ops->stats.rx_over_errors = ntohll(ps11->rx_over_err);
4682 ops->stats.rx_crc_errors = ntohll(ps11->rx_crc_err);
4683 ops->stats.collisions = ntohll(ps11->collisions);
4689 ofputil_port_stats_from_ofp13(struct ofputil_port_stats *ops,
4690 const struct ofp13_port_stats *ps13)
4693 ofputil_port_stats_from_ofp11(ops, &ps13->ps);
4695 /* FIXME: Get ps13->duration_sec and ps13->duration_nsec,
4696 * Add to netdev_stats? */
4703 /* Returns the number of port stats elements in OFPTYPE_PORT_STATS_REPLY
4706 ofputil_count_port_stats(const struct ofp_header *oh)
4710 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4711 ofpraw_pull_assert(&b);
4713 BUILD_ASSERT(sizeof(struct ofp10_port_stats) ==
4714 sizeof(struct ofp11_port_stats));
4715 return b.size / sizeof(struct ofp10_port_stats);
4718 /* Converts an OFPST_PORT_STATS reply in 'msg' into an abstract
4719 * ofputil_port_stats in 'ps'.
4721 * Multiple OFPST_PORT_STATS replies can be packed into a single OpenFlow
4722 * message. Calling this function multiple times for a single 'msg' iterates
4723 * through the replies. The caller must initially leave 'msg''s layer pointers
4724 * null and not modify them between calls.
4726 * Returns 0 if successful, EOF if no replies were left in this 'msg',
4727 * otherwise a positive errno value. */
4729 ofputil_decode_port_stats(struct ofputil_port_stats *ps, struct ofpbuf *msg)
4735 ? ofpraw_decode(&raw, msg->l2)
4736 : ofpraw_pull(&raw, msg));
4743 } else if (raw == OFPRAW_OFPST13_PORT_REPLY) {
4744 const struct ofp13_port_stats *ps13;
4746 ps13 = ofpbuf_try_pull(msg, sizeof *ps13);
4750 return ofputil_port_stats_from_ofp13(ps, ps13);
4751 } else if (raw == OFPRAW_OFPST11_PORT_REPLY) {
4752 const struct ofp11_port_stats *ps11;
4754 ps11 = ofpbuf_try_pull(msg, sizeof *ps11);
4758 return ofputil_port_stats_from_ofp11(ps, ps11);
4759 } else if (raw == OFPRAW_OFPST10_PORT_REPLY) {
4760 const struct ofp10_port_stats *ps10;
4762 ps10 = ofpbuf_try_pull(msg, sizeof *ps10);
4766 return ofputil_port_stats_from_ofp10(ps, ps10);
4772 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_PORT reply has %zu leftover "
4773 "bytes at end", msg->size);
4774 return OFPERR_OFPBRC_BAD_LEN;
4777 /* Parse a port status request message into a 16 bit OpenFlow 1.0
4778 * port number and stores the latter in '*ofp10_port'.
4779 * Returns 0 if successful, otherwise an OFPERR_* number. */
4781 ofputil_decode_port_stats_request(const struct ofp_header *request,
4782 uint16_t *ofp10_port)
4784 switch ((enum ofp_version)request->version) {
4787 case OFP11_VERSION: {
4788 const struct ofp11_port_stats_request *psr11 = ofpmsg_body(request);
4789 return ofputil_port_from_ofp11(psr11->port_no, ofp10_port);
4792 case OFP10_VERSION: {
4793 const struct ofp10_port_stats_request *psr10 = ofpmsg_body(request);
4794 *ofp10_port = ntohs(psr10->port_no);
4803 /* Parse a queue status request message into 'oqsr'.
4804 * Returns 0 if successful, otherwise an OFPERR_* number. */
4806 ofputil_decode_queue_stats_request(const struct ofp_header *request,
4807 struct ofputil_queue_stats_request *oqsr)
4809 switch ((enum ofp_version)request->version) {
4812 case OFP11_VERSION: {
4813 const struct ofp11_queue_stats_request *qsr11 = ofpmsg_body(request);
4814 oqsr->queue_id = ntohl(qsr11->queue_id);
4815 return ofputil_port_from_ofp11(qsr11->port_no, &oqsr->port_no);
4818 case OFP10_VERSION: {
4819 const struct ofp10_queue_stats_request *qsr10 = ofpmsg_body(request);
4820 oqsr->queue_id = ntohl(qsr10->queue_id);
4821 oqsr->port_no = ntohs(qsr10->port_no);
4822 /* OF 1.0 uses OFPP_ALL for OFPP_ANY */
4823 if (oqsr->port_no == OFPP_ALL) {
4824 oqsr->port_no = OFPP_ANY;
4834 /* Encode a queue statsrequest for 'oqsr', the encoded message
4835 * will be fore Open Flow version 'ofp_version'. Returns message
4836 * as a struct ofpbuf. Returns encoded message on success, NULL on error */
4838 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
4839 const struct ofputil_queue_stats_request *oqsr)
4841 struct ofpbuf *request;
4843 switch (ofp_version) {
4846 case OFP13_VERSION: {
4847 struct ofp11_queue_stats_request *req;
4848 request = ofpraw_alloc(OFPRAW_OFPST11_QUEUE_REQUEST, ofp_version, 0);
4849 req = ofpbuf_put_zeros(request, sizeof *req);
4850 req->port_no = ofputil_port_to_ofp11(oqsr->port_no);
4851 req->queue_id = htonl(oqsr->queue_id);
4854 case OFP10_VERSION: {
4855 struct ofp10_queue_stats_request *req;
4856 request = ofpraw_alloc(OFPRAW_OFPST10_QUEUE_REQUEST, ofp_version, 0);
4857 req = ofpbuf_put_zeros(request, sizeof *req);
4858 /* OpenFlow 1.0 needs OFPP_ALL instead of OFPP_ANY */
4859 req->port_no = htons(oqsr->port_no == OFPP_ANY
4860 ? OFPP_ALL : oqsr->port_no);
4861 req->queue_id = htonl(oqsr->queue_id);
4871 /* Returns the number of queue stats elements in OFPTYPE_QUEUE_STATS_REPLY
4874 ofputil_count_queue_stats(const struct ofp_header *oh)
4878 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4879 ofpraw_pull_assert(&b);
4881 BUILD_ASSERT(sizeof(struct ofp10_queue_stats) ==
4882 sizeof(struct ofp11_queue_stats));
4883 return b.size / sizeof(struct ofp10_queue_stats);
4887 ofputil_queue_stats_from_ofp10(struct ofputil_queue_stats *oqs,
4888 const struct ofp10_queue_stats *qs10)
4890 oqs->port_no = ntohs(qs10->port_no);
4891 oqs->queue_id = ntohl(qs10->queue_id);
4892 oqs->stats.tx_bytes = ntohll(get_32aligned_be64(&qs10->tx_bytes));
4893 oqs->stats.tx_packets = ntohll(get_32aligned_be64(&qs10->tx_packets));
4894 oqs->stats.tx_errors = ntohll(get_32aligned_be64(&qs10->tx_errors));
4900 ofputil_queue_stats_from_ofp11(struct ofputil_queue_stats *oqs,
4901 const struct ofp11_queue_stats *qs11)
4905 error = ofputil_port_from_ofp11(qs11->port_no, &oqs->port_no);
4910 oqs->queue_id = ntohl(qs11->queue_id);
4911 oqs->stats.tx_bytes = ntohll(qs11->tx_bytes);
4912 oqs->stats.tx_packets = ntohll(qs11->tx_packets);
4913 oqs->stats.tx_errors = ntohll(qs11->tx_errors);
4919 ofputil_queue_stats_from_ofp13(struct ofputil_queue_stats *oqs,
4920 const struct ofp13_queue_stats *qs13)
4923 = ofputil_queue_stats_from_ofp11(oqs, &qs13->qs);
4925 /* FIXME: Get qs13->duration_sec and qs13->duration_nsec,
4926 * Add to netdev_queue_stats? */
4932 /* Converts an OFPST_QUEUE_STATS reply in 'msg' into an abstract
4933 * ofputil_queue_stats in 'qs'.
4935 * Multiple OFPST_QUEUE_STATS replies can be packed into a single OpenFlow
4936 * message. Calling this function multiple times for a single 'msg' iterates
4937 * through the replies. The caller must initially leave 'msg''s layer pointers
4938 * null and not modify them between calls.
4940 * Returns 0 if successful, EOF if no replies were left in this 'msg',
4941 * otherwise a positive errno value. */
4943 ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg)
4949 ? ofpraw_decode(&raw, msg->l2)
4950 : ofpraw_pull(&raw, msg));
4957 } else if (raw == OFPRAW_OFPST13_QUEUE_REPLY) {
4958 const struct ofp13_queue_stats *qs13;
4960 qs13 = ofpbuf_try_pull(msg, sizeof *qs13);
4964 return ofputil_queue_stats_from_ofp13(qs, qs13);
4965 } else if (raw == OFPRAW_OFPST11_QUEUE_REPLY) {
4966 const struct ofp11_queue_stats *qs11;
4968 qs11 = ofpbuf_try_pull(msg, sizeof *qs11);
4972 return ofputil_queue_stats_from_ofp11(qs, qs11);
4973 } else if (raw == OFPRAW_OFPST10_QUEUE_REPLY) {
4974 const struct ofp10_queue_stats *qs10;
4976 qs10 = ofpbuf_try_pull(msg, sizeof *qs10);
4980 return ofputil_queue_stats_from_ofp10(qs, qs10);
4986 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_QUEUE reply has %zu leftover "
4987 "bytes at end", msg->size);
4988 return OFPERR_OFPBRC_BAD_LEN;
4992 ofputil_queue_stats_to_ofp10(const struct ofputil_queue_stats *oqs,
4993 struct ofp10_queue_stats *qs10)
4995 qs10->port_no = htons(oqs->port_no);
4996 memset(qs10->pad, 0, sizeof qs10->pad);
4997 qs10->queue_id = htonl(oqs->queue_id);
4998 put_32aligned_be64(&qs10->tx_bytes, htonll(oqs->stats.tx_bytes));
4999 put_32aligned_be64(&qs10->tx_packets, htonll(oqs->stats.tx_packets));
5000 put_32aligned_be64(&qs10->tx_errors, htonll(oqs->stats.tx_errors));
5004 ofputil_queue_stats_to_ofp11(const struct ofputil_queue_stats *oqs,
5005 struct ofp11_queue_stats *qs11)
5007 qs11->port_no = ofputil_port_to_ofp11(oqs->port_no);
5008 qs11->queue_id = htonl(oqs->queue_id);
5009 qs11->tx_bytes = htonll(oqs->stats.tx_bytes);
5010 qs11->tx_packets = htonll(oqs->stats.tx_packets);
5011 qs11->tx_errors = htonll(oqs->stats.tx_errors);
5015 ofputil_queue_stats_to_ofp13(const struct ofputil_queue_stats *oqs,
5016 struct ofp13_queue_stats *qs13)
5018 ofputil_queue_stats_to_ofp11(oqs, &qs13->qs);
5019 /* OF 1.3 adds duration fields */
5020 /* FIXME: Need to implement queue alive duration (sec + nsec) */
5021 qs13->duration_sec = htonl(~0);
5022 qs13->duration_nsec = htonl(~0);
5025 /* Encode a queue stat for 'oqs' and append it to 'replies'. */
5027 ofputil_append_queue_stat(struct list *replies,
5028 const struct ofputil_queue_stats *oqs)
5030 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
5031 struct ofp_header *oh = msg->data;
5033 switch ((enum ofp_version)oh->version) {
5034 case OFP13_VERSION: {
5035 struct ofp13_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
5036 ofputil_queue_stats_to_ofp13(oqs, reply);
5041 case OFP11_VERSION: {
5042 struct ofp11_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
5043 ofputil_queue_stats_to_ofp11(oqs, reply);
5047 case OFP10_VERSION: {
5048 struct ofp10_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
5049 ofputil_queue_stats_to_ofp10(oqs, reply);