2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 #include "ofp-print.h"
22 #include <sys/types.h>
23 #include <netinet/in.h>
24 #include <netinet/icmp6.h>
27 #include "byte-order.h"
28 #include "classifier.h"
29 #include "dynamic-string.h"
31 #include "meta-flow.h"
32 #include "multipath.h"
35 #include "ofp-actions.h"
36 #include "ofp-errors.h"
42 #include "unaligned.h"
43 #include "type-props.h"
46 VLOG_DEFINE_THIS_MODULE(ofp_util);
48 /* Rate limit for OpenFlow message parse errors. These always indicate a bug
49 * in the peer and so there's not much point in showing a lot of them. */
50 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
52 /* Given the wildcard bit count in the least-significant 6 of 'wcbits', returns
53 * an IP netmask with a 1 in each bit that must match and a 0 in each bit that
56 * The bits in 'wcbits' are in the format used in enum ofp_flow_wildcards: 0
57 * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
58 * ..., 32 and higher wildcard the entire field. This is the *opposite* of the
59 * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
62 ofputil_wcbits_to_netmask(int wcbits)
65 return wcbits < 32 ? htonl(~((1u << wcbits) - 1)) : 0;
68 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
69 * that it wildcards, that is, the number of 0-bits in 'netmask', a number
70 * between 0 and 32 inclusive.
72 * If 'netmask' is not a CIDR netmask (see ip_is_cidr()), the return value will
73 * still be in the valid range but isn't otherwise meaningful. */
75 ofputil_netmask_to_wcbits(ovs_be32 netmask)
77 return 32 - ip_count_cidr_bits(netmask);
80 /* Converts the OpenFlow 1.0 wildcards in 'ofpfw' (OFPFW10_*) into a
81 * flow_wildcards in 'wc' for use in struct match. It is the caller's
82 * responsibility to handle the special case where the flow match's dl_vlan is
83 * set to OFP_VLAN_NONE. */
85 ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *wc)
87 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 20);
89 /* Initialize most of wc. */
90 flow_wildcards_init_catchall(wc);
92 if (!(ofpfw & OFPFW10_IN_PORT)) {
93 wc->masks.in_port.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 = htons(UINT16_MAX);
111 if (!(ofpfw & OFPFW10_TP_DST)) {
112 wc->masks.tp_dst = htons(UINT16_MAX);
115 if (!(ofpfw & OFPFW10_DL_SRC)) {
116 memset(wc->masks.dl_src, 0xff, ETH_ADDR_LEN);
118 if (!(ofpfw & OFPFW10_DL_DST)) {
119 memset(wc->masks.dl_dst, 0xff, ETH_ADDR_LEN);
121 if (!(ofpfw & OFPFW10_DL_TYPE)) {
122 wc->masks.dl_type = htons(UINT16_MAX);
126 if (!(ofpfw & OFPFW10_DL_VLAN_PCP)) {
127 wc->masks.vlan_tci |= htons(VLAN_PCP_MASK | VLAN_CFI);
129 if (!(ofpfw & OFPFW10_DL_VLAN)) {
130 wc->masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
134 /* Converts the ofp10_match in 'ofmatch' into a struct match in 'match'. */
136 ofputil_match_from_ofp10_match(const struct ofp10_match *ofmatch,
139 uint32_t ofpfw = ntohl(ofmatch->wildcards) & OFPFW10_ALL;
141 /* Initialize match->wc. */
142 memset(&match->flow, 0, sizeof match->flow);
143 ofputil_wildcard_from_ofpfw10(ofpfw, &match->wc);
145 /* Initialize most of match->flow. */
146 match->flow.nw_src = ofmatch->nw_src;
147 match->flow.nw_dst = ofmatch->nw_dst;
148 match->flow.in_port.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 'match' into a struct match in 'match. Returns
300 * 0 if successful, otherwise an OFPERR_* value. */
302 ofputil_match_from_ofp11_match(const struct ofp11_match *ofmatch,
305 uint16_t wc = ntohl(ofmatch->wildcards);
306 uint8_t dl_src_mask[ETH_ADDR_LEN];
307 uint8_t dl_dst_mask[ETH_ADDR_LEN];
308 bool ipv4, arp, rarp;
311 match_init_catchall(match);
313 if (!(wc & OFPFW11_IN_PORT)) {
317 error = ofputil_port_from_ofp11(ofmatch->in_port, &ofp_port);
319 return OFPERR_OFPBMC_BAD_VALUE;
321 match_set_in_port(match, ofp_port);
324 for (i = 0; i < ETH_ADDR_LEN; i++) {
325 dl_src_mask[i] = ~ofmatch->dl_src_mask[i];
327 match_set_dl_src_masked(match, ofmatch->dl_src, dl_src_mask);
329 for (i = 0; i < ETH_ADDR_LEN; i++) {
330 dl_dst_mask[i] = ~ofmatch->dl_dst_mask[i];
332 match_set_dl_dst_masked(match, ofmatch->dl_dst, dl_dst_mask);
334 if (!(wc & OFPFW11_DL_VLAN)) {
335 if (ofmatch->dl_vlan == htons(OFPVID11_NONE)) {
336 /* Match only packets without a VLAN tag. */
337 match->flow.vlan_tci = htons(0);
338 match->wc.masks.vlan_tci = htons(UINT16_MAX);
340 if (ofmatch->dl_vlan == htons(OFPVID11_ANY)) {
341 /* Match any packet with a VLAN tag regardless of VID. */
342 match->flow.vlan_tci = htons(VLAN_CFI);
343 match->wc.masks.vlan_tci = htons(VLAN_CFI);
344 } else if (ntohs(ofmatch->dl_vlan) < 4096) {
345 /* Match only packets with the specified VLAN VID. */
346 match->flow.vlan_tci = htons(VLAN_CFI) | ofmatch->dl_vlan;
347 match->wc.masks.vlan_tci = htons(VLAN_CFI | VLAN_VID_MASK);
350 return OFPERR_OFPBMC_BAD_VALUE;
353 if (!(wc & OFPFW11_DL_VLAN_PCP)) {
354 if (ofmatch->dl_vlan_pcp <= 7) {
355 match->flow.vlan_tci |= htons(ofmatch->dl_vlan_pcp
357 match->wc.masks.vlan_tci |= htons(VLAN_PCP_MASK);
360 return OFPERR_OFPBMC_BAD_VALUE;
366 if (!(wc & OFPFW11_DL_TYPE)) {
367 match_set_dl_type(match,
368 ofputil_dl_type_from_openflow(ofmatch->dl_type));
371 ipv4 = match->flow.dl_type == htons(ETH_TYPE_IP);
372 arp = match->flow.dl_type == htons(ETH_TYPE_ARP);
373 rarp = match->flow.dl_type == htons(ETH_TYPE_RARP);
375 if (ipv4 && !(wc & OFPFW11_NW_TOS)) {
376 if (ofmatch->nw_tos & ~IP_DSCP_MASK) {
378 return OFPERR_OFPBMC_BAD_VALUE;
381 match_set_nw_dscp(match, ofmatch->nw_tos);
384 if (ipv4 || arp || rarp) {
385 if (!(wc & OFPFW11_NW_PROTO)) {
386 match_set_nw_proto(match, ofmatch->nw_proto);
388 match_set_nw_src_masked(match, ofmatch->nw_src, ~ofmatch->nw_src_mask);
389 match_set_nw_dst_masked(match, ofmatch->nw_dst, ~ofmatch->nw_dst_mask);
392 #define OFPFW11_TP_ALL (OFPFW11_TP_SRC | OFPFW11_TP_DST)
393 if (ipv4 && (wc & OFPFW11_TP_ALL) != OFPFW11_TP_ALL) {
394 switch (match->flow.nw_proto) {
396 /* "A.2.3 Flow Match Structures" in OF1.1 says:
398 * The tp_src and tp_dst fields will be ignored unless the
399 * network protocol specified is as TCP, UDP or SCTP.
401 * but I'm pretty sure we should support ICMP too, otherwise
402 * that's a regression from OF1.0. */
403 if (!(wc & OFPFW11_TP_SRC)) {
404 uint16_t icmp_type = ntohs(ofmatch->tp_src);
405 if (icmp_type < 0x100) {
406 match_set_icmp_type(match, icmp_type);
408 return OFPERR_OFPBMC_BAD_FIELD;
411 if (!(wc & OFPFW11_TP_DST)) {
412 uint16_t icmp_code = ntohs(ofmatch->tp_dst);
413 if (icmp_code < 0x100) {
414 match_set_icmp_code(match, icmp_code);
416 return OFPERR_OFPBMC_BAD_FIELD;
423 if (!(wc & (OFPFW11_TP_SRC))) {
424 match_set_tp_src(match, ofmatch->tp_src);
426 if (!(wc & (OFPFW11_TP_DST))) {
427 match_set_tp_dst(match, ofmatch->tp_dst);
432 /* We don't support SCTP and it seems that we should tell the
433 * controller, since OF1.1 implementations are supposed to. */
434 return OFPERR_OFPBMC_BAD_FIELD;
437 /* OF1.1 says explicitly to ignore this. */
442 if (eth_type_mpls(match->flow.dl_type)) {
443 enum { OFPFW11_MPLS_ALL = OFPFW11_MPLS_LABEL | OFPFW11_MPLS_TC };
445 if ((wc & OFPFW11_MPLS_ALL) != OFPFW11_MPLS_ALL) {
446 /* MPLS not supported. */
447 return OFPERR_OFPBMC_BAD_TAG;
451 match_set_metadata_masked(match, ofmatch->metadata,
452 ~ofmatch->metadata_mask);
457 /* Convert 'match' into the OpenFlow 1.1 match structure 'ofmatch'. */
459 ofputil_match_to_ofp11_match(const struct match *match,
460 struct ofp11_match *ofmatch)
465 memset(ofmatch, 0, sizeof *ofmatch);
466 ofmatch->omh.type = htons(OFPMT_STANDARD);
467 ofmatch->omh.length = htons(OFPMT11_STANDARD_LENGTH);
469 if (!match->wc.masks.in_port.ofp_port) {
470 wc |= OFPFW11_IN_PORT;
472 ofmatch->in_port = ofputil_port_to_ofp11(match->flow.in_port.ofp_port);
475 memcpy(ofmatch->dl_src, match->flow.dl_src, ETH_ADDR_LEN);
476 for (i = 0; i < ETH_ADDR_LEN; i++) {
477 ofmatch->dl_src_mask[i] = ~match->wc.masks.dl_src[i];
480 memcpy(ofmatch->dl_dst, match->flow.dl_dst, ETH_ADDR_LEN);
481 for (i = 0; i < ETH_ADDR_LEN; i++) {
482 ofmatch->dl_dst_mask[i] = ~match->wc.masks.dl_dst[i];
485 if (match->wc.masks.vlan_tci == htons(0)) {
486 wc |= OFPFW11_DL_VLAN | OFPFW11_DL_VLAN_PCP;
487 } else if (match->wc.masks.vlan_tci & htons(VLAN_CFI)
488 && !(match->flow.vlan_tci & htons(VLAN_CFI))) {
489 ofmatch->dl_vlan = htons(OFPVID11_NONE);
490 wc |= OFPFW11_DL_VLAN_PCP;
492 if (!(match->wc.masks.vlan_tci & htons(VLAN_VID_MASK))) {
493 ofmatch->dl_vlan = htons(OFPVID11_ANY);
495 ofmatch->dl_vlan = htons(vlan_tci_to_vid(match->flow.vlan_tci));
498 if (!(match->wc.masks.vlan_tci & htons(VLAN_PCP_MASK))) {
499 wc |= OFPFW11_DL_VLAN_PCP;
501 ofmatch->dl_vlan_pcp = vlan_tci_to_pcp(match->flow.vlan_tci);
505 if (!match->wc.masks.dl_type) {
506 wc |= OFPFW11_DL_TYPE;
508 ofmatch->dl_type = ofputil_dl_type_to_openflow(match->flow.dl_type);
511 if (!(match->wc.masks.nw_tos & IP_DSCP_MASK)) {
512 wc |= OFPFW11_NW_TOS;
514 ofmatch->nw_tos = match->flow.nw_tos & IP_DSCP_MASK;
517 if (!match->wc.masks.nw_proto) {
518 wc |= OFPFW11_NW_PROTO;
520 ofmatch->nw_proto = match->flow.nw_proto;
523 ofmatch->nw_src = match->flow.nw_src;
524 ofmatch->nw_src_mask = ~match->wc.masks.nw_src;
525 ofmatch->nw_dst = match->flow.nw_dst;
526 ofmatch->nw_dst_mask = ~match->wc.masks.nw_dst;
528 if (!match->wc.masks.tp_src) {
529 wc |= OFPFW11_TP_SRC;
531 ofmatch->tp_src = match->flow.tp_src;
534 if (!match->wc.masks.tp_dst) {
535 wc |= OFPFW11_TP_DST;
537 ofmatch->tp_dst = match->flow.tp_dst;
540 /* MPLS not supported. */
541 wc |= OFPFW11_MPLS_LABEL;
542 wc |= OFPFW11_MPLS_TC;
544 ofmatch->metadata = match->flow.metadata;
545 ofmatch->metadata_mask = ~match->wc.masks.metadata;
547 ofmatch->wildcards = htonl(wc);
550 /* Returns the "typical" length of a match for 'protocol', for use in
551 * estimating space to preallocate. */
553 ofputil_match_typical_len(enum ofputil_protocol protocol)
556 case OFPUTIL_P_OF10_STD:
557 case OFPUTIL_P_OF10_STD_TID:
558 return sizeof(struct ofp10_match);
560 case OFPUTIL_P_OF10_NXM:
561 case OFPUTIL_P_OF10_NXM_TID:
562 return NXM_TYPICAL_LEN;
564 case OFPUTIL_P_OF11_STD:
565 return sizeof(struct ofp11_match);
567 case OFPUTIL_P_OF12_OXM:
568 case OFPUTIL_P_OF13_OXM:
569 return NXM_TYPICAL_LEN;
576 /* Appends to 'b' an struct ofp11_match_header followed by a match that
577 * expresses 'match' properly for 'protocol', plus enough zero bytes to pad the
578 * data appended out to a multiple of 8. 'protocol' must be one that is usable
579 * in OpenFlow 1.1 or later.
581 * This function can cause 'b''s data to be reallocated.
583 * Returns the number of bytes appended to 'b', excluding the padding. Never
586 ofputil_put_ofp11_match(struct ofpbuf *b, const struct match *match,
587 enum ofputil_protocol protocol)
590 case OFPUTIL_P_OF10_STD:
591 case OFPUTIL_P_OF10_STD_TID:
592 case OFPUTIL_P_OF10_NXM:
593 case OFPUTIL_P_OF10_NXM_TID:
596 case OFPUTIL_P_OF11_STD: {
597 struct ofp11_match *om;
599 /* Make sure that no padding is needed. */
600 BUILD_ASSERT_DECL(sizeof *om % 8 == 0);
602 om = ofpbuf_put_uninit(b, sizeof *om);
603 ofputil_match_to_ofp11_match(match, om);
607 case OFPUTIL_P_OF12_OXM:
608 case OFPUTIL_P_OF13_OXM:
609 return oxm_put_match(b, match);
615 /* Given a 'dl_type' value in the format used in struct flow, returns the
616 * corresponding 'dl_type' value for use in an ofp10_match or ofp11_match
619 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type)
621 return (flow_dl_type == htons(FLOW_DL_TYPE_NONE)
622 ? htons(OFP_DL_TYPE_NOT_ETH_TYPE)
626 /* Given a 'dl_type' value in the format used in an ofp10_match or ofp11_match
627 * structure, returns the corresponding 'dl_type' value for use in struct
630 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type)
632 return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
633 ? htons(FLOW_DL_TYPE_NONE)
639 struct proto_abbrev {
640 enum ofputil_protocol protocol;
644 /* Most users really don't care about some of the differences between
645 * protocols. These abbreviations help with that. */
646 static const struct proto_abbrev proto_abbrevs[] = {
647 { OFPUTIL_P_ANY, "any" },
648 { OFPUTIL_P_OF10_STD_ANY, "OpenFlow10" },
649 { OFPUTIL_P_OF10_NXM_ANY, "NXM" },
650 { OFPUTIL_P_ANY_OXM, "OXM" },
652 #define N_PROTO_ABBREVS ARRAY_SIZE(proto_abbrevs)
654 enum ofputil_protocol ofputil_flow_dump_protocols[] = {
661 size_t ofputil_n_flow_dump_protocols = ARRAY_SIZE(ofputil_flow_dump_protocols);
663 /* Returns the set of ofputil_protocols that are supported with the given
664 * OpenFlow 'version'. 'version' should normally be an 8-bit OpenFlow version
665 * identifier (e.g. 0x01 for OpenFlow 1.0, 0x02 for OpenFlow 1.1). Returns 0
666 * if 'version' is not supported or outside the valid range. */
667 enum ofputil_protocol
668 ofputil_protocols_from_ofp_version(enum ofp_version version)
672 return OFPUTIL_P_OF10_STD_ANY | OFPUTIL_P_OF10_NXM_ANY;
674 return OFPUTIL_P_OF11_STD;
676 return OFPUTIL_P_OF12_OXM;
678 return OFPUTIL_P_OF13_OXM;
684 /* Returns the ofputil_protocol that is initially in effect on an OpenFlow
685 * connection that has negotiated the given 'version'. 'version' should
686 * normally be an 8-bit OpenFlow version identifier (e.g. 0x01 for OpenFlow
687 * 1.0, 0x02 for OpenFlow 1.1). Returns 0 if 'version' is not supported or
688 * outside the valid range. */
689 enum ofputil_protocol
690 ofputil_protocol_from_ofp_version(enum ofp_version version)
692 return rightmost_1bit(ofputil_protocols_from_ofp_version(version));
695 /* Returns the OpenFlow protocol version number (e.g. OFP10_VERSION,
696 * etc.) that corresponds to 'protocol'. */
698 ofputil_protocol_to_ofp_version(enum ofputil_protocol protocol)
701 case OFPUTIL_P_OF10_STD:
702 case OFPUTIL_P_OF10_STD_TID:
703 case OFPUTIL_P_OF10_NXM:
704 case OFPUTIL_P_OF10_NXM_TID:
705 return OFP10_VERSION;
706 case OFPUTIL_P_OF11_STD:
707 return OFP11_VERSION;
708 case OFPUTIL_P_OF12_OXM:
709 return OFP12_VERSION;
710 case OFPUTIL_P_OF13_OXM:
711 return OFP13_VERSION;
717 /* Returns a bitmap of OpenFlow versions that are supported by at
718 * least one of the 'protocols'. */
720 ofputil_protocols_to_version_bitmap(enum ofputil_protocol protocols)
724 for (; protocols; protocols = zero_rightmost_1bit(protocols)) {
725 enum ofputil_protocol protocol = rightmost_1bit(protocols);
727 bitmap |= 1u << ofputil_protocol_to_ofp_version(protocol);
733 /* Returns the set of protocols that are supported on top of the
734 * OpenFlow versions included in 'bitmap'. */
735 enum ofputil_protocol
736 ofputil_protocols_from_version_bitmap(uint32_t bitmap)
738 enum ofputil_protocol protocols = 0;
740 for (; bitmap; bitmap = zero_rightmost_1bit(bitmap)) {
741 enum ofp_version version = rightmost_1bit_idx(bitmap);
743 protocols |= ofputil_protocols_from_ofp_version(version);
749 /* Returns true if 'protocol' is a single OFPUTIL_P_* value, false
752 ofputil_protocol_is_valid(enum ofputil_protocol protocol)
754 return protocol & OFPUTIL_P_ANY && is_pow2(protocol);
757 /* Returns the equivalent of 'protocol' with the Nicira flow_mod_table_id
758 * extension turned on or off if 'enable' is true or false, respectively.
760 * This extension is only useful for protocols whose "standard" version does
761 * not allow specific tables to be modified. In particular, this is true of
762 * OpenFlow 1.0. In later versions of OpenFlow, a flow_mod request always
763 * specifies a table ID and so there is no need for such an extension. When
764 * 'protocol' is such a protocol that doesn't need a flow_mod_table_id
765 * extension, this function just returns its 'protocol' argument unchanged
766 * regardless of the value of 'enable'. */
767 enum ofputil_protocol
768 ofputil_protocol_set_tid(enum ofputil_protocol protocol, bool enable)
771 case OFPUTIL_P_OF10_STD:
772 case OFPUTIL_P_OF10_STD_TID:
773 return enable ? OFPUTIL_P_OF10_STD_TID : OFPUTIL_P_OF10_STD;
775 case OFPUTIL_P_OF10_NXM:
776 case OFPUTIL_P_OF10_NXM_TID:
777 return enable ? OFPUTIL_P_OF10_NXM_TID : OFPUTIL_P_OF10_NXM;
779 case OFPUTIL_P_OF11_STD:
780 return OFPUTIL_P_OF11_STD;
782 case OFPUTIL_P_OF12_OXM:
783 return OFPUTIL_P_OF12_OXM;
785 case OFPUTIL_P_OF13_OXM:
786 return OFPUTIL_P_OF13_OXM;
793 /* Returns the "base" version of 'protocol'. That is, if 'protocol' includes
794 * some extension to a standard protocol version, the return value is the
795 * standard version of that protocol without any extension. If 'protocol' is a
796 * standard protocol version, returns 'protocol' unchanged. */
797 enum ofputil_protocol
798 ofputil_protocol_to_base(enum ofputil_protocol protocol)
800 return ofputil_protocol_set_tid(protocol, false);
803 /* Returns 'new_base' with any extensions taken from 'cur'. */
804 enum ofputil_protocol
805 ofputil_protocol_set_base(enum ofputil_protocol cur,
806 enum ofputil_protocol new_base)
808 bool tid = (cur & OFPUTIL_P_TID) != 0;
811 case OFPUTIL_P_OF10_STD:
812 case OFPUTIL_P_OF10_STD_TID:
813 return ofputil_protocol_set_tid(OFPUTIL_P_OF10_STD, tid);
815 case OFPUTIL_P_OF10_NXM:
816 case OFPUTIL_P_OF10_NXM_TID:
817 return ofputil_protocol_set_tid(OFPUTIL_P_OF10_NXM, tid);
819 case OFPUTIL_P_OF11_STD:
820 return ofputil_protocol_set_tid(OFPUTIL_P_OF11_STD, tid);
822 case OFPUTIL_P_OF12_OXM:
823 return ofputil_protocol_set_tid(OFPUTIL_P_OF12_OXM, tid);
825 case OFPUTIL_P_OF13_OXM:
826 return ofputil_protocol_set_tid(OFPUTIL_P_OF13_OXM, tid);
833 /* Returns a string form of 'protocol', if a simple form exists (that is, if
834 * 'protocol' is either a single protocol or it is a combination of protocols
835 * that have a single abbreviation). Otherwise, returns NULL. */
837 ofputil_protocol_to_string(enum ofputil_protocol protocol)
839 const struct proto_abbrev *p;
841 /* Use a "switch" statement for single-bit names so that we get a compiler
842 * warning if we forget any. */
844 case OFPUTIL_P_OF10_NXM:
845 return "NXM-table_id";
847 case OFPUTIL_P_OF10_NXM_TID:
848 return "NXM+table_id";
850 case OFPUTIL_P_OF10_STD:
851 return "OpenFlow10-table_id";
853 case OFPUTIL_P_OF10_STD_TID:
854 return "OpenFlow10+table_id";
856 case OFPUTIL_P_OF11_STD:
859 case OFPUTIL_P_OF12_OXM:
860 return "OXM-OpenFlow12";
862 case OFPUTIL_P_OF13_OXM:
863 return "OXM-OpenFlow13";
866 /* Check abbreviations. */
867 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
868 if (protocol == p->protocol) {
876 /* Returns a string that represents 'protocols'. The return value might be a
877 * comma-separated list if 'protocols' doesn't have a simple name. The return
878 * value is "none" if 'protocols' is 0.
880 * The caller must free the returned string (with free()). */
882 ofputil_protocols_to_string(enum ofputil_protocol protocols)
886 ovs_assert(!(protocols & ~OFPUTIL_P_ANY));
887 if (protocols == 0) {
888 return xstrdup("none");
893 const struct proto_abbrev *p;
897 ds_put_char(&s, ',');
900 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
901 if ((protocols & p->protocol) == p->protocol) {
902 ds_put_cstr(&s, p->name);
903 protocols &= ~p->protocol;
908 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
909 enum ofputil_protocol bit = 1u << i;
911 if (protocols & bit) {
912 ds_put_cstr(&s, ofputil_protocol_to_string(bit));
921 return ds_steal_cstr(&s);
924 static enum ofputil_protocol
925 ofputil_protocol_from_string__(const char *s, size_t n)
927 const struct proto_abbrev *p;
930 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
931 enum ofputil_protocol bit = 1u << i;
932 const char *name = ofputil_protocol_to_string(bit);
934 if (name && n == strlen(name) && !strncasecmp(s, name, n)) {
939 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
940 if (n == strlen(p->name) && !strncasecmp(s, p->name, n)) {
948 /* Returns the nonempty set of protocols represented by 's', which can be a
949 * single protocol name or abbreviation or a comma-separated list of them.
951 * Aborts the program with an error message if 's' is invalid. */
952 enum ofputil_protocol
953 ofputil_protocols_from_string(const char *s)
955 const char *orig_s = s;
956 enum ofputil_protocol protocols;
960 enum ofputil_protocol p;
969 p = ofputil_protocol_from_string__(s, n);
971 ovs_fatal(0, "%.*s: unknown flow protocol", (int) n, s);
979 ovs_fatal(0, "%s: no flow protocol specified", orig_s);
985 ofputil_version_from_string(const char *s)
987 if (!strcasecmp(s, "OpenFlow10")) {
988 return OFP10_VERSION;
990 if (!strcasecmp(s, "OpenFlow11")) {
991 return OFP11_VERSION;
993 if (!strcasecmp(s, "OpenFlow12")) {
994 return OFP12_VERSION;
996 if (!strcasecmp(s, "OpenFlow13")) {
997 return OFP13_VERSION;
1003 is_delimiter(unsigned char c)
1005 return isspace(c) || c == ',';
1009 ofputil_versions_from_string(const char *s)
1012 uint32_t bitmap = 0;
1019 if (is_delimiter(s[i])) {
1024 while (s[i + j] && !is_delimiter(s[i + j])) {
1027 key = xmemdup0(s + i, j);
1028 version = ofputil_version_from_string(key);
1030 VLOG_FATAL("Unknown OpenFlow version: \"%s\"", key);
1033 bitmap |= 1u << version;
1041 ofputil_versions_from_strings(char ** const s, size_t count)
1043 uint32_t bitmap = 0;
1046 int version = ofputil_version_from_string(s[count]);
1048 VLOG_WARN("Unknown OpenFlow version: \"%s\"", s[count]);
1050 bitmap |= 1u << version;
1058 ofputil_version_to_string(enum ofp_version ofp_version)
1060 switch (ofp_version) {
1062 return "OpenFlow10";
1064 return "OpenFlow11";
1066 return "OpenFlow12";
1068 return "OpenFlow13";
1075 ofputil_packet_in_format_is_valid(enum nx_packet_in_format packet_in_format)
1077 switch (packet_in_format) {
1078 case NXPIF_OPENFLOW10:
1087 ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format)
1089 switch (packet_in_format) {
1090 case NXPIF_OPENFLOW10:
1091 return "openflow10";
1100 ofputil_packet_in_format_from_string(const char *s)
1102 return (!strcmp(s, "openflow10") ? NXPIF_OPENFLOW10
1103 : !strcmp(s, "nxm") ? NXPIF_NXM
1108 regs_fully_wildcarded(const struct flow_wildcards *wc)
1112 for (i = 0; i < FLOW_N_REGS; i++) {
1113 if (wc->masks.regs[i] != 0) {
1120 /* Returns a bit-mask of ofputil_protocols that can be used for sending 'match'
1121 * to a switch (e.g. to add or remove a flow). Only NXM can handle tunnel IDs,
1122 * registers, or fixing the Ethernet multicast bit. Otherwise, it's better to
1123 * use OpenFlow 1.0 protocol for backward compatibility. */
1124 enum ofputil_protocol
1125 ofputil_usable_protocols(const struct match *match)
1127 const struct flow_wildcards *wc = &match->wc;
1129 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 20);
1131 /* These tunnel params can't be sent in a flow_mod */
1132 if (wc->masks.tunnel.ip_ttl
1133 || wc->masks.tunnel.ip_tos || wc->masks.tunnel.flags) {
1134 return OFPUTIL_P_NONE;
1137 /* skb_mark and skb_priority can't be sent in a flow_mod */
1138 if (wc->masks.skb_mark || wc->masks.skb_priority) {
1139 return OFPUTIL_P_NONE;
1142 /* NXM, OXM, and OF1.1 support bitwise matching on ethernet addresses. */
1143 if (!eth_mask_is_exact(wc->masks.dl_src)
1144 && !eth_addr_is_zero(wc->masks.dl_src)) {
1145 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1146 | OFPUTIL_P_OF13_OXM;
1148 if (!eth_mask_is_exact(wc->masks.dl_dst)
1149 && !eth_addr_is_zero(wc->masks.dl_dst)) {
1150 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1151 | OFPUTIL_P_OF13_OXM;
1154 /* NXM, OXM, and OF1.1+ support matching metadata. */
1155 if (wc->masks.metadata != htonll(0)) {
1156 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1157 | OFPUTIL_P_OF13_OXM;
1160 /* NXM and OXM support matching ARP hardware addresses. */
1161 if (!eth_addr_is_zero(wc->masks.arp_sha) ||
1162 !eth_addr_is_zero(wc->masks.arp_tha)) {
1163 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1164 | OFPUTIL_P_OF13_OXM;
1167 /* NXM and OXM support matching L3 and L4 fields within IPv6.
1169 * (arp_sha, arp_tha, nw_frag, and nw_ttl are covered elsewhere so they
1170 * don't need to be included in this test too.) */
1171 if (match->flow.dl_type == htons(ETH_TYPE_IPV6)
1172 && (!ipv6_mask_is_any(&wc->masks.ipv6_src)
1173 || !ipv6_mask_is_any(&wc->masks.ipv6_dst)
1174 || !ipv6_mask_is_any(&wc->masks.nd_target)
1175 || wc->masks.ipv6_label
1178 || wc->masks.nw_proto
1179 || wc->masks.nw_tos)) {
1180 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1181 | OFPUTIL_P_OF13_OXM;
1184 /* NXM and OXM support matching registers. */
1185 if (!regs_fully_wildcarded(wc)) {
1186 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1187 | OFPUTIL_P_OF13_OXM;
1190 /* NXM and OXM support matching tun_id, tun_src, and tun_dst. */
1191 if (wc->masks.tunnel.tun_id != htonll(0)
1192 || wc->masks.tunnel.ip_src != htonl(0)
1193 || wc->masks.tunnel.ip_dst != htonl(0)) {
1194 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1195 | OFPUTIL_P_OF13_OXM;
1198 /* NXM and OXM support matching fragments. */
1199 if (wc->masks.nw_frag) {
1200 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1201 | OFPUTIL_P_OF13_OXM;
1204 /* NXM and OXM support matching IP ECN bits. */
1205 if (wc->masks.nw_tos & IP_ECN_MASK) {
1206 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1207 | OFPUTIL_P_OF13_OXM;
1210 /* NXM and OXM support matching IP TTL/hop limit. */
1211 if (wc->masks.nw_ttl) {
1212 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1213 | OFPUTIL_P_OF13_OXM;
1216 /* NXM and OXM support non-CIDR IPv4 address masks. */
1217 if (!ip_is_cidr(wc->masks.nw_src) || !ip_is_cidr(wc->masks.nw_dst)) {
1218 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1219 | OFPUTIL_P_OF13_OXM;
1222 /* NXM and OXM support bitwise matching on transport port. */
1223 if ((wc->masks.tp_src && wc->masks.tp_src != htons(UINT16_MAX)) ||
1224 (wc->masks.tp_dst && wc->masks.tp_dst != htons(UINT16_MAX))) {
1225 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1226 | OFPUTIL_P_OF13_OXM;
1229 /* NXM and OF1.1+ support matching MPLS label */
1230 if (wc->masks.mpls_lse & htonl(MPLS_LABEL_MASK)) {
1231 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1232 | OFPUTIL_P_OF13_OXM;
1235 /* NXM and OF1.1+ support matching MPLS TC */
1236 if (wc->masks.mpls_lse & htonl(MPLS_TC_MASK)) {
1237 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1238 | OFPUTIL_P_OF13_OXM;
1241 /* NXM and OF1.3+ support matching MPLS stack flag */
1242 /* Allow for OF1.2 as there doesn't seem to be a
1243 * particularly good reason not to */
1244 if (wc->masks.mpls_lse & htonl(MPLS_BOS_MASK)) {
1245 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1246 | OFPUTIL_P_OF13_OXM;
1249 /* Other formats can express this rule. */
1250 return OFPUTIL_P_ANY;
1254 ofputil_format_version(struct ds *msg, enum ofp_version version)
1256 ds_put_format(msg, "0x%02x", version);
1260 ofputil_format_version_name(struct ds *msg, enum ofp_version version)
1262 ds_put_cstr(msg, ofputil_version_to_string(version));
1266 ofputil_format_version_bitmap__(struct ds *msg, uint32_t bitmap,
1267 void (*format_version)(struct ds *msg,
1271 format_version(msg, raw_ctz(bitmap));
1272 bitmap = zero_rightmost_1bit(bitmap);
1274 ds_put_cstr(msg, ", ");
1280 ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap)
1282 ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version);
1286 ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap)
1288 ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version_name);
1292 ofputil_decode_hello_bitmap(const struct ofp_hello_elem_header *oheh,
1293 uint32_t *allowed_versionsp)
1295 uint16_t bitmap_len = ntohs(oheh->length) - sizeof *oheh;
1296 const ovs_be32 *bitmap = ALIGNED_CAST(const ovs_be32 *, oheh + 1);
1297 uint32_t allowed_versions;
1299 if (!bitmap_len || bitmap_len % sizeof *bitmap) {
1303 /* Only use the first 32-bit element of the bitmap as that is all the
1304 * current implementation supports. Subsequent elements are ignored which
1305 * should have no effect on session negotiation until Open vSwtich supports
1306 * wire-protocol versions greater than 31.
1308 allowed_versions = ntohl(bitmap[0]);
1310 if (allowed_versions & 1) {
1311 /* There's no OpenFlow version 0. */
1312 VLOG_WARN_RL(&bad_ofmsg_rl, "peer claims to support invalid OpenFlow "
1314 allowed_versions &= ~1u;
1317 if (!allowed_versions) {
1318 VLOG_WARN_RL(&bad_ofmsg_rl, "peer does not support any OpenFlow "
1319 "version (between 0x01 and 0x1f)");
1323 *allowed_versionsp = allowed_versions;
1328 version_bitmap_from_version(uint8_t ofp_version)
1330 return ((ofp_version < 32 ? 1u << ofp_version : 0) - 1) << 1;
1333 /* Decodes OpenFlow OFPT_HELLO message 'oh', storing into '*allowed_versions'
1334 * the set of OpenFlow versions for which 'oh' announces support.
1336 * Because of how OpenFlow defines OFPT_HELLO messages, this function is always
1337 * successful, and thus '*allowed_versions' is always initialized. However, it
1338 * returns false if 'oh' contains some data that could not be fully understood,
1339 * true if 'oh' was completely parsed. */
1341 ofputil_decode_hello(const struct ofp_header *oh, uint32_t *allowed_versions)
1346 ofpbuf_use_const(&msg, oh, ntohs(oh->length));
1347 ofpbuf_pull(&msg, sizeof *oh);
1349 *allowed_versions = version_bitmap_from_version(oh->version);
1351 const struct ofp_hello_elem_header *oheh;
1354 if (msg.size < sizeof *oheh) {
1359 len = ntohs(oheh->length);
1360 if (len < sizeof *oheh || !ofpbuf_try_pull(&msg, ROUND_UP(len, 8))) {
1364 if (oheh->type != htons(OFPHET_VERSIONBITMAP)
1365 || !ofputil_decode_hello_bitmap(oheh, allowed_versions)) {
1373 /* Returns true if 'allowed_versions' needs to be accompanied by a version
1374 * bitmap to be correctly expressed in an OFPT_HELLO message. */
1376 should_send_version_bitmap(uint32_t allowed_versions)
1378 return !is_pow2((allowed_versions >> 1) + 1);
1381 /* Create an OFPT_HELLO message that expresses support for the OpenFlow
1382 * versions in the 'allowed_versions' bitmaps and returns the message. */
1384 ofputil_encode_hello(uint32_t allowed_versions)
1386 enum ofp_version ofp_version;
1389 ofp_version = leftmost_1bit_idx(allowed_versions);
1390 msg = ofpraw_alloc(OFPRAW_OFPT_HELLO, ofp_version, 0);
1392 if (should_send_version_bitmap(allowed_versions)) {
1393 struct ofp_hello_elem_header *oheh;
1396 map_len = sizeof allowed_versions;
1397 oheh = ofpbuf_put_zeros(msg, ROUND_UP(map_len + sizeof *oheh, 8));
1398 oheh->type = htons(OFPHET_VERSIONBITMAP);
1399 oheh->length = htons(map_len + sizeof *oheh);
1400 *ALIGNED_CAST(ovs_be32 *, oheh + 1) = htonl(allowed_versions);
1402 ofpmsg_update_length(msg);
1408 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
1409 * protocol is 'current', at least partly transitions the protocol to 'want'.
1410 * Stores in '*next' the protocol that will be in effect on the OpenFlow
1411 * connection if the switch processes the returned message correctly. (If
1412 * '*next != want' then the caller will have to iterate.)
1414 * If 'current == want', or if it is not possible to transition from 'current'
1415 * to 'want' (because, for example, 'current' and 'want' use different OpenFlow
1416 * protocol versions), returns NULL and stores 'current' in '*next'. */
1418 ofputil_encode_set_protocol(enum ofputil_protocol current,
1419 enum ofputil_protocol want,
1420 enum ofputil_protocol *next)
1422 enum ofp_version cur_version, want_version;
1423 enum ofputil_protocol cur_base, want_base;
1424 bool cur_tid, want_tid;
1426 cur_version = ofputil_protocol_to_ofp_version(current);
1427 want_version = ofputil_protocol_to_ofp_version(want);
1428 if (cur_version != want_version) {
1433 cur_base = ofputil_protocol_to_base(current);
1434 want_base = ofputil_protocol_to_base(want);
1435 if (cur_base != want_base) {
1436 *next = ofputil_protocol_set_base(current, want_base);
1438 switch (want_base) {
1439 case OFPUTIL_P_OF10_NXM:
1440 return ofputil_encode_nx_set_flow_format(NXFF_NXM);
1442 case OFPUTIL_P_OF10_STD:
1443 return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10);
1445 case OFPUTIL_P_OF11_STD:
1446 case OFPUTIL_P_OF12_OXM:
1447 case OFPUTIL_P_OF13_OXM:
1448 /* There is only one variant of each OpenFlow 1.1+ protocol, and we
1449 * verified above that we're not trying to change versions. */
1452 case OFPUTIL_P_OF10_STD_TID:
1453 case OFPUTIL_P_OF10_NXM_TID:
1458 cur_tid = (current & OFPUTIL_P_TID) != 0;
1459 want_tid = (want & OFPUTIL_P_TID) != 0;
1460 if (cur_tid != want_tid) {
1461 *next = ofputil_protocol_set_tid(current, want_tid);
1462 return ofputil_make_flow_mod_table_id(want_tid);
1465 ovs_assert(current == want);
1471 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1472 * format to 'nxff'. */
1474 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff)
1476 struct nx_set_flow_format *sff;
1479 ovs_assert(ofputil_nx_flow_format_is_valid(nxff));
1481 msg = ofpraw_alloc(OFPRAW_NXT_SET_FLOW_FORMAT, OFP10_VERSION, 0);
1482 sff = ofpbuf_put_zeros(msg, sizeof *sff);
1483 sff->format = htonl(nxff);
1488 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1490 enum ofputil_protocol
1491 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format)
1493 switch (flow_format) {
1494 case NXFF_OPENFLOW10:
1495 return OFPUTIL_P_OF10_STD;
1498 return OFPUTIL_P_OF10_NXM;
1505 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1507 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format)
1509 return ofputil_nx_flow_format_to_protocol(flow_format) != 0;
1512 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1515 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format)
1517 switch (flow_format) {
1518 case NXFF_OPENFLOW10:
1519 return "openflow10";
1528 ofputil_make_set_packet_in_format(enum ofp_version ofp_version,
1529 enum nx_packet_in_format packet_in_format)
1531 struct nx_set_packet_in_format *spif;
1534 msg = ofpraw_alloc(OFPRAW_NXT_SET_PACKET_IN_FORMAT, ofp_version, 0);
1535 spif = ofpbuf_put_zeros(msg, sizeof *spif);
1536 spif->format = htonl(packet_in_format);
1541 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1542 * extension on or off (according to 'flow_mod_table_id'). */
1544 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
1546 struct nx_flow_mod_table_id *nfmti;
1549 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION, 0);
1550 nfmti = ofpbuf_put_zeros(msg, sizeof *nfmti);
1551 nfmti->set = flow_mod_table_id;
1555 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1556 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
1559 * Uses 'ofpacts' to store the abstract OFPACT_* version of 'oh''s actions.
1560 * The caller must initialize 'ofpacts' and retains ownership of it.
1561 * 'fm->ofpacts' will point into the 'ofpacts' buffer.
1563 * Does not validate the flow_mod actions. The caller should do that, with
1564 * ofpacts_check(). */
1566 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
1567 const struct ofp_header *oh,
1568 enum ofputil_protocol protocol,
1569 struct ofpbuf *ofpacts)
1575 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1576 raw = ofpraw_pull_assert(&b);
1577 if (raw == OFPRAW_OFPT11_FLOW_MOD) {
1578 /* Standard OpenFlow 1.1 flow_mod. */
1579 const struct ofp11_flow_mod *ofm;
1582 ofm = ofpbuf_pull(&b, sizeof *ofm);
1584 error = ofputil_pull_ofp11_match(&b, &fm->match, NULL);
1589 error = ofpacts_pull_openflow11_instructions(&b, b.size, ofpacts);
1594 /* Translate the message. */
1595 fm->priority = ntohs(ofm->priority);
1596 if (ofm->command == OFPFC_ADD
1597 || (oh->version == OFP11_VERSION
1598 && (ofm->command == OFPFC_MODIFY ||
1599 ofm->command == OFPFC_MODIFY_STRICT)
1600 && ofm->cookie_mask == htonll(0))) {
1601 /* In OpenFlow 1.1 only, a "modify" or "modify-strict" that does
1602 * not match on the cookie is treated as an "add" if there is no
1604 fm->cookie = htonll(0);
1605 fm->cookie_mask = htonll(0);
1606 fm->new_cookie = ofm->cookie;
1608 fm->cookie = ofm->cookie;
1609 fm->cookie_mask = ofm->cookie_mask;
1610 fm->new_cookie = htonll(UINT64_MAX);
1612 fm->modify_cookie = false;
1613 fm->command = ofm->command;
1614 fm->table_id = ofm->table_id;
1615 fm->idle_timeout = ntohs(ofm->idle_timeout);
1616 fm->hard_timeout = ntohs(ofm->hard_timeout);
1617 fm->buffer_id = ntohl(ofm->buffer_id);
1618 error = ofputil_port_from_ofp11(ofm->out_port, &fm->out_port);
1622 if ((ofm->command == OFPFC_DELETE
1623 || ofm->command == OFPFC_DELETE_STRICT)
1624 && ofm->out_group != htonl(OFPG_ANY)) {
1625 return OFPERR_OFPFMFC_UNKNOWN;
1627 fm->flags = ntohs(ofm->flags);
1629 if (raw == OFPRAW_OFPT10_FLOW_MOD) {
1630 /* Standard OpenFlow 1.0 flow_mod. */
1631 const struct ofp10_flow_mod *ofm;
1634 /* Get the ofp10_flow_mod. */
1635 ofm = ofpbuf_pull(&b, sizeof *ofm);
1637 /* Translate the rule. */
1638 ofputil_match_from_ofp10_match(&ofm->match, &fm->match);
1639 ofputil_normalize_match(&fm->match);
1641 /* Now get the actions. */
1642 error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1647 /* OpenFlow 1.0 says that exact-match rules have to have the
1648 * highest possible priority. */
1649 fm->priority = (ofm->match.wildcards & htonl(OFPFW10_ALL)
1650 ? ntohs(ofm->priority)
1653 /* Translate the message. */
1654 command = ntohs(ofm->command);
1655 fm->cookie = htonll(0);
1656 fm->cookie_mask = htonll(0);
1657 fm->new_cookie = ofm->cookie;
1658 fm->idle_timeout = ntohs(ofm->idle_timeout);
1659 fm->hard_timeout = ntohs(ofm->hard_timeout);
1660 fm->buffer_id = ntohl(ofm->buffer_id);
1661 fm->out_port = u16_to_ofp(ntohs(ofm->out_port));
1662 fm->flags = ntohs(ofm->flags);
1663 } else if (raw == OFPRAW_NXT_FLOW_MOD) {
1664 /* Nicira extended flow_mod. */
1665 const struct nx_flow_mod *nfm;
1668 /* Dissect the message. */
1669 nfm = ofpbuf_pull(&b, sizeof *nfm);
1670 error = nx_pull_match(&b, ntohs(nfm->match_len),
1671 &fm->match, &fm->cookie, &fm->cookie_mask);
1675 error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1680 /* Translate the message. */
1681 command = ntohs(nfm->command);
1682 if ((command & 0xff) == OFPFC_ADD && fm->cookie_mask) {
1683 /* Flow additions may only set a new cookie, not match an
1684 * existing cookie. */
1685 return OFPERR_NXBRC_NXM_INVALID;
1687 fm->priority = ntohs(nfm->priority);
1688 fm->new_cookie = nfm->cookie;
1689 fm->idle_timeout = ntohs(nfm->idle_timeout);
1690 fm->hard_timeout = ntohs(nfm->hard_timeout);
1691 fm->buffer_id = ntohl(nfm->buffer_id);
1692 fm->out_port = u16_to_ofp(ntohs(nfm->out_port));
1693 fm->flags = ntohs(nfm->flags);
1698 if (fm->flags & OFPFF10_EMERG) {
1699 /* We do not support the OpenFlow 1.0 emergency flow cache, which
1700 * is not required in OpenFlow 1.0.1 and removed from OpenFlow 1.1.
1702 * OpenFlow 1.0 specifies the error code to use when idle_timeout
1703 * or hard_timeout is nonzero. Otherwise, there is no good error
1704 * code, so just state that the flow table is full. */
1705 return (fm->hard_timeout || fm->idle_timeout
1706 ? OFPERR_OFPFMFC_BAD_EMERG_TIMEOUT
1707 : OFPERR_OFPFMFC_TABLE_FULL);
1710 fm->modify_cookie = fm->new_cookie != htonll(UINT64_MAX);
1711 if (protocol & OFPUTIL_P_TID) {
1712 fm->command = command & 0xff;
1713 fm->table_id = command >> 8;
1715 fm->command = command;
1716 fm->table_id = 0xff;
1720 fm->ofpacts = ofpacts->data;
1721 fm->ofpacts_len = ofpacts->size;
1727 ofputil_pull_bands(struct ofpbuf *msg, size_t len, uint16_t *n_bands,
1728 struct ofpbuf *bands)
1730 const struct ofp13_meter_band_header *ombh;
1731 struct ofputil_meter_band *mb;
1734 ombh = ofpbuf_try_pull(msg, len);
1736 return OFPERR_OFPBRC_BAD_LEN;
1739 while (len >= sizeof (struct ofp13_meter_band_drop)) {
1740 size_t ombh_len = ntohs(ombh->len);
1741 /* All supported band types have the same length. */
1742 if (ombh_len != sizeof (struct ofp13_meter_band_drop)) {
1743 return OFPERR_OFPBRC_BAD_LEN;
1745 mb = ofpbuf_put_uninit(bands, sizeof *mb);
1746 mb->type = ntohs(ombh->type);
1747 mb->rate = ntohl(ombh->rate);
1748 mb->burst_size = ntohl(ombh->burst_size);
1749 mb->prec_level = (mb->type == OFPMBT13_DSCP_REMARK) ?
1750 ((struct ofp13_meter_band_dscp_remark *)ombh)->prec_level : 0;
1753 ombh = ALIGNED_CAST(struct ofp13_meter_band_header *,
1754 (char *) ombh + ombh_len);
1757 return OFPERR_OFPBRC_BAD_LEN;
1764 ofputil_decode_meter_mod(const struct ofp_header *oh,
1765 struct ofputil_meter_mod *mm,
1766 struct ofpbuf *bands)
1768 const struct ofp13_meter_mod *omm;
1771 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1772 ofpraw_pull_assert(&b);
1773 omm = ofpbuf_pull(&b, sizeof *omm);
1775 /* Translate the message. */
1776 mm->command = ntohs(omm->command);
1777 mm->meter.meter_id = ntohl(omm->meter_id);
1779 if (mm->command == OFPMC13_DELETE) {
1780 mm->meter.flags = 0;
1781 mm->meter.n_bands = 0;
1782 mm->meter.bands = NULL;
1786 mm->meter.flags = ntohs(omm->flags);
1787 mm->meter.bands = bands->data;
1789 error = ofputil_pull_bands(&b, b.size, &mm->meter.n_bands, bands);
1798 ofputil_decode_meter_request(const struct ofp_header *oh, uint32_t *meter_id)
1800 const struct ofp13_meter_multipart_request *omr = ofpmsg_body(oh);
1801 *meter_id = ntohl(omr->meter_id);
1805 ofputil_encode_meter_request(enum ofp_version ofp_version,
1806 enum ofputil_meter_request_type type,
1814 case OFPUTIL_METER_CONFIG:
1815 raw = OFPRAW_OFPST13_METER_CONFIG_REQUEST;
1817 case OFPUTIL_METER_STATS:
1818 raw = OFPRAW_OFPST13_METER_REQUEST;
1821 case OFPUTIL_METER_FEATURES:
1822 raw = OFPRAW_OFPST13_METER_FEATURES_REQUEST;
1826 msg = ofpraw_alloc(raw, ofp_version, 0);
1828 if (type != OFPUTIL_METER_FEATURES) {
1829 struct ofp13_meter_multipart_request *omr;
1830 omr = ofpbuf_put_zeros(msg, sizeof *omr);
1831 omr->meter_id = htonl(meter_id);
1837 ofputil_put_bands(uint16_t n_bands, const struct ofputil_meter_band *mb,
1842 for (n = 0; n < n_bands; ++n) {
1843 /* Currently all band types have same size. */
1844 struct ofp13_meter_band_dscp_remark *ombh;
1845 size_t ombh_len = sizeof *ombh;
1847 ombh = ofpbuf_put_zeros(msg, ombh_len);
1849 ombh->type = htons(mb->type);
1850 ombh->len = htons(ombh_len);
1851 ombh->rate = htonl(mb->rate);
1852 ombh->burst_size = htonl(mb->burst_size);
1853 ombh->prec_level = mb->prec_level;
1859 /* Encode a meter stat for 'mc' and append it to 'replies'. */
1861 ofputil_append_meter_config(struct list *replies,
1862 const struct ofputil_meter_config *mc)
1864 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
1865 size_t start_ofs = msg->size;
1866 struct ofp13_meter_config *reply = ofpbuf_put_uninit(msg, sizeof *reply);
1867 reply->flags = htons(mc->flags);
1868 reply->meter_id = htonl(mc->meter_id);
1870 ofputil_put_bands(mc->n_bands, mc->bands, msg);
1872 reply->length = htons(msg->size - start_ofs);
1874 ofpmp_postappend(replies, start_ofs);
1877 /* Encode a meter stat for 'ms' and append it to 'replies'. */
1879 ofputil_append_meter_stats(struct list *replies,
1880 const struct ofputil_meter_stats *ms)
1882 struct ofp13_meter_stats *reply;
1886 len = sizeof *reply + ms->n_bands * sizeof(struct ofp13_meter_band_stats);
1887 reply = ofpmp_append(replies, len);
1889 reply->meter_id = htonl(ms->meter_id);
1890 reply->len = htons(len);
1891 memset(reply->pad, 0, sizeof reply->pad);
1892 reply->flow_count = htonl(ms->flow_count);
1893 reply->packet_in_count = htonll(ms->packet_in_count);
1894 reply->byte_in_count = htonll(ms->byte_in_count);
1895 reply->duration_sec = htonl(ms->duration_sec);
1896 reply->duration_nsec = htonl(ms->duration_nsec);
1898 for (n = 0; n < ms->n_bands; ++n) {
1899 const struct ofputil_meter_band_stats *src = &ms->bands[n];
1900 struct ofp13_meter_band_stats *dst = &reply->band_stats[n];
1902 dst->packet_band_count = htonll(src->packet_count);
1903 dst->byte_band_count = htonll(src->byte_count);
1907 /* Converts an OFPMP_METER_CONFIG reply in 'msg' into an abstract
1908 * ofputil_meter_config in 'mc', with mc->bands pointing to bands decoded into
1909 * 'bands'. The caller must have initialized 'bands' and retains ownership of
1910 * it across the call.
1912 * Multiple OFPST13_METER_CONFIG replies can be packed into a single OpenFlow
1913 * message. Calling this function multiple times for a single 'msg' iterates
1914 * through the replies. 'bands' is cleared for each reply.
1916 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1917 * otherwise a positive errno value. */
1919 ofputil_decode_meter_config(struct ofpbuf *msg,
1920 struct ofputil_meter_config *mc,
1921 struct ofpbuf *bands)
1923 const struct ofp13_meter_config *omc;
1926 /* Pull OpenFlow headers for the first call. */
1928 ofpraw_pull_assert(msg);
1935 omc = ofpbuf_try_pull(msg, sizeof *omc);
1937 VLOG_WARN_RL(&bad_ofmsg_rl,
1938 "OFPMP_METER_CONFIG reply has %zu leftover bytes at end",
1940 return OFPERR_OFPBRC_BAD_LEN;
1943 ofpbuf_clear(bands);
1944 err = ofputil_pull_bands(msg, ntohs(omc->length) - sizeof *omc,
1945 &mc->n_bands, bands);
1949 mc->meter_id = ntohl(omc->meter_id);
1950 mc->flags = ntohs(omc->flags);
1951 mc->bands = bands->data;
1957 ofputil_pull_band_stats(struct ofpbuf *msg, size_t len, uint16_t *n_bands,
1958 struct ofpbuf *bands)
1960 const struct ofp13_meter_band_stats *ombs;
1961 struct ofputil_meter_band_stats *mbs;
1964 ombs = ofpbuf_try_pull(msg, len);
1966 return OFPERR_OFPBRC_BAD_LEN;
1969 n = len / sizeof *ombs;
1970 if (len != n * sizeof *ombs) {
1971 return OFPERR_OFPBRC_BAD_LEN;
1974 mbs = ofpbuf_put_uninit(bands, len);
1976 for (i = 0; i < n; ++i) {
1977 mbs[i].packet_count = ntohll(ombs[i].packet_band_count);
1978 mbs[i].byte_count = ntohll(ombs[i].byte_band_count);
1984 /* Converts an OFPMP_METER reply in 'msg' into an abstract
1985 * ofputil_meter_stats in 'ms', with ms->bands pointing to band stats
1986 * decoded into 'bands'.
1988 * Multiple OFPMP_METER replies can be packed into a single OpenFlow
1989 * message. Calling this function multiple times for a single 'msg' iterates
1990 * through the replies. 'bands' is cleared for each reply.
1992 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1993 * otherwise a positive errno value. */
1995 ofputil_decode_meter_stats(struct ofpbuf *msg,
1996 struct ofputil_meter_stats *ms,
1997 struct ofpbuf *bands)
1999 const struct ofp13_meter_stats *oms;
2002 /* Pull OpenFlow headers for the first call. */
2004 ofpraw_pull_assert(msg);
2011 oms = ofpbuf_try_pull(msg, sizeof *oms);
2013 VLOG_WARN_RL(&bad_ofmsg_rl,
2014 "OFPMP_METER reply has %zu leftover bytes at end",
2016 return OFPERR_OFPBRC_BAD_LEN;
2019 ofpbuf_clear(bands);
2020 err = ofputil_pull_band_stats(msg, ntohs(oms->len) - sizeof *oms,
2021 &ms->n_bands, bands);
2025 ms->meter_id = ntohl(oms->meter_id);
2026 ms->flow_count = ntohl(oms->flow_count);
2027 ms->packet_in_count = ntohll(oms->packet_in_count);
2028 ms->byte_in_count = ntohll(oms->byte_in_count);
2029 ms->duration_sec = ntohl(oms->duration_sec);
2030 ms->duration_nsec = ntohl(oms->duration_nsec);
2031 ms->bands = bands->data;
2037 ofputil_decode_meter_features(const struct ofp_header *oh,
2038 struct ofputil_meter_features *mf)
2040 const struct ofp13_meter_features *omf = ofpmsg_body(oh);
2042 mf->max_meters = ntohl(omf->max_meter);
2043 mf->band_types = ntohl(omf->band_types);
2044 mf->capabilities = ntohl(omf->capabilities);
2045 mf->max_bands = omf->max_bands;
2046 mf->max_color = omf->max_color;
2050 ofputil_encode_meter_features_reply(const struct ofputil_meter_features *mf,
2051 const struct ofp_header *request)
2053 struct ofpbuf *reply;
2054 struct ofp13_meter_features *omf;
2056 reply = ofpraw_alloc_stats_reply(request, 0);
2057 omf = ofpbuf_put_zeros(reply, sizeof *omf);
2059 omf->max_meter = htonl(mf->max_meters);
2060 omf->band_types = htonl(mf->band_types);
2061 omf->capabilities = htonl(mf->capabilities);
2062 omf->max_bands = mf->max_bands;
2063 omf->max_color = mf->max_color;
2069 ofputil_encode_meter_mod(enum ofp_version ofp_version,
2070 const struct ofputil_meter_mod *mm)
2074 struct ofp13_meter_mod *omm;
2076 msg = ofpraw_alloc(OFPRAW_OFPT13_METER_MOD, ofp_version,
2077 NXM_TYPICAL_LEN + mm->meter.n_bands * 16);
2078 omm = ofpbuf_put_zeros(msg, sizeof *omm);
2079 omm->command = htons(mm->command);
2080 if (mm->command != OFPMC13_DELETE) {
2081 omm->flags = htons(mm->meter.flags);
2083 omm->meter_id = htonl(mm->meter.meter_id);
2085 ofputil_put_bands(mm->meter.n_bands, mm->meter.bands, msg);
2087 ofpmsg_update_length(msg);
2092 ofputil_tid_command(const struct ofputil_flow_mod *fm,
2093 enum ofputil_protocol protocol)
2095 return htons(protocol & OFPUTIL_P_TID
2096 ? (fm->command & 0xff) | (fm->table_id << 8)
2100 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
2101 * 'protocol' and returns the message. */
2103 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
2104 enum ofputil_protocol protocol)
2109 case OFPUTIL_P_OF11_STD:
2110 case OFPUTIL_P_OF12_OXM:
2111 case OFPUTIL_P_OF13_OXM: {
2112 struct ofp11_flow_mod *ofm;
2115 tailroom = ofputil_match_typical_len(protocol) + fm->ofpacts_len;
2116 msg = ofpraw_alloc(OFPRAW_OFPT11_FLOW_MOD,
2117 ofputil_protocol_to_ofp_version(protocol),
2119 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
2120 if ((protocol == OFPUTIL_P_OF11_STD
2121 && (fm->command == OFPFC_MODIFY ||
2122 fm->command == OFPFC_MODIFY_STRICT)
2123 && fm->cookie_mask == htonll(0))
2124 || fm->command == OFPFC_ADD) {
2125 ofm->cookie = fm->new_cookie;
2127 ofm->cookie = fm->cookie;
2129 ofm->cookie_mask = fm->cookie_mask;
2130 ofm->table_id = fm->table_id;
2131 ofm->command = fm->command;
2132 ofm->idle_timeout = htons(fm->idle_timeout);
2133 ofm->hard_timeout = htons(fm->hard_timeout);
2134 ofm->priority = htons(fm->priority);
2135 ofm->buffer_id = htonl(fm->buffer_id);
2136 ofm->out_port = ofputil_port_to_ofp11(fm->out_port);
2137 ofm->out_group = htonl(OFPG11_ANY);
2138 ofm->flags = htons(fm->flags);
2139 ofputil_put_ofp11_match(msg, &fm->match, protocol);
2140 ofpacts_put_openflow11_instructions(fm->ofpacts, fm->ofpacts_len, msg);
2144 case OFPUTIL_P_OF10_STD:
2145 case OFPUTIL_P_OF10_STD_TID: {
2146 struct ofp10_flow_mod *ofm;
2148 msg = ofpraw_alloc(OFPRAW_OFPT10_FLOW_MOD, OFP10_VERSION,
2150 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
2151 ofputil_match_to_ofp10_match(&fm->match, &ofm->match);
2152 ofm->cookie = fm->new_cookie;
2153 ofm->command = ofputil_tid_command(fm, protocol);
2154 ofm->idle_timeout = htons(fm->idle_timeout);
2155 ofm->hard_timeout = htons(fm->hard_timeout);
2156 ofm->priority = htons(fm->priority);
2157 ofm->buffer_id = htonl(fm->buffer_id);
2158 ofm->out_port = htons(ofp_to_u16(fm->out_port));
2159 ofm->flags = htons(fm->flags);
2160 ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
2164 case OFPUTIL_P_OF10_NXM:
2165 case OFPUTIL_P_OF10_NXM_TID: {
2166 struct nx_flow_mod *nfm;
2169 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD, OFP10_VERSION,
2170 NXM_TYPICAL_LEN + fm->ofpacts_len);
2171 nfm = ofpbuf_put_zeros(msg, sizeof *nfm);
2172 nfm->command = ofputil_tid_command(fm, protocol);
2173 nfm->cookie = fm->new_cookie;
2174 match_len = nx_put_match(msg, &fm->match, fm->cookie, fm->cookie_mask);
2176 nfm->idle_timeout = htons(fm->idle_timeout);
2177 nfm->hard_timeout = htons(fm->hard_timeout);
2178 nfm->priority = htons(fm->priority);
2179 nfm->buffer_id = htonl(fm->buffer_id);
2180 nfm->out_port = htons(ofp_to_u16(fm->out_port));
2181 nfm->flags = htons(fm->flags);
2182 nfm->match_len = htons(match_len);
2183 ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
2191 ofpmsg_update_length(msg);
2195 /* Returns a bitmask with a 1-bit for each protocol that could be used to
2196 * send all of the 'n_fm's flow table modification requests in 'fms', and a
2197 * 0-bit for each protocol that is inadequate.
2199 * (The return value will have at least one 1-bit.) */
2200 enum ofputil_protocol
2201 ofputil_flow_mod_usable_protocols(const struct ofputil_flow_mod *fms,
2204 enum ofputil_protocol usable_protocols;
2207 usable_protocols = OFPUTIL_P_ANY;
2208 for (i = 0; i < n_fms; i++) {
2209 const struct ofputil_flow_mod *fm = &fms[i];
2211 usable_protocols &= ofputil_usable_protocols(&fm->match);
2212 if (fm->table_id != 0xff) {
2213 usable_protocols &= OFPUTIL_P_TID;
2216 /* Matching of the cookie is only supported through NXM or OF1.1+. */
2217 if (fm->cookie_mask != htonll(0)) {
2218 usable_protocols &= (OFPUTIL_P_OF10_NXM_ANY
2219 | OFPUTIL_P_OF11_STD
2220 | OFPUTIL_P_OF12_OXM
2221 | OFPUTIL_P_OF13_OXM);
2225 return usable_protocols;
2229 ofputil_decode_ofpst10_flow_request(struct ofputil_flow_stats_request *fsr,
2230 const struct ofp10_flow_stats_request *ofsr,
2233 fsr->aggregate = aggregate;
2234 ofputil_match_from_ofp10_match(&ofsr->match, &fsr->match);
2235 fsr->out_port = u16_to_ofp(ntohs(ofsr->out_port));
2236 fsr->table_id = ofsr->table_id;
2237 fsr->cookie = fsr->cookie_mask = htonll(0);
2243 ofputil_decode_ofpst11_flow_request(struct ofputil_flow_stats_request *fsr,
2244 struct ofpbuf *b, bool aggregate)
2246 const struct ofp11_flow_stats_request *ofsr;
2249 ofsr = ofpbuf_pull(b, sizeof *ofsr);
2250 fsr->aggregate = aggregate;
2251 fsr->table_id = ofsr->table_id;
2252 error = ofputil_port_from_ofp11(ofsr->out_port, &fsr->out_port);
2256 if (ofsr->out_group != htonl(OFPG11_ANY)) {
2257 return OFPERR_OFPFMFC_UNKNOWN;
2259 fsr->cookie = ofsr->cookie;
2260 fsr->cookie_mask = ofsr->cookie_mask;
2261 error = ofputil_pull_ofp11_match(b, &fsr->match, NULL);
2270 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
2271 struct ofpbuf *b, bool aggregate)
2273 const struct nx_flow_stats_request *nfsr;
2276 nfsr = ofpbuf_pull(b, sizeof *nfsr);
2277 error = nx_pull_match(b, ntohs(nfsr->match_len), &fsr->match,
2278 &fsr->cookie, &fsr->cookie_mask);
2283 return OFPERR_OFPBRC_BAD_LEN;
2286 fsr->aggregate = aggregate;
2287 fsr->out_port = u16_to_ofp(ntohs(nfsr->out_port));
2288 fsr->table_id = nfsr->table_id;
2293 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
2294 * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
2295 * successful, otherwise an OpenFlow error code. */
2297 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
2298 const struct ofp_header *oh)
2303 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2304 raw = ofpraw_pull_assert(&b);
2305 switch ((int) raw) {
2306 case OFPRAW_OFPST10_FLOW_REQUEST:
2307 return ofputil_decode_ofpst10_flow_request(fsr, b.data, false);
2309 case OFPRAW_OFPST10_AGGREGATE_REQUEST:
2310 return ofputil_decode_ofpst10_flow_request(fsr, b.data, true);
2312 case OFPRAW_OFPST11_FLOW_REQUEST:
2313 return ofputil_decode_ofpst11_flow_request(fsr, &b, false);
2315 case OFPRAW_OFPST11_AGGREGATE_REQUEST:
2316 return ofputil_decode_ofpst11_flow_request(fsr, &b, true);
2318 case OFPRAW_NXST_FLOW_REQUEST:
2319 return ofputil_decode_nxst_flow_request(fsr, &b, false);
2321 case OFPRAW_NXST_AGGREGATE_REQUEST:
2322 return ofputil_decode_nxst_flow_request(fsr, &b, true);
2325 /* Hey, the caller lied. */
2330 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
2331 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
2332 * 'protocol', and returns the message. */
2334 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
2335 enum ofputil_protocol protocol)
2341 case OFPUTIL_P_OF11_STD:
2342 case OFPUTIL_P_OF12_OXM:
2343 case OFPUTIL_P_OF13_OXM: {
2344 struct ofp11_flow_stats_request *ofsr;
2346 raw = (fsr->aggregate
2347 ? OFPRAW_OFPST11_AGGREGATE_REQUEST
2348 : OFPRAW_OFPST11_FLOW_REQUEST);
2349 msg = ofpraw_alloc(raw, ofputil_protocol_to_ofp_version(protocol),
2350 ofputil_match_typical_len(protocol));
2351 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
2352 ofsr->table_id = fsr->table_id;
2353 ofsr->out_port = ofputil_port_to_ofp11(fsr->out_port);
2354 ofsr->out_group = htonl(OFPG11_ANY);
2355 ofsr->cookie = fsr->cookie;
2356 ofsr->cookie_mask = fsr->cookie_mask;
2357 ofputil_put_ofp11_match(msg, &fsr->match, protocol);
2361 case OFPUTIL_P_OF10_STD:
2362 case OFPUTIL_P_OF10_STD_TID: {
2363 struct ofp10_flow_stats_request *ofsr;
2365 raw = (fsr->aggregate
2366 ? OFPRAW_OFPST10_AGGREGATE_REQUEST
2367 : OFPRAW_OFPST10_FLOW_REQUEST);
2368 msg = ofpraw_alloc(raw, OFP10_VERSION, 0);
2369 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
2370 ofputil_match_to_ofp10_match(&fsr->match, &ofsr->match);
2371 ofsr->table_id = fsr->table_id;
2372 ofsr->out_port = htons(ofp_to_u16(fsr->out_port));
2376 case OFPUTIL_P_OF10_NXM:
2377 case OFPUTIL_P_OF10_NXM_TID: {
2378 struct nx_flow_stats_request *nfsr;
2381 raw = (fsr->aggregate
2382 ? OFPRAW_NXST_AGGREGATE_REQUEST
2383 : OFPRAW_NXST_FLOW_REQUEST);
2384 msg = ofpraw_alloc(raw, OFP10_VERSION, NXM_TYPICAL_LEN);
2385 ofpbuf_put_zeros(msg, sizeof *nfsr);
2386 match_len = nx_put_match(msg, &fsr->match,
2387 fsr->cookie, fsr->cookie_mask);
2390 nfsr->out_port = htons(ofp_to_u16(fsr->out_port));
2391 nfsr->match_len = htons(match_len);
2392 nfsr->table_id = fsr->table_id;
2403 /* Returns a bitmask with a 1-bit for each protocol that could be used to
2404 * accurately encode 'fsr', and a 0-bit for each protocol that is inadequate.
2406 * (The return value will have at least one 1-bit.) */
2407 enum ofputil_protocol
2408 ofputil_flow_stats_request_usable_protocols(
2409 const struct ofputil_flow_stats_request *fsr)
2411 enum ofputil_protocol usable_protocols;
2413 usable_protocols = ofputil_usable_protocols(&fsr->match);
2414 if (fsr->cookie_mask != htonll(0)) {
2415 usable_protocols &= OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
2416 | OFPUTIL_P_OF13_OXM;
2418 return usable_protocols;
2421 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
2422 * ofputil_flow_stats in 'fs'.
2424 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
2425 * OpenFlow message. Calling this function multiple times for a single 'msg'
2426 * iterates through the replies. The caller must initially leave 'msg''s layer
2427 * pointers null and not modify them between calls.
2429 * Most switches don't send the values needed to populate fs->idle_age and
2430 * fs->hard_age, so those members will usually be set to 0. If the switch from
2431 * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
2432 * 'flow_age_extension' as true so that the contents of 'msg' determine the
2433 * 'idle_age' and 'hard_age' members in 'fs'.
2435 * Uses 'ofpacts' to store the abstract OFPACT_* version of the flow stats
2436 * reply's actions. The caller must initialize 'ofpacts' and retains ownership
2437 * of it. 'fs->ofpacts' will point into the 'ofpacts' buffer.
2439 * Returns 0 if successful, EOF if no replies were left in this 'msg',
2440 * otherwise a positive errno value. */
2442 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
2444 bool flow_age_extension,
2445 struct ofpbuf *ofpacts)
2451 ? ofpraw_decode(&raw, msg->l2)
2452 : ofpraw_pull(&raw, msg));
2459 } else if (raw == OFPRAW_OFPST11_FLOW_REPLY
2460 || raw == OFPRAW_OFPST13_FLOW_REPLY) {
2461 const struct ofp11_flow_stats *ofs;
2463 uint16_t padded_match_len;
2465 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2467 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
2468 "bytes at end", msg->size);
2472 length = ntohs(ofs->length);
2473 if (length < sizeof *ofs) {
2474 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2475 "length %zu", length);
2479 if (ofputil_pull_ofp11_match(msg, &fs->match, &padded_match_len)) {
2480 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad match");
2484 if (ofpacts_pull_openflow11_instructions(msg, length - sizeof *ofs -
2485 padded_match_len, ofpacts)) {
2486 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad instructions");
2490 fs->priority = ntohs(ofs->priority);
2491 fs->table_id = ofs->table_id;
2492 fs->duration_sec = ntohl(ofs->duration_sec);
2493 fs->duration_nsec = ntohl(ofs->duration_nsec);
2494 fs->idle_timeout = ntohs(ofs->idle_timeout);
2495 fs->hard_timeout = ntohs(ofs->hard_timeout);
2496 fs->flags = (raw == OFPRAW_OFPST13_FLOW_REPLY) ? ntohs(ofs->flags) : 0;
2499 fs->cookie = ofs->cookie;
2500 fs->packet_count = ntohll(ofs->packet_count);
2501 fs->byte_count = ntohll(ofs->byte_count);
2502 } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
2503 const struct ofp10_flow_stats *ofs;
2506 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2508 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
2509 "bytes at end", msg->size);
2513 length = ntohs(ofs->length);
2514 if (length < sizeof *ofs) {
2515 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2516 "length %zu", length);
2520 if (ofpacts_pull_openflow10(msg, length - sizeof *ofs, ofpacts)) {
2524 fs->cookie = get_32aligned_be64(&ofs->cookie);
2525 ofputil_match_from_ofp10_match(&ofs->match, &fs->match);
2526 fs->priority = ntohs(ofs->priority);
2527 fs->table_id = ofs->table_id;
2528 fs->duration_sec = ntohl(ofs->duration_sec);
2529 fs->duration_nsec = ntohl(ofs->duration_nsec);
2530 fs->idle_timeout = ntohs(ofs->idle_timeout);
2531 fs->hard_timeout = ntohs(ofs->hard_timeout);
2534 fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
2535 fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
2537 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
2538 const struct nx_flow_stats *nfs;
2539 size_t match_len, actions_len, length;
2541 nfs = ofpbuf_try_pull(msg, sizeof *nfs);
2543 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
2544 "bytes at end", msg->size);
2548 length = ntohs(nfs->length);
2549 match_len = ntohs(nfs->match_len);
2550 if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
2551 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
2552 "claims invalid length %zu", match_len, length);
2555 if (nx_pull_match(msg, match_len, &fs->match, NULL, NULL)) {
2559 actions_len = length - sizeof *nfs - ROUND_UP(match_len, 8);
2560 if (ofpacts_pull_openflow10(msg, actions_len, ofpacts)) {
2564 fs->cookie = nfs->cookie;
2565 fs->table_id = nfs->table_id;
2566 fs->duration_sec = ntohl(nfs->duration_sec);
2567 fs->duration_nsec = ntohl(nfs->duration_nsec);
2568 fs->priority = ntohs(nfs->priority);
2569 fs->idle_timeout = ntohs(nfs->idle_timeout);
2570 fs->hard_timeout = ntohs(nfs->hard_timeout);
2573 if (flow_age_extension) {
2574 if (nfs->idle_age) {
2575 fs->idle_age = ntohs(nfs->idle_age) - 1;
2577 if (nfs->hard_age) {
2578 fs->hard_age = ntohs(nfs->hard_age) - 1;
2581 fs->packet_count = ntohll(nfs->packet_count);
2582 fs->byte_count = ntohll(nfs->byte_count);
2588 fs->ofpacts = ofpacts->data;
2589 fs->ofpacts_len = ofpacts->size;
2594 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
2596 * We use this in situations where OVS internally uses UINT64_MAX to mean
2597 * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
2599 unknown_to_zero(uint64_t count)
2601 return count != UINT64_MAX ? count : 0;
2604 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
2605 * those already present in the list of ofpbufs in 'replies'. 'replies' should
2606 * have been initialized with ofputil_start_stats_reply(). */
2608 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
2609 struct list *replies)
2611 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
2612 size_t start_ofs = reply->size;
2615 ofpraw_decode_partial(&raw, reply->data, reply->size);
2616 if (raw == OFPRAW_OFPST11_FLOW_REPLY || raw == OFPRAW_OFPST13_FLOW_REPLY) {
2617 struct ofp11_flow_stats *ofs;
2619 ofpbuf_put_uninit(reply, sizeof *ofs);
2620 oxm_put_match(reply, &fs->match);
2621 ofpacts_put_openflow11_instructions(fs->ofpacts, fs->ofpacts_len,
2624 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
2625 ofs->length = htons(reply->size - start_ofs);
2626 ofs->table_id = fs->table_id;
2628 ofs->duration_sec = htonl(fs->duration_sec);
2629 ofs->duration_nsec = htonl(fs->duration_nsec);
2630 ofs->priority = htons(fs->priority);
2631 ofs->idle_timeout = htons(fs->idle_timeout);
2632 ofs->hard_timeout = htons(fs->hard_timeout);
2633 ofs->flags = (raw == OFPRAW_OFPST13_FLOW_REPLY) ? htons(fs->flags) : 0;
2634 memset(ofs->pad2, 0, sizeof ofs->pad2);
2635 ofs->cookie = fs->cookie;
2636 ofs->packet_count = htonll(unknown_to_zero(fs->packet_count));
2637 ofs->byte_count = htonll(unknown_to_zero(fs->byte_count));
2638 } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
2639 struct ofp10_flow_stats *ofs;
2641 ofpbuf_put_uninit(reply, sizeof *ofs);
2642 ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
2644 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
2645 ofs->length = htons(reply->size - start_ofs);
2646 ofs->table_id = fs->table_id;
2648 ofputil_match_to_ofp10_match(&fs->match, &ofs->match);
2649 ofs->duration_sec = htonl(fs->duration_sec);
2650 ofs->duration_nsec = htonl(fs->duration_nsec);
2651 ofs->priority = htons(fs->priority);
2652 ofs->idle_timeout = htons(fs->idle_timeout);
2653 ofs->hard_timeout = htons(fs->hard_timeout);
2654 memset(ofs->pad2, 0, sizeof ofs->pad2);
2655 put_32aligned_be64(&ofs->cookie, fs->cookie);
2656 put_32aligned_be64(&ofs->packet_count,
2657 htonll(unknown_to_zero(fs->packet_count)));
2658 put_32aligned_be64(&ofs->byte_count,
2659 htonll(unknown_to_zero(fs->byte_count)));
2660 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
2661 struct nx_flow_stats *nfs;
2664 ofpbuf_put_uninit(reply, sizeof *nfs);
2665 match_len = nx_put_match(reply, &fs->match, 0, 0);
2666 ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
2668 nfs = ofpbuf_at_assert(reply, start_ofs, sizeof *nfs);
2669 nfs->length = htons(reply->size - start_ofs);
2670 nfs->table_id = fs->table_id;
2672 nfs->duration_sec = htonl(fs->duration_sec);
2673 nfs->duration_nsec = htonl(fs->duration_nsec);
2674 nfs->priority = htons(fs->priority);
2675 nfs->idle_timeout = htons(fs->idle_timeout);
2676 nfs->hard_timeout = htons(fs->hard_timeout);
2677 nfs->idle_age = htons(fs->idle_age < 0 ? 0
2678 : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
2680 nfs->hard_age = htons(fs->hard_age < 0 ? 0
2681 : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
2683 nfs->match_len = htons(match_len);
2684 nfs->cookie = fs->cookie;
2685 nfs->packet_count = htonll(fs->packet_count);
2686 nfs->byte_count = htonll(fs->byte_count);
2691 ofpmp_postappend(replies, start_ofs);
2694 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
2695 * NXST_AGGREGATE reply matching 'request', and returns the message. */
2697 ofputil_encode_aggregate_stats_reply(
2698 const struct ofputil_aggregate_stats *stats,
2699 const struct ofp_header *request)
2701 struct ofp_aggregate_stats_reply *asr;
2702 uint64_t packet_count;
2703 uint64_t byte_count;
2707 ofpraw_decode(&raw, request);
2708 if (raw == OFPRAW_OFPST10_AGGREGATE_REQUEST) {
2709 packet_count = unknown_to_zero(stats->packet_count);
2710 byte_count = unknown_to_zero(stats->byte_count);
2712 packet_count = stats->packet_count;
2713 byte_count = stats->byte_count;
2716 msg = ofpraw_alloc_stats_reply(request, 0);
2717 asr = ofpbuf_put_zeros(msg, sizeof *asr);
2718 put_32aligned_be64(&asr->packet_count, htonll(packet_count));
2719 put_32aligned_be64(&asr->byte_count, htonll(byte_count));
2720 asr->flow_count = htonl(stats->flow_count);
2726 ofputil_decode_aggregate_stats_reply(struct ofputil_aggregate_stats *stats,
2727 const struct ofp_header *reply)
2729 struct ofp_aggregate_stats_reply *asr;
2732 ofpbuf_use_const(&msg, reply, ntohs(reply->length));
2733 ofpraw_pull_assert(&msg);
2736 stats->packet_count = ntohll(get_32aligned_be64(&asr->packet_count));
2737 stats->byte_count = ntohll(get_32aligned_be64(&asr->byte_count));
2738 stats->flow_count = ntohl(asr->flow_count);
2743 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
2744 * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
2745 * an OpenFlow error code. */
2747 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
2748 const struct ofp_header *oh)
2753 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2754 raw = ofpraw_pull_assert(&b);
2755 if (raw == OFPRAW_OFPT11_FLOW_REMOVED) {
2756 const struct ofp12_flow_removed *ofr;
2759 ofr = ofpbuf_pull(&b, sizeof *ofr);
2761 error = ofputil_pull_ofp11_match(&b, &fr->match, NULL);
2766 fr->priority = ntohs(ofr->priority);
2767 fr->cookie = ofr->cookie;
2768 fr->reason = ofr->reason;
2769 fr->table_id = ofr->table_id;
2770 fr->duration_sec = ntohl(ofr->duration_sec);
2771 fr->duration_nsec = ntohl(ofr->duration_nsec);
2772 fr->idle_timeout = ntohs(ofr->idle_timeout);
2773 fr->hard_timeout = ntohs(ofr->hard_timeout);
2774 fr->packet_count = ntohll(ofr->packet_count);
2775 fr->byte_count = ntohll(ofr->byte_count);
2776 } else if (raw == OFPRAW_OFPT10_FLOW_REMOVED) {
2777 const struct ofp10_flow_removed *ofr;
2779 ofr = ofpbuf_pull(&b, sizeof *ofr);
2781 ofputil_match_from_ofp10_match(&ofr->match, &fr->match);
2782 fr->priority = ntohs(ofr->priority);
2783 fr->cookie = ofr->cookie;
2784 fr->reason = ofr->reason;
2786 fr->duration_sec = ntohl(ofr->duration_sec);
2787 fr->duration_nsec = ntohl(ofr->duration_nsec);
2788 fr->idle_timeout = ntohs(ofr->idle_timeout);
2789 fr->hard_timeout = 0;
2790 fr->packet_count = ntohll(ofr->packet_count);
2791 fr->byte_count = ntohll(ofr->byte_count);
2792 } else if (raw == OFPRAW_NXT_FLOW_REMOVED) {
2793 struct nx_flow_removed *nfr;
2796 nfr = ofpbuf_pull(&b, sizeof *nfr);
2797 error = nx_pull_match(&b, ntohs(nfr->match_len), &fr->match,
2803 return OFPERR_OFPBRC_BAD_LEN;
2806 fr->priority = ntohs(nfr->priority);
2807 fr->cookie = nfr->cookie;
2808 fr->reason = nfr->reason;
2809 fr->table_id = nfr->table_id ? nfr->table_id - 1 : 255;
2810 fr->duration_sec = ntohl(nfr->duration_sec);
2811 fr->duration_nsec = ntohl(nfr->duration_nsec);
2812 fr->idle_timeout = ntohs(nfr->idle_timeout);
2813 fr->hard_timeout = 0;
2814 fr->packet_count = ntohll(nfr->packet_count);
2815 fr->byte_count = ntohll(nfr->byte_count);
2823 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
2824 * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
2827 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
2828 enum ofputil_protocol protocol)
2833 case OFPUTIL_P_OF11_STD:
2834 case OFPUTIL_P_OF12_OXM:
2835 case OFPUTIL_P_OF13_OXM: {
2836 struct ofp12_flow_removed *ofr;
2838 msg = ofpraw_alloc_xid(OFPRAW_OFPT11_FLOW_REMOVED,
2839 ofputil_protocol_to_ofp_version(protocol),
2841 ofputil_match_typical_len(protocol));
2842 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
2843 ofr->cookie = fr->cookie;
2844 ofr->priority = htons(fr->priority);
2845 ofr->reason = fr->reason;
2846 ofr->table_id = fr->table_id;
2847 ofr->duration_sec = htonl(fr->duration_sec);
2848 ofr->duration_nsec = htonl(fr->duration_nsec);
2849 ofr->idle_timeout = htons(fr->idle_timeout);
2850 ofr->hard_timeout = htons(fr->hard_timeout);
2851 ofr->packet_count = htonll(fr->packet_count);
2852 ofr->byte_count = htonll(fr->byte_count);
2853 ofputil_put_ofp11_match(msg, &fr->match, protocol);
2857 case OFPUTIL_P_OF10_STD:
2858 case OFPUTIL_P_OF10_STD_TID: {
2859 struct ofp10_flow_removed *ofr;
2861 msg = ofpraw_alloc_xid(OFPRAW_OFPT10_FLOW_REMOVED, OFP10_VERSION,
2863 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
2864 ofputil_match_to_ofp10_match(&fr->match, &ofr->match);
2865 ofr->cookie = fr->cookie;
2866 ofr->priority = htons(fr->priority);
2867 ofr->reason = fr->reason;
2868 ofr->duration_sec = htonl(fr->duration_sec);
2869 ofr->duration_nsec = htonl(fr->duration_nsec);
2870 ofr->idle_timeout = htons(fr->idle_timeout);
2871 ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
2872 ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
2876 case OFPUTIL_P_OF10_NXM:
2877 case OFPUTIL_P_OF10_NXM_TID: {
2878 struct nx_flow_removed *nfr;
2881 msg = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_REMOVED, OFP10_VERSION,
2882 htonl(0), NXM_TYPICAL_LEN);
2883 nfr = ofpbuf_put_zeros(msg, sizeof *nfr);
2884 match_len = nx_put_match(msg, &fr->match, 0, 0);
2887 nfr->cookie = fr->cookie;
2888 nfr->priority = htons(fr->priority);
2889 nfr->reason = fr->reason;
2890 nfr->table_id = fr->table_id + 1;
2891 nfr->duration_sec = htonl(fr->duration_sec);
2892 nfr->duration_nsec = htonl(fr->duration_nsec);
2893 nfr->idle_timeout = htons(fr->idle_timeout);
2894 nfr->match_len = htons(match_len);
2895 nfr->packet_count = htonll(fr->packet_count);
2896 nfr->byte_count = htonll(fr->byte_count);
2908 ofputil_decode_packet_in_finish(struct ofputil_packet_in *pin,
2909 struct match *match, struct ofpbuf *b)
2911 pin->packet = b->data;
2912 pin->packet_len = b->size;
2914 pin->fmd.in_port = match->flow.in_port.ofp_port;
2915 pin->fmd.tun_id = match->flow.tunnel.tun_id;
2916 pin->fmd.tun_src = match->flow.tunnel.ip_src;
2917 pin->fmd.tun_dst = match->flow.tunnel.ip_dst;
2918 pin->fmd.metadata = match->flow.metadata;
2919 memcpy(pin->fmd.regs, match->flow.regs, sizeof pin->fmd.regs);
2923 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
2924 const struct ofp_header *oh)
2929 memset(pin, 0, sizeof *pin);
2931 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2932 raw = ofpraw_pull_assert(&b);
2933 if (raw == OFPRAW_OFPT13_PACKET_IN || raw == OFPRAW_OFPT12_PACKET_IN) {
2934 const struct ofp13_packet_in *opi;
2937 size_t packet_in_size;
2939 if (raw == OFPRAW_OFPT12_PACKET_IN) {
2940 packet_in_size = sizeof (struct ofp12_packet_in);
2942 packet_in_size = sizeof (struct ofp13_packet_in);
2945 opi = ofpbuf_pull(&b, packet_in_size);
2946 error = oxm_pull_match_loose(&b, &match);
2951 if (!ofpbuf_try_pull(&b, 2)) {
2952 return OFPERR_OFPBRC_BAD_LEN;
2955 pin->reason = opi->pi.reason;
2956 pin->table_id = opi->pi.table_id;
2957 pin->buffer_id = ntohl(opi->pi.buffer_id);
2958 pin->total_len = ntohs(opi->pi.total_len);
2960 if (raw == OFPRAW_OFPT13_PACKET_IN) {
2961 pin->cookie = opi->cookie;
2964 ofputil_decode_packet_in_finish(pin, &match, &b);
2965 } else if (raw == OFPRAW_OFPT10_PACKET_IN) {
2966 const struct ofp10_packet_in *opi;
2968 opi = ofpbuf_pull(&b, offsetof(struct ofp10_packet_in, data));
2970 pin->packet = opi->data;
2971 pin->packet_len = b.size;
2973 pin->fmd.in_port = u16_to_ofp(ntohs(opi->in_port));
2974 pin->reason = opi->reason;
2975 pin->buffer_id = ntohl(opi->buffer_id);
2976 pin->total_len = ntohs(opi->total_len);
2977 } else if (raw == OFPRAW_NXT_PACKET_IN) {
2978 const struct nx_packet_in *npi;
2982 npi = ofpbuf_pull(&b, sizeof *npi);
2983 error = nx_pull_match_loose(&b, ntohs(npi->match_len), &match, NULL,
2989 if (!ofpbuf_try_pull(&b, 2)) {
2990 return OFPERR_OFPBRC_BAD_LEN;
2993 pin->reason = npi->reason;
2994 pin->table_id = npi->table_id;
2995 pin->cookie = npi->cookie;
2997 pin->buffer_id = ntohl(npi->buffer_id);
2998 pin->total_len = ntohs(npi->total_len);
3000 ofputil_decode_packet_in_finish(pin, &match, &b);
3009 ofputil_packet_in_to_match(const struct ofputil_packet_in *pin,
3010 struct match *match)
3014 match_init_catchall(match);
3015 if (pin->fmd.tun_id != htonll(0)) {
3016 match_set_tun_id(match, pin->fmd.tun_id);
3018 if (pin->fmd.tun_src != htonl(0)) {
3019 match_set_tun_src(match, pin->fmd.tun_src);
3021 if (pin->fmd.tun_dst != htonl(0)) {
3022 match_set_tun_dst(match, pin->fmd.tun_dst);
3024 if (pin->fmd.metadata != htonll(0)) {
3025 match_set_metadata(match, pin->fmd.metadata);
3028 for (i = 0; i < FLOW_N_REGS; i++) {
3029 if (pin->fmd.regs[i]) {
3030 match_set_reg(match, i, pin->fmd.regs[i]);
3034 match_set_in_port(match, pin->fmd.in_port);
3037 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
3038 * in the format specified by 'packet_in_format'. */
3040 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
3041 enum ofputil_protocol protocol,
3042 enum nx_packet_in_format packet_in_format)
3044 size_t send_len = MIN(pin->send_len, pin->packet_len);
3045 struct ofpbuf *packet;
3047 /* Add OFPT_PACKET_IN. */
3048 if (protocol == OFPUTIL_P_OF13_OXM || protocol == OFPUTIL_P_OF12_OXM) {
3049 struct ofp13_packet_in *opi;
3051 enum ofpraw packet_in_raw;
3052 enum ofp_version packet_in_version;
3053 size_t packet_in_size;
3055 if (protocol == OFPUTIL_P_OF12_OXM) {
3056 packet_in_raw = OFPRAW_OFPT12_PACKET_IN;
3057 packet_in_version = OFP12_VERSION;
3058 packet_in_size = sizeof (struct ofp12_packet_in);
3060 packet_in_raw = OFPRAW_OFPT13_PACKET_IN;
3061 packet_in_version = OFP13_VERSION;
3062 packet_in_size = sizeof (struct ofp13_packet_in);
3065 ofputil_packet_in_to_match(pin, &match);
3067 /* The final argument is just an estimate of the space required. */
3068 packet = ofpraw_alloc_xid(packet_in_raw, packet_in_version,
3069 htonl(0), (sizeof(struct flow_metadata) * 2
3071 ofpbuf_put_zeros(packet, packet_in_size);
3072 oxm_put_match(packet, &match);
3073 ofpbuf_put_zeros(packet, 2);
3074 ofpbuf_put(packet, pin->packet, send_len);
3077 opi->pi.buffer_id = htonl(pin->buffer_id);
3078 opi->pi.total_len = htons(pin->total_len);
3079 opi->pi.reason = pin->reason;
3080 opi->pi.table_id = pin->table_id;
3081 if (protocol == OFPUTIL_P_OF13_OXM) {
3082 opi->cookie = pin->cookie;
3084 } else if (packet_in_format == NXPIF_OPENFLOW10) {
3085 struct ofp10_packet_in *opi;
3087 packet = ofpraw_alloc_xid(OFPRAW_OFPT10_PACKET_IN, OFP10_VERSION,
3088 htonl(0), send_len);
3089 opi = ofpbuf_put_zeros(packet, offsetof(struct ofp10_packet_in, data));
3090 opi->total_len = htons(pin->total_len);
3091 opi->in_port = htons(ofp_to_u16(pin->fmd.in_port));
3092 opi->reason = pin->reason;
3093 opi->buffer_id = htonl(pin->buffer_id);
3095 ofpbuf_put(packet, pin->packet, send_len);
3096 } else if (packet_in_format == NXPIF_NXM) {
3097 struct nx_packet_in *npi;
3101 ofputil_packet_in_to_match(pin, &match);
3103 /* The final argument is just an estimate of the space required. */
3104 packet = ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN, OFP10_VERSION,
3105 htonl(0), (sizeof(struct flow_metadata) * 2
3107 ofpbuf_put_zeros(packet, sizeof *npi);
3108 match_len = nx_put_match(packet, &match, 0, 0);
3109 ofpbuf_put_zeros(packet, 2);
3110 ofpbuf_put(packet, pin->packet, send_len);
3113 npi->buffer_id = htonl(pin->buffer_id);
3114 npi->total_len = htons(pin->total_len);
3115 npi->reason = pin->reason;
3116 npi->table_id = pin->table_id;
3117 npi->cookie = pin->cookie;
3118 npi->match_len = htons(match_len);
3122 ofpmsg_update_length(packet);
3127 /* Returns a string form of 'reason'. The return value is either a statically
3128 * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
3129 * 'bufsize' should be at least OFPUTIL_PACKET_IN_REASON_BUFSIZE. */
3131 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason,
3132 char *reasonbuf, size_t bufsize)
3139 case OFPR_INVALID_TTL:
3140 return "invalid_ttl";
3142 case OFPR_N_REASONS:
3144 snprintf(reasonbuf, bufsize, "%d", (int) reason);
3150 ofputil_packet_in_reason_from_string(const char *s,
3151 enum ofp_packet_in_reason *reason)
3155 for (i = 0; i < OFPR_N_REASONS; i++) {
3156 char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
3157 const char *reason_s;
3159 reason_s = ofputil_packet_in_reason_to_string(i, reasonbuf,
3161 if (!strcasecmp(s, reason_s)) {
3169 /* Converts an OFPT_PACKET_OUT in 'opo' into an abstract ofputil_packet_out in
3172 * Uses 'ofpacts' to store the abstract OFPACT_* version of the packet out
3173 * message's actions. The caller must initialize 'ofpacts' and retains
3174 * ownership of it. 'po->ofpacts' will point into the 'ofpacts' buffer.
3176 * Returns 0 if successful, otherwise an OFPERR_* value. */
3178 ofputil_decode_packet_out(struct ofputil_packet_out *po,
3179 const struct ofp_header *oh,
3180 struct ofpbuf *ofpacts)
3185 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3186 raw = ofpraw_pull_assert(&b);
3188 if (raw == OFPRAW_OFPT11_PACKET_OUT) {
3190 const struct ofp11_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
3192 po->buffer_id = ntohl(opo->buffer_id);
3193 error = ofputil_port_from_ofp11(opo->in_port, &po->in_port);
3198 error = ofpacts_pull_openflow11_actions(&b, ntohs(opo->actions_len),
3203 } else if (raw == OFPRAW_OFPT10_PACKET_OUT) {
3205 const struct ofp10_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
3207 po->buffer_id = ntohl(opo->buffer_id);
3208 po->in_port = u16_to_ofp(ntohs(opo->in_port));
3210 error = ofpacts_pull_openflow10(&b, ntohs(opo->actions_len), ofpacts);
3218 if (ofp_to_u16(po->in_port) >= ofp_to_u16(OFPP_MAX)
3219 && po->in_port != OFPP_LOCAL
3220 && po->in_port != OFPP_NONE && po->in_port != OFPP_CONTROLLER) {
3221 VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
3223 return OFPERR_OFPBRC_BAD_PORT;
3226 po->ofpacts = ofpacts->data;
3227 po->ofpacts_len = ofpacts->size;
3229 if (po->buffer_id == UINT32_MAX) {
3230 po->packet = b.data;
3231 po->packet_len = b.size;
3240 /* ofputil_phy_port */
3242 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
3243 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
3244 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
3245 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
3246 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
3247 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
3248 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
3249 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
3251 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
3252 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
3253 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
3254 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
3255 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
3256 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
3258 static enum netdev_features
3259 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
3261 uint32_t ofp10 = ntohl(ofp10_);
3262 return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
3266 netdev_port_features_to_ofp10(enum netdev_features features)
3268 return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
3271 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
3272 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
3273 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
3274 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
3275 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
3276 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
3277 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
3278 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD == OFPPF11_40GB_FD); /* bit 7 */
3279 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD == OFPPF11_100GB_FD); /* bit 8 */
3280 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD == OFPPF11_1TB_FD); /* bit 9 */
3281 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER == OFPPF11_OTHER); /* bit 10 */
3282 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == OFPPF11_COPPER); /* bit 11 */
3283 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == OFPPF11_FIBER); /* bit 12 */
3284 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == OFPPF11_AUTONEG); /* bit 13 */
3285 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == OFPPF11_PAUSE); /* bit 14 */
3286 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
3288 static enum netdev_features
3289 netdev_port_features_from_ofp11(ovs_be32 ofp11)
3291 return ntohl(ofp11) & 0xffff;
3295 netdev_port_features_to_ofp11(enum netdev_features features)
3297 return htonl(features & 0xffff);
3301 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
3302 const struct ofp10_phy_port *opp)
3304 memset(pp, 0, sizeof *pp);
3306 pp->port_no = u16_to_ofp(ntohs(opp->port_no));
3307 memcpy(pp->hw_addr, opp->hw_addr, OFP_ETH_ALEN);
3308 ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
3310 pp->config = ntohl(opp->config) & OFPPC10_ALL;
3311 pp->state = ntohl(opp->state) & OFPPS10_ALL;
3313 pp->curr = netdev_port_features_from_ofp10(opp->curr);
3314 pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
3315 pp->supported = netdev_port_features_from_ofp10(opp->supported);
3316 pp->peer = netdev_port_features_from_ofp10(opp->peer);
3318 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
3319 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
3325 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
3326 const struct ofp11_port *op)
3330 memset(pp, 0, sizeof *pp);
3332 error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
3336 memcpy(pp->hw_addr, op->hw_addr, OFP_ETH_ALEN);
3337 ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
3339 pp->config = ntohl(op->config) & OFPPC11_ALL;
3340 pp->state = ntohl(op->state) & OFPPC11_ALL;
3342 pp->curr = netdev_port_features_from_ofp11(op->curr);
3343 pp->advertised = netdev_port_features_from_ofp11(op->advertised);
3344 pp->supported = netdev_port_features_from_ofp11(op->supported);
3345 pp->peer = netdev_port_features_from_ofp11(op->peer);
3347 pp->curr_speed = ntohl(op->curr_speed);
3348 pp->max_speed = ntohl(op->max_speed);
3354 ofputil_get_phy_port_size(enum ofp_version ofp_version)
3356 switch (ofp_version) {
3358 return sizeof(struct ofp10_phy_port);
3362 return sizeof(struct ofp11_port);
3369 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
3370 struct ofp10_phy_port *opp)
3372 memset(opp, 0, sizeof *opp);
3374 opp->port_no = htons(ofp_to_u16(pp->port_no));
3375 memcpy(opp->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
3376 ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
3378 opp->config = htonl(pp->config & OFPPC10_ALL);
3379 opp->state = htonl(pp->state & OFPPS10_ALL);
3381 opp->curr = netdev_port_features_to_ofp10(pp->curr);
3382 opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
3383 opp->supported = netdev_port_features_to_ofp10(pp->supported);
3384 opp->peer = netdev_port_features_to_ofp10(pp->peer);
3388 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
3389 struct ofp11_port *op)
3391 memset(op, 0, sizeof *op);
3393 op->port_no = ofputil_port_to_ofp11(pp->port_no);
3394 memcpy(op->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
3395 ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
3397 op->config = htonl(pp->config & OFPPC11_ALL);
3398 op->state = htonl(pp->state & OFPPS11_ALL);
3400 op->curr = netdev_port_features_to_ofp11(pp->curr);
3401 op->advertised = netdev_port_features_to_ofp11(pp->advertised);
3402 op->supported = netdev_port_features_to_ofp11(pp->supported);
3403 op->peer = netdev_port_features_to_ofp11(pp->peer);
3405 op->curr_speed = htonl(pp->curr_speed);
3406 op->max_speed = htonl(pp->max_speed);
3410 ofputil_put_phy_port(enum ofp_version ofp_version,
3411 const struct ofputil_phy_port *pp, struct ofpbuf *b)
3413 switch (ofp_version) {
3414 case OFP10_VERSION: {
3415 struct ofp10_phy_port *opp;
3416 if (b->size + sizeof *opp <= UINT16_MAX) {
3417 opp = ofpbuf_put_uninit(b, sizeof *opp);
3418 ofputil_encode_ofp10_phy_port(pp, opp);
3425 case OFP13_VERSION: {
3426 struct ofp11_port *op;
3427 if (b->size + sizeof *op <= UINT16_MAX) {
3428 op = ofpbuf_put_uninit(b, sizeof *op);
3429 ofputil_encode_ofp11_port(pp, op);
3440 ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
3441 const struct ofputil_phy_port *pp,
3442 struct list *replies)
3444 switch (ofp_version) {
3445 case OFP10_VERSION: {
3446 struct ofp10_phy_port *opp;
3448 opp = ofpmp_append(replies, sizeof *opp);
3449 ofputil_encode_ofp10_phy_port(pp, opp);
3455 case OFP13_VERSION: {
3456 struct ofp11_port *op;
3458 op = ofpmp_append(replies, sizeof *op);
3459 ofputil_encode_ofp11_port(pp, op);
3468 /* ofputil_switch_features */
3470 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
3471 OFPC_IP_REASM | OFPC_QUEUE_STATS)
3472 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
3473 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
3474 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
3475 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
3476 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
3477 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
3479 struct ofputil_action_bit_translation {
3480 enum ofputil_action_bitmap ofputil_bit;
3484 static const struct ofputil_action_bit_translation of10_action_bits[] = {
3485 { OFPUTIL_A_OUTPUT, OFPAT10_OUTPUT },
3486 { OFPUTIL_A_SET_VLAN_VID, OFPAT10_SET_VLAN_VID },
3487 { OFPUTIL_A_SET_VLAN_PCP, OFPAT10_SET_VLAN_PCP },
3488 { OFPUTIL_A_STRIP_VLAN, OFPAT10_STRIP_VLAN },
3489 { OFPUTIL_A_SET_DL_SRC, OFPAT10_SET_DL_SRC },
3490 { OFPUTIL_A_SET_DL_DST, OFPAT10_SET_DL_DST },
3491 { OFPUTIL_A_SET_NW_SRC, OFPAT10_SET_NW_SRC },
3492 { OFPUTIL_A_SET_NW_DST, OFPAT10_SET_NW_DST },
3493 { OFPUTIL_A_SET_NW_TOS, OFPAT10_SET_NW_TOS },
3494 { OFPUTIL_A_SET_TP_SRC, OFPAT10_SET_TP_SRC },
3495 { OFPUTIL_A_SET_TP_DST, OFPAT10_SET_TP_DST },
3496 { OFPUTIL_A_ENQUEUE, OFPAT10_ENQUEUE },
3500 static enum ofputil_action_bitmap
3501 decode_action_bits(ovs_be32 of_actions,
3502 const struct ofputil_action_bit_translation *x)
3504 enum ofputil_action_bitmap ofputil_actions;
3506 ofputil_actions = 0;
3507 for (; x->ofputil_bit; x++) {
3508 if (of_actions & htonl(1u << x->of_bit)) {
3509 ofputil_actions |= x->ofputil_bit;
3512 return ofputil_actions;
3516 ofputil_capabilities_mask(enum ofp_version ofp_version)
3518 /* Handle capabilities whose bit is unique for all Open Flow versions */
3519 switch (ofp_version) {
3522 return OFPC_COMMON | OFPC_ARP_MATCH_IP;
3525 return OFPC_COMMON | OFPC12_PORT_BLOCKED;
3527 /* Caller needs to check osf->header.version itself */
3532 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
3533 * abstract representation in '*features'. Initializes '*b' to iterate over
3534 * the OpenFlow port structures following 'osf' with later calls to
3535 * ofputil_pull_phy_port(). Returns 0 if successful, otherwise an
3536 * OFPERR_* value. */
3538 ofputil_decode_switch_features(const struct ofp_header *oh,
3539 struct ofputil_switch_features *features,
3542 const struct ofp_switch_features *osf;
3545 ofpbuf_use_const(b, oh, ntohs(oh->length));
3546 raw = ofpraw_pull_assert(b);
3548 osf = ofpbuf_pull(b, sizeof *osf);
3549 features->datapath_id = ntohll(osf->datapath_id);
3550 features->n_buffers = ntohl(osf->n_buffers);
3551 features->n_tables = osf->n_tables;
3552 features->auxiliary_id = 0;
3554 features->capabilities = ntohl(osf->capabilities) &
3555 ofputil_capabilities_mask(oh->version);
3557 if (b->size % ofputil_get_phy_port_size(oh->version)) {
3558 return OFPERR_OFPBRC_BAD_LEN;
3561 if (raw == OFPRAW_OFPT10_FEATURES_REPLY) {
3562 if (osf->capabilities & htonl(OFPC10_STP)) {
3563 features->capabilities |= OFPUTIL_C_STP;
3565 features->actions = decode_action_bits(osf->actions, of10_action_bits);
3566 } else if (raw == OFPRAW_OFPT11_FEATURES_REPLY
3567 || raw == OFPRAW_OFPT13_FEATURES_REPLY) {
3568 if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
3569 features->capabilities |= OFPUTIL_C_GROUP_STATS;
3571 features->actions = 0;
3572 if (raw == OFPRAW_OFPT13_FEATURES_REPLY) {
3573 features->auxiliary_id = osf->auxiliary_id;
3576 return OFPERR_OFPBRC_BAD_VERSION;
3582 /* Returns true if the maximum number of ports are in 'oh'. */
3584 max_ports_in_features(const struct ofp_header *oh)
3586 size_t pp_size = ofputil_get_phy_port_size(oh->version);
3587 return ntohs(oh->length) + pp_size > UINT16_MAX;
3590 /* Given a buffer 'b' that contains a Features Reply message, checks if
3591 * it contains the maximum number of ports that will fit. If so, it
3592 * returns true and removes the ports from the message. The caller
3593 * should then send an OFPST_PORT_DESC stats request to get the ports,
3594 * since the switch may have more ports than could be represented in the
3595 * Features Reply. Otherwise, returns false.
3598 ofputil_switch_features_ports_trunc(struct ofpbuf *b)
3600 struct ofp_header *oh = b->data;
3602 if (max_ports_in_features(oh)) {
3603 /* Remove all the ports. */
3604 b->size = (sizeof(struct ofp_header)
3605 + sizeof(struct ofp_switch_features));
3606 ofpmsg_update_length(b);
3615 encode_action_bits(enum ofputil_action_bitmap ofputil_actions,
3616 const struct ofputil_action_bit_translation *x)
3618 uint32_t of_actions;
3621 for (; x->ofputil_bit; x++) {
3622 if (ofputil_actions & x->ofputil_bit) {
3623 of_actions |= 1 << x->of_bit;
3626 return htonl(of_actions);
3629 /* Returns a buffer owned by the caller that encodes 'features' in the format
3630 * required by 'protocol' with the given 'xid'. The caller should append port
3631 * information to the buffer with subsequent calls to
3632 * ofputil_put_switch_features_port(). */
3634 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
3635 enum ofputil_protocol protocol, ovs_be32 xid)
3637 struct ofp_switch_features *osf;
3639 enum ofp_version version;
3642 version = ofputil_protocol_to_ofp_version(protocol);
3645 raw = OFPRAW_OFPT10_FEATURES_REPLY;
3649 raw = OFPRAW_OFPT11_FEATURES_REPLY;
3652 raw = OFPRAW_OFPT13_FEATURES_REPLY;
3657 b = ofpraw_alloc_xid(raw, version, xid, 0);
3658 osf = ofpbuf_put_zeros(b, sizeof *osf);
3659 osf->datapath_id = htonll(features->datapath_id);
3660 osf->n_buffers = htonl(features->n_buffers);
3661 osf->n_tables = features->n_tables;
3663 osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
3664 osf->capabilities = htonl(features->capabilities &
3665 ofputil_capabilities_mask(version));
3668 if (features->capabilities & OFPUTIL_C_STP) {
3669 osf->capabilities |= htonl(OFPC10_STP);
3671 osf->actions = encode_action_bits(features->actions, of10_action_bits);
3674 osf->auxiliary_id = features->auxiliary_id;
3678 if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
3679 osf->capabilities |= htonl(OFPC11_GROUP_STATS);
3689 /* Encodes 'pp' into the format required by the switch_features message already
3690 * in 'b', which should have been returned by ofputil_encode_switch_features(),
3691 * and appends the encoded version to 'b'. */
3693 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
3696 const struct ofp_header *oh = b->data;
3698 if (oh->version < OFP13_VERSION) {
3699 ofputil_put_phy_port(oh->version, pp, b);
3703 /* ofputil_port_status */
3705 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
3706 * in '*ps'. Returns 0 if successful, otherwise an OFPERR_* value. */
3708 ofputil_decode_port_status(const struct ofp_header *oh,
3709 struct ofputil_port_status *ps)
3711 const struct ofp_port_status *ops;
3715 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3716 ofpraw_pull_assert(&b);
3717 ops = ofpbuf_pull(&b, sizeof *ops);
3719 if (ops->reason != OFPPR_ADD &&
3720 ops->reason != OFPPR_DELETE &&
3721 ops->reason != OFPPR_MODIFY) {
3722 return OFPERR_NXBRC_BAD_REASON;
3724 ps->reason = ops->reason;
3726 retval = ofputil_pull_phy_port(oh->version, &b, &ps->desc);
3727 ovs_assert(retval != EOF);
3731 /* Converts the abstract form of a "port status" message in '*ps' into an
3732 * OpenFlow message suitable for 'protocol', and returns that encoded form in
3733 * a buffer owned by the caller. */
3735 ofputil_encode_port_status(const struct ofputil_port_status *ps,
3736 enum ofputil_protocol protocol)
3738 struct ofp_port_status *ops;
3740 enum ofp_version version;
3743 version = ofputil_protocol_to_ofp_version(protocol);
3746 raw = OFPRAW_OFPT10_PORT_STATUS;
3752 raw = OFPRAW_OFPT11_PORT_STATUS;
3759 b = ofpraw_alloc_xid(raw, version, htonl(0), 0);
3760 ops = ofpbuf_put_zeros(b, sizeof *ops);
3761 ops->reason = ps->reason;
3762 ofputil_put_phy_port(version, &ps->desc, b);
3763 ofpmsg_update_length(b);
3767 /* ofputil_port_mod */
3769 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
3770 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
3772 ofputil_decode_port_mod(const struct ofp_header *oh,
3773 struct ofputil_port_mod *pm)
3778 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3779 raw = ofpraw_pull_assert(&b);
3781 if (raw == OFPRAW_OFPT10_PORT_MOD) {
3782 const struct ofp10_port_mod *opm = b.data;
3784 pm->port_no = u16_to_ofp(ntohs(opm->port_no));
3785 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
3786 pm->config = ntohl(opm->config) & OFPPC10_ALL;
3787 pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
3788 pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
3789 } else if (raw == OFPRAW_OFPT11_PORT_MOD) {
3790 const struct ofp11_port_mod *opm = b.data;
3793 error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
3798 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
3799 pm->config = ntohl(opm->config) & OFPPC11_ALL;
3800 pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
3801 pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
3803 return OFPERR_OFPBRC_BAD_TYPE;
3806 pm->config &= pm->mask;
3810 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
3811 * message suitable for 'protocol', and returns that encoded form in a buffer
3812 * owned by the caller. */
3814 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
3815 enum ofputil_protocol protocol)
3817 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
3820 switch (ofp_version) {
3821 case OFP10_VERSION: {
3822 struct ofp10_port_mod *opm;
3824 b = ofpraw_alloc(OFPRAW_OFPT10_PORT_MOD, ofp_version, 0);
3825 opm = ofpbuf_put_zeros(b, sizeof *opm);
3826 opm->port_no = htons(ofp_to_u16(pm->port_no));
3827 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
3828 opm->config = htonl(pm->config & OFPPC10_ALL);
3829 opm->mask = htonl(pm->mask & OFPPC10_ALL);
3830 opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
3836 case OFP13_VERSION: {
3837 struct ofp11_port_mod *opm;
3839 b = ofpraw_alloc(OFPRAW_OFPT11_PORT_MOD, ofp_version, 0);
3840 opm = ofpbuf_put_zeros(b, sizeof *opm);
3841 opm->port_no = ofputil_port_to_ofp11(pm->port_no);
3842 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
3843 opm->config = htonl(pm->config & OFPPC11_ALL);
3844 opm->mask = htonl(pm->mask & OFPPC11_ALL);
3845 opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
3856 /* ofputil_role_request */
3858 /* Decodes the OpenFlow "role request" or "role reply" message in '*oh' into
3859 * an abstract form in '*rr'. Returns 0 if successful, otherwise an
3860 * OFPERR_* value. */
3862 ofputil_decode_role_message(const struct ofp_header *oh,
3863 struct ofputil_role_request *rr)
3868 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3869 raw = ofpraw_pull_assert(&b);
3871 if (raw == OFPRAW_OFPT12_ROLE_REQUEST ||
3872 raw == OFPRAW_OFPT12_ROLE_REPLY) {
3873 const struct ofp12_role_request *orr = b.l3;
3875 if (orr->role != htonl(OFPCR12_ROLE_NOCHANGE) &&
3876 orr->role != htonl(OFPCR12_ROLE_EQUAL) &&
3877 orr->role != htonl(OFPCR12_ROLE_MASTER) &&
3878 orr->role != htonl(OFPCR12_ROLE_SLAVE)) {
3879 return OFPERR_OFPRRFC_BAD_ROLE;
3882 rr->role = ntohl(orr->role);
3883 if (raw == OFPRAW_OFPT12_ROLE_REQUEST
3884 ? orr->role == htonl(OFPCR12_ROLE_NOCHANGE)
3885 : orr->generation_id == htonll(UINT64_MAX)) {
3886 rr->have_generation_id = false;
3887 rr->generation_id = 0;
3889 rr->have_generation_id = true;
3890 rr->generation_id = ntohll(orr->generation_id);
3892 } else if (raw == OFPRAW_NXT_ROLE_REQUEST ||
3893 raw == OFPRAW_NXT_ROLE_REPLY) {
3894 const struct nx_role_request *nrr = b.l3;
3896 BUILD_ASSERT(NX_ROLE_OTHER + 1 == OFPCR12_ROLE_EQUAL);
3897 BUILD_ASSERT(NX_ROLE_MASTER + 1 == OFPCR12_ROLE_MASTER);
3898 BUILD_ASSERT(NX_ROLE_SLAVE + 1 == OFPCR12_ROLE_SLAVE);
3900 if (nrr->role != htonl(NX_ROLE_OTHER) &&
3901 nrr->role != htonl(NX_ROLE_MASTER) &&
3902 nrr->role != htonl(NX_ROLE_SLAVE)) {
3903 return OFPERR_OFPRRFC_BAD_ROLE;
3906 rr->role = ntohl(nrr->role) + 1;
3907 rr->have_generation_id = false;
3908 rr->generation_id = 0;
3916 /* Returns an encoded form of a role reply suitable for the "request" in a
3917 * buffer owned by the caller. */
3919 ofputil_encode_role_reply(const struct ofp_header *request,
3920 const struct ofputil_role_request *rr)
3925 raw = ofpraw_decode_assert(request);
3926 if (raw == OFPRAW_OFPT12_ROLE_REQUEST) {
3927 struct ofp12_role_request *orr;
3929 buf = ofpraw_alloc_reply(OFPRAW_OFPT12_ROLE_REPLY, request, 0);
3930 orr = ofpbuf_put_zeros(buf, sizeof *orr);
3932 orr->role = htonl(rr->role);
3933 orr->generation_id = htonll(rr->have_generation_id
3936 } else if (raw == OFPRAW_NXT_ROLE_REQUEST) {
3937 struct nx_role_request *nrr;
3939 BUILD_ASSERT(NX_ROLE_OTHER == OFPCR12_ROLE_EQUAL - 1);
3940 BUILD_ASSERT(NX_ROLE_MASTER == OFPCR12_ROLE_MASTER - 1);
3941 BUILD_ASSERT(NX_ROLE_SLAVE == OFPCR12_ROLE_SLAVE - 1);
3943 buf = ofpraw_alloc_reply(OFPRAW_NXT_ROLE_REPLY, request, 0);
3944 nrr = ofpbuf_put_zeros(buf, sizeof *nrr);
3945 nrr->role = htonl(rr->role - 1);
3956 ofputil_put_ofp10_table_stats(const struct ofp12_table_stats *in,
3960 enum ofp10_flow_wildcards wc10;
3961 enum oxm12_ofb_match_fields mf12;
3964 static const struct wc_map wc_map[] = {
3965 { OFPFW10_IN_PORT, OFPXMT12_OFB_IN_PORT },
3966 { OFPFW10_DL_VLAN, OFPXMT12_OFB_VLAN_VID },
3967 { OFPFW10_DL_SRC, OFPXMT12_OFB_ETH_SRC },
3968 { OFPFW10_DL_DST, OFPXMT12_OFB_ETH_DST},
3969 { OFPFW10_DL_TYPE, OFPXMT12_OFB_ETH_TYPE },
3970 { OFPFW10_NW_PROTO, OFPXMT12_OFB_IP_PROTO },
3971 { OFPFW10_TP_SRC, OFPXMT12_OFB_TCP_SRC },
3972 { OFPFW10_TP_DST, OFPXMT12_OFB_TCP_DST },
3973 { OFPFW10_NW_SRC_MASK, OFPXMT12_OFB_IPV4_SRC },
3974 { OFPFW10_NW_DST_MASK, OFPXMT12_OFB_IPV4_DST },
3975 { OFPFW10_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP },
3976 { OFPFW10_NW_TOS, OFPXMT12_OFB_IP_DSCP },
3979 struct ofp10_table_stats *out;
3980 const struct wc_map *p;
3982 out = ofpbuf_put_zeros(buf, sizeof *out);
3983 out->table_id = in->table_id;
3984 ovs_strlcpy(out->name, in->name, sizeof out->name);
3986 for (p = wc_map; p < &wc_map[ARRAY_SIZE(wc_map)]; p++) {
3987 if (in->wildcards & htonll(1ULL << p->mf12)) {
3988 out->wildcards |= htonl(p->wc10);
3991 out->max_entries = in->max_entries;
3992 out->active_count = in->active_count;
3993 put_32aligned_be64(&out->lookup_count, in->lookup_count);
3994 put_32aligned_be64(&out->matched_count, in->matched_count);
3998 oxm12_to_ofp11_flow_match_fields(ovs_be64 oxm12)
4001 enum ofp11_flow_match_fields fmf11;
4002 enum oxm12_ofb_match_fields mf12;
4005 static const struct map map[] = {
4006 { OFPFMF11_IN_PORT, OFPXMT12_OFB_IN_PORT },
4007 { OFPFMF11_DL_VLAN, OFPXMT12_OFB_VLAN_VID },
4008 { OFPFMF11_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP },
4009 { OFPFMF11_DL_TYPE, OFPXMT12_OFB_ETH_TYPE },
4010 { OFPFMF11_NW_TOS, OFPXMT12_OFB_IP_DSCP },
4011 { OFPFMF11_NW_PROTO, OFPXMT12_OFB_IP_PROTO },
4012 { OFPFMF11_TP_SRC, OFPXMT12_OFB_TCP_SRC },
4013 { OFPFMF11_TP_DST, OFPXMT12_OFB_TCP_DST },
4014 { OFPFMF11_MPLS_LABEL, OFPXMT12_OFB_MPLS_LABEL },
4015 { OFPFMF11_MPLS_TC, OFPXMT12_OFB_MPLS_TC },
4016 /* I don't know what OFPFMF11_TYPE means. */
4017 { OFPFMF11_DL_SRC, OFPXMT12_OFB_ETH_SRC },
4018 { OFPFMF11_DL_DST, OFPXMT12_OFB_ETH_DST },
4019 { OFPFMF11_NW_SRC, OFPXMT12_OFB_IPV4_SRC },
4020 { OFPFMF11_NW_DST, OFPXMT12_OFB_IPV4_DST },
4021 { OFPFMF11_METADATA, OFPXMT12_OFB_METADATA },
4024 const struct map *p;
4028 for (p = map; p < &map[ARRAY_SIZE(map)]; p++) {
4029 if (oxm12 & htonll(1ULL << p->mf12)) {
4033 return htonl(fmf11);
4037 ofputil_put_ofp11_table_stats(const struct ofp12_table_stats *in,
4040 struct ofp11_table_stats *out;
4042 out = ofpbuf_put_zeros(buf, sizeof *out);
4043 out->table_id = in->table_id;
4044 ovs_strlcpy(out->name, in->name, sizeof out->name);
4045 out->wildcards = oxm12_to_ofp11_flow_match_fields(in->wildcards);
4046 out->match = oxm12_to_ofp11_flow_match_fields(in->match);
4047 out->instructions = in->instructions;
4048 out->write_actions = in->write_actions;
4049 out->apply_actions = in->apply_actions;
4050 out->config = in->config;
4051 out->max_entries = in->max_entries;
4052 out->active_count = in->active_count;
4053 out->lookup_count = in->lookup_count;
4054 out->matched_count = in->matched_count;
4058 ofputil_put_ofp13_table_stats(const struct ofp12_table_stats *in,
4061 struct ofp13_table_stats *out;
4063 /* OF 1.3 splits table features off the ofp_table_stats,
4064 * so there is not much here. */
4066 out = ofpbuf_put_uninit(buf, sizeof *out);
4067 out->table_id = in->table_id;
4068 out->active_count = in->active_count;
4069 out->lookup_count = in->lookup_count;
4070 out->matched_count = in->matched_count;
4074 ofputil_encode_table_stats_reply(const struct ofp12_table_stats stats[], int n,
4075 const struct ofp_header *request)
4077 struct ofpbuf *reply;
4080 reply = ofpraw_alloc_stats_reply(request, n * sizeof *stats);
4082 switch ((enum ofp_version) request->version) {
4084 for (i = 0; i < n; i++) {
4085 ofputil_put_ofp10_table_stats(&stats[i], reply);
4090 for (i = 0; i < n; i++) {
4091 ofputil_put_ofp11_table_stats(&stats[i], reply);
4096 ofpbuf_put(reply, stats, n * sizeof *stats);
4100 for (i = 0; i < n; i++) {
4101 ofputil_put_ofp13_table_stats(&stats[i], reply);
4112 /* ofputil_flow_monitor_request */
4114 /* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract
4115 * ofputil_flow_monitor_request in 'rq'.
4117 * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow
4118 * message. Calling this function multiple times for a single 'msg' iterates
4119 * through the requests. The caller must initially leave 'msg''s layer
4120 * pointers null and not modify them between calls.
4122 * Returns 0 if successful, EOF if no requests were left in this 'msg',
4123 * otherwise an OFPERR_* value. */
4125 ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *rq,
4128 struct nx_flow_monitor_request *nfmr;
4132 msg->l2 = msg->data;
4133 ofpraw_pull_assert(msg);
4140 nfmr = ofpbuf_try_pull(msg, sizeof *nfmr);
4142 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR request has %zu "
4143 "leftover bytes at end", msg->size);
4144 return OFPERR_OFPBRC_BAD_LEN;
4147 flags = ntohs(nfmr->flags);
4148 if (!(flags & (NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY))
4149 || flags & ~(NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE
4150 | NXFMF_MODIFY | NXFMF_ACTIONS | NXFMF_OWN)) {
4151 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR has bad flags %#"PRIx16,
4153 return OFPERR_NXBRC_FM_BAD_FLAGS;
4156 if (!is_all_zeros(nfmr->zeros, sizeof nfmr->zeros)) {
4157 return OFPERR_NXBRC_MUST_BE_ZERO;
4160 rq->id = ntohl(nfmr->id);
4162 rq->out_port = u16_to_ofp(ntohs(nfmr->out_port));
4163 rq->table_id = nfmr->table_id;
4165 return nx_pull_match(msg, ntohs(nfmr->match_len), &rq->match, NULL, NULL);
4169 ofputil_append_flow_monitor_request(
4170 const struct ofputil_flow_monitor_request *rq, struct ofpbuf *msg)
4172 struct nx_flow_monitor_request *nfmr;
4177 ofpraw_put(OFPRAW_NXST_FLOW_MONITOR_REQUEST, OFP10_VERSION, msg);
4180 start_ofs = msg->size;
4181 ofpbuf_put_zeros(msg, sizeof *nfmr);
4182 match_len = nx_put_match(msg, &rq->match, htonll(0), htonll(0));
4184 nfmr = ofpbuf_at_assert(msg, start_ofs, sizeof *nfmr);
4185 nfmr->id = htonl(rq->id);
4186 nfmr->flags = htons(rq->flags);
4187 nfmr->out_port = htons(ofp_to_u16(rq->out_port));
4188 nfmr->match_len = htons(match_len);
4189 nfmr->table_id = rq->table_id;
4192 /* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg'
4193 * into an abstract ofputil_flow_update in 'update'. The caller must have
4194 * initialized update->match to point to space allocated for a match.
4196 * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's
4197 * actions (except for NXFME_ABBREV, which never includes actions). The caller
4198 * must initialize 'ofpacts' and retains ownership of it. 'update->ofpacts'
4199 * will point into the 'ofpacts' buffer.
4201 * Multiple flow updates can be packed into a single OpenFlow message. Calling
4202 * this function multiple times for a single 'msg' iterates through the
4203 * updates. The caller must initially leave 'msg''s layer pointers null and
4204 * not modify them between calls.
4206 * Returns 0 if successful, EOF if no updates were left in this 'msg',
4207 * otherwise an OFPERR_* value. */
4209 ofputil_decode_flow_update(struct ofputil_flow_update *update,
4210 struct ofpbuf *msg, struct ofpbuf *ofpacts)
4212 struct nx_flow_update_header *nfuh;
4213 unsigned int length;
4216 msg->l2 = msg->data;
4217 ofpraw_pull_assert(msg);
4224 if (msg->size < sizeof(struct nx_flow_update_header)) {
4229 update->event = ntohs(nfuh->event);
4230 length = ntohs(nfuh->length);
4231 if (length > msg->size || length % 8) {
4235 if (update->event == NXFME_ABBREV) {
4236 struct nx_flow_update_abbrev *nfua;
4238 if (length != sizeof *nfua) {
4242 nfua = ofpbuf_pull(msg, sizeof *nfua);
4243 update->xid = nfua->xid;
4245 } else if (update->event == NXFME_ADDED
4246 || update->event == NXFME_DELETED
4247 || update->event == NXFME_MODIFIED) {
4248 struct nx_flow_update_full *nfuf;
4249 unsigned int actions_len;
4250 unsigned int match_len;
4253 if (length < sizeof *nfuf) {
4257 nfuf = ofpbuf_pull(msg, sizeof *nfuf);
4258 match_len = ntohs(nfuf->match_len);
4259 if (sizeof *nfuf + match_len > length) {
4263 update->reason = ntohs(nfuf->reason);
4264 update->idle_timeout = ntohs(nfuf->idle_timeout);
4265 update->hard_timeout = ntohs(nfuf->hard_timeout);
4266 update->table_id = nfuf->table_id;
4267 update->cookie = nfuf->cookie;
4268 update->priority = ntohs(nfuf->priority);
4270 error = nx_pull_match(msg, match_len, update->match, NULL, NULL);
4275 actions_len = length - sizeof *nfuf - ROUND_UP(match_len, 8);
4276 error = ofpacts_pull_openflow10(msg, actions_len, ofpacts);
4281 update->ofpacts = ofpacts->data;
4282 update->ofpacts_len = ofpacts->size;
4285 VLOG_WARN_RL(&bad_ofmsg_rl,
4286 "NXST_FLOW_MONITOR reply has bad event %"PRIu16,
4287 ntohs(nfuh->event));
4288 return OFPERR_NXBRC_FM_BAD_EVENT;
4292 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR reply has %zu "
4293 "leftover bytes at end", msg->size);
4294 return OFPERR_OFPBRC_BAD_LEN;
4298 ofputil_decode_flow_monitor_cancel(const struct ofp_header *oh)
4300 const struct nx_flow_monitor_cancel *cancel = ofpmsg_body(oh);
4302 return ntohl(cancel->id);
4306 ofputil_encode_flow_monitor_cancel(uint32_t id)
4308 struct nx_flow_monitor_cancel *nfmc;
4311 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MONITOR_CANCEL, OFP10_VERSION, 0);
4312 nfmc = ofpbuf_put_uninit(msg, sizeof *nfmc);
4313 nfmc->id = htonl(id);
4318 ofputil_start_flow_update(struct list *replies)
4322 msg = ofpraw_alloc_xid(OFPRAW_NXST_FLOW_MONITOR_REPLY, OFP10_VERSION,
4326 list_push_back(replies, &msg->list_node);
4330 ofputil_append_flow_update(const struct ofputil_flow_update *update,
4331 struct list *replies)
4333 struct nx_flow_update_header *nfuh;
4337 msg = ofpbuf_from_list(list_back(replies));
4338 start_ofs = msg->size;
4340 if (update->event == NXFME_ABBREV) {
4341 struct nx_flow_update_abbrev *nfua;
4343 nfua = ofpbuf_put_zeros(msg, sizeof *nfua);
4344 nfua->xid = update->xid;
4346 struct nx_flow_update_full *nfuf;
4349 ofpbuf_put_zeros(msg, sizeof *nfuf);
4350 match_len = nx_put_match(msg, update->match, htonll(0), htonll(0));
4351 ofpacts_put_openflow10(update->ofpacts, update->ofpacts_len, msg);
4353 nfuf = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuf);
4354 nfuf->reason = htons(update->reason);
4355 nfuf->priority = htons(update->priority);
4356 nfuf->idle_timeout = htons(update->idle_timeout);
4357 nfuf->hard_timeout = htons(update->hard_timeout);
4358 nfuf->match_len = htons(match_len);
4359 nfuf->table_id = update->table_id;
4360 nfuf->cookie = update->cookie;
4363 nfuh = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuh);
4364 nfuh->length = htons(msg->size - start_ofs);
4365 nfuh->event = htons(update->event);
4367 ofpmp_postappend(replies, start_ofs);
4371 ofputil_encode_packet_out(const struct ofputil_packet_out *po,
4372 enum ofputil_protocol protocol)
4374 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
4378 size = po->ofpacts_len;
4379 if (po->buffer_id == UINT32_MAX) {
4380 size += po->packet_len;
4383 switch (ofp_version) {
4384 case OFP10_VERSION: {
4385 struct ofp10_packet_out *opo;
4388 msg = ofpraw_alloc(OFPRAW_OFPT10_PACKET_OUT, OFP10_VERSION, size);
4389 ofpbuf_put_zeros(msg, sizeof *opo);
4390 actions_ofs = msg->size;
4391 ofpacts_put_openflow10(po->ofpacts, po->ofpacts_len, msg);
4394 opo->buffer_id = htonl(po->buffer_id);
4395 opo->in_port = htons(ofp_to_u16(po->in_port));
4396 opo->actions_len = htons(msg->size - actions_ofs);
4402 case OFP13_VERSION: {
4403 struct ofp11_packet_out *opo;
4406 msg = ofpraw_alloc(OFPRAW_OFPT11_PACKET_OUT, ofp_version, size);
4407 ofpbuf_put_zeros(msg, sizeof *opo);
4408 len = ofpacts_put_openflow11_actions(po->ofpacts, po->ofpacts_len, msg);
4411 opo->buffer_id = htonl(po->buffer_id);
4412 opo->in_port = ofputil_port_to_ofp11(po->in_port);
4413 opo->actions_len = htons(len);
4421 if (po->buffer_id == UINT32_MAX) {
4422 ofpbuf_put(msg, po->packet, po->packet_len);
4425 ofpmsg_update_length(msg);
4430 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
4432 make_echo_request(enum ofp_version ofp_version)
4434 return ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST, ofp_version,
4438 /* Creates and returns an OFPT_ECHO_REPLY message matching the
4439 * OFPT_ECHO_REQUEST message in 'rq'. */
4441 make_echo_reply(const struct ofp_header *rq)
4443 struct ofpbuf rq_buf;
4444 struct ofpbuf *reply;
4446 ofpbuf_use_const(&rq_buf, rq, ntohs(rq->length));
4447 ofpraw_pull_assert(&rq_buf);
4449 reply = ofpraw_alloc_reply(OFPRAW_OFPT_ECHO_REPLY, rq, rq_buf.size);
4450 ofpbuf_put(reply, rq_buf.data, rq_buf.size);
4455 ofputil_encode_barrier_request(enum ofp_version ofp_version)
4459 switch (ofp_version) {
4463 type = OFPRAW_OFPT11_BARRIER_REQUEST;
4467 type = OFPRAW_OFPT10_BARRIER_REQUEST;
4474 return ofpraw_alloc(type, ofp_version, 0);
4478 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
4480 switch (flags & OFPC_FRAG_MASK) {
4481 case OFPC_FRAG_NORMAL: return "normal";
4482 case OFPC_FRAG_DROP: return "drop";
4483 case OFPC_FRAG_REASM: return "reassemble";
4484 case OFPC_FRAG_NX_MATCH: return "nx-match";
4491 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
4493 if (!strcasecmp(s, "normal")) {
4494 *flags = OFPC_FRAG_NORMAL;
4495 } else if (!strcasecmp(s, "drop")) {
4496 *flags = OFPC_FRAG_DROP;
4497 } else if (!strcasecmp(s, "reassemble")) {
4498 *flags = OFPC_FRAG_REASM;
4499 } else if (!strcasecmp(s, "nx-match")) {
4500 *flags = OFPC_FRAG_NX_MATCH;
4507 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
4508 * port number and stores the latter in '*ofp10_port', for the purpose of
4509 * decoding OpenFlow 1.1+ protocol messages. Returns 0 if successful,
4510 * otherwise an OFPERR_* number. On error, stores OFPP_NONE in '*ofp10_port'.
4512 * See the definition of OFP11_MAX for an explanation of the mapping. */
4514 ofputil_port_from_ofp11(ovs_be32 ofp11_port, ofp_port_t *ofp10_port)
4516 uint32_t ofp11_port_h = ntohl(ofp11_port);
4518 if (ofp11_port_h < ofp_to_u16(OFPP_MAX)) {
4519 *ofp10_port = u16_to_ofp(ofp11_port_h);
4521 } else if (ofp11_port_h >= ofp11_to_u32(OFPP11_MAX)) {
4522 *ofp10_port = u16_to_ofp(ofp11_port_h - OFPP11_OFFSET);
4525 *ofp10_port = OFPP_NONE;
4526 VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
4527 "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
4528 ofp11_port_h, ofp_to_u16(OFPP_MAX) - 1,
4529 ofp11_to_u32(OFPP11_MAX), UINT32_MAX);
4530 return OFPERR_OFPBAC_BAD_OUT_PORT;
4534 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
4535 * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
4537 * See the definition of OFP11_MAX for an explanation of the mapping. */
4539 ofputil_port_to_ofp11(ofp_port_t ofp10_port)
4541 return htonl(ofp_to_u16(ofp10_port) < ofp_to_u16(OFPP_MAX)
4542 ? ofp_to_u16(ofp10_port)
4543 : ofp_to_u16(ofp10_port) + OFPP11_OFFSET);
4546 /* Checks that 'port' is a valid output port for the OFPAT10_OUTPUT action, given
4547 * that the switch will never have more than 'max_ports' ports. Returns 0 if
4548 * 'port' is valid, otherwise an OpenFlow return code. */
4550 ofputil_check_output_port(ofp_port_t port, ofp_port_t max_ports)
4558 case OFPP_CONTROLLER:
4564 if (ofp_to_u16(port) < ofp_to_u16(max_ports)) {
4567 return OFPERR_OFPBAC_BAD_OUT_PORT;
4571 #define OFPUTIL_NAMED_PORTS \
4572 OFPUTIL_NAMED_PORT(IN_PORT) \
4573 OFPUTIL_NAMED_PORT(TABLE) \
4574 OFPUTIL_NAMED_PORT(NORMAL) \
4575 OFPUTIL_NAMED_PORT(FLOOD) \
4576 OFPUTIL_NAMED_PORT(ALL) \
4577 OFPUTIL_NAMED_PORT(CONTROLLER) \
4578 OFPUTIL_NAMED_PORT(LOCAL) \
4579 OFPUTIL_NAMED_PORT(ANY)
4581 /* For backwards compatibility, so that "none" is recognized as OFPP_ANY */
4582 #define OFPUTIL_NAMED_PORTS_WITH_NONE \
4583 OFPUTIL_NAMED_PORTS \
4584 OFPUTIL_NAMED_PORT(NONE)
4586 /* Stores the port number represented by 's' into '*portp'. 's' may be an
4587 * integer or, for reserved ports, the standard OpenFlow name for the port
4590 * Returns true if successful, false if 's' is not a valid OpenFlow port number
4591 * or name. The caller should issue an error message in this case, because
4592 * this function usually does not. (This gives the caller an opportunity to
4593 * look up the port name another way, e.g. by contacting the switch and listing
4594 * the names of all its ports).
4596 * This function accepts OpenFlow 1.0 port numbers. It also accepts a subset
4597 * of OpenFlow 1.1+ port numbers, mapping those port numbers into the 16-bit
4598 * range as described in include/openflow/openflow-1.1.h. */
4600 ofputil_port_from_string(const char *s, ofp_port_t *portp)
4605 if (str_to_uint(s, 10, &port32)) {
4606 if (port32 < ofp_to_u16(OFPP_MAX)) {
4608 } else if (port32 < ofp_to_u16(OFPP_FIRST_RESV)) {
4609 VLOG_WARN("port %u is a reserved OF1.0 port number that will "
4610 "be translated to %u when talking to an OF1.1 or "
4611 "later controller", port32, port32 + OFPP11_OFFSET);
4612 } else if (port32 <= ofp_to_u16(OFPP_LAST_RESV)) {
4613 char name[OFP_MAX_PORT_NAME_LEN];
4615 ofputil_port_to_string(u16_to_ofp(port32), name, sizeof name);
4616 VLOG_WARN_ONCE("referring to port %s as %"PRIu32" is deprecated "
4617 "for compatibility with OpenFlow 1.1 and later",
4619 } else if (port32 < ofp11_to_u32(OFPP11_MAX)) {
4620 VLOG_WARN("port %u is outside the supported range 0 through "
4621 "%"PRIx16" or 0x%x through 0x%"PRIx32, port32,
4622 UINT16_MAX, ofp11_to_u32(OFPP11_MAX), UINT32_MAX);
4625 port32 -= OFPP11_OFFSET;
4628 *portp = u16_to_ofp(port32);
4635 static const struct pair pairs[] = {
4636 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
4637 OFPUTIL_NAMED_PORTS_WITH_NONE
4638 #undef OFPUTIL_NAMED_PORT
4640 const struct pair *p;
4642 for (p = pairs; p < &pairs[ARRAY_SIZE(pairs)]; p++) {
4643 if (!strcasecmp(s, p->name)) {
4652 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
4653 * Most ports' string representation is just the port number, but for special
4654 * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
4656 ofputil_format_port(ofp_port_t port, struct ds *s)
4658 char name[OFP_MAX_PORT_NAME_LEN];
4660 ofputil_port_to_string(port, name, sizeof name);
4661 ds_put_cstr(s, name);
4664 /* Puts in the 'bufsize' byte in 'namebuf' a null-terminated string
4665 * representation of OpenFlow port number 'port'. Most ports are represented
4666 * as just the port number, but special ports, e.g. OFPP_LOCAL, are represented
4667 * by name, e.g. "LOCAL". */
4669 ofputil_port_to_string(ofp_port_t port,
4670 char namebuf[OFP_MAX_PORT_NAME_LEN], size_t bufsize)
4673 #define OFPUTIL_NAMED_PORT(NAME) \
4675 ovs_strlcpy(namebuf, #NAME, bufsize); \
4678 #undef OFPUTIL_NAMED_PORT
4681 snprintf(namebuf, bufsize, "%"PRIu16, port);
4686 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
4687 * 'ofp_version', tries to pull the first element from the array. If
4688 * successful, initializes '*pp' with an abstract representation of the
4689 * port and returns 0. If no ports remain to be decoded, returns EOF.
4690 * On an error, returns a positive OFPERR_* value. */
4692 ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *b,
4693 struct ofputil_phy_port *pp)
4695 switch (ofp_version) {
4696 case OFP10_VERSION: {
4697 const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
4698 return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
4702 case OFP13_VERSION: {
4703 const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
4704 return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
4711 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
4712 * 'ofp_version', returns the number of elements. */
4713 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *b)
4715 return b->size / ofputil_get_phy_port_size(ofp_version);
4718 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
4719 * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1 if
4720 * 'name' is not the name of any action.
4722 * ofp-util.def lists the mapping from names to action. */
4724 ofputil_action_code_from_name(const char *name)
4726 static const char *const names[OFPUTIL_N_ACTIONS] = {
4728 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) NAME,
4729 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
4730 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
4731 #include "ofp-util.def"
4734 const char *const *p;
4736 for (p = names; p < &names[ARRAY_SIZE(names)]; p++) {
4737 if (*p && !strcasecmp(name, *p)) {
4744 /* Appends an action of the type specified by 'code' to 'buf' and returns the
4745 * action. Initializes the parts of 'action' that identify it as having type
4746 * <ENUM> and length 'sizeof *action' and zeros the rest. For actions that
4747 * have variable length, the length used and cleared is that of struct
4750 ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
4753 case OFPUTIL_ACTION_INVALID:
4756 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
4757 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
4758 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
4759 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
4760 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
4761 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
4762 #include "ofp-util.def"
4767 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
4769 ofputil_init_##ENUM(struct STRUCT *s) \
4771 memset(s, 0, sizeof *s); \
4772 s->type = htons(ENUM); \
4773 s->len = htons(sizeof *s); \
4777 ofputil_put_##ENUM(struct ofpbuf *buf) \
4779 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
4780 ofputil_init_##ENUM(s); \
4783 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
4784 OFPAT10_ACTION(ENUM, STRUCT, NAME)
4785 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
4787 ofputil_init_##ENUM(struct STRUCT *s) \
4789 memset(s, 0, sizeof *s); \
4790 s->type = htons(OFPAT10_VENDOR); \
4791 s->len = htons(sizeof *s); \
4792 s->vendor = htonl(NX_VENDOR_ID); \
4793 s->subtype = htons(ENUM); \
4797 ofputil_put_##ENUM(struct ofpbuf *buf) \
4799 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
4800 ofputil_init_##ENUM(s); \
4803 #include "ofp-util.def"
4806 ofputil_normalize_match__(struct match *match, bool may_log)
4809 MAY_NW_ADDR = 1 << 0, /* nw_src, nw_dst */
4810 MAY_TP_ADDR = 1 << 1, /* tp_src, tp_dst */
4811 MAY_NW_PROTO = 1 << 2, /* nw_proto */
4812 MAY_IPVx = 1 << 3, /* tos, frag, ttl */
4813 MAY_ARP_SHA = 1 << 4, /* arp_sha */
4814 MAY_ARP_THA = 1 << 5, /* arp_tha */
4815 MAY_IPV6 = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
4816 MAY_ND_TARGET = 1 << 7, /* nd_target */
4817 MAY_MPLS = 1 << 8, /* mpls label and tc */
4820 struct flow_wildcards wc;
4822 /* Figure out what fields may be matched. */
4823 if (match->flow.dl_type == htons(ETH_TYPE_IP)) {
4824 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
4825 if (match->flow.nw_proto == IPPROTO_TCP ||
4826 match->flow.nw_proto == IPPROTO_UDP ||
4827 match->flow.nw_proto == IPPROTO_ICMP) {
4828 may_match |= MAY_TP_ADDR;
4830 } else if (match->flow.dl_type == htons(ETH_TYPE_IPV6)) {
4831 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
4832 if (match->flow.nw_proto == IPPROTO_TCP ||
4833 match->flow.nw_proto == IPPROTO_UDP) {
4834 may_match |= MAY_TP_ADDR;
4835 } else if (match->flow.nw_proto == IPPROTO_ICMPV6) {
4836 may_match |= MAY_TP_ADDR;
4837 if (match->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
4838 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
4839 } else if (match->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
4840 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
4843 } else if (match->flow.dl_type == htons(ETH_TYPE_ARP) ||
4844 match->flow.dl_type == htons(ETH_TYPE_RARP)) {
4845 may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
4846 } else if (eth_type_mpls(match->flow.dl_type)) {
4847 may_match = MAY_MPLS;
4852 /* Clear the fields that may not be matched. */
4854 if (!(may_match & MAY_NW_ADDR)) {
4855 wc.masks.nw_src = wc.masks.nw_dst = htonl(0);
4857 if (!(may_match & MAY_TP_ADDR)) {
4858 wc.masks.tp_src = wc.masks.tp_dst = htons(0);
4860 if (!(may_match & MAY_NW_PROTO)) {
4861 wc.masks.nw_proto = 0;
4863 if (!(may_match & MAY_IPVx)) {
4864 wc.masks.nw_tos = 0;
4865 wc.masks.nw_ttl = 0;
4867 if (!(may_match & MAY_ARP_SHA)) {
4868 memset(wc.masks.arp_sha, 0, ETH_ADDR_LEN);
4870 if (!(may_match & MAY_ARP_THA)) {
4871 memset(wc.masks.arp_tha, 0, ETH_ADDR_LEN);
4873 if (!(may_match & MAY_IPV6)) {
4874 wc.masks.ipv6_src = wc.masks.ipv6_dst = in6addr_any;
4875 wc.masks.ipv6_label = htonl(0);
4877 if (!(may_match & MAY_ND_TARGET)) {
4878 wc.masks.nd_target = in6addr_any;
4880 if (!(may_match & MAY_MPLS)) {
4881 wc.masks.mpls_lse = htonl(0);
4882 wc.masks.mpls_depth = 0;
4885 /* Log any changes. */
4886 if (!flow_wildcards_equal(&wc, &match->wc)) {
4887 bool log = may_log && !VLOG_DROP_INFO(&bad_ofmsg_rl);
4888 char *pre = log ? match_to_string(match, OFP_DEFAULT_PRIORITY) : NULL;
4891 match_zero_wildcarded_fields(match);
4894 char *post = match_to_string(match, OFP_DEFAULT_PRIORITY);
4895 VLOG_INFO("normalization changed ofp_match, details:");
4896 VLOG_INFO(" pre: %s", pre);
4897 VLOG_INFO("post: %s", post);
4904 /* "Normalizes" the wildcards in 'match'. That means:
4906 * 1. If the type of level N is known, then only the valid fields for that
4907 * level may be specified. For example, ARP does not have a TOS field,
4908 * so nw_tos must be wildcarded if 'match' specifies an ARP flow.
4909 * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
4910 * ipv6_dst (and other fields) must be wildcarded if 'match' specifies an
4913 * 2. If the type of level N is not known (or not understood by Open
4914 * vSwitch), then no fields at all for that level may be specified. For
4915 * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
4916 * L4 fields tp_src and tp_dst must be wildcarded if 'match' specifies an
4919 * If this function changes 'match', it logs a rate-limited informational
4922 ofputil_normalize_match(struct match *match)
4924 ofputil_normalize_match__(match, true);
4927 /* Same as ofputil_normalize_match() without the logging. Thus, this function
4928 * is suitable for a program's internal use, whereas ofputil_normalize_match()
4929 * sense for use on flows received from elsewhere (so that a bug in the program
4930 * that sent them can be reported and corrected). */
4932 ofputil_normalize_match_quiet(struct match *match)
4934 ofputil_normalize_match__(match, false);
4937 /* Parses a key or a key-value pair from '*stringp'.
4939 * On success: Stores the key into '*keyp'. Stores the value, if present, into
4940 * '*valuep', otherwise an empty string. Advances '*stringp' past the end of
4941 * the key-value pair, preparing it for another call. '*keyp' and '*valuep'
4942 * are substrings of '*stringp' created by replacing some of its bytes by null
4943 * terminators. Returns true.
4945 * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
4946 * NULL and returns false. */
4948 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
4950 char *pos, *key, *value;
4954 pos += strspn(pos, ", \t\r\n");
4956 *keyp = *valuep = NULL;
4961 key_len = strcspn(pos, ":=(, \t\r\n");
4962 if (key[key_len] == ':' || key[key_len] == '=') {
4963 /* The value can be separated by a colon. */
4966 value = key + key_len + 1;
4967 value_len = strcspn(value, ", \t\r\n");
4968 pos = value + value_len + (value[value_len] != '\0');
4969 value[value_len] = '\0';
4970 } else if (key[key_len] == '(') {
4971 /* The value can be surrounded by balanced parentheses. The outermost
4972 * set of parentheses is removed. */
4976 value = key + key_len + 1;
4977 for (value_len = 0; level > 0; value_len++) {
4978 switch (value[value_len]) {
4992 value[value_len - 1] = '\0';
4993 pos = value + value_len;
4995 /* There might be no value at all. */
4996 value = key + key_len; /* Will become the empty string below. */
4997 pos = key + key_len + (key[key_len] != '\0');
4999 key[key_len] = '\0';
5007 /* Encode a dump ports request for 'port', the encoded message
5008 * will be for Open Flow version 'ofp_version'. Returns message
5009 * as a struct ofpbuf. Returns encoded message on success, NULL on error */
5011 ofputil_encode_dump_ports_request(enum ofp_version ofp_version, ofp_port_t port)
5013 struct ofpbuf *request;
5015 switch (ofp_version) {
5016 case OFP10_VERSION: {
5017 struct ofp10_port_stats_request *req;
5018 request = ofpraw_alloc(OFPRAW_OFPST10_PORT_REQUEST, ofp_version, 0);
5019 req = ofpbuf_put_zeros(request, sizeof *req);
5020 req->port_no = htons(ofp_to_u16(port));
5025 case OFP13_VERSION: {
5026 struct ofp11_port_stats_request *req;
5027 request = ofpraw_alloc(OFPRAW_OFPST11_PORT_REQUEST, ofp_version, 0);
5028 req = ofpbuf_put_zeros(request, sizeof *req);
5029 req->port_no = ofputil_port_to_ofp11(port);
5040 ofputil_port_stats_to_ofp10(const struct ofputil_port_stats *ops,
5041 struct ofp10_port_stats *ps10)
5043 ps10->port_no = htons(ofp_to_u16(ops->port_no));
5044 memset(ps10->pad, 0, sizeof ps10->pad);
5045 put_32aligned_be64(&ps10->rx_packets, htonll(ops->stats.rx_packets));
5046 put_32aligned_be64(&ps10->tx_packets, htonll(ops->stats.tx_packets));
5047 put_32aligned_be64(&ps10->rx_bytes, htonll(ops->stats.rx_bytes));
5048 put_32aligned_be64(&ps10->tx_bytes, htonll(ops->stats.tx_bytes));
5049 put_32aligned_be64(&ps10->rx_dropped, htonll(ops->stats.rx_dropped));
5050 put_32aligned_be64(&ps10->tx_dropped, htonll(ops->stats.tx_dropped));
5051 put_32aligned_be64(&ps10->rx_errors, htonll(ops->stats.rx_errors));
5052 put_32aligned_be64(&ps10->tx_errors, htonll(ops->stats.tx_errors));
5053 put_32aligned_be64(&ps10->rx_frame_err, htonll(ops->stats.rx_frame_errors));
5054 put_32aligned_be64(&ps10->rx_over_err, htonll(ops->stats.rx_over_errors));
5055 put_32aligned_be64(&ps10->rx_crc_err, htonll(ops->stats.rx_crc_errors));
5056 put_32aligned_be64(&ps10->collisions, htonll(ops->stats.collisions));
5060 ofputil_port_stats_to_ofp11(const struct ofputil_port_stats *ops,
5061 struct ofp11_port_stats *ps11)
5063 ps11->port_no = ofputil_port_to_ofp11(ops->port_no);
5064 memset(ps11->pad, 0, sizeof ps11->pad);
5065 ps11->rx_packets = htonll(ops->stats.rx_packets);
5066 ps11->tx_packets = htonll(ops->stats.tx_packets);
5067 ps11->rx_bytes = htonll(ops->stats.rx_bytes);
5068 ps11->tx_bytes = htonll(ops->stats.tx_bytes);
5069 ps11->rx_dropped = htonll(ops->stats.rx_dropped);
5070 ps11->tx_dropped = htonll(ops->stats.tx_dropped);
5071 ps11->rx_errors = htonll(ops->stats.rx_errors);
5072 ps11->tx_errors = htonll(ops->stats.tx_errors);
5073 ps11->rx_frame_err = htonll(ops->stats.rx_frame_errors);
5074 ps11->rx_over_err = htonll(ops->stats.rx_over_errors);
5075 ps11->rx_crc_err = htonll(ops->stats.rx_crc_errors);
5076 ps11->collisions = htonll(ops->stats.collisions);
5080 ofputil_port_stats_to_ofp13(const struct ofputil_port_stats *ops,
5081 struct ofp13_port_stats *ps13)
5083 ofputil_port_stats_to_ofp11(ops, &ps13->ps);
5084 ps13->duration_sec = htonl(ops->duration_sec);
5085 ps13->duration_nsec = htonl(ops->duration_nsec);
5089 /* Encode a ports stat for 'ops' and append it to 'replies'. */
5091 ofputil_append_port_stat(struct list *replies,
5092 const struct ofputil_port_stats *ops)
5094 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
5095 struct ofp_header *oh = msg->data;
5097 switch ((enum ofp_version)oh->version) {
5098 case OFP13_VERSION: {
5099 struct ofp13_port_stats *reply = ofpmp_append(replies, sizeof *reply);
5100 ofputil_port_stats_to_ofp13(ops, reply);
5104 case OFP11_VERSION: {
5105 struct ofp11_port_stats *reply = ofpmp_append(replies, sizeof *reply);
5106 ofputil_port_stats_to_ofp11(ops, reply);
5110 case OFP10_VERSION: {
5111 struct ofp10_port_stats *reply = ofpmp_append(replies, sizeof *reply);
5112 ofputil_port_stats_to_ofp10(ops, reply);
5122 ofputil_port_stats_from_ofp10(struct ofputil_port_stats *ops,
5123 const struct ofp10_port_stats *ps10)
5125 memset(ops, 0, sizeof *ops);
5127 ops->port_no = u16_to_ofp(ntohs(ps10->port_no));
5128 ops->stats.rx_packets = ntohll(get_32aligned_be64(&ps10->rx_packets));
5129 ops->stats.tx_packets = ntohll(get_32aligned_be64(&ps10->tx_packets));
5130 ops->stats.rx_bytes = ntohll(get_32aligned_be64(&ps10->rx_bytes));
5131 ops->stats.tx_bytes = ntohll(get_32aligned_be64(&ps10->tx_bytes));
5132 ops->stats.rx_dropped = ntohll(get_32aligned_be64(&ps10->rx_dropped));
5133 ops->stats.tx_dropped = ntohll(get_32aligned_be64(&ps10->tx_dropped));
5134 ops->stats.rx_errors = ntohll(get_32aligned_be64(&ps10->rx_errors));
5135 ops->stats.tx_errors = ntohll(get_32aligned_be64(&ps10->tx_errors));
5136 ops->stats.rx_frame_errors =
5137 ntohll(get_32aligned_be64(&ps10->rx_frame_err));
5138 ops->stats.rx_over_errors = ntohll(get_32aligned_be64(&ps10->rx_over_err));
5139 ops->stats.rx_crc_errors = ntohll(get_32aligned_be64(&ps10->rx_crc_err));
5140 ops->stats.collisions = ntohll(get_32aligned_be64(&ps10->collisions));
5141 ops->duration_sec = ops->duration_nsec = UINT32_MAX;
5147 ofputil_port_stats_from_ofp11(struct ofputil_port_stats *ops,
5148 const struct ofp11_port_stats *ps11)
5152 memset(ops, 0, sizeof *ops);
5153 error = ofputil_port_from_ofp11(ps11->port_no, &ops->port_no);
5158 ops->stats.rx_packets = ntohll(ps11->rx_packets);
5159 ops->stats.tx_packets = ntohll(ps11->tx_packets);
5160 ops->stats.rx_bytes = ntohll(ps11->rx_bytes);
5161 ops->stats.tx_bytes = ntohll(ps11->tx_bytes);
5162 ops->stats.rx_dropped = ntohll(ps11->rx_dropped);
5163 ops->stats.tx_dropped = ntohll(ps11->tx_dropped);
5164 ops->stats.rx_errors = ntohll(ps11->rx_errors);
5165 ops->stats.tx_errors = ntohll(ps11->tx_errors);
5166 ops->stats.rx_frame_errors = ntohll(ps11->rx_frame_err);
5167 ops->stats.rx_over_errors = ntohll(ps11->rx_over_err);
5168 ops->stats.rx_crc_errors = ntohll(ps11->rx_crc_err);
5169 ops->stats.collisions = ntohll(ps11->collisions);
5170 ops->duration_sec = ops->duration_nsec = UINT32_MAX;
5176 ofputil_port_stats_from_ofp13(struct ofputil_port_stats *ops,
5177 const struct ofp13_port_stats *ps13)
5179 enum ofperr error = ofputil_port_stats_from_ofp11(ops, &ps13->ps);
5181 ops->duration_sec = ntohl(ps13->duration_sec);
5182 ops->duration_nsec = ntohl(ps13->duration_nsec);
5188 ofputil_get_port_stats_size(enum ofp_version ofp_version)
5190 switch (ofp_version) {
5192 return sizeof(struct ofp10_port_stats);
5195 return sizeof(struct ofp11_port_stats);
5197 return sizeof(struct ofp13_port_stats);
5203 /* Returns the number of port stats elements in OFPTYPE_PORT_STATS_REPLY
5206 ofputil_count_port_stats(const struct ofp_header *oh)
5210 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5211 ofpraw_pull_assert(&b);
5213 return b.size / ofputil_get_port_stats_size(oh->version);
5216 /* Converts an OFPST_PORT_STATS reply in 'msg' into an abstract
5217 * ofputil_port_stats in 'ps'.
5219 * Multiple OFPST_PORT_STATS replies can be packed into a single OpenFlow
5220 * message. Calling this function multiple times for a single 'msg' iterates
5221 * through the replies. The caller must initially leave 'msg''s layer pointers
5222 * null and not modify them between calls.
5224 * Returns 0 if successful, EOF if no replies were left in this 'msg',
5225 * otherwise a positive errno value. */
5227 ofputil_decode_port_stats(struct ofputil_port_stats *ps, struct ofpbuf *msg)
5233 ? ofpraw_decode(&raw, msg->l2)
5234 : ofpraw_pull(&raw, msg));
5241 } else if (raw == OFPRAW_OFPST13_PORT_REPLY) {
5242 const struct ofp13_port_stats *ps13;
5244 ps13 = ofpbuf_try_pull(msg, sizeof *ps13);
5248 return ofputil_port_stats_from_ofp13(ps, ps13);
5249 } else if (raw == OFPRAW_OFPST11_PORT_REPLY) {
5250 const struct ofp11_port_stats *ps11;
5252 ps11 = ofpbuf_try_pull(msg, sizeof *ps11);
5256 return ofputil_port_stats_from_ofp11(ps, ps11);
5257 } else if (raw == OFPRAW_OFPST10_PORT_REPLY) {
5258 const struct ofp10_port_stats *ps10;
5260 ps10 = ofpbuf_try_pull(msg, sizeof *ps10);
5264 return ofputil_port_stats_from_ofp10(ps, ps10);
5270 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_PORT reply has %zu leftover "
5271 "bytes at end", msg->size);
5272 return OFPERR_OFPBRC_BAD_LEN;
5275 /* Parse a port status request message into a 16 bit OpenFlow 1.0
5276 * port number and stores the latter in '*ofp10_port'.
5277 * Returns 0 if successful, otherwise an OFPERR_* number. */
5279 ofputil_decode_port_stats_request(const struct ofp_header *request,
5280 ofp_port_t *ofp10_port)
5282 switch ((enum ofp_version)request->version) {
5285 case OFP11_VERSION: {
5286 const struct ofp11_port_stats_request *psr11 = ofpmsg_body(request);
5287 return ofputil_port_from_ofp11(psr11->port_no, ofp10_port);
5290 case OFP10_VERSION: {
5291 const struct ofp10_port_stats_request *psr10 = ofpmsg_body(request);
5292 *ofp10_port = u16_to_ofp(ntohs(psr10->port_no));
5301 /* Parse a queue status request message into 'oqsr'.
5302 * Returns 0 if successful, otherwise an OFPERR_* number. */
5304 ofputil_decode_queue_stats_request(const struct ofp_header *request,
5305 struct ofputil_queue_stats_request *oqsr)
5307 switch ((enum ofp_version)request->version) {
5310 case OFP11_VERSION: {
5311 const struct ofp11_queue_stats_request *qsr11 = ofpmsg_body(request);
5312 oqsr->queue_id = ntohl(qsr11->queue_id);
5313 return ofputil_port_from_ofp11(qsr11->port_no, &oqsr->port_no);
5316 case OFP10_VERSION: {
5317 const struct ofp10_queue_stats_request *qsr10 = ofpmsg_body(request);
5318 oqsr->queue_id = ntohl(qsr10->queue_id);
5319 oqsr->port_no = u16_to_ofp(ntohs(qsr10->port_no));
5320 /* OF 1.0 uses OFPP_ALL for OFPP_ANY */
5321 if (oqsr->port_no == OFPP_ALL) {
5322 oqsr->port_no = OFPP_ANY;
5332 /* Encode a queue statsrequest for 'oqsr', the encoded message
5333 * will be fore Open Flow version 'ofp_version'. Returns message
5334 * as a struct ofpbuf. Returns encoded message on success, NULL on error */
5336 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
5337 const struct ofputil_queue_stats_request *oqsr)
5339 struct ofpbuf *request;
5341 switch (ofp_version) {
5344 case OFP13_VERSION: {
5345 struct ofp11_queue_stats_request *req;
5346 request = ofpraw_alloc(OFPRAW_OFPST11_QUEUE_REQUEST, ofp_version, 0);
5347 req = ofpbuf_put_zeros(request, sizeof *req);
5348 req->port_no = ofputil_port_to_ofp11(oqsr->port_no);
5349 req->queue_id = htonl(oqsr->queue_id);
5352 case OFP10_VERSION: {
5353 struct ofp10_queue_stats_request *req;
5354 request = ofpraw_alloc(OFPRAW_OFPST10_QUEUE_REQUEST, ofp_version, 0);
5355 req = ofpbuf_put_zeros(request, sizeof *req);
5356 /* OpenFlow 1.0 needs OFPP_ALL instead of OFPP_ANY */
5357 req->port_no = htons(ofp_to_u16(oqsr->port_no == OFPP_ANY
5358 ? OFPP_ALL : oqsr->port_no));
5359 req->queue_id = htonl(oqsr->queue_id);
5370 ofputil_get_queue_stats_size(enum ofp_version ofp_version)
5372 switch (ofp_version) {
5374 return sizeof(struct ofp10_queue_stats);
5377 return sizeof(struct ofp11_queue_stats);
5379 return sizeof(struct ofp13_queue_stats);
5385 /* Returns the number of queue stats elements in OFPTYPE_QUEUE_STATS_REPLY
5388 ofputil_count_queue_stats(const struct ofp_header *oh)
5392 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5393 ofpraw_pull_assert(&b);
5395 return b.size / ofputil_get_queue_stats_size(oh->version);
5399 ofputil_queue_stats_from_ofp10(struct ofputil_queue_stats *oqs,
5400 const struct ofp10_queue_stats *qs10)
5402 oqs->port_no = u16_to_ofp(ntohs(qs10->port_no));
5403 oqs->queue_id = ntohl(qs10->queue_id);
5404 oqs->tx_bytes = ntohll(get_32aligned_be64(&qs10->tx_bytes));
5405 oqs->tx_packets = ntohll(get_32aligned_be64(&qs10->tx_packets));
5406 oqs->tx_errors = ntohll(get_32aligned_be64(&qs10->tx_errors));
5407 oqs->duration_sec = oqs->duration_nsec = UINT32_MAX;
5413 ofputil_queue_stats_from_ofp11(struct ofputil_queue_stats *oqs,
5414 const struct ofp11_queue_stats *qs11)
5418 error = ofputil_port_from_ofp11(qs11->port_no, &oqs->port_no);
5423 oqs->queue_id = ntohl(qs11->queue_id);
5424 oqs->tx_bytes = ntohll(qs11->tx_bytes);
5425 oqs->tx_packets = ntohll(qs11->tx_packets);
5426 oqs->tx_errors = ntohll(qs11->tx_errors);
5427 oqs->duration_sec = oqs->duration_nsec = UINT32_MAX;
5433 ofputil_queue_stats_from_ofp13(struct ofputil_queue_stats *oqs,
5434 const struct ofp13_queue_stats *qs13)
5436 enum ofperr error = ofputil_queue_stats_from_ofp11(oqs, &qs13->qs);
5438 oqs->duration_sec = ntohl(qs13->duration_sec);
5439 oqs->duration_nsec = ntohl(qs13->duration_nsec);
5445 /* Converts an OFPST_QUEUE_STATS reply in 'msg' into an abstract
5446 * ofputil_queue_stats in 'qs'.
5448 * Multiple OFPST_QUEUE_STATS replies can be packed into a single OpenFlow
5449 * message. Calling this function multiple times for a single 'msg' iterates
5450 * through the replies. The caller must initially leave 'msg''s layer pointers
5451 * null and not modify them between calls.
5453 * Returns 0 if successful, EOF if no replies were left in this 'msg',
5454 * otherwise a positive errno value. */
5456 ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg)
5462 ? ofpraw_decode(&raw, msg->l2)
5463 : ofpraw_pull(&raw, msg));
5470 } else if (raw == OFPRAW_OFPST13_QUEUE_REPLY) {
5471 const struct ofp13_queue_stats *qs13;
5473 qs13 = ofpbuf_try_pull(msg, sizeof *qs13);
5477 return ofputil_queue_stats_from_ofp13(qs, qs13);
5478 } else if (raw == OFPRAW_OFPST11_QUEUE_REPLY) {
5479 const struct ofp11_queue_stats *qs11;
5481 qs11 = ofpbuf_try_pull(msg, sizeof *qs11);
5485 return ofputil_queue_stats_from_ofp11(qs, qs11);
5486 } else if (raw == OFPRAW_OFPST10_QUEUE_REPLY) {
5487 const struct ofp10_queue_stats *qs10;
5489 qs10 = ofpbuf_try_pull(msg, sizeof *qs10);
5493 return ofputil_queue_stats_from_ofp10(qs, qs10);
5499 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_QUEUE reply has %zu leftover "
5500 "bytes at end", msg->size);
5501 return OFPERR_OFPBRC_BAD_LEN;
5505 ofputil_queue_stats_to_ofp10(const struct ofputil_queue_stats *oqs,
5506 struct ofp10_queue_stats *qs10)
5508 qs10->port_no = htons(ofp_to_u16(oqs->port_no));
5509 memset(qs10->pad, 0, sizeof qs10->pad);
5510 qs10->queue_id = htonl(oqs->queue_id);
5511 put_32aligned_be64(&qs10->tx_bytes, htonll(oqs->tx_bytes));
5512 put_32aligned_be64(&qs10->tx_packets, htonll(oqs->tx_packets));
5513 put_32aligned_be64(&qs10->tx_errors, htonll(oqs->tx_errors));
5517 ofputil_queue_stats_to_ofp11(const struct ofputil_queue_stats *oqs,
5518 struct ofp11_queue_stats *qs11)
5520 qs11->port_no = ofputil_port_to_ofp11(oqs->port_no);
5521 qs11->queue_id = htonl(oqs->queue_id);
5522 qs11->tx_bytes = htonll(oqs->tx_bytes);
5523 qs11->tx_packets = htonll(oqs->tx_packets);
5524 qs11->tx_errors = htonll(oqs->tx_errors);
5528 ofputil_queue_stats_to_ofp13(const struct ofputil_queue_stats *oqs,
5529 struct ofp13_queue_stats *qs13)
5531 ofputil_queue_stats_to_ofp11(oqs, &qs13->qs);
5532 if (oqs->duration_sec != UINT32_MAX) {
5533 qs13->duration_sec = htonl(oqs->duration_sec);
5534 qs13->duration_nsec = htonl(oqs->duration_nsec);
5536 qs13->duration_sec = htonl(UINT32_MAX);
5537 qs13->duration_nsec = htonl(UINT32_MAX);
5541 /* Encode a queue stat for 'oqs' and append it to 'replies'. */
5543 ofputil_append_queue_stat(struct list *replies,
5544 const struct ofputil_queue_stats *oqs)
5546 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
5547 struct ofp_header *oh = msg->data;
5549 switch ((enum ofp_version)oh->version) {
5550 case OFP13_VERSION: {
5551 struct ofp13_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
5552 ofputil_queue_stats_to_ofp13(oqs, reply);
5557 case OFP11_VERSION: {
5558 struct ofp11_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
5559 ofputil_queue_stats_to_ofp11(oqs, reply);
5563 case OFP10_VERSION: {
5564 struct ofp10_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
5565 ofputil_queue_stats_to_ofp10(oqs, reply);