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_priority can't be sent in a flow_mod */
1138 if (wc->masks.skb_priority) {
1139 return OFPUTIL_P_NONE;
1142 /* NXM and OXM support pkt_mark */
1143 if (wc->masks.pkt_mark) {
1144 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1145 | OFPUTIL_P_OF13_OXM;
1148 /* NXM, OXM, and OF1.1 support bitwise matching on ethernet addresses. */
1149 if (!eth_mask_is_exact(wc->masks.dl_src)
1150 && !eth_addr_is_zero(wc->masks.dl_src)) {
1151 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1152 | OFPUTIL_P_OF13_OXM;
1154 if (!eth_mask_is_exact(wc->masks.dl_dst)
1155 && !eth_addr_is_zero(wc->masks.dl_dst)) {
1156 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1157 | OFPUTIL_P_OF13_OXM;
1160 /* NXM, OXM, and OF1.1+ support matching metadata. */
1161 if (wc->masks.metadata != htonll(0)) {
1162 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1163 | OFPUTIL_P_OF13_OXM;
1166 /* NXM and OXM support matching ARP hardware addresses. */
1167 if (!eth_addr_is_zero(wc->masks.arp_sha) ||
1168 !eth_addr_is_zero(wc->masks.arp_tha)) {
1169 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1170 | OFPUTIL_P_OF13_OXM;
1173 /* NXM and OXM support matching L3 and L4 fields within IPv6.
1175 * (arp_sha, arp_tha, nw_frag, and nw_ttl are covered elsewhere so they
1176 * don't need to be included in this test too.) */
1177 if (match->flow.dl_type == htons(ETH_TYPE_IPV6)
1178 && (!ipv6_mask_is_any(&wc->masks.ipv6_src)
1179 || !ipv6_mask_is_any(&wc->masks.ipv6_dst)
1180 || !ipv6_mask_is_any(&wc->masks.nd_target)
1181 || wc->masks.ipv6_label
1184 || wc->masks.nw_proto
1185 || wc->masks.nw_tos)) {
1186 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1187 | OFPUTIL_P_OF13_OXM;
1190 /* NXM and OXM support matching registers. */
1191 if (!regs_fully_wildcarded(wc)) {
1192 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1193 | OFPUTIL_P_OF13_OXM;
1196 /* NXM and OXM support matching tun_id, tun_src, and tun_dst. */
1197 if (wc->masks.tunnel.tun_id != htonll(0)
1198 || wc->masks.tunnel.ip_src != htonl(0)
1199 || wc->masks.tunnel.ip_dst != htonl(0)) {
1200 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1201 | OFPUTIL_P_OF13_OXM;
1204 /* NXM and OXM support matching fragments. */
1205 if (wc->masks.nw_frag) {
1206 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1207 | OFPUTIL_P_OF13_OXM;
1210 /* NXM and OXM support matching IP ECN bits. */
1211 if (wc->masks.nw_tos & IP_ECN_MASK) {
1212 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1213 | OFPUTIL_P_OF13_OXM;
1216 /* NXM and OXM support matching IP TTL/hop limit. */
1217 if (wc->masks.nw_ttl) {
1218 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1219 | OFPUTIL_P_OF13_OXM;
1222 /* NXM and OXM support non-CIDR IPv4 address masks. */
1223 if (!ip_is_cidr(wc->masks.nw_src) || !ip_is_cidr(wc->masks.nw_dst)) {
1224 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1225 | OFPUTIL_P_OF13_OXM;
1228 /* NXM and OXM support bitwise matching on transport port. */
1229 if ((wc->masks.tp_src && wc->masks.tp_src != htons(UINT16_MAX)) ||
1230 (wc->masks.tp_dst && wc->masks.tp_dst != htons(UINT16_MAX))) {
1231 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1232 | OFPUTIL_P_OF13_OXM;
1235 /* NXM and OF1.1+ support matching MPLS label */
1236 if (wc->masks.mpls_lse & htonl(MPLS_LABEL_MASK)) {
1237 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1238 | OFPUTIL_P_OF13_OXM;
1241 /* NXM and OF1.1+ support matching MPLS TC */
1242 if (wc->masks.mpls_lse & htonl(MPLS_TC_MASK)) {
1243 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1244 | OFPUTIL_P_OF13_OXM;
1247 /* NXM and OF1.3+ support matching MPLS stack flag */
1248 /* Allow for OF1.2 as there doesn't seem to be a
1249 * particularly good reason not to */
1250 if (wc->masks.mpls_lse & htonl(MPLS_BOS_MASK)) {
1251 return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1252 | OFPUTIL_P_OF13_OXM;
1255 /* Other formats can express this rule. */
1256 return OFPUTIL_P_ANY;
1260 ofputil_format_version(struct ds *msg, enum ofp_version version)
1262 ds_put_format(msg, "0x%02x", version);
1266 ofputil_format_version_name(struct ds *msg, enum ofp_version version)
1268 ds_put_cstr(msg, ofputil_version_to_string(version));
1272 ofputil_format_version_bitmap__(struct ds *msg, uint32_t bitmap,
1273 void (*format_version)(struct ds *msg,
1277 format_version(msg, raw_ctz(bitmap));
1278 bitmap = zero_rightmost_1bit(bitmap);
1280 ds_put_cstr(msg, ", ");
1286 ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap)
1288 ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version);
1292 ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap)
1294 ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version_name);
1298 ofputil_decode_hello_bitmap(const struct ofp_hello_elem_header *oheh,
1299 uint32_t *allowed_versionsp)
1301 uint16_t bitmap_len = ntohs(oheh->length) - sizeof *oheh;
1302 const ovs_be32 *bitmap = ALIGNED_CAST(const ovs_be32 *, oheh + 1);
1303 uint32_t allowed_versions;
1305 if (!bitmap_len || bitmap_len % sizeof *bitmap) {
1309 /* Only use the first 32-bit element of the bitmap as that is all the
1310 * current implementation supports. Subsequent elements are ignored which
1311 * should have no effect on session negotiation until Open vSwtich supports
1312 * wire-protocol versions greater than 31.
1314 allowed_versions = ntohl(bitmap[0]);
1316 if (allowed_versions & 1) {
1317 /* There's no OpenFlow version 0. */
1318 VLOG_WARN_RL(&bad_ofmsg_rl, "peer claims to support invalid OpenFlow "
1320 allowed_versions &= ~1u;
1323 if (!allowed_versions) {
1324 VLOG_WARN_RL(&bad_ofmsg_rl, "peer does not support any OpenFlow "
1325 "version (between 0x01 and 0x1f)");
1329 *allowed_versionsp = allowed_versions;
1334 version_bitmap_from_version(uint8_t ofp_version)
1336 return ((ofp_version < 32 ? 1u << ofp_version : 0) - 1) << 1;
1339 /* Decodes OpenFlow OFPT_HELLO message 'oh', storing into '*allowed_versions'
1340 * the set of OpenFlow versions for which 'oh' announces support.
1342 * Because of how OpenFlow defines OFPT_HELLO messages, this function is always
1343 * successful, and thus '*allowed_versions' is always initialized. However, it
1344 * returns false if 'oh' contains some data that could not be fully understood,
1345 * true if 'oh' was completely parsed. */
1347 ofputil_decode_hello(const struct ofp_header *oh, uint32_t *allowed_versions)
1352 ofpbuf_use_const(&msg, oh, ntohs(oh->length));
1353 ofpbuf_pull(&msg, sizeof *oh);
1355 *allowed_versions = version_bitmap_from_version(oh->version);
1357 const struct ofp_hello_elem_header *oheh;
1360 if (msg.size < sizeof *oheh) {
1365 len = ntohs(oheh->length);
1366 if (len < sizeof *oheh || !ofpbuf_try_pull(&msg, ROUND_UP(len, 8))) {
1370 if (oheh->type != htons(OFPHET_VERSIONBITMAP)
1371 || !ofputil_decode_hello_bitmap(oheh, allowed_versions)) {
1379 /* Returns true if 'allowed_versions' needs to be accompanied by a version
1380 * bitmap to be correctly expressed in an OFPT_HELLO message. */
1382 should_send_version_bitmap(uint32_t allowed_versions)
1384 return !is_pow2((allowed_versions >> 1) + 1);
1387 /* Create an OFPT_HELLO message that expresses support for the OpenFlow
1388 * versions in the 'allowed_versions' bitmaps and returns the message. */
1390 ofputil_encode_hello(uint32_t allowed_versions)
1392 enum ofp_version ofp_version;
1395 ofp_version = leftmost_1bit_idx(allowed_versions);
1396 msg = ofpraw_alloc(OFPRAW_OFPT_HELLO, ofp_version, 0);
1398 if (should_send_version_bitmap(allowed_versions)) {
1399 struct ofp_hello_elem_header *oheh;
1402 map_len = sizeof allowed_versions;
1403 oheh = ofpbuf_put_zeros(msg, ROUND_UP(map_len + sizeof *oheh, 8));
1404 oheh->type = htons(OFPHET_VERSIONBITMAP);
1405 oheh->length = htons(map_len + sizeof *oheh);
1406 *ALIGNED_CAST(ovs_be32 *, oheh + 1) = htonl(allowed_versions);
1408 ofpmsg_update_length(msg);
1414 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
1415 * protocol is 'current', at least partly transitions the protocol to 'want'.
1416 * Stores in '*next' the protocol that will be in effect on the OpenFlow
1417 * connection if the switch processes the returned message correctly. (If
1418 * '*next != want' then the caller will have to iterate.)
1420 * If 'current == want', or if it is not possible to transition from 'current'
1421 * to 'want' (because, for example, 'current' and 'want' use different OpenFlow
1422 * protocol versions), returns NULL and stores 'current' in '*next'. */
1424 ofputil_encode_set_protocol(enum ofputil_protocol current,
1425 enum ofputil_protocol want,
1426 enum ofputil_protocol *next)
1428 enum ofp_version cur_version, want_version;
1429 enum ofputil_protocol cur_base, want_base;
1430 bool cur_tid, want_tid;
1432 cur_version = ofputil_protocol_to_ofp_version(current);
1433 want_version = ofputil_protocol_to_ofp_version(want);
1434 if (cur_version != want_version) {
1439 cur_base = ofputil_protocol_to_base(current);
1440 want_base = ofputil_protocol_to_base(want);
1441 if (cur_base != want_base) {
1442 *next = ofputil_protocol_set_base(current, want_base);
1444 switch (want_base) {
1445 case OFPUTIL_P_OF10_NXM:
1446 return ofputil_encode_nx_set_flow_format(NXFF_NXM);
1448 case OFPUTIL_P_OF10_STD:
1449 return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10);
1451 case OFPUTIL_P_OF11_STD:
1452 case OFPUTIL_P_OF12_OXM:
1453 case OFPUTIL_P_OF13_OXM:
1454 /* There is only one variant of each OpenFlow 1.1+ protocol, and we
1455 * verified above that we're not trying to change versions. */
1458 case OFPUTIL_P_OF10_STD_TID:
1459 case OFPUTIL_P_OF10_NXM_TID:
1464 cur_tid = (current & OFPUTIL_P_TID) != 0;
1465 want_tid = (want & OFPUTIL_P_TID) != 0;
1466 if (cur_tid != want_tid) {
1467 *next = ofputil_protocol_set_tid(current, want_tid);
1468 return ofputil_make_flow_mod_table_id(want_tid);
1471 ovs_assert(current == want);
1477 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1478 * format to 'nxff'. */
1480 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff)
1482 struct nx_set_flow_format *sff;
1485 ovs_assert(ofputil_nx_flow_format_is_valid(nxff));
1487 msg = ofpraw_alloc(OFPRAW_NXT_SET_FLOW_FORMAT, OFP10_VERSION, 0);
1488 sff = ofpbuf_put_zeros(msg, sizeof *sff);
1489 sff->format = htonl(nxff);
1494 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1496 enum ofputil_protocol
1497 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format)
1499 switch (flow_format) {
1500 case NXFF_OPENFLOW10:
1501 return OFPUTIL_P_OF10_STD;
1504 return OFPUTIL_P_OF10_NXM;
1511 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1513 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format)
1515 return ofputil_nx_flow_format_to_protocol(flow_format) != 0;
1518 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1521 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format)
1523 switch (flow_format) {
1524 case NXFF_OPENFLOW10:
1525 return "openflow10";
1534 ofputil_make_set_packet_in_format(enum ofp_version ofp_version,
1535 enum nx_packet_in_format packet_in_format)
1537 struct nx_set_packet_in_format *spif;
1540 msg = ofpraw_alloc(OFPRAW_NXT_SET_PACKET_IN_FORMAT, ofp_version, 0);
1541 spif = ofpbuf_put_zeros(msg, sizeof *spif);
1542 spif->format = htonl(packet_in_format);
1547 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1548 * extension on or off (according to 'flow_mod_table_id'). */
1550 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
1552 struct nx_flow_mod_table_id *nfmti;
1555 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION, 0);
1556 nfmti = ofpbuf_put_zeros(msg, sizeof *nfmti);
1557 nfmti->set = flow_mod_table_id;
1561 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1562 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
1565 * Uses 'ofpacts' to store the abstract OFPACT_* version of 'oh''s actions.
1566 * The caller must initialize 'ofpacts' and retains ownership of it.
1567 * 'fm->ofpacts' will point into the 'ofpacts' buffer.
1569 * Does not validate the flow_mod actions. The caller should do that, with
1570 * ofpacts_check(). */
1572 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
1573 const struct ofp_header *oh,
1574 enum ofputil_protocol protocol,
1575 struct ofpbuf *ofpacts)
1581 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1582 raw = ofpraw_pull_assert(&b);
1583 if (raw == OFPRAW_OFPT11_FLOW_MOD) {
1584 /* Standard OpenFlow 1.1 flow_mod. */
1585 const struct ofp11_flow_mod *ofm;
1588 ofm = ofpbuf_pull(&b, sizeof *ofm);
1590 error = ofputil_pull_ofp11_match(&b, &fm->match, NULL);
1595 error = ofpacts_pull_openflow11_instructions(&b, b.size, ofpacts);
1600 /* Translate the message. */
1601 fm->priority = ntohs(ofm->priority);
1602 if (ofm->command == OFPFC_ADD
1603 || (oh->version == OFP11_VERSION
1604 && (ofm->command == OFPFC_MODIFY ||
1605 ofm->command == OFPFC_MODIFY_STRICT)
1606 && ofm->cookie_mask == htonll(0))) {
1607 /* In OpenFlow 1.1 only, a "modify" or "modify-strict" that does
1608 * not match on the cookie is treated as an "add" if there is no
1610 fm->cookie = htonll(0);
1611 fm->cookie_mask = htonll(0);
1612 fm->new_cookie = ofm->cookie;
1614 fm->cookie = ofm->cookie;
1615 fm->cookie_mask = ofm->cookie_mask;
1616 fm->new_cookie = htonll(UINT64_MAX);
1618 fm->modify_cookie = false;
1619 fm->command = ofm->command;
1620 fm->table_id = ofm->table_id;
1621 fm->idle_timeout = ntohs(ofm->idle_timeout);
1622 fm->hard_timeout = ntohs(ofm->hard_timeout);
1623 fm->buffer_id = ntohl(ofm->buffer_id);
1624 error = ofputil_port_from_ofp11(ofm->out_port, &fm->out_port);
1628 if ((ofm->command == OFPFC_DELETE
1629 || ofm->command == OFPFC_DELETE_STRICT)
1630 && ofm->out_group != htonl(OFPG_ANY)) {
1631 return OFPERR_OFPFMFC_UNKNOWN;
1633 fm->flags = ntohs(ofm->flags);
1635 if (raw == OFPRAW_OFPT10_FLOW_MOD) {
1636 /* Standard OpenFlow 1.0 flow_mod. */
1637 const struct ofp10_flow_mod *ofm;
1640 /* Get the ofp10_flow_mod. */
1641 ofm = ofpbuf_pull(&b, sizeof *ofm);
1643 /* Translate the rule. */
1644 ofputil_match_from_ofp10_match(&ofm->match, &fm->match);
1645 ofputil_normalize_match(&fm->match);
1647 /* Now get the actions. */
1648 error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1653 /* OpenFlow 1.0 says that exact-match rules have to have the
1654 * highest possible priority. */
1655 fm->priority = (ofm->match.wildcards & htonl(OFPFW10_ALL)
1656 ? ntohs(ofm->priority)
1659 /* Translate the message. */
1660 command = ntohs(ofm->command);
1661 fm->cookie = htonll(0);
1662 fm->cookie_mask = htonll(0);
1663 fm->new_cookie = ofm->cookie;
1664 fm->idle_timeout = ntohs(ofm->idle_timeout);
1665 fm->hard_timeout = ntohs(ofm->hard_timeout);
1666 fm->buffer_id = ntohl(ofm->buffer_id);
1667 fm->out_port = u16_to_ofp(ntohs(ofm->out_port));
1668 fm->flags = ntohs(ofm->flags);
1669 } else if (raw == OFPRAW_NXT_FLOW_MOD) {
1670 /* Nicira extended flow_mod. */
1671 const struct nx_flow_mod *nfm;
1674 /* Dissect the message. */
1675 nfm = ofpbuf_pull(&b, sizeof *nfm);
1676 error = nx_pull_match(&b, ntohs(nfm->match_len),
1677 &fm->match, &fm->cookie, &fm->cookie_mask);
1681 error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1686 /* Translate the message. */
1687 command = ntohs(nfm->command);
1688 if ((command & 0xff) == OFPFC_ADD && fm->cookie_mask) {
1689 /* Flow additions may only set a new cookie, not match an
1690 * existing cookie. */
1691 return OFPERR_NXBRC_NXM_INVALID;
1693 fm->priority = ntohs(nfm->priority);
1694 fm->new_cookie = nfm->cookie;
1695 fm->idle_timeout = ntohs(nfm->idle_timeout);
1696 fm->hard_timeout = ntohs(nfm->hard_timeout);
1697 fm->buffer_id = ntohl(nfm->buffer_id);
1698 fm->out_port = u16_to_ofp(ntohs(nfm->out_port));
1699 fm->flags = ntohs(nfm->flags);
1704 if (fm->flags & OFPFF10_EMERG) {
1705 /* We do not support the OpenFlow 1.0 emergency flow cache, which
1706 * is not required in OpenFlow 1.0.1 and removed from OpenFlow 1.1.
1708 * OpenFlow 1.0 specifies the error code to use when idle_timeout
1709 * or hard_timeout is nonzero. Otherwise, there is no good error
1710 * code, so just state that the flow table is full. */
1711 return (fm->hard_timeout || fm->idle_timeout
1712 ? OFPERR_OFPFMFC_BAD_EMERG_TIMEOUT
1713 : OFPERR_OFPFMFC_TABLE_FULL);
1716 fm->modify_cookie = fm->new_cookie != htonll(UINT64_MAX);
1717 if (protocol & OFPUTIL_P_TID) {
1718 fm->command = command & 0xff;
1719 fm->table_id = command >> 8;
1721 fm->command = command;
1722 fm->table_id = 0xff;
1726 fm->ofpacts = ofpacts->data;
1727 fm->ofpacts_len = ofpacts->size;
1733 ofputil_pull_bands(struct ofpbuf *msg, size_t len, uint16_t *n_bands,
1734 struct ofpbuf *bands)
1736 const struct ofp13_meter_band_header *ombh;
1737 struct ofputil_meter_band *mb;
1740 ombh = ofpbuf_try_pull(msg, len);
1742 return OFPERR_OFPBRC_BAD_LEN;
1745 while (len >= sizeof (struct ofp13_meter_band_drop)) {
1746 size_t ombh_len = ntohs(ombh->len);
1747 /* All supported band types have the same length. */
1748 if (ombh_len != sizeof (struct ofp13_meter_band_drop)) {
1749 return OFPERR_OFPBRC_BAD_LEN;
1751 mb = ofpbuf_put_uninit(bands, sizeof *mb);
1752 mb->type = ntohs(ombh->type);
1753 mb->rate = ntohl(ombh->rate);
1754 mb->burst_size = ntohl(ombh->burst_size);
1755 mb->prec_level = (mb->type == OFPMBT13_DSCP_REMARK) ?
1756 ((struct ofp13_meter_band_dscp_remark *)ombh)->prec_level : 0;
1759 ombh = ALIGNED_CAST(struct ofp13_meter_band_header *,
1760 (char *) ombh + ombh_len);
1763 return OFPERR_OFPBRC_BAD_LEN;
1770 ofputil_decode_meter_mod(const struct ofp_header *oh,
1771 struct ofputil_meter_mod *mm,
1772 struct ofpbuf *bands)
1774 const struct ofp13_meter_mod *omm;
1777 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1778 ofpraw_pull_assert(&b);
1779 omm = ofpbuf_pull(&b, sizeof *omm);
1781 /* Translate the message. */
1782 mm->command = ntohs(omm->command);
1783 mm->meter.meter_id = ntohl(omm->meter_id);
1785 if (mm->command == OFPMC13_DELETE) {
1786 mm->meter.flags = 0;
1787 mm->meter.n_bands = 0;
1788 mm->meter.bands = NULL;
1792 mm->meter.flags = ntohs(omm->flags);
1793 mm->meter.bands = bands->data;
1795 error = ofputil_pull_bands(&b, b.size, &mm->meter.n_bands, bands);
1804 ofputil_decode_meter_request(const struct ofp_header *oh, uint32_t *meter_id)
1806 const struct ofp13_meter_multipart_request *omr = ofpmsg_body(oh);
1807 *meter_id = ntohl(omr->meter_id);
1811 ofputil_encode_meter_request(enum ofp_version ofp_version,
1812 enum ofputil_meter_request_type type,
1820 case OFPUTIL_METER_CONFIG:
1821 raw = OFPRAW_OFPST13_METER_CONFIG_REQUEST;
1823 case OFPUTIL_METER_STATS:
1824 raw = OFPRAW_OFPST13_METER_REQUEST;
1827 case OFPUTIL_METER_FEATURES:
1828 raw = OFPRAW_OFPST13_METER_FEATURES_REQUEST;
1832 msg = ofpraw_alloc(raw, ofp_version, 0);
1834 if (type != OFPUTIL_METER_FEATURES) {
1835 struct ofp13_meter_multipart_request *omr;
1836 omr = ofpbuf_put_zeros(msg, sizeof *omr);
1837 omr->meter_id = htonl(meter_id);
1843 ofputil_put_bands(uint16_t n_bands, const struct ofputil_meter_band *mb,
1848 for (n = 0; n < n_bands; ++n) {
1849 /* Currently all band types have same size. */
1850 struct ofp13_meter_band_dscp_remark *ombh;
1851 size_t ombh_len = sizeof *ombh;
1853 ombh = ofpbuf_put_zeros(msg, ombh_len);
1855 ombh->type = htons(mb->type);
1856 ombh->len = htons(ombh_len);
1857 ombh->rate = htonl(mb->rate);
1858 ombh->burst_size = htonl(mb->burst_size);
1859 ombh->prec_level = mb->prec_level;
1865 /* Encode a meter stat for 'mc' and append it to 'replies'. */
1867 ofputil_append_meter_config(struct list *replies,
1868 const struct ofputil_meter_config *mc)
1870 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
1871 size_t start_ofs = msg->size;
1872 struct ofp13_meter_config *reply = ofpbuf_put_uninit(msg, sizeof *reply);
1873 reply->flags = htons(mc->flags);
1874 reply->meter_id = htonl(mc->meter_id);
1876 ofputil_put_bands(mc->n_bands, mc->bands, msg);
1878 reply->length = htons(msg->size - start_ofs);
1880 ofpmp_postappend(replies, start_ofs);
1883 /* Encode a meter stat for 'ms' and append it to 'replies'. */
1885 ofputil_append_meter_stats(struct list *replies,
1886 const struct ofputil_meter_stats *ms)
1888 struct ofp13_meter_stats *reply;
1892 len = sizeof *reply + ms->n_bands * sizeof(struct ofp13_meter_band_stats);
1893 reply = ofpmp_append(replies, len);
1895 reply->meter_id = htonl(ms->meter_id);
1896 reply->len = htons(len);
1897 memset(reply->pad, 0, sizeof reply->pad);
1898 reply->flow_count = htonl(ms->flow_count);
1899 reply->packet_in_count = htonll(ms->packet_in_count);
1900 reply->byte_in_count = htonll(ms->byte_in_count);
1901 reply->duration_sec = htonl(ms->duration_sec);
1902 reply->duration_nsec = htonl(ms->duration_nsec);
1904 for (n = 0; n < ms->n_bands; ++n) {
1905 const struct ofputil_meter_band_stats *src = &ms->bands[n];
1906 struct ofp13_meter_band_stats *dst = &reply->band_stats[n];
1908 dst->packet_band_count = htonll(src->packet_count);
1909 dst->byte_band_count = htonll(src->byte_count);
1913 /* Converts an OFPMP_METER_CONFIG reply in 'msg' into an abstract
1914 * ofputil_meter_config in 'mc', with mc->bands pointing to bands decoded into
1915 * 'bands'. The caller must have initialized 'bands' and retains ownership of
1916 * it across the call.
1918 * Multiple OFPST13_METER_CONFIG replies can be packed into a single OpenFlow
1919 * message. Calling this function multiple times for a single 'msg' iterates
1920 * through the replies. 'bands' is cleared for each reply.
1922 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1923 * otherwise a positive errno value. */
1925 ofputil_decode_meter_config(struct ofpbuf *msg,
1926 struct ofputil_meter_config *mc,
1927 struct ofpbuf *bands)
1929 const struct ofp13_meter_config *omc;
1932 /* Pull OpenFlow headers for the first call. */
1934 ofpraw_pull_assert(msg);
1941 omc = ofpbuf_try_pull(msg, sizeof *omc);
1943 VLOG_WARN_RL(&bad_ofmsg_rl,
1944 "OFPMP_METER_CONFIG reply has %zu leftover bytes at end",
1946 return OFPERR_OFPBRC_BAD_LEN;
1949 ofpbuf_clear(bands);
1950 err = ofputil_pull_bands(msg, ntohs(omc->length) - sizeof *omc,
1951 &mc->n_bands, bands);
1955 mc->meter_id = ntohl(omc->meter_id);
1956 mc->flags = ntohs(omc->flags);
1957 mc->bands = bands->data;
1963 ofputil_pull_band_stats(struct ofpbuf *msg, size_t len, uint16_t *n_bands,
1964 struct ofpbuf *bands)
1966 const struct ofp13_meter_band_stats *ombs;
1967 struct ofputil_meter_band_stats *mbs;
1970 ombs = ofpbuf_try_pull(msg, len);
1972 return OFPERR_OFPBRC_BAD_LEN;
1975 n = len / sizeof *ombs;
1976 if (len != n * sizeof *ombs) {
1977 return OFPERR_OFPBRC_BAD_LEN;
1980 mbs = ofpbuf_put_uninit(bands, len);
1982 for (i = 0; i < n; ++i) {
1983 mbs[i].packet_count = ntohll(ombs[i].packet_band_count);
1984 mbs[i].byte_count = ntohll(ombs[i].byte_band_count);
1990 /* Converts an OFPMP_METER reply in 'msg' into an abstract
1991 * ofputil_meter_stats in 'ms', with ms->bands pointing to band stats
1992 * decoded into 'bands'.
1994 * Multiple OFPMP_METER replies can be packed into a single OpenFlow
1995 * message. Calling this function multiple times for a single 'msg' iterates
1996 * through the replies. 'bands' is cleared for each reply.
1998 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1999 * otherwise a positive errno value. */
2001 ofputil_decode_meter_stats(struct ofpbuf *msg,
2002 struct ofputil_meter_stats *ms,
2003 struct ofpbuf *bands)
2005 const struct ofp13_meter_stats *oms;
2008 /* Pull OpenFlow headers for the first call. */
2010 ofpraw_pull_assert(msg);
2017 oms = ofpbuf_try_pull(msg, sizeof *oms);
2019 VLOG_WARN_RL(&bad_ofmsg_rl,
2020 "OFPMP_METER reply has %zu leftover bytes at end",
2022 return OFPERR_OFPBRC_BAD_LEN;
2025 ofpbuf_clear(bands);
2026 err = ofputil_pull_band_stats(msg, ntohs(oms->len) - sizeof *oms,
2027 &ms->n_bands, bands);
2031 ms->meter_id = ntohl(oms->meter_id);
2032 ms->flow_count = ntohl(oms->flow_count);
2033 ms->packet_in_count = ntohll(oms->packet_in_count);
2034 ms->byte_in_count = ntohll(oms->byte_in_count);
2035 ms->duration_sec = ntohl(oms->duration_sec);
2036 ms->duration_nsec = ntohl(oms->duration_nsec);
2037 ms->bands = bands->data;
2043 ofputil_decode_meter_features(const struct ofp_header *oh,
2044 struct ofputil_meter_features *mf)
2046 const struct ofp13_meter_features *omf = ofpmsg_body(oh);
2048 mf->max_meters = ntohl(omf->max_meter);
2049 mf->band_types = ntohl(omf->band_types);
2050 mf->capabilities = ntohl(omf->capabilities);
2051 mf->max_bands = omf->max_bands;
2052 mf->max_color = omf->max_color;
2056 ofputil_encode_meter_features_reply(const struct ofputil_meter_features *mf,
2057 const struct ofp_header *request)
2059 struct ofpbuf *reply;
2060 struct ofp13_meter_features *omf;
2062 reply = ofpraw_alloc_stats_reply(request, 0);
2063 omf = ofpbuf_put_zeros(reply, sizeof *omf);
2065 omf->max_meter = htonl(mf->max_meters);
2066 omf->band_types = htonl(mf->band_types);
2067 omf->capabilities = htonl(mf->capabilities);
2068 omf->max_bands = mf->max_bands;
2069 omf->max_color = mf->max_color;
2075 ofputil_encode_meter_mod(enum ofp_version ofp_version,
2076 const struct ofputil_meter_mod *mm)
2080 struct ofp13_meter_mod *omm;
2082 msg = ofpraw_alloc(OFPRAW_OFPT13_METER_MOD, ofp_version,
2083 NXM_TYPICAL_LEN + mm->meter.n_bands * 16);
2084 omm = ofpbuf_put_zeros(msg, sizeof *omm);
2085 omm->command = htons(mm->command);
2086 if (mm->command != OFPMC13_DELETE) {
2087 omm->flags = htons(mm->meter.flags);
2089 omm->meter_id = htonl(mm->meter.meter_id);
2091 ofputil_put_bands(mm->meter.n_bands, mm->meter.bands, msg);
2093 ofpmsg_update_length(msg);
2098 ofputil_tid_command(const struct ofputil_flow_mod *fm,
2099 enum ofputil_protocol protocol)
2101 return htons(protocol & OFPUTIL_P_TID
2102 ? (fm->command & 0xff) | (fm->table_id << 8)
2106 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
2107 * 'protocol' and returns the message. */
2109 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
2110 enum ofputil_protocol protocol)
2115 case OFPUTIL_P_OF11_STD:
2116 case OFPUTIL_P_OF12_OXM:
2117 case OFPUTIL_P_OF13_OXM: {
2118 struct ofp11_flow_mod *ofm;
2121 tailroom = ofputil_match_typical_len(protocol) + fm->ofpacts_len;
2122 msg = ofpraw_alloc(OFPRAW_OFPT11_FLOW_MOD,
2123 ofputil_protocol_to_ofp_version(protocol),
2125 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
2126 if ((protocol == OFPUTIL_P_OF11_STD
2127 && (fm->command == OFPFC_MODIFY ||
2128 fm->command == OFPFC_MODIFY_STRICT)
2129 && fm->cookie_mask == htonll(0))
2130 || fm->command == OFPFC_ADD) {
2131 ofm->cookie = fm->new_cookie;
2133 ofm->cookie = fm->cookie;
2135 ofm->cookie_mask = fm->cookie_mask;
2136 ofm->table_id = fm->table_id;
2137 ofm->command = fm->command;
2138 ofm->idle_timeout = htons(fm->idle_timeout);
2139 ofm->hard_timeout = htons(fm->hard_timeout);
2140 ofm->priority = htons(fm->priority);
2141 ofm->buffer_id = htonl(fm->buffer_id);
2142 ofm->out_port = ofputil_port_to_ofp11(fm->out_port);
2143 ofm->out_group = htonl(OFPG11_ANY);
2144 ofm->flags = htons(fm->flags);
2145 ofputil_put_ofp11_match(msg, &fm->match, protocol);
2146 ofpacts_put_openflow11_instructions(fm->ofpacts, fm->ofpacts_len, msg);
2150 case OFPUTIL_P_OF10_STD:
2151 case OFPUTIL_P_OF10_STD_TID: {
2152 struct ofp10_flow_mod *ofm;
2154 msg = ofpraw_alloc(OFPRAW_OFPT10_FLOW_MOD, OFP10_VERSION,
2156 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
2157 ofputil_match_to_ofp10_match(&fm->match, &ofm->match);
2158 ofm->cookie = fm->new_cookie;
2159 ofm->command = ofputil_tid_command(fm, protocol);
2160 ofm->idle_timeout = htons(fm->idle_timeout);
2161 ofm->hard_timeout = htons(fm->hard_timeout);
2162 ofm->priority = htons(fm->priority);
2163 ofm->buffer_id = htonl(fm->buffer_id);
2164 ofm->out_port = htons(ofp_to_u16(fm->out_port));
2165 ofm->flags = htons(fm->flags);
2166 ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
2170 case OFPUTIL_P_OF10_NXM:
2171 case OFPUTIL_P_OF10_NXM_TID: {
2172 struct nx_flow_mod *nfm;
2175 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD, OFP10_VERSION,
2176 NXM_TYPICAL_LEN + fm->ofpacts_len);
2177 nfm = ofpbuf_put_zeros(msg, sizeof *nfm);
2178 nfm->command = ofputil_tid_command(fm, protocol);
2179 nfm->cookie = fm->new_cookie;
2180 match_len = nx_put_match(msg, &fm->match, fm->cookie, fm->cookie_mask);
2182 nfm->idle_timeout = htons(fm->idle_timeout);
2183 nfm->hard_timeout = htons(fm->hard_timeout);
2184 nfm->priority = htons(fm->priority);
2185 nfm->buffer_id = htonl(fm->buffer_id);
2186 nfm->out_port = htons(ofp_to_u16(fm->out_port));
2187 nfm->flags = htons(fm->flags);
2188 nfm->match_len = htons(match_len);
2189 ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
2197 ofpmsg_update_length(msg);
2201 /* Returns a bitmask with a 1-bit for each protocol that could be used to
2202 * send all of the 'n_fm's flow table modification requests in 'fms', and a
2203 * 0-bit for each protocol that is inadequate.
2205 * (The return value will have at least one 1-bit.) */
2206 enum ofputil_protocol
2207 ofputil_flow_mod_usable_protocols(const struct ofputil_flow_mod *fms,
2210 enum ofputil_protocol usable_protocols;
2213 usable_protocols = OFPUTIL_P_ANY;
2214 for (i = 0; i < n_fms; i++) {
2215 const struct ofputil_flow_mod *fm = &fms[i];
2217 usable_protocols &= ofputil_usable_protocols(&fm->match);
2218 if (fm->table_id != 0xff) {
2219 usable_protocols &= OFPUTIL_P_TID;
2222 /* Matching of the cookie is only supported through NXM or OF1.1+. */
2223 if (fm->cookie_mask != htonll(0)) {
2224 usable_protocols &= (OFPUTIL_P_OF10_NXM_ANY
2225 | OFPUTIL_P_OF11_STD
2226 | OFPUTIL_P_OF12_OXM
2227 | OFPUTIL_P_OF13_OXM);
2231 return usable_protocols;
2235 ofputil_decode_ofpst10_flow_request(struct ofputil_flow_stats_request *fsr,
2236 const struct ofp10_flow_stats_request *ofsr,
2239 fsr->aggregate = aggregate;
2240 ofputil_match_from_ofp10_match(&ofsr->match, &fsr->match);
2241 fsr->out_port = u16_to_ofp(ntohs(ofsr->out_port));
2242 fsr->table_id = ofsr->table_id;
2243 fsr->cookie = fsr->cookie_mask = htonll(0);
2249 ofputil_decode_ofpst11_flow_request(struct ofputil_flow_stats_request *fsr,
2250 struct ofpbuf *b, bool aggregate)
2252 const struct ofp11_flow_stats_request *ofsr;
2255 ofsr = ofpbuf_pull(b, sizeof *ofsr);
2256 fsr->aggregate = aggregate;
2257 fsr->table_id = ofsr->table_id;
2258 error = ofputil_port_from_ofp11(ofsr->out_port, &fsr->out_port);
2262 if (ofsr->out_group != htonl(OFPG11_ANY)) {
2263 return OFPERR_OFPFMFC_UNKNOWN;
2265 fsr->cookie = ofsr->cookie;
2266 fsr->cookie_mask = ofsr->cookie_mask;
2267 error = ofputil_pull_ofp11_match(b, &fsr->match, NULL);
2276 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
2277 struct ofpbuf *b, bool aggregate)
2279 const struct nx_flow_stats_request *nfsr;
2282 nfsr = ofpbuf_pull(b, sizeof *nfsr);
2283 error = nx_pull_match(b, ntohs(nfsr->match_len), &fsr->match,
2284 &fsr->cookie, &fsr->cookie_mask);
2289 return OFPERR_OFPBRC_BAD_LEN;
2292 fsr->aggregate = aggregate;
2293 fsr->out_port = u16_to_ofp(ntohs(nfsr->out_port));
2294 fsr->table_id = nfsr->table_id;
2299 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
2300 * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
2301 * successful, otherwise an OpenFlow error code. */
2303 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
2304 const struct ofp_header *oh)
2309 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2310 raw = ofpraw_pull_assert(&b);
2311 switch ((int) raw) {
2312 case OFPRAW_OFPST10_FLOW_REQUEST:
2313 return ofputil_decode_ofpst10_flow_request(fsr, b.data, false);
2315 case OFPRAW_OFPST10_AGGREGATE_REQUEST:
2316 return ofputil_decode_ofpst10_flow_request(fsr, b.data, true);
2318 case OFPRAW_OFPST11_FLOW_REQUEST:
2319 return ofputil_decode_ofpst11_flow_request(fsr, &b, false);
2321 case OFPRAW_OFPST11_AGGREGATE_REQUEST:
2322 return ofputil_decode_ofpst11_flow_request(fsr, &b, true);
2324 case OFPRAW_NXST_FLOW_REQUEST:
2325 return ofputil_decode_nxst_flow_request(fsr, &b, false);
2327 case OFPRAW_NXST_AGGREGATE_REQUEST:
2328 return ofputil_decode_nxst_flow_request(fsr, &b, true);
2331 /* Hey, the caller lied. */
2336 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
2337 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
2338 * 'protocol', and returns the message. */
2340 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
2341 enum ofputil_protocol protocol)
2347 case OFPUTIL_P_OF11_STD:
2348 case OFPUTIL_P_OF12_OXM:
2349 case OFPUTIL_P_OF13_OXM: {
2350 struct ofp11_flow_stats_request *ofsr;
2352 raw = (fsr->aggregate
2353 ? OFPRAW_OFPST11_AGGREGATE_REQUEST
2354 : OFPRAW_OFPST11_FLOW_REQUEST);
2355 msg = ofpraw_alloc(raw, ofputil_protocol_to_ofp_version(protocol),
2356 ofputil_match_typical_len(protocol));
2357 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
2358 ofsr->table_id = fsr->table_id;
2359 ofsr->out_port = ofputil_port_to_ofp11(fsr->out_port);
2360 ofsr->out_group = htonl(OFPG11_ANY);
2361 ofsr->cookie = fsr->cookie;
2362 ofsr->cookie_mask = fsr->cookie_mask;
2363 ofputil_put_ofp11_match(msg, &fsr->match, protocol);
2367 case OFPUTIL_P_OF10_STD:
2368 case OFPUTIL_P_OF10_STD_TID: {
2369 struct ofp10_flow_stats_request *ofsr;
2371 raw = (fsr->aggregate
2372 ? OFPRAW_OFPST10_AGGREGATE_REQUEST
2373 : OFPRAW_OFPST10_FLOW_REQUEST);
2374 msg = ofpraw_alloc(raw, OFP10_VERSION, 0);
2375 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
2376 ofputil_match_to_ofp10_match(&fsr->match, &ofsr->match);
2377 ofsr->table_id = fsr->table_id;
2378 ofsr->out_port = htons(ofp_to_u16(fsr->out_port));
2382 case OFPUTIL_P_OF10_NXM:
2383 case OFPUTIL_P_OF10_NXM_TID: {
2384 struct nx_flow_stats_request *nfsr;
2387 raw = (fsr->aggregate
2388 ? OFPRAW_NXST_AGGREGATE_REQUEST
2389 : OFPRAW_NXST_FLOW_REQUEST);
2390 msg = ofpraw_alloc(raw, OFP10_VERSION, NXM_TYPICAL_LEN);
2391 ofpbuf_put_zeros(msg, sizeof *nfsr);
2392 match_len = nx_put_match(msg, &fsr->match,
2393 fsr->cookie, fsr->cookie_mask);
2396 nfsr->out_port = htons(ofp_to_u16(fsr->out_port));
2397 nfsr->match_len = htons(match_len);
2398 nfsr->table_id = fsr->table_id;
2409 /* Returns a bitmask with a 1-bit for each protocol that could be used to
2410 * accurately encode 'fsr', and a 0-bit for each protocol that is inadequate.
2412 * (The return value will have at least one 1-bit.) */
2413 enum ofputil_protocol
2414 ofputil_flow_stats_request_usable_protocols(
2415 const struct ofputil_flow_stats_request *fsr)
2417 enum ofputil_protocol usable_protocols;
2419 usable_protocols = ofputil_usable_protocols(&fsr->match);
2420 if (fsr->cookie_mask != htonll(0)) {
2421 usable_protocols &= OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
2422 | OFPUTIL_P_OF13_OXM;
2424 return usable_protocols;
2427 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
2428 * ofputil_flow_stats in 'fs'.
2430 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
2431 * OpenFlow message. Calling this function multiple times for a single 'msg'
2432 * iterates through the replies. The caller must initially leave 'msg''s layer
2433 * pointers null and not modify them between calls.
2435 * Most switches don't send the values needed to populate fs->idle_age and
2436 * fs->hard_age, so those members will usually be set to 0. If the switch from
2437 * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
2438 * 'flow_age_extension' as true so that the contents of 'msg' determine the
2439 * 'idle_age' and 'hard_age' members in 'fs'.
2441 * Uses 'ofpacts' to store the abstract OFPACT_* version of the flow stats
2442 * reply's actions. The caller must initialize 'ofpacts' and retains ownership
2443 * of it. 'fs->ofpacts' will point into the 'ofpacts' buffer.
2445 * Returns 0 if successful, EOF if no replies were left in this 'msg',
2446 * otherwise a positive errno value. */
2448 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
2450 bool flow_age_extension,
2451 struct ofpbuf *ofpacts)
2457 ? ofpraw_decode(&raw, msg->l2)
2458 : ofpraw_pull(&raw, msg));
2465 } else if (raw == OFPRAW_OFPST11_FLOW_REPLY
2466 || raw == OFPRAW_OFPST13_FLOW_REPLY) {
2467 const struct ofp11_flow_stats *ofs;
2469 uint16_t padded_match_len;
2471 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2473 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
2474 "bytes at end", msg->size);
2478 length = ntohs(ofs->length);
2479 if (length < sizeof *ofs) {
2480 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2481 "length %zu", length);
2485 if (ofputil_pull_ofp11_match(msg, &fs->match, &padded_match_len)) {
2486 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad match");
2490 if (ofpacts_pull_openflow11_instructions(msg, length - sizeof *ofs -
2491 padded_match_len, ofpacts)) {
2492 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad instructions");
2496 fs->priority = ntohs(ofs->priority);
2497 fs->table_id = ofs->table_id;
2498 fs->duration_sec = ntohl(ofs->duration_sec);
2499 fs->duration_nsec = ntohl(ofs->duration_nsec);
2500 fs->idle_timeout = ntohs(ofs->idle_timeout);
2501 fs->hard_timeout = ntohs(ofs->hard_timeout);
2502 fs->flags = (raw == OFPRAW_OFPST13_FLOW_REPLY) ? ntohs(ofs->flags) : 0;
2505 fs->cookie = ofs->cookie;
2506 fs->packet_count = ntohll(ofs->packet_count);
2507 fs->byte_count = ntohll(ofs->byte_count);
2508 } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
2509 const struct ofp10_flow_stats *ofs;
2512 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2514 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
2515 "bytes at end", msg->size);
2519 length = ntohs(ofs->length);
2520 if (length < sizeof *ofs) {
2521 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2522 "length %zu", length);
2526 if (ofpacts_pull_openflow10(msg, length - sizeof *ofs, ofpacts)) {
2530 fs->cookie = get_32aligned_be64(&ofs->cookie);
2531 ofputil_match_from_ofp10_match(&ofs->match, &fs->match);
2532 fs->priority = ntohs(ofs->priority);
2533 fs->table_id = ofs->table_id;
2534 fs->duration_sec = ntohl(ofs->duration_sec);
2535 fs->duration_nsec = ntohl(ofs->duration_nsec);
2536 fs->idle_timeout = ntohs(ofs->idle_timeout);
2537 fs->hard_timeout = ntohs(ofs->hard_timeout);
2540 fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
2541 fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
2543 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
2544 const struct nx_flow_stats *nfs;
2545 size_t match_len, actions_len, length;
2547 nfs = ofpbuf_try_pull(msg, sizeof *nfs);
2549 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
2550 "bytes at end", msg->size);
2554 length = ntohs(nfs->length);
2555 match_len = ntohs(nfs->match_len);
2556 if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
2557 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
2558 "claims invalid length %zu", match_len, length);
2561 if (nx_pull_match(msg, match_len, &fs->match, NULL, NULL)) {
2565 actions_len = length - sizeof *nfs - ROUND_UP(match_len, 8);
2566 if (ofpacts_pull_openflow10(msg, actions_len, ofpacts)) {
2570 fs->cookie = nfs->cookie;
2571 fs->table_id = nfs->table_id;
2572 fs->duration_sec = ntohl(nfs->duration_sec);
2573 fs->duration_nsec = ntohl(nfs->duration_nsec);
2574 fs->priority = ntohs(nfs->priority);
2575 fs->idle_timeout = ntohs(nfs->idle_timeout);
2576 fs->hard_timeout = ntohs(nfs->hard_timeout);
2579 if (flow_age_extension) {
2580 if (nfs->idle_age) {
2581 fs->idle_age = ntohs(nfs->idle_age) - 1;
2583 if (nfs->hard_age) {
2584 fs->hard_age = ntohs(nfs->hard_age) - 1;
2587 fs->packet_count = ntohll(nfs->packet_count);
2588 fs->byte_count = ntohll(nfs->byte_count);
2594 fs->ofpacts = ofpacts->data;
2595 fs->ofpacts_len = ofpacts->size;
2600 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
2602 * We use this in situations where OVS internally uses UINT64_MAX to mean
2603 * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
2605 unknown_to_zero(uint64_t count)
2607 return count != UINT64_MAX ? count : 0;
2610 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
2611 * those already present in the list of ofpbufs in 'replies'. 'replies' should
2612 * have been initialized with ofputil_start_stats_reply(). */
2614 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
2615 struct list *replies)
2617 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
2618 size_t start_ofs = reply->size;
2621 ofpraw_decode_partial(&raw, reply->data, reply->size);
2622 if (raw == OFPRAW_OFPST11_FLOW_REPLY || raw == OFPRAW_OFPST13_FLOW_REPLY) {
2623 struct ofp11_flow_stats *ofs;
2625 ofpbuf_put_uninit(reply, sizeof *ofs);
2626 oxm_put_match(reply, &fs->match);
2627 ofpacts_put_openflow11_instructions(fs->ofpacts, fs->ofpacts_len,
2630 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
2631 ofs->length = htons(reply->size - start_ofs);
2632 ofs->table_id = fs->table_id;
2634 ofs->duration_sec = htonl(fs->duration_sec);
2635 ofs->duration_nsec = htonl(fs->duration_nsec);
2636 ofs->priority = htons(fs->priority);
2637 ofs->idle_timeout = htons(fs->idle_timeout);
2638 ofs->hard_timeout = htons(fs->hard_timeout);
2639 ofs->flags = (raw == OFPRAW_OFPST13_FLOW_REPLY) ? htons(fs->flags) : 0;
2640 memset(ofs->pad2, 0, sizeof ofs->pad2);
2641 ofs->cookie = fs->cookie;
2642 ofs->packet_count = htonll(unknown_to_zero(fs->packet_count));
2643 ofs->byte_count = htonll(unknown_to_zero(fs->byte_count));
2644 } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
2645 struct ofp10_flow_stats *ofs;
2647 ofpbuf_put_uninit(reply, sizeof *ofs);
2648 ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
2650 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
2651 ofs->length = htons(reply->size - start_ofs);
2652 ofs->table_id = fs->table_id;
2654 ofputil_match_to_ofp10_match(&fs->match, &ofs->match);
2655 ofs->duration_sec = htonl(fs->duration_sec);
2656 ofs->duration_nsec = htonl(fs->duration_nsec);
2657 ofs->priority = htons(fs->priority);
2658 ofs->idle_timeout = htons(fs->idle_timeout);
2659 ofs->hard_timeout = htons(fs->hard_timeout);
2660 memset(ofs->pad2, 0, sizeof ofs->pad2);
2661 put_32aligned_be64(&ofs->cookie, fs->cookie);
2662 put_32aligned_be64(&ofs->packet_count,
2663 htonll(unknown_to_zero(fs->packet_count)));
2664 put_32aligned_be64(&ofs->byte_count,
2665 htonll(unknown_to_zero(fs->byte_count)));
2666 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
2667 struct nx_flow_stats *nfs;
2670 ofpbuf_put_uninit(reply, sizeof *nfs);
2671 match_len = nx_put_match(reply, &fs->match, 0, 0);
2672 ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
2674 nfs = ofpbuf_at_assert(reply, start_ofs, sizeof *nfs);
2675 nfs->length = htons(reply->size - start_ofs);
2676 nfs->table_id = fs->table_id;
2678 nfs->duration_sec = htonl(fs->duration_sec);
2679 nfs->duration_nsec = htonl(fs->duration_nsec);
2680 nfs->priority = htons(fs->priority);
2681 nfs->idle_timeout = htons(fs->idle_timeout);
2682 nfs->hard_timeout = htons(fs->hard_timeout);
2683 nfs->idle_age = htons(fs->idle_age < 0 ? 0
2684 : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
2686 nfs->hard_age = htons(fs->hard_age < 0 ? 0
2687 : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
2689 nfs->match_len = htons(match_len);
2690 nfs->cookie = fs->cookie;
2691 nfs->packet_count = htonll(fs->packet_count);
2692 nfs->byte_count = htonll(fs->byte_count);
2697 ofpmp_postappend(replies, start_ofs);
2700 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
2701 * NXST_AGGREGATE reply matching 'request', and returns the message. */
2703 ofputil_encode_aggregate_stats_reply(
2704 const struct ofputil_aggregate_stats *stats,
2705 const struct ofp_header *request)
2707 struct ofp_aggregate_stats_reply *asr;
2708 uint64_t packet_count;
2709 uint64_t byte_count;
2713 ofpraw_decode(&raw, request);
2714 if (raw == OFPRAW_OFPST10_AGGREGATE_REQUEST) {
2715 packet_count = unknown_to_zero(stats->packet_count);
2716 byte_count = unknown_to_zero(stats->byte_count);
2718 packet_count = stats->packet_count;
2719 byte_count = stats->byte_count;
2722 msg = ofpraw_alloc_stats_reply(request, 0);
2723 asr = ofpbuf_put_zeros(msg, sizeof *asr);
2724 put_32aligned_be64(&asr->packet_count, htonll(packet_count));
2725 put_32aligned_be64(&asr->byte_count, htonll(byte_count));
2726 asr->flow_count = htonl(stats->flow_count);
2732 ofputil_decode_aggregate_stats_reply(struct ofputil_aggregate_stats *stats,
2733 const struct ofp_header *reply)
2735 struct ofp_aggregate_stats_reply *asr;
2738 ofpbuf_use_const(&msg, reply, ntohs(reply->length));
2739 ofpraw_pull_assert(&msg);
2742 stats->packet_count = ntohll(get_32aligned_be64(&asr->packet_count));
2743 stats->byte_count = ntohll(get_32aligned_be64(&asr->byte_count));
2744 stats->flow_count = ntohl(asr->flow_count);
2749 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
2750 * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
2751 * an OpenFlow error code. */
2753 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
2754 const struct ofp_header *oh)
2759 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2760 raw = ofpraw_pull_assert(&b);
2761 if (raw == OFPRAW_OFPT11_FLOW_REMOVED) {
2762 const struct ofp12_flow_removed *ofr;
2765 ofr = ofpbuf_pull(&b, sizeof *ofr);
2767 error = ofputil_pull_ofp11_match(&b, &fr->match, NULL);
2772 fr->priority = ntohs(ofr->priority);
2773 fr->cookie = ofr->cookie;
2774 fr->reason = ofr->reason;
2775 fr->table_id = ofr->table_id;
2776 fr->duration_sec = ntohl(ofr->duration_sec);
2777 fr->duration_nsec = ntohl(ofr->duration_nsec);
2778 fr->idle_timeout = ntohs(ofr->idle_timeout);
2779 fr->hard_timeout = ntohs(ofr->hard_timeout);
2780 fr->packet_count = ntohll(ofr->packet_count);
2781 fr->byte_count = ntohll(ofr->byte_count);
2782 } else if (raw == OFPRAW_OFPT10_FLOW_REMOVED) {
2783 const struct ofp10_flow_removed *ofr;
2785 ofr = ofpbuf_pull(&b, sizeof *ofr);
2787 ofputil_match_from_ofp10_match(&ofr->match, &fr->match);
2788 fr->priority = ntohs(ofr->priority);
2789 fr->cookie = ofr->cookie;
2790 fr->reason = ofr->reason;
2792 fr->duration_sec = ntohl(ofr->duration_sec);
2793 fr->duration_nsec = ntohl(ofr->duration_nsec);
2794 fr->idle_timeout = ntohs(ofr->idle_timeout);
2795 fr->hard_timeout = 0;
2796 fr->packet_count = ntohll(ofr->packet_count);
2797 fr->byte_count = ntohll(ofr->byte_count);
2798 } else if (raw == OFPRAW_NXT_FLOW_REMOVED) {
2799 struct nx_flow_removed *nfr;
2802 nfr = ofpbuf_pull(&b, sizeof *nfr);
2803 error = nx_pull_match(&b, ntohs(nfr->match_len), &fr->match,
2809 return OFPERR_OFPBRC_BAD_LEN;
2812 fr->priority = ntohs(nfr->priority);
2813 fr->cookie = nfr->cookie;
2814 fr->reason = nfr->reason;
2815 fr->table_id = nfr->table_id ? nfr->table_id - 1 : 255;
2816 fr->duration_sec = ntohl(nfr->duration_sec);
2817 fr->duration_nsec = ntohl(nfr->duration_nsec);
2818 fr->idle_timeout = ntohs(nfr->idle_timeout);
2819 fr->hard_timeout = 0;
2820 fr->packet_count = ntohll(nfr->packet_count);
2821 fr->byte_count = ntohll(nfr->byte_count);
2829 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
2830 * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
2833 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
2834 enum ofputil_protocol protocol)
2839 case OFPUTIL_P_OF11_STD:
2840 case OFPUTIL_P_OF12_OXM:
2841 case OFPUTIL_P_OF13_OXM: {
2842 struct ofp12_flow_removed *ofr;
2844 msg = ofpraw_alloc_xid(OFPRAW_OFPT11_FLOW_REMOVED,
2845 ofputil_protocol_to_ofp_version(protocol),
2847 ofputil_match_typical_len(protocol));
2848 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
2849 ofr->cookie = fr->cookie;
2850 ofr->priority = htons(fr->priority);
2851 ofr->reason = fr->reason;
2852 ofr->table_id = fr->table_id;
2853 ofr->duration_sec = htonl(fr->duration_sec);
2854 ofr->duration_nsec = htonl(fr->duration_nsec);
2855 ofr->idle_timeout = htons(fr->idle_timeout);
2856 ofr->hard_timeout = htons(fr->hard_timeout);
2857 ofr->packet_count = htonll(fr->packet_count);
2858 ofr->byte_count = htonll(fr->byte_count);
2859 ofputil_put_ofp11_match(msg, &fr->match, protocol);
2863 case OFPUTIL_P_OF10_STD:
2864 case OFPUTIL_P_OF10_STD_TID: {
2865 struct ofp10_flow_removed *ofr;
2867 msg = ofpraw_alloc_xid(OFPRAW_OFPT10_FLOW_REMOVED, OFP10_VERSION,
2869 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
2870 ofputil_match_to_ofp10_match(&fr->match, &ofr->match);
2871 ofr->cookie = fr->cookie;
2872 ofr->priority = htons(fr->priority);
2873 ofr->reason = fr->reason;
2874 ofr->duration_sec = htonl(fr->duration_sec);
2875 ofr->duration_nsec = htonl(fr->duration_nsec);
2876 ofr->idle_timeout = htons(fr->idle_timeout);
2877 ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
2878 ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
2882 case OFPUTIL_P_OF10_NXM:
2883 case OFPUTIL_P_OF10_NXM_TID: {
2884 struct nx_flow_removed *nfr;
2887 msg = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_REMOVED, OFP10_VERSION,
2888 htonl(0), NXM_TYPICAL_LEN);
2889 nfr = ofpbuf_put_zeros(msg, sizeof *nfr);
2890 match_len = nx_put_match(msg, &fr->match, 0, 0);
2893 nfr->cookie = fr->cookie;
2894 nfr->priority = htons(fr->priority);
2895 nfr->reason = fr->reason;
2896 nfr->table_id = fr->table_id + 1;
2897 nfr->duration_sec = htonl(fr->duration_sec);
2898 nfr->duration_nsec = htonl(fr->duration_nsec);
2899 nfr->idle_timeout = htons(fr->idle_timeout);
2900 nfr->match_len = htons(match_len);
2901 nfr->packet_count = htonll(fr->packet_count);
2902 nfr->byte_count = htonll(fr->byte_count);
2914 ofputil_decode_packet_in_finish(struct ofputil_packet_in *pin,
2915 struct match *match, struct ofpbuf *b)
2917 pin->packet = b->data;
2918 pin->packet_len = b->size;
2920 pin->fmd.in_port = match->flow.in_port.ofp_port;
2921 pin->fmd.tun_id = match->flow.tunnel.tun_id;
2922 pin->fmd.tun_src = match->flow.tunnel.ip_src;
2923 pin->fmd.tun_dst = match->flow.tunnel.ip_dst;
2924 pin->fmd.metadata = match->flow.metadata;
2925 memcpy(pin->fmd.regs, match->flow.regs, sizeof pin->fmd.regs);
2926 pin->fmd.pkt_mark = match->flow.pkt_mark;
2930 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
2931 const struct ofp_header *oh)
2936 memset(pin, 0, sizeof *pin);
2938 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2939 raw = ofpraw_pull_assert(&b);
2940 if (raw == OFPRAW_OFPT13_PACKET_IN || raw == OFPRAW_OFPT12_PACKET_IN) {
2941 const struct ofp13_packet_in *opi;
2944 size_t packet_in_size;
2946 if (raw == OFPRAW_OFPT12_PACKET_IN) {
2947 packet_in_size = sizeof (struct ofp12_packet_in);
2949 packet_in_size = sizeof (struct ofp13_packet_in);
2952 opi = ofpbuf_pull(&b, packet_in_size);
2953 error = oxm_pull_match_loose(&b, &match);
2958 if (!ofpbuf_try_pull(&b, 2)) {
2959 return OFPERR_OFPBRC_BAD_LEN;
2962 pin->reason = opi->pi.reason;
2963 pin->table_id = opi->pi.table_id;
2964 pin->buffer_id = ntohl(opi->pi.buffer_id);
2965 pin->total_len = ntohs(opi->pi.total_len);
2967 if (raw == OFPRAW_OFPT13_PACKET_IN) {
2968 pin->cookie = opi->cookie;
2971 ofputil_decode_packet_in_finish(pin, &match, &b);
2972 } else if (raw == OFPRAW_OFPT10_PACKET_IN) {
2973 const struct ofp10_packet_in *opi;
2975 opi = ofpbuf_pull(&b, offsetof(struct ofp10_packet_in, data));
2977 pin->packet = opi->data;
2978 pin->packet_len = b.size;
2980 pin->fmd.in_port = u16_to_ofp(ntohs(opi->in_port));
2981 pin->reason = opi->reason;
2982 pin->buffer_id = ntohl(opi->buffer_id);
2983 pin->total_len = ntohs(opi->total_len);
2984 } else if (raw == OFPRAW_NXT_PACKET_IN) {
2985 const struct nx_packet_in *npi;
2989 npi = ofpbuf_pull(&b, sizeof *npi);
2990 error = nx_pull_match_loose(&b, ntohs(npi->match_len), &match, NULL,
2996 if (!ofpbuf_try_pull(&b, 2)) {
2997 return OFPERR_OFPBRC_BAD_LEN;
3000 pin->reason = npi->reason;
3001 pin->table_id = npi->table_id;
3002 pin->cookie = npi->cookie;
3004 pin->buffer_id = ntohl(npi->buffer_id);
3005 pin->total_len = ntohs(npi->total_len);
3007 ofputil_decode_packet_in_finish(pin, &match, &b);
3016 ofputil_packet_in_to_match(const struct ofputil_packet_in *pin,
3017 struct match *match)
3021 match_init_catchall(match);
3022 if (pin->fmd.tun_id != htonll(0)) {
3023 match_set_tun_id(match, pin->fmd.tun_id);
3025 if (pin->fmd.tun_src != htonl(0)) {
3026 match_set_tun_src(match, pin->fmd.tun_src);
3028 if (pin->fmd.tun_dst != htonl(0)) {
3029 match_set_tun_dst(match, pin->fmd.tun_dst);
3031 if (pin->fmd.metadata != htonll(0)) {
3032 match_set_metadata(match, pin->fmd.metadata);
3035 for (i = 0; i < FLOW_N_REGS; i++) {
3036 if (pin->fmd.regs[i]) {
3037 match_set_reg(match, i, pin->fmd.regs[i]);
3041 if (pin->fmd.pkt_mark != 0) {
3042 match_set_pkt_mark(match, pin->fmd.pkt_mark);
3045 match_set_in_port(match, pin->fmd.in_port);
3048 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
3049 * in the format specified by 'packet_in_format'. */
3051 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
3052 enum ofputil_protocol protocol,
3053 enum nx_packet_in_format packet_in_format)
3055 size_t send_len = MIN(pin->send_len, pin->packet_len);
3056 struct ofpbuf *packet;
3058 /* Add OFPT_PACKET_IN. */
3059 if (protocol == OFPUTIL_P_OF13_OXM || protocol == OFPUTIL_P_OF12_OXM) {
3060 struct ofp13_packet_in *opi;
3062 enum ofpraw packet_in_raw;
3063 enum ofp_version packet_in_version;
3064 size_t packet_in_size;
3066 if (protocol == OFPUTIL_P_OF12_OXM) {
3067 packet_in_raw = OFPRAW_OFPT12_PACKET_IN;
3068 packet_in_version = OFP12_VERSION;
3069 packet_in_size = sizeof (struct ofp12_packet_in);
3071 packet_in_raw = OFPRAW_OFPT13_PACKET_IN;
3072 packet_in_version = OFP13_VERSION;
3073 packet_in_size = sizeof (struct ofp13_packet_in);
3076 ofputil_packet_in_to_match(pin, &match);
3078 /* The final argument is just an estimate of the space required. */
3079 packet = ofpraw_alloc_xid(packet_in_raw, packet_in_version,
3080 htonl(0), (sizeof(struct flow_metadata) * 2
3082 ofpbuf_put_zeros(packet, packet_in_size);
3083 oxm_put_match(packet, &match);
3084 ofpbuf_put_zeros(packet, 2);
3085 ofpbuf_put(packet, pin->packet, send_len);
3088 opi->pi.buffer_id = htonl(pin->buffer_id);
3089 opi->pi.total_len = htons(pin->total_len);
3090 opi->pi.reason = pin->reason;
3091 opi->pi.table_id = pin->table_id;
3092 if (protocol == OFPUTIL_P_OF13_OXM) {
3093 opi->cookie = pin->cookie;
3095 } else if (packet_in_format == NXPIF_OPENFLOW10) {
3096 struct ofp10_packet_in *opi;
3098 packet = ofpraw_alloc_xid(OFPRAW_OFPT10_PACKET_IN, OFP10_VERSION,
3099 htonl(0), send_len);
3100 opi = ofpbuf_put_zeros(packet, offsetof(struct ofp10_packet_in, data));
3101 opi->total_len = htons(pin->total_len);
3102 opi->in_port = htons(ofp_to_u16(pin->fmd.in_port));
3103 opi->reason = pin->reason;
3104 opi->buffer_id = htonl(pin->buffer_id);
3106 ofpbuf_put(packet, pin->packet, send_len);
3107 } else if (packet_in_format == NXPIF_NXM) {
3108 struct nx_packet_in *npi;
3112 ofputil_packet_in_to_match(pin, &match);
3114 /* The final argument is just an estimate of the space required. */
3115 packet = ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN, OFP10_VERSION,
3116 htonl(0), (sizeof(struct flow_metadata) * 2
3118 ofpbuf_put_zeros(packet, sizeof *npi);
3119 match_len = nx_put_match(packet, &match, 0, 0);
3120 ofpbuf_put_zeros(packet, 2);
3121 ofpbuf_put(packet, pin->packet, send_len);
3124 npi->buffer_id = htonl(pin->buffer_id);
3125 npi->total_len = htons(pin->total_len);
3126 npi->reason = pin->reason;
3127 npi->table_id = pin->table_id;
3128 npi->cookie = pin->cookie;
3129 npi->match_len = htons(match_len);
3133 ofpmsg_update_length(packet);
3138 /* Returns a string form of 'reason'. The return value is either a statically
3139 * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
3140 * 'bufsize' should be at least OFPUTIL_PACKET_IN_REASON_BUFSIZE. */
3142 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason,
3143 char *reasonbuf, size_t bufsize)
3150 case OFPR_INVALID_TTL:
3151 return "invalid_ttl";
3153 case OFPR_N_REASONS:
3155 snprintf(reasonbuf, bufsize, "%d", (int) reason);
3161 ofputil_packet_in_reason_from_string(const char *s,
3162 enum ofp_packet_in_reason *reason)
3166 for (i = 0; i < OFPR_N_REASONS; i++) {
3167 char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
3168 const char *reason_s;
3170 reason_s = ofputil_packet_in_reason_to_string(i, reasonbuf,
3172 if (!strcasecmp(s, reason_s)) {
3180 /* Converts an OFPT_PACKET_OUT in 'opo' into an abstract ofputil_packet_out in
3183 * Uses 'ofpacts' to store the abstract OFPACT_* version of the packet out
3184 * message's actions. The caller must initialize 'ofpacts' and retains
3185 * ownership of it. 'po->ofpacts' will point into the 'ofpacts' buffer.
3187 * Returns 0 if successful, otherwise an OFPERR_* value. */
3189 ofputil_decode_packet_out(struct ofputil_packet_out *po,
3190 const struct ofp_header *oh,
3191 struct ofpbuf *ofpacts)
3196 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3197 raw = ofpraw_pull_assert(&b);
3199 if (raw == OFPRAW_OFPT11_PACKET_OUT) {
3201 const struct ofp11_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
3203 po->buffer_id = ntohl(opo->buffer_id);
3204 error = ofputil_port_from_ofp11(opo->in_port, &po->in_port);
3209 error = ofpacts_pull_openflow11_actions(&b, ntohs(opo->actions_len),
3214 } else if (raw == OFPRAW_OFPT10_PACKET_OUT) {
3216 const struct ofp10_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
3218 po->buffer_id = ntohl(opo->buffer_id);
3219 po->in_port = u16_to_ofp(ntohs(opo->in_port));
3221 error = ofpacts_pull_openflow10(&b, ntohs(opo->actions_len), ofpacts);
3229 if (ofp_to_u16(po->in_port) >= ofp_to_u16(OFPP_MAX)
3230 && po->in_port != OFPP_LOCAL
3231 && po->in_port != OFPP_NONE && po->in_port != OFPP_CONTROLLER) {
3232 VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
3234 return OFPERR_OFPBRC_BAD_PORT;
3237 po->ofpacts = ofpacts->data;
3238 po->ofpacts_len = ofpacts->size;
3240 if (po->buffer_id == UINT32_MAX) {
3241 po->packet = b.data;
3242 po->packet_len = b.size;
3251 /* ofputil_phy_port */
3253 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
3254 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
3255 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
3256 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
3257 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
3258 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
3259 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
3260 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
3262 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
3263 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
3264 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
3265 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
3266 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
3267 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
3269 static enum netdev_features
3270 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
3272 uint32_t ofp10 = ntohl(ofp10_);
3273 return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
3277 netdev_port_features_to_ofp10(enum netdev_features features)
3279 return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
3282 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
3283 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
3284 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
3285 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
3286 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
3287 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
3288 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
3289 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD == OFPPF11_40GB_FD); /* bit 7 */
3290 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD == OFPPF11_100GB_FD); /* bit 8 */
3291 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD == OFPPF11_1TB_FD); /* bit 9 */
3292 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER == OFPPF11_OTHER); /* bit 10 */
3293 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == OFPPF11_COPPER); /* bit 11 */
3294 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == OFPPF11_FIBER); /* bit 12 */
3295 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == OFPPF11_AUTONEG); /* bit 13 */
3296 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == OFPPF11_PAUSE); /* bit 14 */
3297 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
3299 static enum netdev_features
3300 netdev_port_features_from_ofp11(ovs_be32 ofp11)
3302 return ntohl(ofp11) & 0xffff;
3306 netdev_port_features_to_ofp11(enum netdev_features features)
3308 return htonl(features & 0xffff);
3312 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
3313 const struct ofp10_phy_port *opp)
3315 memset(pp, 0, sizeof *pp);
3317 pp->port_no = u16_to_ofp(ntohs(opp->port_no));
3318 memcpy(pp->hw_addr, opp->hw_addr, OFP_ETH_ALEN);
3319 ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
3321 pp->config = ntohl(opp->config) & OFPPC10_ALL;
3322 pp->state = ntohl(opp->state) & OFPPS10_ALL;
3324 pp->curr = netdev_port_features_from_ofp10(opp->curr);
3325 pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
3326 pp->supported = netdev_port_features_from_ofp10(opp->supported);
3327 pp->peer = netdev_port_features_from_ofp10(opp->peer);
3329 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
3330 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
3336 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
3337 const struct ofp11_port *op)
3341 memset(pp, 0, sizeof *pp);
3343 error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
3347 memcpy(pp->hw_addr, op->hw_addr, OFP_ETH_ALEN);
3348 ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
3350 pp->config = ntohl(op->config) & OFPPC11_ALL;
3351 pp->state = ntohl(op->state) & OFPPC11_ALL;
3353 pp->curr = netdev_port_features_from_ofp11(op->curr);
3354 pp->advertised = netdev_port_features_from_ofp11(op->advertised);
3355 pp->supported = netdev_port_features_from_ofp11(op->supported);
3356 pp->peer = netdev_port_features_from_ofp11(op->peer);
3358 pp->curr_speed = ntohl(op->curr_speed);
3359 pp->max_speed = ntohl(op->max_speed);
3365 ofputil_get_phy_port_size(enum ofp_version ofp_version)
3367 switch (ofp_version) {
3369 return sizeof(struct ofp10_phy_port);
3373 return sizeof(struct ofp11_port);
3380 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
3381 struct ofp10_phy_port *opp)
3383 memset(opp, 0, sizeof *opp);
3385 opp->port_no = htons(ofp_to_u16(pp->port_no));
3386 memcpy(opp->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
3387 ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
3389 opp->config = htonl(pp->config & OFPPC10_ALL);
3390 opp->state = htonl(pp->state & OFPPS10_ALL);
3392 opp->curr = netdev_port_features_to_ofp10(pp->curr);
3393 opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
3394 opp->supported = netdev_port_features_to_ofp10(pp->supported);
3395 opp->peer = netdev_port_features_to_ofp10(pp->peer);
3399 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
3400 struct ofp11_port *op)
3402 memset(op, 0, sizeof *op);
3404 op->port_no = ofputil_port_to_ofp11(pp->port_no);
3405 memcpy(op->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
3406 ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
3408 op->config = htonl(pp->config & OFPPC11_ALL);
3409 op->state = htonl(pp->state & OFPPS11_ALL);
3411 op->curr = netdev_port_features_to_ofp11(pp->curr);
3412 op->advertised = netdev_port_features_to_ofp11(pp->advertised);
3413 op->supported = netdev_port_features_to_ofp11(pp->supported);
3414 op->peer = netdev_port_features_to_ofp11(pp->peer);
3416 op->curr_speed = htonl(pp->curr_speed);
3417 op->max_speed = htonl(pp->max_speed);
3421 ofputil_put_phy_port(enum ofp_version ofp_version,
3422 const struct ofputil_phy_port *pp, struct ofpbuf *b)
3424 switch (ofp_version) {
3425 case OFP10_VERSION: {
3426 struct ofp10_phy_port *opp;
3427 if (b->size + sizeof *opp <= UINT16_MAX) {
3428 opp = ofpbuf_put_uninit(b, sizeof *opp);
3429 ofputil_encode_ofp10_phy_port(pp, opp);
3436 case OFP13_VERSION: {
3437 struct ofp11_port *op;
3438 if (b->size + sizeof *op <= UINT16_MAX) {
3439 op = ofpbuf_put_uninit(b, sizeof *op);
3440 ofputil_encode_ofp11_port(pp, op);
3451 ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
3452 const struct ofputil_phy_port *pp,
3453 struct list *replies)
3455 switch (ofp_version) {
3456 case OFP10_VERSION: {
3457 struct ofp10_phy_port *opp;
3459 opp = ofpmp_append(replies, sizeof *opp);
3460 ofputil_encode_ofp10_phy_port(pp, opp);
3466 case OFP13_VERSION: {
3467 struct ofp11_port *op;
3469 op = ofpmp_append(replies, sizeof *op);
3470 ofputil_encode_ofp11_port(pp, op);
3479 /* ofputil_switch_features */
3481 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
3482 OFPC_IP_REASM | OFPC_QUEUE_STATS)
3483 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
3484 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
3485 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
3486 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
3487 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
3488 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
3490 struct ofputil_action_bit_translation {
3491 enum ofputil_action_bitmap ofputil_bit;
3495 static const struct ofputil_action_bit_translation of10_action_bits[] = {
3496 { OFPUTIL_A_OUTPUT, OFPAT10_OUTPUT },
3497 { OFPUTIL_A_SET_VLAN_VID, OFPAT10_SET_VLAN_VID },
3498 { OFPUTIL_A_SET_VLAN_PCP, OFPAT10_SET_VLAN_PCP },
3499 { OFPUTIL_A_STRIP_VLAN, OFPAT10_STRIP_VLAN },
3500 { OFPUTIL_A_SET_DL_SRC, OFPAT10_SET_DL_SRC },
3501 { OFPUTIL_A_SET_DL_DST, OFPAT10_SET_DL_DST },
3502 { OFPUTIL_A_SET_NW_SRC, OFPAT10_SET_NW_SRC },
3503 { OFPUTIL_A_SET_NW_DST, OFPAT10_SET_NW_DST },
3504 { OFPUTIL_A_SET_NW_TOS, OFPAT10_SET_NW_TOS },
3505 { OFPUTIL_A_SET_TP_SRC, OFPAT10_SET_TP_SRC },
3506 { OFPUTIL_A_SET_TP_DST, OFPAT10_SET_TP_DST },
3507 { OFPUTIL_A_ENQUEUE, OFPAT10_ENQUEUE },
3511 static enum ofputil_action_bitmap
3512 decode_action_bits(ovs_be32 of_actions,
3513 const struct ofputil_action_bit_translation *x)
3515 enum ofputil_action_bitmap ofputil_actions;
3517 ofputil_actions = 0;
3518 for (; x->ofputil_bit; x++) {
3519 if (of_actions & htonl(1u << x->of_bit)) {
3520 ofputil_actions |= x->ofputil_bit;
3523 return ofputil_actions;
3527 ofputil_capabilities_mask(enum ofp_version ofp_version)
3529 /* Handle capabilities whose bit is unique for all Open Flow versions */
3530 switch (ofp_version) {
3533 return OFPC_COMMON | OFPC_ARP_MATCH_IP;
3536 return OFPC_COMMON | OFPC12_PORT_BLOCKED;
3538 /* Caller needs to check osf->header.version itself */
3543 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
3544 * abstract representation in '*features'. Initializes '*b' to iterate over
3545 * the OpenFlow port structures following 'osf' with later calls to
3546 * ofputil_pull_phy_port(). Returns 0 if successful, otherwise an
3547 * OFPERR_* value. */
3549 ofputil_decode_switch_features(const struct ofp_header *oh,
3550 struct ofputil_switch_features *features,
3553 const struct ofp_switch_features *osf;
3556 ofpbuf_use_const(b, oh, ntohs(oh->length));
3557 raw = ofpraw_pull_assert(b);
3559 osf = ofpbuf_pull(b, sizeof *osf);
3560 features->datapath_id = ntohll(osf->datapath_id);
3561 features->n_buffers = ntohl(osf->n_buffers);
3562 features->n_tables = osf->n_tables;
3563 features->auxiliary_id = 0;
3565 features->capabilities = ntohl(osf->capabilities) &
3566 ofputil_capabilities_mask(oh->version);
3568 if (b->size % ofputil_get_phy_port_size(oh->version)) {
3569 return OFPERR_OFPBRC_BAD_LEN;
3572 if (raw == OFPRAW_OFPT10_FEATURES_REPLY) {
3573 if (osf->capabilities & htonl(OFPC10_STP)) {
3574 features->capabilities |= OFPUTIL_C_STP;
3576 features->actions = decode_action_bits(osf->actions, of10_action_bits);
3577 } else if (raw == OFPRAW_OFPT11_FEATURES_REPLY
3578 || raw == OFPRAW_OFPT13_FEATURES_REPLY) {
3579 if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
3580 features->capabilities |= OFPUTIL_C_GROUP_STATS;
3582 features->actions = 0;
3583 if (raw == OFPRAW_OFPT13_FEATURES_REPLY) {
3584 features->auxiliary_id = osf->auxiliary_id;
3587 return OFPERR_OFPBRC_BAD_VERSION;
3593 /* Returns true if the maximum number of ports are in 'oh'. */
3595 max_ports_in_features(const struct ofp_header *oh)
3597 size_t pp_size = ofputil_get_phy_port_size(oh->version);
3598 return ntohs(oh->length) + pp_size > UINT16_MAX;
3601 /* Given a buffer 'b' that contains a Features Reply message, checks if
3602 * it contains the maximum number of ports that will fit. If so, it
3603 * returns true and removes the ports from the message. The caller
3604 * should then send an OFPST_PORT_DESC stats request to get the ports,
3605 * since the switch may have more ports than could be represented in the
3606 * Features Reply. Otherwise, returns false.
3609 ofputil_switch_features_ports_trunc(struct ofpbuf *b)
3611 struct ofp_header *oh = b->data;
3613 if (max_ports_in_features(oh)) {
3614 /* Remove all the ports. */
3615 b->size = (sizeof(struct ofp_header)
3616 + sizeof(struct ofp_switch_features));
3617 ofpmsg_update_length(b);
3626 encode_action_bits(enum ofputil_action_bitmap ofputil_actions,
3627 const struct ofputil_action_bit_translation *x)
3629 uint32_t of_actions;
3632 for (; x->ofputil_bit; x++) {
3633 if (ofputil_actions & x->ofputil_bit) {
3634 of_actions |= 1 << x->of_bit;
3637 return htonl(of_actions);
3640 /* Returns a buffer owned by the caller that encodes 'features' in the format
3641 * required by 'protocol' with the given 'xid'. The caller should append port
3642 * information to the buffer with subsequent calls to
3643 * ofputil_put_switch_features_port(). */
3645 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
3646 enum ofputil_protocol protocol, ovs_be32 xid)
3648 struct ofp_switch_features *osf;
3650 enum ofp_version version;
3653 version = ofputil_protocol_to_ofp_version(protocol);
3656 raw = OFPRAW_OFPT10_FEATURES_REPLY;
3660 raw = OFPRAW_OFPT11_FEATURES_REPLY;
3663 raw = OFPRAW_OFPT13_FEATURES_REPLY;
3668 b = ofpraw_alloc_xid(raw, version, xid, 0);
3669 osf = ofpbuf_put_zeros(b, sizeof *osf);
3670 osf->datapath_id = htonll(features->datapath_id);
3671 osf->n_buffers = htonl(features->n_buffers);
3672 osf->n_tables = features->n_tables;
3674 osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
3675 osf->capabilities = htonl(features->capabilities &
3676 ofputil_capabilities_mask(version));
3679 if (features->capabilities & OFPUTIL_C_STP) {
3680 osf->capabilities |= htonl(OFPC10_STP);
3682 osf->actions = encode_action_bits(features->actions, of10_action_bits);
3685 osf->auxiliary_id = features->auxiliary_id;
3689 if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
3690 osf->capabilities |= htonl(OFPC11_GROUP_STATS);
3700 /* Encodes 'pp' into the format required by the switch_features message already
3701 * in 'b', which should have been returned by ofputil_encode_switch_features(),
3702 * and appends the encoded version to 'b'. */
3704 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
3707 const struct ofp_header *oh = b->data;
3709 if (oh->version < OFP13_VERSION) {
3710 ofputil_put_phy_port(oh->version, pp, b);
3714 /* ofputil_port_status */
3716 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
3717 * in '*ps'. Returns 0 if successful, otherwise an OFPERR_* value. */
3719 ofputil_decode_port_status(const struct ofp_header *oh,
3720 struct ofputil_port_status *ps)
3722 const struct ofp_port_status *ops;
3726 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3727 ofpraw_pull_assert(&b);
3728 ops = ofpbuf_pull(&b, sizeof *ops);
3730 if (ops->reason != OFPPR_ADD &&
3731 ops->reason != OFPPR_DELETE &&
3732 ops->reason != OFPPR_MODIFY) {
3733 return OFPERR_NXBRC_BAD_REASON;
3735 ps->reason = ops->reason;
3737 retval = ofputil_pull_phy_port(oh->version, &b, &ps->desc);
3738 ovs_assert(retval != EOF);
3742 /* Converts the abstract form of a "port status" message in '*ps' into an
3743 * OpenFlow message suitable for 'protocol', and returns that encoded form in
3744 * a buffer owned by the caller. */
3746 ofputil_encode_port_status(const struct ofputil_port_status *ps,
3747 enum ofputil_protocol protocol)
3749 struct ofp_port_status *ops;
3751 enum ofp_version version;
3754 version = ofputil_protocol_to_ofp_version(protocol);
3757 raw = OFPRAW_OFPT10_PORT_STATUS;
3763 raw = OFPRAW_OFPT11_PORT_STATUS;
3770 b = ofpraw_alloc_xid(raw, version, htonl(0), 0);
3771 ops = ofpbuf_put_zeros(b, sizeof *ops);
3772 ops->reason = ps->reason;
3773 ofputil_put_phy_port(version, &ps->desc, b);
3774 ofpmsg_update_length(b);
3778 /* ofputil_port_mod */
3780 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
3781 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
3783 ofputil_decode_port_mod(const struct ofp_header *oh,
3784 struct ofputil_port_mod *pm)
3789 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3790 raw = ofpraw_pull_assert(&b);
3792 if (raw == OFPRAW_OFPT10_PORT_MOD) {
3793 const struct ofp10_port_mod *opm = b.data;
3795 pm->port_no = u16_to_ofp(ntohs(opm->port_no));
3796 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
3797 pm->config = ntohl(opm->config) & OFPPC10_ALL;
3798 pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
3799 pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
3800 } else if (raw == OFPRAW_OFPT11_PORT_MOD) {
3801 const struct ofp11_port_mod *opm = b.data;
3804 error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
3809 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
3810 pm->config = ntohl(opm->config) & OFPPC11_ALL;
3811 pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
3812 pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
3814 return OFPERR_OFPBRC_BAD_TYPE;
3817 pm->config &= pm->mask;
3821 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
3822 * message suitable for 'protocol', and returns that encoded form in a buffer
3823 * owned by the caller. */
3825 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
3826 enum ofputil_protocol protocol)
3828 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
3831 switch (ofp_version) {
3832 case OFP10_VERSION: {
3833 struct ofp10_port_mod *opm;
3835 b = ofpraw_alloc(OFPRAW_OFPT10_PORT_MOD, ofp_version, 0);
3836 opm = ofpbuf_put_zeros(b, sizeof *opm);
3837 opm->port_no = htons(ofp_to_u16(pm->port_no));
3838 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
3839 opm->config = htonl(pm->config & OFPPC10_ALL);
3840 opm->mask = htonl(pm->mask & OFPPC10_ALL);
3841 opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
3847 case OFP13_VERSION: {
3848 struct ofp11_port_mod *opm;
3850 b = ofpraw_alloc(OFPRAW_OFPT11_PORT_MOD, ofp_version, 0);
3851 opm = ofpbuf_put_zeros(b, sizeof *opm);
3852 opm->port_no = ofputil_port_to_ofp11(pm->port_no);
3853 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
3854 opm->config = htonl(pm->config & OFPPC11_ALL);
3855 opm->mask = htonl(pm->mask & OFPPC11_ALL);
3856 opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
3867 /* ofputil_role_request */
3869 /* Decodes the OpenFlow "role request" or "role reply" message in '*oh' into
3870 * an abstract form in '*rr'. Returns 0 if successful, otherwise an
3871 * OFPERR_* value. */
3873 ofputil_decode_role_message(const struct ofp_header *oh,
3874 struct ofputil_role_request *rr)
3879 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3880 raw = ofpraw_pull_assert(&b);
3882 if (raw == OFPRAW_OFPT12_ROLE_REQUEST ||
3883 raw == OFPRAW_OFPT12_ROLE_REPLY) {
3884 const struct ofp12_role_request *orr = b.l3;
3886 if (orr->role != htonl(OFPCR12_ROLE_NOCHANGE) &&
3887 orr->role != htonl(OFPCR12_ROLE_EQUAL) &&
3888 orr->role != htonl(OFPCR12_ROLE_MASTER) &&
3889 orr->role != htonl(OFPCR12_ROLE_SLAVE)) {
3890 return OFPERR_OFPRRFC_BAD_ROLE;
3893 rr->role = ntohl(orr->role);
3894 if (raw == OFPRAW_OFPT12_ROLE_REQUEST
3895 ? orr->role == htonl(OFPCR12_ROLE_NOCHANGE)
3896 : orr->generation_id == htonll(UINT64_MAX)) {
3897 rr->have_generation_id = false;
3898 rr->generation_id = 0;
3900 rr->have_generation_id = true;
3901 rr->generation_id = ntohll(orr->generation_id);
3903 } else if (raw == OFPRAW_NXT_ROLE_REQUEST ||
3904 raw == OFPRAW_NXT_ROLE_REPLY) {
3905 const struct nx_role_request *nrr = b.l3;
3907 BUILD_ASSERT(NX_ROLE_OTHER + 1 == OFPCR12_ROLE_EQUAL);
3908 BUILD_ASSERT(NX_ROLE_MASTER + 1 == OFPCR12_ROLE_MASTER);
3909 BUILD_ASSERT(NX_ROLE_SLAVE + 1 == OFPCR12_ROLE_SLAVE);
3911 if (nrr->role != htonl(NX_ROLE_OTHER) &&
3912 nrr->role != htonl(NX_ROLE_MASTER) &&
3913 nrr->role != htonl(NX_ROLE_SLAVE)) {
3914 return OFPERR_OFPRRFC_BAD_ROLE;
3917 rr->role = ntohl(nrr->role) + 1;
3918 rr->have_generation_id = false;
3919 rr->generation_id = 0;
3927 /* Returns an encoded form of a role reply suitable for the "request" in a
3928 * buffer owned by the caller. */
3930 ofputil_encode_role_reply(const struct ofp_header *request,
3931 const struct ofputil_role_request *rr)
3936 raw = ofpraw_decode_assert(request);
3937 if (raw == OFPRAW_OFPT12_ROLE_REQUEST) {
3938 struct ofp12_role_request *orr;
3940 buf = ofpraw_alloc_reply(OFPRAW_OFPT12_ROLE_REPLY, request, 0);
3941 orr = ofpbuf_put_zeros(buf, sizeof *orr);
3943 orr->role = htonl(rr->role);
3944 orr->generation_id = htonll(rr->have_generation_id
3947 } else if (raw == OFPRAW_NXT_ROLE_REQUEST) {
3948 struct nx_role_request *nrr;
3950 BUILD_ASSERT(NX_ROLE_OTHER == OFPCR12_ROLE_EQUAL - 1);
3951 BUILD_ASSERT(NX_ROLE_MASTER == OFPCR12_ROLE_MASTER - 1);
3952 BUILD_ASSERT(NX_ROLE_SLAVE == OFPCR12_ROLE_SLAVE - 1);
3954 buf = ofpraw_alloc_reply(OFPRAW_NXT_ROLE_REPLY, request, 0);
3955 nrr = ofpbuf_put_zeros(buf, sizeof *nrr);
3956 nrr->role = htonl(rr->role - 1);
3967 ofputil_put_ofp10_table_stats(const struct ofp12_table_stats *in,
3971 enum ofp10_flow_wildcards wc10;
3972 enum oxm12_ofb_match_fields mf12;
3975 static const struct wc_map wc_map[] = {
3976 { OFPFW10_IN_PORT, OFPXMT12_OFB_IN_PORT },
3977 { OFPFW10_DL_VLAN, OFPXMT12_OFB_VLAN_VID },
3978 { OFPFW10_DL_SRC, OFPXMT12_OFB_ETH_SRC },
3979 { OFPFW10_DL_DST, OFPXMT12_OFB_ETH_DST},
3980 { OFPFW10_DL_TYPE, OFPXMT12_OFB_ETH_TYPE },
3981 { OFPFW10_NW_PROTO, OFPXMT12_OFB_IP_PROTO },
3982 { OFPFW10_TP_SRC, OFPXMT12_OFB_TCP_SRC },
3983 { OFPFW10_TP_DST, OFPXMT12_OFB_TCP_DST },
3984 { OFPFW10_NW_SRC_MASK, OFPXMT12_OFB_IPV4_SRC },
3985 { OFPFW10_NW_DST_MASK, OFPXMT12_OFB_IPV4_DST },
3986 { OFPFW10_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP },
3987 { OFPFW10_NW_TOS, OFPXMT12_OFB_IP_DSCP },
3990 struct ofp10_table_stats *out;
3991 const struct wc_map *p;
3993 out = ofpbuf_put_zeros(buf, sizeof *out);
3994 out->table_id = in->table_id;
3995 ovs_strlcpy(out->name, in->name, sizeof out->name);
3997 for (p = wc_map; p < &wc_map[ARRAY_SIZE(wc_map)]; p++) {
3998 if (in->wildcards & htonll(1ULL << p->mf12)) {
3999 out->wildcards |= htonl(p->wc10);
4002 out->max_entries = in->max_entries;
4003 out->active_count = in->active_count;
4004 put_32aligned_be64(&out->lookup_count, in->lookup_count);
4005 put_32aligned_be64(&out->matched_count, in->matched_count);
4009 oxm12_to_ofp11_flow_match_fields(ovs_be64 oxm12)
4012 enum ofp11_flow_match_fields fmf11;
4013 enum oxm12_ofb_match_fields mf12;
4016 static const struct map map[] = {
4017 { OFPFMF11_IN_PORT, OFPXMT12_OFB_IN_PORT },
4018 { OFPFMF11_DL_VLAN, OFPXMT12_OFB_VLAN_VID },
4019 { OFPFMF11_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP },
4020 { OFPFMF11_DL_TYPE, OFPXMT12_OFB_ETH_TYPE },
4021 { OFPFMF11_NW_TOS, OFPXMT12_OFB_IP_DSCP },
4022 { OFPFMF11_NW_PROTO, OFPXMT12_OFB_IP_PROTO },
4023 { OFPFMF11_TP_SRC, OFPXMT12_OFB_TCP_SRC },
4024 { OFPFMF11_TP_DST, OFPXMT12_OFB_TCP_DST },
4025 { OFPFMF11_MPLS_LABEL, OFPXMT12_OFB_MPLS_LABEL },
4026 { OFPFMF11_MPLS_TC, OFPXMT12_OFB_MPLS_TC },
4027 /* I don't know what OFPFMF11_TYPE means. */
4028 { OFPFMF11_DL_SRC, OFPXMT12_OFB_ETH_SRC },
4029 { OFPFMF11_DL_DST, OFPXMT12_OFB_ETH_DST },
4030 { OFPFMF11_NW_SRC, OFPXMT12_OFB_IPV4_SRC },
4031 { OFPFMF11_NW_DST, OFPXMT12_OFB_IPV4_DST },
4032 { OFPFMF11_METADATA, OFPXMT12_OFB_METADATA },
4035 const struct map *p;
4039 for (p = map; p < &map[ARRAY_SIZE(map)]; p++) {
4040 if (oxm12 & htonll(1ULL << p->mf12)) {
4044 return htonl(fmf11);
4048 ofputil_put_ofp11_table_stats(const struct ofp12_table_stats *in,
4051 struct ofp11_table_stats *out;
4053 out = ofpbuf_put_zeros(buf, sizeof *out);
4054 out->table_id = in->table_id;
4055 ovs_strlcpy(out->name, in->name, sizeof out->name);
4056 out->wildcards = oxm12_to_ofp11_flow_match_fields(in->wildcards);
4057 out->match = oxm12_to_ofp11_flow_match_fields(in->match);
4058 out->instructions = in->instructions;
4059 out->write_actions = in->write_actions;
4060 out->apply_actions = in->apply_actions;
4061 out->config = in->config;
4062 out->max_entries = in->max_entries;
4063 out->active_count = in->active_count;
4064 out->lookup_count = in->lookup_count;
4065 out->matched_count = in->matched_count;
4069 ofputil_put_ofp13_table_stats(const struct ofp12_table_stats *in,
4072 struct ofp13_table_stats *out;
4074 /* OF 1.3 splits table features off the ofp_table_stats,
4075 * so there is not much here. */
4077 out = ofpbuf_put_uninit(buf, sizeof *out);
4078 out->table_id = in->table_id;
4079 out->active_count = in->active_count;
4080 out->lookup_count = in->lookup_count;
4081 out->matched_count = in->matched_count;
4085 ofputil_encode_table_stats_reply(const struct ofp12_table_stats stats[], int n,
4086 const struct ofp_header *request)
4088 struct ofpbuf *reply;
4091 reply = ofpraw_alloc_stats_reply(request, n * sizeof *stats);
4093 switch ((enum ofp_version) request->version) {
4095 for (i = 0; i < n; i++) {
4096 ofputil_put_ofp10_table_stats(&stats[i], reply);
4101 for (i = 0; i < n; i++) {
4102 ofputil_put_ofp11_table_stats(&stats[i], reply);
4107 ofpbuf_put(reply, stats, n * sizeof *stats);
4111 for (i = 0; i < n; i++) {
4112 ofputil_put_ofp13_table_stats(&stats[i], reply);
4123 /* ofputil_flow_monitor_request */
4125 /* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract
4126 * ofputil_flow_monitor_request in 'rq'.
4128 * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow
4129 * message. Calling this function multiple times for a single 'msg' iterates
4130 * through the requests. The caller must initially leave 'msg''s layer
4131 * pointers null and not modify them between calls.
4133 * Returns 0 if successful, EOF if no requests were left in this 'msg',
4134 * otherwise an OFPERR_* value. */
4136 ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *rq,
4139 struct nx_flow_monitor_request *nfmr;
4143 msg->l2 = msg->data;
4144 ofpraw_pull_assert(msg);
4151 nfmr = ofpbuf_try_pull(msg, sizeof *nfmr);
4153 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR request has %zu "
4154 "leftover bytes at end", msg->size);
4155 return OFPERR_OFPBRC_BAD_LEN;
4158 flags = ntohs(nfmr->flags);
4159 if (!(flags & (NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY))
4160 || flags & ~(NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE
4161 | NXFMF_MODIFY | NXFMF_ACTIONS | NXFMF_OWN)) {
4162 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR has bad flags %#"PRIx16,
4164 return OFPERR_NXBRC_FM_BAD_FLAGS;
4167 if (!is_all_zeros(nfmr->zeros, sizeof nfmr->zeros)) {
4168 return OFPERR_NXBRC_MUST_BE_ZERO;
4171 rq->id = ntohl(nfmr->id);
4173 rq->out_port = u16_to_ofp(ntohs(nfmr->out_port));
4174 rq->table_id = nfmr->table_id;
4176 return nx_pull_match(msg, ntohs(nfmr->match_len), &rq->match, NULL, NULL);
4180 ofputil_append_flow_monitor_request(
4181 const struct ofputil_flow_monitor_request *rq, struct ofpbuf *msg)
4183 struct nx_flow_monitor_request *nfmr;
4188 ofpraw_put(OFPRAW_NXST_FLOW_MONITOR_REQUEST, OFP10_VERSION, msg);
4191 start_ofs = msg->size;
4192 ofpbuf_put_zeros(msg, sizeof *nfmr);
4193 match_len = nx_put_match(msg, &rq->match, htonll(0), htonll(0));
4195 nfmr = ofpbuf_at_assert(msg, start_ofs, sizeof *nfmr);
4196 nfmr->id = htonl(rq->id);
4197 nfmr->flags = htons(rq->flags);
4198 nfmr->out_port = htons(ofp_to_u16(rq->out_port));
4199 nfmr->match_len = htons(match_len);
4200 nfmr->table_id = rq->table_id;
4203 /* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg'
4204 * into an abstract ofputil_flow_update in 'update'. The caller must have
4205 * initialized update->match to point to space allocated for a match.
4207 * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's
4208 * actions (except for NXFME_ABBREV, which never includes actions). The caller
4209 * must initialize 'ofpacts' and retains ownership of it. 'update->ofpacts'
4210 * will point into the 'ofpacts' buffer.
4212 * Multiple flow updates can be packed into a single OpenFlow message. Calling
4213 * this function multiple times for a single 'msg' iterates through the
4214 * updates. The caller must initially leave 'msg''s layer pointers null and
4215 * not modify them between calls.
4217 * Returns 0 if successful, EOF if no updates were left in this 'msg',
4218 * otherwise an OFPERR_* value. */
4220 ofputil_decode_flow_update(struct ofputil_flow_update *update,
4221 struct ofpbuf *msg, struct ofpbuf *ofpacts)
4223 struct nx_flow_update_header *nfuh;
4224 unsigned int length;
4227 msg->l2 = msg->data;
4228 ofpraw_pull_assert(msg);
4235 if (msg->size < sizeof(struct nx_flow_update_header)) {
4240 update->event = ntohs(nfuh->event);
4241 length = ntohs(nfuh->length);
4242 if (length > msg->size || length % 8) {
4246 if (update->event == NXFME_ABBREV) {
4247 struct nx_flow_update_abbrev *nfua;
4249 if (length != sizeof *nfua) {
4253 nfua = ofpbuf_pull(msg, sizeof *nfua);
4254 update->xid = nfua->xid;
4256 } else if (update->event == NXFME_ADDED
4257 || update->event == NXFME_DELETED
4258 || update->event == NXFME_MODIFIED) {
4259 struct nx_flow_update_full *nfuf;
4260 unsigned int actions_len;
4261 unsigned int match_len;
4264 if (length < sizeof *nfuf) {
4268 nfuf = ofpbuf_pull(msg, sizeof *nfuf);
4269 match_len = ntohs(nfuf->match_len);
4270 if (sizeof *nfuf + match_len > length) {
4274 update->reason = ntohs(nfuf->reason);
4275 update->idle_timeout = ntohs(nfuf->idle_timeout);
4276 update->hard_timeout = ntohs(nfuf->hard_timeout);
4277 update->table_id = nfuf->table_id;
4278 update->cookie = nfuf->cookie;
4279 update->priority = ntohs(nfuf->priority);
4281 error = nx_pull_match(msg, match_len, update->match, NULL, NULL);
4286 actions_len = length - sizeof *nfuf - ROUND_UP(match_len, 8);
4287 error = ofpacts_pull_openflow10(msg, actions_len, ofpacts);
4292 update->ofpacts = ofpacts->data;
4293 update->ofpacts_len = ofpacts->size;
4296 VLOG_WARN_RL(&bad_ofmsg_rl,
4297 "NXST_FLOW_MONITOR reply has bad event %"PRIu16,
4298 ntohs(nfuh->event));
4299 return OFPERR_NXBRC_FM_BAD_EVENT;
4303 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR reply has %zu "
4304 "leftover bytes at end", msg->size);
4305 return OFPERR_OFPBRC_BAD_LEN;
4309 ofputil_decode_flow_monitor_cancel(const struct ofp_header *oh)
4311 const struct nx_flow_monitor_cancel *cancel = ofpmsg_body(oh);
4313 return ntohl(cancel->id);
4317 ofputil_encode_flow_monitor_cancel(uint32_t id)
4319 struct nx_flow_monitor_cancel *nfmc;
4322 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MONITOR_CANCEL, OFP10_VERSION, 0);
4323 nfmc = ofpbuf_put_uninit(msg, sizeof *nfmc);
4324 nfmc->id = htonl(id);
4329 ofputil_start_flow_update(struct list *replies)
4333 msg = ofpraw_alloc_xid(OFPRAW_NXST_FLOW_MONITOR_REPLY, OFP10_VERSION,
4337 list_push_back(replies, &msg->list_node);
4341 ofputil_append_flow_update(const struct ofputil_flow_update *update,
4342 struct list *replies)
4344 struct nx_flow_update_header *nfuh;
4348 msg = ofpbuf_from_list(list_back(replies));
4349 start_ofs = msg->size;
4351 if (update->event == NXFME_ABBREV) {
4352 struct nx_flow_update_abbrev *nfua;
4354 nfua = ofpbuf_put_zeros(msg, sizeof *nfua);
4355 nfua->xid = update->xid;
4357 struct nx_flow_update_full *nfuf;
4360 ofpbuf_put_zeros(msg, sizeof *nfuf);
4361 match_len = nx_put_match(msg, update->match, htonll(0), htonll(0));
4362 ofpacts_put_openflow10(update->ofpacts, update->ofpacts_len, msg);
4364 nfuf = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuf);
4365 nfuf->reason = htons(update->reason);
4366 nfuf->priority = htons(update->priority);
4367 nfuf->idle_timeout = htons(update->idle_timeout);
4368 nfuf->hard_timeout = htons(update->hard_timeout);
4369 nfuf->match_len = htons(match_len);
4370 nfuf->table_id = update->table_id;
4371 nfuf->cookie = update->cookie;
4374 nfuh = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuh);
4375 nfuh->length = htons(msg->size - start_ofs);
4376 nfuh->event = htons(update->event);
4378 ofpmp_postappend(replies, start_ofs);
4382 ofputil_encode_packet_out(const struct ofputil_packet_out *po,
4383 enum ofputil_protocol protocol)
4385 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
4389 size = po->ofpacts_len;
4390 if (po->buffer_id == UINT32_MAX) {
4391 size += po->packet_len;
4394 switch (ofp_version) {
4395 case OFP10_VERSION: {
4396 struct ofp10_packet_out *opo;
4399 msg = ofpraw_alloc(OFPRAW_OFPT10_PACKET_OUT, OFP10_VERSION, size);
4400 ofpbuf_put_zeros(msg, sizeof *opo);
4401 actions_ofs = msg->size;
4402 ofpacts_put_openflow10(po->ofpacts, po->ofpacts_len, msg);
4405 opo->buffer_id = htonl(po->buffer_id);
4406 opo->in_port = htons(ofp_to_u16(po->in_port));
4407 opo->actions_len = htons(msg->size - actions_ofs);
4413 case OFP13_VERSION: {
4414 struct ofp11_packet_out *opo;
4417 msg = ofpraw_alloc(OFPRAW_OFPT11_PACKET_OUT, ofp_version, size);
4418 ofpbuf_put_zeros(msg, sizeof *opo);
4419 len = ofpacts_put_openflow11_actions(po->ofpacts, po->ofpacts_len, msg);
4422 opo->buffer_id = htonl(po->buffer_id);
4423 opo->in_port = ofputil_port_to_ofp11(po->in_port);
4424 opo->actions_len = htons(len);
4432 if (po->buffer_id == UINT32_MAX) {
4433 ofpbuf_put(msg, po->packet, po->packet_len);
4436 ofpmsg_update_length(msg);
4441 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
4443 make_echo_request(enum ofp_version ofp_version)
4445 return ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST, ofp_version,
4449 /* Creates and returns an OFPT_ECHO_REPLY message matching the
4450 * OFPT_ECHO_REQUEST message in 'rq'. */
4452 make_echo_reply(const struct ofp_header *rq)
4454 struct ofpbuf rq_buf;
4455 struct ofpbuf *reply;
4457 ofpbuf_use_const(&rq_buf, rq, ntohs(rq->length));
4458 ofpraw_pull_assert(&rq_buf);
4460 reply = ofpraw_alloc_reply(OFPRAW_OFPT_ECHO_REPLY, rq, rq_buf.size);
4461 ofpbuf_put(reply, rq_buf.data, rq_buf.size);
4466 ofputil_encode_barrier_request(enum ofp_version ofp_version)
4470 switch (ofp_version) {
4474 type = OFPRAW_OFPT11_BARRIER_REQUEST;
4478 type = OFPRAW_OFPT10_BARRIER_REQUEST;
4485 return ofpraw_alloc(type, ofp_version, 0);
4489 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
4491 switch (flags & OFPC_FRAG_MASK) {
4492 case OFPC_FRAG_NORMAL: return "normal";
4493 case OFPC_FRAG_DROP: return "drop";
4494 case OFPC_FRAG_REASM: return "reassemble";
4495 case OFPC_FRAG_NX_MATCH: return "nx-match";
4502 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
4504 if (!strcasecmp(s, "normal")) {
4505 *flags = OFPC_FRAG_NORMAL;
4506 } else if (!strcasecmp(s, "drop")) {
4507 *flags = OFPC_FRAG_DROP;
4508 } else if (!strcasecmp(s, "reassemble")) {
4509 *flags = OFPC_FRAG_REASM;
4510 } else if (!strcasecmp(s, "nx-match")) {
4511 *flags = OFPC_FRAG_NX_MATCH;
4518 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
4519 * port number and stores the latter in '*ofp10_port', for the purpose of
4520 * decoding OpenFlow 1.1+ protocol messages. Returns 0 if successful,
4521 * otherwise an OFPERR_* number. On error, stores OFPP_NONE in '*ofp10_port'.
4523 * See the definition of OFP11_MAX for an explanation of the mapping. */
4525 ofputil_port_from_ofp11(ovs_be32 ofp11_port, ofp_port_t *ofp10_port)
4527 uint32_t ofp11_port_h = ntohl(ofp11_port);
4529 if (ofp11_port_h < ofp_to_u16(OFPP_MAX)) {
4530 *ofp10_port = u16_to_ofp(ofp11_port_h);
4532 } else if (ofp11_port_h >= ofp11_to_u32(OFPP11_MAX)) {
4533 *ofp10_port = u16_to_ofp(ofp11_port_h - OFPP11_OFFSET);
4536 *ofp10_port = OFPP_NONE;
4537 VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
4538 "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
4539 ofp11_port_h, ofp_to_u16(OFPP_MAX) - 1,
4540 ofp11_to_u32(OFPP11_MAX), UINT32_MAX);
4541 return OFPERR_OFPBAC_BAD_OUT_PORT;
4545 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
4546 * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
4548 * See the definition of OFP11_MAX for an explanation of the mapping. */
4550 ofputil_port_to_ofp11(ofp_port_t ofp10_port)
4552 return htonl(ofp_to_u16(ofp10_port) < ofp_to_u16(OFPP_MAX)
4553 ? ofp_to_u16(ofp10_port)
4554 : ofp_to_u16(ofp10_port) + OFPP11_OFFSET);
4557 /* Checks that 'port' is a valid output port for the OFPAT10_OUTPUT action, given
4558 * that the switch will never have more than 'max_ports' ports. Returns 0 if
4559 * 'port' is valid, otherwise an OpenFlow return code. */
4561 ofputil_check_output_port(ofp_port_t port, ofp_port_t max_ports)
4569 case OFPP_CONTROLLER:
4575 if (ofp_to_u16(port) < ofp_to_u16(max_ports)) {
4578 return OFPERR_OFPBAC_BAD_OUT_PORT;
4582 #define OFPUTIL_NAMED_PORTS \
4583 OFPUTIL_NAMED_PORT(IN_PORT) \
4584 OFPUTIL_NAMED_PORT(TABLE) \
4585 OFPUTIL_NAMED_PORT(NORMAL) \
4586 OFPUTIL_NAMED_PORT(FLOOD) \
4587 OFPUTIL_NAMED_PORT(ALL) \
4588 OFPUTIL_NAMED_PORT(CONTROLLER) \
4589 OFPUTIL_NAMED_PORT(LOCAL) \
4590 OFPUTIL_NAMED_PORT(ANY)
4592 /* For backwards compatibility, so that "none" is recognized as OFPP_ANY */
4593 #define OFPUTIL_NAMED_PORTS_WITH_NONE \
4594 OFPUTIL_NAMED_PORTS \
4595 OFPUTIL_NAMED_PORT(NONE)
4597 /* Stores the port number represented by 's' into '*portp'. 's' may be an
4598 * integer or, for reserved ports, the standard OpenFlow name for the port
4601 * Returns true if successful, false if 's' is not a valid OpenFlow port number
4602 * or name. The caller should issue an error message in this case, because
4603 * this function usually does not. (This gives the caller an opportunity to
4604 * look up the port name another way, e.g. by contacting the switch and listing
4605 * the names of all its ports).
4607 * This function accepts OpenFlow 1.0 port numbers. It also accepts a subset
4608 * of OpenFlow 1.1+ port numbers, mapping those port numbers into the 16-bit
4609 * range as described in include/openflow/openflow-1.1.h. */
4611 ofputil_port_from_string(const char *s, ofp_port_t *portp)
4616 if (str_to_uint(s, 10, &port32)) {
4617 if (port32 < ofp_to_u16(OFPP_MAX)) {
4619 } else if (port32 < ofp_to_u16(OFPP_FIRST_RESV)) {
4620 VLOG_WARN("port %u is a reserved OF1.0 port number that will "
4621 "be translated to %u when talking to an OF1.1 or "
4622 "later controller", port32, port32 + OFPP11_OFFSET);
4623 } else if (port32 <= ofp_to_u16(OFPP_LAST_RESV)) {
4624 char name[OFP_MAX_PORT_NAME_LEN];
4626 ofputil_port_to_string(u16_to_ofp(port32), name, sizeof name);
4627 VLOG_WARN_ONCE("referring to port %s as %"PRIu32" is deprecated "
4628 "for compatibility with OpenFlow 1.1 and later",
4630 } else if (port32 < ofp11_to_u32(OFPP11_MAX)) {
4631 VLOG_WARN("port %u is outside the supported range 0 through "
4632 "%"PRIx16" or 0x%x through 0x%"PRIx32, port32,
4633 UINT16_MAX, ofp11_to_u32(OFPP11_MAX), UINT32_MAX);
4636 port32 -= OFPP11_OFFSET;
4639 *portp = u16_to_ofp(port32);
4646 static const struct pair pairs[] = {
4647 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
4648 OFPUTIL_NAMED_PORTS_WITH_NONE
4649 #undef OFPUTIL_NAMED_PORT
4651 const struct pair *p;
4653 for (p = pairs; p < &pairs[ARRAY_SIZE(pairs)]; p++) {
4654 if (!strcasecmp(s, p->name)) {
4663 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
4664 * Most ports' string representation is just the port number, but for special
4665 * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
4667 ofputil_format_port(ofp_port_t port, struct ds *s)
4669 char name[OFP_MAX_PORT_NAME_LEN];
4671 ofputil_port_to_string(port, name, sizeof name);
4672 ds_put_cstr(s, name);
4675 /* Puts in the 'bufsize' byte in 'namebuf' a null-terminated string
4676 * representation of OpenFlow port number 'port'. Most ports are represented
4677 * as just the port number, but special ports, e.g. OFPP_LOCAL, are represented
4678 * by name, e.g. "LOCAL". */
4680 ofputil_port_to_string(ofp_port_t port,
4681 char namebuf[OFP_MAX_PORT_NAME_LEN], size_t bufsize)
4684 #define OFPUTIL_NAMED_PORT(NAME) \
4686 ovs_strlcpy(namebuf, #NAME, bufsize); \
4689 #undef OFPUTIL_NAMED_PORT
4692 snprintf(namebuf, bufsize, "%"PRIu16, port);
4697 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
4698 * 'ofp_version', tries to pull the first element from the array. If
4699 * successful, initializes '*pp' with an abstract representation of the
4700 * port and returns 0. If no ports remain to be decoded, returns EOF.
4701 * On an error, returns a positive OFPERR_* value. */
4703 ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *b,
4704 struct ofputil_phy_port *pp)
4706 switch (ofp_version) {
4707 case OFP10_VERSION: {
4708 const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
4709 return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
4713 case OFP13_VERSION: {
4714 const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
4715 return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
4722 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
4723 * 'ofp_version', returns the number of elements. */
4724 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *b)
4726 return b->size / ofputil_get_phy_port_size(ofp_version);
4729 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
4730 * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1 if
4731 * 'name' is not the name of any action.
4733 * ofp-util.def lists the mapping from names to action. */
4735 ofputil_action_code_from_name(const char *name)
4737 static const char *const names[OFPUTIL_N_ACTIONS] = {
4739 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) NAME,
4740 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
4741 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
4742 #include "ofp-util.def"
4745 const char *const *p;
4747 for (p = names; p < &names[ARRAY_SIZE(names)]; p++) {
4748 if (*p && !strcasecmp(name, *p)) {
4755 /* Appends an action of the type specified by 'code' to 'buf' and returns the
4756 * action. Initializes the parts of 'action' that identify it as having type
4757 * <ENUM> and length 'sizeof *action' and zeros the rest. For actions that
4758 * have variable length, the length used and cleared is that of struct
4761 ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
4764 case OFPUTIL_ACTION_INVALID:
4767 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
4768 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
4769 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
4770 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
4771 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
4772 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
4773 #include "ofp-util.def"
4778 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
4780 ofputil_init_##ENUM(struct STRUCT *s) \
4782 memset(s, 0, sizeof *s); \
4783 s->type = htons(ENUM); \
4784 s->len = htons(sizeof *s); \
4788 ofputil_put_##ENUM(struct ofpbuf *buf) \
4790 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
4791 ofputil_init_##ENUM(s); \
4794 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
4795 OFPAT10_ACTION(ENUM, STRUCT, NAME)
4796 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
4798 ofputil_init_##ENUM(struct STRUCT *s) \
4800 memset(s, 0, sizeof *s); \
4801 s->type = htons(OFPAT10_VENDOR); \
4802 s->len = htons(sizeof *s); \
4803 s->vendor = htonl(NX_VENDOR_ID); \
4804 s->subtype = htons(ENUM); \
4808 ofputil_put_##ENUM(struct ofpbuf *buf) \
4810 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
4811 ofputil_init_##ENUM(s); \
4814 #include "ofp-util.def"
4817 ofputil_normalize_match__(struct match *match, bool may_log)
4820 MAY_NW_ADDR = 1 << 0, /* nw_src, nw_dst */
4821 MAY_TP_ADDR = 1 << 1, /* tp_src, tp_dst */
4822 MAY_NW_PROTO = 1 << 2, /* nw_proto */
4823 MAY_IPVx = 1 << 3, /* tos, frag, ttl */
4824 MAY_ARP_SHA = 1 << 4, /* arp_sha */
4825 MAY_ARP_THA = 1 << 5, /* arp_tha */
4826 MAY_IPV6 = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
4827 MAY_ND_TARGET = 1 << 7, /* nd_target */
4828 MAY_MPLS = 1 << 8, /* mpls label and tc */
4831 struct flow_wildcards wc;
4833 /* Figure out what fields may be matched. */
4834 if (match->flow.dl_type == htons(ETH_TYPE_IP)) {
4835 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
4836 if (match->flow.nw_proto == IPPROTO_TCP ||
4837 match->flow.nw_proto == IPPROTO_UDP ||
4838 match->flow.nw_proto == IPPROTO_ICMP) {
4839 may_match |= MAY_TP_ADDR;
4841 } else if (match->flow.dl_type == htons(ETH_TYPE_IPV6)) {
4842 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
4843 if (match->flow.nw_proto == IPPROTO_TCP ||
4844 match->flow.nw_proto == IPPROTO_UDP) {
4845 may_match |= MAY_TP_ADDR;
4846 } else if (match->flow.nw_proto == IPPROTO_ICMPV6) {
4847 may_match |= MAY_TP_ADDR;
4848 if (match->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
4849 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
4850 } else if (match->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
4851 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
4854 } else if (match->flow.dl_type == htons(ETH_TYPE_ARP) ||
4855 match->flow.dl_type == htons(ETH_TYPE_RARP)) {
4856 may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
4857 } else if (eth_type_mpls(match->flow.dl_type)) {
4858 may_match = MAY_MPLS;
4863 /* Clear the fields that may not be matched. */
4865 if (!(may_match & MAY_NW_ADDR)) {
4866 wc.masks.nw_src = wc.masks.nw_dst = htonl(0);
4868 if (!(may_match & MAY_TP_ADDR)) {
4869 wc.masks.tp_src = wc.masks.tp_dst = htons(0);
4871 if (!(may_match & MAY_NW_PROTO)) {
4872 wc.masks.nw_proto = 0;
4874 if (!(may_match & MAY_IPVx)) {
4875 wc.masks.nw_tos = 0;
4876 wc.masks.nw_ttl = 0;
4878 if (!(may_match & MAY_ARP_SHA)) {
4879 memset(wc.masks.arp_sha, 0, ETH_ADDR_LEN);
4881 if (!(may_match & MAY_ARP_THA)) {
4882 memset(wc.masks.arp_tha, 0, ETH_ADDR_LEN);
4884 if (!(may_match & MAY_IPV6)) {
4885 wc.masks.ipv6_src = wc.masks.ipv6_dst = in6addr_any;
4886 wc.masks.ipv6_label = htonl(0);
4888 if (!(may_match & MAY_ND_TARGET)) {
4889 wc.masks.nd_target = in6addr_any;
4891 if (!(may_match & MAY_MPLS)) {
4892 wc.masks.mpls_lse = htonl(0);
4893 wc.masks.mpls_depth = 0;
4896 /* Log any changes. */
4897 if (!flow_wildcards_equal(&wc, &match->wc)) {
4898 bool log = may_log && !VLOG_DROP_INFO(&bad_ofmsg_rl);
4899 char *pre = log ? match_to_string(match, OFP_DEFAULT_PRIORITY) : NULL;
4902 match_zero_wildcarded_fields(match);
4905 char *post = match_to_string(match, OFP_DEFAULT_PRIORITY);
4906 VLOG_INFO("normalization changed ofp_match, details:");
4907 VLOG_INFO(" pre: %s", pre);
4908 VLOG_INFO("post: %s", post);
4915 /* "Normalizes" the wildcards in 'match'. That means:
4917 * 1. If the type of level N is known, then only the valid fields for that
4918 * level may be specified. For example, ARP does not have a TOS field,
4919 * so nw_tos must be wildcarded if 'match' specifies an ARP flow.
4920 * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
4921 * ipv6_dst (and other fields) must be wildcarded if 'match' specifies an
4924 * 2. If the type of level N is not known (or not understood by Open
4925 * vSwitch), then no fields at all for that level may be specified. For
4926 * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
4927 * L4 fields tp_src and tp_dst must be wildcarded if 'match' specifies an
4930 * If this function changes 'match', it logs a rate-limited informational
4933 ofputil_normalize_match(struct match *match)
4935 ofputil_normalize_match__(match, true);
4938 /* Same as ofputil_normalize_match() without the logging. Thus, this function
4939 * is suitable for a program's internal use, whereas ofputil_normalize_match()
4940 * sense for use on flows received from elsewhere (so that a bug in the program
4941 * that sent them can be reported and corrected). */
4943 ofputil_normalize_match_quiet(struct match *match)
4945 ofputil_normalize_match__(match, false);
4948 /* Parses a key or a key-value pair from '*stringp'.
4950 * On success: Stores the key into '*keyp'. Stores the value, if present, into
4951 * '*valuep', otherwise an empty string. Advances '*stringp' past the end of
4952 * the key-value pair, preparing it for another call. '*keyp' and '*valuep'
4953 * are substrings of '*stringp' created by replacing some of its bytes by null
4954 * terminators. Returns true.
4956 * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
4957 * NULL and returns false. */
4959 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
4961 char *pos, *key, *value;
4965 pos += strspn(pos, ", \t\r\n");
4967 *keyp = *valuep = NULL;
4972 key_len = strcspn(pos, ":=(, \t\r\n");
4973 if (key[key_len] == ':' || key[key_len] == '=') {
4974 /* The value can be separated by a colon. */
4977 value = key + key_len + 1;
4978 value_len = strcspn(value, ", \t\r\n");
4979 pos = value + value_len + (value[value_len] != '\0');
4980 value[value_len] = '\0';
4981 } else if (key[key_len] == '(') {
4982 /* The value can be surrounded by balanced parentheses. The outermost
4983 * set of parentheses is removed. */
4987 value = key + key_len + 1;
4988 for (value_len = 0; level > 0; value_len++) {
4989 switch (value[value_len]) {
5003 value[value_len - 1] = '\0';
5004 pos = value + value_len;
5006 /* There might be no value at all. */
5007 value = key + key_len; /* Will become the empty string below. */
5008 pos = key + key_len + (key[key_len] != '\0');
5010 key[key_len] = '\0';
5018 /* Encode a dump ports request for 'port', the encoded message
5019 * will be for Open Flow version 'ofp_version'. Returns message
5020 * as a struct ofpbuf. Returns encoded message on success, NULL on error */
5022 ofputil_encode_dump_ports_request(enum ofp_version ofp_version, ofp_port_t port)
5024 struct ofpbuf *request;
5026 switch (ofp_version) {
5027 case OFP10_VERSION: {
5028 struct ofp10_port_stats_request *req;
5029 request = ofpraw_alloc(OFPRAW_OFPST10_PORT_REQUEST, ofp_version, 0);
5030 req = ofpbuf_put_zeros(request, sizeof *req);
5031 req->port_no = htons(ofp_to_u16(port));
5036 case OFP13_VERSION: {
5037 struct ofp11_port_stats_request *req;
5038 request = ofpraw_alloc(OFPRAW_OFPST11_PORT_REQUEST, ofp_version, 0);
5039 req = ofpbuf_put_zeros(request, sizeof *req);
5040 req->port_no = ofputil_port_to_ofp11(port);
5051 ofputil_port_stats_to_ofp10(const struct ofputil_port_stats *ops,
5052 struct ofp10_port_stats *ps10)
5054 ps10->port_no = htons(ofp_to_u16(ops->port_no));
5055 memset(ps10->pad, 0, sizeof ps10->pad);
5056 put_32aligned_be64(&ps10->rx_packets, htonll(ops->stats.rx_packets));
5057 put_32aligned_be64(&ps10->tx_packets, htonll(ops->stats.tx_packets));
5058 put_32aligned_be64(&ps10->rx_bytes, htonll(ops->stats.rx_bytes));
5059 put_32aligned_be64(&ps10->tx_bytes, htonll(ops->stats.tx_bytes));
5060 put_32aligned_be64(&ps10->rx_dropped, htonll(ops->stats.rx_dropped));
5061 put_32aligned_be64(&ps10->tx_dropped, htonll(ops->stats.tx_dropped));
5062 put_32aligned_be64(&ps10->rx_errors, htonll(ops->stats.rx_errors));
5063 put_32aligned_be64(&ps10->tx_errors, htonll(ops->stats.tx_errors));
5064 put_32aligned_be64(&ps10->rx_frame_err, htonll(ops->stats.rx_frame_errors));
5065 put_32aligned_be64(&ps10->rx_over_err, htonll(ops->stats.rx_over_errors));
5066 put_32aligned_be64(&ps10->rx_crc_err, htonll(ops->stats.rx_crc_errors));
5067 put_32aligned_be64(&ps10->collisions, htonll(ops->stats.collisions));
5071 ofputil_port_stats_to_ofp11(const struct ofputil_port_stats *ops,
5072 struct ofp11_port_stats *ps11)
5074 ps11->port_no = ofputil_port_to_ofp11(ops->port_no);
5075 memset(ps11->pad, 0, sizeof ps11->pad);
5076 ps11->rx_packets = htonll(ops->stats.rx_packets);
5077 ps11->tx_packets = htonll(ops->stats.tx_packets);
5078 ps11->rx_bytes = htonll(ops->stats.rx_bytes);
5079 ps11->tx_bytes = htonll(ops->stats.tx_bytes);
5080 ps11->rx_dropped = htonll(ops->stats.rx_dropped);
5081 ps11->tx_dropped = htonll(ops->stats.tx_dropped);
5082 ps11->rx_errors = htonll(ops->stats.rx_errors);
5083 ps11->tx_errors = htonll(ops->stats.tx_errors);
5084 ps11->rx_frame_err = htonll(ops->stats.rx_frame_errors);
5085 ps11->rx_over_err = htonll(ops->stats.rx_over_errors);
5086 ps11->rx_crc_err = htonll(ops->stats.rx_crc_errors);
5087 ps11->collisions = htonll(ops->stats.collisions);
5091 ofputil_port_stats_to_ofp13(const struct ofputil_port_stats *ops,
5092 struct ofp13_port_stats *ps13)
5094 ofputil_port_stats_to_ofp11(ops, &ps13->ps);
5095 ps13->duration_sec = htonl(ops->duration_sec);
5096 ps13->duration_nsec = htonl(ops->duration_nsec);
5100 /* Encode a ports stat for 'ops' and append it to 'replies'. */
5102 ofputil_append_port_stat(struct list *replies,
5103 const struct ofputil_port_stats *ops)
5105 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
5106 struct ofp_header *oh = msg->data;
5108 switch ((enum ofp_version)oh->version) {
5109 case OFP13_VERSION: {
5110 struct ofp13_port_stats *reply = ofpmp_append(replies, sizeof *reply);
5111 ofputil_port_stats_to_ofp13(ops, reply);
5115 case OFP11_VERSION: {
5116 struct ofp11_port_stats *reply = ofpmp_append(replies, sizeof *reply);
5117 ofputil_port_stats_to_ofp11(ops, reply);
5121 case OFP10_VERSION: {
5122 struct ofp10_port_stats *reply = ofpmp_append(replies, sizeof *reply);
5123 ofputil_port_stats_to_ofp10(ops, reply);
5133 ofputil_port_stats_from_ofp10(struct ofputil_port_stats *ops,
5134 const struct ofp10_port_stats *ps10)
5136 memset(ops, 0, sizeof *ops);
5138 ops->port_no = u16_to_ofp(ntohs(ps10->port_no));
5139 ops->stats.rx_packets = ntohll(get_32aligned_be64(&ps10->rx_packets));
5140 ops->stats.tx_packets = ntohll(get_32aligned_be64(&ps10->tx_packets));
5141 ops->stats.rx_bytes = ntohll(get_32aligned_be64(&ps10->rx_bytes));
5142 ops->stats.tx_bytes = ntohll(get_32aligned_be64(&ps10->tx_bytes));
5143 ops->stats.rx_dropped = ntohll(get_32aligned_be64(&ps10->rx_dropped));
5144 ops->stats.tx_dropped = ntohll(get_32aligned_be64(&ps10->tx_dropped));
5145 ops->stats.rx_errors = ntohll(get_32aligned_be64(&ps10->rx_errors));
5146 ops->stats.tx_errors = ntohll(get_32aligned_be64(&ps10->tx_errors));
5147 ops->stats.rx_frame_errors =
5148 ntohll(get_32aligned_be64(&ps10->rx_frame_err));
5149 ops->stats.rx_over_errors = ntohll(get_32aligned_be64(&ps10->rx_over_err));
5150 ops->stats.rx_crc_errors = ntohll(get_32aligned_be64(&ps10->rx_crc_err));
5151 ops->stats.collisions = ntohll(get_32aligned_be64(&ps10->collisions));
5152 ops->duration_sec = ops->duration_nsec = UINT32_MAX;
5158 ofputil_port_stats_from_ofp11(struct ofputil_port_stats *ops,
5159 const struct ofp11_port_stats *ps11)
5163 memset(ops, 0, sizeof *ops);
5164 error = ofputil_port_from_ofp11(ps11->port_no, &ops->port_no);
5169 ops->stats.rx_packets = ntohll(ps11->rx_packets);
5170 ops->stats.tx_packets = ntohll(ps11->tx_packets);
5171 ops->stats.rx_bytes = ntohll(ps11->rx_bytes);
5172 ops->stats.tx_bytes = ntohll(ps11->tx_bytes);
5173 ops->stats.rx_dropped = ntohll(ps11->rx_dropped);
5174 ops->stats.tx_dropped = ntohll(ps11->tx_dropped);
5175 ops->stats.rx_errors = ntohll(ps11->rx_errors);
5176 ops->stats.tx_errors = ntohll(ps11->tx_errors);
5177 ops->stats.rx_frame_errors = ntohll(ps11->rx_frame_err);
5178 ops->stats.rx_over_errors = ntohll(ps11->rx_over_err);
5179 ops->stats.rx_crc_errors = ntohll(ps11->rx_crc_err);
5180 ops->stats.collisions = ntohll(ps11->collisions);
5181 ops->duration_sec = ops->duration_nsec = UINT32_MAX;
5187 ofputil_port_stats_from_ofp13(struct ofputil_port_stats *ops,
5188 const struct ofp13_port_stats *ps13)
5190 enum ofperr error = ofputil_port_stats_from_ofp11(ops, &ps13->ps);
5192 ops->duration_sec = ntohl(ps13->duration_sec);
5193 ops->duration_nsec = ntohl(ps13->duration_nsec);
5199 ofputil_get_port_stats_size(enum ofp_version ofp_version)
5201 switch (ofp_version) {
5203 return sizeof(struct ofp10_port_stats);
5206 return sizeof(struct ofp11_port_stats);
5208 return sizeof(struct ofp13_port_stats);
5214 /* Returns the number of port stats elements in OFPTYPE_PORT_STATS_REPLY
5217 ofputil_count_port_stats(const struct ofp_header *oh)
5221 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5222 ofpraw_pull_assert(&b);
5224 return b.size / ofputil_get_port_stats_size(oh->version);
5227 /* Converts an OFPST_PORT_STATS reply in 'msg' into an abstract
5228 * ofputil_port_stats in 'ps'.
5230 * Multiple OFPST_PORT_STATS replies can be packed into a single OpenFlow
5231 * message. Calling this function multiple times for a single 'msg' iterates
5232 * through the replies. The caller must initially leave 'msg''s layer pointers
5233 * null and not modify them between calls.
5235 * Returns 0 if successful, EOF if no replies were left in this 'msg',
5236 * otherwise a positive errno value. */
5238 ofputil_decode_port_stats(struct ofputil_port_stats *ps, struct ofpbuf *msg)
5244 ? ofpraw_decode(&raw, msg->l2)
5245 : ofpraw_pull(&raw, msg));
5252 } else if (raw == OFPRAW_OFPST13_PORT_REPLY) {
5253 const struct ofp13_port_stats *ps13;
5255 ps13 = ofpbuf_try_pull(msg, sizeof *ps13);
5259 return ofputil_port_stats_from_ofp13(ps, ps13);
5260 } else if (raw == OFPRAW_OFPST11_PORT_REPLY) {
5261 const struct ofp11_port_stats *ps11;
5263 ps11 = ofpbuf_try_pull(msg, sizeof *ps11);
5267 return ofputil_port_stats_from_ofp11(ps, ps11);
5268 } else if (raw == OFPRAW_OFPST10_PORT_REPLY) {
5269 const struct ofp10_port_stats *ps10;
5271 ps10 = ofpbuf_try_pull(msg, sizeof *ps10);
5275 return ofputil_port_stats_from_ofp10(ps, ps10);
5281 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_PORT reply has %zu leftover "
5282 "bytes at end", msg->size);
5283 return OFPERR_OFPBRC_BAD_LEN;
5286 /* Parse a port status request message into a 16 bit OpenFlow 1.0
5287 * port number and stores the latter in '*ofp10_port'.
5288 * Returns 0 if successful, otherwise an OFPERR_* number. */
5290 ofputil_decode_port_stats_request(const struct ofp_header *request,
5291 ofp_port_t *ofp10_port)
5293 switch ((enum ofp_version)request->version) {
5296 case OFP11_VERSION: {
5297 const struct ofp11_port_stats_request *psr11 = ofpmsg_body(request);
5298 return ofputil_port_from_ofp11(psr11->port_no, ofp10_port);
5301 case OFP10_VERSION: {
5302 const struct ofp10_port_stats_request *psr10 = ofpmsg_body(request);
5303 *ofp10_port = u16_to_ofp(ntohs(psr10->port_no));
5312 /* Parse a queue status request message into 'oqsr'.
5313 * Returns 0 if successful, otherwise an OFPERR_* number. */
5315 ofputil_decode_queue_stats_request(const struct ofp_header *request,
5316 struct ofputil_queue_stats_request *oqsr)
5318 switch ((enum ofp_version)request->version) {
5321 case OFP11_VERSION: {
5322 const struct ofp11_queue_stats_request *qsr11 = ofpmsg_body(request);
5323 oqsr->queue_id = ntohl(qsr11->queue_id);
5324 return ofputil_port_from_ofp11(qsr11->port_no, &oqsr->port_no);
5327 case OFP10_VERSION: {
5328 const struct ofp10_queue_stats_request *qsr10 = ofpmsg_body(request);
5329 oqsr->queue_id = ntohl(qsr10->queue_id);
5330 oqsr->port_no = u16_to_ofp(ntohs(qsr10->port_no));
5331 /* OF 1.0 uses OFPP_ALL for OFPP_ANY */
5332 if (oqsr->port_no == OFPP_ALL) {
5333 oqsr->port_no = OFPP_ANY;
5343 /* Encode a queue statsrequest for 'oqsr', the encoded message
5344 * will be fore Open Flow version 'ofp_version'. Returns message
5345 * as a struct ofpbuf. Returns encoded message on success, NULL on error */
5347 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
5348 const struct ofputil_queue_stats_request *oqsr)
5350 struct ofpbuf *request;
5352 switch (ofp_version) {
5355 case OFP13_VERSION: {
5356 struct ofp11_queue_stats_request *req;
5357 request = ofpraw_alloc(OFPRAW_OFPST11_QUEUE_REQUEST, ofp_version, 0);
5358 req = ofpbuf_put_zeros(request, sizeof *req);
5359 req->port_no = ofputil_port_to_ofp11(oqsr->port_no);
5360 req->queue_id = htonl(oqsr->queue_id);
5363 case OFP10_VERSION: {
5364 struct ofp10_queue_stats_request *req;
5365 request = ofpraw_alloc(OFPRAW_OFPST10_QUEUE_REQUEST, ofp_version, 0);
5366 req = ofpbuf_put_zeros(request, sizeof *req);
5367 /* OpenFlow 1.0 needs OFPP_ALL instead of OFPP_ANY */
5368 req->port_no = htons(ofp_to_u16(oqsr->port_no == OFPP_ANY
5369 ? OFPP_ALL : oqsr->port_no));
5370 req->queue_id = htonl(oqsr->queue_id);
5381 ofputil_get_queue_stats_size(enum ofp_version ofp_version)
5383 switch (ofp_version) {
5385 return sizeof(struct ofp10_queue_stats);
5388 return sizeof(struct ofp11_queue_stats);
5390 return sizeof(struct ofp13_queue_stats);
5396 /* Returns the number of queue stats elements in OFPTYPE_QUEUE_STATS_REPLY
5399 ofputil_count_queue_stats(const struct ofp_header *oh)
5403 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5404 ofpraw_pull_assert(&b);
5406 return b.size / ofputil_get_queue_stats_size(oh->version);
5410 ofputil_queue_stats_from_ofp10(struct ofputil_queue_stats *oqs,
5411 const struct ofp10_queue_stats *qs10)
5413 oqs->port_no = u16_to_ofp(ntohs(qs10->port_no));
5414 oqs->queue_id = ntohl(qs10->queue_id);
5415 oqs->tx_bytes = ntohll(get_32aligned_be64(&qs10->tx_bytes));
5416 oqs->tx_packets = ntohll(get_32aligned_be64(&qs10->tx_packets));
5417 oqs->tx_errors = ntohll(get_32aligned_be64(&qs10->tx_errors));
5418 oqs->duration_sec = oqs->duration_nsec = UINT32_MAX;
5424 ofputil_queue_stats_from_ofp11(struct ofputil_queue_stats *oqs,
5425 const struct ofp11_queue_stats *qs11)
5429 error = ofputil_port_from_ofp11(qs11->port_no, &oqs->port_no);
5434 oqs->queue_id = ntohl(qs11->queue_id);
5435 oqs->tx_bytes = ntohll(qs11->tx_bytes);
5436 oqs->tx_packets = ntohll(qs11->tx_packets);
5437 oqs->tx_errors = ntohll(qs11->tx_errors);
5438 oqs->duration_sec = oqs->duration_nsec = UINT32_MAX;
5444 ofputil_queue_stats_from_ofp13(struct ofputil_queue_stats *oqs,
5445 const struct ofp13_queue_stats *qs13)
5447 enum ofperr error = ofputil_queue_stats_from_ofp11(oqs, &qs13->qs);
5449 oqs->duration_sec = ntohl(qs13->duration_sec);
5450 oqs->duration_nsec = ntohl(qs13->duration_nsec);
5456 /* Converts an OFPST_QUEUE_STATS reply in 'msg' into an abstract
5457 * ofputil_queue_stats in 'qs'.
5459 * Multiple OFPST_QUEUE_STATS replies can be packed into a single OpenFlow
5460 * message. Calling this function multiple times for a single 'msg' iterates
5461 * through the replies. The caller must initially leave 'msg''s layer pointers
5462 * null and not modify them between calls.
5464 * Returns 0 if successful, EOF if no replies were left in this 'msg',
5465 * otherwise a positive errno value. */
5467 ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg)
5473 ? ofpraw_decode(&raw, msg->l2)
5474 : ofpraw_pull(&raw, msg));
5481 } else if (raw == OFPRAW_OFPST13_QUEUE_REPLY) {
5482 const struct ofp13_queue_stats *qs13;
5484 qs13 = ofpbuf_try_pull(msg, sizeof *qs13);
5488 return ofputil_queue_stats_from_ofp13(qs, qs13);
5489 } else if (raw == OFPRAW_OFPST11_QUEUE_REPLY) {
5490 const struct ofp11_queue_stats *qs11;
5492 qs11 = ofpbuf_try_pull(msg, sizeof *qs11);
5496 return ofputil_queue_stats_from_ofp11(qs, qs11);
5497 } else if (raw == OFPRAW_OFPST10_QUEUE_REPLY) {
5498 const struct ofp10_queue_stats *qs10;
5500 qs10 = ofpbuf_try_pull(msg, sizeof *qs10);
5504 return ofputil_queue_stats_from_ofp10(qs, qs10);
5510 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_QUEUE reply has %zu leftover "
5511 "bytes at end", msg->size);
5512 return OFPERR_OFPBRC_BAD_LEN;
5516 ofputil_queue_stats_to_ofp10(const struct ofputil_queue_stats *oqs,
5517 struct ofp10_queue_stats *qs10)
5519 qs10->port_no = htons(ofp_to_u16(oqs->port_no));
5520 memset(qs10->pad, 0, sizeof qs10->pad);
5521 qs10->queue_id = htonl(oqs->queue_id);
5522 put_32aligned_be64(&qs10->tx_bytes, htonll(oqs->tx_bytes));
5523 put_32aligned_be64(&qs10->tx_packets, htonll(oqs->tx_packets));
5524 put_32aligned_be64(&qs10->tx_errors, htonll(oqs->tx_errors));
5528 ofputil_queue_stats_to_ofp11(const struct ofputil_queue_stats *oqs,
5529 struct ofp11_queue_stats *qs11)
5531 qs11->port_no = ofputil_port_to_ofp11(oqs->port_no);
5532 qs11->queue_id = htonl(oqs->queue_id);
5533 qs11->tx_bytes = htonll(oqs->tx_bytes);
5534 qs11->tx_packets = htonll(oqs->tx_packets);
5535 qs11->tx_errors = htonll(oqs->tx_errors);
5539 ofputil_queue_stats_to_ofp13(const struct ofputil_queue_stats *oqs,
5540 struct ofp13_queue_stats *qs13)
5542 ofputil_queue_stats_to_ofp11(oqs, &qs13->qs);
5543 if (oqs->duration_sec != UINT32_MAX) {
5544 qs13->duration_sec = htonl(oqs->duration_sec);
5545 qs13->duration_nsec = htonl(oqs->duration_nsec);
5547 qs13->duration_sec = htonl(UINT32_MAX);
5548 qs13->duration_nsec = htonl(UINT32_MAX);
5552 /* Encode a queue stat for 'oqs' and append it to 'replies'. */
5554 ofputil_append_queue_stat(struct list *replies,
5555 const struct ofputil_queue_stats *oqs)
5557 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
5558 struct ofp_header *oh = msg->data;
5560 switch ((enum ofp_version)oh->version) {
5561 case OFP13_VERSION: {
5562 struct ofp13_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
5563 ofputil_queue_stats_to_ofp13(oqs, reply);
5568 case OFP11_VERSION: {
5569 struct ofp11_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
5570 ofputil_queue_stats_to_ofp11(oqs, reply);
5574 case OFP10_VERSION: {
5575 struct ofp10_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
5576 ofputil_queue_stats_to_ofp10(oqs, reply);