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 == 23);
89 /* Initialize most of wc. */
90 flow_wildcards_init_catchall(wc);
92 if (!(ofpfw & OFPFW10_IN_PORT)) {
93 wc->masks.in_port.ofp_port = u16_to_ofp(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 = OVS_BE16_MAX;
111 if (!(ofpfw & OFPFW10_TP_DST)) {
112 wc->masks.tp_dst = OVS_BE16_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 = OVS_BE16_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.ofp_port = u16_to_ofp(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.ofp_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(ofp_to_u16(match->flow.in_port.ofp_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 'ofmatch' into a struct match in 'match'.
300 * Returns 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 = OVS_BE16_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;
424 if (!(wc & (OFPFW11_TP_SRC))) {
425 match_set_tp_src(match, ofmatch->tp_src);
427 if (!(wc & (OFPFW11_TP_DST))) {
428 match_set_tp_dst(match, ofmatch->tp_dst);
433 /* OF1.1 says explicitly to ignore this. */
438 if (eth_type_mpls(match->flow.dl_type)) {
439 if (!(wc & OFPFW11_MPLS_LABEL)) {
440 match_set_mpls_label(match, ofmatch->mpls_label);
442 if (!(wc & OFPFW11_MPLS_TC)) {
443 match_set_mpls_tc(match, ofmatch->mpls_tc);
447 match_set_metadata_masked(match, ofmatch->metadata,
448 ~ofmatch->metadata_mask);
453 /* Convert 'match' into the OpenFlow 1.1 match structure 'ofmatch'. */
455 ofputil_match_to_ofp11_match(const struct match *match,
456 struct ofp11_match *ofmatch)
461 memset(ofmatch, 0, sizeof *ofmatch);
462 ofmatch->omh.type = htons(OFPMT_STANDARD);
463 ofmatch->omh.length = htons(OFPMT11_STANDARD_LENGTH);
465 if (!match->wc.masks.in_port.ofp_port) {
466 wc |= OFPFW11_IN_PORT;
468 ofmatch->in_port = ofputil_port_to_ofp11(match->flow.in_port.ofp_port);
471 memcpy(ofmatch->dl_src, match->flow.dl_src, ETH_ADDR_LEN);
472 for (i = 0; i < ETH_ADDR_LEN; i++) {
473 ofmatch->dl_src_mask[i] = ~match->wc.masks.dl_src[i];
476 memcpy(ofmatch->dl_dst, match->flow.dl_dst, ETH_ADDR_LEN);
477 for (i = 0; i < ETH_ADDR_LEN; i++) {
478 ofmatch->dl_dst_mask[i] = ~match->wc.masks.dl_dst[i];
481 if (match->wc.masks.vlan_tci == htons(0)) {
482 wc |= OFPFW11_DL_VLAN | OFPFW11_DL_VLAN_PCP;
483 } else if (match->wc.masks.vlan_tci & htons(VLAN_CFI)
484 && !(match->flow.vlan_tci & htons(VLAN_CFI))) {
485 ofmatch->dl_vlan = htons(OFPVID11_NONE);
486 wc |= OFPFW11_DL_VLAN_PCP;
488 if (!(match->wc.masks.vlan_tci & htons(VLAN_VID_MASK))) {
489 ofmatch->dl_vlan = htons(OFPVID11_ANY);
491 ofmatch->dl_vlan = htons(vlan_tci_to_vid(match->flow.vlan_tci));
494 if (!(match->wc.masks.vlan_tci & htons(VLAN_PCP_MASK))) {
495 wc |= OFPFW11_DL_VLAN_PCP;
497 ofmatch->dl_vlan_pcp = vlan_tci_to_pcp(match->flow.vlan_tci);
501 if (!match->wc.masks.dl_type) {
502 wc |= OFPFW11_DL_TYPE;
504 ofmatch->dl_type = ofputil_dl_type_to_openflow(match->flow.dl_type);
507 if (!(match->wc.masks.nw_tos & IP_DSCP_MASK)) {
508 wc |= OFPFW11_NW_TOS;
510 ofmatch->nw_tos = match->flow.nw_tos & IP_DSCP_MASK;
513 if (!match->wc.masks.nw_proto) {
514 wc |= OFPFW11_NW_PROTO;
516 ofmatch->nw_proto = match->flow.nw_proto;
519 ofmatch->nw_src = match->flow.nw_src;
520 ofmatch->nw_src_mask = ~match->wc.masks.nw_src;
521 ofmatch->nw_dst = match->flow.nw_dst;
522 ofmatch->nw_dst_mask = ~match->wc.masks.nw_dst;
524 if (!match->wc.masks.tp_src) {
525 wc |= OFPFW11_TP_SRC;
527 ofmatch->tp_src = match->flow.tp_src;
530 if (!match->wc.masks.tp_dst) {
531 wc |= OFPFW11_TP_DST;
533 ofmatch->tp_dst = match->flow.tp_dst;
536 if (!(match->wc.masks.mpls_lse & htonl(MPLS_LABEL_MASK))) {
537 wc |= OFPFW11_MPLS_LABEL;
539 ofmatch->mpls_label = htonl(mpls_lse_to_label(match->flow.mpls_lse));
542 if (!(match->wc.masks.mpls_lse & htonl(MPLS_TC_MASK))) {
543 wc |= OFPFW11_MPLS_TC;
545 ofmatch->mpls_tc = mpls_lse_to_tc(match->flow.mpls_lse);
548 ofmatch->metadata = match->flow.metadata;
549 ofmatch->metadata_mask = ~match->wc.masks.metadata;
551 ofmatch->wildcards = htonl(wc);
554 /* Returns the "typical" length of a match for 'protocol', for use in
555 * estimating space to preallocate. */
557 ofputil_match_typical_len(enum ofputil_protocol protocol)
560 case OFPUTIL_P_OF10_STD:
561 case OFPUTIL_P_OF10_STD_TID:
562 return sizeof(struct ofp10_match);
564 case OFPUTIL_P_OF10_NXM:
565 case OFPUTIL_P_OF10_NXM_TID:
566 return NXM_TYPICAL_LEN;
568 case OFPUTIL_P_OF11_STD:
569 return sizeof(struct ofp11_match);
571 case OFPUTIL_P_OF12_OXM:
572 case OFPUTIL_P_OF13_OXM:
573 return NXM_TYPICAL_LEN;
580 /* Appends to 'b' an struct ofp11_match_header followed by a match that
581 * expresses 'match' properly for 'protocol', plus enough zero bytes to pad the
582 * data appended out to a multiple of 8. 'protocol' must be one that is usable
583 * in OpenFlow 1.1 or later.
585 * This function can cause 'b''s data to be reallocated.
587 * Returns the number of bytes appended to 'b', excluding the padding. Never
590 ofputil_put_ofp11_match(struct ofpbuf *b, const struct match *match,
591 enum ofputil_protocol protocol)
594 case OFPUTIL_P_OF10_STD:
595 case OFPUTIL_P_OF10_STD_TID:
596 case OFPUTIL_P_OF10_NXM:
597 case OFPUTIL_P_OF10_NXM_TID:
600 case OFPUTIL_P_OF11_STD: {
601 struct ofp11_match *om;
603 /* Make sure that no padding is needed. */
604 BUILD_ASSERT_DECL(sizeof *om % 8 == 0);
606 om = ofpbuf_put_uninit(b, sizeof *om);
607 ofputil_match_to_ofp11_match(match, om);
611 case OFPUTIL_P_OF12_OXM:
612 case OFPUTIL_P_OF13_OXM:
613 return oxm_put_match(b, match);
619 /* Given a 'dl_type' value in the format used in struct flow, returns the
620 * corresponding 'dl_type' value for use in an ofp10_match or ofp11_match
623 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type)
625 return (flow_dl_type == htons(FLOW_DL_TYPE_NONE)
626 ? htons(OFP_DL_TYPE_NOT_ETH_TYPE)
630 /* Given a 'dl_type' value in the format used in an ofp10_match or ofp11_match
631 * structure, returns the corresponding 'dl_type' value for use in struct
634 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type)
636 return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
637 ? htons(FLOW_DL_TYPE_NONE)
643 struct proto_abbrev {
644 enum ofputil_protocol protocol;
648 /* Most users really don't care about some of the differences between
649 * protocols. These abbreviations help with that. */
650 static const struct proto_abbrev proto_abbrevs[] = {
651 { OFPUTIL_P_ANY, "any" },
652 { OFPUTIL_P_OF10_STD_ANY, "OpenFlow10" },
653 { OFPUTIL_P_OF10_NXM_ANY, "NXM" },
654 { OFPUTIL_P_ANY_OXM, "OXM" },
656 #define N_PROTO_ABBREVS ARRAY_SIZE(proto_abbrevs)
658 enum ofputil_protocol ofputil_flow_dump_protocols[] = {
665 size_t ofputil_n_flow_dump_protocols = ARRAY_SIZE(ofputil_flow_dump_protocols);
667 /* Returns the set of ofputil_protocols that are supported with the given
668 * OpenFlow 'version'. 'version' should normally be an 8-bit OpenFlow version
669 * identifier (e.g. 0x01 for OpenFlow 1.0, 0x02 for OpenFlow 1.1). Returns 0
670 * if 'version' is not supported or outside the valid range. */
671 enum ofputil_protocol
672 ofputil_protocols_from_ofp_version(enum ofp_version version)
676 return OFPUTIL_P_OF10_STD_ANY | OFPUTIL_P_OF10_NXM_ANY;
678 return OFPUTIL_P_OF11_STD;
680 return OFPUTIL_P_OF12_OXM;
682 return OFPUTIL_P_OF13_OXM;
688 /* Returns the ofputil_protocol that is initially in effect on an OpenFlow
689 * connection that has negotiated the given 'version'. 'version' should
690 * normally be an 8-bit OpenFlow version identifier (e.g. 0x01 for OpenFlow
691 * 1.0, 0x02 for OpenFlow 1.1). Returns 0 if 'version' is not supported or
692 * outside the valid range. */
693 enum ofputil_protocol
694 ofputil_protocol_from_ofp_version(enum ofp_version version)
696 return rightmost_1bit(ofputil_protocols_from_ofp_version(version));
699 /* Returns the OpenFlow protocol version number (e.g. OFP10_VERSION,
700 * etc.) that corresponds to 'protocol'. */
702 ofputil_protocol_to_ofp_version(enum ofputil_protocol protocol)
705 case OFPUTIL_P_OF10_STD:
706 case OFPUTIL_P_OF10_STD_TID:
707 case OFPUTIL_P_OF10_NXM:
708 case OFPUTIL_P_OF10_NXM_TID:
709 return OFP10_VERSION;
710 case OFPUTIL_P_OF11_STD:
711 return OFP11_VERSION;
712 case OFPUTIL_P_OF12_OXM:
713 return OFP12_VERSION;
714 case OFPUTIL_P_OF13_OXM:
715 return OFP13_VERSION;
721 /* Returns a bitmap of OpenFlow versions that are supported by at
722 * least one of the 'protocols'. */
724 ofputil_protocols_to_version_bitmap(enum ofputil_protocol protocols)
728 for (; protocols; protocols = zero_rightmost_1bit(protocols)) {
729 enum ofputil_protocol protocol = rightmost_1bit(protocols);
731 bitmap |= 1u << ofputil_protocol_to_ofp_version(protocol);
737 /* Returns the set of protocols that are supported on top of the
738 * OpenFlow versions included in 'bitmap'. */
739 enum ofputil_protocol
740 ofputil_protocols_from_version_bitmap(uint32_t bitmap)
742 enum ofputil_protocol protocols = 0;
744 for (; bitmap; bitmap = zero_rightmost_1bit(bitmap)) {
745 enum ofp_version version = rightmost_1bit_idx(bitmap);
747 protocols |= ofputil_protocols_from_ofp_version(version);
753 /* Returns true if 'protocol' is a single OFPUTIL_P_* value, false
756 ofputil_protocol_is_valid(enum ofputil_protocol protocol)
758 return protocol & OFPUTIL_P_ANY && is_pow2(protocol);
761 /* Returns the equivalent of 'protocol' with the Nicira flow_mod_table_id
762 * extension turned on or off if 'enable' is true or false, respectively.
764 * This extension is only useful for protocols whose "standard" version does
765 * not allow specific tables to be modified. In particular, this is true of
766 * OpenFlow 1.0. In later versions of OpenFlow, a flow_mod request always
767 * specifies a table ID and so there is no need for such an extension. When
768 * 'protocol' is such a protocol that doesn't need a flow_mod_table_id
769 * extension, this function just returns its 'protocol' argument unchanged
770 * regardless of the value of 'enable'. */
771 enum ofputil_protocol
772 ofputil_protocol_set_tid(enum ofputil_protocol protocol, bool enable)
775 case OFPUTIL_P_OF10_STD:
776 case OFPUTIL_P_OF10_STD_TID:
777 return enable ? OFPUTIL_P_OF10_STD_TID : OFPUTIL_P_OF10_STD;
779 case OFPUTIL_P_OF10_NXM:
780 case OFPUTIL_P_OF10_NXM_TID:
781 return enable ? OFPUTIL_P_OF10_NXM_TID : OFPUTIL_P_OF10_NXM;
783 case OFPUTIL_P_OF11_STD:
784 return OFPUTIL_P_OF11_STD;
786 case OFPUTIL_P_OF12_OXM:
787 return OFPUTIL_P_OF12_OXM;
789 case OFPUTIL_P_OF13_OXM:
790 return OFPUTIL_P_OF13_OXM;
797 /* Returns the "base" version of 'protocol'. That is, if 'protocol' includes
798 * some extension to a standard protocol version, the return value is the
799 * standard version of that protocol without any extension. If 'protocol' is a
800 * standard protocol version, returns 'protocol' unchanged. */
801 enum ofputil_protocol
802 ofputil_protocol_to_base(enum ofputil_protocol protocol)
804 return ofputil_protocol_set_tid(protocol, false);
807 /* Returns 'new_base' with any extensions taken from 'cur'. */
808 enum ofputil_protocol
809 ofputil_protocol_set_base(enum ofputil_protocol cur,
810 enum ofputil_protocol new_base)
812 bool tid = (cur & OFPUTIL_P_TID) != 0;
815 case OFPUTIL_P_OF10_STD:
816 case OFPUTIL_P_OF10_STD_TID:
817 return ofputil_protocol_set_tid(OFPUTIL_P_OF10_STD, tid);
819 case OFPUTIL_P_OF10_NXM:
820 case OFPUTIL_P_OF10_NXM_TID:
821 return ofputil_protocol_set_tid(OFPUTIL_P_OF10_NXM, tid);
823 case OFPUTIL_P_OF11_STD:
824 return ofputil_protocol_set_tid(OFPUTIL_P_OF11_STD, tid);
826 case OFPUTIL_P_OF12_OXM:
827 return ofputil_protocol_set_tid(OFPUTIL_P_OF12_OXM, tid);
829 case OFPUTIL_P_OF13_OXM:
830 return ofputil_protocol_set_tid(OFPUTIL_P_OF13_OXM, tid);
837 /* Returns a string form of 'protocol', if a simple form exists (that is, if
838 * 'protocol' is either a single protocol or it is a combination of protocols
839 * that have a single abbreviation). Otherwise, returns NULL. */
841 ofputil_protocol_to_string(enum ofputil_protocol protocol)
843 const struct proto_abbrev *p;
845 /* Use a "switch" statement for single-bit names so that we get a compiler
846 * warning if we forget any. */
848 case OFPUTIL_P_OF10_NXM:
849 return "NXM-table_id";
851 case OFPUTIL_P_OF10_NXM_TID:
852 return "NXM+table_id";
854 case OFPUTIL_P_OF10_STD:
855 return "OpenFlow10-table_id";
857 case OFPUTIL_P_OF10_STD_TID:
858 return "OpenFlow10+table_id";
860 case OFPUTIL_P_OF11_STD:
863 case OFPUTIL_P_OF12_OXM:
864 return "OXM-OpenFlow12";
866 case OFPUTIL_P_OF13_OXM:
867 return "OXM-OpenFlow13";
870 /* Check abbreviations. */
871 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
872 if (protocol == p->protocol) {
880 /* Returns a string that represents 'protocols'. The return value might be a
881 * comma-separated list if 'protocols' doesn't have a simple name. The return
882 * value is "none" if 'protocols' is 0.
884 * The caller must free the returned string (with free()). */
886 ofputil_protocols_to_string(enum ofputil_protocol protocols)
890 ovs_assert(!(protocols & ~OFPUTIL_P_ANY));
891 if (protocols == 0) {
892 return xstrdup("none");
897 const struct proto_abbrev *p;
901 ds_put_char(&s, ',');
904 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
905 if ((protocols & p->protocol) == p->protocol) {
906 ds_put_cstr(&s, p->name);
907 protocols &= ~p->protocol;
912 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
913 enum ofputil_protocol bit = 1u << i;
915 if (protocols & bit) {
916 ds_put_cstr(&s, ofputil_protocol_to_string(bit));
925 return ds_steal_cstr(&s);
928 static enum ofputil_protocol
929 ofputil_protocol_from_string__(const char *s, size_t n)
931 const struct proto_abbrev *p;
934 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
935 enum ofputil_protocol bit = 1u << i;
936 const char *name = ofputil_protocol_to_string(bit);
938 if (name && n == strlen(name) && !strncasecmp(s, name, n)) {
943 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
944 if (n == strlen(p->name) && !strncasecmp(s, p->name, n)) {
952 /* Returns the nonempty set of protocols represented by 's', which can be a
953 * single protocol name or abbreviation or a comma-separated list of them.
955 * Aborts the program with an error message if 's' is invalid. */
956 enum ofputil_protocol
957 ofputil_protocols_from_string(const char *s)
959 const char *orig_s = s;
960 enum ofputil_protocol protocols;
964 enum ofputil_protocol p;
973 p = ofputil_protocol_from_string__(s, n);
975 ovs_fatal(0, "%.*s: unknown flow protocol", (int) n, s);
983 ovs_fatal(0, "%s: no flow protocol specified", orig_s);
989 ofputil_version_from_string(const char *s)
991 if (!strcasecmp(s, "OpenFlow10")) {
992 return OFP10_VERSION;
994 if (!strcasecmp(s, "OpenFlow11")) {
995 return OFP11_VERSION;
997 if (!strcasecmp(s, "OpenFlow12")) {
998 return OFP12_VERSION;
1000 if (!strcasecmp(s, "OpenFlow13")) {
1001 return OFP13_VERSION;
1007 is_delimiter(unsigned char c)
1009 return isspace(c) || c == ',';
1013 ofputil_versions_from_string(const char *s)
1016 uint32_t bitmap = 0;
1023 if (is_delimiter(s[i])) {
1028 while (s[i + j] && !is_delimiter(s[i + j])) {
1031 key = xmemdup0(s + i, j);
1032 version = ofputil_version_from_string(key);
1034 VLOG_FATAL("Unknown OpenFlow version: \"%s\"", key);
1037 bitmap |= 1u << version;
1045 ofputil_versions_from_strings(char ** const s, size_t count)
1047 uint32_t bitmap = 0;
1050 int version = ofputil_version_from_string(s[count]);
1052 VLOG_WARN("Unknown OpenFlow version: \"%s\"", s[count]);
1054 bitmap |= 1u << version;
1062 ofputil_version_to_string(enum ofp_version ofp_version)
1064 switch (ofp_version) {
1066 return "OpenFlow10";
1068 return "OpenFlow11";
1070 return "OpenFlow12";
1072 return "OpenFlow13";
1079 ofputil_packet_in_format_is_valid(enum nx_packet_in_format packet_in_format)
1081 switch (packet_in_format) {
1082 case NXPIF_OPENFLOW10:
1091 ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format)
1093 switch (packet_in_format) {
1094 case NXPIF_OPENFLOW10:
1095 return "openflow10";
1104 ofputil_packet_in_format_from_string(const char *s)
1106 return (!strcmp(s, "openflow10") ? NXPIF_OPENFLOW10
1107 : !strcmp(s, "nxm") ? NXPIF_NXM
1112 ofputil_format_version(struct ds *msg, enum ofp_version version)
1114 ds_put_format(msg, "0x%02x", version);
1118 ofputil_format_version_name(struct ds *msg, enum ofp_version version)
1120 ds_put_cstr(msg, ofputil_version_to_string(version));
1124 ofputil_format_version_bitmap__(struct ds *msg, uint32_t bitmap,
1125 void (*format_version)(struct ds *msg,
1129 format_version(msg, raw_ctz(bitmap));
1130 bitmap = zero_rightmost_1bit(bitmap);
1132 ds_put_cstr(msg, ", ");
1138 ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap)
1140 ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version);
1144 ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap)
1146 ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version_name);
1150 ofputil_decode_hello_bitmap(const struct ofp_hello_elem_header *oheh,
1151 uint32_t *allowed_versionsp)
1153 uint16_t bitmap_len = ntohs(oheh->length) - sizeof *oheh;
1154 const ovs_be32 *bitmap = ALIGNED_CAST(const ovs_be32 *, oheh + 1);
1155 uint32_t allowed_versions;
1157 if (!bitmap_len || bitmap_len % sizeof *bitmap) {
1161 /* Only use the first 32-bit element of the bitmap as that is all the
1162 * current implementation supports. Subsequent elements are ignored which
1163 * should have no effect on session negotiation until Open vSwtich supports
1164 * wire-protocol versions greater than 31.
1166 allowed_versions = ntohl(bitmap[0]);
1168 if (allowed_versions & 1) {
1169 /* There's no OpenFlow version 0. */
1170 VLOG_WARN_RL(&bad_ofmsg_rl, "peer claims to support invalid OpenFlow "
1172 allowed_versions &= ~1u;
1175 if (!allowed_versions) {
1176 VLOG_WARN_RL(&bad_ofmsg_rl, "peer does not support any OpenFlow "
1177 "version (between 0x01 and 0x1f)");
1181 *allowed_versionsp = allowed_versions;
1186 version_bitmap_from_version(uint8_t ofp_version)
1188 return ((ofp_version < 32 ? 1u << ofp_version : 0) - 1) << 1;
1191 /* Decodes OpenFlow OFPT_HELLO message 'oh', storing into '*allowed_versions'
1192 * the set of OpenFlow versions for which 'oh' announces support.
1194 * Because of how OpenFlow defines OFPT_HELLO messages, this function is always
1195 * successful, and thus '*allowed_versions' is always initialized. However, it
1196 * returns false if 'oh' contains some data that could not be fully understood,
1197 * true if 'oh' was completely parsed. */
1199 ofputil_decode_hello(const struct ofp_header *oh, uint32_t *allowed_versions)
1204 ofpbuf_use_const(&msg, oh, ntohs(oh->length));
1205 ofpbuf_pull(&msg, sizeof *oh);
1207 *allowed_versions = version_bitmap_from_version(oh->version);
1209 const struct ofp_hello_elem_header *oheh;
1212 if (msg.size < sizeof *oheh) {
1217 len = ntohs(oheh->length);
1218 if (len < sizeof *oheh || !ofpbuf_try_pull(&msg, ROUND_UP(len, 8))) {
1222 if (oheh->type != htons(OFPHET_VERSIONBITMAP)
1223 || !ofputil_decode_hello_bitmap(oheh, allowed_versions)) {
1231 /* Returns true if 'allowed_versions' needs to be accompanied by a version
1232 * bitmap to be correctly expressed in an OFPT_HELLO message. */
1234 should_send_version_bitmap(uint32_t allowed_versions)
1236 return !is_pow2((allowed_versions >> 1) + 1);
1239 /* Create an OFPT_HELLO message that expresses support for the OpenFlow
1240 * versions in the 'allowed_versions' bitmaps and returns the message. */
1242 ofputil_encode_hello(uint32_t allowed_versions)
1244 enum ofp_version ofp_version;
1247 ofp_version = leftmost_1bit_idx(allowed_versions);
1248 msg = ofpraw_alloc(OFPRAW_OFPT_HELLO, ofp_version, 0);
1250 if (should_send_version_bitmap(allowed_versions)) {
1251 struct ofp_hello_elem_header *oheh;
1254 map_len = sizeof allowed_versions;
1255 oheh = ofpbuf_put_zeros(msg, ROUND_UP(map_len + sizeof *oheh, 8));
1256 oheh->type = htons(OFPHET_VERSIONBITMAP);
1257 oheh->length = htons(map_len + sizeof *oheh);
1258 *ALIGNED_CAST(ovs_be32 *, oheh + 1) = htonl(allowed_versions);
1260 ofpmsg_update_length(msg);
1266 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
1267 * protocol is 'current', at least partly transitions the protocol to 'want'.
1268 * Stores in '*next' the protocol that will be in effect on the OpenFlow
1269 * connection if the switch processes the returned message correctly. (If
1270 * '*next != want' then the caller will have to iterate.)
1272 * If 'current == want', or if it is not possible to transition from 'current'
1273 * to 'want' (because, for example, 'current' and 'want' use different OpenFlow
1274 * protocol versions), returns NULL and stores 'current' in '*next'. */
1276 ofputil_encode_set_protocol(enum ofputil_protocol current,
1277 enum ofputil_protocol want,
1278 enum ofputil_protocol *next)
1280 enum ofp_version cur_version, want_version;
1281 enum ofputil_protocol cur_base, want_base;
1282 bool cur_tid, want_tid;
1284 cur_version = ofputil_protocol_to_ofp_version(current);
1285 want_version = ofputil_protocol_to_ofp_version(want);
1286 if (cur_version != want_version) {
1291 cur_base = ofputil_protocol_to_base(current);
1292 want_base = ofputil_protocol_to_base(want);
1293 if (cur_base != want_base) {
1294 *next = ofputil_protocol_set_base(current, want_base);
1296 switch (want_base) {
1297 case OFPUTIL_P_OF10_NXM:
1298 return ofputil_encode_nx_set_flow_format(NXFF_NXM);
1300 case OFPUTIL_P_OF10_STD:
1301 return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10);
1303 case OFPUTIL_P_OF11_STD:
1304 case OFPUTIL_P_OF12_OXM:
1305 case OFPUTIL_P_OF13_OXM:
1306 /* There is only one variant of each OpenFlow 1.1+ protocol, and we
1307 * verified above that we're not trying to change versions. */
1310 case OFPUTIL_P_OF10_STD_TID:
1311 case OFPUTIL_P_OF10_NXM_TID:
1316 cur_tid = (current & OFPUTIL_P_TID) != 0;
1317 want_tid = (want & OFPUTIL_P_TID) != 0;
1318 if (cur_tid != want_tid) {
1319 *next = ofputil_protocol_set_tid(current, want_tid);
1320 return ofputil_make_flow_mod_table_id(want_tid);
1323 ovs_assert(current == want);
1329 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1330 * format to 'nxff'. */
1332 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff)
1334 struct nx_set_flow_format *sff;
1337 ovs_assert(ofputil_nx_flow_format_is_valid(nxff));
1339 msg = ofpraw_alloc(OFPRAW_NXT_SET_FLOW_FORMAT, OFP10_VERSION, 0);
1340 sff = ofpbuf_put_zeros(msg, sizeof *sff);
1341 sff->format = htonl(nxff);
1346 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1348 enum ofputil_protocol
1349 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format)
1351 switch (flow_format) {
1352 case NXFF_OPENFLOW10:
1353 return OFPUTIL_P_OF10_STD;
1356 return OFPUTIL_P_OF10_NXM;
1363 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1365 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format)
1367 return ofputil_nx_flow_format_to_protocol(flow_format) != 0;
1370 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1373 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format)
1375 switch (flow_format) {
1376 case NXFF_OPENFLOW10:
1377 return "openflow10";
1386 ofputil_make_set_packet_in_format(enum ofp_version ofp_version,
1387 enum nx_packet_in_format packet_in_format)
1389 struct nx_set_packet_in_format *spif;
1392 msg = ofpraw_alloc(OFPRAW_NXT_SET_PACKET_IN_FORMAT, ofp_version, 0);
1393 spif = ofpbuf_put_zeros(msg, sizeof *spif);
1394 spif->format = htonl(packet_in_format);
1399 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1400 * extension on or off (according to 'flow_mod_table_id'). */
1402 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
1404 struct nx_flow_mod_table_id *nfmti;
1407 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION, 0);
1408 nfmti = ofpbuf_put_zeros(msg, sizeof *nfmti);
1409 nfmti->set = flow_mod_table_id;
1413 struct ofputil_flow_mod_flag {
1415 enum ofp_version min_version, max_version;
1416 enum ofputil_flow_mod_flags flag;
1419 static const struct ofputil_flow_mod_flag ofputil_flow_mod_flags[] = {
1420 { OFPFF_SEND_FLOW_REM, OFP10_VERSION, 0, OFPUTIL_FF_SEND_FLOW_REM },
1421 { OFPFF_CHECK_OVERLAP, OFP10_VERSION, 0, OFPUTIL_FF_CHECK_OVERLAP },
1422 { OFPFF10_EMERG, OFP10_VERSION, OFP10_VERSION,
1424 { OFPFF12_RESET_COUNTS, OFP12_VERSION, 0, OFPUTIL_FF_RESET_COUNTS },
1425 { OFPFF13_NO_PKT_COUNTS, OFP13_VERSION, 0, OFPUTIL_FF_NO_PKT_COUNTS },
1426 { OFPFF13_NO_BYT_COUNTS, OFP13_VERSION, 0, OFPUTIL_FF_NO_BYT_COUNTS },
1431 ofputil_decode_flow_mod_flags(ovs_be16 raw_flags_,
1432 enum ofp_flow_mod_command command,
1433 enum ofp_version version,
1434 enum ofputil_flow_mod_flags *flagsp)
1436 uint16_t raw_flags = ntohs(raw_flags_);
1437 const struct ofputil_flow_mod_flag *f;
1440 for (f = ofputil_flow_mod_flags; f->raw_flag; f++) {
1441 if (raw_flags & f->raw_flag
1442 && version >= f->min_version
1443 && (!f->max_version || version <= f->max_version)) {
1444 raw_flags &= ~f->raw_flag;
1449 /* In OF1.0 and OF1.1, "add" always resets counters, and other commands
1452 * In OF1.2 and later, OFPFF12_RESET_COUNTS controls whether each command
1453 * resets counters. */
1454 if ((version == OFP10_VERSION || version == OFP11_VERSION)
1455 && command == OFPFC_ADD) {
1456 *flagsp |= OFPUTIL_FF_RESET_COUNTS;
1459 return raw_flags ? OFPERR_OFPFMFC_BAD_FLAGS : 0;
1463 ofputil_encode_flow_mod_flags(enum ofputil_flow_mod_flags flags,
1464 enum ofp_version version)
1466 const struct ofputil_flow_mod_flag *f;
1470 for (f = ofputil_flow_mod_flags; f->raw_flag; f++) {
1472 && version >= f->min_version
1473 && (!f->max_version || version <= f->max_version)) {
1474 raw_flags |= f->raw_flag;
1478 return htons(raw_flags);
1481 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1482 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
1485 * Uses 'ofpacts' to store the abstract OFPACT_* version of 'oh''s actions.
1486 * The caller must initialize 'ofpacts' and retains ownership of it.
1487 * 'fm->ofpacts' will point into the 'ofpacts' buffer.
1489 * Does not validate the flow_mod actions. The caller should do that, with
1490 * ofpacts_check(). */
1492 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
1493 const struct ofp_header *oh,
1494 enum ofputil_protocol protocol,
1495 struct ofpbuf *ofpacts,
1496 ofp_port_t max_port, uint8_t max_table)
1503 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1504 raw = ofpraw_pull_assert(&b);
1505 if (raw == OFPRAW_OFPT11_FLOW_MOD) {
1506 /* Standard OpenFlow 1.1+ flow_mod. */
1507 const struct ofp11_flow_mod *ofm;
1509 ofm = ofpbuf_pull(&b, sizeof *ofm);
1511 error = ofputil_pull_ofp11_match(&b, &fm->match, NULL);
1516 error = ofpacts_pull_openflow_instructions(&b, b.size, oh->version,
1522 /* Translate the message. */
1523 fm->priority = ntohs(ofm->priority);
1524 if (ofm->command == OFPFC_ADD
1525 || (oh->version == OFP11_VERSION
1526 && (ofm->command == OFPFC_MODIFY ||
1527 ofm->command == OFPFC_MODIFY_STRICT)
1528 && ofm->cookie_mask == htonll(0))) {
1529 /* In OpenFlow 1.1 only, a "modify" or "modify-strict" that does
1530 * not match on the cookie is treated as an "add" if there is no
1532 fm->cookie = htonll(0);
1533 fm->cookie_mask = htonll(0);
1534 fm->new_cookie = ofm->cookie;
1536 fm->cookie = ofm->cookie;
1537 fm->cookie_mask = ofm->cookie_mask;
1538 fm->new_cookie = OVS_BE64_MAX;
1540 fm->modify_cookie = false;
1541 fm->command = ofm->command;
1545 * OF1.1 entirely forbids table_id == OFPTT_ALL.
1546 * OF1.2+ allows table_id == OFPTT_ALL only for deletes. */
1547 fm->table_id = ofm->table_id;
1548 if (fm->table_id == OFPTT_ALL
1549 && (oh->version == OFP11_VERSION
1550 || (ofm->command != OFPFC_DELETE &&
1551 ofm->command != OFPFC_DELETE_STRICT))) {
1552 return OFPERR_OFPFMFC_BAD_TABLE_ID;
1555 fm->idle_timeout = ntohs(ofm->idle_timeout);
1556 fm->hard_timeout = ntohs(ofm->hard_timeout);
1557 fm->buffer_id = ntohl(ofm->buffer_id);
1558 error = ofputil_port_from_ofp11(ofm->out_port, &fm->out_port);
1562 fm->out_group = ntohl(ofm->out_group);
1564 if ((ofm->command == OFPFC_DELETE
1565 || ofm->command == OFPFC_DELETE_STRICT)
1566 && ofm->out_group != htonl(OFPG_ANY)) {
1567 return OFPERR_OFPFMFC_UNKNOWN;
1569 raw_flags = ofm->flags;
1573 if (raw == OFPRAW_OFPT10_FLOW_MOD) {
1574 /* Standard OpenFlow 1.0 flow_mod. */
1575 const struct ofp10_flow_mod *ofm;
1577 /* Get the ofp10_flow_mod. */
1578 ofm = ofpbuf_pull(&b, sizeof *ofm);
1580 /* Translate the rule. */
1581 ofputil_match_from_ofp10_match(&ofm->match, &fm->match);
1582 ofputil_normalize_match(&fm->match);
1584 /* Now get the actions. */
1585 error = ofpacts_pull_openflow_actions(&b, b.size, oh->version,
1591 /* OpenFlow 1.0 says that exact-match rules have to have the
1592 * highest possible priority. */
1593 fm->priority = (ofm->match.wildcards & htonl(OFPFW10_ALL)
1594 ? ntohs(ofm->priority)
1597 /* Translate the message. */
1598 command = ntohs(ofm->command);
1599 fm->cookie = htonll(0);
1600 fm->cookie_mask = htonll(0);
1601 fm->new_cookie = ofm->cookie;
1602 fm->idle_timeout = ntohs(ofm->idle_timeout);
1603 fm->hard_timeout = ntohs(ofm->hard_timeout);
1604 fm->buffer_id = ntohl(ofm->buffer_id);
1605 fm->out_port = u16_to_ofp(ntohs(ofm->out_port));
1606 fm->out_group = OFPG11_ANY;
1607 raw_flags = ofm->flags;
1608 } else if (raw == OFPRAW_NXT_FLOW_MOD) {
1609 /* Nicira extended flow_mod. */
1610 const struct nx_flow_mod *nfm;
1612 /* Dissect the message. */
1613 nfm = ofpbuf_pull(&b, sizeof *nfm);
1614 error = nx_pull_match(&b, ntohs(nfm->match_len),
1615 &fm->match, &fm->cookie, &fm->cookie_mask);
1619 error = ofpacts_pull_openflow_actions(&b, b.size, oh->version,
1625 /* Translate the message. */
1626 command = ntohs(nfm->command);
1627 if ((command & 0xff) == OFPFC_ADD && fm->cookie_mask) {
1628 /* Flow additions may only set a new cookie, not match an
1629 * existing cookie. */
1630 return OFPERR_NXBRC_NXM_INVALID;
1632 fm->priority = ntohs(nfm->priority);
1633 fm->new_cookie = nfm->cookie;
1634 fm->idle_timeout = ntohs(nfm->idle_timeout);
1635 fm->hard_timeout = ntohs(nfm->hard_timeout);
1636 fm->buffer_id = ntohl(nfm->buffer_id);
1637 fm->out_port = u16_to_ofp(ntohs(nfm->out_port));
1638 fm->out_group = OFPG11_ANY;
1639 raw_flags = nfm->flags;
1644 fm->modify_cookie = fm->new_cookie != OVS_BE64_MAX;
1645 if (protocol & OFPUTIL_P_TID) {
1646 fm->command = command & 0xff;
1647 fm->table_id = command >> 8;
1649 fm->command = command;
1650 fm->table_id = 0xff;
1654 fm->ofpacts = ofpacts->data;
1655 fm->ofpacts_len = ofpacts->size;
1657 error = ofputil_decode_flow_mod_flags(raw_flags, fm->command,
1658 oh->version, &fm->flags);
1663 if (fm->flags & OFPUTIL_FF_EMERG) {
1664 /* We do not support the OpenFlow 1.0 emergency flow cache, which
1665 * is not required in OpenFlow 1.0.1 and removed from OpenFlow 1.1.
1667 * OpenFlow 1.0 specifies the error code to use when idle_timeout
1668 * or hard_timeout is nonzero. Otherwise, there is no good error
1669 * code, so just state that the flow table is full. */
1670 return (fm->hard_timeout || fm->idle_timeout
1671 ? OFPERR_OFPFMFC_BAD_EMERG_TIMEOUT
1672 : OFPERR_OFPFMFC_TABLE_FULL);
1675 return ofpacts_check_consistency(fm->ofpacts, fm->ofpacts_len,
1676 &fm->match.flow, max_port,
1677 fm->table_id, max_table, protocol);
1681 ofputil_pull_bands(struct ofpbuf *msg, size_t len, uint16_t *n_bands,
1682 struct ofpbuf *bands)
1684 const struct ofp13_meter_band_header *ombh;
1685 struct ofputil_meter_band *mb;
1688 ombh = ofpbuf_try_pull(msg, len);
1690 return OFPERR_OFPBRC_BAD_LEN;
1693 while (len >= sizeof (struct ofp13_meter_band_drop)) {
1694 size_t ombh_len = ntohs(ombh->len);
1695 /* All supported band types have the same length. */
1696 if (ombh_len != sizeof (struct ofp13_meter_band_drop)) {
1697 return OFPERR_OFPBRC_BAD_LEN;
1699 mb = ofpbuf_put_uninit(bands, sizeof *mb);
1700 mb->type = ntohs(ombh->type);
1701 if (mb->type != OFPMBT13_DROP && mb->type != OFPMBT13_DSCP_REMARK) {
1702 return OFPERR_OFPMMFC_BAD_BAND;
1704 mb->rate = ntohl(ombh->rate);
1705 mb->burst_size = ntohl(ombh->burst_size);
1706 mb->prec_level = (mb->type == OFPMBT13_DSCP_REMARK) ?
1707 ((struct ofp13_meter_band_dscp_remark *)ombh)->prec_level : 0;
1710 ombh = ALIGNED_CAST(struct ofp13_meter_band_header *,
1711 (char *) ombh + ombh_len);
1714 return OFPERR_OFPBRC_BAD_LEN;
1721 ofputil_decode_meter_mod(const struct ofp_header *oh,
1722 struct ofputil_meter_mod *mm,
1723 struct ofpbuf *bands)
1725 const struct ofp13_meter_mod *omm;
1728 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1729 ofpraw_pull_assert(&b);
1730 omm = ofpbuf_pull(&b, sizeof *omm);
1732 /* Translate the message. */
1733 mm->command = ntohs(omm->command);
1734 if (mm->command != OFPMC13_ADD &&
1735 mm->command != OFPMC13_MODIFY &&
1736 mm->command != OFPMC13_DELETE) {
1737 return OFPERR_OFPMMFC_BAD_COMMAND;
1739 mm->meter.meter_id = ntohl(omm->meter_id);
1741 if (mm->command == OFPMC13_DELETE) {
1742 mm->meter.flags = 0;
1743 mm->meter.n_bands = 0;
1744 mm->meter.bands = NULL;
1748 mm->meter.flags = ntohs(omm->flags);
1749 if (mm->meter.flags & OFPMF13_KBPS &&
1750 mm->meter.flags & OFPMF13_PKTPS) {
1751 return OFPERR_OFPMMFC_BAD_FLAGS;
1753 mm->meter.bands = bands->data;
1755 error = ofputil_pull_bands(&b, b.size, &mm->meter.n_bands, bands);
1764 ofputil_decode_meter_request(const struct ofp_header *oh, uint32_t *meter_id)
1766 const struct ofp13_meter_multipart_request *omr = ofpmsg_body(oh);
1767 *meter_id = ntohl(omr->meter_id);
1771 ofputil_encode_meter_request(enum ofp_version ofp_version,
1772 enum ofputil_meter_request_type type,
1780 case OFPUTIL_METER_CONFIG:
1781 raw = OFPRAW_OFPST13_METER_CONFIG_REQUEST;
1783 case OFPUTIL_METER_STATS:
1784 raw = OFPRAW_OFPST13_METER_REQUEST;
1787 case OFPUTIL_METER_FEATURES:
1788 raw = OFPRAW_OFPST13_METER_FEATURES_REQUEST;
1792 msg = ofpraw_alloc(raw, ofp_version, 0);
1794 if (type != OFPUTIL_METER_FEATURES) {
1795 struct ofp13_meter_multipart_request *omr;
1796 omr = ofpbuf_put_zeros(msg, sizeof *omr);
1797 omr->meter_id = htonl(meter_id);
1803 ofputil_put_bands(uint16_t n_bands, const struct ofputil_meter_band *mb,
1808 for (n = 0; n < n_bands; ++n) {
1809 /* Currently all band types have same size. */
1810 struct ofp13_meter_band_dscp_remark *ombh;
1811 size_t ombh_len = sizeof *ombh;
1813 ombh = ofpbuf_put_zeros(msg, ombh_len);
1815 ombh->type = htons(mb->type);
1816 ombh->len = htons(ombh_len);
1817 ombh->rate = htonl(mb->rate);
1818 ombh->burst_size = htonl(mb->burst_size);
1819 ombh->prec_level = mb->prec_level;
1825 /* Encode a meter stat for 'mc' and append it to 'replies'. */
1827 ofputil_append_meter_config(struct list *replies,
1828 const struct ofputil_meter_config *mc)
1830 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
1831 size_t start_ofs = msg->size;
1832 struct ofp13_meter_config *reply = ofpbuf_put_uninit(msg, sizeof *reply);
1833 reply->flags = htons(mc->flags);
1834 reply->meter_id = htonl(mc->meter_id);
1836 ofputil_put_bands(mc->n_bands, mc->bands, msg);
1838 reply->length = htons(msg->size - start_ofs);
1840 ofpmp_postappend(replies, start_ofs);
1843 /* Encode a meter stat for 'ms' and append it to 'replies'. */
1845 ofputil_append_meter_stats(struct list *replies,
1846 const struct ofputil_meter_stats *ms)
1848 struct ofp13_meter_stats *reply;
1852 len = sizeof *reply + ms->n_bands * sizeof(struct ofp13_meter_band_stats);
1853 reply = ofpmp_append(replies, len);
1855 reply->meter_id = htonl(ms->meter_id);
1856 reply->len = htons(len);
1857 memset(reply->pad, 0, sizeof reply->pad);
1858 reply->flow_count = htonl(ms->flow_count);
1859 reply->packet_in_count = htonll(ms->packet_in_count);
1860 reply->byte_in_count = htonll(ms->byte_in_count);
1861 reply->duration_sec = htonl(ms->duration_sec);
1862 reply->duration_nsec = htonl(ms->duration_nsec);
1864 for (n = 0; n < ms->n_bands; ++n) {
1865 const struct ofputil_meter_band_stats *src = &ms->bands[n];
1866 struct ofp13_meter_band_stats *dst = &reply->band_stats[n];
1868 dst->packet_band_count = htonll(src->packet_count);
1869 dst->byte_band_count = htonll(src->byte_count);
1873 /* Converts an OFPMP_METER_CONFIG reply in 'msg' into an abstract
1874 * ofputil_meter_config in 'mc', with mc->bands pointing to bands decoded into
1875 * 'bands'. The caller must have initialized 'bands' and retains ownership of
1876 * it across the call.
1878 * Multiple OFPST13_METER_CONFIG replies can be packed into a single OpenFlow
1879 * message. Calling this function multiple times for a single 'msg' iterates
1880 * through the replies. 'bands' is cleared for each reply.
1882 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1883 * otherwise a positive errno value. */
1885 ofputil_decode_meter_config(struct ofpbuf *msg,
1886 struct ofputil_meter_config *mc,
1887 struct ofpbuf *bands)
1889 const struct ofp13_meter_config *omc;
1892 /* Pull OpenFlow headers for the first call. */
1894 ofpraw_pull_assert(msg);
1901 omc = ofpbuf_try_pull(msg, sizeof *omc);
1903 VLOG_WARN_RL(&bad_ofmsg_rl,
1904 "OFPMP_METER_CONFIG reply has %"PRIuSIZE" leftover bytes at end",
1906 return OFPERR_OFPBRC_BAD_LEN;
1909 ofpbuf_clear(bands);
1910 err = ofputil_pull_bands(msg, ntohs(omc->length) - sizeof *omc,
1911 &mc->n_bands, bands);
1915 mc->meter_id = ntohl(omc->meter_id);
1916 mc->flags = ntohs(omc->flags);
1917 mc->bands = bands->data;
1923 ofputil_pull_band_stats(struct ofpbuf *msg, size_t len, uint16_t *n_bands,
1924 struct ofpbuf *bands)
1926 const struct ofp13_meter_band_stats *ombs;
1927 struct ofputil_meter_band_stats *mbs;
1930 ombs = ofpbuf_try_pull(msg, len);
1932 return OFPERR_OFPBRC_BAD_LEN;
1935 n = len / sizeof *ombs;
1936 if (len != n * sizeof *ombs) {
1937 return OFPERR_OFPBRC_BAD_LEN;
1940 mbs = ofpbuf_put_uninit(bands, len);
1942 for (i = 0; i < n; ++i) {
1943 mbs[i].packet_count = ntohll(ombs[i].packet_band_count);
1944 mbs[i].byte_count = ntohll(ombs[i].byte_band_count);
1950 /* Converts an OFPMP_METER reply in 'msg' into an abstract
1951 * ofputil_meter_stats in 'ms', with ms->bands pointing to band stats
1952 * decoded into 'bands'.
1954 * Multiple OFPMP_METER replies can be packed into a single OpenFlow
1955 * message. Calling this function multiple times for a single 'msg' iterates
1956 * through the replies. 'bands' is cleared for each reply.
1958 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1959 * otherwise a positive errno value. */
1961 ofputil_decode_meter_stats(struct ofpbuf *msg,
1962 struct ofputil_meter_stats *ms,
1963 struct ofpbuf *bands)
1965 const struct ofp13_meter_stats *oms;
1968 /* Pull OpenFlow headers for the first call. */
1970 ofpraw_pull_assert(msg);
1977 oms = ofpbuf_try_pull(msg, sizeof *oms);
1979 VLOG_WARN_RL(&bad_ofmsg_rl,
1980 "OFPMP_METER reply has %"PRIuSIZE" leftover bytes at end",
1982 return OFPERR_OFPBRC_BAD_LEN;
1985 ofpbuf_clear(bands);
1986 err = ofputil_pull_band_stats(msg, ntohs(oms->len) - sizeof *oms,
1987 &ms->n_bands, bands);
1991 ms->meter_id = ntohl(oms->meter_id);
1992 ms->flow_count = ntohl(oms->flow_count);
1993 ms->packet_in_count = ntohll(oms->packet_in_count);
1994 ms->byte_in_count = ntohll(oms->byte_in_count);
1995 ms->duration_sec = ntohl(oms->duration_sec);
1996 ms->duration_nsec = ntohl(oms->duration_nsec);
1997 ms->bands = bands->data;
2003 ofputil_decode_meter_features(const struct ofp_header *oh,
2004 struct ofputil_meter_features *mf)
2006 const struct ofp13_meter_features *omf = ofpmsg_body(oh);
2008 mf->max_meters = ntohl(omf->max_meter);
2009 mf->band_types = ntohl(omf->band_types);
2010 mf->capabilities = ntohl(omf->capabilities);
2011 mf->max_bands = omf->max_bands;
2012 mf->max_color = omf->max_color;
2016 ofputil_encode_meter_features_reply(const struct ofputil_meter_features *mf,
2017 const struct ofp_header *request)
2019 struct ofpbuf *reply;
2020 struct ofp13_meter_features *omf;
2022 reply = ofpraw_alloc_stats_reply(request, 0);
2023 omf = ofpbuf_put_zeros(reply, sizeof *omf);
2025 omf->max_meter = htonl(mf->max_meters);
2026 omf->band_types = htonl(mf->band_types);
2027 omf->capabilities = htonl(mf->capabilities);
2028 omf->max_bands = mf->max_bands;
2029 omf->max_color = mf->max_color;
2035 ofputil_encode_meter_mod(enum ofp_version ofp_version,
2036 const struct ofputil_meter_mod *mm)
2040 struct ofp13_meter_mod *omm;
2042 msg = ofpraw_alloc(OFPRAW_OFPT13_METER_MOD, ofp_version,
2043 NXM_TYPICAL_LEN + mm->meter.n_bands * 16);
2044 omm = ofpbuf_put_zeros(msg, sizeof *omm);
2045 omm->command = htons(mm->command);
2046 if (mm->command != OFPMC13_DELETE) {
2047 omm->flags = htons(mm->meter.flags);
2049 omm->meter_id = htonl(mm->meter.meter_id);
2051 ofputil_put_bands(mm->meter.n_bands, mm->meter.bands, msg);
2053 ofpmsg_update_length(msg);
2058 ofputil_tid_command(const struct ofputil_flow_mod *fm,
2059 enum ofputil_protocol protocol)
2061 return htons(protocol & OFPUTIL_P_TID
2062 ? (fm->command & 0xff) | (fm->table_id << 8)
2066 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
2067 * 'protocol' and returns the message. */
2069 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
2070 enum ofputil_protocol protocol)
2072 enum ofp_version version = ofputil_protocol_to_ofp_version(protocol);
2073 ovs_be16 raw_flags = ofputil_encode_flow_mod_flags(fm->flags, version);
2077 case OFPUTIL_P_OF11_STD:
2078 case OFPUTIL_P_OF12_OXM:
2079 case OFPUTIL_P_OF13_OXM: {
2080 struct ofp11_flow_mod *ofm;
2083 tailroom = ofputil_match_typical_len(protocol) + fm->ofpacts_len;
2084 msg = ofpraw_alloc(OFPRAW_OFPT11_FLOW_MOD, version, tailroom);
2085 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
2086 if ((protocol == OFPUTIL_P_OF11_STD
2087 && (fm->command == OFPFC_MODIFY ||
2088 fm->command == OFPFC_MODIFY_STRICT)
2089 && fm->cookie_mask == htonll(0))
2090 || fm->command == OFPFC_ADD) {
2091 ofm->cookie = fm->new_cookie;
2093 ofm->cookie = fm->cookie;
2095 ofm->cookie_mask = fm->cookie_mask;
2096 if (fm->table_id != OFPTT_ALL
2097 || (protocol != OFPUTIL_P_OF11_STD
2098 && (fm->command == OFPFC_DELETE ||
2099 fm->command == OFPFC_DELETE_STRICT))) {
2100 ofm->table_id = fm->table_id;
2104 ofm->command = fm->command;
2105 ofm->idle_timeout = htons(fm->idle_timeout);
2106 ofm->hard_timeout = htons(fm->hard_timeout);
2107 ofm->priority = htons(fm->priority);
2108 ofm->buffer_id = htonl(fm->buffer_id);
2109 ofm->out_port = ofputil_port_to_ofp11(fm->out_port);
2110 ofm->out_group = htonl(fm->out_group);
2111 ofm->flags = raw_flags;
2112 ofputil_put_ofp11_match(msg, &fm->match, protocol);
2113 ofpacts_put_openflow_instructions(fm->ofpacts, fm->ofpacts_len, msg,
2118 case OFPUTIL_P_OF10_STD:
2119 case OFPUTIL_P_OF10_STD_TID: {
2120 struct ofp10_flow_mod *ofm;
2122 msg = ofpraw_alloc(OFPRAW_OFPT10_FLOW_MOD, OFP10_VERSION,
2124 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
2125 ofputil_match_to_ofp10_match(&fm->match, &ofm->match);
2126 ofm->cookie = fm->new_cookie;
2127 ofm->command = ofputil_tid_command(fm, protocol);
2128 ofm->idle_timeout = htons(fm->idle_timeout);
2129 ofm->hard_timeout = htons(fm->hard_timeout);
2130 ofm->priority = htons(fm->priority);
2131 ofm->buffer_id = htonl(fm->buffer_id);
2132 ofm->out_port = htons(ofp_to_u16(fm->out_port));
2133 ofm->flags = raw_flags;
2134 ofpacts_put_openflow_actions(fm->ofpacts, fm->ofpacts_len, msg,
2139 case OFPUTIL_P_OF10_NXM:
2140 case OFPUTIL_P_OF10_NXM_TID: {
2141 struct nx_flow_mod *nfm;
2144 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD, OFP10_VERSION,
2145 NXM_TYPICAL_LEN + fm->ofpacts_len);
2146 nfm = ofpbuf_put_zeros(msg, sizeof *nfm);
2147 nfm->command = ofputil_tid_command(fm, protocol);
2148 nfm->cookie = fm->new_cookie;
2149 match_len = nx_put_match(msg, &fm->match, fm->cookie, fm->cookie_mask);
2151 nfm->idle_timeout = htons(fm->idle_timeout);
2152 nfm->hard_timeout = htons(fm->hard_timeout);
2153 nfm->priority = htons(fm->priority);
2154 nfm->buffer_id = htonl(fm->buffer_id);
2155 nfm->out_port = htons(ofp_to_u16(fm->out_port));
2156 nfm->flags = raw_flags;
2157 nfm->match_len = htons(match_len);
2158 ofpacts_put_openflow_actions(fm->ofpacts, fm->ofpacts_len, msg,
2167 ofpmsg_update_length(msg);
2172 ofputil_decode_ofpst10_flow_request(struct ofputil_flow_stats_request *fsr,
2173 const struct ofp10_flow_stats_request *ofsr,
2176 fsr->aggregate = aggregate;
2177 ofputil_match_from_ofp10_match(&ofsr->match, &fsr->match);
2178 fsr->out_port = u16_to_ofp(ntohs(ofsr->out_port));
2179 fsr->out_group = OFPG11_ANY;
2180 fsr->table_id = ofsr->table_id;
2181 fsr->cookie = fsr->cookie_mask = htonll(0);
2187 ofputil_decode_ofpst11_flow_request(struct ofputil_flow_stats_request *fsr,
2188 struct ofpbuf *b, bool aggregate)
2190 const struct ofp11_flow_stats_request *ofsr;
2193 ofsr = ofpbuf_pull(b, sizeof *ofsr);
2194 fsr->aggregate = aggregate;
2195 fsr->table_id = ofsr->table_id;
2196 error = ofputil_port_from_ofp11(ofsr->out_port, &fsr->out_port);
2200 fsr->out_group = ntohl(ofsr->out_group);
2201 fsr->cookie = ofsr->cookie;
2202 fsr->cookie_mask = ofsr->cookie_mask;
2203 error = ofputil_pull_ofp11_match(b, &fsr->match, NULL);
2212 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
2213 struct ofpbuf *b, bool aggregate)
2215 const struct nx_flow_stats_request *nfsr;
2218 nfsr = ofpbuf_pull(b, sizeof *nfsr);
2219 error = nx_pull_match(b, ntohs(nfsr->match_len), &fsr->match,
2220 &fsr->cookie, &fsr->cookie_mask);
2225 return OFPERR_OFPBRC_BAD_LEN;
2228 fsr->aggregate = aggregate;
2229 fsr->out_port = u16_to_ofp(ntohs(nfsr->out_port));
2230 fsr->out_group = OFPG11_ANY;
2231 fsr->table_id = nfsr->table_id;
2236 /* Constructs and returns an OFPT_QUEUE_GET_CONFIG request for the specified
2237 * 'port', suitable for OpenFlow version 'version'. */
2239 ofputil_encode_queue_get_config_request(enum ofp_version version,
2242 struct ofpbuf *request;
2244 if (version == OFP10_VERSION) {
2245 struct ofp10_queue_get_config_request *qgcr10;
2247 request = ofpraw_alloc(OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST,
2249 qgcr10 = ofpbuf_put_zeros(request, sizeof *qgcr10);
2250 qgcr10->port = htons(ofp_to_u16(port));
2252 struct ofp11_queue_get_config_request *qgcr11;
2254 request = ofpraw_alloc(OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST,
2256 qgcr11 = ofpbuf_put_zeros(request, sizeof *qgcr11);
2257 qgcr11->port = ofputil_port_to_ofp11(port);
2263 /* Parses OFPT_QUEUE_GET_CONFIG request 'oh', storing the port specified by the
2264 * request into '*port'. Returns 0 if successful, otherwise an OpenFlow error
2267 ofputil_decode_queue_get_config_request(const struct ofp_header *oh,
2270 const struct ofp10_queue_get_config_request *qgcr10;
2271 const struct ofp11_queue_get_config_request *qgcr11;
2275 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2276 raw = ofpraw_pull_assert(&b);
2278 switch ((int) raw) {
2279 case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST:
2281 *port = u16_to_ofp(ntohs(qgcr10->port));
2284 case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST:
2286 return ofputil_port_from_ofp11(qgcr11->port, port);
2292 /* Constructs and returns the beginning of a reply to
2293 * OFPT_QUEUE_GET_CONFIG_REQUEST 'oh'. The caller may append information about
2294 * individual queues with ofputil_append_queue_get_config_reply(). */
2296 ofputil_encode_queue_get_config_reply(const struct ofp_header *oh)
2298 struct ofp10_queue_get_config_reply *qgcr10;
2299 struct ofp11_queue_get_config_reply *qgcr11;
2300 struct ofpbuf *reply;
2306 error = ofputil_decode_queue_get_config_request(oh, &port);
2309 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2310 raw = ofpraw_pull_assert(&b);
2312 switch ((int) raw) {
2313 case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST:
2314 reply = ofpraw_alloc_reply(OFPRAW_OFPT10_QUEUE_GET_CONFIG_REPLY,
2316 qgcr10 = ofpbuf_put_zeros(reply, sizeof *qgcr10);
2317 qgcr10->port = htons(ofp_to_u16(port));
2320 case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST:
2321 reply = ofpraw_alloc_reply(OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY,
2323 qgcr11 = ofpbuf_put_zeros(reply, sizeof *qgcr11);
2324 qgcr11->port = ofputil_port_to_ofp11(port);
2335 put_queue_rate(struct ofpbuf *reply, enum ofp_queue_properties property,
2338 if (rate != UINT16_MAX) {
2339 struct ofp_queue_prop_rate *oqpr;
2341 oqpr = ofpbuf_put_zeros(reply, sizeof *oqpr);
2342 oqpr->prop_header.property = htons(property);
2343 oqpr->prop_header.len = htons(sizeof *oqpr);
2344 oqpr->rate = htons(rate);
2348 /* Appends a queue description for 'queue_id' to the
2349 * OFPT_QUEUE_GET_CONFIG_REPLY already in 'oh'. */
2351 ofputil_append_queue_get_config_reply(struct ofpbuf *reply,
2352 const struct ofputil_queue_config *oqc)
2354 const struct ofp_header *oh = reply->data;
2355 size_t start_ofs, len_ofs;
2358 start_ofs = reply->size;
2359 if (oh->version < OFP12_VERSION) {
2360 struct ofp10_packet_queue *opq10;
2362 opq10 = ofpbuf_put_zeros(reply, sizeof *opq10);
2363 opq10->queue_id = htonl(oqc->queue_id);
2364 len_ofs = (char *) &opq10->len - (char *) reply->data;
2366 struct ofp11_queue_get_config_reply *qgcr11;
2367 struct ofp12_packet_queue *opq12;
2371 port = qgcr11->port;
2373 opq12 = ofpbuf_put_zeros(reply, sizeof *opq12);
2375 opq12->queue_id = htonl(oqc->queue_id);
2376 len_ofs = (char *) &opq12->len - (char *) reply->data;
2379 put_queue_rate(reply, OFPQT_MIN_RATE, oqc->min_rate);
2380 put_queue_rate(reply, OFPQT_MAX_RATE, oqc->max_rate);
2382 len = ofpbuf_at(reply, len_ofs, sizeof *len);
2383 *len = htons(reply->size - start_ofs);
2386 /* Decodes the initial part of an OFPT_QUEUE_GET_CONFIG_REPLY from 'reply' and
2387 * stores in '*port' the port that the reply is about. The caller may call
2388 * ofputil_pull_queue_get_config_reply() to obtain information about individual
2389 * queues included in the reply. Returns 0 if successful, otherwise an
2392 ofputil_decode_queue_get_config_reply(struct ofpbuf *reply, ofp_port_t *port)
2394 const struct ofp10_queue_get_config_reply *qgcr10;
2395 const struct ofp11_queue_get_config_reply *qgcr11;
2398 raw = ofpraw_pull_assert(reply);
2399 switch ((int) raw) {
2400 case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REPLY:
2401 qgcr10 = ofpbuf_pull(reply, sizeof *qgcr10);
2402 *port = u16_to_ofp(ntohs(qgcr10->port));
2405 case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY:
2406 qgcr11 = ofpbuf_pull(reply, sizeof *qgcr11);
2407 return ofputil_port_from_ofp11(qgcr11->port, port);
2414 parse_queue_rate(const struct ofp_queue_prop_header *hdr, uint16_t *rate)
2416 const struct ofp_queue_prop_rate *oqpr;
2418 if (hdr->len == htons(sizeof *oqpr)) {
2419 oqpr = (const struct ofp_queue_prop_rate *) hdr;
2420 *rate = ntohs(oqpr->rate);
2423 return OFPERR_OFPBRC_BAD_LEN;
2427 /* Decodes information about a queue from the OFPT_QUEUE_GET_CONFIG_REPLY in
2428 * 'reply' and stores it in '*queue'. ofputil_decode_queue_get_config_reply()
2429 * must already have pulled off the main header.
2431 * This function returns EOF if the last queue has already been decoded, 0 if a
2432 * queue was successfully decoded into '*queue', or an ofperr if there was a
2433 * problem decoding 'reply'. */
2435 ofputil_pull_queue_get_config_reply(struct ofpbuf *reply,
2436 struct ofputil_queue_config *queue)
2438 const struct ofp_header *oh;
2439 unsigned int opq_len;
2446 queue->min_rate = UINT16_MAX;
2447 queue->max_rate = UINT16_MAX;
2450 if (oh->version < OFP12_VERSION) {
2451 const struct ofp10_packet_queue *opq10;
2453 opq10 = ofpbuf_try_pull(reply, sizeof *opq10);
2455 return OFPERR_OFPBRC_BAD_LEN;
2457 queue->queue_id = ntohl(opq10->queue_id);
2458 len = ntohs(opq10->len);
2459 opq_len = sizeof *opq10;
2461 const struct ofp12_packet_queue *opq12;
2463 opq12 = ofpbuf_try_pull(reply, sizeof *opq12);
2465 return OFPERR_OFPBRC_BAD_LEN;
2467 queue->queue_id = ntohl(opq12->queue_id);
2468 len = ntohs(opq12->len);
2469 opq_len = sizeof *opq12;
2472 if (len < opq_len || len > reply->size + opq_len || len % 8) {
2473 return OFPERR_OFPBRC_BAD_LEN;
2478 const struct ofp_queue_prop_header *hdr;
2479 unsigned int property;
2480 unsigned int prop_len;
2481 enum ofperr error = 0;
2483 hdr = ofpbuf_at_assert(reply, 0, sizeof *hdr);
2484 prop_len = ntohs(hdr->len);
2485 if (prop_len < sizeof *hdr || prop_len > reply->size || prop_len % 8) {
2486 return OFPERR_OFPBRC_BAD_LEN;
2489 property = ntohs(hdr->property);
2491 case OFPQT_MIN_RATE:
2492 error = parse_queue_rate(hdr, &queue->min_rate);
2495 case OFPQT_MAX_RATE:
2496 error = parse_queue_rate(hdr, &queue->max_rate);
2500 VLOG_INFO_RL(&bad_ofmsg_rl, "unknown queue property %u", property);
2507 ofpbuf_pull(reply, prop_len);
2513 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
2514 * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
2515 * successful, otherwise an OpenFlow error code. */
2517 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
2518 const struct ofp_header *oh)
2523 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2524 raw = ofpraw_pull_assert(&b);
2525 switch ((int) raw) {
2526 case OFPRAW_OFPST10_FLOW_REQUEST:
2527 return ofputil_decode_ofpst10_flow_request(fsr, b.data, false);
2529 case OFPRAW_OFPST10_AGGREGATE_REQUEST:
2530 return ofputil_decode_ofpst10_flow_request(fsr, b.data, true);
2532 case OFPRAW_OFPST11_FLOW_REQUEST:
2533 return ofputil_decode_ofpst11_flow_request(fsr, &b, false);
2535 case OFPRAW_OFPST11_AGGREGATE_REQUEST:
2536 return ofputil_decode_ofpst11_flow_request(fsr, &b, true);
2538 case OFPRAW_NXST_FLOW_REQUEST:
2539 return ofputil_decode_nxst_flow_request(fsr, &b, false);
2541 case OFPRAW_NXST_AGGREGATE_REQUEST:
2542 return ofputil_decode_nxst_flow_request(fsr, &b, true);
2545 /* Hey, the caller lied. */
2550 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
2551 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
2552 * 'protocol', and returns the message. */
2554 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
2555 enum ofputil_protocol protocol)
2561 case OFPUTIL_P_OF11_STD:
2562 case OFPUTIL_P_OF12_OXM:
2563 case OFPUTIL_P_OF13_OXM: {
2564 struct ofp11_flow_stats_request *ofsr;
2566 raw = (fsr->aggregate
2567 ? OFPRAW_OFPST11_AGGREGATE_REQUEST
2568 : OFPRAW_OFPST11_FLOW_REQUEST);
2569 msg = ofpraw_alloc(raw, ofputil_protocol_to_ofp_version(protocol),
2570 ofputil_match_typical_len(protocol));
2571 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
2572 ofsr->table_id = fsr->table_id;
2573 ofsr->out_port = ofputil_port_to_ofp11(fsr->out_port);
2574 ofsr->out_group = htonl(fsr->out_group);
2575 ofsr->cookie = fsr->cookie;
2576 ofsr->cookie_mask = fsr->cookie_mask;
2577 ofputil_put_ofp11_match(msg, &fsr->match, protocol);
2581 case OFPUTIL_P_OF10_STD:
2582 case OFPUTIL_P_OF10_STD_TID: {
2583 struct ofp10_flow_stats_request *ofsr;
2585 raw = (fsr->aggregate
2586 ? OFPRAW_OFPST10_AGGREGATE_REQUEST
2587 : OFPRAW_OFPST10_FLOW_REQUEST);
2588 msg = ofpraw_alloc(raw, OFP10_VERSION, 0);
2589 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
2590 ofputil_match_to_ofp10_match(&fsr->match, &ofsr->match);
2591 ofsr->table_id = fsr->table_id;
2592 ofsr->out_port = htons(ofp_to_u16(fsr->out_port));
2596 case OFPUTIL_P_OF10_NXM:
2597 case OFPUTIL_P_OF10_NXM_TID: {
2598 struct nx_flow_stats_request *nfsr;
2601 raw = (fsr->aggregate
2602 ? OFPRAW_NXST_AGGREGATE_REQUEST
2603 : OFPRAW_NXST_FLOW_REQUEST);
2604 msg = ofpraw_alloc(raw, OFP10_VERSION, NXM_TYPICAL_LEN);
2605 ofpbuf_put_zeros(msg, sizeof *nfsr);
2606 match_len = nx_put_match(msg, &fsr->match,
2607 fsr->cookie, fsr->cookie_mask);
2610 nfsr->out_port = htons(ofp_to_u16(fsr->out_port));
2611 nfsr->match_len = htons(match_len);
2612 nfsr->table_id = fsr->table_id;
2623 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
2624 * ofputil_flow_stats in 'fs'.
2626 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
2627 * OpenFlow message. Calling this function multiple times for a single 'msg'
2628 * iterates through the replies. The caller must initially leave 'msg''s layer
2629 * pointers null and not modify them between calls.
2631 * Most switches don't send the values needed to populate fs->idle_age and
2632 * fs->hard_age, so those members will usually be set to 0. If the switch from
2633 * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
2634 * 'flow_age_extension' as true so that the contents of 'msg' determine the
2635 * 'idle_age' and 'hard_age' members in 'fs'.
2637 * Uses 'ofpacts' to store the abstract OFPACT_* version of the flow stats
2638 * reply's actions. The caller must initialize 'ofpacts' and retains ownership
2639 * of it. 'fs->ofpacts' will point into the 'ofpacts' buffer.
2641 * Returns 0 if successful, EOF if no replies were left in this 'msg',
2642 * otherwise a positive errno value. */
2644 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
2646 bool flow_age_extension,
2647 struct ofpbuf *ofpacts)
2649 const struct ofp_header *oh;
2654 ? ofpraw_decode(&raw, msg->l2)
2655 : ofpraw_pull(&raw, msg));
2663 } else if (raw == OFPRAW_OFPST11_FLOW_REPLY
2664 || raw == OFPRAW_OFPST13_FLOW_REPLY) {
2665 const struct ofp11_flow_stats *ofs;
2667 uint16_t padded_match_len;
2669 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2671 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %"PRIuSIZE" leftover "
2672 "bytes at end", msg->size);
2676 length = ntohs(ofs->length);
2677 if (length < sizeof *ofs) {
2678 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2679 "length %"PRIuSIZE, length);
2683 if (ofputil_pull_ofp11_match(msg, &fs->match, &padded_match_len)) {
2684 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad match");
2688 if (ofpacts_pull_openflow_instructions(msg, length - sizeof *ofs -
2689 padded_match_len, oh->version,
2691 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad instructions");
2695 fs->priority = ntohs(ofs->priority);
2696 fs->table_id = ofs->table_id;
2697 fs->duration_sec = ntohl(ofs->duration_sec);
2698 fs->duration_nsec = ntohl(ofs->duration_nsec);
2699 fs->idle_timeout = ntohs(ofs->idle_timeout);
2700 fs->hard_timeout = ntohs(ofs->hard_timeout);
2701 if (raw == OFPRAW_OFPST13_FLOW_REPLY) {
2702 error = ofputil_decode_flow_mod_flags(ofs->flags, -1, oh->version,
2712 fs->cookie = ofs->cookie;
2713 fs->packet_count = ntohll(ofs->packet_count);
2714 fs->byte_count = ntohll(ofs->byte_count);
2715 } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
2716 const struct ofp10_flow_stats *ofs;
2719 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2721 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %"PRIuSIZE" leftover "
2722 "bytes at end", msg->size);
2726 length = ntohs(ofs->length);
2727 if (length < sizeof *ofs) {
2728 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2729 "length %"PRIuSIZE, length);
2733 if (ofpacts_pull_openflow_actions(msg, length - sizeof *ofs,
2734 oh->version, ofpacts)) {
2738 fs->cookie = get_32aligned_be64(&ofs->cookie);
2739 ofputil_match_from_ofp10_match(&ofs->match, &fs->match);
2740 fs->priority = ntohs(ofs->priority);
2741 fs->table_id = ofs->table_id;
2742 fs->duration_sec = ntohl(ofs->duration_sec);
2743 fs->duration_nsec = ntohl(ofs->duration_nsec);
2744 fs->idle_timeout = ntohs(ofs->idle_timeout);
2745 fs->hard_timeout = ntohs(ofs->hard_timeout);
2748 fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
2749 fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
2751 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
2752 const struct nx_flow_stats *nfs;
2753 size_t match_len, actions_len, length;
2755 nfs = ofpbuf_try_pull(msg, sizeof *nfs);
2757 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %"PRIuSIZE" leftover "
2758 "bytes at end", msg->size);
2762 length = ntohs(nfs->length);
2763 match_len = ntohs(nfs->match_len);
2764 if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
2765 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%"PRIuSIZE" "
2766 "claims invalid length %"PRIuSIZE, match_len, length);
2769 if (nx_pull_match(msg, match_len, &fs->match, NULL, NULL)) {
2773 actions_len = length - sizeof *nfs - ROUND_UP(match_len, 8);
2774 if (ofpacts_pull_openflow_actions(msg, actions_len, oh->version,
2779 fs->cookie = nfs->cookie;
2780 fs->table_id = nfs->table_id;
2781 fs->duration_sec = ntohl(nfs->duration_sec);
2782 fs->duration_nsec = ntohl(nfs->duration_nsec);
2783 fs->priority = ntohs(nfs->priority);
2784 fs->idle_timeout = ntohs(nfs->idle_timeout);
2785 fs->hard_timeout = ntohs(nfs->hard_timeout);
2788 if (flow_age_extension) {
2789 if (nfs->idle_age) {
2790 fs->idle_age = ntohs(nfs->idle_age) - 1;
2792 if (nfs->hard_age) {
2793 fs->hard_age = ntohs(nfs->hard_age) - 1;
2796 fs->packet_count = ntohll(nfs->packet_count);
2797 fs->byte_count = ntohll(nfs->byte_count);
2803 fs->ofpacts = ofpacts->data;
2804 fs->ofpacts_len = ofpacts->size;
2809 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
2811 * We use this in situations where OVS internally uses UINT64_MAX to mean
2812 * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
2814 unknown_to_zero(uint64_t count)
2816 return count != UINT64_MAX ? count : 0;
2819 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
2820 * those already present in the list of ofpbufs in 'replies'. 'replies' should
2821 * have been initialized with ofpmp_init(). */
2823 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
2824 struct list *replies)
2826 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
2827 size_t start_ofs = reply->size;
2829 enum ofp_version version = ((struct ofp_header *)reply->data)->version;
2831 ofpraw_decode_partial(&raw, reply->data, reply->size);
2832 if (raw == OFPRAW_OFPST11_FLOW_REPLY || raw == OFPRAW_OFPST13_FLOW_REPLY) {
2833 struct ofp11_flow_stats *ofs;
2835 ofpbuf_put_uninit(reply, sizeof *ofs);
2836 oxm_put_match(reply, &fs->match);
2837 ofpacts_put_openflow_instructions(fs->ofpacts, fs->ofpacts_len, reply,
2840 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
2841 ofs->length = htons(reply->size - start_ofs);
2842 ofs->table_id = fs->table_id;
2844 ofs->duration_sec = htonl(fs->duration_sec);
2845 ofs->duration_nsec = htonl(fs->duration_nsec);
2846 ofs->priority = htons(fs->priority);
2847 ofs->idle_timeout = htons(fs->idle_timeout);
2848 ofs->hard_timeout = htons(fs->hard_timeout);
2849 if (raw == OFPRAW_OFPST13_FLOW_REPLY) {
2850 ofs->flags = ofputil_encode_flow_mod_flags(fs->flags, version);
2854 memset(ofs->pad2, 0, sizeof ofs->pad2);
2855 ofs->cookie = fs->cookie;
2856 ofs->packet_count = htonll(unknown_to_zero(fs->packet_count));
2857 ofs->byte_count = htonll(unknown_to_zero(fs->byte_count));
2858 } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
2859 struct ofp10_flow_stats *ofs;
2861 ofpbuf_put_uninit(reply, sizeof *ofs);
2862 ofpacts_put_openflow_actions(fs->ofpacts, fs->ofpacts_len, reply,
2864 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
2865 ofs->length = htons(reply->size - start_ofs);
2866 ofs->table_id = fs->table_id;
2868 ofputil_match_to_ofp10_match(&fs->match, &ofs->match);
2869 ofs->duration_sec = htonl(fs->duration_sec);
2870 ofs->duration_nsec = htonl(fs->duration_nsec);
2871 ofs->priority = htons(fs->priority);
2872 ofs->idle_timeout = htons(fs->idle_timeout);
2873 ofs->hard_timeout = htons(fs->hard_timeout);
2874 memset(ofs->pad2, 0, sizeof ofs->pad2);
2875 put_32aligned_be64(&ofs->cookie, fs->cookie);
2876 put_32aligned_be64(&ofs->packet_count,
2877 htonll(unknown_to_zero(fs->packet_count)));
2878 put_32aligned_be64(&ofs->byte_count,
2879 htonll(unknown_to_zero(fs->byte_count)));
2880 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
2881 struct nx_flow_stats *nfs;
2884 ofpbuf_put_uninit(reply, sizeof *nfs);
2885 match_len = nx_put_match(reply, &fs->match, 0, 0);
2886 ofpacts_put_openflow_actions(fs->ofpacts, fs->ofpacts_len, reply,
2888 nfs = ofpbuf_at_assert(reply, start_ofs, sizeof *nfs);
2889 nfs->length = htons(reply->size - start_ofs);
2890 nfs->table_id = fs->table_id;
2892 nfs->duration_sec = htonl(fs->duration_sec);
2893 nfs->duration_nsec = htonl(fs->duration_nsec);
2894 nfs->priority = htons(fs->priority);
2895 nfs->idle_timeout = htons(fs->idle_timeout);
2896 nfs->hard_timeout = htons(fs->hard_timeout);
2897 nfs->idle_age = htons(fs->idle_age < 0 ? 0
2898 : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
2900 nfs->hard_age = htons(fs->hard_age < 0 ? 0
2901 : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
2903 nfs->match_len = htons(match_len);
2904 nfs->cookie = fs->cookie;
2905 nfs->packet_count = htonll(fs->packet_count);
2906 nfs->byte_count = htonll(fs->byte_count);
2911 ofpmp_postappend(replies, start_ofs);
2914 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
2915 * NXST_AGGREGATE reply matching 'request', and returns the message. */
2917 ofputil_encode_aggregate_stats_reply(
2918 const struct ofputil_aggregate_stats *stats,
2919 const struct ofp_header *request)
2921 struct ofp_aggregate_stats_reply *asr;
2922 uint64_t packet_count;
2923 uint64_t byte_count;
2927 ofpraw_decode(&raw, request);
2928 if (raw == OFPRAW_OFPST10_AGGREGATE_REQUEST) {
2929 packet_count = unknown_to_zero(stats->packet_count);
2930 byte_count = unknown_to_zero(stats->byte_count);
2932 packet_count = stats->packet_count;
2933 byte_count = stats->byte_count;
2936 msg = ofpraw_alloc_stats_reply(request, 0);
2937 asr = ofpbuf_put_zeros(msg, sizeof *asr);
2938 put_32aligned_be64(&asr->packet_count, htonll(packet_count));
2939 put_32aligned_be64(&asr->byte_count, htonll(byte_count));
2940 asr->flow_count = htonl(stats->flow_count);
2946 ofputil_decode_aggregate_stats_reply(struct ofputil_aggregate_stats *stats,
2947 const struct ofp_header *reply)
2949 struct ofp_aggregate_stats_reply *asr;
2952 ofpbuf_use_const(&msg, reply, ntohs(reply->length));
2953 ofpraw_pull_assert(&msg);
2956 stats->packet_count = ntohll(get_32aligned_be64(&asr->packet_count));
2957 stats->byte_count = ntohll(get_32aligned_be64(&asr->byte_count));
2958 stats->flow_count = ntohl(asr->flow_count);
2963 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
2964 * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
2965 * an OpenFlow error code. */
2967 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
2968 const struct ofp_header *oh)
2973 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2974 raw = ofpraw_pull_assert(&b);
2975 if (raw == OFPRAW_OFPT11_FLOW_REMOVED) {
2976 const struct ofp12_flow_removed *ofr;
2979 ofr = ofpbuf_pull(&b, sizeof *ofr);
2981 error = ofputil_pull_ofp11_match(&b, &fr->match, NULL);
2986 fr->priority = ntohs(ofr->priority);
2987 fr->cookie = ofr->cookie;
2988 fr->reason = ofr->reason;
2989 fr->table_id = ofr->table_id;
2990 fr->duration_sec = ntohl(ofr->duration_sec);
2991 fr->duration_nsec = ntohl(ofr->duration_nsec);
2992 fr->idle_timeout = ntohs(ofr->idle_timeout);
2993 fr->hard_timeout = ntohs(ofr->hard_timeout);
2994 fr->packet_count = ntohll(ofr->packet_count);
2995 fr->byte_count = ntohll(ofr->byte_count);
2996 } else if (raw == OFPRAW_OFPT10_FLOW_REMOVED) {
2997 const struct ofp10_flow_removed *ofr;
2999 ofr = ofpbuf_pull(&b, sizeof *ofr);
3001 ofputil_match_from_ofp10_match(&ofr->match, &fr->match);
3002 fr->priority = ntohs(ofr->priority);
3003 fr->cookie = ofr->cookie;
3004 fr->reason = ofr->reason;
3006 fr->duration_sec = ntohl(ofr->duration_sec);
3007 fr->duration_nsec = ntohl(ofr->duration_nsec);
3008 fr->idle_timeout = ntohs(ofr->idle_timeout);
3009 fr->hard_timeout = 0;
3010 fr->packet_count = ntohll(ofr->packet_count);
3011 fr->byte_count = ntohll(ofr->byte_count);
3012 } else if (raw == OFPRAW_NXT_FLOW_REMOVED) {
3013 struct nx_flow_removed *nfr;
3016 nfr = ofpbuf_pull(&b, sizeof *nfr);
3017 error = nx_pull_match(&b, ntohs(nfr->match_len), &fr->match,
3023 return OFPERR_OFPBRC_BAD_LEN;
3026 fr->priority = ntohs(nfr->priority);
3027 fr->cookie = nfr->cookie;
3028 fr->reason = nfr->reason;
3029 fr->table_id = nfr->table_id ? nfr->table_id - 1 : 255;
3030 fr->duration_sec = ntohl(nfr->duration_sec);
3031 fr->duration_nsec = ntohl(nfr->duration_nsec);
3032 fr->idle_timeout = ntohs(nfr->idle_timeout);
3033 fr->hard_timeout = 0;
3034 fr->packet_count = ntohll(nfr->packet_count);
3035 fr->byte_count = ntohll(nfr->byte_count);
3043 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
3044 * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
3047 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
3048 enum ofputil_protocol protocol)
3053 case OFPUTIL_P_OF11_STD:
3054 case OFPUTIL_P_OF12_OXM:
3055 case OFPUTIL_P_OF13_OXM: {
3056 struct ofp12_flow_removed *ofr;
3058 msg = ofpraw_alloc_xid(OFPRAW_OFPT11_FLOW_REMOVED,
3059 ofputil_protocol_to_ofp_version(protocol),
3061 ofputil_match_typical_len(protocol));
3062 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
3063 ofr->cookie = fr->cookie;
3064 ofr->priority = htons(fr->priority);
3065 ofr->reason = fr->reason;
3066 ofr->table_id = fr->table_id;
3067 ofr->duration_sec = htonl(fr->duration_sec);
3068 ofr->duration_nsec = htonl(fr->duration_nsec);
3069 ofr->idle_timeout = htons(fr->idle_timeout);
3070 ofr->hard_timeout = htons(fr->hard_timeout);
3071 ofr->packet_count = htonll(fr->packet_count);
3072 ofr->byte_count = htonll(fr->byte_count);
3073 ofputil_put_ofp11_match(msg, &fr->match, protocol);
3077 case OFPUTIL_P_OF10_STD:
3078 case OFPUTIL_P_OF10_STD_TID: {
3079 struct ofp10_flow_removed *ofr;
3081 msg = ofpraw_alloc_xid(OFPRAW_OFPT10_FLOW_REMOVED, OFP10_VERSION,
3083 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
3084 ofputil_match_to_ofp10_match(&fr->match, &ofr->match);
3085 ofr->cookie = fr->cookie;
3086 ofr->priority = htons(fr->priority);
3087 ofr->reason = fr->reason;
3088 ofr->duration_sec = htonl(fr->duration_sec);
3089 ofr->duration_nsec = htonl(fr->duration_nsec);
3090 ofr->idle_timeout = htons(fr->idle_timeout);
3091 ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
3092 ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
3096 case OFPUTIL_P_OF10_NXM:
3097 case OFPUTIL_P_OF10_NXM_TID: {
3098 struct nx_flow_removed *nfr;
3101 msg = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_REMOVED, OFP10_VERSION,
3102 htonl(0), NXM_TYPICAL_LEN);
3103 nfr = ofpbuf_put_zeros(msg, sizeof *nfr);
3104 match_len = nx_put_match(msg, &fr->match, 0, 0);
3107 nfr->cookie = fr->cookie;
3108 nfr->priority = htons(fr->priority);
3109 nfr->reason = fr->reason;
3110 nfr->table_id = fr->table_id + 1;
3111 nfr->duration_sec = htonl(fr->duration_sec);
3112 nfr->duration_nsec = htonl(fr->duration_nsec);
3113 nfr->idle_timeout = htons(fr->idle_timeout);
3114 nfr->match_len = htons(match_len);
3115 nfr->packet_count = htonll(fr->packet_count);
3116 nfr->byte_count = htonll(fr->byte_count);
3128 ofputil_decode_packet_in_finish(struct ofputil_packet_in *pin,
3129 struct match *match, struct ofpbuf *b)
3131 pin->packet = b->data;
3132 pin->packet_len = b->size;
3134 pin->fmd.in_port = match->flow.in_port.ofp_port;
3135 pin->fmd.tun_id = match->flow.tunnel.tun_id;
3136 pin->fmd.tun_src = match->flow.tunnel.ip_src;
3137 pin->fmd.tun_dst = match->flow.tunnel.ip_dst;
3138 pin->fmd.metadata = match->flow.metadata;
3139 memcpy(pin->fmd.regs, match->flow.regs, sizeof pin->fmd.regs);
3140 pin->fmd.pkt_mark = match->flow.pkt_mark;
3144 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
3145 const struct ofp_header *oh)
3150 memset(pin, 0, sizeof *pin);
3151 pin->cookie = OVS_BE64_MAX;
3153 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3154 raw = ofpraw_pull_assert(&b);
3155 if (raw == OFPRAW_OFPT13_PACKET_IN || raw == OFPRAW_OFPT12_PACKET_IN) {
3156 const struct ofp13_packet_in *opi;
3159 size_t packet_in_size;
3161 if (raw == OFPRAW_OFPT12_PACKET_IN) {
3162 packet_in_size = sizeof (struct ofp12_packet_in);
3164 packet_in_size = sizeof (struct ofp13_packet_in);
3167 opi = ofpbuf_pull(&b, packet_in_size);
3168 error = oxm_pull_match_loose(&b, &match);
3173 if (!ofpbuf_try_pull(&b, 2)) {
3174 return OFPERR_OFPBRC_BAD_LEN;
3177 pin->reason = opi->pi.reason;
3178 pin->table_id = opi->pi.table_id;
3179 pin->buffer_id = ntohl(opi->pi.buffer_id);
3180 pin->total_len = ntohs(opi->pi.total_len);
3182 if (raw == OFPRAW_OFPT13_PACKET_IN) {
3183 pin->cookie = opi->cookie;
3186 ofputil_decode_packet_in_finish(pin, &match, &b);
3187 } else if (raw == OFPRAW_OFPT10_PACKET_IN) {
3188 const struct ofp10_packet_in *opi;
3190 opi = ofpbuf_pull(&b, offsetof(struct ofp10_packet_in, data));
3192 pin->packet = opi->data;
3193 pin->packet_len = b.size;
3195 pin->fmd.in_port = u16_to_ofp(ntohs(opi->in_port));
3196 pin->reason = opi->reason;
3197 pin->buffer_id = ntohl(opi->buffer_id);
3198 pin->total_len = ntohs(opi->total_len);
3199 } else if (raw == OFPRAW_NXT_PACKET_IN) {
3200 const struct nx_packet_in *npi;
3204 npi = ofpbuf_pull(&b, sizeof *npi);
3205 error = nx_pull_match_loose(&b, ntohs(npi->match_len), &match, NULL,
3211 if (!ofpbuf_try_pull(&b, 2)) {
3212 return OFPERR_OFPBRC_BAD_LEN;
3215 pin->reason = npi->reason;
3216 pin->table_id = npi->table_id;
3217 pin->cookie = npi->cookie;
3219 pin->buffer_id = ntohl(npi->buffer_id);
3220 pin->total_len = ntohs(npi->total_len);
3222 ofputil_decode_packet_in_finish(pin, &match, &b);
3231 ofputil_packet_in_to_match(const struct ofputil_packet_in *pin,
3232 struct match *match)
3236 match_init_catchall(match);
3237 if (pin->fmd.tun_id != htonll(0)) {
3238 match_set_tun_id(match, pin->fmd.tun_id);
3240 if (pin->fmd.tun_src != htonl(0)) {
3241 match_set_tun_src(match, pin->fmd.tun_src);
3243 if (pin->fmd.tun_dst != htonl(0)) {
3244 match_set_tun_dst(match, pin->fmd.tun_dst);
3246 if (pin->fmd.metadata != htonll(0)) {
3247 match_set_metadata(match, pin->fmd.metadata);
3250 for (i = 0; i < FLOW_N_REGS; i++) {
3251 if (pin->fmd.regs[i]) {
3252 match_set_reg(match, i, pin->fmd.regs[i]);
3256 if (pin->fmd.pkt_mark != 0) {
3257 match_set_pkt_mark(match, pin->fmd.pkt_mark);
3260 match_set_in_port(match, pin->fmd.in_port);
3263 static struct ofpbuf *
3264 ofputil_encode_ofp10_packet_in(const struct ofputil_packet_in *pin)
3266 struct ofp10_packet_in *opi;
3267 struct ofpbuf *packet;
3269 packet = ofpraw_alloc_xid(OFPRAW_OFPT10_PACKET_IN, OFP10_VERSION,
3270 htonl(0), pin->packet_len);
3271 opi = ofpbuf_put_zeros(packet, offsetof(struct ofp10_packet_in, data));
3272 opi->total_len = htons(pin->total_len);
3273 opi->in_port = htons(ofp_to_u16(pin->fmd.in_port));
3274 opi->reason = pin->reason;
3275 opi->buffer_id = htonl(pin->buffer_id);
3277 ofpbuf_put(packet, pin->packet, pin->packet_len);
3282 static struct ofpbuf *
3283 ofputil_encode_nx_packet_in(const struct ofputil_packet_in *pin)
3285 struct nx_packet_in *npi;
3286 struct ofpbuf *packet;
3290 ofputil_packet_in_to_match(pin, &match);
3292 /* The final argument is just an estimate of the space required. */
3293 packet = ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN, OFP10_VERSION,
3294 htonl(0), (sizeof(struct flow_metadata) * 2
3295 + 2 + pin->packet_len));
3296 ofpbuf_put_zeros(packet, sizeof *npi);
3297 match_len = nx_put_match(packet, &match, 0, 0);
3298 ofpbuf_put_zeros(packet, 2);
3299 ofpbuf_put(packet, pin->packet, pin->packet_len);
3302 npi->buffer_id = htonl(pin->buffer_id);
3303 npi->total_len = htons(pin->total_len);
3304 npi->reason = pin->reason;
3305 npi->table_id = pin->table_id;
3306 npi->cookie = pin->cookie;
3307 npi->match_len = htons(match_len);
3312 static struct ofpbuf *
3313 ofputil_encode_ofp12_packet_in(const struct ofputil_packet_in *pin,
3314 enum ofputil_protocol protocol)
3316 struct ofp13_packet_in *opi;
3318 enum ofpraw packet_in_raw;
3319 enum ofp_version packet_in_version;
3320 size_t packet_in_size;
3321 struct ofpbuf *packet;
3323 if (protocol == OFPUTIL_P_OF12_OXM) {
3324 packet_in_raw = OFPRAW_OFPT12_PACKET_IN;
3325 packet_in_version = OFP12_VERSION;
3326 packet_in_size = sizeof (struct ofp12_packet_in);
3328 packet_in_raw = OFPRAW_OFPT13_PACKET_IN;
3329 packet_in_version = OFP13_VERSION;
3330 packet_in_size = sizeof (struct ofp13_packet_in);
3333 ofputil_packet_in_to_match(pin, &match);
3335 /* The final argument is just an estimate of the space required. */
3336 packet = ofpraw_alloc_xid(packet_in_raw, packet_in_version,
3337 htonl(0), (sizeof(struct flow_metadata) * 2
3338 + 2 + pin->packet_len));
3339 ofpbuf_put_zeros(packet, packet_in_size);
3340 oxm_put_match(packet, &match);
3341 ofpbuf_put_zeros(packet, 2);
3342 ofpbuf_put(packet, pin->packet, pin->packet_len);
3345 opi->pi.buffer_id = htonl(pin->buffer_id);
3346 opi->pi.total_len = htons(pin->total_len);
3347 opi->pi.reason = pin->reason;
3348 opi->pi.table_id = pin->table_id;
3349 if (protocol == OFPUTIL_P_OF13_OXM) {
3350 opi->cookie = pin->cookie;
3356 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
3357 * in the format specified by 'packet_in_format'. */
3359 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
3360 enum ofputil_protocol protocol,
3361 enum nx_packet_in_format packet_in_format)
3363 struct ofpbuf *packet;
3366 case OFPUTIL_P_OF10_STD:
3367 case OFPUTIL_P_OF10_STD_TID:
3368 case OFPUTIL_P_OF10_NXM:
3369 case OFPUTIL_P_OF10_NXM_TID:
3370 packet = (packet_in_format == NXPIF_NXM
3371 ? ofputil_encode_nx_packet_in(pin)
3372 : ofputil_encode_ofp10_packet_in(pin));
3375 case OFPUTIL_P_OF11_STD:
3378 case OFPUTIL_P_OF12_OXM:
3379 case OFPUTIL_P_OF13_OXM:
3380 packet = ofputil_encode_ofp12_packet_in(pin, protocol);
3387 ofpmsg_update_length(packet);
3391 /* Returns a string form of 'reason'. The return value is either a statically
3392 * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
3393 * 'bufsize' should be at least OFPUTIL_PACKET_IN_REASON_BUFSIZE. */
3395 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason,
3396 char *reasonbuf, size_t bufsize)
3403 case OFPR_INVALID_TTL:
3404 return "invalid_ttl";
3406 case OFPR_N_REASONS:
3408 snprintf(reasonbuf, bufsize, "%d", (int) reason);
3414 ofputil_packet_in_reason_from_string(const char *s,
3415 enum ofp_packet_in_reason *reason)
3419 for (i = 0; i < OFPR_N_REASONS; i++) {
3420 char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
3421 const char *reason_s;
3423 reason_s = ofputil_packet_in_reason_to_string(i, reasonbuf,
3425 if (!strcasecmp(s, reason_s)) {
3433 /* Converts an OFPT_PACKET_OUT in 'opo' into an abstract ofputil_packet_out in
3436 * Uses 'ofpacts' to store the abstract OFPACT_* version of the packet out
3437 * message's actions. The caller must initialize 'ofpacts' and retains
3438 * ownership of it. 'po->ofpacts' will point into the 'ofpacts' buffer.
3440 * Returns 0 if successful, otherwise an OFPERR_* value. */
3442 ofputil_decode_packet_out(struct ofputil_packet_out *po,
3443 const struct ofp_header *oh,
3444 struct ofpbuf *ofpacts)
3449 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3450 raw = ofpraw_pull_assert(&b);
3452 if (raw == OFPRAW_OFPT11_PACKET_OUT) {
3454 const struct ofp11_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
3456 po->buffer_id = ntohl(opo->buffer_id);
3457 error = ofputil_port_from_ofp11(opo->in_port, &po->in_port);
3462 error = ofpacts_pull_openflow_actions(&b, ntohs(opo->actions_len),
3463 oh->version, ofpacts);
3467 } else if (raw == OFPRAW_OFPT10_PACKET_OUT) {
3469 const struct ofp10_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
3471 po->buffer_id = ntohl(opo->buffer_id);
3472 po->in_port = u16_to_ofp(ntohs(opo->in_port));
3474 error = ofpacts_pull_openflow_actions(&b, ntohs(opo->actions_len),
3475 oh->version, ofpacts);
3483 if (ofp_to_u16(po->in_port) >= ofp_to_u16(OFPP_MAX)
3484 && po->in_port != OFPP_LOCAL
3485 && po->in_port != OFPP_NONE && po->in_port != OFPP_CONTROLLER) {
3486 VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
3488 return OFPERR_OFPBRC_BAD_PORT;
3491 po->ofpacts = ofpacts->data;
3492 po->ofpacts_len = ofpacts->size;
3494 if (po->buffer_id == UINT32_MAX) {
3495 po->packet = b.data;
3496 po->packet_len = b.size;
3505 /* ofputil_phy_port */
3507 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
3508 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
3509 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
3510 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
3511 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
3512 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
3513 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
3514 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
3516 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
3517 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
3518 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
3519 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
3520 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
3521 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
3523 static enum netdev_features
3524 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
3526 uint32_t ofp10 = ntohl(ofp10_);
3527 return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
3531 netdev_port_features_to_ofp10(enum netdev_features features)
3533 return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
3536 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
3537 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
3538 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
3539 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
3540 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
3541 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
3542 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
3543 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD == OFPPF11_40GB_FD); /* bit 7 */
3544 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD == OFPPF11_100GB_FD); /* bit 8 */
3545 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD == OFPPF11_1TB_FD); /* bit 9 */
3546 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER == OFPPF11_OTHER); /* bit 10 */
3547 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == OFPPF11_COPPER); /* bit 11 */
3548 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == OFPPF11_FIBER); /* bit 12 */
3549 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == OFPPF11_AUTONEG); /* bit 13 */
3550 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == OFPPF11_PAUSE); /* bit 14 */
3551 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
3553 static enum netdev_features
3554 netdev_port_features_from_ofp11(ovs_be32 ofp11)
3556 return ntohl(ofp11) & 0xffff;
3560 netdev_port_features_to_ofp11(enum netdev_features features)
3562 return htonl(features & 0xffff);
3566 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
3567 const struct ofp10_phy_port *opp)
3569 memset(pp, 0, sizeof *pp);
3571 pp->port_no = u16_to_ofp(ntohs(opp->port_no));
3572 memcpy(pp->hw_addr, opp->hw_addr, OFP_ETH_ALEN);
3573 ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
3575 pp->config = ntohl(opp->config) & OFPPC10_ALL;
3576 pp->state = ntohl(opp->state) & OFPPS10_ALL;
3578 pp->curr = netdev_port_features_from_ofp10(opp->curr);
3579 pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
3580 pp->supported = netdev_port_features_from_ofp10(opp->supported);
3581 pp->peer = netdev_port_features_from_ofp10(opp->peer);
3583 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
3584 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
3590 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
3591 const struct ofp11_port *op)
3595 memset(pp, 0, sizeof *pp);
3597 error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
3601 memcpy(pp->hw_addr, op->hw_addr, OFP_ETH_ALEN);
3602 ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
3604 pp->config = ntohl(op->config) & OFPPC11_ALL;
3605 pp->state = ntohl(op->state) & OFPPC11_ALL;
3607 pp->curr = netdev_port_features_from_ofp11(op->curr);
3608 pp->advertised = netdev_port_features_from_ofp11(op->advertised);
3609 pp->supported = netdev_port_features_from_ofp11(op->supported);
3610 pp->peer = netdev_port_features_from_ofp11(op->peer);
3612 pp->curr_speed = ntohl(op->curr_speed);
3613 pp->max_speed = ntohl(op->max_speed);
3619 ofputil_get_phy_port_size(enum ofp_version ofp_version)
3621 switch (ofp_version) {
3623 return sizeof(struct ofp10_phy_port);
3627 return sizeof(struct ofp11_port);
3634 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
3635 struct ofp10_phy_port *opp)
3637 memset(opp, 0, sizeof *opp);
3639 opp->port_no = htons(ofp_to_u16(pp->port_no));
3640 memcpy(opp->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
3641 ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
3643 opp->config = htonl(pp->config & OFPPC10_ALL);
3644 opp->state = htonl(pp->state & OFPPS10_ALL);
3646 opp->curr = netdev_port_features_to_ofp10(pp->curr);
3647 opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
3648 opp->supported = netdev_port_features_to_ofp10(pp->supported);
3649 opp->peer = netdev_port_features_to_ofp10(pp->peer);
3653 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
3654 struct ofp11_port *op)
3656 memset(op, 0, sizeof *op);
3658 op->port_no = ofputil_port_to_ofp11(pp->port_no);
3659 memcpy(op->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
3660 ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
3662 op->config = htonl(pp->config & OFPPC11_ALL);
3663 op->state = htonl(pp->state & OFPPS11_ALL);
3665 op->curr = netdev_port_features_to_ofp11(pp->curr);
3666 op->advertised = netdev_port_features_to_ofp11(pp->advertised);
3667 op->supported = netdev_port_features_to_ofp11(pp->supported);
3668 op->peer = netdev_port_features_to_ofp11(pp->peer);
3670 op->curr_speed = htonl(pp->curr_speed);
3671 op->max_speed = htonl(pp->max_speed);
3675 ofputil_put_phy_port(enum ofp_version ofp_version,
3676 const struct ofputil_phy_port *pp, struct ofpbuf *b)
3678 switch (ofp_version) {
3679 case OFP10_VERSION: {
3680 struct ofp10_phy_port *opp;
3681 if (b->size + sizeof *opp <= UINT16_MAX) {
3682 opp = ofpbuf_put_uninit(b, sizeof *opp);
3683 ofputil_encode_ofp10_phy_port(pp, opp);
3690 case OFP13_VERSION: {
3691 struct ofp11_port *op;
3692 if (b->size + sizeof *op <= UINT16_MAX) {
3693 op = ofpbuf_put_uninit(b, sizeof *op);
3694 ofputil_encode_ofp11_port(pp, op);
3705 ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
3706 const struct ofputil_phy_port *pp,
3707 struct list *replies)
3709 switch (ofp_version) {
3710 case OFP10_VERSION: {
3711 struct ofp10_phy_port *opp;
3713 opp = ofpmp_append(replies, sizeof *opp);
3714 ofputil_encode_ofp10_phy_port(pp, opp);
3720 case OFP13_VERSION: {
3721 struct ofp11_port *op;
3723 op = ofpmp_append(replies, sizeof *op);
3724 ofputil_encode_ofp11_port(pp, op);
3733 /* ofputil_switch_features */
3735 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
3736 OFPC_IP_REASM | OFPC_QUEUE_STATS)
3737 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
3738 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
3739 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
3740 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
3741 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
3742 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
3744 struct ofputil_action_bit_translation {
3745 enum ofputil_action_bitmap ofputil_bit;
3749 static const struct ofputil_action_bit_translation of10_action_bits[] = {
3750 { OFPUTIL_A_OUTPUT, OFPAT10_OUTPUT },
3751 { OFPUTIL_A_SET_VLAN_VID, OFPAT10_SET_VLAN_VID },
3752 { OFPUTIL_A_SET_VLAN_PCP, OFPAT10_SET_VLAN_PCP },
3753 { OFPUTIL_A_STRIP_VLAN, OFPAT10_STRIP_VLAN },
3754 { OFPUTIL_A_SET_DL_SRC, OFPAT10_SET_DL_SRC },
3755 { OFPUTIL_A_SET_DL_DST, OFPAT10_SET_DL_DST },
3756 { OFPUTIL_A_SET_NW_SRC, OFPAT10_SET_NW_SRC },
3757 { OFPUTIL_A_SET_NW_DST, OFPAT10_SET_NW_DST },
3758 { OFPUTIL_A_SET_NW_TOS, OFPAT10_SET_NW_TOS },
3759 { OFPUTIL_A_SET_TP_SRC, OFPAT10_SET_TP_SRC },
3760 { OFPUTIL_A_SET_TP_DST, OFPAT10_SET_TP_DST },
3761 { OFPUTIL_A_ENQUEUE, OFPAT10_ENQUEUE },
3765 static enum ofputil_action_bitmap
3766 decode_action_bits(ovs_be32 of_actions,
3767 const struct ofputil_action_bit_translation *x)
3769 enum ofputil_action_bitmap ofputil_actions;
3771 ofputil_actions = 0;
3772 for (; x->ofputil_bit; x++) {
3773 if (of_actions & htonl(1u << x->of_bit)) {
3774 ofputil_actions |= x->ofputil_bit;
3777 return ofputil_actions;
3781 ofputil_capabilities_mask(enum ofp_version ofp_version)
3783 /* Handle capabilities whose bit is unique for all Open Flow versions */
3784 switch (ofp_version) {
3787 return OFPC_COMMON | OFPC_ARP_MATCH_IP;
3790 return OFPC_COMMON | OFPC12_PORT_BLOCKED;
3792 /* Caller needs to check osf->header.version itself */
3797 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
3798 * abstract representation in '*features'. Initializes '*b' to iterate over
3799 * the OpenFlow port structures following 'osf' with later calls to
3800 * ofputil_pull_phy_port(). Returns 0 if successful, otherwise an
3801 * OFPERR_* value. */
3803 ofputil_decode_switch_features(const struct ofp_header *oh,
3804 struct ofputil_switch_features *features,
3807 const struct ofp_switch_features *osf;
3810 ofpbuf_use_const(b, oh, ntohs(oh->length));
3811 raw = ofpraw_pull_assert(b);
3813 osf = ofpbuf_pull(b, sizeof *osf);
3814 features->datapath_id = ntohll(osf->datapath_id);
3815 features->n_buffers = ntohl(osf->n_buffers);
3816 features->n_tables = osf->n_tables;
3817 features->auxiliary_id = 0;
3819 features->capabilities = ntohl(osf->capabilities) &
3820 ofputil_capabilities_mask(oh->version);
3822 if (b->size % ofputil_get_phy_port_size(oh->version)) {
3823 return OFPERR_OFPBRC_BAD_LEN;
3826 if (raw == OFPRAW_OFPT10_FEATURES_REPLY) {
3827 if (osf->capabilities & htonl(OFPC10_STP)) {
3828 features->capabilities |= OFPUTIL_C_STP;
3830 features->actions = decode_action_bits(osf->actions, of10_action_bits);
3831 } else if (raw == OFPRAW_OFPT11_FEATURES_REPLY
3832 || raw == OFPRAW_OFPT13_FEATURES_REPLY) {
3833 if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
3834 features->capabilities |= OFPUTIL_C_GROUP_STATS;
3836 features->actions = 0;
3837 if (raw == OFPRAW_OFPT13_FEATURES_REPLY) {
3838 features->auxiliary_id = osf->auxiliary_id;
3841 return OFPERR_OFPBRC_BAD_VERSION;
3847 /* Returns true if the maximum number of ports are in 'oh'. */
3849 max_ports_in_features(const struct ofp_header *oh)
3851 size_t pp_size = ofputil_get_phy_port_size(oh->version);
3852 return ntohs(oh->length) + pp_size > UINT16_MAX;
3855 /* Given a buffer 'b' that contains a Features Reply message, checks if
3856 * it contains the maximum number of ports that will fit. If so, it
3857 * returns true and removes the ports from the message. The caller
3858 * should then send an OFPST_PORT_DESC stats request to get the ports,
3859 * since the switch may have more ports than could be represented in the
3860 * Features Reply. Otherwise, returns false.
3863 ofputil_switch_features_ports_trunc(struct ofpbuf *b)
3865 struct ofp_header *oh = b->data;
3867 if (max_ports_in_features(oh)) {
3868 /* Remove all the ports. */
3869 b->size = (sizeof(struct ofp_header)
3870 + sizeof(struct ofp_switch_features));
3871 ofpmsg_update_length(b);
3880 encode_action_bits(enum ofputil_action_bitmap ofputil_actions,
3881 const struct ofputil_action_bit_translation *x)
3883 uint32_t of_actions;
3886 for (; x->ofputil_bit; x++) {
3887 if (ofputil_actions & x->ofputil_bit) {
3888 of_actions |= 1 << x->of_bit;
3891 return htonl(of_actions);
3894 /* Returns a buffer owned by the caller that encodes 'features' in the format
3895 * required by 'protocol' with the given 'xid'. The caller should append port
3896 * information to the buffer with subsequent calls to
3897 * ofputil_put_switch_features_port(). */
3899 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
3900 enum ofputil_protocol protocol, ovs_be32 xid)
3902 struct ofp_switch_features *osf;
3904 enum ofp_version version;
3907 version = ofputil_protocol_to_ofp_version(protocol);
3910 raw = OFPRAW_OFPT10_FEATURES_REPLY;
3914 raw = OFPRAW_OFPT11_FEATURES_REPLY;
3917 raw = OFPRAW_OFPT13_FEATURES_REPLY;
3922 b = ofpraw_alloc_xid(raw, version, xid, 0);
3923 osf = ofpbuf_put_zeros(b, sizeof *osf);
3924 osf->datapath_id = htonll(features->datapath_id);
3925 osf->n_buffers = htonl(features->n_buffers);
3926 osf->n_tables = features->n_tables;
3928 osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
3929 osf->capabilities = htonl(features->capabilities &
3930 ofputil_capabilities_mask(version));
3933 if (features->capabilities & OFPUTIL_C_STP) {
3934 osf->capabilities |= htonl(OFPC10_STP);
3936 osf->actions = encode_action_bits(features->actions, of10_action_bits);
3939 osf->auxiliary_id = features->auxiliary_id;
3943 if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
3944 osf->capabilities |= htonl(OFPC11_GROUP_STATS);
3954 /* Encodes 'pp' into the format required by the switch_features message already
3955 * in 'b', which should have been returned by ofputil_encode_switch_features(),
3956 * and appends the encoded version to 'b'. */
3958 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
3961 const struct ofp_header *oh = b->data;
3963 if (oh->version < OFP13_VERSION) {
3964 ofputil_put_phy_port(oh->version, pp, b);
3968 /* ofputil_port_status */
3970 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
3971 * in '*ps'. Returns 0 if successful, otherwise an OFPERR_* value. */
3973 ofputil_decode_port_status(const struct ofp_header *oh,
3974 struct ofputil_port_status *ps)
3976 const struct ofp_port_status *ops;
3980 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3981 ofpraw_pull_assert(&b);
3982 ops = ofpbuf_pull(&b, sizeof *ops);
3984 if (ops->reason != OFPPR_ADD &&
3985 ops->reason != OFPPR_DELETE &&
3986 ops->reason != OFPPR_MODIFY) {
3987 return OFPERR_NXBRC_BAD_REASON;
3989 ps->reason = ops->reason;
3991 retval = ofputil_pull_phy_port(oh->version, &b, &ps->desc);
3992 ovs_assert(retval != EOF);
3996 /* Converts the abstract form of a "port status" message in '*ps' into an
3997 * OpenFlow message suitable for 'protocol', and returns that encoded form in
3998 * a buffer owned by the caller. */
4000 ofputil_encode_port_status(const struct ofputil_port_status *ps,
4001 enum ofputil_protocol protocol)
4003 struct ofp_port_status *ops;
4005 enum ofp_version version;
4008 version = ofputil_protocol_to_ofp_version(protocol);
4011 raw = OFPRAW_OFPT10_PORT_STATUS;
4017 raw = OFPRAW_OFPT11_PORT_STATUS;
4024 b = ofpraw_alloc_xid(raw, version, htonl(0), 0);
4025 ops = ofpbuf_put_zeros(b, sizeof *ops);
4026 ops->reason = ps->reason;
4027 ofputil_put_phy_port(version, &ps->desc, b);
4028 ofpmsg_update_length(b);
4032 /* ofputil_port_mod */
4034 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
4035 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
4037 ofputil_decode_port_mod(const struct ofp_header *oh,
4038 struct ofputil_port_mod *pm)
4043 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4044 raw = ofpraw_pull_assert(&b);
4046 if (raw == OFPRAW_OFPT10_PORT_MOD) {
4047 const struct ofp10_port_mod *opm = b.data;
4049 pm->port_no = u16_to_ofp(ntohs(opm->port_no));
4050 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
4051 pm->config = ntohl(opm->config) & OFPPC10_ALL;
4052 pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
4053 pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
4054 } else if (raw == OFPRAW_OFPT11_PORT_MOD) {
4055 const struct ofp11_port_mod *opm = b.data;
4058 error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
4063 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
4064 pm->config = ntohl(opm->config) & OFPPC11_ALL;
4065 pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
4066 pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
4068 return OFPERR_OFPBRC_BAD_TYPE;
4071 pm->config &= pm->mask;
4075 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
4076 * message suitable for 'protocol', and returns that encoded form in a buffer
4077 * owned by the caller. */
4079 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
4080 enum ofputil_protocol protocol)
4082 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
4085 switch (ofp_version) {
4086 case OFP10_VERSION: {
4087 struct ofp10_port_mod *opm;
4089 b = ofpraw_alloc(OFPRAW_OFPT10_PORT_MOD, ofp_version, 0);
4090 opm = ofpbuf_put_zeros(b, sizeof *opm);
4091 opm->port_no = htons(ofp_to_u16(pm->port_no));
4092 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
4093 opm->config = htonl(pm->config & OFPPC10_ALL);
4094 opm->mask = htonl(pm->mask & OFPPC10_ALL);
4095 opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
4101 case OFP13_VERSION: {
4102 struct ofp11_port_mod *opm;
4104 b = ofpraw_alloc(OFPRAW_OFPT11_PORT_MOD, ofp_version, 0);
4105 opm = ofpbuf_put_zeros(b, sizeof *opm);
4106 opm->port_no = ofputil_port_to_ofp11(pm->port_no);
4107 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
4108 opm->config = htonl(pm->config & OFPPC11_ALL);
4109 opm->mask = htonl(pm->mask & OFPPC11_ALL);
4110 opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
4120 /* ofputil_table_mod */
4122 /* Decodes the OpenFlow "table mod" message in '*oh' into an abstract form in
4123 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
4125 ofputil_decode_table_mod(const struct ofp_header *oh,
4126 struct ofputil_table_mod *pm)
4131 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4132 raw = ofpraw_pull_assert(&b);
4134 if (raw == OFPRAW_OFPT11_TABLE_MOD) {
4135 const struct ofp11_table_mod *otm = b.data;
4137 pm->table_id = otm->table_id;
4138 pm->config = ntohl(otm->config);
4140 return OFPERR_OFPBRC_BAD_TYPE;
4146 /* Converts the abstract form of a "table mod" message in '*pm' into an OpenFlow
4147 * message suitable for 'protocol', and returns that encoded form in a buffer
4148 * owned by the caller. */
4150 ofputil_encode_table_mod(const struct ofputil_table_mod *pm,
4151 enum ofputil_protocol protocol)
4153 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
4156 switch (ofp_version) {
4157 case OFP10_VERSION: {
4158 ovs_fatal(0, "table mod needs OpenFlow 1.1 or later "
4159 "(\'-O OpenFlow11\')");
4164 case OFP13_VERSION: {
4165 struct ofp11_table_mod *otm;
4167 b = ofpraw_alloc(OFPRAW_OFPT11_TABLE_MOD, ofp_version, 0);
4168 otm = ofpbuf_put_zeros(b, sizeof *otm);
4169 otm->table_id = pm->table_id;
4170 otm->config = htonl(pm->config);
4180 /* ofputil_role_request */
4182 /* Decodes the OpenFlow "role request" or "role reply" message in '*oh' into
4183 * an abstract form in '*rr'. Returns 0 if successful, otherwise an
4184 * OFPERR_* value. */
4186 ofputil_decode_role_message(const struct ofp_header *oh,
4187 struct ofputil_role_request *rr)
4192 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4193 raw = ofpraw_pull_assert(&b);
4195 if (raw == OFPRAW_OFPT12_ROLE_REQUEST ||
4196 raw == OFPRAW_OFPT12_ROLE_REPLY) {
4197 const struct ofp12_role_request *orr = b.l3;
4199 if (orr->role != htonl(OFPCR12_ROLE_NOCHANGE) &&
4200 orr->role != htonl(OFPCR12_ROLE_EQUAL) &&
4201 orr->role != htonl(OFPCR12_ROLE_MASTER) &&
4202 orr->role != htonl(OFPCR12_ROLE_SLAVE)) {
4203 return OFPERR_OFPRRFC_BAD_ROLE;
4206 rr->role = ntohl(orr->role);
4207 if (raw == OFPRAW_OFPT12_ROLE_REQUEST
4208 ? orr->role == htonl(OFPCR12_ROLE_NOCHANGE)
4209 : orr->generation_id == OVS_BE64_MAX) {
4210 rr->have_generation_id = false;
4211 rr->generation_id = 0;
4213 rr->have_generation_id = true;
4214 rr->generation_id = ntohll(orr->generation_id);
4216 } else if (raw == OFPRAW_NXT_ROLE_REQUEST ||
4217 raw == OFPRAW_NXT_ROLE_REPLY) {
4218 const struct nx_role_request *nrr = b.l3;
4220 BUILD_ASSERT(NX_ROLE_OTHER + 1 == OFPCR12_ROLE_EQUAL);
4221 BUILD_ASSERT(NX_ROLE_MASTER + 1 == OFPCR12_ROLE_MASTER);
4222 BUILD_ASSERT(NX_ROLE_SLAVE + 1 == OFPCR12_ROLE_SLAVE);
4224 if (nrr->role != htonl(NX_ROLE_OTHER) &&
4225 nrr->role != htonl(NX_ROLE_MASTER) &&
4226 nrr->role != htonl(NX_ROLE_SLAVE)) {
4227 return OFPERR_OFPRRFC_BAD_ROLE;
4230 rr->role = ntohl(nrr->role) + 1;
4231 rr->have_generation_id = false;
4232 rr->generation_id = 0;
4240 /* Returns an encoded form of a role reply suitable for the "request" in a
4241 * buffer owned by the caller. */
4243 ofputil_encode_role_reply(const struct ofp_header *request,
4244 const struct ofputil_role_request *rr)
4249 raw = ofpraw_decode_assert(request);
4250 if (raw == OFPRAW_OFPT12_ROLE_REQUEST) {
4251 struct ofp12_role_request *orr;
4253 buf = ofpraw_alloc_reply(OFPRAW_OFPT12_ROLE_REPLY, request, 0);
4254 orr = ofpbuf_put_zeros(buf, sizeof *orr);
4256 orr->role = htonl(rr->role);
4257 orr->generation_id = htonll(rr->have_generation_id
4260 } else if (raw == OFPRAW_NXT_ROLE_REQUEST) {
4261 struct nx_role_request *nrr;
4263 BUILD_ASSERT(NX_ROLE_OTHER == OFPCR12_ROLE_EQUAL - 1);
4264 BUILD_ASSERT(NX_ROLE_MASTER == OFPCR12_ROLE_MASTER - 1);
4265 BUILD_ASSERT(NX_ROLE_SLAVE == OFPCR12_ROLE_SLAVE - 1);
4267 buf = ofpraw_alloc_reply(OFPRAW_NXT_ROLE_REPLY, request, 0);
4268 nrr = ofpbuf_put_zeros(buf, sizeof *nrr);
4269 nrr->role = htonl(rr->role - 1);
4278 ofputil_encode_role_status(const struct ofputil_role_status *status,
4279 enum ofputil_protocol protocol)
4282 enum ofp_version version;
4283 struct ofp14_role_status *rstatus;
4285 version = ofputil_protocol_to_ofp_version(protocol);
4286 buf = ofpraw_alloc_xid(OFPRAW_OFPT14_ROLE_STATUS, version, htonl(0), 0);
4287 rstatus = ofpbuf_put_zeros(buf, sizeof *rstatus);
4288 rstatus->role = htonl(status->role);
4289 rstatus->reason = status->reason;
4290 rstatus->generation_id = htonll(status->generation_id);
4296 ofputil_decode_role_status(const struct ofp_header *oh,
4297 struct ofputil_role_status *rs)
4301 const struct ofp14_role_status *r;
4303 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4304 raw = ofpraw_pull_assert(&b);
4305 ovs_assert(raw == OFPRAW_OFPT14_ROLE_STATUS);
4308 if (r->role != htonl(OFPCR12_ROLE_NOCHANGE) &&
4309 r->role != htonl(OFPCR12_ROLE_EQUAL) &&
4310 r->role != htonl(OFPCR12_ROLE_MASTER) &&
4311 r->role != htonl(OFPCR12_ROLE_SLAVE)) {
4312 return OFPERR_OFPRRFC_BAD_ROLE;
4315 rs->role = ntohl(r->role);
4316 rs->generation_id = ntohll(r->generation_id);
4317 rs->reason = r->reason;
4325 ofputil_put_ofp10_table_stats(const struct ofp12_table_stats *in,
4329 enum ofp10_flow_wildcards wc10;
4330 enum oxm12_ofb_match_fields mf12;
4333 static const struct wc_map wc_map[] = {
4334 { OFPFW10_IN_PORT, OFPXMT12_OFB_IN_PORT },
4335 { OFPFW10_DL_VLAN, OFPXMT12_OFB_VLAN_VID },
4336 { OFPFW10_DL_SRC, OFPXMT12_OFB_ETH_SRC },
4337 { OFPFW10_DL_DST, OFPXMT12_OFB_ETH_DST},
4338 { OFPFW10_DL_TYPE, OFPXMT12_OFB_ETH_TYPE },
4339 { OFPFW10_NW_PROTO, OFPXMT12_OFB_IP_PROTO },
4340 { OFPFW10_TP_SRC, OFPXMT12_OFB_TCP_SRC },
4341 { OFPFW10_TP_DST, OFPXMT12_OFB_TCP_DST },
4342 { OFPFW10_NW_SRC_MASK, OFPXMT12_OFB_IPV4_SRC },
4343 { OFPFW10_NW_DST_MASK, OFPXMT12_OFB_IPV4_DST },
4344 { OFPFW10_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP },
4345 { OFPFW10_NW_TOS, OFPXMT12_OFB_IP_DSCP },
4348 struct ofp10_table_stats *out;
4349 const struct wc_map *p;
4351 out = ofpbuf_put_zeros(buf, sizeof *out);
4352 out->table_id = in->table_id;
4353 ovs_strlcpy(out->name, in->name, sizeof out->name);
4355 for (p = wc_map; p < &wc_map[ARRAY_SIZE(wc_map)]; p++) {
4356 if (in->wildcards & htonll(1ULL << p->mf12)) {
4357 out->wildcards |= htonl(p->wc10);
4360 out->max_entries = in->max_entries;
4361 out->active_count = in->active_count;
4362 put_32aligned_be64(&out->lookup_count, in->lookup_count);
4363 put_32aligned_be64(&out->matched_count, in->matched_count);
4367 oxm12_to_ofp11_flow_match_fields(ovs_be64 oxm12)
4370 enum ofp11_flow_match_fields fmf11;
4371 enum oxm12_ofb_match_fields mf12;
4374 static const struct map map[] = {
4375 { OFPFMF11_IN_PORT, OFPXMT12_OFB_IN_PORT },
4376 { OFPFMF11_DL_VLAN, OFPXMT12_OFB_VLAN_VID },
4377 { OFPFMF11_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP },
4378 { OFPFMF11_DL_TYPE, OFPXMT12_OFB_ETH_TYPE },
4379 { OFPFMF11_NW_TOS, OFPXMT12_OFB_IP_DSCP },
4380 { OFPFMF11_NW_PROTO, OFPXMT12_OFB_IP_PROTO },
4381 { OFPFMF11_TP_SRC, OFPXMT12_OFB_TCP_SRC },
4382 { OFPFMF11_TP_DST, OFPXMT12_OFB_TCP_DST },
4383 { OFPFMF11_MPLS_LABEL, OFPXMT12_OFB_MPLS_LABEL },
4384 { OFPFMF11_MPLS_TC, OFPXMT12_OFB_MPLS_TC },
4385 /* I don't know what OFPFMF11_TYPE means. */
4386 { OFPFMF11_DL_SRC, OFPXMT12_OFB_ETH_SRC },
4387 { OFPFMF11_DL_DST, OFPXMT12_OFB_ETH_DST },
4388 { OFPFMF11_NW_SRC, OFPXMT12_OFB_IPV4_SRC },
4389 { OFPFMF11_NW_DST, OFPXMT12_OFB_IPV4_DST },
4390 { OFPFMF11_METADATA, OFPXMT12_OFB_METADATA },
4393 const struct map *p;
4397 for (p = map; p < &map[ARRAY_SIZE(map)]; p++) {
4398 if (oxm12 & htonll(1ULL << p->mf12)) {
4402 return htonl(fmf11);
4406 ofputil_put_ofp11_table_stats(const struct ofp12_table_stats *in,
4409 struct ofp11_table_stats *out;
4411 out = ofpbuf_put_zeros(buf, sizeof *out);
4412 out->table_id = in->table_id;
4413 ovs_strlcpy(out->name, in->name, sizeof out->name);
4414 out->wildcards = oxm12_to_ofp11_flow_match_fields(in->wildcards);
4415 out->match = oxm12_to_ofp11_flow_match_fields(in->match);
4416 out->instructions = in->instructions;
4417 out->write_actions = in->write_actions;
4418 out->apply_actions = in->apply_actions;
4419 out->config = in->config;
4420 out->max_entries = in->max_entries;
4421 out->active_count = in->active_count;
4422 out->lookup_count = in->lookup_count;
4423 out->matched_count = in->matched_count;
4427 ofputil_put_ofp12_table_stats(const struct ofp12_table_stats *in,
4430 struct ofp12_table_stats *out = ofpbuf_put(buf, in, sizeof *in);
4432 /* Trim off OF1.3-only capabilities. */
4433 out->match &= htonll(OFPXMT12_MASK);
4434 out->wildcards &= htonll(OFPXMT12_MASK);
4435 out->write_setfields &= htonll(OFPXMT12_MASK);
4436 out->apply_setfields &= htonll(OFPXMT12_MASK);
4440 ofputil_put_ofp13_table_stats(const struct ofp12_table_stats *in,
4443 struct ofp13_table_stats *out;
4445 /* OF 1.3 splits table features off the ofp_table_stats,
4446 * so there is not much here. */
4448 out = ofpbuf_put_uninit(buf, sizeof *out);
4449 out->table_id = in->table_id;
4450 out->active_count = in->active_count;
4451 out->lookup_count = in->lookup_count;
4452 out->matched_count = in->matched_count;
4456 ofputil_encode_table_stats_reply(const struct ofp12_table_stats stats[], int n,
4457 const struct ofp_header *request)
4459 struct ofpbuf *reply;
4462 reply = ofpraw_alloc_stats_reply(request, n * sizeof *stats);
4464 for (i = 0; i < n; i++) {
4465 switch ((enum ofp_version) request->version) {
4467 ofputil_put_ofp10_table_stats(&stats[i], reply);
4471 ofputil_put_ofp11_table_stats(&stats[i], reply);
4475 ofputil_put_ofp12_table_stats(&stats[i], reply);
4479 ofputil_put_ofp13_table_stats(&stats[i], reply);
4490 /* ofputil_flow_monitor_request */
4492 /* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract
4493 * ofputil_flow_monitor_request in 'rq'.
4495 * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow
4496 * message. Calling this function multiple times for a single 'msg' iterates
4497 * through the requests. The caller must initially leave 'msg''s layer
4498 * pointers null and not modify them between calls.
4500 * Returns 0 if successful, EOF if no requests were left in this 'msg',
4501 * otherwise an OFPERR_* value. */
4503 ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *rq,
4506 struct nx_flow_monitor_request *nfmr;
4510 msg->l2 = msg->data;
4511 ofpraw_pull_assert(msg);
4518 nfmr = ofpbuf_try_pull(msg, sizeof *nfmr);
4520 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR request has %"PRIuSIZE" "
4521 "leftover bytes at end", msg->size);
4522 return OFPERR_OFPBRC_BAD_LEN;
4525 flags = ntohs(nfmr->flags);
4526 if (!(flags & (NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY))
4527 || flags & ~(NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE
4528 | NXFMF_MODIFY | NXFMF_ACTIONS | NXFMF_OWN)) {
4529 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR has bad flags %#"PRIx16,
4531 return OFPERR_NXBRC_FM_BAD_FLAGS;
4534 if (!is_all_zeros(nfmr->zeros, sizeof nfmr->zeros)) {
4535 return OFPERR_NXBRC_MUST_BE_ZERO;
4538 rq->id = ntohl(nfmr->id);
4540 rq->out_port = u16_to_ofp(ntohs(nfmr->out_port));
4541 rq->table_id = nfmr->table_id;
4543 return nx_pull_match(msg, ntohs(nfmr->match_len), &rq->match, NULL, NULL);
4547 ofputil_append_flow_monitor_request(
4548 const struct ofputil_flow_monitor_request *rq, struct ofpbuf *msg)
4550 struct nx_flow_monitor_request *nfmr;
4555 ofpraw_put(OFPRAW_NXST_FLOW_MONITOR_REQUEST, OFP10_VERSION, msg);
4558 start_ofs = msg->size;
4559 ofpbuf_put_zeros(msg, sizeof *nfmr);
4560 match_len = nx_put_match(msg, &rq->match, htonll(0), htonll(0));
4562 nfmr = ofpbuf_at_assert(msg, start_ofs, sizeof *nfmr);
4563 nfmr->id = htonl(rq->id);
4564 nfmr->flags = htons(rq->flags);
4565 nfmr->out_port = htons(ofp_to_u16(rq->out_port));
4566 nfmr->match_len = htons(match_len);
4567 nfmr->table_id = rq->table_id;
4570 /* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg'
4571 * into an abstract ofputil_flow_update in 'update'. The caller must have
4572 * initialized update->match to point to space allocated for a match.
4574 * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's
4575 * actions (except for NXFME_ABBREV, which never includes actions). The caller
4576 * must initialize 'ofpacts' and retains ownership of it. 'update->ofpacts'
4577 * will point into the 'ofpacts' buffer.
4579 * Multiple flow updates can be packed into a single OpenFlow message. Calling
4580 * this function multiple times for a single 'msg' iterates through the
4581 * updates. The caller must initially leave 'msg''s layer pointers null and
4582 * not modify them between calls.
4584 * Returns 0 if successful, EOF if no updates were left in this 'msg',
4585 * otherwise an OFPERR_* value. */
4587 ofputil_decode_flow_update(struct ofputil_flow_update *update,
4588 struct ofpbuf *msg, struct ofpbuf *ofpacts)
4590 struct nx_flow_update_header *nfuh;
4591 unsigned int length;
4592 struct ofp_header *oh;
4595 msg->l2 = msg->data;
4596 ofpraw_pull_assert(msg);
4603 if (msg->size < sizeof(struct nx_flow_update_header)) {
4610 update->event = ntohs(nfuh->event);
4611 length = ntohs(nfuh->length);
4612 if (length > msg->size || length % 8) {
4616 if (update->event == NXFME_ABBREV) {
4617 struct nx_flow_update_abbrev *nfua;
4619 if (length != sizeof *nfua) {
4623 nfua = ofpbuf_pull(msg, sizeof *nfua);
4624 update->xid = nfua->xid;
4626 } else if (update->event == NXFME_ADDED
4627 || update->event == NXFME_DELETED
4628 || update->event == NXFME_MODIFIED) {
4629 struct nx_flow_update_full *nfuf;
4630 unsigned int actions_len;
4631 unsigned int match_len;
4634 if (length < sizeof *nfuf) {
4638 nfuf = ofpbuf_pull(msg, sizeof *nfuf);
4639 match_len = ntohs(nfuf->match_len);
4640 if (sizeof *nfuf + match_len > length) {
4644 update->reason = ntohs(nfuf->reason);
4645 update->idle_timeout = ntohs(nfuf->idle_timeout);
4646 update->hard_timeout = ntohs(nfuf->hard_timeout);
4647 update->table_id = nfuf->table_id;
4648 update->cookie = nfuf->cookie;
4649 update->priority = ntohs(nfuf->priority);
4651 error = nx_pull_match(msg, match_len, update->match, NULL, NULL);
4656 actions_len = length - sizeof *nfuf - ROUND_UP(match_len, 8);
4657 error = ofpacts_pull_openflow_actions(msg, actions_len, oh->version,
4663 update->ofpacts = ofpacts->data;
4664 update->ofpacts_len = ofpacts->size;
4667 VLOG_WARN_RL(&bad_ofmsg_rl,
4668 "NXST_FLOW_MONITOR reply has bad event %"PRIu16,
4669 ntohs(nfuh->event));
4670 return OFPERR_NXBRC_FM_BAD_EVENT;
4674 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR reply has %"PRIuSIZE" "
4675 "leftover bytes at end", msg->size);
4676 return OFPERR_OFPBRC_BAD_LEN;
4680 ofputil_decode_flow_monitor_cancel(const struct ofp_header *oh)
4682 const struct nx_flow_monitor_cancel *cancel = ofpmsg_body(oh);
4684 return ntohl(cancel->id);
4688 ofputil_encode_flow_monitor_cancel(uint32_t id)
4690 struct nx_flow_monitor_cancel *nfmc;
4693 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MONITOR_CANCEL, OFP10_VERSION, 0);
4694 nfmc = ofpbuf_put_uninit(msg, sizeof *nfmc);
4695 nfmc->id = htonl(id);
4700 ofputil_start_flow_update(struct list *replies)
4704 msg = ofpraw_alloc_xid(OFPRAW_NXST_FLOW_MONITOR_REPLY, OFP10_VERSION,
4708 list_push_back(replies, &msg->list_node);
4712 ofputil_append_flow_update(const struct ofputil_flow_update *update,
4713 struct list *replies)
4715 struct nx_flow_update_header *nfuh;
4718 enum ofp_version version;
4720 msg = ofpbuf_from_list(list_back(replies));
4721 start_ofs = msg->size;
4722 version = ((struct ofp_header *)msg->l2)->version;
4724 if (update->event == NXFME_ABBREV) {
4725 struct nx_flow_update_abbrev *nfua;
4727 nfua = ofpbuf_put_zeros(msg, sizeof *nfua);
4728 nfua->xid = update->xid;
4730 struct nx_flow_update_full *nfuf;
4733 ofpbuf_put_zeros(msg, sizeof *nfuf);
4734 match_len = nx_put_match(msg, update->match, htonll(0), htonll(0));
4735 ofpacts_put_openflow_actions(update->ofpacts, update->ofpacts_len, msg,
4737 nfuf = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuf);
4738 nfuf->reason = htons(update->reason);
4739 nfuf->priority = htons(update->priority);
4740 nfuf->idle_timeout = htons(update->idle_timeout);
4741 nfuf->hard_timeout = htons(update->hard_timeout);
4742 nfuf->match_len = htons(match_len);
4743 nfuf->table_id = update->table_id;
4744 nfuf->cookie = update->cookie;
4747 nfuh = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuh);
4748 nfuh->length = htons(msg->size - start_ofs);
4749 nfuh->event = htons(update->event);
4751 ofpmp_postappend(replies, start_ofs);
4755 ofputil_encode_packet_out(const struct ofputil_packet_out *po,
4756 enum ofputil_protocol protocol)
4758 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
4762 size = po->ofpacts_len;
4763 if (po->buffer_id == UINT32_MAX) {
4764 size += po->packet_len;
4767 switch (ofp_version) {
4768 case OFP10_VERSION: {
4769 struct ofp10_packet_out *opo;
4772 msg = ofpraw_alloc(OFPRAW_OFPT10_PACKET_OUT, OFP10_VERSION, size);
4773 ofpbuf_put_zeros(msg, sizeof *opo);
4774 actions_ofs = msg->size;
4775 ofpacts_put_openflow_actions(po->ofpacts, po->ofpacts_len, msg,
4779 opo->buffer_id = htonl(po->buffer_id);
4780 opo->in_port = htons(ofp_to_u16(po->in_port));
4781 opo->actions_len = htons(msg->size - actions_ofs);
4787 case OFP13_VERSION: {
4788 struct ofp11_packet_out *opo;
4791 msg = ofpraw_alloc(OFPRAW_OFPT11_PACKET_OUT, ofp_version, size);
4792 ofpbuf_put_zeros(msg, sizeof *opo);
4793 len = ofpacts_put_openflow_actions(po->ofpacts, po->ofpacts_len, msg,
4796 opo->buffer_id = htonl(po->buffer_id);
4797 opo->in_port = ofputil_port_to_ofp11(po->in_port);
4798 opo->actions_len = htons(len);
4806 if (po->buffer_id == UINT32_MAX) {
4807 ofpbuf_put(msg, po->packet, po->packet_len);
4810 ofpmsg_update_length(msg);
4815 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
4817 make_echo_request(enum ofp_version ofp_version)
4819 return ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST, ofp_version,
4823 /* Creates and returns an OFPT_ECHO_REPLY message matching the
4824 * OFPT_ECHO_REQUEST message in 'rq'. */
4826 make_echo_reply(const struct ofp_header *rq)
4828 struct ofpbuf rq_buf;
4829 struct ofpbuf *reply;
4831 ofpbuf_use_const(&rq_buf, rq, ntohs(rq->length));
4832 ofpraw_pull_assert(&rq_buf);
4834 reply = ofpraw_alloc_reply(OFPRAW_OFPT_ECHO_REPLY, rq, rq_buf.size);
4835 ofpbuf_put(reply, rq_buf.data, rq_buf.size);
4840 ofputil_encode_barrier_request(enum ofp_version ofp_version)
4844 switch (ofp_version) {
4848 type = OFPRAW_OFPT11_BARRIER_REQUEST;
4852 type = OFPRAW_OFPT10_BARRIER_REQUEST;
4859 return ofpraw_alloc(type, ofp_version, 0);
4863 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
4865 switch (flags & OFPC_FRAG_MASK) {
4866 case OFPC_FRAG_NORMAL: return "normal";
4867 case OFPC_FRAG_DROP: return "drop";
4868 case OFPC_FRAG_REASM: return "reassemble";
4869 case OFPC_FRAG_NX_MATCH: return "nx-match";
4876 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
4878 if (!strcasecmp(s, "normal")) {
4879 *flags = OFPC_FRAG_NORMAL;
4880 } else if (!strcasecmp(s, "drop")) {
4881 *flags = OFPC_FRAG_DROP;
4882 } else if (!strcasecmp(s, "reassemble")) {
4883 *flags = OFPC_FRAG_REASM;
4884 } else if (!strcasecmp(s, "nx-match")) {
4885 *flags = OFPC_FRAG_NX_MATCH;
4892 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
4893 * port number and stores the latter in '*ofp10_port', for the purpose of
4894 * decoding OpenFlow 1.1+ protocol messages. Returns 0 if successful,
4895 * otherwise an OFPERR_* number. On error, stores OFPP_NONE in '*ofp10_port'.
4897 * See the definition of OFP11_MAX for an explanation of the mapping. */
4899 ofputil_port_from_ofp11(ovs_be32 ofp11_port, ofp_port_t *ofp10_port)
4901 uint32_t ofp11_port_h = ntohl(ofp11_port);
4903 if (ofp11_port_h < ofp_to_u16(OFPP_MAX)) {
4904 *ofp10_port = u16_to_ofp(ofp11_port_h);
4906 } else if (ofp11_port_h >= ofp11_to_u32(OFPP11_MAX)) {
4907 *ofp10_port = u16_to_ofp(ofp11_port_h - OFPP11_OFFSET);
4910 *ofp10_port = OFPP_NONE;
4911 VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
4912 "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
4913 ofp11_port_h, ofp_to_u16(OFPP_MAX) - 1,
4914 ofp11_to_u32(OFPP11_MAX), UINT32_MAX);
4915 return OFPERR_OFPBAC_BAD_OUT_PORT;
4919 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
4920 * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
4922 * See the definition of OFP11_MAX for an explanation of the mapping. */
4924 ofputil_port_to_ofp11(ofp_port_t ofp10_port)
4926 return htonl(ofp_to_u16(ofp10_port) < ofp_to_u16(OFPP_MAX)
4927 ? ofp_to_u16(ofp10_port)
4928 : ofp_to_u16(ofp10_port) + OFPP11_OFFSET);
4931 #define OFPUTIL_NAMED_PORTS \
4932 OFPUTIL_NAMED_PORT(IN_PORT) \
4933 OFPUTIL_NAMED_PORT(TABLE) \
4934 OFPUTIL_NAMED_PORT(NORMAL) \
4935 OFPUTIL_NAMED_PORT(FLOOD) \
4936 OFPUTIL_NAMED_PORT(ALL) \
4937 OFPUTIL_NAMED_PORT(CONTROLLER) \
4938 OFPUTIL_NAMED_PORT(LOCAL) \
4939 OFPUTIL_NAMED_PORT(ANY)
4941 /* For backwards compatibility, so that "none" is recognized as OFPP_ANY */
4942 #define OFPUTIL_NAMED_PORTS_WITH_NONE \
4943 OFPUTIL_NAMED_PORTS \
4944 OFPUTIL_NAMED_PORT(NONE)
4946 /* Stores the port number represented by 's' into '*portp'. 's' may be an
4947 * integer or, for reserved ports, the standard OpenFlow name for the port
4950 * Returns true if successful, false if 's' is not a valid OpenFlow port number
4951 * or name. The caller should issue an error message in this case, because
4952 * this function usually does not. (This gives the caller an opportunity to
4953 * look up the port name another way, e.g. by contacting the switch and listing
4954 * the names of all its ports).
4956 * This function accepts OpenFlow 1.0 port numbers. It also accepts a subset
4957 * of OpenFlow 1.1+ port numbers, mapping those port numbers into the 16-bit
4958 * range as described in include/openflow/openflow-1.1.h. */
4960 ofputil_port_from_string(const char *s, ofp_port_t *portp)
4965 if (str_to_uint(s, 10, &port32)) {
4966 if (port32 < ofp_to_u16(OFPP_MAX)) {
4968 } else if (port32 < ofp_to_u16(OFPP_FIRST_RESV)) {
4969 VLOG_WARN("port %u is a reserved OF1.0 port number that will "
4970 "be translated to %u when talking to an OF1.1 or "
4971 "later controller", port32, port32 + OFPP11_OFFSET);
4972 } else if (port32 <= ofp_to_u16(OFPP_LAST_RESV)) {
4973 char name[OFP_MAX_PORT_NAME_LEN];
4975 ofputil_port_to_string(u16_to_ofp(port32), name, sizeof name);
4976 VLOG_WARN_ONCE("referring to port %s as %"PRIu32" is deprecated "
4977 "for compatibility with OpenFlow 1.1 and later",
4979 } else if (port32 < ofp11_to_u32(OFPP11_MAX)) {
4980 VLOG_WARN("port %u is outside the supported range 0 through "
4981 "%"PRIx16" or 0x%x through 0x%"PRIx32, port32,
4982 UINT16_MAX, ofp11_to_u32(OFPP11_MAX), UINT32_MAX);
4985 port32 -= OFPP11_OFFSET;
4988 *portp = u16_to_ofp(port32);
4995 static const struct pair pairs[] = {
4996 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
4997 OFPUTIL_NAMED_PORTS_WITH_NONE
4998 #undef OFPUTIL_NAMED_PORT
5000 const struct pair *p;
5002 for (p = pairs; p < &pairs[ARRAY_SIZE(pairs)]; p++) {
5003 if (!strcasecmp(s, p->name)) {
5012 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
5013 * Most ports' string representation is just the port number, but for special
5014 * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
5016 ofputil_format_port(ofp_port_t port, struct ds *s)
5018 char name[OFP_MAX_PORT_NAME_LEN];
5020 ofputil_port_to_string(port, name, sizeof name);
5021 ds_put_cstr(s, name);
5024 /* Puts in the 'bufsize' byte in 'namebuf' a null-terminated string
5025 * representation of OpenFlow port number 'port'. Most ports are represented
5026 * as just the port number, but special ports, e.g. OFPP_LOCAL, are represented
5027 * by name, e.g. "LOCAL". */
5029 ofputil_port_to_string(ofp_port_t port,
5030 char namebuf[OFP_MAX_PORT_NAME_LEN], size_t bufsize)
5033 #define OFPUTIL_NAMED_PORT(NAME) \
5035 ovs_strlcpy(namebuf, #NAME, bufsize); \
5038 #undef OFPUTIL_NAMED_PORT
5041 snprintf(namebuf, bufsize, "%"PRIu16, port);
5046 /* Stores the group id represented by 's' into '*group_idp'. 's' may be an
5047 * integer or, for reserved group IDs, the standard OpenFlow name for the group
5048 * (either "ANY" or "ALL").
5050 * Returns true if successful, false if 's' is not a valid OpenFlow group ID or
5053 ofputil_group_from_string(const char *s, uint32_t *group_idp)
5055 if (!strcasecmp(s, "any")) {
5056 *group_idp = OFPG11_ANY;
5057 } else if (!strcasecmp(s, "all")) {
5058 *group_idp = OFPG11_ALL;
5059 } else if (!str_to_uint(s, 10, group_idp)) {
5060 VLOG_WARN("%s is not a valid group ID. (Valid group IDs are "
5061 "32-bit nonnegative integers or the keywords ANY or "
5069 /* Appends to 's' a string representation of the OpenFlow group ID 'group_id'.
5070 * Most groups' string representation is just the number, but for special
5071 * groups, e.g. OFPG11_ALL, it is the name, e.g. "ALL". */
5073 ofputil_format_group(uint32_t group_id, struct ds *s)
5075 char name[MAX_GROUP_NAME_LEN];
5077 ofputil_group_to_string(group_id, name, sizeof name);
5078 ds_put_cstr(s, name);
5082 /* Puts in the 'bufsize' byte in 'namebuf' a null-terminated string
5083 * representation of OpenFlow group ID 'group_id'. Most group are represented
5084 * as just their number, but special groups, e.g. OFPG11_ALL, are represented
5085 * by name, e.g. "ALL". */
5087 ofputil_group_to_string(uint32_t group_id,
5088 char namebuf[MAX_GROUP_NAME_LEN + 1], size_t bufsize)
5092 ovs_strlcpy(namebuf, "ALL", bufsize);
5096 ovs_strlcpy(namebuf, "ANY", bufsize);
5100 snprintf(namebuf, bufsize, "%"PRIu32, group_id);
5105 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
5106 * 'ofp_version', tries to pull the first element from the array. If
5107 * successful, initializes '*pp' with an abstract representation of the
5108 * port and returns 0. If no ports remain to be decoded, returns EOF.
5109 * On an error, returns a positive OFPERR_* value. */
5111 ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *b,
5112 struct ofputil_phy_port *pp)
5114 switch (ofp_version) {
5115 case OFP10_VERSION: {
5116 const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
5117 return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
5121 case OFP13_VERSION: {
5122 const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
5123 return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
5130 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
5131 * 'ofp_version', returns the number of elements. */
5132 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *b)
5134 return b->size / ofputil_get_phy_port_size(ofp_version);
5137 /* ofp-util.def lists the mapping from names to action. */
5138 static const char *const names[OFPUTIL_N_ACTIONS] = {
5140 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) NAME,
5141 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
5142 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
5143 #include "ofp-util.def"
5146 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
5147 * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1
5148 * if 'name' is not the name of any action. */
5150 ofputil_action_code_from_name(const char *name)
5152 const char *const *p;
5154 for (p = names; p < &names[ARRAY_SIZE(names)]; p++) {
5155 if (*p && !strcasecmp(name, *p)) {
5162 /* Returns name corresponding to the 'enum ofputil_action_code',
5163 * or "Unkonwn action", if the name is not available. */
5165 ofputil_action_name_from_code(enum ofputil_action_code code)
5167 return code < (int)OFPUTIL_N_ACTIONS && names[code] ? names[code]
5171 /* Appends an action of the type specified by 'code' to 'buf' and returns the
5172 * action. Initializes the parts of 'action' that identify it as having type
5173 * <ENUM> and length 'sizeof *action' and zeros the rest. For actions that
5174 * have variable length, the length used and cleared is that of struct
5177 ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
5180 case OFPUTIL_ACTION_INVALID:
5183 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
5184 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
5185 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
5186 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
5187 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
5188 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
5189 #include "ofp-util.def"
5194 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
5196 ofputil_init_##ENUM(struct STRUCT *s) \
5198 memset(s, 0, sizeof *s); \
5199 s->type = htons(ENUM); \
5200 s->len = htons(sizeof *s); \
5204 ofputil_put_##ENUM(struct ofpbuf *buf) \
5206 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
5207 ofputil_init_##ENUM(s); \
5210 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
5211 OFPAT10_ACTION(ENUM, STRUCT, NAME)
5212 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
5214 ofputil_init_##ENUM(struct STRUCT *s) \
5216 memset(s, 0, sizeof *s); \
5217 s->type = htons(OFPAT10_VENDOR); \
5218 s->len = htons(sizeof *s); \
5219 s->vendor = htonl(NX_VENDOR_ID); \
5220 s->subtype = htons(ENUM); \
5224 ofputil_put_##ENUM(struct ofpbuf *buf) \
5226 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
5227 ofputil_init_##ENUM(s); \
5230 #include "ofp-util.def"
5233 ofputil_normalize_match__(struct match *match, bool may_log)
5236 MAY_NW_ADDR = 1 << 0, /* nw_src, nw_dst */
5237 MAY_TP_ADDR = 1 << 1, /* tp_src, tp_dst */
5238 MAY_NW_PROTO = 1 << 2, /* nw_proto */
5239 MAY_IPVx = 1 << 3, /* tos, frag, ttl */
5240 MAY_ARP_SHA = 1 << 4, /* arp_sha */
5241 MAY_ARP_THA = 1 << 5, /* arp_tha */
5242 MAY_IPV6 = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
5243 MAY_ND_TARGET = 1 << 7, /* nd_target */
5244 MAY_MPLS = 1 << 8, /* mpls label and tc */
5247 struct flow_wildcards wc;
5249 /* Figure out what fields may be matched. */
5250 if (match->flow.dl_type == htons(ETH_TYPE_IP)) {
5251 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
5252 if (match->flow.nw_proto == IPPROTO_TCP ||
5253 match->flow.nw_proto == IPPROTO_UDP ||
5254 match->flow.nw_proto == IPPROTO_SCTP ||
5255 match->flow.nw_proto == IPPROTO_ICMP) {
5256 may_match |= MAY_TP_ADDR;
5258 } else if (match->flow.dl_type == htons(ETH_TYPE_IPV6)) {
5259 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
5260 if (match->flow.nw_proto == IPPROTO_TCP ||
5261 match->flow.nw_proto == IPPROTO_UDP ||
5262 match->flow.nw_proto == IPPROTO_SCTP) {
5263 may_match |= MAY_TP_ADDR;
5264 } else if (match->flow.nw_proto == IPPROTO_ICMPV6) {
5265 may_match |= MAY_TP_ADDR;
5266 if (match->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
5267 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
5268 } else if (match->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
5269 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
5272 } else if (match->flow.dl_type == htons(ETH_TYPE_ARP) ||
5273 match->flow.dl_type == htons(ETH_TYPE_RARP)) {
5274 may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
5275 } else if (eth_type_mpls(match->flow.dl_type)) {
5276 may_match = MAY_MPLS;
5281 /* Clear the fields that may not be matched. */
5283 if (!(may_match & MAY_NW_ADDR)) {
5284 wc.masks.nw_src = wc.masks.nw_dst = htonl(0);
5286 if (!(may_match & MAY_TP_ADDR)) {
5287 wc.masks.tp_src = wc.masks.tp_dst = htons(0);
5289 if (!(may_match & MAY_NW_PROTO)) {
5290 wc.masks.nw_proto = 0;
5292 if (!(may_match & MAY_IPVx)) {
5293 wc.masks.nw_tos = 0;
5294 wc.masks.nw_ttl = 0;
5296 if (!(may_match & MAY_ARP_SHA)) {
5297 memset(wc.masks.arp_sha, 0, ETH_ADDR_LEN);
5299 if (!(may_match & MAY_ARP_THA)) {
5300 memset(wc.masks.arp_tha, 0, ETH_ADDR_LEN);
5302 if (!(may_match & MAY_IPV6)) {
5303 wc.masks.ipv6_src = wc.masks.ipv6_dst = in6addr_any;
5304 wc.masks.ipv6_label = htonl(0);
5306 if (!(may_match & MAY_ND_TARGET)) {
5307 wc.masks.nd_target = in6addr_any;
5309 if (!(may_match & MAY_MPLS)) {
5310 wc.masks.mpls_lse = htonl(0);
5313 /* Log any changes. */
5314 if (!flow_wildcards_equal(&wc, &match->wc)) {
5315 bool log = may_log && !VLOG_DROP_INFO(&bad_ofmsg_rl);
5316 char *pre = log ? match_to_string(match, OFP_DEFAULT_PRIORITY) : NULL;
5319 match_zero_wildcarded_fields(match);
5322 char *post = match_to_string(match, OFP_DEFAULT_PRIORITY);
5323 VLOG_INFO("normalization changed ofp_match, details:");
5324 VLOG_INFO(" pre: %s", pre);
5325 VLOG_INFO("post: %s", post);
5332 /* "Normalizes" the wildcards in 'match'. That means:
5334 * 1. If the type of level N is known, then only the valid fields for that
5335 * level may be specified. For example, ARP does not have a TOS field,
5336 * so nw_tos must be wildcarded if 'match' specifies an ARP flow.
5337 * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
5338 * ipv6_dst (and other fields) must be wildcarded if 'match' specifies an
5341 * 2. If the type of level N is not known (or not understood by Open
5342 * vSwitch), then no fields at all for that level may be specified. For
5343 * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
5344 * L4 fields tp_src and tp_dst must be wildcarded if 'match' specifies an
5347 * If this function changes 'match', it logs a rate-limited informational
5350 ofputil_normalize_match(struct match *match)
5352 ofputil_normalize_match__(match, true);
5355 /* Same as ofputil_normalize_match() without the logging. Thus, this function
5356 * is suitable for a program's internal use, whereas ofputil_normalize_match()
5357 * sense for use on flows received from elsewhere (so that a bug in the program
5358 * that sent them can be reported and corrected). */
5360 ofputil_normalize_match_quiet(struct match *match)
5362 ofputil_normalize_match__(match, false);
5365 /* Parses a key or a key-value pair from '*stringp'.
5367 * On success: Stores the key into '*keyp'. Stores the value, if present, into
5368 * '*valuep', otherwise an empty string. Advances '*stringp' past the end of
5369 * the key-value pair, preparing it for another call. '*keyp' and '*valuep'
5370 * are substrings of '*stringp' created by replacing some of its bytes by null
5371 * terminators. Returns true.
5373 * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
5374 * NULL and returns false. */
5376 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
5378 char *pos, *key, *value;
5382 pos += strspn(pos, ", \t\r\n");
5384 *keyp = *valuep = NULL;
5389 key_len = strcspn(pos, ":=(, \t\r\n");
5390 if (key[key_len] == ':' || key[key_len] == '=') {
5391 /* The value can be separated by a colon. */
5394 value = key + key_len + 1;
5395 value_len = strcspn(value, ", \t\r\n");
5396 pos = value + value_len + (value[value_len] != '\0');
5397 value[value_len] = '\0';
5398 } else if (key[key_len] == '(') {
5399 /* The value can be surrounded by balanced parentheses. The outermost
5400 * set of parentheses is removed. */
5404 value = key + key_len + 1;
5405 for (value_len = 0; level > 0; value_len++) {
5406 switch (value[value_len]) {
5420 value[value_len - 1] = '\0';
5421 pos = value + value_len;
5423 /* There might be no value at all. */
5424 value = key + key_len; /* Will become the empty string below. */
5425 pos = key + key_len + (key[key_len] != '\0');
5427 key[key_len] = '\0';
5435 /* Encode a dump ports request for 'port', the encoded message
5436 * will be for Open Flow version 'ofp_version'. Returns message
5437 * as a struct ofpbuf. Returns encoded message on success, NULL on error */
5439 ofputil_encode_dump_ports_request(enum ofp_version ofp_version, ofp_port_t port)
5441 struct ofpbuf *request;
5443 switch (ofp_version) {
5444 case OFP10_VERSION: {
5445 struct ofp10_port_stats_request *req;
5446 request = ofpraw_alloc(OFPRAW_OFPST10_PORT_REQUEST, ofp_version, 0);
5447 req = ofpbuf_put_zeros(request, sizeof *req);
5448 req->port_no = htons(ofp_to_u16(port));
5453 case OFP13_VERSION: {
5454 struct ofp11_port_stats_request *req;
5455 request = ofpraw_alloc(OFPRAW_OFPST11_PORT_REQUEST, ofp_version, 0);
5456 req = ofpbuf_put_zeros(request, sizeof *req);
5457 req->port_no = ofputil_port_to_ofp11(port);
5468 ofputil_port_stats_to_ofp10(const struct ofputil_port_stats *ops,
5469 struct ofp10_port_stats *ps10)
5471 ps10->port_no = htons(ofp_to_u16(ops->port_no));
5472 memset(ps10->pad, 0, sizeof ps10->pad);
5473 put_32aligned_be64(&ps10->rx_packets, htonll(ops->stats.rx_packets));
5474 put_32aligned_be64(&ps10->tx_packets, htonll(ops->stats.tx_packets));
5475 put_32aligned_be64(&ps10->rx_bytes, htonll(ops->stats.rx_bytes));
5476 put_32aligned_be64(&ps10->tx_bytes, htonll(ops->stats.tx_bytes));
5477 put_32aligned_be64(&ps10->rx_dropped, htonll(ops->stats.rx_dropped));
5478 put_32aligned_be64(&ps10->tx_dropped, htonll(ops->stats.tx_dropped));
5479 put_32aligned_be64(&ps10->rx_errors, htonll(ops->stats.rx_errors));
5480 put_32aligned_be64(&ps10->tx_errors, htonll(ops->stats.tx_errors));
5481 put_32aligned_be64(&ps10->rx_frame_err, htonll(ops->stats.rx_frame_errors));
5482 put_32aligned_be64(&ps10->rx_over_err, htonll(ops->stats.rx_over_errors));
5483 put_32aligned_be64(&ps10->rx_crc_err, htonll(ops->stats.rx_crc_errors));
5484 put_32aligned_be64(&ps10->collisions, htonll(ops->stats.collisions));
5488 ofputil_port_stats_to_ofp11(const struct ofputil_port_stats *ops,
5489 struct ofp11_port_stats *ps11)
5491 ps11->port_no = ofputil_port_to_ofp11(ops->port_no);
5492 memset(ps11->pad, 0, sizeof ps11->pad);
5493 ps11->rx_packets = htonll(ops->stats.rx_packets);
5494 ps11->tx_packets = htonll(ops->stats.tx_packets);
5495 ps11->rx_bytes = htonll(ops->stats.rx_bytes);
5496 ps11->tx_bytes = htonll(ops->stats.tx_bytes);
5497 ps11->rx_dropped = htonll(ops->stats.rx_dropped);
5498 ps11->tx_dropped = htonll(ops->stats.tx_dropped);
5499 ps11->rx_errors = htonll(ops->stats.rx_errors);
5500 ps11->tx_errors = htonll(ops->stats.tx_errors);
5501 ps11->rx_frame_err = htonll(ops->stats.rx_frame_errors);
5502 ps11->rx_over_err = htonll(ops->stats.rx_over_errors);
5503 ps11->rx_crc_err = htonll(ops->stats.rx_crc_errors);
5504 ps11->collisions = htonll(ops->stats.collisions);
5508 ofputil_port_stats_to_ofp13(const struct ofputil_port_stats *ops,
5509 struct ofp13_port_stats *ps13)
5511 ofputil_port_stats_to_ofp11(ops, &ps13->ps);
5512 ps13->duration_sec = htonl(ops->duration_sec);
5513 ps13->duration_nsec = htonl(ops->duration_nsec);
5517 /* Encode a ports stat for 'ops' and append it to 'replies'. */
5519 ofputil_append_port_stat(struct list *replies,
5520 const struct ofputil_port_stats *ops)
5522 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
5523 struct ofp_header *oh = msg->data;
5525 switch ((enum ofp_version)oh->version) {
5526 case OFP13_VERSION: {
5527 struct ofp13_port_stats *reply = ofpmp_append(replies, sizeof *reply);
5528 ofputil_port_stats_to_ofp13(ops, reply);
5532 case OFP11_VERSION: {
5533 struct ofp11_port_stats *reply = ofpmp_append(replies, sizeof *reply);
5534 ofputil_port_stats_to_ofp11(ops, reply);
5538 case OFP10_VERSION: {
5539 struct ofp10_port_stats *reply = ofpmp_append(replies, sizeof *reply);
5540 ofputil_port_stats_to_ofp10(ops, reply);
5550 ofputil_port_stats_from_ofp10(struct ofputil_port_stats *ops,
5551 const struct ofp10_port_stats *ps10)
5553 memset(ops, 0, sizeof *ops);
5555 ops->port_no = u16_to_ofp(ntohs(ps10->port_no));
5556 ops->stats.rx_packets = ntohll(get_32aligned_be64(&ps10->rx_packets));
5557 ops->stats.tx_packets = ntohll(get_32aligned_be64(&ps10->tx_packets));
5558 ops->stats.rx_bytes = ntohll(get_32aligned_be64(&ps10->rx_bytes));
5559 ops->stats.tx_bytes = ntohll(get_32aligned_be64(&ps10->tx_bytes));
5560 ops->stats.rx_dropped = ntohll(get_32aligned_be64(&ps10->rx_dropped));
5561 ops->stats.tx_dropped = ntohll(get_32aligned_be64(&ps10->tx_dropped));
5562 ops->stats.rx_errors = ntohll(get_32aligned_be64(&ps10->rx_errors));
5563 ops->stats.tx_errors = ntohll(get_32aligned_be64(&ps10->tx_errors));
5564 ops->stats.rx_frame_errors =
5565 ntohll(get_32aligned_be64(&ps10->rx_frame_err));
5566 ops->stats.rx_over_errors = ntohll(get_32aligned_be64(&ps10->rx_over_err));
5567 ops->stats.rx_crc_errors = ntohll(get_32aligned_be64(&ps10->rx_crc_err));
5568 ops->stats.collisions = ntohll(get_32aligned_be64(&ps10->collisions));
5569 ops->duration_sec = ops->duration_nsec = UINT32_MAX;
5575 ofputil_port_stats_from_ofp11(struct ofputil_port_stats *ops,
5576 const struct ofp11_port_stats *ps11)
5580 memset(ops, 0, sizeof *ops);
5581 error = ofputil_port_from_ofp11(ps11->port_no, &ops->port_no);
5586 ops->stats.rx_packets = ntohll(ps11->rx_packets);
5587 ops->stats.tx_packets = ntohll(ps11->tx_packets);
5588 ops->stats.rx_bytes = ntohll(ps11->rx_bytes);
5589 ops->stats.tx_bytes = ntohll(ps11->tx_bytes);
5590 ops->stats.rx_dropped = ntohll(ps11->rx_dropped);
5591 ops->stats.tx_dropped = ntohll(ps11->tx_dropped);
5592 ops->stats.rx_errors = ntohll(ps11->rx_errors);
5593 ops->stats.tx_errors = ntohll(ps11->tx_errors);
5594 ops->stats.rx_frame_errors = ntohll(ps11->rx_frame_err);
5595 ops->stats.rx_over_errors = ntohll(ps11->rx_over_err);
5596 ops->stats.rx_crc_errors = ntohll(ps11->rx_crc_err);
5597 ops->stats.collisions = ntohll(ps11->collisions);
5598 ops->duration_sec = ops->duration_nsec = UINT32_MAX;
5604 ofputil_port_stats_from_ofp13(struct ofputil_port_stats *ops,
5605 const struct ofp13_port_stats *ps13)
5607 enum ofperr error = ofputil_port_stats_from_ofp11(ops, &ps13->ps);
5609 ops->duration_sec = ntohl(ps13->duration_sec);
5610 ops->duration_nsec = ntohl(ps13->duration_nsec);
5616 ofputil_get_port_stats_size(enum ofp_version ofp_version)
5618 switch (ofp_version) {
5620 return sizeof(struct ofp10_port_stats);
5623 return sizeof(struct ofp11_port_stats);
5625 return sizeof(struct ofp13_port_stats);
5631 /* Returns the number of port stats elements in OFPTYPE_PORT_STATS_REPLY
5634 ofputil_count_port_stats(const struct ofp_header *oh)
5638 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5639 ofpraw_pull_assert(&b);
5641 return b.size / ofputil_get_port_stats_size(oh->version);
5644 /* Converts an OFPST_PORT_STATS reply in 'msg' into an abstract
5645 * ofputil_port_stats in 'ps'.
5647 * Multiple OFPST_PORT_STATS replies can be packed into a single OpenFlow
5648 * message. Calling this function multiple times for a single 'msg' iterates
5649 * through the replies. The caller must initially leave 'msg''s layer pointers
5650 * null and not modify them between calls.
5652 * Returns 0 if successful, EOF if no replies were left in this 'msg',
5653 * otherwise a positive errno value. */
5655 ofputil_decode_port_stats(struct ofputil_port_stats *ps, struct ofpbuf *msg)
5661 ? ofpraw_decode(&raw, msg->l2)
5662 : ofpraw_pull(&raw, msg));
5669 } else if (raw == OFPRAW_OFPST13_PORT_REPLY) {
5670 const struct ofp13_port_stats *ps13;
5672 ps13 = ofpbuf_try_pull(msg, sizeof *ps13);
5676 return ofputil_port_stats_from_ofp13(ps, ps13);
5677 } else if (raw == OFPRAW_OFPST11_PORT_REPLY) {
5678 const struct ofp11_port_stats *ps11;
5680 ps11 = ofpbuf_try_pull(msg, sizeof *ps11);
5684 return ofputil_port_stats_from_ofp11(ps, ps11);
5685 } else if (raw == OFPRAW_OFPST10_PORT_REPLY) {
5686 const struct ofp10_port_stats *ps10;
5688 ps10 = ofpbuf_try_pull(msg, sizeof *ps10);
5692 return ofputil_port_stats_from_ofp10(ps, ps10);
5698 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_PORT reply has %"PRIuSIZE" leftover "
5699 "bytes at end", msg->size);
5700 return OFPERR_OFPBRC_BAD_LEN;
5703 /* Parse a port status request message into a 16 bit OpenFlow 1.0
5704 * port number and stores the latter in '*ofp10_port'.
5705 * Returns 0 if successful, otherwise an OFPERR_* number. */
5707 ofputil_decode_port_stats_request(const struct ofp_header *request,
5708 ofp_port_t *ofp10_port)
5710 switch ((enum ofp_version)request->version) {
5713 case OFP11_VERSION: {
5714 const struct ofp11_port_stats_request *psr11 = ofpmsg_body(request);
5715 return ofputil_port_from_ofp11(psr11->port_no, ofp10_port);
5718 case OFP10_VERSION: {
5719 const struct ofp10_port_stats_request *psr10 = ofpmsg_body(request);
5720 *ofp10_port = u16_to_ofp(ntohs(psr10->port_no));
5729 /* Frees all of the "struct ofputil_bucket"s in the 'buckets' list. */
5731 ofputil_bucket_list_destroy(struct list *buckets)
5733 struct ofputil_bucket *bucket, *next_bucket;
5735 LIST_FOR_EACH_SAFE (bucket, next_bucket, list_node, buckets) {
5736 list_remove(&bucket->list_node);
5737 free(bucket->ofpacts);
5742 /* Returns an OpenFlow group stats request for OpenFlow version 'ofp_version',
5743 * that requests stats for group 'group_id'. (Use OFPG_ALL to request stats
5746 * Group statistics include packet and byte counts for each group. */
5748 ofputil_encode_group_stats_request(enum ofp_version ofp_version,
5751 struct ofpbuf *request;
5753 switch (ofp_version) {
5755 ovs_fatal(0, "dump-group-stats needs OpenFlow 1.1 or later "
5756 "(\'-O OpenFlow11\')");
5759 case OFP13_VERSION: {
5760 struct ofp11_group_stats_request *req;
5761 request = ofpraw_alloc(OFPRAW_OFPST11_GROUP_REQUEST, ofp_version, 0);
5762 req = ofpbuf_put_zeros(request, sizeof *req);
5763 req->group_id = htonl(group_id);
5773 /* Returns an OpenFlow group description request for OpenFlow version
5774 * 'ofp_version', that requests stats for group 'group_id'. (Use OFPG_ALL to
5775 * request stats for all groups.)
5777 * Group descriptions include the bucket and action configuration for each
5780 ofputil_encode_group_desc_request(enum ofp_version ofp_version)
5782 struct ofpbuf *request;
5784 switch (ofp_version) {
5786 ovs_fatal(0, "dump-groups needs OpenFlow 1.1 or later "
5787 "(\'-O OpenFlow11\')");
5790 case OFP13_VERSION: {
5791 request = ofpraw_alloc(OFPRAW_OFPST11_GROUP_DESC_REQUEST, ofp_version, 0);
5802 ofputil_group_stats_to_ofp11(const struct ofputil_group_stats *ogs,
5803 size_t base_len, struct list *replies)
5805 struct ofp11_bucket_counter *bc11;
5806 struct ofp11_group_stats *gs11;
5810 length = base_len + sizeof(struct ofp11_bucket_counter) * ogs->n_buckets;
5812 gs11 = ofpmp_append(replies, length);
5813 memset(gs11, 0, base_len);
5814 gs11->length = htons(length);
5815 gs11->group_id = htonl(ogs->group_id);
5816 gs11->ref_count = htonl(ogs->ref_count);
5817 gs11->packet_count = htonll(ogs->packet_count);
5818 gs11->byte_count = htonll(ogs->byte_count);
5820 bc11 = (void *) (((uint8_t *) gs11) + base_len);
5821 for (i = 0; i < ogs->n_buckets; i++) {
5822 const struct bucket_counter *obc = &ogs->bucket_stats[i];
5824 bc11[i].packet_count = htonll(obc->packet_count);
5825 bc11[i].byte_count = htonll(obc->byte_count);
5832 ofputil_append_of13_group_stats(const struct ofputil_group_stats *ogs,
5833 struct list *replies)
5835 struct ofp13_group_stats *gs13;
5837 gs13 = ofputil_group_stats_to_ofp11(ogs, sizeof *gs13, replies);
5838 gs13->duration_sec = htonl(ogs->duration_sec);
5839 gs13->duration_nsec = htonl(ogs->duration_nsec);
5842 /* Encodes 'ogs' properly for the format of the list of group statistics
5843 * replies already begun in 'replies' and appends it to the list. 'replies'
5844 * must have originally been initialized with ofpmp_init(). */
5846 ofputil_append_group_stats(struct list *replies,
5847 const struct ofputil_group_stats *ogs)
5849 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
5850 struct ofp_header *oh = msg->data;
5852 switch ((enum ofp_version)oh->version) {
5855 ofputil_group_stats_to_ofp11(ogs, sizeof(struct ofp11_group_stats),
5860 ofputil_append_of13_group_stats(ogs, replies);
5869 /* Returns an OpenFlow group features request for OpenFlow version
5872 ofputil_encode_group_features_request(enum ofp_version ofp_version)
5874 struct ofpbuf *request = NULL;
5876 switch (ofp_version) {
5879 ovs_fatal(0, "dump-group-features needs OpenFlow 1.2 or later "
5880 "(\'-O OpenFlow12\')");
5882 case OFP13_VERSION: {
5883 request = ofpraw_alloc(OFPRAW_OFPST12_GROUP_FEATURES_REQUEST,
5894 /* Returns a OpenFlow message that encodes 'features' properly as a reply to
5895 * group features request 'request'. */
5897 ofputil_encode_group_features_reply(
5898 const struct ofputil_group_features *features,
5899 const struct ofp_header *request)
5901 struct ofp12_group_features_stats *ogf;
5902 struct ofpbuf *reply;
5904 reply = ofpraw_alloc_xid(OFPRAW_OFPST12_GROUP_FEATURES_REPLY,
5905 request->version, request->xid, 0);
5906 ogf = ofpbuf_put_zeros(reply, sizeof *ogf);
5907 ogf->types = htonl(features->types);
5908 ogf->capabilities = htonl(features->capabilities);
5909 ogf->max_groups[0] = htonl(features->max_groups[0]);
5910 ogf->max_groups[1] = htonl(features->max_groups[1]);
5911 ogf->max_groups[2] = htonl(features->max_groups[2]);
5912 ogf->max_groups[3] = htonl(features->max_groups[3]);
5913 ogf->actions[0] = htonl(features->actions[0]);
5914 ogf->actions[1] = htonl(features->actions[1]);
5915 ogf->actions[2] = htonl(features->actions[2]);
5916 ogf->actions[3] = htonl(features->actions[3]);
5921 /* Decodes group features reply 'oh' into 'features'. */
5923 ofputil_decode_group_features_reply(const struct ofp_header *oh,
5924 struct ofputil_group_features *features)
5926 const struct ofp12_group_features_stats *ogf = ofpmsg_body(oh);
5928 features->types = ntohl(ogf->types);
5929 features->capabilities = ntohl(ogf->capabilities);
5930 features->max_groups[0] = ntohl(ogf->max_groups[0]);
5931 features->max_groups[1] = ntohl(ogf->max_groups[1]);
5932 features->max_groups[2] = ntohl(ogf->max_groups[2]);
5933 features->max_groups[3] = ntohl(ogf->max_groups[3]);
5934 features->actions[0] = ntohl(ogf->actions[0]);
5935 features->actions[1] = ntohl(ogf->actions[1]);
5936 features->actions[2] = ntohl(ogf->actions[2]);
5937 features->actions[3] = ntohl(ogf->actions[3]);
5940 /* Parse a group status request message into a 32 bit OpenFlow 1.1
5941 * group ID and stores the latter in '*group_id'.
5942 * Returns 0 if successful, otherwise an OFPERR_* number. */
5944 ofputil_decode_group_stats_request(const struct ofp_header *request,
5947 const struct ofp11_group_stats_request *gsr11 = ofpmsg_body(request);
5948 *group_id = ntohl(gsr11->group_id);
5952 /* Converts a group stats reply in 'msg' into an abstract ofputil_group_stats
5953 * in 'gs'. Assigns freshly allocated memory to gs->bucket_stats for the
5954 * caller to eventually free.
5956 * Multiple group stats replies can be packed into a single OpenFlow message.
5957 * Calling this function multiple times for a single 'msg' iterates through the
5958 * replies. The caller must initially leave 'msg''s layer pointers null and
5959 * not modify them between calls.
5961 * Returns 0 if successful, EOF if no replies were left in this 'msg',
5962 * otherwise a positive errno value. */
5964 ofputil_decode_group_stats_reply(struct ofpbuf *msg,
5965 struct ofputil_group_stats *gs)
5967 struct ofp11_bucket_counter *obc;
5968 struct ofp11_group_stats *ogs11;
5975 gs->bucket_stats = NULL;
5977 ? ofpraw_decode(&raw, msg->l2)
5978 : ofpraw_pull(&raw, msg));
5987 if (raw == OFPRAW_OFPST11_GROUP_REPLY) {
5988 base_len = sizeof *ogs11;
5989 ogs11 = ofpbuf_try_pull(msg, sizeof *ogs11);
5990 gs->duration_sec = gs->duration_nsec = UINT32_MAX;
5991 } else if (raw == OFPRAW_OFPST13_GROUP_REPLY) {
5992 struct ofp13_group_stats *ogs13;
5994 base_len = sizeof *ogs13;
5995 ogs13 = ofpbuf_try_pull(msg, sizeof *ogs13);
5998 gs->duration_sec = ntohl(ogs13->duration_sec);
5999 gs->duration_nsec = ntohl(ogs13->duration_nsec);
6008 VLOG_WARN_RL(&bad_ofmsg_rl, "%s reply has %"PRIuSIZE" leftover bytes at end",
6009 ofpraw_get_name(raw), msg->size);
6010 return OFPERR_OFPBRC_BAD_LEN;
6012 length = ntohs(ogs11->length);
6013 if (length < sizeof base_len) {
6014 VLOG_WARN_RL(&bad_ofmsg_rl, "%s reply claims invalid length %"PRIuSIZE,
6015 ofpraw_get_name(raw), length);
6016 return OFPERR_OFPBRC_BAD_LEN;
6019 gs->group_id = ntohl(ogs11->group_id);
6020 gs->ref_count = ntohl(ogs11->ref_count);
6021 gs->packet_count = ntohll(ogs11->packet_count);
6022 gs->byte_count = ntohll(ogs11->byte_count);
6024 gs->n_buckets = (length - base_len) / sizeof *obc;
6025 obc = ofpbuf_try_pull(msg, gs->n_buckets * sizeof *obc);
6027 VLOG_WARN_RL(&bad_ofmsg_rl, "%s reply has %"PRIuSIZE" leftover bytes at end",
6028 ofpraw_get_name(raw), msg->size);
6029 return OFPERR_OFPBRC_BAD_LEN;
6032 gs->bucket_stats = xmalloc(gs->n_buckets * sizeof *gs->bucket_stats);
6033 for (i = 0; i < gs->n_buckets; i++) {
6034 gs->bucket_stats[i].packet_count = ntohll(obc[i].packet_count);
6035 gs->bucket_stats[i].byte_count = ntohll(obc[i].byte_count);
6041 /* Appends a group stats reply that contains the data in 'gds' to those already
6042 * present in the list of ofpbufs in 'replies'. 'replies' should have been
6043 * initialized with ofpmp_init(). */
6045 ofputil_append_group_desc_reply(const struct ofputil_group_desc *gds,
6046 struct list *buckets,
6047 struct list *replies)
6049 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
6050 struct ofp11_group_desc_stats *ogds;
6051 struct ofputil_bucket *bucket;
6053 enum ofp_version version = ((struct ofp_header *)reply->data)->version;
6055 start_ogds = reply->size;
6056 ofpbuf_put_zeros(reply, sizeof *ogds);
6057 LIST_FOR_EACH (bucket, list_node, buckets) {
6058 struct ofp11_bucket *ob;
6061 start_ob = reply->size;
6062 ofpbuf_put_zeros(reply, sizeof *ob);
6063 ofpacts_put_openflow_actions(bucket->ofpacts, bucket->ofpacts_len,
6065 ob = ofpbuf_at_assert(reply, start_ob, sizeof *ob);
6066 ob->len = htons(reply->size - start_ob);
6067 ob->weight = htons(bucket->weight);
6068 ob->watch_port = ofputil_port_to_ofp11(bucket->watch_port);
6069 ob->watch_group = htonl(bucket->watch_group);
6071 ogds = ofpbuf_at_assert(reply, start_ogds, sizeof *ogds);
6072 ogds->length = htons(reply->size - start_ogds);
6073 ogds->type = gds->type;
6074 ogds->group_id = htonl(gds->group_id);
6076 ofpmp_postappend(replies, start_ogds);
6080 ofputil_pull_buckets(struct ofpbuf *msg, size_t buckets_length,
6081 enum ofp_version version, struct list *buckets)
6083 struct ofp11_bucket *ob;
6086 while (buckets_length > 0) {
6087 struct ofputil_bucket *bucket;
6088 struct ofpbuf ofpacts;
6092 ob = (buckets_length >= sizeof *ob
6093 ? ofpbuf_try_pull(msg, sizeof *ob)
6096 VLOG_WARN_RL(&bad_ofmsg_rl, "buckets end with %"PRIuSIZE" leftover bytes",
6100 ob_len = ntohs(ob->len);
6101 if (ob_len < sizeof *ob) {
6102 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket length "
6103 "%"PRIuSIZE" is not valid", ob_len);
6104 return OFPERR_OFPGMFC_BAD_BUCKET;
6105 } else if (ob_len > buckets_length) {
6106 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket length "
6107 "%"PRIuSIZE" exceeds remaining buckets data size %"PRIuSIZE,
6108 ob_len, buckets_length);
6109 return OFPERR_OFPGMFC_BAD_BUCKET;
6111 buckets_length -= ob_len;
6113 ofpbuf_init(&ofpacts, 0);
6114 error = ofpacts_pull_openflow_actions(msg, ob_len - sizeof *ob,
6117 ofpbuf_uninit(&ofpacts);
6118 ofputil_bucket_list_destroy(buckets);
6122 bucket = xzalloc(sizeof *bucket);
6123 bucket->weight = ntohs(ob->weight);
6124 error = ofputil_port_from_ofp11(ob->watch_port, &bucket->watch_port);
6126 ofpbuf_uninit(&ofpacts);
6127 ofputil_bucket_list_destroy(buckets);
6128 return OFPERR_OFPGMFC_BAD_WATCH;
6130 bucket->watch_group = ntohl(ob->watch_group);
6131 bucket->ofpacts = ofpbuf_steal_data(&ofpacts);
6132 bucket->ofpacts_len = ofpacts.size;
6133 list_push_back(buckets, &bucket->list_node);
6139 /* Converts a group description reply in 'msg' into an abstract
6140 * ofputil_group_desc in 'gd'.
6142 * Multiple group description replies can be packed into a single OpenFlow
6143 * message. Calling this function multiple times for a single 'msg' iterates
6144 * through the replies. The caller must initially leave 'msg''s layer pointers
6145 * null and not modify them between calls.
6147 * Returns 0 if successful, EOF if no replies were left in this 'msg',
6148 * otherwise a positive errno value. */
6150 ofputil_decode_group_desc_reply(struct ofputil_group_desc *gd,
6151 struct ofpbuf *msg, enum ofp_version version)
6153 struct ofp11_group_desc_stats *ogds;
6157 ofpraw_pull_assert(msg);
6164 ogds = ofpbuf_try_pull(msg, sizeof *ogds);
6166 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply has %"PRIuSIZE" "
6167 "leftover bytes at end", msg->size);
6168 return OFPERR_OFPBRC_BAD_LEN;
6170 gd->type = ogds->type;
6171 gd->group_id = ntohl(ogds->group_id);
6173 length = ntohs(ogds->length);
6174 if (length < sizeof *ogds || length - sizeof *ogds > msg->size) {
6175 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply claims invalid "
6176 "length %"PRIuSIZE, length);
6177 return OFPERR_OFPBRC_BAD_LEN;
6180 return ofputil_pull_buckets(msg, length - sizeof *ogds, version,
6184 /* Converts abstract group mod 'gm' into a message for OpenFlow version
6185 * 'ofp_version' and returns the message. */
6187 ofputil_encode_group_mod(enum ofp_version ofp_version,
6188 const struct ofputil_group_mod *gm)
6191 struct ofp11_group_mod *ogm;
6193 size_t start_bucket;
6194 struct ofputil_bucket *bucket;
6195 struct ofp11_bucket *ob;
6197 switch (ofp_version) {
6198 case OFP10_VERSION: {
6199 if (gm->command == OFPGC11_ADD) {
6200 ovs_fatal(0, "add-group needs OpenFlow 1.1 or later "
6201 "(\'-O OpenFlow11\')");
6202 } else if (gm->command == OFPGC11_MODIFY) {
6203 ovs_fatal(0, "mod-group needs OpenFlow 1.1 or later "
6204 "(\'-O OpenFlow11\')");
6206 ovs_fatal(0, "del-groups needs OpenFlow 1.1 or later "
6207 "(\'-O OpenFlow11\')");
6213 case OFP13_VERSION: {
6214 b = ofpraw_alloc(OFPRAW_OFPT11_GROUP_MOD, ofp_version, 0);
6215 start_ogm = b->size;
6216 ofpbuf_put_zeros(b, sizeof *ogm);
6218 LIST_FOR_EACH (bucket, list_node, &gm->buckets) {
6219 start_bucket = b->size;
6220 ofpbuf_put_zeros(b, sizeof *ob);
6221 if (bucket->ofpacts && bucket->ofpacts_len) {
6222 ofpacts_put_openflow_actions(bucket->ofpacts,
6223 bucket->ofpacts_len, b,
6226 ob = ofpbuf_at_assert(b, start_bucket, sizeof *ob);
6227 ob->len = htons(b->size - start_bucket);;
6228 ob->weight = htons(bucket->weight);
6229 ob->watch_port = ofputil_port_to_ofp11(bucket->watch_port);
6230 ob->watch_group = htonl(bucket->watch_group);
6232 ogm = ofpbuf_at_assert(b, start_ogm, sizeof *ogm);
6233 ogm->command = htons(gm->command);
6234 ogm->type = gm->type;
6235 ogm->group_id = htonl(gm->group_id);
6247 /* Converts OpenFlow group mod message 'oh' into an abstract group mod in
6248 * 'gm'. Returns 0 if successful, otherwise an OpenFlow error code. */
6250 ofputil_decode_group_mod(const struct ofp_header *oh,
6251 struct ofputil_group_mod *gm)
6253 const struct ofp11_group_mod *ogm;
6255 struct ofputil_bucket *bucket;
6258 ofpbuf_use_const(&msg, oh, ntohs(oh->length));
6259 ofpraw_pull_assert(&msg);
6261 ogm = ofpbuf_pull(&msg, sizeof *ogm);
6262 gm->command = ntohs(ogm->command);
6263 gm->type = ogm->type;
6264 gm->group_id = ntohl(ogm->group_id);
6266 err = ofputil_pull_buckets(&msg, msg.size, oh->version, &gm->buckets);
6271 LIST_FOR_EACH (bucket, list_node, &gm->buckets) {
6274 case OFPGT11_INDIRECT:
6275 if (ofputil_bucket_has_liveness(bucket)) {
6276 return OFPERR_OFPGMFC_WATCH_UNSUPPORTED;
6279 case OFPGT11_SELECT:
6282 if (!ofputil_bucket_has_liveness(bucket)) {
6283 return OFPERR_OFPGMFC_INVALID_GROUP;
6294 /* Parse a queue status request message into 'oqsr'.
6295 * Returns 0 if successful, otherwise an OFPERR_* number. */
6297 ofputil_decode_queue_stats_request(const struct ofp_header *request,
6298 struct ofputil_queue_stats_request *oqsr)
6300 switch ((enum ofp_version)request->version) {
6303 case OFP11_VERSION: {
6304 const struct ofp11_queue_stats_request *qsr11 = ofpmsg_body(request);
6305 oqsr->queue_id = ntohl(qsr11->queue_id);
6306 return ofputil_port_from_ofp11(qsr11->port_no, &oqsr->port_no);
6309 case OFP10_VERSION: {
6310 const struct ofp10_queue_stats_request *qsr10 = ofpmsg_body(request);
6311 oqsr->queue_id = ntohl(qsr10->queue_id);
6312 oqsr->port_no = u16_to_ofp(ntohs(qsr10->port_no));
6313 /* OF 1.0 uses OFPP_ALL for OFPP_ANY */
6314 if (oqsr->port_no == OFPP_ALL) {
6315 oqsr->port_no = OFPP_ANY;
6325 /* Encode a queue statsrequest for 'oqsr', the encoded message
6326 * will be fore Open Flow version 'ofp_version'. Returns message
6327 * as a struct ofpbuf. Returns encoded message on success, NULL on error */
6329 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
6330 const struct ofputil_queue_stats_request *oqsr)
6332 struct ofpbuf *request;
6334 switch (ofp_version) {
6337 case OFP13_VERSION: {
6338 struct ofp11_queue_stats_request *req;
6339 request = ofpraw_alloc(OFPRAW_OFPST11_QUEUE_REQUEST, ofp_version, 0);
6340 req = ofpbuf_put_zeros(request, sizeof *req);
6341 req->port_no = ofputil_port_to_ofp11(oqsr->port_no);
6342 req->queue_id = htonl(oqsr->queue_id);
6345 case OFP10_VERSION: {
6346 struct ofp10_queue_stats_request *req;
6347 request = ofpraw_alloc(OFPRAW_OFPST10_QUEUE_REQUEST, ofp_version, 0);
6348 req = ofpbuf_put_zeros(request, sizeof *req);
6349 /* OpenFlow 1.0 needs OFPP_ALL instead of OFPP_ANY */
6350 req->port_no = htons(ofp_to_u16(oqsr->port_no == OFPP_ANY
6351 ? OFPP_ALL : oqsr->port_no));
6352 req->queue_id = htonl(oqsr->queue_id);
6363 ofputil_get_queue_stats_size(enum ofp_version ofp_version)
6365 switch (ofp_version) {
6367 return sizeof(struct ofp10_queue_stats);
6370 return sizeof(struct ofp11_queue_stats);
6372 return sizeof(struct ofp13_queue_stats);
6378 /* Returns the number of queue stats elements in OFPTYPE_QUEUE_STATS_REPLY
6381 ofputil_count_queue_stats(const struct ofp_header *oh)
6385 ofpbuf_use_const(&b, oh, ntohs(oh->length));
6386 ofpraw_pull_assert(&b);
6388 return b.size / ofputil_get_queue_stats_size(oh->version);
6392 ofputil_queue_stats_from_ofp10(struct ofputil_queue_stats *oqs,
6393 const struct ofp10_queue_stats *qs10)
6395 oqs->port_no = u16_to_ofp(ntohs(qs10->port_no));
6396 oqs->queue_id = ntohl(qs10->queue_id);
6397 oqs->tx_bytes = ntohll(get_32aligned_be64(&qs10->tx_bytes));
6398 oqs->tx_packets = ntohll(get_32aligned_be64(&qs10->tx_packets));
6399 oqs->tx_errors = ntohll(get_32aligned_be64(&qs10->tx_errors));
6400 oqs->duration_sec = oqs->duration_nsec = UINT32_MAX;
6406 ofputil_queue_stats_from_ofp11(struct ofputil_queue_stats *oqs,
6407 const struct ofp11_queue_stats *qs11)
6411 error = ofputil_port_from_ofp11(qs11->port_no, &oqs->port_no);
6416 oqs->queue_id = ntohl(qs11->queue_id);
6417 oqs->tx_bytes = ntohll(qs11->tx_bytes);
6418 oqs->tx_packets = ntohll(qs11->tx_packets);
6419 oqs->tx_errors = ntohll(qs11->tx_errors);
6420 oqs->duration_sec = oqs->duration_nsec = UINT32_MAX;
6426 ofputil_queue_stats_from_ofp13(struct ofputil_queue_stats *oqs,
6427 const struct ofp13_queue_stats *qs13)
6429 enum ofperr error = ofputil_queue_stats_from_ofp11(oqs, &qs13->qs);
6431 oqs->duration_sec = ntohl(qs13->duration_sec);
6432 oqs->duration_nsec = ntohl(qs13->duration_nsec);
6438 /* Converts an OFPST_QUEUE_STATS reply in 'msg' into an abstract
6439 * ofputil_queue_stats in 'qs'.
6441 * Multiple OFPST_QUEUE_STATS replies can be packed into a single OpenFlow
6442 * message. Calling this function multiple times for a single 'msg' iterates
6443 * through the replies. The caller must initially leave 'msg''s layer pointers
6444 * null and not modify them between calls.
6446 * Returns 0 if successful, EOF if no replies were left in this 'msg',
6447 * otherwise a positive errno value. */
6449 ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg)
6455 ? ofpraw_decode(&raw, msg->l2)
6456 : ofpraw_pull(&raw, msg));
6463 } else if (raw == OFPRAW_OFPST13_QUEUE_REPLY) {
6464 const struct ofp13_queue_stats *qs13;
6466 qs13 = ofpbuf_try_pull(msg, sizeof *qs13);
6470 return ofputil_queue_stats_from_ofp13(qs, qs13);
6471 } else if (raw == OFPRAW_OFPST11_QUEUE_REPLY) {
6472 const struct ofp11_queue_stats *qs11;
6474 qs11 = ofpbuf_try_pull(msg, sizeof *qs11);
6478 return ofputil_queue_stats_from_ofp11(qs, qs11);
6479 } else if (raw == OFPRAW_OFPST10_QUEUE_REPLY) {
6480 const struct ofp10_queue_stats *qs10;
6482 qs10 = ofpbuf_try_pull(msg, sizeof *qs10);
6486 return ofputil_queue_stats_from_ofp10(qs, qs10);
6492 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_QUEUE reply has %"PRIuSIZE" leftover "
6493 "bytes at end", msg->size);
6494 return OFPERR_OFPBRC_BAD_LEN;
6498 ofputil_queue_stats_to_ofp10(const struct ofputil_queue_stats *oqs,
6499 struct ofp10_queue_stats *qs10)
6501 qs10->port_no = htons(ofp_to_u16(oqs->port_no));
6502 memset(qs10->pad, 0, sizeof qs10->pad);
6503 qs10->queue_id = htonl(oqs->queue_id);
6504 put_32aligned_be64(&qs10->tx_bytes, htonll(oqs->tx_bytes));
6505 put_32aligned_be64(&qs10->tx_packets, htonll(oqs->tx_packets));
6506 put_32aligned_be64(&qs10->tx_errors, htonll(oqs->tx_errors));
6510 ofputil_queue_stats_to_ofp11(const struct ofputil_queue_stats *oqs,
6511 struct ofp11_queue_stats *qs11)
6513 qs11->port_no = ofputil_port_to_ofp11(oqs->port_no);
6514 qs11->queue_id = htonl(oqs->queue_id);
6515 qs11->tx_bytes = htonll(oqs->tx_bytes);
6516 qs11->tx_packets = htonll(oqs->tx_packets);
6517 qs11->tx_errors = htonll(oqs->tx_errors);
6521 ofputil_queue_stats_to_ofp13(const struct ofputil_queue_stats *oqs,
6522 struct ofp13_queue_stats *qs13)
6524 ofputil_queue_stats_to_ofp11(oqs, &qs13->qs);
6525 if (oqs->duration_sec != UINT32_MAX) {
6526 qs13->duration_sec = htonl(oqs->duration_sec);
6527 qs13->duration_nsec = htonl(oqs->duration_nsec);
6529 qs13->duration_sec = OVS_BE32_MAX;
6530 qs13->duration_nsec = OVS_BE32_MAX;
6534 /* Encode a queue stat for 'oqs' and append it to 'replies'. */
6536 ofputil_append_queue_stat(struct list *replies,
6537 const struct ofputil_queue_stats *oqs)
6539 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
6540 struct ofp_header *oh = msg->data;
6542 switch ((enum ofp_version)oh->version) {
6543 case OFP13_VERSION: {
6544 struct ofp13_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
6545 ofputil_queue_stats_to_ofp13(oqs, reply);
6550 case OFP11_VERSION: {
6551 struct ofp11_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
6552 ofputil_queue_stats_to_ofp11(oqs, reply);
6556 case OFP10_VERSION: {
6557 struct ofp10_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
6558 ofputil_queue_stats_to_ofp10(oqs, reply);