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.
21 #include <sys/types.h>
22 #include <netinet/in.h>
23 #include <netinet/icmp6.h>
27 #include "byte-order.h"
28 #include "classifier.h"
30 #include "multipath.h"
34 #include "openflow/netronome-ext.h"
35 #include "openvswitch/dynamic-string.h"
36 #include "openvswitch/meta-flow.h"
37 #include "openvswitch/ofp-actions.h"
38 #include "openvswitch/ofp-errors.h"
39 #include "openvswitch/ofp-msgs.h"
40 #include "openvswitch/ofp-print.h"
41 #include "openvswitch/ofp-prop.h"
42 #include "openvswitch/ofp-util.h"
43 #include "openvswitch/ofpbuf.h"
44 #include "openvswitch/type-props.h"
45 #include "openvswitch/vlog.h"
46 #include "openflow/intel-ext.h"
50 #include "tun-metadata.h"
51 #include "unaligned.h"
54 VLOG_DEFINE_THIS_MODULE(ofp_util);
56 /* Rate limit for OpenFlow message parse errors. These always indicate a bug
57 * in the peer and so there's not much point in showing a lot of them. */
58 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
60 static enum ofputil_table_vacancy ofputil_decode_table_vacancy(
61 ovs_be32 config, enum ofp_version);
62 static enum ofputil_table_eviction ofputil_decode_table_eviction(
63 ovs_be32 config, enum ofp_version);
64 static ovs_be32 ofputil_encode_table_config(enum ofputil_table_miss,
65 enum ofputil_table_eviction,
66 enum ofputil_table_vacancy,
69 /* Given the wildcard bit count in the least-significant 6 of 'wcbits', returns
70 * an IP netmask with a 1 in each bit that must match and a 0 in each bit that
73 * The bits in 'wcbits' are in the format used in enum ofp_flow_wildcards: 0
74 * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
75 * ..., 32 and higher wildcard the entire field. This is the *opposite* of the
76 * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
79 ofputil_wcbits_to_netmask(int wcbits)
82 return wcbits < 32 ? htonl(~((1u << wcbits) - 1)) : 0;
85 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
86 * that it wildcards, that is, the number of 0-bits in 'netmask', a number
87 * between 0 and 32 inclusive.
89 * If 'netmask' is not a CIDR netmask (see ip_is_cidr()), the return value will
90 * still be in the valid range but isn't otherwise meaningful. */
92 ofputil_netmask_to_wcbits(ovs_be32 netmask)
94 return 32 - ip_count_cidr_bits(netmask);
97 /* Converts the OpenFlow 1.0 wildcards in 'ofpfw' (OFPFW10_*) into a
98 * flow_wildcards in 'wc' for use in struct match. It is the caller's
99 * responsibility to handle the special case where the flow match's dl_vlan is
100 * set to OFP_VLAN_NONE. */
102 ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *wc)
104 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 35);
106 /* Initialize most of wc. */
107 flow_wildcards_init_catchall(wc);
109 if (!(ofpfw & OFPFW10_IN_PORT)) {
110 wc->masks.in_port.ofp_port = u16_to_ofp(UINT16_MAX);
113 if (!(ofpfw & OFPFW10_NW_TOS)) {
114 wc->masks.nw_tos |= IP_DSCP_MASK;
117 if (!(ofpfw & OFPFW10_NW_PROTO)) {
118 wc->masks.nw_proto = UINT8_MAX;
120 wc->masks.nw_src = ofputil_wcbits_to_netmask(ofpfw
121 >> OFPFW10_NW_SRC_SHIFT);
122 wc->masks.nw_dst = ofputil_wcbits_to_netmask(ofpfw
123 >> OFPFW10_NW_DST_SHIFT);
125 if (!(ofpfw & OFPFW10_TP_SRC)) {
126 wc->masks.tp_src = OVS_BE16_MAX;
128 if (!(ofpfw & OFPFW10_TP_DST)) {
129 wc->masks.tp_dst = OVS_BE16_MAX;
132 if (!(ofpfw & OFPFW10_DL_SRC)) {
133 WC_MASK_FIELD(wc, dl_src);
135 if (!(ofpfw & OFPFW10_DL_DST)) {
136 WC_MASK_FIELD(wc, dl_dst);
138 if (!(ofpfw & OFPFW10_DL_TYPE)) {
139 wc->masks.dl_type = OVS_BE16_MAX;
143 if (!(ofpfw & OFPFW10_DL_VLAN_PCP)) {
144 wc->masks.vlan_tci |= htons(VLAN_PCP_MASK | VLAN_CFI);
146 if (!(ofpfw & OFPFW10_DL_VLAN)) {
147 wc->masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
151 /* Converts the ofp10_match in 'ofmatch' into a struct match in 'match'. */
153 ofputil_match_from_ofp10_match(const struct ofp10_match *ofmatch,
156 uint32_t ofpfw = ntohl(ofmatch->wildcards) & OFPFW10_ALL;
158 /* Initialize match->wc. */
159 memset(&match->flow, 0, sizeof match->flow);
160 ofputil_wildcard_from_ofpfw10(ofpfw, &match->wc);
162 /* Initialize most of match->flow. */
163 match->flow.nw_src = ofmatch->nw_src;
164 match->flow.nw_dst = ofmatch->nw_dst;
165 match->flow.in_port.ofp_port = u16_to_ofp(ntohs(ofmatch->in_port));
166 match->flow.dl_type = ofputil_dl_type_from_openflow(ofmatch->dl_type);
167 match->flow.tp_src = ofmatch->tp_src;
168 match->flow.tp_dst = ofmatch->tp_dst;
169 match->flow.dl_src = ofmatch->dl_src;
170 match->flow.dl_dst = ofmatch->dl_dst;
171 match->flow.nw_tos = ofmatch->nw_tos & IP_DSCP_MASK;
172 match->flow.nw_proto = ofmatch->nw_proto;
174 /* Translate VLANs. */
175 if (!(ofpfw & OFPFW10_DL_VLAN) &&
176 ofmatch->dl_vlan == htons(OFP10_VLAN_NONE)) {
177 /* Match only packets without 802.1Q header.
179 * When OFPFW10_DL_VLAN_PCP is wildcarded, this is obviously correct.
181 * If OFPFW10_DL_VLAN_PCP is matched, the flow match is contradictory,
182 * because we can't have a specific PCP without an 802.1Q header.
183 * However, older versions of OVS treated this as matching packets
184 * withut an 802.1Q header, so we do here too. */
185 match->flow.vlan_tci = htons(0);
186 match->wc.masks.vlan_tci = htons(0xffff);
188 ovs_be16 vid, pcp, tci;
191 vid = ofmatch->dl_vlan & htons(VLAN_VID_MASK);
192 hpcp = (ofmatch->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK;
194 tci = vid | pcp | htons(VLAN_CFI);
195 match->flow.vlan_tci = tci & match->wc.masks.vlan_tci;
199 match_zero_wildcarded_fields(match);
202 /* Convert 'match' into the OpenFlow 1.0 match structure 'ofmatch'. */
204 ofputil_match_to_ofp10_match(const struct match *match,
205 struct ofp10_match *ofmatch)
207 const struct flow_wildcards *wc = &match->wc;
210 /* Figure out most OpenFlow wildcards. */
212 if (!wc->masks.in_port.ofp_port) {
213 ofpfw |= OFPFW10_IN_PORT;
215 if (!wc->masks.dl_type) {
216 ofpfw |= OFPFW10_DL_TYPE;
218 if (!wc->masks.nw_proto) {
219 ofpfw |= OFPFW10_NW_PROTO;
221 ofpfw |= (ofputil_netmask_to_wcbits(wc->masks.nw_src)
222 << OFPFW10_NW_SRC_SHIFT);
223 ofpfw |= (ofputil_netmask_to_wcbits(wc->masks.nw_dst)
224 << OFPFW10_NW_DST_SHIFT);
225 if (!(wc->masks.nw_tos & IP_DSCP_MASK)) {
226 ofpfw |= OFPFW10_NW_TOS;
228 if (!wc->masks.tp_src) {
229 ofpfw |= OFPFW10_TP_SRC;
231 if (!wc->masks.tp_dst) {
232 ofpfw |= OFPFW10_TP_DST;
234 if (eth_addr_is_zero(wc->masks.dl_src)) {
235 ofpfw |= OFPFW10_DL_SRC;
237 if (eth_addr_is_zero(wc->masks.dl_dst)) {
238 ofpfw |= OFPFW10_DL_DST;
241 /* Translate VLANs. */
242 ofmatch->dl_vlan = htons(0);
243 ofmatch->dl_vlan_pcp = 0;
244 if (match->wc.masks.vlan_tci == htons(0)) {
245 ofpfw |= OFPFW10_DL_VLAN | OFPFW10_DL_VLAN_PCP;
246 } else if (match->wc.masks.vlan_tci & htons(VLAN_CFI)
247 && !(match->flow.vlan_tci & htons(VLAN_CFI))) {
248 ofmatch->dl_vlan = htons(OFP10_VLAN_NONE);
250 if (!(match->wc.masks.vlan_tci & htons(VLAN_VID_MASK))) {
251 ofpfw |= OFPFW10_DL_VLAN;
253 ofmatch->dl_vlan = htons(vlan_tci_to_vid(match->flow.vlan_tci));
256 if (!(match->wc.masks.vlan_tci & htons(VLAN_PCP_MASK))) {
257 ofpfw |= OFPFW10_DL_VLAN_PCP;
259 ofmatch->dl_vlan_pcp = vlan_tci_to_pcp(match->flow.vlan_tci);
263 /* Compose most of the match structure. */
264 ofmatch->wildcards = htonl(ofpfw);
265 ofmatch->in_port = htons(ofp_to_u16(match->flow.in_port.ofp_port));
266 ofmatch->dl_src = match->flow.dl_src;
267 ofmatch->dl_dst = match->flow.dl_dst;
268 ofmatch->dl_type = ofputil_dl_type_to_openflow(match->flow.dl_type);
269 ofmatch->nw_src = match->flow.nw_src;
270 ofmatch->nw_dst = match->flow.nw_dst;
271 ofmatch->nw_tos = match->flow.nw_tos & IP_DSCP_MASK;
272 ofmatch->nw_proto = match->flow.nw_proto;
273 ofmatch->tp_src = match->flow.tp_src;
274 ofmatch->tp_dst = match->flow.tp_dst;
275 memset(ofmatch->pad1, '\0', sizeof ofmatch->pad1);
276 memset(ofmatch->pad2, '\0', sizeof ofmatch->pad2);
280 ofputil_pull_ofp11_match(struct ofpbuf *buf, struct match *match,
281 uint16_t *padded_match_len)
283 struct ofp11_match_header *omh = buf->data;
286 if (buf->size < sizeof *omh) {
287 return OFPERR_OFPBMC_BAD_LEN;
290 match_len = ntohs(omh->length);
292 switch (ntohs(omh->type)) {
293 case OFPMT_STANDARD: {
294 struct ofp11_match *om;
296 if (match_len != sizeof *om || buf->size < sizeof *om) {
297 return OFPERR_OFPBMC_BAD_LEN;
299 om = ofpbuf_pull(buf, sizeof *om);
300 if (padded_match_len) {
301 *padded_match_len = match_len;
303 return ofputil_match_from_ofp11_match(om, match);
307 if (padded_match_len) {
308 *padded_match_len = ROUND_UP(match_len, 8);
310 return oxm_pull_match(buf, match);
313 return OFPERR_OFPBMC_BAD_TYPE;
317 /* Converts the ofp11_match in 'ofmatch' into a struct match in 'match'.
318 * Returns 0 if successful, otherwise an OFPERR_* value. */
320 ofputil_match_from_ofp11_match(const struct ofp11_match *ofmatch,
323 uint16_t wc = ntohl(ofmatch->wildcards);
324 bool ipv4, arp, rarp;
326 match_init_catchall(match);
328 if (!(wc & OFPFW11_IN_PORT)) {
332 error = ofputil_port_from_ofp11(ofmatch->in_port, &ofp_port);
334 return OFPERR_OFPBMC_BAD_VALUE;
336 match_set_in_port(match, ofp_port);
339 match_set_dl_src_masked(match, ofmatch->dl_src,
340 eth_addr_invert(ofmatch->dl_src_mask));
341 match_set_dl_dst_masked(match, ofmatch->dl_dst,
342 eth_addr_invert(ofmatch->dl_dst_mask));
344 if (!(wc & OFPFW11_DL_VLAN)) {
345 if (ofmatch->dl_vlan == htons(OFPVID11_NONE)) {
346 /* Match only packets without a VLAN tag. */
347 match->flow.vlan_tci = htons(0);
348 match->wc.masks.vlan_tci = OVS_BE16_MAX;
350 if (ofmatch->dl_vlan == htons(OFPVID11_ANY)) {
351 /* Match any packet with a VLAN tag regardless of VID. */
352 match->flow.vlan_tci = htons(VLAN_CFI);
353 match->wc.masks.vlan_tci = htons(VLAN_CFI);
354 } else if (ntohs(ofmatch->dl_vlan) < 4096) {
355 /* Match only packets with the specified VLAN VID. */
356 match->flow.vlan_tci = htons(VLAN_CFI) | ofmatch->dl_vlan;
357 match->wc.masks.vlan_tci = htons(VLAN_CFI | VLAN_VID_MASK);
360 return OFPERR_OFPBMC_BAD_VALUE;
363 if (!(wc & OFPFW11_DL_VLAN_PCP)) {
364 if (ofmatch->dl_vlan_pcp <= 7) {
365 match->flow.vlan_tci |= htons(ofmatch->dl_vlan_pcp
367 match->wc.masks.vlan_tci |= htons(VLAN_PCP_MASK);
370 return OFPERR_OFPBMC_BAD_VALUE;
376 if (!(wc & OFPFW11_DL_TYPE)) {
377 match_set_dl_type(match,
378 ofputil_dl_type_from_openflow(ofmatch->dl_type));
381 ipv4 = match->flow.dl_type == htons(ETH_TYPE_IP);
382 arp = match->flow.dl_type == htons(ETH_TYPE_ARP);
383 rarp = match->flow.dl_type == htons(ETH_TYPE_RARP);
385 if (ipv4 && !(wc & OFPFW11_NW_TOS)) {
386 if (ofmatch->nw_tos & ~IP_DSCP_MASK) {
388 return OFPERR_OFPBMC_BAD_VALUE;
391 match_set_nw_dscp(match, ofmatch->nw_tos);
394 if (ipv4 || arp || rarp) {
395 if (!(wc & OFPFW11_NW_PROTO)) {
396 match_set_nw_proto(match, ofmatch->nw_proto);
398 match_set_nw_src_masked(match, ofmatch->nw_src, ~ofmatch->nw_src_mask);
399 match_set_nw_dst_masked(match, ofmatch->nw_dst, ~ofmatch->nw_dst_mask);
402 #define OFPFW11_TP_ALL (OFPFW11_TP_SRC | OFPFW11_TP_DST)
403 if (ipv4 && (wc & OFPFW11_TP_ALL) != OFPFW11_TP_ALL) {
404 switch (match->flow.nw_proto) {
406 /* "A.2.3 Flow Match Structures" in OF1.1 says:
408 * The tp_src and tp_dst fields will be ignored unless the
409 * network protocol specified is as TCP, UDP or SCTP.
411 * but I'm pretty sure we should support ICMP too, otherwise
412 * that's a regression from OF1.0. */
413 if (!(wc & OFPFW11_TP_SRC)) {
414 uint16_t icmp_type = ntohs(ofmatch->tp_src);
415 if (icmp_type < 0x100) {
416 match_set_icmp_type(match, icmp_type);
418 return OFPERR_OFPBMC_BAD_FIELD;
421 if (!(wc & OFPFW11_TP_DST)) {
422 uint16_t icmp_code = ntohs(ofmatch->tp_dst);
423 if (icmp_code < 0x100) {
424 match_set_icmp_code(match, icmp_code);
426 return OFPERR_OFPBMC_BAD_FIELD;
434 if (!(wc & (OFPFW11_TP_SRC))) {
435 match_set_tp_src(match, ofmatch->tp_src);
437 if (!(wc & (OFPFW11_TP_DST))) {
438 match_set_tp_dst(match, ofmatch->tp_dst);
443 /* OF1.1 says explicitly to ignore this. */
448 if (eth_type_mpls(match->flow.dl_type)) {
449 if (!(wc & OFPFW11_MPLS_LABEL)) {
450 match_set_mpls_label(match, 0, ofmatch->mpls_label);
452 if (!(wc & OFPFW11_MPLS_TC)) {
453 match_set_mpls_tc(match, 0, ofmatch->mpls_tc);
457 match_set_metadata_masked(match, ofmatch->metadata,
458 ~ofmatch->metadata_mask);
463 /* Convert 'match' into the OpenFlow 1.1 match structure 'ofmatch'. */
465 ofputil_match_to_ofp11_match(const struct match *match,
466 struct ofp11_match *ofmatch)
470 memset(ofmatch, 0, sizeof *ofmatch);
471 ofmatch->omh.type = htons(OFPMT_STANDARD);
472 ofmatch->omh.length = htons(OFPMT11_STANDARD_LENGTH);
474 if (!match->wc.masks.in_port.ofp_port) {
475 wc |= OFPFW11_IN_PORT;
477 ofmatch->in_port = ofputil_port_to_ofp11(match->flow.in_port.ofp_port);
480 ofmatch->dl_src = match->flow.dl_src;
481 ofmatch->dl_src_mask = eth_addr_invert(match->wc.masks.dl_src);
482 ofmatch->dl_dst = match->flow.dl_dst;
483 ofmatch->dl_dst_mask = eth_addr_invert(match->wc.masks.dl_dst);
485 if (match->wc.masks.vlan_tci == htons(0)) {
486 wc |= OFPFW11_DL_VLAN | OFPFW11_DL_VLAN_PCP;
487 } else if (match->wc.masks.vlan_tci & htons(VLAN_CFI)
488 && !(match->flow.vlan_tci & htons(VLAN_CFI))) {
489 ofmatch->dl_vlan = htons(OFPVID11_NONE);
490 wc |= OFPFW11_DL_VLAN_PCP;
492 if (!(match->wc.masks.vlan_tci & htons(VLAN_VID_MASK))) {
493 ofmatch->dl_vlan = htons(OFPVID11_ANY);
495 ofmatch->dl_vlan = htons(vlan_tci_to_vid(match->flow.vlan_tci));
498 if (!(match->wc.masks.vlan_tci & htons(VLAN_PCP_MASK))) {
499 wc |= OFPFW11_DL_VLAN_PCP;
501 ofmatch->dl_vlan_pcp = vlan_tci_to_pcp(match->flow.vlan_tci);
505 if (!match->wc.masks.dl_type) {
506 wc |= OFPFW11_DL_TYPE;
508 ofmatch->dl_type = ofputil_dl_type_to_openflow(match->flow.dl_type);
511 if (!(match->wc.masks.nw_tos & IP_DSCP_MASK)) {
512 wc |= OFPFW11_NW_TOS;
514 ofmatch->nw_tos = match->flow.nw_tos & IP_DSCP_MASK;
517 if (!match->wc.masks.nw_proto) {
518 wc |= OFPFW11_NW_PROTO;
520 ofmatch->nw_proto = match->flow.nw_proto;
523 ofmatch->nw_src = match->flow.nw_src;
524 ofmatch->nw_src_mask = ~match->wc.masks.nw_src;
525 ofmatch->nw_dst = match->flow.nw_dst;
526 ofmatch->nw_dst_mask = ~match->wc.masks.nw_dst;
528 if (!match->wc.masks.tp_src) {
529 wc |= OFPFW11_TP_SRC;
531 ofmatch->tp_src = match->flow.tp_src;
534 if (!match->wc.masks.tp_dst) {
535 wc |= OFPFW11_TP_DST;
537 ofmatch->tp_dst = match->flow.tp_dst;
540 if (!(match->wc.masks.mpls_lse[0] & htonl(MPLS_LABEL_MASK))) {
541 wc |= OFPFW11_MPLS_LABEL;
543 ofmatch->mpls_label = htonl(mpls_lse_to_label(
544 match->flow.mpls_lse[0]));
547 if (!(match->wc.masks.mpls_lse[0] & htonl(MPLS_TC_MASK))) {
548 wc |= OFPFW11_MPLS_TC;
550 ofmatch->mpls_tc = mpls_lse_to_tc(match->flow.mpls_lse[0]);
553 ofmatch->metadata = match->flow.metadata;
554 ofmatch->metadata_mask = ~match->wc.masks.metadata;
556 ofmatch->wildcards = htonl(wc);
559 /* Returns the "typical" length of a match for 'protocol', for use in
560 * estimating space to preallocate. */
562 ofputil_match_typical_len(enum ofputil_protocol protocol)
565 case OFPUTIL_P_OF10_STD:
566 case OFPUTIL_P_OF10_STD_TID:
567 return sizeof(struct ofp10_match);
569 case OFPUTIL_P_OF10_NXM:
570 case OFPUTIL_P_OF10_NXM_TID:
571 return NXM_TYPICAL_LEN;
573 case OFPUTIL_P_OF11_STD:
574 return sizeof(struct ofp11_match);
576 case OFPUTIL_P_OF12_OXM:
577 case OFPUTIL_P_OF13_OXM:
578 case OFPUTIL_P_OF14_OXM:
579 case OFPUTIL_P_OF15_OXM:
580 case OFPUTIL_P_OF16_OXM:
581 return NXM_TYPICAL_LEN;
588 /* Appends to 'b' an struct ofp11_match_header followed by a match that
589 * expresses 'match' properly for 'protocol', plus enough zero bytes to pad the
590 * data appended out to a multiple of 8. 'protocol' must be one that is usable
591 * in OpenFlow 1.1 or later.
593 * This function can cause 'b''s data to be reallocated.
595 * Returns the number of bytes appended to 'b', excluding the padding. Never
598 ofputil_put_ofp11_match(struct ofpbuf *b, const struct match *match,
599 enum ofputil_protocol protocol)
602 case OFPUTIL_P_OF10_STD:
603 case OFPUTIL_P_OF10_STD_TID:
604 case OFPUTIL_P_OF10_NXM:
605 case OFPUTIL_P_OF10_NXM_TID:
608 case OFPUTIL_P_OF11_STD: {
609 struct ofp11_match *om;
611 /* Make sure that no padding is needed. */
612 BUILD_ASSERT_DECL(sizeof *om % 8 == 0);
614 om = ofpbuf_put_uninit(b, sizeof *om);
615 ofputil_match_to_ofp11_match(match, om);
619 case OFPUTIL_P_OF12_OXM:
620 case OFPUTIL_P_OF13_OXM:
621 case OFPUTIL_P_OF14_OXM:
622 case OFPUTIL_P_OF15_OXM:
623 case OFPUTIL_P_OF16_OXM:
624 return oxm_put_match(b, match,
625 ofputil_protocol_to_ofp_version(protocol));
631 /* Given a 'dl_type' value in the format used in struct flow, returns the
632 * corresponding 'dl_type' value for use in an ofp10_match or ofp11_match
635 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type)
637 return (flow_dl_type == htons(FLOW_DL_TYPE_NONE)
638 ? htons(OFP_DL_TYPE_NOT_ETH_TYPE)
642 /* Given a 'dl_type' value in the format used in an ofp10_match or ofp11_match
643 * structure, returns the corresponding 'dl_type' value for use in struct
646 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type)
648 return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
649 ? htons(FLOW_DL_TYPE_NONE)
655 struct proto_abbrev {
656 enum ofputil_protocol protocol;
660 /* Most users really don't care about some of the differences between
661 * protocols. These abbreviations help with that. */
662 static const struct proto_abbrev proto_abbrevs[] = {
663 { OFPUTIL_P_ANY, "any" },
664 { OFPUTIL_P_OF10_STD_ANY, "OpenFlow10" },
665 { OFPUTIL_P_OF10_NXM_ANY, "NXM" },
666 { OFPUTIL_P_ANY_OXM, "OXM" },
668 #define N_PROTO_ABBREVS ARRAY_SIZE(proto_abbrevs)
670 enum ofputil_protocol ofputil_flow_dump_protocols[] = {
680 size_t ofputil_n_flow_dump_protocols = ARRAY_SIZE(ofputil_flow_dump_protocols);
682 /* Returns the set of ofputil_protocols that are supported with the given
683 * OpenFlow 'version'. 'version' should normally be an 8-bit OpenFlow version
684 * identifier (e.g. 0x01 for OpenFlow 1.0, 0x02 for OpenFlow 1.1). Returns 0
685 * if 'version' is not supported or outside the valid range. */
686 enum ofputil_protocol
687 ofputil_protocols_from_ofp_version(enum ofp_version version)
691 return OFPUTIL_P_OF10_STD_ANY | OFPUTIL_P_OF10_NXM_ANY;
693 return OFPUTIL_P_OF11_STD;
695 return OFPUTIL_P_OF12_OXM;
697 return OFPUTIL_P_OF13_OXM;
699 return OFPUTIL_P_OF14_OXM;
701 return OFPUTIL_P_OF15_OXM;
703 return OFPUTIL_P_OF16_OXM;
709 /* Returns the ofputil_protocol that is initially in effect on an OpenFlow
710 * connection that has negotiated the given 'version'. 'version' should
711 * normally be an 8-bit OpenFlow version identifier (e.g. 0x01 for OpenFlow
712 * 1.0, 0x02 for OpenFlow 1.1). Returns 0 if 'version' is not supported or
713 * outside the valid range. */
714 enum ofputil_protocol
715 ofputil_protocol_from_ofp_version(enum ofp_version version)
717 return rightmost_1bit(ofputil_protocols_from_ofp_version(version));
720 /* Returns the OpenFlow protocol version number (e.g. OFP10_VERSION,
721 * etc.) that corresponds to 'protocol'. */
723 ofputil_protocol_to_ofp_version(enum ofputil_protocol protocol)
726 case OFPUTIL_P_OF10_STD:
727 case OFPUTIL_P_OF10_STD_TID:
728 case OFPUTIL_P_OF10_NXM:
729 case OFPUTIL_P_OF10_NXM_TID:
730 return OFP10_VERSION;
731 case OFPUTIL_P_OF11_STD:
732 return OFP11_VERSION;
733 case OFPUTIL_P_OF12_OXM:
734 return OFP12_VERSION;
735 case OFPUTIL_P_OF13_OXM:
736 return OFP13_VERSION;
737 case OFPUTIL_P_OF14_OXM:
738 return OFP14_VERSION;
739 case OFPUTIL_P_OF15_OXM:
740 return OFP15_VERSION;
741 case OFPUTIL_P_OF16_OXM:
742 return OFP16_VERSION;
748 /* Returns a bitmap of OpenFlow versions that are supported by at
749 * least one of the 'protocols'. */
751 ofputil_protocols_to_version_bitmap(enum ofputil_protocol protocols)
755 for (; protocols; protocols = zero_rightmost_1bit(protocols)) {
756 enum ofputil_protocol protocol = rightmost_1bit(protocols);
758 bitmap |= 1u << ofputil_protocol_to_ofp_version(protocol);
764 /* Returns the set of protocols that are supported on top of the
765 * OpenFlow versions included in 'bitmap'. */
766 enum ofputil_protocol
767 ofputil_protocols_from_version_bitmap(uint32_t bitmap)
769 enum ofputil_protocol protocols = 0;
771 for (; bitmap; bitmap = zero_rightmost_1bit(bitmap)) {
772 enum ofp_version version = rightmost_1bit_idx(bitmap);
774 protocols |= ofputil_protocols_from_ofp_version(version);
780 /* Returns true if 'protocol' is a single OFPUTIL_P_* value, false
783 ofputil_protocol_is_valid(enum ofputil_protocol protocol)
785 return protocol & OFPUTIL_P_ANY && is_pow2(protocol);
788 /* Returns the equivalent of 'protocol' with the Nicira flow_mod_table_id
789 * extension turned on or off if 'enable' is true or false, respectively.
791 * This extension is only useful for protocols whose "standard" version does
792 * not allow specific tables to be modified. In particular, this is true of
793 * OpenFlow 1.0. In later versions of OpenFlow, a flow_mod request always
794 * specifies a table ID and so there is no need for such an extension. When
795 * 'protocol' is such a protocol that doesn't need a flow_mod_table_id
796 * extension, this function just returns its 'protocol' argument unchanged
797 * regardless of the value of 'enable'. */
798 enum ofputil_protocol
799 ofputil_protocol_set_tid(enum ofputil_protocol protocol, bool enable)
802 case OFPUTIL_P_OF10_STD:
803 case OFPUTIL_P_OF10_STD_TID:
804 return enable ? OFPUTIL_P_OF10_STD_TID : OFPUTIL_P_OF10_STD;
806 case OFPUTIL_P_OF10_NXM:
807 case OFPUTIL_P_OF10_NXM_TID:
808 return enable ? OFPUTIL_P_OF10_NXM_TID : OFPUTIL_P_OF10_NXM;
810 case OFPUTIL_P_OF11_STD:
811 return OFPUTIL_P_OF11_STD;
813 case OFPUTIL_P_OF12_OXM:
814 return OFPUTIL_P_OF12_OXM;
816 case OFPUTIL_P_OF13_OXM:
817 return OFPUTIL_P_OF13_OXM;
819 case OFPUTIL_P_OF14_OXM:
820 return OFPUTIL_P_OF14_OXM;
822 case OFPUTIL_P_OF15_OXM:
823 return OFPUTIL_P_OF15_OXM;
825 case OFPUTIL_P_OF16_OXM:
826 return OFPUTIL_P_OF16_OXM;
833 /* Returns the "base" version of 'protocol'. That is, if 'protocol' includes
834 * some extension to a standard protocol version, the return value is the
835 * standard version of that protocol without any extension. If 'protocol' is a
836 * standard protocol version, returns 'protocol' unchanged. */
837 enum ofputil_protocol
838 ofputil_protocol_to_base(enum ofputil_protocol protocol)
840 return ofputil_protocol_set_tid(protocol, false);
843 /* Returns 'new_base' with any extensions taken from 'cur'. */
844 enum ofputil_protocol
845 ofputil_protocol_set_base(enum ofputil_protocol cur,
846 enum ofputil_protocol new_base)
848 bool tid = (cur & OFPUTIL_P_TID) != 0;
851 case OFPUTIL_P_OF10_STD:
852 case OFPUTIL_P_OF10_STD_TID:
853 return ofputil_protocol_set_tid(OFPUTIL_P_OF10_STD, tid);
855 case OFPUTIL_P_OF10_NXM:
856 case OFPUTIL_P_OF10_NXM_TID:
857 return ofputil_protocol_set_tid(OFPUTIL_P_OF10_NXM, tid);
859 case OFPUTIL_P_OF11_STD:
860 return ofputil_protocol_set_tid(OFPUTIL_P_OF11_STD, tid);
862 case OFPUTIL_P_OF12_OXM:
863 return ofputil_protocol_set_tid(OFPUTIL_P_OF12_OXM, tid);
865 case OFPUTIL_P_OF13_OXM:
866 return ofputil_protocol_set_tid(OFPUTIL_P_OF13_OXM, tid);
868 case OFPUTIL_P_OF14_OXM:
869 return ofputil_protocol_set_tid(OFPUTIL_P_OF14_OXM, tid);
871 case OFPUTIL_P_OF15_OXM:
872 return ofputil_protocol_set_tid(OFPUTIL_P_OF15_OXM, tid);
874 case OFPUTIL_P_OF16_OXM:
875 return ofputil_protocol_set_tid(OFPUTIL_P_OF16_OXM, tid);
882 /* Returns a string form of 'protocol', if a simple form exists (that is, if
883 * 'protocol' is either a single protocol or it is a combination of protocols
884 * that have a single abbreviation). Otherwise, returns NULL. */
886 ofputil_protocol_to_string(enum ofputil_protocol protocol)
888 const struct proto_abbrev *p;
890 /* Use a "switch" statement for single-bit names so that we get a compiler
891 * warning if we forget any. */
893 case OFPUTIL_P_OF10_NXM:
894 return "NXM-table_id";
896 case OFPUTIL_P_OF10_NXM_TID:
897 return "NXM+table_id";
899 case OFPUTIL_P_OF10_STD:
900 return "OpenFlow10-table_id";
902 case OFPUTIL_P_OF10_STD_TID:
903 return "OpenFlow10+table_id";
905 case OFPUTIL_P_OF11_STD:
908 case OFPUTIL_P_OF12_OXM:
909 return "OXM-OpenFlow12";
911 case OFPUTIL_P_OF13_OXM:
912 return "OXM-OpenFlow13";
914 case OFPUTIL_P_OF14_OXM:
915 return "OXM-OpenFlow14";
917 case OFPUTIL_P_OF15_OXM:
918 return "OXM-OpenFlow15";
920 case OFPUTIL_P_OF16_OXM:
921 return "OXM-OpenFlow16";
924 /* Check abbreviations. */
925 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
926 if (protocol == p->protocol) {
934 /* Returns a string that represents 'protocols'. The return value might be a
935 * comma-separated list if 'protocols' doesn't have a simple name. The return
936 * value is "none" if 'protocols' is 0.
938 * The caller must free the returned string (with free()). */
940 ofputil_protocols_to_string(enum ofputil_protocol protocols)
944 ovs_assert(!(protocols & ~OFPUTIL_P_ANY));
945 if (protocols == 0) {
946 return xstrdup("none");
951 const struct proto_abbrev *p;
955 ds_put_char(&s, ',');
958 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
959 if ((protocols & p->protocol) == p->protocol) {
960 ds_put_cstr(&s, p->name);
961 protocols &= ~p->protocol;
966 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
967 enum ofputil_protocol bit = 1u << i;
969 if (protocols & bit) {
970 ds_put_cstr(&s, ofputil_protocol_to_string(bit));
979 return ds_steal_cstr(&s);
982 static enum ofputil_protocol
983 ofputil_protocol_from_string__(const char *s, size_t n)
985 const struct proto_abbrev *p;
988 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
989 enum ofputil_protocol bit = 1u << i;
990 const char *name = ofputil_protocol_to_string(bit);
992 if (name && n == strlen(name) && !strncasecmp(s, name, n)) {
997 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
998 if (n == strlen(p->name) && !strncasecmp(s, p->name, n)) {
1006 /* Returns the nonempty set of protocols represented by 's', which can be a
1007 * single protocol name or abbreviation or a comma-separated list of them.
1009 * Aborts the program with an error message if 's' is invalid. */
1010 enum ofputil_protocol
1011 ofputil_protocols_from_string(const char *s)
1013 const char *orig_s = s;
1014 enum ofputil_protocol protocols;
1018 enum ofputil_protocol p;
1021 n = strcspn(s, ",");
1027 p = ofputil_protocol_from_string__(s, n);
1029 ovs_fatal(0, "%.*s: unknown flow protocol", (int) n, s);
1037 ovs_fatal(0, "%s: no flow protocol specified", orig_s);
1043 ofputil_version_from_string(const char *s)
1045 if (!strcasecmp(s, "OpenFlow10")) {
1046 return OFP10_VERSION;
1048 if (!strcasecmp(s, "OpenFlow11")) {
1049 return OFP11_VERSION;
1051 if (!strcasecmp(s, "OpenFlow12")) {
1052 return OFP12_VERSION;
1054 if (!strcasecmp(s, "OpenFlow13")) {
1055 return OFP13_VERSION;
1057 if (!strcasecmp(s, "OpenFlow14")) {
1058 return OFP14_VERSION;
1060 if (!strcasecmp(s, "OpenFlow15")) {
1061 return OFP15_VERSION;
1063 if (!strcasecmp(s, "OpenFlow16")) {
1064 return OFP16_VERSION;
1070 is_delimiter(unsigned char c)
1072 return isspace(c) || c == ',';
1076 ofputil_versions_from_string(const char *s)
1079 uint32_t bitmap = 0;
1086 if (is_delimiter(s[i])) {
1091 while (s[i + j] && !is_delimiter(s[i + j])) {
1094 key = xmemdup0(s + i, j);
1095 version = ofputil_version_from_string(key);
1097 VLOG_FATAL("Unknown OpenFlow version: \"%s\"", key);
1100 bitmap |= 1u << version;
1108 ofputil_versions_from_strings(char ** const s, size_t count)
1110 uint32_t bitmap = 0;
1113 int version = ofputil_version_from_string(s[count]);
1115 VLOG_WARN("Unknown OpenFlow version: \"%s\"", s[count]);
1117 bitmap |= 1u << version;
1125 ofputil_version_to_string(enum ofp_version ofp_version)
1127 switch (ofp_version) {
1129 return "OpenFlow10";
1131 return "OpenFlow11";
1133 return "OpenFlow12";
1135 return "OpenFlow13";
1137 return "OpenFlow14";
1139 return "OpenFlow15";
1141 return "OpenFlow16";
1148 ofputil_packet_in_format_is_valid(enum nx_packet_in_format packet_in_format)
1150 switch (packet_in_format) {
1151 case NXPIF_STANDARD:
1152 case NXPIF_NXT_PACKET_IN:
1153 case NXPIF_NXT_PACKET_IN2:
1161 ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format)
1163 switch (packet_in_format) {
1164 case NXPIF_STANDARD:
1166 case NXPIF_NXT_PACKET_IN:
1167 return "nxt_packet_in";
1168 case NXPIF_NXT_PACKET_IN2:
1169 return "nxt_packet_in2";
1176 ofputil_packet_in_format_from_string(const char *s)
1178 return (!strcmp(s, "standard") || !strcmp(s, "openflow10")
1180 : !strcmp(s, "nxt_packet_in") || !strcmp(s, "nxm")
1181 ? NXPIF_NXT_PACKET_IN
1182 : !strcmp(s, "nxt_packet_in2")
1183 ? NXPIF_NXT_PACKET_IN2
1188 ofputil_format_version(struct ds *msg, enum ofp_version version)
1190 ds_put_format(msg, "0x%02x", version);
1194 ofputil_format_version_name(struct ds *msg, enum ofp_version version)
1196 ds_put_cstr(msg, ofputil_version_to_string(version));
1200 ofputil_format_version_bitmap__(struct ds *msg, uint32_t bitmap,
1201 void (*format_version)(struct ds *msg,
1205 format_version(msg, raw_ctz(bitmap));
1206 bitmap = zero_rightmost_1bit(bitmap);
1208 ds_put_cstr(msg, ", ");
1214 ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap)
1216 ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version);
1220 ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap)
1222 ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version_name);
1226 ofputil_decode_hello_bitmap(const struct ofp_hello_elem_header *oheh,
1227 uint32_t *allowed_versionsp)
1229 uint16_t bitmap_len = ntohs(oheh->length) - sizeof *oheh;
1230 const ovs_be32 *bitmap = ALIGNED_CAST(const ovs_be32 *, oheh + 1);
1231 uint32_t allowed_versions;
1233 if (!bitmap_len || bitmap_len % sizeof *bitmap) {
1237 /* Only use the first 32-bit element of the bitmap as that is all the
1238 * current implementation supports. Subsequent elements are ignored which
1239 * should have no effect on session negotiation until Open vSwitch supports
1240 * wire-protocol versions greater than 31.
1242 allowed_versions = ntohl(bitmap[0]);
1244 if (allowed_versions & 1) {
1245 /* There's no OpenFlow version 0. */
1246 VLOG_WARN_RL(&bad_ofmsg_rl, "peer claims to support invalid OpenFlow "
1248 allowed_versions &= ~1u;
1251 if (!allowed_versions) {
1252 VLOG_WARN_RL(&bad_ofmsg_rl, "peer does not support any OpenFlow "
1253 "version (between 0x01 and 0x1f)");
1257 *allowed_versionsp = allowed_versions;
1262 version_bitmap_from_version(uint8_t ofp_version)
1264 return ((ofp_version < 32 ? 1u << ofp_version : 0) - 1) << 1;
1267 /* Decodes OpenFlow OFPT_HELLO message 'oh', storing into '*allowed_versions'
1268 * the set of OpenFlow versions for which 'oh' announces support.
1270 * Because of how OpenFlow defines OFPT_HELLO messages, this function is always
1271 * successful, and thus '*allowed_versions' is always initialized. However, it
1272 * returns false if 'oh' contains some data that could not be fully understood,
1273 * true if 'oh' was completely parsed. */
1275 ofputil_decode_hello(const struct ofp_header *oh, uint32_t *allowed_versions)
1277 struct ofpbuf msg = ofpbuf_const_initializer(oh, ntohs(oh->length));
1278 ofpbuf_pull(&msg, sizeof *oh);
1280 *allowed_versions = version_bitmap_from_version(oh->version);
1284 const struct ofp_hello_elem_header *oheh;
1287 if (msg.size < sizeof *oheh) {
1292 len = ntohs(oheh->length);
1293 if (len < sizeof *oheh || !ofpbuf_try_pull(&msg, ROUND_UP(len, 8))) {
1297 if (oheh->type != htons(OFPHET_VERSIONBITMAP)
1298 || !ofputil_decode_hello_bitmap(oheh, allowed_versions)) {
1306 /* Returns true if 'allowed_versions' needs to be accompanied by a version
1307 * bitmap to be correctly expressed in an OFPT_HELLO message. */
1309 should_send_version_bitmap(uint32_t allowed_versions)
1311 return !is_pow2((allowed_versions >> 1) + 1);
1314 /* Create an OFPT_HELLO message that expresses support for the OpenFlow
1315 * versions in the 'allowed_versions' bitmaps and returns the message. */
1317 ofputil_encode_hello(uint32_t allowed_versions)
1319 enum ofp_version ofp_version;
1322 ofp_version = leftmost_1bit_idx(allowed_versions);
1323 msg = ofpraw_alloc(OFPRAW_OFPT_HELLO, ofp_version, 0);
1325 if (should_send_version_bitmap(allowed_versions)) {
1326 struct ofp_hello_elem_header *oheh;
1329 map_len = sizeof allowed_versions;
1330 oheh = ofpbuf_put_zeros(msg, ROUND_UP(map_len + sizeof *oheh, 8));
1331 oheh->type = htons(OFPHET_VERSIONBITMAP);
1332 oheh->length = htons(map_len + sizeof *oheh);
1333 *ALIGNED_CAST(ovs_be32 *, oheh + 1) = htonl(allowed_versions);
1335 ofpmsg_update_length(msg);
1341 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
1342 * protocol is 'current', at least partly transitions the protocol to 'want'.
1343 * Stores in '*next' the protocol that will be in effect on the OpenFlow
1344 * connection if the switch processes the returned message correctly. (If
1345 * '*next != want' then the caller will have to iterate.)
1347 * If 'current == want', or if it is not possible to transition from 'current'
1348 * to 'want' (because, for example, 'current' and 'want' use different OpenFlow
1349 * protocol versions), returns NULL and stores 'current' in '*next'. */
1351 ofputil_encode_set_protocol(enum ofputil_protocol current,
1352 enum ofputil_protocol want,
1353 enum ofputil_protocol *next)
1355 enum ofp_version cur_version, want_version;
1356 enum ofputil_protocol cur_base, want_base;
1357 bool cur_tid, want_tid;
1359 cur_version = ofputil_protocol_to_ofp_version(current);
1360 want_version = ofputil_protocol_to_ofp_version(want);
1361 if (cur_version != want_version) {
1366 cur_base = ofputil_protocol_to_base(current);
1367 want_base = ofputil_protocol_to_base(want);
1368 if (cur_base != want_base) {
1369 *next = ofputil_protocol_set_base(current, want_base);
1371 switch (want_base) {
1372 case OFPUTIL_P_OF10_NXM:
1373 return ofputil_encode_nx_set_flow_format(NXFF_NXM);
1375 case OFPUTIL_P_OF10_STD:
1376 return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10);
1378 case OFPUTIL_P_OF11_STD:
1379 case OFPUTIL_P_OF12_OXM:
1380 case OFPUTIL_P_OF13_OXM:
1381 case OFPUTIL_P_OF14_OXM:
1382 case OFPUTIL_P_OF15_OXM:
1383 case OFPUTIL_P_OF16_OXM:
1384 /* There is only one variant of each OpenFlow 1.1+ protocol, and we
1385 * verified above that we're not trying to change versions. */
1388 case OFPUTIL_P_OF10_STD_TID:
1389 case OFPUTIL_P_OF10_NXM_TID:
1394 cur_tid = (current & OFPUTIL_P_TID) != 0;
1395 want_tid = (want & OFPUTIL_P_TID) != 0;
1396 if (cur_tid != want_tid) {
1397 *next = ofputil_protocol_set_tid(current, want_tid);
1398 return ofputil_make_flow_mod_table_id(want_tid);
1401 ovs_assert(current == want);
1407 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1408 * format to 'nxff'. */
1410 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff)
1412 struct nx_set_flow_format *sff;
1415 ovs_assert(ofputil_nx_flow_format_is_valid(nxff));
1417 msg = ofpraw_alloc(OFPRAW_NXT_SET_FLOW_FORMAT, OFP10_VERSION, 0);
1418 sff = ofpbuf_put_zeros(msg, sizeof *sff);
1419 sff->format = htonl(nxff);
1424 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1426 enum ofputil_protocol
1427 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format)
1429 switch (flow_format) {
1430 case NXFF_OPENFLOW10:
1431 return OFPUTIL_P_OF10_STD;
1434 return OFPUTIL_P_OF10_NXM;
1441 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1443 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format)
1445 return ofputil_nx_flow_format_to_protocol(flow_format) != 0;
1448 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1451 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format)
1453 switch (flow_format) {
1454 case NXFF_OPENFLOW10:
1455 return "openflow10";
1464 ofputil_make_set_packet_in_format(enum ofp_version ofp_version,
1465 enum nx_packet_in_format packet_in_format)
1467 struct nx_set_packet_in_format *spif;
1470 msg = ofpraw_alloc(OFPRAW_NXT_SET_PACKET_IN_FORMAT, ofp_version, 0);
1471 spif = ofpbuf_put_zeros(msg, sizeof *spif);
1472 spif->format = htonl(packet_in_format);
1477 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1478 * extension on or off (according to 'flow_mod_table_id'). */
1480 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
1482 struct nx_flow_mod_table_id *nfmti;
1485 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION, 0);
1486 nfmti = ofpbuf_put_zeros(msg, sizeof *nfmti);
1487 nfmti->set = flow_mod_table_id;
1491 struct ofputil_flow_mod_flag {
1493 enum ofp_version min_version, max_version;
1494 enum ofputil_flow_mod_flags flag;
1497 static const struct ofputil_flow_mod_flag ofputil_flow_mod_flags[] = {
1498 { OFPFF_SEND_FLOW_REM, OFP10_VERSION, 0, OFPUTIL_FF_SEND_FLOW_REM },
1499 { OFPFF_CHECK_OVERLAP, OFP10_VERSION, 0, OFPUTIL_FF_CHECK_OVERLAP },
1500 { OFPFF10_EMERG, OFP10_VERSION, OFP10_VERSION,
1502 { OFPFF12_RESET_COUNTS, OFP12_VERSION, 0, OFPUTIL_FF_RESET_COUNTS },
1503 { OFPFF13_NO_PKT_COUNTS, OFP13_VERSION, 0, OFPUTIL_FF_NO_PKT_COUNTS },
1504 { OFPFF13_NO_BYT_COUNTS, OFP13_VERSION, 0, OFPUTIL_FF_NO_BYT_COUNTS },
1509 ofputil_decode_flow_mod_flags(ovs_be16 raw_flags_,
1510 enum ofp_flow_mod_command command,
1511 enum ofp_version version,
1512 enum ofputil_flow_mod_flags *flagsp)
1514 uint16_t raw_flags = ntohs(raw_flags_);
1515 const struct ofputil_flow_mod_flag *f;
1518 for (f = ofputil_flow_mod_flags; f->raw_flag; f++) {
1519 if (raw_flags & f->raw_flag
1520 && version >= f->min_version
1521 && (!f->max_version || version <= f->max_version)) {
1522 raw_flags &= ~f->raw_flag;
1527 /* In OF1.0 and OF1.1, "add" always resets counters, and other commands
1530 * In OF1.2 and later, OFPFF12_RESET_COUNTS controls whether each command
1531 * resets counters. */
1532 if ((version == OFP10_VERSION || version == OFP11_VERSION)
1533 && command == OFPFC_ADD) {
1534 *flagsp |= OFPUTIL_FF_RESET_COUNTS;
1537 return raw_flags ? OFPERR_OFPFMFC_BAD_FLAGS : 0;
1541 ofputil_encode_flow_mod_flags(enum ofputil_flow_mod_flags flags,
1542 enum ofp_version version)
1544 const struct ofputil_flow_mod_flag *f;
1548 for (f = ofputil_flow_mod_flags; f->raw_flag; f++) {
1550 && version >= f->min_version
1551 && (!f->max_version || version <= f->max_version)) {
1552 raw_flags |= f->raw_flag;
1556 return htons(raw_flags);
1559 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1560 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
1563 * Uses 'ofpacts' to store the abstract OFPACT_* version of 'oh''s actions.
1564 * The caller must initialize 'ofpacts' and retains ownership of it.
1565 * 'fm->ofpacts' will point into the 'ofpacts' buffer.
1567 * Does not validate the flow_mod actions. The caller should do that, with
1568 * ofpacts_check(). */
1570 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
1571 const struct ofp_header *oh,
1572 enum ofputil_protocol protocol,
1573 struct ofpbuf *ofpacts,
1574 ofp_port_t max_port, uint8_t max_table)
1579 /* Ignored for non-delete actions */
1580 fm->delete_reason = OFPRR_DELETE;
1582 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
1583 enum ofpraw raw = ofpraw_pull_assert(&b);
1584 if (raw == OFPRAW_OFPT11_FLOW_MOD) {
1585 /* Standard OpenFlow 1.1+ flow_mod. */
1586 const struct ofp11_flow_mod *ofm;
1588 ofm = ofpbuf_pull(&b, sizeof *ofm);
1590 error = ofputil_pull_ofp11_match(&b, &fm->match, NULL);
1595 /* Translate the message. */
1596 fm->priority = ntohs(ofm->priority);
1597 if (ofm->command == OFPFC_ADD
1598 || (oh->version == OFP11_VERSION
1599 && (ofm->command == OFPFC_MODIFY ||
1600 ofm->command == OFPFC_MODIFY_STRICT)
1601 && ofm->cookie_mask == htonll(0))) {
1602 /* In OpenFlow 1.1 only, a "modify" or "modify-strict" that does
1603 * not match on the cookie is treated as an "add" if there is no
1605 fm->cookie = htonll(0);
1606 fm->cookie_mask = htonll(0);
1607 fm->new_cookie = ofm->cookie;
1609 fm->cookie = ofm->cookie;
1610 fm->cookie_mask = ofm->cookie_mask;
1611 fm->new_cookie = OVS_BE64_MAX;
1613 fm->modify_cookie = false;
1614 fm->command = ofm->command;
1618 * OF1.1 entirely forbids table_id == OFPTT_ALL.
1619 * OF1.2+ allows table_id == OFPTT_ALL only for deletes. */
1620 fm->table_id = ofm->table_id;
1621 if (fm->table_id == OFPTT_ALL
1622 && (oh->version == OFP11_VERSION
1623 || (ofm->command != OFPFC_DELETE &&
1624 ofm->command != OFPFC_DELETE_STRICT))) {
1625 return OFPERR_OFPFMFC_BAD_TABLE_ID;
1628 fm->idle_timeout = ntohs(ofm->idle_timeout);
1629 fm->hard_timeout = ntohs(ofm->hard_timeout);
1630 if (oh->version >= OFP14_VERSION && ofm->command == OFPFC_ADD) {
1631 fm->importance = ntohs(ofm->importance);
1635 fm->buffer_id = ntohl(ofm->buffer_id);
1636 error = ofputil_port_from_ofp11(ofm->out_port, &fm->out_port);
1641 fm->out_group = (ofm->command == OFPFC_DELETE ||
1642 ofm->command == OFPFC_DELETE_STRICT
1643 ? ntohl(ofm->out_group)
1645 raw_flags = ofm->flags;
1649 if (raw == OFPRAW_OFPT10_FLOW_MOD) {
1650 /* Standard OpenFlow 1.0 flow_mod. */
1651 const struct ofp10_flow_mod *ofm;
1653 /* Get the ofp10_flow_mod. */
1654 ofm = ofpbuf_pull(&b, sizeof *ofm);
1656 /* Translate the rule. */
1657 ofputil_match_from_ofp10_match(&ofm->match, &fm->match);
1658 ofputil_normalize_match(&fm->match);
1660 /* OpenFlow 1.0 says that exact-match rules have to have the
1661 * highest possible priority. */
1662 fm->priority = (ofm->match.wildcards & htonl(OFPFW10_ALL)
1663 ? ntohs(ofm->priority)
1666 /* Translate the message. */
1667 command = ntohs(ofm->command);
1668 fm->cookie = htonll(0);
1669 fm->cookie_mask = htonll(0);
1670 fm->new_cookie = ofm->cookie;
1671 fm->idle_timeout = ntohs(ofm->idle_timeout);
1672 fm->hard_timeout = ntohs(ofm->hard_timeout);
1674 fm->buffer_id = ntohl(ofm->buffer_id);
1675 fm->out_port = u16_to_ofp(ntohs(ofm->out_port));
1676 fm->out_group = OFPG_ANY;
1677 raw_flags = ofm->flags;
1678 } else if (raw == OFPRAW_NXT_FLOW_MOD) {
1679 /* Nicira extended flow_mod. */
1680 const struct nx_flow_mod *nfm;
1682 /* Dissect the message. */
1683 nfm = ofpbuf_pull(&b, sizeof *nfm);
1684 error = nx_pull_match(&b, ntohs(nfm->match_len),
1685 &fm->match, &fm->cookie, &fm->cookie_mask);
1690 /* Translate the message. */
1691 command = ntohs(nfm->command);
1692 if ((command & 0xff) == OFPFC_ADD && fm->cookie_mask) {
1693 /* Flow additions may only set a new cookie, not match an
1694 * existing cookie. */
1695 return OFPERR_NXBRC_NXM_INVALID;
1697 fm->priority = ntohs(nfm->priority);
1698 fm->new_cookie = nfm->cookie;
1699 fm->idle_timeout = ntohs(nfm->idle_timeout);
1700 fm->hard_timeout = ntohs(nfm->hard_timeout);
1702 fm->buffer_id = ntohl(nfm->buffer_id);
1703 fm->out_port = u16_to_ofp(ntohs(nfm->out_port));
1704 fm->out_group = OFPG_ANY;
1705 raw_flags = nfm->flags;
1710 fm->modify_cookie = fm->new_cookie != OVS_BE64_MAX;
1711 if (protocol & OFPUTIL_P_TID) {
1712 fm->command = command & 0xff;
1713 fm->table_id = command >> 8;
1715 if (command > 0xff) {
1716 VLOG_WARN_RL(&bad_ofmsg_rl, "flow_mod has explicit table_id "
1717 "but flow_mod_table_id extension is not enabled");
1719 fm->command = command;
1720 fm->table_id = 0xff;
1724 if (fm->command > OFPFC_DELETE_STRICT) {
1725 return OFPERR_OFPFMFC_BAD_COMMAND;
1728 error = ofpacts_pull_openflow_instructions(&b, b.size,
1729 oh->version, ofpacts);
1733 fm->ofpacts = ofpacts->data;
1734 fm->ofpacts_len = ofpacts->size;
1736 error = ofputil_decode_flow_mod_flags(raw_flags, fm->command,
1737 oh->version, &fm->flags);
1742 if (fm->flags & OFPUTIL_FF_EMERG) {
1743 /* We do not support the OpenFlow 1.0 emergency flow cache, which
1744 * is not required in OpenFlow 1.0.1 and removed from OpenFlow 1.1.
1746 * OpenFlow 1.0 specifies the error code to use when idle_timeout
1747 * or hard_timeout is nonzero. Otherwise, there is no good error
1748 * code, so just state that the flow table is full. */
1749 return (fm->hard_timeout || fm->idle_timeout
1750 ? OFPERR_OFPFMFC_BAD_EMERG_TIMEOUT
1751 : OFPERR_OFPFMFC_TABLE_FULL);
1754 return ofpacts_check_consistency(fm->ofpacts, fm->ofpacts_len,
1755 &fm->match.flow, max_port,
1756 fm->table_id, max_table, protocol);
1760 ofputil_pull_bands(struct ofpbuf *msg, size_t len, uint16_t *n_bands,
1761 struct ofpbuf *bands)
1763 const struct ofp13_meter_band_header *ombh;
1764 struct ofputil_meter_band *mb;
1767 ombh = ofpbuf_try_pull(msg, len);
1769 return OFPERR_OFPBRC_BAD_LEN;
1772 while (len >= sizeof (struct ofp13_meter_band_drop)) {
1773 size_t ombh_len = ntohs(ombh->len);
1774 /* All supported band types have the same length. */
1775 if (ombh_len != sizeof (struct ofp13_meter_band_drop)) {
1776 return OFPERR_OFPBRC_BAD_LEN;
1778 mb = ofpbuf_put_uninit(bands, sizeof *mb);
1779 mb->type = ntohs(ombh->type);
1780 if (mb->type != OFPMBT13_DROP && mb->type != OFPMBT13_DSCP_REMARK) {
1781 return OFPERR_OFPMMFC_BAD_BAND;
1783 mb->rate = ntohl(ombh->rate);
1784 mb->burst_size = ntohl(ombh->burst_size);
1785 mb->prec_level = (mb->type == OFPMBT13_DSCP_REMARK) ?
1786 ((struct ofp13_meter_band_dscp_remark *)ombh)->prec_level : 0;
1789 ombh = ALIGNED_CAST(struct ofp13_meter_band_header *,
1790 (char *) ombh + ombh_len);
1793 return OFPERR_OFPBRC_BAD_LEN;
1800 ofputil_decode_meter_mod(const struct ofp_header *oh,
1801 struct ofputil_meter_mod *mm,
1802 struct ofpbuf *bands)
1804 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
1805 ofpraw_pull_assert(&b);
1806 const struct ofp13_meter_mod *omm = ofpbuf_pull(&b, sizeof *omm);
1808 /* Translate the message. */
1809 mm->command = ntohs(omm->command);
1810 if (mm->command != OFPMC13_ADD &&
1811 mm->command != OFPMC13_MODIFY &&
1812 mm->command != OFPMC13_DELETE) {
1813 return OFPERR_OFPMMFC_BAD_COMMAND;
1815 mm->meter.meter_id = ntohl(omm->meter_id);
1817 if (mm->command == OFPMC13_DELETE) {
1818 mm->meter.flags = 0;
1819 mm->meter.n_bands = 0;
1820 mm->meter.bands = NULL;
1824 mm->meter.flags = ntohs(omm->flags);
1825 if (mm->meter.flags & OFPMF13_KBPS &&
1826 mm->meter.flags & OFPMF13_PKTPS) {
1827 return OFPERR_OFPMMFC_BAD_FLAGS;
1829 mm->meter.bands = bands->data;
1831 error = ofputil_pull_bands(&b, b.size, &mm->meter.n_bands, bands);
1840 ofputil_decode_meter_request(const struct ofp_header *oh, uint32_t *meter_id)
1842 const struct ofp13_meter_multipart_request *omr = ofpmsg_body(oh);
1843 *meter_id = ntohl(omr->meter_id);
1847 ofputil_encode_meter_request(enum ofp_version ofp_version,
1848 enum ofputil_meter_request_type type,
1856 case OFPUTIL_METER_CONFIG:
1857 raw = OFPRAW_OFPST13_METER_CONFIG_REQUEST;
1859 case OFPUTIL_METER_STATS:
1860 raw = OFPRAW_OFPST13_METER_REQUEST;
1863 case OFPUTIL_METER_FEATURES:
1864 raw = OFPRAW_OFPST13_METER_FEATURES_REQUEST;
1868 msg = ofpraw_alloc(raw, ofp_version, 0);
1870 if (type != OFPUTIL_METER_FEATURES) {
1871 struct ofp13_meter_multipart_request *omr;
1872 omr = ofpbuf_put_zeros(msg, sizeof *omr);
1873 omr->meter_id = htonl(meter_id);
1879 ofputil_put_bands(uint16_t n_bands, const struct ofputil_meter_band *mb,
1884 for (n = 0; n < n_bands; ++n) {
1885 /* Currently all band types have same size. */
1886 struct ofp13_meter_band_dscp_remark *ombh;
1887 size_t ombh_len = sizeof *ombh;
1889 ombh = ofpbuf_put_zeros(msg, ombh_len);
1891 ombh->type = htons(mb->type);
1892 ombh->len = htons(ombh_len);
1893 ombh->rate = htonl(mb->rate);
1894 ombh->burst_size = htonl(mb->burst_size);
1895 ombh->prec_level = mb->prec_level;
1901 /* Encode a meter stat for 'mc' and append it to 'replies'. */
1903 ofputil_append_meter_config(struct ovs_list *replies,
1904 const struct ofputil_meter_config *mc)
1906 struct ofpbuf *msg = ofpbuf_from_list(ovs_list_back(replies));
1907 size_t start_ofs = msg->size;
1908 struct ofp13_meter_config *reply;
1910 ofpbuf_put_uninit(msg, sizeof *reply);
1911 ofputil_put_bands(mc->n_bands, mc->bands, msg);
1913 reply = ofpbuf_at_assert(msg, start_ofs, sizeof *reply);
1914 reply->flags = htons(mc->flags);
1915 reply->meter_id = htonl(mc->meter_id);
1916 reply->length = htons(msg->size - start_ofs);
1918 ofpmp_postappend(replies, start_ofs);
1921 /* Encode a meter stat for 'ms' and append it to 'replies'. */
1923 ofputil_append_meter_stats(struct ovs_list *replies,
1924 const struct ofputil_meter_stats *ms)
1926 struct ofp13_meter_stats *reply;
1930 len = sizeof *reply + ms->n_bands * sizeof(struct ofp13_meter_band_stats);
1931 reply = ofpmp_append(replies, len);
1933 reply->meter_id = htonl(ms->meter_id);
1934 reply->len = htons(len);
1935 memset(reply->pad, 0, sizeof reply->pad);
1936 reply->flow_count = htonl(ms->flow_count);
1937 reply->packet_in_count = htonll(ms->packet_in_count);
1938 reply->byte_in_count = htonll(ms->byte_in_count);
1939 reply->duration_sec = htonl(ms->duration_sec);
1940 reply->duration_nsec = htonl(ms->duration_nsec);
1942 for (n = 0; n < ms->n_bands; ++n) {
1943 const struct ofputil_meter_band_stats *src = &ms->bands[n];
1944 struct ofp13_meter_band_stats *dst = &reply->band_stats[n];
1946 dst->packet_band_count = htonll(src->packet_count);
1947 dst->byte_band_count = htonll(src->byte_count);
1951 /* Converts an OFPMP_METER_CONFIG reply in 'msg' into an abstract
1952 * ofputil_meter_config in 'mc', with mc->bands pointing to bands decoded into
1953 * 'bands'. The caller must have initialized 'bands' and retains ownership of
1954 * it across the call.
1956 * Multiple OFPST13_METER_CONFIG replies can be packed into a single OpenFlow
1957 * message. Calling this function multiple times for a single 'msg' iterates
1958 * through the replies. 'bands' is cleared for each reply.
1960 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1961 * otherwise a positive errno value. */
1963 ofputil_decode_meter_config(struct ofpbuf *msg,
1964 struct ofputil_meter_config *mc,
1965 struct ofpbuf *bands)
1967 const struct ofp13_meter_config *omc;
1970 /* Pull OpenFlow headers for the first call. */
1972 ofpraw_pull_assert(msg);
1979 omc = ofpbuf_try_pull(msg, sizeof *omc);
1981 VLOG_WARN_RL(&bad_ofmsg_rl,
1982 "OFPMP_METER_CONFIG reply has %"PRIu32" leftover bytes at end",
1984 return OFPERR_OFPBRC_BAD_LEN;
1987 ofpbuf_clear(bands);
1988 err = ofputil_pull_bands(msg, ntohs(omc->length) - sizeof *omc,
1989 &mc->n_bands, bands);
1993 mc->meter_id = ntohl(omc->meter_id);
1994 mc->flags = ntohs(omc->flags);
1995 mc->bands = bands->data;
2001 ofputil_pull_band_stats(struct ofpbuf *msg, size_t len, uint16_t *n_bands,
2002 struct ofpbuf *bands)
2004 const struct ofp13_meter_band_stats *ombs;
2005 struct ofputil_meter_band_stats *mbs;
2008 ombs = ofpbuf_try_pull(msg, len);
2010 return OFPERR_OFPBRC_BAD_LEN;
2013 n = len / sizeof *ombs;
2014 if (len != n * sizeof *ombs) {
2015 return OFPERR_OFPBRC_BAD_LEN;
2018 mbs = ofpbuf_put_uninit(bands, len);
2020 for (i = 0; i < n; ++i) {
2021 mbs[i].packet_count = ntohll(ombs[i].packet_band_count);
2022 mbs[i].byte_count = ntohll(ombs[i].byte_band_count);
2028 /* Converts an OFPMP_METER reply in 'msg' into an abstract
2029 * ofputil_meter_stats in 'ms', with ms->bands pointing to band stats
2030 * decoded into 'bands'.
2032 * Multiple OFPMP_METER replies can be packed into a single OpenFlow
2033 * message. Calling this function multiple times for a single 'msg' iterates
2034 * through the replies. 'bands' is cleared for each reply.
2036 * Returns 0 if successful, EOF if no replies were left in this 'msg',
2037 * otherwise a positive errno value. */
2039 ofputil_decode_meter_stats(struct ofpbuf *msg,
2040 struct ofputil_meter_stats *ms,
2041 struct ofpbuf *bands)
2043 const struct ofp13_meter_stats *oms;
2046 /* Pull OpenFlow headers for the first call. */
2048 ofpraw_pull_assert(msg);
2055 oms = ofpbuf_try_pull(msg, sizeof *oms);
2057 VLOG_WARN_RL(&bad_ofmsg_rl,
2058 "OFPMP_METER reply has %"PRIu32" leftover bytes at end",
2060 return OFPERR_OFPBRC_BAD_LEN;
2063 ofpbuf_clear(bands);
2064 err = ofputil_pull_band_stats(msg, ntohs(oms->len) - sizeof *oms,
2065 &ms->n_bands, bands);
2069 ms->meter_id = ntohl(oms->meter_id);
2070 ms->flow_count = ntohl(oms->flow_count);
2071 ms->packet_in_count = ntohll(oms->packet_in_count);
2072 ms->byte_in_count = ntohll(oms->byte_in_count);
2073 ms->duration_sec = ntohl(oms->duration_sec);
2074 ms->duration_nsec = ntohl(oms->duration_nsec);
2075 ms->bands = bands->data;
2081 ofputil_decode_meter_features(const struct ofp_header *oh,
2082 struct ofputil_meter_features *mf)
2084 const struct ofp13_meter_features *omf = ofpmsg_body(oh);
2086 mf->max_meters = ntohl(omf->max_meter);
2087 mf->band_types = ntohl(omf->band_types);
2088 mf->capabilities = ntohl(omf->capabilities);
2089 mf->max_bands = omf->max_bands;
2090 mf->max_color = omf->max_color;
2094 ofputil_encode_meter_features_reply(const struct ofputil_meter_features *mf,
2095 const struct ofp_header *request)
2097 struct ofpbuf *reply;
2098 struct ofp13_meter_features *omf;
2100 reply = ofpraw_alloc_stats_reply(request, 0);
2101 omf = ofpbuf_put_zeros(reply, sizeof *omf);
2103 omf->max_meter = htonl(mf->max_meters);
2104 omf->band_types = htonl(mf->band_types);
2105 omf->capabilities = htonl(mf->capabilities);
2106 omf->max_bands = mf->max_bands;
2107 omf->max_color = mf->max_color;
2113 ofputil_encode_meter_mod(enum ofp_version ofp_version,
2114 const struct ofputil_meter_mod *mm)
2118 struct ofp13_meter_mod *omm;
2120 msg = ofpraw_alloc(OFPRAW_OFPT13_METER_MOD, ofp_version,
2121 NXM_TYPICAL_LEN + mm->meter.n_bands * 16);
2122 omm = ofpbuf_put_zeros(msg, sizeof *omm);
2123 omm->command = htons(mm->command);
2124 if (mm->command != OFPMC13_DELETE) {
2125 omm->flags = htons(mm->meter.flags);
2127 omm->meter_id = htonl(mm->meter.meter_id);
2129 ofputil_put_bands(mm->meter.n_bands, mm->meter.bands, msg);
2131 ofpmsg_update_length(msg);
2136 ofputil_tid_command(const struct ofputil_flow_mod *fm,
2137 enum ofputil_protocol protocol)
2139 return htons(protocol & OFPUTIL_P_TID
2140 ? (fm->command & 0xff) | (fm->table_id << 8)
2144 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
2145 * 'protocol' and returns the message. */
2147 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
2148 enum ofputil_protocol protocol)
2150 enum ofp_version version = ofputil_protocol_to_ofp_version(protocol);
2151 ovs_be16 raw_flags = ofputil_encode_flow_mod_flags(fm->flags, version);
2155 case OFPUTIL_P_OF11_STD:
2156 case OFPUTIL_P_OF12_OXM:
2157 case OFPUTIL_P_OF13_OXM:
2158 case OFPUTIL_P_OF14_OXM:
2159 case OFPUTIL_P_OF15_OXM:
2160 case OFPUTIL_P_OF16_OXM: {
2161 struct ofp11_flow_mod *ofm;
2164 tailroom = ofputil_match_typical_len(protocol) + fm->ofpacts_len;
2165 msg = ofpraw_alloc(OFPRAW_OFPT11_FLOW_MOD, version, tailroom);
2166 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
2167 if ((protocol == OFPUTIL_P_OF11_STD
2168 && (fm->command == OFPFC_MODIFY ||
2169 fm->command == OFPFC_MODIFY_STRICT)
2170 && fm->cookie_mask == htonll(0))
2171 || fm->command == OFPFC_ADD) {
2172 ofm->cookie = fm->new_cookie;
2174 ofm->cookie = fm->cookie & fm->cookie_mask;
2176 ofm->cookie_mask = fm->cookie_mask;
2177 if (fm->table_id != OFPTT_ALL
2178 || (protocol != OFPUTIL_P_OF11_STD
2179 && (fm->command == OFPFC_DELETE ||
2180 fm->command == OFPFC_DELETE_STRICT))) {
2181 ofm->table_id = fm->table_id;
2185 ofm->command = fm->command;
2186 ofm->idle_timeout = htons(fm->idle_timeout);
2187 ofm->hard_timeout = htons(fm->hard_timeout);
2188 ofm->priority = htons(fm->priority);
2189 ofm->buffer_id = htonl(fm->buffer_id);
2190 ofm->out_port = ofputil_port_to_ofp11(fm->out_port);
2191 ofm->out_group = htonl(fm->out_group);
2192 ofm->flags = raw_flags;
2193 if (version >= OFP14_VERSION && fm->command == OFPFC_ADD) {
2194 ofm->importance = htons(fm->importance);
2196 ofm->importance = 0;
2198 ofputil_put_ofp11_match(msg, &fm->match, protocol);
2199 ofpacts_put_openflow_instructions(fm->ofpacts, fm->ofpacts_len, msg,
2204 case OFPUTIL_P_OF10_STD:
2205 case OFPUTIL_P_OF10_STD_TID: {
2206 struct ofp10_flow_mod *ofm;
2208 msg = ofpraw_alloc(OFPRAW_OFPT10_FLOW_MOD, OFP10_VERSION,
2210 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
2211 ofputil_match_to_ofp10_match(&fm->match, &ofm->match);
2212 ofm->cookie = fm->new_cookie;
2213 ofm->command = ofputil_tid_command(fm, protocol);
2214 ofm->idle_timeout = htons(fm->idle_timeout);
2215 ofm->hard_timeout = htons(fm->hard_timeout);
2216 ofm->priority = htons(fm->priority);
2217 ofm->buffer_id = htonl(fm->buffer_id);
2218 ofm->out_port = htons(ofp_to_u16(fm->out_port));
2219 ofm->flags = raw_flags;
2220 ofpacts_put_openflow_actions(fm->ofpacts, fm->ofpacts_len, msg,
2225 case OFPUTIL_P_OF10_NXM:
2226 case OFPUTIL_P_OF10_NXM_TID: {
2227 struct nx_flow_mod *nfm;
2230 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD, OFP10_VERSION,
2231 NXM_TYPICAL_LEN + fm->ofpacts_len);
2232 nfm = ofpbuf_put_zeros(msg, sizeof *nfm);
2233 nfm->command = ofputil_tid_command(fm, protocol);
2234 nfm->cookie = fm->new_cookie;
2235 match_len = nx_put_match(msg, &fm->match, fm->cookie, fm->cookie_mask);
2237 nfm->idle_timeout = htons(fm->idle_timeout);
2238 nfm->hard_timeout = htons(fm->hard_timeout);
2239 nfm->priority = htons(fm->priority);
2240 nfm->buffer_id = htonl(fm->buffer_id);
2241 nfm->out_port = htons(ofp_to_u16(fm->out_port));
2242 nfm->flags = raw_flags;
2243 nfm->match_len = htons(match_len);
2244 ofpacts_put_openflow_actions(fm->ofpacts, fm->ofpacts_len, msg,
2253 ofpmsg_update_length(msg);
2258 ofputil_decode_ofpst10_flow_request(struct ofputil_flow_stats_request *fsr,
2259 const struct ofp10_flow_stats_request *ofsr,
2262 fsr->aggregate = aggregate;
2263 ofputil_match_from_ofp10_match(&ofsr->match, &fsr->match);
2264 fsr->out_port = u16_to_ofp(ntohs(ofsr->out_port));
2265 fsr->out_group = OFPG_ANY;
2266 fsr->table_id = ofsr->table_id;
2267 fsr->cookie = fsr->cookie_mask = htonll(0);
2273 ofputil_decode_ofpst11_flow_request(struct ofputil_flow_stats_request *fsr,
2274 struct ofpbuf *b, bool aggregate)
2276 const struct ofp11_flow_stats_request *ofsr;
2279 ofsr = ofpbuf_pull(b, sizeof *ofsr);
2280 fsr->aggregate = aggregate;
2281 fsr->table_id = ofsr->table_id;
2282 error = ofputil_port_from_ofp11(ofsr->out_port, &fsr->out_port);
2286 fsr->out_group = ntohl(ofsr->out_group);
2287 fsr->cookie = ofsr->cookie;
2288 fsr->cookie_mask = ofsr->cookie_mask;
2289 error = ofputil_pull_ofp11_match(b, &fsr->match, NULL);
2298 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
2299 struct ofpbuf *b, bool aggregate)
2301 const struct nx_flow_stats_request *nfsr;
2304 nfsr = ofpbuf_pull(b, sizeof *nfsr);
2305 error = nx_pull_match(b, ntohs(nfsr->match_len), &fsr->match,
2306 &fsr->cookie, &fsr->cookie_mask);
2311 return OFPERR_OFPBRC_BAD_LEN;
2314 fsr->aggregate = aggregate;
2315 fsr->out_port = u16_to_ofp(ntohs(nfsr->out_port));
2316 fsr->out_group = OFPG_ANY;
2317 fsr->table_id = nfsr->table_id;
2322 /* Constructs and returns an OFPT_QUEUE_GET_CONFIG request for the specified
2323 * 'port' and 'queue', suitable for OpenFlow version 'version'.
2325 * 'queue' is honored only for OpenFlow 1.4 and later; older versions always
2326 * request all queues. */
2328 ofputil_encode_queue_get_config_request(enum ofp_version version,
2332 struct ofpbuf *request;
2334 if (version == OFP10_VERSION) {
2335 struct ofp10_queue_get_config_request *qgcr10;
2337 request = ofpraw_alloc(OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST,
2339 qgcr10 = ofpbuf_put_zeros(request, sizeof *qgcr10);
2340 qgcr10->port = htons(ofp_to_u16(port));
2341 } else if (version < OFP14_VERSION) {
2342 struct ofp11_queue_get_config_request *qgcr11;
2344 request = ofpraw_alloc(OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST,
2346 qgcr11 = ofpbuf_put_zeros(request, sizeof *qgcr11);
2347 qgcr11->port = ofputil_port_to_ofp11(port);
2349 struct ofp14_queue_desc_request *qdr14;
2351 request = ofpraw_alloc(OFPRAW_OFPST14_QUEUE_DESC_REQUEST,
2353 qdr14 = ofpbuf_put_zeros(request, sizeof *qdr14);
2354 qdr14->port = ofputil_port_to_ofp11(port);
2355 qdr14->queue = htonl(queue);
2361 /* Parses OFPT_QUEUE_GET_CONFIG request 'oh', storing the port specified by the
2362 * request into '*port'. Returns 0 if successful, otherwise an OpenFlow error
2365 ofputil_decode_queue_get_config_request(const struct ofp_header *oh,
2366 ofp_port_t *port, uint32_t *queue)
2368 const struct ofp10_queue_get_config_request *qgcr10;
2369 const struct ofp11_queue_get_config_request *qgcr11;
2370 const struct ofp14_queue_desc_request *qdr14;
2371 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
2372 enum ofpraw raw = ofpraw_pull_assert(&b);
2374 switch ((int) raw) {
2375 case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST:
2377 *port = u16_to_ofp(ntohs(qgcr10->port));
2381 case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST:
2384 enum ofperr error = ofputil_port_from_ofp11(qgcr11->port, port);
2385 if (error || *port == OFPP_ANY) {
2390 case OFPRAW_OFPST14_QUEUE_DESC_REQUEST:
2392 *queue = ntohl(qdr14->queue);
2393 return ofputil_port_from_ofp11(qdr14->port, port);
2399 return (ofp_to_u16(*port) < ofp_to_u16(OFPP_MAX)
2401 : OFPERR_OFPQOFC_BAD_PORT);
2404 /* Constructs and returns the beginning of a reply to
2405 * OFPT_QUEUE_GET_CONFIG_REQUEST or OFPMP_QUEUE_DESC request 'oh'. The caller
2406 * may append information about individual queues with
2407 * ofputil_append_queue_get_config_reply(). */
2409 ofputil_start_queue_get_config_reply(const struct ofp_header *request,
2410 struct ovs_list *replies)
2412 struct ofpbuf *reply;
2417 error = ofputil_decode_queue_get_config_request(request, &port, &queue);
2420 enum ofpraw raw = ofpraw_decode_assert(request);
2421 switch ((int) raw) {
2422 case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST:
2423 reply = ofpraw_alloc_reply(OFPRAW_OFPT10_QUEUE_GET_CONFIG_REPLY,
2425 struct ofp10_queue_get_config_reply *qgcr10
2426 = ofpbuf_put_zeros(reply, sizeof *qgcr10);
2427 qgcr10->port = htons(ofp_to_u16(port));
2430 case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST:
2431 reply = ofpraw_alloc_reply(OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY,
2433 struct ofp11_queue_get_config_reply *qgcr11
2434 = ofpbuf_put_zeros(reply, sizeof *qgcr11);
2435 qgcr11->port = ofputil_port_to_ofp11(port);
2438 case OFPRAW_OFPST14_QUEUE_DESC_REQUEST:
2439 reply = ofpraw_alloc_stats_reply(request, 0);
2446 ovs_list_init(replies);
2447 ovs_list_push_back(replies, &reply->list_node);
2451 put_ofp10_queue_rate(struct ofpbuf *reply,
2452 enum ofp10_queue_properties property, uint16_t rate)
2454 if (rate != UINT16_MAX) {
2455 struct ofp10_queue_prop_rate *oqpr;
2457 oqpr = ofpbuf_put_zeros(reply, sizeof *oqpr);
2458 oqpr->prop_header.property = htons(property);
2459 oqpr->prop_header.len = htons(sizeof *oqpr);
2460 oqpr->rate = htons(rate);
2465 put_ofp14_queue_rate(struct ofpbuf *reply,
2466 enum ofp14_queue_desc_prop_type type, uint16_t rate)
2468 if (rate != UINT16_MAX) {
2469 ofpprop_put_u16(reply, type, rate);
2474 ofputil_append_queue_get_config_reply(const struct ofputil_queue_config *qc,
2475 struct ovs_list *replies)
2477 enum ofp_version ofp_version = ofpmp_version(replies);
2478 struct ofpbuf *reply = ofpbuf_from_list(ovs_list_back(replies));
2479 size_t start_ofs = reply->size;
2483 if (ofp_version < OFP14_VERSION) {
2484 if (ofp_version < OFP12_VERSION) {
2485 struct ofp10_packet_queue *opq10;
2487 opq10 = ofpbuf_put_zeros(reply, sizeof *opq10);
2488 opq10->queue_id = htonl(qc->queue);
2489 len_ofs = (char *) &opq10->len - (char *) reply->data;
2491 struct ofp12_packet_queue *opq12;
2493 opq12 = ofpbuf_put_zeros(reply, sizeof *opq12);
2494 opq12->port = ofputil_port_to_ofp11(qc->port);
2495 opq12->queue_id = htonl(qc->queue);
2496 len_ofs = (char *) &opq12->len - (char *) reply->data;
2499 put_ofp10_queue_rate(reply, OFPQT10_MIN_RATE, qc->min_rate);
2500 put_ofp10_queue_rate(reply, OFPQT11_MAX_RATE, qc->max_rate);
2502 struct ofp14_queue_desc *oqd = ofpbuf_put_zeros(reply, sizeof *oqd);
2503 oqd->port_no = ofputil_port_to_ofp11(qc->port);
2504 oqd->queue_id = htonl(qc->queue);
2505 len_ofs = (char *) &oqd->len - (char *) reply->data;
2506 put_ofp14_queue_rate(reply, OFPQDPT14_MIN_RATE, qc->min_rate);
2507 put_ofp14_queue_rate(reply, OFPQDPT14_MAX_RATE, qc->max_rate);
2510 len = ofpbuf_at(reply, len_ofs, sizeof *len);
2511 *len = htons(reply->size - start_ofs);
2513 if (ofp_version >= OFP14_VERSION) {
2514 ofpmp_postappend(replies, start_ofs);
2519 parse_ofp10_queue_rate(const struct ofp10_queue_prop_header *hdr,
2522 const struct ofp10_queue_prop_rate *oqpr;
2524 if (hdr->len == htons(sizeof *oqpr)) {
2525 oqpr = (const struct ofp10_queue_prop_rate *) hdr;
2526 *rate = ntohs(oqpr->rate);
2529 return OFPERR_OFPBRC_BAD_LEN;
2534 ofputil_pull_queue_get_config_reply10(struct ofpbuf *msg,
2535 struct ofputil_queue_config *queue)
2537 const struct ofp_header *oh = msg->header;
2538 unsigned int opq_len; /* Length of protocol-specific queue header. */
2539 unsigned int len; /* Total length of queue + properties. */
2541 /* Obtain the port number from the message header. */
2542 if (oh->version == OFP10_VERSION) {
2543 const struct ofp10_queue_get_config_reply *oqgcr10 = msg->msg;
2544 queue->port = u16_to_ofp(ntohs(oqgcr10->port));
2546 const struct ofp11_queue_get_config_reply *oqgcr11 = msg->msg;
2547 enum ofperr error = ofputil_port_from_ofp11(oqgcr11->port,
2554 /* Pull off the queue header and get the queue number and length. */
2555 if (oh->version < OFP12_VERSION) {
2556 const struct ofp10_packet_queue *opq10;
2557 opq10 = ofpbuf_try_pull(msg, sizeof *opq10);
2559 return OFPERR_OFPBRC_BAD_LEN;
2561 queue->queue = ntohl(opq10->queue_id);
2562 len = ntohs(opq10->len);
2563 opq_len = sizeof *opq10;
2565 const struct ofp12_packet_queue *opq12;
2566 opq12 = ofpbuf_try_pull(msg, sizeof *opq12);
2568 return OFPERR_OFPBRC_BAD_LEN;
2570 queue->queue = ntohl(opq12->queue_id);
2571 len = ntohs(opq12->len);
2572 opq_len = sizeof *opq12;
2576 if (len < opq_len || len > msg->size + opq_len || len % 8) {
2577 return OFPERR_OFPBRC_BAD_LEN;
2581 /* Pull properties. The format of these properties differs from used in
2582 * OF1.4+ so we can't use the common property functions. */
2584 const struct ofp10_queue_prop_header *hdr;
2585 unsigned int property;
2586 unsigned int prop_len;
2587 enum ofperr error = 0;
2589 hdr = ofpbuf_at_assert(msg, 0, sizeof *hdr);
2590 prop_len = ntohs(hdr->len);
2591 if (prop_len < sizeof *hdr || prop_len > msg->size || prop_len % 8) {
2592 return OFPERR_OFPBRC_BAD_LEN;
2595 property = ntohs(hdr->property);
2597 case OFPQT10_MIN_RATE:
2598 error = parse_ofp10_queue_rate(hdr, &queue->min_rate);
2601 case OFPQT11_MAX_RATE:
2602 error = parse_ofp10_queue_rate(hdr, &queue->max_rate);
2606 VLOG_INFO_RL(&bad_ofmsg_rl, "unknown queue property %u", property);
2613 ofpbuf_pull(msg, prop_len);
2620 ofputil_pull_queue_get_config_reply14(struct ofpbuf *msg,
2621 struct ofputil_queue_config *queue)
2623 struct ofp14_queue_desc *oqd14 = ofpbuf_try_pull(msg, sizeof *oqd14);
2625 return OFPERR_OFPBRC_BAD_LEN;
2627 enum ofperr error = ofputil_port_from_ofp11(oqd14->port_no, &queue->port);
2631 queue->queue = ntohl(oqd14->queue_id);
2634 unsigned int len = ntohs(oqd14->len);
2635 if (len < sizeof *oqd14 || len > msg->size + sizeof *oqd14 || len % 8) {
2636 return OFPERR_OFPBRC_BAD_LEN;
2638 len -= sizeof *oqd14;
2640 struct ofpbuf properties = ofpbuf_const_initializer(ofpbuf_pull(msg, len),
2642 while (properties.size > 0) {
2643 struct ofpbuf payload;
2646 error = ofpprop_pull(&properties, &payload, &type);
2652 case OFPQDPT14_MIN_RATE:
2653 error = ofpprop_parse_u16(&payload, &queue->min_rate);
2656 case OFPQDPT14_MAX_RATE:
2657 error = ofpprop_parse_u16(&payload, &queue->max_rate);
2661 error = OFPPROP_UNKNOWN(true, "queue desc", type);
2673 /* Decodes information about a queue from the OFPT_QUEUE_GET_CONFIG_REPLY in
2674 * 'reply' and stores it in '*queue'. ofputil_decode_queue_get_config_reply()
2675 * must already have pulled off the main header.
2677 * This function returns EOF if the last queue has already been decoded, 0 if a
2678 * queue was successfully decoded into '*queue', or an ofperr if there was a
2679 * problem decoding 'reply'. */
2681 ofputil_pull_queue_get_config_reply(struct ofpbuf *msg,
2682 struct ofputil_queue_config *queue)
2686 /* Pull OpenFlow header. */
2687 raw = ofpraw_pull_assert(msg);
2689 /* Pull protocol-specific ofp_queue_get_config_reply header (OF1.4
2690 * doesn't have one at all). */
2691 if (raw == OFPRAW_OFPT10_QUEUE_GET_CONFIG_REPLY) {
2692 ofpbuf_pull(msg, sizeof(struct ofp10_queue_get_config_reply));
2693 } else if (raw == OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY) {
2694 ofpbuf_pull(msg, sizeof(struct ofp11_queue_get_config_reply));
2696 ovs_assert(raw == OFPRAW_OFPST14_QUEUE_DESC_REPLY);
2699 raw = ofpraw_decode_assert(msg->header);
2702 queue->min_rate = UINT16_MAX;
2703 queue->max_rate = UINT16_MAX;
2707 } else if (raw == OFPRAW_OFPST14_QUEUE_DESC_REPLY) {
2708 return ofputil_pull_queue_get_config_reply14(msg, queue);
2710 return ofputil_pull_queue_get_config_reply10(msg, queue);
2714 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
2715 * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
2716 * successful, otherwise an OpenFlow error code. */
2718 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
2719 const struct ofp_header *oh)
2721 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
2722 enum ofpraw raw = ofpraw_pull_assert(&b);
2723 switch ((int) raw) {
2724 case OFPRAW_OFPST10_FLOW_REQUEST:
2725 return ofputil_decode_ofpst10_flow_request(fsr, b.data, false);
2727 case OFPRAW_OFPST10_AGGREGATE_REQUEST:
2728 return ofputil_decode_ofpst10_flow_request(fsr, b.data, true);
2730 case OFPRAW_OFPST11_FLOW_REQUEST:
2731 return ofputil_decode_ofpst11_flow_request(fsr, &b, false);
2733 case OFPRAW_OFPST11_AGGREGATE_REQUEST:
2734 return ofputil_decode_ofpst11_flow_request(fsr, &b, true);
2736 case OFPRAW_NXST_FLOW_REQUEST:
2737 return ofputil_decode_nxst_flow_request(fsr, &b, false);
2739 case OFPRAW_NXST_AGGREGATE_REQUEST:
2740 return ofputil_decode_nxst_flow_request(fsr, &b, true);
2743 /* Hey, the caller lied. */
2748 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
2749 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
2750 * 'protocol', and returns the message. */
2752 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
2753 enum ofputil_protocol protocol)
2759 case OFPUTIL_P_OF11_STD:
2760 case OFPUTIL_P_OF12_OXM:
2761 case OFPUTIL_P_OF13_OXM:
2762 case OFPUTIL_P_OF14_OXM:
2763 case OFPUTIL_P_OF15_OXM:
2764 case OFPUTIL_P_OF16_OXM: {
2765 struct ofp11_flow_stats_request *ofsr;
2767 raw = (fsr->aggregate
2768 ? OFPRAW_OFPST11_AGGREGATE_REQUEST
2769 : OFPRAW_OFPST11_FLOW_REQUEST);
2770 msg = ofpraw_alloc(raw, ofputil_protocol_to_ofp_version(protocol),
2771 ofputil_match_typical_len(protocol));
2772 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
2773 ofsr->table_id = fsr->table_id;
2774 ofsr->out_port = ofputil_port_to_ofp11(fsr->out_port);
2775 ofsr->out_group = htonl(fsr->out_group);
2776 ofsr->cookie = fsr->cookie;
2777 ofsr->cookie_mask = fsr->cookie_mask;
2778 ofputil_put_ofp11_match(msg, &fsr->match, protocol);
2782 case OFPUTIL_P_OF10_STD:
2783 case OFPUTIL_P_OF10_STD_TID: {
2784 struct ofp10_flow_stats_request *ofsr;
2786 raw = (fsr->aggregate
2787 ? OFPRAW_OFPST10_AGGREGATE_REQUEST
2788 : OFPRAW_OFPST10_FLOW_REQUEST);
2789 msg = ofpraw_alloc(raw, OFP10_VERSION, 0);
2790 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
2791 ofputil_match_to_ofp10_match(&fsr->match, &ofsr->match);
2792 ofsr->table_id = fsr->table_id;
2793 ofsr->out_port = htons(ofp_to_u16(fsr->out_port));
2797 case OFPUTIL_P_OF10_NXM:
2798 case OFPUTIL_P_OF10_NXM_TID: {
2799 struct nx_flow_stats_request *nfsr;
2802 raw = (fsr->aggregate
2803 ? OFPRAW_NXST_AGGREGATE_REQUEST
2804 : OFPRAW_NXST_FLOW_REQUEST);
2805 msg = ofpraw_alloc(raw, OFP10_VERSION, NXM_TYPICAL_LEN);
2806 ofpbuf_put_zeros(msg, sizeof *nfsr);
2807 match_len = nx_put_match(msg, &fsr->match,
2808 fsr->cookie, fsr->cookie_mask);
2811 nfsr->out_port = htons(ofp_to_u16(fsr->out_port));
2812 nfsr->match_len = htons(match_len);
2813 nfsr->table_id = fsr->table_id;
2824 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
2825 * ofputil_flow_stats in 'fs'.
2827 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
2828 * OpenFlow message. Calling this function multiple times for a single 'msg'
2829 * iterates through the replies. The caller must initially leave 'msg''s layer
2830 * pointers null and not modify them between calls.
2832 * Most switches don't send the values needed to populate fs->idle_age and
2833 * fs->hard_age, so those members will usually be set to 0. If the switch from
2834 * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
2835 * 'flow_age_extension' as true so that the contents of 'msg' determine the
2836 * 'idle_age' and 'hard_age' members in 'fs'.
2838 * Uses 'ofpacts' to store the abstract OFPACT_* version of the flow stats
2839 * reply's actions. The caller must initialize 'ofpacts' and retains ownership
2840 * of it. 'fs->ofpacts' will point into the 'ofpacts' buffer.
2842 * Returns 0 if successful, EOF if no replies were left in this 'msg',
2843 * otherwise a positive errno value. */
2845 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
2847 bool flow_age_extension,
2848 struct ofpbuf *ofpacts)
2850 const struct ofp_header *oh;
2851 size_t instructions_len;
2855 error = (msg->header ? ofpraw_decode(&raw, msg->header)
2856 : ofpraw_pull(&raw, msg));
2864 } else if (raw == OFPRAW_OFPST11_FLOW_REPLY
2865 || raw == OFPRAW_OFPST13_FLOW_REPLY) {
2866 const struct ofp11_flow_stats *ofs;
2868 uint16_t padded_match_len;
2870 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2872 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %"PRIu32" leftover "
2873 "bytes at end", msg->size);
2877 length = ntohs(ofs->length);
2878 if (length < sizeof *ofs) {
2879 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2880 "length %"PRIuSIZE, length);
2884 if (ofputil_pull_ofp11_match(msg, &fs->match, &padded_match_len)) {
2885 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad match");
2888 instructions_len = length - sizeof *ofs - padded_match_len;
2890 fs->priority = ntohs(ofs->priority);
2891 fs->table_id = ofs->table_id;
2892 fs->duration_sec = ntohl(ofs->duration_sec);
2893 fs->duration_nsec = ntohl(ofs->duration_nsec);
2894 fs->idle_timeout = ntohs(ofs->idle_timeout);
2895 fs->hard_timeout = ntohs(ofs->hard_timeout);
2896 if (oh->version >= OFP14_VERSION) {
2897 fs->importance = ntohs(ofs->importance);
2901 if (raw == OFPRAW_OFPST13_FLOW_REPLY) {
2902 error = ofputil_decode_flow_mod_flags(ofs->flags, -1, oh->version,
2912 fs->cookie = ofs->cookie;
2913 fs->packet_count = ntohll(ofs->packet_count);
2914 fs->byte_count = ntohll(ofs->byte_count);
2915 } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
2916 const struct ofp10_flow_stats *ofs;
2919 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2921 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %"PRIu32" leftover "
2922 "bytes at end", msg->size);
2926 length = ntohs(ofs->length);
2927 if (length < sizeof *ofs) {
2928 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2929 "length %"PRIuSIZE, length);
2932 instructions_len = length - sizeof *ofs;
2934 fs->cookie = get_32aligned_be64(&ofs->cookie);
2935 ofputil_match_from_ofp10_match(&ofs->match, &fs->match);
2936 fs->priority = ntohs(ofs->priority);
2937 fs->table_id = ofs->table_id;
2938 fs->duration_sec = ntohl(ofs->duration_sec);
2939 fs->duration_nsec = ntohl(ofs->duration_nsec);
2940 fs->idle_timeout = ntohs(ofs->idle_timeout);
2941 fs->hard_timeout = ntohs(ofs->hard_timeout);
2945 fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
2946 fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
2948 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
2949 const struct nx_flow_stats *nfs;
2950 size_t match_len, length;
2952 nfs = ofpbuf_try_pull(msg, sizeof *nfs);
2954 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %"PRIu32" leftover "
2955 "bytes at end", msg->size);
2959 length = ntohs(nfs->length);
2960 match_len = ntohs(nfs->match_len);
2961 if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
2962 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%"PRIuSIZE" "
2963 "claims invalid length %"PRIuSIZE, match_len, length);
2966 if (nx_pull_match(msg, match_len, &fs->match, NULL, NULL)) {
2969 instructions_len = length - sizeof *nfs - ROUND_UP(match_len, 8);
2971 fs->cookie = nfs->cookie;
2972 fs->table_id = nfs->table_id;
2973 fs->duration_sec = ntohl(nfs->duration_sec);
2974 fs->duration_nsec = ntohl(nfs->duration_nsec);
2975 fs->priority = ntohs(nfs->priority);
2976 fs->idle_timeout = ntohs(nfs->idle_timeout);
2977 fs->hard_timeout = ntohs(nfs->hard_timeout);
2981 if (flow_age_extension) {
2982 if (nfs->idle_age) {
2983 fs->idle_age = ntohs(nfs->idle_age) - 1;
2985 if (nfs->hard_age) {
2986 fs->hard_age = ntohs(nfs->hard_age) - 1;
2989 fs->packet_count = ntohll(nfs->packet_count);
2990 fs->byte_count = ntohll(nfs->byte_count);
2996 if (ofpacts_pull_openflow_instructions(msg, instructions_len, oh->version,
2998 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad instructions");
3001 fs->ofpacts = ofpacts->data;
3002 fs->ofpacts_len = ofpacts->size;
3007 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
3009 * We use this in situations where OVS internally uses UINT64_MAX to mean
3010 * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
3012 unknown_to_zero(uint64_t count)
3014 return count != UINT64_MAX ? count : 0;
3017 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
3018 * those already present in the list of ofpbufs in 'replies'. 'replies' should
3019 * have been initialized with ofpmp_init(). */
3021 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
3022 struct ovs_list *replies)
3024 struct ofpbuf *reply = ofpbuf_from_list(ovs_list_back(replies));
3025 size_t start_ofs = reply->size;
3026 enum ofp_version version = ofpmp_version(replies);
3027 enum ofpraw raw = ofpmp_decode_raw(replies);
3029 if (raw == OFPRAW_OFPST11_FLOW_REPLY || raw == OFPRAW_OFPST13_FLOW_REPLY) {
3030 struct ofp11_flow_stats *ofs;
3032 ofpbuf_put_uninit(reply, sizeof *ofs);
3033 oxm_put_match(reply, &fs->match, version);
3034 ofpacts_put_openflow_instructions(fs->ofpacts, fs->ofpacts_len, reply,
3037 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
3038 ofs->length = htons(reply->size - start_ofs);
3039 ofs->table_id = fs->table_id;
3041 ofs->duration_sec = htonl(fs->duration_sec);
3042 ofs->duration_nsec = htonl(fs->duration_nsec);
3043 ofs->priority = htons(fs->priority);
3044 ofs->idle_timeout = htons(fs->idle_timeout);
3045 ofs->hard_timeout = htons(fs->hard_timeout);
3046 if (version >= OFP14_VERSION) {
3047 ofs->importance = htons(fs->importance);
3049 ofs->importance = 0;
3051 if (raw == OFPRAW_OFPST13_FLOW_REPLY) {
3052 ofs->flags = ofputil_encode_flow_mod_flags(fs->flags, version);
3056 memset(ofs->pad2, 0, sizeof ofs->pad2);
3057 ofs->cookie = fs->cookie;
3058 ofs->packet_count = htonll(unknown_to_zero(fs->packet_count));
3059 ofs->byte_count = htonll(unknown_to_zero(fs->byte_count));
3060 } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
3061 struct ofp10_flow_stats *ofs;
3063 ofpbuf_put_uninit(reply, sizeof *ofs);
3064 ofpacts_put_openflow_actions(fs->ofpacts, fs->ofpacts_len, reply,
3066 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
3067 ofs->length = htons(reply->size - start_ofs);
3068 ofs->table_id = fs->table_id;
3070 ofputil_match_to_ofp10_match(&fs->match, &ofs->match);
3071 ofs->duration_sec = htonl(fs->duration_sec);
3072 ofs->duration_nsec = htonl(fs->duration_nsec);
3073 ofs->priority = htons(fs->priority);
3074 ofs->idle_timeout = htons(fs->idle_timeout);
3075 ofs->hard_timeout = htons(fs->hard_timeout);
3076 memset(ofs->pad2, 0, sizeof ofs->pad2);
3077 put_32aligned_be64(&ofs->cookie, fs->cookie);
3078 put_32aligned_be64(&ofs->packet_count,
3079 htonll(unknown_to_zero(fs->packet_count)));
3080 put_32aligned_be64(&ofs->byte_count,
3081 htonll(unknown_to_zero(fs->byte_count)));
3082 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
3083 struct nx_flow_stats *nfs;
3086 ofpbuf_put_uninit(reply, sizeof *nfs);
3087 match_len = nx_put_match(reply, &fs->match, 0, 0);
3088 ofpacts_put_openflow_actions(fs->ofpacts, fs->ofpacts_len, reply,
3090 nfs = ofpbuf_at_assert(reply, start_ofs, sizeof *nfs);
3091 nfs->length = htons(reply->size - start_ofs);
3092 nfs->table_id = fs->table_id;
3094 nfs->duration_sec = htonl(fs->duration_sec);
3095 nfs->duration_nsec = htonl(fs->duration_nsec);
3096 nfs->priority = htons(fs->priority);
3097 nfs->idle_timeout = htons(fs->idle_timeout);
3098 nfs->hard_timeout = htons(fs->hard_timeout);
3099 nfs->idle_age = htons(fs->idle_age < 0 ? 0
3100 : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
3102 nfs->hard_age = htons(fs->hard_age < 0 ? 0
3103 : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
3105 nfs->match_len = htons(match_len);
3106 nfs->cookie = fs->cookie;
3107 nfs->packet_count = htonll(fs->packet_count);
3108 nfs->byte_count = htonll(fs->byte_count);
3113 ofpmp_postappend(replies, start_ofs);
3116 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
3117 * NXST_AGGREGATE reply matching 'request', and returns the message. */
3119 ofputil_encode_aggregate_stats_reply(
3120 const struct ofputil_aggregate_stats *stats,
3121 const struct ofp_header *request)
3123 struct ofp_aggregate_stats_reply *asr;
3124 uint64_t packet_count;
3125 uint64_t byte_count;
3129 ofpraw_decode(&raw, request);
3130 if (raw == OFPRAW_OFPST10_AGGREGATE_REQUEST) {
3131 packet_count = unknown_to_zero(stats->packet_count);
3132 byte_count = unknown_to_zero(stats->byte_count);
3134 packet_count = stats->packet_count;
3135 byte_count = stats->byte_count;
3138 msg = ofpraw_alloc_stats_reply(request, 0);
3139 asr = ofpbuf_put_zeros(msg, sizeof *asr);
3140 put_32aligned_be64(&asr->packet_count, htonll(packet_count));
3141 put_32aligned_be64(&asr->byte_count, htonll(byte_count));
3142 asr->flow_count = htonl(stats->flow_count);
3148 ofputil_decode_aggregate_stats_reply(struct ofputil_aggregate_stats *stats,
3149 const struct ofp_header *reply)
3151 struct ofpbuf msg = ofpbuf_const_initializer(reply, ntohs(reply->length));
3152 ofpraw_pull_assert(&msg);
3154 struct ofp_aggregate_stats_reply *asr = msg.msg;
3155 stats->packet_count = ntohll(get_32aligned_be64(&asr->packet_count));
3156 stats->byte_count = ntohll(get_32aligned_be64(&asr->byte_count));
3157 stats->flow_count = ntohl(asr->flow_count);
3162 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
3163 * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
3164 * an OpenFlow error code. */
3166 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
3167 const struct ofp_header *oh)
3169 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
3170 enum ofpraw raw = ofpraw_pull_assert(&b);
3171 if (raw == OFPRAW_OFPT11_FLOW_REMOVED) {
3172 const struct ofp12_flow_removed *ofr;
3175 ofr = ofpbuf_pull(&b, sizeof *ofr);
3177 error = ofputil_pull_ofp11_match(&b, &fr->match, NULL);
3182 fr->priority = ntohs(ofr->priority);
3183 fr->cookie = ofr->cookie;
3184 fr->reason = ofr->reason;
3185 fr->table_id = ofr->table_id;
3186 fr->duration_sec = ntohl(ofr->duration_sec);
3187 fr->duration_nsec = ntohl(ofr->duration_nsec);
3188 fr->idle_timeout = ntohs(ofr->idle_timeout);
3189 fr->hard_timeout = ntohs(ofr->hard_timeout);
3190 fr->packet_count = ntohll(ofr->packet_count);
3191 fr->byte_count = ntohll(ofr->byte_count);
3192 } else if (raw == OFPRAW_OFPT10_FLOW_REMOVED) {
3193 const struct ofp10_flow_removed *ofr;
3195 ofr = ofpbuf_pull(&b, sizeof *ofr);
3197 ofputil_match_from_ofp10_match(&ofr->match, &fr->match);
3198 fr->priority = ntohs(ofr->priority);
3199 fr->cookie = ofr->cookie;
3200 fr->reason = ofr->reason;
3202 fr->duration_sec = ntohl(ofr->duration_sec);
3203 fr->duration_nsec = ntohl(ofr->duration_nsec);
3204 fr->idle_timeout = ntohs(ofr->idle_timeout);
3205 fr->hard_timeout = 0;
3206 fr->packet_count = ntohll(ofr->packet_count);
3207 fr->byte_count = ntohll(ofr->byte_count);
3208 } else if (raw == OFPRAW_NXT_FLOW_REMOVED) {
3209 struct nx_flow_removed *nfr;
3212 nfr = ofpbuf_pull(&b, sizeof *nfr);
3213 error = nx_pull_match(&b, ntohs(nfr->match_len), &fr->match,
3219 return OFPERR_OFPBRC_BAD_LEN;
3222 fr->priority = ntohs(nfr->priority);
3223 fr->cookie = nfr->cookie;
3224 fr->reason = nfr->reason;
3225 fr->table_id = nfr->table_id ? nfr->table_id - 1 : 255;
3226 fr->duration_sec = ntohl(nfr->duration_sec);
3227 fr->duration_nsec = ntohl(nfr->duration_nsec);
3228 fr->idle_timeout = ntohs(nfr->idle_timeout);
3229 fr->hard_timeout = 0;
3230 fr->packet_count = ntohll(nfr->packet_count);
3231 fr->byte_count = ntohll(nfr->byte_count);
3239 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
3240 * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
3243 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
3244 enum ofputil_protocol protocol)
3247 enum ofp_flow_removed_reason reason = fr->reason;
3249 if (reason == OFPRR_METER_DELETE && !(protocol & OFPUTIL_P_OF14_UP)) {
3250 reason = OFPRR_DELETE;
3254 case OFPUTIL_P_OF11_STD:
3255 case OFPUTIL_P_OF12_OXM:
3256 case OFPUTIL_P_OF13_OXM:
3257 case OFPUTIL_P_OF14_OXM:
3258 case OFPUTIL_P_OF15_OXM:
3259 case OFPUTIL_P_OF16_OXM: {
3260 struct ofp12_flow_removed *ofr;
3262 msg = ofpraw_alloc_xid(OFPRAW_OFPT11_FLOW_REMOVED,
3263 ofputil_protocol_to_ofp_version(protocol),
3265 ofputil_match_typical_len(protocol));
3266 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
3267 ofr->cookie = fr->cookie;
3268 ofr->priority = htons(fr->priority);
3269 ofr->reason = reason;
3270 ofr->table_id = fr->table_id;
3271 ofr->duration_sec = htonl(fr->duration_sec);
3272 ofr->duration_nsec = htonl(fr->duration_nsec);
3273 ofr->idle_timeout = htons(fr->idle_timeout);
3274 ofr->hard_timeout = htons(fr->hard_timeout);
3275 ofr->packet_count = htonll(fr->packet_count);
3276 ofr->byte_count = htonll(fr->byte_count);
3277 ofputil_put_ofp11_match(msg, &fr->match, protocol);
3281 case OFPUTIL_P_OF10_STD:
3282 case OFPUTIL_P_OF10_STD_TID: {
3283 struct ofp10_flow_removed *ofr;
3285 msg = ofpraw_alloc_xid(OFPRAW_OFPT10_FLOW_REMOVED, OFP10_VERSION,
3287 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
3288 ofputil_match_to_ofp10_match(&fr->match, &ofr->match);
3289 ofr->cookie = fr->cookie;
3290 ofr->priority = htons(fr->priority);
3291 ofr->reason = reason;
3292 ofr->duration_sec = htonl(fr->duration_sec);
3293 ofr->duration_nsec = htonl(fr->duration_nsec);
3294 ofr->idle_timeout = htons(fr->idle_timeout);
3295 ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
3296 ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
3300 case OFPUTIL_P_OF10_NXM:
3301 case OFPUTIL_P_OF10_NXM_TID: {
3302 struct nx_flow_removed *nfr;
3305 msg = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_REMOVED, OFP10_VERSION,
3306 htonl(0), NXM_TYPICAL_LEN);
3307 ofpbuf_put_zeros(msg, sizeof *nfr);
3308 match_len = nx_put_match(msg, &fr->match, 0, 0);
3311 nfr->cookie = fr->cookie;
3312 nfr->priority = htons(fr->priority);
3313 nfr->reason = reason;
3314 nfr->table_id = fr->table_id + 1;
3315 nfr->duration_sec = htonl(fr->duration_sec);
3316 nfr->duration_nsec = htonl(fr->duration_nsec);
3317 nfr->idle_timeout = htons(fr->idle_timeout);
3318 nfr->match_len = htons(match_len);
3319 nfr->packet_count = htonll(fr->packet_count);
3320 nfr->byte_count = htonll(fr->byte_count);
3331 /* The caller has done basic initialization of '*pin'; the other output
3332 * arguments needs to be initialized. */
3334 decode_nx_packet_in2(const struct ofp_header *oh, bool loose,
3335 struct ofputil_packet_in *pin,
3336 size_t *total_len, uint32_t *buffer_id,
3337 struct ofpbuf *continuation)
3340 *buffer_id = UINT32_MAX;
3342 struct ofpbuf properties;
3343 ofpbuf_use_const(&properties, oh, ntohs(oh->length));
3344 ofpraw_pull_assert(&properties);
3346 while (properties.size > 0) {
3347 struct ofpbuf payload;
3350 enum ofperr error = ofpprop_pull(&properties, &payload, &type);
3357 pin->packet = payload.msg;
3358 pin->packet_len = ofpbuf_msgsize(&payload);
3361 case NXPINT_FULL_LEN: {
3363 error = ofpprop_parse_u32(&payload, &u32);
3368 case NXPINT_BUFFER_ID:
3369 error = ofpprop_parse_u32(&payload, buffer_id);
3372 case NXPINT_TABLE_ID:
3373 error = ofpprop_parse_u8(&payload, &pin->table_id);
3377 error = ofpprop_parse_be64(&payload, &pin->cookie);
3380 case NXPINT_REASON: {
3382 error = ofpprop_parse_u8(&payload, &reason);
3383 pin->reason = reason;
3387 case NXPINT_METADATA:
3388 error = oxm_decode_match(payload.msg, ofpbuf_msgsize(&payload),
3389 &pin->flow_metadata);
3392 case NXPINT_USERDATA:
3393 pin->userdata = payload.msg;
3394 pin->userdata_len = ofpbuf_msgsize(&payload);
3397 case NXPINT_CONTINUATION:
3399 error = ofpprop_parse_nested(&payload, continuation);
3404 error = OFPPROP_UNKNOWN(loose, "NX_PACKET_IN2", type);
3412 if (!pin->packet_len) {
3413 VLOG_WARN_RL(&bad_ofmsg_rl, "NXT_PACKET_IN2 lacks packet");
3414 return OFPERR_OFPBRC_BAD_LEN;
3415 } else if (!*total_len) {
3416 *total_len = pin->packet_len;
3417 } else if (*total_len < pin->packet_len) {
3418 VLOG_WARN_RL(&bad_ofmsg_rl, "NXT_PACKET_IN2 claimed full_len < len");
3419 return OFPERR_OFPBRC_BAD_LEN;
3425 /* Decodes the packet-in message starting at 'oh' into '*pin'. Populates
3426 * 'pin->packet' and 'pin->packet_len' with the part of the packet actually
3427 * included in the message. If 'total_lenp' is nonnull, populates
3428 * '*total_lenp' with the original length of the packet (which is larger than
3429 * 'packet->len' if only part of the packet was included). If 'buffer_idp' is
3430 * nonnull, stores the packet's buffer ID in '*buffer_idp' (UINT32_MAX if it
3431 * was not buffered).
3433 * Populates 'continuation', if nonnull, with the continuation data from the
3434 * packet-in (an empty buffer, if 'oh' did not contain continuation data). The
3435 * format of this data is supposed to be opaque to anything other than
3436 * ovs-vswitchd, so that in any other process the only reasonable use of this
3437 * data is to be copied into an NXT_RESUME message via ofputil_encode_resume().
3439 * This function points 'pin->packet' into 'oh', so the caller should not free
3440 * it separately from the original OpenFlow message. This is also true for
3441 * 'pin->userdata' (which could also end up NULL if there is no userdata).
3443 * Returns 0 if successful, otherwise an OpenFlow error code. */
3445 ofputil_decode_packet_in(const struct ofp_header *oh, bool loose,
3446 struct ofputil_packet_in *pin,
3447 size_t *total_lenp, uint32_t *buffer_idp,
3448 struct ofpbuf *continuation)
3453 memset(pin, 0, sizeof *pin);
3454 pin->cookie = OVS_BE64_MAX;
3456 ofpbuf_use_const(continuation, NULL, 0);
3459 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
3460 enum ofpraw raw = ofpraw_pull_assert(&b);
3461 if (raw == OFPRAW_OFPT13_PACKET_IN || raw == OFPRAW_OFPT12_PACKET_IN) {
3462 const struct ofp12_packet_in *opi = ofpbuf_pull(&b, sizeof *opi);
3463 const ovs_be64 *cookie = (raw == OFPRAW_OFPT13_PACKET_IN
3464 ? ofpbuf_pull(&b, sizeof *cookie)
3466 enum ofperr error = oxm_pull_match_loose(&b, &pin->flow_metadata);
3471 if (!ofpbuf_try_pull(&b, 2)) {
3472 return OFPERR_OFPBRC_BAD_LEN;
3475 pin->reason = opi->reason;
3476 pin->table_id = opi->table_id;
3477 buffer_id = ntohl(opi->buffer_id);
3478 total_len = ntohs(opi->total_len);
3480 pin->cookie = *cookie;
3483 pin->packet = b.data;
3484 pin->packet_len = b.size;
3485 } else if (raw == OFPRAW_OFPT10_PACKET_IN) {
3486 const struct ofp10_packet_in *opi;
3488 opi = ofpbuf_pull(&b, offsetof(struct ofp10_packet_in, data));
3490 pin->packet = CONST_CAST(uint8_t *, opi->data);
3491 pin->packet_len = b.size;
3493 match_init_catchall(&pin->flow_metadata);
3494 match_set_in_port(&pin->flow_metadata,
3495 u16_to_ofp(ntohs(opi->in_port)));
3496 pin->reason = opi->reason;
3497 buffer_id = ntohl(opi->buffer_id);
3498 total_len = ntohs(opi->total_len);
3499 } else if (raw == OFPRAW_OFPT11_PACKET_IN) {
3500 const struct ofp11_packet_in *opi;
3504 opi = ofpbuf_pull(&b, sizeof *opi);
3506 pin->packet = b.data;
3507 pin->packet_len = b.size;
3509 buffer_id = ntohl(opi->buffer_id);
3510 error = ofputil_port_from_ofp11(opi->in_port, &in_port);
3514 match_init_catchall(&pin->flow_metadata);
3515 match_set_in_port(&pin->flow_metadata, in_port);
3516 total_len = ntohs(opi->total_len);
3517 pin->reason = opi->reason;
3518 pin->table_id = opi->table_id;
3519 } else if (raw == OFPRAW_NXT_PACKET_IN) {
3520 const struct nx_packet_in *npi;
3523 npi = ofpbuf_pull(&b, sizeof *npi);
3524 error = nx_pull_match_loose(&b, ntohs(npi->match_len),
3525 &pin->flow_metadata, NULL, NULL);
3530 if (!ofpbuf_try_pull(&b, 2)) {
3531 return OFPERR_OFPBRC_BAD_LEN;
3534 pin->reason = npi->reason;
3535 pin->table_id = npi->table_id;
3536 pin->cookie = npi->cookie;
3538 buffer_id = ntohl(npi->buffer_id);
3539 total_len = ntohs(npi->total_len);
3541 pin->packet = b.data;
3542 pin->packet_len = b.size;
3543 } else if (raw == OFPRAW_NXT_PACKET_IN2 || raw == OFPRAW_NXT_RESUME) {
3544 enum ofperr error = decode_nx_packet_in2(oh, loose, pin, &total_len,
3545 &buffer_id, continuation);
3554 *total_lenp = total_len;
3557 *buffer_idp = buffer_id;
3564 encode_packet_in_reason(enum ofp_packet_in_reason reason,
3565 enum ofp_version version)
3570 case OFPR_INVALID_TTL:
3573 case OFPR_ACTION_SET:
3575 case OFPR_PACKET_OUT:
3576 return version < OFP14_VERSION ? OFPR_ACTION : reason;
3578 case OFPR_EXPLICIT_MISS:
3579 return version < OFP13_VERSION ? OFPR_ACTION : OFPR_NO_MATCH;
3581 case OFPR_IMPLICIT_MISS:
3582 return OFPR_NO_MATCH;
3584 case OFPR_N_REASONS:
3590 /* Only NXT_PACKET_IN2 (not NXT_RESUME) should include NXCPT_USERDATA, so this
3591 * function omits it. The caller can add it itself if desired. */
3593 ofputil_put_packet_in(const struct ofputil_packet_in *pin,
3594 enum ofp_version version, uint32_t buffer_id,
3595 size_t include_bytes, struct ofpbuf *msg)
3597 /* Add packet properties. */
3598 ofpprop_put(msg, NXPINT_PACKET, pin->packet, include_bytes);
3599 if (include_bytes != pin->packet_len) {
3600 ofpprop_put_u32(msg, NXPINT_FULL_LEN, pin->packet_len);
3602 if (buffer_id != UINT32_MAX) {
3603 ofpprop_put_u32(msg, NXPINT_BUFFER_ID, buffer_id);
3606 /* Add flow properties. */
3607 ofpprop_put_u8(msg, NXPINT_TABLE_ID, pin->table_id);
3608 if (pin->cookie != OVS_BE64_MAX) {
3609 ofpprop_put_be64(msg, NXPINT_COOKIE, pin->cookie);
3612 /* Add other properties. */
3613 ofpprop_put_u8(msg, NXPINT_REASON,
3614 encode_packet_in_reason(pin->reason, version));
3616 size_t start = ofpprop_start(msg, NXPINT_METADATA);
3617 oxm_put_raw(msg, &pin->flow_metadata, version);
3618 ofpprop_end(msg, start);
3622 put_actions_property(struct ofpbuf *msg, uint64_t prop_type,
3623 enum ofp_version version,
3624 const struct ofpact *actions, size_t actions_len)
3627 size_t start = ofpprop_start_nested(msg, prop_type);
3628 ofpacts_put_openflow_actions(actions, actions_len, msg, version);
3629 ofpprop_end(msg, start);
3633 enum nx_continuation_prop_type {
3634 NXCPT_BRIDGE = 0x8000,
3644 /* Only NXT_PACKET_IN2 (not NXT_RESUME) should include NXCPT_USERDATA, so this
3645 * function omits it. The caller can add it itself if desired. */
3647 ofputil_put_packet_in_private(const struct ofputil_packet_in_private *pin,
3648 enum ofp_version version, uint32_t buffer_id,
3649 size_t include_bytes, struct ofpbuf *msg)
3651 ofputil_put_packet_in(&pin->public, version, buffer_id,
3652 include_bytes, msg);
3654 size_t continuation_ofs = ofpprop_start_nested(msg, NXPINT_CONTINUATION);
3655 size_t inner_ofs = msg->size;
3657 if (!uuid_is_zero(&pin->bridge)) {
3658 ofpprop_put_uuid(msg, NXCPT_BRIDGE, &pin->bridge);
3661 for (size_t i = 0; i < pin->n_stack; i++) {
3662 const union mf_subvalue *s = &pin->stack[i];
3664 for (ofs = 0; ofs < sizeof *s; ofs++) {
3670 ofpprop_put(msg, NXCPT_STACK, &s->u8[ofs], sizeof *s - ofs);
3674 ofpprop_put_u32(msg, NXCPT_MIRRORS, pin->mirrors);
3677 if (pin->conntracked) {
3678 ofpprop_put_flag(msg, NXCPT_CONNTRACKED);
3681 if (pin->actions_len) {
3682 /* Divide 'pin->actions' into groups that begins with an
3683 * unroll_xlate action. For each group, emit a NXCPT_TABLE_ID and
3684 * NXCPT_COOKIE property (if either has changed; each is initially
3685 * assumed 0), then a NXCPT_ACTIONS property with the grouped
3688 * The alternative is to make OFPACT_UNROLL_XLATE public. We can
3689 * always do that later, since this is a private property. */
3690 const struct ofpact *const end = ofpact_end(pin->actions,
3692 const struct ofpact_unroll_xlate *unroll = NULL;
3693 uint8_t table_id = 0;
3694 ovs_be64 cookie = 0;
3696 const struct ofpact *a;
3697 for (a = pin->actions; ; a = ofpact_next(a)) {
3698 if (a == end || a->type == OFPACT_UNROLL_XLATE) {
3700 if (table_id != unroll->rule_table_id) {
3701 ofpprop_put_u8(msg, NXCPT_TABLE_ID,
3702 unroll->rule_table_id);
3703 table_id = unroll->rule_table_id;
3705 if (cookie != unroll->rule_cookie) {
3706 ofpprop_put_be64(msg, NXCPT_COOKIE,
3707 unroll->rule_cookie);
3708 cookie = unroll->rule_cookie;
3712 const struct ofpact *start
3713 = unroll ? ofpact_next(&unroll->ofpact) : pin->actions;
3714 put_actions_property(msg, NXCPT_ACTIONS, version,
3715 start, (a - start) * sizeof *a);
3720 unroll = ofpact_get_UNROLL_XLATE(a);
3725 if (pin->action_set_len) {
3726 size_t start = ofpprop_start_nested(msg, NXCPT_ACTION_SET);
3727 ofpacts_put_openflow_actions(pin->action_set,
3728 pin->action_set_len, msg, version);
3729 ofpprop_end(msg, start);
3732 if (msg->size > inner_ofs) {
3733 ofpprop_end(msg, continuation_ofs);
3735 msg->size = continuation_ofs;
3739 static struct ofpbuf *
3740 ofputil_encode_ofp10_packet_in(const struct ofputil_packet_in *pin,
3743 struct ofp10_packet_in *opi;
3746 msg = ofpraw_alloc_xid(OFPRAW_OFPT10_PACKET_IN, OFP10_VERSION,
3747 htonl(0), pin->packet_len);
3748 opi = ofpbuf_put_zeros(msg, offsetof(struct ofp10_packet_in, data));
3749 opi->total_len = htons(pin->packet_len);
3750 opi->in_port = htons(ofp_to_u16(pin->flow_metadata.flow.in_port.ofp_port));
3751 opi->reason = encode_packet_in_reason(pin->reason, OFP10_VERSION);
3752 opi->buffer_id = htonl(buffer_id);
3757 static struct ofpbuf *
3758 ofputil_encode_nx_packet_in(const struct ofputil_packet_in *pin,
3759 enum ofp_version version, uint32_t buffer_id)
3761 struct nx_packet_in *npi;
3765 /* The final argument is just an estimate of the space required. */
3766 msg = ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN, version,
3767 htonl(0), NXM_TYPICAL_LEN + 2 + pin->packet_len);
3768 ofpbuf_put_zeros(msg, sizeof *npi);
3769 match_len = nx_put_match(msg, &pin->flow_metadata, 0, 0);
3770 ofpbuf_put_zeros(msg, 2);
3773 npi->buffer_id = htonl(buffer_id);
3774 npi->total_len = htons(pin->packet_len);
3775 npi->reason = encode_packet_in_reason(pin->reason, version);
3776 npi->table_id = pin->table_id;
3777 npi->cookie = pin->cookie;
3778 npi->match_len = htons(match_len);
3783 static struct ofpbuf *
3784 ofputil_encode_nx_packet_in2(const struct ofputil_packet_in_private *pin,
3785 enum ofp_version version, uint32_t buffer_id,
3786 size_t include_bytes)
3788 /* 'extra' is just an estimate of the space required. */
3789 size_t extra = (pin->public.packet_len
3790 + NXM_TYPICAL_LEN /* flow_metadata */
3793 + pin->action_set_len
3794 + 256); /* fudge factor */
3795 struct ofpbuf *msg = ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN2, version,
3798 ofputil_put_packet_in_private(pin, version, buffer_id, include_bytes, msg);
3799 if (pin->public.userdata_len) {
3800 ofpprop_put(msg, NXPINT_USERDATA, pin->public.userdata,
3801 pin->public.userdata_len);
3804 ofpmsg_update_length(msg);
3808 static struct ofpbuf *
3809 ofputil_encode_ofp11_packet_in(const struct ofputil_packet_in *pin,
3812 struct ofp11_packet_in *opi;
3815 msg = ofpraw_alloc_xid(OFPRAW_OFPT11_PACKET_IN, OFP11_VERSION,
3816 htonl(0), pin->packet_len);
3817 opi = ofpbuf_put_zeros(msg, sizeof *opi);
3818 opi->buffer_id = htonl(buffer_id);
3819 opi->in_port = ofputil_port_to_ofp11(
3820 pin->flow_metadata.flow.in_port.ofp_port);
3821 opi->in_phy_port = opi->in_port;
3822 opi->total_len = htons(pin->packet_len);
3823 opi->reason = encode_packet_in_reason(pin->reason, OFP11_VERSION);
3824 opi->table_id = pin->table_id;
3829 static struct ofpbuf *
3830 ofputil_encode_ofp12_packet_in(const struct ofputil_packet_in *pin,
3831 enum ofp_version version,
3834 enum ofpraw raw = (version >= OFP13_VERSION
3835 ? OFPRAW_OFPT13_PACKET_IN
3836 : OFPRAW_OFPT12_PACKET_IN);
3839 /* The final argument is just an estimate of the space required. */
3840 msg = ofpraw_alloc_xid(raw, version,
3841 htonl(0), NXM_TYPICAL_LEN + 2 + pin->packet_len);
3843 struct ofp12_packet_in *opi = ofpbuf_put_zeros(msg, sizeof *opi);
3844 opi->buffer_id = htonl(buffer_id);
3845 opi->total_len = htons(pin->packet_len);
3846 opi->reason = encode_packet_in_reason(pin->reason, version);
3847 opi->table_id = pin->table_id;
3849 if (version >= OFP13_VERSION) {
3850 ovs_be64 cookie = pin->cookie;
3851 ofpbuf_put(msg, &cookie, sizeof cookie);
3854 oxm_put_match(msg, &pin->flow_metadata, version);
3855 ofpbuf_put_zeros(msg, 2);
3860 /* Converts abstract ofputil_packet_in_private 'pin' into a PACKET_IN message
3861 * for 'protocol', using the packet-in format specified by 'packet_in_format'.
3863 * If 'pkt_buf' is nonnull and 'max_len' allows the packet to be buffered, this
3864 * function will attempt to obtain a buffer ID from 'pktbuf' and truncate the
3865 * packet to 'max_len' bytes. Otherwise, or if 'pktbuf' doesn't have a free
3866 * buffer, it will send the whole packet without buffering.
3868 * This function is really meant only for use by ovs-vswitchd. To any other
3869 * code, the "continuation" data, i.e. the data that is in struct
3870 * ofputil_packet_in_private but not in struct ofputil_packet_in, is supposed
3871 * to be opaque (and it might change from one OVS version to another). Thus,
3872 * if any other code wants to encode a packet-in, it should use a non-"private"
3873 * version of this function. (Such a version doesn't currently exist because
3874 * only ovs-vswitchd currently wants to encode packet-ins. If you need one,
3877 ofputil_encode_packet_in_private(const struct ofputil_packet_in_private *pin,
3878 enum ofputil_protocol protocol,
3879 enum nx_packet_in_format packet_in_format,
3880 uint16_t max_len, struct pktbuf *pktbuf)
3882 enum ofp_version version = ofputil_protocol_to_ofp_version(protocol);
3884 /* Get buffer ID. */
3885 ofp_port_t in_port = pin->public.flow_metadata.flow.in_port.ofp_port;
3886 uint32_t buffer_id = (max_len != OFPCML12_NO_BUFFER && pktbuf
3887 ? pktbuf_save(pktbuf, pin->public.packet,
3888 pin->public.packet_len, in_port)
3891 /* Calculate the number of bytes of the packet to include in the
3894 * - If not buffered, the whole thing.
3896 * - Otherwise, no more than 'max_len' bytes. */
3897 size_t include_bytes = (buffer_id == UINT32_MAX
3898 ? pin->public.packet_len
3899 : MIN(max_len, pin->public.packet_len));
3902 switch (packet_in_format) {
3903 case NXPIF_STANDARD:
3905 case OFPUTIL_P_OF10_STD:
3906 case OFPUTIL_P_OF10_STD_TID:
3907 case OFPUTIL_P_OF10_NXM:
3908 case OFPUTIL_P_OF10_NXM_TID:
3909 msg = ofputil_encode_ofp10_packet_in(&pin->public, buffer_id);
3912 case OFPUTIL_P_OF11_STD:
3913 msg = ofputil_encode_ofp11_packet_in(&pin->public, buffer_id);
3916 case OFPUTIL_P_OF12_OXM:
3917 case OFPUTIL_P_OF13_OXM:
3918 case OFPUTIL_P_OF14_OXM:
3919 case OFPUTIL_P_OF15_OXM:
3920 case OFPUTIL_P_OF16_OXM:
3921 msg = ofputil_encode_ofp12_packet_in(&pin->public, version, buffer_id);
3929 case NXPIF_NXT_PACKET_IN:
3930 msg = ofputil_encode_nx_packet_in(&pin->public, version, buffer_id);
3933 case NXPIF_NXT_PACKET_IN2:
3934 return ofputil_encode_nx_packet_in2(pin, version, buffer_id,
3941 ofpbuf_put(msg, pin->public.packet, include_bytes);
3942 ofpmsg_update_length(msg);
3946 /* Returns a string form of 'reason'. The return value is either a statically
3947 * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
3948 * 'bufsize' should be at least OFPUTIL_PACKET_IN_REASON_BUFSIZE. */
3950 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason,
3951 char *reasonbuf, size_t bufsize)
3958 case OFPR_INVALID_TTL:
3959 return "invalid_ttl";
3960 case OFPR_ACTION_SET:
3961 return "action_set";
3964 case OFPR_PACKET_OUT:
3965 return "packet_out";
3966 case OFPR_EXPLICIT_MISS:
3967 case OFPR_IMPLICIT_MISS:
3970 case OFPR_N_REASONS:
3972 snprintf(reasonbuf, bufsize, "%d", (int) reason);
3978 ofputil_packet_in_reason_from_string(const char *s,
3979 enum ofp_packet_in_reason *reason)
3983 for (i = 0; i < OFPR_N_REASONS; i++) {
3984 char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
3985 const char *reason_s;
3987 reason_s = ofputil_packet_in_reason_to_string(i, reasonbuf,
3989 if (!strcasecmp(s, reason_s)) {
3997 /* Returns a newly allocated NXT_RESUME message for 'pin', with the given
3998 * 'continuation', for 'protocol'. This message is suitable for resuming the
3999 * pipeline traveral of the packet represented by 'pin', if sent to the switch
4000 * from which 'pin' was received. */
4002 ofputil_encode_resume(const struct ofputil_packet_in *pin,
4003 const struct ofpbuf *continuation,
4004 enum ofputil_protocol protocol)
4006 enum ofp_version version = ofputil_protocol_to_ofp_version(protocol);
4007 size_t extra = pin->packet_len + NXM_TYPICAL_LEN + continuation->size;
4008 struct ofpbuf *msg = ofpraw_alloc_xid(OFPRAW_NXT_RESUME, version,
4010 ofputil_put_packet_in(pin, version, UINT32_MAX, pin->packet_len, msg);
4011 ofpprop_put_nested(msg, NXPINT_CONTINUATION, continuation);
4012 ofpmsg_update_length(msg);
4017 parse_subvalue_prop(const struct ofpbuf *property, union mf_subvalue *sv)
4019 unsigned int len = ofpbuf_msgsize(property);
4020 if (len > sizeof *sv) {
4021 VLOG_WARN_RL(&bad_ofmsg_rl, "NXCPT_STACK property has bad length %u",
4023 return OFPERR_OFPBPC_BAD_LEN;
4025 memset(sv, 0, sizeof *sv);
4026 memcpy(&sv->u8[sizeof *sv - len], property->msg, len);
4031 parse_actions_property(struct ofpbuf *property, enum ofp_version version,
4032 struct ofpbuf *ofpacts)
4034 if (!ofpbuf_try_pull(property, ROUND_UP(ofpbuf_headersize(property), 8))) {
4035 VLOG_WARN_RL(&bad_ofmsg_rl, "actions property has bad length %"PRIu32,
4037 return OFPERR_OFPBPC_BAD_LEN;
4040 return ofpacts_pull_openflow_actions(property, property->size,
4044 /* This is like ofputil_decode_packet_in(), except that it decodes the
4045 * continuation data into 'pin'. The format of this data is supposed to be
4046 * opaque to any process other than ovs-vswitchd, so this function should not
4047 * be used outside ovs-vswitchd.
4049 * When successful, 'pin' contains some dynamically allocated data. Call
4050 * ofputil_packet_in_private_destroy() to free this data. */
4052 ofputil_decode_packet_in_private(const struct ofp_header *oh, bool loose,
4053 struct ofputil_packet_in_private *pin,
4054 size_t *total_len, uint32_t *buffer_id)
4056 memset(pin, 0, sizeof *pin);
4058 struct ofpbuf continuation;
4060 error = ofputil_decode_packet_in(oh, loose, &pin->public, total_len,
4061 buffer_id, &continuation);
4066 struct ofpbuf actions, action_set;
4067 ofpbuf_init(&actions, 0);
4068 ofpbuf_init(&action_set, 0);
4070 uint8_t table_id = 0;
4071 ovs_be64 cookie = 0;
4073 size_t allocated_stack = 0;
4075 while (continuation.size > 0) {
4076 struct ofpbuf payload;
4079 error = ofpprop_pull(&continuation, &payload, &type);
4084 error = ofpprop_parse_uuid(&payload, &pin->bridge);
4088 if (pin->n_stack >= allocated_stack) {
4089 pin->stack = x2nrealloc(pin->stack, &allocated_stack,
4090 sizeof *pin->stack);
4092 error = parse_subvalue_prop(&payload,
4093 &pin->stack[pin->n_stack++]);
4097 error = ofpprop_parse_u32(&payload, &pin->mirrors);
4100 case NXCPT_CONNTRACKED:
4101 pin->conntracked = true;
4104 case NXCPT_TABLE_ID:
4105 error = ofpprop_parse_u8(&payload, &table_id);
4109 error = ofpprop_parse_be64(&payload, &cookie);
4112 case NXCPT_ACTIONS: {
4113 struct ofpact_unroll_xlate *unroll
4114 = ofpact_put_UNROLL_XLATE(&actions);
4115 unroll->rule_table_id = table_id;
4116 unroll->rule_cookie = cookie;
4117 error = parse_actions_property(&payload, oh->version, &actions);
4121 case NXCPT_ACTION_SET:
4122 error = parse_actions_property(&payload, oh->version, &action_set);
4126 error = OFPPROP_UNKNOWN(loose, "continuation", type);
4134 pin->actions_len = actions.size;
4135 pin->actions = ofpbuf_steal_data(&actions);
4136 pin->action_set_len = action_set.size;
4137 pin->action_set = ofpbuf_steal_data(&action_set);
4140 ofputil_packet_in_private_destroy(pin);
4146 /* Frees data in 'pin' that is dynamically allocated by
4147 * ofputil_decode_packet_in_private().
4149 * 'pin->public' contains some pointer members that
4150 * ofputil_decode_packet_in_private() doesn't initialize to newly allocated
4151 * data, so this function doesn't free those. */
4153 ofputil_packet_in_private_destroy(struct ofputil_packet_in_private *pin)
4158 free(pin->action_set);
4162 /* Converts an OFPT_PACKET_OUT in 'opo' into an abstract ofputil_packet_out in
4165 * Uses 'ofpacts' to store the abstract OFPACT_* version of the packet out
4166 * message's actions. The caller must initialize 'ofpacts' and retains
4167 * ownership of it. 'po->ofpacts' will point into the 'ofpacts' buffer.
4169 * Returns 0 if successful, otherwise an OFPERR_* value. */
4171 ofputil_decode_packet_out(struct ofputil_packet_out *po,
4172 const struct ofp_header *oh,
4173 struct ofpbuf *ofpacts)
4175 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
4176 enum ofpraw raw = ofpraw_pull_assert(&b);
4178 ofpbuf_clear(ofpacts);
4179 if (raw == OFPRAW_OFPT11_PACKET_OUT) {
4181 const struct ofp11_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
4183 po->buffer_id = ntohl(opo->buffer_id);
4184 error = ofputil_port_from_ofp11(opo->in_port, &po->in_port);
4189 error = ofpacts_pull_openflow_actions(&b, ntohs(opo->actions_len),
4190 oh->version, ofpacts);
4194 } else if (raw == OFPRAW_OFPT10_PACKET_OUT) {
4196 const struct ofp10_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
4198 po->buffer_id = ntohl(opo->buffer_id);
4199 po->in_port = u16_to_ofp(ntohs(opo->in_port));
4201 error = ofpacts_pull_openflow_actions(&b, ntohs(opo->actions_len),
4202 oh->version, ofpacts);
4210 if (ofp_to_u16(po->in_port) >= ofp_to_u16(OFPP_MAX)
4211 && po->in_port != OFPP_LOCAL
4212 && po->in_port != OFPP_NONE && po->in_port != OFPP_CONTROLLER) {
4213 VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
4215 return OFPERR_OFPBRC_BAD_PORT;
4218 po->ofpacts = ofpacts->data;
4219 po->ofpacts_len = ofpacts->size;
4221 if (po->buffer_id == UINT32_MAX) {
4222 po->packet = b.data;
4223 po->packet_len = b.size;
4232 /* ofputil_phy_port */
4234 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
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 */
4243 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
4244 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
4245 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
4246 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
4247 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
4248 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
4250 static enum netdev_features
4251 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
4253 uint32_t ofp10 = ntohl(ofp10_);
4254 return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
4258 netdev_port_features_to_ofp10(enum netdev_features features)
4260 return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
4263 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
4264 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
4265 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
4266 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
4267 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
4268 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
4269 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
4270 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD == OFPPF11_40GB_FD); /* bit 7 */
4271 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD == OFPPF11_100GB_FD); /* bit 8 */
4272 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD == OFPPF11_1TB_FD); /* bit 9 */
4273 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER == OFPPF11_OTHER); /* bit 10 */
4274 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == OFPPF11_COPPER); /* bit 11 */
4275 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == OFPPF11_FIBER); /* bit 12 */
4276 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == OFPPF11_AUTONEG); /* bit 13 */
4277 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == OFPPF11_PAUSE); /* bit 14 */
4278 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
4280 static enum netdev_features
4281 netdev_port_features_from_ofp11(ovs_be32 ofp11)
4283 return ntohl(ofp11) & 0xffff;
4287 netdev_port_features_to_ofp11(enum netdev_features features)
4289 return htonl(features & 0xffff);
4293 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
4294 const struct ofp10_phy_port *opp)
4296 pp->port_no = u16_to_ofp(ntohs(opp->port_no));
4297 pp->hw_addr = opp->hw_addr;
4298 ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
4300 pp->config = ntohl(opp->config) & OFPPC10_ALL;
4301 pp->state = ntohl(opp->state) & OFPPS10_ALL;
4303 pp->curr = netdev_port_features_from_ofp10(opp->curr);
4304 pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
4305 pp->supported = netdev_port_features_from_ofp10(opp->supported);
4306 pp->peer = netdev_port_features_from_ofp10(opp->peer);
4308 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
4309 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
4315 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
4316 const struct ofp11_port *op)
4320 error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
4324 pp->hw_addr = op->hw_addr;
4325 ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
4327 pp->config = ntohl(op->config) & OFPPC11_ALL;
4328 pp->state = ntohl(op->state) & OFPPS11_ALL;
4330 pp->curr = netdev_port_features_from_ofp11(op->curr);
4331 pp->advertised = netdev_port_features_from_ofp11(op->advertised);
4332 pp->supported = netdev_port_features_from_ofp11(op->supported);
4333 pp->peer = netdev_port_features_from_ofp11(op->peer);
4335 pp->curr_speed = ntohl(op->curr_speed);
4336 pp->max_speed = ntohl(op->max_speed);
4342 parse_ofp14_port_ethernet_property(const struct ofpbuf *payload,
4343 struct ofputil_phy_port *pp)
4345 struct ofp14_port_desc_prop_ethernet *eth = payload->data;
4347 if (payload->size != sizeof *eth) {
4348 return OFPERR_OFPBPC_BAD_LEN;
4351 pp->curr = netdev_port_features_from_ofp11(eth->curr);
4352 pp->advertised = netdev_port_features_from_ofp11(eth->advertised);
4353 pp->supported = netdev_port_features_from_ofp11(eth->supported);
4354 pp->peer = netdev_port_features_from_ofp11(eth->peer);
4356 pp->curr_speed = ntohl(eth->curr_speed);
4357 pp->max_speed = ntohl(eth->max_speed);
4363 ofputil_pull_ofp14_port(struct ofputil_phy_port *pp, struct ofpbuf *msg)
4365 struct ofp14_port *op = ofpbuf_try_pull(msg, sizeof *op);
4367 return OFPERR_OFPBRC_BAD_LEN;
4370 size_t len = ntohs(op->length);
4371 if (len < sizeof *op || len - sizeof *op > msg->size) {
4372 return OFPERR_OFPBRC_BAD_LEN;
4376 enum ofperr error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
4380 pp->hw_addr = op->hw_addr;
4381 ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
4383 pp->config = ntohl(op->config) & OFPPC11_ALL;
4384 pp->state = ntohl(op->state) & OFPPS11_ALL;
4386 struct ofpbuf properties = ofpbuf_const_initializer(ofpbuf_pull(msg, len),
4388 while (properties.size > 0) {
4389 struct ofpbuf payload;
4393 error = ofpprop_pull(&properties, &payload, &type);
4399 case OFPPDPT14_ETHERNET:
4400 error = parse_ofp14_port_ethernet_property(&payload, pp);
4404 error = OFPPROP_UNKNOWN(true, "port", type);
4417 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
4418 struct ofp10_phy_port *opp)
4420 memset(opp, 0, sizeof *opp);
4422 opp->port_no = htons(ofp_to_u16(pp->port_no));
4423 opp->hw_addr = pp->hw_addr;
4424 ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
4426 opp->config = htonl(pp->config & OFPPC10_ALL);
4427 opp->state = htonl(pp->state & OFPPS10_ALL);
4429 opp->curr = netdev_port_features_to_ofp10(pp->curr);
4430 opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
4431 opp->supported = netdev_port_features_to_ofp10(pp->supported);
4432 opp->peer = netdev_port_features_to_ofp10(pp->peer);
4436 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
4437 struct ofp11_port *op)
4439 memset(op, 0, sizeof *op);
4441 op->port_no = ofputil_port_to_ofp11(pp->port_no);
4442 op->hw_addr = pp->hw_addr;
4443 ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
4445 op->config = htonl(pp->config & OFPPC11_ALL);
4446 op->state = htonl(pp->state & OFPPS11_ALL);
4448 op->curr = netdev_port_features_to_ofp11(pp->curr);
4449 op->advertised = netdev_port_features_to_ofp11(pp->advertised);
4450 op->supported = netdev_port_features_to_ofp11(pp->supported);
4451 op->peer = netdev_port_features_to_ofp11(pp->peer);
4453 op->curr_speed = htonl(pp->curr_speed);
4454 op->max_speed = htonl(pp->max_speed);
4458 ofputil_put_ofp14_port(const struct ofputil_phy_port *pp,
4461 struct ofp14_port *op;
4462 struct ofp14_port_desc_prop_ethernet *eth;
4464 ofpbuf_prealloc_tailroom(b, sizeof *op + sizeof *eth);
4466 op = ofpbuf_put_zeros(b, sizeof *op);
4467 op->port_no = ofputil_port_to_ofp11(pp->port_no);
4468 op->length = htons(sizeof *op + sizeof *eth);
4469 op->hw_addr = pp->hw_addr;
4470 ovs_strlcpy(op->name, pp->name, sizeof op->name);
4471 op->config = htonl(pp->config & OFPPC11_ALL);
4472 op->state = htonl(pp->state & OFPPS11_ALL);
4474 eth = ofpprop_put_zeros(b, OFPPDPT14_ETHERNET, sizeof *eth);
4475 eth->curr = netdev_port_features_to_ofp11(pp->curr);
4476 eth->advertised = netdev_port_features_to_ofp11(pp->advertised);
4477 eth->supported = netdev_port_features_to_ofp11(pp->supported);
4478 eth->peer = netdev_port_features_to_ofp11(pp->peer);
4479 eth->curr_speed = htonl(pp->curr_speed);
4480 eth->max_speed = htonl(pp->max_speed);
4484 ofputil_put_phy_port(enum ofp_version ofp_version,
4485 const struct ofputil_phy_port *pp, struct ofpbuf *b)
4487 switch (ofp_version) {
4488 case OFP10_VERSION: {
4489 struct ofp10_phy_port *opp = ofpbuf_put_uninit(b, sizeof *opp);
4490 ofputil_encode_ofp10_phy_port(pp, opp);
4496 case OFP13_VERSION: {
4497 struct ofp11_port *op = ofpbuf_put_uninit(b, sizeof *op);
4498 ofputil_encode_ofp11_port(pp, op);
4505 ofputil_put_ofp14_port(pp, b);
4514 ofputil_decode_port_desc_stats_request(const struct ofp_header *request,
4517 struct ofpbuf b = ofpbuf_const_initializer(request,
4518 ntohs(request->length));
4519 enum ofpraw raw = ofpraw_pull_assert(&b);
4520 if (raw == OFPRAW_OFPST10_PORT_DESC_REQUEST) {
4523 } else if (raw == OFPRAW_OFPST15_PORT_DESC_REQUEST) {
4524 ovs_be32 *ofp11_port;
4526 ofp11_port = ofpbuf_pull(&b, sizeof *ofp11_port);
4527 return ofputil_port_from_ofp11(*ofp11_port, port);
4534 ofputil_encode_port_desc_stats_request(enum ofp_version ofp_version,
4537 struct ofpbuf *request;
4539 switch (ofp_version) {
4545 request = ofpraw_alloc(OFPRAW_OFPST10_PORT_DESC_REQUEST,
4549 case OFP16_VERSION:{
4550 struct ofp15_port_desc_request *req;
4551 request = ofpraw_alloc(OFPRAW_OFPST15_PORT_DESC_REQUEST,
4553 req = ofpbuf_put_zeros(request, sizeof *req);
4554 req->port_no = ofputil_port_to_ofp11(port);
4565 ofputil_append_port_desc_stats_reply(const struct ofputil_phy_port *pp,
4566 struct ovs_list *replies)
4568 struct ofpbuf *reply = ofpbuf_from_list(ovs_list_back(replies));
4569 size_t start_ofs = reply->size;
4571 ofputil_put_phy_port(ofpmp_version(replies), pp, reply);
4572 ofpmp_postappend(replies, start_ofs);
4575 /* ofputil_switch_config */
4577 /* Decodes 'oh', which must be an OFPT_GET_CONFIG_REPLY or OFPT_SET_CONFIG
4578 * message, into 'config'. Returns false if 'oh' contained any flags that
4579 * aren't specified in its version of OpenFlow, true otherwise. */
4581 ofputil_decode_switch_config(const struct ofp_header *oh,
4582 struct ofputil_switch_config *config)
4584 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
4585 ofpraw_pull_assert(&b);
4587 const struct ofp_switch_config *osc = ofpbuf_pull(&b, sizeof *osc);
4588 config->frag = ntohs(osc->flags) & OFPC_FRAG_MASK;
4589 config->miss_send_len = ntohs(osc->miss_send_len);
4591 ovs_be16 valid_mask = htons(OFPC_FRAG_MASK);
4592 if (oh->version < OFP13_VERSION) {
4593 const ovs_be16 ttl_bit = htons(OFPC_INVALID_TTL_TO_CONTROLLER);
4594 valid_mask |= ttl_bit;
4595 config->invalid_ttl_to_controller = (osc->flags & ttl_bit) != 0;
4597 config->invalid_ttl_to_controller = -1;
4600 return !(osc->flags & ~valid_mask);
4604 ofputil_decode_get_config_reply(const struct ofp_header *oh,
4605 struct ofputil_switch_config *config)
4607 ofputil_decode_switch_config(oh, config);
4611 ofputil_decode_set_config(const struct ofp_header *oh,
4612 struct ofputil_switch_config *config)
4614 return (ofputil_decode_switch_config(oh, config)
4616 : OFPERR_OFPSCFC_BAD_FLAGS);
4619 static struct ofpbuf *
4620 ofputil_put_switch_config(const struct ofputil_switch_config *config,
4623 const struct ofp_header *oh = b->data;
4624 struct ofp_switch_config *osc = ofpbuf_put_zeros(b, sizeof *osc);
4625 osc->flags = htons(config->frag);
4626 if (config->invalid_ttl_to_controller > 0 && oh->version < OFP13_VERSION) {
4627 osc->flags |= htons(OFPC_INVALID_TTL_TO_CONTROLLER);
4629 osc->miss_send_len = htons(config->miss_send_len);
4634 ofputil_encode_get_config_reply(const struct ofp_header *request,
4635 const struct ofputil_switch_config *config)
4637 struct ofpbuf *b = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY,
4639 return ofputil_put_switch_config(config, b);
4643 ofputil_encode_set_config(const struct ofputil_switch_config *config,
4644 enum ofp_version version)
4646 struct ofpbuf *b = ofpraw_alloc(OFPRAW_OFPT_SET_CONFIG, version, 0);
4647 return ofputil_put_switch_config(config, b);
4650 /* ofputil_switch_features */
4652 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
4653 OFPC_IP_REASM | OFPC_QUEUE_STATS)
4654 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
4655 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
4656 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
4657 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
4658 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
4659 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
4662 ofputil_capabilities_mask(enum ofp_version ofp_version)
4664 /* Handle capabilities whose bit is unique for all OpenFlow versions */
4665 switch (ofp_version) {
4668 return OFPC_COMMON | OFPC_ARP_MATCH_IP;
4674 return OFPC_COMMON | OFPC12_PORT_BLOCKED;
4676 /* Caller needs to check osf->header.version itself */
4681 /* Pulls an OpenFlow "switch_features" structure from 'b' and decodes it into
4682 * an abstract representation in '*features', readying 'b' to iterate over the
4683 * OpenFlow port structures following 'osf' with later calls to
4684 * ofputil_pull_phy_port(). Returns 0 if successful, otherwise an OFPERR_*
4687 ofputil_pull_switch_features(struct ofpbuf *b,
4688 struct ofputil_switch_features *features)
4690 const struct ofp_header *oh = b->data;
4691 enum ofpraw raw = ofpraw_pull_assert(b);
4692 const struct ofp_switch_features *osf = ofpbuf_pull(b, sizeof *osf);
4693 features->datapath_id = ntohll(osf->datapath_id);
4694 features->n_buffers = ntohl(osf->n_buffers);
4695 features->n_tables = osf->n_tables;
4696 features->auxiliary_id = 0;
4698 features->capabilities = ntohl(osf->capabilities) &
4699 ofputil_capabilities_mask(oh->version);
4701 if (raw == OFPRAW_OFPT10_FEATURES_REPLY) {
4702 if (osf->capabilities & htonl(OFPC10_STP)) {
4703 features->capabilities |= OFPUTIL_C_STP;
4705 features->ofpacts = ofpact_bitmap_from_openflow(osf->actions,
4707 } else if (raw == OFPRAW_OFPT11_FEATURES_REPLY
4708 || raw == OFPRAW_OFPT13_FEATURES_REPLY) {
4709 if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
4710 features->capabilities |= OFPUTIL_C_GROUP_STATS;
4712 features->ofpacts = 0;
4713 if (raw == OFPRAW_OFPT13_FEATURES_REPLY) {
4714 features->auxiliary_id = osf->auxiliary_id;
4717 return OFPERR_OFPBRC_BAD_VERSION;
4723 /* In OpenFlow 1.0, 1.1, and 1.2, an OFPT_FEATURES_REPLY message lists all the
4724 * switch's ports, unless there are too many to fit. In OpenFlow 1.3 and
4725 * later, an OFPT_FEATURES_REPLY does not list ports at all.
4727 * Given a buffer 'b' that contains a Features Reply message, this message
4728 * checks if it contains a complete list of the switch's ports. Returns true,
4729 * if so. Returns false if the list is missing (OF1.3+) or incomplete
4730 * (OF1.0/1.1/1.2), and in the latter case removes all of the ports from the
4733 * When this function returns false, the caller should send an OFPST_PORT_DESC
4734 * stats request to get the ports. */
4736 ofputil_switch_features_has_ports(struct ofpbuf *b)
4738 struct ofp_header *oh = b->data;
4739 size_t phy_port_size;
4741 if (oh->version >= OFP13_VERSION) {
4742 /* OpenFlow 1.3+ never has ports in the feature reply. */
4746 phy_port_size = (oh->version == OFP10_VERSION
4747 ? sizeof(struct ofp10_phy_port)
4748 : sizeof(struct ofp11_port));
4749 if (ntohs(oh->length) + phy_port_size <= UINT16_MAX) {
4750 /* There's room for additional ports in the feature reply.
4751 * Assume that the list is complete. */
4755 /* The feature reply has no room for more ports. Probably the list is
4756 * truncated. Drop the ports and tell the caller to retrieve them with
4757 * OFPST_PORT_DESC. */
4758 b->size = sizeof *oh + sizeof(struct ofp_switch_features);
4759 ofpmsg_update_length(b);
4763 /* Returns a buffer owned by the caller that encodes 'features' in the format
4764 * required by 'protocol' with the given 'xid'. The caller should append port
4765 * information to the buffer with subsequent calls to
4766 * ofputil_put_switch_features_port(). */
4768 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
4769 enum ofputil_protocol protocol, ovs_be32 xid)
4771 struct ofp_switch_features *osf;
4773 enum ofp_version version;
4776 version = ofputil_protocol_to_ofp_version(protocol);
4779 raw = OFPRAW_OFPT10_FEATURES_REPLY;
4783 raw = OFPRAW_OFPT11_FEATURES_REPLY;
4789 raw = OFPRAW_OFPT13_FEATURES_REPLY;
4794 b = ofpraw_alloc_xid(raw, version, xid, 0);
4795 osf = ofpbuf_put_zeros(b, sizeof *osf);
4796 osf->datapath_id = htonll(features->datapath_id);
4797 osf->n_buffers = htonl(features->n_buffers);
4798 osf->n_tables = features->n_tables;
4800 osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
4801 osf->capabilities = htonl(features->capabilities &
4802 ofputil_capabilities_mask(version));
4805 if (features->capabilities & OFPUTIL_C_STP) {
4806 osf->capabilities |= htonl(OFPC10_STP);
4808 osf->actions = ofpact_bitmap_to_openflow(features->ofpacts,
4815 osf->auxiliary_id = features->auxiliary_id;
4819 if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
4820 osf->capabilities |= htonl(OFPC11_GROUP_STATS);
4830 /* Encodes 'pp' into the format required by the switch_features message already
4831 * in 'b', which should have been returned by ofputil_encode_switch_features(),
4832 * and appends the encoded version to 'b'. */
4834 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
4837 const struct ofp_header *oh = b->data;
4839 if (oh->version < OFP13_VERSION) {
4840 /* Try adding a port description to the message, but drop it again if
4841 * the buffer overflows. (This possibility for overflow is why
4842 * OpenFlow 1.3+ moved port descriptions into a multipart message.) */
4843 size_t start_ofs = b->size;
4844 ofputil_put_phy_port(oh->version, pp, b);
4845 if (b->size > UINT16_MAX) {
4846 b->size = start_ofs;
4851 /* ofputil_port_status */
4853 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
4854 * in '*ps'. Returns 0 if successful, otherwise an OFPERR_* value. */
4856 ofputil_decode_port_status(const struct ofp_header *oh,
4857 struct ofputil_port_status *ps)
4859 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
4860 ofpraw_pull_assert(&b);
4862 const struct ofp_port_status *ops = ofpbuf_pull(&b, sizeof *ops);
4863 if (ops->reason != OFPPR_ADD &&
4864 ops->reason != OFPPR_DELETE &&
4865 ops->reason != OFPPR_MODIFY) {
4866 return OFPERR_NXBRC_BAD_REASON;
4868 ps->reason = ops->reason;
4870 int retval = ofputil_pull_phy_port(oh->version, &b, &ps->desc);
4871 ovs_assert(retval != EOF);
4875 /* Converts the abstract form of a "port status" message in '*ps' into an
4876 * OpenFlow message suitable for 'protocol', and returns that encoded form in
4877 * a buffer owned by the caller. */
4879 ofputil_encode_port_status(const struct ofputil_port_status *ps,
4880 enum ofputil_protocol protocol)
4882 struct ofp_port_status *ops;
4884 enum ofp_version version;
4887 version = ofputil_protocol_to_ofp_version(protocol);
4890 raw = OFPRAW_OFPT10_PORT_STATUS;
4896 raw = OFPRAW_OFPT11_PORT_STATUS;
4902 raw = OFPRAW_OFPT14_PORT_STATUS;
4909 b = ofpraw_alloc_xid(raw, version, htonl(0), 0);
4910 ops = ofpbuf_put_zeros(b, sizeof *ops);
4911 ops->reason = ps->reason;
4912 ofputil_put_phy_port(version, &ps->desc, b);
4913 ofpmsg_update_length(b);
4917 /* ofputil_port_mod */
4920 parse_port_mod_ethernet_property(struct ofpbuf *property,
4921 struct ofputil_port_mod *pm)
4926 error = ofpprop_parse_be32(property, &advertise);
4928 pm->advertise = netdev_port_features_from_ofp11(advertise);
4933 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
4934 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
4936 ofputil_decode_port_mod(const struct ofp_header *oh,
4937 struct ofputil_port_mod *pm, bool loose)
4939 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
4940 enum ofpraw raw = ofpraw_pull_assert(&b);
4941 if (raw == OFPRAW_OFPT10_PORT_MOD) {
4942 const struct ofp10_port_mod *opm = b.data;
4944 pm->port_no = u16_to_ofp(ntohs(opm->port_no));
4945 pm->hw_addr = opm->hw_addr;
4946 pm->config = ntohl(opm->config) & OFPPC10_ALL;
4947 pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
4948 pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
4949 } else if (raw == OFPRAW_OFPT11_PORT_MOD) {
4950 const struct ofp11_port_mod *opm = b.data;
4953 error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
4958 pm->hw_addr = opm->hw_addr;
4959 pm->config = ntohl(opm->config) & OFPPC11_ALL;
4960 pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
4961 pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
4962 } else if (raw == OFPRAW_OFPT14_PORT_MOD) {
4963 const struct ofp14_port_mod *opm = ofpbuf_pull(&b, sizeof *opm);
4966 memset(pm, 0, sizeof *pm);
4968 error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
4973 pm->hw_addr = opm->hw_addr;
4974 pm->config = ntohl(opm->config) & OFPPC11_ALL;
4975 pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
4977 while (b.size > 0) {
4978 struct ofpbuf property;
4982 error = ofpprop_pull(&b, &property, &type);
4988 case OFPPMPT14_ETHERNET:
4989 error = parse_port_mod_ethernet_property(&property, pm);
4993 error = OFPPROP_UNKNOWN(loose, "port_mod", type);
5002 return OFPERR_OFPBRC_BAD_TYPE;
5005 pm->config &= pm->mask;
5009 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
5010 * message suitable for 'protocol', and returns that encoded form in a buffer
5011 * owned by the caller. */
5013 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
5014 enum ofputil_protocol protocol)
5016 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
5019 switch (ofp_version) {
5020 case OFP10_VERSION: {
5021 struct ofp10_port_mod *opm;
5023 b = ofpraw_alloc(OFPRAW_OFPT10_PORT_MOD, ofp_version, 0);
5024 opm = ofpbuf_put_zeros(b, sizeof *opm);
5025 opm->port_no = htons(ofp_to_u16(pm->port_no));
5026 opm->hw_addr = pm->hw_addr;
5027 opm->config = htonl(pm->config & OFPPC10_ALL);
5028 opm->mask = htonl(pm->mask & OFPPC10_ALL);
5029 opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
5035 case OFP13_VERSION: {
5036 struct ofp11_port_mod *opm;
5038 b = ofpraw_alloc(OFPRAW_OFPT11_PORT_MOD, ofp_version, 0);
5039 opm = ofpbuf_put_zeros(b, sizeof *opm);
5040 opm->port_no = ofputil_port_to_ofp11(pm->port_no);
5041 opm->hw_addr = pm->hw_addr;
5042 opm->config = htonl(pm->config & OFPPC11_ALL);
5043 opm->mask = htonl(pm->mask & OFPPC11_ALL);
5044 opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
5049 case OFP16_VERSION: {
5050 struct ofp14_port_mod *opm;
5052 b = ofpraw_alloc(OFPRAW_OFPT14_PORT_MOD, ofp_version, 0);
5053 opm = ofpbuf_put_zeros(b, sizeof *opm);
5054 opm->port_no = ofputil_port_to_ofp11(pm->port_no);
5055 opm->hw_addr = pm->hw_addr;
5056 opm->config = htonl(pm->config & OFPPC11_ALL);
5057 opm->mask = htonl(pm->mask & OFPPC11_ALL);
5059 if (pm->advertise) {
5060 ofpprop_put_be32(b, OFPPMPT14_ETHERNET,
5061 netdev_port_features_to_ofp11(pm->advertise));
5072 /* Table features. */
5075 pull_table_feature_property(struct ofpbuf *msg, struct ofpbuf *payload,
5080 error = ofpprop_pull(msg, payload, typep);
5081 if (payload && !error) {
5082 ofpbuf_pull(payload, (char *)payload->msg - (char *)payload->header);
5088 parse_action_bitmap(struct ofpbuf *payload, enum ofp_version ofp_version,
5093 while (payload->size > 0) {
5097 error = ofpprop_pull__(payload, NULL, 1, 0x10000, &type);
5101 if (type < CHAR_BIT * sizeof types) {
5102 types |= 1u << type;
5106 *ofpacts = ofpact_bitmap_from_openflow(htonl(types), ofp_version);
5111 parse_instruction_ids(struct ofpbuf *payload, bool loose, uint32_t *insts)
5114 while (payload->size > 0) {
5115 enum ovs_instruction_type inst;
5119 /* OF1.3 and OF1.4 aren't clear about padding in the instruction IDs.
5120 * It seems clear that they aren't padded to 8 bytes, though, because
5121 * both standards say that "non-experimenter instructions are 4 bytes"
5122 * and do not mention any padding before the first instruction ID.
5123 * (There wouldn't be any point in padding to 8 bytes if the IDs were
5124 * aligned on an odd 4-byte boundary.)
5126 * Anyway, we just assume they're all glommed together on byte
5128 error = ofpprop_pull__(payload, NULL, 1, 0x10000, &ofpit);
5133 error = ovs_instruction_type_from_inst_type(&inst, ofpit);
5135 *insts |= 1u << inst;
5136 } else if (!loose) {
5144 parse_table_features_next_table(struct ofpbuf *payload,
5145 unsigned long int *next_tables)
5149 memset(next_tables, 0, bitmap_n_bytes(255));
5150 for (i = 0; i < payload->size; i++) {
5151 uint8_t id = ((const uint8_t *) payload->data)[i];
5153 return OFPERR_OFPBPC_BAD_VALUE;
5155 bitmap_set1(next_tables, id);
5161 parse_oxms(struct ofpbuf *payload, bool loose,
5162 struct mf_bitmap *exactp, struct mf_bitmap *maskedp)
5164 struct mf_bitmap exact = MF_BITMAP_INITIALIZER;
5165 struct mf_bitmap masked = MF_BITMAP_INITIALIZER;
5167 while (payload->size > 0) {
5168 const struct mf_field *field;
5172 error = nx_pull_header(payload, &field, &hasmask);
5174 bitmap_set1(hasmask ? masked.bm : exact.bm, field->id);
5175 } else if (error != OFPERR_OFPBMC_BAD_FIELD || !loose) {
5181 } else if (!bitmap_is_all_zeros(exact.bm, MFF_N_IDS)) {
5182 return OFPERR_OFPBMC_BAD_MASK;
5186 } else if (!bitmap_is_all_zeros(masked.bm, MFF_N_IDS)) {
5187 return OFPERR_OFPBMC_BAD_MASK;
5192 /* Converts an OFPMP_TABLE_FEATURES request or reply in 'msg' into an abstract
5193 * ofputil_table_features in 'tf'.
5195 * If 'loose' is true, this function ignores properties and values that it does
5196 * not understand, as a controller would want to do when interpreting
5197 * capabilities provided by a switch. If 'loose' is false, this function
5198 * treats unknown properties and values as an error, as a switch would want to
5199 * do when interpreting a configuration request made by a controller.
5201 * A single OpenFlow message can specify features for multiple tables. Calling
5202 * this function multiple times for a single 'msg' iterates through the tables
5203 * in the message. The caller must initially leave 'msg''s layer pointers null
5204 * and not modify them between calls.
5206 * Returns 0 if successful, EOF if no tables were left in this 'msg', otherwise
5207 * a positive "enum ofperr" value. */
5209 ofputil_decode_table_features(struct ofpbuf *msg,
5210 struct ofputil_table_features *tf, bool loose)
5212 memset(tf, 0, sizeof *tf);
5215 ofpraw_pull_assert(msg);
5222 const struct ofp_header *oh = msg->header;
5223 struct ofp13_table_features *otf = msg->data;
5224 if (msg->size < sizeof *otf) {
5225 return OFPERR_OFPBPC_BAD_LEN;
5228 unsigned int len = ntohs(otf->length);
5229 if (len < sizeof *otf || len % 8 || len > msg->size) {
5230 return OFPERR_OFPBPC_BAD_LEN;
5233 tf->table_id = otf->table_id;
5234 if (tf->table_id == OFPTT_ALL) {
5235 return OFPERR_OFPTFFC_BAD_TABLE;
5238 ovs_strlcpy(tf->name, otf->name, OFP_MAX_TABLE_NAME_LEN);
5239 tf->metadata_match = otf->metadata_match;
5240 tf->metadata_write = otf->metadata_write;
5241 tf->miss_config = OFPUTIL_TABLE_MISS_DEFAULT;
5242 if (oh->version >= OFP14_VERSION) {
5243 uint32_t caps = ntohl(otf->capabilities);
5244 tf->supports_eviction = (caps & OFPTC14_EVICTION) != 0;
5245 tf->supports_vacancy_events = (caps & OFPTC14_VACANCY_EVENTS) != 0;
5247 tf->supports_eviction = -1;
5248 tf->supports_vacancy_events = -1;
5250 tf->max_entries = ntohl(otf->max_entries);
5252 struct ofpbuf properties = ofpbuf_const_initializer(ofpbuf_pull(msg, len),
5254 ofpbuf_pull(&properties, sizeof *otf);
5255 while (properties.size > 0) {
5256 struct ofpbuf payload;
5260 error = pull_table_feature_property(&properties, &payload, &type);
5265 switch ((enum ofp13_table_feature_prop_type) type) {
5266 case OFPTFPT13_INSTRUCTIONS:
5267 error = parse_instruction_ids(&payload, loose,
5268 &tf->nonmiss.instructions);
5270 case OFPTFPT13_INSTRUCTIONS_MISS:
5271 error = parse_instruction_ids(&payload, loose,
5272 &tf->miss.instructions);
5275 case OFPTFPT13_NEXT_TABLES:
5276 error = parse_table_features_next_table(&payload,
5279 case OFPTFPT13_NEXT_TABLES_MISS:
5280 error = parse_table_features_next_table(&payload, tf->miss.next);
5283 case OFPTFPT13_WRITE_ACTIONS:
5284 error = parse_action_bitmap(&payload, oh->version,
5285 &tf->nonmiss.write.ofpacts);
5287 case OFPTFPT13_WRITE_ACTIONS_MISS:
5288 error = parse_action_bitmap(&payload, oh->version,
5289 &tf->miss.write.ofpacts);
5292 case OFPTFPT13_APPLY_ACTIONS:
5293 error = parse_action_bitmap(&payload, oh->version,
5294 &tf->nonmiss.apply.ofpacts);
5296 case OFPTFPT13_APPLY_ACTIONS_MISS:
5297 error = parse_action_bitmap(&payload, oh->version,
5298 &tf->miss.apply.ofpacts);
5301 case OFPTFPT13_MATCH:
5302 error = parse_oxms(&payload, loose, &tf->match, &tf->mask);
5304 case OFPTFPT13_WILDCARDS:
5305 error = parse_oxms(&payload, loose, &tf->wildcard, NULL);
5308 case OFPTFPT13_WRITE_SETFIELD:
5309 error = parse_oxms(&payload, loose,
5310 &tf->nonmiss.write.set_fields, NULL);
5312 case OFPTFPT13_WRITE_SETFIELD_MISS:
5313 error = parse_oxms(&payload, loose,
5314 &tf->miss.write.set_fields, NULL);
5316 case OFPTFPT13_APPLY_SETFIELD:
5317 error = parse_oxms(&payload, loose,
5318 &tf->nonmiss.apply.set_fields, NULL);
5320 case OFPTFPT13_APPLY_SETFIELD_MISS:
5321 error = parse_oxms(&payload, loose,
5322 &tf->miss.apply.set_fields, NULL);
5325 case OFPTFPT13_EXPERIMENTER:
5326 case OFPTFPT13_EXPERIMENTER_MISS:
5328 error = OFPPROP_UNKNOWN(loose, "table features", type);
5336 /* Fix inconsistencies:
5338 * - Turn on 'match' bits that are set in 'mask', because maskable
5339 * fields are matchable.
5341 * - Turn on 'wildcard' bits that are set in 'mask', because a field
5342 * that is arbitrarily maskable can be wildcarded entirely.
5344 * - Turn off 'wildcard' bits that are not in 'match', because a field
5345 * must be matchable for it to be meaningfully wildcarded. */
5346 bitmap_or(tf->match.bm, tf->mask.bm, MFF_N_IDS);
5347 bitmap_or(tf->wildcard.bm, tf->mask.bm, MFF_N_IDS);
5348 bitmap_and(tf->wildcard.bm, tf->match.bm, MFF_N_IDS);
5353 /* Encodes and returns a request to obtain the table features of a switch.
5354 * The message is encoded for OpenFlow version 'ofp_version'. */
5356 ofputil_encode_table_features_request(enum ofp_version ofp_version)
5358 struct ofpbuf *request = NULL;
5360 switch (ofp_version) {
5364 ovs_fatal(0, "dump-table-features needs OpenFlow 1.3 or later "
5365 "(\'-O OpenFlow13\')");
5370 request = ofpraw_alloc(OFPRAW_OFPST13_TABLE_FEATURES_REQUEST,
5381 put_fields_property(struct ofpbuf *reply,
5382 const struct mf_bitmap *fields,
5383 const struct mf_bitmap *masks,
5384 enum ofp13_table_feature_prop_type property,
5385 enum ofp_version version)
5390 start_ofs = ofpprop_start(reply, property);
5391 BITMAP_FOR_EACH_1 (field, MFF_N_IDS, fields->bm) {
5392 nx_put_header(reply, field, version,
5393 masks && bitmap_is_set(masks->bm, field));
5395 ofpprop_end(reply, start_ofs);
5399 put_table_action_features(struct ofpbuf *reply,
5400 const struct ofputil_table_action_features *taf,
5401 enum ofp13_table_feature_prop_type actions_type,
5402 enum ofp13_table_feature_prop_type set_fields_type,
5403 int miss_offset, enum ofp_version version)
5405 ofpprop_put_bitmap(reply, actions_type + miss_offset,
5406 ntohl(ofpact_bitmap_to_openflow(taf->ofpacts,
5408 put_fields_property(reply, &taf->set_fields, NULL,
5409 set_fields_type + miss_offset, version);
5413 put_table_instruction_features(
5414 struct ofpbuf *reply, const struct ofputil_table_instruction_features *tif,
5415 int miss_offset, enum ofp_version version)
5420 ofpprop_put_bitmap(reply, OFPTFPT13_INSTRUCTIONS + miss_offset,
5421 ntohl(ovsinst_bitmap_to_openflow(tif->instructions,
5424 start_ofs = ofpprop_start(reply, OFPTFPT13_NEXT_TABLES + miss_offset);
5425 BITMAP_FOR_EACH_1 (table_id, 255, tif->next) {
5426 ofpbuf_put(reply, &table_id, 1);
5428 ofpprop_end(reply, start_ofs);
5430 put_table_action_features(reply, &tif->write,
5431 OFPTFPT13_WRITE_ACTIONS,
5432 OFPTFPT13_WRITE_SETFIELD, miss_offset, version);
5433 put_table_action_features(reply, &tif->apply,
5434 OFPTFPT13_APPLY_ACTIONS,
5435 OFPTFPT13_APPLY_SETFIELD, miss_offset, version);
5439 ofputil_append_table_features_reply(const struct ofputil_table_features *tf,
5440 struct ovs_list *replies)
5442 struct ofpbuf *reply = ofpbuf_from_list(ovs_list_back(replies));
5443 enum ofp_version version = ofpmp_version(replies);
5444 size_t start_ofs = reply->size;
5445 struct ofp13_table_features *otf;
5447 otf = ofpbuf_put_zeros(reply, sizeof *otf);
5448 otf->table_id = tf->table_id;
5449 ovs_strlcpy(otf->name, tf->name, sizeof otf->name);
5450 otf->metadata_match = tf->metadata_match;
5451 otf->metadata_write = tf->metadata_write;
5452 if (version >= OFP14_VERSION) {
5453 if (tf->supports_eviction) {
5454 otf->capabilities |= htonl(OFPTC14_EVICTION);
5456 if (tf->supports_vacancy_events) {
5457 otf->capabilities |= htonl(OFPTC14_VACANCY_EVENTS);
5460 otf->max_entries = htonl(tf->max_entries);
5462 put_table_instruction_features(reply, &tf->nonmiss, 0, version);
5463 put_table_instruction_features(reply, &tf->miss, 1, version);
5465 put_fields_property(reply, &tf->match, &tf->mask,
5466 OFPTFPT13_MATCH, version);
5467 put_fields_property(reply, &tf->wildcard, NULL,
5468 OFPTFPT13_WILDCARDS, version);
5470 otf = ofpbuf_at_assert(reply, start_ofs, sizeof *otf);
5471 otf->length = htons(reply->size - start_ofs);
5472 ofpmp_postappend(replies, start_ofs);
5476 parse_table_desc_vacancy_property(struct ofpbuf *property,
5477 struct ofputil_table_desc *td)
5479 struct ofp14_table_mod_prop_vacancy *otv = property->data;
5481 if (property->size != sizeof *otv) {
5482 return OFPERR_OFPBPC_BAD_LEN;
5485 td->table_vacancy.vacancy_down = otv->vacancy_down;
5486 td->table_vacancy.vacancy_up = otv->vacancy_up;
5487 td->table_vacancy.vacancy = otv->vacancy;
5491 /* Decodes the next OpenFlow "table desc" message (of possibly several) from
5492 * 'msg' into an abstract form in '*td'. Returns 0 if successful, EOF if the
5493 * last "table desc" in 'msg' was already decoded, otherwise an OFPERR_*
5496 ofputil_decode_table_desc(struct ofpbuf *msg,
5497 struct ofputil_table_desc *td,
5498 enum ofp_version version)
5500 memset(td, 0, sizeof *td);
5503 ofpraw_pull_assert(msg);
5510 struct ofp14_table_desc *otd = ofpbuf_try_pull(msg, sizeof *otd);
5512 VLOG_WARN_RL(&bad_ofmsg_rl, "OFP14_TABLE_DESC reply has %"PRIu32" "
5513 "leftover bytes at end", msg->size);
5514 return OFPERR_OFPBRC_BAD_LEN;
5517 td->table_id = otd->table_id;
5518 size_t length = ntohs(otd->length);
5519 if (length < sizeof *otd || length - sizeof *otd > msg->size) {
5520 VLOG_WARN_RL(&bad_ofmsg_rl, "OFP14_TABLE_DESC reply claims invalid "
5521 "length %"PRIuSIZE, length);
5522 return OFPERR_OFPBRC_BAD_LEN;
5524 length -= sizeof *otd;
5526 td->eviction = ofputil_decode_table_eviction(otd->config, version);
5527 td->vacancy = ofputil_decode_table_vacancy(otd->config, version);
5528 td->eviction_flags = UINT32_MAX;
5530 struct ofpbuf properties = ofpbuf_const_initializer(
5531 ofpbuf_pull(msg, length), length);
5532 while (properties.size > 0) {
5533 struct ofpbuf payload;
5537 error = ofpprop_pull(&properties, &payload, &type);
5543 case OFPTMPT14_EVICTION:
5544 error = ofpprop_parse_u32(&payload, &td->eviction_flags);
5547 case OFPTMPT14_VACANCY:
5548 error = parse_table_desc_vacancy_property(&payload, td);
5552 error = OFPPROP_UNKNOWN(true, "table_desc", type);
5564 /* Encodes and returns a request to obtain description of tables of a switch.
5565 * The message is encoded for OpenFlow version 'ofp_version'. */
5567 ofputil_encode_table_desc_request(enum ofp_version ofp_version)
5569 struct ofpbuf *request = NULL;
5571 if (ofp_version >= OFP14_VERSION) {
5572 request = ofpraw_alloc(OFPRAW_OFPST14_TABLE_DESC_REQUEST,
5575 ovs_fatal(0, "dump-table-desc needs OpenFlow 1.4 or later "
5576 "(\'-O OpenFlow14\')");
5582 /* Function to append Table desc information in a reply list. */
5584 ofputil_append_table_desc_reply(const struct ofputil_table_desc *td,
5585 struct ovs_list *replies,
5586 enum ofp_version version)
5588 struct ofpbuf *reply = ofpbuf_from_list(ovs_list_back(replies));
5590 struct ofp14_table_desc *otd;
5592 start_otd = reply->size;
5593 ofpbuf_put_zeros(reply, sizeof *otd);
5594 if (td->eviction_flags != UINT32_MAX) {
5595 ofpprop_put_u32(reply, OFPTMPT14_EVICTION, td->eviction_flags);
5597 if (td->vacancy == OFPUTIL_TABLE_VACANCY_ON) {
5598 struct ofp14_table_mod_prop_vacancy *otv;
5600 otv = ofpprop_put_zeros(reply, OFPTMPT14_VACANCY, sizeof *otv);
5601 otv->vacancy_down = td->table_vacancy.vacancy_down;
5602 otv->vacancy_up = td->table_vacancy.vacancy_up;
5603 otv->vacancy = td->table_vacancy.vacancy;
5606 otd = ofpbuf_at_assert(reply, start_otd, sizeof *otd);
5607 otd->length = htons(reply->size - start_otd);
5608 otd->table_id = td->table_id;
5609 otd->config = ofputil_encode_table_config(OFPUTIL_TABLE_MISS_DEFAULT,
5610 td->eviction, td->vacancy,
5612 ofpmp_postappend(replies, start_otd);
5615 /* This function parses Vacancy property, and decodes the
5616 * ofp14_table_mod_prop_vacancy in ofputil_table_mod.
5617 * Returns OFPERR_OFPBPC_BAD_VALUE error code when vacancy_down is
5618 * greater than vacancy_up and also when current vacancy has non-zero
5619 * value. Returns 0 on success. */
5621 parse_table_mod_vacancy_property(struct ofpbuf *property,
5622 struct ofputil_table_mod *tm)
5624 struct ofp14_table_mod_prop_vacancy *otv = property->data;
5626 if (property->size != sizeof *otv) {
5627 return OFPERR_OFPBPC_BAD_LEN;
5629 tm->table_vacancy.vacancy_down = otv->vacancy_down;
5630 tm->table_vacancy.vacancy_up = otv->vacancy_up;
5631 if (tm->table_vacancy.vacancy_down > tm->table_vacancy.vacancy_up) {
5632 OFPPROP_LOG(&bad_ofmsg_rl, false,
5633 "Value of vacancy_down is greater than vacancy_up");
5634 return OFPERR_OFPBPC_BAD_VALUE;
5636 if (tm->table_vacancy.vacancy_down > 100 ||
5637 tm->table_vacancy.vacancy_up > 100) {
5638 OFPPROP_LOG(&bad_ofmsg_rl, false, "Vacancy threshold percentage "
5639 "should not be greater than 100");
5640 return OFPERR_OFPBPC_BAD_VALUE;
5642 tm->table_vacancy.vacancy = otv->vacancy;
5643 if (tm->table_vacancy.vacancy) {
5644 OFPPROP_LOG(&bad_ofmsg_rl, false,
5645 "Vacancy value should be zero for table-mod messages");
5646 return OFPERR_OFPBPC_BAD_VALUE;
5651 /* Given 'config', taken from an OpenFlow 'version' message that specifies
5652 * table configuration (a table mod, table stats, or table features message),
5653 * returns the table vacancy configuration that it specifies.
5655 * Only OpenFlow 1.4 and later specify table vacancy configuration this way,
5656 * so for other 'version' this function always returns
5657 * OFPUTIL_TABLE_VACANCY_DEFAULT. */
5658 static enum ofputil_table_vacancy
5659 ofputil_decode_table_vacancy(ovs_be32 config, enum ofp_version version)
5661 return (version < OFP14_VERSION ? OFPUTIL_TABLE_VACANCY_DEFAULT
5662 : config & htonl(OFPTC14_VACANCY_EVENTS) ? OFPUTIL_TABLE_VACANCY_ON
5663 : OFPUTIL_TABLE_VACANCY_OFF);
5666 /* Given 'config', taken from an OpenFlow 'version' message that specifies
5667 * table configuration (a table mod, table stats, or table features message),
5668 * returns the table eviction configuration that it specifies.
5670 * Only OpenFlow 1.4 and later specify table eviction configuration this way,
5671 * so for other 'version' values this function always returns
5672 * OFPUTIL_TABLE_EVICTION_DEFAULT. */
5673 static enum ofputil_table_eviction
5674 ofputil_decode_table_eviction(ovs_be32 config, enum ofp_version version)
5676 return (version < OFP14_VERSION ? OFPUTIL_TABLE_EVICTION_DEFAULT
5677 : config & htonl(OFPTC14_EVICTION) ? OFPUTIL_TABLE_EVICTION_ON
5678 : OFPUTIL_TABLE_EVICTION_OFF);
5681 /* Returns a bitmap of OFPTC* values suitable for 'config' fields in various
5682 * OpenFlow messages of the given 'version', based on the provided 'miss' and
5683 * 'eviction' values. */
5685 ofputil_encode_table_config(enum ofputil_table_miss miss,
5686 enum ofputil_table_eviction eviction,
5687 enum ofputil_table_vacancy vacancy,
5688 enum ofp_version version)
5690 uint32_t config = 0;
5691 /* See the section "OFPTC_* Table Configuration" in DESIGN.md for more
5692 * information on the crazy evolution of this field. */
5695 /* OpenFlow 1.0 didn't have such a field, any value ought to do. */
5700 /* OpenFlow 1.1 and 1.2 define only OFPTC11_TABLE_MISS_*. */
5702 case OFPUTIL_TABLE_MISS_DEFAULT:
5703 /* Really this shouldn't be used for encoding (the caller should
5704 * provide a specific value) but I can't imagine that defaulting to
5705 * the fall-through case here will hurt. */
5706 case OFPUTIL_TABLE_MISS_CONTROLLER:
5708 return htonl(OFPTC11_TABLE_MISS_CONTROLLER);
5709 case OFPUTIL_TABLE_MISS_CONTINUE:
5710 return htonl(OFPTC11_TABLE_MISS_CONTINUE);
5711 case OFPUTIL_TABLE_MISS_DROP:
5712 return htonl(OFPTC11_TABLE_MISS_DROP);
5717 /* OpenFlow 1.3 removed OFPTC11_TABLE_MISS_* and didn't define any new
5718 * flags, so this is correct. */
5724 /* OpenFlow 1.4 introduced OFPTC14_EVICTION and
5725 * OFPTC14_VACANCY_EVENTS. */
5726 if (eviction == OFPUTIL_TABLE_EVICTION_ON) {
5727 config |= OFPTC14_EVICTION;
5729 if (vacancy == OFPUTIL_TABLE_VACANCY_ON) {
5730 config |= OFPTC14_VACANCY_EVENTS;
5732 return htonl(config);
5738 /* Given 'config', taken from an OpenFlow 'version' message that specifies
5739 * table configuration (a table mod, table stats, or table features message),
5740 * returns the table miss configuration that it specifies.
5742 * Only OpenFlow 1.1 and 1.2 specify table miss configurations this way, so for
5743 * other 'version' values this function always returns
5744 * OFPUTIL_TABLE_MISS_DEFAULT. */
5745 static enum ofputil_table_miss
5746 ofputil_decode_table_miss(ovs_be32 config_, enum ofp_version version)
5748 uint32_t config = ntohl(config_);
5750 if (version == OFP11_VERSION || version == OFP12_VERSION) {
5751 switch (config & OFPTC11_TABLE_MISS_MASK) {
5752 case OFPTC11_TABLE_MISS_CONTROLLER:
5753 return OFPUTIL_TABLE_MISS_CONTROLLER;
5755 case OFPTC11_TABLE_MISS_CONTINUE:
5756 return OFPUTIL_TABLE_MISS_CONTINUE;
5758 case OFPTC11_TABLE_MISS_DROP:
5759 return OFPUTIL_TABLE_MISS_DROP;
5762 VLOG_WARN_RL(&bad_ofmsg_rl, "bad table miss config %d", config);
5763 return OFPUTIL_TABLE_MISS_CONTROLLER;
5766 return OFPUTIL_TABLE_MISS_DEFAULT;
5770 /* Decodes the OpenFlow "table mod" message in '*oh' into an abstract form in
5771 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
5773 ofputil_decode_table_mod(const struct ofp_header *oh,
5774 struct ofputil_table_mod *pm)
5776 memset(pm, 0, sizeof *pm);
5777 pm->miss = OFPUTIL_TABLE_MISS_DEFAULT;
5778 pm->eviction = OFPUTIL_TABLE_EVICTION_DEFAULT;
5779 pm->eviction_flags = UINT32_MAX;
5780 pm->vacancy = OFPUTIL_TABLE_VACANCY_DEFAULT;
5782 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
5783 enum ofpraw raw = ofpraw_pull_assert(&b);
5784 if (raw == OFPRAW_OFPT11_TABLE_MOD) {
5785 const struct ofp11_table_mod *otm = b.data;
5787 pm->table_id = otm->table_id;
5788 pm->miss = ofputil_decode_table_miss(otm->config, oh->version);
5789 } else if (raw == OFPRAW_OFPT14_TABLE_MOD) {
5790 const struct ofp14_table_mod *otm = ofpbuf_pull(&b, sizeof *otm);
5792 pm->table_id = otm->table_id;
5793 pm->miss = ofputil_decode_table_miss(otm->config, oh->version);
5794 pm->eviction = ofputil_decode_table_eviction(otm->config, oh->version);
5795 pm->vacancy = ofputil_decode_table_vacancy(otm->config, oh->version);
5796 while (b.size > 0) {
5797 struct ofpbuf property;
5801 error = ofpprop_pull(&b, &property, &type);
5807 case OFPTMPT14_EVICTION:
5808 error = ofpprop_parse_u32(&property, &pm->eviction);
5811 case OFPTMPT14_VACANCY:
5812 error = parse_table_mod_vacancy_property(&property, pm);
5816 error = OFPERR_OFPBRC_BAD_TYPE;
5825 return OFPERR_OFPBRC_BAD_TYPE;
5831 /* Converts the abstract form of a "table mod" message in '*tm' into an
5832 * OpenFlow message suitable for 'protocol', and returns that encoded form in a
5833 * buffer owned by the caller. */
5835 ofputil_encode_table_mod(const struct ofputil_table_mod *tm,
5836 enum ofputil_protocol protocol)
5838 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
5841 switch (ofp_version) {
5842 case OFP10_VERSION: {
5843 ovs_fatal(0, "table mod needs OpenFlow 1.1 or later "
5844 "(\'-O OpenFlow11\')");
5849 case OFP13_VERSION: {
5850 struct ofp11_table_mod *otm;
5852 b = ofpraw_alloc(OFPRAW_OFPT11_TABLE_MOD, ofp_version, 0);
5853 otm = ofpbuf_put_zeros(b, sizeof *otm);
5854 otm->table_id = tm->table_id;
5855 otm->config = ofputil_encode_table_config(tm->miss, tm->eviction,
5856 tm->vacancy, ofp_version);
5861 case OFP16_VERSION: {
5862 struct ofp14_table_mod *otm;
5864 b = ofpraw_alloc(OFPRAW_OFPT14_TABLE_MOD, ofp_version, 0);
5865 otm = ofpbuf_put_zeros(b, sizeof *otm);
5866 otm->table_id = tm->table_id;
5867 otm->config = ofputil_encode_table_config(tm->miss, tm->eviction,
5868 tm->vacancy, ofp_version);
5870 if (tm->eviction_flags != UINT32_MAX) {
5871 ofpprop_put_u32(b, OFPTMPT14_EVICTION, tm->eviction_flags);
5873 if (tm->vacancy == OFPUTIL_TABLE_VACANCY_ON) {
5874 struct ofp14_table_mod_prop_vacancy *otv;
5876 otv = ofpprop_put_zeros(b, OFPTMPT14_VACANCY, sizeof *otv);
5877 otv->vacancy_down = tm->table_vacancy.vacancy_down;
5878 otv->vacancy_up = tm->table_vacancy.vacancy_up;
5889 /* ofputil_role_request */
5891 /* Decodes the OpenFlow "role request" or "role reply" message in '*oh' into
5892 * an abstract form in '*rr'. Returns 0 if successful, otherwise an
5893 * OFPERR_* value. */
5895 ofputil_decode_role_message(const struct ofp_header *oh,
5896 struct ofputil_role_request *rr)
5898 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
5899 enum ofpraw raw = ofpraw_pull_assert(&b);
5900 if (raw == OFPRAW_OFPT12_ROLE_REQUEST ||
5901 raw == OFPRAW_OFPT12_ROLE_REPLY) {
5902 const struct ofp12_role_request *orr = b.msg;
5904 if (orr->role != htonl(OFPCR12_ROLE_NOCHANGE) &&
5905 orr->role != htonl(OFPCR12_ROLE_EQUAL) &&
5906 orr->role != htonl(OFPCR12_ROLE_MASTER) &&
5907 orr->role != htonl(OFPCR12_ROLE_SLAVE)) {
5908 return OFPERR_OFPRRFC_BAD_ROLE;
5911 rr->role = ntohl(orr->role);
5912 if (raw == OFPRAW_OFPT12_ROLE_REQUEST
5913 ? orr->role == htonl(OFPCR12_ROLE_NOCHANGE)
5914 : orr->generation_id == OVS_BE64_MAX) {
5915 rr->have_generation_id = false;
5916 rr->generation_id = 0;
5918 rr->have_generation_id = true;
5919 rr->generation_id = ntohll(orr->generation_id);
5921 } else if (raw == OFPRAW_NXT_ROLE_REQUEST ||
5922 raw == OFPRAW_NXT_ROLE_REPLY) {
5923 const struct nx_role_request *nrr = b.msg;
5925 BUILD_ASSERT(NX_ROLE_OTHER + 1 == OFPCR12_ROLE_EQUAL);
5926 BUILD_ASSERT(NX_ROLE_MASTER + 1 == OFPCR12_ROLE_MASTER);
5927 BUILD_ASSERT(NX_ROLE_SLAVE + 1 == OFPCR12_ROLE_SLAVE);
5929 if (nrr->role != htonl(NX_ROLE_OTHER) &&
5930 nrr->role != htonl(NX_ROLE_MASTER) &&
5931 nrr->role != htonl(NX_ROLE_SLAVE)) {
5932 return OFPERR_OFPRRFC_BAD_ROLE;
5935 rr->role = ntohl(nrr->role) + 1;
5936 rr->have_generation_id = false;
5937 rr->generation_id = 0;
5945 /* Returns an encoded form of a role reply suitable for the "request" in a
5946 * buffer owned by the caller. */
5948 ofputil_encode_role_reply(const struct ofp_header *request,
5949 const struct ofputil_role_request *rr)
5954 raw = ofpraw_decode_assert(request);
5955 if (raw == OFPRAW_OFPT12_ROLE_REQUEST) {
5956 struct ofp12_role_request *orr;
5958 buf = ofpraw_alloc_reply(OFPRAW_OFPT12_ROLE_REPLY, request, 0);
5959 orr = ofpbuf_put_zeros(buf, sizeof *orr);
5961 orr->role = htonl(rr->role);
5962 orr->generation_id = htonll(rr->have_generation_id
5965 } else if (raw == OFPRAW_NXT_ROLE_REQUEST) {
5966 struct nx_role_request *nrr;
5968 BUILD_ASSERT(NX_ROLE_OTHER == OFPCR12_ROLE_EQUAL - 1);
5969 BUILD_ASSERT(NX_ROLE_MASTER == OFPCR12_ROLE_MASTER - 1);
5970 BUILD_ASSERT(NX_ROLE_SLAVE == OFPCR12_ROLE_SLAVE - 1);
5972 buf = ofpraw_alloc_reply(OFPRAW_NXT_ROLE_REPLY, request, 0);
5973 nrr = ofpbuf_put_zeros(buf, sizeof *nrr);
5974 nrr->role = htonl(rr->role - 1);
5982 /* Encodes "role status" message 'status' for sending in the given
5983 * 'protocol'. Returns the role status message, if 'protocol' supports them,
5984 * otherwise a null pointer. */
5986 ofputil_encode_role_status(const struct ofputil_role_status *status,
5987 enum ofputil_protocol protocol)
5989 enum ofp_version version;
5991 version = ofputil_protocol_to_ofp_version(protocol);
5992 if (version >= OFP14_VERSION) {
5993 struct ofp14_role_status *rstatus;
5996 buf = ofpraw_alloc_xid(OFPRAW_OFPT14_ROLE_STATUS, version, htonl(0),
5998 rstatus = ofpbuf_put_zeros(buf, sizeof *rstatus);
5999 rstatus->role = htonl(status->role);
6000 rstatus->reason = status->reason;
6001 rstatus->generation_id = htonll(status->generation_id);
6010 ofputil_decode_role_status(const struct ofp_header *oh,
6011 struct ofputil_role_status *rs)
6013 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
6014 enum ofpraw raw = ofpraw_pull_assert(&b);
6015 ovs_assert(raw == OFPRAW_OFPT14_ROLE_STATUS);
6017 const struct ofp14_role_status *r = b.msg;
6018 if (r->role != htonl(OFPCR12_ROLE_NOCHANGE) &&
6019 r->role != htonl(OFPCR12_ROLE_EQUAL) &&
6020 r->role != htonl(OFPCR12_ROLE_MASTER) &&
6021 r->role != htonl(OFPCR12_ROLE_SLAVE)) {
6022 return OFPERR_OFPRRFC_BAD_ROLE;
6025 rs->role = ntohl(r->role);
6026 rs->generation_id = ntohll(r->generation_id);
6027 rs->reason = r->reason;
6032 /* Encodes 'rf' according to 'protocol', and returns the encoded message.
6033 * 'protocol' must be for OpenFlow 1.4 or later. */
6035 ofputil_encode_requestforward(const struct ofputil_requestforward *rf,
6036 enum ofputil_protocol protocol)
6038 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
6039 struct ofpbuf *inner;
6041 switch (rf->reason) {
6042 case OFPRFR_GROUP_MOD:
6043 inner = ofputil_encode_group_mod(ofp_version, rf->group_mod);
6046 case OFPRFR_METER_MOD:
6047 inner = ofputil_encode_meter_mod(ofp_version, rf->meter_mod);
6050 case OFPRFR_N_REASONS:
6055 struct ofp_header *inner_oh = inner->data;
6056 inner_oh->xid = rf->xid;
6057 inner_oh->length = htons(inner->size);
6059 struct ofpbuf *outer = ofpraw_alloc_xid(OFPRAW_OFPT14_REQUESTFORWARD,
6060 ofp_version, htonl(0),
6062 ofpbuf_put(outer, inner->data, inner->size);
6063 ofpbuf_delete(inner);
6068 /* Decodes OFPT_REQUESTFORWARD message 'outer'. On success, puts the decoded
6069 * form into '*rf' and returns 0, and the caller is later responsible for
6070 * freeing the content of 'rf', with ofputil_destroy_requestforward(rf). On
6071 * failure, returns an ofperr and '*rf' is indeterminate. */
6073 ofputil_decode_requestforward(const struct ofp_header *outer,
6074 struct ofputil_requestforward *rf)
6076 struct ofpbuf b = ofpbuf_const_initializer(outer, ntohs(outer->length));
6078 /* Skip past outer message. */
6079 enum ofpraw outer_raw = ofpraw_pull_assert(&b);
6080 ovs_assert(outer_raw == OFPRAW_OFPT14_REQUESTFORWARD);
6082 /* Validate inner message. */
6083 if (b.size < sizeof(struct ofp_header)) {
6084 return OFPERR_OFPBFC_MSG_BAD_LEN;
6086 const struct ofp_header *inner = b.data;
6087 unsigned int inner_len = ntohs(inner->length);
6088 if (inner_len < sizeof(struct ofp_header) || inner_len > b.size) {
6089 return OFPERR_OFPBFC_MSG_BAD_LEN;
6091 if (inner->version != outer->version) {
6092 return OFPERR_OFPBRC_BAD_VERSION;
6095 /* Parse inner message. */
6097 enum ofperr error = ofptype_decode(&type, inner);
6102 rf->xid = inner->xid;
6103 if (type == OFPTYPE_GROUP_MOD) {
6104 rf->reason = OFPRFR_GROUP_MOD;
6105 rf->group_mod = xmalloc(sizeof *rf->group_mod);
6106 error = ofputil_decode_group_mod(inner, rf->group_mod);
6108 free(rf->group_mod);
6111 } else if (type == OFPTYPE_METER_MOD) {
6112 rf->reason = OFPRFR_METER_MOD;
6113 rf->meter_mod = xmalloc(sizeof *rf->meter_mod);
6114 ofpbuf_init(&rf->bands, 64);
6115 error = ofputil_decode_meter_mod(inner, rf->meter_mod, &rf->bands);
6117 free(rf->meter_mod);
6118 ofpbuf_uninit(&rf->bands);
6122 return OFPERR_OFPBFC_MSG_UNSUP;
6128 /* Frees the content of 'rf', which should have been initialized through a
6129 * successful call to ofputil_decode_requestforward(). */
6131 ofputil_destroy_requestforward(struct ofputil_requestforward *rf)
6137 switch (rf->reason) {
6138 case OFPRFR_GROUP_MOD:
6139 ofputil_uninit_group_mod(rf->group_mod);
6140 free(rf->group_mod);
6143 case OFPRFR_METER_MOD:
6144 ofpbuf_uninit(&rf->bands);
6145 free(rf->meter_mod);
6148 case OFPRFR_N_REASONS:
6155 /* OpenFlow 1.0 and 1.1 don't distinguish between a field that cannot be
6156 * matched and a field that must be wildcarded. This function returns a bitmap
6157 * that contains both kinds of fields. */
6158 static struct mf_bitmap
6159 wild_or_nonmatchable_fields(const struct ofputil_table_features *features)
6161 struct mf_bitmap wc = features->match;
6162 bitmap_not(wc.bm, MFF_N_IDS);
6163 bitmap_or(wc.bm, features->wildcard.bm, MFF_N_IDS);
6167 struct ofp10_wc_map {
6168 enum ofp10_flow_wildcards wc10;
6169 enum mf_field_id mf;
6172 static const struct ofp10_wc_map ofp10_wc_map[] = {
6173 { OFPFW10_IN_PORT, MFF_IN_PORT },
6174 { OFPFW10_DL_VLAN, MFF_VLAN_VID },
6175 { OFPFW10_DL_SRC, MFF_ETH_SRC },
6176 { OFPFW10_DL_DST, MFF_ETH_DST},
6177 { OFPFW10_DL_TYPE, MFF_ETH_TYPE },
6178 { OFPFW10_NW_PROTO, MFF_IP_PROTO },
6179 { OFPFW10_TP_SRC, MFF_TCP_SRC },
6180 { OFPFW10_TP_DST, MFF_TCP_DST },
6181 { OFPFW10_NW_SRC_MASK, MFF_IPV4_SRC },
6182 { OFPFW10_NW_DST_MASK, MFF_IPV4_DST },
6183 { OFPFW10_DL_VLAN_PCP, MFF_VLAN_PCP },
6184 { OFPFW10_NW_TOS, MFF_IP_DSCP },
6188 mf_bitmap_to_of10(const struct mf_bitmap *fields)
6190 const struct ofp10_wc_map *p;
6193 for (p = ofp10_wc_map; p < &ofp10_wc_map[ARRAY_SIZE(ofp10_wc_map)]; p++) {
6194 if (bitmap_is_set(fields->bm, p->mf)) {
6201 static struct mf_bitmap
6202 mf_bitmap_from_of10(ovs_be32 wc10_)
6204 struct mf_bitmap fields = MF_BITMAP_INITIALIZER;
6205 const struct ofp10_wc_map *p;
6206 uint32_t wc10 = ntohl(wc10_);
6208 for (p = ofp10_wc_map; p < &ofp10_wc_map[ARRAY_SIZE(ofp10_wc_map)]; p++) {
6209 if (wc10 & p->wc10) {
6210 bitmap_set1(fields.bm, p->mf);
6217 ofputil_put_ofp10_table_stats(const struct ofputil_table_stats *stats,
6218 const struct ofputil_table_features *features,
6221 struct mf_bitmap wc = wild_or_nonmatchable_fields(features);
6222 struct ofp10_table_stats *out;
6224 out = ofpbuf_put_zeros(buf, sizeof *out);
6225 out->table_id = features->table_id;
6226 ovs_strlcpy(out->name, features->name, sizeof out->name);
6227 out->wildcards = mf_bitmap_to_of10(&wc);
6228 out->max_entries = htonl(features->max_entries);
6229 out->active_count = htonl(stats->active_count);
6230 put_32aligned_be64(&out->lookup_count, htonll(stats->lookup_count));
6231 put_32aligned_be64(&out->matched_count, htonll(stats->matched_count));
6234 struct ofp11_wc_map {
6235 enum ofp11_flow_match_fields wc11;
6236 enum mf_field_id mf;
6239 static const struct ofp11_wc_map ofp11_wc_map[] = {
6240 { OFPFMF11_IN_PORT, MFF_IN_PORT },
6241 { OFPFMF11_DL_VLAN, MFF_VLAN_VID },
6242 { OFPFMF11_DL_VLAN_PCP, MFF_VLAN_PCP },
6243 { OFPFMF11_DL_TYPE, MFF_ETH_TYPE },
6244 { OFPFMF11_NW_TOS, MFF_IP_DSCP },
6245 { OFPFMF11_NW_PROTO, MFF_IP_PROTO },
6246 { OFPFMF11_TP_SRC, MFF_TCP_SRC },
6247 { OFPFMF11_TP_DST, MFF_TCP_DST },
6248 { OFPFMF11_MPLS_LABEL, MFF_MPLS_LABEL },
6249 { OFPFMF11_MPLS_TC, MFF_MPLS_TC },
6250 /* I don't know what OFPFMF11_TYPE means. */
6251 { OFPFMF11_DL_SRC, MFF_ETH_SRC },
6252 { OFPFMF11_DL_DST, MFF_ETH_DST },
6253 { OFPFMF11_NW_SRC, MFF_IPV4_SRC },
6254 { OFPFMF11_NW_DST, MFF_IPV4_DST },
6255 { OFPFMF11_METADATA, MFF_METADATA },
6259 mf_bitmap_to_of11(const struct mf_bitmap *fields)
6261 const struct ofp11_wc_map *p;
6264 for (p = ofp11_wc_map; p < &ofp11_wc_map[ARRAY_SIZE(ofp11_wc_map)]; p++) {
6265 if (bitmap_is_set(fields->bm, p->mf)) {
6272 static struct mf_bitmap
6273 mf_bitmap_from_of11(ovs_be32 wc11_)
6275 struct mf_bitmap fields = MF_BITMAP_INITIALIZER;
6276 const struct ofp11_wc_map *p;
6277 uint32_t wc11 = ntohl(wc11_);
6279 for (p = ofp11_wc_map; p < &ofp11_wc_map[ARRAY_SIZE(ofp11_wc_map)]; p++) {
6280 if (wc11 & p->wc11) {
6281 bitmap_set1(fields.bm, p->mf);
6288 ofputil_put_ofp11_table_stats(const struct ofputil_table_stats *stats,
6289 const struct ofputil_table_features *features,
6292 struct mf_bitmap wc = wild_or_nonmatchable_fields(features);
6293 struct ofp11_table_stats *out;
6295 out = ofpbuf_put_zeros(buf, sizeof *out);
6296 out->table_id = features->table_id;
6297 ovs_strlcpy(out->name, features->name, sizeof out->name);
6298 out->wildcards = mf_bitmap_to_of11(&wc);
6299 out->match = mf_bitmap_to_of11(&features->match);
6300 out->instructions = ovsinst_bitmap_to_openflow(
6301 features->nonmiss.instructions, OFP11_VERSION);
6302 out->write_actions = ofpact_bitmap_to_openflow(
6303 features->nonmiss.write.ofpacts, OFP11_VERSION);
6304 out->apply_actions = ofpact_bitmap_to_openflow(
6305 features->nonmiss.apply.ofpacts, OFP11_VERSION);
6306 out->config = htonl(features->miss_config);
6307 out->max_entries = htonl(features->max_entries);
6308 out->active_count = htonl(stats->active_count);
6309 out->lookup_count = htonll(stats->lookup_count);
6310 out->matched_count = htonll(stats->matched_count);
6314 ofputil_put_ofp12_table_stats(const struct ofputil_table_stats *stats,
6315 const struct ofputil_table_features *features,
6318 struct ofp12_table_stats *out;
6320 out = ofpbuf_put_zeros(buf, sizeof *out);
6321 out->table_id = features->table_id;
6322 ovs_strlcpy(out->name, features->name, sizeof out->name);
6323 out->match = oxm_bitmap_from_mf_bitmap(&features->match, OFP12_VERSION);
6324 out->wildcards = oxm_bitmap_from_mf_bitmap(&features->wildcard,
6326 out->write_actions = ofpact_bitmap_to_openflow(
6327 features->nonmiss.write.ofpacts, OFP12_VERSION);
6328 out->apply_actions = ofpact_bitmap_to_openflow(
6329 features->nonmiss.apply.ofpacts, OFP12_VERSION);
6330 out->write_setfields = oxm_bitmap_from_mf_bitmap(
6331 &features->nonmiss.write.set_fields, OFP12_VERSION);
6332 out->apply_setfields = oxm_bitmap_from_mf_bitmap(
6333 &features->nonmiss.apply.set_fields, OFP12_VERSION);
6334 out->metadata_match = features->metadata_match;
6335 out->metadata_write = features->metadata_write;
6336 out->instructions = ovsinst_bitmap_to_openflow(
6337 features->nonmiss.instructions, OFP12_VERSION);
6338 out->config = ofputil_encode_table_config(features->miss_config,
6339 OFPUTIL_TABLE_EVICTION_DEFAULT,
6340 OFPUTIL_TABLE_VACANCY_DEFAULT,
6342 out->max_entries = htonl(features->max_entries);
6343 out->active_count = htonl(stats->active_count);
6344 out->lookup_count = htonll(stats->lookup_count);
6345 out->matched_count = htonll(stats->matched_count);
6349 ofputil_put_ofp13_table_stats(const struct ofputil_table_stats *stats,
6352 struct ofp13_table_stats *out;
6354 out = ofpbuf_put_zeros(buf, sizeof *out);
6355 out->table_id = stats->table_id;
6356 out->active_count = htonl(stats->active_count);
6357 out->lookup_count = htonll(stats->lookup_count);
6358 out->matched_count = htonll(stats->matched_count);
6362 ofputil_encode_table_stats_reply(const struct ofp_header *request)
6364 return ofpraw_alloc_stats_reply(request, 0);
6368 ofputil_append_table_stats_reply(struct ofpbuf *reply,
6369 const struct ofputil_table_stats *stats,
6370 const struct ofputil_table_features *features)
6372 struct ofp_header *oh = reply->header;
6374 ovs_assert(stats->table_id == features->table_id);
6376 switch ((enum ofp_version) oh->version) {
6378 ofputil_put_ofp10_table_stats(stats, features, reply);
6382 ofputil_put_ofp11_table_stats(stats, features, reply);
6386 ofputil_put_ofp12_table_stats(stats, features, reply);
6393 ofputil_put_ofp13_table_stats(stats, reply);
6402 ofputil_decode_ofp10_table_stats(struct ofpbuf *msg,
6403 struct ofputil_table_stats *stats,
6404 struct ofputil_table_features *features)
6406 struct ofp10_table_stats *ots;
6408 ots = ofpbuf_try_pull(msg, sizeof *ots);
6410 return OFPERR_OFPBRC_BAD_LEN;
6413 features->table_id = ots->table_id;
6414 ovs_strlcpy(features->name, ots->name, sizeof features->name);
6415 features->max_entries = ntohl(ots->max_entries);
6416 features->match = features->wildcard = mf_bitmap_from_of10(ots->wildcards);
6418 stats->table_id = ots->table_id;
6419 stats->active_count = ntohl(ots->active_count);
6420 stats->lookup_count = ntohll(get_32aligned_be64(&ots->lookup_count));
6421 stats->matched_count = ntohll(get_32aligned_be64(&ots->matched_count));
6427 ofputil_decode_ofp11_table_stats(struct ofpbuf *msg,
6428 struct ofputil_table_stats *stats,
6429 struct ofputil_table_features *features)
6431 struct ofp11_table_stats *ots;
6433 ots = ofpbuf_try_pull(msg, sizeof *ots);
6435 return OFPERR_OFPBRC_BAD_LEN;
6438 features->table_id = ots->table_id;
6439 ovs_strlcpy(features->name, ots->name, sizeof features->name);
6440 features->max_entries = ntohl(ots->max_entries);
6441 features->nonmiss.instructions = ovsinst_bitmap_from_openflow(
6442 ots->instructions, OFP11_VERSION);
6443 features->nonmiss.write.ofpacts = ofpact_bitmap_from_openflow(
6444 ots->write_actions, OFP11_VERSION);
6445 features->nonmiss.apply.ofpacts = ofpact_bitmap_from_openflow(
6446 ots->write_actions, OFP11_VERSION);
6447 features->miss = features->nonmiss;
6448 features->miss_config = ofputil_decode_table_miss(ots->config,
6450 features->match = mf_bitmap_from_of11(ots->match);
6451 features->wildcard = mf_bitmap_from_of11(ots->wildcards);
6452 bitmap_or(features->match.bm, features->wildcard.bm, MFF_N_IDS);
6454 stats->table_id = ots->table_id;
6455 stats->active_count = ntohl(ots->active_count);
6456 stats->lookup_count = ntohll(ots->lookup_count);
6457 stats->matched_count = ntohll(ots->matched_count);
6463 ofputil_decode_ofp12_table_stats(struct ofpbuf *msg,
6464 struct ofputil_table_stats *stats,
6465 struct ofputil_table_features *features)
6467 struct ofp12_table_stats *ots;
6469 ots = ofpbuf_try_pull(msg, sizeof *ots);
6471 return OFPERR_OFPBRC_BAD_LEN;
6474 features->table_id = ots->table_id;
6475 ovs_strlcpy(features->name, ots->name, sizeof features->name);
6476 features->metadata_match = ots->metadata_match;
6477 features->metadata_write = ots->metadata_write;
6478 features->miss_config = ofputil_decode_table_miss(ots->config,
6480 features->max_entries = ntohl(ots->max_entries);
6482 features->nonmiss.instructions = ovsinst_bitmap_from_openflow(
6483 ots->instructions, OFP12_VERSION);
6484 features->nonmiss.write.ofpacts = ofpact_bitmap_from_openflow(
6485 ots->write_actions, OFP12_VERSION);
6486 features->nonmiss.apply.ofpacts = ofpact_bitmap_from_openflow(
6487 ots->apply_actions, OFP12_VERSION);
6488 features->nonmiss.write.set_fields = oxm_bitmap_to_mf_bitmap(
6489 ots->write_setfields, OFP12_VERSION);
6490 features->nonmiss.apply.set_fields = oxm_bitmap_to_mf_bitmap(
6491 ots->apply_setfields, OFP12_VERSION);
6492 features->miss = features->nonmiss;
6494 features->match = oxm_bitmap_to_mf_bitmap(ots->match, OFP12_VERSION);
6495 features->wildcard = oxm_bitmap_to_mf_bitmap(ots->wildcards,
6497 bitmap_or(features->match.bm, features->wildcard.bm, MFF_N_IDS);
6499 stats->table_id = ots->table_id;
6500 stats->active_count = ntohl(ots->active_count);
6501 stats->lookup_count = ntohll(ots->lookup_count);
6502 stats->matched_count = ntohll(ots->matched_count);
6508 ofputil_decode_ofp13_table_stats(struct ofpbuf *msg,
6509 struct ofputil_table_stats *stats,
6510 struct ofputil_table_features *features)
6512 struct ofp13_table_stats *ots;
6514 ots = ofpbuf_try_pull(msg, sizeof *ots);
6516 return OFPERR_OFPBRC_BAD_LEN;
6519 features->table_id = ots->table_id;
6521 stats->table_id = ots->table_id;
6522 stats->active_count = ntohl(ots->active_count);
6523 stats->lookup_count = ntohll(ots->lookup_count);
6524 stats->matched_count = ntohll(ots->matched_count);
6530 ofputil_decode_table_stats_reply(struct ofpbuf *msg,
6531 struct ofputil_table_stats *stats,
6532 struct ofputil_table_features *features)
6534 const struct ofp_header *oh;
6537 ofpraw_pull_assert(msg);
6545 memset(stats, 0, sizeof *stats);
6546 memset(features, 0, sizeof *features);
6547 features->supports_eviction = -1;
6548 features->supports_vacancy_events = -1;
6550 switch ((enum ofp_version) oh->version) {
6552 return ofputil_decode_ofp10_table_stats(msg, stats, features);
6555 return ofputil_decode_ofp11_table_stats(msg, stats, features);
6558 return ofputil_decode_ofp12_table_stats(msg, stats, features);
6564 return ofputil_decode_ofp13_table_stats(msg, stats, features);
6571 /* ofputil_flow_monitor_request */
6573 /* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract
6574 * ofputil_flow_monitor_request in 'rq'.
6576 * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow
6577 * message. Calling this function multiple times for a single 'msg' iterates
6578 * through the requests. The caller must initially leave 'msg''s layer
6579 * pointers null and not modify them between calls.
6581 * Returns 0 if successful, EOF if no requests were left in this 'msg',
6582 * otherwise an OFPERR_* value. */
6584 ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *rq,
6587 struct nx_flow_monitor_request *nfmr;
6591 ofpraw_pull_assert(msg);
6598 nfmr = ofpbuf_try_pull(msg, sizeof *nfmr);
6600 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR request has %"PRIu32" "
6601 "leftover bytes at end", msg->size);
6602 return OFPERR_OFPBRC_BAD_LEN;
6605 flags = ntohs(nfmr->flags);
6606 if (!(flags & (NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY))
6607 || flags & ~(NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE
6608 | NXFMF_MODIFY | NXFMF_ACTIONS | NXFMF_OWN)) {
6609 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR has bad flags %#"PRIx16,
6611 return OFPERR_OFPMOFC_BAD_FLAGS;
6614 if (!is_all_zeros(nfmr->zeros, sizeof nfmr->zeros)) {
6615 return OFPERR_NXBRC_MUST_BE_ZERO;
6618 rq->id = ntohl(nfmr->id);
6620 rq->out_port = u16_to_ofp(ntohs(nfmr->out_port));
6621 rq->table_id = nfmr->table_id;
6623 return nx_pull_match(msg, ntohs(nfmr->match_len), &rq->match, NULL, NULL);
6627 ofputil_append_flow_monitor_request(
6628 const struct ofputil_flow_monitor_request *rq, struct ofpbuf *msg)
6630 struct nx_flow_monitor_request *nfmr;
6635 ofpraw_put(OFPRAW_NXST_FLOW_MONITOR_REQUEST, OFP10_VERSION, msg);
6638 start_ofs = msg->size;
6639 ofpbuf_put_zeros(msg, sizeof *nfmr);
6640 match_len = nx_put_match(msg, &rq->match, htonll(0), htonll(0));
6642 nfmr = ofpbuf_at_assert(msg, start_ofs, sizeof *nfmr);
6643 nfmr->id = htonl(rq->id);
6644 nfmr->flags = htons(rq->flags);
6645 nfmr->out_port = htons(ofp_to_u16(rq->out_port));
6646 nfmr->match_len = htons(match_len);
6647 nfmr->table_id = rq->table_id;
6650 /* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg'
6651 * into an abstract ofputil_flow_update in 'update'. The caller must have
6652 * initialized update->match to point to space allocated for a match.
6654 * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's
6655 * actions (except for NXFME_ABBREV, which never includes actions). The caller
6656 * must initialize 'ofpacts' and retains ownership of it. 'update->ofpacts'
6657 * will point into the 'ofpacts' buffer.
6659 * Multiple flow updates can be packed into a single OpenFlow message. Calling
6660 * this function multiple times for a single 'msg' iterates through the
6661 * updates. The caller must initially leave 'msg''s layer pointers null and
6662 * not modify them between calls.
6664 * Returns 0 if successful, EOF if no updates were left in this 'msg',
6665 * otherwise an OFPERR_* value. */
6667 ofputil_decode_flow_update(struct ofputil_flow_update *update,
6668 struct ofpbuf *msg, struct ofpbuf *ofpacts)
6670 struct nx_flow_update_header *nfuh;
6671 unsigned int length;
6672 struct ofp_header *oh;
6675 ofpraw_pull_assert(msg);
6678 ofpbuf_clear(ofpacts);
6683 if (msg->size < sizeof(struct nx_flow_update_header)) {
6690 update->event = ntohs(nfuh->event);
6691 length = ntohs(nfuh->length);
6692 if (length > msg->size || length % 8) {
6696 if (update->event == NXFME_ABBREV) {
6697 struct nx_flow_update_abbrev *nfua;
6699 if (length != sizeof *nfua) {
6703 nfua = ofpbuf_pull(msg, sizeof *nfua);
6704 update->xid = nfua->xid;
6706 } else if (update->event == NXFME_ADDED
6707 || update->event == NXFME_DELETED
6708 || update->event == NXFME_MODIFIED) {
6709 struct nx_flow_update_full *nfuf;
6710 unsigned int actions_len;
6711 unsigned int match_len;
6714 if (length < sizeof *nfuf) {
6718 nfuf = ofpbuf_pull(msg, sizeof *nfuf);
6719 match_len = ntohs(nfuf->match_len);
6720 if (sizeof *nfuf + match_len > length) {
6724 update->reason = ntohs(nfuf->reason);
6725 update->idle_timeout = ntohs(nfuf->idle_timeout);
6726 update->hard_timeout = ntohs(nfuf->hard_timeout);
6727 update->table_id = nfuf->table_id;
6728 update->cookie = nfuf->cookie;
6729 update->priority = ntohs(nfuf->priority);
6731 error = nx_pull_match(msg, match_len, update->match, NULL, NULL);
6736 actions_len = length - sizeof *nfuf - ROUND_UP(match_len, 8);
6737 error = ofpacts_pull_openflow_actions(msg, actions_len, oh->version,
6743 update->ofpacts = ofpacts->data;
6744 update->ofpacts_len = ofpacts->size;
6747 VLOG_WARN_RL(&bad_ofmsg_rl,
6748 "NXST_FLOW_MONITOR reply has bad event %"PRIu16,
6749 ntohs(nfuh->event));
6750 return OFPERR_NXBRC_FM_BAD_EVENT;
6754 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR reply has %"PRIu32" "
6755 "leftover bytes at end", msg->size);
6756 return OFPERR_OFPBRC_BAD_LEN;
6760 ofputil_decode_flow_monitor_cancel(const struct ofp_header *oh)
6762 const struct nx_flow_monitor_cancel *cancel = ofpmsg_body(oh);
6764 return ntohl(cancel->id);
6768 ofputil_encode_flow_monitor_cancel(uint32_t id)
6770 struct nx_flow_monitor_cancel *nfmc;
6773 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MONITOR_CANCEL, OFP10_VERSION, 0);
6774 nfmc = ofpbuf_put_uninit(msg, sizeof *nfmc);
6775 nfmc->id = htonl(id);
6780 ofputil_start_flow_update(struct ovs_list *replies)
6784 msg = ofpraw_alloc_xid(OFPRAW_NXST_FLOW_MONITOR_REPLY, OFP10_VERSION,
6787 ovs_list_init(replies);
6788 ovs_list_push_back(replies, &msg->list_node);
6792 ofputil_append_flow_update(const struct ofputil_flow_update *update,
6793 struct ovs_list *replies)
6795 enum ofp_version version = ofpmp_version(replies);
6796 struct nx_flow_update_header *nfuh;
6800 msg = ofpbuf_from_list(ovs_list_back(replies));
6801 start_ofs = msg->size;
6803 if (update->event == NXFME_ABBREV) {
6804 struct nx_flow_update_abbrev *nfua;
6806 nfua = ofpbuf_put_zeros(msg, sizeof *nfua);
6807 nfua->xid = update->xid;
6809 struct nx_flow_update_full *nfuf;
6812 ofpbuf_put_zeros(msg, sizeof *nfuf);
6813 match_len = nx_put_match(msg, update->match, htonll(0), htonll(0));
6814 ofpacts_put_openflow_actions(update->ofpacts, update->ofpacts_len, msg,
6816 nfuf = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuf);
6817 nfuf->reason = htons(update->reason);
6818 nfuf->priority = htons(update->priority);
6819 nfuf->idle_timeout = htons(update->idle_timeout);
6820 nfuf->hard_timeout = htons(update->hard_timeout);
6821 nfuf->match_len = htons(match_len);
6822 nfuf->table_id = update->table_id;
6823 nfuf->cookie = update->cookie;
6826 nfuh = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuh);
6827 nfuh->length = htons(msg->size - start_ofs);
6828 nfuh->event = htons(update->event);
6830 ofpmp_postappend(replies, start_ofs);
6834 ofputil_encode_packet_out(const struct ofputil_packet_out *po,
6835 enum ofputil_protocol protocol)
6837 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
6841 size = po->ofpacts_len;
6842 if (po->buffer_id == UINT32_MAX) {
6843 size += po->packet_len;
6846 switch (ofp_version) {
6847 case OFP10_VERSION: {
6848 struct ofp10_packet_out *opo;
6851 msg = ofpraw_alloc(OFPRAW_OFPT10_PACKET_OUT, OFP10_VERSION, size);
6852 ofpbuf_put_zeros(msg, sizeof *opo);
6853 actions_ofs = msg->size;
6854 ofpacts_put_openflow_actions(po->ofpacts, po->ofpacts_len, msg,
6858 opo->buffer_id = htonl(po->buffer_id);
6859 opo->in_port = htons(ofp_to_u16(po->in_port));
6860 opo->actions_len = htons(msg->size - actions_ofs);
6869 case OFP16_VERSION: {
6870 struct ofp11_packet_out *opo;
6873 msg = ofpraw_alloc(OFPRAW_OFPT11_PACKET_OUT, ofp_version, size);
6874 ofpbuf_put_zeros(msg, sizeof *opo);
6875 len = ofpacts_put_openflow_actions(po->ofpacts, po->ofpacts_len, msg,
6878 opo->buffer_id = htonl(po->buffer_id);
6879 opo->in_port = ofputil_port_to_ofp11(po->in_port);
6880 opo->actions_len = htons(len);
6888 if (po->buffer_id == UINT32_MAX) {
6889 ofpbuf_put(msg, po->packet, po->packet_len);
6892 ofpmsg_update_length(msg);
6897 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
6899 make_echo_request(enum ofp_version ofp_version)
6901 return ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST, ofp_version,
6905 /* Creates and returns an OFPT_ECHO_REPLY message matching the
6906 * OFPT_ECHO_REQUEST message in 'rq'. */
6908 make_echo_reply(const struct ofp_header *rq)
6910 struct ofpbuf rq_buf = ofpbuf_const_initializer(rq, ntohs(rq->length));
6911 ofpraw_pull_assert(&rq_buf);
6913 struct ofpbuf *reply = ofpraw_alloc_reply(OFPRAW_OFPT_ECHO_REPLY,
6915 ofpbuf_put(reply, rq_buf.data, rq_buf.size);
6920 ofputil_encode_barrier_request(enum ofp_version ofp_version)
6924 switch (ofp_version) {
6931 type = OFPRAW_OFPT11_BARRIER_REQUEST;
6935 type = OFPRAW_OFPT10_BARRIER_REQUEST;
6942 return ofpraw_alloc(type, ofp_version, 0);
6946 ofputil_frag_handling_to_string(enum ofputil_frag_handling frag)
6949 case OFPUTIL_FRAG_NORMAL: return "normal";
6950 case OFPUTIL_FRAG_DROP: return "drop";
6951 case OFPUTIL_FRAG_REASM: return "reassemble";
6952 case OFPUTIL_FRAG_NX_MATCH: return "nx-match";
6959 ofputil_frag_handling_from_string(const char *s,
6960 enum ofputil_frag_handling *frag)
6962 if (!strcasecmp(s, "normal")) {
6963 *frag = OFPUTIL_FRAG_NORMAL;
6964 } else if (!strcasecmp(s, "drop")) {
6965 *frag = OFPUTIL_FRAG_DROP;
6966 } else if (!strcasecmp(s, "reassemble")) {
6967 *frag = OFPUTIL_FRAG_REASM;
6968 } else if (!strcasecmp(s, "nx-match")) {
6969 *frag = OFPUTIL_FRAG_NX_MATCH;
6976 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
6977 * port number and stores the latter in '*ofp10_port', for the purpose of
6978 * decoding OpenFlow 1.1+ protocol messages. Returns 0 if successful,
6979 * otherwise an OFPERR_* number. On error, stores OFPP_NONE in '*ofp10_port'.
6981 * See the definition of OFP11_MAX for an explanation of the mapping. */
6983 ofputil_port_from_ofp11(ovs_be32 ofp11_port, ofp_port_t *ofp10_port)
6985 uint32_t ofp11_port_h = ntohl(ofp11_port);
6987 if (ofp11_port_h < ofp_to_u16(OFPP_MAX)) {
6988 *ofp10_port = u16_to_ofp(ofp11_port_h);
6990 } else if (ofp11_port_h >= ofp11_to_u32(OFPP11_MAX)) {
6991 *ofp10_port = u16_to_ofp(ofp11_port_h - OFPP11_OFFSET);
6994 *ofp10_port = OFPP_NONE;
6995 VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
6996 "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
6997 ofp11_port_h, ofp_to_u16(OFPP_MAX) - 1,
6998 ofp11_to_u32(OFPP11_MAX), UINT32_MAX);
6999 return OFPERR_OFPBAC_BAD_OUT_PORT;
7003 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
7004 * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
7006 * See the definition of OFP11_MAX for an explanation of the mapping. */
7008 ofputil_port_to_ofp11(ofp_port_t ofp10_port)
7010 return htonl(ofp_to_u16(ofp10_port) < ofp_to_u16(OFPP_MAX)
7011 ? ofp_to_u16(ofp10_port)
7012 : ofp_to_u16(ofp10_port) + OFPP11_OFFSET);
7015 #define OFPUTIL_NAMED_PORTS \
7016 OFPUTIL_NAMED_PORT(IN_PORT) \
7017 OFPUTIL_NAMED_PORT(TABLE) \
7018 OFPUTIL_NAMED_PORT(NORMAL) \
7019 OFPUTIL_NAMED_PORT(FLOOD) \
7020 OFPUTIL_NAMED_PORT(ALL) \
7021 OFPUTIL_NAMED_PORT(CONTROLLER) \
7022 OFPUTIL_NAMED_PORT(LOCAL) \
7023 OFPUTIL_NAMED_PORT(ANY) \
7024 OFPUTIL_NAMED_PORT(UNSET)
7026 /* For backwards compatibility, so that "none" is recognized as OFPP_ANY */
7027 #define OFPUTIL_NAMED_PORTS_WITH_NONE \
7028 OFPUTIL_NAMED_PORTS \
7029 OFPUTIL_NAMED_PORT(NONE)
7031 /* Stores the port number represented by 's' into '*portp'. 's' may be an
7032 * integer or, for reserved ports, the standard OpenFlow name for the port
7035 * Returns true if successful, false if 's' is not a valid OpenFlow port number
7036 * or name. The caller should issue an error message in this case, because
7037 * this function usually does not. (This gives the caller an opportunity to
7038 * look up the port name another way, e.g. by contacting the switch and listing
7039 * the names of all its ports).
7041 * This function accepts OpenFlow 1.0 port numbers. It also accepts a subset
7042 * of OpenFlow 1.1+ port numbers, mapping those port numbers into the 16-bit
7043 * range as described in include/openflow/openflow-1.1.h. */
7045 ofputil_port_from_string(const char *s, ofp_port_t *portp)
7047 unsigned int port32; /* int is at least 32 bits wide. */
7050 VLOG_WARN("Negative value %s is not a valid port number.", s);
7054 if (str_to_uint(s, 10, &port32)) {
7055 if (port32 < ofp_to_u16(OFPP_MAX)) {
7057 } else if (port32 < ofp_to_u16(OFPP_FIRST_RESV)) {
7058 VLOG_WARN("port %u is a reserved OF1.0 port number that will "
7059 "be translated to %u when talking to an OF1.1 or "
7060 "later controller", port32, port32 + OFPP11_OFFSET);
7061 } else if (port32 <= ofp_to_u16(OFPP_LAST_RESV)) {
7062 char name[OFP_MAX_PORT_NAME_LEN];
7064 ofputil_port_to_string(u16_to_ofp(port32), name, sizeof name);
7065 VLOG_WARN_ONCE("referring to port %s as %"PRIu32" is deprecated "
7066 "for compatibility with OpenFlow 1.1 and later",
7068 } else if (port32 < ofp11_to_u32(OFPP11_MAX)) {
7069 VLOG_WARN("port %u is outside the supported range 0 through "
7070 "%"PRIx16" or 0x%x through 0x%"PRIx32, port32,
7071 UINT16_MAX, ofp11_to_u32(OFPP11_MAX), UINT32_MAX);
7074 port32 -= OFPP11_OFFSET;
7077 *portp = u16_to_ofp(port32);
7084 static const struct pair pairs[] = {
7085 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
7086 OFPUTIL_NAMED_PORTS_WITH_NONE
7087 #undef OFPUTIL_NAMED_PORT
7089 const struct pair *p;
7091 for (p = pairs; p < &pairs[ARRAY_SIZE(pairs)]; p++) {
7092 if (!strcasecmp(s, p->name)) {
7101 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
7102 * Most ports' string representation is just the port number, but for special
7103 * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
7105 ofputil_format_port(ofp_port_t port, struct ds *s)
7107 char name[OFP_MAX_PORT_NAME_LEN];
7109 ofputil_port_to_string(port, name, sizeof name);
7110 ds_put_cstr(s, name);
7113 /* Puts in the 'bufsize' byte in 'namebuf' a null-terminated string
7114 * representation of OpenFlow port number 'port'. Most ports are represented
7115 * as just the port number, but special ports, e.g. OFPP_LOCAL, are represented
7116 * by name, e.g. "LOCAL". */
7118 ofputil_port_to_string(ofp_port_t port,
7119 char namebuf[OFP_MAX_PORT_NAME_LEN], size_t bufsize)
7122 #define OFPUTIL_NAMED_PORT(NAME) \
7124 ovs_strlcpy(namebuf, #NAME, bufsize); \
7127 #undef OFPUTIL_NAMED_PORT
7130 snprintf(namebuf, bufsize, "%"PRIu16, port);
7135 /* Stores the group id represented by 's' into '*group_idp'. 's' may be an
7136 * integer or, for reserved group IDs, the standard OpenFlow name for the group
7137 * (either "ANY" or "ALL").
7139 * Returns true if successful, false if 's' is not a valid OpenFlow group ID or
7142 ofputil_group_from_string(const char *s, uint32_t *group_idp)
7144 if (!strcasecmp(s, "any")) {
7145 *group_idp = OFPG_ANY;
7146 } else if (!strcasecmp(s, "all")) {
7147 *group_idp = OFPG_ALL;
7148 } else if (!str_to_uint(s, 10, group_idp)) {
7149 VLOG_WARN("%s is not a valid group ID. (Valid group IDs are "
7150 "32-bit nonnegative integers or the keywords ANY or "
7158 /* Appends to 's' a string representation of the OpenFlow group ID 'group_id'.
7159 * Most groups' string representation is just the number, but for special
7160 * groups, e.g. OFPG_ALL, it is the name, e.g. "ALL". */
7162 ofputil_format_group(uint32_t group_id, struct ds *s)
7164 char name[MAX_GROUP_NAME_LEN];
7166 ofputil_group_to_string(group_id, name, sizeof name);
7167 ds_put_cstr(s, name);
7171 /* Puts in the 'bufsize' byte in 'namebuf' a null-terminated string
7172 * representation of OpenFlow group ID 'group_id'. Most group are represented
7173 * as just their number, but special groups, e.g. OFPG_ALL, are represented
7174 * by name, e.g. "ALL". */
7176 ofputil_group_to_string(uint32_t group_id,
7177 char namebuf[MAX_GROUP_NAME_LEN + 1], size_t bufsize)
7181 ovs_strlcpy(namebuf, "ALL", bufsize);
7185 ovs_strlcpy(namebuf, "ANY", bufsize);
7189 snprintf(namebuf, bufsize, "%"PRIu32, group_id);
7194 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
7195 * 'ofp_version', tries to pull the first element from the array. If
7196 * successful, initializes '*pp' with an abstract representation of the
7197 * port and returns 0. If no ports remain to be decoded, returns EOF.
7198 * On an error, returns a positive OFPERR_* value. */
7200 ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *b,
7201 struct ofputil_phy_port *pp)
7203 memset(pp, 0, sizeof *pp);
7205 switch (ofp_version) {
7206 case OFP10_VERSION: {
7207 const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
7208 return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
7212 case OFP13_VERSION: {
7213 const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
7214 return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
7219 return b->size ? ofputil_pull_ofp14_port(pp, b) : EOF;
7226 ofputil_normalize_match__(struct match *match, bool may_log)
7229 MAY_NW_ADDR = 1 << 0, /* nw_src, nw_dst */
7230 MAY_TP_ADDR = 1 << 1, /* tp_src, tp_dst */
7231 MAY_NW_PROTO = 1 << 2, /* nw_proto */
7232 MAY_IPVx = 1 << 3, /* tos, frag, ttl */
7233 MAY_ARP_SHA = 1 << 4, /* arp_sha */
7234 MAY_ARP_THA = 1 << 5, /* arp_tha */
7235 MAY_IPV6 = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
7236 MAY_ND_TARGET = 1 << 7, /* nd_target */
7237 MAY_MPLS = 1 << 8, /* mpls label and tc */
7240 struct flow_wildcards wc;
7242 /* Figure out what fields may be matched. */
7243 if (match->flow.dl_type == htons(ETH_TYPE_IP)) {
7244 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
7245 if (match->flow.nw_proto == IPPROTO_TCP ||
7246 match->flow.nw_proto == IPPROTO_UDP ||
7247 match->flow.nw_proto == IPPROTO_SCTP ||
7248 match->flow.nw_proto == IPPROTO_ICMP) {
7249 may_match |= MAY_TP_ADDR;
7251 } else if (match->flow.dl_type == htons(ETH_TYPE_IPV6)) {
7252 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
7253 if (match->flow.nw_proto == IPPROTO_TCP ||
7254 match->flow.nw_proto == IPPROTO_UDP ||
7255 match->flow.nw_proto == IPPROTO_SCTP) {
7256 may_match |= MAY_TP_ADDR;
7257 } else if (match->flow.nw_proto == IPPROTO_ICMPV6) {
7258 may_match |= MAY_TP_ADDR;
7259 if (match->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
7260 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
7261 } else if (match->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
7262 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
7265 } else if (match->flow.dl_type == htons(ETH_TYPE_ARP) ||
7266 match->flow.dl_type == htons(ETH_TYPE_RARP)) {
7267 may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
7268 } else if (eth_type_mpls(match->flow.dl_type)) {
7269 may_match = MAY_MPLS;
7274 /* Clear the fields that may not be matched. */
7276 if (!(may_match & MAY_NW_ADDR)) {
7277 wc.masks.nw_src = wc.masks.nw_dst = htonl(0);
7279 if (!(may_match & MAY_TP_ADDR)) {
7280 wc.masks.tp_src = wc.masks.tp_dst = htons(0);
7282 if (!(may_match & MAY_NW_PROTO)) {
7283 wc.masks.nw_proto = 0;
7285 if (!(may_match & MAY_IPVx)) {
7286 wc.masks.nw_tos = 0;
7287 wc.masks.nw_ttl = 0;
7289 if (!(may_match & MAY_ARP_SHA)) {
7290 WC_UNMASK_FIELD(&wc, arp_sha);
7292 if (!(may_match & MAY_ARP_THA)) {
7293 WC_UNMASK_FIELD(&wc, arp_tha);
7295 if (!(may_match & MAY_IPV6)) {
7296 wc.masks.ipv6_src = wc.masks.ipv6_dst = in6addr_any;
7297 wc.masks.ipv6_label = htonl(0);
7299 if (!(may_match & MAY_ND_TARGET)) {
7300 wc.masks.nd_target = in6addr_any;
7302 if (!(may_match & MAY_MPLS)) {
7303 memset(wc.masks.mpls_lse, 0, sizeof wc.masks.mpls_lse);
7306 /* Log any changes. */
7307 if (!flow_wildcards_equal(&wc, &match->wc)) {
7308 bool log = may_log && !VLOG_DROP_INFO(&bad_ofmsg_rl);
7309 char *pre = log ? match_to_string(match, OFP_DEFAULT_PRIORITY) : NULL;
7312 match_zero_wildcarded_fields(match);
7315 char *post = match_to_string(match, OFP_DEFAULT_PRIORITY);
7316 VLOG_INFO("normalization changed ofp_match, details:");
7317 VLOG_INFO(" pre: %s", pre);
7318 VLOG_INFO("post: %s", post);
7325 /* "Normalizes" the wildcards in 'match'. That means:
7327 * 1. If the type of level N is known, then only the valid fields for that
7328 * level may be specified. For example, ARP does not have a TOS field,
7329 * so nw_tos must be wildcarded if 'match' specifies an ARP flow.
7330 * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
7331 * ipv6_dst (and other fields) must be wildcarded if 'match' specifies an
7334 * 2. If the type of level N is not known (or not understood by Open
7335 * vSwitch), then no fields at all for that level may be specified. For
7336 * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
7337 * L4 fields tp_src and tp_dst must be wildcarded if 'match' specifies an
7340 * If this function changes 'match', it logs a rate-limited informational
7343 ofputil_normalize_match(struct match *match)
7345 ofputil_normalize_match__(match, true);
7348 /* Same as ofputil_normalize_match() without the logging. Thus, this function
7349 * is suitable for a program's internal use, whereas ofputil_normalize_match()
7350 * sense for use on flows received from elsewhere (so that a bug in the program
7351 * that sent them can be reported and corrected). */
7353 ofputil_normalize_match_quiet(struct match *match)
7355 ofputil_normalize_match__(match, false);
7359 parse_value(const char *s, const char *delimiters)
7363 /* Iterate until we reach a delimiter.
7365 * strchr(s, '\0') returns s+strlen(s), so this test handles the null
7366 * terminator at the end of 's'. */
7367 while (!strchr(delimiters, s[n])) {
7382 } while (level > 0);
7390 /* Parses a key or a key-value pair from '*stringp'.
7392 * On success: Stores the key into '*keyp'. Stores the value, if present, into
7393 * '*valuep', otherwise an empty string. Advances '*stringp' past the end of
7394 * the key-value pair, preparing it for another call. '*keyp' and '*valuep'
7395 * are substrings of '*stringp' created by replacing some of its bytes by null
7396 * terminators. Returns true.
7398 * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
7399 * NULL and returns false. */
7401 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
7403 /* Skip white space and delimiters. If that brings us to the end of the
7404 * input string, we are done and there are no more key-value pairs. */
7405 *stringp += strspn(*stringp, ", \t\r\n");
7406 if (**stringp == '\0') {
7407 *keyp = *valuep = NULL;
7411 /* Extract the key and the delimiter that ends the key-value pair or begins
7412 * the value. Advance the input position past the key and delimiter. */
7413 char *key = *stringp;
7414 size_t key_len = strcspn(key, ":=(, \t\r\n");
7415 char key_delim = key[key_len];
7416 key[key_len] = '\0';
7417 *stringp += key_len + (key_delim != '\0');
7419 /* Figure out what delimiter ends the value:
7421 * - If key_delim is ":" or "=", the value extends until white space
7424 * - If key_delim is "(", the value extends until ")".
7426 * If there is no value, we are done. */
7427 const char *value_delims;
7428 if (key_delim == ':' || key_delim == '=') {
7429 value_delims = ", \t\r\n";
7430 } else if (key_delim == '(') {
7434 *valuep = key + key_len; /* Empty string. */
7438 /* Extract the value. Advance the input position past the value and
7440 char *value = *stringp;
7441 size_t value_len = parse_value(value, value_delims);
7442 char value_delim = value[value_len];
7443 value[value_len] = '\0';
7444 *stringp += value_len + (value_delim != '\0');
7451 /* Encode a dump ports request for 'port', the encoded message
7452 * will be for OpenFlow version 'ofp_version'. Returns message
7453 * as a struct ofpbuf. Returns encoded message on success, NULL on error */
7455 ofputil_encode_dump_ports_request(enum ofp_version ofp_version, ofp_port_t port)
7457 struct ofpbuf *request;
7459 switch (ofp_version) {
7460 case OFP10_VERSION: {
7461 struct ofp10_port_stats_request *req;
7462 request = ofpraw_alloc(OFPRAW_OFPST10_PORT_REQUEST, ofp_version, 0);
7463 req = ofpbuf_put_zeros(request, sizeof *req);
7464 req->port_no = htons(ofp_to_u16(port));
7472 case OFP16_VERSION: {
7473 struct ofp11_port_stats_request *req;
7474 request = ofpraw_alloc(OFPRAW_OFPST11_PORT_REQUEST, ofp_version, 0);
7475 req = ofpbuf_put_zeros(request, sizeof *req);
7476 req->port_no = ofputil_port_to_ofp11(port);
7487 ofputil_port_stats_to_ofp10(const struct ofputil_port_stats *ops,
7488 struct ofp10_port_stats *ps10)
7490 ps10->port_no = htons(ofp_to_u16(ops->port_no));
7491 memset(ps10->pad, 0, sizeof ps10->pad);
7492 put_32aligned_be64(&ps10->rx_packets, htonll(ops->stats.rx_packets));
7493 put_32aligned_be64(&ps10->tx_packets, htonll(ops->stats.tx_packets));
7494 put_32aligned_be64(&ps10->rx_bytes, htonll(ops->stats.rx_bytes));
7495 put_32aligned_be64(&ps10->tx_bytes, htonll(ops->stats.tx_bytes));
7496 put_32aligned_be64(&ps10->rx_dropped, htonll(ops->stats.rx_dropped));
7497 put_32aligned_be64(&ps10->tx_dropped, htonll(ops->stats.tx_dropped));
7498 put_32aligned_be64(&ps10->rx_errors, htonll(ops->stats.rx_errors));
7499 put_32aligned_be64(&ps10->tx_errors, htonll(ops->stats.tx_errors));
7500 put_32aligned_be64(&ps10->rx_frame_err, htonll(ops->stats.rx_frame_errors));
7501 put_32aligned_be64(&ps10->rx_over_err, htonll(ops->stats.rx_over_errors));
7502 put_32aligned_be64(&ps10->rx_crc_err, htonll(ops->stats.rx_crc_errors));
7503 put_32aligned_be64(&ps10->collisions, htonll(ops->stats.collisions));
7507 ofputil_port_stats_to_ofp11(const struct ofputil_port_stats *ops,
7508 struct ofp11_port_stats *ps11)
7510 ps11->port_no = ofputil_port_to_ofp11(ops->port_no);
7511 memset(ps11->pad, 0, sizeof ps11->pad);
7512 ps11->rx_packets = htonll(ops->stats.rx_packets);
7513 ps11->tx_packets = htonll(ops->stats.tx_packets);
7514 ps11->rx_bytes = htonll(ops->stats.rx_bytes);
7515 ps11->tx_bytes = htonll(ops->stats.tx_bytes);
7516 ps11->rx_dropped = htonll(ops->stats.rx_dropped);
7517 ps11->tx_dropped = htonll(ops->stats.tx_dropped);
7518 ps11->rx_errors = htonll(ops->stats.rx_errors);
7519 ps11->tx_errors = htonll(ops->stats.tx_errors);
7520 ps11->rx_frame_err = htonll(ops->stats.rx_frame_errors);
7521 ps11->rx_over_err = htonll(ops->stats.rx_over_errors);
7522 ps11->rx_crc_err = htonll(ops->stats.rx_crc_errors);
7523 ps11->collisions = htonll(ops->stats.collisions);
7527 ofputil_port_stats_to_ofp13(const struct ofputil_port_stats *ops,
7528 struct ofp13_port_stats *ps13)
7530 ofputil_port_stats_to_ofp11(ops, &ps13->ps);
7531 ps13->duration_sec = htonl(ops->duration_sec);
7532 ps13->duration_nsec = htonl(ops->duration_nsec);
7536 ofputil_append_ofp14_port_stats(const struct ofputil_port_stats *ops,
7537 struct ovs_list *replies)
7539 struct ofp14_port_stats_prop_ethernet *eth;
7540 struct intel_port_stats_rfc2819 *stats_rfc2819;
7541 struct ofp14_port_stats *ps14;
7542 struct ofpbuf *reply;
7544 reply = ofpmp_reserve(replies, sizeof *ps14 + sizeof *eth +
7545 sizeof *stats_rfc2819);
7547 ps14 = ofpbuf_put_uninit(reply, sizeof *ps14);
7548 ps14->length = htons(sizeof *ps14 + sizeof *eth +
7549 sizeof *stats_rfc2819);
7550 memset(ps14->pad, 0, sizeof ps14->pad);
7551 ps14->port_no = ofputil_port_to_ofp11(ops->port_no);
7552 ps14->duration_sec = htonl(ops->duration_sec);
7553 ps14->duration_nsec = htonl(ops->duration_nsec);
7554 ps14->rx_packets = htonll(ops->stats.rx_packets);
7555 ps14->tx_packets = htonll(ops->stats.tx_packets);
7556 ps14->rx_bytes = htonll(ops->stats.rx_bytes);
7557 ps14->tx_bytes = htonll(ops->stats.tx_bytes);
7558 ps14->rx_dropped = htonll(ops->stats.rx_dropped);
7559 ps14->tx_dropped = htonll(ops->stats.tx_dropped);
7560 ps14->rx_errors = htonll(ops->stats.rx_errors);
7561 ps14->tx_errors = htonll(ops->stats.tx_errors);
7563 eth = ofpprop_put_zeros(reply, OFPPSPT14_ETHERNET, sizeof *eth);
7564 eth->rx_frame_err = htonll(ops->stats.rx_frame_errors);
7565 eth->rx_over_err = htonll(ops->stats.rx_over_errors);
7566 eth->rx_crc_err = htonll(ops->stats.rx_crc_errors);
7567 eth->collisions = htonll(ops->stats.collisions);
7569 uint64_t prop_type = OFPPROP_EXP(INTEL_VENDOR_ID,
7570 INTEL_PORT_STATS_RFC2819);
7572 stats_rfc2819 = ofpprop_put_zeros(reply, prop_type,
7573 sizeof *stats_rfc2819);
7575 memset(stats_rfc2819->pad, 0, sizeof stats_rfc2819->pad);
7576 stats_rfc2819->rx_1_to_64_packets = htonll(ops->stats.rx_1_to_64_packets);
7577 stats_rfc2819->rx_65_to_127_packets =
7578 htonll(ops->stats.rx_65_to_127_packets);
7579 stats_rfc2819->rx_128_to_255_packets =
7580 htonll(ops->stats.rx_128_to_255_packets);
7581 stats_rfc2819->rx_256_to_511_packets =
7582 htonll(ops->stats.rx_256_to_511_packets);
7583 stats_rfc2819->rx_512_to_1023_packets =
7584 htonll(ops->stats.rx_512_to_1023_packets);
7585 stats_rfc2819->rx_1024_to_1522_packets =
7586 htonll(ops->stats.rx_1024_to_1522_packets);
7587 stats_rfc2819->rx_1523_to_max_packets =
7588 htonll(ops->stats.rx_1523_to_max_packets);
7590 stats_rfc2819->tx_1_to_64_packets = htonll(ops->stats.tx_1_to_64_packets);
7591 stats_rfc2819->tx_65_to_127_packets =
7592 htonll(ops->stats.tx_65_to_127_packets);
7593 stats_rfc2819->tx_128_to_255_packets =
7594 htonll(ops->stats.tx_128_to_255_packets);
7595 stats_rfc2819->tx_256_to_511_packets =
7596 htonll(ops->stats.tx_256_to_511_packets);
7597 stats_rfc2819->tx_512_to_1023_packets =
7598 htonll(ops->stats.tx_512_to_1023_packets);
7599 stats_rfc2819->tx_1024_to_1522_packets =
7600 htonll(ops->stats.tx_1024_to_1522_packets);
7601 stats_rfc2819->tx_1523_to_max_packets =
7602 htonll(ops->stats.tx_1523_to_max_packets);
7604 stats_rfc2819->tx_multicast_packets =
7605 htonll(ops->stats.tx_multicast_packets);
7606 stats_rfc2819->rx_broadcast_packets =
7607 htonll(ops->stats.rx_broadcast_packets);
7608 stats_rfc2819->tx_broadcast_packets =
7609 htonll(ops->stats.tx_broadcast_packets);
7610 stats_rfc2819->rx_undersized_errors =
7611 htonll(ops->stats.rx_undersized_errors);
7612 stats_rfc2819->rx_oversize_errors =
7613 htonll(ops->stats.rx_oversize_errors);
7614 stats_rfc2819->rx_fragmented_errors =
7615 htonll(ops->stats.rx_fragmented_errors);
7616 stats_rfc2819->rx_jabber_errors =
7617 htonll(ops->stats.rx_jabber_errors);
7620 /* Encode a ports stat for 'ops' and append it to 'replies'. */
7622 ofputil_append_port_stat(struct ovs_list *replies,
7623 const struct ofputil_port_stats *ops)
7625 switch (ofpmp_version(replies)) {
7626 case OFP13_VERSION: {
7627 struct ofp13_port_stats *reply = ofpmp_append(replies, sizeof *reply);
7628 ofputil_port_stats_to_ofp13(ops, reply);
7632 case OFP11_VERSION: {
7633 struct ofp11_port_stats *reply = ofpmp_append(replies, sizeof *reply);
7634 ofputil_port_stats_to_ofp11(ops, reply);
7638 case OFP10_VERSION: {
7639 struct ofp10_port_stats *reply = ofpmp_append(replies, sizeof *reply);
7640 ofputil_port_stats_to_ofp10(ops, reply);
7647 ofputil_append_ofp14_port_stats(ops, replies);
7656 ofputil_port_stats_from_ofp10(struct ofputil_port_stats *ops,
7657 const struct ofp10_port_stats *ps10)
7660 ops->port_no = u16_to_ofp(ntohs(ps10->port_no));
7661 ops->stats.rx_packets = ntohll(get_32aligned_be64(&ps10->rx_packets));
7662 ops->stats.tx_packets = ntohll(get_32aligned_be64(&ps10->tx_packets));
7663 ops->stats.rx_bytes = ntohll(get_32aligned_be64(&ps10->rx_bytes));
7664 ops->stats.tx_bytes = ntohll(get_32aligned_be64(&ps10->tx_bytes));
7665 ops->stats.rx_dropped = ntohll(get_32aligned_be64(&ps10->rx_dropped));
7666 ops->stats.tx_dropped = ntohll(get_32aligned_be64(&ps10->tx_dropped));
7667 ops->stats.rx_errors = ntohll(get_32aligned_be64(&ps10->rx_errors));
7668 ops->stats.tx_errors = ntohll(get_32aligned_be64(&ps10->tx_errors));
7669 ops->stats.rx_frame_errors =
7670 ntohll(get_32aligned_be64(&ps10->rx_frame_err));
7671 ops->stats.rx_over_errors = ntohll(get_32aligned_be64(&ps10->rx_over_err));
7672 ops->stats.rx_crc_errors = ntohll(get_32aligned_be64(&ps10->rx_crc_err));
7673 ops->stats.collisions = ntohll(get_32aligned_be64(&ps10->collisions));
7674 ops->duration_sec = ops->duration_nsec = UINT32_MAX;
7680 ofputil_port_stats_from_ofp11(struct ofputil_port_stats *ops,
7681 const struct ofp11_port_stats *ps11)
7685 error = ofputil_port_from_ofp11(ps11->port_no, &ops->port_no);
7690 ops->stats.rx_packets = ntohll(ps11->rx_packets);
7691 ops->stats.tx_packets = ntohll(ps11->tx_packets);
7692 ops->stats.rx_bytes = ntohll(ps11->rx_bytes);
7693 ops->stats.tx_bytes = ntohll(ps11->tx_bytes);
7694 ops->stats.rx_dropped = ntohll(ps11->rx_dropped);
7695 ops->stats.tx_dropped = ntohll(ps11->tx_dropped);
7696 ops->stats.rx_errors = ntohll(ps11->rx_errors);
7697 ops->stats.tx_errors = ntohll(ps11->tx_errors);
7698 ops->stats.rx_frame_errors = ntohll(ps11->rx_frame_err);
7699 ops->stats.rx_over_errors = ntohll(ps11->rx_over_err);
7700 ops->stats.rx_crc_errors = ntohll(ps11->rx_crc_err);
7701 ops->stats.collisions = ntohll(ps11->collisions);
7702 ops->duration_sec = ops->duration_nsec = UINT32_MAX;
7708 ofputil_port_stats_from_ofp13(struct ofputil_port_stats *ops,
7709 const struct ofp13_port_stats *ps13)
7711 enum ofperr error = ofputil_port_stats_from_ofp11(ops, &ps13->ps);
7713 ops->duration_sec = ntohl(ps13->duration_sec);
7714 ops->duration_nsec = ntohl(ps13->duration_nsec);
7720 parse_ofp14_port_stats_ethernet_property(const struct ofpbuf *payload,
7721 struct ofputil_port_stats *ops)
7723 const struct ofp14_port_stats_prop_ethernet *eth = payload->data;
7725 if (payload->size != sizeof *eth) {
7726 return OFPERR_OFPBPC_BAD_LEN;
7729 ops->stats.rx_frame_errors = ntohll(eth->rx_frame_err);
7730 ops->stats.rx_over_errors = ntohll(eth->rx_over_err);
7731 ops->stats.rx_crc_errors = ntohll(eth->rx_crc_err);
7732 ops->stats.collisions = ntohll(eth->collisions);
7738 parse_intel_port_stats_rfc2819_property(const struct ofpbuf *payload,
7739 struct ofputil_port_stats *ops)
7741 const struct intel_port_stats_rfc2819 *rfc2819 = payload->data;
7743 if (payload->size != sizeof *rfc2819) {
7744 return OFPERR_OFPBPC_BAD_LEN;
7746 ops->stats.rx_1_to_64_packets = ntohll(rfc2819->rx_1_to_64_packets);
7747 ops->stats.rx_65_to_127_packets = ntohll(rfc2819->rx_65_to_127_packets);
7748 ops->stats.rx_128_to_255_packets = ntohll(rfc2819->rx_128_to_255_packets);
7749 ops->stats.rx_256_to_511_packets = ntohll(rfc2819->rx_256_to_511_packets);
7750 ops->stats.rx_512_to_1023_packets =
7751 ntohll(rfc2819->rx_512_to_1023_packets);
7752 ops->stats.rx_1024_to_1522_packets =
7753 ntohll(rfc2819->rx_1024_to_1522_packets);
7754 ops->stats.rx_1523_to_max_packets =
7755 ntohll(rfc2819->rx_1523_to_max_packets);
7757 ops->stats.tx_1_to_64_packets = ntohll(rfc2819->tx_1_to_64_packets);
7758 ops->stats.tx_65_to_127_packets = ntohll(rfc2819->tx_65_to_127_packets);
7759 ops->stats.tx_128_to_255_packets = ntohll(rfc2819->tx_128_to_255_packets);
7760 ops->stats.tx_256_to_511_packets = ntohll(rfc2819->tx_256_to_511_packets);
7761 ops->stats.tx_512_to_1023_packets =
7762 ntohll(rfc2819->tx_512_to_1023_packets);
7763 ops->stats.tx_1024_to_1522_packets =
7764 ntohll(rfc2819->tx_1024_to_1522_packets);
7765 ops->stats.tx_1523_to_max_packets =
7766 ntohll(rfc2819->tx_1523_to_max_packets);
7768 ops->stats.tx_multicast_packets = ntohll(rfc2819->tx_multicast_packets);
7769 ops->stats.rx_broadcast_packets = ntohll(rfc2819->rx_broadcast_packets);
7770 ops->stats.tx_broadcast_packets = ntohll(rfc2819->tx_broadcast_packets);
7771 ops->stats.rx_undersized_errors = ntohll(rfc2819->rx_undersized_errors);
7773 ops->stats.rx_oversize_errors = ntohll(rfc2819->rx_oversize_errors);
7774 ops->stats.rx_fragmented_errors = ntohll(rfc2819->rx_fragmented_errors);
7775 ops->stats.rx_jabber_errors = ntohll(rfc2819->rx_jabber_errors);
7781 parse_intel_port_stats_property(const struct ofpbuf *payload,
7783 struct ofputil_port_stats *ops)
7788 case INTEL_PORT_STATS_RFC2819:
7789 error = parse_intel_port_stats_rfc2819_property(payload, ops);
7792 error = OFPERR_OFPBPC_BAD_EXP_TYPE;
7800 ofputil_pull_ofp14_port_stats(struct ofputil_port_stats *ops,
7803 const struct ofp14_port_stats *ps14 = ofpbuf_try_pull(msg, sizeof *ps14);
7805 return OFPERR_OFPBRC_BAD_LEN;
7808 size_t len = ntohs(ps14->length);
7809 if (len < sizeof *ps14 || len - sizeof *ps14 > msg->size) {
7810 return OFPERR_OFPBRC_BAD_LEN;
7812 len -= sizeof *ps14;
7814 enum ofperr error = ofputil_port_from_ofp11(ps14->port_no, &ops->port_no);
7819 ops->duration_sec = ntohl(ps14->duration_sec);
7820 ops->duration_nsec = ntohl(ps14->duration_nsec);
7821 ops->stats.rx_packets = ntohll(ps14->rx_packets);
7822 ops->stats.tx_packets = ntohll(ps14->tx_packets);
7823 ops->stats.rx_bytes = ntohll(ps14->rx_bytes);
7824 ops->stats.tx_bytes = ntohll(ps14->tx_bytes);
7825 ops->stats.rx_dropped = ntohll(ps14->rx_dropped);
7826 ops->stats.tx_dropped = ntohll(ps14->tx_dropped);
7827 ops->stats.rx_errors = ntohll(ps14->rx_errors);
7828 ops->stats.tx_errors = ntohll(ps14->tx_errors);
7831 struct ofpbuf properties = ofpbuf_const_initializer(ofpbuf_pull(msg, len),
7833 while (properties.size > 0) {
7834 struct ofpbuf payload;
7838 error = ofpprop_pull(&properties, &payload, &type);
7843 case OFPPSPT14_ETHERNET:
7844 error = parse_ofp14_port_stats_ethernet_property(&payload, ops);
7846 case OFPPROP_EXP(INTEL_VENDOR_ID, INTEL_PORT_STATS_RFC2819):
7847 error = parse_intel_port_stats_property(&payload,
7848 INTEL_PORT_STATS_RFC2819,
7852 error = OFPPROP_UNKNOWN(true, "port stats", type);
7864 /* Returns the number of port stats elements in OFPTYPE_PORT_STATS_REPLY
7867 ofputil_count_port_stats(const struct ofp_header *oh)
7869 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
7870 ofpraw_pull_assert(&b);
7872 for (size_t n = 0; ; n++) {
7873 struct ofputil_port_stats ps;
7874 if (ofputil_decode_port_stats(&ps, &b)) {
7880 /* Converts an OFPST_PORT_STATS reply in 'msg' into an abstract
7881 * ofputil_port_stats in 'ps'.
7883 * Multiple OFPST_PORT_STATS replies can be packed into a single OpenFlow
7884 * message. Calling this function multiple times for a single 'msg' iterates
7885 * through the replies. The caller must initially leave 'msg''s layer pointers
7886 * null and not modify them between calls.
7888 * Returns 0 if successful, EOF if no replies were left in this 'msg',
7889 * otherwise a positive errno value. */
7891 ofputil_decode_port_stats(struct ofputil_port_stats *ps, struct ofpbuf *msg)
7896 memset(&(ps->stats), 0xFF, sizeof (ps->stats));
7898 error = (msg->header ? ofpraw_decode(&raw, msg->header)
7899 : ofpraw_pull(&raw, msg));
7906 } else if (raw == OFPRAW_OFPST14_PORT_REPLY) {
7907 return ofputil_pull_ofp14_port_stats(ps, msg);
7908 } else if (raw == OFPRAW_OFPST13_PORT_REPLY) {
7909 const struct ofp13_port_stats *ps13;
7910 ps13 = ofpbuf_try_pull(msg, sizeof *ps13);
7914 return ofputil_port_stats_from_ofp13(ps, ps13);
7915 } else if (raw == OFPRAW_OFPST11_PORT_REPLY) {
7916 const struct ofp11_port_stats *ps11;
7918 ps11 = ofpbuf_try_pull(msg, sizeof *ps11);
7922 return ofputil_port_stats_from_ofp11(ps, ps11);
7923 } else if (raw == OFPRAW_OFPST10_PORT_REPLY) {
7924 const struct ofp10_port_stats *ps10;
7926 ps10 = ofpbuf_try_pull(msg, sizeof *ps10);
7930 return ofputil_port_stats_from_ofp10(ps, ps10);
7936 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_PORT reply has %"PRIu32" leftover "
7937 "bytes at end", msg->size);
7938 return OFPERR_OFPBRC_BAD_LEN;
7941 /* Parse a port status request message into a 16 bit OpenFlow 1.0
7942 * port number and stores the latter in '*ofp10_port'.
7943 * Returns 0 if successful, otherwise an OFPERR_* number. */
7945 ofputil_decode_port_stats_request(const struct ofp_header *request,
7946 ofp_port_t *ofp10_port)
7948 switch ((enum ofp_version)request->version) {
7954 case OFP11_VERSION: {
7955 const struct ofp11_port_stats_request *psr11 = ofpmsg_body(request);
7956 return ofputil_port_from_ofp11(psr11->port_no, ofp10_port);
7959 case OFP10_VERSION: {
7960 const struct ofp10_port_stats_request *psr10 = ofpmsg_body(request);
7961 *ofp10_port = u16_to_ofp(ntohs(psr10->port_no));
7971 ofputil_ipfix_stats_to_reply(const struct ofputil_ipfix_stats *ois,
7972 struct nx_ipfix_stats_reply *reply)
7974 reply->collector_set_id = htonl(ois->collector_set_id);
7975 reply->total_flows = htonll(ois->total_flows);
7976 reply->current_flows = htonll(ois->current_flows);
7977 reply->pkts = htonll(ois->pkts);
7978 reply->ipv4_pkts = htonll(ois->ipv4_pkts);
7979 reply->ipv6_pkts = htonll(ois->ipv6_pkts);
7980 reply->error_pkts = htonll(ois->error_pkts);
7981 reply->ipv4_error_pkts = htonll(ois->ipv4_error_pkts);
7982 reply->ipv6_error_pkts = htonll(ois->ipv6_error_pkts);
7983 reply->tx_pkts = htonll(ois->tx_pkts);
7984 reply->tx_errors = htonll(ois->tx_errors);
7987 /* Encode a ipfix stat for 'ois' and append it to 'replies'. */
7989 ofputil_append_ipfix_stat(struct ovs_list *replies,
7990 const struct ofputil_ipfix_stats *ois)
7992 struct nx_ipfix_stats_reply *reply = ofpmp_append(replies, sizeof *reply);
7993 ofputil_ipfix_stats_to_reply(ois, reply);
7997 ofputil_ipfix_stats_from_nx(struct ofputil_ipfix_stats *is,
7998 const struct nx_ipfix_stats_reply *reply)
8000 is->collector_set_id = ntohl(reply->collector_set_id);
8001 is->total_flows = ntohll(reply->total_flows);
8002 is->current_flows = ntohll(reply->current_flows);
8003 is->pkts = ntohll(reply->pkts);
8004 is->ipv4_pkts = ntohll(reply->ipv4_pkts);
8005 is->ipv6_pkts = ntohll(reply->ipv6_pkts);
8006 is->error_pkts = ntohll(reply->error_pkts);
8007 is->ipv4_error_pkts = ntohll(reply->ipv4_error_pkts);
8008 is->ipv6_error_pkts = ntohll(reply->ipv6_error_pkts);
8009 is->tx_pkts = ntohll(reply->tx_pkts);
8010 is->tx_errors = ntohll(reply->tx_errors);
8016 ofputil_pull_ipfix_stats(struct ofputil_ipfix_stats *is, struct ofpbuf *msg)
8021 memset(is, 0xFF, sizeof (*is));
8023 error = (msg->header ? ofpraw_decode(&raw, msg->header)
8024 : ofpraw_pull(&raw, msg));
8031 } else if (raw == OFPRAW_NXST_IPFIX_BRIDGE_REPLY ||
8032 raw == OFPRAW_NXST_IPFIX_FLOW_REPLY) {
8033 struct nx_ipfix_stats_reply *reply;
8035 reply = ofpbuf_try_pull(msg, sizeof *reply);
8036 return ofputil_ipfix_stats_from_nx(is, reply);
8043 /* Returns the number of ipfix stats elements in
8044 * OFPTYPE_IPFIX_BRIDGE_STATS_REPLY or OFPTYPE_IPFIX_FLOW_STATS_REPLY
8047 ofputil_count_ipfix_stats(const struct ofp_header *oh)
8049 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
8050 ofpraw_pull_assert(&b);
8052 return b.size / sizeof(struct ofputil_ipfix_stats);
8055 /* Frees all of the "struct ofputil_bucket"s in the 'buckets' list. */
8057 ofputil_bucket_list_destroy(struct ovs_list *buckets)
8059 struct ofputil_bucket *bucket;
8061 LIST_FOR_EACH_POP (bucket, list_node, buckets) {
8062 free(bucket->ofpacts);
8067 /* Clones 'bucket' and its ofpacts data */
8068 static struct ofputil_bucket *
8069 ofputil_bucket_clone_data(const struct ofputil_bucket *bucket)
8071 struct ofputil_bucket *new;
8073 new = xmemdup(bucket, sizeof *bucket);
8074 new->ofpacts = xmemdup(bucket->ofpacts, bucket->ofpacts_len);
8079 /* Clones each of the buckets in the list 'src' appending them
8080 * in turn to 'dest' which should be an initialised list.
8081 * An exception is that if the pointer value of a bucket in 'src'
8082 * matches 'skip' then it is not cloned or appended to 'dest'.
8083 * This allows all of 'src' or 'all of 'src' except 'skip' to
8084 * be cloned and appended to 'dest'. */
8086 ofputil_bucket_clone_list(struct ovs_list *dest, const struct ovs_list *src,
8087 const struct ofputil_bucket *skip)
8089 struct ofputil_bucket *bucket;
8091 LIST_FOR_EACH (bucket, list_node, src) {
8092 struct ofputil_bucket *new_bucket;
8094 if (bucket == skip) {
8098 new_bucket = ofputil_bucket_clone_data(bucket);
8099 ovs_list_push_back(dest, &new_bucket->list_node);
8103 /* Find a bucket in the list 'buckets' whose bucket id is 'bucket_id'
8104 * Returns the first bucket found or NULL if no buckets are found. */
8105 struct ofputil_bucket *
8106 ofputil_bucket_find(const struct ovs_list *buckets, uint32_t bucket_id)
8108 struct ofputil_bucket *bucket;
8110 if (bucket_id > OFPG15_BUCKET_MAX) {
8114 LIST_FOR_EACH (bucket, list_node, buckets) {
8115 if (bucket->bucket_id == bucket_id) {
8123 /* Returns true if more than one bucket in the list 'buckets'
8124 * have the same bucket id. Returns false otherwise. */
8126 ofputil_bucket_check_duplicate_id(const struct ovs_list *buckets)
8128 struct ofputil_bucket *i, *j;
8130 LIST_FOR_EACH (i, list_node, buckets) {
8131 LIST_FOR_EACH_REVERSE (j, list_node, buckets) {
8135 if (i->bucket_id == j->bucket_id) {
8144 /* Returns the bucket at the front of the list 'buckets'.
8145 * Undefined if 'buckets is empty. */
8146 struct ofputil_bucket *
8147 ofputil_bucket_list_front(const struct ovs_list *buckets)
8149 static struct ofputil_bucket *bucket;
8151 ASSIGN_CONTAINER(bucket, ovs_list_front(buckets), list_node);
8156 /* Returns the bucket at the back of the list 'buckets'.
8157 * Undefined if 'buckets is empty. */
8158 struct ofputil_bucket *
8159 ofputil_bucket_list_back(const struct ovs_list *buckets)
8161 static struct ofputil_bucket *bucket;
8163 ASSIGN_CONTAINER(bucket, ovs_list_back(buckets), list_node);
8168 /* Returns an OpenFlow group stats request for OpenFlow version 'ofp_version',
8169 * that requests stats for group 'group_id'. (Use OFPG_ALL to request stats
8172 * Group statistics include packet and byte counts for each group. */
8174 ofputil_encode_group_stats_request(enum ofp_version ofp_version,
8177 struct ofpbuf *request;
8179 switch (ofp_version) {
8181 ovs_fatal(0, "dump-group-stats needs OpenFlow 1.1 or later "
8182 "(\'-O OpenFlow11\')");
8188 case OFP16_VERSION: {
8189 struct ofp11_group_stats_request *req;
8190 request = ofpraw_alloc(OFPRAW_OFPST11_GROUP_REQUEST, ofp_version, 0);
8191 req = ofpbuf_put_zeros(request, sizeof *req);
8192 req->group_id = htonl(group_id);
8203 ofputil_uninit_group_desc(struct ofputil_group_desc *gd)
8205 ofputil_bucket_list_destroy(&gd->buckets);
8206 free(&gd->props.fields);
8209 /* Decodes the OpenFlow group description request in 'oh', returning the group
8210 * whose description is requested, or OFPG_ALL if stats for all groups was
8213 ofputil_decode_group_desc_request(const struct ofp_header *oh)
8215 struct ofpbuf request = ofpbuf_const_initializer(oh, ntohs(oh->length));
8216 enum ofpraw raw = ofpraw_pull_assert(&request);
8217 if (raw == OFPRAW_OFPST11_GROUP_DESC_REQUEST) {
8219 } else if (raw == OFPRAW_OFPST15_GROUP_DESC_REQUEST) {
8220 ovs_be32 *group_id = ofpbuf_pull(&request, sizeof *group_id);
8221 return ntohl(*group_id);
8227 /* Returns an OpenFlow group description request for OpenFlow version
8228 * 'ofp_version', that requests stats for group 'group_id'. Use OFPG_ALL to
8229 * request stats for all groups (OpenFlow 1.4 and earlier always request all
8232 * Group descriptions include the bucket and action configuration for each
8235 ofputil_encode_group_desc_request(enum ofp_version ofp_version,
8238 struct ofpbuf *request;
8240 switch (ofp_version) {
8242 ovs_fatal(0, "dump-groups needs OpenFlow 1.1 or later "
8243 "(\'-O OpenFlow11\')");
8248 request = ofpraw_alloc(OFPRAW_OFPST11_GROUP_DESC_REQUEST,
8252 case OFP16_VERSION: {
8253 struct ofp15_group_desc_request *req;
8254 request = ofpraw_alloc(OFPRAW_OFPST15_GROUP_DESC_REQUEST,
8256 req = ofpbuf_put_zeros(request, sizeof *req);
8257 req->group_id = htonl(group_id);
8268 ofputil_group_bucket_counters_to_ofp11(const struct ofputil_group_stats *gs,
8269 struct ofp11_bucket_counter bucket_cnts[])
8273 for (i = 0; i < gs->n_buckets; i++) {
8274 bucket_cnts[i].packet_count = htonll(gs->bucket_stats[i].packet_count);
8275 bucket_cnts[i].byte_count = htonll(gs->bucket_stats[i].byte_count);
8280 ofputil_group_stats_to_ofp11(const struct ofputil_group_stats *gs,
8281 struct ofp11_group_stats *gs11, size_t length,
8282 struct ofp11_bucket_counter bucket_cnts[])
8284 memset(gs11, 0, sizeof *gs11);
8285 gs11->length = htons(length);
8286 gs11->group_id = htonl(gs->group_id);
8287 gs11->ref_count = htonl(gs->ref_count);
8288 gs11->packet_count = htonll(gs->packet_count);
8289 gs11->byte_count = htonll(gs->byte_count);
8290 ofputil_group_bucket_counters_to_ofp11(gs, bucket_cnts);
8294 ofputil_group_stats_to_ofp13(const struct ofputil_group_stats *gs,
8295 struct ofp13_group_stats *gs13, size_t length,
8296 struct ofp11_bucket_counter bucket_cnts[])
8298 ofputil_group_stats_to_ofp11(gs, &gs13->gs, length, bucket_cnts);
8299 gs13->duration_sec = htonl(gs->duration_sec);
8300 gs13->duration_nsec = htonl(gs->duration_nsec);
8304 /* Encodes 'gs' properly for the format of the list of group statistics
8305 * replies already begun in 'replies' and appends it to the list. 'replies'
8306 * must have originally been initialized with ofpmp_init(). */
8308 ofputil_append_group_stats(struct ovs_list *replies,
8309 const struct ofputil_group_stats *gs)
8311 size_t bucket_counter_size;
8312 struct ofp11_bucket_counter *bucket_counters;
8315 bucket_counter_size = gs->n_buckets * sizeof(struct ofp11_bucket_counter);
8317 switch (ofpmp_version(replies)) {
8319 case OFP12_VERSION:{
8320 struct ofp11_group_stats *gs11;
8322 length = sizeof *gs11 + bucket_counter_size;
8323 gs11 = ofpmp_append(replies, length);
8324 bucket_counters = (struct ofp11_bucket_counter *)(gs11 + 1);
8325 ofputil_group_stats_to_ofp11(gs, gs11, length, bucket_counters);
8332 case OFP16_VERSION: {
8333 struct ofp13_group_stats *gs13;
8335 length = sizeof *gs13 + bucket_counter_size;
8336 gs13 = ofpmp_append(replies, length);
8337 bucket_counters = (struct ofp11_bucket_counter *)(gs13 + 1);
8338 ofputil_group_stats_to_ofp13(gs, gs13, length, bucket_counters);
8347 /* Returns an OpenFlow group features request for OpenFlow version
8350 ofputil_encode_group_features_request(enum ofp_version ofp_version)
8352 struct ofpbuf *request = NULL;
8354 switch (ofp_version) {
8357 ovs_fatal(0, "dump-group-features needs OpenFlow 1.2 or later "
8358 "(\'-O OpenFlow12\')");
8364 request = ofpraw_alloc(OFPRAW_OFPST12_GROUP_FEATURES_REQUEST,
8374 /* Returns a OpenFlow message that encodes 'features' properly as a reply to
8375 * group features request 'request'. */
8377 ofputil_encode_group_features_reply(
8378 const struct ofputil_group_features *features,
8379 const struct ofp_header *request)
8381 struct ofp12_group_features_stats *ogf;
8382 struct ofpbuf *reply;
8385 reply = ofpraw_alloc_xid(OFPRAW_OFPST12_GROUP_FEATURES_REPLY,
8386 request->version, request->xid, 0);
8387 ogf = ofpbuf_put_zeros(reply, sizeof *ogf);
8388 ogf->types = htonl(features->types);
8389 ogf->capabilities = htonl(features->capabilities);
8390 for (i = 0; i < OFPGT12_N_TYPES; i++) {
8391 ogf->max_groups[i] = htonl(features->max_groups[i]);
8392 ogf->actions[i] = ofpact_bitmap_to_openflow(features->ofpacts[i],
8399 /* Decodes group features reply 'oh' into 'features'. */
8401 ofputil_decode_group_features_reply(const struct ofp_header *oh,
8402 struct ofputil_group_features *features)
8404 const struct ofp12_group_features_stats *ogf = ofpmsg_body(oh);
8407 features->types = ntohl(ogf->types);
8408 features->capabilities = ntohl(ogf->capabilities);
8409 for (i = 0; i < OFPGT12_N_TYPES; i++) {
8410 features->max_groups[i] = ntohl(ogf->max_groups[i]);
8411 features->ofpacts[i] = ofpact_bitmap_from_openflow(
8412 ogf->actions[i], oh->version);
8416 /* Parse a group status request message into a 32 bit OpenFlow 1.1
8417 * group ID and stores the latter in '*group_id'.
8418 * Returns 0 if successful, otherwise an OFPERR_* number. */
8420 ofputil_decode_group_stats_request(const struct ofp_header *request,
8423 const struct ofp11_group_stats_request *gsr11 = ofpmsg_body(request);
8424 *group_id = ntohl(gsr11->group_id);
8428 /* Converts a group stats reply in 'msg' into an abstract ofputil_group_stats
8429 * in 'gs'. Assigns freshly allocated memory to gs->bucket_stats for the
8430 * caller to eventually free.
8432 * Multiple group stats replies can be packed into a single OpenFlow message.
8433 * Calling this function multiple times for a single 'msg' iterates through the
8434 * replies. The caller must initially leave 'msg''s layer pointers null and
8435 * not modify them between calls.
8437 * Returns 0 if successful, EOF if no replies were left in this 'msg',
8438 * otherwise a positive errno value. */
8440 ofputil_decode_group_stats_reply(struct ofpbuf *msg,
8441 struct ofputil_group_stats *gs)
8443 struct ofp11_bucket_counter *obc;
8444 struct ofp11_group_stats *ogs11;
8451 gs->bucket_stats = NULL;
8452 error = (msg->header ? ofpraw_decode(&raw, msg->header)
8453 : ofpraw_pull(&raw, msg));
8462 if (raw == OFPRAW_OFPST11_GROUP_REPLY) {
8463 base_len = sizeof *ogs11;
8464 ogs11 = ofpbuf_try_pull(msg, sizeof *ogs11);
8465 gs->duration_sec = gs->duration_nsec = UINT32_MAX;
8466 } else if (raw == OFPRAW_OFPST13_GROUP_REPLY) {
8467 struct ofp13_group_stats *ogs13;
8469 base_len = sizeof *ogs13;
8470 ogs13 = ofpbuf_try_pull(msg, sizeof *ogs13);
8473 gs->duration_sec = ntohl(ogs13->duration_sec);
8474 gs->duration_nsec = ntohl(ogs13->duration_nsec);
8483 VLOG_WARN_RL(&bad_ofmsg_rl, "%s reply has %"PRIu32" leftover bytes at end",
8484 ofpraw_get_name(raw), msg->size);
8485 return OFPERR_OFPBRC_BAD_LEN;
8487 length = ntohs(ogs11->length);
8488 if (length < sizeof base_len) {
8489 VLOG_WARN_RL(&bad_ofmsg_rl, "%s reply claims invalid length %"PRIuSIZE,
8490 ofpraw_get_name(raw), length);
8491 return OFPERR_OFPBRC_BAD_LEN;
8494 gs->group_id = ntohl(ogs11->group_id);
8495 gs->ref_count = ntohl(ogs11->ref_count);
8496 gs->packet_count = ntohll(ogs11->packet_count);
8497 gs->byte_count = ntohll(ogs11->byte_count);
8499 gs->n_buckets = (length - base_len) / sizeof *obc;
8500 obc = ofpbuf_try_pull(msg, gs->n_buckets * sizeof *obc);
8502 VLOG_WARN_RL(&bad_ofmsg_rl, "%s reply has %"PRIu32" leftover bytes at end",
8503 ofpraw_get_name(raw), msg->size);
8504 return OFPERR_OFPBRC_BAD_LEN;
8507 gs->bucket_stats = xmalloc(gs->n_buckets * sizeof *gs->bucket_stats);
8508 for (i = 0; i < gs->n_buckets; i++) {
8509 gs->bucket_stats[i].packet_count = ntohll(obc[i].packet_count);
8510 gs->bucket_stats[i].byte_count = ntohll(obc[i].byte_count);
8517 ofputil_put_ofp11_bucket(const struct ofputil_bucket *bucket,
8518 struct ofpbuf *openflow, enum ofp_version ofp_version)
8520 struct ofp11_bucket *ob;
8523 start = openflow->size;
8524 ofpbuf_put_zeros(openflow, sizeof *ob);
8525 ofpacts_put_openflow_actions(bucket->ofpacts, bucket->ofpacts_len,
8526 openflow, ofp_version);
8527 ob = ofpbuf_at_assert(openflow, start, sizeof *ob);
8528 ob->len = htons(openflow->size - start);
8529 ob->weight = htons(bucket->weight);
8530 ob->watch_port = ofputil_port_to_ofp11(bucket->watch_port);
8531 ob->watch_group = htonl(bucket->watch_group);
8535 ofputil_put_ofp15_bucket(const struct ofputil_bucket *bucket,
8536 uint32_t bucket_id, enum ofp11_group_type group_type,
8537 struct ofpbuf *openflow, enum ofp_version ofp_version)
8539 struct ofp15_bucket *ob;
8540 size_t start, actions_start, actions_len;
8542 start = openflow->size;
8543 ofpbuf_put_zeros(openflow, sizeof *ob);
8545 actions_start = openflow->size;
8546 ofpacts_put_openflow_actions(bucket->ofpacts, bucket->ofpacts_len,
8547 openflow, ofp_version);
8548 actions_len = openflow->size - actions_start;
8550 if (group_type == OFPGT11_SELECT) {
8551 ofpprop_put_u16(openflow, OFPGBPT15_WEIGHT, bucket->weight);
8553 if (bucket->watch_port != OFPP_ANY) {
8554 ofpprop_put_be32(openflow, OFPGBPT15_WATCH_PORT,
8555 ofputil_port_to_ofp11(bucket->watch_port));
8557 if (bucket->watch_group != OFPG_ANY) {
8558 ofpprop_put_u32(openflow, OFPGBPT15_WATCH_GROUP, bucket->watch_group);
8561 ob = ofpbuf_at_assert(openflow, start, sizeof *ob);
8562 ob->len = htons(openflow->size - start);
8563 ob->action_array_len = htons(actions_len);
8564 ob->bucket_id = htonl(bucket_id);
8568 ofputil_put_group_prop_ntr_selection_method(enum ofp_version ofp_version,
8569 const struct ofputil_group_props *gp,
8570 struct ofpbuf *openflow)
8572 struct ntr_group_prop_selection_method *prop;
8575 start = openflow->size;
8576 ofpbuf_put_zeros(openflow, sizeof *prop);
8577 oxm_put_field_array(openflow, &gp->fields, ofp_version);
8578 prop = ofpbuf_at_assert(openflow, start, sizeof *prop);
8579 prop->type = htons(OFPGPT15_EXPERIMENTER);
8580 prop->experimenter = htonl(NTR_VENDOR_ID);
8581 prop->exp_type = htonl(NTRT_SELECTION_METHOD);
8582 strcpy(prop->selection_method, gp->selection_method);
8583 prop->selection_method_param = htonll(gp->selection_method_param);
8584 ofpprop_end(openflow, start);
8588 ofputil_append_ofp11_group_desc_reply(const struct ofputil_group_desc *gds,
8589 const struct ovs_list *buckets,
8590 struct ovs_list *replies,
8591 enum ofp_version version)
8593 struct ofpbuf *reply = ofpbuf_from_list(ovs_list_back(replies));
8594 struct ofp11_group_desc_stats *ogds;
8595 struct ofputil_bucket *bucket;
8598 start_ogds = reply->size;
8599 ofpbuf_put_zeros(reply, sizeof *ogds);
8600 LIST_FOR_EACH (bucket, list_node, buckets) {
8601 ofputil_put_ofp11_bucket(bucket, reply, version);
8603 ogds = ofpbuf_at_assert(reply, start_ogds, sizeof *ogds);
8604 ogds->length = htons(reply->size - start_ogds);
8605 ogds->type = gds->type;
8606 ogds->group_id = htonl(gds->group_id);
8608 ofpmp_postappend(replies, start_ogds);
8612 ofputil_append_ofp15_group_desc_reply(const struct ofputil_group_desc *gds,
8613 const struct ovs_list *buckets,
8614 struct ovs_list *replies,
8615 enum ofp_version version)
8617 struct ofpbuf *reply = ofpbuf_from_list(ovs_list_back(replies));
8618 struct ofp15_group_desc_stats *ogds;
8619 struct ofputil_bucket *bucket;
8620 size_t start_ogds, start_buckets;
8622 start_ogds = reply->size;
8623 ofpbuf_put_zeros(reply, sizeof *ogds);
8624 start_buckets = reply->size;
8625 LIST_FOR_EACH (bucket, list_node, buckets) {
8626 ofputil_put_ofp15_bucket(bucket, bucket->bucket_id,
8627 gds->type, reply, version);
8629 ogds = ofpbuf_at_assert(reply, start_ogds, sizeof *ogds);
8630 ogds->type = gds->type;
8631 ogds->group_id = htonl(gds->group_id);
8632 ogds->bucket_list_len = htons(reply->size - start_buckets);
8634 /* Add group properties */
8635 if (gds->props.selection_method[0]) {
8636 ofputil_put_group_prop_ntr_selection_method(version, &gds->props,
8639 ogds = ofpbuf_at_assert(reply, start_ogds, sizeof *ogds);
8640 ogds->length = htons(reply->size - start_ogds);
8642 ofpmp_postappend(replies, start_ogds);
8645 /* Appends a group stats reply that contains the data in 'gds' to those already
8646 * present in the list of ofpbufs in 'replies'. 'replies' should have been
8647 * initialized with ofpmp_init(). */
8649 ofputil_append_group_desc_reply(const struct ofputil_group_desc *gds,
8650 const struct ovs_list *buckets,
8651 struct ovs_list *replies)
8653 enum ofp_version version = ofpmp_version(replies);
8661 ofputil_append_ofp11_group_desc_reply(gds, buckets, replies, version);
8666 ofputil_append_ofp15_group_desc_reply(gds, buckets, replies, version);
8676 ofputil_pull_ofp11_buckets(struct ofpbuf *msg, size_t buckets_length,
8677 enum ofp_version version, struct ovs_list *buckets)
8679 struct ofp11_bucket *ob;
8680 uint32_t bucket_id = 0;
8682 ovs_list_init(buckets);
8683 while (buckets_length > 0) {
8684 struct ofputil_bucket *bucket;
8685 struct ofpbuf ofpacts;
8689 ob = (buckets_length >= sizeof *ob
8690 ? ofpbuf_try_pull(msg, sizeof *ob)
8693 VLOG_WARN_RL(&bad_ofmsg_rl, "buckets end with %"PRIuSIZE" leftover bytes",
8695 return OFPERR_OFPGMFC_BAD_BUCKET;
8698 ob_len = ntohs(ob->len);
8699 if (ob_len < sizeof *ob) {
8700 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket length "
8701 "%"PRIuSIZE" is not valid", ob_len);
8702 return OFPERR_OFPGMFC_BAD_BUCKET;
8703 } else if (ob_len > buckets_length) {
8704 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket length "
8705 "%"PRIuSIZE" exceeds remaining buckets data size %"PRIuSIZE,
8706 ob_len, buckets_length);
8707 return OFPERR_OFPGMFC_BAD_BUCKET;
8709 buckets_length -= ob_len;
8711 ofpbuf_init(&ofpacts, 0);
8712 error = ofpacts_pull_openflow_actions(msg, ob_len - sizeof *ob,
8715 ofpbuf_uninit(&ofpacts);
8716 ofputil_bucket_list_destroy(buckets);
8720 bucket = xzalloc(sizeof *bucket);
8721 bucket->weight = ntohs(ob->weight);
8722 error = ofputil_port_from_ofp11(ob->watch_port, &bucket->watch_port);
8724 ofpbuf_uninit(&ofpacts);
8725 ofputil_bucket_list_destroy(buckets);
8726 return OFPERR_OFPGMFC_BAD_WATCH;
8728 bucket->watch_group = ntohl(ob->watch_group);
8729 bucket->bucket_id = bucket_id++;
8731 bucket->ofpacts = ofpbuf_steal_data(&ofpacts);
8732 bucket->ofpacts_len = ofpacts.size;
8733 ovs_list_push_back(buckets, &bucket->list_node);
8740 ofputil_pull_ofp15_buckets(struct ofpbuf *msg, size_t buckets_length,
8741 enum ofp_version version, uint8_t group_type,
8742 struct ovs_list *buckets)
8744 struct ofp15_bucket *ob;
8746 ovs_list_init(buckets);
8747 while (buckets_length > 0) {
8748 struct ofputil_bucket *bucket = NULL;
8749 struct ofpbuf ofpacts;
8750 enum ofperr err = OFPERR_OFPGMFC_BAD_BUCKET;
8751 size_t ob_len, actions_len, properties_len;
8752 ovs_be32 watch_port = ofputil_port_to_ofp11(OFPP_ANY);
8753 ovs_be32 watch_group = htonl(OFPG_ANY);
8754 ovs_be16 weight = htons(group_type == OFPGT11_SELECT ? 1 : 0);
8756 ofpbuf_init(&ofpacts, 0);
8758 ob = ofpbuf_try_pull(msg, sizeof *ob);
8760 VLOG_WARN_RL(&bad_ofmsg_rl, "buckets end with %"PRIuSIZE
8761 " leftover bytes", buckets_length);
8765 ob_len = ntohs(ob->len);
8766 actions_len = ntohs(ob->action_array_len);
8768 if (ob_len < sizeof *ob) {
8769 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket length "
8770 "%"PRIuSIZE" is not valid", ob_len);
8772 } else if (ob_len > buckets_length) {
8773 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket length "
8774 "%"PRIuSIZE" exceeds remaining buckets data size %"
8775 PRIuSIZE, ob_len, buckets_length);
8777 } else if (actions_len > ob_len - sizeof *ob) {
8778 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket actions "
8779 "length %"PRIuSIZE" exceeds remaining bucket "
8780 "data size %"PRIuSIZE, actions_len,
8781 ob_len - sizeof *ob);
8784 buckets_length -= ob_len;
8786 err = ofpacts_pull_openflow_actions(msg, actions_len, version,
8792 properties_len = ob_len - sizeof *ob - actions_len;
8793 struct ofpbuf properties = ofpbuf_const_initializer(
8794 ofpbuf_pull(msg, properties_len), properties_len);
8795 while (properties.size > 0) {
8796 struct ofpbuf payload;
8799 err = ofpprop_pull(&properties, &payload, &type);
8805 case OFPGBPT15_WEIGHT:
8806 err = ofpprop_parse_be16(&payload, &weight);
8809 case OFPGBPT15_WATCH_PORT:
8810 err = ofpprop_parse_be32(&payload, &watch_port);
8813 case OFPGBPT15_WATCH_GROUP:
8814 err = ofpprop_parse_be32(&payload, &watch_group);
8818 err = OFPPROP_UNKNOWN(false, "group bucket", type);
8827 bucket = xzalloc(sizeof *bucket);
8829 bucket->weight = ntohs(weight);
8830 err = ofputil_port_from_ofp11(watch_port, &bucket->watch_port);
8832 err = OFPERR_OFPGMFC_BAD_WATCH;
8835 bucket->watch_group = ntohl(watch_group);
8836 bucket->bucket_id = ntohl(ob->bucket_id);
8837 if (bucket->bucket_id > OFPG15_BUCKET_MAX) {
8838 VLOG_WARN_RL(&bad_ofmsg_rl, "bucket id (%u) is out of range",
8840 err = OFPERR_OFPGMFC_BAD_BUCKET;
8844 bucket->ofpacts = ofpbuf_steal_data(&ofpacts);
8845 bucket->ofpacts_len = ofpacts.size;
8846 ovs_list_push_back(buckets, &bucket->list_node);
8852 ofpbuf_uninit(&ofpacts);
8853 ofputil_bucket_list_destroy(buckets);
8857 if (ofputil_bucket_check_duplicate_id(buckets)) {
8858 VLOG_WARN_RL(&bad_ofmsg_rl, "Duplicate bucket id");
8859 ofputil_bucket_list_destroy(buckets);
8860 return OFPERR_OFPGMFC_BAD_BUCKET;
8867 ofputil_init_group_properties(struct ofputil_group_props *gp)
8869 memset(gp, 0, sizeof *gp);
8873 parse_group_prop_ntr_selection_method(struct ofpbuf *payload,
8874 enum ofp11_group_type group_type,
8875 enum ofp15_group_mod_command group_cmd,
8876 struct ofputil_group_props *gp)
8878 struct ntr_group_prop_selection_method *prop = payload->data;
8879 size_t fields_len, method_len;
8882 switch (group_type) {
8883 case OFPGT11_SELECT:
8886 case OFPGT11_INDIRECT:
8888 OFPPROP_LOG(&bad_ofmsg_rl, false, "ntr selection method property is "
8889 "only allowed for select groups");
8890 return OFPERR_OFPBPC_BAD_VALUE;
8895 switch (group_cmd) {
8897 case OFPGC15_MODIFY:
8899 case OFPGC15_DELETE:
8900 case OFPGC15_INSERT_BUCKET:
8901 case OFPGC15_REMOVE_BUCKET:
8902 OFPPROP_LOG(&bad_ofmsg_rl, false, "ntr selection method property is "
8903 "only allowed for add and delete group modifications");
8904 return OFPERR_OFPBPC_BAD_VALUE;
8909 if (payload->size < sizeof *prop) {
8910 OFPPROP_LOG(&bad_ofmsg_rl, false, "ntr selection method property "
8911 "length %u is not valid", payload->size);
8912 return OFPERR_OFPBPC_BAD_LEN;
8915 method_len = strnlen(prop->selection_method, NTR_MAX_SELECTION_METHOD_LEN);
8917 if (method_len == NTR_MAX_SELECTION_METHOD_LEN) {
8918 OFPPROP_LOG(&bad_ofmsg_rl, false,
8919 "ntr selection method is not null terminated");
8920 return OFPERR_OFPBPC_BAD_VALUE;
8923 if (strcmp("hash", prop->selection_method)) {
8924 OFPPROP_LOG(&bad_ofmsg_rl, false,
8925 "ntr selection method '%s' is not supported",
8926 prop->selection_method);
8927 return OFPERR_OFPBPC_BAD_VALUE;
8930 strcpy(gp->selection_method, prop->selection_method);
8931 gp->selection_method_param = ntohll(prop->selection_method_param);
8933 if (!method_len && gp->selection_method_param) {
8934 OFPPROP_LOG(&bad_ofmsg_rl, false, "ntr selection method parameter is "
8935 "non-zero but selection method is empty");
8936 return OFPERR_OFPBPC_BAD_VALUE;
8939 ofpbuf_pull(payload, sizeof *prop);
8941 fields_len = ntohs(prop->length) - sizeof *prop;
8942 if (!method_len && fields_len) {
8943 OFPPROP_LOG(&bad_ofmsg_rl, false, "ntr selection method parameter is "
8944 "zero but fields are provided");
8945 return OFPERR_OFPBPC_BAD_VALUE;
8948 error = oxm_pull_field_array(payload->data, fields_len,
8951 OFPPROP_LOG(&bad_ofmsg_rl, false,
8952 "ntr selection method fields are invalid");
8960 parse_ofp15_group_properties(struct ofpbuf *msg,
8961 enum ofp11_group_type group_type,
8962 enum ofp15_group_mod_command group_cmd,
8963 struct ofputil_group_props *gp,
8964 size_t properties_len)
8966 struct ofpbuf properties = ofpbuf_const_initializer(
8967 ofpbuf_pull(msg, properties_len), properties_len);
8968 while (properties.size > 0) {
8969 struct ofpbuf payload;
8973 error = ofpprop_pull(&properties, &payload, &type);
8979 case OFPPROP_EXP(NTR_VENDOR_ID, NTRT_SELECTION_METHOD):
8980 case OFPPROP_EXP(NTR_COMPAT_VENDOR_ID, NTRT_SELECTION_METHOD):
8981 error = parse_group_prop_ntr_selection_method(&payload, group_type,
8986 error = OFPPROP_UNKNOWN(false, "group", type);
8999 ofputil_decode_ofp11_group_desc_reply(struct ofputil_group_desc *gd,
9001 enum ofp_version version)
9003 struct ofp11_group_desc_stats *ogds;
9007 ofpraw_pull_assert(msg);
9014 ogds = ofpbuf_try_pull(msg, sizeof *ogds);
9016 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply has %"PRIu32" "
9017 "leftover bytes at end", msg->size);
9018 return OFPERR_OFPBRC_BAD_LEN;
9020 gd->type = ogds->type;
9021 gd->group_id = ntohl(ogds->group_id);
9023 length = ntohs(ogds->length);
9024 if (length < sizeof *ogds || length - sizeof *ogds > msg->size) {
9025 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply claims invalid "
9026 "length %"PRIuSIZE, length);
9027 return OFPERR_OFPBRC_BAD_LEN;
9030 return ofputil_pull_ofp11_buckets(msg, length - sizeof *ogds, version,
9035 ofputil_decode_ofp15_group_desc_reply(struct ofputil_group_desc *gd,
9037 enum ofp_version version)
9039 struct ofp15_group_desc_stats *ogds;
9040 uint16_t length, bucket_list_len;
9044 ofpraw_pull_assert(msg);
9051 ogds = ofpbuf_try_pull(msg, sizeof *ogds);
9053 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply has %"PRIu32" "
9054 "leftover bytes at end", msg->size);
9055 return OFPERR_OFPBRC_BAD_LEN;
9057 gd->type = ogds->type;
9058 gd->group_id = ntohl(ogds->group_id);
9060 length = ntohs(ogds->length);
9061 if (length < sizeof *ogds || length - sizeof *ogds > msg->size) {
9062 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply claims invalid "
9063 "length %u", length);
9064 return OFPERR_OFPBRC_BAD_LEN;
9067 bucket_list_len = ntohs(ogds->bucket_list_len);
9068 if (length < bucket_list_len + sizeof *ogds) {
9069 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply claims invalid "
9070 "bucket list length %u", bucket_list_len);
9071 return OFPERR_OFPBRC_BAD_LEN;
9073 error = ofputil_pull_ofp15_buckets(msg, bucket_list_len, version, gd->type,
9079 /* By definition group desc messages don't have a group mod command.
9080 * However, parse_group_prop_ntr_selection_method() checks to make sure
9081 * that the command is OFPGC15_ADD or OFPGC15_DELETE to guard
9082 * against group mod messages with other commands supplying
9083 * a NTR selection method group experimenter property.
9084 * Such properties are valid for group desc replies so
9085 * claim that the group mod command is OFPGC15_ADD to
9086 * satisfy the check in parse_group_prop_ntr_selection_method() */
9087 return parse_ofp15_group_properties(msg, gd->type, OFPGC15_ADD, &gd->props,
9088 length - sizeof *ogds - bucket_list_len);
9091 /* Converts a group description reply in 'msg' into an abstract
9092 * ofputil_group_desc in 'gd'.
9094 * Multiple group description replies can be packed into a single OpenFlow
9095 * message. Calling this function multiple times for a single 'msg' iterates
9096 * through the replies. The caller must initially leave 'msg''s layer pointers
9097 * null and not modify them between calls.
9099 * Returns 0 if successful, EOF if no replies were left in this 'msg',
9100 * otherwise a positive errno value. */
9102 ofputil_decode_group_desc_reply(struct ofputil_group_desc *gd,
9103 struct ofpbuf *msg, enum ofp_version version)
9105 ofputil_init_group_properties(&gd->props);
9113 return ofputil_decode_ofp11_group_desc_reply(gd, msg, version);
9117 return ofputil_decode_ofp15_group_desc_reply(gd, msg, version);
9126 ofputil_uninit_group_mod(struct ofputil_group_mod *gm)
9128 ofputil_bucket_list_destroy(&gm->buckets);
9131 static struct ofpbuf *
9132 ofputil_encode_ofp11_group_mod(enum ofp_version ofp_version,
9133 const struct ofputil_group_mod *gm)
9136 struct ofp11_group_mod *ogm;
9138 struct ofputil_bucket *bucket;
9140 b = ofpraw_alloc(OFPRAW_OFPT11_GROUP_MOD, ofp_version, 0);
9141 start_ogm = b->size;
9142 ofpbuf_put_zeros(b, sizeof *ogm);
9144 LIST_FOR_EACH (bucket, list_node, &gm->buckets) {
9145 ofputil_put_ofp11_bucket(bucket, b, ofp_version);
9147 ogm = ofpbuf_at_assert(b, start_ogm, sizeof *ogm);
9148 ogm->command = htons(gm->command);
9149 ogm->type = gm->type;
9150 ogm->group_id = htonl(gm->group_id);
9155 static struct ofpbuf *
9156 ofputil_encode_ofp15_group_mod(enum ofp_version ofp_version,
9157 const struct ofputil_group_mod *gm)
9160 struct ofp15_group_mod *ogm;
9162 struct ofputil_bucket *bucket;
9163 struct id_pool *bucket_ids = NULL;
9165 b = ofpraw_alloc(OFPRAW_OFPT15_GROUP_MOD, ofp_version, 0);
9166 start_ogm = b->size;
9167 ofpbuf_put_zeros(b, sizeof *ogm);
9169 LIST_FOR_EACH (bucket, list_node, &gm->buckets) {
9172 /* Generate a bucket id if none was supplied */
9173 if (bucket->bucket_id > OFPG15_BUCKET_MAX) {
9175 const struct ofputil_bucket *bkt;
9177 bucket_ids = id_pool_create(0, OFPG15_BUCKET_MAX + 1);
9179 /* Mark all bucket_ids that are present in gm
9180 * as used in the pool. */
9181 LIST_FOR_EACH_REVERSE (bkt, list_node, &gm->buckets) {
9182 if (bkt == bucket) {
9185 if (bkt->bucket_id <= OFPG15_BUCKET_MAX) {
9186 id_pool_add(bucket_ids, bkt->bucket_id);
9191 if (!id_pool_alloc_id(bucket_ids, &bucket_id)) {
9195 bucket_id = bucket->bucket_id;
9198 ofputil_put_ofp15_bucket(bucket, bucket_id, gm->type, b, ofp_version);
9200 ogm = ofpbuf_at_assert(b, start_ogm, sizeof *ogm);
9201 ogm->command = htons(gm->command);
9202 ogm->type = gm->type;
9203 ogm->group_id = htonl(gm->group_id);
9204 ogm->command_bucket_id = htonl(gm->command_bucket_id);
9205 ogm->bucket_array_len = htons(b->size - start_ogm - sizeof *ogm);
9207 /* Add group properties */
9208 if (gm->props.selection_method[0]) {
9209 ofputil_put_group_prop_ntr_selection_method(ofp_version, &gm->props, b);
9212 id_pool_destroy(bucket_ids);
9217 bad_group_cmd(enum ofp15_group_mod_command cmd)
9219 const char *opt_version;
9220 const char *version;
9221 const char *cmd_str;
9225 case OFPGC15_MODIFY:
9226 case OFPGC15_DELETE:
9231 case OFPGC15_INSERT_BUCKET:
9232 case OFPGC15_REMOVE_BUCKET:
9243 cmd_str = "add-group";
9246 case OFPGC15_MODIFY:
9247 cmd_str = "mod-group";
9250 case OFPGC15_DELETE:
9251 cmd_str = "del-group";
9254 case OFPGC15_INSERT_BUCKET:
9255 cmd_str = "insert-bucket";
9258 case OFPGC15_REMOVE_BUCKET:
9259 cmd_str = "remove-bucket";
9266 ovs_fatal(0, "%s needs OpenFlow %s or later (\'-O OpenFlow%s\')",
9267 cmd_str, version, opt_version);
9271 /* Converts abstract group mod 'gm' into a message for OpenFlow version
9272 * 'ofp_version' and returns the message. */
9274 ofputil_encode_group_mod(enum ofp_version ofp_version,
9275 const struct ofputil_group_mod *gm)
9278 switch (ofp_version) {
9280 bad_group_cmd(gm->command);
9286 if (gm->command > OFPGC11_DELETE) {
9287 bad_group_cmd(gm->command);
9289 return ofputil_encode_ofp11_group_mod(ofp_version, gm);
9293 return ofputil_encode_ofp15_group_mod(ofp_version, gm);
9301 ofputil_pull_ofp11_group_mod(struct ofpbuf *msg, enum ofp_version ofp_version,
9302 struct ofputil_group_mod *gm)
9304 const struct ofp11_group_mod *ogm;
9307 ogm = ofpbuf_pull(msg, sizeof *ogm);
9308 gm->command = ntohs(ogm->command);
9309 gm->type = ogm->type;
9310 gm->group_id = ntohl(ogm->group_id);
9311 gm->command_bucket_id = OFPG15_BUCKET_ALL;
9313 error = ofputil_pull_ofp11_buckets(msg, msg->size, ofp_version,
9316 /* OF1.3.5+ prescribes an error when an OFPGC_DELETE includes buckets. */
9318 && ofp_version >= OFP13_VERSION
9319 && gm->command == OFPGC11_DELETE
9320 && !ovs_list_is_empty(&gm->buckets)) {
9321 error = OFPERR_OFPGMFC_INVALID_GROUP;
9328 ofputil_pull_ofp15_group_mod(struct ofpbuf *msg, enum ofp_version ofp_version,
9329 struct ofputil_group_mod *gm)
9331 const struct ofp15_group_mod *ogm;
9332 uint16_t bucket_list_len;
9333 enum ofperr error = OFPERR_OFPGMFC_BAD_BUCKET;
9335 ogm = ofpbuf_pull(msg, sizeof *ogm);
9336 gm->command = ntohs(ogm->command);
9337 gm->type = ogm->type;
9338 gm->group_id = ntohl(ogm->group_id);
9340 gm->command_bucket_id = ntohl(ogm->command_bucket_id);
9341 switch (gm->command) {
9342 case OFPGC15_REMOVE_BUCKET:
9343 if (gm->command_bucket_id == OFPG15_BUCKET_ALL) {
9347 case OFPGC15_INSERT_BUCKET:
9348 if (gm->command_bucket_id <= OFPG15_BUCKET_MAX ||
9349 gm->command_bucket_id == OFPG15_BUCKET_FIRST
9350 || gm->command_bucket_id == OFPG15_BUCKET_LAST) {
9356 case OFPGC11_MODIFY:
9357 case OFPGC11_DELETE:
9359 if (gm->command_bucket_id == OFPG15_BUCKET_ALL) {
9365 VLOG_WARN_RL(&bad_ofmsg_rl,
9366 "group command bucket id (%u) is out of range",
9367 gm->command_bucket_id);
9368 return OFPERR_OFPGMFC_BAD_BUCKET;
9371 bucket_list_len = ntohs(ogm->bucket_array_len);
9372 error = ofputil_pull_ofp15_buckets(msg, bucket_list_len, ofp_version,
9373 gm->type, &gm->buckets);
9378 return parse_ofp15_group_properties(msg, gm->type, gm->command, &gm->props,
9382 /* Converts OpenFlow group mod message 'oh' into an abstract group mod in
9383 * 'gm'. Returns 0 if successful, otherwise an OpenFlow error code. */
9385 ofputil_decode_group_mod(const struct ofp_header *oh,
9386 struct ofputil_group_mod *gm)
9388 ofputil_init_group_properties(&gm->props);
9390 enum ofp_version ofp_version = oh->version;
9391 struct ofpbuf msg = ofpbuf_const_initializer(oh, ntohs(oh->length));
9392 ofpraw_pull_assert(&msg);
9395 switch (ofp_version)
9401 err = ofputil_pull_ofp11_group_mod(&msg, ofp_version, gm);
9406 err = ofputil_pull_ofp15_group_mod(&msg, ofp_version, gm);
9418 case OFPGT11_INDIRECT:
9419 if (gm->command != OFPGC11_DELETE
9420 && !ovs_list_is_singleton(&gm->buckets) ) {
9421 return OFPERR_OFPGMFC_INVALID_GROUP;
9425 case OFPGT11_SELECT:
9429 return OFPERR_OFPGMFC_BAD_TYPE;
9432 switch (gm->command) {
9434 case OFPGC11_MODIFY:
9435 case OFPGC11_DELETE:
9436 case OFPGC15_INSERT_BUCKET:
9438 case OFPGC15_REMOVE_BUCKET:
9439 if (!ovs_list_is_empty(&gm->buckets)) {
9440 return OFPERR_OFPGMFC_BAD_BUCKET;
9444 return OFPERR_OFPGMFC_BAD_COMMAND;
9447 struct ofputil_bucket *bucket;
9448 LIST_FOR_EACH (bucket, list_node, &gm->buckets) {
9449 if (bucket->weight && gm->type != OFPGT11_SELECT) {
9450 return OFPERR_OFPGMFC_INVALID_GROUP;
9455 case OFPGT11_INDIRECT:
9456 if (ofputil_bucket_has_liveness(bucket)) {
9457 return OFPERR_OFPGMFC_WATCH_UNSUPPORTED;
9460 case OFPGT11_SELECT:
9463 if (!ofputil_bucket_has_liveness(bucket)) {
9464 return OFPERR_OFPGMFC_INVALID_GROUP;
9468 /* Returning BAD TYPE to be consistent
9469 * though gm->type has been checked already. */
9470 return OFPERR_OFPGMFC_BAD_TYPE;
9477 /* Parse a queue status request message into 'oqsr'.
9478 * Returns 0 if successful, otherwise an OFPERR_* number. */
9480 ofputil_decode_queue_stats_request(const struct ofp_header *request,
9481 struct ofputil_queue_stats_request *oqsr)
9483 switch ((enum ofp_version)request->version) {
9489 case OFP11_VERSION: {
9490 const struct ofp11_queue_stats_request *qsr11 = ofpmsg_body(request);
9491 oqsr->queue_id = ntohl(qsr11->queue_id);
9492 return ofputil_port_from_ofp11(qsr11->port_no, &oqsr->port_no);
9495 case OFP10_VERSION: {
9496 const struct ofp10_queue_stats_request *qsr10 = ofpmsg_body(request);
9497 oqsr->queue_id = ntohl(qsr10->queue_id);
9498 oqsr->port_no = u16_to_ofp(ntohs(qsr10->port_no));
9499 /* OF 1.0 uses OFPP_ALL for OFPP_ANY */
9500 if (oqsr->port_no == OFPP_ALL) {
9501 oqsr->port_no = OFPP_ANY;
9511 /* Encode a queue stats request for 'oqsr', the encoded message
9512 * will be for OpenFlow version 'ofp_version'. Returns message
9513 * as a struct ofpbuf. Returns encoded message on success, NULL on error. */
9515 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
9516 const struct ofputil_queue_stats_request *oqsr)
9518 struct ofpbuf *request;
9520 switch (ofp_version) {
9526 case OFP16_VERSION: {
9527 struct ofp11_queue_stats_request *req;
9528 request = ofpraw_alloc(OFPRAW_OFPST11_QUEUE_REQUEST, ofp_version, 0);
9529 req = ofpbuf_put_zeros(request, sizeof *req);
9530 req->port_no = ofputil_port_to_ofp11(oqsr->port_no);
9531 req->queue_id = htonl(oqsr->queue_id);
9534 case OFP10_VERSION: {
9535 struct ofp10_queue_stats_request *req;
9536 request = ofpraw_alloc(OFPRAW_OFPST10_QUEUE_REQUEST, ofp_version, 0);
9537 req = ofpbuf_put_zeros(request, sizeof *req);
9538 /* OpenFlow 1.0 needs OFPP_ALL instead of OFPP_ANY */
9539 req->port_no = htons(ofp_to_u16(oqsr->port_no == OFPP_ANY
9540 ? OFPP_ALL : oqsr->port_no));
9541 req->queue_id = htonl(oqsr->queue_id);
9551 /* Returns the number of queue stats elements in OFPTYPE_QUEUE_STATS_REPLY
9554 ofputil_count_queue_stats(const struct ofp_header *oh)
9556 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
9557 ofpraw_pull_assert(&b);
9559 for (size_t n = 0; ; n++) {
9560 struct ofputil_queue_stats qs;
9561 if (ofputil_decode_queue_stats(&qs, &b)) {
9568 ofputil_queue_stats_from_ofp10(struct ofputil_queue_stats *oqs,
9569 const struct ofp10_queue_stats *qs10)
9571 oqs->port_no = u16_to_ofp(ntohs(qs10->port_no));
9572 oqs->queue_id = ntohl(qs10->queue_id);
9573 oqs->tx_bytes = ntohll(get_32aligned_be64(&qs10->tx_bytes));
9574 oqs->tx_packets = ntohll(get_32aligned_be64(&qs10->tx_packets));
9575 oqs->tx_errors = ntohll(get_32aligned_be64(&qs10->tx_errors));
9576 oqs->duration_sec = oqs->duration_nsec = UINT32_MAX;
9582 ofputil_queue_stats_from_ofp11(struct ofputil_queue_stats *oqs,
9583 const struct ofp11_queue_stats *qs11)
9587 error = ofputil_port_from_ofp11(qs11->port_no, &oqs->port_no);
9592 oqs->queue_id = ntohl(qs11->queue_id);
9593 oqs->tx_bytes = ntohll(qs11->tx_bytes);
9594 oqs->tx_packets = ntohll(qs11->tx_packets);
9595 oqs->tx_errors = ntohll(qs11->tx_errors);
9596 oqs->duration_sec = oqs->duration_nsec = UINT32_MAX;
9602 ofputil_queue_stats_from_ofp13(struct ofputil_queue_stats *oqs,
9603 const struct ofp13_queue_stats *qs13)
9605 enum ofperr error = ofputil_queue_stats_from_ofp11(oqs, &qs13->qs);
9607 oqs->duration_sec = ntohl(qs13->duration_sec);
9608 oqs->duration_nsec = ntohl(qs13->duration_nsec);
9615 ofputil_pull_ofp14_queue_stats(struct ofputil_queue_stats *oqs,
9618 const struct ofp14_queue_stats *qs14;
9621 qs14 = ofpbuf_try_pull(msg, sizeof *qs14);
9623 return OFPERR_OFPBRC_BAD_LEN;
9626 len = ntohs(qs14->length);
9627 if (len < sizeof *qs14 || len - sizeof *qs14 > msg->size) {
9628 return OFPERR_OFPBRC_BAD_LEN;
9630 ofpbuf_pull(msg, len - sizeof *qs14);
9632 /* No properties yet defined, so ignore them for now. */
9634 return ofputil_queue_stats_from_ofp13(oqs, &qs14->qs);
9637 /* Converts an OFPST_QUEUE_STATS reply in 'msg' into an abstract
9638 * ofputil_queue_stats in 'qs'.
9640 * Multiple OFPST_QUEUE_STATS replies can be packed into a single OpenFlow
9641 * message. Calling this function multiple times for a single 'msg' iterates
9642 * through the replies. The caller must initially leave 'msg''s layer pointers
9643 * null and not modify them between calls.
9645 * Returns 0 if successful, EOF if no replies were left in this 'msg',
9646 * otherwise a positive errno value. */
9648 ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg)
9653 error = (msg->header ? ofpraw_decode(&raw, msg->header)
9654 : ofpraw_pull(&raw, msg));
9661 } else if (raw == OFPRAW_OFPST14_QUEUE_REPLY) {
9662 return ofputil_pull_ofp14_queue_stats(qs, msg);
9663 } else if (raw == OFPRAW_OFPST13_QUEUE_REPLY) {
9664 const struct ofp13_queue_stats *qs13;
9666 qs13 = ofpbuf_try_pull(msg, sizeof *qs13);
9670 return ofputil_queue_stats_from_ofp13(qs, qs13);
9671 } else if (raw == OFPRAW_OFPST11_QUEUE_REPLY) {
9672 const struct ofp11_queue_stats *qs11;
9674 qs11 = ofpbuf_try_pull(msg, sizeof *qs11);
9678 return ofputil_queue_stats_from_ofp11(qs, qs11);
9679 } else if (raw == OFPRAW_OFPST10_QUEUE_REPLY) {
9680 const struct ofp10_queue_stats *qs10;
9682 qs10 = ofpbuf_try_pull(msg, sizeof *qs10);
9686 return ofputil_queue_stats_from_ofp10(qs, qs10);
9692 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_QUEUE reply has %"PRIu32" leftover "
9693 "bytes at end", msg->size);
9694 return OFPERR_OFPBRC_BAD_LEN;
9698 ofputil_queue_stats_to_ofp10(const struct ofputil_queue_stats *oqs,
9699 struct ofp10_queue_stats *qs10)
9701 qs10->port_no = htons(ofp_to_u16(oqs->port_no));
9702 memset(qs10->pad, 0, sizeof qs10->pad);
9703 qs10->queue_id = htonl(oqs->queue_id);
9704 put_32aligned_be64(&qs10->tx_bytes, htonll(oqs->tx_bytes));
9705 put_32aligned_be64(&qs10->tx_packets, htonll(oqs->tx_packets));
9706 put_32aligned_be64(&qs10->tx_errors, htonll(oqs->tx_errors));
9710 ofputil_queue_stats_to_ofp11(const struct ofputil_queue_stats *oqs,
9711 struct ofp11_queue_stats *qs11)
9713 qs11->port_no = ofputil_port_to_ofp11(oqs->port_no);
9714 qs11->queue_id = htonl(oqs->queue_id);
9715 qs11->tx_bytes = htonll(oqs->tx_bytes);
9716 qs11->tx_packets = htonll(oqs->tx_packets);
9717 qs11->tx_errors = htonll(oqs->tx_errors);
9721 ofputil_queue_stats_to_ofp13(const struct ofputil_queue_stats *oqs,
9722 struct ofp13_queue_stats *qs13)
9724 ofputil_queue_stats_to_ofp11(oqs, &qs13->qs);
9725 if (oqs->duration_sec != UINT32_MAX) {
9726 qs13->duration_sec = htonl(oqs->duration_sec);
9727 qs13->duration_nsec = htonl(oqs->duration_nsec);
9729 qs13->duration_sec = OVS_BE32_MAX;
9730 qs13->duration_nsec = OVS_BE32_MAX;
9735 ofputil_queue_stats_to_ofp14(const struct ofputil_queue_stats *oqs,
9736 struct ofp14_queue_stats *qs14)
9738 qs14->length = htons(sizeof *qs14);
9739 memset(qs14->pad, 0, sizeof qs14->pad);
9740 ofputil_queue_stats_to_ofp13(oqs, &qs14->qs);
9744 /* Encode a queue stat for 'oqs' and append it to 'replies'. */
9746 ofputil_append_queue_stat(struct ovs_list *replies,
9747 const struct ofputil_queue_stats *oqs)
9749 switch (ofpmp_version(replies)) {
9750 case OFP13_VERSION: {
9751 struct ofp13_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
9752 ofputil_queue_stats_to_ofp13(oqs, reply);
9757 case OFP11_VERSION: {
9758 struct ofp11_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
9759 ofputil_queue_stats_to_ofp11(oqs, reply);
9763 case OFP10_VERSION: {
9764 struct ofp10_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
9765 ofputil_queue_stats_to_ofp10(oqs, reply);
9771 case OFP16_VERSION: {
9772 struct ofp14_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
9773 ofputil_queue_stats_to_ofp14(oqs, reply);
9783 ofputil_decode_bundle_ctrl(const struct ofp_header *oh,
9784 struct ofputil_bundle_ctrl_msg *msg)
9786 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
9787 enum ofpraw raw = ofpraw_pull_assert(&b);
9788 ovs_assert(raw == OFPRAW_OFPT14_BUNDLE_CONTROL
9789 || raw == OFPRAW_ONFT13_BUNDLE_CONTROL);
9791 const struct ofp14_bundle_ctrl_msg *m = b.msg;
9792 msg->bundle_id = ntohl(m->bundle_id);
9793 msg->type = ntohs(m->type);
9794 msg->flags = ntohs(m->flags);
9800 ofputil_encode_bundle_ctrl_request(enum ofp_version ofp_version,
9801 struct ofputil_bundle_ctrl_msg *bc)
9803 struct ofpbuf *request;
9804 struct ofp14_bundle_ctrl_msg *m;
9806 switch (ofp_version) {
9810 ovs_fatal(0, "bundles need OpenFlow 1.3 or later "
9811 "(\'-O OpenFlow14\')");
9816 request = ofpraw_alloc(ofp_version == OFP13_VERSION
9817 ? OFPRAW_ONFT13_BUNDLE_CONTROL
9818 : OFPRAW_OFPT14_BUNDLE_CONTROL, ofp_version, 0);
9819 m = ofpbuf_put_zeros(request, sizeof *m);
9821 m->bundle_id = htonl(bc->bundle_id);
9822 m->type = htons(bc->type);
9823 m->flags = htons(bc->flags);
9833 ofputil_encode_bundle_ctrl_reply(const struct ofp_header *oh,
9834 struct ofputil_bundle_ctrl_msg *msg)
9837 struct ofp14_bundle_ctrl_msg *m;
9839 buf = ofpraw_alloc_reply(oh->version == OFP13_VERSION
9840 ? OFPRAW_ONFT13_BUNDLE_CONTROL
9841 : OFPRAW_OFPT14_BUNDLE_CONTROL, oh, 0);
9842 m = ofpbuf_put_zeros(buf, sizeof *m);
9844 m->bundle_id = htonl(msg->bundle_id);
9845 m->type = htons(msg->type);
9846 m->flags = htons(msg->flags);
9851 /* Return true for bundlable state change requests, false for other messages.
9854 ofputil_is_bundlable(enum ofptype type)
9857 /* Minimum required by OpenFlow 1.4. */
9858 case OFPTYPE_PORT_MOD:
9859 case OFPTYPE_FLOW_MOD:
9862 /* Nice to have later. */
9863 case OFPTYPE_FLOW_MOD_TABLE_ID:
9864 case OFPTYPE_GROUP_MOD:
9865 case OFPTYPE_TABLE_MOD:
9866 case OFPTYPE_METER_MOD:
9867 case OFPTYPE_PACKET_OUT:
9868 case OFPTYPE_NXT_TLV_TABLE_MOD:
9870 /* Not to be bundlable. */
9871 case OFPTYPE_ECHO_REQUEST:
9872 case OFPTYPE_FEATURES_REQUEST:
9873 case OFPTYPE_GET_CONFIG_REQUEST:
9874 case OFPTYPE_SET_CONFIG:
9875 case OFPTYPE_BARRIER_REQUEST:
9876 case OFPTYPE_ROLE_REQUEST:
9877 case OFPTYPE_ECHO_REPLY:
9878 case OFPTYPE_SET_FLOW_FORMAT:
9879 case OFPTYPE_SET_PACKET_IN_FORMAT:
9880 case OFPTYPE_SET_CONTROLLER_ID:
9881 case OFPTYPE_FLOW_AGE:
9882 case OFPTYPE_FLOW_MONITOR_CANCEL:
9883 case OFPTYPE_SET_ASYNC_CONFIG:
9884 case OFPTYPE_GET_ASYNC_REQUEST:
9885 case OFPTYPE_DESC_STATS_REQUEST:
9886 case OFPTYPE_FLOW_STATS_REQUEST:
9887 case OFPTYPE_AGGREGATE_STATS_REQUEST:
9888 case OFPTYPE_TABLE_STATS_REQUEST:
9889 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
9890 case OFPTYPE_TABLE_DESC_REQUEST:
9891 case OFPTYPE_PORT_STATS_REQUEST:
9892 case OFPTYPE_QUEUE_STATS_REQUEST:
9893 case OFPTYPE_PORT_DESC_STATS_REQUEST:
9894 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
9895 case OFPTYPE_METER_STATS_REQUEST:
9896 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
9897 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
9898 case OFPTYPE_GROUP_STATS_REQUEST:
9899 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
9900 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
9901 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
9902 case OFPTYPE_BUNDLE_CONTROL:
9903 case OFPTYPE_BUNDLE_ADD_MESSAGE:
9906 case OFPTYPE_FEATURES_REPLY:
9907 case OFPTYPE_GET_CONFIG_REPLY:
9908 case OFPTYPE_PACKET_IN:
9909 case OFPTYPE_FLOW_REMOVED:
9910 case OFPTYPE_PORT_STATUS:
9911 case OFPTYPE_BARRIER_REPLY:
9912 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
9913 case OFPTYPE_DESC_STATS_REPLY:
9914 case OFPTYPE_FLOW_STATS_REPLY:
9915 case OFPTYPE_QUEUE_STATS_REPLY:
9916 case OFPTYPE_PORT_STATS_REPLY:
9917 case OFPTYPE_TABLE_STATS_REPLY:
9918 case OFPTYPE_AGGREGATE_STATS_REPLY:
9919 case OFPTYPE_PORT_DESC_STATS_REPLY:
9920 case OFPTYPE_ROLE_REPLY:
9921 case OFPTYPE_FLOW_MONITOR_PAUSED:
9922 case OFPTYPE_FLOW_MONITOR_RESUMED:
9923 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
9924 case OFPTYPE_GET_ASYNC_REPLY:
9925 case OFPTYPE_GROUP_STATS_REPLY:
9926 case OFPTYPE_GROUP_DESC_STATS_REPLY:
9927 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
9928 case OFPTYPE_METER_STATS_REPLY:
9929 case OFPTYPE_METER_CONFIG_STATS_REPLY:
9930 case OFPTYPE_METER_FEATURES_STATS_REPLY:
9931 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
9932 case OFPTYPE_TABLE_DESC_REPLY:
9933 case OFPTYPE_ROLE_STATUS:
9934 case OFPTYPE_REQUESTFORWARD:
9935 case OFPTYPE_TABLE_STATUS:
9936 case OFPTYPE_NXT_TLV_TABLE_REQUEST:
9937 case OFPTYPE_NXT_TLV_TABLE_REPLY:
9938 case OFPTYPE_NXT_RESUME:
9939 case OFPTYPE_IPFIX_BRIDGE_STATS_REQUEST:
9940 case OFPTYPE_IPFIX_BRIDGE_STATS_REPLY:
9941 case OFPTYPE_IPFIX_FLOW_STATS_REQUEST:
9942 case OFPTYPE_IPFIX_FLOW_STATS_REPLY:
9950 ofputil_decode_bundle_add(const struct ofp_header *oh,
9951 struct ofputil_bundle_add_msg *msg,
9952 enum ofptype *typep)
9954 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
9955 enum ofpraw raw = ofpraw_pull_assert(&b);
9956 ovs_assert(raw == OFPRAW_OFPT14_BUNDLE_ADD_MESSAGE
9957 || raw == OFPRAW_ONFT13_BUNDLE_ADD_MESSAGE);
9959 const struct ofp14_bundle_ctrl_msg *m = ofpbuf_pull(&b, sizeof *m);
9960 msg->bundle_id = ntohl(m->bundle_id);
9961 msg->flags = ntohs(m->flags);
9964 if (msg->msg->version != oh->version) {
9965 return OFPERR_OFPBFC_BAD_VERSION;
9967 size_t inner_len = ntohs(msg->msg->length);
9968 if (inner_len < sizeof(struct ofp_header) || inner_len > b.size) {
9969 return OFPERR_OFPBFC_MSG_BAD_LEN;
9971 if (msg->msg->xid != oh->xid) {
9972 return OFPERR_OFPBFC_MSG_BAD_XID;
9975 /* Reject unbundlable messages. */
9977 enum ofperr error = ofptype_decode(&type, msg->msg);
9979 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPT14_BUNDLE_ADD_MESSAGE contained "
9980 "message is unparsable (%s)", ofperr_get_name(error));
9981 return OFPERR_OFPBFC_MSG_UNSUP; /* 'error' would be confusing. */
9984 if (!ofputil_is_bundlable(type)) {
9985 VLOG_WARN_RL(&bad_ofmsg_rl, "%s message not allowed inside "
9986 "OFPT14_BUNDLE_ADD_MESSAGE", ofptype_get_name(type));
9987 return OFPERR_OFPBFC_MSG_UNSUP;
9997 ofputil_encode_bundle_add(enum ofp_version ofp_version,
9998 struct ofputil_bundle_add_msg *msg)
10000 struct ofpbuf *request;
10001 struct ofp14_bundle_ctrl_msg *m;
10003 /* Must use the same xid as the embedded message. */
10004 request = ofpraw_alloc_xid(ofp_version == OFP13_VERSION
10005 ? OFPRAW_ONFT13_BUNDLE_ADD_MESSAGE
10006 : OFPRAW_OFPT14_BUNDLE_ADD_MESSAGE, ofp_version,
10008 m = ofpbuf_put_zeros(request, sizeof *m);
10010 m->bundle_id = htonl(msg->bundle_id);
10011 m->flags = htons(msg->flags);
10012 ofpbuf_put(request, msg->msg, ntohs(msg->msg->length));
10018 encode_tlv_table_mappings(struct ofpbuf *b, struct ovs_list *mappings)
10020 struct ofputil_tlv_map *map;
10022 LIST_FOR_EACH (map, list_node, mappings) {
10023 struct nx_tlv_map *nx_map;
10025 nx_map = ofpbuf_put_zeros(b, sizeof *nx_map);
10026 nx_map->option_class = htons(map->option_class);
10027 nx_map->option_type = map->option_type;
10028 nx_map->option_len = map->option_len;
10029 nx_map->index = htons(map->index);
10034 ofputil_encode_tlv_table_mod(enum ofp_version ofp_version,
10035 struct ofputil_tlv_table_mod *ttm)
10038 struct nx_tlv_table_mod *nx_ttm;
10040 b = ofpraw_alloc(OFPRAW_NXT_TLV_TABLE_MOD, ofp_version, 0);
10041 nx_ttm = ofpbuf_put_zeros(b, sizeof *nx_ttm);
10042 nx_ttm->command = htons(ttm->command);
10043 encode_tlv_table_mappings(b, &ttm->mappings);
10049 decode_tlv_table_mappings(struct ofpbuf *msg, unsigned int max_fields,
10050 struct ovs_list *mappings)
10052 ovs_list_init(mappings);
10054 while (msg->size) {
10055 struct nx_tlv_map *nx_map;
10056 struct ofputil_tlv_map *map;
10058 nx_map = ofpbuf_pull(msg, sizeof *nx_map);
10059 map = xmalloc(sizeof *map);
10060 ovs_list_push_back(mappings, &map->list_node);
10062 map->option_class = ntohs(nx_map->option_class);
10063 map->option_type = nx_map->option_type;
10065 map->option_len = nx_map->option_len;
10066 if (map->option_len % 4 || map->option_len > TLV_MAX_OPT_SIZE) {
10067 VLOG_WARN_RL(&bad_ofmsg_rl,
10068 "tlv table option length (%u) is not a valid option size",
10070 ofputil_uninit_tlv_table(mappings);
10071 return OFPERR_NXTTMFC_BAD_OPT_LEN;
10074 map->index = ntohs(nx_map->index);
10075 if (map->index >= max_fields) {
10076 VLOG_WARN_RL(&bad_ofmsg_rl,
10077 "tlv table field index (%u) is too large (max %u)",
10078 map->index, max_fields - 1);
10079 ofputil_uninit_tlv_table(mappings);
10080 return OFPERR_NXTTMFC_BAD_FIELD_IDX;
10088 ofputil_decode_tlv_table_mod(const struct ofp_header *oh,
10089 struct ofputil_tlv_table_mod *ttm)
10091 struct ofpbuf msg = ofpbuf_const_initializer(oh, ntohs(oh->length));
10092 ofpraw_pull_assert(&msg);
10094 struct nx_tlv_table_mod *nx_ttm = ofpbuf_pull(&msg, sizeof *nx_ttm);
10095 ttm->command = ntohs(nx_ttm->command);
10096 if (ttm->command > NXTTMC_CLEAR) {
10097 VLOG_WARN_RL(&bad_ofmsg_rl,
10098 "tlv table mod command (%u) is out of range",
10100 return OFPERR_NXTTMFC_BAD_COMMAND;
10103 return decode_tlv_table_mappings(&msg, TUN_METADATA_NUM_OPTS,
10108 ofputil_encode_tlv_table_reply(const struct ofp_header *oh,
10109 struct ofputil_tlv_table_reply *ttr)
10112 struct nx_tlv_table_reply *nx_ttr;
10114 b = ofpraw_alloc_reply(OFPRAW_NXT_TLV_TABLE_REPLY, oh, 0);
10115 nx_ttr = ofpbuf_put_zeros(b, sizeof *nx_ttr);
10116 nx_ttr->max_option_space = htonl(ttr->max_option_space);
10117 nx_ttr->max_fields = htons(ttr->max_fields);
10119 encode_tlv_table_mappings(b, &ttr->mappings);
10124 /* Decodes the NXT_TLV_TABLE_REPLY message in 'oh' into '*ttr'. Returns 0
10125 * if successful, otherwise an ofperr.
10127 * The decoder verifies that the indexes in 'ttr->mappings' are less than
10128 * 'ttr->max_fields', but the caller must ensure, if necessary, that they are
10129 * less than TUN_METADATA_NUM_OPTS. */
10131 ofputil_decode_tlv_table_reply(const struct ofp_header *oh,
10132 struct ofputil_tlv_table_reply *ttr)
10134 struct ofpbuf msg = ofpbuf_const_initializer(oh, ntohs(oh->length));
10135 ofpraw_pull_assert(&msg);
10137 struct nx_tlv_table_reply *nx_ttr = ofpbuf_pull(&msg, sizeof *nx_ttr);
10138 ttr->max_option_space = ntohl(nx_ttr->max_option_space);
10139 ttr->max_fields = ntohs(nx_ttr->max_fields);
10141 return decode_tlv_table_mappings(&msg, ttr->max_fields, &ttr->mappings);
10145 ofputil_uninit_tlv_table(struct ovs_list *mappings)
10147 struct ofputil_tlv_map *map;
10149 LIST_FOR_EACH_POP (map, list_node, mappings) {
10155 ofputil_async_msg_type_to_string(enum ofputil_async_msg_type type)
10158 case OAM_PACKET_IN: return "PACKET_IN";
10159 case OAM_PORT_STATUS: return "PORT_STATUS";
10160 case OAM_FLOW_REMOVED: return "FLOW_REMOVED";
10161 case OAM_ROLE_STATUS: return "ROLE_STATUS";
10162 case OAM_TABLE_STATUS: return "TABLE_STATUS";
10163 case OAM_REQUESTFORWARD: return "REQUESTFORWARD";
10171 struct ofp14_async_prop {
10172 uint64_t prop_type;
10173 enum ofputil_async_msg_type oam;
10175 uint32_t allowed10, allowed14;
10178 #define AP_PAIR(SLAVE_PROP_TYPE, OAM, A10, A14) \
10179 { SLAVE_PROP_TYPE, OAM, false, A10, (A14) ? (A14) : (A10) }, \
10180 { (SLAVE_PROP_TYPE + 1), OAM, true, A10, (A14) ? (A14) : (A10) }
10182 static const struct ofp14_async_prop async_props[] = {
10183 AP_PAIR( 0, OAM_PACKET_IN, OFPR10_BITS, OFPR14_BITS),
10184 AP_PAIR( 2, OAM_PORT_STATUS, (1 << OFPPR_N_REASONS) - 1, 0),
10185 AP_PAIR( 4, OAM_FLOW_REMOVED, (1 << OVS_OFPRR_NONE) - 1, 0),
10186 AP_PAIR( 6, OAM_ROLE_STATUS, (1 << OFPCRR_N_REASONS) - 1, 0),
10187 AP_PAIR( 8, OAM_TABLE_STATUS, OFPTR_BITS, 0),
10188 AP_PAIR(10, OAM_REQUESTFORWARD, (1 << OFPRFR_N_REASONS) - 1, 0),
10191 #define FOR_EACH_ASYNC_PROP(VAR) \
10192 for (const struct ofp14_async_prop *VAR = async_props; \
10193 VAR < &async_props[ARRAY_SIZE(async_props)]; VAR++)
10195 static const struct ofp14_async_prop *
10196 get_ofp14_async_config_prop_by_prop_type(uint64_t prop_type)
10198 FOR_EACH_ASYNC_PROP (ap) {
10199 if (prop_type == ap->prop_type) {
10206 static const struct ofp14_async_prop *
10207 get_ofp14_async_config_prop_by_oam(enum ofputil_async_msg_type oam,
10210 FOR_EACH_ASYNC_PROP (ap) {
10211 if (ap->oam == oam && ap->master == master) {
10219 ofp14_async_prop_allowed(const struct ofp14_async_prop *prop,
10220 enum ofp_version version)
10222 return version >= OFP14_VERSION ? prop->allowed14 : prop->allowed10;
10226 encode_async_mask(const struct ofputil_async_cfg *src,
10227 const struct ofp14_async_prop *ap,
10228 enum ofp_version version)
10230 uint32_t mask = ap->master ? src->master[ap->oam] : src->slave[ap->oam];
10231 return htonl(mask & ofp14_async_prop_allowed(ap, version));
10235 decode_async_mask(ovs_be32 src,
10236 const struct ofp14_async_prop *ap, enum ofp_version version,
10237 bool loose, struct ofputil_async_cfg *dst)
10239 uint32_t mask = ntohl(src);
10240 uint32_t allowed = ofp14_async_prop_allowed(ap, version);
10241 if (mask & ~allowed) {
10242 OFPPROP_LOG(&bad_ofmsg_rl, loose,
10243 "bad value %#x for %s (allowed mask %#x)",
10244 mask, ofputil_async_msg_type_to_string(ap->oam),
10248 return OFPERR_OFPACFC_INVALID;
10252 if (ap->oam == OAM_PACKET_IN) {
10253 if (mask & (1u << OFPR_NO_MATCH)) {
10254 mask |= 1u << OFPR_EXPLICIT_MISS;
10255 if (version < OFP13_VERSION) {
10256 mask |= 1u << OFPR_IMPLICIT_MISS;
10261 uint32_t *array = ap->master ? dst->master : dst->slave;
10262 array[ap->oam] = mask;
10267 parse_async_tlv(const struct ofpbuf *property,
10268 const struct ofp14_async_prop *ap,
10269 struct ofputil_async_cfg *ac,
10270 enum ofp_version version, bool loose)
10275 error = ofpprop_parse_be32(property, &mask);
10280 if (ofpprop_is_experimenter(ap->prop_type)) {
10281 /* For experimenter properties, whether a property is for the master or
10282 * slave role is indicated by both 'type' and 'exp_type' in struct
10283 * ofp_prop_experimenter. Check that these are consistent. */
10284 const struct ofp_prop_experimenter *ope = property->data;
10285 bool should_be_master = ope->type == htons(0xffff);
10286 if (should_be_master != ap->master) {
10287 VLOG_WARN_RL(&bad_ofmsg_rl, "async property type %#"PRIx16" "
10288 "indicates %s role but exp_type %"PRIu32" indicates "
10291 should_be_master ? "master" : "slave",
10292 ntohl(ope->exp_type),
10293 ap->master ? "master" : "slave");
10294 return OFPERR_OFPBPC_BAD_EXP_TYPE;
10298 return decode_async_mask(mask, ap, version, loose, ac);
10302 decode_legacy_async_masks(const ovs_be32 masks[2],
10303 enum ofputil_async_msg_type oam,
10304 enum ofp_version version,
10305 struct ofputil_async_cfg *dst)
10307 for (int i = 0; i < 2; i++) {
10308 bool master = i == 0;
10309 const struct ofp14_async_prop *ap
10310 = get_ofp14_async_config_prop_by_oam(oam, master);
10311 decode_async_mask(masks[i], ap, version, true, dst);
10315 /* Decodes the OpenFlow "set async config" request and "get async config
10316 * reply" message in '*oh' into an abstract form in 'ac'.
10318 * Some versions of the "set async config" request change only some of the
10319 * settings and leave the others alone. This function uses 'basis' as the
10320 * initial state for decoding these. Other versions of the request change all
10321 * the settings; this function ignores 'basis' when decoding these.
10323 * If 'loose' is true, this function ignores properties and values that it does
10324 * not understand, as a controller would want to do when interpreting
10325 * capabilities provided by a switch. If 'loose' is false, this function
10326 * treats unknown properties and values as an error, as a switch would want to
10327 * do when interpreting a configuration request made by a controller.
10329 * Returns 0 if successful, otherwise an OFPERR_* value.
10331 * Returns error code OFPERR_OFPACFC_INVALID if the value of mask is not in
10332 * the valid range of mask.
10334 * Returns error code OFPERR_OFPACFC_UNSUPPORTED if the configuration is not
10337 ofputil_decode_set_async_config(const struct ofp_header *oh, bool loose,
10338 const struct ofputil_async_cfg *basis,
10339 struct ofputil_async_cfg *ac)
10341 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
10342 enum ofpraw raw = ofpraw_pull_assert(&b);
10344 if (raw == OFPRAW_OFPT13_SET_ASYNC ||
10345 raw == OFPRAW_NXT_SET_ASYNC_CONFIG ||
10346 raw == OFPRAW_OFPT13_GET_ASYNC_REPLY) {
10347 const struct nx_async_config *msg = ofpmsg_body(oh);
10349 *ac = OFPUTIL_ASYNC_CFG_INIT;
10350 decode_legacy_async_masks(msg->packet_in_mask, OAM_PACKET_IN,
10352 decode_legacy_async_masks(msg->port_status_mask, OAM_PORT_STATUS,
10354 decode_legacy_async_masks(msg->flow_removed_mask, OAM_FLOW_REMOVED,
10356 } else if (raw == OFPRAW_OFPT14_SET_ASYNC ||
10357 raw == OFPRAW_OFPT14_GET_ASYNC_REPLY ||
10358 raw == OFPRAW_NXT_SET_ASYNC_CONFIG2) {
10360 while (b.size > 0) {
10361 struct ofpbuf property;
10365 error = ofpprop_pull__(&b, &property, 8, 0xfffe, &type);
10370 const struct ofp14_async_prop *ap
10371 = get_ofp14_async_config_prop_by_prop_type(type);
10373 ? parse_async_tlv(&property, ap, ac, oh->version, loose)
10374 : OFPPROP_UNKNOWN(loose, "async config", type));
10376 /* Most messages use OFPBPC_BAD_TYPE but async has its own (who
10377 * knows why, it's OpenFlow. */
10378 if (error == OFPERR_OFPBPC_BAD_TYPE) {
10379 error = OFPERR_OFPACFC_UNSUPPORTED;
10385 return OFPERR_OFPBRC_BAD_VERSION;
10391 encode_legacy_async_masks(const struct ofputil_async_cfg *ac,
10392 enum ofputil_async_msg_type oam,
10393 enum ofp_version version,
10396 for (int i = 0; i < 2; i++) {
10397 bool master = i == 0;
10398 const struct ofp14_async_prop *ap
10399 = get_ofp14_async_config_prop_by_oam(oam, master);
10400 masks[i] = encode_async_mask(ac, ap, version);
10405 ofputil_put_async_config__(const struct ofputil_async_cfg *ac,
10406 struct ofpbuf *buf, bool tlv,
10407 enum ofp_version version, uint32_t oams)
10410 struct nx_async_config *msg = ofpbuf_put_zeros(buf, sizeof *msg);
10411 encode_legacy_async_masks(ac, OAM_PACKET_IN, version,
10412 msg->packet_in_mask);
10413 encode_legacy_async_masks(ac, OAM_PORT_STATUS, version,
10414 msg->port_status_mask);
10415 encode_legacy_async_masks(ac, OAM_FLOW_REMOVED, version,
10416 msg->flow_removed_mask);
10418 FOR_EACH_ASYNC_PROP (ap) {
10419 if (oams & (1u << ap->oam)) {
10420 size_t ofs = buf->size;
10421 ofpprop_put_be32(buf, ap->prop_type,
10422 encode_async_mask(ac, ap, version));
10424 /* For experimenter properties, we need to use type 0xfffe for
10425 * master and 0xffff for slaves. */
10426 if (ofpprop_is_experimenter(ap->prop_type)) {
10427 struct ofp_prop_experimenter *ope
10428 = ofpbuf_at_assert(buf, ofs, sizeof *ope);
10429 ope->type = ap->master ? htons(0xffff) : htons(0xfffe);
10436 /* Encodes and returns a reply to the OFPT_GET_ASYNC_REQUEST in 'oh' that
10437 * states that the asynchronous message configuration is 'ac'. */
10439 ofputil_encode_get_async_reply(const struct ofp_header *oh,
10440 const struct ofputil_async_cfg *ac)
10442 struct ofpbuf *buf;
10444 enum ofpraw raw = (oh->version < OFP14_VERSION
10445 ? OFPRAW_OFPT13_GET_ASYNC_REPLY
10446 : OFPRAW_OFPT14_GET_ASYNC_REPLY);
10447 struct ofpbuf *reply = ofpraw_alloc_reply(raw, oh, 0);
10448 ofputil_put_async_config__(ac, reply,
10449 raw == OFPRAW_OFPT14_GET_ASYNC_REPLY,
10450 oh->version, UINT32_MAX);
10456 /* Encodes and returns a message, in a format appropriate for OpenFlow version
10457 * 'ofp_version', that sets the asynchronous message configuration to 'ac'.
10459 * Specify 'oams' as a bitmap of OAM_* that indicate the asynchronous messages
10460 * to configure. OF1.0 through OF1.3 can't natively configure a subset of
10461 * messages, so more messages than requested may be configured. OF1.0 through
10462 * OF1.3 also can't configure OVS extension OAM_* values, so if 'oam' includes
10463 * any extensions then this function encodes an Open vSwitch extension message
10464 * that does support configuring OVS extension OAM_*. */
10466 ofputil_encode_set_async_config(const struct ofputil_async_cfg *ac,
10467 uint32_t oams, enum ofp_version ofp_version)
10469 enum ofpraw raw = (ofp_version >= OFP14_VERSION ? OFPRAW_OFPT14_SET_ASYNC
10470 : oams & OAM_EXTENSIONS ? OFPRAW_NXT_SET_ASYNC_CONFIG2
10471 : ofp_version >= OFP13_VERSION ? OFPRAW_OFPT13_SET_ASYNC
10472 : OFPRAW_NXT_SET_ASYNC_CONFIG);
10473 struct ofpbuf *request = ofpraw_alloc(raw, ofp_version, 0);
10474 ofputil_put_async_config__(ac, request,
10475 (raw == OFPRAW_OFPT14_SET_ASYNC ||
10476 raw == OFPRAW_NXT_SET_ASYNC_CONFIG2),
10477 ofp_version, oams);
10481 struct ofputil_async_cfg
10482 ofputil_async_cfg_default(enum ofp_version version)
10484 /* We enable all of the OF1.4 reasons regardless of 'version' because the
10485 * reasons added in OF1.4 just are just refinements of the OFPR_ACTION
10486 * introduced in OF1.0, breaking it into more specific categories. When we
10487 * encode these for earlier OpenFlow versions, we translate them into
10489 uint32_t pin = OFPR14_BITS & ~(1u << OFPR_INVALID_TTL);
10490 pin |= 1u << OFPR_EXPLICIT_MISS;
10491 if (version <= OFP12_VERSION) {
10492 pin |= 1u << OFPR_IMPLICIT_MISS;
10495 return (struct ofputil_async_cfg) {
10496 .master[OAM_PACKET_IN] = pin,
10498 .master[OAM_FLOW_REMOVED]
10499 = (version >= OFP14_VERSION ? OFPRR14_BITS : OFPRR10_BITS),
10501 .master[OAM_PORT_STATUS] = OFPPR_BITS,
10502 .slave[OAM_PORT_STATUS] = OFPPR_BITS,
10507 ofputil_put_ofp14_table_desc(const struct ofputil_table_desc *td,
10508 struct ofpbuf *b, enum ofp_version version)
10510 struct ofp14_table_desc *otd;
10511 struct ofp14_table_mod_prop_vacancy *otv;
10514 start_otd = b->size;
10515 ofpbuf_put_zeros(b, sizeof *otd);
10517 ofpprop_put_u32(b, OFPTMPT14_EVICTION, td->eviction_flags);
10519 otv = ofpbuf_put_zeros(b, sizeof *otv);
10520 otv->type = htons(OFPTMPT14_VACANCY);
10521 otv->length = htons(sizeof *otv);
10522 otv->vacancy_down = td->table_vacancy.vacancy_down;
10523 otv->vacancy_up = td->table_vacancy.vacancy_up;
10524 otv->vacancy = td->table_vacancy.vacancy;
10526 otd = ofpbuf_at_assert(b, start_otd, sizeof *otd);
10527 otd->length = htons(b->size - start_otd);
10528 otd->table_id = td->table_id;
10529 otd->config = ofputil_encode_table_config(OFPUTIL_TABLE_MISS_DEFAULT,
10530 td->eviction, td->vacancy,
10534 /* Converts the abstract form of a "table status" message in '*ts' into an
10535 * OpenFlow message suitable for 'protocol', and returns that encoded form in
10536 * a buffer owned by the caller. */
10538 ofputil_encode_table_status(const struct ofputil_table_status *ts,
10539 enum ofputil_protocol protocol)
10541 enum ofp_version version;
10544 version = ofputil_protocol_to_ofp_version(protocol);
10545 if (version >= OFP14_VERSION) {
10547 struct ofp14_table_status *ots;
10549 raw = OFPRAW_OFPT14_TABLE_STATUS;
10550 b = ofpraw_alloc_xid(raw, version, htonl(0), 0);
10551 ots = ofpbuf_put_zeros(b, sizeof *ots);
10552 ots->reason = ts->reason;
10553 ofputil_put_ofp14_table_desc(&ts->desc, b, version);
10554 ofpmsg_update_length(b);
10561 /* Decodes the OpenFlow "table status" message in '*ots' into an abstract form
10562 * in '*ts'. Returns 0 if successful, otherwise an OFPERR_* value. */
10564 ofputil_decode_table_status(const struct ofp_header *oh,
10565 struct ofputil_table_status *ts)
10567 const struct ofp14_table_status *ots;
10572 ofpbuf_use_const(&b, oh, ntohs(oh->length));
10573 raw = ofpraw_pull_assert(&b);
10574 ots = ofpbuf_pull(&b, sizeof *ots);
10576 if (raw == OFPRAW_OFPT14_TABLE_STATUS) {
10577 if (ots->reason != OFPTR_VACANCY_DOWN
10578 && ots->reason != OFPTR_VACANCY_UP) {
10579 return OFPERR_OFPBPC_BAD_VALUE;
10581 ts->reason = ots->reason;
10583 error = ofputil_decode_table_desc(&b, &ts->desc, oh->version);
10586 return OFPERR_OFPBRC_BAD_VERSION;