X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fofp-util.c;h=d17811348bc0673dd9a0f29b20a26ddea9f3464a;hb=HEAD;hp=62cfd2ed47e421854d98c980ca3cb6159b69f0eb;hpb=0d56eaf2e00b9d0e4d9cbc5d5b360191e5c16ded;p=sliver-openvswitch.git diff --git a/lib/ofp-util.c b/lib/ofp-util.c index 62cfd2ed4..d17811348 100644 --- a/lib/ofp-util.c +++ b/lib/ofp-util.c @@ -1,5 +1,5 @@ /* - * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc. + * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -42,6 +42,7 @@ #include "unaligned.h" #include "type-props.h" #include "vlog.h" +#include "bitmap.h" VLOG_DEFINE_THIS_MODULE(ofp_util); @@ -84,7 +85,7 @@ ofputil_netmask_to_wcbits(ovs_be32 netmask) void ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *wc) { - BUILD_ASSERT_DECL(FLOW_WC_SEQ == 20); + BUILD_ASSERT_DECL(FLOW_WC_SEQ == 26); /* Initialize most of wc. */ flow_wildcards_init_catchall(wc); @@ -106,10 +107,10 @@ ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *wc) >> OFPFW10_NW_DST_SHIFT); if (!(ofpfw & OFPFW10_TP_SRC)) { - wc->masks.tp_src = htons(UINT16_MAX); + wc->masks.tp_src = OVS_BE16_MAX; } if (!(ofpfw & OFPFW10_TP_DST)) { - wc->masks.tp_dst = htons(UINT16_MAX); + wc->masks.tp_dst = OVS_BE16_MAX; } if (!(ofpfw & OFPFW10_DL_SRC)) { @@ -119,7 +120,7 @@ ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *wc) memset(wc->masks.dl_dst, 0xff, ETH_ADDR_LEN); } if (!(ofpfw & OFPFW10_DL_TYPE)) { - wc->masks.dl_type = htons(UINT16_MAX); + wc->masks.dl_type = OVS_BE16_MAX; } /* VLAN TCI mask. */ @@ -169,9 +170,11 @@ ofputil_match_from_ofp10_match(const struct ofp10_match *ofmatch, match->wc.masks.vlan_tci = htons(0xffff); } else { ovs_be16 vid, pcp, tci; + uint16_t hpcp; vid = ofmatch->dl_vlan & htons(VLAN_VID_MASK); - pcp = htons((ofmatch->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK); + hpcp = (ofmatch->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK; + pcp = htons(hpcp); tci = vid | pcp | htons(VLAN_CFI); match->flow.vlan_tci = tci & match->wc.masks.vlan_tci; } @@ -262,10 +265,10 @@ enum ofperr ofputil_pull_ofp11_match(struct ofpbuf *buf, struct match *match, uint16_t *padded_match_len) { - struct ofp11_match_header *omh = buf->data; + struct ofp11_match_header *omh = ofpbuf_data(buf); uint16_t match_len; - if (buf->size < sizeof *omh) { + if (ofpbuf_size(buf) < sizeof *omh) { return OFPERR_OFPBMC_BAD_LEN; } @@ -275,7 +278,7 @@ ofputil_pull_ofp11_match(struct ofpbuf *buf, struct match *match, case OFPMT_STANDARD: { struct ofp11_match *om; - if (match_len != sizeof *om || buf->size < sizeof *om) { + if (match_len != sizeof *om || ofpbuf_size(buf) < sizeof *om) { return OFPERR_OFPBMC_BAD_LEN; } om = ofpbuf_pull(buf, sizeof *om); @@ -296,8 +299,8 @@ ofputil_pull_ofp11_match(struct ofpbuf *buf, struct match *match, } } -/* Converts the ofp11_match in 'match' into a struct match in 'match. Returns - * 0 if successful, otherwise an OFPERR_* value. */ +/* Converts the ofp11_match in 'ofmatch' into a struct match in 'match'. + * Returns 0 if successful, otherwise an OFPERR_* value. */ enum ofperr ofputil_match_from_ofp11_match(const struct ofp11_match *ofmatch, struct match *match) @@ -335,7 +338,7 @@ ofputil_match_from_ofp11_match(const struct ofp11_match *ofmatch, if (ofmatch->dl_vlan == htons(OFPVID11_NONE)) { /* Match only packets without a VLAN tag. */ match->flow.vlan_tci = htons(0); - match->wc.masks.vlan_tci = htons(UINT16_MAX); + match->wc.masks.vlan_tci = OVS_BE16_MAX; } else { if (ofmatch->dl_vlan == htons(OFPVID11_ANY)) { /* Match any packet with a VLAN tag regardless of VID. */ @@ -436,11 +439,11 @@ ofputil_match_from_ofp11_match(const struct ofp11_match *ofmatch, } if (eth_type_mpls(match->flow.dl_type)) { - enum { OFPFW11_MPLS_ALL = OFPFW11_MPLS_LABEL | OFPFW11_MPLS_TC }; - - if ((wc & OFPFW11_MPLS_ALL) != OFPFW11_MPLS_ALL) { - /* MPLS not supported. */ - return OFPERR_OFPBMC_BAD_TAG; + if (!(wc & OFPFW11_MPLS_LABEL)) { + match_set_mpls_label(match, 0, ofmatch->mpls_label); + } + if (!(wc & OFPFW11_MPLS_TC)) { + match_set_mpls_tc(match, 0, ofmatch->mpls_tc); } } @@ -533,9 +536,18 @@ ofputil_match_to_ofp11_match(const struct match *match, ofmatch->tp_dst = match->flow.tp_dst; } - /* MPLS not supported. */ - wc |= OFPFW11_MPLS_LABEL; - wc |= OFPFW11_MPLS_TC; + if (!(match->wc.masks.mpls_lse[0] & htonl(MPLS_LABEL_MASK))) { + wc |= OFPFW11_MPLS_LABEL; + } else { + ofmatch->mpls_label = htonl(mpls_lse_to_label( + match->flow.mpls_lse[0])); + } + + if (!(match->wc.masks.mpls_lse[0] & htonl(MPLS_TC_MASK))) { + wc |= OFPFW11_MPLS_TC; + } else { + ofmatch->mpls_tc = mpls_lse_to_tc(match->flow.mpls_lse[0]); + } ofmatch->metadata = match->flow.metadata; ofmatch->metadata_mask = ~match->wc.masks.metadata; @@ -562,10 +574,11 @@ ofputil_match_typical_len(enum ofputil_protocol protocol) case OFPUTIL_P_OF12_OXM: case OFPUTIL_P_OF13_OXM: + case OFPUTIL_P_OF14_OXM: return NXM_TYPICAL_LEN; default: - NOT_REACHED(); + OVS_NOT_REACHED(); } } @@ -587,7 +600,7 @@ ofputil_put_ofp11_match(struct ofpbuf *b, const struct match *match, case OFPUTIL_P_OF10_STD_TID: case OFPUTIL_P_OF10_NXM: case OFPUTIL_P_OF10_NXM_TID: - NOT_REACHED(); + OVS_NOT_REACHED(); case OFPUTIL_P_OF11_STD: { struct ofp11_match *om; @@ -602,10 +615,11 @@ ofputil_put_ofp11_match(struct ofpbuf *b, const struct match *match, case OFPUTIL_P_OF12_OXM: case OFPUTIL_P_OF13_OXM: + case OFPUTIL_P_OF14_OXM: return oxm_put_match(b, match); } - NOT_REACHED(); + OVS_NOT_REACHED(); } /* Given a 'dl_type' value in the format used in struct flow, returns the @@ -638,16 +652,21 @@ struct proto_abbrev { }; /* Most users really don't care about some of the differences between - * protocols. These abbreviations help with that. */ + * protocols. These abbreviations help with that. + * + * Until it is safe to use the OpenFlow 1.4 protocol (which currently can + * cause aborts due to unimplemented features), we omit OpenFlow 1.4 from all + * abbrevations. */ static const struct proto_abbrev proto_abbrevs[] = { - { OFPUTIL_P_ANY, "any" }, - { OFPUTIL_P_OF10_STD_ANY, "OpenFlow10" }, - { OFPUTIL_P_OF10_NXM_ANY, "NXM" }, - { OFPUTIL_P_ANY_OXM, "OXM" }, + { OFPUTIL_P_ANY & ~OFPUTIL_P_OF14_OXM, "any" }, + { OFPUTIL_P_OF10_STD_ANY & ~OFPUTIL_P_OF14_OXM, "OpenFlow10" }, + { OFPUTIL_P_OF10_NXM_ANY & ~OFPUTIL_P_OF14_OXM, "NXM" }, + { OFPUTIL_P_ANY_OXM & ~OFPUTIL_P_OF14_OXM, "OXM" }, }; #define N_PROTO_ABBREVS ARRAY_SIZE(proto_abbrevs) enum ofputil_protocol ofputil_flow_dump_protocols[] = { + OFPUTIL_P_OF14_OXM, OFPUTIL_P_OF13_OXM, OFPUTIL_P_OF12_OXM, OFPUTIL_P_OF11_STD, @@ -672,6 +691,8 @@ ofputil_protocols_from_ofp_version(enum ofp_version version) return OFPUTIL_P_OF12_OXM; case OFP13_VERSION: return OFPUTIL_P_OF13_OXM; + case OFP14_VERSION: + return OFPUTIL_P_OF14_OXM; default: return 0; } @@ -705,9 +726,11 @@ ofputil_protocol_to_ofp_version(enum ofputil_protocol protocol) return OFP12_VERSION; case OFPUTIL_P_OF13_OXM: return OFP13_VERSION; + case OFPUTIL_P_OF14_OXM: + return OFP14_VERSION; } - NOT_REACHED(); + OVS_NOT_REACHED(); } /* Returns a bitmap of OpenFlow versions that are supported by at @@ -781,8 +804,11 @@ ofputil_protocol_set_tid(enum ofputil_protocol protocol, bool enable) case OFPUTIL_P_OF13_OXM: return OFPUTIL_P_OF13_OXM; + case OFPUTIL_P_OF14_OXM: + return OFPUTIL_P_OF14_OXM; + default: - NOT_REACHED(); + OVS_NOT_REACHED(); } } @@ -821,8 +847,11 @@ ofputil_protocol_set_base(enum ofputil_protocol cur, case OFPUTIL_P_OF13_OXM: return ofputil_protocol_set_tid(OFPUTIL_P_OF13_OXM, tid); + case OFPUTIL_P_OF14_OXM: + return ofputil_protocol_set_tid(OFPUTIL_P_OF14_OXM, tid); + default: - NOT_REACHED(); + OVS_NOT_REACHED(); } } @@ -857,6 +886,9 @@ ofputil_protocol_to_string(enum ofputil_protocol protocol) case OFPUTIL_P_OF13_OXM: return "OXM-OpenFlow13"; + + case OFPUTIL_P_OF14_OXM: + return "OXM-OpenFlow14"; } /* Check abbreviations. */ @@ -910,7 +942,7 @@ ofputil_protocols_to_string(enum ofputil_protocol protocols) goto match; } } - NOT_REACHED(); + OVS_NOT_REACHED(); match: ; } @@ -992,6 +1024,9 @@ ofputil_version_from_string(const char *s) if (!strcasecmp(s, "OpenFlow13")) { return OFP13_VERSION; } + if (!strcasecmp(s, "OpenFlow14")) { + return OFP14_VERSION; + } return 0; } @@ -1062,8 +1097,10 @@ ofputil_version_to_string(enum ofp_version ofp_version) return "OpenFlow12"; case OFP13_VERSION: return "OpenFlow13"; + case OFP14_VERSION: + return "OpenFlow14"; default: - NOT_REACHED(); + OVS_NOT_REACHED(); } } @@ -1088,7 +1125,7 @@ ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format) case NXPIF_NXM: return "nxm"; default: - NOT_REACHED(); + OVS_NOT_REACHED(); } } @@ -1100,158 +1137,6 @@ ofputil_packet_in_format_from_string(const char *s) : -1); } -static bool -regs_fully_wildcarded(const struct flow_wildcards *wc) -{ - int i; - - for (i = 0; i < FLOW_N_REGS; i++) { - if (wc->masks.regs[i] != 0) { - return false; - } - } - return true; -} - -/* Returns a bit-mask of ofputil_protocols that can be used for sending 'match' - * to a switch (e.g. to add or remove a flow). Only NXM can handle tunnel IDs, - * registers, or fixing the Ethernet multicast bit. Otherwise, it's better to - * use OpenFlow 1.0 protocol for backward compatibility. */ -enum ofputil_protocol -ofputil_usable_protocols(const struct match *match) -{ - const struct flow_wildcards *wc = &match->wc; - - BUILD_ASSERT_DECL(FLOW_WC_SEQ == 20); - - /* These tunnel params can't be sent in a flow_mod */ - if (wc->masks.tunnel.ip_ttl - || wc->masks.tunnel.ip_tos || wc->masks.tunnel.flags) { - return OFPUTIL_P_NONE; - } - - /* skb_priority can't be sent in a flow_mod */ - if (wc->masks.skb_priority) { - return OFPUTIL_P_NONE; - } - - /* NXM and OXM support pkt_mark */ - if (wc->masks.pkt_mark) { - return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM - | OFPUTIL_P_OF13_OXM; - } - - /* NXM, OXM, and OF1.1 support bitwise matching on ethernet addresses. */ - if (!eth_mask_is_exact(wc->masks.dl_src) - && !eth_addr_is_zero(wc->masks.dl_src)) { - return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM - | OFPUTIL_P_OF13_OXM; - } - if (!eth_mask_is_exact(wc->masks.dl_dst) - && !eth_addr_is_zero(wc->masks.dl_dst)) { - return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM - | OFPUTIL_P_OF13_OXM; - } - - /* NXM, OXM, and OF1.1+ support matching metadata. */ - if (wc->masks.metadata != htonll(0)) { - return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM - | OFPUTIL_P_OF13_OXM; - } - - /* NXM and OXM support matching ARP hardware addresses. */ - if (!eth_addr_is_zero(wc->masks.arp_sha) || - !eth_addr_is_zero(wc->masks.arp_tha)) { - return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM - | OFPUTIL_P_OF13_OXM; - } - - /* NXM and OXM support matching L3 and L4 fields within IPv6. - * - * (arp_sha, arp_tha, nw_frag, and nw_ttl are covered elsewhere so they - * don't need to be included in this test too.) */ - if (match->flow.dl_type == htons(ETH_TYPE_IPV6) - && (!ipv6_mask_is_any(&wc->masks.ipv6_src) - || !ipv6_mask_is_any(&wc->masks.ipv6_dst) - || !ipv6_mask_is_any(&wc->masks.nd_target) - || wc->masks.ipv6_label - || wc->masks.tp_src - || wc->masks.tp_dst - || wc->masks.nw_proto - || wc->masks.nw_tos)) { - return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM - | OFPUTIL_P_OF13_OXM; - } - - /* NXM and OXM support matching registers. */ - if (!regs_fully_wildcarded(wc)) { - return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM - | OFPUTIL_P_OF13_OXM; - } - - /* NXM and OXM support matching tun_id, tun_src, and tun_dst. */ - if (wc->masks.tunnel.tun_id != htonll(0) - || wc->masks.tunnel.ip_src != htonl(0) - || wc->masks.tunnel.ip_dst != htonl(0)) { - return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM - | OFPUTIL_P_OF13_OXM; - } - - /* NXM and OXM support matching fragments. */ - if (wc->masks.nw_frag) { - return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM - | OFPUTIL_P_OF13_OXM; - } - - /* NXM and OXM support matching IP ECN bits. */ - if (wc->masks.nw_tos & IP_ECN_MASK) { - return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM - | OFPUTIL_P_OF13_OXM; - } - - /* NXM and OXM support matching IP TTL/hop limit. */ - if (wc->masks.nw_ttl) { - return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM - | OFPUTIL_P_OF13_OXM; - } - - /* NXM and OXM support non-CIDR IPv4 address masks. */ - if (!ip_is_cidr(wc->masks.nw_src) || !ip_is_cidr(wc->masks.nw_dst)) { - return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM - | OFPUTIL_P_OF13_OXM; - } - - /* NXM and OXM support bitwise matching on transport port. */ - if ((wc->masks.tp_src && wc->masks.tp_src != htons(UINT16_MAX)) || - (wc->masks.tp_dst && wc->masks.tp_dst != htons(UINT16_MAX))) { - return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM - | OFPUTIL_P_OF13_OXM; - } - - /* NXM and OF1.1+ support matching MPLS label */ - if (wc->masks.mpls_lse & htonl(MPLS_LABEL_MASK)) { - return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM - | OFPUTIL_P_OF13_OXM; - } - - /* NXM and OF1.1+ support matching MPLS TC */ - if (wc->masks.mpls_lse & htonl(MPLS_TC_MASK)) { - return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM - | OFPUTIL_P_OF13_OXM; - } - - /* NXM and OF1.3+ support matching MPLS stack flag */ - /* Allow for OF1.2 as there doesn't seem to be a - * particularly good reason not to */ - if (wc->masks.mpls_lse & htonl(MPLS_BOS_MASK)) { - return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM - | OFPUTIL_P_OF13_OXM; - } - - /* Other formats can express this rule. */ - return OFPUTIL_P_ANY; -} - void ofputil_format_version(struct ds *msg, enum ofp_version version) { @@ -1349,15 +1234,15 @@ ofputil_decode_hello(const struct ofp_header *oh, uint32_t *allowed_versions) ofpbuf_pull(&msg, sizeof *oh); *allowed_versions = version_bitmap_from_version(oh->version); - while (msg.size) { + while (ofpbuf_size(&msg)) { const struct ofp_hello_elem_header *oheh; unsigned int len; - if (msg.size < sizeof *oheh) { + if (ofpbuf_size(&msg) < sizeof *oheh) { return false; } - oheh = msg.data; + oheh = ofpbuf_data(&msg); len = ntohs(oheh->length); if (len < sizeof *oheh || !ofpbuf_try_pull(&msg, ROUND_UP(len, 8))) { return false; @@ -1447,13 +1332,14 @@ ofputil_encode_set_protocol(enum ofputil_protocol current, case OFPUTIL_P_OF11_STD: case OFPUTIL_P_OF12_OXM: case OFPUTIL_P_OF13_OXM: + case OFPUTIL_P_OF14_OXM: /* There is only one variant of each OpenFlow 1.1+ protocol, and we * verified above that we're not trying to change versions. */ - NOT_REACHED(); + OVS_NOT_REACHED(); case OFPUTIL_P_OF10_STD_TID: case OFPUTIL_P_OF10_NXM_TID: - NOT_REACHED(); + OVS_NOT_REACHED(); } } @@ -1522,7 +1408,7 @@ ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format) case NXFF_NXM: return "nxm"; default: - NOT_REACHED(); + OVS_NOT_REACHED(); } } @@ -1554,6 +1440,74 @@ ofputil_make_flow_mod_table_id(bool flow_mod_table_id) return msg; } +struct ofputil_flow_mod_flag { + uint16_t raw_flag; + enum ofp_version min_version, max_version; + enum ofputil_flow_mod_flags flag; +}; + +static const struct ofputil_flow_mod_flag ofputil_flow_mod_flags[] = { + { OFPFF_SEND_FLOW_REM, OFP10_VERSION, 0, OFPUTIL_FF_SEND_FLOW_REM }, + { OFPFF_CHECK_OVERLAP, OFP10_VERSION, 0, OFPUTIL_FF_CHECK_OVERLAP }, + { OFPFF10_EMERG, OFP10_VERSION, OFP10_VERSION, + OFPUTIL_FF_EMERG }, + { OFPFF12_RESET_COUNTS, OFP12_VERSION, 0, OFPUTIL_FF_RESET_COUNTS }, + { OFPFF13_NO_PKT_COUNTS, OFP13_VERSION, 0, OFPUTIL_FF_NO_PKT_COUNTS }, + { OFPFF13_NO_BYT_COUNTS, OFP13_VERSION, 0, OFPUTIL_FF_NO_BYT_COUNTS }, + { 0, 0, 0, 0 }, +}; + +static enum ofperr +ofputil_decode_flow_mod_flags(ovs_be16 raw_flags_, + enum ofp_flow_mod_command command, + enum ofp_version version, + enum ofputil_flow_mod_flags *flagsp) +{ + uint16_t raw_flags = ntohs(raw_flags_); + const struct ofputil_flow_mod_flag *f; + + *flagsp = 0; + for (f = ofputil_flow_mod_flags; f->raw_flag; f++) { + if (raw_flags & f->raw_flag + && version >= f->min_version + && (!f->max_version || version <= f->max_version)) { + raw_flags &= ~f->raw_flag; + *flagsp |= f->flag; + } + } + + /* In OF1.0 and OF1.1, "add" always resets counters, and other commands + * never do. + * + * In OF1.2 and later, OFPFF12_RESET_COUNTS controls whether each command + * resets counters. */ + if ((version == OFP10_VERSION || version == OFP11_VERSION) + && command == OFPFC_ADD) { + *flagsp |= OFPUTIL_FF_RESET_COUNTS; + } + + return raw_flags ? OFPERR_OFPFMFC_BAD_FLAGS : 0; +} + +static ovs_be16 +ofputil_encode_flow_mod_flags(enum ofputil_flow_mod_flags flags, + enum ofp_version version) +{ + const struct ofputil_flow_mod_flag *f; + uint16_t raw_flags; + + raw_flags = 0; + for (f = ofputil_flow_mod_flags; f->raw_flag; f++) { + if (f->flag & flags + && version >= f->min_version + && (!f->max_version || version <= f->max_version)) { + raw_flags |= f->raw_flag; + } + } + + return htons(raw_flags); +} + /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error * code. @@ -1568,18 +1522,19 @@ enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *fm, const struct ofp_header *oh, enum ofputil_protocol protocol, - struct ofpbuf *ofpacts) + struct ofpbuf *ofpacts, + ofp_port_t max_port, uint8_t max_table) { - uint16_t command; + ovs_be16 raw_flags; + enum ofperr error; struct ofpbuf b; enum ofpraw raw; ofpbuf_use_const(&b, oh, ntohs(oh->length)); raw = ofpraw_pull_assert(&b); if (raw == OFPRAW_OFPT11_FLOW_MOD) { - /* Standard OpenFlow 1.1 flow_mod. */ + /* Standard OpenFlow 1.1+ flow_mod. */ const struct ofp11_flow_mod *ofm; - enum ofperr error; ofm = ofpbuf_pull(&b, sizeof *ofm); @@ -1588,7 +1543,8 @@ ofputil_decode_flow_mod(struct ofputil_flow_mod *fm, return error; } - error = ofpacts_pull_openflow11_instructions(&b, b.size, ofpacts); + error = ofpacts_pull_openflow_instructions(&b, ofpbuf_size(&b), oh->version, + ofpacts); if (error) { return error; } @@ -1609,11 +1565,23 @@ ofputil_decode_flow_mod(struct ofputil_flow_mod *fm, } else { fm->cookie = ofm->cookie; fm->cookie_mask = ofm->cookie_mask; - fm->new_cookie = htonll(UINT64_MAX); + fm->new_cookie = OVS_BE64_MAX; } fm->modify_cookie = false; fm->command = ofm->command; + + /* Get table ID. + * + * OF1.1 entirely forbids table_id == OFPTT_ALL. + * OF1.2+ allows table_id == OFPTT_ALL only for deletes. */ fm->table_id = ofm->table_id; + if (fm->table_id == OFPTT_ALL + && (oh->version == OFP11_VERSION + || (ofm->command != OFPFC_DELETE && + ofm->command != OFPFC_DELETE_STRICT))) { + return OFPERR_OFPFMFC_BAD_TABLE_ID; + } + fm->idle_timeout = ntohs(ofm->idle_timeout); fm->hard_timeout = ntohs(ofm->hard_timeout); fm->buffer_id = ntohl(ofm->buffer_id); @@ -1621,17 +1589,18 @@ ofputil_decode_flow_mod(struct ofputil_flow_mod *fm, if (error) { return error; } - if ((ofm->command == OFPFC_DELETE - || ofm->command == OFPFC_DELETE_STRICT) - && ofm->out_group != htonl(OFPG_ANY)) { - return OFPERR_OFPFMFC_UNKNOWN; - } - fm->flags = ntohs(ofm->flags); + + fm->out_group = (ofm->command == OFPFC_DELETE || + ofm->command == OFPFC_DELETE_STRICT + ? ntohl(ofm->out_group) + : OFPG11_ANY); + raw_flags = ofm->flags; } else { + uint16_t command; + if (raw == OFPRAW_OFPT10_FLOW_MOD) { /* Standard OpenFlow 1.0 flow_mod. */ const struct ofp10_flow_mod *ofm; - enum ofperr error; /* Get the ofp10_flow_mod. */ ofm = ofpbuf_pull(&b, sizeof *ofm); @@ -1641,7 +1610,8 @@ ofputil_decode_flow_mod(struct ofputil_flow_mod *fm, ofputil_normalize_match(&fm->match); /* Now get the actions. */ - error = ofpacts_pull_openflow10(&b, b.size, ofpacts); + error = ofpacts_pull_openflow_actions(&b, ofpbuf_size(&b), oh->version, + ofpacts); if (error) { return error; } @@ -1661,11 +1631,11 @@ ofputil_decode_flow_mod(struct ofputil_flow_mod *fm, fm->hard_timeout = ntohs(ofm->hard_timeout); fm->buffer_id = ntohl(ofm->buffer_id); fm->out_port = u16_to_ofp(ntohs(ofm->out_port)); - fm->flags = ntohs(ofm->flags); + fm->out_group = OFPG11_ANY; + raw_flags = ofm->flags; } else if (raw == OFPRAW_NXT_FLOW_MOD) { /* Nicira extended flow_mod. */ const struct nx_flow_mod *nfm; - enum ofperr error; /* Dissect the message. */ nfm = ofpbuf_pull(&b, sizeof *nfm); @@ -1674,7 +1644,8 @@ ofputil_decode_flow_mod(struct ofputil_flow_mod *fm, if (error) { return error; } - error = ofpacts_pull_openflow10(&b, b.size, ofpacts); + error = ofpacts_pull_openflow_actions(&b, ofpbuf_size(&b), oh->version, + ofpacts); if (error) { return error; } @@ -1692,24 +1663,13 @@ ofputil_decode_flow_mod(struct ofputil_flow_mod *fm, fm->hard_timeout = ntohs(nfm->hard_timeout); fm->buffer_id = ntohl(nfm->buffer_id); fm->out_port = u16_to_ofp(ntohs(nfm->out_port)); - fm->flags = ntohs(nfm->flags); + fm->out_group = OFPG11_ANY; + raw_flags = nfm->flags; } else { - NOT_REACHED(); - } - - if (fm->flags & OFPFF10_EMERG) { - /* We do not support the OpenFlow 1.0 emergency flow cache, which - * is not required in OpenFlow 1.0.1 and removed from OpenFlow 1.1. - * - * OpenFlow 1.0 specifies the error code to use when idle_timeout - * or hard_timeout is nonzero. Otherwise, there is no good error - * code, so just state that the flow table is full. */ - return (fm->hard_timeout || fm->idle_timeout - ? OFPERR_OFPFMFC_BAD_EMERG_TIMEOUT - : OFPERR_OFPFMFC_TABLE_FULL); + OVS_NOT_REACHED(); } - fm->modify_cookie = fm->new_cookie != htonll(UINT64_MAX); + fm->modify_cookie = fm->new_cookie != OVS_BE64_MAX; if (protocol & OFPUTIL_P_TID) { fm->command = command & 0xff; fm->table_id = command >> 8; @@ -1719,10 +1679,30 @@ ofputil_decode_flow_mod(struct ofputil_flow_mod *fm, } } - fm->ofpacts = ofpacts->data; - fm->ofpacts_len = ofpacts->size; + fm->ofpacts = ofpbuf_data(ofpacts); + fm->ofpacts_len = ofpbuf_size(ofpacts); - return 0; + error = ofputil_decode_flow_mod_flags(raw_flags, fm->command, + oh->version, &fm->flags); + if (error) { + return error; + } + + if (fm->flags & OFPUTIL_FF_EMERG) { + /* We do not support the OpenFlow 1.0 emergency flow cache, which + * is not required in OpenFlow 1.0.1 and removed from OpenFlow 1.1. + * + * OpenFlow 1.0 specifies the error code to use when idle_timeout + * or hard_timeout is nonzero. Otherwise, there is no good error + * code, so just state that the flow table is full. */ + return (fm->hard_timeout || fm->idle_timeout + ? OFPERR_OFPFMFC_BAD_EMERG_TIMEOUT + : OFPERR_OFPFMFC_TABLE_FULL); + } + + return ofpacts_check_consistency(fm->ofpacts, fm->ofpacts_len, + &fm->match.flow, max_port, + fm->table_id, max_table, protocol); } static enum ofperr @@ -1746,6 +1726,9 @@ ofputil_pull_bands(struct ofpbuf *msg, size_t len, uint16_t *n_bands, } mb = ofpbuf_put_uninit(bands, sizeof *mb); mb->type = ntohs(ombh->type); + if (mb->type != OFPMBT13_DROP && mb->type != OFPMBT13_DSCP_REMARK) { + return OFPERR_OFPMMFC_BAD_BAND; + } mb->rate = ntohl(ombh->rate); mb->burst_size = ntohl(ombh->burst_size); mb->prec_level = (mb->type == OFPMBT13_DSCP_REMARK) ? @@ -1776,6 +1759,11 @@ ofputil_decode_meter_mod(const struct ofp_header *oh, /* Translate the message. */ mm->command = ntohs(omm->command); + if (mm->command != OFPMC13_ADD && + mm->command != OFPMC13_MODIFY && + mm->command != OFPMC13_DELETE) { + return OFPERR_OFPMMFC_BAD_COMMAND; + } mm->meter.meter_id = ntohl(omm->meter_id); if (mm->command == OFPMC13_DELETE) { @@ -1786,9 +1774,13 @@ ofputil_decode_meter_mod(const struct ofp_header *oh, enum ofperr error; mm->meter.flags = ntohs(omm->flags); - mm->meter.bands = bands->data; + if (mm->meter.flags & OFPMF13_KBPS && + mm->meter.flags & OFPMF13_PKTPS) { + return OFPERR_OFPMMFC_BAD_FLAGS; + } + mm->meter.bands = ofpbuf_data(bands); - error = ofputil_pull_bands(&b, b.size, &mm->meter.n_bands, bands); + error = ofputil_pull_bands(&b, ofpbuf_size(&b), &mm->meter.n_bands, bands); if (error) { return error; } @@ -1864,14 +1856,14 @@ ofputil_append_meter_config(struct list *replies, const struct ofputil_meter_config *mc) { struct ofpbuf *msg = ofpbuf_from_list(list_back(replies)); - size_t start_ofs = msg->size; + size_t start_ofs = ofpbuf_size(msg); struct ofp13_meter_config *reply = ofpbuf_put_uninit(msg, sizeof *reply); reply->flags = htons(mc->flags); reply->meter_id = htonl(mc->meter_id); ofputil_put_bands(mc->n_bands, mc->bands, msg); - reply->length = htons(msg->size - start_ofs); + reply->length = htons(ofpbuf_size(msg) - start_ofs); ofpmp_postappend(replies, start_ofs); } @@ -1926,19 +1918,19 @@ ofputil_decode_meter_config(struct ofpbuf *msg, enum ofperr err; /* Pull OpenFlow headers for the first call. */ - if (!msg->l2) { + if (!msg->frame) { ofpraw_pull_assert(msg); } - if (!msg->size) { + if (!ofpbuf_size(msg)) { return EOF; } omc = ofpbuf_try_pull(msg, sizeof *omc); if (!omc) { VLOG_WARN_RL(&bad_ofmsg_rl, - "OFPMP_METER_CONFIG reply has %zu leftover bytes at end", - msg->size); + "OFPMP_METER_CONFIG reply has %"PRIu32" leftover bytes at end", + ofpbuf_size(msg)); return OFPERR_OFPBRC_BAD_LEN; } @@ -1950,7 +1942,7 @@ ofputil_decode_meter_config(struct ofpbuf *msg, } mc->meter_id = ntohl(omc->meter_id); mc->flags = ntohs(omc->flags); - mc->bands = bands->data; + mc->bands = ofpbuf_data(bands); return 0; } @@ -2002,19 +1994,19 @@ ofputil_decode_meter_stats(struct ofpbuf *msg, enum ofperr err; /* Pull OpenFlow headers for the first call. */ - if (!msg->l2) { + if (!msg->frame) { ofpraw_pull_assert(msg); } - if (!msg->size) { + if (!ofpbuf_size(msg)) { return EOF; } oms = ofpbuf_try_pull(msg, sizeof *oms); if (!oms) { VLOG_WARN_RL(&bad_ofmsg_rl, - "OFPMP_METER reply has %zu leftover bytes at end", - msg->size); + "OFPMP_METER reply has %"PRIu32" leftover bytes at end", + ofpbuf_size(msg)); return OFPERR_OFPBRC_BAD_LEN; } @@ -2030,7 +2022,7 @@ ofputil_decode_meter_stats(struct ofpbuf *msg, ms->byte_in_count = ntohll(oms->byte_in_count); ms->duration_sec = ntohl(oms->duration_sec); ms->duration_nsec = ntohl(oms->duration_nsec); - ms->bands = bands->data; + ms->bands = ofpbuf_data(bands); return 0; } @@ -2105,19 +2097,20 @@ struct ofpbuf * ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm, enum ofputil_protocol protocol) { + enum ofp_version version = ofputil_protocol_to_ofp_version(protocol); + ovs_be16 raw_flags = ofputil_encode_flow_mod_flags(fm->flags, version); struct ofpbuf *msg; switch (protocol) { case OFPUTIL_P_OF11_STD: case OFPUTIL_P_OF12_OXM: - case OFPUTIL_P_OF13_OXM: { + case OFPUTIL_P_OF13_OXM: + case OFPUTIL_P_OF14_OXM: { struct ofp11_flow_mod *ofm; int tailroom; tailroom = ofputil_match_typical_len(protocol) + fm->ofpacts_len; - msg = ofpraw_alloc(OFPRAW_OFPT11_FLOW_MOD, - ofputil_protocol_to_ofp_version(protocol), - tailroom); + msg = ofpraw_alloc(OFPRAW_OFPT11_FLOW_MOD, version, tailroom); ofm = ofpbuf_put_zeros(msg, sizeof *ofm); if ((protocol == OFPUTIL_P_OF11_STD && (fm->command == OFPFC_MODIFY || @@ -2129,17 +2122,25 @@ ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm, ofm->cookie = fm->cookie; } ofm->cookie_mask = fm->cookie_mask; - ofm->table_id = fm->table_id; + if (fm->table_id != OFPTT_ALL + || (protocol != OFPUTIL_P_OF11_STD + && (fm->command == OFPFC_DELETE || + fm->command == OFPFC_DELETE_STRICT))) { + ofm->table_id = fm->table_id; + } else { + ofm->table_id = 0; + } ofm->command = fm->command; ofm->idle_timeout = htons(fm->idle_timeout); ofm->hard_timeout = htons(fm->hard_timeout); ofm->priority = htons(fm->priority); ofm->buffer_id = htonl(fm->buffer_id); ofm->out_port = ofputil_port_to_ofp11(fm->out_port); - ofm->out_group = htonl(OFPG11_ANY); - ofm->flags = htons(fm->flags); + ofm->out_group = htonl(fm->out_group); + ofm->flags = raw_flags; ofputil_put_ofp11_match(msg, &fm->match, protocol); - ofpacts_put_openflow11_instructions(fm->ofpacts, fm->ofpacts_len, msg); + ofpacts_put_openflow_instructions(fm->ofpacts, fm->ofpacts_len, msg, + version); break; } @@ -2158,8 +2159,9 @@ ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm, ofm->priority = htons(fm->priority); ofm->buffer_id = htonl(fm->buffer_id); ofm->out_port = htons(ofp_to_u16(fm->out_port)); - ofm->flags = htons(fm->flags); - ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg); + ofm->flags = raw_flags; + ofpacts_put_openflow_actions(fm->ofpacts, fm->ofpacts_len, msg, + version); break; } @@ -2174,59 +2176,27 @@ ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm, nfm->command = ofputil_tid_command(fm, protocol); nfm->cookie = fm->new_cookie; match_len = nx_put_match(msg, &fm->match, fm->cookie, fm->cookie_mask); - nfm = msg->l3; + nfm = ofpbuf_l3(msg); nfm->idle_timeout = htons(fm->idle_timeout); nfm->hard_timeout = htons(fm->hard_timeout); nfm->priority = htons(fm->priority); nfm->buffer_id = htonl(fm->buffer_id); nfm->out_port = htons(ofp_to_u16(fm->out_port)); - nfm->flags = htons(fm->flags); + nfm->flags = raw_flags; nfm->match_len = htons(match_len); - ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg); + ofpacts_put_openflow_actions(fm->ofpacts, fm->ofpacts_len, msg, + version); break; } default: - NOT_REACHED(); + OVS_NOT_REACHED(); } ofpmsg_update_length(msg); return msg; } -/* Returns a bitmask with a 1-bit for each protocol that could be used to - * send all of the 'n_fm's flow table modification requests in 'fms', and a - * 0-bit for each protocol that is inadequate. - * - * (The return value will have at least one 1-bit.) */ -enum ofputil_protocol -ofputil_flow_mod_usable_protocols(const struct ofputil_flow_mod *fms, - size_t n_fms) -{ - enum ofputil_protocol usable_protocols; - size_t i; - - usable_protocols = OFPUTIL_P_ANY; - for (i = 0; i < n_fms; i++) { - const struct ofputil_flow_mod *fm = &fms[i]; - - usable_protocols &= ofputil_usable_protocols(&fm->match); - if (fm->table_id != 0xff) { - usable_protocols &= OFPUTIL_P_TID; - } - - /* Matching of the cookie is only supported through NXM or OF1.1+. */ - if (fm->cookie_mask != htonll(0)) { - usable_protocols &= (OFPUTIL_P_OF10_NXM_ANY - | OFPUTIL_P_OF11_STD - | OFPUTIL_P_OF12_OXM - | OFPUTIL_P_OF13_OXM); - } - } - - return usable_protocols; -} - static enum ofperr ofputil_decode_ofpst10_flow_request(struct ofputil_flow_stats_request *fsr, const struct ofp10_flow_stats_request *ofsr, @@ -2235,6 +2205,7 @@ ofputil_decode_ofpst10_flow_request(struct ofputil_flow_stats_request *fsr, fsr->aggregate = aggregate; ofputil_match_from_ofp10_match(&ofsr->match, &fsr->match); fsr->out_port = u16_to_ofp(ntohs(ofsr->out_port)); + fsr->out_group = OFPG11_ANY; fsr->table_id = ofsr->table_id; fsr->cookie = fsr->cookie_mask = htonll(0); @@ -2255,9 +2226,7 @@ ofputil_decode_ofpst11_flow_request(struct ofputil_flow_stats_request *fsr, if (error) { return error; } - if (ofsr->out_group != htonl(OFPG11_ANY)) { - return OFPERR_OFPFMFC_UNKNOWN; - } + fsr->out_group = ntohl(ofsr->out_group); fsr->cookie = ofsr->cookie; fsr->cookie_mask = ofsr->cookie_mask; error = ofputil_pull_ofp11_match(b, &fsr->match, NULL); @@ -2281,17 +2250,295 @@ ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr, if (error) { return error; } - if (b->size) { + if (ofpbuf_size(b)) { return OFPERR_OFPBRC_BAD_LEN; } fsr->aggregate = aggregate; fsr->out_port = u16_to_ofp(ntohs(nfsr->out_port)); + fsr->out_group = OFPG11_ANY; fsr->table_id = nfsr->table_id; return 0; } +/* Constructs and returns an OFPT_QUEUE_GET_CONFIG request for the specified + * 'port', suitable for OpenFlow version 'version'. */ +struct ofpbuf * +ofputil_encode_queue_get_config_request(enum ofp_version version, + ofp_port_t port) +{ + struct ofpbuf *request; + + if (version == OFP10_VERSION) { + struct ofp10_queue_get_config_request *qgcr10; + + request = ofpraw_alloc(OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST, + version, 0); + qgcr10 = ofpbuf_put_zeros(request, sizeof *qgcr10); + qgcr10->port = htons(ofp_to_u16(port)); + } else { + struct ofp11_queue_get_config_request *qgcr11; + + request = ofpraw_alloc(OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST, + version, 0); + qgcr11 = ofpbuf_put_zeros(request, sizeof *qgcr11); + qgcr11->port = ofputil_port_to_ofp11(port); + } + + return request; +} + +/* Parses OFPT_QUEUE_GET_CONFIG request 'oh', storing the port specified by the + * request into '*port'. Returns 0 if successful, otherwise an OpenFlow error + * code. */ +enum ofperr +ofputil_decode_queue_get_config_request(const struct ofp_header *oh, + ofp_port_t *port) +{ + const struct ofp10_queue_get_config_request *qgcr10; + const struct ofp11_queue_get_config_request *qgcr11; + enum ofpraw raw; + struct ofpbuf b; + + ofpbuf_use_const(&b, oh, ntohs(oh->length)); + raw = ofpraw_pull_assert(&b); + + switch ((int) raw) { + case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST: + qgcr10 = ofpbuf_data(&b); + *port = u16_to_ofp(ntohs(qgcr10->port)); + return 0; + + case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST: + qgcr11 = ofpbuf_data(&b); + return ofputil_port_from_ofp11(qgcr11->port, port); + } + + OVS_NOT_REACHED(); +} + +/* Constructs and returns the beginning of a reply to + * OFPT_QUEUE_GET_CONFIG_REQUEST 'oh'. The caller may append information about + * individual queues with ofputil_append_queue_get_config_reply(). */ +struct ofpbuf * +ofputil_encode_queue_get_config_reply(const struct ofp_header *oh) +{ + struct ofp10_queue_get_config_reply *qgcr10; + struct ofp11_queue_get_config_reply *qgcr11; + struct ofpbuf *reply; + enum ofperr error; + struct ofpbuf b; + enum ofpraw raw; + ofp_port_t port; + + error = ofputil_decode_queue_get_config_request(oh, &port); + ovs_assert(!error); + + ofpbuf_use_const(&b, oh, ntohs(oh->length)); + raw = ofpraw_pull_assert(&b); + + switch ((int) raw) { + case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST: + reply = ofpraw_alloc_reply(OFPRAW_OFPT10_QUEUE_GET_CONFIG_REPLY, + oh, 0); + qgcr10 = ofpbuf_put_zeros(reply, sizeof *qgcr10); + qgcr10->port = htons(ofp_to_u16(port)); + break; + + case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST: + reply = ofpraw_alloc_reply(OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY, + oh, 0); + qgcr11 = ofpbuf_put_zeros(reply, sizeof *qgcr11); + qgcr11->port = ofputil_port_to_ofp11(port); + break; + + default: + OVS_NOT_REACHED(); + } + + return reply; +} + +static void +put_queue_rate(struct ofpbuf *reply, enum ofp_queue_properties property, + uint16_t rate) +{ + if (rate != UINT16_MAX) { + struct ofp_queue_prop_rate *oqpr; + + oqpr = ofpbuf_put_zeros(reply, sizeof *oqpr); + oqpr->prop_header.property = htons(property); + oqpr->prop_header.len = htons(sizeof *oqpr); + oqpr->rate = htons(rate); + } +} + +/* Appends a queue description for 'queue_id' to the + * OFPT_QUEUE_GET_CONFIG_REPLY already in 'oh'. */ +void +ofputil_append_queue_get_config_reply(struct ofpbuf *reply, + const struct ofputil_queue_config *oqc) +{ + const struct ofp_header *oh = ofpbuf_data(reply); + size_t start_ofs, len_ofs; + ovs_be16 *len; + + start_ofs = ofpbuf_size(reply); + if (oh->version < OFP12_VERSION) { + struct ofp10_packet_queue *opq10; + + opq10 = ofpbuf_put_zeros(reply, sizeof *opq10); + opq10->queue_id = htonl(oqc->queue_id); + len_ofs = (char *) &opq10->len - (char *) ofpbuf_data(reply); + } else { + struct ofp11_queue_get_config_reply *qgcr11; + struct ofp12_packet_queue *opq12; + ovs_be32 port; + + qgcr11 = ofpbuf_l3(reply); + port = qgcr11->port; + + opq12 = ofpbuf_put_zeros(reply, sizeof *opq12); + opq12->port = port; + opq12->queue_id = htonl(oqc->queue_id); + len_ofs = (char *) &opq12->len - (char *) ofpbuf_data(reply); + } + + put_queue_rate(reply, OFPQT_MIN_RATE, oqc->min_rate); + put_queue_rate(reply, OFPQT_MAX_RATE, oqc->max_rate); + + len = ofpbuf_at(reply, len_ofs, sizeof *len); + *len = htons(ofpbuf_size(reply) - start_ofs); +} + +/* Decodes the initial part of an OFPT_QUEUE_GET_CONFIG_REPLY from 'reply' and + * stores in '*port' the port that the reply is about. The caller may call + * ofputil_pull_queue_get_config_reply() to obtain information about individual + * queues included in the reply. Returns 0 if successful, otherwise an + * ofperr.*/ +enum ofperr +ofputil_decode_queue_get_config_reply(struct ofpbuf *reply, ofp_port_t *port) +{ + const struct ofp10_queue_get_config_reply *qgcr10; + const struct ofp11_queue_get_config_reply *qgcr11; + enum ofpraw raw; + + raw = ofpraw_pull_assert(reply); + switch ((int) raw) { + case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REPLY: + qgcr10 = ofpbuf_pull(reply, sizeof *qgcr10); + *port = u16_to_ofp(ntohs(qgcr10->port)); + return 0; + + case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY: + qgcr11 = ofpbuf_pull(reply, sizeof *qgcr11); + return ofputil_port_from_ofp11(qgcr11->port, port); + } + + OVS_NOT_REACHED(); +} + +static enum ofperr +parse_queue_rate(const struct ofp_queue_prop_header *hdr, uint16_t *rate) +{ + const struct ofp_queue_prop_rate *oqpr; + + if (hdr->len == htons(sizeof *oqpr)) { + oqpr = (const struct ofp_queue_prop_rate *) hdr; + *rate = ntohs(oqpr->rate); + return 0; + } else { + return OFPERR_OFPBRC_BAD_LEN; + } +} + +/* Decodes information about a queue from the OFPT_QUEUE_GET_CONFIG_REPLY in + * 'reply' and stores it in '*queue'. ofputil_decode_queue_get_config_reply() + * must already have pulled off the main header. + * + * This function returns EOF if the last queue has already been decoded, 0 if a + * queue was successfully decoded into '*queue', or an ofperr if there was a + * problem decoding 'reply'. */ +int +ofputil_pull_queue_get_config_reply(struct ofpbuf *reply, + struct ofputil_queue_config *queue) +{ + const struct ofp_header *oh; + unsigned int opq_len; + unsigned int len; + + if (!ofpbuf_size(reply)) { + return EOF; + } + + queue->min_rate = UINT16_MAX; + queue->max_rate = UINT16_MAX; + + oh = reply->frame; + if (oh->version < OFP12_VERSION) { + const struct ofp10_packet_queue *opq10; + + opq10 = ofpbuf_try_pull(reply, sizeof *opq10); + if (!opq10) { + return OFPERR_OFPBRC_BAD_LEN; + } + queue->queue_id = ntohl(opq10->queue_id); + len = ntohs(opq10->len); + opq_len = sizeof *opq10; + } else { + const struct ofp12_packet_queue *opq12; + + opq12 = ofpbuf_try_pull(reply, sizeof *opq12); + if (!opq12) { + return OFPERR_OFPBRC_BAD_LEN; + } + queue->queue_id = ntohl(opq12->queue_id); + len = ntohs(opq12->len); + opq_len = sizeof *opq12; + } + + if (len < opq_len || len > ofpbuf_size(reply) + opq_len || len % 8) { + return OFPERR_OFPBRC_BAD_LEN; + } + len -= opq_len; + + while (len > 0) { + const struct ofp_queue_prop_header *hdr; + unsigned int property; + unsigned int prop_len; + enum ofperr error = 0; + + hdr = ofpbuf_at_assert(reply, 0, sizeof *hdr); + prop_len = ntohs(hdr->len); + if (prop_len < sizeof *hdr || prop_len > ofpbuf_size(reply) || prop_len % 8) { + return OFPERR_OFPBRC_BAD_LEN; + } + + property = ntohs(hdr->property); + switch (property) { + case OFPQT_MIN_RATE: + error = parse_queue_rate(hdr, &queue->min_rate); + break; + + case OFPQT_MAX_RATE: + error = parse_queue_rate(hdr, &queue->max_rate); + break; + + default: + VLOG_INFO_RL(&bad_ofmsg_rl, "unknown queue property %u", property); + break; + } + if (error) { + return error; + } + + ofpbuf_pull(reply, prop_len); + len -= prop_len; + } + return 0; +} + /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if * successful, otherwise an OpenFlow error code. */ @@ -2306,10 +2553,10 @@ ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr, raw = ofpraw_pull_assert(&b); switch ((int) raw) { case OFPRAW_OFPST10_FLOW_REQUEST: - return ofputil_decode_ofpst10_flow_request(fsr, b.data, false); + return ofputil_decode_ofpst10_flow_request(fsr, ofpbuf_data(&b), false); case OFPRAW_OFPST10_AGGREGATE_REQUEST: - return ofputil_decode_ofpst10_flow_request(fsr, b.data, true); + return ofputil_decode_ofpst10_flow_request(fsr, ofpbuf_data(&b), true); case OFPRAW_OFPST11_FLOW_REQUEST: return ofputil_decode_ofpst11_flow_request(fsr, &b, false); @@ -2325,7 +2572,7 @@ ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr, default: /* Hey, the caller lied. */ - NOT_REACHED(); + OVS_NOT_REACHED(); } } @@ -2342,7 +2589,8 @@ ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr, switch (protocol) { case OFPUTIL_P_OF11_STD: case OFPUTIL_P_OF12_OXM: - case OFPUTIL_P_OF13_OXM: { + case OFPUTIL_P_OF13_OXM: + case OFPUTIL_P_OF14_OXM: { struct ofp11_flow_stats_request *ofsr; raw = (fsr->aggregate @@ -2353,7 +2601,7 @@ ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr, ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr); ofsr->table_id = fsr->table_id; ofsr->out_port = ofputil_port_to_ofp11(fsr->out_port); - ofsr->out_group = htonl(OFPG11_ANY); + ofsr->out_group = htonl(fsr->out_group); ofsr->cookie = fsr->cookie; ofsr->cookie_mask = fsr->cookie_mask; ofputil_put_ofp11_match(msg, &fsr->match, protocol); @@ -2388,7 +2636,7 @@ ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr, match_len = nx_put_match(msg, &fsr->match, fsr->cookie, fsr->cookie_mask); - nfsr = msg->l3; + nfsr = ofpbuf_l3(msg); nfsr->out_port = htons(ofp_to_u16(fsr->out_port)); nfsr->match_len = htons(match_len); nfsr->table_id = fsr->table_id; @@ -2396,32 +2644,14 @@ ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr, } default: - NOT_REACHED(); + OVS_NOT_REACHED(); } return msg; } -/* Returns a bitmask with a 1-bit for each protocol that could be used to - * accurately encode 'fsr', and a 0-bit for each protocol that is inadequate. - * - * (The return value will have at least one 1-bit.) */ -enum ofputil_protocol -ofputil_flow_stats_request_usable_protocols( - const struct ofputil_flow_stats_request *fsr) -{ - enum ofputil_protocol usable_protocols; - - usable_protocols = ofputil_usable_protocols(&fsr->match); - if (fsr->cookie_mask != htonll(0)) { - usable_protocols &= OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM - | OFPUTIL_P_OF13_OXM; - } - return usable_protocols; -} - -/* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract - * ofputil_flow_stats in 'fs'. +/* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract + * ofputil_flow_stats in 'fs'. * * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single * OpenFlow message. Calling this function multiple times for a single 'msg' @@ -2446,17 +2676,19 @@ ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs, bool flow_age_extension, struct ofpbuf *ofpacts) { + const struct ofp_header *oh; enum ofperr error; enum ofpraw raw; - error = (msg->l2 - ? ofpraw_decode(&raw, msg->l2) + error = (msg->frame + ? ofpraw_decode(&raw, msg->frame) : ofpraw_pull(&raw, msg)); if (error) { return error; } + oh = msg->frame; - if (!msg->size) { + if (!ofpbuf_size(msg)) { return EOF; } else if (raw == OFPRAW_OFPST11_FLOW_REPLY || raw == OFPRAW_OFPST13_FLOW_REPLY) { @@ -2466,15 +2698,15 @@ ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs, ofs = ofpbuf_try_pull(msg, sizeof *ofs); if (!ofs) { - VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover " - "bytes at end", msg->size); + VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %"PRIu32" leftover " + "bytes at end", ofpbuf_size(msg)); return EINVAL; } length = ntohs(ofs->length); if (length < sizeof *ofs) { VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid " - "length %zu", length); + "length %"PRIuSIZE, length); return EINVAL; } @@ -2483,8 +2715,9 @@ ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs, return EINVAL; } - if (ofpacts_pull_openflow11_instructions(msg, length - sizeof *ofs - - padded_match_len, ofpacts)) { + if (ofpacts_pull_openflow_instructions(msg, length - sizeof *ofs - + padded_match_len, oh->version, + ofpacts)) { VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad instructions"); return EINVAL; } @@ -2495,7 +2728,15 @@ ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs, fs->duration_nsec = ntohl(ofs->duration_nsec); fs->idle_timeout = ntohs(ofs->idle_timeout); fs->hard_timeout = ntohs(ofs->hard_timeout); - fs->flags = (raw == OFPRAW_OFPST13_FLOW_REPLY) ? ntohs(ofs->flags) : 0; + if (raw == OFPRAW_OFPST13_FLOW_REPLY) { + error = ofputil_decode_flow_mod_flags(ofs->flags, -1, oh->version, + &fs->flags); + if (error) { + return error; + } + } else { + fs->flags = 0; + } fs->idle_age = -1; fs->hard_age = -1; fs->cookie = ofs->cookie; @@ -2507,19 +2748,20 @@ ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs, ofs = ofpbuf_try_pull(msg, sizeof *ofs); if (!ofs) { - VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover " - "bytes at end", msg->size); + VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %"PRIu32" leftover " + "bytes at end", ofpbuf_size(msg)); return EINVAL; } length = ntohs(ofs->length); if (length < sizeof *ofs) { VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid " - "length %zu", length); + "length %"PRIuSIZE, length); return EINVAL; } - if (ofpacts_pull_openflow10(msg, length - sizeof *ofs, ofpacts)) { + if (ofpacts_pull_openflow_actions(msg, length - sizeof *ofs, + oh->version, ofpacts)) { return EINVAL; } @@ -2542,16 +2784,16 @@ ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs, nfs = ofpbuf_try_pull(msg, sizeof *nfs); if (!nfs) { - VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover " - "bytes at end", msg->size); + VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %"PRIu32" leftover " + "bytes at end", ofpbuf_size(msg)); return EINVAL; } length = ntohs(nfs->length); match_len = ntohs(nfs->match_len); if (length < sizeof *nfs + ROUND_UP(match_len, 8)) { - VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu " - "claims invalid length %zu", match_len, length); + VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%"PRIuSIZE" " + "claims invalid length %"PRIuSIZE, match_len, length); return EINVAL; } if (nx_pull_match(msg, match_len, &fs->match, NULL, NULL)) { @@ -2559,7 +2801,8 @@ ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs, } actions_len = length - sizeof *nfs - ROUND_UP(match_len, 8); - if (ofpacts_pull_openflow10(msg, actions_len, ofpacts)) { + if (ofpacts_pull_openflow_actions(msg, actions_len, oh->version, + ofpacts)) { return EINVAL; } @@ -2584,11 +2827,11 @@ ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs, fs->byte_count = ntohll(nfs->byte_count); fs->flags = 0; } else { - NOT_REACHED(); + OVS_NOT_REACHED(); } - fs->ofpacts = ofpacts->data; - fs->ofpacts_len = ofpacts->size; + fs->ofpacts = ofpbuf_data(ofpacts); + fs->ofpacts_len = ofpbuf_size(ofpacts); return 0; } @@ -2605,26 +2848,27 @@ unknown_to_zero(uint64_t count) /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to * those already present in the list of ofpbufs in 'replies'. 'replies' should - * have been initialized with ofputil_start_stats_reply(). */ + * have been initialized with ofpmp_init(). */ void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs, struct list *replies) { struct ofpbuf *reply = ofpbuf_from_list(list_back(replies)); - size_t start_ofs = reply->size; + size_t start_ofs = ofpbuf_size(reply); enum ofpraw raw; + enum ofp_version version = ((struct ofp_header *)ofpbuf_data(reply))->version; - ofpraw_decode_partial(&raw, reply->data, reply->size); + ofpraw_decode_partial(&raw, ofpbuf_data(reply), ofpbuf_size(reply)); if (raw == OFPRAW_OFPST11_FLOW_REPLY || raw == OFPRAW_OFPST13_FLOW_REPLY) { struct ofp11_flow_stats *ofs; ofpbuf_put_uninit(reply, sizeof *ofs); oxm_put_match(reply, &fs->match); - ofpacts_put_openflow11_instructions(fs->ofpacts, fs->ofpacts_len, - reply); + ofpacts_put_openflow_instructions(fs->ofpacts, fs->ofpacts_len, reply, + version); ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs); - ofs->length = htons(reply->size - start_ofs); + ofs->length = htons(ofpbuf_size(reply) - start_ofs); ofs->table_id = fs->table_id; ofs->pad = 0; ofs->duration_sec = htonl(fs->duration_sec); @@ -2632,7 +2876,11 @@ ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs, ofs->priority = htons(fs->priority); ofs->idle_timeout = htons(fs->idle_timeout); ofs->hard_timeout = htons(fs->hard_timeout); - ofs->flags = (raw == OFPRAW_OFPST13_FLOW_REPLY) ? htons(fs->flags) : 0; + if (raw == OFPRAW_OFPST13_FLOW_REPLY) { + ofs->flags = ofputil_encode_flow_mod_flags(fs->flags, version); + } else { + ofs->flags = 0; + } memset(ofs->pad2, 0, sizeof ofs->pad2); ofs->cookie = fs->cookie; ofs->packet_count = htonll(unknown_to_zero(fs->packet_count)); @@ -2641,10 +2889,10 @@ ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs, struct ofp10_flow_stats *ofs; ofpbuf_put_uninit(reply, sizeof *ofs); - ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply); - + ofpacts_put_openflow_actions(fs->ofpacts, fs->ofpacts_len, reply, + version); ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs); - ofs->length = htons(reply->size - start_ofs); + ofs->length = htons(ofpbuf_size(reply) - start_ofs); ofs->table_id = fs->table_id; ofs->pad = 0; ofputil_match_to_ofp10_match(&fs->match, &ofs->match); @@ -2665,10 +2913,10 @@ ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs, ofpbuf_put_uninit(reply, sizeof *nfs); match_len = nx_put_match(reply, &fs->match, 0, 0); - ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply); - + ofpacts_put_openflow_actions(fs->ofpacts, fs->ofpacts_len, reply, + version); nfs = ofpbuf_at_assert(reply, start_ofs, sizeof *nfs); - nfs->length = htons(reply->size - start_ofs); + nfs->length = htons(ofpbuf_size(reply) - start_ofs); nfs->table_id = fs->table_id; nfs->pad = 0; nfs->duration_sec = htonl(fs->duration_sec); @@ -2687,7 +2935,7 @@ ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs, nfs->packet_count = htonll(fs->packet_count); nfs->byte_count = htonll(fs->byte_count); } else { - NOT_REACHED(); + OVS_NOT_REACHED(); } ofpmp_postappend(replies, start_ofs); @@ -2734,7 +2982,7 @@ ofputil_decode_aggregate_stats_reply(struct ofputil_aggregate_stats *stats, ofpbuf_use_const(&msg, reply, ntohs(reply->length)); ofpraw_pull_assert(&msg); - asr = msg.l3; + asr = ofpbuf_l3(&msg); stats->packet_count = ntohll(get_32aligned_be64(&asr->packet_count)); stats->byte_count = ntohll(get_32aligned_be64(&asr->byte_count)); stats->flow_count = ntohl(asr->flow_count); @@ -2801,7 +3049,7 @@ ofputil_decode_flow_removed(struct ofputil_flow_removed *fr, if (error) { return error; } - if (b.size) { + if (ofpbuf_size(&b)) { return OFPERR_OFPBRC_BAD_LEN; } @@ -2816,7 +3064,7 @@ ofputil_decode_flow_removed(struct ofputil_flow_removed *fr, fr->packet_count = ntohll(nfr->packet_count); fr->byte_count = ntohll(nfr->byte_count); } else { - NOT_REACHED(); + OVS_NOT_REACHED(); } return 0; @@ -2834,7 +3082,8 @@ ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr, switch (protocol) { case OFPUTIL_P_OF11_STD: case OFPUTIL_P_OF12_OXM: - case OFPUTIL_P_OF13_OXM: { + case OFPUTIL_P_OF13_OXM: + case OFPUTIL_P_OF14_OXM: { struct ofp12_flow_removed *ofr; msg = ofpraw_alloc_xid(OFPRAW_OFPT11_FLOW_REMOVED, @@ -2885,7 +3134,7 @@ ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr, nfr = ofpbuf_put_zeros(msg, sizeof *nfr); match_len = nx_put_match(msg, &fr->match, 0, 0); - nfr = msg->l3; + nfr = ofpbuf_l3(msg); nfr->cookie = fr->cookie; nfr->priority = htons(fr->priority); nfr->reason = fr->reason; @@ -2900,7 +3149,7 @@ ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr, } default: - NOT_REACHED(); + OVS_NOT_REACHED(); } return msg; @@ -2910,8 +3159,8 @@ static void ofputil_decode_packet_in_finish(struct ofputil_packet_in *pin, struct match *match, struct ofpbuf *b) { - pin->packet = b->data; - pin->packet_len = b->size; + pin->packet = ofpbuf_data(b); + pin->packet_len = ofpbuf_size(b); pin->fmd.in_port = match->flow.in_port.ofp_port; pin->fmd.tun_id = match->flow.tunnel.tun_id; @@ -2930,6 +3179,7 @@ ofputil_decode_packet_in(struct ofputil_packet_in *pin, struct ofpbuf b; memset(pin, 0, sizeof *pin); + pin->cookie = OVS_BE64_MAX; ofpbuf_use_const(&b, oh, ntohs(oh->length)); raw = ofpraw_pull_assert(&b); @@ -2971,12 +3221,29 @@ ofputil_decode_packet_in(struct ofputil_packet_in *pin, opi = ofpbuf_pull(&b, offsetof(struct ofp10_packet_in, data)); pin->packet = opi->data; - pin->packet_len = b.size; + pin->packet_len = ofpbuf_size(&b); pin->fmd.in_port = u16_to_ofp(ntohs(opi->in_port)); pin->reason = opi->reason; pin->buffer_id = ntohl(opi->buffer_id); pin->total_len = ntohs(opi->total_len); + } else if (raw == OFPRAW_OFPT11_PACKET_IN) { + const struct ofp11_packet_in *opi; + enum ofperr error; + + opi = ofpbuf_pull(&b, sizeof *opi); + + pin->packet = ofpbuf_data(&b); + pin->packet_len = ofpbuf_size(&b); + + pin->buffer_id = ntohl(opi->buffer_id); + error = ofputil_port_from_ofp11(opi->in_port, &pin->fmd.in_port); + if (error) { + return error; + } + pin->total_len = ntohs(opi->total_len); + pin->reason = opi->reason; + pin->table_id = opi->table_id; } else if (raw == OFPRAW_NXT_PACKET_IN) { const struct nx_packet_in *npi; struct match match; @@ -3002,7 +3269,7 @@ ofputil_decode_packet_in(struct ofputil_packet_in *pin, ofputil_decode_packet_in_finish(pin, &match, &b); } else { - NOT_REACHED(); + OVS_NOT_REACHED(); } return 0; @@ -3041,6 +3308,120 @@ ofputil_packet_in_to_match(const struct ofputil_packet_in *pin, match_set_in_port(match, pin->fmd.in_port); } +static struct ofpbuf * +ofputil_encode_ofp10_packet_in(const struct ofputil_packet_in *pin) +{ + struct ofp10_packet_in *opi; + struct ofpbuf *packet; + + packet = ofpraw_alloc_xid(OFPRAW_OFPT10_PACKET_IN, OFP10_VERSION, + htonl(0), pin->packet_len); + opi = ofpbuf_put_zeros(packet, offsetof(struct ofp10_packet_in, data)); + opi->total_len = htons(pin->total_len); + opi->in_port = htons(ofp_to_u16(pin->fmd.in_port)); + opi->reason = pin->reason; + opi->buffer_id = htonl(pin->buffer_id); + + ofpbuf_put(packet, pin->packet, pin->packet_len); + + return packet; +} + +static struct ofpbuf * +ofputil_encode_nx_packet_in(const struct ofputil_packet_in *pin) +{ + struct nx_packet_in *npi; + struct ofpbuf *packet; + struct match match; + size_t match_len; + + ofputil_packet_in_to_match(pin, &match); + + /* The final argument is just an estimate of the space required. */ + packet = ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN, OFP10_VERSION, + htonl(0), (sizeof(struct flow_metadata) * 2 + + 2 + pin->packet_len)); + ofpbuf_put_zeros(packet, sizeof *npi); + match_len = nx_put_match(packet, &match, 0, 0); + ofpbuf_put_zeros(packet, 2); + ofpbuf_put(packet, pin->packet, pin->packet_len); + + npi = ofpbuf_l3(packet); + npi->buffer_id = htonl(pin->buffer_id); + npi->total_len = htons(pin->total_len); + npi->reason = pin->reason; + npi->table_id = pin->table_id; + npi->cookie = pin->cookie; + npi->match_len = htons(match_len); + + return packet; +} + +static struct ofpbuf * +ofputil_encode_ofp11_packet_in(const struct ofputil_packet_in *pin) +{ + struct ofp11_packet_in *opi; + struct ofpbuf *packet; + + packet = ofpraw_alloc_xid(OFPRAW_OFPT11_PACKET_IN, OFP11_VERSION, + htonl(0), pin->packet_len); + opi = ofpbuf_put_zeros(packet, sizeof *opi); + opi->buffer_id = htonl(pin->buffer_id); + opi->in_port = ofputil_port_to_ofp11(pin->fmd.in_port); + opi->in_phy_port = opi->in_port; + opi->total_len = htons(pin->total_len); + opi->reason = pin->reason; + opi->table_id = pin->table_id; + + ofpbuf_put(packet, pin->packet, pin->packet_len); + + return packet; +} + +static struct ofpbuf * +ofputil_encode_ofp12_packet_in(const struct ofputil_packet_in *pin, + enum ofputil_protocol protocol) +{ + struct ofp13_packet_in *opi; + struct match match; + enum ofpraw packet_in_raw; + enum ofp_version packet_in_version; + size_t packet_in_size; + struct ofpbuf *packet; + + if (protocol == OFPUTIL_P_OF12_OXM) { + packet_in_raw = OFPRAW_OFPT12_PACKET_IN; + packet_in_version = OFP12_VERSION; + packet_in_size = sizeof (struct ofp12_packet_in); + } else { + packet_in_raw = OFPRAW_OFPT13_PACKET_IN; + packet_in_version = OFP13_VERSION; + packet_in_size = sizeof (struct ofp13_packet_in); + } + + ofputil_packet_in_to_match(pin, &match); + + /* The final argument is just an estimate of the space required. */ + packet = ofpraw_alloc_xid(packet_in_raw, packet_in_version, + htonl(0), (sizeof(struct flow_metadata) * 2 + + 2 + pin->packet_len)); + ofpbuf_put_zeros(packet, packet_in_size); + oxm_put_match(packet, &match); + ofpbuf_put_zeros(packet, 2); + ofpbuf_put(packet, pin->packet, pin->packet_len); + + opi = ofpbuf_l3(packet); + opi->pi.buffer_id = htonl(pin->buffer_id); + opi->pi.total_len = htons(pin->total_len); + opi->pi.reason = pin->reason; + opi->pi.table_id = pin->table_id; + if (protocol == OFPUTIL_P_OF13_OXM) { + opi->cookie = pin->cookie; + } + + return packet; +} + /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message * in the format specified by 'packet_in_format'. */ struct ofpbuf * @@ -3048,86 +3429,33 @@ ofputil_encode_packet_in(const struct ofputil_packet_in *pin, enum ofputil_protocol protocol, enum nx_packet_in_format packet_in_format) { - size_t send_len = MIN(pin->send_len, pin->packet_len); struct ofpbuf *packet; - /* Add OFPT_PACKET_IN. */ - if (protocol == OFPUTIL_P_OF13_OXM || protocol == OFPUTIL_P_OF12_OXM) { - struct ofp13_packet_in *opi; - struct match match; - enum ofpraw packet_in_raw; - enum ofp_version packet_in_version; - size_t packet_in_size; + switch (protocol) { + case OFPUTIL_P_OF10_STD: + case OFPUTIL_P_OF10_STD_TID: + case OFPUTIL_P_OF10_NXM: + case OFPUTIL_P_OF10_NXM_TID: + packet = (packet_in_format == NXPIF_NXM + ? ofputil_encode_nx_packet_in(pin) + : ofputil_encode_ofp10_packet_in(pin)); + break; - if (protocol == OFPUTIL_P_OF12_OXM) { - packet_in_raw = OFPRAW_OFPT12_PACKET_IN; - packet_in_version = OFP12_VERSION; - packet_in_size = sizeof (struct ofp12_packet_in); - } else { - packet_in_raw = OFPRAW_OFPT13_PACKET_IN; - packet_in_version = OFP13_VERSION; - packet_in_size = sizeof (struct ofp13_packet_in); - } + case OFPUTIL_P_OF11_STD: + packet = ofputil_encode_ofp11_packet_in(pin); + break; - ofputil_packet_in_to_match(pin, &match); - - /* The final argument is just an estimate of the space required. */ - packet = ofpraw_alloc_xid(packet_in_raw, packet_in_version, - htonl(0), (sizeof(struct flow_metadata) * 2 - + 2 + send_len)); - ofpbuf_put_zeros(packet, packet_in_size); - oxm_put_match(packet, &match); - ofpbuf_put_zeros(packet, 2); - ofpbuf_put(packet, pin->packet, send_len); - - opi = packet->l3; - opi->pi.buffer_id = htonl(pin->buffer_id); - opi->pi.total_len = htons(pin->total_len); - opi->pi.reason = pin->reason; - opi->pi.table_id = pin->table_id; - if (protocol == OFPUTIL_P_OF13_OXM) { - opi->cookie = pin->cookie; - } - } else if (packet_in_format == NXPIF_OPENFLOW10) { - struct ofp10_packet_in *opi; - - packet = ofpraw_alloc_xid(OFPRAW_OFPT10_PACKET_IN, OFP10_VERSION, - htonl(0), send_len); - opi = ofpbuf_put_zeros(packet, offsetof(struct ofp10_packet_in, data)); - opi->total_len = htons(pin->total_len); - opi->in_port = htons(ofp_to_u16(pin->fmd.in_port)); - opi->reason = pin->reason; - opi->buffer_id = htonl(pin->buffer_id); - - ofpbuf_put(packet, pin->packet, send_len); - } else if (packet_in_format == NXPIF_NXM) { - struct nx_packet_in *npi; - struct match match; - size_t match_len; - - ofputil_packet_in_to_match(pin, &match); - - /* The final argument is just an estimate of the space required. */ - packet = ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN, OFP10_VERSION, - htonl(0), (sizeof(struct flow_metadata) * 2 - + 2 + send_len)); - ofpbuf_put_zeros(packet, sizeof *npi); - match_len = nx_put_match(packet, &match, 0, 0); - ofpbuf_put_zeros(packet, 2); - ofpbuf_put(packet, pin->packet, send_len); - - npi = packet->l3; - npi->buffer_id = htonl(pin->buffer_id); - npi->total_len = htons(pin->total_len); - npi->reason = pin->reason; - npi->table_id = pin->table_id; - npi->cookie = pin->cookie; - npi->match_len = htons(match_len); - } else { - NOT_REACHED(); + case OFPUTIL_P_OF12_OXM: + case OFPUTIL_P_OF13_OXM: + case OFPUTIL_P_OF14_OXM: + packet = ofputil_encode_ofp12_packet_in(pin, protocol); + break; + + default: + OVS_NOT_REACHED(); } - ofpmsg_update_length(packet); + ofpmsg_update_length(packet); return packet; } @@ -3202,8 +3530,8 @@ ofputil_decode_packet_out(struct ofputil_packet_out *po, return error; } - error = ofpacts_pull_openflow11_actions(&b, ntohs(opo->actions_len), - ofpacts); + error = ofpacts_pull_openflow_actions(&b, ntohs(opo->actions_len), + oh->version, ofpacts); if (error) { return error; } @@ -3214,12 +3542,13 @@ ofputil_decode_packet_out(struct ofputil_packet_out *po, po->buffer_id = ntohl(opo->buffer_id); po->in_port = u16_to_ofp(ntohs(opo->in_port)); - error = ofpacts_pull_openflow10(&b, ntohs(opo->actions_len), ofpacts); + error = ofpacts_pull_openflow_actions(&b, ntohs(opo->actions_len), + oh->version, ofpacts); if (error) { return error; } } else { - NOT_REACHED(); + OVS_NOT_REACHED(); } if (ofp_to_u16(po->in_port) >= ofp_to_u16(OFPP_MAX) @@ -3230,12 +3559,12 @@ ofputil_decode_packet_out(struct ofputil_packet_out *po, return OFPERR_OFPBRC_BAD_PORT; } - po->ofpacts = ofpacts->data; - po->ofpacts_len = ofpacts->size; + po->ofpacts = ofpbuf_data(ofpacts); + po->ofpacts_len = ofpbuf_size(ofpacts); if (po->buffer_id == UINT32_MAX) { - po->packet = b.data; - po->packet_len = b.size; + po->packet = ofpbuf_data(&b); + po->packet_len = ofpbuf_size(&b); } else { po->packet = NULL; po->packet_len = 0; @@ -3344,7 +3673,7 @@ ofputil_decode_ofp11_port(struct ofputil_phy_port *pp, ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN); pp->config = ntohl(op->config) & OFPPC11_ALL; - pp->state = ntohl(op->state) & OFPPC11_ALL; + pp->state = ntohl(op->state) & OFPPS11_ALL; pp->curr = netdev_port_features_from_ofp11(op->curr); pp->advertised = netdev_port_features_from_ofp11(op->advertised); @@ -3366,9 +3695,10 @@ ofputil_get_phy_port_size(enum ofp_version ofp_version) case OFP11_VERSION: case OFP12_VERSION: case OFP13_VERSION: + case OFP14_VERSION: return sizeof(struct ofp11_port); default: - NOT_REACHED(); + OVS_NOT_REACHED(); } } @@ -3420,7 +3750,7 @@ ofputil_put_phy_port(enum ofp_version ofp_version, switch (ofp_version) { case OFP10_VERSION: { struct ofp10_phy_port *opp; - if (b->size + sizeof *opp <= UINT16_MAX) { + if (ofpbuf_size(b) + sizeof *opp <= UINT16_MAX) { opp = ofpbuf_put_uninit(b, sizeof *opp); ofputil_encode_ofp10_phy_port(pp, opp); } @@ -3431,15 +3761,19 @@ ofputil_put_phy_port(enum ofp_version ofp_version, case OFP12_VERSION: case OFP13_VERSION: { struct ofp11_port *op; - if (b->size + sizeof *op <= UINT16_MAX) { + if (ofpbuf_size(b) + sizeof *op <= UINT16_MAX) { op = ofpbuf_put_uninit(b, sizeof *op); ofputil_encode_ofp11_port(pp, op); } break; } + case OFP14_VERSION: + OVS_NOT_REACHED(); + break; + default: - NOT_REACHED(); + OVS_NOT_REACHED(); } } @@ -3467,8 +3801,12 @@ ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version, break; } + case OFP14_VERSION: + OVS_NOT_REACHED(); + break; + default: - NOT_REACHED(); + OVS_NOT_REACHED(); } } @@ -3530,6 +3868,9 @@ ofputil_capabilities_mask(enum ofp_version ofp_version) case OFP12_VERSION: case OFP13_VERSION: return OFPC_COMMON | OFPC12_PORT_BLOCKED; + case OFP14_VERSION: + OVS_NOT_REACHED(); + break; default: /* Caller needs to check osf->header.version itself */ return 0; @@ -3561,7 +3902,7 @@ ofputil_decode_switch_features(const struct ofp_header *oh, features->capabilities = ntohl(osf->capabilities) & ofputil_capabilities_mask(oh->version); - if (b->size % ofputil_get_phy_port_size(oh->version)) { + if (ofpbuf_size(b) % ofputil_get_phy_port_size(oh->version)) { return OFPERR_OFPBRC_BAD_LEN; } @@ -3604,12 +3945,12 @@ max_ports_in_features(const struct ofp_header *oh) bool ofputil_switch_features_ports_trunc(struct ofpbuf *b) { - struct ofp_header *oh = b->data; + struct ofp_header *oh = ofpbuf_data(b); if (max_ports_in_features(oh)) { /* Remove all the ports. */ - b->size = (sizeof(struct ofp_header) - + sizeof(struct ofp_switch_features)); + ofpbuf_set_size(b, (sizeof(struct ofp_header) + + sizeof(struct ofp_switch_features))); ofpmsg_update_length(b); return true; @@ -3656,10 +3997,11 @@ ofputil_encode_switch_features(const struct ofputil_switch_features *features, raw = OFPRAW_OFPT11_FEATURES_REPLY; break; case OFP13_VERSION: + case OFP14_VERSION: raw = OFPRAW_OFPT13_FEATURES_REPLY; break; default: - NOT_REACHED(); + OVS_NOT_REACHED(); } b = ofpraw_alloc_xid(raw, version, xid, 0); osf = ofpbuf_put_zeros(b, sizeof *osf); @@ -3678,6 +4020,7 @@ ofputil_encode_switch_features(const struct ofputil_switch_features *features, osf->actions = encode_action_bits(features->actions, of10_action_bits); break; case OFP13_VERSION: + case OFP14_VERSION: osf->auxiliary_id = features->auxiliary_id; /* fall through */ case OFP11_VERSION: @@ -3687,7 +4030,7 @@ ofputil_encode_switch_features(const struct ofputil_switch_features *features, } break; default: - NOT_REACHED(); + OVS_NOT_REACHED(); } return b; @@ -3700,7 +4043,7 @@ void ofputil_put_switch_features_port(const struct ofputil_phy_port *pp, struct ofpbuf *b) { - const struct ofp_header *oh = b->data; + const struct ofp_header *oh = ofpbuf_data(b); if (oh->version < OFP13_VERSION) { ofputil_put_phy_port(oh->version, pp, b); @@ -3756,11 +4099,12 @@ ofputil_encode_port_status(const struct ofputil_port_status *ps, case OFP11_VERSION: case OFP12_VERSION: case OFP13_VERSION: + case OFP14_VERSION: raw = OFPRAW_OFPT11_PORT_STATUS; break; default: - NOT_REACHED(); + OVS_NOT_REACHED(); } b = ofpraw_alloc_xid(raw, version, htonl(0), 0); @@ -3770,7 +4114,7 @@ ofputil_encode_port_status(const struct ofputil_port_status *ps, ofpmsg_update_length(b); return b; } - + /* ofputil_port_mod */ /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in @@ -3786,7 +4130,7 @@ ofputil_decode_port_mod(const struct ofp_header *oh, raw = ofpraw_pull_assert(&b); if (raw == OFPRAW_OFPT10_PORT_MOD) { - const struct ofp10_port_mod *opm = b.data; + const struct ofp10_port_mod *opm = ofpbuf_data(&b); pm->port_no = u16_to_ofp(ntohs(opm->port_no)); memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN); @@ -3794,7 +4138,7 @@ ofputil_decode_port_mod(const struct ofp_header *oh, pm->mask = ntohl(opm->mask) & OFPPC10_ALL; pm->advertise = netdev_port_features_from_ofp10(opm->advertise); } else if (raw == OFPRAW_OFPT11_PORT_MOD) { - const struct ofp11_port_mod *opm = b.data; + const struct ofp11_port_mod *opm = ofpbuf_data(&b); enum ofperr error; error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no); @@ -3852,1380 +4196,2432 @@ ofputil_encode_port_mod(const struct ofputil_port_mod *pm, opm->advertise = netdev_port_features_to_ofp11(pm->advertise); break; } - + case OFP14_VERSION: + OVS_NOT_REACHED(); + break; default: - NOT_REACHED(); + OVS_NOT_REACHED(); } return b; } - -/* ofputil_role_request */ -/* Decodes the OpenFlow "role request" or "role reply" message in '*oh' into - * an abstract form in '*rr'. Returns 0 if successful, otherwise an - * OFPERR_* value. */ -enum ofperr -ofputil_decode_role_message(const struct ofp_header *oh, - struct ofputil_role_request *rr) +struct ofp_prop_header { + ovs_be16 type; + ovs_be16 len; +}; + +static enum ofperr +ofputil_pull_property(struct ofpbuf *msg, struct ofpbuf *payload, + uint16_t *typep) { - struct ofpbuf b; - enum ofpraw raw; + struct ofp_prop_header *oph; + unsigned int len; - ofpbuf_use_const(&b, oh, ntohs(oh->length)); - raw = ofpraw_pull_assert(&b); + if (ofpbuf_size(msg) < sizeof *oph) { + return OFPERR_OFPTFFC_BAD_LEN; + } - if (raw == OFPRAW_OFPT12_ROLE_REQUEST || - raw == OFPRAW_OFPT12_ROLE_REPLY) { - const struct ofp12_role_request *orr = b.l3; + oph = ofpbuf_data(msg); + len = ntohs(oph->len); + if (len < sizeof *oph || ROUND_UP(len, 8) > ofpbuf_size(msg)) { + return OFPERR_OFPTFFC_BAD_LEN; + } - if (orr->role != htonl(OFPCR12_ROLE_NOCHANGE) && - orr->role != htonl(OFPCR12_ROLE_EQUAL) && - orr->role != htonl(OFPCR12_ROLE_MASTER) && - orr->role != htonl(OFPCR12_ROLE_SLAVE)) { - return OFPERR_OFPRRFC_BAD_ROLE; - } + *typep = ntohs(oph->type); + if (payload) { + ofpbuf_use_const(payload, ofpbuf_data(msg), len); + ofpbuf_pull(payload, sizeof *oph); + } + ofpbuf_pull(msg, ROUND_UP(len, 8)); + return 0; +} - rr->role = ntohl(orr->role); - if (raw == OFPRAW_OFPT12_ROLE_REQUEST - ? orr->role == htonl(OFPCR12_ROLE_NOCHANGE) - : orr->generation_id == htonll(UINT64_MAX)) { - rr->have_generation_id = false; - rr->generation_id = 0; - } else { - rr->have_generation_id = true; - rr->generation_id = ntohll(orr->generation_id); - } - } else if (raw == OFPRAW_NXT_ROLE_REQUEST || - raw == OFPRAW_NXT_ROLE_REPLY) { - const struct nx_role_request *nrr = b.l3; +static void PRINTF_FORMAT(2, 3) +log_property(bool loose, const char *message, ...) +{ + enum vlog_level level = loose ? VLL_DBG : VLL_WARN; + if (!vlog_should_drop(THIS_MODULE, level, &bad_ofmsg_rl)) { + va_list args; - BUILD_ASSERT(NX_ROLE_OTHER + 1 == OFPCR12_ROLE_EQUAL); - BUILD_ASSERT(NX_ROLE_MASTER + 1 == OFPCR12_ROLE_MASTER); - BUILD_ASSERT(NX_ROLE_SLAVE + 1 == OFPCR12_ROLE_SLAVE); + va_start(args, message); + vlog_valist(THIS_MODULE, level, message, args); + va_end(args); + } +} - if (nrr->role != htonl(NX_ROLE_OTHER) && - nrr->role != htonl(NX_ROLE_MASTER) && - nrr->role != htonl(NX_ROLE_SLAVE)) { - return OFPERR_OFPRRFC_BAD_ROLE; - } +static enum ofperr +parse_table_ids(struct ofpbuf *payload, uint32_t *ids) +{ + uint16_t type; - rr->role = ntohl(nrr->role) + 1; - rr->have_generation_id = false; - rr->generation_id = 0; - } else { - NOT_REACHED(); + *ids = 0; + while (ofpbuf_size(payload) > 0) { + enum ofperr error = ofputil_pull_property(payload, NULL, &type); + if (error) { + return error; + } + if (type < CHAR_BIT * sizeof *ids) { + *ids |= 1u << type; + } } - return 0; } -/* Returns an encoded form of a role reply suitable for the "request" in a - * buffer owned by the caller. */ -struct ofpbuf * -ofputil_encode_role_reply(const struct ofp_header *request, - const struct ofputil_role_request *rr) +static enum ofperr +parse_instruction_ids(struct ofpbuf *payload, bool loose, uint32_t *insts) { - struct ofpbuf *buf; - enum ofpraw raw; + *insts = 0; + while (ofpbuf_size(payload) > 0) { + enum ovs_instruction_type inst; + enum ofperr error; + uint16_t ofpit; - raw = ofpraw_decode_assert(request); - if (raw == OFPRAW_OFPT12_ROLE_REQUEST) { - struct ofp12_role_request *orr; + error = ofputil_pull_property(payload, NULL, &ofpit); + if (error) { + return error; + } - buf = ofpraw_alloc_reply(OFPRAW_OFPT12_ROLE_REPLY, request, 0); - orr = ofpbuf_put_zeros(buf, sizeof *orr); + error = ovs_instruction_type_from_inst_type(&inst, ofpit); + if (!error) { + *insts |= 1u << inst; + } else if (!loose) { + return error; + } + } + return 0; +} - orr->role = htonl(rr->role); - orr->generation_id = htonll(rr->have_generation_id - ? rr->generation_id - : UINT64_MAX); - } else if (raw == OFPRAW_NXT_ROLE_REQUEST) { - struct nx_role_request *nrr; +static enum ofperr +parse_table_features_next_table(struct ofpbuf *payload, + unsigned long int *next_tables) +{ + size_t i; - BUILD_ASSERT(NX_ROLE_OTHER == OFPCR12_ROLE_EQUAL - 1); - BUILD_ASSERT(NX_ROLE_MASTER == OFPCR12_ROLE_MASTER - 1); - BUILD_ASSERT(NX_ROLE_SLAVE == OFPCR12_ROLE_SLAVE - 1); + memset(next_tables, 0, bitmap_n_bytes(255)); + for (i = 0; i < ofpbuf_size(payload); i++) { + uint8_t id = ((const uint8_t *) ofpbuf_data(payload))[i]; + if (id >= 255) { + return OFPERR_OFPTFFC_BAD_ARGUMENT; + } + bitmap_set1(next_tables, id); + } + return 0; +} - buf = ofpraw_alloc_reply(OFPRAW_NXT_ROLE_REPLY, request, 0); - nrr = ofpbuf_put_zeros(buf, sizeof *nrr); - nrr->role = htonl(rr->role - 1); - } else { - NOT_REACHED(); +static enum ofperr +parse_oxm(struct ofpbuf *b, bool loose, + const struct mf_field **fieldp, bool *hasmask) +{ + ovs_be32 *oxmp; + uint32_t oxm; + + oxmp = ofpbuf_try_pull(b, sizeof *oxmp); + if (!oxmp) { + return OFPERR_OFPTFFC_BAD_LEN; + } + oxm = ntohl(*oxmp); + + /* Determine '*hasmask'. If 'oxm' is masked, convert it to the equivalent + * unmasked version, because the table of OXM fields we support only has + * masked versions of fields that we support with masks, but we should be + * able to parse the masked versions of those here. */ + *hasmask = NXM_HASMASK(oxm); + if (*hasmask) { + if (NXM_LENGTH(oxm) & 1) { + return OFPERR_OFPTFFC_BAD_ARGUMENT; + } + oxm = NXM_HEADER(NXM_VENDOR(oxm), NXM_FIELD(oxm), NXM_LENGTH(oxm) / 2); } - return buf; + *fieldp = mf_from_nxm_header(oxm); + if (!*fieldp) { + log_property(loose, "unknown OXM field %#"PRIx32, ntohl(*oxmp)); + } + return *fieldp ? 0 : OFPERR_OFPBMC_BAD_FIELD; } - -/* Table stats. */ -static void -ofputil_put_ofp10_table_stats(const struct ofp12_table_stats *in, - struct ofpbuf *buf) +static enum ofperr +parse_oxms(struct ofpbuf *payload, bool loose, + uint64_t *exactp, uint64_t *maskedp) { - struct wc_map { - enum ofp10_flow_wildcards wc10; - enum oxm12_ofb_match_fields mf12; - }; - - static const struct wc_map wc_map[] = { - { OFPFW10_IN_PORT, OFPXMT12_OFB_IN_PORT }, - { OFPFW10_DL_VLAN, OFPXMT12_OFB_VLAN_VID }, - { OFPFW10_DL_SRC, OFPXMT12_OFB_ETH_SRC }, - { OFPFW10_DL_DST, OFPXMT12_OFB_ETH_DST}, - { OFPFW10_DL_TYPE, OFPXMT12_OFB_ETH_TYPE }, - { OFPFW10_NW_PROTO, OFPXMT12_OFB_IP_PROTO }, - { OFPFW10_TP_SRC, OFPXMT12_OFB_TCP_SRC }, - { OFPFW10_TP_DST, OFPXMT12_OFB_TCP_DST }, - { OFPFW10_NW_SRC_MASK, OFPXMT12_OFB_IPV4_SRC }, - { OFPFW10_NW_DST_MASK, OFPXMT12_OFB_IPV4_DST }, - { OFPFW10_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP }, - { OFPFW10_NW_TOS, OFPXMT12_OFB_IP_DSCP }, - }; + uint64_t exact, masked; - struct ofp10_table_stats *out; - const struct wc_map *p; + exact = masked = 0; + while (ofpbuf_size(payload) > 0) { + const struct mf_field *field; + enum ofperr error; + bool hasmask; - out = ofpbuf_put_zeros(buf, sizeof *out); - out->table_id = in->table_id; - ovs_strlcpy(out->name, in->name, sizeof out->name); - out->wildcards = 0; - for (p = wc_map; p < &wc_map[ARRAY_SIZE(wc_map)]; p++) { - if (in->wildcards & htonll(1ULL << p->mf12)) { - out->wildcards |= htonl(p->wc10); + error = parse_oxm(payload, loose, &field, &hasmask); + if (!error) { + if (hasmask) { + masked |= UINT64_C(1) << field->id; + } else { + exact |= UINT64_C(1) << field->id; + } + } else if (error != OFPERR_OFPBMC_BAD_FIELD || !loose) { + return error; } } - out->max_entries = in->max_entries; - out->active_count = in->active_count; - put_32aligned_be64(&out->lookup_count, in->lookup_count); - put_32aligned_be64(&out->matched_count, in->matched_count); + if (exactp) { + *exactp = exact; + } else if (exact) { + return OFPERR_OFPBMC_BAD_MASK; + } + if (maskedp) { + *maskedp = masked; + } else if (masked) { + return OFPERR_OFPBMC_BAD_MASK; + } + return 0; } -static ovs_be32 -oxm12_to_ofp11_flow_match_fields(ovs_be64 oxm12) +/* Converts an OFPMP_TABLE_FEATURES request or reply in 'msg' into an abstract + * ofputil_table_features in 'tf'. + * + * If 'loose' is true, this function ignores properties and values that it does + * not understand, as a controller would want to do when interpreting + * capabilities provided by a switch. If 'loose' is false, this function + * treats unknown properties and values as an error, as a switch would want to + * do when interpreting a configuration request made by a controller. + * + * A single OpenFlow message can specify features for multiple tables. Calling + * this function multiple times for a single 'msg' iterates through the tables + * in the message. The caller must initially leave 'msg''s layer pointers null + * and not modify them between calls. + * + * Returns 0 if successful, EOF if no tables were left in this 'msg', otherwise + * a positive "enum ofperr" value. */ +int +ofputil_decode_table_features(struct ofpbuf *msg, + struct ofputil_table_features *tf, bool loose) { - struct map { - enum ofp11_flow_match_fields fmf11; - enum oxm12_ofb_match_fields mf12; - }; + struct ofp13_table_features *otf; + unsigned int len; - static const struct map map[] = { - { OFPFMF11_IN_PORT, OFPXMT12_OFB_IN_PORT }, - { OFPFMF11_DL_VLAN, OFPXMT12_OFB_VLAN_VID }, - { OFPFMF11_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP }, - { OFPFMF11_DL_TYPE, OFPXMT12_OFB_ETH_TYPE }, - { OFPFMF11_NW_TOS, OFPXMT12_OFB_IP_DSCP }, - { OFPFMF11_NW_PROTO, OFPXMT12_OFB_IP_PROTO }, - { OFPFMF11_TP_SRC, OFPXMT12_OFB_TCP_SRC }, - { OFPFMF11_TP_DST, OFPXMT12_OFB_TCP_DST }, - { OFPFMF11_MPLS_LABEL, OFPXMT12_OFB_MPLS_LABEL }, - { OFPFMF11_MPLS_TC, OFPXMT12_OFB_MPLS_TC }, - /* I don't know what OFPFMF11_TYPE means. */ - { OFPFMF11_DL_SRC, OFPXMT12_OFB_ETH_SRC }, - { OFPFMF11_DL_DST, OFPXMT12_OFB_ETH_DST }, - { OFPFMF11_NW_SRC, OFPXMT12_OFB_IPV4_SRC }, - { OFPFMF11_NW_DST, OFPXMT12_OFB_IPV4_DST }, - { OFPFMF11_METADATA, OFPXMT12_OFB_METADATA }, - }; + if (!msg->frame) { + ofpraw_pull_assert(msg); + } - const struct map *p; - uint32_t fmf11; + if (!ofpbuf_size(msg)) { + return EOF; + } - fmf11 = 0; - for (p = map; p < &map[ARRAY_SIZE(map)]; p++) { - if (oxm12 & htonll(1ULL << p->mf12)) { - fmf11 |= p->fmf11; - } + if (ofpbuf_size(msg) < sizeof *otf) { + return OFPERR_OFPTFFC_BAD_LEN; } - return htonl(fmf11); -} -static void -ofputil_put_ofp11_table_stats(const struct ofp12_table_stats *in, - struct ofpbuf *buf) -{ - struct ofp11_table_stats *out; + otf = ofpbuf_data(msg); + len = ntohs(otf->length); + if (len < sizeof *otf || len % 8 || len > ofpbuf_size(msg)) { + return OFPERR_OFPTFFC_BAD_LEN; + } + ofpbuf_pull(msg, sizeof *otf); - out = ofpbuf_put_zeros(buf, sizeof *out); - out->table_id = in->table_id; - ovs_strlcpy(out->name, in->name, sizeof out->name); - out->wildcards = oxm12_to_ofp11_flow_match_fields(in->wildcards); - out->match = oxm12_to_ofp11_flow_match_fields(in->match); - out->instructions = in->instructions; - out->write_actions = in->write_actions; - out->apply_actions = in->apply_actions; - out->config = in->config; - out->max_entries = in->max_entries; - out->active_count = in->active_count; - out->lookup_count = in->lookup_count; - out->matched_count = in->matched_count; -} + tf->table_id = otf->table_id; + if (tf->table_id == OFPTT_ALL) { + return OFPERR_OFPTFFC_BAD_TABLE; + } -static void -ofputil_put_ofp13_table_stats(const struct ofp12_table_stats *in, - struct ofpbuf *buf) -{ - struct ofp13_table_stats *out; + ovs_strlcpy(tf->name, otf->name, OFP_MAX_TABLE_NAME_LEN); + tf->metadata_match = otf->metadata_match; + tf->metadata_write = otf->metadata_write; + tf->config = ntohl(otf->config); + tf->max_entries = ntohl(otf->max_entries); - /* OF 1.3 splits table features off the ofp_table_stats, - * so there is not much here. */ + while (ofpbuf_size(msg) > 0) { + struct ofpbuf payload; + enum ofperr error; + uint16_t type; - out = ofpbuf_put_uninit(buf, sizeof *out); - out->table_id = in->table_id; - out->active_count = in->active_count; - out->lookup_count = in->lookup_count; - out->matched_count = in->matched_count; + error = ofputil_pull_property(msg, &payload, &type); + if (error) { + return error; + } + + switch ((enum ofp13_table_feature_prop_type) type) { + case OFPTFPT13_INSTRUCTIONS: + error = parse_instruction_ids(&payload, loose, + &tf->nonmiss.instructions); + break; + case OFPTFPT13_INSTRUCTIONS_MISS: + error = parse_instruction_ids(&payload, loose, + &tf->miss.instructions); + break; + + case OFPTFPT13_NEXT_TABLES: + error = parse_table_features_next_table(&payload, + tf->nonmiss.next); + break; + case OFPTFPT13_NEXT_TABLES_MISS: + error = parse_table_features_next_table(&payload, tf->miss.next); + break; + + case OFPTFPT13_WRITE_ACTIONS: + error = parse_table_ids(&payload, &tf->nonmiss.write.actions); + break; + case OFPTFPT13_WRITE_ACTIONS_MISS: + error = parse_table_ids(&payload, &tf->miss.write.actions); + break; + + case OFPTFPT13_APPLY_ACTIONS: + error = parse_table_ids(&payload, &tf->nonmiss.apply.actions); + break; + case OFPTFPT13_APPLY_ACTIONS_MISS: + error = parse_table_ids(&payload, &tf->miss.apply.actions); + break; + + case OFPTFPT13_MATCH: + error = parse_oxms(&payload, loose, &tf->match, &tf->mask); + break; + case OFPTFPT13_WILDCARDS: + error = parse_oxms(&payload, loose, &tf->wildcard, NULL); + break; + + case OFPTFPT13_WRITE_SETFIELD: + error = parse_oxms(&payload, loose, + &tf->nonmiss.write.set_fields, NULL); + break; + case OFPTFPT13_WRITE_SETFIELD_MISS: + error = parse_oxms(&payload, loose, + &tf->miss.write.set_fields, NULL); + break; + case OFPTFPT13_APPLY_SETFIELD: + error = parse_oxms(&payload, loose, + &tf->nonmiss.apply.set_fields, NULL); + break; + case OFPTFPT13_APPLY_SETFIELD_MISS: + error = parse_oxms(&payload, loose, + &tf->miss.apply.set_fields, NULL); + break; + + case OFPTFPT13_EXPERIMENTER: + case OFPTFPT13_EXPERIMENTER_MISS: + log_property(loose, + "unknown table features experimenter property"); + error = loose ? 0 : OFPERR_OFPTFFC_BAD_TYPE; + break; + } + if (error) { + return error; + } + } + + /* Fix inconsistencies: + * + * - Turn off 'mask' and 'wildcard' bits that are not in 'match', + * because a field must be matchable to be masked or wildcarded. + * + * - Turn on 'wildcard' bits that are set in 'mask', because a field + * that is arbitrarily maskable can be wildcarded entirely. */ + tf->mask &= tf->match; + tf->wildcard &= tf->match; + + tf->wildcard |= tf->mask; + + return 0; } +/* Encodes and returns a request to obtain the table features of a switch. + * The message is encoded for OpenFlow version 'ofp_version'. */ struct ofpbuf * -ofputil_encode_table_stats_reply(const struct ofp12_table_stats stats[], int n, - const struct ofp_header *request) +ofputil_encode_table_features_request(enum ofp_version ofp_version) { - struct ofpbuf *reply; - int i; - - reply = ofpraw_alloc_stats_reply(request, n * sizeof *stats); + struct ofpbuf *request = NULL; - switch ((enum ofp_version) request->version) { + switch (ofp_version) { case OFP10_VERSION: - for (i = 0; i < n; i++) { - ofputil_put_ofp10_table_stats(&stats[i], reply); - } - break; - case OFP11_VERSION: - for (i = 0; i < n; i++) { - ofputil_put_ofp11_table_stats(&stats[i], reply); - } - break; - case OFP12_VERSION: - ofpbuf_put(reply, stats, n * sizeof *stats); - break; - + ovs_fatal(0, "dump-table-features needs OpenFlow 1.3 or later " + "(\'-O OpenFlow13\')"); case OFP13_VERSION: - for (i = 0; i < n; i++) { - ofputil_put_ofp13_table_stats(&stats[i], reply); - } + case OFP14_VERSION: + request = ofpraw_alloc(OFPRAW_OFPST13_TABLE_FEATURES_REQUEST, + ofp_version, 0); break; - default: - NOT_REACHED(); + OVS_NOT_REACHED(); } - return reply; + return request; } - -/* ofputil_flow_monitor_request */ - -/* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract - * ofputil_flow_monitor_request in 'rq'. - * - * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow - * message. Calling this function multiple times for a single 'msg' iterates - * through the requests. The caller must initially leave 'msg''s layer - * pointers null and not modify them between calls. - * - * Returns 0 if successful, EOF if no requests were left in this 'msg', - * otherwise an OFPERR_* value. */ -int -ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *rq, - struct ofpbuf *msg) -{ - struct nx_flow_monitor_request *nfmr; - uint16_t flags; - if (!msg->l2) { - msg->l2 = msg->data; - ofpraw_pull_assert(msg); - } +/* ofputil_table_mod */ - if (!msg->size) { - return EOF; - } +/* Decodes the OpenFlow "table mod" message in '*oh' into an abstract form in + * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */ +enum ofperr +ofputil_decode_table_mod(const struct ofp_header *oh, + struct ofputil_table_mod *pm) +{ + enum ofpraw raw; + struct ofpbuf b; - nfmr = ofpbuf_try_pull(msg, sizeof *nfmr); - if (!nfmr) { - VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR request has %zu " - "leftover bytes at end", msg->size); - return OFPERR_OFPBRC_BAD_LEN; - } + ofpbuf_use_const(&b, oh, ntohs(oh->length)); + raw = ofpraw_pull_assert(&b); - flags = ntohs(nfmr->flags); - if (!(flags & (NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY)) - || flags & ~(NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE - | NXFMF_MODIFY | NXFMF_ACTIONS | NXFMF_OWN)) { - VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR has bad flags %#"PRIx16, - flags); - return OFPERR_NXBRC_FM_BAD_FLAGS; - } + if (raw == OFPRAW_OFPT11_TABLE_MOD) { + const struct ofp11_table_mod *otm = ofpbuf_data(&b); - if (!is_all_zeros(nfmr->zeros, sizeof nfmr->zeros)) { - return OFPERR_NXBRC_MUST_BE_ZERO; + pm->table_id = otm->table_id; + pm->config = ntohl(otm->config); + } else { + return OFPERR_OFPBRC_BAD_TYPE; } - rq->id = ntohl(nfmr->id); - rq->flags = flags; - rq->out_port = u16_to_ofp(ntohs(nfmr->out_port)); - rq->table_id = nfmr->table_id; - - return nx_pull_match(msg, ntohs(nfmr->match_len), &rq->match, NULL, NULL); + return 0; } -void -ofputil_append_flow_monitor_request( - const struct ofputil_flow_monitor_request *rq, struct ofpbuf *msg) +/* Converts the abstract form of a "table mod" message in '*pm' into an OpenFlow + * message suitable for 'protocol', and returns that encoded form in a buffer + * owned by the caller. */ +struct ofpbuf * +ofputil_encode_table_mod(const struct ofputil_table_mod *pm, + enum ofputil_protocol protocol) { - struct nx_flow_monitor_request *nfmr; - size_t start_ofs; - int match_len; + enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol); + struct ofpbuf *b; - if (!msg->size) { - ofpraw_put(OFPRAW_NXST_FLOW_MONITOR_REQUEST, OFP10_VERSION, msg); + switch (ofp_version) { + case OFP10_VERSION: { + ovs_fatal(0, "table mod needs OpenFlow 1.1 or later " + "(\'-O OpenFlow11\')"); + break; } + case OFP11_VERSION: + case OFP12_VERSION: + case OFP13_VERSION: { + struct ofp11_table_mod *otm; - start_ofs = msg->size; - ofpbuf_put_zeros(msg, sizeof *nfmr); - match_len = nx_put_match(msg, &rq->match, htonll(0), htonll(0)); + b = ofpraw_alloc(OFPRAW_OFPT11_TABLE_MOD, ofp_version, 0); + otm = ofpbuf_put_zeros(b, sizeof *otm); + otm->table_id = pm->table_id; + otm->config = htonl(pm->config); + break; + } + case OFP14_VERSION: + OVS_NOT_REACHED(); + break; + default: + OVS_NOT_REACHED(); + } - nfmr = ofpbuf_at_assert(msg, start_ofs, sizeof *nfmr); - nfmr->id = htonl(rq->id); - nfmr->flags = htons(rq->flags); - nfmr->out_port = htons(ofp_to_u16(rq->out_port)); - nfmr->match_len = htons(match_len); - nfmr->table_id = rq->table_id; + return b; } + +/* ofputil_role_request */ -/* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg' - * into an abstract ofputil_flow_update in 'update'. The caller must have - * initialized update->match to point to space allocated for a match. - * - * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's - * actions (except for NXFME_ABBREV, which never includes actions). The caller - * must initialize 'ofpacts' and retains ownership of it. 'update->ofpacts' - * will point into the 'ofpacts' buffer. - * - * Multiple flow updates can be packed into a single OpenFlow message. Calling - * this function multiple times for a single 'msg' iterates through the - * updates. The caller must initially leave 'msg''s layer pointers null and - * not modify them between calls. - * - * Returns 0 if successful, EOF if no updates were left in this 'msg', - * otherwise an OFPERR_* value. */ -int -ofputil_decode_flow_update(struct ofputil_flow_update *update, - struct ofpbuf *msg, struct ofpbuf *ofpacts) +/* Decodes the OpenFlow "role request" or "role reply" message in '*oh' into + * an abstract form in '*rr'. Returns 0 if successful, otherwise an + * OFPERR_* value. */ +enum ofperr +ofputil_decode_role_message(const struct ofp_header *oh, + struct ofputil_role_request *rr) { - struct nx_flow_update_header *nfuh; - unsigned int length; - - if (!msg->l2) { - msg->l2 = msg->data; - ofpraw_pull_assert(msg); - } + struct ofpbuf b; + enum ofpraw raw; - if (!msg->size) { - return EOF; - } + ofpbuf_use_const(&b, oh, ntohs(oh->length)); + raw = ofpraw_pull_assert(&b); - if (msg->size < sizeof(struct nx_flow_update_header)) { - goto bad_len; - } + if (raw == OFPRAW_OFPT12_ROLE_REQUEST || + raw == OFPRAW_OFPT12_ROLE_REPLY) { + const struct ofp12_role_request *orr = ofpbuf_l3(&b); - nfuh = msg->data; - update->event = ntohs(nfuh->event); - length = ntohs(nfuh->length); - if (length > msg->size || length % 8) { - goto bad_len; - } - - if (update->event == NXFME_ABBREV) { - struct nx_flow_update_abbrev *nfua; - - if (length != sizeof *nfua) { - goto bad_len; - } - - nfua = ofpbuf_pull(msg, sizeof *nfua); - update->xid = nfua->xid; - return 0; - } else if (update->event == NXFME_ADDED - || update->event == NXFME_DELETED - || update->event == NXFME_MODIFIED) { - struct nx_flow_update_full *nfuf; - unsigned int actions_len; - unsigned int match_len; - enum ofperr error; - - if (length < sizeof *nfuf) { - goto bad_len; + if (orr->role != htonl(OFPCR12_ROLE_NOCHANGE) && + orr->role != htonl(OFPCR12_ROLE_EQUAL) && + orr->role != htonl(OFPCR12_ROLE_MASTER) && + orr->role != htonl(OFPCR12_ROLE_SLAVE)) { + return OFPERR_OFPRRFC_BAD_ROLE; } - nfuf = ofpbuf_pull(msg, sizeof *nfuf); - match_len = ntohs(nfuf->match_len); - if (sizeof *nfuf + match_len > length) { - goto bad_len; + rr->role = ntohl(orr->role); + if (raw == OFPRAW_OFPT12_ROLE_REQUEST + ? orr->role == htonl(OFPCR12_ROLE_NOCHANGE) + : orr->generation_id == OVS_BE64_MAX) { + rr->have_generation_id = false; + rr->generation_id = 0; + } else { + rr->have_generation_id = true; + rr->generation_id = ntohll(orr->generation_id); } + } else if (raw == OFPRAW_NXT_ROLE_REQUEST || + raw == OFPRAW_NXT_ROLE_REPLY) { + const struct nx_role_request *nrr = ofpbuf_l3(&b); - update->reason = ntohs(nfuf->reason); - update->idle_timeout = ntohs(nfuf->idle_timeout); - update->hard_timeout = ntohs(nfuf->hard_timeout); - update->table_id = nfuf->table_id; - update->cookie = nfuf->cookie; - update->priority = ntohs(nfuf->priority); - - error = nx_pull_match(msg, match_len, update->match, NULL, NULL); - if (error) { - return error; - } + BUILD_ASSERT(NX_ROLE_OTHER + 1 == OFPCR12_ROLE_EQUAL); + BUILD_ASSERT(NX_ROLE_MASTER + 1 == OFPCR12_ROLE_MASTER); + BUILD_ASSERT(NX_ROLE_SLAVE + 1 == OFPCR12_ROLE_SLAVE); - actions_len = length - sizeof *nfuf - ROUND_UP(match_len, 8); - error = ofpacts_pull_openflow10(msg, actions_len, ofpacts); - if (error) { - return error; + if (nrr->role != htonl(NX_ROLE_OTHER) && + nrr->role != htonl(NX_ROLE_MASTER) && + nrr->role != htonl(NX_ROLE_SLAVE)) { + return OFPERR_OFPRRFC_BAD_ROLE; } - update->ofpacts = ofpacts->data; - update->ofpacts_len = ofpacts->size; - return 0; + rr->role = ntohl(nrr->role) + 1; + rr->have_generation_id = false; + rr->generation_id = 0; } else { - VLOG_WARN_RL(&bad_ofmsg_rl, - "NXST_FLOW_MONITOR reply has bad event %"PRIu16, - ntohs(nfuh->event)); - return OFPERR_NXBRC_FM_BAD_EVENT; + OVS_NOT_REACHED(); } -bad_len: - VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR reply has %zu " - "leftover bytes at end", msg->size); - return OFPERR_OFPBRC_BAD_LEN; -} - -uint32_t -ofputil_decode_flow_monitor_cancel(const struct ofp_header *oh) -{ - const struct nx_flow_monitor_cancel *cancel = ofpmsg_body(oh); - - return ntohl(cancel->id); + return 0; } +/* Returns an encoded form of a role reply suitable for the "request" in a + * buffer owned by the caller. */ struct ofpbuf * -ofputil_encode_flow_monitor_cancel(uint32_t id) -{ - struct nx_flow_monitor_cancel *nfmc; - struct ofpbuf *msg; - - msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MONITOR_CANCEL, OFP10_VERSION, 0); - nfmc = ofpbuf_put_uninit(msg, sizeof *nfmc); - nfmc->id = htonl(id); - return msg; -} - -void -ofputil_start_flow_update(struct list *replies) +ofputil_encode_role_reply(const struct ofp_header *request, + const struct ofputil_role_request *rr) { - struct ofpbuf *msg; - - msg = ofpraw_alloc_xid(OFPRAW_NXST_FLOW_MONITOR_REPLY, OFP10_VERSION, - htonl(0), 1024); + struct ofpbuf *buf; + enum ofpraw raw; - list_init(replies); - list_push_back(replies, &msg->list_node); -} + raw = ofpraw_decode_assert(request); + if (raw == OFPRAW_OFPT12_ROLE_REQUEST) { + struct ofp12_role_request *orr; -void -ofputil_append_flow_update(const struct ofputil_flow_update *update, - struct list *replies) -{ - struct nx_flow_update_header *nfuh; - struct ofpbuf *msg; - size_t start_ofs; + buf = ofpraw_alloc_reply(OFPRAW_OFPT12_ROLE_REPLY, request, 0); + orr = ofpbuf_put_zeros(buf, sizeof *orr); - msg = ofpbuf_from_list(list_back(replies)); - start_ofs = msg->size; + orr->role = htonl(rr->role); + orr->generation_id = htonll(rr->have_generation_id + ? rr->generation_id + : UINT64_MAX); + } else if (raw == OFPRAW_NXT_ROLE_REQUEST) { + struct nx_role_request *nrr; - if (update->event == NXFME_ABBREV) { - struct nx_flow_update_abbrev *nfua; + BUILD_ASSERT(NX_ROLE_OTHER == OFPCR12_ROLE_EQUAL - 1); + BUILD_ASSERT(NX_ROLE_MASTER == OFPCR12_ROLE_MASTER - 1); + BUILD_ASSERT(NX_ROLE_SLAVE == OFPCR12_ROLE_SLAVE - 1); - nfua = ofpbuf_put_zeros(msg, sizeof *nfua); - nfua->xid = update->xid; + buf = ofpraw_alloc_reply(OFPRAW_NXT_ROLE_REPLY, request, 0); + nrr = ofpbuf_put_zeros(buf, sizeof *nrr); + nrr->role = htonl(rr->role - 1); } else { - struct nx_flow_update_full *nfuf; - int match_len; - - ofpbuf_put_zeros(msg, sizeof *nfuf); - match_len = nx_put_match(msg, update->match, htonll(0), htonll(0)); - ofpacts_put_openflow10(update->ofpacts, update->ofpacts_len, msg); - - nfuf = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuf); - nfuf->reason = htons(update->reason); - nfuf->priority = htons(update->priority); - nfuf->idle_timeout = htons(update->idle_timeout); - nfuf->hard_timeout = htons(update->hard_timeout); - nfuf->match_len = htons(match_len); - nfuf->table_id = update->table_id; - nfuf->cookie = update->cookie; + OVS_NOT_REACHED(); } - nfuh = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuh); - nfuh->length = htons(msg->size - start_ofs); - nfuh->event = htons(update->event); - - ofpmp_postappend(replies, start_ofs); + return buf; } struct ofpbuf * -ofputil_encode_packet_out(const struct ofputil_packet_out *po, - enum ofputil_protocol protocol) +ofputil_encode_role_status(const struct ofputil_role_status *status, + enum ofputil_protocol protocol) { - enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol); - struct ofpbuf *msg; - size_t size; - - size = po->ofpacts_len; - if (po->buffer_id == UINT32_MAX) { - size += po->packet_len; - } - - switch (ofp_version) { - case OFP10_VERSION: { - struct ofp10_packet_out *opo; - size_t actions_ofs; - - msg = ofpraw_alloc(OFPRAW_OFPT10_PACKET_OUT, OFP10_VERSION, size); - ofpbuf_put_zeros(msg, sizeof *opo); - actions_ofs = msg->size; - ofpacts_put_openflow10(po->ofpacts, po->ofpacts_len, msg); - - opo = msg->l3; - opo->buffer_id = htonl(po->buffer_id); - opo->in_port = htons(ofp_to_u16(po->in_port)); - opo->actions_len = htons(msg->size - actions_ofs); - break; - } + struct ofpbuf *buf; + enum ofp_version version; + struct ofp14_role_status *rstatus; - case OFP11_VERSION: - case OFP12_VERSION: - case OFP13_VERSION: { - struct ofp11_packet_out *opo; - size_t len; + version = ofputil_protocol_to_ofp_version(protocol); + buf = ofpraw_alloc_xid(OFPRAW_OFPT14_ROLE_STATUS, version, htonl(0), 0); + rstatus = ofpbuf_put_zeros(buf, sizeof *rstatus); + rstatus->role = htonl(status->role); + rstatus->reason = status->reason; + rstatus->generation_id = htonll(status->generation_id); - msg = ofpraw_alloc(OFPRAW_OFPT11_PACKET_OUT, ofp_version, size); - ofpbuf_put_zeros(msg, sizeof *opo); - len = ofpacts_put_openflow11_actions(po->ofpacts, po->ofpacts_len, msg); + return buf; +} - opo = msg->l3; - opo->buffer_id = htonl(po->buffer_id); - opo->in_port = ofputil_port_to_ofp11(po->in_port); - opo->actions_len = htons(len); - break; - } +enum ofperr +ofputil_decode_role_status(const struct ofp_header *oh, + struct ofputil_role_status *rs) +{ + struct ofpbuf b; + enum ofpraw raw; + const struct ofp14_role_status *r; - default: - NOT_REACHED(); - } + ofpbuf_use_const(&b, oh, ntohs(oh->length)); + raw = ofpraw_pull_assert(&b); + ovs_assert(raw == OFPRAW_OFPT14_ROLE_STATUS); - if (po->buffer_id == UINT32_MAX) { - ofpbuf_put(msg, po->packet, po->packet_len); + r = ofpbuf_l3(&b); + if (r->role != htonl(OFPCR12_ROLE_NOCHANGE) && + r->role != htonl(OFPCR12_ROLE_EQUAL) && + r->role != htonl(OFPCR12_ROLE_MASTER) && + r->role != htonl(OFPCR12_ROLE_SLAVE)) { + return OFPERR_OFPRRFC_BAD_ROLE; } - ofpmsg_update_length(msg); + rs->role = ntohl(r->role); + rs->generation_id = ntohll(r->generation_id); + rs->reason = r->reason; - return msg; -} - -/* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */ -struct ofpbuf * -make_echo_request(enum ofp_version ofp_version) -{ - return ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST, ofp_version, - htonl(0), 0); + return 0; } -/* Creates and returns an OFPT_ECHO_REPLY message matching the - * OFPT_ECHO_REQUEST message in 'rq'. */ -struct ofpbuf * -make_echo_reply(const struct ofp_header *rq) -{ - struct ofpbuf rq_buf; - struct ofpbuf *reply; +/* Table stats. */ - ofpbuf_use_const(&rq_buf, rq, ntohs(rq->length)); - ofpraw_pull_assert(&rq_buf); +static void +ofputil_put_ofp10_table_stats(const struct ofp12_table_stats *in, + struct ofpbuf *buf) +{ + struct wc_map { + enum ofp10_flow_wildcards wc10; + enum oxm12_ofb_match_fields mf12; + }; - reply = ofpraw_alloc_reply(OFPRAW_OFPT_ECHO_REPLY, rq, rq_buf.size); - ofpbuf_put(reply, rq_buf.data, rq_buf.size); - return reply; -} + static const struct wc_map wc_map[] = { + { OFPFW10_IN_PORT, OFPXMT12_OFB_IN_PORT }, + { OFPFW10_DL_VLAN, OFPXMT12_OFB_VLAN_VID }, + { OFPFW10_DL_SRC, OFPXMT12_OFB_ETH_SRC }, + { OFPFW10_DL_DST, OFPXMT12_OFB_ETH_DST}, + { OFPFW10_DL_TYPE, OFPXMT12_OFB_ETH_TYPE }, + { OFPFW10_NW_PROTO, OFPXMT12_OFB_IP_PROTO }, + { OFPFW10_TP_SRC, OFPXMT12_OFB_TCP_SRC }, + { OFPFW10_TP_DST, OFPXMT12_OFB_TCP_DST }, + { OFPFW10_NW_SRC_MASK, OFPXMT12_OFB_IPV4_SRC }, + { OFPFW10_NW_DST_MASK, OFPXMT12_OFB_IPV4_DST }, + { OFPFW10_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP }, + { OFPFW10_NW_TOS, OFPXMT12_OFB_IP_DSCP }, + }; -struct ofpbuf * -ofputil_encode_barrier_request(enum ofp_version ofp_version) -{ - enum ofpraw type; + struct ofp10_table_stats *out; + const struct wc_map *p; - switch (ofp_version) { - case OFP13_VERSION: - case OFP12_VERSION: - case OFP11_VERSION: - type = OFPRAW_OFPT11_BARRIER_REQUEST; - break; - - case OFP10_VERSION: - type = OFPRAW_OFPT10_BARRIER_REQUEST; - break; - - default: - NOT_REACHED(); + out = ofpbuf_put_zeros(buf, sizeof *out); + out->table_id = in->table_id; + ovs_strlcpy(out->name, in->name, sizeof out->name); + out->wildcards = 0; + for (p = wc_map; p < &wc_map[ARRAY_SIZE(wc_map)]; p++) { + if (in->wildcards & htonll(1ULL << p->mf12)) { + out->wildcards |= htonl(p->wc10); + } } - - return ofpraw_alloc(type, ofp_version, 0); + out->max_entries = in->max_entries; + out->active_count = in->active_count; + put_32aligned_be64(&out->lookup_count, in->lookup_count); + put_32aligned_be64(&out->matched_count, in->matched_count); } -const char * -ofputil_frag_handling_to_string(enum ofp_config_flags flags) +static ovs_be32 +oxm12_to_ofp11_flow_match_fields(ovs_be64 oxm12) { - switch (flags & OFPC_FRAG_MASK) { - case OFPC_FRAG_NORMAL: return "normal"; - case OFPC_FRAG_DROP: return "drop"; - case OFPC_FRAG_REASM: return "reassemble"; - case OFPC_FRAG_NX_MATCH: return "nx-match"; - } + struct map { + enum ofp11_flow_match_fields fmf11; + enum oxm12_ofb_match_fields mf12; + }; - NOT_REACHED(); -} + static const struct map map[] = { + { OFPFMF11_IN_PORT, OFPXMT12_OFB_IN_PORT }, + { OFPFMF11_DL_VLAN, OFPXMT12_OFB_VLAN_VID }, + { OFPFMF11_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP }, + { OFPFMF11_DL_TYPE, OFPXMT12_OFB_ETH_TYPE }, + { OFPFMF11_NW_TOS, OFPXMT12_OFB_IP_DSCP }, + { OFPFMF11_NW_PROTO, OFPXMT12_OFB_IP_PROTO }, + { OFPFMF11_TP_SRC, OFPXMT12_OFB_TCP_SRC }, + { OFPFMF11_TP_DST, OFPXMT12_OFB_TCP_DST }, + { OFPFMF11_MPLS_LABEL, OFPXMT12_OFB_MPLS_LABEL }, + { OFPFMF11_MPLS_TC, OFPXMT12_OFB_MPLS_TC }, + /* I don't know what OFPFMF11_TYPE means. */ + { OFPFMF11_DL_SRC, OFPXMT12_OFB_ETH_SRC }, + { OFPFMF11_DL_DST, OFPXMT12_OFB_ETH_DST }, + { OFPFMF11_NW_SRC, OFPXMT12_OFB_IPV4_SRC }, + { OFPFMF11_NW_DST, OFPXMT12_OFB_IPV4_DST }, + { OFPFMF11_METADATA, OFPXMT12_OFB_METADATA }, + }; -bool -ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags) -{ - if (!strcasecmp(s, "normal")) { - *flags = OFPC_FRAG_NORMAL; - } else if (!strcasecmp(s, "drop")) { - *flags = OFPC_FRAG_DROP; - } else if (!strcasecmp(s, "reassemble")) { - *flags = OFPC_FRAG_REASM; - } else if (!strcasecmp(s, "nx-match")) { - *flags = OFPC_FRAG_NX_MATCH; - } else { - return false; + const struct map *p; + uint32_t fmf11; + + fmf11 = 0; + for (p = map; p < &map[ARRAY_SIZE(map)]; p++) { + if (oxm12 & htonll(1ULL << p->mf12)) { + fmf11 |= p->fmf11; + } } - return true; + return htonl(fmf11); } -/* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0 - * port number and stores the latter in '*ofp10_port', for the purpose of - * decoding OpenFlow 1.1+ protocol messages. Returns 0 if successful, - * otherwise an OFPERR_* number. On error, stores OFPP_NONE in '*ofp10_port'. - * - * See the definition of OFP11_MAX for an explanation of the mapping. */ -enum ofperr -ofputil_port_from_ofp11(ovs_be32 ofp11_port, ofp_port_t *ofp10_port) +static void +ofputil_put_ofp11_table_stats(const struct ofp12_table_stats *in, + struct ofpbuf *buf) { - uint32_t ofp11_port_h = ntohl(ofp11_port); + struct ofp11_table_stats *out; - if (ofp11_port_h < ofp_to_u16(OFPP_MAX)) { - *ofp10_port = u16_to_ofp(ofp11_port_h); - return 0; - } else if (ofp11_port_h >= ofp11_to_u32(OFPP11_MAX)) { - *ofp10_port = u16_to_ofp(ofp11_port_h - OFPP11_OFFSET); - return 0; - } else { - *ofp10_port = OFPP_NONE; - VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported " - "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32, - ofp11_port_h, ofp_to_u16(OFPP_MAX) - 1, - ofp11_to_u32(OFPP11_MAX), UINT32_MAX); - return OFPERR_OFPBAC_BAD_OUT_PORT; - } + out = ofpbuf_put_zeros(buf, sizeof *out); + out->table_id = in->table_id; + ovs_strlcpy(out->name, in->name, sizeof out->name); + out->wildcards = oxm12_to_ofp11_flow_match_fields(in->wildcards); + out->match = oxm12_to_ofp11_flow_match_fields(in->match); + out->instructions = in->instructions; + out->write_actions = in->write_actions; + out->apply_actions = in->apply_actions; + out->config = in->config; + out->max_entries = in->max_entries; + out->active_count = in->active_count; + out->lookup_count = in->lookup_count; + out->matched_count = in->matched_count; } -/* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port - * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages. - * - * See the definition of OFP11_MAX for an explanation of the mapping. */ -ovs_be32 -ofputil_port_to_ofp11(ofp_port_t ofp10_port) +static void +ofputil_put_ofp12_table_stats(const struct ofp12_table_stats *in, + struct ofpbuf *buf) { - return htonl(ofp_to_u16(ofp10_port) < ofp_to_u16(OFPP_MAX) - ? ofp_to_u16(ofp10_port) - : ofp_to_u16(ofp10_port) + OFPP11_OFFSET); + struct ofp12_table_stats *out = ofpbuf_put(buf, in, sizeof *in); + + /* Trim off OF1.3-only capabilities. */ + out->match &= htonll(OFPXMT12_MASK); + out->wildcards &= htonll(OFPXMT12_MASK); + out->write_setfields &= htonll(OFPXMT12_MASK); + out->apply_setfields &= htonll(OFPXMT12_MASK); } -/* Checks that 'port' is a valid output port for the OFPAT10_OUTPUT action, given - * that the switch will never have more than 'max_ports' ports. Returns 0 if - * 'port' is valid, otherwise an OpenFlow return code. */ -enum ofperr -ofputil_check_output_port(ofp_port_t port, ofp_port_t max_ports) +static void +ofputil_put_ofp13_table_stats(const struct ofp12_table_stats *in, + struct ofpbuf *buf) { - switch (port) { - case OFPP_IN_PORT: - case OFPP_TABLE: - case OFPP_NORMAL: - case OFPP_FLOOD: - case OFPP_ALL: - case OFPP_CONTROLLER: - case OFPP_NONE: - case OFPP_LOCAL: - return 0; + struct ofp13_table_stats *out; - default: - if (ofp_to_u16(port) < ofp_to_u16(max_ports)) { - return 0; - } - return OFPERR_OFPBAC_BAD_OUT_PORT; - } + /* OF 1.3 splits table features off the ofp_table_stats, + * so there is not much here. */ + + out = ofpbuf_put_uninit(buf, sizeof *out); + out->table_id = in->table_id; + out->active_count = in->active_count; + out->lookup_count = in->lookup_count; + out->matched_count = in->matched_count; } -#define OFPUTIL_NAMED_PORTS \ - OFPUTIL_NAMED_PORT(IN_PORT) \ - OFPUTIL_NAMED_PORT(TABLE) \ - OFPUTIL_NAMED_PORT(NORMAL) \ - OFPUTIL_NAMED_PORT(FLOOD) \ - OFPUTIL_NAMED_PORT(ALL) \ - OFPUTIL_NAMED_PORT(CONTROLLER) \ - OFPUTIL_NAMED_PORT(LOCAL) \ - OFPUTIL_NAMED_PORT(ANY) +struct ofpbuf * +ofputil_encode_table_stats_reply(const struct ofp12_table_stats stats[], int n, + const struct ofp_header *request) +{ + struct ofpbuf *reply; + int i; -/* For backwards compatibility, so that "none" is recognized as OFPP_ANY */ -#define OFPUTIL_NAMED_PORTS_WITH_NONE \ - OFPUTIL_NAMED_PORTS \ - OFPUTIL_NAMED_PORT(NONE) + reply = ofpraw_alloc_stats_reply(request, n * sizeof *stats); -/* Stores the port number represented by 's' into '*portp'. 's' may be an - * integer or, for reserved ports, the standard OpenFlow name for the port - * (e.g. "LOCAL"). - * - * Returns true if successful, false if 's' is not a valid OpenFlow port number - * or name. The caller should issue an error message in this case, because - * this function usually does not. (This gives the caller an opportunity to - * look up the port name another way, e.g. by contacting the switch and listing - * the names of all its ports). - * - * This function accepts OpenFlow 1.0 port numbers. It also accepts a subset - * of OpenFlow 1.1+ port numbers, mapping those port numbers into the 16-bit - * range as described in include/openflow/openflow-1.1.h. */ -bool -ofputil_port_from_string(const char *s, ofp_port_t *portp) -{ - uint32_t port32; + for (i = 0; i < n; i++) { + switch ((enum ofp_version) request->version) { + case OFP10_VERSION: + ofputil_put_ofp10_table_stats(&stats[i], reply); + break; - *portp = 0; - if (str_to_uint(s, 10, &port32)) { - if (port32 < ofp_to_u16(OFPP_MAX)) { - /* Pass. */ - } else if (port32 < ofp_to_u16(OFPP_FIRST_RESV)) { - VLOG_WARN("port %u is a reserved OF1.0 port number that will " - "be translated to %u when talking to an OF1.1 or " - "later controller", port32, port32 + OFPP11_OFFSET); - } else if (port32 <= ofp_to_u16(OFPP_LAST_RESV)) { - char name[OFP_MAX_PORT_NAME_LEN]; + case OFP11_VERSION: + ofputil_put_ofp11_table_stats(&stats[i], reply); + break; - ofputil_port_to_string(u16_to_ofp(port32), name, sizeof name); - VLOG_WARN_ONCE("referring to port %s as %"PRIu32" is deprecated " - "for compatibility with OpenFlow 1.1 and later", - name, port32); - } else if (port32 < ofp11_to_u32(OFPP11_MAX)) { - VLOG_WARN("port %u is outside the supported range 0 through " - "%"PRIx16" or 0x%x through 0x%"PRIx32, port32, - UINT16_MAX, ofp11_to_u32(OFPP11_MAX), UINT32_MAX); - return false; - } else { - port32 -= OFPP11_OFFSET; - } + case OFP12_VERSION: + ofputil_put_ofp12_table_stats(&stats[i], reply); + break; - *portp = u16_to_ofp(port32); - return true; - } else { - struct pair { - const char *name; - ofp_port_t value; - }; - static const struct pair pairs[] = { -#define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME}, - OFPUTIL_NAMED_PORTS_WITH_NONE -#undef OFPUTIL_NAMED_PORT - }; - const struct pair *p; + case OFP13_VERSION: + case OFP14_VERSION: + ofputil_put_ofp13_table_stats(&stats[i], reply); + break; - for (p = pairs; p < &pairs[ARRAY_SIZE(pairs)]; p++) { - if (!strcasecmp(s, p->name)) { - *portp = p->value; - return true; - } + default: + OVS_NOT_REACHED(); } - return false; } -} - -/* Appends to 's' a string representation of the OpenFlow port number 'port'. - * Most ports' string representation is just the port number, but for special - * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */ -void -ofputil_format_port(ofp_port_t port, struct ds *s) -{ - char name[OFP_MAX_PORT_NAME_LEN]; - ofputil_port_to_string(port, name, sizeof name); - ds_put_cstr(s, name); + return reply; } + +/* ofputil_flow_monitor_request */ -/* Puts in the 'bufsize' byte in 'namebuf' a null-terminated string - * representation of OpenFlow port number 'port'. Most ports are represented - * as just the port number, but special ports, e.g. OFPP_LOCAL, are represented - * by name, e.g. "LOCAL". */ -void -ofputil_port_to_string(ofp_port_t port, - char namebuf[OFP_MAX_PORT_NAME_LEN], size_t bufsize) +/* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract + * ofputil_flow_monitor_request in 'rq'. + * + * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow + * message. Calling this function multiple times for a single 'msg' iterates + * through the requests. The caller must initially leave 'msg''s layer + * pointers null and not modify them between calls. + * + * Returns 0 if successful, EOF if no requests were left in this 'msg', + * otherwise an OFPERR_* value. */ +int +ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *rq, + struct ofpbuf *msg) { - switch (port) { -#define OFPUTIL_NAMED_PORT(NAME) \ - case OFPP_##NAME: \ - ovs_strlcpy(namebuf, #NAME, bufsize); \ - break; - OFPUTIL_NAMED_PORTS -#undef OFPUTIL_NAMED_PORT + struct nx_flow_monitor_request *nfmr; + uint16_t flags; - default: - snprintf(namebuf, bufsize, "%"PRIu16, port); - break; + if (!msg->frame) { + ofpraw_pull_assert(msg); } -} -/* Given a buffer 'b' that contains an array of OpenFlow ports of type - * 'ofp_version', tries to pull the first element from the array. If - * successful, initializes '*pp' with an abstract representation of the - * port and returns 0. If no ports remain to be decoded, returns EOF. - * On an error, returns a positive OFPERR_* value. */ -int -ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *b, - struct ofputil_phy_port *pp) -{ - switch (ofp_version) { - case OFP10_VERSION: { - const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp); - return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF; + if (!ofpbuf_size(msg)) { + return EOF; } - case OFP11_VERSION: - case OFP12_VERSION: - case OFP13_VERSION: { - const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op); - return op ? ofputil_decode_ofp11_port(pp, op) : EOF; + + nfmr = ofpbuf_try_pull(msg, sizeof *nfmr); + if (!nfmr) { + VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR request has %"PRIu32" " + "leftover bytes at end", ofpbuf_size(msg)); + return OFPERR_OFPBRC_BAD_LEN; } - default: - NOT_REACHED(); + + flags = ntohs(nfmr->flags); + if (!(flags & (NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY)) + || flags & ~(NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE + | NXFMF_MODIFY | NXFMF_ACTIONS | NXFMF_OWN)) { + VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR has bad flags %#"PRIx16, + flags); + return OFPERR_NXBRC_FM_BAD_FLAGS; } -} -/* Given a buffer 'b' that contains an array of OpenFlow ports of type - * 'ofp_version', returns the number of elements. */ -size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *b) -{ - return b->size / ofputil_get_phy_port_size(ofp_version); + if (!is_all_zeros(nfmr->zeros, sizeof nfmr->zeros)) { + return OFPERR_NXBRC_MUST_BE_ZERO; + } + + rq->id = ntohl(nfmr->id); + rq->flags = flags; + rq->out_port = u16_to_ofp(ntohs(nfmr->out_port)); + rq->table_id = nfmr->table_id; + + return nx_pull_match(msg, ntohs(nfmr->match_len), &rq->match, NULL, NULL); } -/* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if - * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1 if - * 'name' is not the name of any action. - * - * ofp-util.def lists the mapping from names to action. */ -int -ofputil_action_code_from_name(const char *name) +void +ofputil_append_flow_monitor_request( + const struct ofputil_flow_monitor_request *rq, struct ofpbuf *msg) { - static const char *const names[OFPUTIL_N_ACTIONS] = { - NULL, -#define OFPAT10_ACTION(ENUM, STRUCT, NAME) NAME, -#define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME, -#define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME, -#include "ofp-util.def" - }; - - const char *const *p; + struct nx_flow_monitor_request *nfmr; + size_t start_ofs; + int match_len; - for (p = names; p < &names[ARRAY_SIZE(names)]; p++) { - if (*p && !strcasecmp(name, *p)) { - return p - names; - } + if (!ofpbuf_size(msg)) { + ofpraw_put(OFPRAW_NXST_FLOW_MONITOR_REQUEST, OFP10_VERSION, msg); } - return -1; + + start_ofs = ofpbuf_size(msg); + ofpbuf_put_zeros(msg, sizeof *nfmr); + match_len = nx_put_match(msg, &rq->match, htonll(0), htonll(0)); + + nfmr = ofpbuf_at_assert(msg, start_ofs, sizeof *nfmr); + nfmr->id = htonl(rq->id); + nfmr->flags = htons(rq->flags); + nfmr->out_port = htons(ofp_to_u16(rq->out_port)); + nfmr->match_len = htons(match_len); + nfmr->table_id = rq->table_id; } -/* Appends an action of the type specified by 'code' to 'buf' and returns the - * action. Initializes the parts of 'action' that identify it as having type - * and length 'sizeof *action' and zeros the rest. For actions that - * have variable length, the length used and cleared is that of struct - * . */ -void * -ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf) +/* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg' + * into an abstract ofputil_flow_update in 'update'. The caller must have + * initialized update->match to point to space allocated for a match. + * + * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's + * actions (except for NXFME_ABBREV, which never includes actions). The caller + * must initialize 'ofpacts' and retains ownership of it. 'update->ofpacts' + * will point into the 'ofpacts' buffer. + * + * Multiple flow updates can be packed into a single OpenFlow message. Calling + * this function multiple times for a single 'msg' iterates through the + * updates. The caller must initially leave 'msg''s layer pointers null and + * not modify them between calls. + * + * Returns 0 if successful, EOF if no updates were left in this 'msg', + * otherwise an OFPERR_* value. */ +int +ofputil_decode_flow_update(struct ofputil_flow_update *update, + struct ofpbuf *msg, struct ofpbuf *ofpacts) { - switch (code) { - case OFPUTIL_ACTION_INVALID: - NOT_REACHED(); + struct nx_flow_update_header *nfuh; + unsigned int length; + struct ofp_header *oh; -#define OFPAT10_ACTION(ENUM, STRUCT, NAME) \ - case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf); -#define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \ - case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf); -#define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \ - case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf); -#include "ofp-util.def" + if (!msg->frame) { + ofpraw_pull_assert(msg); } - NOT_REACHED(); -} -#define OFPAT10_ACTION(ENUM, STRUCT, NAME) \ - void \ - ofputil_init_##ENUM(struct STRUCT *s) \ - { \ - memset(s, 0, sizeof *s); \ - s->type = htons(ENUM); \ - s->len = htons(sizeof *s); \ - } \ - \ - struct STRUCT * \ - ofputil_put_##ENUM(struct ofpbuf *buf) \ - { \ - struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \ - ofputil_init_##ENUM(s); \ - return s; \ + if (!ofpbuf_size(msg)) { + return EOF; } -#define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \ - OFPAT10_ACTION(ENUM, STRUCT, NAME) -#define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \ - void \ - ofputil_init_##ENUM(struct STRUCT *s) \ - { \ - memset(s, 0, sizeof *s); \ - s->type = htons(OFPAT10_VENDOR); \ - s->len = htons(sizeof *s); \ - s->vendor = htonl(NX_VENDOR_ID); \ - s->subtype = htons(ENUM); \ - } \ - \ - struct STRUCT * \ - ofputil_put_##ENUM(struct ofpbuf *buf) \ - { \ - struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \ - ofputil_init_##ENUM(s); \ - return s; \ + + if (ofpbuf_size(msg) < sizeof(struct nx_flow_update_header)) { + goto bad_len; } -#include "ofp-util.def" -static void -ofputil_normalize_match__(struct match *match, bool may_log) -{ - enum { - MAY_NW_ADDR = 1 << 0, /* nw_src, nw_dst */ - MAY_TP_ADDR = 1 << 1, /* tp_src, tp_dst */ - MAY_NW_PROTO = 1 << 2, /* nw_proto */ - MAY_IPVx = 1 << 3, /* tos, frag, ttl */ - MAY_ARP_SHA = 1 << 4, /* arp_sha */ - MAY_ARP_THA = 1 << 5, /* arp_tha */ - MAY_IPV6 = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */ - MAY_ND_TARGET = 1 << 7, /* nd_target */ - MAY_MPLS = 1 << 8, /* mpls label and tc */ - } may_match; + oh = msg->frame; - struct flow_wildcards wc; + nfuh = ofpbuf_data(msg); + update->event = ntohs(nfuh->event); + length = ntohs(nfuh->length); + if (length > ofpbuf_size(msg) || length % 8) { + goto bad_len; + } - /* Figure out what fields may be matched. */ - if (match->flow.dl_type == htons(ETH_TYPE_IP)) { - may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR; - if (match->flow.nw_proto == IPPROTO_TCP || - match->flow.nw_proto == IPPROTO_UDP || - match->flow.nw_proto == IPPROTO_SCTP || - match->flow.nw_proto == IPPROTO_ICMP) { - may_match |= MAY_TP_ADDR; + if (update->event == NXFME_ABBREV) { + struct nx_flow_update_abbrev *nfua; + + if (length != sizeof *nfua) { + goto bad_len; } - } else if (match->flow.dl_type == htons(ETH_TYPE_IPV6)) { - may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6; - if (match->flow.nw_proto == IPPROTO_TCP || - match->flow.nw_proto == IPPROTO_UDP || - match->flow.nw_proto == IPPROTO_SCTP) { - may_match |= MAY_TP_ADDR; - } else if (match->flow.nw_proto == IPPROTO_ICMPV6) { - may_match |= MAY_TP_ADDR; - if (match->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) { - may_match |= MAY_ND_TARGET | MAY_ARP_SHA; - } else if (match->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) { - may_match |= MAY_ND_TARGET | MAY_ARP_THA; - } + + nfua = ofpbuf_pull(msg, sizeof *nfua); + update->xid = nfua->xid; + return 0; + } else if (update->event == NXFME_ADDED + || update->event == NXFME_DELETED + || update->event == NXFME_MODIFIED) { + struct nx_flow_update_full *nfuf; + unsigned int actions_len; + unsigned int match_len; + enum ofperr error; + + if (length < sizeof *nfuf) { + goto bad_len; } - } else if (match->flow.dl_type == htons(ETH_TYPE_ARP) || - match->flow.dl_type == htons(ETH_TYPE_RARP)) { - may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA; - } else if (eth_type_mpls(match->flow.dl_type)) { - may_match = MAY_MPLS; - } else { - may_match = 0; - } - /* Clear the fields that may not be matched. */ - wc = match->wc; + nfuf = ofpbuf_pull(msg, sizeof *nfuf); + match_len = ntohs(nfuf->match_len); + if (sizeof *nfuf + match_len > length) { + goto bad_len; + } + + update->reason = ntohs(nfuf->reason); + update->idle_timeout = ntohs(nfuf->idle_timeout); + update->hard_timeout = ntohs(nfuf->hard_timeout); + update->table_id = nfuf->table_id; + update->cookie = nfuf->cookie; + update->priority = ntohs(nfuf->priority); + + error = nx_pull_match(msg, match_len, update->match, NULL, NULL); + if (error) { + return error; + } + + actions_len = length - sizeof *nfuf - ROUND_UP(match_len, 8); + error = ofpacts_pull_openflow_actions(msg, actions_len, oh->version, + ofpacts); + if (error) { + return error; + } + + update->ofpacts = ofpbuf_data(ofpacts); + update->ofpacts_len = ofpbuf_size(ofpacts); + return 0; + } else { + VLOG_WARN_RL(&bad_ofmsg_rl, + "NXST_FLOW_MONITOR reply has bad event %"PRIu16, + ntohs(nfuh->event)); + return OFPERR_NXBRC_FM_BAD_EVENT; + } + +bad_len: + VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR reply has %"PRIu32" " + "leftover bytes at end", ofpbuf_size(msg)); + return OFPERR_OFPBRC_BAD_LEN; +} + +uint32_t +ofputil_decode_flow_monitor_cancel(const struct ofp_header *oh) +{ + const struct nx_flow_monitor_cancel *cancel = ofpmsg_body(oh); + + return ntohl(cancel->id); +} + +struct ofpbuf * +ofputil_encode_flow_monitor_cancel(uint32_t id) +{ + struct nx_flow_monitor_cancel *nfmc; + struct ofpbuf *msg; + + msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MONITOR_CANCEL, OFP10_VERSION, 0); + nfmc = ofpbuf_put_uninit(msg, sizeof *nfmc); + nfmc->id = htonl(id); + return msg; +} + +void +ofputil_start_flow_update(struct list *replies) +{ + struct ofpbuf *msg; + + msg = ofpraw_alloc_xid(OFPRAW_NXST_FLOW_MONITOR_REPLY, OFP10_VERSION, + htonl(0), 1024); + + list_init(replies); + list_push_back(replies, &msg->list_node); +} + +void +ofputil_append_flow_update(const struct ofputil_flow_update *update, + struct list *replies) +{ + struct nx_flow_update_header *nfuh; + struct ofpbuf *msg; + size_t start_ofs; + enum ofp_version version; + + msg = ofpbuf_from_list(list_back(replies)); + start_ofs = ofpbuf_size(msg); + version = ((struct ofp_header *)msg->frame)->version; + + if (update->event == NXFME_ABBREV) { + struct nx_flow_update_abbrev *nfua; + + nfua = ofpbuf_put_zeros(msg, sizeof *nfua); + nfua->xid = update->xid; + } else { + struct nx_flow_update_full *nfuf; + int match_len; + + ofpbuf_put_zeros(msg, sizeof *nfuf); + match_len = nx_put_match(msg, update->match, htonll(0), htonll(0)); + ofpacts_put_openflow_actions(update->ofpacts, update->ofpacts_len, msg, + version); + nfuf = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuf); + nfuf->reason = htons(update->reason); + nfuf->priority = htons(update->priority); + nfuf->idle_timeout = htons(update->idle_timeout); + nfuf->hard_timeout = htons(update->hard_timeout); + nfuf->match_len = htons(match_len); + nfuf->table_id = update->table_id; + nfuf->cookie = update->cookie; + } + + nfuh = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuh); + nfuh->length = htons(ofpbuf_size(msg) - start_ofs); + nfuh->event = htons(update->event); + + ofpmp_postappend(replies, start_ofs); +} + +struct ofpbuf * +ofputil_encode_packet_out(const struct ofputil_packet_out *po, + enum ofputil_protocol protocol) +{ + enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol); + struct ofpbuf *msg; + size_t size; + + size = po->ofpacts_len; + if (po->buffer_id == UINT32_MAX) { + size += po->packet_len; + } + + switch (ofp_version) { + case OFP10_VERSION: { + struct ofp10_packet_out *opo; + size_t actions_ofs; + + msg = ofpraw_alloc(OFPRAW_OFPT10_PACKET_OUT, OFP10_VERSION, size); + ofpbuf_put_zeros(msg, sizeof *opo); + actions_ofs = ofpbuf_size(msg); + ofpacts_put_openflow_actions(po->ofpacts, po->ofpacts_len, msg, + ofp_version); + + opo = ofpbuf_l3(msg); + opo->buffer_id = htonl(po->buffer_id); + opo->in_port = htons(ofp_to_u16(po->in_port)); + opo->actions_len = htons(ofpbuf_size(msg) - actions_ofs); + break; + } + + case OFP11_VERSION: + case OFP12_VERSION: + case OFP13_VERSION: + case OFP14_VERSION:{ + struct ofp11_packet_out *opo; + size_t len; + + msg = ofpraw_alloc(OFPRAW_OFPT11_PACKET_OUT, ofp_version, size); + ofpbuf_put_zeros(msg, sizeof *opo); + len = ofpacts_put_openflow_actions(po->ofpacts, po->ofpacts_len, msg, + ofp_version); + opo = ofpbuf_l3(msg); + opo->buffer_id = htonl(po->buffer_id); + opo->in_port = ofputil_port_to_ofp11(po->in_port); + opo->actions_len = htons(len); + break; + } + + default: + OVS_NOT_REACHED(); + } + + if (po->buffer_id == UINT32_MAX) { + ofpbuf_put(msg, po->packet, po->packet_len); + } + + ofpmsg_update_length(msg); + + return msg; +} + +/* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */ +struct ofpbuf * +make_echo_request(enum ofp_version ofp_version) +{ + return ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST, ofp_version, + htonl(0), 0); +} + +/* Creates and returns an OFPT_ECHO_REPLY message matching the + * OFPT_ECHO_REQUEST message in 'rq'. */ +struct ofpbuf * +make_echo_reply(const struct ofp_header *rq) +{ + struct ofpbuf rq_buf; + struct ofpbuf *reply; + + ofpbuf_use_const(&rq_buf, rq, ntohs(rq->length)); + ofpraw_pull_assert(&rq_buf); + + reply = ofpraw_alloc_reply(OFPRAW_OFPT_ECHO_REPLY, rq, ofpbuf_size(&rq_buf)); + ofpbuf_put(reply, ofpbuf_data(&rq_buf), ofpbuf_size(&rq_buf)); + return reply; +} + +struct ofpbuf * +ofputil_encode_barrier_request(enum ofp_version ofp_version) +{ + enum ofpraw type; + + switch (ofp_version) { + case OFP14_VERSION: + case OFP13_VERSION: + case OFP12_VERSION: + case OFP11_VERSION: + type = OFPRAW_OFPT11_BARRIER_REQUEST; + break; + + case OFP10_VERSION: + type = OFPRAW_OFPT10_BARRIER_REQUEST; + break; + + default: + OVS_NOT_REACHED(); + } + + return ofpraw_alloc(type, ofp_version, 0); +} + +const char * +ofputil_frag_handling_to_string(enum ofp_config_flags flags) +{ + switch (flags & OFPC_FRAG_MASK) { + case OFPC_FRAG_NORMAL: return "normal"; + case OFPC_FRAG_DROP: return "drop"; + case OFPC_FRAG_REASM: return "reassemble"; + case OFPC_FRAG_NX_MATCH: return "nx-match"; + } + + OVS_NOT_REACHED(); +} + +bool +ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags) +{ + if (!strcasecmp(s, "normal")) { + *flags = OFPC_FRAG_NORMAL; + } else if (!strcasecmp(s, "drop")) { + *flags = OFPC_FRAG_DROP; + } else if (!strcasecmp(s, "reassemble")) { + *flags = OFPC_FRAG_REASM; + } else if (!strcasecmp(s, "nx-match")) { + *flags = OFPC_FRAG_NX_MATCH; + } else { + return false; + } + return true; +} + +/* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0 + * port number and stores the latter in '*ofp10_port', for the purpose of + * decoding OpenFlow 1.1+ protocol messages. Returns 0 if successful, + * otherwise an OFPERR_* number. On error, stores OFPP_NONE in '*ofp10_port'. + * + * See the definition of OFP11_MAX for an explanation of the mapping. */ +enum ofperr +ofputil_port_from_ofp11(ovs_be32 ofp11_port, ofp_port_t *ofp10_port) +{ + uint32_t ofp11_port_h = ntohl(ofp11_port); + + if (ofp11_port_h < ofp_to_u16(OFPP_MAX)) { + *ofp10_port = u16_to_ofp(ofp11_port_h); + return 0; + } else if (ofp11_port_h >= ofp11_to_u32(OFPP11_MAX)) { + *ofp10_port = u16_to_ofp(ofp11_port_h - OFPP11_OFFSET); + return 0; + } else { + *ofp10_port = OFPP_NONE; + VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported " + "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32, + ofp11_port_h, ofp_to_u16(OFPP_MAX) - 1, + ofp11_to_u32(OFPP11_MAX), UINT32_MAX); + return OFPERR_OFPBAC_BAD_OUT_PORT; + } +} + +/* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port + * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages. + * + * See the definition of OFP11_MAX for an explanation of the mapping. */ +ovs_be32 +ofputil_port_to_ofp11(ofp_port_t ofp10_port) +{ + return htonl(ofp_to_u16(ofp10_port) < ofp_to_u16(OFPP_MAX) + ? ofp_to_u16(ofp10_port) + : ofp_to_u16(ofp10_port) + OFPP11_OFFSET); +} + +#define OFPUTIL_NAMED_PORTS \ + OFPUTIL_NAMED_PORT(IN_PORT) \ + OFPUTIL_NAMED_PORT(TABLE) \ + OFPUTIL_NAMED_PORT(NORMAL) \ + OFPUTIL_NAMED_PORT(FLOOD) \ + OFPUTIL_NAMED_PORT(ALL) \ + OFPUTIL_NAMED_PORT(CONTROLLER) \ + OFPUTIL_NAMED_PORT(LOCAL) \ + OFPUTIL_NAMED_PORT(ANY) + +/* For backwards compatibility, so that "none" is recognized as OFPP_ANY */ +#define OFPUTIL_NAMED_PORTS_WITH_NONE \ + OFPUTIL_NAMED_PORTS \ + OFPUTIL_NAMED_PORT(NONE) + +/* Stores the port number represented by 's' into '*portp'. 's' may be an + * integer or, for reserved ports, the standard OpenFlow name for the port + * (e.g. "LOCAL"). + * + * Returns true if successful, false if 's' is not a valid OpenFlow port number + * or name. The caller should issue an error message in this case, because + * this function usually does not. (This gives the caller an opportunity to + * look up the port name another way, e.g. by contacting the switch and listing + * the names of all its ports). + * + * This function accepts OpenFlow 1.0 port numbers. It also accepts a subset + * of OpenFlow 1.1+ port numbers, mapping those port numbers into the 16-bit + * range as described in include/openflow/openflow-1.1.h. */ +bool +ofputil_port_from_string(const char *s, ofp_port_t *portp) +{ + unsigned int port32; /* int is at least 32 bits wide. */ + + if (*s == '-') { + VLOG_WARN("Negative value %s is not a valid port number.", s); + return false; + } + *portp = 0; + if (str_to_uint(s, 10, &port32)) { + if (port32 < ofp_to_u16(OFPP_MAX)) { + /* Pass. */ + } else if (port32 < ofp_to_u16(OFPP_FIRST_RESV)) { + VLOG_WARN("port %u is a reserved OF1.0 port number that will " + "be translated to %u when talking to an OF1.1 or " + "later controller", port32, port32 + OFPP11_OFFSET); + } else if (port32 <= ofp_to_u16(OFPP_LAST_RESV)) { + char name[OFP_MAX_PORT_NAME_LEN]; + + ofputil_port_to_string(u16_to_ofp(port32), name, sizeof name); + VLOG_WARN_ONCE("referring to port %s as %"PRIu32" is deprecated " + "for compatibility with OpenFlow 1.1 and later", + name, port32); + } else if (port32 < ofp11_to_u32(OFPP11_MAX)) { + VLOG_WARN("port %u is outside the supported range 0 through " + "%"PRIx16" or 0x%x through 0x%"PRIx32, port32, + UINT16_MAX, ofp11_to_u32(OFPP11_MAX), UINT32_MAX); + return false; + } else { + port32 -= OFPP11_OFFSET; + } + + *portp = u16_to_ofp(port32); + return true; + } else { + struct pair { + const char *name; + ofp_port_t value; + }; + static const struct pair pairs[] = { +#define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME}, + OFPUTIL_NAMED_PORTS_WITH_NONE +#undef OFPUTIL_NAMED_PORT + }; + const struct pair *p; + + for (p = pairs; p < &pairs[ARRAY_SIZE(pairs)]; p++) { + if (!strcasecmp(s, p->name)) { + *portp = p->value; + return true; + } + } + return false; + } +} + +/* Appends to 's' a string representation of the OpenFlow port number 'port'. + * Most ports' string representation is just the port number, but for special + * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */ +void +ofputil_format_port(ofp_port_t port, struct ds *s) +{ + char name[OFP_MAX_PORT_NAME_LEN]; + + ofputil_port_to_string(port, name, sizeof name); + ds_put_cstr(s, name); +} + +/* Puts in the 'bufsize' byte in 'namebuf' a null-terminated string + * representation of OpenFlow port number 'port'. Most ports are represented + * as just the port number, but special ports, e.g. OFPP_LOCAL, are represented + * by name, e.g. "LOCAL". */ +void +ofputil_port_to_string(ofp_port_t port, + char namebuf[OFP_MAX_PORT_NAME_LEN], size_t bufsize) +{ + switch (port) { +#define OFPUTIL_NAMED_PORT(NAME) \ + case OFPP_##NAME: \ + ovs_strlcpy(namebuf, #NAME, bufsize); \ + break; + OFPUTIL_NAMED_PORTS +#undef OFPUTIL_NAMED_PORT + + default: + snprintf(namebuf, bufsize, "%"PRIu16, port); + break; + } +} + +/* Stores the group id represented by 's' into '*group_idp'. 's' may be an + * integer or, for reserved group IDs, the standard OpenFlow name for the group + * (either "ANY" or "ALL"). + * + * Returns true if successful, false if 's' is not a valid OpenFlow group ID or + * name. */ +bool +ofputil_group_from_string(const char *s, uint32_t *group_idp) +{ + if (!strcasecmp(s, "any")) { + *group_idp = OFPG11_ANY; + } else if (!strcasecmp(s, "all")) { + *group_idp = OFPG11_ALL; + } else if (!str_to_uint(s, 10, group_idp)) { + VLOG_WARN("%s is not a valid group ID. (Valid group IDs are " + "32-bit nonnegative integers or the keywords ANY or " + "ALL.)", s); + return false; + } + + return true; +} + +/* Appends to 's' a string representation of the OpenFlow group ID 'group_id'. + * Most groups' string representation is just the number, but for special + * groups, e.g. OFPG11_ALL, it is the name, e.g. "ALL". */ +void +ofputil_format_group(uint32_t group_id, struct ds *s) +{ + char name[MAX_GROUP_NAME_LEN]; + + ofputil_group_to_string(group_id, name, sizeof name); + ds_put_cstr(s, name); +} + + +/* Puts in the 'bufsize' byte in 'namebuf' a null-terminated string + * representation of OpenFlow group ID 'group_id'. Most group are represented + * as just their number, but special groups, e.g. OFPG11_ALL, are represented + * by name, e.g. "ALL". */ +void +ofputil_group_to_string(uint32_t group_id, + char namebuf[MAX_GROUP_NAME_LEN + 1], size_t bufsize) +{ + switch (group_id) { + case OFPG11_ALL: + ovs_strlcpy(namebuf, "ALL", bufsize); + break; + + case OFPG11_ANY: + ovs_strlcpy(namebuf, "ANY", bufsize); + break; + + default: + snprintf(namebuf, bufsize, "%"PRIu32, group_id); + break; + } +} + +/* Given a buffer 'b' that contains an array of OpenFlow ports of type + * 'ofp_version', tries to pull the first element from the array. If + * successful, initializes '*pp' with an abstract representation of the + * port and returns 0. If no ports remain to be decoded, returns EOF. + * On an error, returns a positive OFPERR_* value. */ +int +ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *b, + struct ofputil_phy_port *pp) +{ + switch (ofp_version) { + case OFP10_VERSION: { + const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp); + return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF; + } + case OFP11_VERSION: + case OFP12_VERSION: + case OFP13_VERSION: { + const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op); + return op ? ofputil_decode_ofp11_port(pp, op) : EOF; + } + case OFP14_VERSION: + OVS_NOT_REACHED(); + break; + default: + OVS_NOT_REACHED(); + } +} + +/* Given a buffer 'b' that contains an array of OpenFlow ports of type + * 'ofp_version', returns the number of elements. */ +size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *b) +{ + return ofpbuf_size(b) / ofputil_get_phy_port_size(ofp_version); +} + +/* ofp-util.def lists the mapping from names to action. */ +static const char *const names[OFPUTIL_N_ACTIONS] = { + NULL, +#define OFPAT10_ACTION(ENUM, STRUCT, NAME) NAME, +#define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME, +#define OFPAT13_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME, +#define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME, +#include "ofp-util.def" +}; + +/* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if + * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1 + * if 'name' is not the name of any action. */ +int +ofputil_action_code_from_name(const char *name) +{ + const char *const *p; + + for (p = names; p < &names[ARRAY_SIZE(names)]; p++) { + if (*p && !strcasecmp(name, *p)) { + return p - names; + } + } + return -1; +} + +/* Returns name corresponding to the 'enum ofputil_action_code', + * or "Unkonwn action", if the name is not available. */ +const char * +ofputil_action_name_from_code(enum ofputil_action_code code) +{ + return code < (int)OFPUTIL_N_ACTIONS && names[code] ? names[code] + : "Unknown action"; +} + +enum ofputil_action_code +ofputil_action_code_from_ofp13_action(enum ofp13_action_type type) +{ + switch (type) { + +#define OFPAT13_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \ + case ENUM: \ + return OFPUTIL_##ENUM; +#include "ofp-util.def" + + default: + return OFPUTIL_ACTION_INVALID; + } +} + +/* Appends an action of the type specified by 'code' to 'buf' and returns the + * action. Initializes the parts of 'action' that identify it as having type + * and length 'sizeof *action' and zeros the rest. For actions that + * have variable length, the length used and cleared is that of struct + * . */ +void * +ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf) +{ + switch (code) { + case OFPUTIL_ACTION_INVALID: +#define OFPAT13_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM: +#include "ofp-util.def" + OVS_NOT_REACHED(); + +#define OFPAT10_ACTION(ENUM, STRUCT, NAME) \ + case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf); +#define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \ + case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf); +#define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \ + case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf); +#include "ofp-util.def" + } + OVS_NOT_REACHED(); +} + +#define OFPAT10_ACTION(ENUM, STRUCT, NAME) \ + void \ + ofputil_init_##ENUM(struct STRUCT *s) \ + { \ + memset(s, 0, sizeof *s); \ + s->type = htons(ENUM); \ + s->len = htons(sizeof *s); \ + } \ + \ + struct STRUCT * \ + ofputil_put_##ENUM(struct ofpbuf *buf) \ + { \ + struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \ + ofputil_init_##ENUM(s); \ + return s; \ + } +#define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \ + OFPAT10_ACTION(ENUM, STRUCT, NAME) +#define OFPAT13_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \ + OFPAT10_ACTION(ENUM, STRUCT, NAME) +#define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \ + void \ + ofputil_init_##ENUM(struct STRUCT *s) \ + { \ + memset(s, 0, sizeof *s); \ + s->type = htons(OFPAT10_VENDOR); \ + s->len = htons(sizeof *s); \ + s->vendor = htonl(NX_VENDOR_ID); \ + s->subtype = htons(ENUM); \ + } \ + \ + struct STRUCT * \ + ofputil_put_##ENUM(struct ofpbuf *buf) \ + { \ + struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \ + ofputil_init_##ENUM(s); \ + return s; \ + } +#include "ofp-util.def" + +static void +ofputil_normalize_match__(struct match *match, bool may_log) +{ + enum { + MAY_NW_ADDR = 1 << 0, /* nw_src, nw_dst */ + MAY_TP_ADDR = 1 << 1, /* tp_src, tp_dst */ + MAY_NW_PROTO = 1 << 2, /* nw_proto */ + MAY_IPVx = 1 << 3, /* tos, frag, ttl */ + MAY_ARP_SHA = 1 << 4, /* arp_sha */ + MAY_ARP_THA = 1 << 5, /* arp_tha */ + MAY_IPV6 = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */ + MAY_ND_TARGET = 1 << 7, /* nd_target */ + MAY_MPLS = 1 << 8, /* mpls label and tc */ + } may_match; + + struct flow_wildcards wc; + + /* Figure out what fields may be matched. */ + if (match->flow.dl_type == htons(ETH_TYPE_IP)) { + may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR; + if (match->flow.nw_proto == IPPROTO_TCP || + match->flow.nw_proto == IPPROTO_UDP || + match->flow.nw_proto == IPPROTO_SCTP || + match->flow.nw_proto == IPPROTO_ICMP) { + may_match |= MAY_TP_ADDR; + } + } else if (match->flow.dl_type == htons(ETH_TYPE_IPV6)) { + may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6; + if (match->flow.nw_proto == IPPROTO_TCP || + match->flow.nw_proto == IPPROTO_UDP || + match->flow.nw_proto == IPPROTO_SCTP) { + may_match |= MAY_TP_ADDR; + } else if (match->flow.nw_proto == IPPROTO_ICMPV6) { + may_match |= MAY_TP_ADDR; + if (match->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) { + may_match |= MAY_ND_TARGET | MAY_ARP_SHA; + } else if (match->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) { + may_match |= MAY_ND_TARGET | MAY_ARP_THA; + } + } + } else if (match->flow.dl_type == htons(ETH_TYPE_ARP) || + match->flow.dl_type == htons(ETH_TYPE_RARP)) { + may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA; + } else if (eth_type_mpls(match->flow.dl_type)) { + may_match = MAY_MPLS; + } else { + may_match = 0; + } + + /* Clear the fields that may not be matched. */ + wc = match->wc; if (!(may_match & MAY_NW_ADDR)) { wc.masks.nw_src = wc.masks.nw_dst = htonl(0); } - if (!(may_match & MAY_TP_ADDR)) { - wc.masks.tp_src = wc.masks.tp_dst = htons(0); + if (!(may_match & MAY_TP_ADDR)) { + wc.masks.tp_src = wc.masks.tp_dst = htons(0); + } + if (!(may_match & MAY_NW_PROTO)) { + wc.masks.nw_proto = 0; + } + if (!(may_match & MAY_IPVx)) { + wc.masks.nw_tos = 0; + wc.masks.nw_ttl = 0; + } + if (!(may_match & MAY_ARP_SHA)) { + memset(wc.masks.arp_sha, 0, ETH_ADDR_LEN); + } + if (!(may_match & MAY_ARP_THA)) { + memset(wc.masks.arp_tha, 0, ETH_ADDR_LEN); + } + if (!(may_match & MAY_IPV6)) { + wc.masks.ipv6_src = wc.masks.ipv6_dst = in6addr_any; + wc.masks.ipv6_label = htonl(0); + } + if (!(may_match & MAY_ND_TARGET)) { + wc.masks.nd_target = in6addr_any; + } + if (!(may_match & MAY_MPLS)) { + memset(wc.masks.mpls_lse, 0, sizeof wc.masks.mpls_lse); + } + + /* Log any changes. */ + if (!flow_wildcards_equal(&wc, &match->wc)) { + bool log = may_log && !VLOG_DROP_INFO(&bad_ofmsg_rl); + char *pre = log ? match_to_string(match, OFP_DEFAULT_PRIORITY) : NULL; + + match->wc = wc; + match_zero_wildcarded_fields(match); + + if (log) { + char *post = match_to_string(match, OFP_DEFAULT_PRIORITY); + VLOG_INFO("normalization changed ofp_match, details:"); + VLOG_INFO(" pre: %s", pre); + VLOG_INFO("post: %s", post); + free(pre); + free(post); + } + } +} + +/* "Normalizes" the wildcards in 'match'. That means: + * + * 1. If the type of level N is known, then only the valid fields for that + * level may be specified. For example, ARP does not have a TOS field, + * so nw_tos must be wildcarded if 'match' specifies an ARP flow. + * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and + * ipv6_dst (and other fields) must be wildcarded if 'match' specifies an + * IPv4 flow. + * + * 2. If the type of level N is not known (or not understood by Open + * vSwitch), then no fields at all for that level may be specified. For + * example, Open vSwitch does not understand SCTP, an L4 protocol, so the + * L4 fields tp_src and tp_dst must be wildcarded if 'match' specifies an + * SCTP flow. + * + * If this function changes 'match', it logs a rate-limited informational + * message. */ +void +ofputil_normalize_match(struct match *match) +{ + ofputil_normalize_match__(match, true); +} + +/* Same as ofputil_normalize_match() without the logging. Thus, this function + * is suitable for a program's internal use, whereas ofputil_normalize_match() + * sense for use on flows received from elsewhere (so that a bug in the program + * that sent them can be reported and corrected). */ +void +ofputil_normalize_match_quiet(struct match *match) +{ + ofputil_normalize_match__(match, false); +} + +/* Parses a key or a key-value pair from '*stringp'. + * + * On success: Stores the key into '*keyp'. Stores the value, if present, into + * '*valuep', otherwise an empty string. Advances '*stringp' past the end of + * the key-value pair, preparing it for another call. '*keyp' and '*valuep' + * are substrings of '*stringp' created by replacing some of its bytes by null + * terminators. Returns true. + * + * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to + * NULL and returns false. */ +bool +ofputil_parse_key_value(char **stringp, char **keyp, char **valuep) +{ + char *pos, *key, *value; + size_t key_len; + + pos = *stringp; + pos += strspn(pos, ", \t\r\n"); + if (*pos == '\0') { + *keyp = *valuep = NULL; + return false; + } + + key = pos; + key_len = strcspn(pos, ":=(, \t\r\n"); + if (key[key_len] == ':' || key[key_len] == '=') { + /* The value can be separated by a colon. */ + size_t value_len; + + value = key + key_len + 1; + value_len = strcspn(value, ", \t\r\n"); + pos = value + value_len + (value[value_len] != '\0'); + value[value_len] = '\0'; + } else if (key[key_len] == '(') { + /* The value can be surrounded by balanced parentheses. The outermost + * set of parentheses is removed. */ + int level = 1; + size_t value_len; + + value = key + key_len + 1; + for (value_len = 0; level > 0; value_len++) { + switch (value[value_len]) { + case '\0': + level = 0; + break; + + case '(': + level++; + break; + + case ')': + level--; + break; + } + } + value[value_len - 1] = '\0'; + pos = value + value_len; + } else { + /* There might be no value at all. */ + value = key + key_len; /* Will become the empty string below. */ + pos = key + key_len + (key[key_len] != '\0'); + } + key[key_len] = '\0'; + + *stringp = pos; + *keyp = key; + *valuep = value; + return true; +} + +/* Encode a dump ports request for 'port', the encoded message + * will be for Open Flow version 'ofp_version'. Returns message + * as a struct ofpbuf. Returns encoded message on success, NULL on error */ +struct ofpbuf * +ofputil_encode_dump_ports_request(enum ofp_version ofp_version, ofp_port_t port) +{ + struct ofpbuf *request; + + switch (ofp_version) { + case OFP10_VERSION: { + struct ofp10_port_stats_request *req; + request = ofpraw_alloc(OFPRAW_OFPST10_PORT_REQUEST, ofp_version, 0); + req = ofpbuf_put_zeros(request, sizeof *req); + req->port_no = htons(ofp_to_u16(port)); + break; } - if (!(may_match & MAY_NW_PROTO)) { - wc.masks.nw_proto = 0; + case OFP11_VERSION: + case OFP12_VERSION: + case OFP13_VERSION: + case OFP14_VERSION:{ + struct ofp11_port_stats_request *req; + request = ofpraw_alloc(OFPRAW_OFPST11_PORT_REQUEST, ofp_version, 0); + req = ofpbuf_put_zeros(request, sizeof *req); + req->port_no = ofputil_port_to_ofp11(port); + break; } - if (!(may_match & MAY_IPVx)) { - wc.masks.nw_tos = 0; - wc.masks.nw_ttl = 0; + default: + OVS_NOT_REACHED(); } - if (!(may_match & MAY_ARP_SHA)) { - memset(wc.masks.arp_sha, 0, ETH_ADDR_LEN); + + return request; +} + +static void +ofputil_port_stats_to_ofp10(const struct ofputil_port_stats *ops, + struct ofp10_port_stats *ps10) +{ + ps10->port_no = htons(ofp_to_u16(ops->port_no)); + memset(ps10->pad, 0, sizeof ps10->pad); + put_32aligned_be64(&ps10->rx_packets, htonll(ops->stats.rx_packets)); + put_32aligned_be64(&ps10->tx_packets, htonll(ops->stats.tx_packets)); + put_32aligned_be64(&ps10->rx_bytes, htonll(ops->stats.rx_bytes)); + put_32aligned_be64(&ps10->tx_bytes, htonll(ops->stats.tx_bytes)); + put_32aligned_be64(&ps10->rx_dropped, htonll(ops->stats.rx_dropped)); + put_32aligned_be64(&ps10->tx_dropped, htonll(ops->stats.tx_dropped)); + put_32aligned_be64(&ps10->rx_errors, htonll(ops->stats.rx_errors)); + put_32aligned_be64(&ps10->tx_errors, htonll(ops->stats.tx_errors)); + put_32aligned_be64(&ps10->rx_frame_err, htonll(ops->stats.rx_frame_errors)); + put_32aligned_be64(&ps10->rx_over_err, htonll(ops->stats.rx_over_errors)); + put_32aligned_be64(&ps10->rx_crc_err, htonll(ops->stats.rx_crc_errors)); + put_32aligned_be64(&ps10->collisions, htonll(ops->stats.collisions)); +} + +static void +ofputil_port_stats_to_ofp11(const struct ofputil_port_stats *ops, + struct ofp11_port_stats *ps11) +{ + ps11->port_no = ofputil_port_to_ofp11(ops->port_no); + memset(ps11->pad, 0, sizeof ps11->pad); + ps11->rx_packets = htonll(ops->stats.rx_packets); + ps11->tx_packets = htonll(ops->stats.tx_packets); + ps11->rx_bytes = htonll(ops->stats.rx_bytes); + ps11->tx_bytes = htonll(ops->stats.tx_bytes); + ps11->rx_dropped = htonll(ops->stats.rx_dropped); + ps11->tx_dropped = htonll(ops->stats.tx_dropped); + ps11->rx_errors = htonll(ops->stats.rx_errors); + ps11->tx_errors = htonll(ops->stats.tx_errors); + ps11->rx_frame_err = htonll(ops->stats.rx_frame_errors); + ps11->rx_over_err = htonll(ops->stats.rx_over_errors); + ps11->rx_crc_err = htonll(ops->stats.rx_crc_errors); + ps11->collisions = htonll(ops->stats.collisions); +} + +static void +ofputil_port_stats_to_ofp13(const struct ofputil_port_stats *ops, + struct ofp13_port_stats *ps13) +{ + ofputil_port_stats_to_ofp11(ops, &ps13->ps); + ps13->duration_sec = htonl(ops->duration_sec); + ps13->duration_nsec = htonl(ops->duration_nsec); +} + + +/* Encode a ports stat for 'ops' and append it to 'replies'. */ +void +ofputil_append_port_stat(struct list *replies, + const struct ofputil_port_stats *ops) +{ + struct ofpbuf *msg = ofpbuf_from_list(list_back(replies)); + struct ofp_header *oh = ofpbuf_data(msg); + + switch ((enum ofp_version)oh->version) { + case OFP13_VERSION: { + struct ofp13_port_stats *reply = ofpmp_append(replies, sizeof *reply); + ofputil_port_stats_to_ofp13(ops, reply); + break; } - if (!(may_match & MAY_ARP_THA)) { - memset(wc.masks.arp_tha, 0, ETH_ADDR_LEN); + case OFP12_VERSION: + case OFP11_VERSION: { + struct ofp11_port_stats *reply = ofpmp_append(replies, sizeof *reply); + ofputil_port_stats_to_ofp11(ops, reply); + break; } - if (!(may_match & MAY_IPV6)) { - wc.masks.ipv6_src = wc.masks.ipv6_dst = in6addr_any; - wc.masks.ipv6_label = htonl(0); + + case OFP10_VERSION: { + struct ofp10_port_stats *reply = ofpmp_append(replies, sizeof *reply); + ofputil_port_stats_to_ofp10(ops, reply); + break; } - if (!(may_match & MAY_ND_TARGET)) { - wc.masks.nd_target = in6addr_any; + + case OFP14_VERSION: + OVS_NOT_REACHED(); + break; + + default: + OVS_NOT_REACHED(); } - if (!(may_match & MAY_MPLS)) { - wc.masks.mpls_lse = htonl(0); - wc.masks.mpls_depth = 0; +} + +static enum ofperr +ofputil_port_stats_from_ofp10(struct ofputil_port_stats *ops, + const struct ofp10_port_stats *ps10) +{ + memset(ops, 0, sizeof *ops); + + ops->port_no = u16_to_ofp(ntohs(ps10->port_no)); + ops->stats.rx_packets = ntohll(get_32aligned_be64(&ps10->rx_packets)); + ops->stats.tx_packets = ntohll(get_32aligned_be64(&ps10->tx_packets)); + ops->stats.rx_bytes = ntohll(get_32aligned_be64(&ps10->rx_bytes)); + ops->stats.tx_bytes = ntohll(get_32aligned_be64(&ps10->tx_bytes)); + ops->stats.rx_dropped = ntohll(get_32aligned_be64(&ps10->rx_dropped)); + ops->stats.tx_dropped = ntohll(get_32aligned_be64(&ps10->tx_dropped)); + ops->stats.rx_errors = ntohll(get_32aligned_be64(&ps10->rx_errors)); + ops->stats.tx_errors = ntohll(get_32aligned_be64(&ps10->tx_errors)); + ops->stats.rx_frame_errors = + ntohll(get_32aligned_be64(&ps10->rx_frame_err)); + ops->stats.rx_over_errors = ntohll(get_32aligned_be64(&ps10->rx_over_err)); + ops->stats.rx_crc_errors = ntohll(get_32aligned_be64(&ps10->rx_crc_err)); + ops->stats.collisions = ntohll(get_32aligned_be64(&ps10->collisions)); + ops->duration_sec = ops->duration_nsec = UINT32_MAX; + + return 0; +} + +static enum ofperr +ofputil_port_stats_from_ofp11(struct ofputil_port_stats *ops, + const struct ofp11_port_stats *ps11) +{ + enum ofperr error; + + memset(ops, 0, sizeof *ops); + error = ofputil_port_from_ofp11(ps11->port_no, &ops->port_no); + if (error) { + return error; } - /* Log any changes. */ - if (!flow_wildcards_equal(&wc, &match->wc)) { - bool log = may_log && !VLOG_DROP_INFO(&bad_ofmsg_rl); - char *pre = log ? match_to_string(match, OFP_DEFAULT_PRIORITY) : NULL; + ops->stats.rx_packets = ntohll(ps11->rx_packets); + ops->stats.tx_packets = ntohll(ps11->tx_packets); + ops->stats.rx_bytes = ntohll(ps11->rx_bytes); + ops->stats.tx_bytes = ntohll(ps11->tx_bytes); + ops->stats.rx_dropped = ntohll(ps11->rx_dropped); + ops->stats.tx_dropped = ntohll(ps11->tx_dropped); + ops->stats.rx_errors = ntohll(ps11->rx_errors); + ops->stats.tx_errors = ntohll(ps11->tx_errors); + ops->stats.rx_frame_errors = ntohll(ps11->rx_frame_err); + ops->stats.rx_over_errors = ntohll(ps11->rx_over_err); + ops->stats.rx_crc_errors = ntohll(ps11->rx_crc_err); + ops->stats.collisions = ntohll(ps11->collisions); + ops->duration_sec = ops->duration_nsec = UINT32_MAX; - match->wc = wc; - match_zero_wildcarded_fields(match); + return 0; +} - if (log) { - char *post = match_to_string(match, OFP_DEFAULT_PRIORITY); - VLOG_INFO("normalization changed ofp_match, details:"); - VLOG_INFO(" pre: %s", pre); - VLOG_INFO("post: %s", post); - free(pre); - free(post); - } +static enum ofperr +ofputil_port_stats_from_ofp13(struct ofputil_port_stats *ops, + const struct ofp13_port_stats *ps13) +{ + enum ofperr error = ofputil_port_stats_from_ofp11(ops, &ps13->ps); + if (!error) { + ops->duration_sec = ntohl(ps13->duration_sec); + ops->duration_nsec = ntohl(ps13->duration_nsec); } + return error; } -/* "Normalizes" the wildcards in 'match'. That means: - * - * 1. If the type of level N is known, then only the valid fields for that - * level may be specified. For example, ARP does not have a TOS field, - * so nw_tos must be wildcarded if 'match' specifies an ARP flow. - * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and - * ipv6_dst (and other fields) must be wildcarded if 'match' specifies an - * IPv4 flow. - * - * 2. If the type of level N is not known (or not understood by Open - * vSwitch), then no fields at all for that level may be specified. For - * example, Open vSwitch does not understand SCTP, an L4 protocol, so the - * L4 fields tp_src and tp_dst must be wildcarded if 'match' specifies an - * SCTP flow. - * - * If this function changes 'match', it logs a rate-limited informational - * message. */ -void -ofputil_normalize_match(struct match *match) +static size_t +ofputil_get_port_stats_size(enum ofp_version ofp_version) { - ofputil_normalize_match__(match, true); + switch (ofp_version) { + case OFP10_VERSION: + return sizeof(struct ofp10_port_stats); + case OFP11_VERSION: + case OFP12_VERSION: + return sizeof(struct ofp11_port_stats); + case OFP13_VERSION: + return sizeof(struct ofp13_port_stats); + case OFP14_VERSION: + OVS_NOT_REACHED(); + return 0; + default: + OVS_NOT_REACHED(); + } } -/* Same as ofputil_normalize_match() without the logging. Thus, this function - * is suitable for a program's internal use, whereas ofputil_normalize_match() - * sense for use on flows received from elsewhere (so that a bug in the program - * that sent them can be reported and corrected). */ -void -ofputil_normalize_match_quiet(struct match *match) +/* Returns the number of port stats elements in OFPTYPE_PORT_STATS_REPLY + * message 'oh'. */ +size_t +ofputil_count_port_stats(const struct ofp_header *oh) { - ofputil_normalize_match__(match, false); + struct ofpbuf b; + + ofpbuf_use_const(&b, oh, ntohs(oh->length)); + ofpraw_pull_assert(&b); + + return ofpbuf_size(&b) / ofputil_get_port_stats_size(oh->version); } -/* Parses a key or a key-value pair from '*stringp'. +/* Converts an OFPST_PORT_STATS reply in 'msg' into an abstract + * ofputil_port_stats in 'ps'. * - * On success: Stores the key into '*keyp'. Stores the value, if present, into - * '*valuep', otherwise an empty string. Advances '*stringp' past the end of - * the key-value pair, preparing it for another call. '*keyp' and '*valuep' - * are substrings of '*stringp' created by replacing some of its bytes by null - * terminators. Returns true. + * Multiple OFPST_PORT_STATS replies can be packed into a single OpenFlow + * message. Calling this function multiple times for a single 'msg' iterates + * through the replies. The caller must initially leave 'msg''s layer pointers + * null and not modify them between calls. * - * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to - * NULL and returns false. */ -bool -ofputil_parse_key_value(char **stringp, char **keyp, char **valuep) + * Returns 0 if successful, EOF if no replies were left in this 'msg', + * otherwise a positive errno value. */ +int +ofputil_decode_port_stats(struct ofputil_port_stats *ps, struct ofpbuf *msg) { - char *pos, *key, *value; - size_t key_len; + enum ofperr error; + enum ofpraw raw; - pos = *stringp; - pos += strspn(pos, ", \t\r\n"); - if (*pos == '\0') { - *keyp = *valuep = NULL; - return false; + error = (msg->frame + ? ofpraw_decode(&raw, msg->frame) + : ofpraw_pull(&raw, msg)); + if (error) { + return error; } - key = pos; - key_len = strcspn(pos, ":=(, \t\r\n"); - if (key[key_len] == ':' || key[key_len] == '=') { - /* The value can be separated by a colon. */ - size_t value_len; - - value = key + key_len + 1; - value_len = strcspn(value, ", \t\r\n"); - pos = value + value_len + (value[value_len] != '\0'); - value[value_len] = '\0'; - } else if (key[key_len] == '(') { - /* The value can be surrounded by balanced parentheses. The outermost - * set of parentheses is removed. */ - int level = 1; - size_t value_len; + if (!ofpbuf_size(msg)) { + return EOF; + } else if (raw == OFPRAW_OFPST13_PORT_REPLY) { + const struct ofp13_port_stats *ps13; - value = key + key_len + 1; - for (value_len = 0; level > 0; value_len++) { - switch (value[value_len]) { - case '\0': - level = 0; - break; + ps13 = ofpbuf_try_pull(msg, sizeof *ps13); + if (!ps13) { + goto bad_len; + } + return ofputil_port_stats_from_ofp13(ps, ps13); + } else if (raw == OFPRAW_OFPST11_PORT_REPLY) { + const struct ofp11_port_stats *ps11; - case '(': - level++; - break; + ps11 = ofpbuf_try_pull(msg, sizeof *ps11); + if (!ps11) { + goto bad_len; + } + return ofputil_port_stats_from_ofp11(ps, ps11); + } else if (raw == OFPRAW_OFPST10_PORT_REPLY) { + const struct ofp10_port_stats *ps10; - case ')': - level--; - break; - } + ps10 = ofpbuf_try_pull(msg, sizeof *ps10); + if (!ps10) { + goto bad_len; } - value[value_len - 1] = '\0'; - pos = value + value_len; + return ofputil_port_stats_from_ofp10(ps, ps10); } else { - /* There might be no value at all. */ - value = key + key_len; /* Will become the empty string below. */ - pos = key + key_len + (key[key_len] != '\0'); + OVS_NOT_REACHED(); } - key[key_len] = '\0'; - *stringp = pos; - *keyp = key; - *valuep = value; - return true; + bad_len: + VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_PORT reply has %"PRIu32" leftover " + "bytes at end", ofpbuf_size(msg)); + return OFPERR_OFPBRC_BAD_LEN; } -/* Encode a dump ports request for 'port', the encoded message - * will be for Open Flow version 'ofp_version'. Returns message - * as a struct ofpbuf. Returns encoded message on success, NULL on error */ +/* Parse a port status request message into a 16 bit OpenFlow 1.0 + * port number and stores the latter in '*ofp10_port'. + * Returns 0 if successful, otherwise an OFPERR_* number. */ +enum ofperr +ofputil_decode_port_stats_request(const struct ofp_header *request, + ofp_port_t *ofp10_port) +{ + switch ((enum ofp_version)request->version) { + case OFP13_VERSION: + case OFP12_VERSION: + case OFP11_VERSION: { + const struct ofp11_port_stats_request *psr11 = ofpmsg_body(request); + return ofputil_port_from_ofp11(psr11->port_no, ofp10_port); + } + + case OFP10_VERSION: { + const struct ofp10_port_stats_request *psr10 = ofpmsg_body(request); + *ofp10_port = u16_to_ofp(ntohs(psr10->port_no)); + return 0; + } + + case OFP14_VERSION: + OVS_NOT_REACHED(); + break; + + default: + OVS_NOT_REACHED(); + } +} + +/* Frees all of the "struct ofputil_bucket"s in the 'buckets' list. */ +void +ofputil_bucket_list_destroy(struct list *buckets) +{ + struct ofputil_bucket *bucket, *next_bucket; + + LIST_FOR_EACH_SAFE (bucket, next_bucket, list_node, buckets) { + list_remove(&bucket->list_node); + free(bucket->ofpacts); + free(bucket); + } +} + +/* Returns an OpenFlow group stats request for OpenFlow version 'ofp_version', + * that requests stats for group 'group_id'. (Use OFPG_ALL to request stats + * for all groups.) + * + * Group statistics include packet and byte counts for each group. */ struct ofpbuf * -ofputil_encode_dump_ports_request(enum ofp_version ofp_version, ofp_port_t port) +ofputil_encode_group_stats_request(enum ofp_version ofp_version, + uint32_t group_id) { struct ofpbuf *request; switch (ofp_version) { - case OFP10_VERSION: { - struct ofp10_port_stats_request *req; - request = ofpraw_alloc(OFPRAW_OFPST10_PORT_REQUEST, ofp_version, 0); + case OFP10_VERSION: + ovs_fatal(0, "dump-group-stats needs OpenFlow 1.1 or later " + "(\'-O OpenFlow11\')"); + case OFP11_VERSION: + case OFP12_VERSION: + case OFP13_VERSION: + case OFP14_VERSION: { + struct ofp11_group_stats_request *req; + request = ofpraw_alloc(OFPRAW_OFPST11_GROUP_REQUEST, ofp_version, 0); req = ofpbuf_put_zeros(request, sizeof *req); - req->port_no = htons(ofp_to_u16(port)); + req->group_id = htonl(group_id); break; } + default: + OVS_NOT_REACHED(); + } + + return request; +} + +/* Returns an OpenFlow group description request for OpenFlow version + * 'ofp_version', that requests stats for group 'group_id'. (Use OFPG_ALL to + * request stats for all groups.) + * + * Group descriptions include the bucket and action configuration for each + * group. */ +struct ofpbuf * +ofputil_encode_group_desc_request(enum ofp_version ofp_version) +{ + struct ofpbuf *request; + + switch (ofp_version) { + case OFP10_VERSION: + ovs_fatal(0, "dump-groups needs OpenFlow 1.1 or later " + "(\'-O OpenFlow11\')"); case OFP11_VERSION: case OFP12_VERSION: - case OFP13_VERSION: { - struct ofp11_port_stats_request *req; - request = ofpraw_alloc(OFPRAW_OFPST11_PORT_REQUEST, ofp_version, 0); - req = ofpbuf_put_zeros(request, sizeof *req); - req->port_no = ofputil_port_to_ofp11(port); + case OFP13_VERSION: + case OFP14_VERSION: + request = ofpraw_alloc(OFPRAW_OFPST11_GROUP_DESC_REQUEST, ofp_version, 0); break; - } default: - NOT_REACHED(); + OVS_NOT_REACHED(); } return request; } static void -ofputil_port_stats_to_ofp10(const struct ofputil_port_stats *ops, - struct ofp10_port_stats *ps10) +ofputil_group_stats_to_ofp11__(const struct ofputil_group_stats *gs, + struct ofp11_group_stats *gs11, size_t length, + struct ofp11_bucket_counter bucket_cnts[]) { - ps10->port_no = htons(ofp_to_u16(ops->port_no)); - memset(ps10->pad, 0, sizeof ps10->pad); - put_32aligned_be64(&ps10->rx_packets, htonll(ops->stats.rx_packets)); - put_32aligned_be64(&ps10->tx_packets, htonll(ops->stats.tx_packets)); - put_32aligned_be64(&ps10->rx_bytes, htonll(ops->stats.rx_bytes)); - put_32aligned_be64(&ps10->tx_bytes, htonll(ops->stats.tx_bytes)); - put_32aligned_be64(&ps10->rx_dropped, htonll(ops->stats.rx_dropped)); - put_32aligned_be64(&ps10->tx_dropped, htonll(ops->stats.tx_dropped)); - put_32aligned_be64(&ps10->rx_errors, htonll(ops->stats.rx_errors)); - put_32aligned_be64(&ps10->tx_errors, htonll(ops->stats.tx_errors)); - put_32aligned_be64(&ps10->rx_frame_err, htonll(ops->stats.rx_frame_errors)); - put_32aligned_be64(&ps10->rx_over_err, htonll(ops->stats.rx_over_errors)); - put_32aligned_be64(&ps10->rx_crc_err, htonll(ops->stats.rx_crc_errors)); - put_32aligned_be64(&ps10->collisions, htonll(ops->stats.collisions)); + int i; + + memset(gs11, 0, length); + gs11->length = htons(length); + gs11->group_id = htonl(gs->group_id); + gs11->ref_count = htonl(gs->ref_count); + gs11->packet_count = htonll(gs->packet_count); + gs11->byte_count = htonll(gs->byte_count); + + for (i = 0; i < gs->n_buckets; i++) { + bucket_cnts[i].packet_count = htonll(gs->bucket_stats[i].packet_count); + bucket_cnts[i].byte_count = htonll(gs->bucket_stats[i].byte_count); + } } static void -ofputil_port_stats_to_ofp11(const struct ofputil_port_stats *ops, - struct ofp11_port_stats *ps11) +ofputil_group_stats_to_ofp11(const struct ofputil_group_stats *gs, + struct ofp11_group_stats *gs11, size_t length) { - ps11->port_no = ofputil_port_to_ofp11(ops->port_no); - memset(ps11->pad, 0, sizeof ps11->pad); - ps11->rx_packets = htonll(ops->stats.rx_packets); - ps11->tx_packets = htonll(ops->stats.tx_packets); - ps11->rx_bytes = htonll(ops->stats.rx_bytes); - ps11->tx_bytes = htonll(ops->stats.tx_bytes); - ps11->rx_dropped = htonll(ops->stats.rx_dropped); - ps11->tx_dropped = htonll(ops->stats.tx_dropped); - ps11->rx_errors = htonll(ops->stats.rx_errors); - ps11->tx_errors = htonll(ops->stats.tx_errors); - ps11->rx_frame_err = htonll(ops->stats.rx_frame_errors); - ps11->rx_over_err = htonll(ops->stats.rx_over_errors); - ps11->rx_crc_err = htonll(ops->stats.rx_crc_errors); - ps11->collisions = htonll(ops->stats.collisions); + ofputil_group_stats_to_ofp11__(gs, gs11, length, gs11->bucket_stats); } static void -ofputil_port_stats_to_ofp13(const struct ofputil_port_stats *ops, - struct ofp13_port_stats *ps13) +ofputil_group_stats_to_ofp13(const struct ofputil_group_stats *gs, + struct ofp13_group_stats *gs13, size_t length) { - ofputil_port_stats_to_ofp11(ops, &ps13->ps); - ps13->duration_sec = htonl(ops->duration_sec); - ps13->duration_nsec = htonl(ops->duration_nsec); + ofputil_group_stats_to_ofp11__(gs, &gs13->gs, length, gs13->bucket_stats); + gs13->duration_sec = htonl(gs->duration_sec); + gs13->duration_nsec = htonl(gs->duration_nsec); } - -/* Encode a ports stat for 'ops' and append it to 'replies'. */ +/* Encodes 'gs' properly for the format of the list of group statistics + * replies already begun in 'replies' and appends it to the list. 'replies' + * must have originally been initialized with ofpmp_init(). */ void -ofputil_append_port_stat(struct list *replies, - const struct ofputil_port_stats *ops) +ofputil_append_group_stats(struct list *replies, + const struct ofputil_group_stats *gs) { struct ofpbuf *msg = ofpbuf_from_list(list_back(replies)); - struct ofp_header *oh = msg->data; + struct ofp_header *oh = ofpbuf_data(msg); + size_t length; - switch ((enum ofp_version)oh->version) { - case OFP13_VERSION: { - struct ofp13_port_stats *reply = ofpmp_append(replies, sizeof *reply); - ofputil_port_stats_to_ofp13(ops, reply); - break; + switch ((enum ofp_version) oh->version) { + case OFP11_VERSION: + case OFP12_VERSION:{ + struct ofp11_group_stats *reply; + + length = gs->n_buckets * sizeof reply->bucket_stats[0] + + sizeof *reply; + reply = ofpmp_append(replies, length); + ofputil_group_stats_to_ofp11(gs, reply, length); + break; + } + + case OFP13_VERSION: + case OFP14_VERSION:{ + struct ofp13_group_stats *reply; + + length = gs->n_buckets * sizeof reply->bucket_stats[0] + + sizeof *reply; + reply = ofpmp_append(replies, length); + ofputil_group_stats_to_ofp13(gs, reply, length); + break; + } + + case OFP10_VERSION: + default: + OVS_NOT_REACHED(); } +} +/* Returns an OpenFlow group features request for OpenFlow version + * 'ofp_version'. */ +struct ofpbuf * +ofputil_encode_group_features_request(enum ofp_version ofp_version) +{ + struct ofpbuf *request = NULL; + + switch (ofp_version) { + case OFP10_VERSION: + case OFP11_VERSION: + ovs_fatal(0, "dump-group-features needs OpenFlow 1.2 or later " + "(\'-O OpenFlow12\')"); case OFP12_VERSION: - case OFP11_VERSION: { - struct ofp11_port_stats *reply = ofpmp_append(replies, sizeof *reply); - ofputil_port_stats_to_ofp11(ops, reply); + case OFP13_VERSION: + case OFP14_VERSION: + request = ofpraw_alloc(OFPRAW_OFPST12_GROUP_FEATURES_REQUEST, + ofp_version, 0); break; + default: + OVS_NOT_REACHED(); } - case OFP10_VERSION: { - struct ofp10_port_stats *reply = ofpmp_append(replies, sizeof *reply); - ofputil_port_stats_to_ofp10(ops, reply); - break; - } + return request; +} - default: - NOT_REACHED(); - } +/* Returns a OpenFlow message that encodes 'features' properly as a reply to + * group features request 'request'. */ +struct ofpbuf * +ofputil_encode_group_features_reply( + const struct ofputil_group_features *features, + const struct ofp_header *request) +{ + struct ofp12_group_features_stats *ogf; + struct ofpbuf *reply; + + reply = ofpraw_alloc_xid(OFPRAW_OFPST12_GROUP_FEATURES_REPLY, + request->version, request->xid, 0); + ogf = ofpbuf_put_zeros(reply, sizeof *ogf); + ogf->types = htonl(features->types); + ogf->capabilities = htonl(features->capabilities); + ogf->max_groups[0] = htonl(features->max_groups[0]); + ogf->max_groups[1] = htonl(features->max_groups[1]); + ogf->max_groups[2] = htonl(features->max_groups[2]); + ogf->max_groups[3] = htonl(features->max_groups[3]); + ogf->actions[0] = htonl(features->actions[0]); + ogf->actions[1] = htonl(features->actions[1]); + ogf->actions[2] = htonl(features->actions[2]); + ogf->actions[3] = htonl(features->actions[3]); + + return reply; } -static enum ofperr -ofputil_port_stats_from_ofp10(struct ofputil_port_stats *ops, - const struct ofp10_port_stats *ps10) +/* Decodes group features reply 'oh' into 'features'. */ +void +ofputil_decode_group_features_reply(const struct ofp_header *oh, + struct ofputil_group_features *features) { - memset(ops, 0, sizeof *ops); + const struct ofp12_group_features_stats *ogf = ofpmsg_body(oh); - ops->port_no = u16_to_ofp(ntohs(ps10->port_no)); - ops->stats.rx_packets = ntohll(get_32aligned_be64(&ps10->rx_packets)); - ops->stats.tx_packets = ntohll(get_32aligned_be64(&ps10->tx_packets)); - ops->stats.rx_bytes = ntohll(get_32aligned_be64(&ps10->rx_bytes)); - ops->stats.tx_bytes = ntohll(get_32aligned_be64(&ps10->tx_bytes)); - ops->stats.rx_dropped = ntohll(get_32aligned_be64(&ps10->rx_dropped)); - ops->stats.tx_dropped = ntohll(get_32aligned_be64(&ps10->tx_dropped)); - ops->stats.rx_errors = ntohll(get_32aligned_be64(&ps10->rx_errors)); - ops->stats.tx_errors = ntohll(get_32aligned_be64(&ps10->tx_errors)); - ops->stats.rx_frame_errors = - ntohll(get_32aligned_be64(&ps10->rx_frame_err)); - ops->stats.rx_over_errors = ntohll(get_32aligned_be64(&ps10->rx_over_err)); - ops->stats.rx_crc_errors = ntohll(get_32aligned_be64(&ps10->rx_crc_err)); - ops->stats.collisions = ntohll(get_32aligned_be64(&ps10->collisions)); - ops->duration_sec = ops->duration_nsec = UINT32_MAX; + features->types = ntohl(ogf->types); + features->capabilities = ntohl(ogf->capabilities); + features->max_groups[0] = ntohl(ogf->max_groups[0]); + features->max_groups[1] = ntohl(ogf->max_groups[1]); + features->max_groups[2] = ntohl(ogf->max_groups[2]); + features->max_groups[3] = ntohl(ogf->max_groups[3]); + features->actions[0] = ntohl(ogf->actions[0]); + features->actions[1] = ntohl(ogf->actions[1]); + features->actions[2] = ntohl(ogf->actions[2]); + features->actions[3] = ntohl(ogf->actions[3]); +} +/* Parse a group status request message into a 32 bit OpenFlow 1.1 + * group ID and stores the latter in '*group_id'. + * Returns 0 if successful, otherwise an OFPERR_* number. */ +enum ofperr +ofputil_decode_group_stats_request(const struct ofp_header *request, + uint32_t *group_id) +{ + const struct ofp11_group_stats_request *gsr11 = ofpmsg_body(request); + *group_id = ntohl(gsr11->group_id); return 0; } -static enum ofperr -ofputil_port_stats_from_ofp11(struct ofputil_port_stats *ops, - const struct ofp11_port_stats *ps11) +/* Converts a group stats reply in 'msg' into an abstract ofputil_group_stats + * in 'gs'. Assigns freshly allocated memory to gs->bucket_stats for the + * caller to eventually free. + * + * Multiple group stats replies can be packed into a single OpenFlow message. + * Calling this function multiple times for a single 'msg' iterates through the + * replies. The caller must initially leave 'msg''s layer pointers null and + * not modify them between calls. + * + * Returns 0 if successful, EOF if no replies were left in this 'msg', + * otherwise a positive errno value. */ +int +ofputil_decode_group_stats_reply(struct ofpbuf *msg, + struct ofputil_group_stats *gs) { + struct ofp11_bucket_counter *obc; + struct ofp11_group_stats *ogs11; + enum ofpraw raw; enum ofperr error; + size_t base_len; + size_t length; + size_t i; - memset(ops, 0, sizeof *ops); - error = ofputil_port_from_ofp11(ps11->port_no, &ops->port_no); + gs->bucket_stats = NULL; + error = (msg->frame + ? ofpraw_decode(&raw, msg->frame) + : ofpraw_pull(&raw, msg)); if (error) { return error; } - ops->stats.rx_packets = ntohll(ps11->rx_packets); - ops->stats.tx_packets = ntohll(ps11->tx_packets); - ops->stats.rx_bytes = ntohll(ps11->rx_bytes); - ops->stats.tx_bytes = ntohll(ps11->tx_bytes); - ops->stats.rx_dropped = ntohll(ps11->rx_dropped); - ops->stats.tx_dropped = ntohll(ps11->tx_dropped); - ops->stats.rx_errors = ntohll(ps11->rx_errors); - ops->stats.tx_errors = ntohll(ps11->tx_errors); - ops->stats.rx_frame_errors = ntohll(ps11->rx_frame_err); - ops->stats.rx_over_errors = ntohll(ps11->rx_over_err); - ops->stats.rx_crc_errors = ntohll(ps11->rx_crc_err); - ops->stats.collisions = ntohll(ps11->collisions); - ops->duration_sec = ops->duration_nsec = UINT32_MAX; + if (!ofpbuf_size(msg)) { + return EOF; + } - return 0; -} + if (raw == OFPRAW_OFPST11_GROUP_REPLY) { + base_len = sizeof *ogs11; + ogs11 = ofpbuf_try_pull(msg, sizeof *ogs11); + gs->duration_sec = gs->duration_nsec = UINT32_MAX; + } else if (raw == OFPRAW_OFPST13_GROUP_REPLY) { + struct ofp13_group_stats *ogs13; -static enum ofperr -ofputil_port_stats_from_ofp13(struct ofputil_port_stats *ops, - const struct ofp13_port_stats *ps13) -{ - enum ofperr error = ofputil_port_stats_from_ofp11(ops, &ps13->ps); - if (!error) { - ops->duration_sec = ntohl(ps13->duration_sec); - ops->duration_nsec = ntohl(ps13->duration_nsec); + base_len = sizeof *ogs13; + ogs13 = ofpbuf_try_pull(msg, sizeof *ogs13); + if (ogs13) { + ogs11 = &ogs13->gs; + gs->duration_sec = ntohl(ogs13->duration_sec); + gs->duration_nsec = ntohl(ogs13->duration_nsec); + } else { + ogs11 = NULL; + } + } else { + OVS_NOT_REACHED(); } - return error; + + if (!ogs11) { + VLOG_WARN_RL(&bad_ofmsg_rl, "%s reply has %"PRIu32" leftover bytes at end", + ofpraw_get_name(raw), ofpbuf_size(msg)); + return OFPERR_OFPBRC_BAD_LEN; + } + length = ntohs(ogs11->length); + if (length < sizeof base_len) { + VLOG_WARN_RL(&bad_ofmsg_rl, "%s reply claims invalid length %"PRIuSIZE, + ofpraw_get_name(raw), length); + return OFPERR_OFPBRC_BAD_LEN; + } + + gs->group_id = ntohl(ogs11->group_id); + gs->ref_count = ntohl(ogs11->ref_count); + gs->packet_count = ntohll(ogs11->packet_count); + gs->byte_count = ntohll(ogs11->byte_count); + + gs->n_buckets = (length - base_len) / sizeof *obc; + obc = ofpbuf_try_pull(msg, gs->n_buckets * sizeof *obc); + if (!obc) { + VLOG_WARN_RL(&bad_ofmsg_rl, "%s reply has %"PRIu32" leftover bytes at end", + ofpraw_get_name(raw), ofpbuf_size(msg)); + return OFPERR_OFPBRC_BAD_LEN; + } + + gs->bucket_stats = xmalloc(gs->n_buckets * sizeof *gs->bucket_stats); + for (i = 0; i < gs->n_buckets; i++) { + gs->bucket_stats[i].packet_count = ntohll(obc[i].packet_count); + gs->bucket_stats[i].byte_count = ntohll(obc[i].byte_count); + } + + return 0; } -static size_t -ofputil_get_port_stats_size(enum ofp_version ofp_version) +/* Appends a group stats reply that contains the data in 'gds' to those already + * present in the list of ofpbufs in 'replies'. 'replies' should have been + * initialized with ofpmp_init(). */ +void +ofputil_append_group_desc_reply(const struct ofputil_group_desc *gds, + struct list *buckets, + struct list *replies) { - switch (ofp_version) { - case OFP10_VERSION: - return sizeof(struct ofp10_port_stats); - case OFP11_VERSION: - case OFP12_VERSION: - return sizeof(struct ofp11_port_stats); - case OFP13_VERSION: - return sizeof(struct ofp13_port_stats); - default: - NOT_REACHED(); - } + struct ofpbuf *reply = ofpbuf_from_list(list_back(replies)); + struct ofp11_group_desc_stats *ogds; + struct ofputil_bucket *bucket; + size_t start_ogds; + enum ofp_version version = ((struct ofp_header *)ofpbuf_data(reply))->version; + + start_ogds = ofpbuf_size(reply); + ofpbuf_put_zeros(reply, sizeof *ogds); + LIST_FOR_EACH (bucket, list_node, buckets) { + struct ofp11_bucket *ob; + size_t start_ob; + + start_ob = ofpbuf_size(reply); + ofpbuf_put_zeros(reply, sizeof *ob); + ofpacts_put_openflow_actions(bucket->ofpacts, bucket->ofpacts_len, + reply, version); + ob = ofpbuf_at_assert(reply, start_ob, sizeof *ob); + ob->len = htons(ofpbuf_size(reply) - start_ob); + ob->weight = htons(bucket->weight); + ob->watch_port = ofputil_port_to_ofp11(bucket->watch_port); + ob->watch_group = htonl(bucket->watch_group); + } + ogds = ofpbuf_at_assert(reply, start_ogds, sizeof *ogds); + ogds->length = htons(ofpbuf_size(reply) - start_ogds); + ogds->type = gds->type; + ogds->group_id = htonl(gds->group_id); + + ofpmp_postappend(replies, start_ogds); } -/* Returns the number of port stats elements in OFPTYPE_PORT_STATS_REPLY - * message 'oh'. */ -size_t -ofputil_count_port_stats(const struct ofp_header *oh) +static enum ofperr +ofputil_pull_buckets(struct ofpbuf *msg, size_t buckets_length, + enum ofp_version version, struct list *buckets) { - struct ofpbuf b; + struct ofp11_bucket *ob; - ofpbuf_use_const(&b, oh, ntohs(oh->length)); - ofpraw_pull_assert(&b); + list_init(buckets); + while (buckets_length > 0) { + struct ofputil_bucket *bucket; + struct ofpbuf ofpacts; + enum ofperr error; + size_t ob_len; + + ob = (buckets_length >= sizeof *ob + ? ofpbuf_try_pull(msg, sizeof *ob) + : NULL); + if (!ob) { + VLOG_WARN_RL(&bad_ofmsg_rl, "buckets end with %"PRIuSIZE" leftover bytes", + buckets_length); + } + + ob_len = ntohs(ob->len); + if (ob_len < sizeof *ob) { + VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket length " + "%"PRIuSIZE" is not valid", ob_len); + return OFPERR_OFPGMFC_BAD_BUCKET; + } else if (ob_len > buckets_length) { + VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket length " + "%"PRIuSIZE" exceeds remaining buckets data size %"PRIuSIZE, + ob_len, buckets_length); + return OFPERR_OFPGMFC_BAD_BUCKET; + } + buckets_length -= ob_len; + + ofpbuf_init(&ofpacts, 0); + error = ofpacts_pull_openflow_actions(msg, ob_len - sizeof *ob, + version, &ofpacts); + if (error) { + ofpbuf_uninit(&ofpacts); + ofputil_bucket_list_destroy(buckets); + return error; + } + + bucket = xzalloc(sizeof *bucket); + bucket->weight = ntohs(ob->weight); + error = ofputil_port_from_ofp11(ob->watch_port, &bucket->watch_port); + if (error) { + ofpbuf_uninit(&ofpacts); + ofputil_bucket_list_destroy(buckets); + return OFPERR_OFPGMFC_BAD_WATCH; + } + bucket->watch_group = ntohl(ob->watch_group); + bucket->ofpacts = ofpbuf_steal_data(&ofpacts); + bucket->ofpacts_len = ofpbuf_size(&ofpacts); + list_push_back(buckets, &bucket->list_node); + } - return b.size / ofputil_get_port_stats_size(oh->version); + return 0; } -/* Converts an OFPST_PORT_STATS reply in 'msg' into an abstract - * ofputil_port_stats in 'ps'. +/* Converts a group description reply in 'msg' into an abstract + * ofputil_group_desc in 'gd'. * - * Multiple OFPST_PORT_STATS replies can be packed into a single OpenFlow + * Multiple group description replies can be packed into a single OpenFlow * message. Calling this function multiple times for a single 'msg' iterates * through the replies. The caller must initially leave 'msg''s layer pointers * null and not modify them between calls. @@ -5233,78 +6629,148 @@ ofputil_count_port_stats(const struct ofp_header *oh) * Returns 0 if successful, EOF if no replies were left in this 'msg', * otherwise a positive errno value. */ int -ofputil_decode_port_stats(struct ofputil_port_stats *ps, struct ofpbuf *msg) +ofputil_decode_group_desc_reply(struct ofputil_group_desc *gd, + struct ofpbuf *msg, enum ofp_version version) { - enum ofperr error; - enum ofpraw raw; + struct ofp11_group_desc_stats *ogds; + size_t length; - error = (msg->l2 - ? ofpraw_decode(&raw, msg->l2) - : ofpraw_pull(&raw, msg)); - if (error) { - return error; + if (!msg->frame) { + ofpraw_pull_assert(msg); } - if (!msg->size) { + if (!ofpbuf_size(msg)) { return EOF; - } else if (raw == OFPRAW_OFPST13_PORT_REPLY) { - const struct ofp13_port_stats *ps13; + } - ps13 = ofpbuf_try_pull(msg, sizeof *ps13); - if (!ps13) { - goto bad_len; - } - return ofputil_port_stats_from_ofp13(ps, ps13); - } else if (raw == OFPRAW_OFPST11_PORT_REPLY) { - const struct ofp11_port_stats *ps11; + ogds = ofpbuf_try_pull(msg, sizeof *ogds); + if (!ogds) { + VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply has %"PRIu32" " + "leftover bytes at end", ofpbuf_size(msg)); + return OFPERR_OFPBRC_BAD_LEN; + } + gd->type = ogds->type; + gd->group_id = ntohl(ogds->group_id); - ps11 = ofpbuf_try_pull(msg, sizeof *ps11); - if (!ps11) { - goto bad_len; + length = ntohs(ogds->length); + if (length < sizeof *ogds || length - sizeof *ogds > ofpbuf_size(msg)) { + VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply claims invalid " + "length %"PRIuSIZE, length); + return OFPERR_OFPBRC_BAD_LEN; + } + + return ofputil_pull_buckets(msg, length - sizeof *ogds, version, + &gd->buckets); +} + +/* Converts abstract group mod 'gm' into a message for OpenFlow version + * 'ofp_version' and returns the message. */ +struct ofpbuf * +ofputil_encode_group_mod(enum ofp_version ofp_version, + const struct ofputil_group_mod *gm) +{ + struct ofpbuf *b; + struct ofp11_group_mod *ogm; + size_t start_ogm; + size_t start_bucket; + struct ofputil_bucket *bucket; + struct ofp11_bucket *ob; + + switch (ofp_version) { + case OFP10_VERSION: { + if (gm->command == OFPGC11_ADD) { + ovs_fatal(0, "add-group needs OpenFlow 1.1 or later " + "(\'-O OpenFlow11\')"); + } else if (gm->command == OFPGC11_MODIFY) { + ovs_fatal(0, "mod-group needs OpenFlow 1.1 or later " + "(\'-O OpenFlow11\')"); + } else { + ovs_fatal(0, "del-groups needs OpenFlow 1.1 or later " + "(\'-O OpenFlow11\')"); } - return ofputil_port_stats_from_ofp11(ps, ps11); - } else if (raw == OFPRAW_OFPST10_PORT_REPLY) { - const struct ofp10_port_stats *ps10; + } - ps10 = ofpbuf_try_pull(msg, sizeof *ps10); - if (!ps10) { - goto bad_len; + case OFP11_VERSION: + case OFP12_VERSION: + case OFP13_VERSION: + case OFP14_VERSION: + b = ofpraw_alloc(OFPRAW_OFPT11_GROUP_MOD, ofp_version, 0); + start_ogm = ofpbuf_size(b); + ofpbuf_put_zeros(b, sizeof *ogm); + + LIST_FOR_EACH (bucket, list_node, &gm->buckets) { + start_bucket = ofpbuf_size(b); + ofpbuf_put_zeros(b, sizeof *ob); + if (bucket->ofpacts && bucket->ofpacts_len) { + ofpacts_put_openflow_actions(bucket->ofpacts, + bucket->ofpacts_len, b, + ofp_version); + } + ob = ofpbuf_at_assert(b, start_bucket, sizeof *ob); + ob->len = htons(ofpbuf_size(b) - start_bucket);; + ob->weight = htons(bucket->weight); + ob->watch_port = ofputil_port_to_ofp11(bucket->watch_port); + ob->watch_group = htonl(bucket->watch_group); } - return ofputil_port_stats_from_ofp10(ps, ps10); - } else { - NOT_REACHED(); + ogm = ofpbuf_at_assert(b, start_ogm, sizeof *ogm); + ogm->command = htons(gm->command); + ogm->type = gm->type; + ogm->group_id = htonl(gm->group_id); + + break; + + default: + OVS_NOT_REACHED(); } - bad_len: - VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_PORT reply has %zu leftover " - "bytes at end", msg->size); - return OFPERR_OFPBRC_BAD_LEN; + return b; } -/* Parse a port status request message into a 16 bit OpenFlow 1.0 - * port number and stores the latter in '*ofp10_port'. - * Returns 0 if successful, otherwise an OFPERR_* number. */ +/* Converts OpenFlow group mod message 'oh' into an abstract group mod in + * 'gm'. Returns 0 if successful, otherwise an OpenFlow error code. */ enum ofperr -ofputil_decode_port_stats_request(const struct ofp_header *request, - ofp_port_t *ofp10_port) +ofputil_decode_group_mod(const struct ofp_header *oh, + struct ofputil_group_mod *gm) { - switch ((enum ofp_version)request->version) { - case OFP13_VERSION: - case OFP12_VERSION: - case OFP11_VERSION: { - const struct ofp11_port_stats_request *psr11 = ofpmsg_body(request); - return ofputil_port_from_ofp11(psr11->port_no, ofp10_port); - } + const struct ofp11_group_mod *ogm; + struct ofpbuf msg; + struct ofputil_bucket *bucket; + enum ofperr err; - case OFP10_VERSION: { - const struct ofp10_port_stats_request *psr10 = ofpmsg_body(request); - *ofp10_port = u16_to_ofp(ntohs(psr10->port_no)); - return 0; + ofpbuf_use_const(&msg, oh, ntohs(oh->length)); + ofpraw_pull_assert(&msg); + + ogm = ofpbuf_pull(&msg, sizeof *ogm); + gm->command = ntohs(ogm->command); + gm->type = ogm->type; + gm->group_id = ntohl(ogm->group_id); + + err = ofputil_pull_buckets(&msg, ofpbuf_size(&msg), oh->version, &gm->buckets); + if (err) { + return err; } - default: - NOT_REACHED(); + LIST_FOR_EACH (bucket, list_node, &gm->buckets) { + switch (gm->type) { + case OFPGT11_ALL: + case OFPGT11_INDIRECT: + if (ofputil_bucket_has_liveness(bucket)) { + return OFPERR_OFPGMFC_WATCH_UNSUPPORTED; + } + break; + case OFPGT11_SELECT: + break; + case OFPGT11_FF: + if (!ofputil_bucket_has_liveness(bucket)) { + return OFPERR_OFPGMFC_INVALID_GROUP; + } + break; + default: + OVS_NOT_REACHED(); + } } + + return 0; } /* Parse a queue status request message into 'oqsr'. @@ -5314,6 +6780,7 @@ ofputil_decode_queue_stats_request(const struct ofp_header *request, struct ofputil_queue_stats_request *oqsr) { switch ((enum ofp_version)request->version) { + case OFP14_VERSION: case OFP13_VERSION: case OFP12_VERSION: case OFP11_VERSION: { @@ -5334,7 +6801,7 @@ ofputil_decode_queue_stats_request(const struct ofp_header *request, } default: - NOT_REACHED(); + OVS_NOT_REACHED(); } } @@ -5350,7 +6817,8 @@ ofputil_encode_queue_stats_request(enum ofp_version ofp_version, switch (ofp_version) { case OFP11_VERSION: case OFP12_VERSION: - case OFP13_VERSION: { + case OFP13_VERSION: + case OFP14_VERSION: { struct ofp11_queue_stats_request *req; request = ofpraw_alloc(OFPRAW_OFPST11_QUEUE_REQUEST, ofp_version, 0); req = ofpbuf_put_zeros(request, sizeof *req); @@ -5369,7 +6837,7 @@ ofputil_encode_queue_stats_request(enum ofp_version ofp_version, break; } default: - NOT_REACHED(); + OVS_NOT_REACHED(); } return request; @@ -5386,8 +6854,11 @@ ofputil_get_queue_stats_size(enum ofp_version ofp_version) return sizeof(struct ofp11_queue_stats); case OFP13_VERSION: return sizeof(struct ofp13_queue_stats); + case OFP14_VERSION: + OVS_NOT_REACHED(); + return 0; default: - NOT_REACHED(); + OVS_NOT_REACHED(); } } @@ -5401,7 +6872,7 @@ ofputil_count_queue_stats(const struct ofp_header *oh) ofpbuf_use_const(&b, oh, ntohs(oh->length)); ofpraw_pull_assert(&b); - return b.size / ofputil_get_queue_stats_size(oh->version); + return ofpbuf_size(&b) / ofputil_get_queue_stats_size(oh->version); } static enum ofperr @@ -5467,14 +6938,14 @@ ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg) enum ofperr error; enum ofpraw raw; - error = (msg->l2 - ? ofpraw_decode(&raw, msg->l2) + error = (msg->frame + ? ofpraw_decode(&raw, msg->frame) : ofpraw_pull(&raw, msg)); if (error) { return error; } - if (!msg->size) { + if (!ofpbuf_size(msg)) { return EOF; } else if (raw == OFPRAW_OFPST13_QUEUE_REPLY) { const struct ofp13_queue_stats *qs13; @@ -5501,12 +6972,12 @@ ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg) } return ofputil_queue_stats_from_ofp10(qs, qs10); } else { - NOT_REACHED(); + OVS_NOT_REACHED(); } bad_len: - VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_QUEUE reply has %zu leftover " - "bytes at end", msg->size); + VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_QUEUE reply has %"PRIu32" leftover " + "bytes at end", ofpbuf_size(msg)); return OFPERR_OFPBRC_BAD_LEN; } @@ -5542,8 +7013,8 @@ ofputil_queue_stats_to_ofp13(const struct ofputil_queue_stats *oqs, qs13->duration_sec = htonl(oqs->duration_sec); qs13->duration_nsec = htonl(oqs->duration_nsec); } else { - qs13->duration_sec = htonl(UINT32_MAX); - qs13->duration_nsec = htonl(UINT32_MAX); + qs13->duration_sec = OVS_BE32_MAX; + qs13->duration_nsec = OVS_BE32_MAX; } } @@ -5553,7 +7024,7 @@ ofputil_append_queue_stat(struct list *replies, const struct ofputil_queue_stats *oqs) { struct ofpbuf *msg = ofpbuf_from_list(list_back(replies)); - struct ofp_header *oh = msg->data; + struct ofp_header *oh = ofpbuf_data(msg); switch ((enum ofp_version)oh->version) { case OFP13_VERSION: { @@ -5575,7 +7046,91 @@ ofputil_append_queue_stat(struct list *replies, break; } + case OFP14_VERSION: + OVS_NOT_REACHED(); + break; + default: - NOT_REACHED(); + OVS_NOT_REACHED(); + } +} + +enum ofperr +ofputil_decode_bundle_ctrl(const struct ofp_header *oh, + struct ofputil_bundle_ctrl_msg *msg) +{ + struct ofpbuf b; + enum ofpraw raw; + const struct ofp14_bundle_ctrl_msg *m; + + ofpbuf_use_const(&b, oh, ntohs(oh->length)); + raw = ofpraw_pull_assert(&b); + ovs_assert(raw == OFPRAW_OFPT14_BUNDLE_CONTROL); + + m = ofpbuf_l3(&b); + msg->bundle_id = ntohl(m->bundle_id); + msg->type = ntohs(m->type); + msg->flags = ntohs(m->flags); + + return 0; +} + +struct ofpbuf * +ofputil_encode_bundle_ctrl_reply(const struct ofp_header *oh, + struct ofputil_bundle_ctrl_msg *msg) +{ + struct ofpbuf *buf; + struct ofp14_bundle_ctrl_msg *m; + + buf = ofpraw_alloc_reply(OFPRAW_OFPT14_BUNDLE_CONTROL, oh, 0); + m = ofpbuf_put_zeros(buf, sizeof *m); + + m->bundle_id = htonl(msg->bundle_id); + m->type = htons(msg->type); + m->flags = htons(msg->flags); + + return buf; +} + +enum ofperr +ofputil_decode_bundle_add(const struct ofp_header *oh, + struct ofputil_bundle_add_msg *msg) +{ + const struct ofp14_bundle_ctrl_msg *m; + struct ofpbuf b; + enum ofpraw raw; + size_t inner_len; + + ofpbuf_use_const(&b, oh, ntohs(oh->length)); + raw = ofpraw_pull_assert(&b); + ovs_assert(raw == OFPRAW_OFPT14_BUNDLE_ADD_MESSAGE); + + m = ofpbuf_pull(&b, sizeof *m); + msg->bundle_id = ntohl(m->bundle_id); + msg->flags = ntohs(m->flags); + + msg->msg = ofpbuf_data(&b); + inner_len = ntohs(msg->msg->length); + if (inner_len < sizeof(struct ofp_header) || inner_len > ofpbuf_size(&b)) { + return OFPERR_OFPBFC_MSG_BAD_LEN; } + + return 0; +} + +struct ofpbuf * +ofputil_encode_bundle_add(enum ofp_version ofp_version, + struct ofputil_bundle_add_msg *msg) +{ + struct ofpbuf *request; + struct ofp14_bundle_ctrl_msg *m; + + request = ofpraw_alloc(OFPRAW_OFPT14_BUNDLE_ADD_MESSAGE, ofp_version, 0); + m = ofpbuf_put_zeros(request, sizeof *m); + + m->bundle_id = htonl(msg->bundle_id); + m->flags = htons(msg->flags); + ofpbuf_put(request, msg->msg, ntohs(msg->msg->length)); + + return request; }