2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 #include "ofp-print.h"
22 #include <sys/types.h>
23 #include <netinet/in.h>
24 #include <netinet/icmp6.h>
27 #include "byte-order.h"
28 #include "classifier.h"
29 #include "dynamic-string.h"
31 #include "meta-flow.h"
32 #include "multipath.h"
36 #include "ofp-actions.h"
37 #include "ofp-errors.h"
41 #include "openflow/netronome-ext.h"
44 #include "tun-metadata.h"
45 #include "unaligned.h"
46 #include "type-props.h"
47 #include "openvswitch/vlog.h"
50 VLOG_DEFINE_THIS_MODULE(ofp_util);
52 /* Rate limit for OpenFlow message parse errors. These always indicate a bug
53 * in the peer and so there's not much point in showing a lot of them. */
54 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
56 static enum ofputil_table_eviction ofputil_decode_table_eviction(
57 ovs_be32 config, enum ofp_version);
58 static ovs_be32 ofputil_encode_table_config(enum ofputil_table_miss,
59 enum ofputil_table_eviction,
62 struct ofp_prop_header {
67 struct ofp_prop_experimenter {
68 ovs_be16 type; /* OFP*_EXPERIMENTER. */
69 ovs_be16 length; /* Length in bytes of this property. */
70 ovs_be32 experimenter; /* Experimenter ID which takes the same form as
71 * in struct ofp_experimenter_header. */
72 ovs_be32 exp_type; /* Experimenter defined. */
75 /* Pulls a property, beginning with struct ofp_prop_header, from the beginning
76 * of 'msg'. Stores the type of the property in '*typep' and, if 'property' is
77 * nonnull, the entire property, including the header, in '*property'. Returns
78 * 0 if successful, otherwise an error code.
80 * This function pulls the property's stated size padded out to a multiple of
81 * 'alignment' bytes. The common case in OpenFlow is an 'alignment' of 8, so
82 * you can use ofputil_pull_property() for that case. */
84 ofputil_pull_property__(struct ofpbuf *msg, struct ofpbuf *property,
85 unsigned int alignment, uint16_t *typep)
87 struct ofp_prop_header *oph;
88 unsigned int padded_len;
91 if (msg->size < sizeof *oph) {
92 return OFPERR_OFPBPC_BAD_LEN;
96 len = ntohs(oph->len);
97 padded_len = ROUND_UP(len, alignment);
98 if (len < sizeof *oph || padded_len > msg->size) {
99 return OFPERR_OFPBPC_BAD_LEN;
102 *typep = ntohs(oph->type);
104 ofpbuf_use_const(property, msg->data, len);
106 ofpbuf_pull(msg, padded_len);
110 /* Pulls a property, beginning with struct ofp_prop_header, from the beginning
111 * of 'msg'. Stores the type of the property in '*typep' and, if 'property' is
112 * nonnull, the entire property, including the header, in '*property'. Returns
113 * 0 if successful, otherwise an error code.
115 * This function pulls the property's stated size padded out to a multiple of
116 * 8 bytes, which is the common case for OpenFlow properties. */
118 ofputil_pull_property(struct ofpbuf *msg, struct ofpbuf *property,
121 return ofputil_pull_property__(msg, property, 8, typep);
124 static void OVS_PRINTF_FORMAT(2, 3)
125 log_property(bool loose, const char *message, ...)
127 enum vlog_level level = loose ? VLL_DBG : VLL_WARN;
128 if (!vlog_should_drop(THIS_MODULE, level, &bad_ofmsg_rl)) {
131 va_start(args, message);
132 vlog_valist(THIS_MODULE, level, message, args);
138 start_property(struct ofpbuf *msg, uint16_t type)
140 size_t start_ofs = msg->size;
141 struct ofp_prop_header *oph;
143 oph = ofpbuf_put_uninit(msg, sizeof *oph);
144 oph->type = htons(type);
145 oph->len = htons(4); /* May be updated later by end_property(). */
150 end_property(struct ofpbuf *msg, size_t start_ofs)
152 struct ofp_prop_header *oph;
154 oph = ofpbuf_at_assert(msg, start_ofs, sizeof *oph);
155 oph->len = htons(msg->size - start_ofs);
156 ofpbuf_padto(msg, ROUND_UP(msg->size, 8));
160 put_bitmap_properties(struct ofpbuf *msg, uint64_t bitmap)
162 for (; bitmap; bitmap = zero_rightmost_1bit(bitmap)) {
163 start_property(msg, rightmost_1bit_idx(bitmap));
167 /* Given the wildcard bit count in the least-significant 6 of 'wcbits', returns
168 * an IP netmask with a 1 in each bit that must match and a 0 in each bit that
171 * The bits in 'wcbits' are in the format used in enum ofp_flow_wildcards: 0
172 * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
173 * ..., 32 and higher wildcard the entire field. This is the *opposite* of the
174 * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
177 ofputil_wcbits_to_netmask(int wcbits)
180 return wcbits < 32 ? htonl(~((1u << wcbits) - 1)) : 0;
183 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
184 * that it wildcards, that is, the number of 0-bits in 'netmask', a number
185 * between 0 and 32 inclusive.
187 * If 'netmask' is not a CIDR netmask (see ip_is_cidr()), the return value will
188 * still be in the valid range but isn't otherwise meaningful. */
190 ofputil_netmask_to_wcbits(ovs_be32 netmask)
192 return 32 - ip_count_cidr_bits(netmask);
195 /* Converts the OpenFlow 1.0 wildcards in 'ofpfw' (OFPFW10_*) into a
196 * flow_wildcards in 'wc' for use in struct match. It is the caller's
197 * responsibility to handle the special case where the flow match's dl_vlan is
198 * set to OFP_VLAN_NONE. */
200 ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *wc)
202 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 34);
204 /* Initialize most of wc. */
205 flow_wildcards_init_catchall(wc);
207 if (!(ofpfw & OFPFW10_IN_PORT)) {
208 wc->masks.in_port.ofp_port = u16_to_ofp(UINT16_MAX);
211 if (!(ofpfw & OFPFW10_NW_TOS)) {
212 wc->masks.nw_tos |= IP_DSCP_MASK;
215 if (!(ofpfw & OFPFW10_NW_PROTO)) {
216 wc->masks.nw_proto = UINT8_MAX;
218 wc->masks.nw_src = ofputil_wcbits_to_netmask(ofpfw
219 >> OFPFW10_NW_SRC_SHIFT);
220 wc->masks.nw_dst = ofputil_wcbits_to_netmask(ofpfw
221 >> OFPFW10_NW_DST_SHIFT);
223 if (!(ofpfw & OFPFW10_TP_SRC)) {
224 wc->masks.tp_src = OVS_BE16_MAX;
226 if (!(ofpfw & OFPFW10_TP_DST)) {
227 wc->masks.tp_dst = OVS_BE16_MAX;
230 if (!(ofpfw & OFPFW10_DL_SRC)) {
231 WC_MASK_FIELD(wc, dl_src);
233 if (!(ofpfw & OFPFW10_DL_DST)) {
234 WC_MASK_FIELD(wc, dl_dst);
236 if (!(ofpfw & OFPFW10_DL_TYPE)) {
237 wc->masks.dl_type = OVS_BE16_MAX;
241 if (!(ofpfw & OFPFW10_DL_VLAN_PCP)) {
242 wc->masks.vlan_tci |= htons(VLAN_PCP_MASK | VLAN_CFI);
244 if (!(ofpfw & OFPFW10_DL_VLAN)) {
245 wc->masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
249 /* Converts the ofp10_match in 'ofmatch' into a struct match in 'match'. */
251 ofputil_match_from_ofp10_match(const struct ofp10_match *ofmatch,
254 uint32_t ofpfw = ntohl(ofmatch->wildcards) & OFPFW10_ALL;
256 /* Initialize match->wc. */
257 memset(&match->flow, 0, sizeof match->flow);
258 ofputil_wildcard_from_ofpfw10(ofpfw, &match->wc);
260 /* Initialize most of match->flow. */
261 match->flow.nw_src = ofmatch->nw_src;
262 match->flow.nw_dst = ofmatch->nw_dst;
263 match->flow.in_port.ofp_port = u16_to_ofp(ntohs(ofmatch->in_port));
264 match->flow.dl_type = ofputil_dl_type_from_openflow(ofmatch->dl_type);
265 match->flow.tp_src = ofmatch->tp_src;
266 match->flow.tp_dst = ofmatch->tp_dst;
267 match->flow.dl_src = ofmatch->dl_src;
268 match->flow.dl_dst = ofmatch->dl_dst;
269 match->flow.nw_tos = ofmatch->nw_tos & IP_DSCP_MASK;
270 match->flow.nw_proto = ofmatch->nw_proto;
272 /* Translate VLANs. */
273 if (!(ofpfw & OFPFW10_DL_VLAN) &&
274 ofmatch->dl_vlan == htons(OFP10_VLAN_NONE)) {
275 /* Match only packets without 802.1Q header.
277 * When OFPFW10_DL_VLAN_PCP is wildcarded, this is obviously correct.
279 * If OFPFW10_DL_VLAN_PCP is matched, the flow match is contradictory,
280 * because we can't have a specific PCP without an 802.1Q header.
281 * However, older versions of OVS treated this as matching packets
282 * withut an 802.1Q header, so we do here too. */
283 match->flow.vlan_tci = htons(0);
284 match->wc.masks.vlan_tci = htons(0xffff);
286 ovs_be16 vid, pcp, tci;
289 vid = ofmatch->dl_vlan & htons(VLAN_VID_MASK);
290 hpcp = (ofmatch->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK;
292 tci = vid | pcp | htons(VLAN_CFI);
293 match->flow.vlan_tci = tci & match->wc.masks.vlan_tci;
297 match_zero_wildcarded_fields(match);
300 /* Convert 'match' into the OpenFlow 1.0 match structure 'ofmatch'. */
302 ofputil_match_to_ofp10_match(const struct match *match,
303 struct ofp10_match *ofmatch)
305 const struct flow_wildcards *wc = &match->wc;
308 /* Figure out most OpenFlow wildcards. */
310 if (!wc->masks.in_port.ofp_port) {
311 ofpfw |= OFPFW10_IN_PORT;
313 if (!wc->masks.dl_type) {
314 ofpfw |= OFPFW10_DL_TYPE;
316 if (!wc->masks.nw_proto) {
317 ofpfw |= OFPFW10_NW_PROTO;
319 ofpfw |= (ofputil_netmask_to_wcbits(wc->masks.nw_src)
320 << OFPFW10_NW_SRC_SHIFT);
321 ofpfw |= (ofputil_netmask_to_wcbits(wc->masks.nw_dst)
322 << OFPFW10_NW_DST_SHIFT);
323 if (!(wc->masks.nw_tos & IP_DSCP_MASK)) {
324 ofpfw |= OFPFW10_NW_TOS;
326 if (!wc->masks.tp_src) {
327 ofpfw |= OFPFW10_TP_SRC;
329 if (!wc->masks.tp_dst) {
330 ofpfw |= OFPFW10_TP_DST;
332 if (eth_addr_is_zero(wc->masks.dl_src)) {
333 ofpfw |= OFPFW10_DL_SRC;
335 if (eth_addr_is_zero(wc->masks.dl_dst)) {
336 ofpfw |= OFPFW10_DL_DST;
339 /* Translate VLANs. */
340 ofmatch->dl_vlan = htons(0);
341 ofmatch->dl_vlan_pcp = 0;
342 if (match->wc.masks.vlan_tci == htons(0)) {
343 ofpfw |= OFPFW10_DL_VLAN | OFPFW10_DL_VLAN_PCP;
344 } else if (match->wc.masks.vlan_tci & htons(VLAN_CFI)
345 && !(match->flow.vlan_tci & htons(VLAN_CFI))) {
346 ofmatch->dl_vlan = htons(OFP10_VLAN_NONE);
348 if (!(match->wc.masks.vlan_tci & htons(VLAN_VID_MASK))) {
349 ofpfw |= OFPFW10_DL_VLAN;
351 ofmatch->dl_vlan = htons(vlan_tci_to_vid(match->flow.vlan_tci));
354 if (!(match->wc.masks.vlan_tci & htons(VLAN_PCP_MASK))) {
355 ofpfw |= OFPFW10_DL_VLAN_PCP;
357 ofmatch->dl_vlan_pcp = vlan_tci_to_pcp(match->flow.vlan_tci);
361 /* Compose most of the match structure. */
362 ofmatch->wildcards = htonl(ofpfw);
363 ofmatch->in_port = htons(ofp_to_u16(match->flow.in_port.ofp_port));
364 ofmatch->dl_src = match->flow.dl_src;
365 ofmatch->dl_dst = match->flow.dl_dst;
366 ofmatch->dl_type = ofputil_dl_type_to_openflow(match->flow.dl_type);
367 ofmatch->nw_src = match->flow.nw_src;
368 ofmatch->nw_dst = match->flow.nw_dst;
369 ofmatch->nw_tos = match->flow.nw_tos & IP_DSCP_MASK;
370 ofmatch->nw_proto = match->flow.nw_proto;
371 ofmatch->tp_src = match->flow.tp_src;
372 ofmatch->tp_dst = match->flow.tp_dst;
373 memset(ofmatch->pad1, '\0', sizeof ofmatch->pad1);
374 memset(ofmatch->pad2, '\0', sizeof ofmatch->pad2);
378 ofputil_pull_ofp11_match(struct ofpbuf *buf, struct match *match,
379 uint16_t *padded_match_len)
381 struct ofp11_match_header *omh = buf->data;
384 if (buf->size < sizeof *omh) {
385 return OFPERR_OFPBMC_BAD_LEN;
388 match_len = ntohs(omh->length);
390 switch (ntohs(omh->type)) {
391 case OFPMT_STANDARD: {
392 struct ofp11_match *om;
394 if (match_len != sizeof *om || buf->size < sizeof *om) {
395 return OFPERR_OFPBMC_BAD_LEN;
397 om = ofpbuf_pull(buf, sizeof *om);
398 if (padded_match_len) {
399 *padded_match_len = match_len;
401 return ofputil_match_from_ofp11_match(om, match);
405 if (padded_match_len) {
406 *padded_match_len = ROUND_UP(match_len, 8);
408 return oxm_pull_match(buf, match);
411 return OFPERR_OFPBMC_BAD_TYPE;
415 /* Converts the ofp11_match in 'ofmatch' into a struct match in 'match'.
416 * Returns 0 if successful, otherwise an OFPERR_* value. */
418 ofputil_match_from_ofp11_match(const struct ofp11_match *ofmatch,
421 uint16_t wc = ntohl(ofmatch->wildcards);
422 bool ipv4, arp, rarp;
424 match_init_catchall(match);
426 if (!(wc & OFPFW11_IN_PORT)) {
430 error = ofputil_port_from_ofp11(ofmatch->in_port, &ofp_port);
432 return OFPERR_OFPBMC_BAD_VALUE;
434 match_set_in_port(match, ofp_port);
437 match_set_dl_src_masked(match, ofmatch->dl_src,
438 eth_addr_invert(ofmatch->dl_src_mask));
439 match_set_dl_dst_masked(match, ofmatch->dl_dst,
440 eth_addr_invert(ofmatch->dl_dst_mask));
442 if (!(wc & OFPFW11_DL_VLAN)) {
443 if (ofmatch->dl_vlan == htons(OFPVID11_NONE)) {
444 /* Match only packets without a VLAN tag. */
445 match->flow.vlan_tci = htons(0);
446 match->wc.masks.vlan_tci = OVS_BE16_MAX;
448 if (ofmatch->dl_vlan == htons(OFPVID11_ANY)) {
449 /* Match any packet with a VLAN tag regardless of VID. */
450 match->flow.vlan_tci = htons(VLAN_CFI);
451 match->wc.masks.vlan_tci = htons(VLAN_CFI);
452 } else if (ntohs(ofmatch->dl_vlan) < 4096) {
453 /* Match only packets with the specified VLAN VID. */
454 match->flow.vlan_tci = htons(VLAN_CFI) | ofmatch->dl_vlan;
455 match->wc.masks.vlan_tci = htons(VLAN_CFI | VLAN_VID_MASK);
458 return OFPERR_OFPBMC_BAD_VALUE;
461 if (!(wc & OFPFW11_DL_VLAN_PCP)) {
462 if (ofmatch->dl_vlan_pcp <= 7) {
463 match->flow.vlan_tci |= htons(ofmatch->dl_vlan_pcp
465 match->wc.masks.vlan_tci |= htons(VLAN_PCP_MASK);
468 return OFPERR_OFPBMC_BAD_VALUE;
474 if (!(wc & OFPFW11_DL_TYPE)) {
475 match_set_dl_type(match,
476 ofputil_dl_type_from_openflow(ofmatch->dl_type));
479 ipv4 = match->flow.dl_type == htons(ETH_TYPE_IP);
480 arp = match->flow.dl_type == htons(ETH_TYPE_ARP);
481 rarp = match->flow.dl_type == htons(ETH_TYPE_RARP);
483 if (ipv4 && !(wc & OFPFW11_NW_TOS)) {
484 if (ofmatch->nw_tos & ~IP_DSCP_MASK) {
486 return OFPERR_OFPBMC_BAD_VALUE;
489 match_set_nw_dscp(match, ofmatch->nw_tos);
492 if (ipv4 || arp || rarp) {
493 if (!(wc & OFPFW11_NW_PROTO)) {
494 match_set_nw_proto(match, ofmatch->nw_proto);
496 match_set_nw_src_masked(match, ofmatch->nw_src, ~ofmatch->nw_src_mask);
497 match_set_nw_dst_masked(match, ofmatch->nw_dst, ~ofmatch->nw_dst_mask);
500 #define OFPFW11_TP_ALL (OFPFW11_TP_SRC | OFPFW11_TP_DST)
501 if (ipv4 && (wc & OFPFW11_TP_ALL) != OFPFW11_TP_ALL) {
502 switch (match->flow.nw_proto) {
504 /* "A.2.3 Flow Match Structures" in OF1.1 says:
506 * The tp_src and tp_dst fields will be ignored unless the
507 * network protocol specified is as TCP, UDP or SCTP.
509 * but I'm pretty sure we should support ICMP too, otherwise
510 * that's a regression from OF1.0. */
511 if (!(wc & OFPFW11_TP_SRC)) {
512 uint16_t icmp_type = ntohs(ofmatch->tp_src);
513 if (icmp_type < 0x100) {
514 match_set_icmp_type(match, icmp_type);
516 return OFPERR_OFPBMC_BAD_FIELD;
519 if (!(wc & OFPFW11_TP_DST)) {
520 uint16_t icmp_code = ntohs(ofmatch->tp_dst);
521 if (icmp_code < 0x100) {
522 match_set_icmp_code(match, icmp_code);
524 return OFPERR_OFPBMC_BAD_FIELD;
532 if (!(wc & (OFPFW11_TP_SRC))) {
533 match_set_tp_src(match, ofmatch->tp_src);
535 if (!(wc & (OFPFW11_TP_DST))) {
536 match_set_tp_dst(match, ofmatch->tp_dst);
541 /* OF1.1 says explicitly to ignore this. */
546 if (eth_type_mpls(match->flow.dl_type)) {
547 if (!(wc & OFPFW11_MPLS_LABEL)) {
548 match_set_mpls_label(match, 0, ofmatch->mpls_label);
550 if (!(wc & OFPFW11_MPLS_TC)) {
551 match_set_mpls_tc(match, 0, ofmatch->mpls_tc);
555 match_set_metadata_masked(match, ofmatch->metadata,
556 ~ofmatch->metadata_mask);
561 /* Convert 'match' into the OpenFlow 1.1 match structure 'ofmatch'. */
563 ofputil_match_to_ofp11_match(const struct match *match,
564 struct ofp11_match *ofmatch)
568 memset(ofmatch, 0, sizeof *ofmatch);
569 ofmatch->omh.type = htons(OFPMT_STANDARD);
570 ofmatch->omh.length = htons(OFPMT11_STANDARD_LENGTH);
572 if (!match->wc.masks.in_port.ofp_port) {
573 wc |= OFPFW11_IN_PORT;
575 ofmatch->in_port = ofputil_port_to_ofp11(match->flow.in_port.ofp_port);
578 ofmatch->dl_src = match->flow.dl_src;
579 ofmatch->dl_src_mask = eth_addr_invert(match->wc.masks.dl_src);
580 ofmatch->dl_dst = match->flow.dl_dst;
581 ofmatch->dl_dst_mask = eth_addr_invert(match->wc.masks.dl_dst);
583 if (match->wc.masks.vlan_tci == htons(0)) {
584 wc |= OFPFW11_DL_VLAN | OFPFW11_DL_VLAN_PCP;
585 } else if (match->wc.masks.vlan_tci & htons(VLAN_CFI)
586 && !(match->flow.vlan_tci & htons(VLAN_CFI))) {
587 ofmatch->dl_vlan = htons(OFPVID11_NONE);
588 wc |= OFPFW11_DL_VLAN_PCP;
590 if (!(match->wc.masks.vlan_tci & htons(VLAN_VID_MASK))) {
591 ofmatch->dl_vlan = htons(OFPVID11_ANY);
593 ofmatch->dl_vlan = htons(vlan_tci_to_vid(match->flow.vlan_tci));
596 if (!(match->wc.masks.vlan_tci & htons(VLAN_PCP_MASK))) {
597 wc |= OFPFW11_DL_VLAN_PCP;
599 ofmatch->dl_vlan_pcp = vlan_tci_to_pcp(match->flow.vlan_tci);
603 if (!match->wc.masks.dl_type) {
604 wc |= OFPFW11_DL_TYPE;
606 ofmatch->dl_type = ofputil_dl_type_to_openflow(match->flow.dl_type);
609 if (!(match->wc.masks.nw_tos & IP_DSCP_MASK)) {
610 wc |= OFPFW11_NW_TOS;
612 ofmatch->nw_tos = match->flow.nw_tos & IP_DSCP_MASK;
615 if (!match->wc.masks.nw_proto) {
616 wc |= OFPFW11_NW_PROTO;
618 ofmatch->nw_proto = match->flow.nw_proto;
621 ofmatch->nw_src = match->flow.nw_src;
622 ofmatch->nw_src_mask = ~match->wc.masks.nw_src;
623 ofmatch->nw_dst = match->flow.nw_dst;
624 ofmatch->nw_dst_mask = ~match->wc.masks.nw_dst;
626 if (!match->wc.masks.tp_src) {
627 wc |= OFPFW11_TP_SRC;
629 ofmatch->tp_src = match->flow.tp_src;
632 if (!match->wc.masks.tp_dst) {
633 wc |= OFPFW11_TP_DST;
635 ofmatch->tp_dst = match->flow.tp_dst;
638 if (!(match->wc.masks.mpls_lse[0] & htonl(MPLS_LABEL_MASK))) {
639 wc |= OFPFW11_MPLS_LABEL;
641 ofmatch->mpls_label = htonl(mpls_lse_to_label(
642 match->flow.mpls_lse[0]));
645 if (!(match->wc.masks.mpls_lse[0] & htonl(MPLS_TC_MASK))) {
646 wc |= OFPFW11_MPLS_TC;
648 ofmatch->mpls_tc = mpls_lse_to_tc(match->flow.mpls_lse[0]);
651 ofmatch->metadata = match->flow.metadata;
652 ofmatch->metadata_mask = ~match->wc.masks.metadata;
654 ofmatch->wildcards = htonl(wc);
657 /* Returns the "typical" length of a match for 'protocol', for use in
658 * estimating space to preallocate. */
660 ofputil_match_typical_len(enum ofputil_protocol protocol)
663 case OFPUTIL_P_OF10_STD:
664 case OFPUTIL_P_OF10_STD_TID:
665 return sizeof(struct ofp10_match);
667 case OFPUTIL_P_OF10_NXM:
668 case OFPUTIL_P_OF10_NXM_TID:
669 return NXM_TYPICAL_LEN;
671 case OFPUTIL_P_OF11_STD:
672 return sizeof(struct ofp11_match);
674 case OFPUTIL_P_OF12_OXM:
675 case OFPUTIL_P_OF13_OXM:
676 case OFPUTIL_P_OF14_OXM:
677 case OFPUTIL_P_OF15_OXM:
678 return NXM_TYPICAL_LEN;
685 /* Appends to 'b' an struct ofp11_match_header followed by a match that
686 * expresses 'match' properly for 'protocol', plus enough zero bytes to pad the
687 * data appended out to a multiple of 8. 'protocol' must be one that is usable
688 * in OpenFlow 1.1 or later.
690 * This function can cause 'b''s data to be reallocated.
692 * Returns the number of bytes appended to 'b', excluding the padding. Never
695 ofputil_put_ofp11_match(struct ofpbuf *b, const struct match *match,
696 enum ofputil_protocol protocol)
699 case OFPUTIL_P_OF10_STD:
700 case OFPUTIL_P_OF10_STD_TID:
701 case OFPUTIL_P_OF10_NXM:
702 case OFPUTIL_P_OF10_NXM_TID:
705 case OFPUTIL_P_OF11_STD: {
706 struct ofp11_match *om;
708 /* Make sure that no padding is needed. */
709 BUILD_ASSERT_DECL(sizeof *om % 8 == 0);
711 om = ofpbuf_put_uninit(b, sizeof *om);
712 ofputil_match_to_ofp11_match(match, om);
716 case OFPUTIL_P_OF12_OXM:
717 case OFPUTIL_P_OF13_OXM:
718 case OFPUTIL_P_OF14_OXM:
719 case OFPUTIL_P_OF15_OXM:
720 return oxm_put_match(b, match,
721 ofputil_protocol_to_ofp_version(protocol));
727 /* Given a 'dl_type' value in the format used in struct flow, returns the
728 * corresponding 'dl_type' value for use in an ofp10_match or ofp11_match
731 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type)
733 return (flow_dl_type == htons(FLOW_DL_TYPE_NONE)
734 ? htons(OFP_DL_TYPE_NOT_ETH_TYPE)
738 /* Given a 'dl_type' value in the format used in an ofp10_match or ofp11_match
739 * structure, returns the corresponding 'dl_type' value for use in struct
742 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type)
744 return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
745 ? htons(FLOW_DL_TYPE_NONE)
751 struct proto_abbrev {
752 enum ofputil_protocol protocol;
756 /* Most users really don't care about some of the differences between
757 * protocols. These abbreviations help with that. */
758 static const struct proto_abbrev proto_abbrevs[] = {
759 { OFPUTIL_P_ANY, "any" },
760 { OFPUTIL_P_OF10_STD_ANY, "OpenFlow10" },
761 { OFPUTIL_P_OF10_NXM_ANY, "NXM" },
762 { OFPUTIL_P_ANY_OXM, "OXM" },
764 #define N_PROTO_ABBREVS ARRAY_SIZE(proto_abbrevs)
766 enum ofputil_protocol ofputil_flow_dump_protocols[] = {
775 size_t ofputil_n_flow_dump_protocols = ARRAY_SIZE(ofputil_flow_dump_protocols);
777 /* Returns the set of ofputil_protocols that are supported with the given
778 * OpenFlow 'version'. 'version' should normally be an 8-bit OpenFlow version
779 * identifier (e.g. 0x01 for OpenFlow 1.0, 0x02 for OpenFlow 1.1). Returns 0
780 * if 'version' is not supported or outside the valid range. */
781 enum ofputil_protocol
782 ofputil_protocols_from_ofp_version(enum ofp_version version)
786 return OFPUTIL_P_OF10_STD_ANY | OFPUTIL_P_OF10_NXM_ANY;
788 return OFPUTIL_P_OF11_STD;
790 return OFPUTIL_P_OF12_OXM;
792 return OFPUTIL_P_OF13_OXM;
794 return OFPUTIL_P_OF14_OXM;
796 return OFPUTIL_P_OF15_OXM;
802 /* Returns the ofputil_protocol that is initially in effect on an OpenFlow
803 * connection that has negotiated the given 'version'. 'version' should
804 * normally be an 8-bit OpenFlow version identifier (e.g. 0x01 for OpenFlow
805 * 1.0, 0x02 for OpenFlow 1.1). Returns 0 if 'version' is not supported or
806 * outside the valid range. */
807 enum ofputil_protocol
808 ofputil_protocol_from_ofp_version(enum ofp_version version)
810 return rightmost_1bit(ofputil_protocols_from_ofp_version(version));
813 /* Returns the OpenFlow protocol version number (e.g. OFP10_VERSION,
814 * etc.) that corresponds to 'protocol'. */
816 ofputil_protocol_to_ofp_version(enum ofputil_protocol protocol)
819 case OFPUTIL_P_OF10_STD:
820 case OFPUTIL_P_OF10_STD_TID:
821 case OFPUTIL_P_OF10_NXM:
822 case OFPUTIL_P_OF10_NXM_TID:
823 return OFP10_VERSION;
824 case OFPUTIL_P_OF11_STD:
825 return OFP11_VERSION;
826 case OFPUTIL_P_OF12_OXM:
827 return OFP12_VERSION;
828 case OFPUTIL_P_OF13_OXM:
829 return OFP13_VERSION;
830 case OFPUTIL_P_OF14_OXM:
831 return OFP14_VERSION;
832 case OFPUTIL_P_OF15_OXM:
833 return OFP15_VERSION;
839 /* Returns a bitmap of OpenFlow versions that are supported by at
840 * least one of the 'protocols'. */
842 ofputil_protocols_to_version_bitmap(enum ofputil_protocol protocols)
846 for (; protocols; protocols = zero_rightmost_1bit(protocols)) {
847 enum ofputil_protocol protocol = rightmost_1bit(protocols);
849 bitmap |= 1u << ofputil_protocol_to_ofp_version(protocol);
855 /* Returns the set of protocols that are supported on top of the
856 * OpenFlow versions included in 'bitmap'. */
857 enum ofputil_protocol
858 ofputil_protocols_from_version_bitmap(uint32_t bitmap)
860 enum ofputil_protocol protocols = 0;
862 for (; bitmap; bitmap = zero_rightmost_1bit(bitmap)) {
863 enum ofp_version version = rightmost_1bit_idx(bitmap);
865 protocols |= ofputil_protocols_from_ofp_version(version);
871 /* Returns true if 'protocol' is a single OFPUTIL_P_* value, false
874 ofputil_protocol_is_valid(enum ofputil_protocol protocol)
876 return protocol & OFPUTIL_P_ANY && is_pow2(protocol);
879 /* Returns the equivalent of 'protocol' with the Nicira flow_mod_table_id
880 * extension turned on or off if 'enable' is true or false, respectively.
882 * This extension is only useful for protocols whose "standard" version does
883 * not allow specific tables to be modified. In particular, this is true of
884 * OpenFlow 1.0. In later versions of OpenFlow, a flow_mod request always
885 * specifies a table ID and so there is no need for such an extension. When
886 * 'protocol' is such a protocol that doesn't need a flow_mod_table_id
887 * extension, this function just returns its 'protocol' argument unchanged
888 * regardless of the value of 'enable'. */
889 enum ofputil_protocol
890 ofputil_protocol_set_tid(enum ofputil_protocol protocol, bool enable)
893 case OFPUTIL_P_OF10_STD:
894 case OFPUTIL_P_OF10_STD_TID:
895 return enable ? OFPUTIL_P_OF10_STD_TID : OFPUTIL_P_OF10_STD;
897 case OFPUTIL_P_OF10_NXM:
898 case OFPUTIL_P_OF10_NXM_TID:
899 return enable ? OFPUTIL_P_OF10_NXM_TID : OFPUTIL_P_OF10_NXM;
901 case OFPUTIL_P_OF11_STD:
902 return OFPUTIL_P_OF11_STD;
904 case OFPUTIL_P_OF12_OXM:
905 return OFPUTIL_P_OF12_OXM;
907 case OFPUTIL_P_OF13_OXM:
908 return OFPUTIL_P_OF13_OXM;
910 case OFPUTIL_P_OF14_OXM:
911 return OFPUTIL_P_OF14_OXM;
913 case OFPUTIL_P_OF15_OXM:
914 return OFPUTIL_P_OF15_OXM;
921 /* Returns the "base" version of 'protocol'. That is, if 'protocol' includes
922 * some extension to a standard protocol version, the return value is the
923 * standard version of that protocol without any extension. If 'protocol' is a
924 * standard protocol version, returns 'protocol' unchanged. */
925 enum ofputil_protocol
926 ofputil_protocol_to_base(enum ofputil_protocol protocol)
928 return ofputil_protocol_set_tid(protocol, false);
931 /* Returns 'new_base' with any extensions taken from 'cur'. */
932 enum ofputil_protocol
933 ofputil_protocol_set_base(enum ofputil_protocol cur,
934 enum ofputil_protocol new_base)
936 bool tid = (cur & OFPUTIL_P_TID) != 0;
939 case OFPUTIL_P_OF10_STD:
940 case OFPUTIL_P_OF10_STD_TID:
941 return ofputil_protocol_set_tid(OFPUTIL_P_OF10_STD, tid);
943 case OFPUTIL_P_OF10_NXM:
944 case OFPUTIL_P_OF10_NXM_TID:
945 return ofputil_protocol_set_tid(OFPUTIL_P_OF10_NXM, tid);
947 case OFPUTIL_P_OF11_STD:
948 return ofputil_protocol_set_tid(OFPUTIL_P_OF11_STD, tid);
950 case OFPUTIL_P_OF12_OXM:
951 return ofputil_protocol_set_tid(OFPUTIL_P_OF12_OXM, tid);
953 case OFPUTIL_P_OF13_OXM:
954 return ofputil_protocol_set_tid(OFPUTIL_P_OF13_OXM, tid);
956 case OFPUTIL_P_OF14_OXM:
957 return ofputil_protocol_set_tid(OFPUTIL_P_OF14_OXM, tid);
959 case OFPUTIL_P_OF15_OXM:
960 return ofputil_protocol_set_tid(OFPUTIL_P_OF15_OXM, tid);
967 /* Returns a string form of 'protocol', if a simple form exists (that is, if
968 * 'protocol' is either a single protocol or it is a combination of protocols
969 * that have a single abbreviation). Otherwise, returns NULL. */
971 ofputil_protocol_to_string(enum ofputil_protocol protocol)
973 const struct proto_abbrev *p;
975 /* Use a "switch" statement for single-bit names so that we get a compiler
976 * warning if we forget any. */
978 case OFPUTIL_P_OF10_NXM:
979 return "NXM-table_id";
981 case OFPUTIL_P_OF10_NXM_TID:
982 return "NXM+table_id";
984 case OFPUTIL_P_OF10_STD:
985 return "OpenFlow10-table_id";
987 case OFPUTIL_P_OF10_STD_TID:
988 return "OpenFlow10+table_id";
990 case OFPUTIL_P_OF11_STD:
993 case OFPUTIL_P_OF12_OXM:
994 return "OXM-OpenFlow12";
996 case OFPUTIL_P_OF13_OXM:
997 return "OXM-OpenFlow13";
999 case OFPUTIL_P_OF14_OXM:
1000 return "OXM-OpenFlow14";
1002 case OFPUTIL_P_OF15_OXM:
1003 return "OXM-OpenFlow15";
1006 /* Check abbreviations. */
1007 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
1008 if (protocol == p->protocol) {
1016 /* Returns a string that represents 'protocols'. The return value might be a
1017 * comma-separated list if 'protocols' doesn't have a simple name. The return
1018 * value is "none" if 'protocols' is 0.
1020 * The caller must free the returned string (with free()). */
1022 ofputil_protocols_to_string(enum ofputil_protocol protocols)
1026 ovs_assert(!(protocols & ~OFPUTIL_P_ANY));
1027 if (protocols == 0) {
1028 return xstrdup("none");
1033 const struct proto_abbrev *p;
1037 ds_put_char(&s, ',');
1040 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
1041 if ((protocols & p->protocol) == p->protocol) {
1042 ds_put_cstr(&s, p->name);
1043 protocols &= ~p->protocol;
1048 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
1049 enum ofputil_protocol bit = 1u << i;
1051 if (protocols & bit) {
1052 ds_put_cstr(&s, ofputil_protocol_to_string(bit));
1061 return ds_steal_cstr(&s);
1064 static enum ofputil_protocol
1065 ofputil_protocol_from_string__(const char *s, size_t n)
1067 const struct proto_abbrev *p;
1070 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
1071 enum ofputil_protocol bit = 1u << i;
1072 const char *name = ofputil_protocol_to_string(bit);
1074 if (name && n == strlen(name) && !strncasecmp(s, name, n)) {
1079 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
1080 if (n == strlen(p->name) && !strncasecmp(s, p->name, n)) {
1088 /* Returns the nonempty set of protocols represented by 's', which can be a
1089 * single protocol name or abbreviation or a comma-separated list of them.
1091 * Aborts the program with an error message if 's' is invalid. */
1092 enum ofputil_protocol
1093 ofputil_protocols_from_string(const char *s)
1095 const char *orig_s = s;
1096 enum ofputil_protocol protocols;
1100 enum ofputil_protocol p;
1103 n = strcspn(s, ",");
1109 p = ofputil_protocol_from_string__(s, n);
1111 ovs_fatal(0, "%.*s: unknown flow protocol", (int) n, s);
1119 ovs_fatal(0, "%s: no flow protocol specified", orig_s);
1125 ofputil_version_from_string(const char *s)
1127 if (!strcasecmp(s, "OpenFlow10")) {
1128 return OFP10_VERSION;
1130 if (!strcasecmp(s, "OpenFlow11")) {
1131 return OFP11_VERSION;
1133 if (!strcasecmp(s, "OpenFlow12")) {
1134 return OFP12_VERSION;
1136 if (!strcasecmp(s, "OpenFlow13")) {
1137 return OFP13_VERSION;
1139 if (!strcasecmp(s, "OpenFlow14")) {
1140 return OFP14_VERSION;
1142 if (!strcasecmp(s, "OpenFlow15")) {
1143 return OFP15_VERSION;
1149 is_delimiter(unsigned char c)
1151 return isspace(c) || c == ',';
1155 ofputil_versions_from_string(const char *s)
1158 uint32_t bitmap = 0;
1165 if (is_delimiter(s[i])) {
1170 while (s[i + j] && !is_delimiter(s[i + j])) {
1173 key = xmemdup0(s + i, j);
1174 version = ofputil_version_from_string(key);
1176 VLOG_FATAL("Unknown OpenFlow version: \"%s\"", key);
1179 bitmap |= 1u << version;
1187 ofputil_versions_from_strings(char ** const s, size_t count)
1189 uint32_t bitmap = 0;
1192 int version = ofputil_version_from_string(s[count]);
1194 VLOG_WARN("Unknown OpenFlow version: \"%s\"", s[count]);
1196 bitmap |= 1u << version;
1204 ofputil_version_to_string(enum ofp_version ofp_version)
1206 switch (ofp_version) {
1208 return "OpenFlow10";
1210 return "OpenFlow11";
1212 return "OpenFlow12";
1214 return "OpenFlow13";
1216 return "OpenFlow14";
1218 return "OpenFlow15";
1225 ofputil_packet_in_format_is_valid(enum nx_packet_in_format packet_in_format)
1227 switch (packet_in_format) {
1228 case NXPIF_OPENFLOW10:
1237 ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format)
1239 switch (packet_in_format) {
1240 case NXPIF_OPENFLOW10:
1241 return "openflow10";
1250 ofputil_packet_in_format_from_string(const char *s)
1252 return (!strcmp(s, "openflow10") ? NXPIF_OPENFLOW10
1253 : !strcmp(s, "nxm") ? NXPIF_NXM
1258 ofputil_format_version(struct ds *msg, enum ofp_version version)
1260 ds_put_format(msg, "0x%02x", version);
1264 ofputil_format_version_name(struct ds *msg, enum ofp_version version)
1266 ds_put_cstr(msg, ofputil_version_to_string(version));
1270 ofputil_format_version_bitmap__(struct ds *msg, uint32_t bitmap,
1271 void (*format_version)(struct ds *msg,
1275 format_version(msg, raw_ctz(bitmap));
1276 bitmap = zero_rightmost_1bit(bitmap);
1278 ds_put_cstr(msg, ", ");
1284 ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap)
1286 ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version);
1290 ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap)
1292 ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version_name);
1296 ofputil_decode_hello_bitmap(const struct ofp_hello_elem_header *oheh,
1297 uint32_t *allowed_versionsp)
1299 uint16_t bitmap_len = ntohs(oheh->length) - sizeof *oheh;
1300 const ovs_be32 *bitmap = ALIGNED_CAST(const ovs_be32 *, oheh + 1);
1301 uint32_t allowed_versions;
1303 if (!bitmap_len || bitmap_len % sizeof *bitmap) {
1307 /* Only use the first 32-bit element of the bitmap as that is all the
1308 * current implementation supports. Subsequent elements are ignored which
1309 * should have no effect on session negotiation until Open vSwitch supports
1310 * wire-protocol versions greater than 31.
1312 allowed_versions = ntohl(bitmap[0]);
1314 if (allowed_versions & 1) {
1315 /* There's no OpenFlow version 0. */
1316 VLOG_WARN_RL(&bad_ofmsg_rl, "peer claims to support invalid OpenFlow "
1318 allowed_versions &= ~1u;
1321 if (!allowed_versions) {
1322 VLOG_WARN_RL(&bad_ofmsg_rl, "peer does not support any OpenFlow "
1323 "version (between 0x01 and 0x1f)");
1327 *allowed_versionsp = allowed_versions;
1332 version_bitmap_from_version(uint8_t ofp_version)
1334 return ((ofp_version < 32 ? 1u << ofp_version : 0) - 1) << 1;
1337 /* Decodes OpenFlow OFPT_HELLO message 'oh', storing into '*allowed_versions'
1338 * the set of OpenFlow versions for which 'oh' announces support.
1340 * Because of how OpenFlow defines OFPT_HELLO messages, this function is always
1341 * successful, and thus '*allowed_versions' is always initialized. However, it
1342 * returns false if 'oh' contains some data that could not be fully understood,
1343 * true if 'oh' was completely parsed. */
1345 ofputil_decode_hello(const struct ofp_header *oh, uint32_t *allowed_versions)
1350 ofpbuf_use_const(&msg, oh, ntohs(oh->length));
1351 ofpbuf_pull(&msg, sizeof *oh);
1353 *allowed_versions = version_bitmap_from_version(oh->version);
1355 const struct ofp_hello_elem_header *oheh;
1358 if (msg.size < sizeof *oheh) {
1363 len = ntohs(oheh->length);
1364 if (len < sizeof *oheh || !ofpbuf_try_pull(&msg, ROUND_UP(len, 8))) {
1368 if (oheh->type != htons(OFPHET_VERSIONBITMAP)
1369 || !ofputil_decode_hello_bitmap(oheh, allowed_versions)) {
1377 /* Returns true if 'allowed_versions' needs to be accompanied by a version
1378 * bitmap to be correctly expressed in an OFPT_HELLO message. */
1380 should_send_version_bitmap(uint32_t allowed_versions)
1382 return !is_pow2((allowed_versions >> 1) + 1);
1385 /* Create an OFPT_HELLO message that expresses support for the OpenFlow
1386 * versions in the 'allowed_versions' bitmaps and returns the message. */
1388 ofputil_encode_hello(uint32_t allowed_versions)
1390 enum ofp_version ofp_version;
1393 ofp_version = leftmost_1bit_idx(allowed_versions);
1394 msg = ofpraw_alloc(OFPRAW_OFPT_HELLO, ofp_version, 0);
1396 if (should_send_version_bitmap(allowed_versions)) {
1397 struct ofp_hello_elem_header *oheh;
1400 map_len = sizeof allowed_versions;
1401 oheh = ofpbuf_put_zeros(msg, ROUND_UP(map_len + sizeof *oheh, 8));
1402 oheh->type = htons(OFPHET_VERSIONBITMAP);
1403 oheh->length = htons(map_len + sizeof *oheh);
1404 *ALIGNED_CAST(ovs_be32 *, oheh + 1) = htonl(allowed_versions);
1406 ofpmsg_update_length(msg);
1412 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
1413 * protocol is 'current', at least partly transitions the protocol to 'want'.
1414 * Stores in '*next' the protocol that will be in effect on the OpenFlow
1415 * connection if the switch processes the returned message correctly. (If
1416 * '*next != want' then the caller will have to iterate.)
1418 * If 'current == want', or if it is not possible to transition from 'current'
1419 * to 'want' (because, for example, 'current' and 'want' use different OpenFlow
1420 * protocol versions), returns NULL and stores 'current' in '*next'. */
1422 ofputil_encode_set_protocol(enum ofputil_protocol current,
1423 enum ofputil_protocol want,
1424 enum ofputil_protocol *next)
1426 enum ofp_version cur_version, want_version;
1427 enum ofputil_protocol cur_base, want_base;
1428 bool cur_tid, want_tid;
1430 cur_version = ofputil_protocol_to_ofp_version(current);
1431 want_version = ofputil_protocol_to_ofp_version(want);
1432 if (cur_version != want_version) {
1437 cur_base = ofputil_protocol_to_base(current);
1438 want_base = ofputil_protocol_to_base(want);
1439 if (cur_base != want_base) {
1440 *next = ofputil_protocol_set_base(current, want_base);
1442 switch (want_base) {
1443 case OFPUTIL_P_OF10_NXM:
1444 return ofputil_encode_nx_set_flow_format(NXFF_NXM);
1446 case OFPUTIL_P_OF10_STD:
1447 return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10);
1449 case OFPUTIL_P_OF11_STD:
1450 case OFPUTIL_P_OF12_OXM:
1451 case OFPUTIL_P_OF13_OXM:
1452 case OFPUTIL_P_OF14_OXM:
1453 case OFPUTIL_P_OF15_OXM:
1454 /* There is only one variant of each OpenFlow 1.1+ protocol, and we
1455 * verified above that we're not trying to change versions. */
1458 case OFPUTIL_P_OF10_STD_TID:
1459 case OFPUTIL_P_OF10_NXM_TID:
1464 cur_tid = (current & OFPUTIL_P_TID) != 0;
1465 want_tid = (want & OFPUTIL_P_TID) != 0;
1466 if (cur_tid != want_tid) {
1467 *next = ofputil_protocol_set_tid(current, want_tid);
1468 return ofputil_make_flow_mod_table_id(want_tid);
1471 ovs_assert(current == want);
1477 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1478 * format to 'nxff'. */
1480 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff)
1482 struct nx_set_flow_format *sff;
1485 ovs_assert(ofputil_nx_flow_format_is_valid(nxff));
1487 msg = ofpraw_alloc(OFPRAW_NXT_SET_FLOW_FORMAT, OFP10_VERSION, 0);
1488 sff = ofpbuf_put_zeros(msg, sizeof *sff);
1489 sff->format = htonl(nxff);
1494 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1496 enum ofputil_protocol
1497 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format)
1499 switch (flow_format) {
1500 case NXFF_OPENFLOW10:
1501 return OFPUTIL_P_OF10_STD;
1504 return OFPUTIL_P_OF10_NXM;
1511 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1513 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format)
1515 return ofputil_nx_flow_format_to_protocol(flow_format) != 0;
1518 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1521 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format)
1523 switch (flow_format) {
1524 case NXFF_OPENFLOW10:
1525 return "openflow10";
1534 ofputil_make_set_packet_in_format(enum ofp_version ofp_version,
1535 enum nx_packet_in_format packet_in_format)
1537 struct nx_set_packet_in_format *spif;
1540 msg = ofpraw_alloc(OFPRAW_NXT_SET_PACKET_IN_FORMAT, ofp_version, 0);
1541 spif = ofpbuf_put_zeros(msg, sizeof *spif);
1542 spif->format = htonl(packet_in_format);
1547 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1548 * extension on or off (according to 'flow_mod_table_id'). */
1550 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
1552 struct nx_flow_mod_table_id *nfmti;
1555 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION, 0);
1556 nfmti = ofpbuf_put_zeros(msg, sizeof *nfmti);
1557 nfmti->set = flow_mod_table_id;
1561 struct ofputil_flow_mod_flag {
1563 enum ofp_version min_version, max_version;
1564 enum ofputil_flow_mod_flags flag;
1567 static const struct ofputil_flow_mod_flag ofputil_flow_mod_flags[] = {
1568 { OFPFF_SEND_FLOW_REM, OFP10_VERSION, 0, OFPUTIL_FF_SEND_FLOW_REM },
1569 { OFPFF_CHECK_OVERLAP, OFP10_VERSION, 0, OFPUTIL_FF_CHECK_OVERLAP },
1570 { OFPFF10_EMERG, OFP10_VERSION, OFP10_VERSION,
1572 { OFPFF12_RESET_COUNTS, OFP12_VERSION, 0, OFPUTIL_FF_RESET_COUNTS },
1573 { OFPFF13_NO_PKT_COUNTS, OFP13_VERSION, 0, OFPUTIL_FF_NO_PKT_COUNTS },
1574 { OFPFF13_NO_BYT_COUNTS, OFP13_VERSION, 0, OFPUTIL_FF_NO_BYT_COUNTS },
1579 ofputil_decode_flow_mod_flags(ovs_be16 raw_flags_,
1580 enum ofp_flow_mod_command command,
1581 enum ofp_version version,
1582 enum ofputil_flow_mod_flags *flagsp)
1584 uint16_t raw_flags = ntohs(raw_flags_);
1585 const struct ofputil_flow_mod_flag *f;
1588 for (f = ofputil_flow_mod_flags; f->raw_flag; f++) {
1589 if (raw_flags & f->raw_flag
1590 && version >= f->min_version
1591 && (!f->max_version || version <= f->max_version)) {
1592 raw_flags &= ~f->raw_flag;
1597 /* In OF1.0 and OF1.1, "add" always resets counters, and other commands
1600 * In OF1.2 and later, OFPFF12_RESET_COUNTS controls whether each command
1601 * resets counters. */
1602 if ((version == OFP10_VERSION || version == OFP11_VERSION)
1603 && command == OFPFC_ADD) {
1604 *flagsp |= OFPUTIL_FF_RESET_COUNTS;
1607 return raw_flags ? OFPERR_OFPFMFC_BAD_FLAGS : 0;
1611 ofputil_encode_flow_mod_flags(enum ofputil_flow_mod_flags flags,
1612 enum ofp_version version)
1614 const struct ofputil_flow_mod_flag *f;
1618 for (f = ofputil_flow_mod_flags; f->raw_flag; f++) {
1620 && version >= f->min_version
1621 && (!f->max_version || version <= f->max_version)) {
1622 raw_flags |= f->raw_flag;
1626 return htons(raw_flags);
1629 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1630 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
1633 * Uses 'ofpacts' to store the abstract OFPACT_* version of 'oh''s actions.
1634 * The caller must initialize 'ofpacts' and retains ownership of it.
1635 * 'fm->ofpacts' will point into the 'ofpacts' buffer.
1637 * Does not validate the flow_mod actions. The caller should do that, with
1638 * ofpacts_check(). */
1640 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
1641 const struct ofp_header *oh,
1642 enum ofputil_protocol protocol,
1643 struct ofpbuf *ofpacts,
1644 ofp_port_t max_port, uint8_t max_table)
1651 /* Ignored for non-delete actions */
1652 fm->delete_reason = OFPRR_DELETE;
1654 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1655 raw = ofpraw_pull_assert(&b);
1656 if (raw == OFPRAW_OFPT11_FLOW_MOD) {
1657 /* Standard OpenFlow 1.1+ flow_mod. */
1658 const struct ofp11_flow_mod *ofm;
1660 ofm = ofpbuf_pull(&b, sizeof *ofm);
1662 error = ofputil_pull_ofp11_match(&b, &fm->match, NULL);
1667 /* Translate the message. */
1668 fm->priority = ntohs(ofm->priority);
1669 if (ofm->command == OFPFC_ADD
1670 || (oh->version == OFP11_VERSION
1671 && (ofm->command == OFPFC_MODIFY ||
1672 ofm->command == OFPFC_MODIFY_STRICT)
1673 && ofm->cookie_mask == htonll(0))) {
1674 /* In OpenFlow 1.1 only, a "modify" or "modify-strict" that does
1675 * not match on the cookie is treated as an "add" if there is no
1677 fm->cookie = htonll(0);
1678 fm->cookie_mask = htonll(0);
1679 fm->new_cookie = ofm->cookie;
1681 fm->cookie = ofm->cookie;
1682 fm->cookie_mask = ofm->cookie_mask;
1683 fm->new_cookie = OVS_BE64_MAX;
1685 fm->modify_cookie = false;
1686 fm->command = ofm->command;
1690 * OF1.1 entirely forbids table_id == OFPTT_ALL.
1691 * OF1.2+ allows table_id == OFPTT_ALL only for deletes. */
1692 fm->table_id = ofm->table_id;
1693 if (fm->table_id == OFPTT_ALL
1694 && (oh->version == OFP11_VERSION
1695 || (ofm->command != OFPFC_DELETE &&
1696 ofm->command != OFPFC_DELETE_STRICT))) {
1697 return OFPERR_OFPFMFC_BAD_TABLE_ID;
1700 fm->idle_timeout = ntohs(ofm->idle_timeout);
1701 fm->hard_timeout = ntohs(ofm->hard_timeout);
1702 if (oh->version >= OFP14_VERSION && ofm->command == OFPFC_ADD) {
1703 fm->importance = ntohs(ofm->importance);
1707 fm->buffer_id = ntohl(ofm->buffer_id);
1708 error = ofputil_port_from_ofp11(ofm->out_port, &fm->out_port);
1713 fm->out_group = (ofm->command == OFPFC_DELETE ||
1714 ofm->command == OFPFC_DELETE_STRICT
1715 ? ntohl(ofm->out_group)
1717 raw_flags = ofm->flags;
1721 if (raw == OFPRAW_OFPT10_FLOW_MOD) {
1722 /* Standard OpenFlow 1.0 flow_mod. */
1723 const struct ofp10_flow_mod *ofm;
1725 /* Get the ofp10_flow_mod. */
1726 ofm = ofpbuf_pull(&b, sizeof *ofm);
1728 /* Translate the rule. */
1729 ofputil_match_from_ofp10_match(&ofm->match, &fm->match);
1730 ofputil_normalize_match(&fm->match);
1732 /* OpenFlow 1.0 says that exact-match rules have to have the
1733 * highest possible priority. */
1734 fm->priority = (ofm->match.wildcards & htonl(OFPFW10_ALL)
1735 ? ntohs(ofm->priority)
1738 /* Translate the message. */
1739 command = ntohs(ofm->command);
1740 fm->cookie = htonll(0);
1741 fm->cookie_mask = htonll(0);
1742 fm->new_cookie = ofm->cookie;
1743 fm->idle_timeout = ntohs(ofm->idle_timeout);
1744 fm->hard_timeout = ntohs(ofm->hard_timeout);
1746 fm->buffer_id = ntohl(ofm->buffer_id);
1747 fm->out_port = u16_to_ofp(ntohs(ofm->out_port));
1748 fm->out_group = OFPG11_ANY;
1749 raw_flags = ofm->flags;
1750 } else if (raw == OFPRAW_NXT_FLOW_MOD) {
1751 /* Nicira extended flow_mod. */
1752 const struct nx_flow_mod *nfm;
1754 /* Dissect the message. */
1755 nfm = ofpbuf_pull(&b, sizeof *nfm);
1756 error = nx_pull_match(&b, ntohs(nfm->match_len),
1757 &fm->match, &fm->cookie, &fm->cookie_mask);
1762 /* Translate the message. */
1763 command = ntohs(nfm->command);
1764 if ((command & 0xff) == OFPFC_ADD && fm->cookie_mask) {
1765 /* Flow additions may only set a new cookie, not match an
1766 * existing cookie. */
1767 return OFPERR_NXBRC_NXM_INVALID;
1769 fm->priority = ntohs(nfm->priority);
1770 fm->new_cookie = nfm->cookie;
1771 fm->idle_timeout = ntohs(nfm->idle_timeout);
1772 fm->hard_timeout = ntohs(nfm->hard_timeout);
1774 fm->buffer_id = ntohl(nfm->buffer_id);
1775 fm->out_port = u16_to_ofp(ntohs(nfm->out_port));
1776 fm->out_group = OFPG11_ANY;
1777 raw_flags = nfm->flags;
1782 fm->modify_cookie = fm->new_cookie != OVS_BE64_MAX;
1783 if (protocol & OFPUTIL_P_TID) {
1784 fm->command = command & 0xff;
1785 fm->table_id = command >> 8;
1787 if (command > 0xff) {
1788 VLOG_WARN_RL(&bad_ofmsg_rl, "flow_mod has explicit table_id "
1789 "but flow_mod_table_id extension is not enabled");
1791 fm->command = command;
1792 fm->table_id = 0xff;
1796 if (fm->command > OFPFC_DELETE_STRICT) {
1797 return OFPERR_OFPFMFC_BAD_COMMAND;
1800 error = ofpacts_pull_openflow_instructions(&b, b.size,
1801 oh->version, ofpacts);
1805 fm->ofpacts = ofpacts->data;
1806 fm->ofpacts_len = ofpacts->size;
1808 error = ofputil_decode_flow_mod_flags(raw_flags, fm->command,
1809 oh->version, &fm->flags);
1814 if (fm->flags & OFPUTIL_FF_EMERG) {
1815 /* We do not support the OpenFlow 1.0 emergency flow cache, which
1816 * is not required in OpenFlow 1.0.1 and removed from OpenFlow 1.1.
1818 * OpenFlow 1.0 specifies the error code to use when idle_timeout
1819 * or hard_timeout is nonzero. Otherwise, there is no good error
1820 * code, so just state that the flow table is full. */
1821 return (fm->hard_timeout || fm->idle_timeout
1822 ? OFPERR_OFPFMFC_BAD_EMERG_TIMEOUT
1823 : OFPERR_OFPFMFC_TABLE_FULL);
1826 return ofpacts_check_consistency(fm->ofpacts, fm->ofpacts_len,
1827 &fm->match.flow, max_port,
1828 fm->table_id, max_table, protocol);
1832 ofputil_pull_bands(struct ofpbuf *msg, size_t len, uint16_t *n_bands,
1833 struct ofpbuf *bands)
1835 const struct ofp13_meter_band_header *ombh;
1836 struct ofputil_meter_band *mb;
1839 ombh = ofpbuf_try_pull(msg, len);
1841 return OFPERR_OFPBRC_BAD_LEN;
1844 while (len >= sizeof (struct ofp13_meter_band_drop)) {
1845 size_t ombh_len = ntohs(ombh->len);
1846 /* All supported band types have the same length. */
1847 if (ombh_len != sizeof (struct ofp13_meter_band_drop)) {
1848 return OFPERR_OFPBRC_BAD_LEN;
1850 mb = ofpbuf_put_uninit(bands, sizeof *mb);
1851 mb->type = ntohs(ombh->type);
1852 if (mb->type != OFPMBT13_DROP && mb->type != OFPMBT13_DSCP_REMARK) {
1853 return OFPERR_OFPMMFC_BAD_BAND;
1855 mb->rate = ntohl(ombh->rate);
1856 mb->burst_size = ntohl(ombh->burst_size);
1857 mb->prec_level = (mb->type == OFPMBT13_DSCP_REMARK) ?
1858 ((struct ofp13_meter_band_dscp_remark *)ombh)->prec_level : 0;
1861 ombh = ALIGNED_CAST(struct ofp13_meter_band_header *,
1862 (char *) ombh + ombh_len);
1865 return OFPERR_OFPBRC_BAD_LEN;
1872 ofputil_decode_meter_mod(const struct ofp_header *oh,
1873 struct ofputil_meter_mod *mm,
1874 struct ofpbuf *bands)
1876 const struct ofp13_meter_mod *omm;
1879 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1880 ofpraw_pull_assert(&b);
1881 omm = ofpbuf_pull(&b, sizeof *omm);
1883 /* Translate the message. */
1884 mm->command = ntohs(omm->command);
1885 if (mm->command != OFPMC13_ADD &&
1886 mm->command != OFPMC13_MODIFY &&
1887 mm->command != OFPMC13_DELETE) {
1888 return OFPERR_OFPMMFC_BAD_COMMAND;
1890 mm->meter.meter_id = ntohl(omm->meter_id);
1892 if (mm->command == OFPMC13_DELETE) {
1893 mm->meter.flags = 0;
1894 mm->meter.n_bands = 0;
1895 mm->meter.bands = NULL;
1899 mm->meter.flags = ntohs(omm->flags);
1900 if (mm->meter.flags & OFPMF13_KBPS &&
1901 mm->meter.flags & OFPMF13_PKTPS) {
1902 return OFPERR_OFPMMFC_BAD_FLAGS;
1904 mm->meter.bands = bands->data;
1906 error = ofputil_pull_bands(&b, b.size, &mm->meter.n_bands, bands);
1915 ofputil_decode_meter_request(const struct ofp_header *oh, uint32_t *meter_id)
1917 const struct ofp13_meter_multipart_request *omr = ofpmsg_body(oh);
1918 *meter_id = ntohl(omr->meter_id);
1922 ofputil_encode_meter_request(enum ofp_version ofp_version,
1923 enum ofputil_meter_request_type type,
1931 case OFPUTIL_METER_CONFIG:
1932 raw = OFPRAW_OFPST13_METER_CONFIG_REQUEST;
1934 case OFPUTIL_METER_STATS:
1935 raw = OFPRAW_OFPST13_METER_REQUEST;
1938 case OFPUTIL_METER_FEATURES:
1939 raw = OFPRAW_OFPST13_METER_FEATURES_REQUEST;
1943 msg = ofpraw_alloc(raw, ofp_version, 0);
1945 if (type != OFPUTIL_METER_FEATURES) {
1946 struct ofp13_meter_multipart_request *omr;
1947 omr = ofpbuf_put_zeros(msg, sizeof *omr);
1948 omr->meter_id = htonl(meter_id);
1954 ofputil_put_bands(uint16_t n_bands, const struct ofputil_meter_band *mb,
1959 for (n = 0; n < n_bands; ++n) {
1960 /* Currently all band types have same size. */
1961 struct ofp13_meter_band_dscp_remark *ombh;
1962 size_t ombh_len = sizeof *ombh;
1964 ombh = ofpbuf_put_zeros(msg, ombh_len);
1966 ombh->type = htons(mb->type);
1967 ombh->len = htons(ombh_len);
1968 ombh->rate = htonl(mb->rate);
1969 ombh->burst_size = htonl(mb->burst_size);
1970 ombh->prec_level = mb->prec_level;
1976 /* Encode a meter stat for 'mc' and append it to 'replies'. */
1978 ofputil_append_meter_config(struct ovs_list *replies,
1979 const struct ofputil_meter_config *mc)
1981 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
1982 size_t start_ofs = msg->size;
1983 struct ofp13_meter_config *reply = ofpbuf_put_uninit(msg, sizeof *reply);
1984 reply->flags = htons(mc->flags);
1985 reply->meter_id = htonl(mc->meter_id);
1987 ofputil_put_bands(mc->n_bands, mc->bands, msg);
1989 reply->length = htons(msg->size - start_ofs);
1991 ofpmp_postappend(replies, start_ofs);
1994 /* Encode a meter stat for 'ms' and append it to 'replies'. */
1996 ofputil_append_meter_stats(struct ovs_list *replies,
1997 const struct ofputil_meter_stats *ms)
1999 struct ofp13_meter_stats *reply;
2003 len = sizeof *reply + ms->n_bands * sizeof(struct ofp13_meter_band_stats);
2004 reply = ofpmp_append(replies, len);
2006 reply->meter_id = htonl(ms->meter_id);
2007 reply->len = htons(len);
2008 memset(reply->pad, 0, sizeof reply->pad);
2009 reply->flow_count = htonl(ms->flow_count);
2010 reply->packet_in_count = htonll(ms->packet_in_count);
2011 reply->byte_in_count = htonll(ms->byte_in_count);
2012 reply->duration_sec = htonl(ms->duration_sec);
2013 reply->duration_nsec = htonl(ms->duration_nsec);
2015 for (n = 0; n < ms->n_bands; ++n) {
2016 const struct ofputil_meter_band_stats *src = &ms->bands[n];
2017 struct ofp13_meter_band_stats *dst = &reply->band_stats[n];
2019 dst->packet_band_count = htonll(src->packet_count);
2020 dst->byte_band_count = htonll(src->byte_count);
2024 /* Converts an OFPMP_METER_CONFIG reply in 'msg' into an abstract
2025 * ofputil_meter_config in 'mc', with mc->bands pointing to bands decoded into
2026 * 'bands'. The caller must have initialized 'bands' and retains ownership of
2027 * it across the call.
2029 * Multiple OFPST13_METER_CONFIG replies can be packed into a single OpenFlow
2030 * message. Calling this function multiple times for a single 'msg' iterates
2031 * through the replies. 'bands' is cleared for each reply.
2033 * Returns 0 if successful, EOF if no replies were left in this 'msg',
2034 * otherwise a positive errno value. */
2036 ofputil_decode_meter_config(struct ofpbuf *msg,
2037 struct ofputil_meter_config *mc,
2038 struct ofpbuf *bands)
2040 const struct ofp13_meter_config *omc;
2043 /* Pull OpenFlow headers for the first call. */
2045 ofpraw_pull_assert(msg);
2052 omc = ofpbuf_try_pull(msg, sizeof *omc);
2054 VLOG_WARN_RL(&bad_ofmsg_rl,
2055 "OFPMP_METER_CONFIG reply has %"PRIu32" leftover bytes at end",
2057 return OFPERR_OFPBRC_BAD_LEN;
2060 ofpbuf_clear(bands);
2061 err = ofputil_pull_bands(msg, ntohs(omc->length) - sizeof *omc,
2062 &mc->n_bands, bands);
2066 mc->meter_id = ntohl(omc->meter_id);
2067 mc->flags = ntohs(omc->flags);
2068 mc->bands = bands->data;
2074 ofputil_pull_band_stats(struct ofpbuf *msg, size_t len, uint16_t *n_bands,
2075 struct ofpbuf *bands)
2077 const struct ofp13_meter_band_stats *ombs;
2078 struct ofputil_meter_band_stats *mbs;
2081 ombs = ofpbuf_try_pull(msg, len);
2083 return OFPERR_OFPBRC_BAD_LEN;
2086 n = len / sizeof *ombs;
2087 if (len != n * sizeof *ombs) {
2088 return OFPERR_OFPBRC_BAD_LEN;
2091 mbs = ofpbuf_put_uninit(bands, len);
2093 for (i = 0; i < n; ++i) {
2094 mbs[i].packet_count = ntohll(ombs[i].packet_band_count);
2095 mbs[i].byte_count = ntohll(ombs[i].byte_band_count);
2101 /* Converts an OFPMP_METER reply in 'msg' into an abstract
2102 * ofputil_meter_stats in 'ms', with ms->bands pointing to band stats
2103 * decoded into 'bands'.
2105 * Multiple OFPMP_METER replies can be packed into a single OpenFlow
2106 * message. Calling this function multiple times for a single 'msg' iterates
2107 * through the replies. 'bands' is cleared for each reply.
2109 * Returns 0 if successful, EOF if no replies were left in this 'msg',
2110 * otherwise a positive errno value. */
2112 ofputil_decode_meter_stats(struct ofpbuf *msg,
2113 struct ofputil_meter_stats *ms,
2114 struct ofpbuf *bands)
2116 const struct ofp13_meter_stats *oms;
2119 /* Pull OpenFlow headers for the first call. */
2121 ofpraw_pull_assert(msg);
2128 oms = ofpbuf_try_pull(msg, sizeof *oms);
2130 VLOG_WARN_RL(&bad_ofmsg_rl,
2131 "OFPMP_METER reply has %"PRIu32" leftover bytes at end",
2133 return OFPERR_OFPBRC_BAD_LEN;
2136 ofpbuf_clear(bands);
2137 err = ofputil_pull_band_stats(msg, ntohs(oms->len) - sizeof *oms,
2138 &ms->n_bands, bands);
2142 ms->meter_id = ntohl(oms->meter_id);
2143 ms->flow_count = ntohl(oms->flow_count);
2144 ms->packet_in_count = ntohll(oms->packet_in_count);
2145 ms->byte_in_count = ntohll(oms->byte_in_count);
2146 ms->duration_sec = ntohl(oms->duration_sec);
2147 ms->duration_nsec = ntohl(oms->duration_nsec);
2148 ms->bands = bands->data;
2154 ofputil_decode_meter_features(const struct ofp_header *oh,
2155 struct ofputil_meter_features *mf)
2157 const struct ofp13_meter_features *omf = ofpmsg_body(oh);
2159 mf->max_meters = ntohl(omf->max_meter);
2160 mf->band_types = ntohl(omf->band_types);
2161 mf->capabilities = ntohl(omf->capabilities);
2162 mf->max_bands = omf->max_bands;
2163 mf->max_color = omf->max_color;
2167 ofputil_encode_meter_features_reply(const struct ofputil_meter_features *mf,
2168 const struct ofp_header *request)
2170 struct ofpbuf *reply;
2171 struct ofp13_meter_features *omf;
2173 reply = ofpraw_alloc_stats_reply(request, 0);
2174 omf = ofpbuf_put_zeros(reply, sizeof *omf);
2176 omf->max_meter = htonl(mf->max_meters);
2177 omf->band_types = htonl(mf->band_types);
2178 omf->capabilities = htonl(mf->capabilities);
2179 omf->max_bands = mf->max_bands;
2180 omf->max_color = mf->max_color;
2186 ofputil_encode_meter_mod(enum ofp_version ofp_version,
2187 const struct ofputil_meter_mod *mm)
2191 struct ofp13_meter_mod *omm;
2193 msg = ofpraw_alloc(OFPRAW_OFPT13_METER_MOD, ofp_version,
2194 NXM_TYPICAL_LEN + mm->meter.n_bands * 16);
2195 omm = ofpbuf_put_zeros(msg, sizeof *omm);
2196 omm->command = htons(mm->command);
2197 if (mm->command != OFPMC13_DELETE) {
2198 omm->flags = htons(mm->meter.flags);
2200 omm->meter_id = htonl(mm->meter.meter_id);
2202 ofputil_put_bands(mm->meter.n_bands, mm->meter.bands, msg);
2204 ofpmsg_update_length(msg);
2209 ofputil_tid_command(const struct ofputil_flow_mod *fm,
2210 enum ofputil_protocol protocol)
2212 return htons(protocol & OFPUTIL_P_TID
2213 ? (fm->command & 0xff) | (fm->table_id << 8)
2217 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
2218 * 'protocol' and returns the message. */
2220 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
2221 enum ofputil_protocol protocol)
2223 enum ofp_version version = ofputil_protocol_to_ofp_version(protocol);
2224 ovs_be16 raw_flags = ofputil_encode_flow_mod_flags(fm->flags, version);
2228 case OFPUTIL_P_OF11_STD:
2229 case OFPUTIL_P_OF12_OXM:
2230 case OFPUTIL_P_OF13_OXM:
2231 case OFPUTIL_P_OF14_OXM:
2232 case OFPUTIL_P_OF15_OXM: {
2233 struct ofp11_flow_mod *ofm;
2236 tailroom = ofputil_match_typical_len(protocol) + fm->ofpacts_len;
2237 msg = ofpraw_alloc(OFPRAW_OFPT11_FLOW_MOD, version, tailroom);
2238 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
2239 if ((protocol == OFPUTIL_P_OF11_STD
2240 && (fm->command == OFPFC_MODIFY ||
2241 fm->command == OFPFC_MODIFY_STRICT)
2242 && fm->cookie_mask == htonll(0))
2243 || fm->command == OFPFC_ADD) {
2244 ofm->cookie = fm->new_cookie;
2246 ofm->cookie = fm->cookie & fm->cookie_mask;
2248 ofm->cookie_mask = fm->cookie_mask;
2249 if (fm->table_id != OFPTT_ALL
2250 || (protocol != OFPUTIL_P_OF11_STD
2251 && (fm->command == OFPFC_DELETE ||
2252 fm->command == OFPFC_DELETE_STRICT))) {
2253 ofm->table_id = fm->table_id;
2257 ofm->command = fm->command;
2258 ofm->idle_timeout = htons(fm->idle_timeout);
2259 ofm->hard_timeout = htons(fm->hard_timeout);
2260 ofm->priority = htons(fm->priority);
2261 ofm->buffer_id = htonl(fm->buffer_id);
2262 ofm->out_port = ofputil_port_to_ofp11(fm->out_port);
2263 ofm->out_group = htonl(fm->out_group);
2264 ofm->flags = raw_flags;
2265 if (version >= OFP14_VERSION && fm->command == OFPFC_ADD) {
2266 ofm->importance = htons(fm->importance);
2268 ofm->importance = 0;
2270 ofputil_put_ofp11_match(msg, &fm->match, protocol);
2271 ofpacts_put_openflow_instructions(fm->ofpacts, fm->ofpacts_len, msg,
2276 case OFPUTIL_P_OF10_STD:
2277 case OFPUTIL_P_OF10_STD_TID: {
2278 struct ofp10_flow_mod *ofm;
2280 msg = ofpraw_alloc(OFPRAW_OFPT10_FLOW_MOD, OFP10_VERSION,
2282 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
2283 ofputil_match_to_ofp10_match(&fm->match, &ofm->match);
2284 ofm->cookie = fm->new_cookie;
2285 ofm->command = ofputil_tid_command(fm, protocol);
2286 ofm->idle_timeout = htons(fm->idle_timeout);
2287 ofm->hard_timeout = htons(fm->hard_timeout);
2288 ofm->priority = htons(fm->priority);
2289 ofm->buffer_id = htonl(fm->buffer_id);
2290 ofm->out_port = htons(ofp_to_u16(fm->out_port));
2291 ofm->flags = raw_flags;
2292 ofpacts_put_openflow_actions(fm->ofpacts, fm->ofpacts_len, msg,
2297 case OFPUTIL_P_OF10_NXM:
2298 case OFPUTIL_P_OF10_NXM_TID: {
2299 struct nx_flow_mod *nfm;
2302 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD, OFP10_VERSION,
2303 NXM_TYPICAL_LEN + fm->ofpacts_len);
2304 nfm = ofpbuf_put_zeros(msg, sizeof *nfm);
2305 nfm->command = ofputil_tid_command(fm, protocol);
2306 nfm->cookie = fm->new_cookie;
2307 match_len = nx_put_match(msg, &fm->match, fm->cookie, fm->cookie_mask);
2309 nfm->idle_timeout = htons(fm->idle_timeout);
2310 nfm->hard_timeout = htons(fm->hard_timeout);
2311 nfm->priority = htons(fm->priority);
2312 nfm->buffer_id = htonl(fm->buffer_id);
2313 nfm->out_port = htons(ofp_to_u16(fm->out_port));
2314 nfm->flags = raw_flags;
2315 nfm->match_len = htons(match_len);
2316 ofpacts_put_openflow_actions(fm->ofpacts, fm->ofpacts_len, msg,
2325 ofpmsg_update_length(msg);
2330 ofputil_decode_ofpst10_flow_request(struct ofputil_flow_stats_request *fsr,
2331 const struct ofp10_flow_stats_request *ofsr,
2334 fsr->aggregate = aggregate;
2335 ofputil_match_from_ofp10_match(&ofsr->match, &fsr->match);
2336 fsr->out_port = u16_to_ofp(ntohs(ofsr->out_port));
2337 fsr->out_group = OFPG11_ANY;
2338 fsr->table_id = ofsr->table_id;
2339 fsr->cookie = fsr->cookie_mask = htonll(0);
2345 ofputil_decode_ofpst11_flow_request(struct ofputil_flow_stats_request *fsr,
2346 struct ofpbuf *b, bool aggregate)
2348 const struct ofp11_flow_stats_request *ofsr;
2351 ofsr = ofpbuf_pull(b, sizeof *ofsr);
2352 fsr->aggregate = aggregate;
2353 fsr->table_id = ofsr->table_id;
2354 error = ofputil_port_from_ofp11(ofsr->out_port, &fsr->out_port);
2358 fsr->out_group = ntohl(ofsr->out_group);
2359 fsr->cookie = ofsr->cookie;
2360 fsr->cookie_mask = ofsr->cookie_mask;
2361 error = ofputil_pull_ofp11_match(b, &fsr->match, NULL);
2370 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
2371 struct ofpbuf *b, bool aggregate)
2373 const struct nx_flow_stats_request *nfsr;
2376 nfsr = ofpbuf_pull(b, sizeof *nfsr);
2377 error = nx_pull_match(b, ntohs(nfsr->match_len), &fsr->match,
2378 &fsr->cookie, &fsr->cookie_mask);
2383 return OFPERR_OFPBRC_BAD_LEN;
2386 fsr->aggregate = aggregate;
2387 fsr->out_port = u16_to_ofp(ntohs(nfsr->out_port));
2388 fsr->out_group = OFPG11_ANY;
2389 fsr->table_id = nfsr->table_id;
2394 /* Constructs and returns an OFPT_QUEUE_GET_CONFIG request for the specified
2395 * 'port', suitable for OpenFlow version 'version'. */
2397 ofputil_encode_queue_get_config_request(enum ofp_version version,
2400 struct ofpbuf *request;
2402 if (version == OFP10_VERSION) {
2403 struct ofp10_queue_get_config_request *qgcr10;
2405 request = ofpraw_alloc(OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST,
2407 qgcr10 = ofpbuf_put_zeros(request, sizeof *qgcr10);
2408 qgcr10->port = htons(ofp_to_u16(port));
2410 struct ofp11_queue_get_config_request *qgcr11;
2412 request = ofpraw_alloc(OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST,
2414 qgcr11 = ofpbuf_put_zeros(request, sizeof *qgcr11);
2415 qgcr11->port = ofputil_port_to_ofp11(port);
2421 /* Parses OFPT_QUEUE_GET_CONFIG request 'oh', storing the port specified by the
2422 * request into '*port'. Returns 0 if successful, otherwise an OpenFlow error
2425 ofputil_decode_queue_get_config_request(const struct ofp_header *oh,
2428 const struct ofp10_queue_get_config_request *qgcr10;
2429 const struct ofp11_queue_get_config_request *qgcr11;
2433 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2434 raw = ofpraw_pull_assert(&b);
2436 switch ((int) raw) {
2437 case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST:
2439 *port = u16_to_ofp(ntohs(qgcr10->port));
2442 case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST:
2444 return ofputil_port_from_ofp11(qgcr11->port, port);
2450 /* Constructs and returns the beginning of a reply to
2451 * OFPT_QUEUE_GET_CONFIG_REQUEST 'oh'. The caller may append information about
2452 * individual queues with ofputil_append_queue_get_config_reply(). */
2454 ofputil_encode_queue_get_config_reply(const struct ofp_header *oh)
2456 struct ofp10_queue_get_config_reply *qgcr10;
2457 struct ofp11_queue_get_config_reply *qgcr11;
2458 struct ofpbuf *reply;
2464 error = ofputil_decode_queue_get_config_request(oh, &port);
2467 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2468 raw = ofpraw_pull_assert(&b);
2470 switch ((int) raw) {
2471 case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST:
2472 reply = ofpraw_alloc_reply(OFPRAW_OFPT10_QUEUE_GET_CONFIG_REPLY,
2474 qgcr10 = ofpbuf_put_zeros(reply, sizeof *qgcr10);
2475 qgcr10->port = htons(ofp_to_u16(port));
2478 case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST:
2479 reply = ofpraw_alloc_reply(OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY,
2481 qgcr11 = ofpbuf_put_zeros(reply, sizeof *qgcr11);
2482 qgcr11->port = ofputil_port_to_ofp11(port);
2493 put_queue_rate(struct ofpbuf *reply, enum ofp_queue_properties property,
2496 if (rate != UINT16_MAX) {
2497 struct ofp_queue_prop_rate *oqpr;
2499 oqpr = ofpbuf_put_zeros(reply, sizeof *oqpr);
2500 oqpr->prop_header.property = htons(property);
2501 oqpr->prop_header.len = htons(sizeof *oqpr);
2502 oqpr->rate = htons(rate);
2506 /* Appends a queue description for 'queue_id' to the
2507 * OFPT_QUEUE_GET_CONFIG_REPLY already in 'oh'. */
2509 ofputil_append_queue_get_config_reply(struct ofpbuf *reply,
2510 const struct ofputil_queue_config *oqc)
2512 const struct ofp_header *oh = reply->data;
2513 size_t start_ofs, len_ofs;
2516 start_ofs = reply->size;
2517 if (oh->version < OFP12_VERSION) {
2518 struct ofp10_packet_queue *opq10;
2520 opq10 = ofpbuf_put_zeros(reply, sizeof *opq10);
2521 opq10->queue_id = htonl(oqc->queue_id);
2522 len_ofs = (char *) &opq10->len - (char *) reply->data;
2524 struct ofp11_queue_get_config_reply *qgcr11;
2525 struct ofp12_packet_queue *opq12;
2528 qgcr11 = reply->msg;
2529 port = qgcr11->port;
2531 opq12 = ofpbuf_put_zeros(reply, sizeof *opq12);
2533 opq12->queue_id = htonl(oqc->queue_id);
2534 len_ofs = (char *) &opq12->len - (char *) reply->data;
2537 put_queue_rate(reply, OFPQT_MIN_RATE, oqc->min_rate);
2538 put_queue_rate(reply, OFPQT_MAX_RATE, oqc->max_rate);
2540 len = ofpbuf_at(reply, len_ofs, sizeof *len);
2541 *len = htons(reply->size - start_ofs);
2544 /* Decodes the initial part of an OFPT_QUEUE_GET_CONFIG_REPLY from 'reply' and
2545 * stores in '*port' the port that the reply is about. The caller may call
2546 * ofputil_pull_queue_get_config_reply() to obtain information about individual
2547 * queues included in the reply. Returns 0 if successful, otherwise an
2550 ofputil_decode_queue_get_config_reply(struct ofpbuf *reply, ofp_port_t *port)
2552 const struct ofp10_queue_get_config_reply *qgcr10;
2553 const struct ofp11_queue_get_config_reply *qgcr11;
2556 raw = ofpraw_pull_assert(reply);
2557 switch ((int) raw) {
2558 case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REPLY:
2559 qgcr10 = ofpbuf_pull(reply, sizeof *qgcr10);
2560 *port = u16_to_ofp(ntohs(qgcr10->port));
2563 case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY:
2564 qgcr11 = ofpbuf_pull(reply, sizeof *qgcr11);
2565 return ofputil_port_from_ofp11(qgcr11->port, port);
2572 parse_queue_rate(const struct ofp_queue_prop_header *hdr, uint16_t *rate)
2574 const struct ofp_queue_prop_rate *oqpr;
2576 if (hdr->len == htons(sizeof *oqpr)) {
2577 oqpr = (const struct ofp_queue_prop_rate *) hdr;
2578 *rate = ntohs(oqpr->rate);
2581 return OFPERR_OFPBRC_BAD_LEN;
2585 /* Decodes information about a queue from the OFPT_QUEUE_GET_CONFIG_REPLY in
2586 * 'reply' and stores it in '*queue'. ofputil_decode_queue_get_config_reply()
2587 * must already have pulled off the main header.
2589 * This function returns EOF if the last queue has already been decoded, 0 if a
2590 * queue was successfully decoded into '*queue', or an ofperr if there was a
2591 * problem decoding 'reply'. */
2593 ofputil_pull_queue_get_config_reply(struct ofpbuf *reply,
2594 struct ofputil_queue_config *queue)
2596 const struct ofp_header *oh;
2597 unsigned int opq_len;
2604 queue->min_rate = UINT16_MAX;
2605 queue->max_rate = UINT16_MAX;
2608 if (oh->version < OFP12_VERSION) {
2609 const struct ofp10_packet_queue *opq10;
2611 opq10 = ofpbuf_try_pull(reply, sizeof *opq10);
2613 return OFPERR_OFPBRC_BAD_LEN;
2615 queue->queue_id = ntohl(opq10->queue_id);
2616 len = ntohs(opq10->len);
2617 opq_len = sizeof *opq10;
2619 const struct ofp12_packet_queue *opq12;
2621 opq12 = ofpbuf_try_pull(reply, sizeof *opq12);
2623 return OFPERR_OFPBRC_BAD_LEN;
2625 queue->queue_id = ntohl(opq12->queue_id);
2626 len = ntohs(opq12->len);
2627 opq_len = sizeof *opq12;
2630 if (len < opq_len || len > reply->size + opq_len || len % 8) {
2631 return OFPERR_OFPBRC_BAD_LEN;
2636 const struct ofp_queue_prop_header *hdr;
2637 unsigned int property;
2638 unsigned int prop_len;
2639 enum ofperr error = 0;
2641 hdr = ofpbuf_at_assert(reply, 0, sizeof *hdr);
2642 prop_len = ntohs(hdr->len);
2643 if (prop_len < sizeof *hdr || prop_len > reply->size || prop_len % 8) {
2644 return OFPERR_OFPBRC_BAD_LEN;
2647 property = ntohs(hdr->property);
2649 case OFPQT_MIN_RATE:
2650 error = parse_queue_rate(hdr, &queue->min_rate);
2653 case OFPQT_MAX_RATE:
2654 error = parse_queue_rate(hdr, &queue->max_rate);
2658 VLOG_INFO_RL(&bad_ofmsg_rl, "unknown queue property %u", property);
2665 ofpbuf_pull(reply, prop_len);
2671 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
2672 * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
2673 * successful, otherwise an OpenFlow error code. */
2675 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
2676 const struct ofp_header *oh)
2681 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2682 raw = ofpraw_pull_assert(&b);
2683 switch ((int) raw) {
2684 case OFPRAW_OFPST10_FLOW_REQUEST:
2685 return ofputil_decode_ofpst10_flow_request(fsr, b.data, false);
2687 case OFPRAW_OFPST10_AGGREGATE_REQUEST:
2688 return ofputil_decode_ofpst10_flow_request(fsr, b.data, true);
2690 case OFPRAW_OFPST11_FLOW_REQUEST:
2691 return ofputil_decode_ofpst11_flow_request(fsr, &b, false);
2693 case OFPRAW_OFPST11_AGGREGATE_REQUEST:
2694 return ofputil_decode_ofpst11_flow_request(fsr, &b, true);
2696 case OFPRAW_NXST_FLOW_REQUEST:
2697 return ofputil_decode_nxst_flow_request(fsr, &b, false);
2699 case OFPRAW_NXST_AGGREGATE_REQUEST:
2700 return ofputil_decode_nxst_flow_request(fsr, &b, true);
2703 /* Hey, the caller lied. */
2708 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
2709 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
2710 * 'protocol', and returns the message. */
2712 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
2713 enum ofputil_protocol protocol)
2719 case OFPUTIL_P_OF11_STD:
2720 case OFPUTIL_P_OF12_OXM:
2721 case OFPUTIL_P_OF13_OXM:
2722 case OFPUTIL_P_OF14_OXM:
2723 case OFPUTIL_P_OF15_OXM: {
2724 struct ofp11_flow_stats_request *ofsr;
2726 raw = (fsr->aggregate
2727 ? OFPRAW_OFPST11_AGGREGATE_REQUEST
2728 : OFPRAW_OFPST11_FLOW_REQUEST);
2729 msg = ofpraw_alloc(raw, ofputil_protocol_to_ofp_version(protocol),
2730 ofputil_match_typical_len(protocol));
2731 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
2732 ofsr->table_id = fsr->table_id;
2733 ofsr->out_port = ofputil_port_to_ofp11(fsr->out_port);
2734 ofsr->out_group = htonl(fsr->out_group);
2735 ofsr->cookie = fsr->cookie;
2736 ofsr->cookie_mask = fsr->cookie_mask;
2737 ofputil_put_ofp11_match(msg, &fsr->match, protocol);
2741 case OFPUTIL_P_OF10_STD:
2742 case OFPUTIL_P_OF10_STD_TID: {
2743 struct ofp10_flow_stats_request *ofsr;
2745 raw = (fsr->aggregate
2746 ? OFPRAW_OFPST10_AGGREGATE_REQUEST
2747 : OFPRAW_OFPST10_FLOW_REQUEST);
2748 msg = ofpraw_alloc(raw, OFP10_VERSION, 0);
2749 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
2750 ofputil_match_to_ofp10_match(&fsr->match, &ofsr->match);
2751 ofsr->table_id = fsr->table_id;
2752 ofsr->out_port = htons(ofp_to_u16(fsr->out_port));
2756 case OFPUTIL_P_OF10_NXM:
2757 case OFPUTIL_P_OF10_NXM_TID: {
2758 struct nx_flow_stats_request *nfsr;
2761 raw = (fsr->aggregate
2762 ? OFPRAW_NXST_AGGREGATE_REQUEST
2763 : OFPRAW_NXST_FLOW_REQUEST);
2764 msg = ofpraw_alloc(raw, OFP10_VERSION, NXM_TYPICAL_LEN);
2765 ofpbuf_put_zeros(msg, sizeof *nfsr);
2766 match_len = nx_put_match(msg, &fsr->match,
2767 fsr->cookie, fsr->cookie_mask);
2770 nfsr->out_port = htons(ofp_to_u16(fsr->out_port));
2771 nfsr->match_len = htons(match_len);
2772 nfsr->table_id = fsr->table_id;
2783 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
2784 * ofputil_flow_stats in 'fs'.
2786 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
2787 * OpenFlow message. Calling this function multiple times for a single 'msg'
2788 * iterates through the replies. The caller must initially leave 'msg''s layer
2789 * pointers null and not modify them between calls.
2791 * Most switches don't send the values needed to populate fs->idle_age and
2792 * fs->hard_age, so those members will usually be set to 0. If the switch from
2793 * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
2794 * 'flow_age_extension' as true so that the contents of 'msg' determine the
2795 * 'idle_age' and 'hard_age' members in 'fs'.
2797 * Uses 'ofpacts' to store the abstract OFPACT_* version of the flow stats
2798 * reply's actions. The caller must initialize 'ofpacts' and retains ownership
2799 * of it. 'fs->ofpacts' will point into the 'ofpacts' buffer.
2801 * Returns 0 if successful, EOF if no replies were left in this 'msg',
2802 * otherwise a positive errno value. */
2804 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
2806 bool flow_age_extension,
2807 struct ofpbuf *ofpacts)
2809 const struct ofp_header *oh;
2810 size_t instructions_len;
2814 error = (msg->header ? ofpraw_decode(&raw, msg->header)
2815 : ofpraw_pull(&raw, msg));
2823 } else if (raw == OFPRAW_OFPST11_FLOW_REPLY
2824 || raw == OFPRAW_OFPST13_FLOW_REPLY) {
2825 const struct ofp11_flow_stats *ofs;
2827 uint16_t padded_match_len;
2829 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2831 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %"PRIu32" leftover "
2832 "bytes at end", msg->size);
2836 length = ntohs(ofs->length);
2837 if (length < sizeof *ofs) {
2838 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2839 "length %"PRIuSIZE, length);
2843 if (ofputil_pull_ofp11_match(msg, &fs->match, &padded_match_len)) {
2844 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad match");
2847 instructions_len = length - sizeof *ofs - padded_match_len;
2849 fs->priority = ntohs(ofs->priority);
2850 fs->table_id = ofs->table_id;
2851 fs->duration_sec = ntohl(ofs->duration_sec);
2852 fs->duration_nsec = ntohl(ofs->duration_nsec);
2853 fs->idle_timeout = ntohs(ofs->idle_timeout);
2854 fs->hard_timeout = ntohs(ofs->hard_timeout);
2855 if (oh->version >= OFP14_VERSION) {
2856 fs->importance = ntohs(ofs->importance);
2860 if (raw == OFPRAW_OFPST13_FLOW_REPLY) {
2861 error = ofputil_decode_flow_mod_flags(ofs->flags, -1, oh->version,
2871 fs->cookie = ofs->cookie;
2872 fs->packet_count = ntohll(ofs->packet_count);
2873 fs->byte_count = ntohll(ofs->byte_count);
2874 } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
2875 const struct ofp10_flow_stats *ofs;
2878 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2880 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %"PRIu32" leftover "
2881 "bytes at end", msg->size);
2885 length = ntohs(ofs->length);
2886 if (length < sizeof *ofs) {
2887 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2888 "length %"PRIuSIZE, length);
2891 instructions_len = length - sizeof *ofs;
2893 fs->cookie = get_32aligned_be64(&ofs->cookie);
2894 ofputil_match_from_ofp10_match(&ofs->match, &fs->match);
2895 fs->priority = ntohs(ofs->priority);
2896 fs->table_id = ofs->table_id;
2897 fs->duration_sec = ntohl(ofs->duration_sec);
2898 fs->duration_nsec = ntohl(ofs->duration_nsec);
2899 fs->idle_timeout = ntohs(ofs->idle_timeout);
2900 fs->hard_timeout = ntohs(ofs->hard_timeout);
2904 fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
2905 fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
2907 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
2908 const struct nx_flow_stats *nfs;
2909 size_t match_len, length;
2911 nfs = ofpbuf_try_pull(msg, sizeof *nfs);
2913 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %"PRIu32" leftover "
2914 "bytes at end", msg->size);
2918 length = ntohs(nfs->length);
2919 match_len = ntohs(nfs->match_len);
2920 if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
2921 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%"PRIuSIZE" "
2922 "claims invalid length %"PRIuSIZE, match_len, length);
2925 if (nx_pull_match(msg, match_len, &fs->match, NULL, NULL)) {
2928 instructions_len = length - sizeof *nfs - ROUND_UP(match_len, 8);
2930 fs->cookie = nfs->cookie;
2931 fs->table_id = nfs->table_id;
2932 fs->duration_sec = ntohl(nfs->duration_sec);
2933 fs->duration_nsec = ntohl(nfs->duration_nsec);
2934 fs->priority = ntohs(nfs->priority);
2935 fs->idle_timeout = ntohs(nfs->idle_timeout);
2936 fs->hard_timeout = ntohs(nfs->hard_timeout);
2940 if (flow_age_extension) {
2941 if (nfs->idle_age) {
2942 fs->idle_age = ntohs(nfs->idle_age) - 1;
2944 if (nfs->hard_age) {
2945 fs->hard_age = ntohs(nfs->hard_age) - 1;
2948 fs->packet_count = ntohll(nfs->packet_count);
2949 fs->byte_count = ntohll(nfs->byte_count);
2955 if (ofpacts_pull_openflow_instructions(msg, instructions_len, oh->version,
2957 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad instructions");
2960 fs->ofpacts = ofpacts->data;
2961 fs->ofpacts_len = ofpacts->size;
2966 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
2968 * We use this in situations where OVS internally uses UINT64_MAX to mean
2969 * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
2971 unknown_to_zero(uint64_t count)
2973 return count != UINT64_MAX ? count : 0;
2976 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
2977 * those already present in the list of ofpbufs in 'replies'. 'replies' should
2978 * have been initialized with ofpmp_init(). */
2980 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
2981 struct ovs_list *replies)
2983 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
2984 size_t start_ofs = reply->size;
2985 enum ofp_version version = ofpmp_version(replies);
2986 enum ofpraw raw = ofpmp_decode_raw(replies);
2988 if (raw == OFPRAW_OFPST11_FLOW_REPLY || raw == OFPRAW_OFPST13_FLOW_REPLY) {
2989 struct ofp11_flow_stats *ofs;
2991 ofpbuf_put_uninit(reply, sizeof *ofs);
2992 oxm_put_match(reply, &fs->match, version);
2993 ofpacts_put_openflow_instructions(fs->ofpacts, fs->ofpacts_len, reply,
2996 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
2997 ofs->length = htons(reply->size - start_ofs);
2998 ofs->table_id = fs->table_id;
3000 ofs->duration_sec = htonl(fs->duration_sec);
3001 ofs->duration_nsec = htonl(fs->duration_nsec);
3002 ofs->priority = htons(fs->priority);
3003 ofs->idle_timeout = htons(fs->idle_timeout);
3004 ofs->hard_timeout = htons(fs->hard_timeout);
3005 if (version >= OFP14_VERSION) {
3006 ofs->importance = htons(fs->importance);
3008 ofs->importance = 0;
3010 if (raw == OFPRAW_OFPST13_FLOW_REPLY) {
3011 ofs->flags = ofputil_encode_flow_mod_flags(fs->flags, version);
3015 memset(ofs->pad2, 0, sizeof ofs->pad2);
3016 ofs->cookie = fs->cookie;
3017 ofs->packet_count = htonll(unknown_to_zero(fs->packet_count));
3018 ofs->byte_count = htonll(unknown_to_zero(fs->byte_count));
3019 } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
3020 struct ofp10_flow_stats *ofs;
3022 ofpbuf_put_uninit(reply, sizeof *ofs);
3023 ofpacts_put_openflow_actions(fs->ofpacts, fs->ofpacts_len, reply,
3025 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
3026 ofs->length = htons(reply->size - start_ofs);
3027 ofs->table_id = fs->table_id;
3029 ofputil_match_to_ofp10_match(&fs->match, &ofs->match);
3030 ofs->duration_sec = htonl(fs->duration_sec);
3031 ofs->duration_nsec = htonl(fs->duration_nsec);
3032 ofs->priority = htons(fs->priority);
3033 ofs->idle_timeout = htons(fs->idle_timeout);
3034 ofs->hard_timeout = htons(fs->hard_timeout);
3035 memset(ofs->pad2, 0, sizeof ofs->pad2);
3036 put_32aligned_be64(&ofs->cookie, fs->cookie);
3037 put_32aligned_be64(&ofs->packet_count,
3038 htonll(unknown_to_zero(fs->packet_count)));
3039 put_32aligned_be64(&ofs->byte_count,
3040 htonll(unknown_to_zero(fs->byte_count)));
3041 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
3042 struct nx_flow_stats *nfs;
3045 ofpbuf_put_uninit(reply, sizeof *nfs);
3046 match_len = nx_put_match(reply, &fs->match, 0, 0);
3047 ofpacts_put_openflow_actions(fs->ofpacts, fs->ofpacts_len, reply,
3049 nfs = ofpbuf_at_assert(reply, start_ofs, sizeof *nfs);
3050 nfs->length = htons(reply->size - start_ofs);
3051 nfs->table_id = fs->table_id;
3053 nfs->duration_sec = htonl(fs->duration_sec);
3054 nfs->duration_nsec = htonl(fs->duration_nsec);
3055 nfs->priority = htons(fs->priority);
3056 nfs->idle_timeout = htons(fs->idle_timeout);
3057 nfs->hard_timeout = htons(fs->hard_timeout);
3058 nfs->idle_age = htons(fs->idle_age < 0 ? 0
3059 : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
3061 nfs->hard_age = htons(fs->hard_age < 0 ? 0
3062 : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
3064 nfs->match_len = htons(match_len);
3065 nfs->cookie = fs->cookie;
3066 nfs->packet_count = htonll(fs->packet_count);
3067 nfs->byte_count = htonll(fs->byte_count);
3072 ofpmp_postappend(replies, start_ofs);
3075 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
3076 * NXST_AGGREGATE reply matching 'request', and returns the message. */
3078 ofputil_encode_aggregate_stats_reply(
3079 const struct ofputil_aggregate_stats *stats,
3080 const struct ofp_header *request)
3082 struct ofp_aggregate_stats_reply *asr;
3083 uint64_t packet_count;
3084 uint64_t byte_count;
3088 ofpraw_decode(&raw, request);
3089 if (raw == OFPRAW_OFPST10_AGGREGATE_REQUEST) {
3090 packet_count = unknown_to_zero(stats->packet_count);
3091 byte_count = unknown_to_zero(stats->byte_count);
3093 packet_count = stats->packet_count;
3094 byte_count = stats->byte_count;
3097 msg = ofpraw_alloc_stats_reply(request, 0);
3098 asr = ofpbuf_put_zeros(msg, sizeof *asr);
3099 put_32aligned_be64(&asr->packet_count, htonll(packet_count));
3100 put_32aligned_be64(&asr->byte_count, htonll(byte_count));
3101 asr->flow_count = htonl(stats->flow_count);
3107 ofputil_decode_aggregate_stats_reply(struct ofputil_aggregate_stats *stats,
3108 const struct ofp_header *reply)
3110 struct ofp_aggregate_stats_reply *asr;
3113 ofpbuf_use_const(&msg, reply, ntohs(reply->length));
3114 ofpraw_pull_assert(&msg);
3117 stats->packet_count = ntohll(get_32aligned_be64(&asr->packet_count));
3118 stats->byte_count = ntohll(get_32aligned_be64(&asr->byte_count));
3119 stats->flow_count = ntohl(asr->flow_count);
3124 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
3125 * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
3126 * an OpenFlow error code. */
3128 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
3129 const struct ofp_header *oh)
3134 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3135 raw = ofpraw_pull_assert(&b);
3136 if (raw == OFPRAW_OFPT11_FLOW_REMOVED) {
3137 const struct ofp12_flow_removed *ofr;
3140 ofr = ofpbuf_pull(&b, sizeof *ofr);
3142 error = ofputil_pull_ofp11_match(&b, &fr->match, NULL);
3147 fr->priority = ntohs(ofr->priority);
3148 fr->cookie = ofr->cookie;
3149 fr->reason = ofr->reason;
3150 fr->table_id = ofr->table_id;
3151 fr->duration_sec = ntohl(ofr->duration_sec);
3152 fr->duration_nsec = ntohl(ofr->duration_nsec);
3153 fr->idle_timeout = ntohs(ofr->idle_timeout);
3154 fr->hard_timeout = ntohs(ofr->hard_timeout);
3155 fr->packet_count = ntohll(ofr->packet_count);
3156 fr->byte_count = ntohll(ofr->byte_count);
3157 } else if (raw == OFPRAW_OFPT10_FLOW_REMOVED) {
3158 const struct ofp10_flow_removed *ofr;
3160 ofr = ofpbuf_pull(&b, sizeof *ofr);
3162 ofputil_match_from_ofp10_match(&ofr->match, &fr->match);
3163 fr->priority = ntohs(ofr->priority);
3164 fr->cookie = ofr->cookie;
3165 fr->reason = ofr->reason;
3167 fr->duration_sec = ntohl(ofr->duration_sec);
3168 fr->duration_nsec = ntohl(ofr->duration_nsec);
3169 fr->idle_timeout = ntohs(ofr->idle_timeout);
3170 fr->hard_timeout = 0;
3171 fr->packet_count = ntohll(ofr->packet_count);
3172 fr->byte_count = ntohll(ofr->byte_count);
3173 } else if (raw == OFPRAW_NXT_FLOW_REMOVED) {
3174 struct nx_flow_removed *nfr;
3177 nfr = ofpbuf_pull(&b, sizeof *nfr);
3178 error = nx_pull_match(&b, ntohs(nfr->match_len), &fr->match,
3184 return OFPERR_OFPBRC_BAD_LEN;
3187 fr->priority = ntohs(nfr->priority);
3188 fr->cookie = nfr->cookie;
3189 fr->reason = nfr->reason;
3190 fr->table_id = nfr->table_id ? nfr->table_id - 1 : 255;
3191 fr->duration_sec = ntohl(nfr->duration_sec);
3192 fr->duration_nsec = ntohl(nfr->duration_nsec);
3193 fr->idle_timeout = ntohs(nfr->idle_timeout);
3194 fr->hard_timeout = 0;
3195 fr->packet_count = ntohll(nfr->packet_count);
3196 fr->byte_count = ntohll(nfr->byte_count);
3204 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
3205 * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
3208 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
3209 enum ofputil_protocol protocol)
3212 enum ofp_flow_removed_reason reason = fr->reason;
3214 if (reason == OFPRR_METER_DELETE && !(protocol & OFPUTIL_P_OF14_UP)) {
3215 reason = OFPRR_DELETE;
3219 case OFPUTIL_P_OF11_STD:
3220 case OFPUTIL_P_OF12_OXM:
3221 case OFPUTIL_P_OF13_OXM:
3222 case OFPUTIL_P_OF14_OXM:
3223 case OFPUTIL_P_OF15_OXM: {
3224 struct ofp12_flow_removed *ofr;
3226 msg = ofpraw_alloc_xid(OFPRAW_OFPT11_FLOW_REMOVED,
3227 ofputil_protocol_to_ofp_version(protocol),
3229 ofputil_match_typical_len(protocol));
3230 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
3231 ofr->cookie = fr->cookie;
3232 ofr->priority = htons(fr->priority);
3233 ofr->reason = reason;
3234 ofr->table_id = fr->table_id;
3235 ofr->duration_sec = htonl(fr->duration_sec);
3236 ofr->duration_nsec = htonl(fr->duration_nsec);
3237 ofr->idle_timeout = htons(fr->idle_timeout);
3238 ofr->hard_timeout = htons(fr->hard_timeout);
3239 ofr->packet_count = htonll(fr->packet_count);
3240 ofr->byte_count = htonll(fr->byte_count);
3241 ofputil_put_ofp11_match(msg, &fr->match, protocol);
3245 case OFPUTIL_P_OF10_STD:
3246 case OFPUTIL_P_OF10_STD_TID: {
3247 struct ofp10_flow_removed *ofr;
3249 msg = ofpraw_alloc_xid(OFPRAW_OFPT10_FLOW_REMOVED, OFP10_VERSION,
3251 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
3252 ofputil_match_to_ofp10_match(&fr->match, &ofr->match);
3253 ofr->cookie = fr->cookie;
3254 ofr->priority = htons(fr->priority);
3255 ofr->reason = reason;
3256 ofr->duration_sec = htonl(fr->duration_sec);
3257 ofr->duration_nsec = htonl(fr->duration_nsec);
3258 ofr->idle_timeout = htons(fr->idle_timeout);
3259 ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
3260 ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
3264 case OFPUTIL_P_OF10_NXM:
3265 case OFPUTIL_P_OF10_NXM_TID: {
3266 struct nx_flow_removed *nfr;
3269 msg = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_REMOVED, OFP10_VERSION,
3270 htonl(0), NXM_TYPICAL_LEN);
3271 ofpbuf_put_zeros(msg, sizeof *nfr);
3272 match_len = nx_put_match(msg, &fr->match, 0, 0);
3275 nfr->cookie = fr->cookie;
3276 nfr->priority = htons(fr->priority);
3277 nfr->reason = reason;
3278 nfr->table_id = fr->table_id + 1;
3279 nfr->duration_sec = htonl(fr->duration_sec);
3280 nfr->duration_nsec = htonl(fr->duration_nsec);
3281 nfr->idle_timeout = htons(fr->idle_timeout);
3282 nfr->match_len = htons(match_len);
3283 nfr->packet_count = htonll(fr->packet_count);
3284 nfr->byte_count = htonll(fr->byte_count);
3296 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
3297 const struct ofp_header *oh)
3302 memset(pin, 0, sizeof *pin);
3303 pin->cookie = OVS_BE64_MAX;
3305 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3306 raw = ofpraw_pull_assert(&b);
3307 if (raw == OFPRAW_OFPT13_PACKET_IN || raw == OFPRAW_OFPT12_PACKET_IN) {
3308 const struct ofp13_packet_in *opi;
3310 size_t packet_in_size;
3312 if (raw == OFPRAW_OFPT12_PACKET_IN) {
3313 packet_in_size = sizeof (struct ofp12_packet_in);
3315 packet_in_size = sizeof (struct ofp13_packet_in);
3318 opi = ofpbuf_pull(&b, packet_in_size);
3319 error = oxm_pull_match_loose(&b, &pin->flow_metadata);
3324 if (!ofpbuf_try_pull(&b, 2)) {
3325 return OFPERR_OFPBRC_BAD_LEN;
3328 pin->reason = opi->pi.reason;
3329 pin->table_id = opi->pi.table_id;
3330 pin->buffer_id = ntohl(opi->pi.buffer_id);
3331 pin->total_len = ntohs(opi->pi.total_len);
3333 if (raw == OFPRAW_OFPT13_PACKET_IN) {
3334 pin->cookie = opi->cookie;
3337 pin->packet = b.data;
3338 pin->packet_len = b.size;
3339 } else if (raw == OFPRAW_OFPT10_PACKET_IN) {
3340 const struct ofp10_packet_in *opi;
3342 opi = ofpbuf_pull(&b, offsetof(struct ofp10_packet_in, data));
3344 pin->packet = opi->data;
3345 pin->packet_len = b.size;
3347 match_init_catchall(&pin->flow_metadata);
3348 match_set_in_port(&pin->flow_metadata, u16_to_ofp(ntohs(opi->in_port)));
3349 pin->reason = opi->reason;
3350 pin->buffer_id = ntohl(opi->buffer_id);
3351 pin->total_len = ntohs(opi->total_len);
3352 } else if (raw == OFPRAW_OFPT11_PACKET_IN) {
3353 const struct ofp11_packet_in *opi;
3357 opi = ofpbuf_pull(&b, sizeof *opi);
3359 pin->packet = b.data;
3360 pin->packet_len = b.size;
3362 pin->buffer_id = ntohl(opi->buffer_id);
3363 error = ofputil_port_from_ofp11(opi->in_port, &in_port);
3367 match_init_catchall(&pin->flow_metadata);
3368 match_set_in_port(&pin->flow_metadata, in_port);
3369 pin->total_len = ntohs(opi->total_len);
3370 pin->reason = opi->reason;
3371 pin->table_id = opi->table_id;
3372 } else if (raw == OFPRAW_NXT_PACKET_IN) {
3373 const struct nx_packet_in *npi;
3376 npi = ofpbuf_pull(&b, sizeof *npi);
3377 error = nx_pull_match_loose(&b, ntohs(npi->match_len),
3378 &pin->flow_metadata, NULL, NULL);
3383 if (!ofpbuf_try_pull(&b, 2)) {
3384 return OFPERR_OFPBRC_BAD_LEN;
3387 pin->reason = npi->reason;
3388 pin->table_id = npi->table_id;
3389 pin->cookie = npi->cookie;
3391 pin->buffer_id = ntohl(npi->buffer_id);
3392 pin->total_len = ntohs(npi->total_len);
3394 pin->packet = b.data;
3395 pin->packet_len = b.size;
3403 static struct ofpbuf *
3404 ofputil_encode_ofp10_packet_in(const struct ofputil_packet_in *pin)
3406 struct ofp10_packet_in *opi;
3407 struct ofpbuf *packet;
3409 packet = ofpraw_alloc_xid(OFPRAW_OFPT10_PACKET_IN, OFP10_VERSION,
3410 htonl(0), pin->packet_len);
3411 opi = ofpbuf_put_zeros(packet, offsetof(struct ofp10_packet_in, data));
3412 opi->total_len = htons(pin->total_len);
3413 opi->in_port = htons(ofp_to_u16(pin->flow_metadata.flow.in_port.ofp_port));
3414 opi->reason = pin->reason;
3415 opi->buffer_id = htonl(pin->buffer_id);
3417 ofpbuf_put(packet, pin->packet, pin->packet_len);
3422 static struct ofpbuf *
3423 ofputil_encode_nx_packet_in(const struct ofputil_packet_in *pin)
3425 struct nx_packet_in *npi;
3426 struct ofpbuf *packet;
3429 /* The final argument is just an estimate of the space required. */
3430 packet = ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN, OFP10_VERSION,
3431 htonl(0), NXM_TYPICAL_LEN + 2 + pin->packet_len);
3432 ofpbuf_put_zeros(packet, sizeof *npi);
3433 match_len = nx_put_match(packet, &pin->flow_metadata, 0, 0);
3434 ofpbuf_put_zeros(packet, 2);
3435 ofpbuf_put(packet, pin->packet, pin->packet_len);
3438 npi->buffer_id = htonl(pin->buffer_id);
3439 npi->total_len = htons(pin->total_len);
3440 npi->reason = pin->reason;
3441 npi->table_id = pin->table_id;
3442 npi->cookie = pin->cookie;
3443 npi->match_len = htons(match_len);
3448 static struct ofpbuf *
3449 ofputil_encode_ofp11_packet_in(const struct ofputil_packet_in *pin)
3451 struct ofp11_packet_in *opi;
3452 struct ofpbuf *packet;
3454 packet = ofpraw_alloc_xid(OFPRAW_OFPT11_PACKET_IN, OFP11_VERSION,
3455 htonl(0), pin->packet_len);
3456 opi = ofpbuf_put_zeros(packet, sizeof *opi);
3457 opi->buffer_id = htonl(pin->buffer_id);
3458 opi->in_port = ofputil_port_to_ofp11(pin->flow_metadata.flow.in_port.ofp_port);
3459 opi->in_phy_port = opi->in_port;
3460 opi->total_len = htons(pin->total_len);
3461 opi->reason = pin->reason;
3462 opi->table_id = pin->table_id;
3464 ofpbuf_put(packet, pin->packet, pin->packet_len);
3469 static struct ofpbuf *
3470 ofputil_encode_ofp12_packet_in(const struct ofputil_packet_in *pin,
3471 enum ofputil_protocol protocol)
3473 struct ofp13_packet_in *opi;
3474 enum ofpraw packet_in_raw;
3475 enum ofp_version packet_in_version;
3476 size_t packet_in_size;
3477 struct ofpbuf *packet;
3479 if (protocol == OFPUTIL_P_OF12_OXM) {
3480 packet_in_raw = OFPRAW_OFPT12_PACKET_IN;
3481 packet_in_version = OFP12_VERSION;
3482 packet_in_size = sizeof (struct ofp12_packet_in);
3484 packet_in_raw = OFPRAW_OFPT13_PACKET_IN;
3485 packet_in_version = ofputil_protocol_to_ofp_version(protocol);
3486 packet_in_size = sizeof (struct ofp13_packet_in);
3489 /* The final argument is just an estimate of the space required. */
3490 packet = ofpraw_alloc_xid(packet_in_raw, packet_in_version,
3491 htonl(0), NXM_TYPICAL_LEN + 2 + pin->packet_len);
3492 ofpbuf_put_zeros(packet, packet_in_size);
3493 oxm_put_match(packet, &pin->flow_metadata,
3494 ofputil_protocol_to_ofp_version(protocol));
3495 ofpbuf_put_zeros(packet, 2);
3496 ofpbuf_put(packet, pin->packet, pin->packet_len);
3499 opi->pi.buffer_id = htonl(pin->buffer_id);
3500 opi->pi.total_len = htons(pin->total_len);
3501 opi->pi.reason = pin->reason;
3502 opi->pi.table_id = pin->table_id;
3503 if (protocol != OFPUTIL_P_OF12_OXM) {
3504 opi->cookie = pin->cookie;
3510 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
3511 * in the format specified by 'packet_in_format'. */
3513 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
3514 enum ofputil_protocol protocol,
3515 enum nx_packet_in_format packet_in_format)
3517 struct ofpbuf *packet;
3520 case OFPUTIL_P_OF10_STD:
3521 case OFPUTIL_P_OF10_STD_TID:
3522 case OFPUTIL_P_OF10_NXM:
3523 case OFPUTIL_P_OF10_NXM_TID:
3524 packet = (packet_in_format == NXPIF_NXM
3525 ? ofputil_encode_nx_packet_in(pin)
3526 : ofputil_encode_ofp10_packet_in(pin));
3529 case OFPUTIL_P_OF11_STD:
3530 packet = ofputil_encode_ofp11_packet_in(pin);
3533 case OFPUTIL_P_OF12_OXM:
3534 case OFPUTIL_P_OF13_OXM:
3535 case OFPUTIL_P_OF14_OXM:
3536 case OFPUTIL_P_OF15_OXM:
3537 packet = ofputil_encode_ofp12_packet_in(pin, protocol);
3544 ofpmsg_update_length(packet);
3548 /* Returns a string form of 'reason'. The return value is either a statically
3549 * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
3550 * 'bufsize' should be at least OFPUTIL_PACKET_IN_REASON_BUFSIZE. */
3552 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason,
3553 char *reasonbuf, size_t bufsize)
3560 case OFPR_INVALID_TTL:
3561 return "invalid_ttl";
3562 case OFPR_ACTION_SET:
3563 return "action_set";
3566 case OFPR_PACKET_OUT:
3567 return "packet_out";
3569 case OFPR_N_REASONS:
3571 snprintf(reasonbuf, bufsize, "%d", (int) reason);
3577 ofputil_packet_in_reason_from_string(const char *s,
3578 enum ofp_packet_in_reason *reason)
3582 for (i = 0; i < OFPR_N_REASONS; i++) {
3583 char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
3584 const char *reason_s;
3586 reason_s = ofputil_packet_in_reason_to_string(i, reasonbuf,
3588 if (!strcasecmp(s, reason_s)) {
3596 /* Converts an OFPT_PACKET_OUT in 'opo' into an abstract ofputil_packet_out in
3599 * Uses 'ofpacts' to store the abstract OFPACT_* version of the packet out
3600 * message's actions. The caller must initialize 'ofpacts' and retains
3601 * ownership of it. 'po->ofpacts' will point into the 'ofpacts' buffer.
3603 * Returns 0 if successful, otherwise an OFPERR_* value. */
3605 ofputil_decode_packet_out(struct ofputil_packet_out *po,
3606 const struct ofp_header *oh,
3607 struct ofpbuf *ofpacts)
3612 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3613 raw = ofpraw_pull_assert(&b);
3615 if (raw == OFPRAW_OFPT11_PACKET_OUT) {
3617 const struct ofp11_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
3619 po->buffer_id = ntohl(opo->buffer_id);
3620 error = ofputil_port_from_ofp11(opo->in_port, &po->in_port);
3625 error = ofpacts_pull_openflow_actions(&b, ntohs(opo->actions_len),
3626 oh->version, ofpacts);
3630 } else if (raw == OFPRAW_OFPT10_PACKET_OUT) {
3632 const struct ofp10_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
3634 po->buffer_id = ntohl(opo->buffer_id);
3635 po->in_port = u16_to_ofp(ntohs(opo->in_port));
3637 error = ofpacts_pull_openflow_actions(&b, ntohs(opo->actions_len),
3638 oh->version, ofpacts);
3646 if (ofp_to_u16(po->in_port) >= ofp_to_u16(OFPP_MAX)
3647 && po->in_port != OFPP_LOCAL
3648 && po->in_port != OFPP_NONE && po->in_port != OFPP_CONTROLLER) {
3649 VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
3651 return OFPERR_OFPBRC_BAD_PORT;
3654 po->ofpacts = ofpacts->data;
3655 po->ofpacts_len = ofpacts->size;
3657 if (po->buffer_id == UINT32_MAX) {
3658 po->packet = b.data;
3659 po->packet_len = b.size;
3668 /* ofputil_phy_port */
3670 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
3671 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
3672 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
3673 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
3674 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
3675 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
3676 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
3677 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
3679 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
3680 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
3681 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
3682 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
3683 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
3684 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
3686 static enum netdev_features
3687 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
3689 uint32_t ofp10 = ntohl(ofp10_);
3690 return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
3694 netdev_port_features_to_ofp10(enum netdev_features features)
3696 return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
3699 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
3700 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
3701 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
3702 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
3703 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
3704 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
3705 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
3706 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD == OFPPF11_40GB_FD); /* bit 7 */
3707 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD == OFPPF11_100GB_FD); /* bit 8 */
3708 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD == OFPPF11_1TB_FD); /* bit 9 */
3709 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER == OFPPF11_OTHER); /* bit 10 */
3710 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == OFPPF11_COPPER); /* bit 11 */
3711 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == OFPPF11_FIBER); /* bit 12 */
3712 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == OFPPF11_AUTONEG); /* bit 13 */
3713 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == OFPPF11_PAUSE); /* bit 14 */
3714 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
3716 static enum netdev_features
3717 netdev_port_features_from_ofp11(ovs_be32 ofp11)
3719 return ntohl(ofp11) & 0xffff;
3723 netdev_port_features_to_ofp11(enum netdev_features features)
3725 return htonl(features & 0xffff);
3729 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
3730 const struct ofp10_phy_port *opp)
3732 pp->port_no = u16_to_ofp(ntohs(opp->port_no));
3733 pp->hw_addr = opp->hw_addr;
3734 ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
3736 pp->config = ntohl(opp->config) & OFPPC10_ALL;
3737 pp->state = ntohl(opp->state) & OFPPS10_ALL;
3739 pp->curr = netdev_port_features_from_ofp10(opp->curr);
3740 pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
3741 pp->supported = netdev_port_features_from_ofp10(opp->supported);
3742 pp->peer = netdev_port_features_from_ofp10(opp->peer);
3744 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
3745 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
3751 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
3752 const struct ofp11_port *op)
3756 error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
3760 pp->hw_addr = op->hw_addr;
3761 ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
3763 pp->config = ntohl(op->config) & OFPPC11_ALL;
3764 pp->state = ntohl(op->state) & OFPPS11_ALL;
3766 pp->curr = netdev_port_features_from_ofp11(op->curr);
3767 pp->advertised = netdev_port_features_from_ofp11(op->advertised);
3768 pp->supported = netdev_port_features_from_ofp11(op->supported);
3769 pp->peer = netdev_port_features_from_ofp11(op->peer);
3771 pp->curr_speed = ntohl(op->curr_speed);
3772 pp->max_speed = ntohl(op->max_speed);
3778 parse_ofp14_port_ethernet_property(const struct ofpbuf *payload,
3779 struct ofputil_phy_port *pp)
3781 struct ofp14_port_desc_prop_ethernet *eth = payload->data;
3783 if (payload->size != sizeof *eth) {
3784 return OFPERR_OFPBPC_BAD_LEN;
3787 pp->curr = netdev_port_features_from_ofp11(eth->curr);
3788 pp->advertised = netdev_port_features_from_ofp11(eth->advertised);
3789 pp->supported = netdev_port_features_from_ofp11(eth->supported);
3790 pp->peer = netdev_port_features_from_ofp11(eth->peer);
3792 pp->curr_speed = ntohl(eth->curr_speed);
3793 pp->max_speed = ntohl(eth->max_speed);
3799 ofputil_pull_ofp14_port(struct ofputil_phy_port *pp, struct ofpbuf *msg)
3801 struct ofpbuf properties;
3802 struct ofp14_port *op;
3806 op = ofpbuf_try_pull(msg, sizeof *op);
3808 return OFPERR_OFPBRC_BAD_LEN;
3811 len = ntohs(op->length);
3812 if (len < sizeof *op || len - sizeof *op > msg->size) {
3813 return OFPERR_OFPBRC_BAD_LEN;
3816 ofpbuf_use_const(&properties, ofpbuf_pull(msg, len), len);
3818 error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
3822 pp->hw_addr = op->hw_addr;
3823 ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
3825 pp->config = ntohl(op->config) & OFPPC11_ALL;
3826 pp->state = ntohl(op->state) & OFPPS11_ALL;
3828 while (properties.size > 0) {
3829 struct ofpbuf payload;
3833 error = ofputil_pull_property(&properties, &payload, &type);
3839 case OFPPDPT14_ETHERNET:
3840 error = parse_ofp14_port_ethernet_property(&payload, pp);
3844 log_property(true, "unknown port property %"PRIu16, type);
3858 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
3859 struct ofp10_phy_port *opp)
3861 memset(opp, 0, sizeof *opp);
3863 opp->port_no = htons(ofp_to_u16(pp->port_no));
3864 opp->hw_addr = pp->hw_addr;
3865 ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
3867 opp->config = htonl(pp->config & OFPPC10_ALL);
3868 opp->state = htonl(pp->state & OFPPS10_ALL);
3870 opp->curr = netdev_port_features_to_ofp10(pp->curr);
3871 opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
3872 opp->supported = netdev_port_features_to_ofp10(pp->supported);
3873 opp->peer = netdev_port_features_to_ofp10(pp->peer);
3877 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
3878 struct ofp11_port *op)
3880 memset(op, 0, sizeof *op);
3882 op->port_no = ofputil_port_to_ofp11(pp->port_no);
3883 op->hw_addr = pp->hw_addr;
3884 ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
3886 op->config = htonl(pp->config & OFPPC11_ALL);
3887 op->state = htonl(pp->state & OFPPS11_ALL);
3889 op->curr = netdev_port_features_to_ofp11(pp->curr);
3890 op->advertised = netdev_port_features_to_ofp11(pp->advertised);
3891 op->supported = netdev_port_features_to_ofp11(pp->supported);
3892 op->peer = netdev_port_features_to_ofp11(pp->peer);
3894 op->curr_speed = htonl(pp->curr_speed);
3895 op->max_speed = htonl(pp->max_speed);
3899 ofputil_put_ofp14_port(const struct ofputil_phy_port *pp,
3902 struct ofp14_port *op;
3903 struct ofp14_port_desc_prop_ethernet *eth;
3905 ofpbuf_prealloc_tailroom(b, sizeof *op + sizeof *eth);
3907 op = ofpbuf_put_zeros(b, sizeof *op);
3908 op->port_no = ofputil_port_to_ofp11(pp->port_no);
3909 op->length = htons(sizeof *op + sizeof *eth);
3910 op->hw_addr = pp->hw_addr;
3911 ovs_strlcpy(op->name, pp->name, sizeof op->name);
3912 op->config = htonl(pp->config & OFPPC11_ALL);
3913 op->state = htonl(pp->state & OFPPS11_ALL);
3915 eth = ofpbuf_put_zeros(b, sizeof *eth);
3916 eth->type = htons(OFPPDPT14_ETHERNET);
3917 eth->length = htons(sizeof *eth);
3918 eth->curr = netdev_port_features_to_ofp11(pp->curr);
3919 eth->advertised = netdev_port_features_to_ofp11(pp->advertised);
3920 eth->supported = netdev_port_features_to_ofp11(pp->supported);
3921 eth->peer = netdev_port_features_to_ofp11(pp->peer);
3922 eth->curr_speed = htonl(pp->curr_speed);
3923 eth->max_speed = htonl(pp->max_speed);
3927 ofputil_put_phy_port(enum ofp_version ofp_version,
3928 const struct ofputil_phy_port *pp, struct ofpbuf *b)
3930 switch (ofp_version) {
3931 case OFP10_VERSION: {
3932 struct ofp10_phy_port *opp = ofpbuf_put_uninit(b, sizeof *opp);
3933 ofputil_encode_ofp10_phy_port(pp, opp);
3939 case OFP13_VERSION: {
3940 struct ofp11_port *op = ofpbuf_put_uninit(b, sizeof *op);
3941 ofputil_encode_ofp11_port(pp, op);
3947 ofputil_put_ofp14_port(pp, b);
3956 ofputil_decode_port_desc_stats_request(const struct ofp_header *request,
3962 ofpbuf_use_const(&b, request, ntohs(request->length));
3963 raw = ofpraw_pull_assert(&b);
3964 if (raw == OFPRAW_OFPST10_PORT_DESC_REQUEST) {
3967 } else if (raw == OFPRAW_OFPST15_PORT_DESC_REQUEST) {
3968 ovs_be32 *ofp11_port;
3970 ofp11_port = ofpbuf_pull(&b, sizeof *ofp11_port);
3971 return ofputil_port_from_ofp11(*ofp11_port, port);
3978 ofputil_encode_port_desc_stats_request(enum ofp_version ofp_version,
3981 struct ofpbuf *request;
3983 switch (ofp_version) {
3989 request = ofpraw_alloc(OFPRAW_OFPST10_PORT_DESC_REQUEST,
3992 case OFP15_VERSION:{
3993 struct ofp15_port_desc_request *req;
3994 request = ofpraw_alloc(OFPRAW_OFPST15_PORT_DESC_REQUEST,
3996 req = ofpbuf_put_zeros(request, sizeof *req);
3997 req->port_no = ofputil_port_to_ofp11(port);
4008 ofputil_append_port_desc_stats_reply(const struct ofputil_phy_port *pp,
4009 struct ovs_list *replies)
4011 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
4012 size_t start_ofs = reply->size;
4014 ofputil_put_phy_port(ofpmp_version(replies), pp, reply);
4015 ofpmp_postappend(replies, start_ofs);
4018 /* ofputil_switch_features */
4020 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
4021 OFPC_IP_REASM | OFPC_QUEUE_STATS)
4022 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
4023 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
4024 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
4025 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
4026 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
4027 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
4030 ofputil_capabilities_mask(enum ofp_version ofp_version)
4032 /* Handle capabilities whose bit is unique for all OpenFlow versions */
4033 switch (ofp_version) {
4036 return OFPC_COMMON | OFPC_ARP_MATCH_IP;
4041 return OFPC_COMMON | OFPC12_PORT_BLOCKED;
4043 /* Caller needs to check osf->header.version itself */
4048 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
4049 * abstract representation in '*features'. Initializes '*b' to iterate over
4050 * the OpenFlow port structures following 'osf' with later calls to
4051 * ofputil_pull_phy_port(). Returns 0 if successful, otherwise an
4052 * OFPERR_* value. */
4054 ofputil_decode_switch_features(const struct ofp_header *oh,
4055 struct ofputil_switch_features *features,
4058 const struct ofp_switch_features *osf;
4061 ofpbuf_use_const(b, oh, ntohs(oh->length));
4062 raw = ofpraw_pull_assert(b);
4064 osf = ofpbuf_pull(b, sizeof *osf);
4065 features->datapath_id = ntohll(osf->datapath_id);
4066 features->n_buffers = ntohl(osf->n_buffers);
4067 features->n_tables = osf->n_tables;
4068 features->auxiliary_id = 0;
4070 features->capabilities = ntohl(osf->capabilities) &
4071 ofputil_capabilities_mask(oh->version);
4073 if (raw == OFPRAW_OFPT10_FEATURES_REPLY) {
4074 if (osf->capabilities & htonl(OFPC10_STP)) {
4075 features->capabilities |= OFPUTIL_C_STP;
4077 features->ofpacts = ofpact_bitmap_from_openflow(osf->actions,
4079 } else if (raw == OFPRAW_OFPT11_FEATURES_REPLY
4080 || raw == OFPRAW_OFPT13_FEATURES_REPLY) {
4081 if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
4082 features->capabilities |= OFPUTIL_C_GROUP_STATS;
4084 features->ofpacts = 0;
4085 if (raw == OFPRAW_OFPT13_FEATURES_REPLY) {
4086 features->auxiliary_id = osf->auxiliary_id;
4089 return OFPERR_OFPBRC_BAD_VERSION;
4095 /* In OpenFlow 1.0, 1.1, and 1.2, an OFPT_FEATURES_REPLY message lists all the
4096 * switch's ports, unless there are too many to fit. In OpenFlow 1.3 and
4097 * later, an OFPT_FEATURES_REPLY does not list ports at all.
4099 * Given a buffer 'b' that contains a Features Reply message, this message
4100 * checks if it contains a complete list of the switch's ports. Returns true,
4101 * if so. Returns false if the list is missing (OF1.3+) or incomplete
4102 * (OF1.0/1.1/1.2), and in the latter case removes all of the ports from the
4105 * When this function returns false, the caller should send an OFPST_PORT_DESC
4106 * stats request to get the ports. */
4108 ofputil_switch_features_has_ports(struct ofpbuf *b)
4110 struct ofp_header *oh = b->data;
4111 size_t phy_port_size;
4113 if (oh->version >= OFP13_VERSION) {
4114 /* OpenFlow 1.3+ never has ports in the feature reply. */
4118 phy_port_size = (oh->version == OFP10_VERSION
4119 ? sizeof(struct ofp10_phy_port)
4120 : sizeof(struct ofp11_port));
4121 if (ntohs(oh->length) + phy_port_size <= UINT16_MAX) {
4122 /* There's room for additional ports in the feature reply.
4123 * Assume that the list is complete. */
4127 /* The feature reply has no room for more ports. Probably the list is
4128 * truncated. Drop the ports and tell the caller to retrieve them with
4129 * OFPST_PORT_DESC. */
4130 b->size = sizeof *oh + sizeof(struct ofp_switch_features);
4131 ofpmsg_update_length(b);
4135 /* Returns a buffer owned by the caller that encodes 'features' in the format
4136 * required by 'protocol' with the given 'xid'. The caller should append port
4137 * information to the buffer with subsequent calls to
4138 * ofputil_put_switch_features_port(). */
4140 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
4141 enum ofputil_protocol protocol, ovs_be32 xid)
4143 struct ofp_switch_features *osf;
4145 enum ofp_version version;
4148 version = ofputil_protocol_to_ofp_version(protocol);
4151 raw = OFPRAW_OFPT10_FEATURES_REPLY;
4155 raw = OFPRAW_OFPT11_FEATURES_REPLY;
4160 raw = OFPRAW_OFPT13_FEATURES_REPLY;
4165 b = ofpraw_alloc_xid(raw, version, xid, 0);
4166 osf = ofpbuf_put_zeros(b, sizeof *osf);
4167 osf->datapath_id = htonll(features->datapath_id);
4168 osf->n_buffers = htonl(features->n_buffers);
4169 osf->n_tables = features->n_tables;
4171 osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
4172 osf->capabilities = htonl(features->capabilities &
4173 ofputil_capabilities_mask(version));
4176 if (features->capabilities & OFPUTIL_C_STP) {
4177 osf->capabilities |= htonl(OFPC10_STP);
4179 osf->actions = ofpact_bitmap_to_openflow(features->ofpacts,
4185 osf->auxiliary_id = features->auxiliary_id;
4189 if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
4190 osf->capabilities |= htonl(OFPC11_GROUP_STATS);
4200 /* Encodes 'pp' into the format required by the switch_features message already
4201 * in 'b', which should have been returned by ofputil_encode_switch_features(),
4202 * and appends the encoded version to 'b'. */
4204 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
4207 const struct ofp_header *oh = b->data;
4209 if (oh->version < OFP13_VERSION) {
4210 /* Try adding a port description to the message, but drop it again if
4211 * the buffer overflows. (This possibility for overflow is why
4212 * OpenFlow 1.3+ moved port descriptions into a multipart message.) */
4213 size_t start_ofs = b->size;
4214 ofputil_put_phy_port(oh->version, pp, b);
4215 if (b->size > UINT16_MAX) {
4216 b->size = start_ofs;
4221 /* ofputil_port_status */
4223 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
4224 * in '*ps'. Returns 0 if successful, otherwise an OFPERR_* value. */
4226 ofputil_decode_port_status(const struct ofp_header *oh,
4227 struct ofputil_port_status *ps)
4229 const struct ofp_port_status *ops;
4233 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4234 ofpraw_pull_assert(&b);
4235 ops = ofpbuf_pull(&b, sizeof *ops);
4237 if (ops->reason != OFPPR_ADD &&
4238 ops->reason != OFPPR_DELETE &&
4239 ops->reason != OFPPR_MODIFY) {
4240 return OFPERR_NXBRC_BAD_REASON;
4242 ps->reason = ops->reason;
4244 retval = ofputil_pull_phy_port(oh->version, &b, &ps->desc);
4245 ovs_assert(retval != EOF);
4249 /* Converts the abstract form of a "port status" message in '*ps' into an
4250 * OpenFlow message suitable for 'protocol', and returns that encoded form in
4251 * a buffer owned by the caller. */
4253 ofputil_encode_port_status(const struct ofputil_port_status *ps,
4254 enum ofputil_protocol protocol)
4256 struct ofp_port_status *ops;
4258 enum ofp_version version;
4261 version = ofputil_protocol_to_ofp_version(protocol);
4264 raw = OFPRAW_OFPT10_PORT_STATUS;
4270 raw = OFPRAW_OFPT11_PORT_STATUS;
4275 raw = OFPRAW_OFPT14_PORT_STATUS;
4282 b = ofpraw_alloc_xid(raw, version, htonl(0), 0);
4283 ops = ofpbuf_put_zeros(b, sizeof *ops);
4284 ops->reason = ps->reason;
4285 ofputil_put_phy_port(version, &ps->desc, b);
4286 ofpmsg_update_length(b);
4290 /* ofputil_port_mod */
4293 parse_port_mod_ethernet_property(struct ofpbuf *property,
4294 struct ofputil_port_mod *pm)
4296 struct ofp14_port_mod_prop_ethernet *eth = property->data;
4298 if (property->size != sizeof *eth) {
4299 return OFPERR_OFPBRC_BAD_LEN;
4302 pm->advertise = netdev_port_features_from_ofp11(eth->advertise);
4306 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
4307 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
4309 ofputil_decode_port_mod(const struct ofp_header *oh,
4310 struct ofputil_port_mod *pm, bool loose)
4315 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4316 raw = ofpraw_pull_assert(&b);
4318 if (raw == OFPRAW_OFPT10_PORT_MOD) {
4319 const struct ofp10_port_mod *opm = b.data;
4321 pm->port_no = u16_to_ofp(ntohs(opm->port_no));
4322 pm->hw_addr = opm->hw_addr;
4323 pm->config = ntohl(opm->config) & OFPPC10_ALL;
4324 pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
4325 pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
4326 } else if (raw == OFPRAW_OFPT11_PORT_MOD) {
4327 const struct ofp11_port_mod *opm = b.data;
4330 error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
4335 pm->hw_addr = opm->hw_addr;
4336 pm->config = ntohl(opm->config) & OFPPC11_ALL;
4337 pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
4338 pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
4339 } else if (raw == OFPRAW_OFPT14_PORT_MOD) {
4340 const struct ofp14_port_mod *opm = ofpbuf_pull(&b, sizeof *opm);
4343 memset(pm, 0, sizeof *pm);
4345 error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
4350 pm->hw_addr = opm->hw_addr;
4351 pm->config = ntohl(opm->config) & OFPPC11_ALL;
4352 pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
4354 while (b.size > 0) {
4355 struct ofpbuf property;
4359 error = ofputil_pull_property(&b, &property, &type);
4365 case OFPPMPT14_ETHERNET:
4366 error = parse_port_mod_ethernet_property(&property, pm);
4370 log_property(loose, "unknown port_mod property %"PRIu16, type);
4373 } else if (type == OFPPMPT14_EXPERIMENTER) {
4374 error = OFPERR_OFPBPC_BAD_EXPERIMENTER;
4376 error = OFPERR_OFPBRC_BAD_TYPE;
4386 return OFPERR_OFPBRC_BAD_TYPE;
4389 pm->config &= pm->mask;
4393 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
4394 * message suitable for 'protocol', and returns that encoded form in a buffer
4395 * owned by the caller. */
4397 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
4398 enum ofputil_protocol protocol)
4400 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
4403 switch (ofp_version) {
4404 case OFP10_VERSION: {
4405 struct ofp10_port_mod *opm;
4407 b = ofpraw_alloc(OFPRAW_OFPT10_PORT_MOD, ofp_version, 0);
4408 opm = ofpbuf_put_zeros(b, sizeof *opm);
4409 opm->port_no = htons(ofp_to_u16(pm->port_no));
4410 opm->hw_addr = pm->hw_addr;
4411 opm->config = htonl(pm->config & OFPPC10_ALL);
4412 opm->mask = htonl(pm->mask & OFPPC10_ALL);
4413 opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
4419 case OFP13_VERSION: {
4420 struct ofp11_port_mod *opm;
4422 b = ofpraw_alloc(OFPRAW_OFPT11_PORT_MOD, ofp_version, 0);
4423 opm = ofpbuf_put_zeros(b, sizeof *opm);
4424 opm->port_no = ofputil_port_to_ofp11(pm->port_no);
4425 opm->hw_addr = pm->hw_addr;
4426 opm->config = htonl(pm->config & OFPPC11_ALL);
4427 opm->mask = htonl(pm->mask & OFPPC11_ALL);
4428 opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
4432 case OFP15_VERSION: {
4433 struct ofp14_port_mod_prop_ethernet *eth;
4434 struct ofp14_port_mod *opm;
4436 b = ofpraw_alloc(OFPRAW_OFPT14_PORT_MOD, ofp_version, sizeof *eth);
4437 opm = ofpbuf_put_zeros(b, sizeof *opm);
4438 opm->port_no = ofputil_port_to_ofp11(pm->port_no);
4439 opm->hw_addr = pm->hw_addr;
4440 opm->config = htonl(pm->config & OFPPC11_ALL);
4441 opm->mask = htonl(pm->mask & OFPPC11_ALL);
4443 if (pm->advertise) {
4444 eth = ofpbuf_put_zeros(b, sizeof *eth);
4445 eth->type = htons(OFPPMPT14_ETHERNET);
4446 eth->length = htons(sizeof *eth);
4447 eth->advertise = netdev_port_features_to_ofp11(pm->advertise);
4458 /* Table features. */
4461 pull_table_feature_property(struct ofpbuf *msg, struct ofpbuf *payload,
4466 error = ofputil_pull_property(msg, payload, typep);
4467 if (payload && !error) {
4468 ofpbuf_pull(payload, sizeof(struct ofp_prop_header));
4474 parse_action_bitmap(struct ofpbuf *payload, enum ofp_version ofp_version,
4479 while (payload->size > 0) {
4483 error = ofputil_pull_property__(payload, NULL, 1, &type);
4487 if (type < CHAR_BIT * sizeof types) {
4488 types |= 1u << type;
4492 *ofpacts = ofpact_bitmap_from_openflow(htonl(types), ofp_version);
4497 parse_instruction_ids(struct ofpbuf *payload, bool loose, uint32_t *insts)
4500 while (payload->size > 0) {
4501 enum ovs_instruction_type inst;
4505 /* OF1.3 and OF1.4 aren't clear about padding in the instruction IDs.
4506 * It seems clear that they aren't padded to 8 bytes, though, because
4507 * both standards say that "non-experimenter instructions are 4 bytes"
4508 * and do not mention any padding before the first instruction ID.
4509 * (There wouldn't be any point in padding to 8 bytes if the IDs were
4510 * aligned on an odd 4-byte boundary.)
4512 * Anyway, we just assume they're all glommed together on byte
4514 error = ofputil_pull_property__(payload, NULL, 1, &ofpit);
4519 error = ovs_instruction_type_from_inst_type(&inst, ofpit);
4521 *insts |= 1u << inst;
4522 } else if (!loose) {
4530 parse_table_features_next_table(struct ofpbuf *payload,
4531 unsigned long int *next_tables)
4535 memset(next_tables, 0, bitmap_n_bytes(255));
4536 for (i = 0; i < payload->size; i++) {
4537 uint8_t id = ((const uint8_t *) payload->data)[i];
4539 return OFPERR_OFPBPC_BAD_VALUE;
4541 bitmap_set1(next_tables, id);
4547 parse_oxms(struct ofpbuf *payload, bool loose,
4548 struct mf_bitmap *exactp, struct mf_bitmap *maskedp)
4550 struct mf_bitmap exact = MF_BITMAP_INITIALIZER;
4551 struct mf_bitmap masked = MF_BITMAP_INITIALIZER;
4553 while (payload->size > 0) {
4554 const struct mf_field *field;
4558 error = nx_pull_header(payload, &field, &hasmask);
4560 bitmap_set1(hasmask ? masked.bm : exact.bm, field->id);
4561 } else if (error != OFPERR_OFPBMC_BAD_FIELD || !loose) {
4567 } else if (!bitmap_is_all_zeros(exact.bm, MFF_N_IDS)) {
4568 return OFPERR_OFPBMC_BAD_MASK;
4572 } else if (!bitmap_is_all_zeros(masked.bm, MFF_N_IDS)) {
4573 return OFPERR_OFPBMC_BAD_MASK;
4578 /* Converts an OFPMP_TABLE_FEATURES request or reply in 'msg' into an abstract
4579 * ofputil_table_features in 'tf'.
4581 * If 'loose' is true, this function ignores properties and values that it does
4582 * not understand, as a controller would want to do when interpreting
4583 * capabilities provided by a switch. If 'loose' is false, this function
4584 * treats unknown properties and values as an error, as a switch would want to
4585 * do when interpreting a configuration request made by a controller.
4587 * A single OpenFlow message can specify features for multiple tables. Calling
4588 * this function multiple times for a single 'msg' iterates through the tables
4589 * in the message. The caller must initially leave 'msg''s layer pointers null
4590 * and not modify them between calls.
4592 * Returns 0 if successful, EOF if no tables were left in this 'msg', otherwise
4593 * a positive "enum ofperr" value. */
4595 ofputil_decode_table_features(struct ofpbuf *msg,
4596 struct ofputil_table_features *tf, bool loose)
4598 const struct ofp_header *oh;
4599 struct ofp13_table_features *otf;
4600 struct ofpbuf properties;
4603 memset(tf, 0, sizeof *tf);
4606 ofpraw_pull_assert(msg);
4614 if (msg->size < sizeof *otf) {
4615 return OFPERR_OFPBPC_BAD_LEN;
4619 len = ntohs(otf->length);
4620 if (len < sizeof *otf || len % 8 || len > msg->size) {
4621 return OFPERR_OFPBPC_BAD_LEN;
4623 ofpbuf_use_const(&properties, ofpbuf_pull(msg, len), len);
4624 ofpbuf_pull(&properties, sizeof *otf);
4626 tf->table_id = otf->table_id;
4627 if (tf->table_id == OFPTT_ALL) {
4628 return OFPERR_OFPTFFC_BAD_TABLE;
4631 ovs_strlcpy(tf->name, otf->name, OFP_MAX_TABLE_NAME_LEN);
4632 tf->metadata_match = otf->metadata_match;
4633 tf->metadata_write = otf->metadata_write;
4634 tf->miss_config = OFPUTIL_TABLE_MISS_DEFAULT;
4635 if (oh->version >= OFP14_VERSION) {
4636 uint32_t caps = ntohl(otf->capabilities);
4637 tf->supports_eviction = (caps & OFPTC14_EVICTION) != 0;
4638 tf->supports_vacancy_events = (caps & OFPTC14_VACANCY_EVENTS) != 0;
4640 tf->supports_eviction = -1;
4641 tf->supports_vacancy_events = -1;
4643 tf->max_entries = ntohl(otf->max_entries);
4645 while (properties.size > 0) {
4646 struct ofpbuf payload;
4650 error = pull_table_feature_property(&properties, &payload, &type);
4655 switch ((enum ofp13_table_feature_prop_type) type) {
4656 case OFPTFPT13_INSTRUCTIONS:
4657 error = parse_instruction_ids(&payload, loose,
4658 &tf->nonmiss.instructions);
4660 case OFPTFPT13_INSTRUCTIONS_MISS:
4661 error = parse_instruction_ids(&payload, loose,
4662 &tf->miss.instructions);
4665 case OFPTFPT13_NEXT_TABLES:
4666 error = parse_table_features_next_table(&payload,
4669 case OFPTFPT13_NEXT_TABLES_MISS:
4670 error = parse_table_features_next_table(&payload, tf->miss.next);
4673 case OFPTFPT13_WRITE_ACTIONS:
4674 error = parse_action_bitmap(&payload, oh->version,
4675 &tf->nonmiss.write.ofpacts);
4677 case OFPTFPT13_WRITE_ACTIONS_MISS:
4678 error = parse_action_bitmap(&payload, oh->version,
4679 &tf->miss.write.ofpacts);
4682 case OFPTFPT13_APPLY_ACTIONS:
4683 error = parse_action_bitmap(&payload, oh->version,
4684 &tf->nonmiss.apply.ofpacts);
4686 case OFPTFPT13_APPLY_ACTIONS_MISS:
4687 error = parse_action_bitmap(&payload, oh->version,
4688 &tf->miss.apply.ofpacts);
4691 case OFPTFPT13_MATCH:
4692 error = parse_oxms(&payload, loose, &tf->match, &tf->mask);
4694 case OFPTFPT13_WILDCARDS:
4695 error = parse_oxms(&payload, loose, &tf->wildcard, NULL);
4698 case OFPTFPT13_WRITE_SETFIELD:
4699 error = parse_oxms(&payload, loose,
4700 &tf->nonmiss.write.set_fields, NULL);
4702 case OFPTFPT13_WRITE_SETFIELD_MISS:
4703 error = parse_oxms(&payload, loose,
4704 &tf->miss.write.set_fields, NULL);
4706 case OFPTFPT13_APPLY_SETFIELD:
4707 error = parse_oxms(&payload, loose,
4708 &tf->nonmiss.apply.set_fields, NULL);
4710 case OFPTFPT13_APPLY_SETFIELD_MISS:
4711 error = parse_oxms(&payload, loose,
4712 &tf->miss.apply.set_fields, NULL);
4715 case OFPTFPT13_EXPERIMENTER:
4716 case OFPTFPT13_EXPERIMENTER_MISS:
4718 log_property(loose, "unknown table features property %"PRIu16,
4720 error = loose ? 0 : OFPERR_OFPBPC_BAD_TYPE;
4728 /* Fix inconsistencies:
4730 * - Turn on 'match' bits that are set in 'mask', because maskable
4731 * fields are matchable.
4733 * - Turn on 'wildcard' bits that are set in 'mask', because a field
4734 * that is arbitrarily maskable can be wildcarded entirely.
4736 * - Turn off 'wildcard' bits that are not in 'match', because a field
4737 * must be matchable for it to be meaningfully wildcarded. */
4738 bitmap_or(tf->match.bm, tf->mask.bm, MFF_N_IDS);
4739 bitmap_or(tf->wildcard.bm, tf->mask.bm, MFF_N_IDS);
4740 bitmap_and(tf->wildcard.bm, tf->match.bm, MFF_N_IDS);
4745 /* Encodes and returns a request to obtain the table features of a switch.
4746 * The message is encoded for OpenFlow version 'ofp_version'. */
4748 ofputil_encode_table_features_request(enum ofp_version ofp_version)
4750 struct ofpbuf *request = NULL;
4752 switch (ofp_version) {
4756 ovs_fatal(0, "dump-table-features needs OpenFlow 1.3 or later "
4757 "(\'-O OpenFlow13\')");
4761 request = ofpraw_alloc(OFPRAW_OFPST13_TABLE_FEATURES_REQUEST,
4772 put_fields_property(struct ofpbuf *reply,
4773 const struct mf_bitmap *fields,
4774 const struct mf_bitmap *masks,
4775 enum ofp13_table_feature_prop_type property,
4776 enum ofp_version version)
4781 start_ofs = start_property(reply, property);
4782 BITMAP_FOR_EACH_1 (field, MFF_N_IDS, fields->bm) {
4783 nx_put_header(reply, field, version,
4784 masks && bitmap_is_set(masks->bm, field));
4786 end_property(reply, start_ofs);
4790 put_table_action_features(struct ofpbuf *reply,
4791 const struct ofputil_table_action_features *taf,
4792 enum ofp13_table_feature_prop_type actions_type,
4793 enum ofp13_table_feature_prop_type set_fields_type,
4794 int miss_offset, enum ofp_version version)
4798 start_ofs = start_property(reply, actions_type + miss_offset);
4799 put_bitmap_properties(reply,
4800 ntohl(ofpact_bitmap_to_openflow(taf->ofpacts,
4802 end_property(reply, start_ofs);
4804 put_fields_property(reply, &taf->set_fields, NULL,
4805 set_fields_type + miss_offset, version);
4809 put_table_instruction_features(
4810 struct ofpbuf *reply, const struct ofputil_table_instruction_features *tif,
4811 int miss_offset, enum ofp_version version)
4816 start_ofs = start_property(reply, OFPTFPT13_INSTRUCTIONS + miss_offset);
4817 put_bitmap_properties(reply,
4818 ntohl(ovsinst_bitmap_to_openflow(tif->instructions,
4820 end_property(reply, start_ofs);
4822 start_ofs = start_property(reply, OFPTFPT13_NEXT_TABLES + miss_offset);
4823 BITMAP_FOR_EACH_1 (table_id, 255, tif->next) {
4824 ofpbuf_put(reply, &table_id, 1);
4826 end_property(reply, start_ofs);
4828 put_table_action_features(reply, &tif->write,
4829 OFPTFPT13_WRITE_ACTIONS,
4830 OFPTFPT13_WRITE_SETFIELD, miss_offset, version);
4831 put_table_action_features(reply, &tif->apply,
4832 OFPTFPT13_APPLY_ACTIONS,
4833 OFPTFPT13_APPLY_SETFIELD, miss_offset, version);
4837 ofputil_append_table_features_reply(const struct ofputil_table_features *tf,
4838 struct ovs_list *replies)
4840 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
4841 enum ofp_version version = ofpmp_version(replies);
4842 size_t start_ofs = reply->size;
4843 struct ofp13_table_features *otf;
4845 otf = ofpbuf_put_zeros(reply, sizeof *otf);
4846 otf->table_id = tf->table_id;
4847 ovs_strlcpy(otf->name, tf->name, sizeof otf->name);
4848 otf->metadata_match = tf->metadata_match;
4849 otf->metadata_write = tf->metadata_write;
4850 if (version >= OFP14_VERSION) {
4851 if (tf->supports_eviction) {
4852 otf->capabilities |= htonl(OFPTC14_EVICTION);
4854 if (tf->supports_vacancy_events) {
4855 otf->capabilities |= htonl(OFPTC14_VACANCY_EVENTS);
4858 otf->max_entries = htonl(tf->max_entries);
4860 put_table_instruction_features(reply, &tf->nonmiss, 0, version);
4861 put_table_instruction_features(reply, &tf->miss, 1, version);
4863 put_fields_property(reply, &tf->match, &tf->mask,
4864 OFPTFPT13_MATCH, version);
4865 put_fields_property(reply, &tf->wildcard, NULL,
4866 OFPTFPT13_WILDCARDS, version);
4868 otf = ofpbuf_at_assert(reply, start_ofs, sizeof *otf);
4869 otf->length = htons(reply->size - start_ofs);
4870 ofpmp_postappend(replies, start_ofs);
4874 parse_table_desc_eviction_property(struct ofpbuf *property,
4875 struct ofputil_table_desc *td)
4877 struct ofp14_table_mod_prop_eviction *ote = property->data;
4879 if (property->size != sizeof *ote) {
4880 return OFPERR_OFPBPC_BAD_LEN;
4883 td->eviction_flags = ntohl(ote->flags);
4887 /* Decodes the next OpenFlow "table desc" message (of possibly several) from
4888 * 'msg' into an abstract form in '*td'. Returns 0 if successful, EOF if the
4889 * last "table desc" in 'msg' was already decoded, otherwise an OFPERR_*
4892 ofputil_decode_table_desc(struct ofpbuf *msg,
4893 struct ofputil_table_desc *td,
4894 enum ofp_version version)
4896 struct ofp14_table_desc *otd;
4897 struct ofpbuf properties;
4900 memset(td, 0, sizeof *td);
4903 ofpraw_pull_assert(msg);
4910 otd = ofpbuf_try_pull(msg, sizeof *otd);
4912 VLOG_WARN_RL(&bad_ofmsg_rl, "OFP14_TABLE_DESC reply has %"PRIu32" "
4913 "leftover bytes at end", msg->size);
4914 return OFPERR_OFPBRC_BAD_LEN;
4917 td->table_id = otd->table_id;
4918 length = ntohs(otd->length);
4919 if (length < sizeof *otd || length - sizeof *otd > msg->size) {
4920 VLOG_WARN_RL(&bad_ofmsg_rl, "OFP14_TABLE_DESC reply claims invalid "
4921 "length %"PRIuSIZE, length);
4922 return OFPERR_OFPBRC_BAD_LEN;
4924 length -= sizeof *otd;
4925 ofpbuf_use_const(&properties, ofpbuf_pull(msg, length), length);
4927 td->eviction = ofputil_decode_table_eviction(otd->config, version);
4928 td->eviction_flags = UINT32_MAX;
4930 while (properties.size > 0) {
4931 struct ofpbuf payload;
4935 error = ofputil_pull_property(&properties, &payload, &type);
4941 case OFPTMPT14_EVICTION:
4942 error = parse_table_desc_eviction_property(&payload, td);
4946 log_property(true, "unknown table_desc property %"PRIu16, type);
4959 /* Encodes and returns a request to obtain description of tables of a switch.
4960 * The message is encoded for OpenFlow version 'ofp_version'. */
4962 ofputil_encode_table_desc_request(enum ofp_version ofp_version)
4964 struct ofpbuf *request = NULL;
4966 if (ofp_version >= OFP14_VERSION) {
4967 request = ofpraw_alloc(OFPRAW_OFPST14_TABLE_DESC_REQUEST,
4970 ovs_fatal(0, "dump-table-desc needs OpenFlow 1.4 or later "
4971 "(\'-O OpenFlow14\')");
4977 /* Function to append Table desc information in a reply list. */
4979 ofputil_append_table_desc_reply(const struct ofputil_table_desc *td,
4980 struct ovs_list *replies,
4981 enum ofp_version version)
4983 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
4985 struct ofp14_table_desc *otd;
4987 start_otd = reply->size;
4988 ofpbuf_put_zeros(reply, sizeof *otd);
4989 if (td->eviction_flags != UINT32_MAX) {
4990 struct ofp14_table_mod_prop_eviction *ote;
4992 ote = ofpbuf_put_zeros(reply, sizeof *ote);
4993 ote->type = htons(OFPTMPT14_EVICTION);
4994 ote->length = htons(sizeof *ote);
4995 ote->flags = htonl(td->eviction_flags);
4998 otd = ofpbuf_at_assert(reply, start_otd, sizeof *otd);
4999 otd->length = htons(reply->size - start_otd);
5000 otd->table_id = td->table_id;
5001 otd->config = ofputil_encode_table_config(OFPUTIL_TABLE_MISS_DEFAULT,
5002 td->eviction, version);
5003 ofpmp_postappend(replies, start_otd);
5007 parse_table_mod_eviction_property(struct ofpbuf *property,
5008 struct ofputil_table_mod *tm)
5010 struct ofp14_table_mod_prop_eviction *ote = property->data;
5012 if (property->size != sizeof *ote) {
5013 return OFPERR_OFPBPC_BAD_LEN;
5016 tm->eviction_flags = ntohl(ote->flags);
5020 /* Given 'config', taken from an OpenFlow 'version' message that specifies
5021 * table configuration (a table mod, table stats, or table features message),
5022 * returns the table eviction configuration that it specifies.
5024 * Only OpenFlow 1.4 and later specify table eviction configuration this way,
5025 * so for other 'version' values this function always returns
5026 * OFPUTIL_TABLE_EVICTION_DEFAULT. */
5027 static enum ofputil_table_eviction
5028 ofputil_decode_table_eviction(ovs_be32 config, enum ofp_version version)
5030 return (version < OFP14_VERSION ? OFPUTIL_TABLE_EVICTION_DEFAULT
5031 : config & htonl(OFPTC14_EVICTION) ? OFPUTIL_TABLE_EVICTION_ON
5032 : OFPUTIL_TABLE_EVICTION_OFF);
5035 /* Returns a bitmap of OFPTC* values suitable for 'config' fields in various
5036 * OpenFlow messages of the given 'version', based on the provided 'miss' and
5037 * 'eviction' values. */
5039 ofputil_encode_table_config(enum ofputil_table_miss miss,
5040 enum ofputil_table_eviction eviction,
5041 enum ofp_version version)
5043 /* See the section "OFPTC_* Table Configuration" in DESIGN.md for more
5044 * information on the crazy evolution of this field. */
5047 /* OpenFlow 1.0 didn't have such a field, any value ought to do. */
5052 /* OpenFlow 1.1 and 1.2 define only OFPTC11_TABLE_MISS_*. */
5054 case OFPUTIL_TABLE_MISS_DEFAULT:
5055 /* Really this shouldn't be used for encoding (the caller should
5056 * provide a specific value) but I can't imagine that defaulting to
5057 * the fall-through case here will hurt. */
5058 case OFPUTIL_TABLE_MISS_CONTROLLER:
5060 return htonl(OFPTC11_TABLE_MISS_CONTROLLER);
5061 case OFPUTIL_TABLE_MISS_CONTINUE:
5062 return htonl(OFPTC11_TABLE_MISS_CONTINUE);
5063 case OFPUTIL_TABLE_MISS_DROP:
5064 return htonl(OFPTC11_TABLE_MISS_DROP);
5069 /* OpenFlow 1.3 removed OFPTC11_TABLE_MISS_* and didn't define any new
5070 * flags, so this is correct. */
5075 /* OpenFlow 1.4 introduced OFPTC14_EVICTION and OFPTC14_VACANCY_EVENTS
5076 * and we don't support the latter yet. */
5077 return htonl(eviction == OFPUTIL_TABLE_EVICTION_ON
5078 ? OFPTC14_EVICTION : 0);
5084 /* Given 'config', taken from an OpenFlow 'version' message that specifies
5085 * table configuration (a table mod, table stats, or table features message),
5086 * returns the table miss configuration that it specifies.
5088 * Only OpenFlow 1.1 and 1.2 specify table miss configurations this way, so for
5089 * other 'version' values this function always returns
5090 * OFPUTIL_TABLE_MISS_DEFAULT. */
5091 static enum ofputil_table_miss
5092 ofputil_decode_table_miss(ovs_be32 config_, enum ofp_version version)
5094 uint32_t config = ntohl(config_);
5096 if (version == OFP11_VERSION || version == OFP12_VERSION) {
5097 switch (config & OFPTC11_TABLE_MISS_MASK) {
5098 case OFPTC11_TABLE_MISS_CONTROLLER:
5099 return OFPUTIL_TABLE_MISS_CONTROLLER;
5101 case OFPTC11_TABLE_MISS_CONTINUE:
5102 return OFPUTIL_TABLE_MISS_CONTINUE;
5104 case OFPTC11_TABLE_MISS_DROP:
5105 return OFPUTIL_TABLE_MISS_DROP;
5108 VLOG_WARN_RL(&bad_ofmsg_rl, "bad table miss config %d", config);
5109 return OFPUTIL_TABLE_MISS_CONTROLLER;
5112 return OFPUTIL_TABLE_MISS_DEFAULT;
5116 /* Decodes the OpenFlow "table mod" message in '*oh' into an abstract form in
5117 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
5119 ofputil_decode_table_mod(const struct ofp_header *oh,
5120 struct ofputil_table_mod *pm)
5125 memset(pm, 0, sizeof *pm);
5126 pm->miss = OFPUTIL_TABLE_MISS_DEFAULT;
5127 pm->eviction = OFPUTIL_TABLE_EVICTION_DEFAULT;
5128 pm->eviction_flags = UINT32_MAX;
5129 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5130 raw = ofpraw_pull_assert(&b);
5132 if (raw == OFPRAW_OFPT11_TABLE_MOD) {
5133 const struct ofp11_table_mod *otm = b.data;
5135 pm->table_id = otm->table_id;
5136 pm->miss = ofputil_decode_table_miss(otm->config, oh->version);
5137 } else if (raw == OFPRAW_OFPT14_TABLE_MOD) {
5138 const struct ofp14_table_mod *otm = ofpbuf_pull(&b, sizeof *otm);
5140 pm->table_id = otm->table_id;
5141 pm->miss = ofputil_decode_table_miss(otm->config, oh->version);
5142 pm->eviction = ofputil_decode_table_eviction(otm->config, oh->version);
5143 while (b.size > 0) {
5144 struct ofpbuf property;
5148 error = ofputil_pull_property(&b, &property, &type);
5154 case OFPTMPT14_EVICTION:
5155 error = parse_table_mod_eviction_property(&property, pm);
5159 error = OFPERR_OFPBRC_BAD_TYPE;
5168 return OFPERR_OFPBRC_BAD_TYPE;
5174 /* Converts the abstract form of a "table mod" message in '*tm' into an
5175 * OpenFlow message suitable for 'protocol', and returns that encoded form in a
5176 * buffer owned by the caller. */
5178 ofputil_encode_table_mod(const struct ofputil_table_mod *tm,
5179 enum ofputil_protocol protocol)
5181 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
5184 switch (ofp_version) {
5185 case OFP10_VERSION: {
5186 ovs_fatal(0, "table mod needs OpenFlow 1.1 or later "
5187 "(\'-O OpenFlow11\')");
5192 case OFP13_VERSION: {
5193 struct ofp11_table_mod *otm;
5195 b = ofpraw_alloc(OFPRAW_OFPT11_TABLE_MOD, ofp_version, 0);
5196 otm = ofpbuf_put_zeros(b, sizeof *otm);
5197 otm->table_id = tm->table_id;
5198 otm->config = ofputil_encode_table_config(tm->miss, tm->eviction,
5203 case OFP15_VERSION: {
5204 struct ofp14_table_mod *otm;
5205 struct ofp14_table_mod_prop_eviction *ote;
5207 b = ofpraw_alloc(OFPRAW_OFPT14_TABLE_MOD, ofp_version, 0);
5208 otm = ofpbuf_put_zeros(b, sizeof *otm);
5209 otm->table_id = tm->table_id;
5210 otm->config = ofputil_encode_table_config(tm->miss, tm->eviction,
5213 if (tm->eviction_flags != UINT32_MAX) {
5214 ote = ofpbuf_put_zeros(b, sizeof *ote);
5215 ote->type = htons(OFPTMPT14_EVICTION);
5216 ote->length = htons(sizeof *ote);
5217 ote->flags = htonl(tm->eviction_flags);
5228 /* ofputil_role_request */
5230 /* Decodes the OpenFlow "role request" or "role reply" message in '*oh' into
5231 * an abstract form in '*rr'. Returns 0 if successful, otherwise an
5232 * OFPERR_* value. */
5234 ofputil_decode_role_message(const struct ofp_header *oh,
5235 struct ofputil_role_request *rr)
5240 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5241 raw = ofpraw_pull_assert(&b);
5243 if (raw == OFPRAW_OFPT12_ROLE_REQUEST ||
5244 raw == OFPRAW_OFPT12_ROLE_REPLY) {
5245 const struct ofp12_role_request *orr = b.msg;
5247 if (orr->role != htonl(OFPCR12_ROLE_NOCHANGE) &&
5248 orr->role != htonl(OFPCR12_ROLE_EQUAL) &&
5249 orr->role != htonl(OFPCR12_ROLE_MASTER) &&
5250 orr->role != htonl(OFPCR12_ROLE_SLAVE)) {
5251 return OFPERR_OFPRRFC_BAD_ROLE;
5254 rr->role = ntohl(orr->role);
5255 if (raw == OFPRAW_OFPT12_ROLE_REQUEST
5256 ? orr->role == htonl(OFPCR12_ROLE_NOCHANGE)
5257 : orr->generation_id == OVS_BE64_MAX) {
5258 rr->have_generation_id = false;
5259 rr->generation_id = 0;
5261 rr->have_generation_id = true;
5262 rr->generation_id = ntohll(orr->generation_id);
5264 } else if (raw == OFPRAW_NXT_ROLE_REQUEST ||
5265 raw == OFPRAW_NXT_ROLE_REPLY) {
5266 const struct nx_role_request *nrr = b.msg;
5268 BUILD_ASSERT(NX_ROLE_OTHER + 1 == OFPCR12_ROLE_EQUAL);
5269 BUILD_ASSERT(NX_ROLE_MASTER + 1 == OFPCR12_ROLE_MASTER);
5270 BUILD_ASSERT(NX_ROLE_SLAVE + 1 == OFPCR12_ROLE_SLAVE);
5272 if (nrr->role != htonl(NX_ROLE_OTHER) &&
5273 nrr->role != htonl(NX_ROLE_MASTER) &&
5274 nrr->role != htonl(NX_ROLE_SLAVE)) {
5275 return OFPERR_OFPRRFC_BAD_ROLE;
5278 rr->role = ntohl(nrr->role) + 1;
5279 rr->have_generation_id = false;
5280 rr->generation_id = 0;
5288 /* Returns an encoded form of a role reply suitable for the "request" in a
5289 * buffer owned by the caller. */
5291 ofputil_encode_role_reply(const struct ofp_header *request,
5292 const struct ofputil_role_request *rr)
5297 raw = ofpraw_decode_assert(request);
5298 if (raw == OFPRAW_OFPT12_ROLE_REQUEST) {
5299 struct ofp12_role_request *orr;
5301 buf = ofpraw_alloc_reply(OFPRAW_OFPT12_ROLE_REPLY, request, 0);
5302 orr = ofpbuf_put_zeros(buf, sizeof *orr);
5304 orr->role = htonl(rr->role);
5305 orr->generation_id = htonll(rr->have_generation_id
5308 } else if (raw == OFPRAW_NXT_ROLE_REQUEST) {
5309 struct nx_role_request *nrr;
5311 BUILD_ASSERT(NX_ROLE_OTHER == OFPCR12_ROLE_EQUAL - 1);
5312 BUILD_ASSERT(NX_ROLE_MASTER == OFPCR12_ROLE_MASTER - 1);
5313 BUILD_ASSERT(NX_ROLE_SLAVE == OFPCR12_ROLE_SLAVE - 1);
5315 buf = ofpraw_alloc_reply(OFPRAW_NXT_ROLE_REPLY, request, 0);
5316 nrr = ofpbuf_put_zeros(buf, sizeof *nrr);
5317 nrr->role = htonl(rr->role - 1);
5325 /* Encodes "role status" message 'status' for sending in the given
5326 * 'protocol'. Returns the role status message, if 'protocol' supports them,
5327 * otherwise a null pointer. */
5329 ofputil_encode_role_status(const struct ofputil_role_status *status,
5330 enum ofputil_protocol protocol)
5332 enum ofp_version version;
5334 version = ofputil_protocol_to_ofp_version(protocol);
5335 if (version >= OFP14_VERSION) {
5336 struct ofp14_role_status *rstatus;
5339 buf = ofpraw_alloc_xid(OFPRAW_OFPT14_ROLE_STATUS, version, htonl(0),
5341 rstatus = ofpbuf_put_zeros(buf, sizeof *rstatus);
5342 rstatus->role = htonl(status->role);
5343 rstatus->reason = status->reason;
5344 rstatus->generation_id = htonll(status->generation_id);
5353 ofputil_decode_role_status(const struct ofp_header *oh,
5354 struct ofputil_role_status *rs)
5358 const struct ofp14_role_status *r;
5360 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5361 raw = ofpraw_pull_assert(&b);
5362 ovs_assert(raw == OFPRAW_OFPT14_ROLE_STATUS);
5365 if (r->role != htonl(OFPCR12_ROLE_NOCHANGE) &&
5366 r->role != htonl(OFPCR12_ROLE_EQUAL) &&
5367 r->role != htonl(OFPCR12_ROLE_MASTER) &&
5368 r->role != htonl(OFPCR12_ROLE_SLAVE)) {
5369 return OFPERR_OFPRRFC_BAD_ROLE;
5372 rs->role = ntohl(r->role);
5373 rs->generation_id = ntohll(r->generation_id);
5374 rs->reason = r->reason;
5379 /* Encodes 'rf' according to 'protocol', and returns the encoded message.
5380 * 'protocol' must be for OpenFlow 1.4 or later. */
5382 ofputil_encode_requestforward(const struct ofputil_requestforward *rf,
5383 enum ofputil_protocol protocol)
5385 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
5386 struct ofpbuf *inner;
5388 switch (rf->reason) {
5389 case OFPRFR_GROUP_MOD:
5390 inner = ofputil_encode_group_mod(ofp_version, rf->group_mod);
5393 case OFPRFR_METER_MOD:
5394 inner = ofputil_encode_meter_mod(ofp_version, rf->meter_mod);
5401 struct ofp_header *inner_oh = inner->data;
5402 inner_oh->xid = rf->xid;
5403 inner_oh->length = htons(inner->size);
5405 struct ofpbuf *outer = ofpraw_alloc_xid(OFPRAW_OFPT14_REQUESTFORWARD,
5406 ofp_version, htonl(0),
5408 ofpbuf_put(outer, inner->data, inner->size);
5409 ofpbuf_delete(inner);
5414 /* Decodes OFPT_REQUESTFORWARD message 'outer'. On success, puts the decoded
5415 * form into '*rf' and returns 0, and the caller is later responsible for
5416 * freeing the content of 'rf', with ofputil_destroy_requestforward(rf). On
5417 * failure, returns an ofperr and '*rf' is indeterminate. */
5419 ofputil_decode_requestforward(const struct ofp_header *outer,
5420 struct ofputil_requestforward *rf)
5425 ofpbuf_use_const(&b, outer, ntohs(outer->length));
5427 /* Skip past outer message. */
5428 enum ofpraw outer_raw = ofpraw_pull_assert(&b);
5429 ovs_assert(outer_raw == OFPRAW_OFPT14_REQUESTFORWARD);
5431 /* Validate inner message. */
5432 if (b.size < sizeof(struct ofp_header)) {
5433 return OFPERR_OFPBFC_MSG_BAD_LEN;
5435 const struct ofp_header *inner = b.data;
5436 unsigned int inner_len = ntohs(inner->length);
5437 if (inner_len < sizeof(struct ofp_header) || inner_len > b.size) {
5438 return OFPERR_OFPBFC_MSG_BAD_LEN;
5440 if (inner->version != outer->version) {
5441 return OFPERR_OFPBRC_BAD_VERSION;
5444 /* Parse inner message. */
5446 error = ofptype_decode(&type, inner);
5451 rf->xid = inner->xid;
5452 if (type == OFPTYPE_GROUP_MOD) {
5453 rf->reason = OFPRFR_GROUP_MOD;
5454 rf->group_mod = xmalloc(sizeof *rf->group_mod);
5455 error = ofputil_decode_group_mod(inner, rf->group_mod);
5457 free(rf->group_mod);
5460 } else if (type == OFPTYPE_METER_MOD) {
5461 rf->reason = OFPRFR_METER_MOD;
5462 rf->meter_mod = xmalloc(sizeof *rf->meter_mod);
5463 ofpbuf_init(&rf->bands, 64);
5464 error = ofputil_decode_meter_mod(inner, rf->meter_mod, &rf->bands);
5466 free(rf->meter_mod);
5467 ofpbuf_uninit(&rf->bands);
5471 return OFPERR_OFPBFC_MSG_UNSUP;
5477 /* Frees the content of 'rf', which should have been initialized through a
5478 * successful call to ofputil_decode_requestforward(). */
5480 ofputil_destroy_requestforward(struct ofputil_requestforward *rf)
5486 switch (rf->reason) {
5487 case OFPRFR_GROUP_MOD:
5488 ofputil_uninit_group_mod(rf->group_mod);
5489 free(rf->group_mod);
5492 case OFPRFR_METER_MOD:
5493 ofpbuf_uninit(&rf->bands);
5494 free(rf->meter_mod);
5500 /* OpenFlow 1.0 and 1.1 don't distinguish between a field that cannot be
5501 * matched and a field that must be wildcarded. This function returns a bitmap
5502 * that contains both kinds of fields. */
5503 static struct mf_bitmap
5504 wild_or_nonmatchable_fields(const struct ofputil_table_features *features)
5506 struct mf_bitmap wc = features->match;
5507 bitmap_not(wc.bm, MFF_N_IDS);
5508 bitmap_or(wc.bm, features->wildcard.bm, MFF_N_IDS);
5512 struct ofp10_wc_map {
5513 enum ofp10_flow_wildcards wc10;
5514 enum mf_field_id mf;
5517 static const struct ofp10_wc_map ofp10_wc_map[] = {
5518 { OFPFW10_IN_PORT, MFF_IN_PORT },
5519 { OFPFW10_DL_VLAN, MFF_VLAN_VID },
5520 { OFPFW10_DL_SRC, MFF_ETH_SRC },
5521 { OFPFW10_DL_DST, MFF_ETH_DST},
5522 { OFPFW10_DL_TYPE, MFF_ETH_TYPE },
5523 { OFPFW10_NW_PROTO, MFF_IP_PROTO },
5524 { OFPFW10_TP_SRC, MFF_TCP_SRC },
5525 { OFPFW10_TP_DST, MFF_TCP_DST },
5526 { OFPFW10_NW_SRC_MASK, MFF_IPV4_SRC },
5527 { OFPFW10_NW_DST_MASK, MFF_IPV4_DST },
5528 { OFPFW10_DL_VLAN_PCP, MFF_VLAN_PCP },
5529 { OFPFW10_NW_TOS, MFF_IP_DSCP },
5533 mf_bitmap_to_of10(const struct mf_bitmap *fields)
5535 const struct ofp10_wc_map *p;
5538 for (p = ofp10_wc_map; p < &ofp10_wc_map[ARRAY_SIZE(ofp10_wc_map)]; p++) {
5539 if (bitmap_is_set(fields->bm, p->mf)) {
5546 static struct mf_bitmap
5547 mf_bitmap_from_of10(ovs_be32 wc10_)
5549 struct mf_bitmap fields = MF_BITMAP_INITIALIZER;
5550 const struct ofp10_wc_map *p;
5551 uint32_t wc10 = ntohl(wc10_);
5553 for (p = ofp10_wc_map; p < &ofp10_wc_map[ARRAY_SIZE(ofp10_wc_map)]; p++) {
5554 if (wc10 & p->wc10) {
5555 bitmap_set1(fields.bm, p->mf);
5562 ofputil_put_ofp10_table_stats(const struct ofputil_table_stats *stats,
5563 const struct ofputil_table_features *features,
5566 struct mf_bitmap wc = wild_or_nonmatchable_fields(features);
5567 struct ofp10_table_stats *out;
5569 out = ofpbuf_put_zeros(buf, sizeof *out);
5570 out->table_id = features->table_id;
5571 ovs_strlcpy(out->name, features->name, sizeof out->name);
5572 out->wildcards = mf_bitmap_to_of10(&wc);
5573 out->max_entries = htonl(features->max_entries);
5574 out->active_count = htonl(stats->active_count);
5575 put_32aligned_be64(&out->lookup_count, htonll(stats->lookup_count));
5576 put_32aligned_be64(&out->matched_count, htonll(stats->matched_count));
5579 struct ofp11_wc_map {
5580 enum ofp11_flow_match_fields wc11;
5581 enum mf_field_id mf;
5584 static const struct ofp11_wc_map ofp11_wc_map[] = {
5585 { OFPFMF11_IN_PORT, MFF_IN_PORT },
5586 { OFPFMF11_DL_VLAN, MFF_VLAN_VID },
5587 { OFPFMF11_DL_VLAN_PCP, MFF_VLAN_PCP },
5588 { OFPFMF11_DL_TYPE, MFF_ETH_TYPE },
5589 { OFPFMF11_NW_TOS, MFF_IP_DSCP },
5590 { OFPFMF11_NW_PROTO, MFF_IP_PROTO },
5591 { OFPFMF11_TP_SRC, MFF_TCP_SRC },
5592 { OFPFMF11_TP_DST, MFF_TCP_DST },
5593 { OFPFMF11_MPLS_LABEL, MFF_MPLS_LABEL },
5594 { OFPFMF11_MPLS_TC, MFF_MPLS_TC },
5595 /* I don't know what OFPFMF11_TYPE means. */
5596 { OFPFMF11_DL_SRC, MFF_ETH_SRC },
5597 { OFPFMF11_DL_DST, MFF_ETH_DST },
5598 { OFPFMF11_NW_SRC, MFF_IPV4_SRC },
5599 { OFPFMF11_NW_DST, MFF_IPV4_DST },
5600 { OFPFMF11_METADATA, MFF_METADATA },
5604 mf_bitmap_to_of11(const struct mf_bitmap *fields)
5606 const struct ofp11_wc_map *p;
5609 for (p = ofp11_wc_map; p < &ofp11_wc_map[ARRAY_SIZE(ofp11_wc_map)]; p++) {
5610 if (bitmap_is_set(fields->bm, p->mf)) {
5617 static struct mf_bitmap
5618 mf_bitmap_from_of11(ovs_be32 wc11_)
5620 struct mf_bitmap fields = MF_BITMAP_INITIALIZER;
5621 const struct ofp11_wc_map *p;
5622 uint32_t wc11 = ntohl(wc11_);
5624 for (p = ofp11_wc_map; p < &ofp11_wc_map[ARRAY_SIZE(ofp11_wc_map)]; p++) {
5625 if (wc11 & p->wc11) {
5626 bitmap_set1(fields.bm, p->mf);
5633 ofputil_put_ofp11_table_stats(const struct ofputil_table_stats *stats,
5634 const struct ofputil_table_features *features,
5637 struct mf_bitmap wc = wild_or_nonmatchable_fields(features);
5638 struct ofp11_table_stats *out;
5640 out = ofpbuf_put_zeros(buf, sizeof *out);
5641 out->table_id = features->table_id;
5642 ovs_strlcpy(out->name, features->name, sizeof out->name);
5643 out->wildcards = mf_bitmap_to_of11(&wc);
5644 out->match = mf_bitmap_to_of11(&features->match);
5645 out->instructions = ovsinst_bitmap_to_openflow(
5646 features->nonmiss.instructions, OFP11_VERSION);
5647 out->write_actions = ofpact_bitmap_to_openflow(
5648 features->nonmiss.write.ofpacts, OFP11_VERSION);
5649 out->apply_actions = ofpact_bitmap_to_openflow(
5650 features->nonmiss.apply.ofpacts, OFP11_VERSION);
5651 out->config = htonl(features->miss_config);
5652 out->max_entries = htonl(features->max_entries);
5653 out->active_count = htonl(stats->active_count);
5654 out->lookup_count = htonll(stats->lookup_count);
5655 out->matched_count = htonll(stats->matched_count);
5659 ofputil_put_ofp12_table_stats(const struct ofputil_table_stats *stats,
5660 const struct ofputil_table_features *features,
5663 struct ofp12_table_stats *out;
5665 out = ofpbuf_put_zeros(buf, sizeof *out);
5666 out->table_id = features->table_id;
5667 ovs_strlcpy(out->name, features->name, sizeof out->name);
5668 out->match = oxm_bitmap_from_mf_bitmap(&features->match, OFP12_VERSION);
5669 out->wildcards = oxm_bitmap_from_mf_bitmap(&features->wildcard,
5671 out->write_actions = ofpact_bitmap_to_openflow(
5672 features->nonmiss.write.ofpacts, OFP12_VERSION);
5673 out->apply_actions = ofpact_bitmap_to_openflow(
5674 features->nonmiss.apply.ofpacts, OFP12_VERSION);
5675 out->write_setfields = oxm_bitmap_from_mf_bitmap(
5676 &features->nonmiss.write.set_fields, OFP12_VERSION);
5677 out->apply_setfields = oxm_bitmap_from_mf_bitmap(
5678 &features->nonmiss.apply.set_fields, OFP12_VERSION);
5679 out->metadata_match = features->metadata_match;
5680 out->metadata_write = features->metadata_write;
5681 out->instructions = ovsinst_bitmap_to_openflow(
5682 features->nonmiss.instructions, OFP12_VERSION);
5683 out->config = ofputil_encode_table_config(features->miss_config,
5684 OFPUTIL_TABLE_EVICTION_DEFAULT,
5686 out->max_entries = htonl(features->max_entries);
5687 out->active_count = htonl(stats->active_count);
5688 out->lookup_count = htonll(stats->lookup_count);
5689 out->matched_count = htonll(stats->matched_count);
5693 ofputil_put_ofp13_table_stats(const struct ofputil_table_stats *stats,
5696 struct ofp13_table_stats *out;
5698 out = ofpbuf_put_zeros(buf, sizeof *out);
5699 out->table_id = stats->table_id;
5700 out->active_count = htonl(stats->active_count);
5701 out->lookup_count = htonll(stats->lookup_count);
5702 out->matched_count = htonll(stats->matched_count);
5706 ofputil_encode_table_stats_reply(const struct ofp_header *request)
5708 return ofpraw_alloc_stats_reply(request, 0);
5712 ofputil_append_table_stats_reply(struct ofpbuf *reply,
5713 const struct ofputil_table_stats *stats,
5714 const struct ofputil_table_features *features)
5716 struct ofp_header *oh = reply->header;
5718 ovs_assert(stats->table_id == features->table_id);
5720 switch ((enum ofp_version) oh->version) {
5722 ofputil_put_ofp10_table_stats(stats, features, reply);
5726 ofputil_put_ofp11_table_stats(stats, features, reply);
5730 ofputil_put_ofp12_table_stats(stats, features, reply);
5736 ofputil_put_ofp13_table_stats(stats, reply);
5745 ofputil_decode_ofp10_table_stats(struct ofpbuf *msg,
5746 struct ofputil_table_stats *stats,
5747 struct ofputil_table_features *features)
5749 struct ofp10_table_stats *ots;
5751 ots = ofpbuf_try_pull(msg, sizeof *ots);
5753 return OFPERR_OFPBRC_BAD_LEN;
5756 features->table_id = ots->table_id;
5757 ovs_strlcpy(features->name, ots->name, sizeof features->name);
5758 features->max_entries = ntohl(ots->max_entries);
5759 features->match = features->wildcard = mf_bitmap_from_of10(ots->wildcards);
5761 stats->table_id = ots->table_id;
5762 stats->active_count = ntohl(ots->active_count);
5763 stats->lookup_count = ntohll(get_32aligned_be64(&ots->lookup_count));
5764 stats->matched_count = ntohll(get_32aligned_be64(&ots->matched_count));
5770 ofputil_decode_ofp11_table_stats(struct ofpbuf *msg,
5771 struct ofputil_table_stats *stats,
5772 struct ofputil_table_features *features)
5774 struct ofp11_table_stats *ots;
5776 ots = ofpbuf_try_pull(msg, sizeof *ots);
5778 return OFPERR_OFPBRC_BAD_LEN;
5781 features->table_id = ots->table_id;
5782 ovs_strlcpy(features->name, ots->name, sizeof features->name);
5783 features->max_entries = ntohl(ots->max_entries);
5784 features->nonmiss.instructions = ovsinst_bitmap_from_openflow(
5785 ots->instructions, OFP11_VERSION);
5786 features->nonmiss.write.ofpacts = ofpact_bitmap_from_openflow(
5787 ots->write_actions, OFP11_VERSION);
5788 features->nonmiss.apply.ofpacts = ofpact_bitmap_from_openflow(
5789 ots->write_actions, OFP11_VERSION);
5790 features->miss = features->nonmiss;
5791 features->miss_config = ofputil_decode_table_miss(ots->config,
5793 features->match = mf_bitmap_from_of11(ots->match);
5794 features->wildcard = mf_bitmap_from_of11(ots->wildcards);
5795 bitmap_or(features->match.bm, features->wildcard.bm, MFF_N_IDS);
5797 stats->table_id = ots->table_id;
5798 stats->active_count = ntohl(ots->active_count);
5799 stats->lookup_count = ntohll(ots->lookup_count);
5800 stats->matched_count = ntohll(ots->matched_count);
5806 ofputil_decode_ofp12_table_stats(struct ofpbuf *msg,
5807 struct ofputil_table_stats *stats,
5808 struct ofputil_table_features *features)
5810 struct ofp12_table_stats *ots;
5812 ots = ofpbuf_try_pull(msg, sizeof *ots);
5814 return OFPERR_OFPBRC_BAD_LEN;
5817 features->table_id = ots->table_id;
5818 ovs_strlcpy(features->name, ots->name, sizeof features->name);
5819 features->metadata_match = ots->metadata_match;
5820 features->metadata_write = ots->metadata_write;
5821 features->miss_config = ofputil_decode_table_miss(ots->config,
5823 features->max_entries = ntohl(ots->max_entries);
5825 features->nonmiss.instructions = ovsinst_bitmap_from_openflow(
5826 ots->instructions, OFP12_VERSION);
5827 features->nonmiss.write.ofpacts = ofpact_bitmap_from_openflow(
5828 ots->write_actions, OFP12_VERSION);
5829 features->nonmiss.apply.ofpacts = ofpact_bitmap_from_openflow(
5830 ots->apply_actions, OFP12_VERSION);
5831 features->nonmiss.write.set_fields = oxm_bitmap_to_mf_bitmap(
5832 ots->write_setfields, OFP12_VERSION);
5833 features->nonmiss.apply.set_fields = oxm_bitmap_to_mf_bitmap(
5834 ots->apply_setfields, OFP12_VERSION);
5835 features->miss = features->nonmiss;
5837 features->match = oxm_bitmap_to_mf_bitmap(ots->match, OFP12_VERSION);
5838 features->wildcard = oxm_bitmap_to_mf_bitmap(ots->wildcards,
5840 bitmap_or(features->match.bm, features->wildcard.bm, MFF_N_IDS);
5842 stats->table_id = ots->table_id;
5843 stats->active_count = ntohl(ots->active_count);
5844 stats->lookup_count = ntohll(ots->lookup_count);
5845 stats->matched_count = ntohll(ots->matched_count);
5851 ofputil_decode_ofp13_table_stats(struct ofpbuf *msg,
5852 struct ofputil_table_stats *stats,
5853 struct ofputil_table_features *features)
5855 struct ofp13_table_stats *ots;
5857 ots = ofpbuf_try_pull(msg, sizeof *ots);
5859 return OFPERR_OFPBRC_BAD_LEN;
5862 features->table_id = ots->table_id;
5864 stats->table_id = ots->table_id;
5865 stats->active_count = ntohl(ots->active_count);
5866 stats->lookup_count = ntohll(ots->lookup_count);
5867 stats->matched_count = ntohll(ots->matched_count);
5873 ofputil_decode_table_stats_reply(struct ofpbuf *msg,
5874 struct ofputil_table_stats *stats,
5875 struct ofputil_table_features *features)
5877 const struct ofp_header *oh;
5880 ofpraw_pull_assert(msg);
5888 memset(stats, 0, sizeof *stats);
5889 memset(features, 0, sizeof *features);
5890 features->supports_eviction = -1;
5891 features->supports_vacancy_events = -1;
5893 switch ((enum ofp_version) oh->version) {
5895 return ofputil_decode_ofp10_table_stats(msg, stats, features);
5898 return ofputil_decode_ofp11_table_stats(msg, stats, features);
5901 return ofputil_decode_ofp12_table_stats(msg, stats, features);
5906 return ofputil_decode_ofp13_table_stats(msg, stats, features);
5913 /* ofputil_flow_monitor_request */
5915 /* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract
5916 * ofputil_flow_monitor_request in 'rq'.
5918 * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow
5919 * message. Calling this function multiple times for a single 'msg' iterates
5920 * through the requests. The caller must initially leave 'msg''s layer
5921 * pointers null and not modify them between calls.
5923 * Returns 0 if successful, EOF if no requests were left in this 'msg',
5924 * otherwise an OFPERR_* value. */
5926 ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *rq,
5929 struct nx_flow_monitor_request *nfmr;
5933 ofpraw_pull_assert(msg);
5940 nfmr = ofpbuf_try_pull(msg, sizeof *nfmr);
5942 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR request has %"PRIu32" "
5943 "leftover bytes at end", msg->size);
5944 return OFPERR_OFPBRC_BAD_LEN;
5947 flags = ntohs(nfmr->flags);
5948 if (!(flags & (NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY))
5949 || flags & ~(NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE
5950 | NXFMF_MODIFY | NXFMF_ACTIONS | NXFMF_OWN)) {
5951 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR has bad flags %#"PRIx16,
5953 return OFPERR_OFPMOFC_BAD_FLAGS;
5956 if (!is_all_zeros(nfmr->zeros, sizeof nfmr->zeros)) {
5957 return OFPERR_NXBRC_MUST_BE_ZERO;
5960 rq->id = ntohl(nfmr->id);
5962 rq->out_port = u16_to_ofp(ntohs(nfmr->out_port));
5963 rq->table_id = nfmr->table_id;
5965 return nx_pull_match(msg, ntohs(nfmr->match_len), &rq->match, NULL, NULL);
5969 ofputil_append_flow_monitor_request(
5970 const struct ofputil_flow_monitor_request *rq, struct ofpbuf *msg)
5972 struct nx_flow_monitor_request *nfmr;
5977 ofpraw_put(OFPRAW_NXST_FLOW_MONITOR_REQUEST, OFP10_VERSION, msg);
5980 start_ofs = msg->size;
5981 ofpbuf_put_zeros(msg, sizeof *nfmr);
5982 match_len = nx_put_match(msg, &rq->match, htonll(0), htonll(0));
5984 nfmr = ofpbuf_at_assert(msg, start_ofs, sizeof *nfmr);
5985 nfmr->id = htonl(rq->id);
5986 nfmr->flags = htons(rq->flags);
5987 nfmr->out_port = htons(ofp_to_u16(rq->out_port));
5988 nfmr->match_len = htons(match_len);
5989 nfmr->table_id = rq->table_id;
5992 /* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg'
5993 * into an abstract ofputil_flow_update in 'update'. The caller must have
5994 * initialized update->match to point to space allocated for a match.
5996 * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's
5997 * actions (except for NXFME_ABBREV, which never includes actions). The caller
5998 * must initialize 'ofpacts' and retains ownership of it. 'update->ofpacts'
5999 * will point into the 'ofpacts' buffer.
6001 * Multiple flow updates can be packed into a single OpenFlow message. Calling
6002 * this function multiple times for a single 'msg' iterates through the
6003 * updates. The caller must initially leave 'msg''s layer pointers null and
6004 * not modify them between calls.
6006 * Returns 0 if successful, EOF if no updates were left in this 'msg',
6007 * otherwise an OFPERR_* value. */
6009 ofputil_decode_flow_update(struct ofputil_flow_update *update,
6010 struct ofpbuf *msg, struct ofpbuf *ofpacts)
6012 struct nx_flow_update_header *nfuh;
6013 unsigned int length;
6014 struct ofp_header *oh;
6017 ofpraw_pull_assert(msg);
6024 if (msg->size < sizeof(struct nx_flow_update_header)) {
6031 update->event = ntohs(nfuh->event);
6032 length = ntohs(nfuh->length);
6033 if (length > msg->size || length % 8) {
6037 if (update->event == NXFME_ABBREV) {
6038 struct nx_flow_update_abbrev *nfua;
6040 if (length != sizeof *nfua) {
6044 nfua = ofpbuf_pull(msg, sizeof *nfua);
6045 update->xid = nfua->xid;
6047 } else if (update->event == NXFME_ADDED
6048 || update->event == NXFME_DELETED
6049 || update->event == NXFME_MODIFIED) {
6050 struct nx_flow_update_full *nfuf;
6051 unsigned int actions_len;
6052 unsigned int match_len;
6055 if (length < sizeof *nfuf) {
6059 nfuf = ofpbuf_pull(msg, sizeof *nfuf);
6060 match_len = ntohs(nfuf->match_len);
6061 if (sizeof *nfuf + match_len > length) {
6065 update->reason = ntohs(nfuf->reason);
6066 update->idle_timeout = ntohs(nfuf->idle_timeout);
6067 update->hard_timeout = ntohs(nfuf->hard_timeout);
6068 update->table_id = nfuf->table_id;
6069 update->cookie = nfuf->cookie;
6070 update->priority = ntohs(nfuf->priority);
6072 error = nx_pull_match(msg, match_len, update->match, NULL, NULL);
6077 actions_len = length - sizeof *nfuf - ROUND_UP(match_len, 8);
6078 error = ofpacts_pull_openflow_actions(msg, actions_len, oh->version,
6084 update->ofpacts = ofpacts->data;
6085 update->ofpacts_len = ofpacts->size;
6088 VLOG_WARN_RL(&bad_ofmsg_rl,
6089 "NXST_FLOW_MONITOR reply has bad event %"PRIu16,
6090 ntohs(nfuh->event));
6091 return OFPERR_NXBRC_FM_BAD_EVENT;
6095 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR reply has %"PRIu32" "
6096 "leftover bytes at end", msg->size);
6097 return OFPERR_OFPBRC_BAD_LEN;
6101 ofputil_decode_flow_monitor_cancel(const struct ofp_header *oh)
6103 const struct nx_flow_monitor_cancel *cancel = ofpmsg_body(oh);
6105 return ntohl(cancel->id);
6109 ofputil_encode_flow_monitor_cancel(uint32_t id)
6111 struct nx_flow_monitor_cancel *nfmc;
6114 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MONITOR_CANCEL, OFP10_VERSION, 0);
6115 nfmc = ofpbuf_put_uninit(msg, sizeof *nfmc);
6116 nfmc->id = htonl(id);
6121 ofputil_start_flow_update(struct ovs_list *replies)
6125 msg = ofpraw_alloc_xid(OFPRAW_NXST_FLOW_MONITOR_REPLY, OFP10_VERSION,
6129 list_push_back(replies, &msg->list_node);
6133 ofputil_append_flow_update(const struct ofputil_flow_update *update,
6134 struct ovs_list *replies)
6136 enum ofp_version version = ofpmp_version(replies);
6137 struct nx_flow_update_header *nfuh;
6141 msg = ofpbuf_from_list(list_back(replies));
6142 start_ofs = msg->size;
6144 if (update->event == NXFME_ABBREV) {
6145 struct nx_flow_update_abbrev *nfua;
6147 nfua = ofpbuf_put_zeros(msg, sizeof *nfua);
6148 nfua->xid = update->xid;
6150 struct nx_flow_update_full *nfuf;
6153 ofpbuf_put_zeros(msg, sizeof *nfuf);
6154 match_len = nx_put_match(msg, update->match, htonll(0), htonll(0));
6155 ofpacts_put_openflow_actions(update->ofpacts, update->ofpacts_len, msg,
6157 nfuf = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuf);
6158 nfuf->reason = htons(update->reason);
6159 nfuf->priority = htons(update->priority);
6160 nfuf->idle_timeout = htons(update->idle_timeout);
6161 nfuf->hard_timeout = htons(update->hard_timeout);
6162 nfuf->match_len = htons(match_len);
6163 nfuf->table_id = update->table_id;
6164 nfuf->cookie = update->cookie;
6167 nfuh = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuh);
6168 nfuh->length = htons(msg->size - start_ofs);
6169 nfuh->event = htons(update->event);
6171 ofpmp_postappend(replies, start_ofs);
6175 ofputil_encode_packet_out(const struct ofputil_packet_out *po,
6176 enum ofputil_protocol protocol)
6178 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
6182 size = po->ofpacts_len;
6183 if (po->buffer_id == UINT32_MAX) {
6184 size += po->packet_len;
6187 switch (ofp_version) {
6188 case OFP10_VERSION: {
6189 struct ofp10_packet_out *opo;
6192 msg = ofpraw_alloc(OFPRAW_OFPT10_PACKET_OUT, OFP10_VERSION, size);
6193 ofpbuf_put_zeros(msg, sizeof *opo);
6194 actions_ofs = msg->size;
6195 ofpacts_put_openflow_actions(po->ofpacts, po->ofpacts_len, msg,
6199 opo->buffer_id = htonl(po->buffer_id);
6200 opo->in_port = htons(ofp_to_u16(po->in_port));
6201 opo->actions_len = htons(msg->size - actions_ofs);
6209 case OFP15_VERSION: {
6210 struct ofp11_packet_out *opo;
6213 msg = ofpraw_alloc(OFPRAW_OFPT11_PACKET_OUT, ofp_version, size);
6214 ofpbuf_put_zeros(msg, sizeof *opo);
6215 len = ofpacts_put_openflow_actions(po->ofpacts, po->ofpacts_len, msg,
6218 opo->buffer_id = htonl(po->buffer_id);
6219 opo->in_port = ofputil_port_to_ofp11(po->in_port);
6220 opo->actions_len = htons(len);
6228 if (po->buffer_id == UINT32_MAX) {
6229 ofpbuf_put(msg, po->packet, po->packet_len);
6232 ofpmsg_update_length(msg);
6237 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
6239 make_echo_request(enum ofp_version ofp_version)
6241 return ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST, ofp_version,
6245 /* Creates and returns an OFPT_ECHO_REPLY message matching the
6246 * OFPT_ECHO_REQUEST message in 'rq'. */
6248 make_echo_reply(const struct ofp_header *rq)
6250 struct ofpbuf rq_buf;
6251 struct ofpbuf *reply;
6253 ofpbuf_use_const(&rq_buf, rq, ntohs(rq->length));
6254 ofpraw_pull_assert(&rq_buf);
6256 reply = ofpraw_alloc_reply(OFPRAW_OFPT_ECHO_REPLY, rq, rq_buf.size);
6257 ofpbuf_put(reply, rq_buf.data, rq_buf.size);
6262 ofputil_encode_barrier_request(enum ofp_version ofp_version)
6266 switch (ofp_version) {
6272 type = OFPRAW_OFPT11_BARRIER_REQUEST;
6276 type = OFPRAW_OFPT10_BARRIER_REQUEST;
6283 return ofpraw_alloc(type, ofp_version, 0);
6287 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
6289 switch (flags & OFPC_FRAG_MASK) {
6290 case OFPC_FRAG_NORMAL: return "normal";
6291 case OFPC_FRAG_DROP: return "drop";
6292 case OFPC_FRAG_REASM: return "reassemble";
6293 case OFPC_FRAG_NX_MATCH: return "nx-match";
6300 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
6302 if (!strcasecmp(s, "normal")) {
6303 *flags = OFPC_FRAG_NORMAL;
6304 } else if (!strcasecmp(s, "drop")) {
6305 *flags = OFPC_FRAG_DROP;
6306 } else if (!strcasecmp(s, "reassemble")) {
6307 *flags = OFPC_FRAG_REASM;
6308 } else if (!strcasecmp(s, "nx-match")) {
6309 *flags = OFPC_FRAG_NX_MATCH;
6316 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
6317 * port number and stores the latter in '*ofp10_port', for the purpose of
6318 * decoding OpenFlow 1.1+ protocol messages. Returns 0 if successful,
6319 * otherwise an OFPERR_* number. On error, stores OFPP_NONE in '*ofp10_port'.
6321 * See the definition of OFP11_MAX for an explanation of the mapping. */
6323 ofputil_port_from_ofp11(ovs_be32 ofp11_port, ofp_port_t *ofp10_port)
6325 uint32_t ofp11_port_h = ntohl(ofp11_port);
6327 if (ofp11_port_h < ofp_to_u16(OFPP_MAX)) {
6328 *ofp10_port = u16_to_ofp(ofp11_port_h);
6330 } else if (ofp11_port_h >= ofp11_to_u32(OFPP11_MAX)) {
6331 *ofp10_port = u16_to_ofp(ofp11_port_h - OFPP11_OFFSET);
6334 *ofp10_port = OFPP_NONE;
6335 VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
6336 "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
6337 ofp11_port_h, ofp_to_u16(OFPP_MAX) - 1,
6338 ofp11_to_u32(OFPP11_MAX), UINT32_MAX);
6339 return OFPERR_OFPBAC_BAD_OUT_PORT;
6343 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
6344 * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
6346 * See the definition of OFP11_MAX for an explanation of the mapping. */
6348 ofputil_port_to_ofp11(ofp_port_t ofp10_port)
6350 return htonl(ofp_to_u16(ofp10_port) < ofp_to_u16(OFPP_MAX)
6351 ? ofp_to_u16(ofp10_port)
6352 : ofp_to_u16(ofp10_port) + OFPP11_OFFSET);
6355 #define OFPUTIL_NAMED_PORTS \
6356 OFPUTIL_NAMED_PORT(IN_PORT) \
6357 OFPUTIL_NAMED_PORT(TABLE) \
6358 OFPUTIL_NAMED_PORT(NORMAL) \
6359 OFPUTIL_NAMED_PORT(FLOOD) \
6360 OFPUTIL_NAMED_PORT(ALL) \
6361 OFPUTIL_NAMED_PORT(CONTROLLER) \
6362 OFPUTIL_NAMED_PORT(LOCAL) \
6363 OFPUTIL_NAMED_PORT(ANY) \
6364 OFPUTIL_NAMED_PORT(UNSET)
6366 /* For backwards compatibility, so that "none" is recognized as OFPP_ANY */
6367 #define OFPUTIL_NAMED_PORTS_WITH_NONE \
6368 OFPUTIL_NAMED_PORTS \
6369 OFPUTIL_NAMED_PORT(NONE)
6371 /* Stores the port number represented by 's' into '*portp'. 's' may be an
6372 * integer or, for reserved ports, the standard OpenFlow name for the port
6375 * Returns true if successful, false if 's' is not a valid OpenFlow port number
6376 * or name. The caller should issue an error message in this case, because
6377 * this function usually does not. (This gives the caller an opportunity to
6378 * look up the port name another way, e.g. by contacting the switch and listing
6379 * the names of all its ports).
6381 * This function accepts OpenFlow 1.0 port numbers. It also accepts a subset
6382 * of OpenFlow 1.1+ port numbers, mapping those port numbers into the 16-bit
6383 * range as described in include/openflow/openflow-1.1.h. */
6385 ofputil_port_from_string(const char *s, ofp_port_t *portp)
6387 unsigned int port32; /* int is at least 32 bits wide. */
6390 VLOG_WARN("Negative value %s is not a valid port number.", s);
6394 if (str_to_uint(s, 10, &port32)) {
6395 if (port32 < ofp_to_u16(OFPP_MAX)) {
6397 } else if (port32 < ofp_to_u16(OFPP_FIRST_RESV)) {
6398 VLOG_WARN("port %u is a reserved OF1.0 port number that will "
6399 "be translated to %u when talking to an OF1.1 or "
6400 "later controller", port32, port32 + OFPP11_OFFSET);
6401 } else if (port32 <= ofp_to_u16(OFPP_LAST_RESV)) {
6402 char name[OFP_MAX_PORT_NAME_LEN];
6404 ofputil_port_to_string(u16_to_ofp(port32), name, sizeof name);
6405 VLOG_WARN_ONCE("referring to port %s as %"PRIu32" is deprecated "
6406 "for compatibility with OpenFlow 1.1 and later",
6408 } else if (port32 < ofp11_to_u32(OFPP11_MAX)) {
6409 VLOG_WARN("port %u is outside the supported range 0 through "
6410 "%"PRIx16" or 0x%x through 0x%"PRIx32, port32,
6411 UINT16_MAX, ofp11_to_u32(OFPP11_MAX), UINT32_MAX);
6414 port32 -= OFPP11_OFFSET;
6417 *portp = u16_to_ofp(port32);
6424 static const struct pair pairs[] = {
6425 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
6426 OFPUTIL_NAMED_PORTS_WITH_NONE
6427 #undef OFPUTIL_NAMED_PORT
6429 const struct pair *p;
6431 for (p = pairs; p < &pairs[ARRAY_SIZE(pairs)]; p++) {
6432 if (!strcasecmp(s, p->name)) {
6441 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
6442 * Most ports' string representation is just the port number, but for special
6443 * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
6445 ofputil_format_port(ofp_port_t port, struct ds *s)
6447 char name[OFP_MAX_PORT_NAME_LEN];
6449 ofputil_port_to_string(port, name, sizeof name);
6450 ds_put_cstr(s, name);
6453 /* Puts in the 'bufsize' byte in 'namebuf' a null-terminated string
6454 * representation of OpenFlow port number 'port'. Most ports are represented
6455 * as just the port number, but special ports, e.g. OFPP_LOCAL, are represented
6456 * by name, e.g. "LOCAL". */
6458 ofputil_port_to_string(ofp_port_t port,
6459 char namebuf[OFP_MAX_PORT_NAME_LEN], size_t bufsize)
6462 #define OFPUTIL_NAMED_PORT(NAME) \
6464 ovs_strlcpy(namebuf, #NAME, bufsize); \
6467 #undef OFPUTIL_NAMED_PORT
6470 snprintf(namebuf, bufsize, "%"PRIu16, port);
6475 /* Stores the group id represented by 's' into '*group_idp'. 's' may be an
6476 * integer or, for reserved group IDs, the standard OpenFlow name for the group
6477 * (either "ANY" or "ALL").
6479 * Returns true if successful, false if 's' is not a valid OpenFlow group ID or
6482 ofputil_group_from_string(const char *s, uint32_t *group_idp)
6484 if (!strcasecmp(s, "any")) {
6485 *group_idp = OFPG11_ANY;
6486 } else if (!strcasecmp(s, "all")) {
6487 *group_idp = OFPG11_ALL;
6488 } else if (!str_to_uint(s, 10, group_idp)) {
6489 VLOG_WARN("%s is not a valid group ID. (Valid group IDs are "
6490 "32-bit nonnegative integers or the keywords ANY or "
6498 /* Appends to 's' a string representation of the OpenFlow group ID 'group_id'.
6499 * Most groups' string representation is just the number, but for special
6500 * groups, e.g. OFPG11_ALL, it is the name, e.g. "ALL". */
6502 ofputil_format_group(uint32_t group_id, struct ds *s)
6504 char name[MAX_GROUP_NAME_LEN];
6506 ofputil_group_to_string(group_id, name, sizeof name);
6507 ds_put_cstr(s, name);
6511 /* Puts in the 'bufsize' byte in 'namebuf' a null-terminated string
6512 * representation of OpenFlow group ID 'group_id'. Most group are represented
6513 * as just their number, but special groups, e.g. OFPG11_ALL, are represented
6514 * by name, e.g. "ALL". */
6516 ofputil_group_to_string(uint32_t group_id,
6517 char namebuf[MAX_GROUP_NAME_LEN + 1], size_t bufsize)
6521 ovs_strlcpy(namebuf, "ALL", bufsize);
6525 ovs_strlcpy(namebuf, "ANY", bufsize);
6529 snprintf(namebuf, bufsize, "%"PRIu32, group_id);
6534 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
6535 * 'ofp_version', tries to pull the first element from the array. If
6536 * successful, initializes '*pp' with an abstract representation of the
6537 * port and returns 0. If no ports remain to be decoded, returns EOF.
6538 * On an error, returns a positive OFPERR_* value. */
6540 ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *b,
6541 struct ofputil_phy_port *pp)
6543 memset(pp, 0, sizeof *pp);
6545 switch (ofp_version) {
6546 case OFP10_VERSION: {
6547 const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
6548 return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
6552 case OFP13_VERSION: {
6553 const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
6554 return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
6558 return b->size ? ofputil_pull_ofp14_port(pp, b) : EOF;
6565 ofputil_normalize_match__(struct match *match, bool may_log)
6568 MAY_NW_ADDR = 1 << 0, /* nw_src, nw_dst */
6569 MAY_TP_ADDR = 1 << 1, /* tp_src, tp_dst */
6570 MAY_NW_PROTO = 1 << 2, /* nw_proto */
6571 MAY_IPVx = 1 << 3, /* tos, frag, ttl */
6572 MAY_ARP_SHA = 1 << 4, /* arp_sha */
6573 MAY_ARP_THA = 1 << 5, /* arp_tha */
6574 MAY_IPV6 = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
6575 MAY_ND_TARGET = 1 << 7, /* nd_target */
6576 MAY_MPLS = 1 << 8, /* mpls label and tc */
6579 struct flow_wildcards wc;
6581 /* Figure out what fields may be matched. */
6582 if (match->flow.dl_type == htons(ETH_TYPE_IP)) {
6583 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
6584 if (match->flow.nw_proto == IPPROTO_TCP ||
6585 match->flow.nw_proto == IPPROTO_UDP ||
6586 match->flow.nw_proto == IPPROTO_SCTP ||
6587 match->flow.nw_proto == IPPROTO_ICMP) {
6588 may_match |= MAY_TP_ADDR;
6590 } else if (match->flow.dl_type == htons(ETH_TYPE_IPV6)) {
6591 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
6592 if (match->flow.nw_proto == IPPROTO_TCP ||
6593 match->flow.nw_proto == IPPROTO_UDP ||
6594 match->flow.nw_proto == IPPROTO_SCTP) {
6595 may_match |= MAY_TP_ADDR;
6596 } else if (match->flow.nw_proto == IPPROTO_ICMPV6) {
6597 may_match |= MAY_TP_ADDR;
6598 if (match->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
6599 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
6600 } else if (match->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
6601 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
6604 } else if (match->flow.dl_type == htons(ETH_TYPE_ARP) ||
6605 match->flow.dl_type == htons(ETH_TYPE_RARP)) {
6606 may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
6607 } else if (eth_type_mpls(match->flow.dl_type)) {
6608 may_match = MAY_MPLS;
6613 /* Clear the fields that may not be matched. */
6615 if (!(may_match & MAY_NW_ADDR)) {
6616 wc.masks.nw_src = wc.masks.nw_dst = htonl(0);
6618 if (!(may_match & MAY_TP_ADDR)) {
6619 wc.masks.tp_src = wc.masks.tp_dst = htons(0);
6621 if (!(may_match & MAY_NW_PROTO)) {
6622 wc.masks.nw_proto = 0;
6624 if (!(may_match & MAY_IPVx)) {
6625 wc.masks.nw_tos = 0;
6626 wc.masks.nw_ttl = 0;
6628 if (!(may_match & MAY_ARP_SHA)) {
6629 WC_UNMASK_FIELD(&wc, arp_sha);
6631 if (!(may_match & MAY_ARP_THA)) {
6632 WC_UNMASK_FIELD(&wc, arp_tha);
6634 if (!(may_match & MAY_IPV6)) {
6635 wc.masks.ipv6_src = wc.masks.ipv6_dst = in6addr_any;
6636 wc.masks.ipv6_label = htonl(0);
6638 if (!(may_match & MAY_ND_TARGET)) {
6639 wc.masks.nd_target = in6addr_any;
6641 if (!(may_match & MAY_MPLS)) {
6642 memset(wc.masks.mpls_lse, 0, sizeof wc.masks.mpls_lse);
6645 /* Log any changes. */
6646 if (!flow_wildcards_equal(&wc, &match->wc)) {
6647 bool log = may_log && !VLOG_DROP_INFO(&bad_ofmsg_rl);
6648 char *pre = log ? match_to_string(match, OFP_DEFAULT_PRIORITY) : NULL;
6651 match_zero_wildcarded_fields(match);
6654 char *post = match_to_string(match, OFP_DEFAULT_PRIORITY);
6655 VLOG_INFO("normalization changed ofp_match, details:");
6656 VLOG_INFO(" pre: %s", pre);
6657 VLOG_INFO("post: %s", post);
6664 /* "Normalizes" the wildcards in 'match'. That means:
6666 * 1. If the type of level N is known, then only the valid fields for that
6667 * level may be specified. For example, ARP does not have a TOS field,
6668 * so nw_tos must be wildcarded if 'match' specifies an ARP flow.
6669 * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
6670 * ipv6_dst (and other fields) must be wildcarded if 'match' specifies an
6673 * 2. If the type of level N is not known (or not understood by Open
6674 * vSwitch), then no fields at all for that level may be specified. For
6675 * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
6676 * L4 fields tp_src and tp_dst must be wildcarded if 'match' specifies an
6679 * If this function changes 'match', it logs a rate-limited informational
6682 ofputil_normalize_match(struct match *match)
6684 ofputil_normalize_match__(match, true);
6687 /* Same as ofputil_normalize_match() without the logging. Thus, this function
6688 * is suitable for a program's internal use, whereas ofputil_normalize_match()
6689 * sense for use on flows received from elsewhere (so that a bug in the program
6690 * that sent them can be reported and corrected). */
6692 ofputil_normalize_match_quiet(struct match *match)
6694 ofputil_normalize_match__(match, false);
6697 /* Parses a key or a key-value pair from '*stringp'.
6699 * On success: Stores the key into '*keyp'. Stores the value, if present, into
6700 * '*valuep', otherwise an empty string. Advances '*stringp' past the end of
6701 * the key-value pair, preparing it for another call. '*keyp' and '*valuep'
6702 * are substrings of '*stringp' created by replacing some of its bytes by null
6703 * terminators. Returns true.
6705 * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
6706 * NULL and returns false. */
6708 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
6710 char *pos, *key, *value;
6714 pos += strspn(pos, ", \t\r\n");
6716 *keyp = *valuep = NULL;
6721 key_len = strcspn(pos, ":=(, \t\r\n");
6722 if (key[key_len] == ':' || key[key_len] == '=') {
6723 /* The value can be separated by a colon. */
6726 value = key + key_len + 1;
6727 value_len = strcspn(value, ", \t\r\n");
6728 pos = value + value_len + (value[value_len] != '\0');
6729 value[value_len] = '\0';
6730 } else if (key[key_len] == '(') {
6731 /* The value can be surrounded by balanced parentheses. The outermost
6732 * set of parentheses is removed. */
6736 value = key + key_len + 1;
6737 for (value_len = 0; level > 0; value_len++) {
6738 switch (value[value_len]) {
6752 value[value_len - 1] = '\0';
6753 pos = value + value_len;
6755 /* There might be no value at all. */
6756 value = key + key_len; /* Will become the empty string below. */
6757 pos = key + key_len + (key[key_len] != '\0');
6759 key[key_len] = '\0';
6767 /* Encode a dump ports request for 'port', the encoded message
6768 * will be for OpenFlow version 'ofp_version'. Returns message
6769 * as a struct ofpbuf. Returns encoded message on success, NULL on error */
6771 ofputil_encode_dump_ports_request(enum ofp_version ofp_version, ofp_port_t port)
6773 struct ofpbuf *request;
6775 switch (ofp_version) {
6776 case OFP10_VERSION: {
6777 struct ofp10_port_stats_request *req;
6778 request = ofpraw_alloc(OFPRAW_OFPST10_PORT_REQUEST, ofp_version, 0);
6779 req = ofpbuf_put_zeros(request, sizeof *req);
6780 req->port_no = htons(ofp_to_u16(port));
6787 case OFP15_VERSION: {
6788 struct ofp11_port_stats_request *req;
6789 request = ofpraw_alloc(OFPRAW_OFPST11_PORT_REQUEST, ofp_version, 0);
6790 req = ofpbuf_put_zeros(request, sizeof *req);
6791 req->port_no = ofputil_port_to_ofp11(port);
6802 ofputil_port_stats_to_ofp10(const struct ofputil_port_stats *ops,
6803 struct ofp10_port_stats *ps10)
6805 ps10->port_no = htons(ofp_to_u16(ops->port_no));
6806 memset(ps10->pad, 0, sizeof ps10->pad);
6807 put_32aligned_be64(&ps10->rx_packets, htonll(ops->stats.rx_packets));
6808 put_32aligned_be64(&ps10->tx_packets, htonll(ops->stats.tx_packets));
6809 put_32aligned_be64(&ps10->rx_bytes, htonll(ops->stats.rx_bytes));
6810 put_32aligned_be64(&ps10->tx_bytes, htonll(ops->stats.tx_bytes));
6811 put_32aligned_be64(&ps10->rx_dropped, htonll(ops->stats.rx_dropped));
6812 put_32aligned_be64(&ps10->tx_dropped, htonll(ops->stats.tx_dropped));
6813 put_32aligned_be64(&ps10->rx_errors, htonll(ops->stats.rx_errors));
6814 put_32aligned_be64(&ps10->tx_errors, htonll(ops->stats.tx_errors));
6815 put_32aligned_be64(&ps10->rx_frame_err, htonll(ops->stats.rx_frame_errors));
6816 put_32aligned_be64(&ps10->rx_over_err, htonll(ops->stats.rx_over_errors));
6817 put_32aligned_be64(&ps10->rx_crc_err, htonll(ops->stats.rx_crc_errors));
6818 put_32aligned_be64(&ps10->collisions, htonll(ops->stats.collisions));
6822 ofputil_port_stats_to_ofp11(const struct ofputil_port_stats *ops,
6823 struct ofp11_port_stats *ps11)
6825 ps11->port_no = ofputil_port_to_ofp11(ops->port_no);
6826 memset(ps11->pad, 0, sizeof ps11->pad);
6827 ps11->rx_packets = htonll(ops->stats.rx_packets);
6828 ps11->tx_packets = htonll(ops->stats.tx_packets);
6829 ps11->rx_bytes = htonll(ops->stats.rx_bytes);
6830 ps11->tx_bytes = htonll(ops->stats.tx_bytes);
6831 ps11->rx_dropped = htonll(ops->stats.rx_dropped);
6832 ps11->tx_dropped = htonll(ops->stats.tx_dropped);
6833 ps11->rx_errors = htonll(ops->stats.rx_errors);
6834 ps11->tx_errors = htonll(ops->stats.tx_errors);
6835 ps11->rx_frame_err = htonll(ops->stats.rx_frame_errors);
6836 ps11->rx_over_err = htonll(ops->stats.rx_over_errors);
6837 ps11->rx_crc_err = htonll(ops->stats.rx_crc_errors);
6838 ps11->collisions = htonll(ops->stats.collisions);
6842 ofputil_port_stats_to_ofp13(const struct ofputil_port_stats *ops,
6843 struct ofp13_port_stats *ps13)
6845 ofputil_port_stats_to_ofp11(ops, &ps13->ps);
6846 ps13->duration_sec = htonl(ops->duration_sec);
6847 ps13->duration_nsec = htonl(ops->duration_nsec);
6851 ofputil_append_ofp14_port_stats(const struct ofputil_port_stats *ops,
6852 struct ovs_list *replies)
6854 struct ofp14_port_stats_prop_ethernet *eth;
6855 struct ofp14_port_stats *ps14;
6856 struct ofpbuf *reply;
6858 reply = ofpmp_reserve(replies, sizeof *ps14 + sizeof *eth);
6860 ps14 = ofpbuf_put_uninit(reply, sizeof *ps14);
6861 ps14->length = htons(sizeof *ps14 + sizeof *eth);
6862 memset(ps14->pad, 0, sizeof ps14->pad);
6863 ps14->port_no = ofputil_port_to_ofp11(ops->port_no);
6864 ps14->duration_sec = htonl(ops->duration_sec);
6865 ps14->duration_nsec = htonl(ops->duration_nsec);
6866 ps14->rx_packets = htonll(ops->stats.rx_packets);
6867 ps14->tx_packets = htonll(ops->stats.tx_packets);
6868 ps14->rx_bytes = htonll(ops->stats.rx_bytes);
6869 ps14->tx_bytes = htonll(ops->stats.tx_bytes);
6870 ps14->rx_dropped = htonll(ops->stats.rx_dropped);
6871 ps14->tx_dropped = htonll(ops->stats.tx_dropped);
6872 ps14->rx_errors = htonll(ops->stats.rx_errors);
6873 ps14->tx_errors = htonll(ops->stats.tx_errors);
6875 eth = ofpbuf_put_uninit(reply, sizeof *eth);
6876 eth->type = htons(OFPPSPT14_ETHERNET);
6877 eth->length = htons(sizeof *eth);
6878 memset(eth->pad, 0, sizeof eth->pad);
6879 eth->rx_frame_err = htonll(ops->stats.rx_frame_errors);
6880 eth->rx_over_err = htonll(ops->stats.rx_over_errors);
6881 eth->rx_crc_err = htonll(ops->stats.rx_crc_errors);
6882 eth->collisions = htonll(ops->stats.collisions);
6885 /* Encode a ports stat for 'ops' and append it to 'replies'. */
6887 ofputil_append_port_stat(struct ovs_list *replies,
6888 const struct ofputil_port_stats *ops)
6890 switch (ofpmp_version(replies)) {
6891 case OFP13_VERSION: {
6892 struct ofp13_port_stats *reply = ofpmp_append(replies, sizeof *reply);
6893 ofputil_port_stats_to_ofp13(ops, reply);
6897 case OFP11_VERSION: {
6898 struct ofp11_port_stats *reply = ofpmp_append(replies, sizeof *reply);
6899 ofputil_port_stats_to_ofp11(ops, reply);
6903 case OFP10_VERSION: {
6904 struct ofp10_port_stats *reply = ofpmp_append(replies, sizeof *reply);
6905 ofputil_port_stats_to_ofp10(ops, reply);
6911 ofputil_append_ofp14_port_stats(ops, replies);
6920 ofputil_port_stats_from_ofp10(struct ofputil_port_stats *ops,
6921 const struct ofp10_port_stats *ps10)
6923 memset(ops, 0, sizeof *ops);
6925 ops->port_no = u16_to_ofp(ntohs(ps10->port_no));
6926 ops->stats.rx_packets = ntohll(get_32aligned_be64(&ps10->rx_packets));
6927 ops->stats.tx_packets = ntohll(get_32aligned_be64(&ps10->tx_packets));
6928 ops->stats.rx_bytes = ntohll(get_32aligned_be64(&ps10->rx_bytes));
6929 ops->stats.tx_bytes = ntohll(get_32aligned_be64(&ps10->tx_bytes));
6930 ops->stats.rx_dropped = ntohll(get_32aligned_be64(&ps10->rx_dropped));
6931 ops->stats.tx_dropped = ntohll(get_32aligned_be64(&ps10->tx_dropped));
6932 ops->stats.rx_errors = ntohll(get_32aligned_be64(&ps10->rx_errors));
6933 ops->stats.tx_errors = ntohll(get_32aligned_be64(&ps10->tx_errors));
6934 ops->stats.rx_frame_errors =
6935 ntohll(get_32aligned_be64(&ps10->rx_frame_err));
6936 ops->stats.rx_over_errors = ntohll(get_32aligned_be64(&ps10->rx_over_err));
6937 ops->stats.rx_crc_errors = ntohll(get_32aligned_be64(&ps10->rx_crc_err));
6938 ops->stats.collisions = ntohll(get_32aligned_be64(&ps10->collisions));
6939 ops->duration_sec = ops->duration_nsec = UINT32_MAX;
6945 ofputil_port_stats_from_ofp11(struct ofputil_port_stats *ops,
6946 const struct ofp11_port_stats *ps11)
6950 memset(ops, 0, sizeof *ops);
6951 error = ofputil_port_from_ofp11(ps11->port_no, &ops->port_no);
6956 ops->stats.rx_packets = ntohll(ps11->rx_packets);
6957 ops->stats.tx_packets = ntohll(ps11->tx_packets);
6958 ops->stats.rx_bytes = ntohll(ps11->rx_bytes);
6959 ops->stats.tx_bytes = ntohll(ps11->tx_bytes);
6960 ops->stats.rx_dropped = ntohll(ps11->rx_dropped);
6961 ops->stats.tx_dropped = ntohll(ps11->tx_dropped);
6962 ops->stats.rx_errors = ntohll(ps11->rx_errors);
6963 ops->stats.tx_errors = ntohll(ps11->tx_errors);
6964 ops->stats.rx_frame_errors = ntohll(ps11->rx_frame_err);
6965 ops->stats.rx_over_errors = ntohll(ps11->rx_over_err);
6966 ops->stats.rx_crc_errors = ntohll(ps11->rx_crc_err);
6967 ops->stats.collisions = ntohll(ps11->collisions);
6968 ops->duration_sec = ops->duration_nsec = UINT32_MAX;
6974 ofputil_port_stats_from_ofp13(struct ofputil_port_stats *ops,
6975 const struct ofp13_port_stats *ps13)
6977 enum ofperr error = ofputil_port_stats_from_ofp11(ops, &ps13->ps);
6979 ops->duration_sec = ntohl(ps13->duration_sec);
6980 ops->duration_nsec = ntohl(ps13->duration_nsec);
6986 parse_ofp14_port_stats_ethernet_property(const struct ofpbuf *payload,
6987 struct ofputil_port_stats *ops)
6989 const struct ofp14_port_stats_prop_ethernet *eth = payload->data;
6991 if (payload->size != sizeof *eth) {
6992 return OFPERR_OFPBPC_BAD_LEN;
6995 ops->stats.rx_frame_errors = ntohll(eth->rx_frame_err);
6996 ops->stats.rx_over_errors = ntohll(eth->rx_over_err);
6997 ops->stats.rx_crc_errors = ntohll(eth->rx_crc_err);
6998 ops->stats.collisions = ntohll(eth->collisions);
7004 ofputil_pull_ofp14_port_stats(struct ofputil_port_stats *ops,
7007 const struct ofp14_port_stats *ps14;
7008 struct ofpbuf properties;
7012 ps14 = ofpbuf_try_pull(msg, sizeof *ps14);
7014 return OFPERR_OFPBRC_BAD_LEN;
7017 len = ntohs(ps14->length);
7018 if (len < sizeof *ps14 || len - sizeof *ps14 > msg->size) {
7019 return OFPERR_OFPBRC_BAD_LEN;
7021 len -= sizeof *ps14;
7022 ofpbuf_use_const(&properties, ofpbuf_pull(msg, len), len);
7024 error = ofputil_port_from_ofp11(ps14->port_no, &ops->port_no);
7029 ops->duration_sec = ntohl(ps14->duration_sec);
7030 ops->duration_nsec = ntohl(ps14->duration_nsec);
7031 ops->stats.rx_packets = ntohll(ps14->rx_packets);
7032 ops->stats.tx_packets = ntohll(ps14->tx_packets);
7033 ops->stats.rx_bytes = ntohll(ps14->rx_bytes);
7034 ops->stats.tx_bytes = ntohll(ps14->tx_bytes);
7035 ops->stats.rx_dropped = ntohll(ps14->rx_dropped);
7036 ops->stats.tx_dropped = ntohll(ps14->tx_dropped);
7037 ops->stats.rx_errors = ntohll(ps14->rx_errors);
7038 ops->stats.tx_errors = ntohll(ps14->tx_errors);
7039 ops->stats.rx_frame_errors = UINT64_MAX;
7040 ops->stats.rx_over_errors = UINT64_MAX;
7041 ops->stats.rx_crc_errors = UINT64_MAX;
7042 ops->stats.collisions = UINT64_MAX;
7044 while (properties.size > 0) {
7045 struct ofpbuf payload;
7049 error = ofputil_pull_property(&properties, &payload, &type);
7055 case OFPPSPT14_ETHERNET:
7056 error = parse_ofp14_port_stats_ethernet_property(&payload, ops);
7060 log_property(true, "unknown port stats property %"PRIu16, type);
7073 /* Returns the number of port stats elements in OFPTYPE_PORT_STATS_REPLY
7076 ofputil_count_port_stats(const struct ofp_header *oh)
7078 struct ofputil_port_stats ps;
7082 ofpbuf_use_const(&b, oh, ntohs(oh->length));
7083 ofpraw_pull_assert(&b);
7084 while (!ofputil_decode_port_stats(&ps, &b)) {
7090 /* Converts an OFPST_PORT_STATS reply in 'msg' into an abstract
7091 * ofputil_port_stats in 'ps'.
7093 * Multiple OFPST_PORT_STATS replies can be packed into a single OpenFlow
7094 * message. Calling this function multiple times for a single 'msg' iterates
7095 * through the replies. The caller must initially leave 'msg''s layer pointers
7096 * null and not modify them between calls.
7098 * Returns 0 if successful, EOF if no replies were left in this 'msg',
7099 * otherwise a positive errno value. */
7101 ofputil_decode_port_stats(struct ofputil_port_stats *ps, struct ofpbuf *msg)
7106 error = (msg->header ? ofpraw_decode(&raw, msg->header)
7107 : ofpraw_pull(&raw, msg));
7114 } else if (raw == OFPRAW_OFPST14_PORT_REPLY) {
7115 return ofputil_pull_ofp14_port_stats(ps, msg);
7116 } else if (raw == OFPRAW_OFPST13_PORT_REPLY) {
7117 const struct ofp13_port_stats *ps13;
7119 ps13 = ofpbuf_try_pull(msg, sizeof *ps13);
7123 return ofputil_port_stats_from_ofp13(ps, ps13);
7124 } else if (raw == OFPRAW_OFPST11_PORT_REPLY) {
7125 const struct ofp11_port_stats *ps11;
7127 ps11 = ofpbuf_try_pull(msg, sizeof *ps11);
7131 return ofputil_port_stats_from_ofp11(ps, ps11);
7132 } else if (raw == OFPRAW_OFPST10_PORT_REPLY) {
7133 const struct ofp10_port_stats *ps10;
7135 ps10 = ofpbuf_try_pull(msg, sizeof *ps10);
7139 return ofputil_port_stats_from_ofp10(ps, ps10);
7145 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_PORT reply has %"PRIu32" leftover "
7146 "bytes at end", msg->size);
7147 return OFPERR_OFPBRC_BAD_LEN;
7150 /* Parse a port status request message into a 16 bit OpenFlow 1.0
7151 * port number and stores the latter in '*ofp10_port'.
7152 * Returns 0 if successful, otherwise an OFPERR_* number. */
7154 ofputil_decode_port_stats_request(const struct ofp_header *request,
7155 ofp_port_t *ofp10_port)
7157 switch ((enum ofp_version)request->version) {
7162 case OFP11_VERSION: {
7163 const struct ofp11_port_stats_request *psr11 = ofpmsg_body(request);
7164 return ofputil_port_from_ofp11(psr11->port_no, ofp10_port);
7167 case OFP10_VERSION: {
7168 const struct ofp10_port_stats_request *psr10 = ofpmsg_body(request);
7169 *ofp10_port = u16_to_ofp(ntohs(psr10->port_no));
7178 /* Frees all of the "struct ofputil_bucket"s in the 'buckets' list. */
7180 ofputil_bucket_list_destroy(struct ovs_list *buckets)
7182 struct ofputil_bucket *bucket;
7184 LIST_FOR_EACH_POP (bucket, list_node, buckets) {
7185 free(bucket->ofpacts);
7190 /* Clones 'bucket' and its ofpacts data */
7191 static struct ofputil_bucket *
7192 ofputil_bucket_clone_data(const struct ofputil_bucket *bucket)
7194 struct ofputil_bucket *new;
7196 new = xmemdup(bucket, sizeof *bucket);
7197 new->ofpacts = xmemdup(bucket->ofpacts, bucket->ofpacts_len);
7202 /* Clones each of the buckets in the list 'src' appending them
7203 * in turn to 'dest' which should be an initialised list.
7204 * An exception is that if the pointer value of a bucket in 'src'
7205 * matches 'skip' then it is not cloned or appended to 'dest'.
7206 * This allows all of 'src' or 'all of 'src' except 'skip' to
7207 * be cloned and appended to 'dest'. */
7209 ofputil_bucket_clone_list(struct ovs_list *dest, const struct ovs_list *src,
7210 const struct ofputil_bucket *skip)
7212 struct ofputil_bucket *bucket;
7214 LIST_FOR_EACH (bucket, list_node, src) {
7215 struct ofputil_bucket *new_bucket;
7217 if (bucket == skip) {
7221 new_bucket = ofputil_bucket_clone_data(bucket);
7222 list_push_back(dest, &new_bucket->list_node);
7226 /* Find a bucket in the list 'buckets' whose bucket id is 'bucket_id'
7227 * Returns the first bucket found or NULL if no buckets are found. */
7228 struct ofputil_bucket *
7229 ofputil_bucket_find(const struct ovs_list *buckets, uint32_t bucket_id)
7231 struct ofputil_bucket *bucket;
7233 if (bucket_id > OFPG15_BUCKET_MAX) {
7237 LIST_FOR_EACH (bucket, list_node, buckets) {
7238 if (bucket->bucket_id == bucket_id) {
7246 /* Returns true if more than one bucket in the list 'buckets'
7247 * have the same bucket id. Returns false otherwise. */
7249 ofputil_bucket_check_duplicate_id(const struct ovs_list *buckets)
7251 struct ofputil_bucket *i, *j;
7253 LIST_FOR_EACH (i, list_node, buckets) {
7254 LIST_FOR_EACH_REVERSE (j, list_node, buckets) {
7258 if (i->bucket_id == j->bucket_id) {
7267 /* Returns the bucket at the front of the list 'buckets'.
7268 * Undefined if 'buckets is empty. */
7269 struct ofputil_bucket *
7270 ofputil_bucket_list_front(const struct ovs_list *buckets)
7272 static struct ofputil_bucket *bucket;
7274 ASSIGN_CONTAINER(bucket, list_front(buckets), list_node);
7279 /* Returns the bucket at the back of the list 'buckets'.
7280 * Undefined if 'buckets is empty. */
7281 struct ofputil_bucket *
7282 ofputil_bucket_list_back(const struct ovs_list *buckets)
7284 static struct ofputil_bucket *bucket;
7286 ASSIGN_CONTAINER(bucket, list_back(buckets), list_node);
7291 /* Returns an OpenFlow group stats request for OpenFlow version 'ofp_version',
7292 * that requests stats for group 'group_id'. (Use OFPG_ALL to request stats
7295 * Group statistics include packet and byte counts for each group. */
7297 ofputil_encode_group_stats_request(enum ofp_version ofp_version,
7300 struct ofpbuf *request;
7302 switch (ofp_version) {
7304 ovs_fatal(0, "dump-group-stats needs OpenFlow 1.1 or later "
7305 "(\'-O OpenFlow11\')");
7310 case OFP15_VERSION: {
7311 struct ofp11_group_stats_request *req;
7312 request = ofpraw_alloc(OFPRAW_OFPST11_GROUP_REQUEST, ofp_version, 0);
7313 req = ofpbuf_put_zeros(request, sizeof *req);
7314 req->group_id = htonl(group_id);
7325 ofputil_uninit_group_desc(struct ofputil_group_desc *gd)
7327 ofputil_bucket_list_destroy(&gd->buckets);
7328 free(&gd->props.fields);
7331 /* Decodes the OpenFlow group description request in 'oh', returning the group
7332 * whose description is requested, or OFPG_ALL if stats for all groups was
7335 ofputil_decode_group_desc_request(const struct ofp_header *oh)
7337 struct ofpbuf request;
7340 ofpbuf_use_const(&request, oh, ntohs(oh->length));
7341 raw = ofpraw_pull_assert(&request);
7342 if (raw == OFPRAW_OFPST11_GROUP_DESC_REQUEST) {
7344 } else if (raw == OFPRAW_OFPST15_GROUP_DESC_REQUEST) {
7345 ovs_be32 *group_id = ofpbuf_pull(&request, sizeof *group_id);
7346 return ntohl(*group_id);
7352 /* Returns an OpenFlow group description request for OpenFlow version
7353 * 'ofp_version', that requests stats for group 'group_id'. Use OFPG_ALL to
7354 * request stats for all groups (OpenFlow 1.4 and earlier always request all
7357 * Group descriptions include the bucket and action configuration for each
7360 ofputil_encode_group_desc_request(enum ofp_version ofp_version,
7363 struct ofpbuf *request;
7365 switch (ofp_version) {
7367 ovs_fatal(0, "dump-groups needs OpenFlow 1.1 or later "
7368 "(\'-O OpenFlow11\')");
7373 request = ofpraw_alloc(OFPRAW_OFPST11_GROUP_DESC_REQUEST,
7376 case OFP15_VERSION:{
7377 struct ofp15_group_desc_request *req;
7378 request = ofpraw_alloc(OFPRAW_OFPST15_GROUP_DESC_REQUEST,
7380 req = ofpbuf_put_zeros(request, sizeof *req);
7381 req->group_id = htonl(group_id);
7392 ofputil_group_bucket_counters_to_ofp11(const struct ofputil_group_stats *gs,
7393 struct ofp11_bucket_counter bucket_cnts[])
7397 for (i = 0; i < gs->n_buckets; i++) {
7398 bucket_cnts[i].packet_count = htonll(gs->bucket_stats[i].packet_count);
7399 bucket_cnts[i].byte_count = htonll(gs->bucket_stats[i].byte_count);
7404 ofputil_group_stats_to_ofp11(const struct ofputil_group_stats *gs,
7405 struct ofp11_group_stats *gs11, size_t length,
7406 struct ofp11_bucket_counter bucket_cnts[])
7408 memset(gs11, 0, sizeof *gs11);
7409 gs11->length = htons(length);
7410 gs11->group_id = htonl(gs->group_id);
7411 gs11->ref_count = htonl(gs->ref_count);
7412 gs11->packet_count = htonll(gs->packet_count);
7413 gs11->byte_count = htonll(gs->byte_count);
7414 ofputil_group_bucket_counters_to_ofp11(gs, bucket_cnts);
7418 ofputil_group_stats_to_ofp13(const struct ofputil_group_stats *gs,
7419 struct ofp13_group_stats *gs13, size_t length,
7420 struct ofp11_bucket_counter bucket_cnts[])
7422 ofputil_group_stats_to_ofp11(gs, &gs13->gs, length, bucket_cnts);
7423 gs13->duration_sec = htonl(gs->duration_sec);
7424 gs13->duration_nsec = htonl(gs->duration_nsec);
7428 /* Encodes 'gs' properly for the format of the list of group statistics
7429 * replies already begun in 'replies' and appends it to the list. 'replies'
7430 * must have originally been initialized with ofpmp_init(). */
7432 ofputil_append_group_stats(struct ovs_list *replies,
7433 const struct ofputil_group_stats *gs)
7435 size_t bucket_counter_size;
7436 struct ofp11_bucket_counter *bucket_counters;
7439 bucket_counter_size = gs->n_buckets * sizeof(struct ofp11_bucket_counter);
7441 switch (ofpmp_version(replies)) {
7443 case OFP12_VERSION:{
7444 struct ofp11_group_stats *gs11;
7446 length = sizeof *gs11 + bucket_counter_size;
7447 gs11 = ofpmp_append(replies, length);
7448 bucket_counters = (struct ofp11_bucket_counter *)(gs11 + 1);
7449 ofputil_group_stats_to_ofp11(gs, gs11, length, bucket_counters);
7455 case OFP15_VERSION: {
7456 struct ofp13_group_stats *gs13;
7458 length = sizeof *gs13 + bucket_counter_size;
7459 gs13 = ofpmp_append(replies, length);
7460 bucket_counters = (struct ofp11_bucket_counter *)(gs13 + 1);
7461 ofputil_group_stats_to_ofp13(gs, gs13, length, bucket_counters);
7470 /* Returns an OpenFlow group features request for OpenFlow version
7473 ofputil_encode_group_features_request(enum ofp_version ofp_version)
7475 struct ofpbuf *request = NULL;
7477 switch (ofp_version) {
7480 ovs_fatal(0, "dump-group-features needs OpenFlow 1.2 or later "
7481 "(\'-O OpenFlow12\')");
7486 request = ofpraw_alloc(OFPRAW_OFPST12_GROUP_FEATURES_REQUEST,
7496 /* Returns a OpenFlow message that encodes 'features' properly as a reply to
7497 * group features request 'request'. */
7499 ofputil_encode_group_features_reply(
7500 const struct ofputil_group_features *features,
7501 const struct ofp_header *request)
7503 struct ofp12_group_features_stats *ogf;
7504 struct ofpbuf *reply;
7507 reply = ofpraw_alloc_xid(OFPRAW_OFPST12_GROUP_FEATURES_REPLY,
7508 request->version, request->xid, 0);
7509 ogf = ofpbuf_put_zeros(reply, sizeof *ogf);
7510 ogf->types = htonl(features->types);
7511 ogf->capabilities = htonl(features->capabilities);
7512 for (i = 0; i < OFPGT12_N_TYPES; i++) {
7513 ogf->max_groups[i] = htonl(features->max_groups[i]);
7514 ogf->actions[i] = ofpact_bitmap_to_openflow(features->ofpacts[i],
7521 /* Decodes group features reply 'oh' into 'features'. */
7523 ofputil_decode_group_features_reply(const struct ofp_header *oh,
7524 struct ofputil_group_features *features)
7526 const struct ofp12_group_features_stats *ogf = ofpmsg_body(oh);
7529 features->types = ntohl(ogf->types);
7530 features->capabilities = ntohl(ogf->capabilities);
7531 for (i = 0; i < OFPGT12_N_TYPES; i++) {
7532 features->max_groups[i] = ntohl(ogf->max_groups[i]);
7533 features->ofpacts[i] = ofpact_bitmap_from_openflow(
7534 ogf->actions[i], oh->version);
7538 /* Parse a group status request message into a 32 bit OpenFlow 1.1
7539 * group ID and stores the latter in '*group_id'.
7540 * Returns 0 if successful, otherwise an OFPERR_* number. */
7542 ofputil_decode_group_stats_request(const struct ofp_header *request,
7545 const struct ofp11_group_stats_request *gsr11 = ofpmsg_body(request);
7546 *group_id = ntohl(gsr11->group_id);
7550 /* Converts a group stats reply in 'msg' into an abstract ofputil_group_stats
7551 * in 'gs'. Assigns freshly allocated memory to gs->bucket_stats for the
7552 * caller to eventually free.
7554 * Multiple group stats replies can be packed into a single OpenFlow message.
7555 * Calling this function multiple times for a single 'msg' iterates through the
7556 * replies. The caller must initially leave 'msg''s layer pointers null and
7557 * not modify them between calls.
7559 * Returns 0 if successful, EOF if no replies were left in this 'msg',
7560 * otherwise a positive errno value. */
7562 ofputil_decode_group_stats_reply(struct ofpbuf *msg,
7563 struct ofputil_group_stats *gs)
7565 struct ofp11_bucket_counter *obc;
7566 struct ofp11_group_stats *ogs11;
7573 gs->bucket_stats = NULL;
7574 error = (msg->header ? ofpraw_decode(&raw, msg->header)
7575 : ofpraw_pull(&raw, msg));
7584 if (raw == OFPRAW_OFPST11_GROUP_REPLY) {
7585 base_len = sizeof *ogs11;
7586 ogs11 = ofpbuf_try_pull(msg, sizeof *ogs11);
7587 gs->duration_sec = gs->duration_nsec = UINT32_MAX;
7588 } else if (raw == OFPRAW_OFPST13_GROUP_REPLY) {
7589 struct ofp13_group_stats *ogs13;
7591 base_len = sizeof *ogs13;
7592 ogs13 = ofpbuf_try_pull(msg, sizeof *ogs13);
7595 gs->duration_sec = ntohl(ogs13->duration_sec);
7596 gs->duration_nsec = ntohl(ogs13->duration_nsec);
7605 VLOG_WARN_RL(&bad_ofmsg_rl, "%s reply has %"PRIu32" leftover bytes at end",
7606 ofpraw_get_name(raw), msg->size);
7607 return OFPERR_OFPBRC_BAD_LEN;
7609 length = ntohs(ogs11->length);
7610 if (length < sizeof base_len) {
7611 VLOG_WARN_RL(&bad_ofmsg_rl, "%s reply claims invalid length %"PRIuSIZE,
7612 ofpraw_get_name(raw), length);
7613 return OFPERR_OFPBRC_BAD_LEN;
7616 gs->group_id = ntohl(ogs11->group_id);
7617 gs->ref_count = ntohl(ogs11->ref_count);
7618 gs->packet_count = ntohll(ogs11->packet_count);
7619 gs->byte_count = ntohll(ogs11->byte_count);
7621 gs->n_buckets = (length - base_len) / sizeof *obc;
7622 obc = ofpbuf_try_pull(msg, gs->n_buckets * sizeof *obc);
7624 VLOG_WARN_RL(&bad_ofmsg_rl, "%s reply has %"PRIu32" leftover bytes at end",
7625 ofpraw_get_name(raw), msg->size);
7626 return OFPERR_OFPBRC_BAD_LEN;
7629 gs->bucket_stats = xmalloc(gs->n_buckets * sizeof *gs->bucket_stats);
7630 for (i = 0; i < gs->n_buckets; i++) {
7631 gs->bucket_stats[i].packet_count = ntohll(obc[i].packet_count);
7632 gs->bucket_stats[i].byte_count = ntohll(obc[i].byte_count);
7639 ofputil_put_ofp11_bucket(const struct ofputil_bucket *bucket,
7640 struct ofpbuf *openflow, enum ofp_version ofp_version)
7642 struct ofp11_bucket *ob;
7645 start = openflow->size;
7646 ofpbuf_put_zeros(openflow, sizeof *ob);
7647 ofpacts_put_openflow_actions(bucket->ofpacts, bucket->ofpacts_len,
7648 openflow, ofp_version);
7649 ob = ofpbuf_at_assert(openflow, start, sizeof *ob);
7650 ob->len = htons(openflow->size - start);
7651 ob->weight = htons(bucket->weight);
7652 ob->watch_port = ofputil_port_to_ofp11(bucket->watch_port);
7653 ob->watch_group = htonl(bucket->watch_group);
7657 ofputil_put_ofp15_group_bucket_prop_weight(ovs_be16 weight,
7658 struct ofpbuf *openflow)
7661 struct ofp15_group_bucket_prop_weight *prop;
7663 start_ofs = start_property(openflow, OFPGBPT15_WEIGHT);
7664 ofpbuf_put_zeros(openflow, sizeof *prop - sizeof(struct ofp_prop_header));
7665 prop = ofpbuf_at_assert(openflow, start_ofs, sizeof *prop);
7666 prop->weight = weight;
7667 end_property(openflow, start_ofs);
7671 ofputil_put_ofp15_group_bucket_prop_watch(ovs_be32 watch, uint16_t type,
7672 struct ofpbuf *openflow)
7675 struct ofp15_group_bucket_prop_watch *prop;
7677 start_ofs = start_property(openflow, type);
7678 ofpbuf_put_zeros(openflow, sizeof *prop - sizeof(struct ofp_prop_header));
7679 prop = ofpbuf_at_assert(openflow, start_ofs, sizeof *prop);
7680 prop->watch = watch;
7681 end_property(openflow, start_ofs);
7685 ofputil_put_ofp15_bucket(const struct ofputil_bucket *bucket,
7686 uint32_t bucket_id, enum ofp11_group_type group_type,
7687 struct ofpbuf *openflow, enum ofp_version ofp_version)
7689 struct ofp15_bucket *ob;
7690 size_t start, actions_start, actions_len;
7692 start = openflow->size;
7693 ofpbuf_put_zeros(openflow, sizeof *ob);
7695 actions_start = openflow->size;
7696 ofpacts_put_openflow_actions(bucket->ofpacts, bucket->ofpacts_len,
7697 openflow, ofp_version);
7698 actions_len = openflow->size - actions_start;
7700 if (group_type == OFPGT11_SELECT) {
7701 ofputil_put_ofp15_group_bucket_prop_weight(htons(bucket->weight),
7704 if (bucket->watch_port != OFPP_ANY) {
7705 ovs_be32 port = ofputil_port_to_ofp11(bucket->watch_port);
7706 ofputil_put_ofp15_group_bucket_prop_watch(port,
7707 OFPGBPT15_WATCH_PORT,
7710 if (bucket->watch_group != OFPG_ANY) {
7711 ovs_be32 group = htonl(bucket->watch_group);
7712 ofputil_put_ofp15_group_bucket_prop_watch(group,
7713 OFPGBPT15_WATCH_GROUP,
7717 ob = ofpbuf_at_assert(openflow, start, sizeof *ob);
7718 ob->len = htons(openflow->size - start);
7719 ob->action_array_len = htons(actions_len);
7720 ob->bucket_id = htonl(bucket_id);
7724 ofputil_put_group_prop_ntr_selection_method(enum ofp_version ofp_version,
7725 const struct ofputil_group_props *gp,
7726 struct ofpbuf *openflow)
7728 struct ntr_group_prop_selection_method *prop;
7731 start = openflow->size;
7732 ofpbuf_put_zeros(openflow, sizeof *prop);
7733 oxm_put_field_array(openflow, &gp->fields, ofp_version);
7734 prop = ofpbuf_at_assert(openflow, start, sizeof *prop);
7735 prop->type = htons(OFPGPT15_EXPERIMENTER);
7736 prop->experimenter = htonl(NTR_VENDOR_ID);
7737 prop->exp_type = htonl(NTRT_SELECTION_METHOD);
7738 strcpy(prop->selection_method, gp->selection_method);
7739 prop->selection_method_param = htonll(gp->selection_method_param);
7740 end_property(openflow, start);
7744 ofputil_append_ofp11_group_desc_reply(const struct ofputil_group_desc *gds,
7745 const struct ovs_list *buckets,
7746 struct ovs_list *replies,
7747 enum ofp_version version)
7749 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
7750 struct ofp11_group_desc_stats *ogds;
7751 struct ofputil_bucket *bucket;
7754 start_ogds = reply->size;
7755 ofpbuf_put_zeros(reply, sizeof *ogds);
7756 LIST_FOR_EACH (bucket, list_node, buckets) {
7757 ofputil_put_ofp11_bucket(bucket, reply, version);
7759 ogds = ofpbuf_at_assert(reply, start_ogds, sizeof *ogds);
7760 ogds->length = htons(reply->size - start_ogds);
7761 ogds->type = gds->type;
7762 ogds->group_id = htonl(gds->group_id);
7764 ofpmp_postappend(replies, start_ogds);
7768 ofputil_append_ofp15_group_desc_reply(const struct ofputil_group_desc *gds,
7769 const struct ovs_list *buckets,
7770 struct ovs_list *replies,
7771 enum ofp_version version)
7773 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
7774 struct ofp15_group_desc_stats *ogds;
7775 struct ofputil_bucket *bucket;
7776 size_t start_ogds, start_buckets;
7778 start_ogds = reply->size;
7779 ofpbuf_put_zeros(reply, sizeof *ogds);
7780 start_buckets = reply->size;
7781 LIST_FOR_EACH (bucket, list_node, buckets) {
7782 ofputil_put_ofp15_bucket(bucket, bucket->bucket_id,
7783 gds->type, reply, version);
7785 ogds = ofpbuf_at_assert(reply, start_ogds, sizeof *ogds);
7786 ogds->type = gds->type;
7787 ogds->group_id = htonl(gds->group_id);
7788 ogds->bucket_list_len = htons(reply->size - start_buckets);
7790 /* Add group properties */
7791 if (gds->props.selection_method[0]) {
7792 ofputil_put_group_prop_ntr_selection_method(version, &gds->props,
7795 ogds->length = htons(reply->size - start_ogds);
7797 ofpmp_postappend(replies, start_ogds);
7800 /* Appends a group stats reply that contains the data in 'gds' to those already
7801 * present in the list of ofpbufs in 'replies'. 'replies' should have been
7802 * initialized with ofpmp_init(). */
7804 ofputil_append_group_desc_reply(const struct ofputil_group_desc *gds,
7805 const struct ovs_list *buckets,
7806 struct ovs_list *replies)
7808 enum ofp_version version = ofpmp_version(replies);
7816 ofputil_append_ofp11_group_desc_reply(gds, buckets, replies, version);
7820 ofputil_append_ofp15_group_desc_reply(gds, buckets, replies, version);
7830 ofputil_pull_ofp11_buckets(struct ofpbuf *msg, size_t buckets_length,
7831 enum ofp_version version, struct ovs_list *buckets)
7833 struct ofp11_bucket *ob;
7834 uint32_t bucket_id = 0;
7837 while (buckets_length > 0) {
7838 struct ofputil_bucket *bucket;
7839 struct ofpbuf ofpacts;
7843 ob = (buckets_length >= sizeof *ob
7844 ? ofpbuf_try_pull(msg, sizeof *ob)
7847 VLOG_WARN_RL(&bad_ofmsg_rl, "buckets end with %"PRIuSIZE" leftover bytes",
7849 return OFPERR_OFPGMFC_BAD_BUCKET;
7852 ob_len = ntohs(ob->len);
7853 if (ob_len < sizeof *ob) {
7854 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket length "
7855 "%"PRIuSIZE" is not valid", ob_len);
7856 return OFPERR_OFPGMFC_BAD_BUCKET;
7857 } else if (ob_len > buckets_length) {
7858 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket length "
7859 "%"PRIuSIZE" exceeds remaining buckets data size %"PRIuSIZE,
7860 ob_len, buckets_length);
7861 return OFPERR_OFPGMFC_BAD_BUCKET;
7863 buckets_length -= ob_len;
7865 ofpbuf_init(&ofpacts, 0);
7866 error = ofpacts_pull_openflow_actions(msg, ob_len - sizeof *ob,
7869 ofpbuf_uninit(&ofpacts);
7870 ofputil_bucket_list_destroy(buckets);
7874 bucket = xzalloc(sizeof *bucket);
7875 bucket->weight = ntohs(ob->weight);
7876 error = ofputil_port_from_ofp11(ob->watch_port, &bucket->watch_port);
7878 ofpbuf_uninit(&ofpacts);
7879 ofputil_bucket_list_destroy(buckets);
7880 return OFPERR_OFPGMFC_BAD_WATCH;
7882 bucket->watch_group = ntohl(ob->watch_group);
7883 bucket->bucket_id = bucket_id++;
7885 bucket->ofpacts = ofpbuf_steal_data(&ofpacts);
7886 bucket->ofpacts_len = ofpacts.size;
7887 list_push_back(buckets, &bucket->list_node);
7894 parse_ofp15_group_bucket_prop_weight(const struct ofpbuf *payload,
7897 struct ofp15_group_bucket_prop_weight *prop = payload->data;
7899 if (payload->size != sizeof *prop) {
7900 log_property(false, "OpenFlow bucket weight property length "
7901 "%u is not valid", payload->size);
7902 return OFPERR_OFPBPC_BAD_LEN;
7905 *weight = prop->weight;
7911 parse_ofp15_group_bucket_prop_watch(const struct ofpbuf *payload,
7914 struct ofp15_group_bucket_prop_watch *prop = payload->data;
7916 if (payload->size != sizeof *prop) {
7917 log_property(false, "OpenFlow bucket watch port or group "
7918 "property length %u is not valid", payload->size);
7919 return OFPERR_OFPBPC_BAD_LEN;
7922 *watch = prop->watch;
7928 ofputil_pull_ofp15_buckets(struct ofpbuf *msg, size_t buckets_length,
7929 enum ofp_version version, uint8_t group_type,
7930 struct ovs_list *buckets)
7932 struct ofp15_bucket *ob;
7935 while (buckets_length > 0) {
7936 struct ofputil_bucket *bucket = NULL;
7937 struct ofpbuf ofpacts;
7938 enum ofperr err = OFPERR_OFPGMFC_BAD_BUCKET;
7939 struct ofpbuf properties;
7940 size_t ob_len, actions_len, properties_len;
7941 ovs_be32 watch_port = ofputil_port_to_ofp11(OFPP_ANY);
7942 ovs_be32 watch_group = htonl(OFPG_ANY);
7943 ovs_be16 weight = htons(group_type == OFPGT11_SELECT ? 1 : 0);
7945 ofpbuf_init(&ofpacts, 0);
7947 ob = ofpbuf_try_pull(msg, sizeof *ob);
7949 VLOG_WARN_RL(&bad_ofmsg_rl, "buckets end with %"PRIuSIZE
7950 " leftover bytes", buckets_length);
7954 ob_len = ntohs(ob->len);
7955 actions_len = ntohs(ob->action_array_len);
7957 if (ob_len < sizeof *ob) {
7958 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket length "
7959 "%"PRIuSIZE" is not valid", ob_len);
7961 } else if (ob_len > buckets_length) {
7962 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket length "
7963 "%"PRIuSIZE" exceeds remaining buckets data size %"
7964 PRIuSIZE, ob_len, buckets_length);
7966 } else if (actions_len > ob_len - sizeof *ob) {
7967 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket actions "
7968 "length %"PRIuSIZE" exceeds remaining bucket "
7969 "data size %"PRIuSIZE, actions_len,
7970 ob_len - sizeof *ob);
7973 buckets_length -= ob_len;
7975 err = ofpacts_pull_openflow_actions(msg, actions_len, version,
7981 properties_len = ob_len - sizeof *ob - actions_len;
7982 ofpbuf_use_const(&properties, ofpbuf_pull(msg, properties_len),
7985 while (properties.size > 0) {
7986 struct ofpbuf payload;
7989 err = ofputil_pull_property(&properties, &payload, &type);
7995 case OFPGBPT15_WEIGHT:
7996 err = parse_ofp15_group_bucket_prop_weight(&payload, &weight);
7999 case OFPGBPT15_WATCH_PORT:
8000 err = parse_ofp15_group_bucket_prop_watch(&payload,
8004 case OFPGBPT15_WATCH_GROUP:
8005 err = parse_ofp15_group_bucket_prop_watch(&payload,
8010 log_property(false, "unknown group bucket property %"PRIu16,
8012 err = OFPERR_OFPBPC_BAD_TYPE;
8021 bucket = xzalloc(sizeof *bucket);
8023 bucket->weight = ntohs(weight);
8024 err = ofputil_port_from_ofp11(watch_port, &bucket->watch_port);
8026 err = OFPERR_OFPGMFC_BAD_WATCH;
8029 bucket->watch_group = ntohl(watch_group);
8030 bucket->bucket_id = ntohl(ob->bucket_id);
8031 if (bucket->bucket_id > OFPG15_BUCKET_MAX) {
8032 VLOG_WARN_RL(&bad_ofmsg_rl, "bucket id (%u) is out of range",
8034 err = OFPERR_OFPGMFC_BAD_BUCKET;
8038 bucket->ofpacts = ofpbuf_steal_data(&ofpacts);
8039 bucket->ofpacts_len = ofpacts.size;
8040 list_push_back(buckets, &bucket->list_node);
8046 ofpbuf_uninit(&ofpacts);
8047 ofputil_bucket_list_destroy(buckets);
8051 if (ofputil_bucket_check_duplicate_id(buckets)) {
8052 VLOG_WARN_RL(&bad_ofmsg_rl, "Duplicate bucket id");
8053 ofputil_bucket_list_destroy(buckets);
8054 return OFPERR_OFPGMFC_BAD_BUCKET;
8061 ofputil_init_group_properties(struct ofputil_group_props *gp)
8063 memset(gp, 0, sizeof *gp);
8067 parse_group_prop_ntr_selection_method(struct ofpbuf *payload,
8068 enum ofp11_group_type group_type,
8069 enum ofp15_group_mod_command group_cmd,
8070 struct ofputil_group_props *gp)
8072 struct ntr_group_prop_selection_method *prop = payload->data;
8073 size_t fields_len, method_len;
8076 switch (group_type) {
8077 case OFPGT11_SELECT:
8080 case OFPGT11_INDIRECT:
8082 log_property(false, "ntr selection method property is only allowed "
8083 "for select groups");
8084 return OFPERR_OFPBPC_BAD_VALUE;
8089 switch (group_cmd) {
8091 case OFPGC15_MODIFY:
8093 case OFPGC15_DELETE:
8094 case OFPGC15_INSERT_BUCKET:
8095 case OFPGC15_REMOVE_BUCKET:
8096 log_property(false, "ntr selection method property is only allowed "
8097 "for add and delete group modifications");
8098 return OFPERR_OFPBPC_BAD_VALUE;
8103 if (payload->size < sizeof *prop) {
8104 log_property(false, "ntr selection method property length "
8105 "%u is not valid", payload->size);
8106 return OFPERR_OFPBPC_BAD_LEN;
8109 method_len = strnlen(prop->selection_method, NTR_MAX_SELECTION_METHOD_LEN);
8111 if (method_len == NTR_MAX_SELECTION_METHOD_LEN) {
8112 log_property(false, "ntr selection method is not null terminated");
8113 return OFPERR_OFPBPC_BAD_VALUE;
8116 if (strcmp("hash", prop->selection_method)) {
8117 log_property(false, "ntr selection method '%s' is not supported",
8118 prop->selection_method);
8119 return OFPERR_OFPBPC_BAD_VALUE;
8122 strcpy(gp->selection_method, prop->selection_method);
8123 gp->selection_method_param = ntohll(prop->selection_method_param);
8125 if (!method_len && gp->selection_method_param) {
8126 log_property(false, "ntr selection method parameter is non-zero but "
8127 "selection method is empty");
8128 return OFPERR_OFPBPC_BAD_VALUE;
8131 ofpbuf_pull(payload, sizeof *prop);
8133 fields_len = ntohs(prop->length) - sizeof *prop;
8134 if (!method_len && fields_len) {
8135 log_property(false, "ntr selection method parameter is zero "
8136 "but fields are provided");
8137 return OFPERR_OFPBPC_BAD_VALUE;
8140 error = oxm_pull_field_array(payload->data, fields_len,
8143 log_property(false, "ntr selection method fields are invalid");
8151 parse_group_prop_ntr(struct ofpbuf *payload, uint32_t exp_type,
8152 enum ofp11_group_type group_type,
8153 enum ofp15_group_mod_command group_cmd,
8154 struct ofputil_group_props *gp)
8159 case NTRT_SELECTION_METHOD:
8160 error = parse_group_prop_ntr_selection_method(payload, group_type,
8165 log_property(false, "unknown group property ntr experimenter type "
8166 "%"PRIu32, exp_type);
8167 error = OFPERR_OFPBPC_BAD_TYPE;
8175 parse_ofp15_group_prop_exp(struct ofpbuf *payload,
8176 enum ofp11_group_type group_type,
8177 enum ofp15_group_mod_command group_cmd,
8178 struct ofputil_group_props *gp)
8180 struct ofp_prop_experimenter *prop = payload->data;
8181 uint16_t experimenter;
8185 if (payload->size < sizeof *prop) {
8186 return OFPERR_OFPBPC_BAD_LEN;
8189 experimenter = ntohl(prop->experimenter);
8190 exp_type = ntohl(prop->exp_type);
8192 switch (experimenter) {
8194 case NTR_COMPAT_VENDOR_ID:
8195 error = parse_group_prop_ntr(payload, exp_type, group_type,
8200 log_property(false, "unknown group property experimenter %"PRIu16,
8202 error = OFPERR_OFPBPC_BAD_EXPERIMENTER;
8210 parse_ofp15_group_properties(struct ofpbuf *msg,
8211 enum ofp11_group_type group_type,
8212 enum ofp15_group_mod_command group_cmd,
8213 struct ofputil_group_props *gp,
8214 size_t properties_len)
8216 struct ofpbuf properties;
8218 ofpbuf_use_const(&properties, ofpbuf_pull(msg, properties_len),
8221 while (properties.size > 0) {
8222 struct ofpbuf payload;
8226 error = ofputil_pull_property(&properties, &payload, &type);
8232 case OFPGPT15_EXPERIMENTER:
8233 error = parse_ofp15_group_prop_exp(&payload, group_type,
8238 log_property(false, "unknown group property %"PRIu16, type);
8239 error = OFPERR_OFPBPC_BAD_TYPE;
8252 ofputil_decode_ofp11_group_desc_reply(struct ofputil_group_desc *gd,
8254 enum ofp_version version)
8256 struct ofp11_group_desc_stats *ogds;
8260 ofpraw_pull_assert(msg);
8267 ogds = ofpbuf_try_pull(msg, sizeof *ogds);
8269 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply has %"PRIu32" "
8270 "leftover bytes at end", msg->size);
8271 return OFPERR_OFPBRC_BAD_LEN;
8273 gd->type = ogds->type;
8274 gd->group_id = ntohl(ogds->group_id);
8276 length = ntohs(ogds->length);
8277 if (length < sizeof *ogds || length - sizeof *ogds > msg->size) {
8278 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply claims invalid "
8279 "length %"PRIuSIZE, length);
8280 return OFPERR_OFPBRC_BAD_LEN;
8283 return ofputil_pull_ofp11_buckets(msg, length - sizeof *ogds, version,
8288 ofputil_decode_ofp15_group_desc_reply(struct ofputil_group_desc *gd,
8290 enum ofp_version version)
8292 struct ofp15_group_desc_stats *ogds;
8293 uint16_t length, bucket_list_len;
8297 ofpraw_pull_assert(msg);
8304 ogds = ofpbuf_try_pull(msg, sizeof *ogds);
8306 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply has %"PRIu32" "
8307 "leftover bytes at end", msg->size);
8308 return OFPERR_OFPBRC_BAD_LEN;
8310 gd->type = ogds->type;
8311 gd->group_id = ntohl(ogds->group_id);
8313 length = ntohs(ogds->length);
8314 if (length < sizeof *ogds || length - sizeof *ogds > msg->size) {
8315 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply claims invalid "
8316 "length %u", length);
8317 return OFPERR_OFPBRC_BAD_LEN;
8320 bucket_list_len = ntohs(ogds->bucket_list_len);
8321 if (length < bucket_list_len + sizeof *ogds) {
8322 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply claims invalid "
8323 "bucket list length %u", bucket_list_len);
8324 return OFPERR_OFPBRC_BAD_LEN;
8326 error = ofputil_pull_ofp15_buckets(msg, bucket_list_len, version, gd->type,
8332 /* By definition group desc messages don't have a group mod command.
8333 * However, parse_group_prop_ntr_selection_method() checks to make sure
8334 * that the command is OFPGC15_ADD or OFPGC15_DELETE to guard
8335 * against group mod messages with other commands supplying
8336 * a NTR selection method group experimenter property.
8337 * Such properties are valid for group desc replies so
8338 * claim that the group mod command is OFPGC15_ADD to
8339 * satisfy the check in parse_group_prop_ntr_selection_method() */
8340 return parse_ofp15_group_properties(msg, gd->type, OFPGC15_ADD, &gd->props,
8341 length - sizeof *ogds - bucket_list_len);
8344 /* Converts a group description reply in 'msg' into an abstract
8345 * ofputil_group_desc in 'gd'.
8347 * Multiple group description replies can be packed into a single OpenFlow
8348 * message. Calling this function multiple times for a single 'msg' iterates
8349 * through the replies. The caller must initially leave 'msg''s layer pointers
8350 * null and not modify them between calls.
8352 * Returns 0 if successful, EOF if no replies were left in this 'msg',
8353 * otherwise a positive errno value. */
8355 ofputil_decode_group_desc_reply(struct ofputil_group_desc *gd,
8356 struct ofpbuf *msg, enum ofp_version version)
8358 ofputil_init_group_properties(&gd->props);
8366 return ofputil_decode_ofp11_group_desc_reply(gd, msg, version);
8369 return ofputil_decode_ofp15_group_desc_reply(gd, msg, version);
8378 ofputil_uninit_group_mod(struct ofputil_group_mod *gm)
8380 ofputil_bucket_list_destroy(&gm->buckets);
8383 static struct ofpbuf *
8384 ofputil_encode_ofp11_group_mod(enum ofp_version ofp_version,
8385 const struct ofputil_group_mod *gm)
8388 struct ofp11_group_mod *ogm;
8390 struct ofputil_bucket *bucket;
8392 b = ofpraw_alloc(OFPRAW_OFPT11_GROUP_MOD, ofp_version, 0);
8393 start_ogm = b->size;
8394 ofpbuf_put_zeros(b, sizeof *ogm);
8396 LIST_FOR_EACH (bucket, list_node, &gm->buckets) {
8397 ofputil_put_ofp11_bucket(bucket, b, ofp_version);
8399 ogm = ofpbuf_at_assert(b, start_ogm, sizeof *ogm);
8400 ogm->command = htons(gm->command);
8401 ogm->type = gm->type;
8402 ogm->group_id = htonl(gm->group_id);
8407 static struct ofpbuf *
8408 ofputil_encode_ofp15_group_mod(enum ofp_version ofp_version,
8409 const struct ofputil_group_mod *gm)
8412 struct ofp15_group_mod *ogm;
8414 struct ofputil_bucket *bucket;
8415 struct id_pool *bucket_ids = NULL;
8417 b = ofpraw_alloc(OFPRAW_OFPT15_GROUP_MOD, ofp_version, 0);
8418 start_ogm = b->size;
8419 ofpbuf_put_zeros(b, sizeof *ogm);
8421 LIST_FOR_EACH (bucket, list_node, &gm->buckets) {
8424 /* Generate a bucket id if none was supplied */
8425 if (bucket->bucket_id > OFPG15_BUCKET_MAX) {
8427 const struct ofputil_bucket *bkt;
8429 bucket_ids = id_pool_create(0, OFPG15_BUCKET_MAX + 1);
8431 /* Mark all bucket_ids that are present in gm
8432 * as used in the pool. */
8433 LIST_FOR_EACH_REVERSE (bkt, list_node, &gm->buckets) {
8434 if (bkt == bucket) {
8437 if (bkt->bucket_id <= OFPG15_BUCKET_MAX) {
8438 id_pool_add(bucket_ids, bkt->bucket_id);
8443 if (!id_pool_alloc_id(bucket_ids, &bucket_id)) {
8447 bucket_id = bucket->bucket_id;
8450 ofputil_put_ofp15_bucket(bucket, bucket_id, gm->type, b, ofp_version);
8452 ogm = ofpbuf_at_assert(b, start_ogm, sizeof *ogm);
8453 ogm->command = htons(gm->command);
8454 ogm->type = gm->type;
8455 ogm->group_id = htonl(gm->group_id);
8456 ogm->command_bucket_id = htonl(gm->command_bucket_id);
8457 ogm->bucket_array_len = htons(b->size - start_ogm - sizeof *ogm);
8459 /* Add group properties */
8460 if (gm->props.selection_method[0]) {
8461 ofputil_put_group_prop_ntr_selection_method(ofp_version, &gm->props, b);
8464 id_pool_destroy(bucket_ids);
8469 bad_group_cmd(enum ofp15_group_mod_command cmd)
8471 const char *opt_version;
8472 const char *version;
8473 const char *cmd_str;
8477 case OFPGC15_MODIFY:
8478 case OFPGC15_DELETE:
8483 case OFPGC15_INSERT_BUCKET:
8484 case OFPGC15_REMOVE_BUCKET:
8495 cmd_str = "add-group";
8498 case OFPGC15_MODIFY:
8499 cmd_str = "mod-group";
8502 case OFPGC15_DELETE:
8503 cmd_str = "del-group";
8506 case OFPGC15_INSERT_BUCKET:
8507 cmd_str = "insert-bucket";
8510 case OFPGC15_REMOVE_BUCKET:
8511 cmd_str = "remove-bucket";
8518 ovs_fatal(0, "%s needs OpenFlow %s or later (\'-O OpenFlow%s\')",
8519 cmd_str, version, opt_version);
8523 /* Converts abstract group mod 'gm' into a message for OpenFlow version
8524 * 'ofp_version' and returns the message. */
8526 ofputil_encode_group_mod(enum ofp_version ofp_version,
8527 const struct ofputil_group_mod *gm)
8530 switch (ofp_version) {
8532 bad_group_cmd(gm->command);
8538 if (gm->command > OFPGC11_DELETE) {
8539 bad_group_cmd(gm->command);
8541 return ofputil_encode_ofp11_group_mod(ofp_version, gm);
8544 return ofputil_encode_ofp15_group_mod(ofp_version, gm);
8552 ofputil_pull_ofp11_group_mod(struct ofpbuf *msg, enum ofp_version ofp_version,
8553 struct ofputil_group_mod *gm)
8555 const struct ofp11_group_mod *ogm;
8558 ogm = ofpbuf_pull(msg, sizeof *ogm);
8559 gm->command = ntohs(ogm->command);
8560 gm->type = ogm->type;
8561 gm->group_id = ntohl(ogm->group_id);
8562 gm->command_bucket_id = OFPG15_BUCKET_ALL;
8564 error = ofputil_pull_ofp11_buckets(msg, msg->size, ofp_version,
8567 /* OF1.3.5+ prescribes an error when an OFPGC_DELETE includes buckets. */
8569 && ofp_version >= OFP13_VERSION
8570 && gm->command == OFPGC11_DELETE
8571 && !list_is_empty(&gm->buckets)) {
8572 error = OFPERR_OFPGMFC_INVALID_GROUP;
8579 ofputil_pull_ofp15_group_mod(struct ofpbuf *msg, enum ofp_version ofp_version,
8580 struct ofputil_group_mod *gm)
8582 const struct ofp15_group_mod *ogm;
8583 uint16_t bucket_list_len;
8584 enum ofperr error = OFPERR_OFPGMFC_BAD_BUCKET;
8586 ogm = ofpbuf_pull(msg, sizeof *ogm);
8587 gm->command = ntohs(ogm->command);
8588 gm->type = ogm->type;
8589 gm->group_id = ntohl(ogm->group_id);
8591 gm->command_bucket_id = ntohl(ogm->command_bucket_id);
8592 switch (gm->command) {
8593 case OFPGC15_REMOVE_BUCKET:
8594 if (gm->command_bucket_id == OFPG15_BUCKET_ALL) {
8598 case OFPGC15_INSERT_BUCKET:
8599 if (gm->command_bucket_id <= OFPG15_BUCKET_MAX ||
8600 gm->command_bucket_id == OFPG15_BUCKET_FIRST
8601 || gm->command_bucket_id == OFPG15_BUCKET_LAST) {
8607 case OFPGC11_MODIFY:
8608 case OFPGC11_DELETE:
8610 if (gm->command_bucket_id == OFPG15_BUCKET_ALL) {
8616 VLOG_WARN_RL(&bad_ofmsg_rl,
8617 "group command bucket id (%u) is out of range",
8618 gm->command_bucket_id);
8619 return OFPERR_OFPGMFC_BAD_BUCKET;
8622 bucket_list_len = ntohs(ogm->bucket_array_len);
8623 error = ofputil_pull_ofp15_buckets(msg, bucket_list_len, ofp_version,
8624 gm->type, &gm->buckets);
8629 return parse_ofp15_group_properties(msg, gm->type, gm->command, &gm->props,
8633 /* Converts OpenFlow group mod message 'oh' into an abstract group mod in
8634 * 'gm'. Returns 0 if successful, otherwise an OpenFlow error code. */
8636 ofputil_decode_group_mod(const struct ofp_header *oh,
8637 struct ofputil_group_mod *gm)
8639 enum ofp_version ofp_version = oh->version;
8641 struct ofputil_bucket *bucket;
8644 ofpbuf_use_const(&msg, oh, ntohs(oh->length));
8645 ofpraw_pull_assert(&msg);
8647 ofputil_init_group_properties(&gm->props);
8649 switch (ofp_version)
8655 err = ofputil_pull_ofp11_group_mod(&msg, ofp_version, gm);
8659 err = ofputil_pull_ofp15_group_mod(&msg, ofp_version, gm);
8672 case OFPGT11_INDIRECT:
8673 if (!list_is_singleton(&gm->buckets)) {
8674 return OFPERR_OFPGMFC_INVALID_GROUP;
8678 case OFPGT11_SELECT:
8685 switch (gm->command) {
8687 case OFPGC11_MODIFY:
8688 case OFPGC11_DELETE:
8689 case OFPGC15_INSERT_BUCKET:
8691 case OFPGC15_REMOVE_BUCKET:
8692 if (!list_is_empty(&gm->buckets)) {
8693 return OFPERR_OFPGMFC_BAD_BUCKET;
8700 LIST_FOR_EACH (bucket, list_node, &gm->buckets) {
8701 if (bucket->weight && gm->type != OFPGT11_SELECT) {
8702 return OFPERR_OFPGMFC_INVALID_GROUP;
8707 case OFPGT11_INDIRECT:
8708 if (ofputil_bucket_has_liveness(bucket)) {
8709 return OFPERR_OFPGMFC_WATCH_UNSUPPORTED;
8712 case OFPGT11_SELECT:
8715 if (!ofputil_bucket_has_liveness(bucket)) {
8716 return OFPERR_OFPGMFC_INVALID_GROUP;
8727 /* Parse a queue status request message into 'oqsr'.
8728 * Returns 0 if successful, otherwise an OFPERR_* number. */
8730 ofputil_decode_queue_stats_request(const struct ofp_header *request,
8731 struct ofputil_queue_stats_request *oqsr)
8733 switch ((enum ofp_version)request->version) {
8738 case OFP11_VERSION: {
8739 const struct ofp11_queue_stats_request *qsr11 = ofpmsg_body(request);
8740 oqsr->queue_id = ntohl(qsr11->queue_id);
8741 return ofputil_port_from_ofp11(qsr11->port_no, &oqsr->port_no);
8744 case OFP10_VERSION: {
8745 const struct ofp10_queue_stats_request *qsr10 = ofpmsg_body(request);
8746 oqsr->queue_id = ntohl(qsr10->queue_id);
8747 oqsr->port_no = u16_to_ofp(ntohs(qsr10->port_no));
8748 /* OF 1.0 uses OFPP_ALL for OFPP_ANY */
8749 if (oqsr->port_no == OFPP_ALL) {
8750 oqsr->port_no = OFPP_ANY;
8760 /* Encode a queue stats request for 'oqsr', the encoded message
8761 * will be for OpenFlow version 'ofp_version'. Returns message
8762 * as a struct ofpbuf. Returns encoded message on success, NULL on error. */
8764 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
8765 const struct ofputil_queue_stats_request *oqsr)
8767 struct ofpbuf *request;
8769 switch (ofp_version) {
8774 case OFP15_VERSION: {
8775 struct ofp11_queue_stats_request *req;
8776 request = ofpraw_alloc(OFPRAW_OFPST11_QUEUE_REQUEST, ofp_version, 0);
8777 req = ofpbuf_put_zeros(request, sizeof *req);
8778 req->port_no = ofputil_port_to_ofp11(oqsr->port_no);
8779 req->queue_id = htonl(oqsr->queue_id);
8782 case OFP10_VERSION: {
8783 struct ofp10_queue_stats_request *req;
8784 request = ofpraw_alloc(OFPRAW_OFPST10_QUEUE_REQUEST, ofp_version, 0);
8785 req = ofpbuf_put_zeros(request, sizeof *req);
8786 /* OpenFlow 1.0 needs OFPP_ALL instead of OFPP_ANY */
8787 req->port_no = htons(ofp_to_u16(oqsr->port_no == OFPP_ANY
8788 ? OFPP_ALL : oqsr->port_no));
8789 req->queue_id = htonl(oqsr->queue_id);
8799 /* Returns the number of queue stats elements in OFPTYPE_QUEUE_STATS_REPLY
8802 ofputil_count_queue_stats(const struct ofp_header *oh)
8804 struct ofputil_queue_stats qs;
8808 ofpbuf_use_const(&b, oh, ntohs(oh->length));
8809 ofpraw_pull_assert(&b);
8810 while (!ofputil_decode_queue_stats(&qs, &b)) {
8817 ofputil_queue_stats_from_ofp10(struct ofputil_queue_stats *oqs,
8818 const struct ofp10_queue_stats *qs10)
8820 oqs->port_no = u16_to_ofp(ntohs(qs10->port_no));
8821 oqs->queue_id = ntohl(qs10->queue_id);
8822 oqs->tx_bytes = ntohll(get_32aligned_be64(&qs10->tx_bytes));
8823 oqs->tx_packets = ntohll(get_32aligned_be64(&qs10->tx_packets));
8824 oqs->tx_errors = ntohll(get_32aligned_be64(&qs10->tx_errors));
8825 oqs->duration_sec = oqs->duration_nsec = UINT32_MAX;
8831 ofputil_queue_stats_from_ofp11(struct ofputil_queue_stats *oqs,
8832 const struct ofp11_queue_stats *qs11)
8836 error = ofputil_port_from_ofp11(qs11->port_no, &oqs->port_no);
8841 oqs->queue_id = ntohl(qs11->queue_id);
8842 oqs->tx_bytes = ntohll(qs11->tx_bytes);
8843 oqs->tx_packets = ntohll(qs11->tx_packets);
8844 oqs->tx_errors = ntohll(qs11->tx_errors);
8845 oqs->duration_sec = oqs->duration_nsec = UINT32_MAX;
8851 ofputil_queue_stats_from_ofp13(struct ofputil_queue_stats *oqs,
8852 const struct ofp13_queue_stats *qs13)
8854 enum ofperr error = ofputil_queue_stats_from_ofp11(oqs, &qs13->qs);
8856 oqs->duration_sec = ntohl(qs13->duration_sec);
8857 oqs->duration_nsec = ntohl(qs13->duration_nsec);
8864 ofputil_pull_ofp14_queue_stats(struct ofputil_queue_stats *oqs,
8867 const struct ofp14_queue_stats *qs14;
8870 qs14 = ofpbuf_try_pull(msg, sizeof *qs14);
8872 return OFPERR_OFPBRC_BAD_LEN;
8875 len = ntohs(qs14->length);
8876 if (len < sizeof *qs14 || len - sizeof *qs14 > msg->size) {
8877 return OFPERR_OFPBRC_BAD_LEN;
8879 ofpbuf_pull(msg, len - sizeof *qs14);
8881 /* No properties yet defined, so ignore them for now. */
8883 return ofputil_queue_stats_from_ofp13(oqs, &qs14->qs);
8886 /* Converts an OFPST_QUEUE_STATS reply in 'msg' into an abstract
8887 * ofputil_queue_stats in 'qs'.
8889 * Multiple OFPST_QUEUE_STATS replies can be packed into a single OpenFlow
8890 * message. Calling this function multiple times for a single 'msg' iterates
8891 * through the replies. The caller must initially leave 'msg''s layer pointers
8892 * null and not modify them between calls.
8894 * Returns 0 if successful, EOF if no replies were left in this 'msg',
8895 * otherwise a positive errno value. */
8897 ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg)
8902 error = (msg->header ? ofpraw_decode(&raw, msg->header)
8903 : ofpraw_pull(&raw, msg));
8910 } else if (raw == OFPRAW_OFPST14_QUEUE_REPLY) {
8911 return ofputil_pull_ofp14_queue_stats(qs, msg);
8912 } else if (raw == OFPRAW_OFPST13_QUEUE_REPLY) {
8913 const struct ofp13_queue_stats *qs13;
8915 qs13 = ofpbuf_try_pull(msg, sizeof *qs13);
8919 return ofputil_queue_stats_from_ofp13(qs, qs13);
8920 } else if (raw == OFPRAW_OFPST11_QUEUE_REPLY) {
8921 const struct ofp11_queue_stats *qs11;
8923 qs11 = ofpbuf_try_pull(msg, sizeof *qs11);
8927 return ofputil_queue_stats_from_ofp11(qs, qs11);
8928 } else if (raw == OFPRAW_OFPST10_QUEUE_REPLY) {
8929 const struct ofp10_queue_stats *qs10;
8931 qs10 = ofpbuf_try_pull(msg, sizeof *qs10);
8935 return ofputil_queue_stats_from_ofp10(qs, qs10);
8941 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_QUEUE reply has %"PRIu32" leftover "
8942 "bytes at end", msg->size);
8943 return OFPERR_OFPBRC_BAD_LEN;
8947 ofputil_queue_stats_to_ofp10(const struct ofputil_queue_stats *oqs,
8948 struct ofp10_queue_stats *qs10)
8950 qs10->port_no = htons(ofp_to_u16(oqs->port_no));
8951 memset(qs10->pad, 0, sizeof qs10->pad);
8952 qs10->queue_id = htonl(oqs->queue_id);
8953 put_32aligned_be64(&qs10->tx_bytes, htonll(oqs->tx_bytes));
8954 put_32aligned_be64(&qs10->tx_packets, htonll(oqs->tx_packets));
8955 put_32aligned_be64(&qs10->tx_errors, htonll(oqs->tx_errors));
8959 ofputil_queue_stats_to_ofp11(const struct ofputil_queue_stats *oqs,
8960 struct ofp11_queue_stats *qs11)
8962 qs11->port_no = ofputil_port_to_ofp11(oqs->port_no);
8963 qs11->queue_id = htonl(oqs->queue_id);
8964 qs11->tx_bytes = htonll(oqs->tx_bytes);
8965 qs11->tx_packets = htonll(oqs->tx_packets);
8966 qs11->tx_errors = htonll(oqs->tx_errors);
8970 ofputil_queue_stats_to_ofp13(const struct ofputil_queue_stats *oqs,
8971 struct ofp13_queue_stats *qs13)
8973 ofputil_queue_stats_to_ofp11(oqs, &qs13->qs);
8974 if (oqs->duration_sec != UINT32_MAX) {
8975 qs13->duration_sec = htonl(oqs->duration_sec);
8976 qs13->duration_nsec = htonl(oqs->duration_nsec);
8978 qs13->duration_sec = OVS_BE32_MAX;
8979 qs13->duration_nsec = OVS_BE32_MAX;
8984 ofputil_queue_stats_to_ofp14(const struct ofputil_queue_stats *oqs,
8985 struct ofp14_queue_stats *qs14)
8987 qs14->length = htons(sizeof *qs14);
8988 memset(qs14->pad, 0, sizeof qs14->pad);
8989 ofputil_queue_stats_to_ofp13(oqs, &qs14->qs);
8993 /* Encode a queue stat for 'oqs' and append it to 'replies'. */
8995 ofputil_append_queue_stat(struct ovs_list *replies,
8996 const struct ofputil_queue_stats *oqs)
8998 switch (ofpmp_version(replies)) {
8999 case OFP13_VERSION: {
9000 struct ofp13_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
9001 ofputil_queue_stats_to_ofp13(oqs, reply);
9006 case OFP11_VERSION: {
9007 struct ofp11_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
9008 ofputil_queue_stats_to_ofp11(oqs, reply);
9012 case OFP10_VERSION: {
9013 struct ofp10_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
9014 ofputil_queue_stats_to_ofp10(oqs, reply);
9019 case OFP15_VERSION: {
9020 struct ofp14_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
9021 ofputil_queue_stats_to_ofp14(oqs, reply);
9031 ofputil_decode_bundle_ctrl(const struct ofp_header *oh,
9032 struct ofputil_bundle_ctrl_msg *msg)
9036 const struct ofp14_bundle_ctrl_msg *m;
9038 ofpbuf_use_const(&b, oh, ntohs(oh->length));
9039 raw = ofpraw_pull_assert(&b);
9040 ovs_assert(raw == OFPRAW_OFPT14_BUNDLE_CONTROL);
9043 msg->bundle_id = ntohl(m->bundle_id);
9044 msg->type = ntohs(m->type);
9045 msg->flags = ntohs(m->flags);
9051 ofputil_encode_bundle_ctrl_request(enum ofp_version ofp_version,
9052 struct ofputil_bundle_ctrl_msg *bc)
9054 struct ofpbuf *request;
9055 struct ofp14_bundle_ctrl_msg *m;
9057 switch (ofp_version) {
9062 ovs_fatal(0, "bundles need OpenFlow 1.4 or later "
9063 "(\'-O OpenFlow14\')");
9066 request = ofpraw_alloc(OFPRAW_OFPT14_BUNDLE_CONTROL, ofp_version, 0);
9067 m = ofpbuf_put_zeros(request, sizeof *m);
9069 m->bundle_id = htonl(bc->bundle_id);
9070 m->type = htons(bc->type);
9071 m->flags = htons(bc->flags);
9081 ofputil_encode_bundle_ctrl_reply(const struct ofp_header *oh,
9082 struct ofputil_bundle_ctrl_msg *msg)
9085 struct ofp14_bundle_ctrl_msg *m;
9087 buf = ofpraw_alloc_reply(OFPRAW_OFPT14_BUNDLE_CONTROL, oh, 0);
9088 m = ofpbuf_put_zeros(buf, sizeof *m);
9090 m->bundle_id = htonl(msg->bundle_id);
9091 m->type = htons(msg->type);
9092 m->flags = htons(msg->flags);
9097 /* Return true for bundlable state change requests, false for other messages.
9100 ofputil_is_bundlable(enum ofptype type)
9103 /* Minimum required by OpenFlow 1.4. */
9104 case OFPTYPE_PORT_MOD:
9105 case OFPTYPE_FLOW_MOD:
9108 /* Nice to have later. */
9109 case OFPTYPE_FLOW_MOD_TABLE_ID:
9110 case OFPTYPE_GROUP_MOD:
9111 case OFPTYPE_TABLE_MOD:
9112 case OFPTYPE_METER_MOD:
9113 case OFPTYPE_PACKET_OUT:
9114 case OFPTYPE_NXT_GENEVE_TABLE_MOD:
9116 /* Not to be bundlable. */
9117 case OFPTYPE_ECHO_REQUEST:
9118 case OFPTYPE_FEATURES_REQUEST:
9119 case OFPTYPE_GET_CONFIG_REQUEST:
9120 case OFPTYPE_SET_CONFIG:
9121 case OFPTYPE_BARRIER_REQUEST:
9122 case OFPTYPE_ROLE_REQUEST:
9123 case OFPTYPE_ECHO_REPLY:
9124 case OFPTYPE_SET_FLOW_FORMAT:
9125 case OFPTYPE_SET_PACKET_IN_FORMAT:
9126 case OFPTYPE_SET_CONTROLLER_ID:
9127 case OFPTYPE_FLOW_AGE:
9128 case OFPTYPE_FLOW_MONITOR_CANCEL:
9129 case OFPTYPE_SET_ASYNC_CONFIG:
9130 case OFPTYPE_GET_ASYNC_REQUEST:
9131 case OFPTYPE_DESC_STATS_REQUEST:
9132 case OFPTYPE_FLOW_STATS_REQUEST:
9133 case OFPTYPE_AGGREGATE_STATS_REQUEST:
9134 case OFPTYPE_TABLE_STATS_REQUEST:
9135 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
9136 case OFPTYPE_TABLE_DESC_REQUEST:
9137 case OFPTYPE_PORT_STATS_REQUEST:
9138 case OFPTYPE_QUEUE_STATS_REQUEST:
9139 case OFPTYPE_PORT_DESC_STATS_REQUEST:
9140 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
9141 case OFPTYPE_METER_STATS_REQUEST:
9142 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
9143 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
9144 case OFPTYPE_GROUP_STATS_REQUEST:
9145 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
9146 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
9147 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
9148 case OFPTYPE_BUNDLE_CONTROL:
9149 case OFPTYPE_BUNDLE_ADD_MESSAGE:
9152 case OFPTYPE_FEATURES_REPLY:
9153 case OFPTYPE_GET_CONFIG_REPLY:
9154 case OFPTYPE_PACKET_IN:
9155 case OFPTYPE_FLOW_REMOVED:
9156 case OFPTYPE_PORT_STATUS:
9157 case OFPTYPE_BARRIER_REPLY:
9158 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
9159 case OFPTYPE_DESC_STATS_REPLY:
9160 case OFPTYPE_FLOW_STATS_REPLY:
9161 case OFPTYPE_QUEUE_STATS_REPLY:
9162 case OFPTYPE_PORT_STATS_REPLY:
9163 case OFPTYPE_TABLE_STATS_REPLY:
9164 case OFPTYPE_AGGREGATE_STATS_REPLY:
9165 case OFPTYPE_PORT_DESC_STATS_REPLY:
9166 case OFPTYPE_ROLE_REPLY:
9167 case OFPTYPE_FLOW_MONITOR_PAUSED:
9168 case OFPTYPE_FLOW_MONITOR_RESUMED:
9169 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
9170 case OFPTYPE_GET_ASYNC_REPLY:
9171 case OFPTYPE_GROUP_STATS_REPLY:
9172 case OFPTYPE_GROUP_DESC_STATS_REPLY:
9173 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
9174 case OFPTYPE_METER_STATS_REPLY:
9175 case OFPTYPE_METER_CONFIG_STATS_REPLY:
9176 case OFPTYPE_METER_FEATURES_STATS_REPLY:
9177 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
9178 case OFPTYPE_TABLE_DESC_REPLY:
9179 case OFPTYPE_ROLE_STATUS:
9180 case OFPTYPE_REQUESTFORWARD:
9181 case OFPTYPE_NXT_GENEVE_TABLE_REQUEST:
9182 case OFPTYPE_NXT_GENEVE_TABLE_REPLY:
9190 ofputil_decode_bundle_add(const struct ofp_header *oh,
9191 struct ofputil_bundle_add_msg *msg,
9192 enum ofptype *type_ptr)
9194 const struct ofp14_bundle_ctrl_msg *m;
9201 ofpbuf_use_const(&b, oh, ntohs(oh->length));
9202 raw = ofpraw_pull_assert(&b);
9203 ovs_assert(raw == OFPRAW_OFPT14_BUNDLE_ADD_MESSAGE);
9205 m = ofpbuf_pull(&b, sizeof *m);
9206 msg->bundle_id = ntohl(m->bundle_id);
9207 msg->flags = ntohs(m->flags);
9210 if (msg->msg->version != oh->version) {
9211 return OFPERR_NXBFC_BAD_VERSION;
9213 inner_len = ntohs(msg->msg->length);
9214 if (inner_len < sizeof(struct ofp_header) || inner_len > b.size) {
9215 return OFPERR_OFPBFC_MSG_BAD_LEN;
9217 if (msg->msg->xid != oh->xid) {
9218 return OFPERR_OFPBFC_MSG_BAD_XID;
9221 /* Reject unbundlable messages. */
9225 error = ofptype_decode(type_ptr, msg->msg);
9227 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPT14_BUNDLE_ADD_MESSAGE contained "
9228 "message is unparsable (%s)", ofperr_get_name(error));
9229 return OFPERR_OFPBFC_MSG_UNSUP; /* 'error' would be confusing. */
9232 if (!ofputil_is_bundlable(*type_ptr)) {
9233 VLOG_WARN_RL(&bad_ofmsg_rl, "%s message not allowed inside "
9234 "OFPT14_BUNDLE_ADD_MESSAGE", ofptype_get_name(*type_ptr));
9235 return OFPERR_OFPBFC_MSG_UNSUP;
9242 ofputil_encode_bundle_add(enum ofp_version ofp_version,
9243 struct ofputil_bundle_add_msg *msg)
9245 struct ofpbuf *request;
9246 struct ofp14_bundle_ctrl_msg *m;
9248 /* Must use the same xid as the embedded message. */
9249 request = ofpraw_alloc_xid(OFPRAW_OFPT14_BUNDLE_ADD_MESSAGE, ofp_version,
9251 m = ofpbuf_put_zeros(request, sizeof *m);
9253 m->bundle_id = htonl(msg->bundle_id);
9254 m->flags = htons(msg->flags);
9255 ofpbuf_put(request, msg->msg, ntohs(msg->msg->length));
9261 encode_geneve_table_mappings(struct ofpbuf *b, struct ovs_list *mappings)
9263 struct ofputil_geneve_map *map;
9265 LIST_FOR_EACH (map, list_node, mappings) {
9266 struct nx_geneve_map *nx_map;
9268 nx_map = ofpbuf_put_zeros(b, sizeof *nx_map);
9269 nx_map->option_class = htons(map->option_class);
9270 nx_map->option_type = map->option_type;
9271 nx_map->option_len = map->option_len;
9272 nx_map->index = htons(map->index);
9277 ofputil_encode_geneve_table_mod(enum ofp_version ofp_version,
9278 struct ofputil_geneve_table_mod *gtm)
9281 struct nx_geneve_table_mod *nx_gtm;
9283 b = ofpraw_alloc(OFPRAW_NXT_GENEVE_TABLE_MOD, ofp_version, 0);
9284 nx_gtm = ofpbuf_put_zeros(b, sizeof *nx_gtm);
9285 nx_gtm->command = htons(gtm->command);
9286 encode_geneve_table_mappings(b, >m->mappings);
9292 decode_geneve_table_mappings(struct ofpbuf *msg, unsigned int max_fields,
9293 struct ovs_list *mappings)
9295 list_init(mappings);
9298 struct nx_geneve_map *nx_map;
9299 struct ofputil_geneve_map *map;
9301 nx_map = ofpbuf_pull(msg, sizeof *nx_map);
9302 map = xmalloc(sizeof *map);
9303 list_push_back(mappings, &map->list_node);
9305 map->option_class = ntohs(nx_map->option_class);
9306 map->option_type = nx_map->option_type;
9308 map->option_len = nx_map->option_len;
9309 if (map->option_len % 4 || map->option_len > GENEVE_MAX_OPT_SIZE) {
9310 VLOG_WARN_RL(&bad_ofmsg_rl,
9311 "geneve table option length (%u) is not a valid option size",
9313 ofputil_uninit_geneve_table(mappings);
9314 return OFPERR_NXGTMFC_BAD_OPT_LEN;
9317 map->index = ntohs(nx_map->index);
9318 if (map->index >= max_fields) {
9319 VLOG_WARN_RL(&bad_ofmsg_rl,
9320 "geneve table field index (%u) is too large (max %u)",
9321 map->index, max_fields - 1);
9322 ofputil_uninit_geneve_table(mappings);
9323 return OFPERR_NXGTMFC_BAD_FIELD_IDX;
9331 ofputil_decode_geneve_table_mod(const struct ofp_header *oh,
9332 struct ofputil_geneve_table_mod *gtm)
9335 struct nx_geneve_table_mod *nx_gtm;
9337 ofpbuf_use_const(&msg, oh, ntohs(oh->length));
9338 ofpraw_pull_assert(&msg);
9340 nx_gtm = ofpbuf_pull(&msg, sizeof *nx_gtm);
9341 gtm->command = ntohs(nx_gtm->command);
9342 if (gtm->command > NXGTMC_CLEAR) {
9343 VLOG_WARN_RL(&bad_ofmsg_rl,
9344 "geneve table mod command (%u) is out of range",
9346 return OFPERR_NXGTMFC_BAD_COMMAND;
9349 return decode_geneve_table_mappings(&msg, TUN_METADATA_NUM_OPTS,
9354 ofputil_encode_geneve_table_reply(const struct ofp_header *oh,
9355 struct ofputil_geneve_table_reply *gtr)
9358 struct nx_geneve_table_reply *nx_gtr;
9360 b = ofpraw_alloc_reply(OFPRAW_NXT_GENEVE_TABLE_REPLY, oh, 0);
9361 nx_gtr = ofpbuf_put_zeros(b, sizeof *nx_gtr);
9362 nx_gtr->max_option_space = htonl(gtr->max_option_space);
9363 nx_gtr->max_fields = htons(gtr->max_fields);
9365 encode_geneve_table_mappings(b, >r->mappings);
9370 /* Decodes the NXT_GENEVE_TABLE_REPLY message in 'oh' into '*gtr'. Returns 0
9371 * if successful, otherwise an ofperr.
9373 * The decoder verifies that the indexes in 'gtr->mappings' are less than
9374 * 'gtr->max_fields', but the caller must ensure, if necessary, that they are
9375 * less than TUN_METADATA_NUM_OPTS. */
9377 ofputil_decode_geneve_table_reply(const struct ofp_header *oh,
9378 struct ofputil_geneve_table_reply *gtr)
9381 struct nx_geneve_table_reply *nx_gtr;
9383 ofpbuf_use_const(&msg, oh, ntohs(oh->length));
9384 ofpraw_pull_assert(&msg);
9386 nx_gtr = ofpbuf_pull(&msg, sizeof *nx_gtr);
9387 gtr->max_option_space = ntohl(nx_gtr->max_option_space);
9388 gtr->max_fields = ntohs(nx_gtr->max_fields);
9390 return decode_geneve_table_mappings(&msg, gtr->max_fields, >r->mappings);
9394 ofputil_uninit_geneve_table(struct ovs_list *mappings)
9396 struct ofputil_geneve_map *map;
9398 LIST_FOR_EACH_POP (map, list_node, mappings) {
9403 /* Decodes the OpenFlow "set async config" request and "get async config
9404 * reply" message in '*oh' into an abstract form in 'master' and 'slave'.
9406 * If 'loose' is true, this function ignores properties and values that it does
9407 * not understand, as a controller would want to do when interpreting
9408 * capabilities provided by a switch. If 'loose' is false, this function
9409 * treats unknown properties and values as an error, as a switch would want to
9410 * do when interpreting a configuration request made by a controller.
9412 * Returns 0 if successful, otherwise an OFPERR_* value. */
9414 ofputil_decode_set_async_config(const struct ofp_header *oh,
9415 uint32_t master[OAM_N_TYPES],
9416 uint32_t slave[OAM_N_TYPES],
9422 ofpbuf_use_const(&b, oh, ntohs(oh->length));
9423 raw = ofpraw_pull_assert(&b);
9425 if (raw == OFPRAW_OFPT13_SET_ASYNC ||
9426 raw == OFPRAW_NXT_SET_ASYNC_CONFIG ||
9427 raw == OFPRAW_OFPT13_GET_ASYNC_REPLY) {
9428 const struct nx_async_config *msg = ofpmsg_body(oh);
9430 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
9431 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
9432 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
9434 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
9435 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
9436 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
9438 } else if (raw == OFPRAW_OFPT14_SET_ASYNC ||
9439 raw == OFPRAW_OFPT14_GET_ASYNC_REPLY) {
9441 while (b.size > 0) {
9442 struct ofp14_async_config_prop_reasons *msg;
9443 struct ofpbuf property;
9447 error = ofputil_pull_property(&b, &property, &type);
9452 msg = property.data;
9454 if (property.size != sizeof *msg) {
9455 return OFPERR_OFPBRC_BAD_LEN;
9459 case OFPACPT_PACKET_IN_SLAVE:
9460 slave[OAM_PACKET_IN] = ntohl(msg->mask);
9463 case OFPACPT_PACKET_IN_MASTER:
9464 master[OAM_PACKET_IN] = ntohl(msg->mask);
9467 case OFPACPT_PORT_STATUS_SLAVE:
9468 slave[OAM_PORT_STATUS] = ntohl(msg->mask);
9471 case OFPACPT_PORT_STATUS_MASTER:
9472 master[OAM_PORT_STATUS] = ntohl(msg->mask);
9475 case OFPACPT_FLOW_REMOVED_SLAVE:
9476 slave[OAM_FLOW_REMOVED] = ntohl(msg->mask);
9479 case OFPACPT_FLOW_REMOVED_MASTER:
9480 master[OAM_FLOW_REMOVED] = ntohl(msg->mask);
9483 case OFPACPT_ROLE_STATUS_SLAVE:
9484 slave[OAM_ROLE_STATUS] = ntohl(msg->mask);
9487 case OFPACPT_ROLE_STATUS_MASTER:
9488 master[OAM_ROLE_STATUS] = ntohl(msg->mask);
9491 case OFPACPT_TABLE_STATUS_SLAVE:
9492 slave[OAM_TABLE_STATUS] = ntohl(msg->mask);
9495 case OFPACPT_TABLE_STATUS_MASTER:
9496 master[OAM_TABLE_STATUS] = ntohl(msg->mask);
9499 case OFPACPT_REQUESTFORWARD_SLAVE:
9500 slave[OAM_REQUESTFORWARD] = ntohl(msg->mask);
9503 case OFPACPT_REQUESTFORWARD_MASTER:
9504 master[OAM_REQUESTFORWARD] = ntohl(msg->mask);
9508 error = loose ? 0 : OFPERR_OFPBPC_BAD_TYPE;
9516 return OFPERR_OFPBRC_BAD_VERSION;
9521 /* Append all asynchronous configuration properties in GET_ASYNC_REPLY
9522 * message, describing if various set of asynchronous messages are enabled
9525 ofputil_get_async_reply(struct ofpbuf *buf, const uint32_t master_mask,
9526 const uint32_t slave_mask, const uint32_t type)
9530 for (role = 0; role < 2; role++) {
9531 struct ofp14_async_config_prop_reasons *msg;
9533 msg = ofpbuf_put_zeros(buf, sizeof *msg);
9537 msg->type = (role ? htons(OFPACPT_PACKET_IN_SLAVE)
9538 : htons(OFPACPT_PACKET_IN_MASTER));
9541 case OAM_PORT_STATUS:
9542 msg->type = (role ? htons(OFPACPT_PORT_STATUS_SLAVE)
9543 : htons(OFPACPT_PORT_STATUS_MASTER));
9546 case OAM_FLOW_REMOVED:
9547 msg->type = (role ? htons(OFPACPT_FLOW_REMOVED_SLAVE)
9548 : htons(OFPACPT_FLOW_REMOVED_MASTER));
9551 case OAM_ROLE_STATUS:
9552 msg->type = (role ? htons(OFPACPT_ROLE_STATUS_SLAVE)
9553 : htons(OFPACPT_ROLE_STATUS_MASTER));
9556 case OAM_TABLE_STATUS:
9557 msg->type = (role ? htons(OFPACPT_TABLE_STATUS_SLAVE)
9558 : htons(OFPACPT_TABLE_STATUS_MASTER));
9561 case OAM_REQUESTFORWARD:
9562 msg->type = (role ? htons(OFPACPT_REQUESTFORWARD_SLAVE)
9563 : htons(OFPACPT_REQUESTFORWARD_MASTER));
9567 return OFPERR_OFPBRC_BAD_TYPE;
9569 msg->length = htons(sizeof *msg);
9570 msg->mask = (role ? htonl(slave_mask) : htonl(master_mask));
9576 /* Returns a OpenFlow message that encodes 'asynchronous configuration' properly
9577 * as a reply to get async config request. */
9579 ofputil_encode_get_async_config(const struct ofp_header *oh,
9580 uint32_t master[OAM_N_TYPES],
9581 uint32_t slave[OAM_N_TYPES])
9586 buf = ofpraw_alloc_reply((oh->version < OFP14_VERSION
9587 ? OFPRAW_OFPT13_GET_ASYNC_REPLY
9588 : OFPRAW_OFPT14_GET_ASYNC_REPLY), oh, 0);
9590 if (oh->version < OFP14_VERSION) {
9591 struct nx_async_config *msg;
9592 msg = ofpbuf_put_zeros(buf, sizeof *msg);
9594 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
9595 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
9596 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
9598 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
9599 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
9600 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
9601 } else if (oh->version == OFP14_VERSION) {
9602 for (type = 0; type < OAM_N_TYPES; type++) {
9603 ofputil_get_async_reply(buf, master[type], slave[type], type);