2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 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"
36 #include "ofp-actions.h"
37 #include "ofp-errors.h"
42 #include "openflow/netronome-ext.h"
46 #include "tun-metadata.h"
47 #include "unaligned.h"
48 #include "type-props.h"
49 #include "openvswitch/vlog.h"
52 VLOG_DEFINE_THIS_MODULE(ofp_util);
54 /* Rate limit for OpenFlow message parse errors. These always indicate a bug
55 * in the peer and so there's not much point in showing a lot of them. */
56 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
58 static enum ofputil_table_vacancy ofputil_decode_table_vacancy(
59 ovs_be32 config, enum ofp_version);
60 static enum ofputil_table_eviction ofputil_decode_table_eviction(
61 ovs_be32 config, enum ofp_version);
62 static ovs_be32 ofputil_encode_table_config(enum ofputil_table_miss,
63 enum ofputil_table_eviction,
64 enum ofputil_table_vacancy,
67 /* Given the wildcard bit count in the least-significant 6 of 'wcbits', returns
68 * an IP netmask with a 1 in each bit that must match and a 0 in each bit that
71 * The bits in 'wcbits' are in the format used in enum ofp_flow_wildcards: 0
72 * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
73 * ..., 32 and higher wildcard the entire field. This is the *opposite* of the
74 * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
77 ofputil_wcbits_to_netmask(int wcbits)
80 return wcbits < 32 ? htonl(~((1u << wcbits) - 1)) : 0;
83 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
84 * that it wildcards, that is, the number of 0-bits in 'netmask', a number
85 * between 0 and 32 inclusive.
87 * If 'netmask' is not a CIDR netmask (see ip_is_cidr()), the return value will
88 * still be in the valid range but isn't otherwise meaningful. */
90 ofputil_netmask_to_wcbits(ovs_be32 netmask)
92 return 32 - ip_count_cidr_bits(netmask);
95 /* Converts the OpenFlow 1.0 wildcards in 'ofpfw' (OFPFW10_*) into a
96 * flow_wildcards in 'wc' for use in struct match. It is the caller's
97 * responsibility to handle the special case where the flow match's dl_vlan is
98 * set to OFP_VLAN_NONE. */
100 ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *wc)
102 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 35);
104 /* Initialize most of wc. */
105 flow_wildcards_init_catchall(wc);
107 if (!(ofpfw & OFPFW10_IN_PORT)) {
108 wc->masks.in_port.ofp_port = u16_to_ofp(UINT16_MAX);
111 if (!(ofpfw & OFPFW10_NW_TOS)) {
112 wc->masks.nw_tos |= IP_DSCP_MASK;
115 if (!(ofpfw & OFPFW10_NW_PROTO)) {
116 wc->masks.nw_proto = UINT8_MAX;
118 wc->masks.nw_src = ofputil_wcbits_to_netmask(ofpfw
119 >> OFPFW10_NW_SRC_SHIFT);
120 wc->masks.nw_dst = ofputil_wcbits_to_netmask(ofpfw
121 >> OFPFW10_NW_DST_SHIFT);
123 if (!(ofpfw & OFPFW10_TP_SRC)) {
124 wc->masks.tp_src = OVS_BE16_MAX;
126 if (!(ofpfw & OFPFW10_TP_DST)) {
127 wc->masks.tp_dst = OVS_BE16_MAX;
130 if (!(ofpfw & OFPFW10_DL_SRC)) {
131 WC_MASK_FIELD(wc, dl_src);
133 if (!(ofpfw & OFPFW10_DL_DST)) {
134 WC_MASK_FIELD(wc, dl_dst);
136 if (!(ofpfw & OFPFW10_DL_TYPE)) {
137 wc->masks.dl_type = OVS_BE16_MAX;
141 if (!(ofpfw & OFPFW10_DL_VLAN_PCP)) {
142 wc->masks.vlan_tci |= htons(VLAN_PCP_MASK | VLAN_CFI);
144 if (!(ofpfw & OFPFW10_DL_VLAN)) {
145 wc->masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
149 /* Converts the ofp10_match in 'ofmatch' into a struct match in 'match'. */
151 ofputil_match_from_ofp10_match(const struct ofp10_match *ofmatch,
154 uint32_t ofpfw = ntohl(ofmatch->wildcards) & OFPFW10_ALL;
156 /* Initialize match->wc. */
157 memset(&match->flow, 0, sizeof match->flow);
158 ofputil_wildcard_from_ofpfw10(ofpfw, &match->wc);
160 /* Initialize most of match->flow. */
161 match->flow.nw_src = ofmatch->nw_src;
162 match->flow.nw_dst = ofmatch->nw_dst;
163 match->flow.in_port.ofp_port = u16_to_ofp(ntohs(ofmatch->in_port));
164 match->flow.dl_type = ofputil_dl_type_from_openflow(ofmatch->dl_type);
165 match->flow.tp_src = ofmatch->tp_src;
166 match->flow.tp_dst = ofmatch->tp_dst;
167 match->flow.dl_src = ofmatch->dl_src;
168 match->flow.dl_dst = ofmatch->dl_dst;
169 match->flow.nw_tos = ofmatch->nw_tos & IP_DSCP_MASK;
170 match->flow.nw_proto = ofmatch->nw_proto;
172 /* Translate VLANs. */
173 if (!(ofpfw & OFPFW10_DL_VLAN) &&
174 ofmatch->dl_vlan == htons(OFP10_VLAN_NONE)) {
175 /* Match only packets without 802.1Q header.
177 * When OFPFW10_DL_VLAN_PCP is wildcarded, this is obviously correct.
179 * If OFPFW10_DL_VLAN_PCP is matched, the flow match is contradictory,
180 * because we can't have a specific PCP without an 802.1Q header.
181 * However, older versions of OVS treated this as matching packets
182 * withut an 802.1Q header, so we do here too. */
183 match->flow.vlan_tci = htons(0);
184 match->wc.masks.vlan_tci = htons(0xffff);
186 ovs_be16 vid, pcp, tci;
189 vid = ofmatch->dl_vlan & htons(VLAN_VID_MASK);
190 hpcp = (ofmatch->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK;
192 tci = vid | pcp | htons(VLAN_CFI);
193 match->flow.vlan_tci = tci & match->wc.masks.vlan_tci;
197 match_zero_wildcarded_fields(match);
200 /* Convert 'match' into the OpenFlow 1.0 match structure 'ofmatch'. */
202 ofputil_match_to_ofp10_match(const struct match *match,
203 struct ofp10_match *ofmatch)
205 const struct flow_wildcards *wc = &match->wc;
208 /* Figure out most OpenFlow wildcards. */
210 if (!wc->masks.in_port.ofp_port) {
211 ofpfw |= OFPFW10_IN_PORT;
213 if (!wc->masks.dl_type) {
214 ofpfw |= OFPFW10_DL_TYPE;
216 if (!wc->masks.nw_proto) {
217 ofpfw |= OFPFW10_NW_PROTO;
219 ofpfw |= (ofputil_netmask_to_wcbits(wc->masks.nw_src)
220 << OFPFW10_NW_SRC_SHIFT);
221 ofpfw |= (ofputil_netmask_to_wcbits(wc->masks.nw_dst)
222 << OFPFW10_NW_DST_SHIFT);
223 if (!(wc->masks.nw_tos & IP_DSCP_MASK)) {
224 ofpfw |= OFPFW10_NW_TOS;
226 if (!wc->masks.tp_src) {
227 ofpfw |= OFPFW10_TP_SRC;
229 if (!wc->masks.tp_dst) {
230 ofpfw |= OFPFW10_TP_DST;
232 if (eth_addr_is_zero(wc->masks.dl_src)) {
233 ofpfw |= OFPFW10_DL_SRC;
235 if (eth_addr_is_zero(wc->masks.dl_dst)) {
236 ofpfw |= OFPFW10_DL_DST;
239 /* Translate VLANs. */
240 ofmatch->dl_vlan = htons(0);
241 ofmatch->dl_vlan_pcp = 0;
242 if (match->wc.masks.vlan_tci == htons(0)) {
243 ofpfw |= OFPFW10_DL_VLAN | OFPFW10_DL_VLAN_PCP;
244 } else if (match->wc.masks.vlan_tci & htons(VLAN_CFI)
245 && !(match->flow.vlan_tci & htons(VLAN_CFI))) {
246 ofmatch->dl_vlan = htons(OFP10_VLAN_NONE);
248 if (!(match->wc.masks.vlan_tci & htons(VLAN_VID_MASK))) {
249 ofpfw |= OFPFW10_DL_VLAN;
251 ofmatch->dl_vlan = htons(vlan_tci_to_vid(match->flow.vlan_tci));
254 if (!(match->wc.masks.vlan_tci & htons(VLAN_PCP_MASK))) {
255 ofpfw |= OFPFW10_DL_VLAN_PCP;
257 ofmatch->dl_vlan_pcp = vlan_tci_to_pcp(match->flow.vlan_tci);
261 /* Compose most of the match structure. */
262 ofmatch->wildcards = htonl(ofpfw);
263 ofmatch->in_port = htons(ofp_to_u16(match->flow.in_port.ofp_port));
264 ofmatch->dl_src = match->flow.dl_src;
265 ofmatch->dl_dst = match->flow.dl_dst;
266 ofmatch->dl_type = ofputil_dl_type_to_openflow(match->flow.dl_type);
267 ofmatch->nw_src = match->flow.nw_src;
268 ofmatch->nw_dst = match->flow.nw_dst;
269 ofmatch->nw_tos = match->flow.nw_tos & IP_DSCP_MASK;
270 ofmatch->nw_proto = match->flow.nw_proto;
271 ofmatch->tp_src = match->flow.tp_src;
272 ofmatch->tp_dst = match->flow.tp_dst;
273 memset(ofmatch->pad1, '\0', sizeof ofmatch->pad1);
274 memset(ofmatch->pad2, '\0', sizeof ofmatch->pad2);
278 ofputil_pull_ofp11_match(struct ofpbuf *buf, struct match *match,
279 uint16_t *padded_match_len)
281 struct ofp11_match_header *omh = buf->data;
284 if (buf->size < sizeof *omh) {
285 return OFPERR_OFPBMC_BAD_LEN;
288 match_len = ntohs(omh->length);
290 switch (ntohs(omh->type)) {
291 case OFPMT_STANDARD: {
292 struct ofp11_match *om;
294 if (match_len != sizeof *om || buf->size < sizeof *om) {
295 return OFPERR_OFPBMC_BAD_LEN;
297 om = ofpbuf_pull(buf, sizeof *om);
298 if (padded_match_len) {
299 *padded_match_len = match_len;
301 return ofputil_match_from_ofp11_match(om, match);
305 if (padded_match_len) {
306 *padded_match_len = ROUND_UP(match_len, 8);
308 return oxm_pull_match(buf, match);
311 return OFPERR_OFPBMC_BAD_TYPE;
315 /* Converts the ofp11_match in 'ofmatch' into a struct match in 'match'.
316 * Returns 0 if successful, otherwise an OFPERR_* value. */
318 ofputil_match_from_ofp11_match(const struct ofp11_match *ofmatch,
321 uint16_t wc = ntohl(ofmatch->wildcards);
322 bool ipv4, arp, rarp;
324 match_init_catchall(match);
326 if (!(wc & OFPFW11_IN_PORT)) {
330 error = ofputil_port_from_ofp11(ofmatch->in_port, &ofp_port);
332 return OFPERR_OFPBMC_BAD_VALUE;
334 match_set_in_port(match, ofp_port);
337 match_set_dl_src_masked(match, ofmatch->dl_src,
338 eth_addr_invert(ofmatch->dl_src_mask));
339 match_set_dl_dst_masked(match, ofmatch->dl_dst,
340 eth_addr_invert(ofmatch->dl_dst_mask));
342 if (!(wc & OFPFW11_DL_VLAN)) {
343 if (ofmatch->dl_vlan == htons(OFPVID11_NONE)) {
344 /* Match only packets without a VLAN tag. */
345 match->flow.vlan_tci = htons(0);
346 match->wc.masks.vlan_tci = OVS_BE16_MAX;
348 if (ofmatch->dl_vlan == htons(OFPVID11_ANY)) {
349 /* Match any packet with a VLAN tag regardless of VID. */
350 match->flow.vlan_tci = htons(VLAN_CFI);
351 match->wc.masks.vlan_tci = htons(VLAN_CFI);
352 } else if (ntohs(ofmatch->dl_vlan) < 4096) {
353 /* Match only packets with the specified VLAN VID. */
354 match->flow.vlan_tci = htons(VLAN_CFI) | ofmatch->dl_vlan;
355 match->wc.masks.vlan_tci = htons(VLAN_CFI | VLAN_VID_MASK);
358 return OFPERR_OFPBMC_BAD_VALUE;
361 if (!(wc & OFPFW11_DL_VLAN_PCP)) {
362 if (ofmatch->dl_vlan_pcp <= 7) {
363 match->flow.vlan_tci |= htons(ofmatch->dl_vlan_pcp
365 match->wc.masks.vlan_tci |= htons(VLAN_PCP_MASK);
368 return OFPERR_OFPBMC_BAD_VALUE;
374 if (!(wc & OFPFW11_DL_TYPE)) {
375 match_set_dl_type(match,
376 ofputil_dl_type_from_openflow(ofmatch->dl_type));
379 ipv4 = match->flow.dl_type == htons(ETH_TYPE_IP);
380 arp = match->flow.dl_type == htons(ETH_TYPE_ARP);
381 rarp = match->flow.dl_type == htons(ETH_TYPE_RARP);
383 if (ipv4 && !(wc & OFPFW11_NW_TOS)) {
384 if (ofmatch->nw_tos & ~IP_DSCP_MASK) {
386 return OFPERR_OFPBMC_BAD_VALUE;
389 match_set_nw_dscp(match, ofmatch->nw_tos);
392 if (ipv4 || arp || rarp) {
393 if (!(wc & OFPFW11_NW_PROTO)) {
394 match_set_nw_proto(match, ofmatch->nw_proto);
396 match_set_nw_src_masked(match, ofmatch->nw_src, ~ofmatch->nw_src_mask);
397 match_set_nw_dst_masked(match, ofmatch->nw_dst, ~ofmatch->nw_dst_mask);
400 #define OFPFW11_TP_ALL (OFPFW11_TP_SRC | OFPFW11_TP_DST)
401 if (ipv4 && (wc & OFPFW11_TP_ALL) != OFPFW11_TP_ALL) {
402 switch (match->flow.nw_proto) {
404 /* "A.2.3 Flow Match Structures" in OF1.1 says:
406 * The tp_src and tp_dst fields will be ignored unless the
407 * network protocol specified is as TCP, UDP or SCTP.
409 * but I'm pretty sure we should support ICMP too, otherwise
410 * that's a regression from OF1.0. */
411 if (!(wc & OFPFW11_TP_SRC)) {
412 uint16_t icmp_type = ntohs(ofmatch->tp_src);
413 if (icmp_type < 0x100) {
414 match_set_icmp_type(match, icmp_type);
416 return OFPERR_OFPBMC_BAD_FIELD;
419 if (!(wc & OFPFW11_TP_DST)) {
420 uint16_t icmp_code = ntohs(ofmatch->tp_dst);
421 if (icmp_code < 0x100) {
422 match_set_icmp_code(match, icmp_code);
424 return OFPERR_OFPBMC_BAD_FIELD;
432 if (!(wc & (OFPFW11_TP_SRC))) {
433 match_set_tp_src(match, ofmatch->tp_src);
435 if (!(wc & (OFPFW11_TP_DST))) {
436 match_set_tp_dst(match, ofmatch->tp_dst);
441 /* OF1.1 says explicitly to ignore this. */
446 if (eth_type_mpls(match->flow.dl_type)) {
447 if (!(wc & OFPFW11_MPLS_LABEL)) {
448 match_set_mpls_label(match, 0, ofmatch->mpls_label);
450 if (!(wc & OFPFW11_MPLS_TC)) {
451 match_set_mpls_tc(match, 0, ofmatch->mpls_tc);
455 match_set_metadata_masked(match, ofmatch->metadata,
456 ~ofmatch->metadata_mask);
461 /* Convert 'match' into the OpenFlow 1.1 match structure 'ofmatch'. */
463 ofputil_match_to_ofp11_match(const struct match *match,
464 struct ofp11_match *ofmatch)
468 memset(ofmatch, 0, sizeof *ofmatch);
469 ofmatch->omh.type = htons(OFPMT_STANDARD);
470 ofmatch->omh.length = htons(OFPMT11_STANDARD_LENGTH);
472 if (!match->wc.masks.in_port.ofp_port) {
473 wc |= OFPFW11_IN_PORT;
475 ofmatch->in_port = ofputil_port_to_ofp11(match->flow.in_port.ofp_port);
478 ofmatch->dl_src = match->flow.dl_src;
479 ofmatch->dl_src_mask = eth_addr_invert(match->wc.masks.dl_src);
480 ofmatch->dl_dst = match->flow.dl_dst;
481 ofmatch->dl_dst_mask = eth_addr_invert(match->wc.masks.dl_dst);
483 if (match->wc.masks.vlan_tci == htons(0)) {
484 wc |= OFPFW11_DL_VLAN | OFPFW11_DL_VLAN_PCP;
485 } else if (match->wc.masks.vlan_tci & htons(VLAN_CFI)
486 && !(match->flow.vlan_tci & htons(VLAN_CFI))) {
487 ofmatch->dl_vlan = htons(OFPVID11_NONE);
488 wc |= OFPFW11_DL_VLAN_PCP;
490 if (!(match->wc.masks.vlan_tci & htons(VLAN_VID_MASK))) {
491 ofmatch->dl_vlan = htons(OFPVID11_ANY);
493 ofmatch->dl_vlan = htons(vlan_tci_to_vid(match->flow.vlan_tci));
496 if (!(match->wc.masks.vlan_tci & htons(VLAN_PCP_MASK))) {
497 wc |= OFPFW11_DL_VLAN_PCP;
499 ofmatch->dl_vlan_pcp = vlan_tci_to_pcp(match->flow.vlan_tci);
503 if (!match->wc.masks.dl_type) {
504 wc |= OFPFW11_DL_TYPE;
506 ofmatch->dl_type = ofputil_dl_type_to_openflow(match->flow.dl_type);
509 if (!(match->wc.masks.nw_tos & IP_DSCP_MASK)) {
510 wc |= OFPFW11_NW_TOS;
512 ofmatch->nw_tos = match->flow.nw_tos & IP_DSCP_MASK;
515 if (!match->wc.masks.nw_proto) {
516 wc |= OFPFW11_NW_PROTO;
518 ofmatch->nw_proto = match->flow.nw_proto;
521 ofmatch->nw_src = match->flow.nw_src;
522 ofmatch->nw_src_mask = ~match->wc.masks.nw_src;
523 ofmatch->nw_dst = match->flow.nw_dst;
524 ofmatch->nw_dst_mask = ~match->wc.masks.nw_dst;
526 if (!match->wc.masks.tp_src) {
527 wc |= OFPFW11_TP_SRC;
529 ofmatch->tp_src = match->flow.tp_src;
532 if (!match->wc.masks.tp_dst) {
533 wc |= OFPFW11_TP_DST;
535 ofmatch->tp_dst = match->flow.tp_dst;
538 if (!(match->wc.masks.mpls_lse[0] & htonl(MPLS_LABEL_MASK))) {
539 wc |= OFPFW11_MPLS_LABEL;
541 ofmatch->mpls_label = htonl(mpls_lse_to_label(
542 match->flow.mpls_lse[0]));
545 if (!(match->wc.masks.mpls_lse[0] & htonl(MPLS_TC_MASK))) {
546 wc |= OFPFW11_MPLS_TC;
548 ofmatch->mpls_tc = mpls_lse_to_tc(match->flow.mpls_lse[0]);
551 ofmatch->metadata = match->flow.metadata;
552 ofmatch->metadata_mask = ~match->wc.masks.metadata;
554 ofmatch->wildcards = htonl(wc);
557 /* Returns the "typical" length of a match for 'protocol', for use in
558 * estimating space to preallocate. */
560 ofputil_match_typical_len(enum ofputil_protocol protocol)
563 case OFPUTIL_P_OF10_STD:
564 case OFPUTIL_P_OF10_STD_TID:
565 return sizeof(struct ofp10_match);
567 case OFPUTIL_P_OF10_NXM:
568 case OFPUTIL_P_OF10_NXM_TID:
569 return NXM_TYPICAL_LEN;
571 case OFPUTIL_P_OF11_STD:
572 return sizeof(struct ofp11_match);
574 case OFPUTIL_P_OF12_OXM:
575 case OFPUTIL_P_OF13_OXM:
576 case OFPUTIL_P_OF14_OXM:
577 case OFPUTIL_P_OF15_OXM:
578 return NXM_TYPICAL_LEN;
585 /* Appends to 'b' an struct ofp11_match_header followed by a match that
586 * expresses 'match' properly for 'protocol', plus enough zero bytes to pad the
587 * data appended out to a multiple of 8. 'protocol' must be one that is usable
588 * in OpenFlow 1.1 or later.
590 * This function can cause 'b''s data to be reallocated.
592 * Returns the number of bytes appended to 'b', excluding the padding. Never
595 ofputil_put_ofp11_match(struct ofpbuf *b, const struct match *match,
596 enum ofputil_protocol protocol)
599 case OFPUTIL_P_OF10_STD:
600 case OFPUTIL_P_OF10_STD_TID:
601 case OFPUTIL_P_OF10_NXM:
602 case OFPUTIL_P_OF10_NXM_TID:
605 case OFPUTIL_P_OF11_STD: {
606 struct ofp11_match *om;
608 /* Make sure that no padding is needed. */
609 BUILD_ASSERT_DECL(sizeof *om % 8 == 0);
611 om = ofpbuf_put_uninit(b, sizeof *om);
612 ofputil_match_to_ofp11_match(match, om);
616 case OFPUTIL_P_OF12_OXM:
617 case OFPUTIL_P_OF13_OXM:
618 case OFPUTIL_P_OF14_OXM:
619 case OFPUTIL_P_OF15_OXM:
620 return oxm_put_match(b, match,
621 ofputil_protocol_to_ofp_version(protocol));
627 /* Given a 'dl_type' value in the format used in struct flow, returns the
628 * corresponding 'dl_type' value for use in an ofp10_match or ofp11_match
631 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type)
633 return (flow_dl_type == htons(FLOW_DL_TYPE_NONE)
634 ? htons(OFP_DL_TYPE_NOT_ETH_TYPE)
638 /* Given a 'dl_type' value in the format used in an ofp10_match or ofp11_match
639 * structure, returns the corresponding 'dl_type' value for use in struct
642 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type)
644 return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
645 ? htons(FLOW_DL_TYPE_NONE)
651 struct proto_abbrev {
652 enum ofputil_protocol protocol;
656 /* Most users really don't care about some of the differences between
657 * protocols. These abbreviations help with that. */
658 static const struct proto_abbrev proto_abbrevs[] = {
659 { OFPUTIL_P_ANY, "any" },
660 { OFPUTIL_P_OF10_STD_ANY, "OpenFlow10" },
661 { OFPUTIL_P_OF10_NXM_ANY, "NXM" },
662 { OFPUTIL_P_ANY_OXM, "OXM" },
664 #define N_PROTO_ABBREVS ARRAY_SIZE(proto_abbrevs)
666 enum ofputil_protocol ofputil_flow_dump_protocols[] = {
675 size_t ofputil_n_flow_dump_protocols = ARRAY_SIZE(ofputil_flow_dump_protocols);
677 /* Returns the set of ofputil_protocols that are supported with the given
678 * OpenFlow 'version'. 'version' should normally be an 8-bit OpenFlow version
679 * identifier (e.g. 0x01 for OpenFlow 1.0, 0x02 for OpenFlow 1.1). Returns 0
680 * if 'version' is not supported or outside the valid range. */
681 enum ofputil_protocol
682 ofputil_protocols_from_ofp_version(enum ofp_version version)
686 return OFPUTIL_P_OF10_STD_ANY | OFPUTIL_P_OF10_NXM_ANY;
688 return OFPUTIL_P_OF11_STD;
690 return OFPUTIL_P_OF12_OXM;
692 return OFPUTIL_P_OF13_OXM;
694 return OFPUTIL_P_OF14_OXM;
696 return OFPUTIL_P_OF15_OXM;
702 /* Returns the ofputil_protocol that is initially in effect on an OpenFlow
703 * connection that has negotiated the given 'version'. 'version' should
704 * normally be an 8-bit OpenFlow version identifier (e.g. 0x01 for OpenFlow
705 * 1.0, 0x02 for OpenFlow 1.1). Returns 0 if 'version' is not supported or
706 * outside the valid range. */
707 enum ofputil_protocol
708 ofputil_protocol_from_ofp_version(enum ofp_version version)
710 return rightmost_1bit(ofputil_protocols_from_ofp_version(version));
713 /* Returns the OpenFlow protocol version number (e.g. OFP10_VERSION,
714 * etc.) that corresponds to 'protocol'. */
716 ofputil_protocol_to_ofp_version(enum ofputil_protocol protocol)
719 case OFPUTIL_P_OF10_STD:
720 case OFPUTIL_P_OF10_STD_TID:
721 case OFPUTIL_P_OF10_NXM:
722 case OFPUTIL_P_OF10_NXM_TID:
723 return OFP10_VERSION;
724 case OFPUTIL_P_OF11_STD:
725 return OFP11_VERSION;
726 case OFPUTIL_P_OF12_OXM:
727 return OFP12_VERSION;
728 case OFPUTIL_P_OF13_OXM:
729 return OFP13_VERSION;
730 case OFPUTIL_P_OF14_OXM:
731 return OFP14_VERSION;
732 case OFPUTIL_P_OF15_OXM:
733 return OFP15_VERSION;
739 /* Returns a bitmap of OpenFlow versions that are supported by at
740 * least one of the 'protocols'. */
742 ofputil_protocols_to_version_bitmap(enum ofputil_protocol protocols)
746 for (; protocols; protocols = zero_rightmost_1bit(protocols)) {
747 enum ofputil_protocol protocol = rightmost_1bit(protocols);
749 bitmap |= 1u << ofputil_protocol_to_ofp_version(protocol);
755 /* Returns the set of protocols that are supported on top of the
756 * OpenFlow versions included in 'bitmap'. */
757 enum ofputil_protocol
758 ofputil_protocols_from_version_bitmap(uint32_t bitmap)
760 enum ofputil_protocol protocols = 0;
762 for (; bitmap; bitmap = zero_rightmost_1bit(bitmap)) {
763 enum ofp_version version = rightmost_1bit_idx(bitmap);
765 protocols |= ofputil_protocols_from_ofp_version(version);
771 /* Returns true if 'protocol' is a single OFPUTIL_P_* value, false
774 ofputil_protocol_is_valid(enum ofputil_protocol protocol)
776 return protocol & OFPUTIL_P_ANY && is_pow2(protocol);
779 /* Returns the equivalent of 'protocol' with the Nicira flow_mod_table_id
780 * extension turned on or off if 'enable' is true or false, respectively.
782 * This extension is only useful for protocols whose "standard" version does
783 * not allow specific tables to be modified. In particular, this is true of
784 * OpenFlow 1.0. In later versions of OpenFlow, a flow_mod request always
785 * specifies a table ID and so there is no need for such an extension. When
786 * 'protocol' is such a protocol that doesn't need a flow_mod_table_id
787 * extension, this function just returns its 'protocol' argument unchanged
788 * regardless of the value of 'enable'. */
789 enum ofputil_protocol
790 ofputil_protocol_set_tid(enum ofputil_protocol protocol, bool enable)
793 case OFPUTIL_P_OF10_STD:
794 case OFPUTIL_P_OF10_STD_TID:
795 return enable ? OFPUTIL_P_OF10_STD_TID : OFPUTIL_P_OF10_STD;
797 case OFPUTIL_P_OF10_NXM:
798 case OFPUTIL_P_OF10_NXM_TID:
799 return enable ? OFPUTIL_P_OF10_NXM_TID : OFPUTIL_P_OF10_NXM;
801 case OFPUTIL_P_OF11_STD:
802 return OFPUTIL_P_OF11_STD;
804 case OFPUTIL_P_OF12_OXM:
805 return OFPUTIL_P_OF12_OXM;
807 case OFPUTIL_P_OF13_OXM:
808 return OFPUTIL_P_OF13_OXM;
810 case OFPUTIL_P_OF14_OXM:
811 return OFPUTIL_P_OF14_OXM;
813 case OFPUTIL_P_OF15_OXM:
814 return OFPUTIL_P_OF15_OXM;
821 /* Returns the "base" version of 'protocol'. That is, if 'protocol' includes
822 * some extension to a standard protocol version, the return value is the
823 * standard version of that protocol without any extension. If 'protocol' is a
824 * standard protocol version, returns 'protocol' unchanged. */
825 enum ofputil_protocol
826 ofputil_protocol_to_base(enum ofputil_protocol protocol)
828 return ofputil_protocol_set_tid(protocol, false);
831 /* Returns 'new_base' with any extensions taken from 'cur'. */
832 enum ofputil_protocol
833 ofputil_protocol_set_base(enum ofputil_protocol cur,
834 enum ofputil_protocol new_base)
836 bool tid = (cur & OFPUTIL_P_TID) != 0;
839 case OFPUTIL_P_OF10_STD:
840 case OFPUTIL_P_OF10_STD_TID:
841 return ofputil_protocol_set_tid(OFPUTIL_P_OF10_STD, tid);
843 case OFPUTIL_P_OF10_NXM:
844 case OFPUTIL_P_OF10_NXM_TID:
845 return ofputil_protocol_set_tid(OFPUTIL_P_OF10_NXM, tid);
847 case OFPUTIL_P_OF11_STD:
848 return ofputil_protocol_set_tid(OFPUTIL_P_OF11_STD, tid);
850 case OFPUTIL_P_OF12_OXM:
851 return ofputil_protocol_set_tid(OFPUTIL_P_OF12_OXM, tid);
853 case OFPUTIL_P_OF13_OXM:
854 return ofputil_protocol_set_tid(OFPUTIL_P_OF13_OXM, tid);
856 case OFPUTIL_P_OF14_OXM:
857 return ofputil_protocol_set_tid(OFPUTIL_P_OF14_OXM, tid);
859 case OFPUTIL_P_OF15_OXM:
860 return ofputil_protocol_set_tid(OFPUTIL_P_OF15_OXM, tid);
867 /* Returns a string form of 'protocol', if a simple form exists (that is, if
868 * 'protocol' is either a single protocol or it is a combination of protocols
869 * that have a single abbreviation). Otherwise, returns NULL. */
871 ofputil_protocol_to_string(enum ofputil_protocol protocol)
873 const struct proto_abbrev *p;
875 /* Use a "switch" statement for single-bit names so that we get a compiler
876 * warning if we forget any. */
878 case OFPUTIL_P_OF10_NXM:
879 return "NXM-table_id";
881 case OFPUTIL_P_OF10_NXM_TID:
882 return "NXM+table_id";
884 case OFPUTIL_P_OF10_STD:
885 return "OpenFlow10-table_id";
887 case OFPUTIL_P_OF10_STD_TID:
888 return "OpenFlow10+table_id";
890 case OFPUTIL_P_OF11_STD:
893 case OFPUTIL_P_OF12_OXM:
894 return "OXM-OpenFlow12";
896 case OFPUTIL_P_OF13_OXM:
897 return "OXM-OpenFlow13";
899 case OFPUTIL_P_OF14_OXM:
900 return "OXM-OpenFlow14";
902 case OFPUTIL_P_OF15_OXM:
903 return "OXM-OpenFlow15";
906 /* Check abbreviations. */
907 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
908 if (protocol == p->protocol) {
916 /* Returns a string that represents 'protocols'. The return value might be a
917 * comma-separated list if 'protocols' doesn't have a simple name. The return
918 * value is "none" if 'protocols' is 0.
920 * The caller must free the returned string (with free()). */
922 ofputil_protocols_to_string(enum ofputil_protocol protocols)
926 ovs_assert(!(protocols & ~OFPUTIL_P_ANY));
927 if (protocols == 0) {
928 return xstrdup("none");
933 const struct proto_abbrev *p;
937 ds_put_char(&s, ',');
940 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
941 if ((protocols & p->protocol) == p->protocol) {
942 ds_put_cstr(&s, p->name);
943 protocols &= ~p->protocol;
948 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
949 enum ofputil_protocol bit = 1u << i;
951 if (protocols & bit) {
952 ds_put_cstr(&s, ofputil_protocol_to_string(bit));
961 return ds_steal_cstr(&s);
964 static enum ofputil_protocol
965 ofputil_protocol_from_string__(const char *s, size_t n)
967 const struct proto_abbrev *p;
970 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
971 enum ofputil_protocol bit = 1u << i;
972 const char *name = ofputil_protocol_to_string(bit);
974 if (name && n == strlen(name) && !strncasecmp(s, name, n)) {
979 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
980 if (n == strlen(p->name) && !strncasecmp(s, p->name, n)) {
988 /* Returns the nonempty set of protocols represented by 's', which can be a
989 * single protocol name or abbreviation or a comma-separated list of them.
991 * Aborts the program with an error message if 's' is invalid. */
992 enum ofputil_protocol
993 ofputil_protocols_from_string(const char *s)
995 const char *orig_s = s;
996 enum ofputil_protocol protocols;
1000 enum ofputil_protocol p;
1003 n = strcspn(s, ",");
1009 p = ofputil_protocol_from_string__(s, n);
1011 ovs_fatal(0, "%.*s: unknown flow protocol", (int) n, s);
1019 ovs_fatal(0, "%s: no flow protocol specified", orig_s);
1025 ofputil_version_from_string(const char *s)
1027 if (!strcasecmp(s, "OpenFlow10")) {
1028 return OFP10_VERSION;
1030 if (!strcasecmp(s, "OpenFlow11")) {
1031 return OFP11_VERSION;
1033 if (!strcasecmp(s, "OpenFlow12")) {
1034 return OFP12_VERSION;
1036 if (!strcasecmp(s, "OpenFlow13")) {
1037 return OFP13_VERSION;
1039 if (!strcasecmp(s, "OpenFlow14")) {
1040 return OFP14_VERSION;
1042 if (!strcasecmp(s, "OpenFlow15")) {
1043 return OFP15_VERSION;
1049 is_delimiter(unsigned char c)
1051 return isspace(c) || c == ',';
1055 ofputil_versions_from_string(const char *s)
1058 uint32_t bitmap = 0;
1065 if (is_delimiter(s[i])) {
1070 while (s[i + j] && !is_delimiter(s[i + j])) {
1073 key = xmemdup0(s + i, j);
1074 version = ofputil_version_from_string(key);
1076 VLOG_FATAL("Unknown OpenFlow version: \"%s\"", key);
1079 bitmap |= 1u << version;
1087 ofputil_versions_from_strings(char ** const s, size_t count)
1089 uint32_t bitmap = 0;
1092 int version = ofputil_version_from_string(s[count]);
1094 VLOG_WARN("Unknown OpenFlow version: \"%s\"", s[count]);
1096 bitmap |= 1u << version;
1104 ofputil_version_to_string(enum ofp_version ofp_version)
1106 switch (ofp_version) {
1108 return "OpenFlow10";
1110 return "OpenFlow11";
1112 return "OpenFlow12";
1114 return "OpenFlow13";
1116 return "OpenFlow14";
1118 return "OpenFlow15";
1125 ofputil_packet_in_format_is_valid(enum nx_packet_in_format packet_in_format)
1127 switch (packet_in_format) {
1128 case NXPIF_STANDARD:
1129 case NXPIF_NXT_PACKET_IN:
1130 case NXPIF_NXT_PACKET_IN2:
1138 ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format)
1140 switch (packet_in_format) {
1141 case NXPIF_STANDARD:
1143 case NXPIF_NXT_PACKET_IN:
1144 return "nxt_packet_in";
1145 case NXPIF_NXT_PACKET_IN2:
1146 return "nxt_packet_in2";
1153 ofputil_packet_in_format_from_string(const char *s)
1155 return (!strcmp(s, "standard") || !strcmp(s, "openflow10")
1157 : !strcmp(s, "nxt_packet_in") || !strcmp(s, "nxm")
1158 ? NXPIF_NXT_PACKET_IN
1159 : !strcmp(s, "nxt_packet_in2")
1160 ? NXPIF_NXT_PACKET_IN2
1165 ofputil_format_version(struct ds *msg, enum ofp_version version)
1167 ds_put_format(msg, "0x%02x", version);
1171 ofputil_format_version_name(struct ds *msg, enum ofp_version version)
1173 ds_put_cstr(msg, ofputil_version_to_string(version));
1177 ofputil_format_version_bitmap__(struct ds *msg, uint32_t bitmap,
1178 void (*format_version)(struct ds *msg,
1182 format_version(msg, raw_ctz(bitmap));
1183 bitmap = zero_rightmost_1bit(bitmap);
1185 ds_put_cstr(msg, ", ");
1191 ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap)
1193 ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version);
1197 ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap)
1199 ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version_name);
1203 ofputil_decode_hello_bitmap(const struct ofp_hello_elem_header *oheh,
1204 uint32_t *allowed_versionsp)
1206 uint16_t bitmap_len = ntohs(oheh->length) - sizeof *oheh;
1207 const ovs_be32 *bitmap = ALIGNED_CAST(const ovs_be32 *, oheh + 1);
1208 uint32_t allowed_versions;
1210 if (!bitmap_len || bitmap_len % sizeof *bitmap) {
1214 /* Only use the first 32-bit element of the bitmap as that is all the
1215 * current implementation supports. Subsequent elements are ignored which
1216 * should have no effect on session negotiation until Open vSwitch supports
1217 * wire-protocol versions greater than 31.
1219 allowed_versions = ntohl(bitmap[0]);
1221 if (allowed_versions & 1) {
1222 /* There's no OpenFlow version 0. */
1223 VLOG_WARN_RL(&bad_ofmsg_rl, "peer claims to support invalid OpenFlow "
1225 allowed_versions &= ~1u;
1228 if (!allowed_versions) {
1229 VLOG_WARN_RL(&bad_ofmsg_rl, "peer does not support any OpenFlow "
1230 "version (between 0x01 and 0x1f)");
1234 *allowed_versionsp = allowed_versions;
1239 version_bitmap_from_version(uint8_t ofp_version)
1241 return ((ofp_version < 32 ? 1u << ofp_version : 0) - 1) << 1;
1244 /* Decodes OpenFlow OFPT_HELLO message 'oh', storing into '*allowed_versions'
1245 * the set of OpenFlow versions for which 'oh' announces support.
1247 * Because of how OpenFlow defines OFPT_HELLO messages, this function is always
1248 * successful, and thus '*allowed_versions' is always initialized. However, it
1249 * returns false if 'oh' contains some data that could not be fully understood,
1250 * true if 'oh' was completely parsed. */
1252 ofputil_decode_hello(const struct ofp_header *oh, uint32_t *allowed_versions)
1254 struct ofpbuf msg = ofpbuf_const_initializer(oh, ntohs(oh->length));
1255 ofpbuf_pull(&msg, sizeof *oh);
1257 *allowed_versions = version_bitmap_from_version(oh->version);
1261 const struct ofp_hello_elem_header *oheh;
1264 if (msg.size < sizeof *oheh) {
1269 len = ntohs(oheh->length);
1270 if (len < sizeof *oheh || !ofpbuf_try_pull(&msg, ROUND_UP(len, 8))) {
1274 if (oheh->type != htons(OFPHET_VERSIONBITMAP)
1275 || !ofputil_decode_hello_bitmap(oheh, allowed_versions)) {
1283 /* Returns true if 'allowed_versions' needs to be accompanied by a version
1284 * bitmap to be correctly expressed in an OFPT_HELLO message. */
1286 should_send_version_bitmap(uint32_t allowed_versions)
1288 return !is_pow2((allowed_versions >> 1) + 1);
1291 /* Create an OFPT_HELLO message that expresses support for the OpenFlow
1292 * versions in the 'allowed_versions' bitmaps and returns the message. */
1294 ofputil_encode_hello(uint32_t allowed_versions)
1296 enum ofp_version ofp_version;
1299 ofp_version = leftmost_1bit_idx(allowed_versions);
1300 msg = ofpraw_alloc(OFPRAW_OFPT_HELLO, ofp_version, 0);
1302 if (should_send_version_bitmap(allowed_versions)) {
1303 struct ofp_hello_elem_header *oheh;
1306 map_len = sizeof allowed_versions;
1307 oheh = ofpbuf_put_zeros(msg, ROUND_UP(map_len + sizeof *oheh, 8));
1308 oheh->type = htons(OFPHET_VERSIONBITMAP);
1309 oheh->length = htons(map_len + sizeof *oheh);
1310 *ALIGNED_CAST(ovs_be32 *, oheh + 1) = htonl(allowed_versions);
1312 ofpmsg_update_length(msg);
1318 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
1319 * protocol is 'current', at least partly transitions the protocol to 'want'.
1320 * Stores in '*next' the protocol that will be in effect on the OpenFlow
1321 * connection if the switch processes the returned message correctly. (If
1322 * '*next != want' then the caller will have to iterate.)
1324 * If 'current == want', or if it is not possible to transition from 'current'
1325 * to 'want' (because, for example, 'current' and 'want' use different OpenFlow
1326 * protocol versions), returns NULL and stores 'current' in '*next'. */
1328 ofputil_encode_set_protocol(enum ofputil_protocol current,
1329 enum ofputil_protocol want,
1330 enum ofputil_protocol *next)
1332 enum ofp_version cur_version, want_version;
1333 enum ofputil_protocol cur_base, want_base;
1334 bool cur_tid, want_tid;
1336 cur_version = ofputil_protocol_to_ofp_version(current);
1337 want_version = ofputil_protocol_to_ofp_version(want);
1338 if (cur_version != want_version) {
1343 cur_base = ofputil_protocol_to_base(current);
1344 want_base = ofputil_protocol_to_base(want);
1345 if (cur_base != want_base) {
1346 *next = ofputil_protocol_set_base(current, want_base);
1348 switch (want_base) {
1349 case OFPUTIL_P_OF10_NXM:
1350 return ofputil_encode_nx_set_flow_format(NXFF_NXM);
1352 case OFPUTIL_P_OF10_STD:
1353 return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10);
1355 case OFPUTIL_P_OF11_STD:
1356 case OFPUTIL_P_OF12_OXM:
1357 case OFPUTIL_P_OF13_OXM:
1358 case OFPUTIL_P_OF14_OXM:
1359 case OFPUTIL_P_OF15_OXM:
1360 /* There is only one variant of each OpenFlow 1.1+ protocol, and we
1361 * verified above that we're not trying to change versions. */
1364 case OFPUTIL_P_OF10_STD_TID:
1365 case OFPUTIL_P_OF10_NXM_TID:
1370 cur_tid = (current & OFPUTIL_P_TID) != 0;
1371 want_tid = (want & OFPUTIL_P_TID) != 0;
1372 if (cur_tid != want_tid) {
1373 *next = ofputil_protocol_set_tid(current, want_tid);
1374 return ofputil_make_flow_mod_table_id(want_tid);
1377 ovs_assert(current == want);
1383 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1384 * format to 'nxff'. */
1386 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff)
1388 struct nx_set_flow_format *sff;
1391 ovs_assert(ofputil_nx_flow_format_is_valid(nxff));
1393 msg = ofpraw_alloc(OFPRAW_NXT_SET_FLOW_FORMAT, OFP10_VERSION, 0);
1394 sff = ofpbuf_put_zeros(msg, sizeof *sff);
1395 sff->format = htonl(nxff);
1400 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1402 enum ofputil_protocol
1403 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format)
1405 switch (flow_format) {
1406 case NXFF_OPENFLOW10:
1407 return OFPUTIL_P_OF10_STD;
1410 return OFPUTIL_P_OF10_NXM;
1417 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1419 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format)
1421 return ofputil_nx_flow_format_to_protocol(flow_format) != 0;
1424 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1427 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format)
1429 switch (flow_format) {
1430 case NXFF_OPENFLOW10:
1431 return "openflow10";
1440 ofputil_make_set_packet_in_format(enum ofp_version ofp_version,
1441 enum nx_packet_in_format packet_in_format)
1443 struct nx_set_packet_in_format *spif;
1446 msg = ofpraw_alloc(OFPRAW_NXT_SET_PACKET_IN_FORMAT, ofp_version, 0);
1447 spif = ofpbuf_put_zeros(msg, sizeof *spif);
1448 spif->format = htonl(packet_in_format);
1453 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1454 * extension on or off (according to 'flow_mod_table_id'). */
1456 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
1458 struct nx_flow_mod_table_id *nfmti;
1461 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION, 0);
1462 nfmti = ofpbuf_put_zeros(msg, sizeof *nfmti);
1463 nfmti->set = flow_mod_table_id;
1467 struct ofputil_flow_mod_flag {
1469 enum ofp_version min_version, max_version;
1470 enum ofputil_flow_mod_flags flag;
1473 static const struct ofputil_flow_mod_flag ofputil_flow_mod_flags[] = {
1474 { OFPFF_SEND_FLOW_REM, OFP10_VERSION, 0, OFPUTIL_FF_SEND_FLOW_REM },
1475 { OFPFF_CHECK_OVERLAP, OFP10_VERSION, 0, OFPUTIL_FF_CHECK_OVERLAP },
1476 { OFPFF10_EMERG, OFP10_VERSION, OFP10_VERSION,
1478 { OFPFF12_RESET_COUNTS, OFP12_VERSION, 0, OFPUTIL_FF_RESET_COUNTS },
1479 { OFPFF13_NO_PKT_COUNTS, OFP13_VERSION, 0, OFPUTIL_FF_NO_PKT_COUNTS },
1480 { OFPFF13_NO_BYT_COUNTS, OFP13_VERSION, 0, OFPUTIL_FF_NO_BYT_COUNTS },
1485 ofputil_decode_flow_mod_flags(ovs_be16 raw_flags_,
1486 enum ofp_flow_mod_command command,
1487 enum ofp_version version,
1488 enum ofputil_flow_mod_flags *flagsp)
1490 uint16_t raw_flags = ntohs(raw_flags_);
1491 const struct ofputil_flow_mod_flag *f;
1494 for (f = ofputil_flow_mod_flags; f->raw_flag; f++) {
1495 if (raw_flags & f->raw_flag
1496 && version >= f->min_version
1497 && (!f->max_version || version <= f->max_version)) {
1498 raw_flags &= ~f->raw_flag;
1503 /* In OF1.0 and OF1.1, "add" always resets counters, and other commands
1506 * In OF1.2 and later, OFPFF12_RESET_COUNTS controls whether each command
1507 * resets counters. */
1508 if ((version == OFP10_VERSION || version == OFP11_VERSION)
1509 && command == OFPFC_ADD) {
1510 *flagsp |= OFPUTIL_FF_RESET_COUNTS;
1513 return raw_flags ? OFPERR_OFPFMFC_BAD_FLAGS : 0;
1517 ofputil_encode_flow_mod_flags(enum ofputil_flow_mod_flags flags,
1518 enum ofp_version version)
1520 const struct ofputil_flow_mod_flag *f;
1524 for (f = ofputil_flow_mod_flags; f->raw_flag; f++) {
1526 && version >= f->min_version
1527 && (!f->max_version || version <= f->max_version)) {
1528 raw_flags |= f->raw_flag;
1532 return htons(raw_flags);
1535 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1536 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
1539 * Uses 'ofpacts' to store the abstract OFPACT_* version of 'oh''s actions.
1540 * The caller must initialize 'ofpacts' and retains ownership of it.
1541 * 'fm->ofpacts' will point into the 'ofpacts' buffer.
1543 * Does not validate the flow_mod actions. The caller should do that, with
1544 * ofpacts_check(). */
1546 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
1547 const struct ofp_header *oh,
1548 enum ofputil_protocol protocol,
1549 struct ofpbuf *ofpacts,
1550 ofp_port_t max_port, uint8_t max_table)
1555 /* Ignored for non-delete actions */
1556 fm->delete_reason = OFPRR_DELETE;
1558 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
1559 enum ofpraw raw = ofpraw_pull_assert(&b);
1560 if (raw == OFPRAW_OFPT11_FLOW_MOD) {
1561 /* Standard OpenFlow 1.1+ flow_mod. */
1562 const struct ofp11_flow_mod *ofm;
1564 ofm = ofpbuf_pull(&b, sizeof *ofm);
1566 error = ofputil_pull_ofp11_match(&b, &fm->match, NULL);
1571 /* Translate the message. */
1572 fm->priority = ntohs(ofm->priority);
1573 if (ofm->command == OFPFC_ADD
1574 || (oh->version == OFP11_VERSION
1575 && (ofm->command == OFPFC_MODIFY ||
1576 ofm->command == OFPFC_MODIFY_STRICT)
1577 && ofm->cookie_mask == htonll(0))) {
1578 /* In OpenFlow 1.1 only, a "modify" or "modify-strict" that does
1579 * not match on the cookie is treated as an "add" if there is no
1581 fm->cookie = htonll(0);
1582 fm->cookie_mask = htonll(0);
1583 fm->new_cookie = ofm->cookie;
1585 fm->cookie = ofm->cookie;
1586 fm->cookie_mask = ofm->cookie_mask;
1587 fm->new_cookie = OVS_BE64_MAX;
1589 fm->modify_cookie = false;
1590 fm->command = ofm->command;
1594 * OF1.1 entirely forbids table_id == OFPTT_ALL.
1595 * OF1.2+ allows table_id == OFPTT_ALL only for deletes. */
1596 fm->table_id = ofm->table_id;
1597 if (fm->table_id == OFPTT_ALL
1598 && (oh->version == OFP11_VERSION
1599 || (ofm->command != OFPFC_DELETE &&
1600 ofm->command != OFPFC_DELETE_STRICT))) {
1601 return OFPERR_OFPFMFC_BAD_TABLE_ID;
1604 fm->idle_timeout = ntohs(ofm->idle_timeout);
1605 fm->hard_timeout = ntohs(ofm->hard_timeout);
1606 if (oh->version >= OFP14_VERSION && ofm->command == OFPFC_ADD) {
1607 fm->importance = ntohs(ofm->importance);
1611 fm->buffer_id = ntohl(ofm->buffer_id);
1612 error = ofputil_port_from_ofp11(ofm->out_port, &fm->out_port);
1617 fm->out_group = (ofm->command == OFPFC_DELETE ||
1618 ofm->command == OFPFC_DELETE_STRICT
1619 ? ntohl(ofm->out_group)
1621 raw_flags = ofm->flags;
1625 if (raw == OFPRAW_OFPT10_FLOW_MOD) {
1626 /* Standard OpenFlow 1.0 flow_mod. */
1627 const struct ofp10_flow_mod *ofm;
1629 /* Get the ofp10_flow_mod. */
1630 ofm = ofpbuf_pull(&b, sizeof *ofm);
1632 /* Translate the rule. */
1633 ofputil_match_from_ofp10_match(&ofm->match, &fm->match);
1634 ofputil_normalize_match(&fm->match);
1636 /* OpenFlow 1.0 says that exact-match rules have to have the
1637 * highest possible priority. */
1638 fm->priority = (ofm->match.wildcards & htonl(OFPFW10_ALL)
1639 ? ntohs(ofm->priority)
1642 /* Translate the message. */
1643 command = ntohs(ofm->command);
1644 fm->cookie = htonll(0);
1645 fm->cookie_mask = htonll(0);
1646 fm->new_cookie = ofm->cookie;
1647 fm->idle_timeout = ntohs(ofm->idle_timeout);
1648 fm->hard_timeout = ntohs(ofm->hard_timeout);
1650 fm->buffer_id = ntohl(ofm->buffer_id);
1651 fm->out_port = u16_to_ofp(ntohs(ofm->out_port));
1652 fm->out_group = OFPG_ANY;
1653 raw_flags = ofm->flags;
1654 } else if (raw == OFPRAW_NXT_FLOW_MOD) {
1655 /* Nicira extended flow_mod. */
1656 const struct nx_flow_mod *nfm;
1658 /* Dissect the message. */
1659 nfm = ofpbuf_pull(&b, sizeof *nfm);
1660 error = nx_pull_match(&b, ntohs(nfm->match_len),
1661 &fm->match, &fm->cookie, &fm->cookie_mask);
1666 /* Translate the message. */
1667 command = ntohs(nfm->command);
1668 if ((command & 0xff) == OFPFC_ADD && fm->cookie_mask) {
1669 /* Flow additions may only set a new cookie, not match an
1670 * existing cookie. */
1671 return OFPERR_NXBRC_NXM_INVALID;
1673 fm->priority = ntohs(nfm->priority);
1674 fm->new_cookie = nfm->cookie;
1675 fm->idle_timeout = ntohs(nfm->idle_timeout);
1676 fm->hard_timeout = ntohs(nfm->hard_timeout);
1678 fm->buffer_id = ntohl(nfm->buffer_id);
1679 fm->out_port = u16_to_ofp(ntohs(nfm->out_port));
1680 fm->out_group = OFPG_ANY;
1681 raw_flags = nfm->flags;
1686 fm->modify_cookie = fm->new_cookie != OVS_BE64_MAX;
1687 if (protocol & OFPUTIL_P_TID) {
1688 fm->command = command & 0xff;
1689 fm->table_id = command >> 8;
1691 if (command > 0xff) {
1692 VLOG_WARN_RL(&bad_ofmsg_rl, "flow_mod has explicit table_id "
1693 "but flow_mod_table_id extension is not enabled");
1695 fm->command = command;
1696 fm->table_id = 0xff;
1700 if (fm->command > OFPFC_DELETE_STRICT) {
1701 return OFPERR_OFPFMFC_BAD_COMMAND;
1704 error = ofpacts_pull_openflow_instructions(&b, b.size,
1705 oh->version, ofpacts);
1709 fm->ofpacts = ofpacts->data;
1710 fm->ofpacts_len = ofpacts->size;
1712 error = ofputil_decode_flow_mod_flags(raw_flags, fm->command,
1713 oh->version, &fm->flags);
1718 if (fm->flags & OFPUTIL_FF_EMERG) {
1719 /* We do not support the OpenFlow 1.0 emergency flow cache, which
1720 * is not required in OpenFlow 1.0.1 and removed from OpenFlow 1.1.
1722 * OpenFlow 1.0 specifies the error code to use when idle_timeout
1723 * or hard_timeout is nonzero. Otherwise, there is no good error
1724 * code, so just state that the flow table is full. */
1725 return (fm->hard_timeout || fm->idle_timeout
1726 ? OFPERR_OFPFMFC_BAD_EMERG_TIMEOUT
1727 : OFPERR_OFPFMFC_TABLE_FULL);
1730 return ofpacts_check_consistency(fm->ofpacts, fm->ofpacts_len,
1731 &fm->match.flow, max_port,
1732 fm->table_id, max_table, protocol);
1736 ofputil_pull_bands(struct ofpbuf *msg, size_t len, uint16_t *n_bands,
1737 struct ofpbuf *bands)
1739 const struct ofp13_meter_band_header *ombh;
1740 struct ofputil_meter_band *mb;
1743 ombh = ofpbuf_try_pull(msg, len);
1745 return OFPERR_OFPBRC_BAD_LEN;
1748 while (len >= sizeof (struct ofp13_meter_band_drop)) {
1749 size_t ombh_len = ntohs(ombh->len);
1750 /* All supported band types have the same length. */
1751 if (ombh_len != sizeof (struct ofp13_meter_band_drop)) {
1752 return OFPERR_OFPBRC_BAD_LEN;
1754 mb = ofpbuf_put_uninit(bands, sizeof *mb);
1755 mb->type = ntohs(ombh->type);
1756 if (mb->type != OFPMBT13_DROP && mb->type != OFPMBT13_DSCP_REMARK) {
1757 return OFPERR_OFPMMFC_BAD_BAND;
1759 mb->rate = ntohl(ombh->rate);
1760 mb->burst_size = ntohl(ombh->burst_size);
1761 mb->prec_level = (mb->type == OFPMBT13_DSCP_REMARK) ?
1762 ((struct ofp13_meter_band_dscp_remark *)ombh)->prec_level : 0;
1765 ombh = ALIGNED_CAST(struct ofp13_meter_band_header *,
1766 (char *) ombh + ombh_len);
1769 return OFPERR_OFPBRC_BAD_LEN;
1776 ofputil_decode_meter_mod(const struct ofp_header *oh,
1777 struct ofputil_meter_mod *mm,
1778 struct ofpbuf *bands)
1780 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
1781 ofpraw_pull_assert(&b);
1782 const struct ofp13_meter_mod *omm = ofpbuf_pull(&b, sizeof *omm);
1784 /* Translate the message. */
1785 mm->command = ntohs(omm->command);
1786 if (mm->command != OFPMC13_ADD &&
1787 mm->command != OFPMC13_MODIFY &&
1788 mm->command != OFPMC13_DELETE) {
1789 return OFPERR_OFPMMFC_BAD_COMMAND;
1791 mm->meter.meter_id = ntohl(omm->meter_id);
1793 if (mm->command == OFPMC13_DELETE) {
1794 mm->meter.flags = 0;
1795 mm->meter.n_bands = 0;
1796 mm->meter.bands = NULL;
1800 mm->meter.flags = ntohs(omm->flags);
1801 if (mm->meter.flags & OFPMF13_KBPS &&
1802 mm->meter.flags & OFPMF13_PKTPS) {
1803 return OFPERR_OFPMMFC_BAD_FLAGS;
1805 mm->meter.bands = bands->data;
1807 error = ofputil_pull_bands(&b, b.size, &mm->meter.n_bands, bands);
1816 ofputil_decode_meter_request(const struct ofp_header *oh, uint32_t *meter_id)
1818 const struct ofp13_meter_multipart_request *omr = ofpmsg_body(oh);
1819 *meter_id = ntohl(omr->meter_id);
1823 ofputil_encode_meter_request(enum ofp_version ofp_version,
1824 enum ofputil_meter_request_type type,
1832 case OFPUTIL_METER_CONFIG:
1833 raw = OFPRAW_OFPST13_METER_CONFIG_REQUEST;
1835 case OFPUTIL_METER_STATS:
1836 raw = OFPRAW_OFPST13_METER_REQUEST;
1839 case OFPUTIL_METER_FEATURES:
1840 raw = OFPRAW_OFPST13_METER_FEATURES_REQUEST;
1844 msg = ofpraw_alloc(raw, ofp_version, 0);
1846 if (type != OFPUTIL_METER_FEATURES) {
1847 struct ofp13_meter_multipart_request *omr;
1848 omr = ofpbuf_put_zeros(msg, sizeof *omr);
1849 omr->meter_id = htonl(meter_id);
1855 ofputil_put_bands(uint16_t n_bands, const struct ofputil_meter_band *mb,
1860 for (n = 0; n < n_bands; ++n) {
1861 /* Currently all band types have same size. */
1862 struct ofp13_meter_band_dscp_remark *ombh;
1863 size_t ombh_len = sizeof *ombh;
1865 ombh = ofpbuf_put_zeros(msg, ombh_len);
1867 ombh->type = htons(mb->type);
1868 ombh->len = htons(ombh_len);
1869 ombh->rate = htonl(mb->rate);
1870 ombh->burst_size = htonl(mb->burst_size);
1871 ombh->prec_level = mb->prec_level;
1877 /* Encode a meter stat for 'mc' and append it to 'replies'. */
1879 ofputil_append_meter_config(struct ovs_list *replies,
1880 const struct ofputil_meter_config *mc)
1882 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
1883 size_t start_ofs = msg->size;
1884 struct ofp13_meter_config *reply;
1886 ofpbuf_put_uninit(msg, sizeof *reply);
1887 ofputil_put_bands(mc->n_bands, mc->bands, msg);
1889 reply = ofpbuf_at_assert(msg, start_ofs, sizeof *reply);
1890 reply->flags = htons(mc->flags);
1891 reply->meter_id = htonl(mc->meter_id);
1892 reply->length = htons(msg->size - start_ofs);
1894 ofpmp_postappend(replies, start_ofs);
1897 /* Encode a meter stat for 'ms' and append it to 'replies'. */
1899 ofputil_append_meter_stats(struct ovs_list *replies,
1900 const struct ofputil_meter_stats *ms)
1902 struct ofp13_meter_stats *reply;
1906 len = sizeof *reply + ms->n_bands * sizeof(struct ofp13_meter_band_stats);
1907 reply = ofpmp_append(replies, len);
1909 reply->meter_id = htonl(ms->meter_id);
1910 reply->len = htons(len);
1911 memset(reply->pad, 0, sizeof reply->pad);
1912 reply->flow_count = htonl(ms->flow_count);
1913 reply->packet_in_count = htonll(ms->packet_in_count);
1914 reply->byte_in_count = htonll(ms->byte_in_count);
1915 reply->duration_sec = htonl(ms->duration_sec);
1916 reply->duration_nsec = htonl(ms->duration_nsec);
1918 for (n = 0; n < ms->n_bands; ++n) {
1919 const struct ofputil_meter_band_stats *src = &ms->bands[n];
1920 struct ofp13_meter_band_stats *dst = &reply->band_stats[n];
1922 dst->packet_band_count = htonll(src->packet_count);
1923 dst->byte_band_count = htonll(src->byte_count);
1927 /* Converts an OFPMP_METER_CONFIG reply in 'msg' into an abstract
1928 * ofputil_meter_config in 'mc', with mc->bands pointing to bands decoded into
1929 * 'bands'. The caller must have initialized 'bands' and retains ownership of
1930 * it across the call.
1932 * Multiple OFPST13_METER_CONFIG replies can be packed into a single OpenFlow
1933 * message. Calling this function multiple times for a single 'msg' iterates
1934 * through the replies. 'bands' is cleared for each reply.
1936 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1937 * otherwise a positive errno value. */
1939 ofputil_decode_meter_config(struct ofpbuf *msg,
1940 struct ofputil_meter_config *mc,
1941 struct ofpbuf *bands)
1943 const struct ofp13_meter_config *omc;
1946 /* Pull OpenFlow headers for the first call. */
1948 ofpraw_pull_assert(msg);
1955 omc = ofpbuf_try_pull(msg, sizeof *omc);
1957 VLOG_WARN_RL(&bad_ofmsg_rl,
1958 "OFPMP_METER_CONFIG reply has %"PRIu32" leftover bytes at end",
1960 return OFPERR_OFPBRC_BAD_LEN;
1963 ofpbuf_clear(bands);
1964 err = ofputil_pull_bands(msg, ntohs(omc->length) - sizeof *omc,
1965 &mc->n_bands, bands);
1969 mc->meter_id = ntohl(omc->meter_id);
1970 mc->flags = ntohs(omc->flags);
1971 mc->bands = bands->data;
1977 ofputil_pull_band_stats(struct ofpbuf *msg, size_t len, uint16_t *n_bands,
1978 struct ofpbuf *bands)
1980 const struct ofp13_meter_band_stats *ombs;
1981 struct ofputil_meter_band_stats *mbs;
1984 ombs = ofpbuf_try_pull(msg, len);
1986 return OFPERR_OFPBRC_BAD_LEN;
1989 n = len / sizeof *ombs;
1990 if (len != n * sizeof *ombs) {
1991 return OFPERR_OFPBRC_BAD_LEN;
1994 mbs = ofpbuf_put_uninit(bands, len);
1996 for (i = 0; i < n; ++i) {
1997 mbs[i].packet_count = ntohll(ombs[i].packet_band_count);
1998 mbs[i].byte_count = ntohll(ombs[i].byte_band_count);
2004 /* Converts an OFPMP_METER reply in 'msg' into an abstract
2005 * ofputil_meter_stats in 'ms', with ms->bands pointing to band stats
2006 * decoded into 'bands'.
2008 * Multiple OFPMP_METER replies can be packed into a single OpenFlow
2009 * message. Calling this function multiple times for a single 'msg' iterates
2010 * through the replies. 'bands' is cleared for each reply.
2012 * Returns 0 if successful, EOF if no replies were left in this 'msg',
2013 * otherwise a positive errno value. */
2015 ofputil_decode_meter_stats(struct ofpbuf *msg,
2016 struct ofputil_meter_stats *ms,
2017 struct ofpbuf *bands)
2019 const struct ofp13_meter_stats *oms;
2022 /* Pull OpenFlow headers for the first call. */
2024 ofpraw_pull_assert(msg);
2031 oms = ofpbuf_try_pull(msg, sizeof *oms);
2033 VLOG_WARN_RL(&bad_ofmsg_rl,
2034 "OFPMP_METER reply has %"PRIu32" leftover bytes at end",
2036 return OFPERR_OFPBRC_BAD_LEN;
2039 ofpbuf_clear(bands);
2040 err = ofputil_pull_band_stats(msg, ntohs(oms->len) - sizeof *oms,
2041 &ms->n_bands, bands);
2045 ms->meter_id = ntohl(oms->meter_id);
2046 ms->flow_count = ntohl(oms->flow_count);
2047 ms->packet_in_count = ntohll(oms->packet_in_count);
2048 ms->byte_in_count = ntohll(oms->byte_in_count);
2049 ms->duration_sec = ntohl(oms->duration_sec);
2050 ms->duration_nsec = ntohl(oms->duration_nsec);
2051 ms->bands = bands->data;
2057 ofputil_decode_meter_features(const struct ofp_header *oh,
2058 struct ofputil_meter_features *mf)
2060 const struct ofp13_meter_features *omf = ofpmsg_body(oh);
2062 mf->max_meters = ntohl(omf->max_meter);
2063 mf->band_types = ntohl(omf->band_types);
2064 mf->capabilities = ntohl(omf->capabilities);
2065 mf->max_bands = omf->max_bands;
2066 mf->max_color = omf->max_color;
2070 ofputil_encode_meter_features_reply(const struct ofputil_meter_features *mf,
2071 const struct ofp_header *request)
2073 struct ofpbuf *reply;
2074 struct ofp13_meter_features *omf;
2076 reply = ofpraw_alloc_stats_reply(request, 0);
2077 omf = ofpbuf_put_zeros(reply, sizeof *omf);
2079 omf->max_meter = htonl(mf->max_meters);
2080 omf->band_types = htonl(mf->band_types);
2081 omf->capabilities = htonl(mf->capabilities);
2082 omf->max_bands = mf->max_bands;
2083 omf->max_color = mf->max_color;
2089 ofputil_encode_meter_mod(enum ofp_version ofp_version,
2090 const struct ofputil_meter_mod *mm)
2094 struct ofp13_meter_mod *omm;
2096 msg = ofpraw_alloc(OFPRAW_OFPT13_METER_MOD, ofp_version,
2097 NXM_TYPICAL_LEN + mm->meter.n_bands * 16);
2098 omm = ofpbuf_put_zeros(msg, sizeof *omm);
2099 omm->command = htons(mm->command);
2100 if (mm->command != OFPMC13_DELETE) {
2101 omm->flags = htons(mm->meter.flags);
2103 omm->meter_id = htonl(mm->meter.meter_id);
2105 ofputil_put_bands(mm->meter.n_bands, mm->meter.bands, msg);
2107 ofpmsg_update_length(msg);
2112 ofputil_tid_command(const struct ofputil_flow_mod *fm,
2113 enum ofputil_protocol protocol)
2115 return htons(protocol & OFPUTIL_P_TID
2116 ? (fm->command & 0xff) | (fm->table_id << 8)
2120 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
2121 * 'protocol' and returns the message. */
2123 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
2124 enum ofputil_protocol protocol)
2126 enum ofp_version version = ofputil_protocol_to_ofp_version(protocol);
2127 ovs_be16 raw_flags = ofputil_encode_flow_mod_flags(fm->flags, version);
2131 case OFPUTIL_P_OF11_STD:
2132 case OFPUTIL_P_OF12_OXM:
2133 case OFPUTIL_P_OF13_OXM:
2134 case OFPUTIL_P_OF14_OXM:
2135 case OFPUTIL_P_OF15_OXM: {
2136 struct ofp11_flow_mod *ofm;
2139 tailroom = ofputil_match_typical_len(protocol) + fm->ofpacts_len;
2140 msg = ofpraw_alloc(OFPRAW_OFPT11_FLOW_MOD, version, tailroom);
2141 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
2142 if ((protocol == OFPUTIL_P_OF11_STD
2143 && (fm->command == OFPFC_MODIFY ||
2144 fm->command == OFPFC_MODIFY_STRICT)
2145 && fm->cookie_mask == htonll(0))
2146 || fm->command == OFPFC_ADD) {
2147 ofm->cookie = fm->new_cookie;
2149 ofm->cookie = fm->cookie & fm->cookie_mask;
2151 ofm->cookie_mask = fm->cookie_mask;
2152 if (fm->table_id != OFPTT_ALL
2153 || (protocol != OFPUTIL_P_OF11_STD
2154 && (fm->command == OFPFC_DELETE ||
2155 fm->command == OFPFC_DELETE_STRICT))) {
2156 ofm->table_id = fm->table_id;
2160 ofm->command = fm->command;
2161 ofm->idle_timeout = htons(fm->idle_timeout);
2162 ofm->hard_timeout = htons(fm->hard_timeout);
2163 ofm->priority = htons(fm->priority);
2164 ofm->buffer_id = htonl(fm->buffer_id);
2165 ofm->out_port = ofputil_port_to_ofp11(fm->out_port);
2166 ofm->out_group = htonl(fm->out_group);
2167 ofm->flags = raw_flags;
2168 if (version >= OFP14_VERSION && fm->command == OFPFC_ADD) {
2169 ofm->importance = htons(fm->importance);
2171 ofm->importance = 0;
2173 ofputil_put_ofp11_match(msg, &fm->match, protocol);
2174 ofpacts_put_openflow_instructions(fm->ofpacts, fm->ofpacts_len, msg,
2179 case OFPUTIL_P_OF10_STD:
2180 case OFPUTIL_P_OF10_STD_TID: {
2181 struct ofp10_flow_mod *ofm;
2183 msg = ofpraw_alloc(OFPRAW_OFPT10_FLOW_MOD, OFP10_VERSION,
2185 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
2186 ofputil_match_to_ofp10_match(&fm->match, &ofm->match);
2187 ofm->cookie = fm->new_cookie;
2188 ofm->command = ofputil_tid_command(fm, protocol);
2189 ofm->idle_timeout = htons(fm->idle_timeout);
2190 ofm->hard_timeout = htons(fm->hard_timeout);
2191 ofm->priority = htons(fm->priority);
2192 ofm->buffer_id = htonl(fm->buffer_id);
2193 ofm->out_port = htons(ofp_to_u16(fm->out_port));
2194 ofm->flags = raw_flags;
2195 ofpacts_put_openflow_actions(fm->ofpacts, fm->ofpacts_len, msg,
2200 case OFPUTIL_P_OF10_NXM:
2201 case OFPUTIL_P_OF10_NXM_TID: {
2202 struct nx_flow_mod *nfm;
2205 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD, OFP10_VERSION,
2206 NXM_TYPICAL_LEN + fm->ofpacts_len);
2207 nfm = ofpbuf_put_zeros(msg, sizeof *nfm);
2208 nfm->command = ofputil_tid_command(fm, protocol);
2209 nfm->cookie = fm->new_cookie;
2210 match_len = nx_put_match(msg, &fm->match, fm->cookie, fm->cookie_mask);
2212 nfm->idle_timeout = htons(fm->idle_timeout);
2213 nfm->hard_timeout = htons(fm->hard_timeout);
2214 nfm->priority = htons(fm->priority);
2215 nfm->buffer_id = htonl(fm->buffer_id);
2216 nfm->out_port = htons(ofp_to_u16(fm->out_port));
2217 nfm->flags = raw_flags;
2218 nfm->match_len = htons(match_len);
2219 ofpacts_put_openflow_actions(fm->ofpacts, fm->ofpacts_len, msg,
2228 ofpmsg_update_length(msg);
2233 ofputil_decode_ofpst10_flow_request(struct ofputil_flow_stats_request *fsr,
2234 const struct ofp10_flow_stats_request *ofsr,
2237 fsr->aggregate = aggregate;
2238 ofputil_match_from_ofp10_match(&ofsr->match, &fsr->match);
2239 fsr->out_port = u16_to_ofp(ntohs(ofsr->out_port));
2240 fsr->out_group = OFPG_ANY;
2241 fsr->table_id = ofsr->table_id;
2242 fsr->cookie = fsr->cookie_mask = htonll(0);
2248 ofputil_decode_ofpst11_flow_request(struct ofputil_flow_stats_request *fsr,
2249 struct ofpbuf *b, bool aggregate)
2251 const struct ofp11_flow_stats_request *ofsr;
2254 ofsr = ofpbuf_pull(b, sizeof *ofsr);
2255 fsr->aggregate = aggregate;
2256 fsr->table_id = ofsr->table_id;
2257 error = ofputil_port_from_ofp11(ofsr->out_port, &fsr->out_port);
2261 fsr->out_group = ntohl(ofsr->out_group);
2262 fsr->cookie = ofsr->cookie;
2263 fsr->cookie_mask = ofsr->cookie_mask;
2264 error = ofputil_pull_ofp11_match(b, &fsr->match, NULL);
2273 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
2274 struct ofpbuf *b, bool aggregate)
2276 const struct nx_flow_stats_request *nfsr;
2279 nfsr = ofpbuf_pull(b, sizeof *nfsr);
2280 error = nx_pull_match(b, ntohs(nfsr->match_len), &fsr->match,
2281 &fsr->cookie, &fsr->cookie_mask);
2286 return OFPERR_OFPBRC_BAD_LEN;
2289 fsr->aggregate = aggregate;
2290 fsr->out_port = u16_to_ofp(ntohs(nfsr->out_port));
2291 fsr->out_group = OFPG_ANY;
2292 fsr->table_id = nfsr->table_id;
2297 /* Constructs and returns an OFPT_QUEUE_GET_CONFIG request for the specified
2298 * 'port' and 'queue', suitable for OpenFlow version 'version'.
2300 * 'queue' is honored only for OpenFlow 1.4 and later; older versions always
2301 * request all queues. */
2303 ofputil_encode_queue_get_config_request(enum ofp_version version,
2307 struct ofpbuf *request;
2309 if (version == OFP10_VERSION) {
2310 struct ofp10_queue_get_config_request *qgcr10;
2312 request = ofpraw_alloc(OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST,
2314 qgcr10 = ofpbuf_put_zeros(request, sizeof *qgcr10);
2315 qgcr10->port = htons(ofp_to_u16(port));
2316 } else if (version < OFP14_VERSION) {
2317 struct ofp11_queue_get_config_request *qgcr11;
2319 request = ofpraw_alloc(OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST,
2321 qgcr11 = ofpbuf_put_zeros(request, sizeof *qgcr11);
2322 qgcr11->port = ofputil_port_to_ofp11(port);
2324 struct ofp14_queue_desc_request *qdr14;
2326 request = ofpraw_alloc(OFPRAW_OFPST14_QUEUE_DESC_REQUEST,
2328 qdr14 = ofpbuf_put_zeros(request, sizeof *qdr14);
2329 qdr14->port = ofputil_port_to_ofp11(port);
2330 qdr14->queue = htonl(queue);
2336 /* Parses OFPT_QUEUE_GET_CONFIG request 'oh', storing the port specified by the
2337 * request into '*port'. Returns 0 if successful, otherwise an OpenFlow error
2340 ofputil_decode_queue_get_config_request(const struct ofp_header *oh,
2341 ofp_port_t *port, uint32_t *queue)
2343 const struct ofp10_queue_get_config_request *qgcr10;
2344 const struct ofp11_queue_get_config_request *qgcr11;
2345 const struct ofp14_queue_desc_request *qdr14;
2346 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
2347 enum ofpraw raw = ofpraw_pull_assert(&b);
2349 switch ((int) raw) {
2350 case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST:
2352 *port = u16_to_ofp(ntohs(qgcr10->port));
2356 case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST:
2359 enum ofperr error = ofputil_port_from_ofp11(qgcr11->port, port);
2360 if (error || *port == OFPP_ANY) {
2365 case OFPRAW_OFPST14_QUEUE_DESC_REQUEST:
2367 *queue = ntohl(qdr14->queue);
2368 return ofputil_port_from_ofp11(qdr14->port, port);
2374 return (ofp_to_u16(*port) < ofp_to_u16(OFPP_MAX)
2376 : OFPERR_OFPQOFC_BAD_PORT);
2379 /* Constructs and returns the beginning of a reply to
2380 * OFPT_QUEUE_GET_CONFIG_REQUEST or OFPMP_QUEUE_DESC request 'oh'. The caller
2381 * may append information about individual queues with
2382 * ofputil_append_queue_get_config_reply(). */
2384 ofputil_start_queue_get_config_reply(const struct ofp_header *request,
2385 struct ovs_list *replies)
2387 struct ofpbuf *reply;
2392 error = ofputil_decode_queue_get_config_request(request, &port, &queue);
2395 enum ofpraw raw = ofpraw_decode_assert(request);
2396 switch ((int) raw) {
2397 case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST:
2398 reply = ofpraw_alloc_reply(OFPRAW_OFPT10_QUEUE_GET_CONFIG_REPLY,
2400 struct ofp10_queue_get_config_reply *qgcr10
2401 = ofpbuf_put_zeros(reply, sizeof *qgcr10);
2402 qgcr10->port = htons(ofp_to_u16(port));
2405 case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST:
2406 reply = ofpraw_alloc_reply(OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY,
2408 struct ofp11_queue_get_config_reply *qgcr11
2409 = ofpbuf_put_zeros(reply, sizeof *qgcr11);
2410 qgcr11->port = ofputil_port_to_ofp11(port);
2413 case OFPRAW_OFPST14_QUEUE_DESC_REQUEST:
2414 reply = ofpraw_alloc_stats_reply(request, 0);
2422 list_push_back(replies, &reply->list_node);
2426 put_ofp10_queue_rate(struct ofpbuf *reply,
2427 enum ofp10_queue_properties property, uint16_t rate)
2429 if (rate != UINT16_MAX) {
2430 struct ofp10_queue_prop_rate *oqpr;
2432 oqpr = ofpbuf_put_zeros(reply, sizeof *oqpr);
2433 oqpr->prop_header.property = htons(property);
2434 oqpr->prop_header.len = htons(sizeof *oqpr);
2435 oqpr->rate = htons(rate);
2440 put_ofp14_queue_rate(struct ofpbuf *reply,
2441 enum ofp14_queue_desc_prop_type type, uint16_t rate)
2443 if (rate != UINT16_MAX) {
2444 ofpprop_put_u16(reply, type, rate);
2449 ofputil_append_queue_get_config_reply(const struct ofputil_queue_config *qc,
2450 struct ovs_list *replies)
2452 enum ofp_version ofp_version = ofpmp_version(replies);
2453 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
2454 size_t start_ofs = reply->size;
2458 if (ofp_version < OFP14_VERSION) {
2459 if (ofp_version < OFP12_VERSION) {
2460 struct ofp10_packet_queue *opq10;
2462 opq10 = ofpbuf_put_zeros(reply, sizeof *opq10);
2463 opq10->queue_id = htonl(qc->queue);
2464 len_ofs = (char *) &opq10->len - (char *) reply->data;
2466 struct ofp12_packet_queue *opq12;
2468 opq12 = ofpbuf_put_zeros(reply, sizeof *opq12);
2469 opq12->port = ofputil_port_to_ofp11(qc->port);
2470 opq12->queue_id = htonl(qc->queue);
2471 len_ofs = (char *) &opq12->len - (char *) reply->data;
2474 put_ofp10_queue_rate(reply, OFPQT10_MIN_RATE, qc->min_rate);
2475 put_ofp10_queue_rate(reply, OFPQT11_MAX_RATE, qc->max_rate);
2477 struct ofp14_queue_desc *oqd = ofpbuf_put_zeros(reply, sizeof *oqd);
2478 oqd->port_no = ofputil_port_to_ofp11(qc->port);
2479 oqd->queue_id = htonl(qc->queue);
2480 len_ofs = (char *) &oqd->len - (char *) reply->data;
2481 put_ofp14_queue_rate(reply, OFPQDPT14_MIN_RATE, qc->min_rate);
2482 put_ofp14_queue_rate(reply, OFPQDPT14_MAX_RATE, qc->max_rate);
2485 len = ofpbuf_at(reply, len_ofs, sizeof *len);
2486 *len = htons(reply->size - start_ofs);
2488 if (ofp_version >= OFP14_VERSION) {
2489 ofpmp_postappend(replies, start_ofs);
2494 parse_ofp10_queue_rate(const struct ofp10_queue_prop_header *hdr,
2497 const struct ofp10_queue_prop_rate *oqpr;
2499 if (hdr->len == htons(sizeof *oqpr)) {
2500 oqpr = (const struct ofp10_queue_prop_rate *) hdr;
2501 *rate = ntohs(oqpr->rate);
2504 return OFPERR_OFPBRC_BAD_LEN;
2509 ofputil_pull_queue_get_config_reply10(struct ofpbuf *msg,
2510 struct ofputil_queue_config *queue)
2512 const struct ofp_header *oh = msg->header;
2513 unsigned int opq_len; /* Length of protocol-specific queue header. */
2514 unsigned int len; /* Total length of queue + properties. */
2516 /* Obtain the port number from the message header. */
2517 if (oh->version == OFP10_VERSION) {
2518 const struct ofp10_queue_get_config_reply *oqgcr10 = msg->msg;
2519 queue->port = u16_to_ofp(ntohs(oqgcr10->port));
2521 const struct ofp11_queue_get_config_reply *oqgcr11 = msg->msg;
2522 enum ofperr error = ofputil_port_from_ofp11(oqgcr11->port,
2529 /* Pull off the queue header and get the queue number and length. */
2530 if (oh->version < OFP12_VERSION) {
2531 const struct ofp10_packet_queue *opq10;
2532 opq10 = ofpbuf_try_pull(msg, sizeof *opq10);
2534 return OFPERR_OFPBRC_BAD_LEN;
2536 queue->queue = ntohl(opq10->queue_id);
2537 len = ntohs(opq10->len);
2538 opq_len = sizeof *opq10;
2540 const struct ofp12_packet_queue *opq12;
2541 opq12 = ofpbuf_try_pull(msg, sizeof *opq12);
2543 return OFPERR_OFPBRC_BAD_LEN;
2545 queue->queue = ntohl(opq12->queue_id);
2546 len = ntohs(opq12->len);
2547 opq_len = sizeof *opq12;
2551 if (len < opq_len || len > msg->size + opq_len || len % 8) {
2552 return OFPERR_OFPBRC_BAD_LEN;
2556 /* Pull properties. The format of these properties differs from used in
2557 * OF1.4+ so we can't use the common property functions. */
2559 const struct ofp10_queue_prop_header *hdr;
2560 unsigned int property;
2561 unsigned int prop_len;
2562 enum ofperr error = 0;
2564 hdr = ofpbuf_at_assert(msg, 0, sizeof *hdr);
2565 prop_len = ntohs(hdr->len);
2566 if (prop_len < sizeof *hdr || prop_len > msg->size || prop_len % 8) {
2567 return OFPERR_OFPBRC_BAD_LEN;
2570 property = ntohs(hdr->property);
2572 case OFPQT10_MIN_RATE:
2573 error = parse_ofp10_queue_rate(hdr, &queue->min_rate);
2576 case OFPQT11_MAX_RATE:
2577 error = parse_ofp10_queue_rate(hdr, &queue->max_rate);
2581 VLOG_INFO_RL(&bad_ofmsg_rl, "unknown queue property %u", property);
2588 ofpbuf_pull(msg, prop_len);
2595 ofputil_pull_queue_get_config_reply14(struct ofpbuf *msg,
2596 struct ofputil_queue_config *queue)
2598 struct ofp14_queue_desc *oqd14 = ofpbuf_try_pull(msg, sizeof *oqd14);
2600 return OFPERR_OFPBRC_BAD_LEN;
2602 enum ofperr error = ofputil_port_from_ofp11(oqd14->port_no, &queue->port);
2606 queue->queue = ntohl(oqd14->queue_id);
2609 unsigned int len = ntohs(oqd14->len);
2610 if (len < sizeof *oqd14 || len > msg->size + sizeof *oqd14 || len % 8) {
2611 return OFPERR_OFPBRC_BAD_LEN;
2613 len -= sizeof *oqd14;
2615 struct ofpbuf properties = ofpbuf_const_initializer(ofpbuf_pull(msg, len),
2617 while (properties.size > 0) {
2618 struct ofpbuf payload;
2621 error = ofpprop_pull(&properties, &payload, &type);
2627 case OFPQDPT14_MIN_RATE:
2628 error = ofpprop_parse_u16(&payload, &queue->min_rate);
2631 case OFPQDPT14_MAX_RATE:
2632 error = ofpprop_parse_u16(&payload, &queue->max_rate);
2636 error = OFPPROP_UNKNOWN(true, "queue desc", type);
2648 /* Decodes information about a queue from the OFPT_QUEUE_GET_CONFIG_REPLY in
2649 * 'reply' and stores it in '*queue'. ofputil_decode_queue_get_config_reply()
2650 * must already have pulled off the main header.
2652 * This function returns EOF if the last queue has already been decoded, 0 if a
2653 * queue was successfully decoded into '*queue', or an ofperr if there was a
2654 * problem decoding 'reply'. */
2656 ofputil_pull_queue_get_config_reply(struct ofpbuf *msg,
2657 struct ofputil_queue_config *queue)
2661 /* Pull OpenFlow header. */
2662 raw = ofpraw_pull_assert(msg);
2664 /* Pull protocol-specific ofp_queue_get_config_reply header (OF1.4
2665 * doesn't have one at all). */
2666 if (raw == OFPRAW_OFPT10_QUEUE_GET_CONFIG_REPLY) {
2667 ofpbuf_pull(msg, sizeof(struct ofp10_queue_get_config_reply));
2668 } else if (raw == OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY) {
2669 ofpbuf_pull(msg, sizeof(struct ofp11_queue_get_config_reply));
2671 ovs_assert(raw == OFPRAW_OFPST14_QUEUE_DESC_REPLY);
2674 raw = ofpraw_decode_assert(msg->header);
2677 queue->min_rate = UINT16_MAX;
2678 queue->max_rate = UINT16_MAX;
2682 } else if (raw == OFPRAW_OFPST14_QUEUE_DESC_REPLY) {
2683 return ofputil_pull_queue_get_config_reply14(msg, queue);
2685 return ofputil_pull_queue_get_config_reply10(msg, queue);
2689 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
2690 * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
2691 * successful, otherwise an OpenFlow error code. */
2693 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
2694 const struct ofp_header *oh)
2696 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
2697 enum ofpraw raw = ofpraw_pull_assert(&b);
2698 switch ((int) raw) {
2699 case OFPRAW_OFPST10_FLOW_REQUEST:
2700 return ofputil_decode_ofpst10_flow_request(fsr, b.data, false);
2702 case OFPRAW_OFPST10_AGGREGATE_REQUEST:
2703 return ofputil_decode_ofpst10_flow_request(fsr, b.data, true);
2705 case OFPRAW_OFPST11_FLOW_REQUEST:
2706 return ofputil_decode_ofpst11_flow_request(fsr, &b, false);
2708 case OFPRAW_OFPST11_AGGREGATE_REQUEST:
2709 return ofputil_decode_ofpst11_flow_request(fsr, &b, true);
2711 case OFPRAW_NXST_FLOW_REQUEST:
2712 return ofputil_decode_nxst_flow_request(fsr, &b, false);
2714 case OFPRAW_NXST_AGGREGATE_REQUEST:
2715 return ofputil_decode_nxst_flow_request(fsr, &b, true);
2718 /* Hey, the caller lied. */
2723 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
2724 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
2725 * 'protocol', and returns the message. */
2727 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
2728 enum ofputil_protocol protocol)
2734 case OFPUTIL_P_OF11_STD:
2735 case OFPUTIL_P_OF12_OXM:
2736 case OFPUTIL_P_OF13_OXM:
2737 case OFPUTIL_P_OF14_OXM:
2738 case OFPUTIL_P_OF15_OXM: {
2739 struct ofp11_flow_stats_request *ofsr;
2741 raw = (fsr->aggregate
2742 ? OFPRAW_OFPST11_AGGREGATE_REQUEST
2743 : OFPRAW_OFPST11_FLOW_REQUEST);
2744 msg = ofpraw_alloc(raw, ofputil_protocol_to_ofp_version(protocol),
2745 ofputil_match_typical_len(protocol));
2746 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
2747 ofsr->table_id = fsr->table_id;
2748 ofsr->out_port = ofputil_port_to_ofp11(fsr->out_port);
2749 ofsr->out_group = htonl(fsr->out_group);
2750 ofsr->cookie = fsr->cookie;
2751 ofsr->cookie_mask = fsr->cookie_mask;
2752 ofputil_put_ofp11_match(msg, &fsr->match, protocol);
2756 case OFPUTIL_P_OF10_STD:
2757 case OFPUTIL_P_OF10_STD_TID: {
2758 struct ofp10_flow_stats_request *ofsr;
2760 raw = (fsr->aggregate
2761 ? OFPRAW_OFPST10_AGGREGATE_REQUEST
2762 : OFPRAW_OFPST10_FLOW_REQUEST);
2763 msg = ofpraw_alloc(raw, OFP10_VERSION, 0);
2764 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
2765 ofputil_match_to_ofp10_match(&fsr->match, &ofsr->match);
2766 ofsr->table_id = fsr->table_id;
2767 ofsr->out_port = htons(ofp_to_u16(fsr->out_port));
2771 case OFPUTIL_P_OF10_NXM:
2772 case OFPUTIL_P_OF10_NXM_TID: {
2773 struct nx_flow_stats_request *nfsr;
2776 raw = (fsr->aggregate
2777 ? OFPRAW_NXST_AGGREGATE_REQUEST
2778 : OFPRAW_NXST_FLOW_REQUEST);
2779 msg = ofpraw_alloc(raw, OFP10_VERSION, NXM_TYPICAL_LEN);
2780 ofpbuf_put_zeros(msg, sizeof *nfsr);
2781 match_len = nx_put_match(msg, &fsr->match,
2782 fsr->cookie, fsr->cookie_mask);
2785 nfsr->out_port = htons(ofp_to_u16(fsr->out_port));
2786 nfsr->match_len = htons(match_len);
2787 nfsr->table_id = fsr->table_id;
2798 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
2799 * ofputil_flow_stats in 'fs'.
2801 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
2802 * OpenFlow message. Calling this function multiple times for a single 'msg'
2803 * iterates through the replies. The caller must initially leave 'msg''s layer
2804 * pointers null and not modify them between calls.
2806 * Most switches don't send the values needed to populate fs->idle_age and
2807 * fs->hard_age, so those members will usually be set to 0. If the switch from
2808 * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
2809 * 'flow_age_extension' as true so that the contents of 'msg' determine the
2810 * 'idle_age' and 'hard_age' members in 'fs'.
2812 * Uses 'ofpacts' to store the abstract OFPACT_* version of the flow stats
2813 * reply's actions. The caller must initialize 'ofpacts' and retains ownership
2814 * of it. 'fs->ofpacts' will point into the 'ofpacts' buffer.
2816 * Returns 0 if successful, EOF if no replies were left in this 'msg',
2817 * otherwise a positive errno value. */
2819 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
2821 bool flow_age_extension,
2822 struct ofpbuf *ofpacts)
2824 const struct ofp_header *oh;
2825 size_t instructions_len;
2829 error = (msg->header ? ofpraw_decode(&raw, msg->header)
2830 : ofpraw_pull(&raw, msg));
2838 } else if (raw == OFPRAW_OFPST11_FLOW_REPLY
2839 || raw == OFPRAW_OFPST13_FLOW_REPLY) {
2840 const struct ofp11_flow_stats *ofs;
2842 uint16_t padded_match_len;
2844 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2846 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %"PRIu32" leftover "
2847 "bytes at end", msg->size);
2851 length = ntohs(ofs->length);
2852 if (length < sizeof *ofs) {
2853 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2854 "length %"PRIuSIZE, length);
2858 if (ofputil_pull_ofp11_match(msg, &fs->match, &padded_match_len)) {
2859 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad match");
2862 instructions_len = length - sizeof *ofs - padded_match_len;
2864 fs->priority = ntohs(ofs->priority);
2865 fs->table_id = ofs->table_id;
2866 fs->duration_sec = ntohl(ofs->duration_sec);
2867 fs->duration_nsec = ntohl(ofs->duration_nsec);
2868 fs->idle_timeout = ntohs(ofs->idle_timeout);
2869 fs->hard_timeout = ntohs(ofs->hard_timeout);
2870 if (oh->version >= OFP14_VERSION) {
2871 fs->importance = ntohs(ofs->importance);
2875 if (raw == OFPRAW_OFPST13_FLOW_REPLY) {
2876 error = ofputil_decode_flow_mod_flags(ofs->flags, -1, oh->version,
2886 fs->cookie = ofs->cookie;
2887 fs->packet_count = ntohll(ofs->packet_count);
2888 fs->byte_count = ntohll(ofs->byte_count);
2889 } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
2890 const struct ofp10_flow_stats *ofs;
2893 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2895 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %"PRIu32" leftover "
2896 "bytes at end", msg->size);
2900 length = ntohs(ofs->length);
2901 if (length < sizeof *ofs) {
2902 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2903 "length %"PRIuSIZE, length);
2906 instructions_len = length - sizeof *ofs;
2908 fs->cookie = get_32aligned_be64(&ofs->cookie);
2909 ofputil_match_from_ofp10_match(&ofs->match, &fs->match);
2910 fs->priority = ntohs(ofs->priority);
2911 fs->table_id = ofs->table_id;
2912 fs->duration_sec = ntohl(ofs->duration_sec);
2913 fs->duration_nsec = ntohl(ofs->duration_nsec);
2914 fs->idle_timeout = ntohs(ofs->idle_timeout);
2915 fs->hard_timeout = ntohs(ofs->hard_timeout);
2919 fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
2920 fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
2922 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
2923 const struct nx_flow_stats *nfs;
2924 size_t match_len, length;
2926 nfs = ofpbuf_try_pull(msg, sizeof *nfs);
2928 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %"PRIu32" leftover "
2929 "bytes at end", msg->size);
2933 length = ntohs(nfs->length);
2934 match_len = ntohs(nfs->match_len);
2935 if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
2936 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%"PRIuSIZE" "
2937 "claims invalid length %"PRIuSIZE, match_len, length);
2940 if (nx_pull_match(msg, match_len, &fs->match, NULL, NULL)) {
2943 instructions_len = length - sizeof *nfs - ROUND_UP(match_len, 8);
2945 fs->cookie = nfs->cookie;
2946 fs->table_id = nfs->table_id;
2947 fs->duration_sec = ntohl(nfs->duration_sec);
2948 fs->duration_nsec = ntohl(nfs->duration_nsec);
2949 fs->priority = ntohs(nfs->priority);
2950 fs->idle_timeout = ntohs(nfs->idle_timeout);
2951 fs->hard_timeout = ntohs(nfs->hard_timeout);
2955 if (flow_age_extension) {
2956 if (nfs->idle_age) {
2957 fs->idle_age = ntohs(nfs->idle_age) - 1;
2959 if (nfs->hard_age) {
2960 fs->hard_age = ntohs(nfs->hard_age) - 1;
2963 fs->packet_count = ntohll(nfs->packet_count);
2964 fs->byte_count = ntohll(nfs->byte_count);
2970 if (ofpacts_pull_openflow_instructions(msg, instructions_len, oh->version,
2972 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad instructions");
2975 fs->ofpacts = ofpacts->data;
2976 fs->ofpacts_len = ofpacts->size;
2981 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
2983 * We use this in situations where OVS internally uses UINT64_MAX to mean
2984 * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
2986 unknown_to_zero(uint64_t count)
2988 return count != UINT64_MAX ? count : 0;
2991 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
2992 * those already present in the list of ofpbufs in 'replies'. 'replies' should
2993 * have been initialized with ofpmp_init(). */
2995 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
2996 struct ovs_list *replies)
2998 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
2999 size_t start_ofs = reply->size;
3000 enum ofp_version version = ofpmp_version(replies);
3001 enum ofpraw raw = ofpmp_decode_raw(replies);
3003 if (raw == OFPRAW_OFPST11_FLOW_REPLY || raw == OFPRAW_OFPST13_FLOW_REPLY) {
3004 struct ofp11_flow_stats *ofs;
3006 ofpbuf_put_uninit(reply, sizeof *ofs);
3007 oxm_put_match(reply, &fs->match, version);
3008 ofpacts_put_openflow_instructions(fs->ofpacts, fs->ofpacts_len, reply,
3011 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
3012 ofs->length = htons(reply->size - start_ofs);
3013 ofs->table_id = fs->table_id;
3015 ofs->duration_sec = htonl(fs->duration_sec);
3016 ofs->duration_nsec = htonl(fs->duration_nsec);
3017 ofs->priority = htons(fs->priority);
3018 ofs->idle_timeout = htons(fs->idle_timeout);
3019 ofs->hard_timeout = htons(fs->hard_timeout);
3020 if (version >= OFP14_VERSION) {
3021 ofs->importance = htons(fs->importance);
3023 ofs->importance = 0;
3025 if (raw == OFPRAW_OFPST13_FLOW_REPLY) {
3026 ofs->flags = ofputil_encode_flow_mod_flags(fs->flags, version);
3030 memset(ofs->pad2, 0, sizeof ofs->pad2);
3031 ofs->cookie = fs->cookie;
3032 ofs->packet_count = htonll(unknown_to_zero(fs->packet_count));
3033 ofs->byte_count = htonll(unknown_to_zero(fs->byte_count));
3034 } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
3035 struct ofp10_flow_stats *ofs;
3037 ofpbuf_put_uninit(reply, sizeof *ofs);
3038 ofpacts_put_openflow_actions(fs->ofpacts, fs->ofpacts_len, reply,
3040 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
3041 ofs->length = htons(reply->size - start_ofs);
3042 ofs->table_id = fs->table_id;
3044 ofputil_match_to_ofp10_match(&fs->match, &ofs->match);
3045 ofs->duration_sec = htonl(fs->duration_sec);
3046 ofs->duration_nsec = htonl(fs->duration_nsec);
3047 ofs->priority = htons(fs->priority);
3048 ofs->idle_timeout = htons(fs->idle_timeout);
3049 ofs->hard_timeout = htons(fs->hard_timeout);
3050 memset(ofs->pad2, 0, sizeof ofs->pad2);
3051 put_32aligned_be64(&ofs->cookie, fs->cookie);
3052 put_32aligned_be64(&ofs->packet_count,
3053 htonll(unknown_to_zero(fs->packet_count)));
3054 put_32aligned_be64(&ofs->byte_count,
3055 htonll(unknown_to_zero(fs->byte_count)));
3056 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
3057 struct nx_flow_stats *nfs;
3060 ofpbuf_put_uninit(reply, sizeof *nfs);
3061 match_len = nx_put_match(reply, &fs->match, 0, 0);
3062 ofpacts_put_openflow_actions(fs->ofpacts, fs->ofpacts_len, reply,
3064 nfs = ofpbuf_at_assert(reply, start_ofs, sizeof *nfs);
3065 nfs->length = htons(reply->size - start_ofs);
3066 nfs->table_id = fs->table_id;
3068 nfs->duration_sec = htonl(fs->duration_sec);
3069 nfs->duration_nsec = htonl(fs->duration_nsec);
3070 nfs->priority = htons(fs->priority);
3071 nfs->idle_timeout = htons(fs->idle_timeout);
3072 nfs->hard_timeout = htons(fs->hard_timeout);
3073 nfs->idle_age = htons(fs->idle_age < 0 ? 0
3074 : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
3076 nfs->hard_age = htons(fs->hard_age < 0 ? 0
3077 : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
3079 nfs->match_len = htons(match_len);
3080 nfs->cookie = fs->cookie;
3081 nfs->packet_count = htonll(fs->packet_count);
3082 nfs->byte_count = htonll(fs->byte_count);
3087 ofpmp_postappend(replies, start_ofs);
3090 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
3091 * NXST_AGGREGATE reply matching 'request', and returns the message. */
3093 ofputil_encode_aggregate_stats_reply(
3094 const struct ofputil_aggregate_stats *stats,
3095 const struct ofp_header *request)
3097 struct ofp_aggregate_stats_reply *asr;
3098 uint64_t packet_count;
3099 uint64_t byte_count;
3103 ofpraw_decode(&raw, request);
3104 if (raw == OFPRAW_OFPST10_AGGREGATE_REQUEST) {
3105 packet_count = unknown_to_zero(stats->packet_count);
3106 byte_count = unknown_to_zero(stats->byte_count);
3108 packet_count = stats->packet_count;
3109 byte_count = stats->byte_count;
3112 msg = ofpraw_alloc_stats_reply(request, 0);
3113 asr = ofpbuf_put_zeros(msg, sizeof *asr);
3114 put_32aligned_be64(&asr->packet_count, htonll(packet_count));
3115 put_32aligned_be64(&asr->byte_count, htonll(byte_count));
3116 asr->flow_count = htonl(stats->flow_count);
3122 ofputil_decode_aggregate_stats_reply(struct ofputil_aggregate_stats *stats,
3123 const struct ofp_header *reply)
3125 struct ofpbuf msg = ofpbuf_const_initializer(reply, ntohs(reply->length));
3126 ofpraw_pull_assert(&msg);
3128 struct ofp_aggregate_stats_reply *asr = msg.msg;
3129 stats->packet_count = ntohll(get_32aligned_be64(&asr->packet_count));
3130 stats->byte_count = ntohll(get_32aligned_be64(&asr->byte_count));
3131 stats->flow_count = ntohl(asr->flow_count);
3136 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
3137 * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
3138 * an OpenFlow error code. */
3140 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
3141 const struct ofp_header *oh)
3143 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
3144 enum ofpraw raw = ofpraw_pull_assert(&b);
3145 if (raw == OFPRAW_OFPT11_FLOW_REMOVED) {
3146 const struct ofp12_flow_removed *ofr;
3149 ofr = ofpbuf_pull(&b, sizeof *ofr);
3151 error = ofputil_pull_ofp11_match(&b, &fr->match, NULL);
3156 fr->priority = ntohs(ofr->priority);
3157 fr->cookie = ofr->cookie;
3158 fr->reason = ofr->reason;
3159 fr->table_id = ofr->table_id;
3160 fr->duration_sec = ntohl(ofr->duration_sec);
3161 fr->duration_nsec = ntohl(ofr->duration_nsec);
3162 fr->idle_timeout = ntohs(ofr->idle_timeout);
3163 fr->hard_timeout = ntohs(ofr->hard_timeout);
3164 fr->packet_count = ntohll(ofr->packet_count);
3165 fr->byte_count = ntohll(ofr->byte_count);
3166 } else if (raw == OFPRAW_OFPT10_FLOW_REMOVED) {
3167 const struct ofp10_flow_removed *ofr;
3169 ofr = ofpbuf_pull(&b, sizeof *ofr);
3171 ofputil_match_from_ofp10_match(&ofr->match, &fr->match);
3172 fr->priority = ntohs(ofr->priority);
3173 fr->cookie = ofr->cookie;
3174 fr->reason = ofr->reason;
3176 fr->duration_sec = ntohl(ofr->duration_sec);
3177 fr->duration_nsec = ntohl(ofr->duration_nsec);
3178 fr->idle_timeout = ntohs(ofr->idle_timeout);
3179 fr->hard_timeout = 0;
3180 fr->packet_count = ntohll(ofr->packet_count);
3181 fr->byte_count = ntohll(ofr->byte_count);
3182 } else if (raw == OFPRAW_NXT_FLOW_REMOVED) {
3183 struct nx_flow_removed *nfr;
3186 nfr = ofpbuf_pull(&b, sizeof *nfr);
3187 error = nx_pull_match(&b, ntohs(nfr->match_len), &fr->match,
3193 return OFPERR_OFPBRC_BAD_LEN;
3196 fr->priority = ntohs(nfr->priority);
3197 fr->cookie = nfr->cookie;
3198 fr->reason = nfr->reason;
3199 fr->table_id = nfr->table_id ? nfr->table_id - 1 : 255;
3200 fr->duration_sec = ntohl(nfr->duration_sec);
3201 fr->duration_nsec = ntohl(nfr->duration_nsec);
3202 fr->idle_timeout = ntohs(nfr->idle_timeout);
3203 fr->hard_timeout = 0;
3204 fr->packet_count = ntohll(nfr->packet_count);
3205 fr->byte_count = ntohll(nfr->byte_count);
3213 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
3214 * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
3217 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
3218 enum ofputil_protocol protocol)
3221 enum ofp_flow_removed_reason reason = fr->reason;
3223 if (reason == OFPRR_METER_DELETE && !(protocol & OFPUTIL_P_OF14_UP)) {
3224 reason = OFPRR_DELETE;
3228 case OFPUTIL_P_OF11_STD:
3229 case OFPUTIL_P_OF12_OXM:
3230 case OFPUTIL_P_OF13_OXM:
3231 case OFPUTIL_P_OF14_OXM:
3232 case OFPUTIL_P_OF15_OXM: {
3233 struct ofp12_flow_removed *ofr;
3235 msg = ofpraw_alloc_xid(OFPRAW_OFPT11_FLOW_REMOVED,
3236 ofputil_protocol_to_ofp_version(protocol),
3238 ofputil_match_typical_len(protocol));
3239 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
3240 ofr->cookie = fr->cookie;
3241 ofr->priority = htons(fr->priority);
3242 ofr->reason = reason;
3243 ofr->table_id = fr->table_id;
3244 ofr->duration_sec = htonl(fr->duration_sec);
3245 ofr->duration_nsec = htonl(fr->duration_nsec);
3246 ofr->idle_timeout = htons(fr->idle_timeout);
3247 ofr->hard_timeout = htons(fr->hard_timeout);
3248 ofr->packet_count = htonll(fr->packet_count);
3249 ofr->byte_count = htonll(fr->byte_count);
3250 ofputil_put_ofp11_match(msg, &fr->match, protocol);
3254 case OFPUTIL_P_OF10_STD:
3255 case OFPUTIL_P_OF10_STD_TID: {
3256 struct ofp10_flow_removed *ofr;
3258 msg = ofpraw_alloc_xid(OFPRAW_OFPT10_FLOW_REMOVED, OFP10_VERSION,
3260 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
3261 ofputil_match_to_ofp10_match(&fr->match, &ofr->match);
3262 ofr->cookie = fr->cookie;
3263 ofr->priority = htons(fr->priority);
3264 ofr->reason = reason;
3265 ofr->duration_sec = htonl(fr->duration_sec);
3266 ofr->duration_nsec = htonl(fr->duration_nsec);
3267 ofr->idle_timeout = htons(fr->idle_timeout);
3268 ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
3269 ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
3273 case OFPUTIL_P_OF10_NXM:
3274 case OFPUTIL_P_OF10_NXM_TID: {
3275 struct nx_flow_removed *nfr;
3278 msg = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_REMOVED, OFP10_VERSION,
3279 htonl(0), NXM_TYPICAL_LEN);
3280 ofpbuf_put_zeros(msg, sizeof *nfr);
3281 match_len = nx_put_match(msg, &fr->match, 0, 0);
3284 nfr->cookie = fr->cookie;
3285 nfr->priority = htons(fr->priority);
3286 nfr->reason = reason;
3287 nfr->table_id = fr->table_id + 1;
3288 nfr->duration_sec = htonl(fr->duration_sec);
3289 nfr->duration_nsec = htonl(fr->duration_nsec);
3290 nfr->idle_timeout = htons(fr->idle_timeout);
3291 nfr->match_len = htons(match_len);
3292 nfr->packet_count = htonll(fr->packet_count);
3293 nfr->byte_count = htonll(fr->byte_count);
3304 /* The caller has done basic initialization of '*pin'; the other output
3305 * arguments needs to be initialized. */
3307 decode_nx_packet_in2(const struct ofp_header *oh, bool loose,
3308 struct ofputil_packet_in *pin,
3309 size_t *total_len, uint32_t *buffer_id,
3310 struct ofpbuf *continuation)
3313 *buffer_id = UINT32_MAX;
3315 struct ofpbuf properties;
3316 ofpbuf_use_const(&properties, oh, ntohs(oh->length));
3317 ofpraw_pull_assert(&properties);
3319 while (properties.size > 0) {
3320 struct ofpbuf payload;
3323 enum ofperr error = ofpprop_pull(&properties, &payload, &type);
3330 pin->packet = payload.msg;
3331 pin->packet_len = ofpbuf_msgsize(&payload);
3334 case NXPINT_FULL_LEN: {
3336 error = ofpprop_parse_u32(&payload, &u32);
3341 case NXPINT_BUFFER_ID:
3342 error = ofpprop_parse_u32(&payload, buffer_id);
3345 case NXPINT_TABLE_ID:
3346 error = ofpprop_parse_u8(&payload, &pin->table_id);
3350 error = ofpprop_parse_be64(&payload, &pin->cookie);
3353 case NXPINT_REASON: {
3355 error = ofpprop_parse_u8(&payload, &reason);
3356 pin->reason = reason;
3360 case NXPINT_METADATA:
3361 error = oxm_decode_match(payload.msg, ofpbuf_msgsize(&payload),
3362 &pin->flow_metadata);
3365 case NXPINT_USERDATA:
3366 pin->userdata = payload.msg;
3367 pin->userdata_len = ofpbuf_msgsize(&payload);
3370 case NXPINT_CONTINUATION:
3372 error = ofpprop_parse_nested(&payload, continuation);
3377 error = OFPPROP_UNKNOWN(loose, "NX_PACKET_IN2", type);
3385 if (!pin->packet_len) {
3386 VLOG_WARN_RL(&bad_ofmsg_rl, "NXT_PACKET_IN2 lacks packet");
3387 return OFPERR_OFPBRC_BAD_LEN;
3388 } else if (!*total_len) {
3389 *total_len = pin->packet_len;
3390 } else if (*total_len < pin->packet_len) {
3391 VLOG_WARN_RL(&bad_ofmsg_rl, "NXT_PACKET_IN2 claimed full_len < len");
3392 return OFPERR_OFPBRC_BAD_LEN;
3398 /* Decodes the packet-in message starting at 'oh' into '*pin'. Populates
3399 * 'pin->packet' and 'pin->packet_len' with the part of the packet actually
3400 * included in the message. If 'total_lenp' is nonnull, populates
3401 * '*total_lenp' with the original length of the packet (which is larger than
3402 * 'packet->len' if only part of the packet was included). If 'buffer_idp' is
3403 * nonnull, stores the packet's buffer ID in '*buffer_idp' (UINT32_MAX if it
3404 * was not buffered).
3406 * Populates 'continuation', if nonnull, with the continuation data from the
3407 * packet-in (an empty buffer, if 'oh' did not contain continuation data). The
3408 * format of this data is supposed to be opaque to anything other than
3409 * ovs-vswitchd, so that in any other process the only reasonable use of this
3410 * data is to be copied into an NXT_RESUME message via ofputil_encode_resume().
3412 * This function points 'pin->packet' into 'oh', so the caller should not free
3413 * it separately from the original OpenFlow message. This is also true for
3414 * 'pin->userdata' (which could also end up NULL if there is no userdata).
3416 * Returns 0 if successful, otherwise an OpenFlow error code. */
3418 ofputil_decode_packet_in(const struct ofp_header *oh, bool loose,
3419 struct ofputil_packet_in *pin,
3420 size_t *total_lenp, uint32_t *buffer_idp,
3421 struct ofpbuf *continuation)
3426 memset(pin, 0, sizeof *pin);
3427 pin->cookie = OVS_BE64_MAX;
3429 ofpbuf_use_const(continuation, NULL, 0);
3432 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
3433 enum ofpraw raw = ofpraw_pull_assert(&b);
3434 if (raw == OFPRAW_OFPT13_PACKET_IN || raw == OFPRAW_OFPT12_PACKET_IN) {
3435 const struct ofp12_packet_in *opi = ofpbuf_pull(&b, sizeof *opi);
3436 const ovs_be64 *cookie = (raw == OFPRAW_OFPT13_PACKET_IN
3437 ? ofpbuf_pull(&b, sizeof *cookie)
3439 enum ofperr error = oxm_pull_match_loose(&b, &pin->flow_metadata);
3444 if (!ofpbuf_try_pull(&b, 2)) {
3445 return OFPERR_OFPBRC_BAD_LEN;
3448 pin->reason = opi->reason;
3449 pin->table_id = opi->table_id;
3450 buffer_id = ntohl(opi->buffer_id);
3451 total_len = ntohs(opi->total_len);
3453 pin->cookie = *cookie;
3456 pin->packet = b.data;
3457 pin->packet_len = b.size;
3458 } else if (raw == OFPRAW_OFPT10_PACKET_IN) {
3459 const struct ofp10_packet_in *opi;
3461 opi = ofpbuf_pull(&b, offsetof(struct ofp10_packet_in, data));
3463 pin->packet = CONST_CAST(uint8_t *, opi->data);
3464 pin->packet_len = b.size;
3466 match_init_catchall(&pin->flow_metadata);
3467 match_set_in_port(&pin->flow_metadata,
3468 u16_to_ofp(ntohs(opi->in_port)));
3469 pin->reason = opi->reason;
3470 buffer_id = ntohl(opi->buffer_id);
3471 total_len = ntohs(opi->total_len);
3472 } else if (raw == OFPRAW_OFPT11_PACKET_IN) {
3473 const struct ofp11_packet_in *opi;
3477 opi = ofpbuf_pull(&b, sizeof *opi);
3479 pin->packet = b.data;
3480 pin->packet_len = b.size;
3482 buffer_id = ntohl(opi->buffer_id);
3483 error = ofputil_port_from_ofp11(opi->in_port, &in_port);
3487 match_init_catchall(&pin->flow_metadata);
3488 match_set_in_port(&pin->flow_metadata, in_port);
3489 total_len = ntohs(opi->total_len);
3490 pin->reason = opi->reason;
3491 pin->table_id = opi->table_id;
3492 } else if (raw == OFPRAW_NXT_PACKET_IN) {
3493 const struct nx_packet_in *npi;
3496 npi = ofpbuf_pull(&b, sizeof *npi);
3497 error = nx_pull_match_loose(&b, ntohs(npi->match_len),
3498 &pin->flow_metadata, NULL, NULL);
3503 if (!ofpbuf_try_pull(&b, 2)) {
3504 return OFPERR_OFPBRC_BAD_LEN;
3507 pin->reason = npi->reason;
3508 pin->table_id = npi->table_id;
3509 pin->cookie = npi->cookie;
3511 buffer_id = ntohl(npi->buffer_id);
3512 total_len = ntohs(npi->total_len);
3514 pin->packet = b.data;
3515 pin->packet_len = b.size;
3516 } else if (raw == OFPRAW_NXT_PACKET_IN2 || raw == OFPRAW_NXT_RESUME) {
3517 enum ofperr error = decode_nx_packet_in2(oh, loose, pin, &total_len,
3518 &buffer_id, continuation);
3527 *total_lenp = total_len;
3530 *buffer_idp = buffer_id;
3537 encode_packet_in_reason(enum ofp_packet_in_reason reason,
3538 enum ofp_version version)
3543 case OFPR_INVALID_TTL:
3546 case OFPR_ACTION_SET:
3548 case OFPR_PACKET_OUT:
3549 return version < OFP14_VERSION ? OFPR_ACTION : reason;
3551 case OFPR_EXPLICIT_MISS:
3552 return version < OFP13_VERSION ? OFPR_ACTION : OFPR_NO_MATCH;
3554 case OFPR_IMPLICIT_MISS:
3555 return OFPR_NO_MATCH;
3557 case OFPR_N_REASONS:
3563 /* Only NXT_PACKET_IN2 (not NXT_RESUME) should include NXCPT_USERDATA, so this
3564 * function omits it. The caller can add it itself if desired. */
3566 ofputil_put_packet_in(const struct ofputil_packet_in *pin,
3567 enum ofp_version version, uint32_t buffer_id,
3568 size_t include_bytes, struct ofpbuf *msg)
3570 /* Add packet properties. */
3571 ofpprop_put(msg, NXPINT_PACKET, pin->packet, include_bytes);
3572 if (include_bytes != pin->packet_len) {
3573 ofpprop_put_u32(msg, NXPINT_FULL_LEN, pin->packet_len);
3575 if (buffer_id != UINT32_MAX) {
3576 ofpprop_put_u32(msg, NXPINT_BUFFER_ID, buffer_id);
3579 /* Add flow properties. */
3580 ofpprop_put_u8(msg, NXPINT_TABLE_ID, pin->table_id);
3581 if (pin->cookie != OVS_BE64_MAX) {
3582 ofpprop_put_be64(msg, NXPINT_COOKIE, pin->cookie);
3585 /* Add other properties. */
3586 ofpprop_put_u8(msg, NXPINT_REASON,
3587 encode_packet_in_reason(pin->reason, version));
3589 size_t start = ofpprop_start(msg, NXPINT_METADATA);
3590 oxm_put_raw(msg, &pin->flow_metadata, version);
3591 ofpprop_end(msg, start);
3595 put_actions_property(struct ofpbuf *msg, uint64_t prop_type,
3596 enum ofp_version version,
3597 const struct ofpact *actions, size_t actions_len)
3600 size_t start = ofpprop_start_nested(msg, prop_type);
3601 ofpacts_put_openflow_actions(actions, actions_len, msg, version);
3602 ofpprop_end(msg, start);
3606 enum nx_continuation_prop_type {
3607 NXCPT_BRIDGE = 0x8000,
3617 /* Only NXT_PACKET_IN2 (not NXT_RESUME) should include NXCPT_USERDATA, so this
3618 * function omits it. The caller can add it itself if desired. */
3620 ofputil_put_packet_in_private(const struct ofputil_packet_in_private *pin,
3621 enum ofp_version version, uint32_t buffer_id,
3622 size_t include_bytes, struct ofpbuf *msg)
3624 ofputil_put_packet_in(&pin->public, version, buffer_id,
3625 include_bytes, msg);
3627 size_t continuation_ofs = ofpprop_start_nested(msg, NXPINT_CONTINUATION);
3628 size_t inner_ofs = msg->size;
3630 if (!uuid_is_zero(&pin->bridge)) {
3631 ofpprop_put_uuid(msg, NXCPT_BRIDGE, &pin->bridge);
3634 for (size_t i = 0; i < pin->n_stack; i++) {
3635 const union mf_subvalue *s = &pin->stack[i];
3637 for (ofs = 0; ofs < sizeof *s; ofs++) {
3643 ofpprop_put(msg, NXCPT_STACK, &s->u8[ofs], sizeof *s - ofs);
3647 ofpprop_put_u32(msg, NXCPT_MIRRORS, pin->mirrors);
3650 if (pin->conntracked) {
3651 ofpprop_put_flag(msg, NXCPT_CONNTRACKED);
3654 if (pin->actions_len) {
3655 /* Divide 'pin->actions' into groups that begins with an
3656 * unroll_xlate action. For each group, emit a NXCPT_TABLE_ID and
3657 * NXCPT_COOKIE property (if either has changed; each is initially
3658 * assumed 0), then a NXCPT_ACTIONS property with the grouped
3661 * The alternative is to make OFPACT_UNROLL_XLATE public. We can
3662 * always do that later, since this is a private property. */
3663 const struct ofpact *const end = ofpact_end(pin->actions,
3665 const struct ofpact_unroll_xlate *unroll = NULL;
3666 uint8_t table_id = 0;
3667 ovs_be64 cookie = 0;
3669 const struct ofpact *a;
3670 for (a = pin->actions; ; a = ofpact_next(a)) {
3671 if (a == end || a->type == OFPACT_UNROLL_XLATE) {
3673 if (table_id != unroll->rule_table_id) {
3674 ofpprop_put_u8(msg, NXCPT_TABLE_ID,
3675 unroll->rule_table_id);
3676 table_id = unroll->rule_table_id;
3678 if (cookie != unroll->rule_cookie) {
3679 ofpprop_put_be64(msg, NXCPT_COOKIE,
3680 unroll->rule_cookie);
3681 cookie = unroll->rule_cookie;
3685 const struct ofpact *start
3686 = unroll ? ofpact_next(&unroll->ofpact) : pin->actions;
3687 put_actions_property(msg, NXCPT_ACTIONS, version,
3688 start, (a - start) * sizeof *a);
3693 unroll = ofpact_get_UNROLL_XLATE(a);
3698 if (pin->action_set_len) {
3699 size_t start = ofpprop_start_nested(msg, NXCPT_ACTION_SET);
3700 ofpacts_put_openflow_actions(pin->action_set,
3701 pin->action_set_len, msg, version);
3702 ofpprop_end(msg, start);
3705 if (msg->size > inner_ofs) {
3706 ofpprop_end(msg, continuation_ofs);
3708 msg->size = continuation_ofs;
3712 static struct ofpbuf *
3713 ofputil_encode_ofp10_packet_in(const struct ofputil_packet_in *pin,
3716 struct ofp10_packet_in *opi;
3719 msg = ofpraw_alloc_xid(OFPRAW_OFPT10_PACKET_IN, OFP10_VERSION,
3720 htonl(0), pin->packet_len);
3721 opi = ofpbuf_put_zeros(msg, offsetof(struct ofp10_packet_in, data));
3722 opi->total_len = htons(pin->packet_len);
3723 opi->in_port = htons(ofp_to_u16(pin->flow_metadata.flow.in_port.ofp_port));
3724 opi->reason = encode_packet_in_reason(pin->reason, OFP10_VERSION);
3725 opi->buffer_id = htonl(buffer_id);
3730 static struct ofpbuf *
3731 ofputil_encode_nx_packet_in(const struct ofputil_packet_in *pin,
3732 enum ofp_version version, uint32_t buffer_id)
3734 struct nx_packet_in *npi;
3738 /* The final argument is just an estimate of the space required. */
3739 msg = ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN, version,
3740 htonl(0), NXM_TYPICAL_LEN + 2 + pin->packet_len);
3741 ofpbuf_put_zeros(msg, sizeof *npi);
3742 match_len = nx_put_match(msg, &pin->flow_metadata, 0, 0);
3743 ofpbuf_put_zeros(msg, 2);
3746 npi->buffer_id = htonl(buffer_id);
3747 npi->total_len = htons(pin->packet_len);
3748 npi->reason = encode_packet_in_reason(pin->reason, version);
3749 npi->table_id = pin->table_id;
3750 npi->cookie = pin->cookie;
3751 npi->match_len = htons(match_len);
3756 static struct ofpbuf *
3757 ofputil_encode_nx_packet_in2(const struct ofputil_packet_in_private *pin,
3758 enum ofp_version version, uint32_t buffer_id,
3759 size_t include_bytes)
3761 /* 'extra' is just an estimate of the space required. */
3762 size_t extra = (pin->public.packet_len
3763 + NXM_TYPICAL_LEN /* flow_metadata */
3766 + pin->action_set_len
3767 + 256); /* fudge factor */
3768 struct ofpbuf *msg = ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN2, version,
3771 ofputil_put_packet_in_private(pin, version, buffer_id, include_bytes, msg);
3772 if (pin->public.userdata_len) {
3773 ofpprop_put(msg, NXPINT_USERDATA, pin->public.userdata,
3774 pin->public.userdata_len);
3777 ofpmsg_update_length(msg);
3781 static struct ofpbuf *
3782 ofputil_encode_ofp11_packet_in(const struct ofputil_packet_in *pin,
3785 struct ofp11_packet_in *opi;
3788 msg = ofpraw_alloc_xid(OFPRAW_OFPT11_PACKET_IN, OFP11_VERSION,
3789 htonl(0), pin->packet_len);
3790 opi = ofpbuf_put_zeros(msg, sizeof *opi);
3791 opi->buffer_id = htonl(buffer_id);
3792 opi->in_port = ofputil_port_to_ofp11(
3793 pin->flow_metadata.flow.in_port.ofp_port);
3794 opi->in_phy_port = opi->in_port;
3795 opi->total_len = htons(pin->packet_len);
3796 opi->reason = encode_packet_in_reason(pin->reason, OFP11_VERSION);
3797 opi->table_id = pin->table_id;
3802 static struct ofpbuf *
3803 ofputil_encode_ofp12_packet_in(const struct ofputil_packet_in *pin,
3804 enum ofp_version version,
3807 enum ofpraw raw = (version >= OFP13_VERSION
3808 ? OFPRAW_OFPT13_PACKET_IN
3809 : OFPRAW_OFPT12_PACKET_IN);
3812 /* The final argument is just an estimate of the space required. */
3813 msg = ofpraw_alloc_xid(raw, version,
3814 htonl(0), NXM_TYPICAL_LEN + 2 + pin->packet_len);
3816 struct ofp12_packet_in *opi = ofpbuf_put_zeros(msg, sizeof *opi);
3817 opi->buffer_id = htonl(buffer_id);
3818 opi->total_len = htons(pin->packet_len);
3819 opi->reason = encode_packet_in_reason(pin->reason, version);
3820 opi->table_id = pin->table_id;
3822 if (version >= OFP13_VERSION) {
3823 ovs_be64 cookie = pin->cookie;
3824 ofpbuf_put(msg, &cookie, sizeof cookie);
3827 oxm_put_match(msg, &pin->flow_metadata, version);
3828 ofpbuf_put_zeros(msg, 2);
3833 /* Converts abstract ofputil_packet_in_private 'pin' into a PACKET_IN message
3834 * for 'protocol', using the packet-in format specified by 'packet_in_format'.
3836 * If 'pkt_buf' is nonnull and 'max_len' allows the packet to be buffered, this
3837 * function will attempt to obtain a buffer ID from 'pktbuf' and truncate the
3838 * packet to 'max_len' bytes. Otherwise, or if 'pktbuf' doesn't have a free
3839 * buffer, it will send the whole packet without buffering.
3841 * This function is really meant only for use by ovs-vswitchd. To any other
3842 * code, the "continuation" data, i.e. the data that is in struct
3843 * ofputil_packet_in_private but not in struct ofputil_packet_in, is supposed
3844 * to be opaque (and it might change from one OVS version to another). Thus,
3845 * if any other code wants to encode a packet-in, it should use a non-"private"
3846 * version of this function. (Such a version doesn't currently exist because
3847 * only ovs-vswitchd currently wants to encode packet-ins. If you need one,
3850 ofputil_encode_packet_in_private(const struct ofputil_packet_in_private *pin,
3851 enum ofputil_protocol protocol,
3852 enum nx_packet_in_format packet_in_format,
3853 uint16_t max_len, struct pktbuf *pktbuf)
3855 enum ofp_version version = ofputil_protocol_to_ofp_version(protocol);
3857 /* Get buffer ID. */
3858 ofp_port_t in_port = pin->public.flow_metadata.flow.in_port.ofp_port;
3859 uint32_t buffer_id = (max_len != OFPCML12_NO_BUFFER && pktbuf
3860 ? pktbuf_save(pktbuf, pin->public.packet,
3861 pin->public.packet_len, in_port)
3864 /* Calculate the number of bytes of the packet to include in the
3867 * - If not buffered, the whole thing.
3869 * - Otherwise, no more than 'max_len' bytes. */
3870 size_t include_bytes = (buffer_id == UINT32_MAX
3871 ? pin->public.packet_len
3872 : MIN(max_len, pin->public.packet_len));
3875 switch (packet_in_format) {
3876 case NXPIF_STANDARD:
3878 case OFPUTIL_P_OF10_STD:
3879 case OFPUTIL_P_OF10_STD_TID:
3880 case OFPUTIL_P_OF10_NXM:
3881 case OFPUTIL_P_OF10_NXM_TID:
3882 msg = ofputil_encode_ofp10_packet_in(&pin->public, buffer_id);
3885 case OFPUTIL_P_OF11_STD:
3886 msg = ofputil_encode_ofp11_packet_in(&pin->public, buffer_id);
3889 case OFPUTIL_P_OF12_OXM:
3890 case OFPUTIL_P_OF13_OXM:
3891 case OFPUTIL_P_OF14_OXM:
3892 case OFPUTIL_P_OF15_OXM:
3893 msg = ofputil_encode_ofp12_packet_in(&pin->public, version, buffer_id);
3901 case NXPIF_NXT_PACKET_IN:
3902 msg = ofputil_encode_nx_packet_in(&pin->public, version, buffer_id);
3905 case NXPIF_NXT_PACKET_IN2:
3906 return ofputil_encode_nx_packet_in2(pin, version, buffer_id,
3913 ofpbuf_put(msg, pin->public.packet, include_bytes);
3914 ofpmsg_update_length(msg);
3918 /* Returns a string form of 'reason'. The return value is either a statically
3919 * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
3920 * 'bufsize' should be at least OFPUTIL_PACKET_IN_REASON_BUFSIZE. */
3922 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason,
3923 char *reasonbuf, size_t bufsize)
3930 case OFPR_INVALID_TTL:
3931 return "invalid_ttl";
3932 case OFPR_ACTION_SET:
3933 return "action_set";
3936 case OFPR_PACKET_OUT:
3937 return "packet_out";
3938 case OFPR_EXPLICIT_MISS:
3939 case OFPR_IMPLICIT_MISS:
3942 case OFPR_N_REASONS:
3944 snprintf(reasonbuf, bufsize, "%d", (int) reason);
3950 ofputil_packet_in_reason_from_string(const char *s,
3951 enum ofp_packet_in_reason *reason)
3955 for (i = 0; i < OFPR_N_REASONS; i++) {
3956 char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
3957 const char *reason_s;
3959 reason_s = ofputil_packet_in_reason_to_string(i, reasonbuf,
3961 if (!strcasecmp(s, reason_s)) {
3969 /* Returns a newly allocated NXT_RESUME message for 'pin', with the given
3970 * 'continuation', for 'protocol'. This message is suitable for resuming the
3971 * pipeline traveral of the packet represented by 'pin', if sent to the switch
3972 * from which 'pin' was received. */
3974 ofputil_encode_resume(const struct ofputil_packet_in *pin,
3975 const struct ofpbuf *continuation,
3976 enum ofputil_protocol protocol)
3978 enum ofp_version version = ofputil_protocol_to_ofp_version(protocol);
3979 size_t extra = pin->packet_len + NXM_TYPICAL_LEN + continuation->size;
3980 struct ofpbuf *msg = ofpraw_alloc_xid(OFPRAW_NXT_RESUME, version,
3982 ofputil_put_packet_in(pin, version, UINT32_MAX, pin->packet_len, msg);
3983 ofpprop_put_nested(msg, NXPINT_CONTINUATION, continuation);
3984 ofpmsg_update_length(msg);
3989 parse_subvalue_prop(const struct ofpbuf *property, union mf_subvalue *sv)
3991 unsigned int len = ofpbuf_msgsize(property);
3992 if (len > sizeof *sv) {
3993 VLOG_WARN_RL(&bad_ofmsg_rl, "NXCPT_STACK property has bad length %u",
3995 return OFPERR_OFPBPC_BAD_LEN;
3997 memset(sv, 0, sizeof *sv);
3998 memcpy(&sv->u8[sizeof *sv - len], property->msg, len);
4003 parse_actions_property(struct ofpbuf *property, enum ofp_version version,
4004 struct ofpbuf *ofpacts)
4006 if (!ofpbuf_try_pull(property, ROUND_UP(ofpbuf_headersize(property), 8))) {
4007 VLOG_WARN_RL(&bad_ofmsg_rl, "actions property has bad length %"PRIu32,
4009 return OFPERR_OFPBPC_BAD_LEN;
4012 return ofpacts_pull_openflow_actions(property, property->size,
4016 /* This is like ofputil_decode_packet_in(), except that it decodes the
4017 * continuation data into 'pin'. The format of this data is supposed to be
4018 * opaque to any process other than ovs-vswitchd, so this function should not
4019 * be used outside ovs-vswitchd.
4021 * When successful, 'pin' contains some dynamically allocated data. Call
4022 * ofputil_packet_in_private_destroy() to free this data. */
4024 ofputil_decode_packet_in_private(const struct ofp_header *oh, bool loose,
4025 struct ofputil_packet_in_private *pin,
4026 size_t *total_len, uint32_t *buffer_id)
4028 memset(pin, 0, sizeof *pin);
4030 struct ofpbuf continuation;
4032 error = ofputil_decode_packet_in(oh, loose, &pin->public, total_len,
4033 buffer_id, &continuation);
4038 struct ofpbuf actions, action_set;
4039 ofpbuf_init(&actions, 0);
4040 ofpbuf_init(&action_set, 0);
4042 uint8_t table_id = 0;
4043 ovs_be64 cookie = 0;
4045 size_t allocated_stack = 0;
4047 while (continuation.size > 0) {
4048 struct ofpbuf payload;
4051 error = ofpprop_pull(&continuation, &payload, &type);
4056 error = ofpprop_parse_uuid(&payload, &pin->bridge);
4060 if (pin->n_stack >= allocated_stack) {
4061 pin->stack = x2nrealloc(pin->stack, &allocated_stack,
4062 sizeof *pin->stack);
4064 error = parse_subvalue_prop(&payload,
4065 &pin->stack[pin->n_stack++]);
4069 error = ofpprop_parse_u32(&payload, &pin->mirrors);
4072 case NXCPT_CONNTRACKED:
4073 pin->conntracked = true;
4076 case NXCPT_TABLE_ID:
4077 error = ofpprop_parse_u8(&payload, &table_id);
4081 error = ofpprop_parse_be64(&payload, &cookie);
4084 case NXCPT_ACTIONS: {
4085 struct ofpact_unroll_xlate *unroll
4086 = ofpact_put_UNROLL_XLATE(&actions);
4087 unroll->rule_table_id = table_id;
4088 unroll->rule_cookie = cookie;
4089 error = parse_actions_property(&payload, oh->version, &actions);
4093 case NXCPT_ACTION_SET:
4094 error = parse_actions_property(&payload, oh->version, &action_set);
4098 error = OFPPROP_UNKNOWN(loose, "continuation", type);
4106 pin->actions_len = actions.size;
4107 pin->actions = ofpbuf_steal_data(&actions);
4108 pin->action_set_len = action_set.size;
4109 pin->action_set = ofpbuf_steal_data(&action_set);
4112 ofputil_packet_in_private_destroy(pin);
4118 /* Frees data in 'pin' that is dynamically allocated by
4119 * ofputil_decode_packet_in_private().
4121 * 'pin->public' contains some pointer members that
4122 * ofputil_decode_packet_in_private() doesn't initialize to newly allocated
4123 * data, so this function doesn't free those. */
4125 ofputil_packet_in_private_destroy(struct ofputil_packet_in_private *pin)
4130 free(pin->action_set);
4134 /* Converts an OFPT_PACKET_OUT in 'opo' into an abstract ofputil_packet_out in
4137 * Uses 'ofpacts' to store the abstract OFPACT_* version of the packet out
4138 * message's actions. The caller must initialize 'ofpacts' and retains
4139 * ownership of it. 'po->ofpacts' will point into the 'ofpacts' buffer.
4141 * Returns 0 if successful, otherwise an OFPERR_* value. */
4143 ofputil_decode_packet_out(struct ofputil_packet_out *po,
4144 const struct ofp_header *oh,
4145 struct ofpbuf *ofpacts)
4147 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
4148 enum ofpraw raw = ofpraw_pull_assert(&b);
4150 ofpbuf_clear(ofpacts);
4151 if (raw == OFPRAW_OFPT11_PACKET_OUT) {
4153 const struct ofp11_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
4155 po->buffer_id = ntohl(opo->buffer_id);
4156 error = ofputil_port_from_ofp11(opo->in_port, &po->in_port);
4161 error = ofpacts_pull_openflow_actions(&b, ntohs(opo->actions_len),
4162 oh->version, ofpacts);
4166 } else if (raw == OFPRAW_OFPT10_PACKET_OUT) {
4168 const struct ofp10_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
4170 po->buffer_id = ntohl(opo->buffer_id);
4171 po->in_port = u16_to_ofp(ntohs(opo->in_port));
4173 error = ofpacts_pull_openflow_actions(&b, ntohs(opo->actions_len),
4174 oh->version, ofpacts);
4182 if (ofp_to_u16(po->in_port) >= ofp_to_u16(OFPP_MAX)
4183 && po->in_port != OFPP_LOCAL
4184 && po->in_port != OFPP_NONE && po->in_port != OFPP_CONTROLLER) {
4185 VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
4187 return OFPERR_OFPBRC_BAD_PORT;
4190 po->ofpacts = ofpacts->data;
4191 po->ofpacts_len = ofpacts->size;
4193 if (po->buffer_id == UINT32_MAX) {
4194 po->packet = b.data;
4195 po->packet_len = b.size;
4204 /* ofputil_phy_port */
4206 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
4207 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
4208 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
4209 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
4210 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
4211 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
4212 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
4213 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
4215 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
4216 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
4217 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
4218 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
4219 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
4220 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
4222 static enum netdev_features
4223 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
4225 uint32_t ofp10 = ntohl(ofp10_);
4226 return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
4230 netdev_port_features_to_ofp10(enum netdev_features features)
4232 return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
4235 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
4236 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
4237 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
4238 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
4239 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
4240 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
4241 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
4242 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD == OFPPF11_40GB_FD); /* bit 7 */
4243 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD == OFPPF11_100GB_FD); /* bit 8 */
4244 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD == OFPPF11_1TB_FD); /* bit 9 */
4245 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER == OFPPF11_OTHER); /* bit 10 */
4246 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == OFPPF11_COPPER); /* bit 11 */
4247 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == OFPPF11_FIBER); /* bit 12 */
4248 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == OFPPF11_AUTONEG); /* bit 13 */
4249 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == OFPPF11_PAUSE); /* bit 14 */
4250 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
4252 static enum netdev_features
4253 netdev_port_features_from_ofp11(ovs_be32 ofp11)
4255 return ntohl(ofp11) & 0xffff;
4259 netdev_port_features_to_ofp11(enum netdev_features features)
4261 return htonl(features & 0xffff);
4265 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
4266 const struct ofp10_phy_port *opp)
4268 pp->port_no = u16_to_ofp(ntohs(opp->port_no));
4269 pp->hw_addr = opp->hw_addr;
4270 ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
4272 pp->config = ntohl(opp->config) & OFPPC10_ALL;
4273 pp->state = ntohl(opp->state) & OFPPS10_ALL;
4275 pp->curr = netdev_port_features_from_ofp10(opp->curr);
4276 pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
4277 pp->supported = netdev_port_features_from_ofp10(opp->supported);
4278 pp->peer = netdev_port_features_from_ofp10(opp->peer);
4280 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
4281 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
4287 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
4288 const struct ofp11_port *op)
4292 error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
4296 pp->hw_addr = op->hw_addr;
4297 ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
4299 pp->config = ntohl(op->config) & OFPPC11_ALL;
4300 pp->state = ntohl(op->state) & OFPPS11_ALL;
4302 pp->curr = netdev_port_features_from_ofp11(op->curr);
4303 pp->advertised = netdev_port_features_from_ofp11(op->advertised);
4304 pp->supported = netdev_port_features_from_ofp11(op->supported);
4305 pp->peer = netdev_port_features_from_ofp11(op->peer);
4307 pp->curr_speed = ntohl(op->curr_speed);
4308 pp->max_speed = ntohl(op->max_speed);
4314 parse_ofp14_port_ethernet_property(const struct ofpbuf *payload,
4315 struct ofputil_phy_port *pp)
4317 struct ofp14_port_desc_prop_ethernet *eth = payload->data;
4319 if (payload->size != sizeof *eth) {
4320 return OFPERR_OFPBPC_BAD_LEN;
4323 pp->curr = netdev_port_features_from_ofp11(eth->curr);
4324 pp->advertised = netdev_port_features_from_ofp11(eth->advertised);
4325 pp->supported = netdev_port_features_from_ofp11(eth->supported);
4326 pp->peer = netdev_port_features_from_ofp11(eth->peer);
4328 pp->curr_speed = ntohl(eth->curr_speed);
4329 pp->max_speed = ntohl(eth->max_speed);
4335 ofputil_pull_ofp14_port(struct ofputil_phy_port *pp, struct ofpbuf *msg)
4337 struct ofp14_port *op = ofpbuf_try_pull(msg, sizeof *op);
4339 return OFPERR_OFPBRC_BAD_LEN;
4342 size_t len = ntohs(op->length);
4343 if (len < sizeof *op || len - sizeof *op > msg->size) {
4344 return OFPERR_OFPBRC_BAD_LEN;
4348 enum ofperr error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
4352 pp->hw_addr = op->hw_addr;
4353 ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
4355 pp->config = ntohl(op->config) & OFPPC11_ALL;
4356 pp->state = ntohl(op->state) & OFPPS11_ALL;
4358 struct ofpbuf properties = ofpbuf_const_initializer(ofpbuf_pull(msg, len),
4360 while (properties.size > 0) {
4361 struct ofpbuf payload;
4365 error = ofpprop_pull(&properties, &payload, &type);
4371 case OFPPDPT14_ETHERNET:
4372 error = parse_ofp14_port_ethernet_property(&payload, pp);
4376 error = OFPPROP_UNKNOWN(true, "port", type);
4389 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
4390 struct ofp10_phy_port *opp)
4392 memset(opp, 0, sizeof *opp);
4394 opp->port_no = htons(ofp_to_u16(pp->port_no));
4395 opp->hw_addr = pp->hw_addr;
4396 ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
4398 opp->config = htonl(pp->config & OFPPC10_ALL);
4399 opp->state = htonl(pp->state & OFPPS10_ALL);
4401 opp->curr = netdev_port_features_to_ofp10(pp->curr);
4402 opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
4403 opp->supported = netdev_port_features_to_ofp10(pp->supported);
4404 opp->peer = netdev_port_features_to_ofp10(pp->peer);
4408 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
4409 struct ofp11_port *op)
4411 memset(op, 0, sizeof *op);
4413 op->port_no = ofputil_port_to_ofp11(pp->port_no);
4414 op->hw_addr = pp->hw_addr;
4415 ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
4417 op->config = htonl(pp->config & OFPPC11_ALL);
4418 op->state = htonl(pp->state & OFPPS11_ALL);
4420 op->curr = netdev_port_features_to_ofp11(pp->curr);
4421 op->advertised = netdev_port_features_to_ofp11(pp->advertised);
4422 op->supported = netdev_port_features_to_ofp11(pp->supported);
4423 op->peer = netdev_port_features_to_ofp11(pp->peer);
4425 op->curr_speed = htonl(pp->curr_speed);
4426 op->max_speed = htonl(pp->max_speed);
4430 ofputil_put_ofp14_port(const struct ofputil_phy_port *pp,
4433 struct ofp14_port *op;
4434 struct ofp14_port_desc_prop_ethernet *eth;
4436 ofpbuf_prealloc_tailroom(b, sizeof *op + sizeof *eth);
4438 op = ofpbuf_put_zeros(b, sizeof *op);
4439 op->port_no = ofputil_port_to_ofp11(pp->port_no);
4440 op->length = htons(sizeof *op + sizeof *eth);
4441 op->hw_addr = pp->hw_addr;
4442 ovs_strlcpy(op->name, pp->name, sizeof op->name);
4443 op->config = htonl(pp->config & OFPPC11_ALL);
4444 op->state = htonl(pp->state & OFPPS11_ALL);
4446 eth = ofpprop_put_zeros(b, OFPPDPT14_ETHERNET, sizeof *eth);
4447 eth->curr = netdev_port_features_to_ofp11(pp->curr);
4448 eth->advertised = netdev_port_features_to_ofp11(pp->advertised);
4449 eth->supported = netdev_port_features_to_ofp11(pp->supported);
4450 eth->peer = netdev_port_features_to_ofp11(pp->peer);
4451 eth->curr_speed = htonl(pp->curr_speed);
4452 eth->max_speed = htonl(pp->max_speed);
4456 ofputil_put_phy_port(enum ofp_version ofp_version,
4457 const struct ofputil_phy_port *pp, struct ofpbuf *b)
4459 switch (ofp_version) {
4460 case OFP10_VERSION: {
4461 struct ofp10_phy_port *opp = ofpbuf_put_uninit(b, sizeof *opp);
4462 ofputil_encode_ofp10_phy_port(pp, opp);
4468 case OFP13_VERSION: {
4469 struct ofp11_port *op = ofpbuf_put_uninit(b, sizeof *op);
4470 ofputil_encode_ofp11_port(pp, op);
4476 ofputil_put_ofp14_port(pp, b);
4485 ofputil_decode_port_desc_stats_request(const struct ofp_header *request,
4488 struct ofpbuf b = ofpbuf_const_initializer(request,
4489 ntohs(request->length));
4490 enum ofpraw raw = ofpraw_pull_assert(&b);
4491 if (raw == OFPRAW_OFPST10_PORT_DESC_REQUEST) {
4494 } else if (raw == OFPRAW_OFPST15_PORT_DESC_REQUEST) {
4495 ovs_be32 *ofp11_port;
4497 ofp11_port = ofpbuf_pull(&b, sizeof *ofp11_port);
4498 return ofputil_port_from_ofp11(*ofp11_port, port);
4505 ofputil_encode_port_desc_stats_request(enum ofp_version ofp_version,
4508 struct ofpbuf *request;
4510 switch (ofp_version) {
4516 request = ofpraw_alloc(OFPRAW_OFPST10_PORT_DESC_REQUEST,
4519 case OFP15_VERSION:{
4520 struct ofp15_port_desc_request *req;
4521 request = ofpraw_alloc(OFPRAW_OFPST15_PORT_DESC_REQUEST,
4523 req = ofpbuf_put_zeros(request, sizeof *req);
4524 req->port_no = ofputil_port_to_ofp11(port);
4535 ofputil_append_port_desc_stats_reply(const struct ofputil_phy_port *pp,
4536 struct ovs_list *replies)
4538 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
4539 size_t start_ofs = reply->size;
4541 ofputil_put_phy_port(ofpmp_version(replies), pp, reply);
4542 ofpmp_postappend(replies, start_ofs);
4545 /* ofputil_switch_config */
4547 /* Decodes 'oh', which must be an OFPT_GET_CONFIG_REPLY or OFPT_SET_CONFIG
4548 * message, into 'config'. Returns false if 'oh' contained any flags that
4549 * aren't specified in its version of OpenFlow, true otherwise. */
4551 ofputil_decode_switch_config(const struct ofp_header *oh,
4552 struct ofputil_switch_config *config)
4554 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
4555 ofpraw_pull_assert(&b);
4557 const struct ofp_switch_config *osc = ofpbuf_pull(&b, sizeof *osc);
4558 config->frag = ntohs(osc->flags) & OFPC_FRAG_MASK;
4559 config->miss_send_len = ntohs(osc->miss_send_len);
4561 ovs_be16 valid_mask = htons(OFPC_FRAG_MASK);
4562 if (oh->version < OFP13_VERSION) {
4563 const ovs_be16 ttl_bit = htons(OFPC_INVALID_TTL_TO_CONTROLLER);
4564 valid_mask |= ttl_bit;
4565 config->invalid_ttl_to_controller = (osc->flags & ttl_bit) != 0;
4567 config->invalid_ttl_to_controller = -1;
4570 return !(osc->flags & ~valid_mask);
4574 ofputil_decode_get_config_reply(const struct ofp_header *oh,
4575 struct ofputil_switch_config *config)
4577 ofputil_decode_switch_config(oh, config);
4581 ofputil_decode_set_config(const struct ofp_header *oh,
4582 struct ofputil_switch_config *config)
4584 return (ofputil_decode_switch_config(oh, config)
4586 : OFPERR_OFPSCFC_BAD_FLAGS);
4589 static struct ofpbuf *
4590 ofputil_put_switch_config(const struct ofputil_switch_config *config,
4593 const struct ofp_header *oh = b->data;
4594 struct ofp_switch_config *osc = ofpbuf_put_zeros(b, sizeof *osc);
4595 osc->flags = htons(config->frag);
4596 if (config->invalid_ttl_to_controller > 0 && oh->version < OFP13_VERSION) {
4597 osc->flags |= htons(OFPC_INVALID_TTL_TO_CONTROLLER);
4599 osc->miss_send_len = htons(config->miss_send_len);
4604 ofputil_encode_get_config_reply(const struct ofp_header *request,
4605 const struct ofputil_switch_config *config)
4607 struct ofpbuf *b = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY,
4609 return ofputil_put_switch_config(config, b);
4613 ofputil_encode_set_config(const struct ofputil_switch_config *config,
4614 enum ofp_version version)
4616 struct ofpbuf *b = ofpraw_alloc(OFPRAW_OFPT_SET_CONFIG, version, 0);
4617 return ofputil_put_switch_config(config, b);
4620 /* ofputil_switch_features */
4622 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
4623 OFPC_IP_REASM | OFPC_QUEUE_STATS)
4624 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
4625 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
4626 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
4627 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
4628 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
4629 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
4632 ofputil_capabilities_mask(enum ofp_version ofp_version)
4634 /* Handle capabilities whose bit is unique for all OpenFlow versions */
4635 switch (ofp_version) {
4638 return OFPC_COMMON | OFPC_ARP_MATCH_IP;
4643 return OFPC_COMMON | OFPC12_PORT_BLOCKED;
4645 /* Caller needs to check osf->header.version itself */
4650 /* Pulls an OpenFlow "switch_features" structure from 'b' and decodes it into
4651 * an abstract representation in '*features', readying 'b' to iterate over the
4652 * OpenFlow port structures following 'osf' with later calls to
4653 * ofputil_pull_phy_port(). Returns 0 if successful, otherwise an OFPERR_*
4656 ofputil_pull_switch_features(struct ofpbuf *b,
4657 struct ofputil_switch_features *features)
4659 const struct ofp_header *oh = b->data;
4660 enum ofpraw raw = ofpraw_pull_assert(b);
4661 const struct ofp_switch_features *osf = ofpbuf_pull(b, sizeof *osf);
4662 features->datapath_id = ntohll(osf->datapath_id);
4663 features->n_buffers = ntohl(osf->n_buffers);
4664 features->n_tables = osf->n_tables;
4665 features->auxiliary_id = 0;
4667 features->capabilities = ntohl(osf->capabilities) &
4668 ofputil_capabilities_mask(oh->version);
4670 if (raw == OFPRAW_OFPT10_FEATURES_REPLY) {
4671 if (osf->capabilities & htonl(OFPC10_STP)) {
4672 features->capabilities |= OFPUTIL_C_STP;
4674 features->ofpacts = ofpact_bitmap_from_openflow(osf->actions,
4676 } else if (raw == OFPRAW_OFPT11_FEATURES_REPLY
4677 || raw == OFPRAW_OFPT13_FEATURES_REPLY) {
4678 if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
4679 features->capabilities |= OFPUTIL_C_GROUP_STATS;
4681 features->ofpacts = 0;
4682 if (raw == OFPRAW_OFPT13_FEATURES_REPLY) {
4683 features->auxiliary_id = osf->auxiliary_id;
4686 return OFPERR_OFPBRC_BAD_VERSION;
4692 /* In OpenFlow 1.0, 1.1, and 1.2, an OFPT_FEATURES_REPLY message lists all the
4693 * switch's ports, unless there are too many to fit. In OpenFlow 1.3 and
4694 * later, an OFPT_FEATURES_REPLY does not list ports at all.
4696 * Given a buffer 'b' that contains a Features Reply message, this message
4697 * checks if it contains a complete list of the switch's ports. Returns true,
4698 * if so. Returns false if the list is missing (OF1.3+) or incomplete
4699 * (OF1.0/1.1/1.2), and in the latter case removes all of the ports from the
4702 * When this function returns false, the caller should send an OFPST_PORT_DESC
4703 * stats request to get the ports. */
4705 ofputil_switch_features_has_ports(struct ofpbuf *b)
4707 struct ofp_header *oh = b->data;
4708 size_t phy_port_size;
4710 if (oh->version >= OFP13_VERSION) {
4711 /* OpenFlow 1.3+ never has ports in the feature reply. */
4715 phy_port_size = (oh->version == OFP10_VERSION
4716 ? sizeof(struct ofp10_phy_port)
4717 : sizeof(struct ofp11_port));
4718 if (ntohs(oh->length) + phy_port_size <= UINT16_MAX) {
4719 /* There's room for additional ports in the feature reply.
4720 * Assume that the list is complete. */
4724 /* The feature reply has no room for more ports. Probably the list is
4725 * truncated. Drop the ports and tell the caller to retrieve them with
4726 * OFPST_PORT_DESC. */
4727 b->size = sizeof *oh + sizeof(struct ofp_switch_features);
4728 ofpmsg_update_length(b);
4732 /* Returns a buffer owned by the caller that encodes 'features' in the format
4733 * required by 'protocol' with the given 'xid'. The caller should append port
4734 * information to the buffer with subsequent calls to
4735 * ofputil_put_switch_features_port(). */
4737 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
4738 enum ofputil_protocol protocol, ovs_be32 xid)
4740 struct ofp_switch_features *osf;
4742 enum ofp_version version;
4745 version = ofputil_protocol_to_ofp_version(protocol);
4748 raw = OFPRAW_OFPT10_FEATURES_REPLY;
4752 raw = OFPRAW_OFPT11_FEATURES_REPLY;
4757 raw = OFPRAW_OFPT13_FEATURES_REPLY;
4762 b = ofpraw_alloc_xid(raw, version, xid, 0);
4763 osf = ofpbuf_put_zeros(b, sizeof *osf);
4764 osf->datapath_id = htonll(features->datapath_id);
4765 osf->n_buffers = htonl(features->n_buffers);
4766 osf->n_tables = features->n_tables;
4768 osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
4769 osf->capabilities = htonl(features->capabilities &
4770 ofputil_capabilities_mask(version));
4773 if (features->capabilities & OFPUTIL_C_STP) {
4774 osf->capabilities |= htonl(OFPC10_STP);
4776 osf->actions = ofpact_bitmap_to_openflow(features->ofpacts,
4782 osf->auxiliary_id = features->auxiliary_id;
4786 if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
4787 osf->capabilities |= htonl(OFPC11_GROUP_STATS);
4797 /* Encodes 'pp' into the format required by the switch_features message already
4798 * in 'b', which should have been returned by ofputil_encode_switch_features(),
4799 * and appends the encoded version to 'b'. */
4801 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
4804 const struct ofp_header *oh = b->data;
4806 if (oh->version < OFP13_VERSION) {
4807 /* Try adding a port description to the message, but drop it again if
4808 * the buffer overflows. (This possibility for overflow is why
4809 * OpenFlow 1.3+ moved port descriptions into a multipart message.) */
4810 size_t start_ofs = b->size;
4811 ofputil_put_phy_port(oh->version, pp, b);
4812 if (b->size > UINT16_MAX) {
4813 b->size = start_ofs;
4818 /* ofputil_port_status */
4820 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
4821 * in '*ps'. Returns 0 if successful, otherwise an OFPERR_* value. */
4823 ofputil_decode_port_status(const struct ofp_header *oh,
4824 struct ofputil_port_status *ps)
4826 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
4827 ofpraw_pull_assert(&b);
4829 const struct ofp_port_status *ops = ofpbuf_pull(&b, sizeof *ops);
4830 if (ops->reason != OFPPR_ADD &&
4831 ops->reason != OFPPR_DELETE &&
4832 ops->reason != OFPPR_MODIFY) {
4833 return OFPERR_NXBRC_BAD_REASON;
4835 ps->reason = ops->reason;
4837 int retval = ofputil_pull_phy_port(oh->version, &b, &ps->desc);
4838 ovs_assert(retval != EOF);
4842 /* Converts the abstract form of a "port status" message in '*ps' into an
4843 * OpenFlow message suitable for 'protocol', and returns that encoded form in
4844 * a buffer owned by the caller. */
4846 ofputil_encode_port_status(const struct ofputil_port_status *ps,
4847 enum ofputil_protocol protocol)
4849 struct ofp_port_status *ops;
4851 enum ofp_version version;
4854 version = ofputil_protocol_to_ofp_version(protocol);
4857 raw = OFPRAW_OFPT10_PORT_STATUS;
4863 raw = OFPRAW_OFPT11_PORT_STATUS;
4868 raw = OFPRAW_OFPT14_PORT_STATUS;
4875 b = ofpraw_alloc_xid(raw, version, htonl(0), 0);
4876 ops = ofpbuf_put_zeros(b, sizeof *ops);
4877 ops->reason = ps->reason;
4878 ofputil_put_phy_port(version, &ps->desc, b);
4879 ofpmsg_update_length(b);
4883 /* ofputil_port_mod */
4886 parse_port_mod_ethernet_property(struct ofpbuf *property,
4887 struct ofputil_port_mod *pm)
4892 error = ofpprop_parse_be32(property, &advertise);
4894 pm->advertise = netdev_port_features_from_ofp11(advertise);
4899 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
4900 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
4902 ofputil_decode_port_mod(const struct ofp_header *oh,
4903 struct ofputil_port_mod *pm, bool loose)
4905 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
4906 enum ofpraw raw = ofpraw_pull_assert(&b);
4907 if (raw == OFPRAW_OFPT10_PORT_MOD) {
4908 const struct ofp10_port_mod *opm = b.data;
4910 pm->port_no = u16_to_ofp(ntohs(opm->port_no));
4911 pm->hw_addr = opm->hw_addr;
4912 pm->config = ntohl(opm->config) & OFPPC10_ALL;
4913 pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
4914 pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
4915 } else if (raw == OFPRAW_OFPT11_PORT_MOD) {
4916 const struct ofp11_port_mod *opm = b.data;
4919 error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
4924 pm->hw_addr = opm->hw_addr;
4925 pm->config = ntohl(opm->config) & OFPPC11_ALL;
4926 pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
4927 pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
4928 } else if (raw == OFPRAW_OFPT14_PORT_MOD) {
4929 const struct ofp14_port_mod *opm = ofpbuf_pull(&b, sizeof *opm);
4932 memset(pm, 0, sizeof *pm);
4934 error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
4939 pm->hw_addr = opm->hw_addr;
4940 pm->config = ntohl(opm->config) & OFPPC11_ALL;
4941 pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
4943 while (b.size > 0) {
4944 struct ofpbuf property;
4948 error = ofpprop_pull(&b, &property, &type);
4954 case OFPPMPT14_ETHERNET:
4955 error = parse_port_mod_ethernet_property(&property, pm);
4959 error = OFPPROP_UNKNOWN(loose, "port_mod", type);
4968 return OFPERR_OFPBRC_BAD_TYPE;
4971 pm->config &= pm->mask;
4975 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
4976 * message suitable for 'protocol', and returns that encoded form in a buffer
4977 * owned by the caller. */
4979 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
4980 enum ofputil_protocol protocol)
4982 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
4985 switch (ofp_version) {
4986 case OFP10_VERSION: {
4987 struct ofp10_port_mod *opm;
4989 b = ofpraw_alloc(OFPRAW_OFPT10_PORT_MOD, ofp_version, 0);
4990 opm = ofpbuf_put_zeros(b, sizeof *opm);
4991 opm->port_no = htons(ofp_to_u16(pm->port_no));
4992 opm->hw_addr = pm->hw_addr;
4993 opm->config = htonl(pm->config & OFPPC10_ALL);
4994 opm->mask = htonl(pm->mask & OFPPC10_ALL);
4995 opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
5001 case OFP13_VERSION: {
5002 struct ofp11_port_mod *opm;
5004 b = ofpraw_alloc(OFPRAW_OFPT11_PORT_MOD, ofp_version, 0);
5005 opm = ofpbuf_put_zeros(b, sizeof *opm);
5006 opm->port_no = ofputil_port_to_ofp11(pm->port_no);
5007 opm->hw_addr = pm->hw_addr;
5008 opm->config = htonl(pm->config & OFPPC11_ALL);
5009 opm->mask = htonl(pm->mask & OFPPC11_ALL);
5010 opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
5014 case OFP15_VERSION: {
5015 struct ofp14_port_mod *opm;
5017 b = ofpraw_alloc(OFPRAW_OFPT14_PORT_MOD, ofp_version, 0);
5018 opm = ofpbuf_put_zeros(b, sizeof *opm);
5019 opm->port_no = ofputil_port_to_ofp11(pm->port_no);
5020 opm->hw_addr = pm->hw_addr;
5021 opm->config = htonl(pm->config & OFPPC11_ALL);
5022 opm->mask = htonl(pm->mask & OFPPC11_ALL);
5024 if (pm->advertise) {
5025 ofpprop_put_be32(b, OFPPMPT14_ETHERNET,
5026 netdev_port_features_to_ofp11(pm->advertise));
5037 /* Table features. */
5040 pull_table_feature_property(struct ofpbuf *msg, struct ofpbuf *payload,
5045 error = ofpprop_pull(msg, payload, typep);
5046 if (payload && !error) {
5047 ofpbuf_pull(payload, (char *)payload->msg - (char *)payload->header);
5053 parse_action_bitmap(struct ofpbuf *payload, enum ofp_version ofp_version,
5058 while (payload->size > 0) {
5062 error = ofpprop_pull__(payload, NULL, 1, 0x10000, &type);
5066 if (type < CHAR_BIT * sizeof types) {
5067 types |= 1u << type;
5071 *ofpacts = ofpact_bitmap_from_openflow(htonl(types), ofp_version);
5076 parse_instruction_ids(struct ofpbuf *payload, bool loose, uint32_t *insts)
5079 while (payload->size > 0) {
5080 enum ovs_instruction_type inst;
5084 /* OF1.3 and OF1.4 aren't clear about padding in the instruction IDs.
5085 * It seems clear that they aren't padded to 8 bytes, though, because
5086 * both standards say that "non-experimenter instructions are 4 bytes"
5087 * and do not mention any padding before the first instruction ID.
5088 * (There wouldn't be any point in padding to 8 bytes if the IDs were
5089 * aligned on an odd 4-byte boundary.)
5091 * Anyway, we just assume they're all glommed together on byte
5093 error = ofpprop_pull__(payload, NULL, 1, 0x10000, &ofpit);
5098 error = ovs_instruction_type_from_inst_type(&inst, ofpit);
5100 *insts |= 1u << inst;
5101 } else if (!loose) {
5109 parse_table_features_next_table(struct ofpbuf *payload,
5110 unsigned long int *next_tables)
5114 memset(next_tables, 0, bitmap_n_bytes(255));
5115 for (i = 0; i < payload->size; i++) {
5116 uint8_t id = ((const uint8_t *) payload->data)[i];
5118 return OFPERR_OFPBPC_BAD_VALUE;
5120 bitmap_set1(next_tables, id);
5126 parse_oxms(struct ofpbuf *payload, bool loose,
5127 struct mf_bitmap *exactp, struct mf_bitmap *maskedp)
5129 struct mf_bitmap exact = MF_BITMAP_INITIALIZER;
5130 struct mf_bitmap masked = MF_BITMAP_INITIALIZER;
5132 while (payload->size > 0) {
5133 const struct mf_field *field;
5137 error = nx_pull_header(payload, &field, &hasmask);
5139 bitmap_set1(hasmask ? masked.bm : exact.bm, field->id);
5140 } else if (error != OFPERR_OFPBMC_BAD_FIELD || !loose) {
5146 } else if (!bitmap_is_all_zeros(exact.bm, MFF_N_IDS)) {
5147 return OFPERR_OFPBMC_BAD_MASK;
5151 } else if (!bitmap_is_all_zeros(masked.bm, MFF_N_IDS)) {
5152 return OFPERR_OFPBMC_BAD_MASK;
5157 /* Converts an OFPMP_TABLE_FEATURES request or reply in 'msg' into an abstract
5158 * ofputil_table_features in 'tf'.
5160 * If 'loose' is true, this function ignores properties and values that it does
5161 * not understand, as a controller would want to do when interpreting
5162 * capabilities provided by a switch. If 'loose' is false, this function
5163 * treats unknown properties and values as an error, as a switch would want to
5164 * do when interpreting a configuration request made by a controller.
5166 * A single OpenFlow message can specify features for multiple tables. Calling
5167 * this function multiple times for a single 'msg' iterates through the tables
5168 * in the message. The caller must initially leave 'msg''s layer pointers null
5169 * and not modify them between calls.
5171 * Returns 0 if successful, EOF if no tables were left in this 'msg', otherwise
5172 * a positive "enum ofperr" value. */
5174 ofputil_decode_table_features(struct ofpbuf *msg,
5175 struct ofputil_table_features *tf, bool loose)
5177 memset(tf, 0, sizeof *tf);
5180 ofpraw_pull_assert(msg);
5187 const struct ofp_header *oh = msg->header;
5188 struct ofp13_table_features *otf = msg->data;
5189 if (msg->size < sizeof *otf) {
5190 return OFPERR_OFPBPC_BAD_LEN;
5193 unsigned int len = ntohs(otf->length);
5194 if (len < sizeof *otf || len % 8 || len > msg->size) {
5195 return OFPERR_OFPBPC_BAD_LEN;
5198 tf->table_id = otf->table_id;
5199 if (tf->table_id == OFPTT_ALL) {
5200 return OFPERR_OFPTFFC_BAD_TABLE;
5203 ovs_strlcpy(tf->name, otf->name, OFP_MAX_TABLE_NAME_LEN);
5204 tf->metadata_match = otf->metadata_match;
5205 tf->metadata_write = otf->metadata_write;
5206 tf->miss_config = OFPUTIL_TABLE_MISS_DEFAULT;
5207 if (oh->version >= OFP14_VERSION) {
5208 uint32_t caps = ntohl(otf->capabilities);
5209 tf->supports_eviction = (caps & OFPTC14_EVICTION) != 0;
5210 tf->supports_vacancy_events = (caps & OFPTC14_VACANCY_EVENTS) != 0;
5212 tf->supports_eviction = -1;
5213 tf->supports_vacancy_events = -1;
5215 tf->max_entries = ntohl(otf->max_entries);
5217 struct ofpbuf properties = ofpbuf_const_initializer(ofpbuf_pull(msg, len),
5219 ofpbuf_pull(&properties, sizeof *otf);
5220 while (properties.size > 0) {
5221 struct ofpbuf payload;
5225 error = pull_table_feature_property(&properties, &payload, &type);
5230 switch ((enum ofp13_table_feature_prop_type) type) {
5231 case OFPTFPT13_INSTRUCTIONS:
5232 error = parse_instruction_ids(&payload, loose,
5233 &tf->nonmiss.instructions);
5235 case OFPTFPT13_INSTRUCTIONS_MISS:
5236 error = parse_instruction_ids(&payload, loose,
5237 &tf->miss.instructions);
5240 case OFPTFPT13_NEXT_TABLES:
5241 error = parse_table_features_next_table(&payload,
5244 case OFPTFPT13_NEXT_TABLES_MISS:
5245 error = parse_table_features_next_table(&payload, tf->miss.next);
5248 case OFPTFPT13_WRITE_ACTIONS:
5249 error = parse_action_bitmap(&payload, oh->version,
5250 &tf->nonmiss.write.ofpacts);
5252 case OFPTFPT13_WRITE_ACTIONS_MISS:
5253 error = parse_action_bitmap(&payload, oh->version,
5254 &tf->miss.write.ofpacts);
5257 case OFPTFPT13_APPLY_ACTIONS:
5258 error = parse_action_bitmap(&payload, oh->version,
5259 &tf->nonmiss.apply.ofpacts);
5261 case OFPTFPT13_APPLY_ACTIONS_MISS:
5262 error = parse_action_bitmap(&payload, oh->version,
5263 &tf->miss.apply.ofpacts);
5266 case OFPTFPT13_MATCH:
5267 error = parse_oxms(&payload, loose, &tf->match, &tf->mask);
5269 case OFPTFPT13_WILDCARDS:
5270 error = parse_oxms(&payload, loose, &tf->wildcard, NULL);
5273 case OFPTFPT13_WRITE_SETFIELD:
5274 error = parse_oxms(&payload, loose,
5275 &tf->nonmiss.write.set_fields, NULL);
5277 case OFPTFPT13_WRITE_SETFIELD_MISS:
5278 error = parse_oxms(&payload, loose,
5279 &tf->miss.write.set_fields, NULL);
5281 case OFPTFPT13_APPLY_SETFIELD:
5282 error = parse_oxms(&payload, loose,
5283 &tf->nonmiss.apply.set_fields, NULL);
5285 case OFPTFPT13_APPLY_SETFIELD_MISS:
5286 error = parse_oxms(&payload, loose,
5287 &tf->miss.apply.set_fields, NULL);
5290 case OFPTFPT13_EXPERIMENTER:
5291 case OFPTFPT13_EXPERIMENTER_MISS:
5293 error = OFPPROP_UNKNOWN(loose, "table features", type);
5301 /* Fix inconsistencies:
5303 * - Turn on 'match' bits that are set in 'mask', because maskable
5304 * fields are matchable.
5306 * - Turn on 'wildcard' bits that are set in 'mask', because a field
5307 * that is arbitrarily maskable can be wildcarded entirely.
5309 * - Turn off 'wildcard' bits that are not in 'match', because a field
5310 * must be matchable for it to be meaningfully wildcarded. */
5311 bitmap_or(tf->match.bm, tf->mask.bm, MFF_N_IDS);
5312 bitmap_or(tf->wildcard.bm, tf->mask.bm, MFF_N_IDS);
5313 bitmap_and(tf->wildcard.bm, tf->match.bm, MFF_N_IDS);
5318 /* Encodes and returns a request to obtain the table features of a switch.
5319 * The message is encoded for OpenFlow version 'ofp_version'. */
5321 ofputil_encode_table_features_request(enum ofp_version ofp_version)
5323 struct ofpbuf *request = NULL;
5325 switch (ofp_version) {
5329 ovs_fatal(0, "dump-table-features needs OpenFlow 1.3 or later "
5330 "(\'-O OpenFlow13\')");
5334 request = ofpraw_alloc(OFPRAW_OFPST13_TABLE_FEATURES_REQUEST,
5345 put_fields_property(struct ofpbuf *reply,
5346 const struct mf_bitmap *fields,
5347 const struct mf_bitmap *masks,
5348 enum ofp13_table_feature_prop_type property,
5349 enum ofp_version version)
5354 start_ofs = ofpprop_start(reply, property);
5355 BITMAP_FOR_EACH_1 (field, MFF_N_IDS, fields->bm) {
5356 nx_put_header(reply, field, version,
5357 masks && bitmap_is_set(masks->bm, field));
5359 ofpprop_end(reply, start_ofs);
5363 put_table_action_features(struct ofpbuf *reply,
5364 const struct ofputil_table_action_features *taf,
5365 enum ofp13_table_feature_prop_type actions_type,
5366 enum ofp13_table_feature_prop_type set_fields_type,
5367 int miss_offset, enum ofp_version version)
5369 ofpprop_put_bitmap(reply, actions_type + miss_offset,
5370 ntohl(ofpact_bitmap_to_openflow(taf->ofpacts,
5372 put_fields_property(reply, &taf->set_fields, NULL,
5373 set_fields_type + miss_offset, version);
5377 put_table_instruction_features(
5378 struct ofpbuf *reply, const struct ofputil_table_instruction_features *tif,
5379 int miss_offset, enum ofp_version version)
5384 ofpprop_put_bitmap(reply, OFPTFPT13_INSTRUCTIONS + miss_offset,
5385 ntohl(ovsinst_bitmap_to_openflow(tif->instructions,
5388 start_ofs = ofpprop_start(reply, OFPTFPT13_NEXT_TABLES + miss_offset);
5389 BITMAP_FOR_EACH_1 (table_id, 255, tif->next) {
5390 ofpbuf_put(reply, &table_id, 1);
5392 ofpprop_end(reply, start_ofs);
5394 put_table_action_features(reply, &tif->write,
5395 OFPTFPT13_WRITE_ACTIONS,
5396 OFPTFPT13_WRITE_SETFIELD, miss_offset, version);
5397 put_table_action_features(reply, &tif->apply,
5398 OFPTFPT13_APPLY_ACTIONS,
5399 OFPTFPT13_APPLY_SETFIELD, miss_offset, version);
5403 ofputil_append_table_features_reply(const struct ofputil_table_features *tf,
5404 struct ovs_list *replies)
5406 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
5407 enum ofp_version version = ofpmp_version(replies);
5408 size_t start_ofs = reply->size;
5409 struct ofp13_table_features *otf;
5411 otf = ofpbuf_put_zeros(reply, sizeof *otf);
5412 otf->table_id = tf->table_id;
5413 ovs_strlcpy(otf->name, tf->name, sizeof otf->name);
5414 otf->metadata_match = tf->metadata_match;
5415 otf->metadata_write = tf->metadata_write;
5416 if (version >= OFP14_VERSION) {
5417 if (tf->supports_eviction) {
5418 otf->capabilities |= htonl(OFPTC14_EVICTION);
5420 if (tf->supports_vacancy_events) {
5421 otf->capabilities |= htonl(OFPTC14_VACANCY_EVENTS);
5424 otf->max_entries = htonl(tf->max_entries);
5426 put_table_instruction_features(reply, &tf->nonmiss, 0, version);
5427 put_table_instruction_features(reply, &tf->miss, 1, version);
5429 put_fields_property(reply, &tf->match, &tf->mask,
5430 OFPTFPT13_MATCH, version);
5431 put_fields_property(reply, &tf->wildcard, NULL,
5432 OFPTFPT13_WILDCARDS, version);
5434 otf = ofpbuf_at_assert(reply, start_ofs, sizeof *otf);
5435 otf->length = htons(reply->size - start_ofs);
5436 ofpmp_postappend(replies, start_ofs);
5440 parse_table_desc_vacancy_property(struct ofpbuf *property,
5441 struct ofputil_table_desc *td)
5443 struct ofp14_table_mod_prop_vacancy *otv = property->data;
5445 if (property->size != sizeof *otv) {
5446 return OFPERR_OFPBPC_BAD_LEN;
5449 td->table_vacancy.vacancy_down = otv->vacancy_down;
5450 td->table_vacancy.vacancy_up = otv->vacancy_up;
5451 td->table_vacancy.vacancy = otv->vacancy;
5455 /* Decodes the next OpenFlow "table desc" message (of possibly several) from
5456 * 'msg' into an abstract form in '*td'. Returns 0 if successful, EOF if the
5457 * last "table desc" in 'msg' was already decoded, otherwise an OFPERR_*
5460 ofputil_decode_table_desc(struct ofpbuf *msg,
5461 struct ofputil_table_desc *td,
5462 enum ofp_version version)
5464 memset(td, 0, sizeof *td);
5467 ofpraw_pull_assert(msg);
5474 struct ofp14_table_desc *otd = ofpbuf_try_pull(msg, sizeof *otd);
5476 VLOG_WARN_RL(&bad_ofmsg_rl, "OFP14_TABLE_DESC reply has %"PRIu32" "
5477 "leftover bytes at end", msg->size);
5478 return OFPERR_OFPBRC_BAD_LEN;
5481 td->table_id = otd->table_id;
5482 size_t length = ntohs(otd->length);
5483 if (length < sizeof *otd || length - sizeof *otd > msg->size) {
5484 VLOG_WARN_RL(&bad_ofmsg_rl, "OFP14_TABLE_DESC reply claims invalid "
5485 "length %"PRIuSIZE, length);
5486 return OFPERR_OFPBRC_BAD_LEN;
5488 length -= sizeof *otd;
5490 td->eviction = ofputil_decode_table_eviction(otd->config, version);
5491 td->vacancy = ofputil_decode_table_vacancy(otd->config, version);
5492 td->eviction_flags = UINT32_MAX;
5494 struct ofpbuf properties = ofpbuf_const_initializer(
5495 ofpbuf_pull(msg, length), length);
5496 while (properties.size > 0) {
5497 struct ofpbuf payload;
5501 error = ofpprop_pull(&properties, &payload, &type);
5507 case OFPTMPT14_EVICTION:
5508 error = ofpprop_parse_u32(&payload, &td->eviction_flags);
5511 case OFPTMPT14_VACANCY:
5512 error = parse_table_desc_vacancy_property(&payload, td);
5516 error = OFPPROP_UNKNOWN(true, "table_desc", type);
5528 /* Encodes and returns a request to obtain description of tables of a switch.
5529 * The message is encoded for OpenFlow version 'ofp_version'. */
5531 ofputil_encode_table_desc_request(enum ofp_version ofp_version)
5533 struct ofpbuf *request = NULL;
5535 if (ofp_version >= OFP14_VERSION) {
5536 request = ofpraw_alloc(OFPRAW_OFPST14_TABLE_DESC_REQUEST,
5539 ovs_fatal(0, "dump-table-desc needs OpenFlow 1.4 or later "
5540 "(\'-O OpenFlow14\')");
5546 /* Function to append Table desc information in a reply list. */
5548 ofputil_append_table_desc_reply(const struct ofputil_table_desc *td,
5549 struct ovs_list *replies,
5550 enum ofp_version version)
5552 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
5554 struct ofp14_table_desc *otd;
5556 start_otd = reply->size;
5557 ofpbuf_put_zeros(reply, sizeof *otd);
5558 if (td->eviction_flags != UINT32_MAX) {
5559 ofpprop_put_u32(reply, OFPTMPT14_EVICTION, td->eviction_flags);
5561 if (td->vacancy == OFPUTIL_TABLE_VACANCY_ON) {
5562 struct ofp14_table_mod_prop_vacancy *otv;
5564 otv = ofpprop_put_zeros(reply, OFPTMPT14_VACANCY, sizeof *otv);
5565 otv->vacancy_down = td->table_vacancy.vacancy_down;
5566 otv->vacancy_up = td->table_vacancy.vacancy_up;
5567 otv->vacancy = td->table_vacancy.vacancy;
5570 otd = ofpbuf_at_assert(reply, start_otd, sizeof *otd);
5571 otd->length = htons(reply->size - start_otd);
5572 otd->table_id = td->table_id;
5573 otd->config = ofputil_encode_table_config(OFPUTIL_TABLE_MISS_DEFAULT,
5574 td->eviction, td->vacancy,
5576 ofpmp_postappend(replies, start_otd);
5579 /* This function parses Vacancy property, and decodes the
5580 * ofp14_table_mod_prop_vacancy in ofputil_table_mod.
5581 * Returns OFPERR_OFPBPC_BAD_VALUE error code when vacancy_down is
5582 * greater than vacancy_up and also when current vacancy has non-zero
5583 * value. Returns 0 on success. */
5585 parse_table_mod_vacancy_property(struct ofpbuf *property,
5586 struct ofputil_table_mod *tm)
5588 struct ofp14_table_mod_prop_vacancy *otv = property->data;
5590 if (property->size != sizeof *otv) {
5591 return OFPERR_OFPBPC_BAD_LEN;
5593 tm->table_vacancy.vacancy_down = otv->vacancy_down;
5594 tm->table_vacancy.vacancy_up = otv->vacancy_up;
5595 if (tm->table_vacancy.vacancy_down > tm->table_vacancy.vacancy_up) {
5596 OFPPROP_LOG(&bad_ofmsg_rl, false,
5597 "Value of vacancy_down is greater than vacancy_up");
5598 return OFPERR_OFPBPC_BAD_VALUE;
5600 if (tm->table_vacancy.vacancy_down > 100 ||
5601 tm->table_vacancy.vacancy_up > 100) {
5602 OFPPROP_LOG(&bad_ofmsg_rl, false, "Vacancy threshold percentage "
5603 "should not be greater than 100");
5604 return OFPERR_OFPBPC_BAD_VALUE;
5606 tm->table_vacancy.vacancy = otv->vacancy;
5607 if (tm->table_vacancy.vacancy) {
5608 OFPPROP_LOG(&bad_ofmsg_rl, false,
5609 "Vacancy value should be zero for table-mod messages");
5610 return OFPERR_OFPBPC_BAD_VALUE;
5615 /* Given 'config', taken from an OpenFlow 'version' message that specifies
5616 * table configuration (a table mod, table stats, or table features message),
5617 * returns the table vacancy configuration that it specifies.
5619 * Only OpenFlow 1.4 and later specify table vacancy configuration this way,
5620 * so for other 'version' this function always returns
5621 * OFPUTIL_TABLE_VACANCY_DEFAULT. */
5622 static enum ofputil_table_vacancy
5623 ofputil_decode_table_vacancy(ovs_be32 config, enum ofp_version version)
5625 return (version < OFP14_VERSION ? OFPUTIL_TABLE_VACANCY_DEFAULT
5626 : config & htonl(OFPTC14_VACANCY_EVENTS) ? OFPUTIL_TABLE_VACANCY_ON
5627 : OFPUTIL_TABLE_VACANCY_OFF);
5630 /* Given 'config', taken from an OpenFlow 'version' message that specifies
5631 * table configuration (a table mod, table stats, or table features message),
5632 * returns the table eviction configuration that it specifies.
5634 * Only OpenFlow 1.4 and later specify table eviction configuration this way,
5635 * so for other 'version' values this function always returns
5636 * OFPUTIL_TABLE_EVICTION_DEFAULT. */
5637 static enum ofputil_table_eviction
5638 ofputil_decode_table_eviction(ovs_be32 config, enum ofp_version version)
5640 return (version < OFP14_VERSION ? OFPUTIL_TABLE_EVICTION_DEFAULT
5641 : config & htonl(OFPTC14_EVICTION) ? OFPUTIL_TABLE_EVICTION_ON
5642 : OFPUTIL_TABLE_EVICTION_OFF);
5645 /* Returns a bitmap of OFPTC* values suitable for 'config' fields in various
5646 * OpenFlow messages of the given 'version', based on the provided 'miss' and
5647 * 'eviction' values. */
5649 ofputil_encode_table_config(enum ofputil_table_miss miss,
5650 enum ofputil_table_eviction eviction,
5651 enum ofputil_table_vacancy vacancy,
5652 enum ofp_version version)
5654 uint32_t config = 0;
5655 /* See the section "OFPTC_* Table Configuration" in DESIGN.md for more
5656 * information on the crazy evolution of this field. */
5659 /* OpenFlow 1.0 didn't have such a field, any value ought to do. */
5664 /* OpenFlow 1.1 and 1.2 define only OFPTC11_TABLE_MISS_*. */
5666 case OFPUTIL_TABLE_MISS_DEFAULT:
5667 /* Really this shouldn't be used for encoding (the caller should
5668 * provide a specific value) but I can't imagine that defaulting to
5669 * the fall-through case here will hurt. */
5670 case OFPUTIL_TABLE_MISS_CONTROLLER:
5672 return htonl(OFPTC11_TABLE_MISS_CONTROLLER);
5673 case OFPUTIL_TABLE_MISS_CONTINUE:
5674 return htonl(OFPTC11_TABLE_MISS_CONTINUE);
5675 case OFPUTIL_TABLE_MISS_DROP:
5676 return htonl(OFPTC11_TABLE_MISS_DROP);
5681 /* OpenFlow 1.3 removed OFPTC11_TABLE_MISS_* and didn't define any new
5682 * flags, so this is correct. */
5687 /* OpenFlow 1.4 introduced OFPTC14_EVICTION and
5688 * OFPTC14_VACANCY_EVENTS. */
5689 if (eviction == OFPUTIL_TABLE_EVICTION_ON) {
5690 config |= OFPTC14_EVICTION;
5692 if (vacancy == OFPUTIL_TABLE_VACANCY_ON) {
5693 config |= OFPTC14_VACANCY_EVENTS;
5695 return htonl(config);
5701 /* Given 'config', taken from an OpenFlow 'version' message that specifies
5702 * table configuration (a table mod, table stats, or table features message),
5703 * returns the table miss configuration that it specifies.
5705 * Only OpenFlow 1.1 and 1.2 specify table miss configurations this way, so for
5706 * other 'version' values this function always returns
5707 * OFPUTIL_TABLE_MISS_DEFAULT. */
5708 static enum ofputil_table_miss
5709 ofputil_decode_table_miss(ovs_be32 config_, enum ofp_version version)
5711 uint32_t config = ntohl(config_);
5713 if (version == OFP11_VERSION || version == OFP12_VERSION) {
5714 switch (config & OFPTC11_TABLE_MISS_MASK) {
5715 case OFPTC11_TABLE_MISS_CONTROLLER:
5716 return OFPUTIL_TABLE_MISS_CONTROLLER;
5718 case OFPTC11_TABLE_MISS_CONTINUE:
5719 return OFPUTIL_TABLE_MISS_CONTINUE;
5721 case OFPTC11_TABLE_MISS_DROP:
5722 return OFPUTIL_TABLE_MISS_DROP;
5725 VLOG_WARN_RL(&bad_ofmsg_rl, "bad table miss config %d", config);
5726 return OFPUTIL_TABLE_MISS_CONTROLLER;
5729 return OFPUTIL_TABLE_MISS_DEFAULT;
5733 /* Decodes the OpenFlow "table mod" message in '*oh' into an abstract form in
5734 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
5736 ofputil_decode_table_mod(const struct ofp_header *oh,
5737 struct ofputil_table_mod *pm)
5739 memset(pm, 0, sizeof *pm);
5740 pm->miss = OFPUTIL_TABLE_MISS_DEFAULT;
5741 pm->eviction = OFPUTIL_TABLE_EVICTION_DEFAULT;
5742 pm->eviction_flags = UINT32_MAX;
5743 pm->vacancy = OFPUTIL_TABLE_VACANCY_DEFAULT;
5745 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
5746 enum ofpraw raw = ofpraw_pull_assert(&b);
5747 if (raw == OFPRAW_OFPT11_TABLE_MOD) {
5748 const struct ofp11_table_mod *otm = b.data;
5750 pm->table_id = otm->table_id;
5751 pm->miss = ofputil_decode_table_miss(otm->config, oh->version);
5752 } else if (raw == OFPRAW_OFPT14_TABLE_MOD) {
5753 const struct ofp14_table_mod *otm = ofpbuf_pull(&b, sizeof *otm);
5755 pm->table_id = otm->table_id;
5756 pm->miss = ofputil_decode_table_miss(otm->config, oh->version);
5757 pm->eviction = ofputil_decode_table_eviction(otm->config, oh->version);
5758 pm->vacancy = ofputil_decode_table_vacancy(otm->config, oh->version);
5759 while (b.size > 0) {
5760 struct ofpbuf property;
5764 error = ofpprop_pull(&b, &property, &type);
5770 case OFPTMPT14_EVICTION:
5771 error = ofpprop_parse_u32(&property, &pm->eviction);
5774 case OFPTMPT14_VACANCY:
5775 error = parse_table_mod_vacancy_property(&property, pm);
5779 error = OFPERR_OFPBRC_BAD_TYPE;
5788 return OFPERR_OFPBRC_BAD_TYPE;
5794 /* Converts the abstract form of a "table mod" message in '*tm' into an
5795 * OpenFlow message suitable for 'protocol', and returns that encoded form in a
5796 * buffer owned by the caller. */
5798 ofputil_encode_table_mod(const struct ofputil_table_mod *tm,
5799 enum ofputil_protocol protocol)
5801 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
5804 switch (ofp_version) {
5805 case OFP10_VERSION: {
5806 ovs_fatal(0, "table mod needs OpenFlow 1.1 or later "
5807 "(\'-O OpenFlow11\')");
5812 case OFP13_VERSION: {
5813 struct ofp11_table_mod *otm;
5815 b = ofpraw_alloc(OFPRAW_OFPT11_TABLE_MOD, ofp_version, 0);
5816 otm = ofpbuf_put_zeros(b, sizeof *otm);
5817 otm->table_id = tm->table_id;
5818 otm->config = ofputil_encode_table_config(tm->miss, tm->eviction,
5819 tm->vacancy, ofp_version);
5823 case OFP15_VERSION: {
5824 struct ofp14_table_mod *otm;
5826 b = ofpraw_alloc(OFPRAW_OFPT14_TABLE_MOD, ofp_version, 0);
5827 otm = ofpbuf_put_zeros(b, sizeof *otm);
5828 otm->table_id = tm->table_id;
5829 otm->config = ofputil_encode_table_config(tm->miss, tm->eviction,
5830 tm->vacancy, ofp_version);
5832 if (tm->eviction_flags != UINT32_MAX) {
5833 ofpprop_put_u32(b, OFPTMPT14_EVICTION, tm->eviction_flags);
5835 if (tm->vacancy == OFPUTIL_TABLE_VACANCY_ON) {
5836 struct ofp14_table_mod_prop_vacancy *otv;
5838 otv = ofpprop_put_zeros(b, OFPTMPT14_VACANCY, sizeof *otv);
5839 otv->vacancy_down = tm->table_vacancy.vacancy_down;
5840 otv->vacancy_up = tm->table_vacancy.vacancy_up;
5851 /* ofputil_role_request */
5853 /* Decodes the OpenFlow "role request" or "role reply" message in '*oh' into
5854 * an abstract form in '*rr'. Returns 0 if successful, otherwise an
5855 * OFPERR_* value. */
5857 ofputil_decode_role_message(const struct ofp_header *oh,
5858 struct ofputil_role_request *rr)
5860 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
5861 enum ofpraw raw = ofpraw_pull_assert(&b);
5862 if (raw == OFPRAW_OFPT12_ROLE_REQUEST ||
5863 raw == OFPRAW_OFPT12_ROLE_REPLY) {
5864 const struct ofp12_role_request *orr = b.msg;
5866 if (orr->role != htonl(OFPCR12_ROLE_NOCHANGE) &&
5867 orr->role != htonl(OFPCR12_ROLE_EQUAL) &&
5868 orr->role != htonl(OFPCR12_ROLE_MASTER) &&
5869 orr->role != htonl(OFPCR12_ROLE_SLAVE)) {
5870 return OFPERR_OFPRRFC_BAD_ROLE;
5873 rr->role = ntohl(orr->role);
5874 if (raw == OFPRAW_OFPT12_ROLE_REQUEST
5875 ? orr->role == htonl(OFPCR12_ROLE_NOCHANGE)
5876 : orr->generation_id == OVS_BE64_MAX) {
5877 rr->have_generation_id = false;
5878 rr->generation_id = 0;
5880 rr->have_generation_id = true;
5881 rr->generation_id = ntohll(orr->generation_id);
5883 } else if (raw == OFPRAW_NXT_ROLE_REQUEST ||
5884 raw == OFPRAW_NXT_ROLE_REPLY) {
5885 const struct nx_role_request *nrr = b.msg;
5887 BUILD_ASSERT(NX_ROLE_OTHER + 1 == OFPCR12_ROLE_EQUAL);
5888 BUILD_ASSERT(NX_ROLE_MASTER + 1 == OFPCR12_ROLE_MASTER);
5889 BUILD_ASSERT(NX_ROLE_SLAVE + 1 == OFPCR12_ROLE_SLAVE);
5891 if (nrr->role != htonl(NX_ROLE_OTHER) &&
5892 nrr->role != htonl(NX_ROLE_MASTER) &&
5893 nrr->role != htonl(NX_ROLE_SLAVE)) {
5894 return OFPERR_OFPRRFC_BAD_ROLE;
5897 rr->role = ntohl(nrr->role) + 1;
5898 rr->have_generation_id = false;
5899 rr->generation_id = 0;
5907 /* Returns an encoded form of a role reply suitable for the "request" in a
5908 * buffer owned by the caller. */
5910 ofputil_encode_role_reply(const struct ofp_header *request,
5911 const struct ofputil_role_request *rr)
5916 raw = ofpraw_decode_assert(request);
5917 if (raw == OFPRAW_OFPT12_ROLE_REQUEST) {
5918 struct ofp12_role_request *orr;
5920 buf = ofpraw_alloc_reply(OFPRAW_OFPT12_ROLE_REPLY, request, 0);
5921 orr = ofpbuf_put_zeros(buf, sizeof *orr);
5923 orr->role = htonl(rr->role);
5924 orr->generation_id = htonll(rr->have_generation_id
5927 } else if (raw == OFPRAW_NXT_ROLE_REQUEST) {
5928 struct nx_role_request *nrr;
5930 BUILD_ASSERT(NX_ROLE_OTHER == OFPCR12_ROLE_EQUAL - 1);
5931 BUILD_ASSERT(NX_ROLE_MASTER == OFPCR12_ROLE_MASTER - 1);
5932 BUILD_ASSERT(NX_ROLE_SLAVE == OFPCR12_ROLE_SLAVE - 1);
5934 buf = ofpraw_alloc_reply(OFPRAW_NXT_ROLE_REPLY, request, 0);
5935 nrr = ofpbuf_put_zeros(buf, sizeof *nrr);
5936 nrr->role = htonl(rr->role - 1);
5944 /* Encodes "role status" message 'status' for sending in the given
5945 * 'protocol'. Returns the role status message, if 'protocol' supports them,
5946 * otherwise a null pointer. */
5948 ofputil_encode_role_status(const struct ofputil_role_status *status,
5949 enum ofputil_protocol protocol)
5951 enum ofp_version version;
5953 version = ofputil_protocol_to_ofp_version(protocol);
5954 if (version >= OFP14_VERSION) {
5955 struct ofp14_role_status *rstatus;
5958 buf = ofpraw_alloc_xid(OFPRAW_OFPT14_ROLE_STATUS, version, htonl(0),
5960 rstatus = ofpbuf_put_zeros(buf, sizeof *rstatus);
5961 rstatus->role = htonl(status->role);
5962 rstatus->reason = status->reason;
5963 rstatus->generation_id = htonll(status->generation_id);
5972 ofputil_decode_role_status(const struct ofp_header *oh,
5973 struct ofputil_role_status *rs)
5975 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
5976 enum ofpraw raw = ofpraw_pull_assert(&b);
5977 ovs_assert(raw == OFPRAW_OFPT14_ROLE_STATUS);
5979 const struct ofp14_role_status *r = b.msg;
5980 if (r->role != htonl(OFPCR12_ROLE_NOCHANGE) &&
5981 r->role != htonl(OFPCR12_ROLE_EQUAL) &&
5982 r->role != htonl(OFPCR12_ROLE_MASTER) &&
5983 r->role != htonl(OFPCR12_ROLE_SLAVE)) {
5984 return OFPERR_OFPRRFC_BAD_ROLE;
5987 rs->role = ntohl(r->role);
5988 rs->generation_id = ntohll(r->generation_id);
5989 rs->reason = r->reason;
5994 /* Encodes 'rf' according to 'protocol', and returns the encoded message.
5995 * 'protocol' must be for OpenFlow 1.4 or later. */
5997 ofputil_encode_requestforward(const struct ofputil_requestforward *rf,
5998 enum ofputil_protocol protocol)
6000 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
6001 struct ofpbuf *inner;
6003 switch (rf->reason) {
6004 case OFPRFR_GROUP_MOD:
6005 inner = ofputil_encode_group_mod(ofp_version, rf->group_mod);
6008 case OFPRFR_METER_MOD:
6009 inner = ofputil_encode_meter_mod(ofp_version, rf->meter_mod);
6012 case OFPRFR_N_REASONS:
6017 struct ofp_header *inner_oh = inner->data;
6018 inner_oh->xid = rf->xid;
6019 inner_oh->length = htons(inner->size);
6021 struct ofpbuf *outer = ofpraw_alloc_xid(OFPRAW_OFPT14_REQUESTFORWARD,
6022 ofp_version, htonl(0),
6024 ofpbuf_put(outer, inner->data, inner->size);
6025 ofpbuf_delete(inner);
6030 /* Decodes OFPT_REQUESTFORWARD message 'outer'. On success, puts the decoded
6031 * form into '*rf' and returns 0, and the caller is later responsible for
6032 * freeing the content of 'rf', with ofputil_destroy_requestforward(rf). On
6033 * failure, returns an ofperr and '*rf' is indeterminate. */
6035 ofputil_decode_requestforward(const struct ofp_header *outer,
6036 struct ofputil_requestforward *rf)
6038 struct ofpbuf b = ofpbuf_const_initializer(outer, ntohs(outer->length));
6040 /* Skip past outer message. */
6041 enum ofpraw outer_raw = ofpraw_pull_assert(&b);
6042 ovs_assert(outer_raw == OFPRAW_OFPT14_REQUESTFORWARD);
6044 /* Validate inner message. */
6045 if (b.size < sizeof(struct ofp_header)) {
6046 return OFPERR_OFPBFC_MSG_BAD_LEN;
6048 const struct ofp_header *inner = b.data;
6049 unsigned int inner_len = ntohs(inner->length);
6050 if (inner_len < sizeof(struct ofp_header) || inner_len > b.size) {
6051 return OFPERR_OFPBFC_MSG_BAD_LEN;
6053 if (inner->version != outer->version) {
6054 return OFPERR_OFPBRC_BAD_VERSION;
6057 /* Parse inner message. */
6059 enum ofperr error = ofptype_decode(&type, inner);
6064 rf->xid = inner->xid;
6065 if (type == OFPTYPE_GROUP_MOD) {
6066 rf->reason = OFPRFR_GROUP_MOD;
6067 rf->group_mod = xmalloc(sizeof *rf->group_mod);
6068 error = ofputil_decode_group_mod(inner, rf->group_mod);
6070 free(rf->group_mod);
6073 } else if (type == OFPTYPE_METER_MOD) {
6074 rf->reason = OFPRFR_METER_MOD;
6075 rf->meter_mod = xmalloc(sizeof *rf->meter_mod);
6076 ofpbuf_init(&rf->bands, 64);
6077 error = ofputil_decode_meter_mod(inner, rf->meter_mod, &rf->bands);
6079 free(rf->meter_mod);
6080 ofpbuf_uninit(&rf->bands);
6084 return OFPERR_OFPBFC_MSG_UNSUP;
6090 /* Frees the content of 'rf', which should have been initialized through a
6091 * successful call to ofputil_decode_requestforward(). */
6093 ofputil_destroy_requestforward(struct ofputil_requestforward *rf)
6099 switch (rf->reason) {
6100 case OFPRFR_GROUP_MOD:
6101 ofputil_uninit_group_mod(rf->group_mod);
6102 free(rf->group_mod);
6105 case OFPRFR_METER_MOD:
6106 ofpbuf_uninit(&rf->bands);
6107 free(rf->meter_mod);
6110 case OFPRFR_N_REASONS:
6117 /* OpenFlow 1.0 and 1.1 don't distinguish between a field that cannot be
6118 * matched and a field that must be wildcarded. This function returns a bitmap
6119 * that contains both kinds of fields. */
6120 static struct mf_bitmap
6121 wild_or_nonmatchable_fields(const struct ofputil_table_features *features)
6123 struct mf_bitmap wc = features->match;
6124 bitmap_not(wc.bm, MFF_N_IDS);
6125 bitmap_or(wc.bm, features->wildcard.bm, MFF_N_IDS);
6129 struct ofp10_wc_map {
6130 enum ofp10_flow_wildcards wc10;
6131 enum mf_field_id mf;
6134 static const struct ofp10_wc_map ofp10_wc_map[] = {
6135 { OFPFW10_IN_PORT, MFF_IN_PORT },
6136 { OFPFW10_DL_VLAN, MFF_VLAN_VID },
6137 { OFPFW10_DL_SRC, MFF_ETH_SRC },
6138 { OFPFW10_DL_DST, MFF_ETH_DST},
6139 { OFPFW10_DL_TYPE, MFF_ETH_TYPE },
6140 { OFPFW10_NW_PROTO, MFF_IP_PROTO },
6141 { OFPFW10_TP_SRC, MFF_TCP_SRC },
6142 { OFPFW10_TP_DST, MFF_TCP_DST },
6143 { OFPFW10_NW_SRC_MASK, MFF_IPV4_SRC },
6144 { OFPFW10_NW_DST_MASK, MFF_IPV4_DST },
6145 { OFPFW10_DL_VLAN_PCP, MFF_VLAN_PCP },
6146 { OFPFW10_NW_TOS, MFF_IP_DSCP },
6150 mf_bitmap_to_of10(const struct mf_bitmap *fields)
6152 const struct ofp10_wc_map *p;
6155 for (p = ofp10_wc_map; p < &ofp10_wc_map[ARRAY_SIZE(ofp10_wc_map)]; p++) {
6156 if (bitmap_is_set(fields->bm, p->mf)) {
6163 static struct mf_bitmap
6164 mf_bitmap_from_of10(ovs_be32 wc10_)
6166 struct mf_bitmap fields = MF_BITMAP_INITIALIZER;
6167 const struct ofp10_wc_map *p;
6168 uint32_t wc10 = ntohl(wc10_);
6170 for (p = ofp10_wc_map; p < &ofp10_wc_map[ARRAY_SIZE(ofp10_wc_map)]; p++) {
6171 if (wc10 & p->wc10) {
6172 bitmap_set1(fields.bm, p->mf);
6179 ofputil_put_ofp10_table_stats(const struct ofputil_table_stats *stats,
6180 const struct ofputil_table_features *features,
6183 struct mf_bitmap wc = wild_or_nonmatchable_fields(features);
6184 struct ofp10_table_stats *out;
6186 out = ofpbuf_put_zeros(buf, sizeof *out);
6187 out->table_id = features->table_id;
6188 ovs_strlcpy(out->name, features->name, sizeof out->name);
6189 out->wildcards = mf_bitmap_to_of10(&wc);
6190 out->max_entries = htonl(features->max_entries);
6191 out->active_count = htonl(stats->active_count);
6192 put_32aligned_be64(&out->lookup_count, htonll(stats->lookup_count));
6193 put_32aligned_be64(&out->matched_count, htonll(stats->matched_count));
6196 struct ofp11_wc_map {
6197 enum ofp11_flow_match_fields wc11;
6198 enum mf_field_id mf;
6201 static const struct ofp11_wc_map ofp11_wc_map[] = {
6202 { OFPFMF11_IN_PORT, MFF_IN_PORT },
6203 { OFPFMF11_DL_VLAN, MFF_VLAN_VID },
6204 { OFPFMF11_DL_VLAN_PCP, MFF_VLAN_PCP },
6205 { OFPFMF11_DL_TYPE, MFF_ETH_TYPE },
6206 { OFPFMF11_NW_TOS, MFF_IP_DSCP },
6207 { OFPFMF11_NW_PROTO, MFF_IP_PROTO },
6208 { OFPFMF11_TP_SRC, MFF_TCP_SRC },
6209 { OFPFMF11_TP_DST, MFF_TCP_DST },
6210 { OFPFMF11_MPLS_LABEL, MFF_MPLS_LABEL },
6211 { OFPFMF11_MPLS_TC, MFF_MPLS_TC },
6212 /* I don't know what OFPFMF11_TYPE means. */
6213 { OFPFMF11_DL_SRC, MFF_ETH_SRC },
6214 { OFPFMF11_DL_DST, MFF_ETH_DST },
6215 { OFPFMF11_NW_SRC, MFF_IPV4_SRC },
6216 { OFPFMF11_NW_DST, MFF_IPV4_DST },
6217 { OFPFMF11_METADATA, MFF_METADATA },
6221 mf_bitmap_to_of11(const struct mf_bitmap *fields)
6223 const struct ofp11_wc_map *p;
6226 for (p = ofp11_wc_map; p < &ofp11_wc_map[ARRAY_SIZE(ofp11_wc_map)]; p++) {
6227 if (bitmap_is_set(fields->bm, p->mf)) {
6234 static struct mf_bitmap
6235 mf_bitmap_from_of11(ovs_be32 wc11_)
6237 struct mf_bitmap fields = MF_BITMAP_INITIALIZER;
6238 const struct ofp11_wc_map *p;
6239 uint32_t wc11 = ntohl(wc11_);
6241 for (p = ofp11_wc_map; p < &ofp11_wc_map[ARRAY_SIZE(ofp11_wc_map)]; p++) {
6242 if (wc11 & p->wc11) {
6243 bitmap_set1(fields.bm, p->mf);
6250 ofputil_put_ofp11_table_stats(const struct ofputil_table_stats *stats,
6251 const struct ofputil_table_features *features,
6254 struct mf_bitmap wc = wild_or_nonmatchable_fields(features);
6255 struct ofp11_table_stats *out;
6257 out = ofpbuf_put_zeros(buf, sizeof *out);
6258 out->table_id = features->table_id;
6259 ovs_strlcpy(out->name, features->name, sizeof out->name);
6260 out->wildcards = mf_bitmap_to_of11(&wc);
6261 out->match = mf_bitmap_to_of11(&features->match);
6262 out->instructions = ovsinst_bitmap_to_openflow(
6263 features->nonmiss.instructions, OFP11_VERSION);
6264 out->write_actions = ofpact_bitmap_to_openflow(
6265 features->nonmiss.write.ofpacts, OFP11_VERSION);
6266 out->apply_actions = ofpact_bitmap_to_openflow(
6267 features->nonmiss.apply.ofpacts, OFP11_VERSION);
6268 out->config = htonl(features->miss_config);
6269 out->max_entries = htonl(features->max_entries);
6270 out->active_count = htonl(stats->active_count);
6271 out->lookup_count = htonll(stats->lookup_count);
6272 out->matched_count = htonll(stats->matched_count);
6276 ofputil_put_ofp12_table_stats(const struct ofputil_table_stats *stats,
6277 const struct ofputil_table_features *features,
6280 struct ofp12_table_stats *out;
6282 out = ofpbuf_put_zeros(buf, sizeof *out);
6283 out->table_id = features->table_id;
6284 ovs_strlcpy(out->name, features->name, sizeof out->name);
6285 out->match = oxm_bitmap_from_mf_bitmap(&features->match, OFP12_VERSION);
6286 out->wildcards = oxm_bitmap_from_mf_bitmap(&features->wildcard,
6288 out->write_actions = ofpact_bitmap_to_openflow(
6289 features->nonmiss.write.ofpacts, OFP12_VERSION);
6290 out->apply_actions = ofpact_bitmap_to_openflow(
6291 features->nonmiss.apply.ofpacts, OFP12_VERSION);
6292 out->write_setfields = oxm_bitmap_from_mf_bitmap(
6293 &features->nonmiss.write.set_fields, OFP12_VERSION);
6294 out->apply_setfields = oxm_bitmap_from_mf_bitmap(
6295 &features->nonmiss.apply.set_fields, OFP12_VERSION);
6296 out->metadata_match = features->metadata_match;
6297 out->metadata_write = features->metadata_write;
6298 out->instructions = ovsinst_bitmap_to_openflow(
6299 features->nonmiss.instructions, OFP12_VERSION);
6300 out->config = ofputil_encode_table_config(features->miss_config,
6301 OFPUTIL_TABLE_EVICTION_DEFAULT,
6302 OFPUTIL_TABLE_VACANCY_DEFAULT,
6304 out->max_entries = htonl(features->max_entries);
6305 out->active_count = htonl(stats->active_count);
6306 out->lookup_count = htonll(stats->lookup_count);
6307 out->matched_count = htonll(stats->matched_count);
6311 ofputil_put_ofp13_table_stats(const struct ofputil_table_stats *stats,
6314 struct ofp13_table_stats *out;
6316 out = ofpbuf_put_zeros(buf, sizeof *out);
6317 out->table_id = stats->table_id;
6318 out->active_count = htonl(stats->active_count);
6319 out->lookup_count = htonll(stats->lookup_count);
6320 out->matched_count = htonll(stats->matched_count);
6324 ofputil_encode_table_stats_reply(const struct ofp_header *request)
6326 return ofpraw_alloc_stats_reply(request, 0);
6330 ofputil_append_table_stats_reply(struct ofpbuf *reply,
6331 const struct ofputil_table_stats *stats,
6332 const struct ofputil_table_features *features)
6334 struct ofp_header *oh = reply->header;
6336 ovs_assert(stats->table_id == features->table_id);
6338 switch ((enum ofp_version) oh->version) {
6340 ofputil_put_ofp10_table_stats(stats, features, reply);
6344 ofputil_put_ofp11_table_stats(stats, features, reply);
6348 ofputil_put_ofp12_table_stats(stats, features, reply);
6354 ofputil_put_ofp13_table_stats(stats, reply);
6363 ofputil_decode_ofp10_table_stats(struct ofpbuf *msg,
6364 struct ofputil_table_stats *stats,
6365 struct ofputil_table_features *features)
6367 struct ofp10_table_stats *ots;
6369 ots = ofpbuf_try_pull(msg, sizeof *ots);
6371 return OFPERR_OFPBRC_BAD_LEN;
6374 features->table_id = ots->table_id;
6375 ovs_strlcpy(features->name, ots->name, sizeof features->name);
6376 features->max_entries = ntohl(ots->max_entries);
6377 features->match = features->wildcard = mf_bitmap_from_of10(ots->wildcards);
6379 stats->table_id = ots->table_id;
6380 stats->active_count = ntohl(ots->active_count);
6381 stats->lookup_count = ntohll(get_32aligned_be64(&ots->lookup_count));
6382 stats->matched_count = ntohll(get_32aligned_be64(&ots->matched_count));
6388 ofputil_decode_ofp11_table_stats(struct ofpbuf *msg,
6389 struct ofputil_table_stats *stats,
6390 struct ofputil_table_features *features)
6392 struct ofp11_table_stats *ots;
6394 ots = ofpbuf_try_pull(msg, sizeof *ots);
6396 return OFPERR_OFPBRC_BAD_LEN;
6399 features->table_id = ots->table_id;
6400 ovs_strlcpy(features->name, ots->name, sizeof features->name);
6401 features->max_entries = ntohl(ots->max_entries);
6402 features->nonmiss.instructions = ovsinst_bitmap_from_openflow(
6403 ots->instructions, OFP11_VERSION);
6404 features->nonmiss.write.ofpacts = ofpact_bitmap_from_openflow(
6405 ots->write_actions, OFP11_VERSION);
6406 features->nonmiss.apply.ofpacts = ofpact_bitmap_from_openflow(
6407 ots->write_actions, OFP11_VERSION);
6408 features->miss = features->nonmiss;
6409 features->miss_config = ofputil_decode_table_miss(ots->config,
6411 features->match = mf_bitmap_from_of11(ots->match);
6412 features->wildcard = mf_bitmap_from_of11(ots->wildcards);
6413 bitmap_or(features->match.bm, features->wildcard.bm, MFF_N_IDS);
6415 stats->table_id = ots->table_id;
6416 stats->active_count = ntohl(ots->active_count);
6417 stats->lookup_count = ntohll(ots->lookup_count);
6418 stats->matched_count = ntohll(ots->matched_count);
6424 ofputil_decode_ofp12_table_stats(struct ofpbuf *msg,
6425 struct ofputil_table_stats *stats,
6426 struct ofputil_table_features *features)
6428 struct ofp12_table_stats *ots;
6430 ots = ofpbuf_try_pull(msg, sizeof *ots);
6432 return OFPERR_OFPBRC_BAD_LEN;
6435 features->table_id = ots->table_id;
6436 ovs_strlcpy(features->name, ots->name, sizeof features->name);
6437 features->metadata_match = ots->metadata_match;
6438 features->metadata_write = ots->metadata_write;
6439 features->miss_config = ofputil_decode_table_miss(ots->config,
6441 features->max_entries = ntohl(ots->max_entries);
6443 features->nonmiss.instructions = ovsinst_bitmap_from_openflow(
6444 ots->instructions, OFP12_VERSION);
6445 features->nonmiss.write.ofpacts = ofpact_bitmap_from_openflow(
6446 ots->write_actions, OFP12_VERSION);
6447 features->nonmiss.apply.ofpacts = ofpact_bitmap_from_openflow(
6448 ots->apply_actions, OFP12_VERSION);
6449 features->nonmiss.write.set_fields = oxm_bitmap_to_mf_bitmap(
6450 ots->write_setfields, OFP12_VERSION);
6451 features->nonmiss.apply.set_fields = oxm_bitmap_to_mf_bitmap(
6452 ots->apply_setfields, OFP12_VERSION);
6453 features->miss = features->nonmiss;
6455 features->match = oxm_bitmap_to_mf_bitmap(ots->match, OFP12_VERSION);
6456 features->wildcard = oxm_bitmap_to_mf_bitmap(ots->wildcards,
6458 bitmap_or(features->match.bm, features->wildcard.bm, MFF_N_IDS);
6460 stats->table_id = ots->table_id;
6461 stats->active_count = ntohl(ots->active_count);
6462 stats->lookup_count = ntohll(ots->lookup_count);
6463 stats->matched_count = ntohll(ots->matched_count);
6469 ofputil_decode_ofp13_table_stats(struct ofpbuf *msg,
6470 struct ofputil_table_stats *stats,
6471 struct ofputil_table_features *features)
6473 struct ofp13_table_stats *ots;
6475 ots = ofpbuf_try_pull(msg, sizeof *ots);
6477 return OFPERR_OFPBRC_BAD_LEN;
6480 features->table_id = ots->table_id;
6482 stats->table_id = ots->table_id;
6483 stats->active_count = ntohl(ots->active_count);
6484 stats->lookup_count = ntohll(ots->lookup_count);
6485 stats->matched_count = ntohll(ots->matched_count);
6491 ofputil_decode_table_stats_reply(struct ofpbuf *msg,
6492 struct ofputil_table_stats *stats,
6493 struct ofputil_table_features *features)
6495 const struct ofp_header *oh;
6498 ofpraw_pull_assert(msg);
6506 memset(stats, 0, sizeof *stats);
6507 memset(features, 0, sizeof *features);
6508 features->supports_eviction = -1;
6509 features->supports_vacancy_events = -1;
6511 switch ((enum ofp_version) oh->version) {
6513 return ofputil_decode_ofp10_table_stats(msg, stats, features);
6516 return ofputil_decode_ofp11_table_stats(msg, stats, features);
6519 return ofputil_decode_ofp12_table_stats(msg, stats, features);
6524 return ofputil_decode_ofp13_table_stats(msg, stats, features);
6531 /* ofputil_flow_monitor_request */
6533 /* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract
6534 * ofputil_flow_monitor_request in 'rq'.
6536 * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow
6537 * message. Calling this function multiple times for a single 'msg' iterates
6538 * through the requests. The caller must initially leave 'msg''s layer
6539 * pointers null and not modify them between calls.
6541 * Returns 0 if successful, EOF if no requests were left in this 'msg',
6542 * otherwise an OFPERR_* value. */
6544 ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *rq,
6547 struct nx_flow_monitor_request *nfmr;
6551 ofpraw_pull_assert(msg);
6558 nfmr = ofpbuf_try_pull(msg, sizeof *nfmr);
6560 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR request has %"PRIu32" "
6561 "leftover bytes at end", msg->size);
6562 return OFPERR_OFPBRC_BAD_LEN;
6565 flags = ntohs(nfmr->flags);
6566 if (!(flags & (NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY))
6567 || flags & ~(NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE
6568 | NXFMF_MODIFY | NXFMF_ACTIONS | NXFMF_OWN)) {
6569 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR has bad flags %#"PRIx16,
6571 return OFPERR_OFPMOFC_BAD_FLAGS;
6574 if (!is_all_zeros(nfmr->zeros, sizeof nfmr->zeros)) {
6575 return OFPERR_NXBRC_MUST_BE_ZERO;
6578 rq->id = ntohl(nfmr->id);
6580 rq->out_port = u16_to_ofp(ntohs(nfmr->out_port));
6581 rq->table_id = nfmr->table_id;
6583 return nx_pull_match(msg, ntohs(nfmr->match_len), &rq->match, NULL, NULL);
6587 ofputil_append_flow_monitor_request(
6588 const struct ofputil_flow_monitor_request *rq, struct ofpbuf *msg)
6590 struct nx_flow_monitor_request *nfmr;
6595 ofpraw_put(OFPRAW_NXST_FLOW_MONITOR_REQUEST, OFP10_VERSION, msg);
6598 start_ofs = msg->size;
6599 ofpbuf_put_zeros(msg, sizeof *nfmr);
6600 match_len = nx_put_match(msg, &rq->match, htonll(0), htonll(0));
6602 nfmr = ofpbuf_at_assert(msg, start_ofs, sizeof *nfmr);
6603 nfmr->id = htonl(rq->id);
6604 nfmr->flags = htons(rq->flags);
6605 nfmr->out_port = htons(ofp_to_u16(rq->out_port));
6606 nfmr->match_len = htons(match_len);
6607 nfmr->table_id = rq->table_id;
6610 /* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg'
6611 * into an abstract ofputil_flow_update in 'update'. The caller must have
6612 * initialized update->match to point to space allocated for a match.
6614 * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's
6615 * actions (except for NXFME_ABBREV, which never includes actions). The caller
6616 * must initialize 'ofpacts' and retains ownership of it. 'update->ofpacts'
6617 * will point into the 'ofpacts' buffer.
6619 * Multiple flow updates can be packed into a single OpenFlow message. Calling
6620 * this function multiple times for a single 'msg' iterates through the
6621 * updates. The caller must initially leave 'msg''s layer pointers null and
6622 * not modify them between calls.
6624 * Returns 0 if successful, EOF if no updates were left in this 'msg',
6625 * otherwise an OFPERR_* value. */
6627 ofputil_decode_flow_update(struct ofputil_flow_update *update,
6628 struct ofpbuf *msg, struct ofpbuf *ofpacts)
6630 struct nx_flow_update_header *nfuh;
6631 unsigned int length;
6632 struct ofp_header *oh;
6635 ofpraw_pull_assert(msg);
6638 ofpbuf_clear(ofpacts);
6643 if (msg->size < sizeof(struct nx_flow_update_header)) {
6650 update->event = ntohs(nfuh->event);
6651 length = ntohs(nfuh->length);
6652 if (length > msg->size || length % 8) {
6656 if (update->event == NXFME_ABBREV) {
6657 struct nx_flow_update_abbrev *nfua;
6659 if (length != sizeof *nfua) {
6663 nfua = ofpbuf_pull(msg, sizeof *nfua);
6664 update->xid = nfua->xid;
6666 } else if (update->event == NXFME_ADDED
6667 || update->event == NXFME_DELETED
6668 || update->event == NXFME_MODIFIED) {
6669 struct nx_flow_update_full *nfuf;
6670 unsigned int actions_len;
6671 unsigned int match_len;
6674 if (length < sizeof *nfuf) {
6678 nfuf = ofpbuf_pull(msg, sizeof *nfuf);
6679 match_len = ntohs(nfuf->match_len);
6680 if (sizeof *nfuf + match_len > length) {
6684 update->reason = ntohs(nfuf->reason);
6685 update->idle_timeout = ntohs(nfuf->idle_timeout);
6686 update->hard_timeout = ntohs(nfuf->hard_timeout);
6687 update->table_id = nfuf->table_id;
6688 update->cookie = nfuf->cookie;
6689 update->priority = ntohs(nfuf->priority);
6691 error = nx_pull_match(msg, match_len, update->match, NULL, NULL);
6696 actions_len = length - sizeof *nfuf - ROUND_UP(match_len, 8);
6697 error = ofpacts_pull_openflow_actions(msg, actions_len, oh->version,
6703 update->ofpacts = ofpacts->data;
6704 update->ofpacts_len = ofpacts->size;
6707 VLOG_WARN_RL(&bad_ofmsg_rl,
6708 "NXST_FLOW_MONITOR reply has bad event %"PRIu16,
6709 ntohs(nfuh->event));
6710 return OFPERR_NXBRC_FM_BAD_EVENT;
6714 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR reply has %"PRIu32" "
6715 "leftover bytes at end", msg->size);
6716 return OFPERR_OFPBRC_BAD_LEN;
6720 ofputil_decode_flow_monitor_cancel(const struct ofp_header *oh)
6722 const struct nx_flow_monitor_cancel *cancel = ofpmsg_body(oh);
6724 return ntohl(cancel->id);
6728 ofputil_encode_flow_monitor_cancel(uint32_t id)
6730 struct nx_flow_monitor_cancel *nfmc;
6733 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MONITOR_CANCEL, OFP10_VERSION, 0);
6734 nfmc = ofpbuf_put_uninit(msg, sizeof *nfmc);
6735 nfmc->id = htonl(id);
6740 ofputil_start_flow_update(struct ovs_list *replies)
6744 msg = ofpraw_alloc_xid(OFPRAW_NXST_FLOW_MONITOR_REPLY, OFP10_VERSION,
6748 list_push_back(replies, &msg->list_node);
6752 ofputil_append_flow_update(const struct ofputil_flow_update *update,
6753 struct ovs_list *replies)
6755 enum ofp_version version = ofpmp_version(replies);
6756 struct nx_flow_update_header *nfuh;
6760 msg = ofpbuf_from_list(list_back(replies));
6761 start_ofs = msg->size;
6763 if (update->event == NXFME_ABBREV) {
6764 struct nx_flow_update_abbrev *nfua;
6766 nfua = ofpbuf_put_zeros(msg, sizeof *nfua);
6767 nfua->xid = update->xid;
6769 struct nx_flow_update_full *nfuf;
6772 ofpbuf_put_zeros(msg, sizeof *nfuf);
6773 match_len = nx_put_match(msg, update->match, htonll(0), htonll(0));
6774 ofpacts_put_openflow_actions(update->ofpacts, update->ofpacts_len, msg,
6776 nfuf = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuf);
6777 nfuf->reason = htons(update->reason);
6778 nfuf->priority = htons(update->priority);
6779 nfuf->idle_timeout = htons(update->idle_timeout);
6780 nfuf->hard_timeout = htons(update->hard_timeout);
6781 nfuf->match_len = htons(match_len);
6782 nfuf->table_id = update->table_id;
6783 nfuf->cookie = update->cookie;
6786 nfuh = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuh);
6787 nfuh->length = htons(msg->size - start_ofs);
6788 nfuh->event = htons(update->event);
6790 ofpmp_postappend(replies, start_ofs);
6794 ofputil_encode_packet_out(const struct ofputil_packet_out *po,
6795 enum ofputil_protocol protocol)
6797 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
6801 size = po->ofpacts_len;
6802 if (po->buffer_id == UINT32_MAX) {
6803 size += po->packet_len;
6806 switch (ofp_version) {
6807 case OFP10_VERSION: {
6808 struct ofp10_packet_out *opo;
6811 msg = ofpraw_alloc(OFPRAW_OFPT10_PACKET_OUT, OFP10_VERSION, size);
6812 ofpbuf_put_zeros(msg, sizeof *opo);
6813 actions_ofs = msg->size;
6814 ofpacts_put_openflow_actions(po->ofpacts, po->ofpacts_len, msg,
6818 opo->buffer_id = htonl(po->buffer_id);
6819 opo->in_port = htons(ofp_to_u16(po->in_port));
6820 opo->actions_len = htons(msg->size - actions_ofs);
6828 case OFP15_VERSION: {
6829 struct ofp11_packet_out *opo;
6832 msg = ofpraw_alloc(OFPRAW_OFPT11_PACKET_OUT, ofp_version, size);
6833 ofpbuf_put_zeros(msg, sizeof *opo);
6834 len = ofpacts_put_openflow_actions(po->ofpacts, po->ofpacts_len, msg,
6837 opo->buffer_id = htonl(po->buffer_id);
6838 opo->in_port = ofputil_port_to_ofp11(po->in_port);
6839 opo->actions_len = htons(len);
6847 if (po->buffer_id == UINT32_MAX) {
6848 ofpbuf_put(msg, po->packet, po->packet_len);
6851 ofpmsg_update_length(msg);
6856 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
6858 make_echo_request(enum ofp_version ofp_version)
6860 return ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST, ofp_version,
6864 /* Creates and returns an OFPT_ECHO_REPLY message matching the
6865 * OFPT_ECHO_REQUEST message in 'rq'. */
6867 make_echo_reply(const struct ofp_header *rq)
6869 struct ofpbuf rq_buf = ofpbuf_const_initializer(rq, ntohs(rq->length));
6870 ofpraw_pull_assert(&rq_buf);
6872 struct ofpbuf *reply = ofpraw_alloc_reply(OFPRAW_OFPT_ECHO_REPLY,
6874 ofpbuf_put(reply, rq_buf.data, rq_buf.size);
6879 ofputil_encode_barrier_request(enum ofp_version ofp_version)
6883 switch (ofp_version) {
6889 type = OFPRAW_OFPT11_BARRIER_REQUEST;
6893 type = OFPRAW_OFPT10_BARRIER_REQUEST;
6900 return ofpraw_alloc(type, ofp_version, 0);
6904 ofputil_frag_handling_to_string(enum ofputil_frag_handling frag)
6907 case OFPUTIL_FRAG_NORMAL: return "normal";
6908 case OFPUTIL_FRAG_DROP: return "drop";
6909 case OFPUTIL_FRAG_REASM: return "reassemble";
6910 case OFPUTIL_FRAG_NX_MATCH: return "nx-match";
6917 ofputil_frag_handling_from_string(const char *s,
6918 enum ofputil_frag_handling *frag)
6920 if (!strcasecmp(s, "normal")) {
6921 *frag = OFPUTIL_FRAG_NORMAL;
6922 } else if (!strcasecmp(s, "drop")) {
6923 *frag = OFPUTIL_FRAG_DROP;
6924 } else if (!strcasecmp(s, "reassemble")) {
6925 *frag = OFPUTIL_FRAG_REASM;
6926 } else if (!strcasecmp(s, "nx-match")) {
6927 *frag = OFPUTIL_FRAG_NX_MATCH;
6934 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
6935 * port number and stores the latter in '*ofp10_port', for the purpose of
6936 * decoding OpenFlow 1.1+ protocol messages. Returns 0 if successful,
6937 * otherwise an OFPERR_* number. On error, stores OFPP_NONE in '*ofp10_port'.
6939 * See the definition of OFP11_MAX for an explanation of the mapping. */
6941 ofputil_port_from_ofp11(ovs_be32 ofp11_port, ofp_port_t *ofp10_port)
6943 uint32_t ofp11_port_h = ntohl(ofp11_port);
6945 if (ofp11_port_h < ofp_to_u16(OFPP_MAX)) {
6946 *ofp10_port = u16_to_ofp(ofp11_port_h);
6948 } else if (ofp11_port_h >= ofp11_to_u32(OFPP11_MAX)) {
6949 *ofp10_port = u16_to_ofp(ofp11_port_h - OFPP11_OFFSET);
6952 *ofp10_port = OFPP_NONE;
6953 VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
6954 "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
6955 ofp11_port_h, ofp_to_u16(OFPP_MAX) - 1,
6956 ofp11_to_u32(OFPP11_MAX), UINT32_MAX);
6957 return OFPERR_OFPBAC_BAD_OUT_PORT;
6961 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
6962 * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
6964 * See the definition of OFP11_MAX for an explanation of the mapping. */
6966 ofputil_port_to_ofp11(ofp_port_t ofp10_port)
6968 return htonl(ofp_to_u16(ofp10_port) < ofp_to_u16(OFPP_MAX)
6969 ? ofp_to_u16(ofp10_port)
6970 : ofp_to_u16(ofp10_port) + OFPP11_OFFSET);
6973 #define OFPUTIL_NAMED_PORTS \
6974 OFPUTIL_NAMED_PORT(IN_PORT) \
6975 OFPUTIL_NAMED_PORT(TABLE) \
6976 OFPUTIL_NAMED_PORT(NORMAL) \
6977 OFPUTIL_NAMED_PORT(FLOOD) \
6978 OFPUTIL_NAMED_PORT(ALL) \
6979 OFPUTIL_NAMED_PORT(CONTROLLER) \
6980 OFPUTIL_NAMED_PORT(LOCAL) \
6981 OFPUTIL_NAMED_PORT(ANY) \
6982 OFPUTIL_NAMED_PORT(UNSET)
6984 /* For backwards compatibility, so that "none" is recognized as OFPP_ANY */
6985 #define OFPUTIL_NAMED_PORTS_WITH_NONE \
6986 OFPUTIL_NAMED_PORTS \
6987 OFPUTIL_NAMED_PORT(NONE)
6989 /* Stores the port number represented by 's' into '*portp'. 's' may be an
6990 * integer or, for reserved ports, the standard OpenFlow name for the port
6993 * Returns true if successful, false if 's' is not a valid OpenFlow port number
6994 * or name. The caller should issue an error message in this case, because
6995 * this function usually does not. (This gives the caller an opportunity to
6996 * look up the port name another way, e.g. by contacting the switch and listing
6997 * the names of all its ports).
6999 * This function accepts OpenFlow 1.0 port numbers. It also accepts a subset
7000 * of OpenFlow 1.1+ port numbers, mapping those port numbers into the 16-bit
7001 * range as described in include/openflow/openflow-1.1.h. */
7003 ofputil_port_from_string(const char *s, ofp_port_t *portp)
7005 unsigned int port32; /* int is at least 32 bits wide. */
7008 VLOG_WARN("Negative value %s is not a valid port number.", s);
7012 if (str_to_uint(s, 10, &port32)) {
7013 if (port32 < ofp_to_u16(OFPP_MAX)) {
7015 } else if (port32 < ofp_to_u16(OFPP_FIRST_RESV)) {
7016 VLOG_WARN("port %u is a reserved OF1.0 port number that will "
7017 "be translated to %u when talking to an OF1.1 or "
7018 "later controller", port32, port32 + OFPP11_OFFSET);
7019 } else if (port32 <= ofp_to_u16(OFPP_LAST_RESV)) {
7020 char name[OFP_MAX_PORT_NAME_LEN];
7022 ofputil_port_to_string(u16_to_ofp(port32), name, sizeof name);
7023 VLOG_WARN_ONCE("referring to port %s as %"PRIu32" is deprecated "
7024 "for compatibility with OpenFlow 1.1 and later",
7026 } else if (port32 < ofp11_to_u32(OFPP11_MAX)) {
7027 VLOG_WARN("port %u is outside the supported range 0 through "
7028 "%"PRIx16" or 0x%x through 0x%"PRIx32, port32,
7029 UINT16_MAX, ofp11_to_u32(OFPP11_MAX), UINT32_MAX);
7032 port32 -= OFPP11_OFFSET;
7035 *portp = u16_to_ofp(port32);
7042 static const struct pair pairs[] = {
7043 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
7044 OFPUTIL_NAMED_PORTS_WITH_NONE
7045 #undef OFPUTIL_NAMED_PORT
7047 const struct pair *p;
7049 for (p = pairs; p < &pairs[ARRAY_SIZE(pairs)]; p++) {
7050 if (!strcasecmp(s, p->name)) {
7059 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
7060 * Most ports' string representation is just the port number, but for special
7061 * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
7063 ofputil_format_port(ofp_port_t port, struct ds *s)
7065 char name[OFP_MAX_PORT_NAME_LEN];
7067 ofputil_port_to_string(port, name, sizeof name);
7068 ds_put_cstr(s, name);
7071 /* Puts in the 'bufsize' byte in 'namebuf' a null-terminated string
7072 * representation of OpenFlow port number 'port'. Most ports are represented
7073 * as just the port number, but special ports, e.g. OFPP_LOCAL, are represented
7074 * by name, e.g. "LOCAL". */
7076 ofputil_port_to_string(ofp_port_t port,
7077 char namebuf[OFP_MAX_PORT_NAME_LEN], size_t bufsize)
7080 #define OFPUTIL_NAMED_PORT(NAME) \
7082 ovs_strlcpy(namebuf, #NAME, bufsize); \
7085 #undef OFPUTIL_NAMED_PORT
7088 snprintf(namebuf, bufsize, "%"PRIu16, port);
7093 /* Stores the group id represented by 's' into '*group_idp'. 's' may be an
7094 * integer or, for reserved group IDs, the standard OpenFlow name for the group
7095 * (either "ANY" or "ALL").
7097 * Returns true if successful, false if 's' is not a valid OpenFlow group ID or
7100 ofputil_group_from_string(const char *s, uint32_t *group_idp)
7102 if (!strcasecmp(s, "any")) {
7103 *group_idp = OFPG_ANY;
7104 } else if (!strcasecmp(s, "all")) {
7105 *group_idp = OFPG_ALL;
7106 } else if (!str_to_uint(s, 10, group_idp)) {
7107 VLOG_WARN("%s is not a valid group ID. (Valid group IDs are "
7108 "32-bit nonnegative integers or the keywords ANY or "
7116 /* Appends to 's' a string representation of the OpenFlow group ID 'group_id'.
7117 * Most groups' string representation is just the number, but for special
7118 * groups, e.g. OFPG_ALL, it is the name, e.g. "ALL". */
7120 ofputil_format_group(uint32_t group_id, struct ds *s)
7122 char name[MAX_GROUP_NAME_LEN];
7124 ofputil_group_to_string(group_id, name, sizeof name);
7125 ds_put_cstr(s, name);
7129 /* Puts in the 'bufsize' byte in 'namebuf' a null-terminated string
7130 * representation of OpenFlow group ID 'group_id'. Most group are represented
7131 * as just their number, but special groups, e.g. OFPG_ALL, are represented
7132 * by name, e.g. "ALL". */
7134 ofputil_group_to_string(uint32_t group_id,
7135 char namebuf[MAX_GROUP_NAME_LEN + 1], size_t bufsize)
7139 ovs_strlcpy(namebuf, "ALL", bufsize);
7143 ovs_strlcpy(namebuf, "ANY", bufsize);
7147 snprintf(namebuf, bufsize, "%"PRIu32, group_id);
7152 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
7153 * 'ofp_version', tries to pull the first element from the array. If
7154 * successful, initializes '*pp' with an abstract representation of the
7155 * port and returns 0. If no ports remain to be decoded, returns EOF.
7156 * On an error, returns a positive OFPERR_* value. */
7158 ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *b,
7159 struct ofputil_phy_port *pp)
7161 memset(pp, 0, sizeof *pp);
7163 switch (ofp_version) {
7164 case OFP10_VERSION: {
7165 const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
7166 return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
7170 case OFP13_VERSION: {
7171 const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
7172 return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
7176 return b->size ? ofputil_pull_ofp14_port(pp, b) : EOF;
7183 ofputil_normalize_match__(struct match *match, bool may_log)
7186 MAY_NW_ADDR = 1 << 0, /* nw_src, nw_dst */
7187 MAY_TP_ADDR = 1 << 1, /* tp_src, tp_dst */
7188 MAY_NW_PROTO = 1 << 2, /* nw_proto */
7189 MAY_IPVx = 1 << 3, /* tos, frag, ttl */
7190 MAY_ARP_SHA = 1 << 4, /* arp_sha */
7191 MAY_ARP_THA = 1 << 5, /* arp_tha */
7192 MAY_IPV6 = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
7193 MAY_ND_TARGET = 1 << 7, /* nd_target */
7194 MAY_MPLS = 1 << 8, /* mpls label and tc */
7197 struct flow_wildcards wc;
7199 /* Figure out what fields may be matched. */
7200 if (match->flow.dl_type == htons(ETH_TYPE_IP)) {
7201 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
7202 if (match->flow.nw_proto == IPPROTO_TCP ||
7203 match->flow.nw_proto == IPPROTO_UDP ||
7204 match->flow.nw_proto == IPPROTO_SCTP ||
7205 match->flow.nw_proto == IPPROTO_ICMP) {
7206 may_match |= MAY_TP_ADDR;
7208 } else if (match->flow.dl_type == htons(ETH_TYPE_IPV6)) {
7209 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
7210 if (match->flow.nw_proto == IPPROTO_TCP ||
7211 match->flow.nw_proto == IPPROTO_UDP ||
7212 match->flow.nw_proto == IPPROTO_SCTP) {
7213 may_match |= MAY_TP_ADDR;
7214 } else if (match->flow.nw_proto == IPPROTO_ICMPV6) {
7215 may_match |= MAY_TP_ADDR;
7216 if (match->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
7217 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
7218 } else if (match->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
7219 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
7222 } else if (match->flow.dl_type == htons(ETH_TYPE_ARP) ||
7223 match->flow.dl_type == htons(ETH_TYPE_RARP)) {
7224 may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
7225 } else if (eth_type_mpls(match->flow.dl_type)) {
7226 may_match = MAY_MPLS;
7231 /* Clear the fields that may not be matched. */
7233 if (!(may_match & MAY_NW_ADDR)) {
7234 wc.masks.nw_src = wc.masks.nw_dst = htonl(0);
7236 if (!(may_match & MAY_TP_ADDR)) {
7237 wc.masks.tp_src = wc.masks.tp_dst = htons(0);
7239 if (!(may_match & MAY_NW_PROTO)) {
7240 wc.masks.nw_proto = 0;
7242 if (!(may_match & MAY_IPVx)) {
7243 wc.masks.nw_tos = 0;
7244 wc.masks.nw_ttl = 0;
7246 if (!(may_match & MAY_ARP_SHA)) {
7247 WC_UNMASK_FIELD(&wc, arp_sha);
7249 if (!(may_match & MAY_ARP_THA)) {
7250 WC_UNMASK_FIELD(&wc, arp_tha);
7252 if (!(may_match & MAY_IPV6)) {
7253 wc.masks.ipv6_src = wc.masks.ipv6_dst = in6addr_any;
7254 wc.masks.ipv6_label = htonl(0);
7256 if (!(may_match & MAY_ND_TARGET)) {
7257 wc.masks.nd_target = in6addr_any;
7259 if (!(may_match & MAY_MPLS)) {
7260 memset(wc.masks.mpls_lse, 0, sizeof wc.masks.mpls_lse);
7263 /* Log any changes. */
7264 if (!flow_wildcards_equal(&wc, &match->wc)) {
7265 bool log = may_log && !VLOG_DROP_INFO(&bad_ofmsg_rl);
7266 char *pre = log ? match_to_string(match, OFP_DEFAULT_PRIORITY) : NULL;
7269 match_zero_wildcarded_fields(match);
7272 char *post = match_to_string(match, OFP_DEFAULT_PRIORITY);
7273 VLOG_INFO("normalization changed ofp_match, details:");
7274 VLOG_INFO(" pre: %s", pre);
7275 VLOG_INFO("post: %s", post);
7282 /* "Normalizes" the wildcards in 'match'. That means:
7284 * 1. If the type of level N is known, then only the valid fields for that
7285 * level may be specified. For example, ARP does not have a TOS field,
7286 * so nw_tos must be wildcarded if 'match' specifies an ARP flow.
7287 * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
7288 * ipv6_dst (and other fields) must be wildcarded if 'match' specifies an
7291 * 2. If the type of level N is not known (or not understood by Open
7292 * vSwitch), then no fields at all for that level may be specified. For
7293 * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
7294 * L4 fields tp_src and tp_dst must be wildcarded if 'match' specifies an
7297 * If this function changes 'match', it logs a rate-limited informational
7300 ofputil_normalize_match(struct match *match)
7302 ofputil_normalize_match__(match, true);
7305 /* Same as ofputil_normalize_match() without the logging. Thus, this function
7306 * is suitable for a program's internal use, whereas ofputil_normalize_match()
7307 * sense for use on flows received from elsewhere (so that a bug in the program
7308 * that sent them can be reported and corrected). */
7310 ofputil_normalize_match_quiet(struct match *match)
7312 ofputil_normalize_match__(match, false);
7315 /* Parses a key or a key-value pair from '*stringp'.
7317 * On success: Stores the key into '*keyp'. Stores the value, if present, into
7318 * '*valuep', otherwise an empty string. Advances '*stringp' past the end of
7319 * the key-value pair, preparing it for another call. '*keyp' and '*valuep'
7320 * are substrings of '*stringp' created by replacing some of its bytes by null
7321 * terminators. Returns true.
7323 * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
7324 * NULL and returns false. */
7326 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
7328 char *pos, *key, *value;
7332 pos += strspn(pos, ", \t\r\n");
7334 *keyp = *valuep = NULL;
7339 key_len = strcspn(pos, ":=(, \t\r\n");
7340 if (key[key_len] == ':' || key[key_len] == '=') {
7341 /* The value can be separated by a colon. */
7344 value = key + key_len + 1;
7345 value_len = strcspn(value, ", \t\r\n");
7346 pos = value + value_len + (value[value_len] != '\0');
7347 value[value_len] = '\0';
7348 } else if (key[key_len] == '(') {
7349 /* The value can be surrounded by balanced parentheses. The outermost
7350 * set of parentheses is removed. */
7354 value = key + key_len + 1;
7355 for (value_len = 0; level > 0; value_len++) {
7356 switch (value[value_len]) {
7370 value[value_len - 1] = '\0';
7371 pos = value + value_len;
7373 /* There might be no value at all. */
7374 value = key + key_len; /* Will become the empty string below. */
7375 pos = key + key_len + (key[key_len] != '\0');
7377 key[key_len] = '\0';
7385 /* Encode a dump ports request for 'port', the encoded message
7386 * will be for OpenFlow version 'ofp_version'. Returns message
7387 * as a struct ofpbuf. Returns encoded message on success, NULL on error */
7389 ofputil_encode_dump_ports_request(enum ofp_version ofp_version, ofp_port_t port)
7391 struct ofpbuf *request;
7393 switch (ofp_version) {
7394 case OFP10_VERSION: {
7395 struct ofp10_port_stats_request *req;
7396 request = ofpraw_alloc(OFPRAW_OFPST10_PORT_REQUEST, ofp_version, 0);
7397 req = ofpbuf_put_zeros(request, sizeof *req);
7398 req->port_no = htons(ofp_to_u16(port));
7405 case OFP15_VERSION: {
7406 struct ofp11_port_stats_request *req;
7407 request = ofpraw_alloc(OFPRAW_OFPST11_PORT_REQUEST, ofp_version, 0);
7408 req = ofpbuf_put_zeros(request, sizeof *req);
7409 req->port_no = ofputil_port_to_ofp11(port);
7420 ofputil_port_stats_to_ofp10(const struct ofputil_port_stats *ops,
7421 struct ofp10_port_stats *ps10)
7423 ps10->port_no = htons(ofp_to_u16(ops->port_no));
7424 memset(ps10->pad, 0, sizeof ps10->pad);
7425 put_32aligned_be64(&ps10->rx_packets, htonll(ops->stats.rx_packets));
7426 put_32aligned_be64(&ps10->tx_packets, htonll(ops->stats.tx_packets));
7427 put_32aligned_be64(&ps10->rx_bytes, htonll(ops->stats.rx_bytes));
7428 put_32aligned_be64(&ps10->tx_bytes, htonll(ops->stats.tx_bytes));
7429 put_32aligned_be64(&ps10->rx_dropped, htonll(ops->stats.rx_dropped));
7430 put_32aligned_be64(&ps10->tx_dropped, htonll(ops->stats.tx_dropped));
7431 put_32aligned_be64(&ps10->rx_errors, htonll(ops->stats.rx_errors));
7432 put_32aligned_be64(&ps10->tx_errors, htonll(ops->stats.tx_errors));
7433 put_32aligned_be64(&ps10->rx_frame_err, htonll(ops->stats.rx_frame_errors));
7434 put_32aligned_be64(&ps10->rx_over_err, htonll(ops->stats.rx_over_errors));
7435 put_32aligned_be64(&ps10->rx_crc_err, htonll(ops->stats.rx_crc_errors));
7436 put_32aligned_be64(&ps10->collisions, htonll(ops->stats.collisions));
7440 ofputil_port_stats_to_ofp11(const struct ofputil_port_stats *ops,
7441 struct ofp11_port_stats *ps11)
7443 ps11->port_no = ofputil_port_to_ofp11(ops->port_no);
7444 memset(ps11->pad, 0, sizeof ps11->pad);
7445 ps11->rx_packets = htonll(ops->stats.rx_packets);
7446 ps11->tx_packets = htonll(ops->stats.tx_packets);
7447 ps11->rx_bytes = htonll(ops->stats.rx_bytes);
7448 ps11->tx_bytes = htonll(ops->stats.tx_bytes);
7449 ps11->rx_dropped = htonll(ops->stats.rx_dropped);
7450 ps11->tx_dropped = htonll(ops->stats.tx_dropped);
7451 ps11->rx_errors = htonll(ops->stats.rx_errors);
7452 ps11->tx_errors = htonll(ops->stats.tx_errors);
7453 ps11->rx_frame_err = htonll(ops->stats.rx_frame_errors);
7454 ps11->rx_over_err = htonll(ops->stats.rx_over_errors);
7455 ps11->rx_crc_err = htonll(ops->stats.rx_crc_errors);
7456 ps11->collisions = htonll(ops->stats.collisions);
7460 ofputil_port_stats_to_ofp13(const struct ofputil_port_stats *ops,
7461 struct ofp13_port_stats *ps13)
7463 ofputil_port_stats_to_ofp11(ops, &ps13->ps);
7464 ps13->duration_sec = htonl(ops->duration_sec);
7465 ps13->duration_nsec = htonl(ops->duration_nsec);
7469 ofputil_append_ofp14_port_stats(const struct ofputil_port_stats *ops,
7470 struct ovs_list *replies)
7472 struct ofp14_port_stats_prop_ethernet *eth;
7473 struct ofp14_port_stats *ps14;
7474 struct ofpbuf *reply;
7476 reply = ofpmp_reserve(replies, sizeof *ps14 + sizeof *eth);
7478 ps14 = ofpbuf_put_uninit(reply, sizeof *ps14);
7479 ps14->length = htons(sizeof *ps14 + sizeof *eth);
7480 memset(ps14->pad, 0, sizeof ps14->pad);
7481 ps14->port_no = ofputil_port_to_ofp11(ops->port_no);
7482 ps14->duration_sec = htonl(ops->duration_sec);
7483 ps14->duration_nsec = htonl(ops->duration_nsec);
7484 ps14->rx_packets = htonll(ops->stats.rx_packets);
7485 ps14->tx_packets = htonll(ops->stats.tx_packets);
7486 ps14->rx_bytes = htonll(ops->stats.rx_bytes);
7487 ps14->tx_bytes = htonll(ops->stats.tx_bytes);
7488 ps14->rx_dropped = htonll(ops->stats.rx_dropped);
7489 ps14->tx_dropped = htonll(ops->stats.tx_dropped);
7490 ps14->rx_errors = htonll(ops->stats.rx_errors);
7491 ps14->tx_errors = htonll(ops->stats.tx_errors);
7493 eth = ofpprop_put_zeros(reply, OFPPSPT14_ETHERNET, sizeof *eth);
7494 eth->rx_frame_err = htonll(ops->stats.rx_frame_errors);
7495 eth->rx_over_err = htonll(ops->stats.rx_over_errors);
7496 eth->rx_crc_err = htonll(ops->stats.rx_crc_errors);
7497 eth->collisions = htonll(ops->stats.collisions);
7500 /* Encode a ports stat for 'ops' and append it to 'replies'. */
7502 ofputil_append_port_stat(struct ovs_list *replies,
7503 const struct ofputil_port_stats *ops)
7505 switch (ofpmp_version(replies)) {
7506 case OFP13_VERSION: {
7507 struct ofp13_port_stats *reply = ofpmp_append(replies, sizeof *reply);
7508 ofputil_port_stats_to_ofp13(ops, reply);
7512 case OFP11_VERSION: {
7513 struct ofp11_port_stats *reply = ofpmp_append(replies, sizeof *reply);
7514 ofputil_port_stats_to_ofp11(ops, reply);
7518 case OFP10_VERSION: {
7519 struct ofp10_port_stats *reply = ofpmp_append(replies, sizeof *reply);
7520 ofputil_port_stats_to_ofp10(ops, reply);
7526 ofputil_append_ofp14_port_stats(ops, replies);
7535 ofputil_port_stats_from_ofp10(struct ofputil_port_stats *ops,
7536 const struct ofp10_port_stats *ps10)
7538 memset(ops, 0, sizeof *ops);
7540 ops->port_no = u16_to_ofp(ntohs(ps10->port_no));
7541 ops->stats.rx_packets = ntohll(get_32aligned_be64(&ps10->rx_packets));
7542 ops->stats.tx_packets = ntohll(get_32aligned_be64(&ps10->tx_packets));
7543 ops->stats.rx_bytes = ntohll(get_32aligned_be64(&ps10->rx_bytes));
7544 ops->stats.tx_bytes = ntohll(get_32aligned_be64(&ps10->tx_bytes));
7545 ops->stats.rx_dropped = ntohll(get_32aligned_be64(&ps10->rx_dropped));
7546 ops->stats.tx_dropped = ntohll(get_32aligned_be64(&ps10->tx_dropped));
7547 ops->stats.rx_errors = ntohll(get_32aligned_be64(&ps10->rx_errors));
7548 ops->stats.tx_errors = ntohll(get_32aligned_be64(&ps10->tx_errors));
7549 ops->stats.rx_frame_errors =
7550 ntohll(get_32aligned_be64(&ps10->rx_frame_err));
7551 ops->stats.rx_over_errors = ntohll(get_32aligned_be64(&ps10->rx_over_err));
7552 ops->stats.rx_crc_errors = ntohll(get_32aligned_be64(&ps10->rx_crc_err));
7553 ops->stats.collisions = ntohll(get_32aligned_be64(&ps10->collisions));
7554 ops->duration_sec = ops->duration_nsec = UINT32_MAX;
7560 ofputil_port_stats_from_ofp11(struct ofputil_port_stats *ops,
7561 const struct ofp11_port_stats *ps11)
7565 memset(ops, 0, sizeof *ops);
7566 error = ofputil_port_from_ofp11(ps11->port_no, &ops->port_no);
7571 ops->stats.rx_packets = ntohll(ps11->rx_packets);
7572 ops->stats.tx_packets = ntohll(ps11->tx_packets);
7573 ops->stats.rx_bytes = ntohll(ps11->rx_bytes);
7574 ops->stats.tx_bytes = ntohll(ps11->tx_bytes);
7575 ops->stats.rx_dropped = ntohll(ps11->rx_dropped);
7576 ops->stats.tx_dropped = ntohll(ps11->tx_dropped);
7577 ops->stats.rx_errors = ntohll(ps11->rx_errors);
7578 ops->stats.tx_errors = ntohll(ps11->tx_errors);
7579 ops->stats.rx_frame_errors = ntohll(ps11->rx_frame_err);
7580 ops->stats.rx_over_errors = ntohll(ps11->rx_over_err);
7581 ops->stats.rx_crc_errors = ntohll(ps11->rx_crc_err);
7582 ops->stats.collisions = ntohll(ps11->collisions);
7583 ops->duration_sec = ops->duration_nsec = UINT32_MAX;
7589 ofputil_port_stats_from_ofp13(struct ofputil_port_stats *ops,
7590 const struct ofp13_port_stats *ps13)
7592 enum ofperr error = ofputil_port_stats_from_ofp11(ops, &ps13->ps);
7594 ops->duration_sec = ntohl(ps13->duration_sec);
7595 ops->duration_nsec = ntohl(ps13->duration_nsec);
7601 parse_ofp14_port_stats_ethernet_property(const struct ofpbuf *payload,
7602 struct ofputil_port_stats *ops)
7604 const struct ofp14_port_stats_prop_ethernet *eth = payload->data;
7606 if (payload->size != sizeof *eth) {
7607 return OFPERR_OFPBPC_BAD_LEN;
7610 ops->stats.rx_frame_errors = ntohll(eth->rx_frame_err);
7611 ops->stats.rx_over_errors = ntohll(eth->rx_over_err);
7612 ops->stats.rx_crc_errors = ntohll(eth->rx_crc_err);
7613 ops->stats.collisions = ntohll(eth->collisions);
7619 ofputil_pull_ofp14_port_stats(struct ofputil_port_stats *ops,
7622 const struct ofp14_port_stats *ps14 = ofpbuf_try_pull(msg, sizeof *ps14);
7624 return OFPERR_OFPBRC_BAD_LEN;
7627 size_t len = ntohs(ps14->length);
7628 if (len < sizeof *ps14 || len - sizeof *ps14 > msg->size) {
7629 return OFPERR_OFPBRC_BAD_LEN;
7631 len -= sizeof *ps14;
7633 enum ofperr error = ofputil_port_from_ofp11(ps14->port_no, &ops->port_no);
7638 ops->duration_sec = ntohl(ps14->duration_sec);
7639 ops->duration_nsec = ntohl(ps14->duration_nsec);
7640 ops->stats.rx_packets = ntohll(ps14->rx_packets);
7641 ops->stats.tx_packets = ntohll(ps14->tx_packets);
7642 ops->stats.rx_bytes = ntohll(ps14->rx_bytes);
7643 ops->stats.tx_bytes = ntohll(ps14->tx_bytes);
7644 ops->stats.rx_dropped = ntohll(ps14->rx_dropped);
7645 ops->stats.tx_dropped = ntohll(ps14->tx_dropped);
7646 ops->stats.rx_errors = ntohll(ps14->rx_errors);
7647 ops->stats.tx_errors = ntohll(ps14->tx_errors);
7648 ops->stats.rx_frame_errors = UINT64_MAX;
7649 ops->stats.rx_over_errors = UINT64_MAX;
7650 ops->stats.rx_crc_errors = UINT64_MAX;
7651 ops->stats.collisions = UINT64_MAX;
7653 struct ofpbuf properties = ofpbuf_const_initializer(ofpbuf_pull(msg, len),
7655 while (properties.size > 0) {
7656 struct ofpbuf payload;
7660 error = ofpprop_pull(&properties, &payload, &type);
7666 case OFPPSPT14_ETHERNET:
7667 error = parse_ofp14_port_stats_ethernet_property(&payload, ops);
7671 error = OFPPROP_UNKNOWN(true, "port stats", type);
7683 /* Returns the number of port stats elements in OFPTYPE_PORT_STATS_REPLY
7686 ofputil_count_port_stats(const struct ofp_header *oh)
7688 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
7689 ofpraw_pull_assert(&b);
7691 for (size_t n = 0; ; n++) {
7692 struct ofputil_port_stats ps;
7693 if (ofputil_decode_port_stats(&ps, &b)) {
7699 /* Converts an OFPST_PORT_STATS reply in 'msg' into an abstract
7700 * ofputil_port_stats in 'ps'.
7702 * Multiple OFPST_PORT_STATS replies can be packed into a single OpenFlow
7703 * message. Calling this function multiple times for a single 'msg' iterates
7704 * through the replies. The caller must initially leave 'msg''s layer pointers
7705 * null and not modify them between calls.
7707 * Returns 0 if successful, EOF if no replies were left in this 'msg',
7708 * otherwise a positive errno value. */
7710 ofputil_decode_port_stats(struct ofputil_port_stats *ps, struct ofpbuf *msg)
7715 error = (msg->header ? ofpraw_decode(&raw, msg->header)
7716 : ofpraw_pull(&raw, msg));
7723 } else if (raw == OFPRAW_OFPST14_PORT_REPLY) {
7724 return ofputil_pull_ofp14_port_stats(ps, msg);
7725 } else if (raw == OFPRAW_OFPST13_PORT_REPLY) {
7726 const struct ofp13_port_stats *ps13;
7728 ps13 = ofpbuf_try_pull(msg, sizeof *ps13);
7732 return ofputil_port_stats_from_ofp13(ps, ps13);
7733 } else if (raw == OFPRAW_OFPST11_PORT_REPLY) {
7734 const struct ofp11_port_stats *ps11;
7736 ps11 = ofpbuf_try_pull(msg, sizeof *ps11);
7740 return ofputil_port_stats_from_ofp11(ps, ps11);
7741 } else if (raw == OFPRAW_OFPST10_PORT_REPLY) {
7742 const struct ofp10_port_stats *ps10;
7744 ps10 = ofpbuf_try_pull(msg, sizeof *ps10);
7748 return ofputil_port_stats_from_ofp10(ps, ps10);
7754 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_PORT reply has %"PRIu32" leftover "
7755 "bytes at end", msg->size);
7756 return OFPERR_OFPBRC_BAD_LEN;
7759 /* Parse a port status request message into a 16 bit OpenFlow 1.0
7760 * port number and stores the latter in '*ofp10_port'.
7761 * Returns 0 if successful, otherwise an OFPERR_* number. */
7763 ofputil_decode_port_stats_request(const struct ofp_header *request,
7764 ofp_port_t *ofp10_port)
7766 switch ((enum ofp_version)request->version) {
7771 case OFP11_VERSION: {
7772 const struct ofp11_port_stats_request *psr11 = ofpmsg_body(request);
7773 return ofputil_port_from_ofp11(psr11->port_no, ofp10_port);
7776 case OFP10_VERSION: {
7777 const struct ofp10_port_stats_request *psr10 = ofpmsg_body(request);
7778 *ofp10_port = u16_to_ofp(ntohs(psr10->port_no));
7787 /* Frees all of the "struct ofputil_bucket"s in the 'buckets' list. */
7789 ofputil_bucket_list_destroy(struct ovs_list *buckets)
7791 struct ofputil_bucket *bucket;
7793 LIST_FOR_EACH_POP (bucket, list_node, buckets) {
7794 free(bucket->ofpacts);
7799 /* Clones 'bucket' and its ofpacts data */
7800 static struct ofputil_bucket *
7801 ofputil_bucket_clone_data(const struct ofputil_bucket *bucket)
7803 struct ofputil_bucket *new;
7805 new = xmemdup(bucket, sizeof *bucket);
7806 new->ofpacts = xmemdup(bucket->ofpacts, bucket->ofpacts_len);
7811 /* Clones each of the buckets in the list 'src' appending them
7812 * in turn to 'dest' which should be an initialised list.
7813 * An exception is that if the pointer value of a bucket in 'src'
7814 * matches 'skip' then it is not cloned or appended to 'dest'.
7815 * This allows all of 'src' or 'all of 'src' except 'skip' to
7816 * be cloned and appended to 'dest'. */
7818 ofputil_bucket_clone_list(struct ovs_list *dest, const struct ovs_list *src,
7819 const struct ofputil_bucket *skip)
7821 struct ofputil_bucket *bucket;
7823 LIST_FOR_EACH (bucket, list_node, src) {
7824 struct ofputil_bucket *new_bucket;
7826 if (bucket == skip) {
7830 new_bucket = ofputil_bucket_clone_data(bucket);
7831 list_push_back(dest, &new_bucket->list_node);
7835 /* Find a bucket in the list 'buckets' whose bucket id is 'bucket_id'
7836 * Returns the first bucket found or NULL if no buckets are found. */
7837 struct ofputil_bucket *
7838 ofputil_bucket_find(const struct ovs_list *buckets, uint32_t bucket_id)
7840 struct ofputil_bucket *bucket;
7842 if (bucket_id > OFPG15_BUCKET_MAX) {
7846 LIST_FOR_EACH (bucket, list_node, buckets) {
7847 if (bucket->bucket_id == bucket_id) {
7855 /* Returns true if more than one bucket in the list 'buckets'
7856 * have the same bucket id. Returns false otherwise. */
7858 ofputil_bucket_check_duplicate_id(const struct ovs_list *buckets)
7860 struct ofputil_bucket *i, *j;
7862 LIST_FOR_EACH (i, list_node, buckets) {
7863 LIST_FOR_EACH_REVERSE (j, list_node, buckets) {
7867 if (i->bucket_id == j->bucket_id) {
7876 /* Returns the bucket at the front of the list 'buckets'.
7877 * Undefined if 'buckets is empty. */
7878 struct ofputil_bucket *
7879 ofputil_bucket_list_front(const struct ovs_list *buckets)
7881 static struct ofputil_bucket *bucket;
7883 ASSIGN_CONTAINER(bucket, list_front(buckets), list_node);
7888 /* Returns the bucket at the back of the list 'buckets'.
7889 * Undefined if 'buckets is empty. */
7890 struct ofputil_bucket *
7891 ofputil_bucket_list_back(const struct ovs_list *buckets)
7893 static struct ofputil_bucket *bucket;
7895 ASSIGN_CONTAINER(bucket, list_back(buckets), list_node);
7900 /* Returns an OpenFlow group stats request for OpenFlow version 'ofp_version',
7901 * that requests stats for group 'group_id'. (Use OFPG_ALL to request stats
7904 * Group statistics include packet and byte counts for each group. */
7906 ofputil_encode_group_stats_request(enum ofp_version ofp_version,
7909 struct ofpbuf *request;
7911 switch (ofp_version) {
7913 ovs_fatal(0, "dump-group-stats needs OpenFlow 1.1 or later "
7914 "(\'-O OpenFlow11\')");
7919 case OFP15_VERSION: {
7920 struct ofp11_group_stats_request *req;
7921 request = ofpraw_alloc(OFPRAW_OFPST11_GROUP_REQUEST, ofp_version, 0);
7922 req = ofpbuf_put_zeros(request, sizeof *req);
7923 req->group_id = htonl(group_id);
7934 ofputil_uninit_group_desc(struct ofputil_group_desc *gd)
7936 ofputil_bucket_list_destroy(&gd->buckets);
7937 free(&gd->props.fields);
7940 /* Decodes the OpenFlow group description request in 'oh', returning the group
7941 * whose description is requested, or OFPG_ALL if stats for all groups was
7944 ofputil_decode_group_desc_request(const struct ofp_header *oh)
7946 struct ofpbuf request = ofpbuf_const_initializer(oh, ntohs(oh->length));
7947 enum ofpraw raw = ofpraw_pull_assert(&request);
7948 if (raw == OFPRAW_OFPST11_GROUP_DESC_REQUEST) {
7950 } else if (raw == OFPRAW_OFPST15_GROUP_DESC_REQUEST) {
7951 ovs_be32 *group_id = ofpbuf_pull(&request, sizeof *group_id);
7952 return ntohl(*group_id);
7958 /* Returns an OpenFlow group description request for OpenFlow version
7959 * 'ofp_version', that requests stats for group 'group_id'. Use OFPG_ALL to
7960 * request stats for all groups (OpenFlow 1.4 and earlier always request all
7963 * Group descriptions include the bucket and action configuration for each
7966 ofputil_encode_group_desc_request(enum ofp_version ofp_version,
7969 struct ofpbuf *request;
7971 switch (ofp_version) {
7973 ovs_fatal(0, "dump-groups needs OpenFlow 1.1 or later "
7974 "(\'-O OpenFlow11\')");
7979 request = ofpraw_alloc(OFPRAW_OFPST11_GROUP_DESC_REQUEST,
7982 case OFP15_VERSION:{
7983 struct ofp15_group_desc_request *req;
7984 request = ofpraw_alloc(OFPRAW_OFPST15_GROUP_DESC_REQUEST,
7986 req = ofpbuf_put_zeros(request, sizeof *req);
7987 req->group_id = htonl(group_id);
7998 ofputil_group_bucket_counters_to_ofp11(const struct ofputil_group_stats *gs,
7999 struct ofp11_bucket_counter bucket_cnts[])
8003 for (i = 0; i < gs->n_buckets; i++) {
8004 bucket_cnts[i].packet_count = htonll(gs->bucket_stats[i].packet_count);
8005 bucket_cnts[i].byte_count = htonll(gs->bucket_stats[i].byte_count);
8010 ofputil_group_stats_to_ofp11(const struct ofputil_group_stats *gs,
8011 struct ofp11_group_stats *gs11, size_t length,
8012 struct ofp11_bucket_counter bucket_cnts[])
8014 memset(gs11, 0, sizeof *gs11);
8015 gs11->length = htons(length);
8016 gs11->group_id = htonl(gs->group_id);
8017 gs11->ref_count = htonl(gs->ref_count);
8018 gs11->packet_count = htonll(gs->packet_count);
8019 gs11->byte_count = htonll(gs->byte_count);
8020 ofputil_group_bucket_counters_to_ofp11(gs, bucket_cnts);
8024 ofputil_group_stats_to_ofp13(const struct ofputil_group_stats *gs,
8025 struct ofp13_group_stats *gs13, size_t length,
8026 struct ofp11_bucket_counter bucket_cnts[])
8028 ofputil_group_stats_to_ofp11(gs, &gs13->gs, length, bucket_cnts);
8029 gs13->duration_sec = htonl(gs->duration_sec);
8030 gs13->duration_nsec = htonl(gs->duration_nsec);
8034 /* Encodes 'gs' properly for the format of the list of group statistics
8035 * replies already begun in 'replies' and appends it to the list. 'replies'
8036 * must have originally been initialized with ofpmp_init(). */
8038 ofputil_append_group_stats(struct ovs_list *replies,
8039 const struct ofputil_group_stats *gs)
8041 size_t bucket_counter_size;
8042 struct ofp11_bucket_counter *bucket_counters;
8045 bucket_counter_size = gs->n_buckets * sizeof(struct ofp11_bucket_counter);
8047 switch (ofpmp_version(replies)) {
8049 case OFP12_VERSION:{
8050 struct ofp11_group_stats *gs11;
8052 length = sizeof *gs11 + bucket_counter_size;
8053 gs11 = ofpmp_append(replies, length);
8054 bucket_counters = (struct ofp11_bucket_counter *)(gs11 + 1);
8055 ofputil_group_stats_to_ofp11(gs, gs11, length, bucket_counters);
8061 case OFP15_VERSION: {
8062 struct ofp13_group_stats *gs13;
8064 length = sizeof *gs13 + bucket_counter_size;
8065 gs13 = ofpmp_append(replies, length);
8066 bucket_counters = (struct ofp11_bucket_counter *)(gs13 + 1);
8067 ofputil_group_stats_to_ofp13(gs, gs13, length, bucket_counters);
8076 /* Returns an OpenFlow group features request for OpenFlow version
8079 ofputil_encode_group_features_request(enum ofp_version ofp_version)
8081 struct ofpbuf *request = NULL;
8083 switch (ofp_version) {
8086 ovs_fatal(0, "dump-group-features needs OpenFlow 1.2 or later "
8087 "(\'-O OpenFlow12\')");
8092 request = ofpraw_alloc(OFPRAW_OFPST12_GROUP_FEATURES_REQUEST,
8102 /* Returns a OpenFlow message that encodes 'features' properly as a reply to
8103 * group features request 'request'. */
8105 ofputil_encode_group_features_reply(
8106 const struct ofputil_group_features *features,
8107 const struct ofp_header *request)
8109 struct ofp12_group_features_stats *ogf;
8110 struct ofpbuf *reply;
8113 reply = ofpraw_alloc_xid(OFPRAW_OFPST12_GROUP_FEATURES_REPLY,
8114 request->version, request->xid, 0);
8115 ogf = ofpbuf_put_zeros(reply, sizeof *ogf);
8116 ogf->types = htonl(features->types);
8117 ogf->capabilities = htonl(features->capabilities);
8118 for (i = 0; i < OFPGT12_N_TYPES; i++) {
8119 ogf->max_groups[i] = htonl(features->max_groups[i]);
8120 ogf->actions[i] = ofpact_bitmap_to_openflow(features->ofpacts[i],
8127 /* Decodes group features reply 'oh' into 'features'. */
8129 ofputil_decode_group_features_reply(const struct ofp_header *oh,
8130 struct ofputil_group_features *features)
8132 const struct ofp12_group_features_stats *ogf = ofpmsg_body(oh);
8135 features->types = ntohl(ogf->types);
8136 features->capabilities = ntohl(ogf->capabilities);
8137 for (i = 0; i < OFPGT12_N_TYPES; i++) {
8138 features->max_groups[i] = ntohl(ogf->max_groups[i]);
8139 features->ofpacts[i] = ofpact_bitmap_from_openflow(
8140 ogf->actions[i], oh->version);
8144 /* Parse a group status request message into a 32 bit OpenFlow 1.1
8145 * group ID and stores the latter in '*group_id'.
8146 * Returns 0 if successful, otherwise an OFPERR_* number. */
8148 ofputil_decode_group_stats_request(const struct ofp_header *request,
8151 const struct ofp11_group_stats_request *gsr11 = ofpmsg_body(request);
8152 *group_id = ntohl(gsr11->group_id);
8156 /* Converts a group stats reply in 'msg' into an abstract ofputil_group_stats
8157 * in 'gs'. Assigns freshly allocated memory to gs->bucket_stats for the
8158 * caller to eventually free.
8160 * Multiple group stats replies can be packed into a single OpenFlow message.
8161 * Calling this function multiple times for a single 'msg' iterates through the
8162 * replies. The caller must initially leave 'msg''s layer pointers null and
8163 * not modify them between calls.
8165 * Returns 0 if successful, EOF if no replies were left in this 'msg',
8166 * otherwise a positive errno value. */
8168 ofputil_decode_group_stats_reply(struct ofpbuf *msg,
8169 struct ofputil_group_stats *gs)
8171 struct ofp11_bucket_counter *obc;
8172 struct ofp11_group_stats *ogs11;
8179 gs->bucket_stats = NULL;
8180 error = (msg->header ? ofpraw_decode(&raw, msg->header)
8181 : ofpraw_pull(&raw, msg));
8190 if (raw == OFPRAW_OFPST11_GROUP_REPLY) {
8191 base_len = sizeof *ogs11;
8192 ogs11 = ofpbuf_try_pull(msg, sizeof *ogs11);
8193 gs->duration_sec = gs->duration_nsec = UINT32_MAX;
8194 } else if (raw == OFPRAW_OFPST13_GROUP_REPLY) {
8195 struct ofp13_group_stats *ogs13;
8197 base_len = sizeof *ogs13;
8198 ogs13 = ofpbuf_try_pull(msg, sizeof *ogs13);
8201 gs->duration_sec = ntohl(ogs13->duration_sec);
8202 gs->duration_nsec = ntohl(ogs13->duration_nsec);
8211 VLOG_WARN_RL(&bad_ofmsg_rl, "%s reply has %"PRIu32" leftover bytes at end",
8212 ofpraw_get_name(raw), msg->size);
8213 return OFPERR_OFPBRC_BAD_LEN;
8215 length = ntohs(ogs11->length);
8216 if (length < sizeof base_len) {
8217 VLOG_WARN_RL(&bad_ofmsg_rl, "%s reply claims invalid length %"PRIuSIZE,
8218 ofpraw_get_name(raw), length);
8219 return OFPERR_OFPBRC_BAD_LEN;
8222 gs->group_id = ntohl(ogs11->group_id);
8223 gs->ref_count = ntohl(ogs11->ref_count);
8224 gs->packet_count = ntohll(ogs11->packet_count);
8225 gs->byte_count = ntohll(ogs11->byte_count);
8227 gs->n_buckets = (length - base_len) / sizeof *obc;
8228 obc = ofpbuf_try_pull(msg, gs->n_buckets * sizeof *obc);
8230 VLOG_WARN_RL(&bad_ofmsg_rl, "%s reply has %"PRIu32" leftover bytes at end",
8231 ofpraw_get_name(raw), msg->size);
8232 return OFPERR_OFPBRC_BAD_LEN;
8235 gs->bucket_stats = xmalloc(gs->n_buckets * sizeof *gs->bucket_stats);
8236 for (i = 0; i < gs->n_buckets; i++) {
8237 gs->bucket_stats[i].packet_count = ntohll(obc[i].packet_count);
8238 gs->bucket_stats[i].byte_count = ntohll(obc[i].byte_count);
8245 ofputil_put_ofp11_bucket(const struct ofputil_bucket *bucket,
8246 struct ofpbuf *openflow, enum ofp_version ofp_version)
8248 struct ofp11_bucket *ob;
8251 start = openflow->size;
8252 ofpbuf_put_zeros(openflow, sizeof *ob);
8253 ofpacts_put_openflow_actions(bucket->ofpacts, bucket->ofpacts_len,
8254 openflow, ofp_version);
8255 ob = ofpbuf_at_assert(openflow, start, sizeof *ob);
8256 ob->len = htons(openflow->size - start);
8257 ob->weight = htons(bucket->weight);
8258 ob->watch_port = ofputil_port_to_ofp11(bucket->watch_port);
8259 ob->watch_group = htonl(bucket->watch_group);
8263 ofputil_put_ofp15_bucket(const struct ofputil_bucket *bucket,
8264 uint32_t bucket_id, enum ofp11_group_type group_type,
8265 struct ofpbuf *openflow, enum ofp_version ofp_version)
8267 struct ofp15_bucket *ob;
8268 size_t start, actions_start, actions_len;
8270 start = openflow->size;
8271 ofpbuf_put_zeros(openflow, sizeof *ob);
8273 actions_start = openflow->size;
8274 ofpacts_put_openflow_actions(bucket->ofpacts, bucket->ofpacts_len,
8275 openflow, ofp_version);
8276 actions_len = openflow->size - actions_start;
8278 if (group_type == OFPGT11_SELECT) {
8279 ofpprop_put_u16(openflow, OFPGBPT15_WEIGHT, bucket->weight);
8281 if (bucket->watch_port != OFPP_ANY) {
8282 ofpprop_put_be32(openflow, OFPGBPT15_WATCH_PORT,
8283 ofputil_port_to_ofp11(bucket->watch_port));
8285 if (bucket->watch_group != OFPG_ANY) {
8286 ofpprop_put_u32(openflow, OFPGBPT15_WATCH_GROUP, bucket->watch_group);
8289 ob = ofpbuf_at_assert(openflow, start, sizeof *ob);
8290 ob->len = htons(openflow->size - start);
8291 ob->action_array_len = htons(actions_len);
8292 ob->bucket_id = htonl(bucket_id);
8296 ofputil_put_group_prop_ntr_selection_method(enum ofp_version ofp_version,
8297 const struct ofputil_group_props *gp,
8298 struct ofpbuf *openflow)
8300 struct ntr_group_prop_selection_method *prop;
8303 start = openflow->size;
8304 ofpbuf_put_zeros(openflow, sizeof *prop);
8305 oxm_put_field_array(openflow, &gp->fields, ofp_version);
8306 prop = ofpbuf_at_assert(openflow, start, sizeof *prop);
8307 prop->type = htons(OFPGPT15_EXPERIMENTER);
8308 prop->experimenter = htonl(NTR_VENDOR_ID);
8309 prop->exp_type = htonl(NTRT_SELECTION_METHOD);
8310 strcpy(prop->selection_method, gp->selection_method);
8311 prop->selection_method_param = htonll(gp->selection_method_param);
8312 ofpprop_end(openflow, start);
8316 ofputil_append_ofp11_group_desc_reply(const struct ofputil_group_desc *gds,
8317 const struct ovs_list *buckets,
8318 struct ovs_list *replies,
8319 enum ofp_version version)
8321 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
8322 struct ofp11_group_desc_stats *ogds;
8323 struct ofputil_bucket *bucket;
8326 start_ogds = reply->size;
8327 ofpbuf_put_zeros(reply, sizeof *ogds);
8328 LIST_FOR_EACH (bucket, list_node, buckets) {
8329 ofputil_put_ofp11_bucket(bucket, reply, version);
8331 ogds = ofpbuf_at_assert(reply, start_ogds, sizeof *ogds);
8332 ogds->length = htons(reply->size - start_ogds);
8333 ogds->type = gds->type;
8334 ogds->group_id = htonl(gds->group_id);
8336 ofpmp_postappend(replies, start_ogds);
8340 ofputil_append_ofp15_group_desc_reply(const struct ofputil_group_desc *gds,
8341 const struct ovs_list *buckets,
8342 struct ovs_list *replies,
8343 enum ofp_version version)
8345 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
8346 struct ofp15_group_desc_stats *ogds;
8347 struct ofputil_bucket *bucket;
8348 size_t start_ogds, start_buckets;
8350 start_ogds = reply->size;
8351 ofpbuf_put_zeros(reply, sizeof *ogds);
8352 start_buckets = reply->size;
8353 LIST_FOR_EACH (bucket, list_node, buckets) {
8354 ofputil_put_ofp15_bucket(bucket, bucket->bucket_id,
8355 gds->type, reply, version);
8357 ogds = ofpbuf_at_assert(reply, start_ogds, sizeof *ogds);
8358 ogds->type = gds->type;
8359 ogds->group_id = htonl(gds->group_id);
8360 ogds->bucket_list_len = htons(reply->size - start_buckets);
8362 /* Add group properties */
8363 if (gds->props.selection_method[0]) {
8364 ofputil_put_group_prop_ntr_selection_method(version, &gds->props,
8367 ogds = ofpbuf_at_assert(reply, start_ogds, sizeof *ogds);
8368 ogds->length = htons(reply->size - start_ogds);
8370 ofpmp_postappend(replies, start_ogds);
8373 /* Appends a group stats reply that contains the data in 'gds' to those already
8374 * present in the list of ofpbufs in 'replies'. 'replies' should have been
8375 * initialized with ofpmp_init(). */
8377 ofputil_append_group_desc_reply(const struct ofputil_group_desc *gds,
8378 const struct ovs_list *buckets,
8379 struct ovs_list *replies)
8381 enum ofp_version version = ofpmp_version(replies);
8389 ofputil_append_ofp11_group_desc_reply(gds, buckets, replies, version);
8393 ofputil_append_ofp15_group_desc_reply(gds, buckets, replies, version);
8403 ofputil_pull_ofp11_buckets(struct ofpbuf *msg, size_t buckets_length,
8404 enum ofp_version version, struct ovs_list *buckets)
8406 struct ofp11_bucket *ob;
8407 uint32_t bucket_id = 0;
8410 while (buckets_length > 0) {
8411 struct ofputil_bucket *bucket;
8412 struct ofpbuf ofpacts;
8416 ob = (buckets_length >= sizeof *ob
8417 ? ofpbuf_try_pull(msg, sizeof *ob)
8420 VLOG_WARN_RL(&bad_ofmsg_rl, "buckets end with %"PRIuSIZE" leftover bytes",
8422 return OFPERR_OFPGMFC_BAD_BUCKET;
8425 ob_len = ntohs(ob->len);
8426 if (ob_len < sizeof *ob) {
8427 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket length "
8428 "%"PRIuSIZE" is not valid", ob_len);
8429 return OFPERR_OFPGMFC_BAD_BUCKET;
8430 } else if (ob_len > buckets_length) {
8431 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket length "
8432 "%"PRIuSIZE" exceeds remaining buckets data size %"PRIuSIZE,
8433 ob_len, buckets_length);
8434 return OFPERR_OFPGMFC_BAD_BUCKET;
8436 buckets_length -= ob_len;
8438 ofpbuf_init(&ofpacts, 0);
8439 error = ofpacts_pull_openflow_actions(msg, ob_len - sizeof *ob,
8442 ofpbuf_uninit(&ofpacts);
8443 ofputil_bucket_list_destroy(buckets);
8447 bucket = xzalloc(sizeof *bucket);
8448 bucket->weight = ntohs(ob->weight);
8449 error = ofputil_port_from_ofp11(ob->watch_port, &bucket->watch_port);
8451 ofpbuf_uninit(&ofpacts);
8452 ofputil_bucket_list_destroy(buckets);
8453 return OFPERR_OFPGMFC_BAD_WATCH;
8455 bucket->watch_group = ntohl(ob->watch_group);
8456 bucket->bucket_id = bucket_id++;
8458 bucket->ofpacts = ofpbuf_steal_data(&ofpacts);
8459 bucket->ofpacts_len = ofpacts.size;
8460 list_push_back(buckets, &bucket->list_node);
8467 ofputil_pull_ofp15_buckets(struct ofpbuf *msg, size_t buckets_length,
8468 enum ofp_version version, uint8_t group_type,
8469 struct ovs_list *buckets)
8471 struct ofp15_bucket *ob;
8474 while (buckets_length > 0) {
8475 struct ofputil_bucket *bucket = NULL;
8476 struct ofpbuf ofpacts;
8477 enum ofperr err = OFPERR_OFPGMFC_BAD_BUCKET;
8478 size_t ob_len, actions_len, properties_len;
8479 ovs_be32 watch_port = ofputil_port_to_ofp11(OFPP_ANY);
8480 ovs_be32 watch_group = htonl(OFPG_ANY);
8481 ovs_be16 weight = htons(group_type == OFPGT11_SELECT ? 1 : 0);
8483 ofpbuf_init(&ofpacts, 0);
8485 ob = ofpbuf_try_pull(msg, sizeof *ob);
8487 VLOG_WARN_RL(&bad_ofmsg_rl, "buckets end with %"PRIuSIZE
8488 " leftover bytes", buckets_length);
8492 ob_len = ntohs(ob->len);
8493 actions_len = ntohs(ob->action_array_len);
8495 if (ob_len < sizeof *ob) {
8496 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket length "
8497 "%"PRIuSIZE" is not valid", ob_len);
8499 } else if (ob_len > buckets_length) {
8500 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket length "
8501 "%"PRIuSIZE" exceeds remaining buckets data size %"
8502 PRIuSIZE, ob_len, buckets_length);
8504 } else if (actions_len > ob_len - sizeof *ob) {
8505 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket actions "
8506 "length %"PRIuSIZE" exceeds remaining bucket "
8507 "data size %"PRIuSIZE, actions_len,
8508 ob_len - sizeof *ob);
8511 buckets_length -= ob_len;
8513 err = ofpacts_pull_openflow_actions(msg, actions_len, version,
8519 properties_len = ob_len - sizeof *ob - actions_len;
8520 struct ofpbuf properties = ofpbuf_const_initializer(
8521 ofpbuf_pull(msg, properties_len), properties_len);
8522 while (properties.size > 0) {
8523 struct ofpbuf payload;
8526 err = ofpprop_pull(&properties, &payload, &type);
8532 case OFPGBPT15_WEIGHT:
8533 err = ofpprop_parse_be16(&payload, &weight);
8536 case OFPGBPT15_WATCH_PORT:
8537 err = ofpprop_parse_be32(&payload, &watch_port);
8540 case OFPGBPT15_WATCH_GROUP:
8541 err = ofpprop_parse_be32(&payload, &watch_group);
8545 err = OFPPROP_UNKNOWN(false, "group bucket", type);
8554 bucket = xzalloc(sizeof *bucket);
8556 bucket->weight = ntohs(weight);
8557 err = ofputil_port_from_ofp11(watch_port, &bucket->watch_port);
8559 err = OFPERR_OFPGMFC_BAD_WATCH;
8562 bucket->watch_group = ntohl(watch_group);
8563 bucket->bucket_id = ntohl(ob->bucket_id);
8564 if (bucket->bucket_id > OFPG15_BUCKET_MAX) {
8565 VLOG_WARN_RL(&bad_ofmsg_rl, "bucket id (%u) is out of range",
8567 err = OFPERR_OFPGMFC_BAD_BUCKET;
8571 bucket->ofpacts = ofpbuf_steal_data(&ofpacts);
8572 bucket->ofpacts_len = ofpacts.size;
8573 list_push_back(buckets, &bucket->list_node);
8579 ofpbuf_uninit(&ofpacts);
8580 ofputil_bucket_list_destroy(buckets);
8584 if (ofputil_bucket_check_duplicate_id(buckets)) {
8585 VLOG_WARN_RL(&bad_ofmsg_rl, "Duplicate bucket id");
8586 ofputil_bucket_list_destroy(buckets);
8587 return OFPERR_OFPGMFC_BAD_BUCKET;
8594 ofputil_init_group_properties(struct ofputil_group_props *gp)
8596 memset(gp, 0, sizeof *gp);
8600 parse_group_prop_ntr_selection_method(struct ofpbuf *payload,
8601 enum ofp11_group_type group_type,
8602 enum ofp15_group_mod_command group_cmd,
8603 struct ofputil_group_props *gp)
8605 struct ntr_group_prop_selection_method *prop = payload->data;
8606 size_t fields_len, method_len;
8609 switch (group_type) {
8610 case OFPGT11_SELECT:
8613 case OFPGT11_INDIRECT:
8615 OFPPROP_LOG(&bad_ofmsg_rl, false, "ntr selection method property is "
8616 "only allowed for select groups");
8617 return OFPERR_OFPBPC_BAD_VALUE;
8622 switch (group_cmd) {
8624 case OFPGC15_MODIFY:
8626 case OFPGC15_DELETE:
8627 case OFPGC15_INSERT_BUCKET:
8628 case OFPGC15_REMOVE_BUCKET:
8629 OFPPROP_LOG(&bad_ofmsg_rl, false, "ntr selection method property is "
8630 "only allowed for add and delete group modifications");
8631 return OFPERR_OFPBPC_BAD_VALUE;
8636 if (payload->size < sizeof *prop) {
8637 OFPPROP_LOG(&bad_ofmsg_rl, false, "ntr selection method property "
8638 "length %u is not valid", payload->size);
8639 return OFPERR_OFPBPC_BAD_LEN;
8642 method_len = strnlen(prop->selection_method, NTR_MAX_SELECTION_METHOD_LEN);
8644 if (method_len == NTR_MAX_SELECTION_METHOD_LEN) {
8645 OFPPROP_LOG(&bad_ofmsg_rl, false,
8646 "ntr selection method is not null terminated");
8647 return OFPERR_OFPBPC_BAD_VALUE;
8650 if (strcmp("hash", prop->selection_method)) {
8651 OFPPROP_LOG(&bad_ofmsg_rl, false,
8652 "ntr selection method '%s' is not supported",
8653 prop->selection_method);
8654 return OFPERR_OFPBPC_BAD_VALUE;
8657 strcpy(gp->selection_method, prop->selection_method);
8658 gp->selection_method_param = ntohll(prop->selection_method_param);
8660 if (!method_len && gp->selection_method_param) {
8661 OFPPROP_LOG(&bad_ofmsg_rl, false, "ntr selection method parameter is "
8662 "non-zero but selection method is empty");
8663 return OFPERR_OFPBPC_BAD_VALUE;
8666 ofpbuf_pull(payload, sizeof *prop);
8668 fields_len = ntohs(prop->length) - sizeof *prop;
8669 if (!method_len && fields_len) {
8670 OFPPROP_LOG(&bad_ofmsg_rl, false, "ntr selection method parameter is "
8671 "zero but fields are provided");
8672 return OFPERR_OFPBPC_BAD_VALUE;
8675 error = oxm_pull_field_array(payload->data, fields_len,
8678 OFPPROP_LOG(&bad_ofmsg_rl, false,
8679 "ntr selection method fields are invalid");
8687 parse_ofp15_group_properties(struct ofpbuf *msg,
8688 enum ofp11_group_type group_type,
8689 enum ofp15_group_mod_command group_cmd,
8690 struct ofputil_group_props *gp,
8691 size_t properties_len)
8693 struct ofpbuf properties = ofpbuf_const_initializer(
8694 ofpbuf_pull(msg, properties_len), properties_len);
8695 while (properties.size > 0) {
8696 struct ofpbuf payload;
8700 error = ofpprop_pull(&properties, &payload, &type);
8706 case OFPPROP_EXP(NTR_VENDOR_ID, NTRT_SELECTION_METHOD):
8707 case OFPPROP_EXP(NTR_COMPAT_VENDOR_ID, NTRT_SELECTION_METHOD):
8708 error = parse_group_prop_ntr_selection_method(&payload, group_type,
8713 error = OFPPROP_UNKNOWN(false, "group", type);
8726 ofputil_decode_ofp11_group_desc_reply(struct ofputil_group_desc *gd,
8728 enum ofp_version version)
8730 struct ofp11_group_desc_stats *ogds;
8734 ofpraw_pull_assert(msg);
8741 ogds = ofpbuf_try_pull(msg, sizeof *ogds);
8743 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply has %"PRIu32" "
8744 "leftover bytes at end", msg->size);
8745 return OFPERR_OFPBRC_BAD_LEN;
8747 gd->type = ogds->type;
8748 gd->group_id = ntohl(ogds->group_id);
8750 length = ntohs(ogds->length);
8751 if (length < sizeof *ogds || length - sizeof *ogds > msg->size) {
8752 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply claims invalid "
8753 "length %"PRIuSIZE, length);
8754 return OFPERR_OFPBRC_BAD_LEN;
8757 return ofputil_pull_ofp11_buckets(msg, length - sizeof *ogds, version,
8762 ofputil_decode_ofp15_group_desc_reply(struct ofputil_group_desc *gd,
8764 enum ofp_version version)
8766 struct ofp15_group_desc_stats *ogds;
8767 uint16_t length, bucket_list_len;
8771 ofpraw_pull_assert(msg);
8778 ogds = ofpbuf_try_pull(msg, sizeof *ogds);
8780 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply has %"PRIu32" "
8781 "leftover bytes at end", msg->size);
8782 return OFPERR_OFPBRC_BAD_LEN;
8784 gd->type = ogds->type;
8785 gd->group_id = ntohl(ogds->group_id);
8787 length = ntohs(ogds->length);
8788 if (length < sizeof *ogds || length - sizeof *ogds > msg->size) {
8789 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply claims invalid "
8790 "length %u", length);
8791 return OFPERR_OFPBRC_BAD_LEN;
8794 bucket_list_len = ntohs(ogds->bucket_list_len);
8795 if (length < bucket_list_len + sizeof *ogds) {
8796 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply claims invalid "
8797 "bucket list length %u", bucket_list_len);
8798 return OFPERR_OFPBRC_BAD_LEN;
8800 error = ofputil_pull_ofp15_buckets(msg, bucket_list_len, version, gd->type,
8806 /* By definition group desc messages don't have a group mod command.
8807 * However, parse_group_prop_ntr_selection_method() checks to make sure
8808 * that the command is OFPGC15_ADD or OFPGC15_DELETE to guard
8809 * against group mod messages with other commands supplying
8810 * a NTR selection method group experimenter property.
8811 * Such properties are valid for group desc replies so
8812 * claim that the group mod command is OFPGC15_ADD to
8813 * satisfy the check in parse_group_prop_ntr_selection_method() */
8814 return parse_ofp15_group_properties(msg, gd->type, OFPGC15_ADD, &gd->props,
8815 length - sizeof *ogds - bucket_list_len);
8818 /* Converts a group description reply in 'msg' into an abstract
8819 * ofputil_group_desc in 'gd'.
8821 * Multiple group description replies can be packed into a single OpenFlow
8822 * message. Calling this function multiple times for a single 'msg' iterates
8823 * through the replies. The caller must initially leave 'msg''s layer pointers
8824 * null and not modify them between calls.
8826 * Returns 0 if successful, EOF if no replies were left in this 'msg',
8827 * otherwise a positive errno value. */
8829 ofputil_decode_group_desc_reply(struct ofputil_group_desc *gd,
8830 struct ofpbuf *msg, enum ofp_version version)
8832 ofputil_init_group_properties(&gd->props);
8840 return ofputil_decode_ofp11_group_desc_reply(gd, msg, version);
8843 return ofputil_decode_ofp15_group_desc_reply(gd, msg, version);
8852 ofputil_uninit_group_mod(struct ofputil_group_mod *gm)
8854 ofputil_bucket_list_destroy(&gm->buckets);
8857 static struct ofpbuf *
8858 ofputil_encode_ofp11_group_mod(enum ofp_version ofp_version,
8859 const struct ofputil_group_mod *gm)
8862 struct ofp11_group_mod *ogm;
8864 struct ofputil_bucket *bucket;
8866 b = ofpraw_alloc(OFPRAW_OFPT11_GROUP_MOD, ofp_version, 0);
8867 start_ogm = b->size;
8868 ofpbuf_put_zeros(b, sizeof *ogm);
8870 LIST_FOR_EACH (bucket, list_node, &gm->buckets) {
8871 ofputil_put_ofp11_bucket(bucket, b, ofp_version);
8873 ogm = ofpbuf_at_assert(b, start_ogm, sizeof *ogm);
8874 ogm->command = htons(gm->command);
8875 ogm->type = gm->type;
8876 ogm->group_id = htonl(gm->group_id);
8881 static struct ofpbuf *
8882 ofputil_encode_ofp15_group_mod(enum ofp_version ofp_version,
8883 const struct ofputil_group_mod *gm)
8886 struct ofp15_group_mod *ogm;
8888 struct ofputil_bucket *bucket;
8889 struct id_pool *bucket_ids = NULL;
8891 b = ofpraw_alloc(OFPRAW_OFPT15_GROUP_MOD, ofp_version, 0);
8892 start_ogm = b->size;
8893 ofpbuf_put_zeros(b, sizeof *ogm);
8895 LIST_FOR_EACH (bucket, list_node, &gm->buckets) {
8898 /* Generate a bucket id if none was supplied */
8899 if (bucket->bucket_id > OFPG15_BUCKET_MAX) {
8901 const struct ofputil_bucket *bkt;
8903 bucket_ids = id_pool_create(0, OFPG15_BUCKET_MAX + 1);
8905 /* Mark all bucket_ids that are present in gm
8906 * as used in the pool. */
8907 LIST_FOR_EACH_REVERSE (bkt, list_node, &gm->buckets) {
8908 if (bkt == bucket) {
8911 if (bkt->bucket_id <= OFPG15_BUCKET_MAX) {
8912 id_pool_add(bucket_ids, bkt->bucket_id);
8917 if (!id_pool_alloc_id(bucket_ids, &bucket_id)) {
8921 bucket_id = bucket->bucket_id;
8924 ofputil_put_ofp15_bucket(bucket, bucket_id, gm->type, b, ofp_version);
8926 ogm = ofpbuf_at_assert(b, start_ogm, sizeof *ogm);
8927 ogm->command = htons(gm->command);
8928 ogm->type = gm->type;
8929 ogm->group_id = htonl(gm->group_id);
8930 ogm->command_bucket_id = htonl(gm->command_bucket_id);
8931 ogm->bucket_array_len = htons(b->size - start_ogm - sizeof *ogm);
8933 /* Add group properties */
8934 if (gm->props.selection_method[0]) {
8935 ofputil_put_group_prop_ntr_selection_method(ofp_version, &gm->props, b);
8938 id_pool_destroy(bucket_ids);
8943 bad_group_cmd(enum ofp15_group_mod_command cmd)
8945 const char *opt_version;
8946 const char *version;
8947 const char *cmd_str;
8951 case OFPGC15_MODIFY:
8952 case OFPGC15_DELETE:
8957 case OFPGC15_INSERT_BUCKET:
8958 case OFPGC15_REMOVE_BUCKET:
8969 cmd_str = "add-group";
8972 case OFPGC15_MODIFY:
8973 cmd_str = "mod-group";
8976 case OFPGC15_DELETE:
8977 cmd_str = "del-group";
8980 case OFPGC15_INSERT_BUCKET:
8981 cmd_str = "insert-bucket";
8984 case OFPGC15_REMOVE_BUCKET:
8985 cmd_str = "remove-bucket";
8992 ovs_fatal(0, "%s needs OpenFlow %s or later (\'-O OpenFlow%s\')",
8993 cmd_str, version, opt_version);
8997 /* Converts abstract group mod 'gm' into a message for OpenFlow version
8998 * 'ofp_version' and returns the message. */
9000 ofputil_encode_group_mod(enum ofp_version ofp_version,
9001 const struct ofputil_group_mod *gm)
9004 switch (ofp_version) {
9006 bad_group_cmd(gm->command);
9012 if (gm->command > OFPGC11_DELETE) {
9013 bad_group_cmd(gm->command);
9015 return ofputil_encode_ofp11_group_mod(ofp_version, gm);
9018 return ofputil_encode_ofp15_group_mod(ofp_version, gm);
9026 ofputil_pull_ofp11_group_mod(struct ofpbuf *msg, enum ofp_version ofp_version,
9027 struct ofputil_group_mod *gm)
9029 const struct ofp11_group_mod *ogm;
9032 ogm = ofpbuf_pull(msg, sizeof *ogm);
9033 gm->command = ntohs(ogm->command);
9034 gm->type = ogm->type;
9035 gm->group_id = ntohl(ogm->group_id);
9036 gm->command_bucket_id = OFPG15_BUCKET_ALL;
9038 error = ofputil_pull_ofp11_buckets(msg, msg->size, ofp_version,
9041 /* OF1.3.5+ prescribes an error when an OFPGC_DELETE includes buckets. */
9043 && ofp_version >= OFP13_VERSION
9044 && gm->command == OFPGC11_DELETE
9045 && !list_is_empty(&gm->buckets)) {
9046 error = OFPERR_OFPGMFC_INVALID_GROUP;
9053 ofputil_pull_ofp15_group_mod(struct ofpbuf *msg, enum ofp_version ofp_version,
9054 struct ofputil_group_mod *gm)
9056 const struct ofp15_group_mod *ogm;
9057 uint16_t bucket_list_len;
9058 enum ofperr error = OFPERR_OFPGMFC_BAD_BUCKET;
9060 ogm = ofpbuf_pull(msg, sizeof *ogm);
9061 gm->command = ntohs(ogm->command);
9062 gm->type = ogm->type;
9063 gm->group_id = ntohl(ogm->group_id);
9065 gm->command_bucket_id = ntohl(ogm->command_bucket_id);
9066 switch (gm->command) {
9067 case OFPGC15_REMOVE_BUCKET:
9068 if (gm->command_bucket_id == OFPG15_BUCKET_ALL) {
9072 case OFPGC15_INSERT_BUCKET:
9073 if (gm->command_bucket_id <= OFPG15_BUCKET_MAX ||
9074 gm->command_bucket_id == OFPG15_BUCKET_FIRST
9075 || gm->command_bucket_id == OFPG15_BUCKET_LAST) {
9081 case OFPGC11_MODIFY:
9082 case OFPGC11_DELETE:
9084 if (gm->command_bucket_id == OFPG15_BUCKET_ALL) {
9090 VLOG_WARN_RL(&bad_ofmsg_rl,
9091 "group command bucket id (%u) is out of range",
9092 gm->command_bucket_id);
9093 return OFPERR_OFPGMFC_BAD_BUCKET;
9096 bucket_list_len = ntohs(ogm->bucket_array_len);
9097 error = ofputil_pull_ofp15_buckets(msg, bucket_list_len, ofp_version,
9098 gm->type, &gm->buckets);
9103 return parse_ofp15_group_properties(msg, gm->type, gm->command, &gm->props,
9107 /* Converts OpenFlow group mod message 'oh' into an abstract group mod in
9108 * 'gm'. Returns 0 if successful, otherwise an OpenFlow error code. */
9110 ofputil_decode_group_mod(const struct ofp_header *oh,
9111 struct ofputil_group_mod *gm)
9113 ofputil_init_group_properties(&gm->props);
9115 enum ofp_version ofp_version = oh->version;
9116 struct ofpbuf msg = ofpbuf_const_initializer(oh, ntohs(oh->length));
9117 ofpraw_pull_assert(&msg);
9120 switch (ofp_version)
9126 err = ofputil_pull_ofp11_group_mod(&msg, ofp_version, gm);
9130 err = ofputil_pull_ofp15_group_mod(&msg, ofp_version, gm);
9142 case OFPGT11_INDIRECT:
9143 if (!list_is_singleton(&gm->buckets)) {
9144 return OFPERR_OFPGMFC_INVALID_GROUP;
9148 case OFPGT11_SELECT:
9152 return OFPERR_OFPGMFC_BAD_TYPE;
9155 switch (gm->command) {
9157 case OFPGC11_MODIFY:
9158 case OFPGC11_DELETE:
9159 case OFPGC15_INSERT_BUCKET:
9161 case OFPGC15_REMOVE_BUCKET:
9162 if (!list_is_empty(&gm->buckets)) {
9163 return OFPERR_OFPGMFC_BAD_BUCKET;
9167 return OFPERR_OFPGMFC_BAD_COMMAND;
9170 struct ofputil_bucket *bucket;
9171 LIST_FOR_EACH (bucket, list_node, &gm->buckets) {
9172 if (bucket->weight && gm->type != OFPGT11_SELECT) {
9173 return OFPERR_OFPGMFC_INVALID_GROUP;
9178 case OFPGT11_INDIRECT:
9179 if (ofputil_bucket_has_liveness(bucket)) {
9180 return OFPERR_OFPGMFC_WATCH_UNSUPPORTED;
9183 case OFPGT11_SELECT:
9186 if (!ofputil_bucket_has_liveness(bucket)) {
9187 return OFPERR_OFPGMFC_INVALID_GROUP;
9191 /* Returning BAD TYPE to be consistent
9192 * though gm->type has been checked already. */
9193 return OFPERR_OFPGMFC_BAD_TYPE;
9200 /* Parse a queue status request message into 'oqsr'.
9201 * Returns 0 if successful, otherwise an OFPERR_* number. */
9203 ofputil_decode_queue_stats_request(const struct ofp_header *request,
9204 struct ofputil_queue_stats_request *oqsr)
9206 switch ((enum ofp_version)request->version) {
9211 case OFP11_VERSION: {
9212 const struct ofp11_queue_stats_request *qsr11 = ofpmsg_body(request);
9213 oqsr->queue_id = ntohl(qsr11->queue_id);
9214 return ofputil_port_from_ofp11(qsr11->port_no, &oqsr->port_no);
9217 case OFP10_VERSION: {
9218 const struct ofp10_queue_stats_request *qsr10 = ofpmsg_body(request);
9219 oqsr->queue_id = ntohl(qsr10->queue_id);
9220 oqsr->port_no = u16_to_ofp(ntohs(qsr10->port_no));
9221 /* OF 1.0 uses OFPP_ALL for OFPP_ANY */
9222 if (oqsr->port_no == OFPP_ALL) {
9223 oqsr->port_no = OFPP_ANY;
9233 /* Encode a queue stats request for 'oqsr', the encoded message
9234 * will be for OpenFlow version 'ofp_version'. Returns message
9235 * as a struct ofpbuf. Returns encoded message on success, NULL on error. */
9237 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
9238 const struct ofputil_queue_stats_request *oqsr)
9240 struct ofpbuf *request;
9242 switch (ofp_version) {
9247 case OFP15_VERSION: {
9248 struct ofp11_queue_stats_request *req;
9249 request = ofpraw_alloc(OFPRAW_OFPST11_QUEUE_REQUEST, ofp_version, 0);
9250 req = ofpbuf_put_zeros(request, sizeof *req);
9251 req->port_no = ofputil_port_to_ofp11(oqsr->port_no);
9252 req->queue_id = htonl(oqsr->queue_id);
9255 case OFP10_VERSION: {
9256 struct ofp10_queue_stats_request *req;
9257 request = ofpraw_alloc(OFPRAW_OFPST10_QUEUE_REQUEST, ofp_version, 0);
9258 req = ofpbuf_put_zeros(request, sizeof *req);
9259 /* OpenFlow 1.0 needs OFPP_ALL instead of OFPP_ANY */
9260 req->port_no = htons(ofp_to_u16(oqsr->port_no == OFPP_ANY
9261 ? OFPP_ALL : oqsr->port_no));
9262 req->queue_id = htonl(oqsr->queue_id);
9272 /* Returns the number of queue stats elements in OFPTYPE_QUEUE_STATS_REPLY
9275 ofputil_count_queue_stats(const struct ofp_header *oh)
9277 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
9278 ofpraw_pull_assert(&b);
9280 for (size_t n = 0; ; n++) {
9281 struct ofputil_queue_stats qs;
9282 if (ofputil_decode_queue_stats(&qs, &b)) {
9289 ofputil_queue_stats_from_ofp10(struct ofputil_queue_stats *oqs,
9290 const struct ofp10_queue_stats *qs10)
9292 oqs->port_no = u16_to_ofp(ntohs(qs10->port_no));
9293 oqs->queue_id = ntohl(qs10->queue_id);
9294 oqs->tx_bytes = ntohll(get_32aligned_be64(&qs10->tx_bytes));
9295 oqs->tx_packets = ntohll(get_32aligned_be64(&qs10->tx_packets));
9296 oqs->tx_errors = ntohll(get_32aligned_be64(&qs10->tx_errors));
9297 oqs->duration_sec = oqs->duration_nsec = UINT32_MAX;
9303 ofputil_queue_stats_from_ofp11(struct ofputil_queue_stats *oqs,
9304 const struct ofp11_queue_stats *qs11)
9308 error = ofputil_port_from_ofp11(qs11->port_no, &oqs->port_no);
9313 oqs->queue_id = ntohl(qs11->queue_id);
9314 oqs->tx_bytes = ntohll(qs11->tx_bytes);
9315 oqs->tx_packets = ntohll(qs11->tx_packets);
9316 oqs->tx_errors = ntohll(qs11->tx_errors);
9317 oqs->duration_sec = oqs->duration_nsec = UINT32_MAX;
9323 ofputil_queue_stats_from_ofp13(struct ofputil_queue_stats *oqs,
9324 const struct ofp13_queue_stats *qs13)
9326 enum ofperr error = ofputil_queue_stats_from_ofp11(oqs, &qs13->qs);
9328 oqs->duration_sec = ntohl(qs13->duration_sec);
9329 oqs->duration_nsec = ntohl(qs13->duration_nsec);
9336 ofputil_pull_ofp14_queue_stats(struct ofputil_queue_stats *oqs,
9339 const struct ofp14_queue_stats *qs14;
9342 qs14 = ofpbuf_try_pull(msg, sizeof *qs14);
9344 return OFPERR_OFPBRC_BAD_LEN;
9347 len = ntohs(qs14->length);
9348 if (len < sizeof *qs14 || len - sizeof *qs14 > msg->size) {
9349 return OFPERR_OFPBRC_BAD_LEN;
9351 ofpbuf_pull(msg, len - sizeof *qs14);
9353 /* No properties yet defined, so ignore them for now. */
9355 return ofputil_queue_stats_from_ofp13(oqs, &qs14->qs);
9358 /* Converts an OFPST_QUEUE_STATS reply in 'msg' into an abstract
9359 * ofputil_queue_stats in 'qs'.
9361 * Multiple OFPST_QUEUE_STATS replies can be packed into a single OpenFlow
9362 * message. Calling this function multiple times for a single 'msg' iterates
9363 * through the replies. The caller must initially leave 'msg''s layer pointers
9364 * null and not modify them between calls.
9366 * Returns 0 if successful, EOF if no replies were left in this 'msg',
9367 * otherwise a positive errno value. */
9369 ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg)
9374 error = (msg->header ? ofpraw_decode(&raw, msg->header)
9375 : ofpraw_pull(&raw, msg));
9382 } else if (raw == OFPRAW_OFPST14_QUEUE_REPLY) {
9383 return ofputil_pull_ofp14_queue_stats(qs, msg);
9384 } else if (raw == OFPRAW_OFPST13_QUEUE_REPLY) {
9385 const struct ofp13_queue_stats *qs13;
9387 qs13 = ofpbuf_try_pull(msg, sizeof *qs13);
9391 return ofputil_queue_stats_from_ofp13(qs, qs13);
9392 } else if (raw == OFPRAW_OFPST11_QUEUE_REPLY) {
9393 const struct ofp11_queue_stats *qs11;
9395 qs11 = ofpbuf_try_pull(msg, sizeof *qs11);
9399 return ofputil_queue_stats_from_ofp11(qs, qs11);
9400 } else if (raw == OFPRAW_OFPST10_QUEUE_REPLY) {
9401 const struct ofp10_queue_stats *qs10;
9403 qs10 = ofpbuf_try_pull(msg, sizeof *qs10);
9407 return ofputil_queue_stats_from_ofp10(qs, qs10);
9413 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_QUEUE reply has %"PRIu32" leftover "
9414 "bytes at end", msg->size);
9415 return OFPERR_OFPBRC_BAD_LEN;
9419 ofputil_queue_stats_to_ofp10(const struct ofputil_queue_stats *oqs,
9420 struct ofp10_queue_stats *qs10)
9422 qs10->port_no = htons(ofp_to_u16(oqs->port_no));
9423 memset(qs10->pad, 0, sizeof qs10->pad);
9424 qs10->queue_id = htonl(oqs->queue_id);
9425 put_32aligned_be64(&qs10->tx_bytes, htonll(oqs->tx_bytes));
9426 put_32aligned_be64(&qs10->tx_packets, htonll(oqs->tx_packets));
9427 put_32aligned_be64(&qs10->tx_errors, htonll(oqs->tx_errors));
9431 ofputil_queue_stats_to_ofp11(const struct ofputil_queue_stats *oqs,
9432 struct ofp11_queue_stats *qs11)
9434 qs11->port_no = ofputil_port_to_ofp11(oqs->port_no);
9435 qs11->queue_id = htonl(oqs->queue_id);
9436 qs11->tx_bytes = htonll(oqs->tx_bytes);
9437 qs11->tx_packets = htonll(oqs->tx_packets);
9438 qs11->tx_errors = htonll(oqs->tx_errors);
9442 ofputil_queue_stats_to_ofp13(const struct ofputil_queue_stats *oqs,
9443 struct ofp13_queue_stats *qs13)
9445 ofputil_queue_stats_to_ofp11(oqs, &qs13->qs);
9446 if (oqs->duration_sec != UINT32_MAX) {
9447 qs13->duration_sec = htonl(oqs->duration_sec);
9448 qs13->duration_nsec = htonl(oqs->duration_nsec);
9450 qs13->duration_sec = OVS_BE32_MAX;
9451 qs13->duration_nsec = OVS_BE32_MAX;
9456 ofputil_queue_stats_to_ofp14(const struct ofputil_queue_stats *oqs,
9457 struct ofp14_queue_stats *qs14)
9459 qs14->length = htons(sizeof *qs14);
9460 memset(qs14->pad, 0, sizeof qs14->pad);
9461 ofputil_queue_stats_to_ofp13(oqs, &qs14->qs);
9465 /* Encode a queue stat for 'oqs' and append it to 'replies'. */
9467 ofputil_append_queue_stat(struct ovs_list *replies,
9468 const struct ofputil_queue_stats *oqs)
9470 switch (ofpmp_version(replies)) {
9471 case OFP13_VERSION: {
9472 struct ofp13_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
9473 ofputil_queue_stats_to_ofp13(oqs, reply);
9478 case OFP11_VERSION: {
9479 struct ofp11_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
9480 ofputil_queue_stats_to_ofp11(oqs, reply);
9484 case OFP10_VERSION: {
9485 struct ofp10_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
9486 ofputil_queue_stats_to_ofp10(oqs, reply);
9491 case OFP15_VERSION: {
9492 struct ofp14_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
9493 ofputil_queue_stats_to_ofp14(oqs, reply);
9503 ofputil_decode_bundle_ctrl(const struct ofp_header *oh,
9504 struct ofputil_bundle_ctrl_msg *msg)
9506 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
9507 enum ofpraw raw = ofpraw_pull_assert(&b);
9508 ovs_assert(raw == OFPRAW_OFPT14_BUNDLE_CONTROL
9509 || raw == OFPRAW_ONFT13_BUNDLE_CONTROL);
9511 const struct ofp14_bundle_ctrl_msg *m = b.msg;
9512 msg->bundle_id = ntohl(m->bundle_id);
9513 msg->type = ntohs(m->type);
9514 msg->flags = ntohs(m->flags);
9520 ofputil_encode_bundle_ctrl_request(enum ofp_version ofp_version,
9521 struct ofputil_bundle_ctrl_msg *bc)
9523 struct ofpbuf *request;
9524 struct ofp14_bundle_ctrl_msg *m;
9526 switch (ofp_version) {
9530 ovs_fatal(0, "bundles need OpenFlow 1.3 or later "
9531 "(\'-O OpenFlow14\')");
9535 request = ofpraw_alloc(ofp_version == OFP13_VERSION
9536 ? OFPRAW_ONFT13_BUNDLE_CONTROL
9537 : OFPRAW_OFPT14_BUNDLE_CONTROL, ofp_version, 0);
9538 m = ofpbuf_put_zeros(request, sizeof *m);
9540 m->bundle_id = htonl(bc->bundle_id);
9541 m->type = htons(bc->type);
9542 m->flags = htons(bc->flags);
9552 ofputil_encode_bundle_ctrl_reply(const struct ofp_header *oh,
9553 struct ofputil_bundle_ctrl_msg *msg)
9556 struct ofp14_bundle_ctrl_msg *m;
9558 buf = ofpraw_alloc_reply(oh->version == OFP13_VERSION
9559 ? OFPRAW_ONFT13_BUNDLE_CONTROL
9560 : OFPRAW_OFPT14_BUNDLE_CONTROL, oh, 0);
9561 m = ofpbuf_put_zeros(buf, sizeof *m);
9563 m->bundle_id = htonl(msg->bundle_id);
9564 m->type = htons(msg->type);
9565 m->flags = htons(msg->flags);
9570 /* Return true for bundlable state change requests, false for other messages.
9573 ofputil_is_bundlable(enum ofptype type)
9576 /* Minimum required by OpenFlow 1.4. */
9577 case OFPTYPE_PORT_MOD:
9578 case OFPTYPE_FLOW_MOD:
9581 /* Nice to have later. */
9582 case OFPTYPE_FLOW_MOD_TABLE_ID:
9583 case OFPTYPE_GROUP_MOD:
9584 case OFPTYPE_TABLE_MOD:
9585 case OFPTYPE_METER_MOD:
9586 case OFPTYPE_PACKET_OUT:
9587 case OFPTYPE_NXT_TLV_TABLE_MOD:
9589 /* Not to be bundlable. */
9590 case OFPTYPE_ECHO_REQUEST:
9591 case OFPTYPE_FEATURES_REQUEST:
9592 case OFPTYPE_GET_CONFIG_REQUEST:
9593 case OFPTYPE_SET_CONFIG:
9594 case OFPTYPE_BARRIER_REQUEST:
9595 case OFPTYPE_ROLE_REQUEST:
9596 case OFPTYPE_ECHO_REPLY:
9597 case OFPTYPE_SET_FLOW_FORMAT:
9598 case OFPTYPE_SET_PACKET_IN_FORMAT:
9599 case OFPTYPE_SET_CONTROLLER_ID:
9600 case OFPTYPE_FLOW_AGE:
9601 case OFPTYPE_FLOW_MONITOR_CANCEL:
9602 case OFPTYPE_SET_ASYNC_CONFIG:
9603 case OFPTYPE_GET_ASYNC_REQUEST:
9604 case OFPTYPE_DESC_STATS_REQUEST:
9605 case OFPTYPE_FLOW_STATS_REQUEST:
9606 case OFPTYPE_AGGREGATE_STATS_REQUEST:
9607 case OFPTYPE_TABLE_STATS_REQUEST:
9608 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
9609 case OFPTYPE_TABLE_DESC_REQUEST:
9610 case OFPTYPE_PORT_STATS_REQUEST:
9611 case OFPTYPE_QUEUE_STATS_REQUEST:
9612 case OFPTYPE_PORT_DESC_STATS_REQUEST:
9613 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
9614 case OFPTYPE_METER_STATS_REQUEST:
9615 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
9616 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
9617 case OFPTYPE_GROUP_STATS_REQUEST:
9618 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
9619 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
9620 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
9621 case OFPTYPE_BUNDLE_CONTROL:
9622 case OFPTYPE_BUNDLE_ADD_MESSAGE:
9625 case OFPTYPE_FEATURES_REPLY:
9626 case OFPTYPE_GET_CONFIG_REPLY:
9627 case OFPTYPE_PACKET_IN:
9628 case OFPTYPE_FLOW_REMOVED:
9629 case OFPTYPE_PORT_STATUS:
9630 case OFPTYPE_BARRIER_REPLY:
9631 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
9632 case OFPTYPE_DESC_STATS_REPLY:
9633 case OFPTYPE_FLOW_STATS_REPLY:
9634 case OFPTYPE_QUEUE_STATS_REPLY:
9635 case OFPTYPE_PORT_STATS_REPLY:
9636 case OFPTYPE_TABLE_STATS_REPLY:
9637 case OFPTYPE_AGGREGATE_STATS_REPLY:
9638 case OFPTYPE_PORT_DESC_STATS_REPLY:
9639 case OFPTYPE_ROLE_REPLY:
9640 case OFPTYPE_FLOW_MONITOR_PAUSED:
9641 case OFPTYPE_FLOW_MONITOR_RESUMED:
9642 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
9643 case OFPTYPE_GET_ASYNC_REPLY:
9644 case OFPTYPE_GROUP_STATS_REPLY:
9645 case OFPTYPE_GROUP_DESC_STATS_REPLY:
9646 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
9647 case OFPTYPE_METER_STATS_REPLY:
9648 case OFPTYPE_METER_CONFIG_STATS_REPLY:
9649 case OFPTYPE_METER_FEATURES_STATS_REPLY:
9650 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
9651 case OFPTYPE_TABLE_DESC_REPLY:
9652 case OFPTYPE_ROLE_STATUS:
9653 case OFPTYPE_REQUESTFORWARD:
9654 case OFPTYPE_TABLE_STATUS:
9655 case OFPTYPE_NXT_TLV_TABLE_REQUEST:
9656 case OFPTYPE_NXT_TLV_TABLE_REPLY:
9657 case OFPTYPE_NXT_RESUME:
9665 ofputil_decode_bundle_add(const struct ofp_header *oh,
9666 struct ofputil_bundle_add_msg *msg,
9667 enum ofptype *typep)
9669 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
9670 enum ofpraw raw = ofpraw_pull_assert(&b);
9671 ovs_assert(raw == OFPRAW_OFPT14_BUNDLE_ADD_MESSAGE
9672 || raw == OFPRAW_ONFT13_BUNDLE_ADD_MESSAGE);
9674 const struct ofp14_bundle_ctrl_msg *m = ofpbuf_pull(&b, sizeof *m);
9675 msg->bundle_id = ntohl(m->bundle_id);
9676 msg->flags = ntohs(m->flags);
9679 if (msg->msg->version != oh->version) {
9680 return OFPERR_NXBFC_BAD_VERSION;
9682 size_t inner_len = ntohs(msg->msg->length);
9683 if (inner_len < sizeof(struct ofp_header) || inner_len > b.size) {
9684 return OFPERR_OFPBFC_MSG_BAD_LEN;
9686 if (msg->msg->xid != oh->xid) {
9687 return OFPERR_OFPBFC_MSG_BAD_XID;
9690 /* Reject unbundlable messages. */
9692 enum ofperr error = ofptype_decode(&type, msg->msg);
9694 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPT14_BUNDLE_ADD_MESSAGE contained "
9695 "message is unparsable (%s)", ofperr_get_name(error));
9696 return OFPERR_OFPBFC_MSG_UNSUP; /* 'error' would be confusing. */
9699 if (!ofputil_is_bundlable(type)) {
9700 VLOG_WARN_RL(&bad_ofmsg_rl, "%s message not allowed inside "
9701 "OFPT14_BUNDLE_ADD_MESSAGE", ofptype_get_name(type));
9702 return OFPERR_OFPBFC_MSG_UNSUP;
9712 ofputil_encode_bundle_add(enum ofp_version ofp_version,
9713 struct ofputil_bundle_add_msg *msg)
9715 struct ofpbuf *request;
9716 struct ofp14_bundle_ctrl_msg *m;
9718 /* Must use the same xid as the embedded message. */
9719 request = ofpraw_alloc_xid(ofp_version == OFP13_VERSION
9720 ? OFPRAW_ONFT13_BUNDLE_ADD_MESSAGE
9721 : OFPRAW_OFPT14_BUNDLE_ADD_MESSAGE, ofp_version,
9723 m = ofpbuf_put_zeros(request, sizeof *m);
9725 m->bundle_id = htonl(msg->bundle_id);
9726 m->flags = htons(msg->flags);
9727 ofpbuf_put(request, msg->msg, ntohs(msg->msg->length));
9733 encode_tlv_table_mappings(struct ofpbuf *b, struct ovs_list *mappings)
9735 struct ofputil_tlv_map *map;
9737 LIST_FOR_EACH (map, list_node, mappings) {
9738 struct nx_tlv_map *nx_map;
9740 nx_map = ofpbuf_put_zeros(b, sizeof *nx_map);
9741 nx_map->option_class = htons(map->option_class);
9742 nx_map->option_type = map->option_type;
9743 nx_map->option_len = map->option_len;
9744 nx_map->index = htons(map->index);
9749 ofputil_encode_tlv_table_mod(enum ofp_version ofp_version,
9750 struct ofputil_tlv_table_mod *ttm)
9753 struct nx_tlv_table_mod *nx_ttm;
9755 b = ofpraw_alloc(OFPRAW_NXT_TLV_TABLE_MOD, ofp_version, 0);
9756 nx_ttm = ofpbuf_put_zeros(b, sizeof *nx_ttm);
9757 nx_ttm->command = htons(ttm->command);
9758 encode_tlv_table_mappings(b, &ttm->mappings);
9764 decode_tlv_table_mappings(struct ofpbuf *msg, unsigned int max_fields,
9765 struct ovs_list *mappings)
9767 list_init(mappings);
9770 struct nx_tlv_map *nx_map;
9771 struct ofputil_tlv_map *map;
9773 nx_map = ofpbuf_pull(msg, sizeof *nx_map);
9774 map = xmalloc(sizeof *map);
9775 list_push_back(mappings, &map->list_node);
9777 map->option_class = ntohs(nx_map->option_class);
9778 map->option_type = nx_map->option_type;
9780 map->option_len = nx_map->option_len;
9781 if (map->option_len % 4 || map->option_len > TLV_MAX_OPT_SIZE) {
9782 VLOG_WARN_RL(&bad_ofmsg_rl,
9783 "tlv table option length (%u) is not a valid option size",
9785 ofputil_uninit_tlv_table(mappings);
9786 return OFPERR_NXTTMFC_BAD_OPT_LEN;
9789 map->index = ntohs(nx_map->index);
9790 if (map->index >= max_fields) {
9791 VLOG_WARN_RL(&bad_ofmsg_rl,
9792 "tlv table field index (%u) is too large (max %u)",
9793 map->index, max_fields - 1);
9794 ofputil_uninit_tlv_table(mappings);
9795 return OFPERR_NXTTMFC_BAD_FIELD_IDX;
9803 ofputil_decode_tlv_table_mod(const struct ofp_header *oh,
9804 struct ofputil_tlv_table_mod *ttm)
9806 struct ofpbuf msg = ofpbuf_const_initializer(oh, ntohs(oh->length));
9807 ofpraw_pull_assert(&msg);
9809 struct nx_tlv_table_mod *nx_ttm = ofpbuf_pull(&msg, sizeof *nx_ttm);
9810 ttm->command = ntohs(nx_ttm->command);
9811 if (ttm->command > NXTTMC_CLEAR) {
9812 VLOG_WARN_RL(&bad_ofmsg_rl,
9813 "tlv table mod command (%u) is out of range",
9815 return OFPERR_NXTTMFC_BAD_COMMAND;
9818 return decode_tlv_table_mappings(&msg, TUN_METADATA_NUM_OPTS,
9823 ofputil_encode_tlv_table_reply(const struct ofp_header *oh,
9824 struct ofputil_tlv_table_reply *ttr)
9827 struct nx_tlv_table_reply *nx_ttr;
9829 b = ofpraw_alloc_reply(OFPRAW_NXT_TLV_TABLE_REPLY, oh, 0);
9830 nx_ttr = ofpbuf_put_zeros(b, sizeof *nx_ttr);
9831 nx_ttr->max_option_space = htonl(ttr->max_option_space);
9832 nx_ttr->max_fields = htons(ttr->max_fields);
9834 encode_tlv_table_mappings(b, &ttr->mappings);
9839 /* Decodes the NXT_TLV_TABLE_REPLY message in 'oh' into '*ttr'. Returns 0
9840 * if successful, otherwise an ofperr.
9842 * The decoder verifies that the indexes in 'ttr->mappings' are less than
9843 * 'ttr->max_fields', but the caller must ensure, if necessary, that they are
9844 * less than TUN_METADATA_NUM_OPTS. */
9846 ofputil_decode_tlv_table_reply(const struct ofp_header *oh,
9847 struct ofputil_tlv_table_reply *ttr)
9849 struct ofpbuf msg = ofpbuf_const_initializer(oh, ntohs(oh->length));
9850 ofpraw_pull_assert(&msg);
9852 struct nx_tlv_table_reply *nx_ttr = ofpbuf_pull(&msg, sizeof *nx_ttr);
9853 ttr->max_option_space = ntohl(nx_ttr->max_option_space);
9854 ttr->max_fields = ntohs(nx_ttr->max_fields);
9856 return decode_tlv_table_mappings(&msg, ttr->max_fields, &ttr->mappings);
9860 ofputil_uninit_tlv_table(struct ovs_list *mappings)
9862 struct ofputil_tlv_map *map;
9864 LIST_FOR_EACH_POP (map, list_node, mappings) {
9870 ofputil_async_msg_type_to_string(enum ofputil_async_msg_type type)
9873 case OAM_PACKET_IN: return "PACKET_IN";
9874 case OAM_PORT_STATUS: return "PORT_STATUS";
9875 case OAM_FLOW_REMOVED: return "FLOW_REMOVED";
9876 case OAM_ROLE_STATUS: return "ROLE_STATUS";
9877 case OAM_TABLE_STATUS: return "TABLE_STATUS";
9878 case OAM_REQUESTFORWARD: return "REQUESTFORWARD";
9886 struct ofp14_async_prop {
9888 enum ofputil_async_msg_type oam;
9890 uint32_t allowed10, allowed14;
9893 #define AP_PAIR(SLAVE_PROP_TYPE, OAM, A10, A14) \
9894 { SLAVE_PROP_TYPE, OAM, false, A10, (A14) ? (A14) : (A10) }, \
9895 { (SLAVE_PROP_TYPE + 1), OAM, true, A10, (A14) ? (A14) : (A10) }
9897 static const struct ofp14_async_prop async_props[] = {
9898 AP_PAIR( 0, OAM_PACKET_IN, OFPR10_BITS, OFPR14_BITS),
9899 AP_PAIR( 2, OAM_PORT_STATUS, (1 << OFPPR_N_REASONS) - 1, 0),
9900 AP_PAIR( 4, OAM_FLOW_REMOVED, (1 << OVS_OFPRR_NONE) - 1, 0),
9901 AP_PAIR( 6, OAM_ROLE_STATUS, (1 << OFPCRR_N_REASONS) - 1, 0),
9902 AP_PAIR( 8, OAM_TABLE_STATUS, OFPTR_BITS, 0),
9903 AP_PAIR(10, OAM_REQUESTFORWARD, (1 << OFPRFR_N_REASONS) - 1, 0),
9906 #define FOR_EACH_ASYNC_PROP(VAR) \
9907 for (const struct ofp14_async_prop *VAR = async_props; \
9908 VAR < &async_props[ARRAY_SIZE(async_props)]; VAR++)
9910 static const struct ofp14_async_prop *
9911 get_ofp14_async_config_prop_by_prop_type(uint64_t prop_type)
9913 FOR_EACH_ASYNC_PROP (ap) {
9914 if (prop_type == ap->prop_type) {
9921 static const struct ofp14_async_prop *
9922 get_ofp14_async_config_prop_by_oam(enum ofputil_async_msg_type oam,
9925 FOR_EACH_ASYNC_PROP (ap) {
9926 if (ap->oam == oam && ap->master == master) {
9934 ofp14_async_prop_allowed(const struct ofp14_async_prop *prop,
9935 enum ofp_version version)
9937 return version >= OFP14_VERSION ? prop->allowed14 : prop->allowed10;
9941 encode_async_mask(const struct ofputil_async_cfg *src,
9942 const struct ofp14_async_prop *ap,
9943 enum ofp_version version)
9945 uint32_t mask = ap->master ? src->master[ap->oam] : src->slave[ap->oam];
9946 return htonl(mask & ofp14_async_prop_allowed(ap, version));
9950 decode_async_mask(ovs_be32 src,
9951 const struct ofp14_async_prop *ap, enum ofp_version version,
9952 bool loose, struct ofputil_async_cfg *dst)
9954 uint32_t mask = ntohl(src);
9955 uint32_t allowed = ofp14_async_prop_allowed(ap, version);
9956 if (mask & ~allowed) {
9957 OFPPROP_LOG(&bad_ofmsg_rl, loose,
9958 "bad value %#x for %s (allowed mask %#x)",
9959 mask, ofputil_async_msg_type_to_string(ap->oam),
9963 return OFPERR_OFPACFC_INVALID;
9967 if (ap->oam == OAM_PACKET_IN) {
9968 if (mask & (1u << OFPR_NO_MATCH)) {
9969 mask |= 1u << OFPR_EXPLICIT_MISS;
9970 if (version < OFP13_VERSION) {
9971 mask |= 1u << OFPR_IMPLICIT_MISS;
9976 uint32_t *array = ap->master ? dst->master : dst->slave;
9977 array[ap->oam] = mask;
9982 parse_async_tlv(const struct ofpbuf *property,
9983 const struct ofp14_async_prop *ap,
9984 struct ofputil_async_cfg *ac,
9985 enum ofp_version version, bool loose)
9990 error = ofpprop_parse_be32(property, &mask);
9995 if (ofpprop_is_experimenter(ap->prop_type)) {
9996 /* For experimenter properties, whether a property is for the master or
9997 * slave role is indicated by both 'type' and 'exp_type' in struct
9998 * ofp_prop_experimenter. Check that these are consistent. */
9999 const struct ofp_prop_experimenter *ope = property->data;
10000 bool should_be_master = ope->type == htons(0xffff);
10001 if (should_be_master != ap->master) {
10002 VLOG_WARN_RL(&bad_ofmsg_rl, "async property type %#"PRIx16" "
10003 "indicates %s role but exp_type %"PRIu32" indicates "
10006 should_be_master ? "master" : "slave",
10007 ntohl(ope->exp_type),
10008 ap->master ? "master" : "slave");
10009 return OFPERR_OFPBPC_BAD_EXP_TYPE;
10013 return decode_async_mask(mask, ap, version, loose, ac);
10017 decode_legacy_async_masks(const ovs_be32 masks[2],
10018 enum ofputil_async_msg_type oam,
10019 enum ofp_version version,
10020 struct ofputil_async_cfg *dst)
10022 for (int i = 0; i < 2; i++) {
10023 bool master = i == 0;
10024 const struct ofp14_async_prop *ap
10025 = get_ofp14_async_config_prop_by_oam(oam, master);
10026 decode_async_mask(masks[i], ap, version, true, dst);
10030 /* Decodes the OpenFlow "set async config" request and "get async config
10031 * reply" message in '*oh' into an abstract form in 'ac'.
10033 * Some versions of the "set async config" request change only some of the
10034 * settings and leave the others alone. This function uses 'basis' as the
10035 * initial state for decoding these. Other versions of the request change all
10036 * the settings; this function ignores 'basis' when decoding these.
10038 * If 'loose' is true, this function ignores properties and values that it does
10039 * not understand, as a controller would want to do when interpreting
10040 * capabilities provided by a switch. If 'loose' is false, this function
10041 * treats unknown properties and values as an error, as a switch would want to
10042 * do when interpreting a configuration request made by a controller.
10044 * Returns 0 if successful, otherwise an OFPERR_* value.
10046 * Returns error code OFPERR_OFPACFC_INVALID if the value of mask is not in
10047 * the valid range of mask.
10049 * Returns error code OFPERR_OFPACFC_UNSUPPORTED if the configuration is not
10052 ofputil_decode_set_async_config(const struct ofp_header *oh, bool loose,
10053 const struct ofputil_async_cfg *basis,
10054 struct ofputil_async_cfg *ac)
10056 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
10057 enum ofpraw raw = ofpraw_pull_assert(&b);
10059 if (raw == OFPRAW_OFPT13_SET_ASYNC ||
10060 raw == OFPRAW_NXT_SET_ASYNC_CONFIG ||
10061 raw == OFPRAW_OFPT13_GET_ASYNC_REPLY) {
10062 const struct nx_async_config *msg = ofpmsg_body(oh);
10064 *ac = OFPUTIL_ASYNC_CFG_INIT;
10065 decode_legacy_async_masks(msg->packet_in_mask, OAM_PACKET_IN,
10067 decode_legacy_async_masks(msg->port_status_mask, OAM_PORT_STATUS,
10069 decode_legacy_async_masks(msg->flow_removed_mask, OAM_FLOW_REMOVED,
10071 } else if (raw == OFPRAW_OFPT14_SET_ASYNC ||
10072 raw == OFPRAW_OFPT14_GET_ASYNC_REPLY ||
10073 raw == OFPRAW_NXT_SET_ASYNC_CONFIG2) {
10075 while (b.size > 0) {
10076 struct ofpbuf property;
10080 error = ofpprop_pull__(&b, &property, 8, 0xfffe, &type);
10085 const struct ofp14_async_prop *ap
10086 = get_ofp14_async_config_prop_by_prop_type(type);
10088 ? parse_async_tlv(&property, ap, ac, oh->version, loose)
10089 : OFPPROP_UNKNOWN(loose, "async config", type));
10091 /* Most messages use OFPBPC_BAD_TYPE but async has its own (who
10092 * knows why, it's OpenFlow. */
10093 if (error == OFPERR_OFPBPC_BAD_TYPE) {
10094 error = OFPERR_OFPACFC_UNSUPPORTED;
10100 return OFPERR_OFPBRC_BAD_VERSION;
10106 encode_legacy_async_masks(const struct ofputil_async_cfg *ac,
10107 enum ofputil_async_msg_type oam,
10108 enum ofp_version version,
10111 for (int i = 0; i < 2; i++) {
10112 bool master = i == 0;
10113 const struct ofp14_async_prop *ap
10114 = get_ofp14_async_config_prop_by_oam(oam, master);
10115 masks[i] = encode_async_mask(ac, ap, version);
10120 ofputil_put_async_config__(const struct ofputil_async_cfg *ac,
10121 struct ofpbuf *buf, bool tlv,
10122 enum ofp_version version, uint32_t oams)
10125 struct nx_async_config *msg = ofpbuf_put_zeros(buf, sizeof *msg);
10126 encode_legacy_async_masks(ac, OAM_PACKET_IN, version,
10127 msg->packet_in_mask);
10128 encode_legacy_async_masks(ac, OAM_PORT_STATUS, version,
10129 msg->port_status_mask);
10130 encode_legacy_async_masks(ac, OAM_FLOW_REMOVED, version,
10131 msg->flow_removed_mask);
10133 FOR_EACH_ASYNC_PROP (ap) {
10134 if (oams & (1u << ap->oam)) {
10135 size_t ofs = buf->size;
10136 ofpprop_put_be32(buf, ap->prop_type,
10137 encode_async_mask(ac, ap, version));
10139 /* For experimenter properties, we need to use type 0xfffe for
10140 * master and 0xffff for slaves. */
10141 if (ofpprop_is_experimenter(ap->prop_type)) {
10142 struct ofp_prop_experimenter *ope
10143 = ofpbuf_at_assert(buf, ofs, sizeof *ope);
10144 ope->type = ap->master ? htons(0xffff) : htons(0xfffe);
10151 /* Encodes and returns a reply to the OFPT_GET_ASYNC_REQUEST in 'oh' that
10152 * states that the asynchronous message configuration is 'ac'. */
10154 ofputil_encode_get_async_reply(const struct ofp_header *oh,
10155 const struct ofputil_async_cfg *ac)
10157 struct ofpbuf *buf;
10159 enum ofpraw raw = (oh->version < OFP14_VERSION
10160 ? OFPRAW_OFPT13_GET_ASYNC_REPLY
10161 : OFPRAW_OFPT14_GET_ASYNC_REPLY);
10162 struct ofpbuf *reply = ofpraw_alloc_reply(raw, oh, 0);
10163 ofputil_put_async_config__(ac, reply,
10164 raw == OFPRAW_OFPT14_GET_ASYNC_REPLY,
10165 oh->version, UINT32_MAX);
10171 /* Encodes and returns a message, in a format appropriate for OpenFlow version
10172 * 'ofp_version', that sets the asynchronous message configuration to 'ac'.
10174 * Specify 'oams' as a bitmap of OAM_* that indicate the asynchronous messages
10175 * to configure. OF1.0 through OF1.3 can't natively configure a subset of
10176 * messages, so more messages than requested may be configured. OF1.0 through
10177 * OF1.3 also can't configure OVS extension OAM_* values, so if 'oam' includes
10178 * any extensions then this function encodes an Open vSwitch extension message
10179 * that does support configuring OVS extension OAM_*. */
10181 ofputil_encode_set_async_config(const struct ofputil_async_cfg *ac,
10182 uint32_t oams, enum ofp_version ofp_version)
10184 enum ofpraw raw = (ofp_version >= OFP14_VERSION ? OFPRAW_OFPT14_SET_ASYNC
10185 : oams & OAM_EXTENSIONS ? OFPRAW_NXT_SET_ASYNC_CONFIG2
10186 : ofp_version >= OFP13_VERSION ? OFPRAW_OFPT13_SET_ASYNC
10187 : OFPRAW_NXT_SET_ASYNC_CONFIG);
10188 struct ofpbuf *request = ofpraw_alloc(raw, ofp_version, 0);
10189 ofputil_put_async_config__(ac, request,
10190 (raw == OFPRAW_OFPT14_SET_ASYNC ||
10191 raw == OFPRAW_NXT_SET_ASYNC_CONFIG2),
10192 ofp_version, oams);
10196 struct ofputil_async_cfg
10197 ofputil_async_cfg_default(enum ofp_version version)
10199 /* We enable all of the OF1.4 reasons regardless of 'version' because the
10200 * reasons added in OF1.4 just are just refinements of the OFPR_ACTION
10201 * introduced in OF1.0, breaking it into more specific categories. When we
10202 * encode these for earlier OpenFlow versions, we translate them into
10204 uint32_t pin = OFPR14_BITS & ~(1u << OFPR_INVALID_TTL);
10205 pin |= 1u << OFPR_EXPLICIT_MISS;
10206 if (version <= OFP12_VERSION) {
10207 pin |= 1u << OFPR_IMPLICIT_MISS;
10210 return (struct ofputil_async_cfg) {
10211 .master[OAM_PACKET_IN] = pin,
10213 .master[OAM_FLOW_REMOVED]
10214 = (version >= OFP14_VERSION ? OFPRR14_BITS : OFPRR10_BITS),
10216 .master[OAM_PORT_STATUS] = OFPPR_BITS,
10217 .slave[OAM_PORT_STATUS] = OFPPR_BITS,
10222 ofputil_put_ofp14_table_desc(const struct ofputil_table_desc *td,
10223 struct ofpbuf *b, enum ofp_version version)
10225 struct ofp14_table_desc *otd;
10226 struct ofp14_table_mod_prop_vacancy *otv;
10229 start_otd = b->size;
10230 ofpbuf_put_zeros(b, sizeof *otd);
10232 ofpprop_put_u32(b, OFPTMPT14_EVICTION, td->eviction_flags);
10234 otv = ofpbuf_put_zeros(b, sizeof *otv);
10235 otv->type = htons(OFPTMPT14_VACANCY);
10236 otv->length = htons(sizeof *otv);
10237 otv->vacancy_down = td->table_vacancy.vacancy_down;
10238 otv->vacancy_up = td->table_vacancy.vacancy_up;
10239 otv->vacancy = td->table_vacancy.vacancy;
10241 otd = ofpbuf_at_assert(b, start_otd, sizeof *otd);
10242 otd->length = htons(b->size - start_otd);
10243 otd->table_id = td->table_id;
10244 otd->config = ofputil_encode_table_config(OFPUTIL_TABLE_MISS_DEFAULT,
10245 td->eviction, td->vacancy,
10249 /* Converts the abstract form of a "table status" message in '*ts' into an
10250 * OpenFlow message suitable for 'protocol', and returns that encoded form in
10251 * a buffer owned by the caller. */
10253 ofputil_encode_table_status(const struct ofputil_table_status *ts,
10254 enum ofputil_protocol protocol)
10256 enum ofp_version version;
10259 version = ofputil_protocol_to_ofp_version(protocol);
10260 if (version >= OFP14_VERSION) {
10262 struct ofp14_table_status *ots;
10264 raw = OFPRAW_OFPT14_TABLE_STATUS;
10265 b = ofpraw_alloc_xid(raw, version, htonl(0), 0);
10266 ots = ofpbuf_put_zeros(b, sizeof *ots);
10267 ots->reason = ts->reason;
10268 ofputil_put_ofp14_table_desc(&ts->desc, b, version);
10269 ofpmsg_update_length(b);
10276 /* Decodes the OpenFlow "table status" message in '*ots' into an abstract form
10277 * in '*ts'. Returns 0 if successful, otherwise an OFPERR_* value. */
10279 ofputil_decode_table_status(const struct ofp_header *oh,
10280 struct ofputil_table_status *ts)
10282 const struct ofp14_table_status *ots;
10287 ofpbuf_use_const(&b, oh, ntohs(oh->length));
10288 raw = ofpraw_pull_assert(&b);
10289 ots = ofpbuf_pull(&b, sizeof *ots);
10291 if (raw == OFPRAW_OFPT14_TABLE_STATUS) {
10292 if (ots->reason != OFPTR_VACANCY_DOWN
10293 && ots->reason != OFPTR_VACANCY_UP) {
10294 return OFPERR_OFPBPC_BAD_VALUE;
10296 ts->reason = ots->reason;
10298 error = ofputil_decode_table_desc(&b, &ts->desc, oh->version);
10301 return OFPERR_OFPBRC_BAD_VERSION;