X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fofp-util.c;h=4e28b511425126a46dbc3160d7a5d67d62713769;hb=6c0386119d614d5e26ca08cc3d8e527806b87ef9;hp=8721b191d811ded83bd3d283e8dde21e2410f5c4;hpb=5e9d0469fcaa30f4de0209392a1329b4c52d8d63;p=sliver-openvswitch.git diff --git a/lib/ofp-util.c b/lib/ofp-util.c index 8721b191d..4e28b5114 100644 --- a/lib/ofp-util.c +++ b/lib/ofp-util.c @@ -1,5 +1,5 @@ /* - * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks. + * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira Networks. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -18,13 +18,19 @@ #include "ofp-print.h" #include #include +#include +#include #include #include #include "autopath.h" +#include "bundle.h" #include "byte-order.h" #include "classifier.h" #include "dynamic-string.h" +#include "learn.h" #include "multipath.h" +#include "meta-flow.h" +#include "netdev.h" #include "nx-match.h" #include "ofp-errors.h" #include "ofp-util.h" @@ -58,22 +64,12 @@ ofputil_wcbits_to_netmask(int wcbits) } /* Given the IP netmask 'netmask', returns the number of bits of the IP address - * that it wildcards. 'netmask' must be a CIDR netmask (see ip_is_cidr()). */ + * that it wildcards, that is, the number of 0-bits in 'netmask'. 'netmask' + * must be a CIDR netmask (see ip_is_cidr()). */ int ofputil_netmask_to_wcbits(ovs_be32 netmask) { - assert(ip_is_cidr(netmask)); -#if __GNUC__ >= 4 - return netmask == htonl(0) ? 32 : __builtin_ctz(ntohl(netmask)); -#else - int wcbits; - - for (wcbits = 32; netmask; wcbits--) { - netmask &= netmask - 1; - } - - return wcbits; -#endif + return 32 - ip_count_cidr_bits(netmask); } /* A list of the FWW_* and OFPFW_ bits that have the same value, meaning, and @@ -83,9 +79,7 @@ ofputil_netmask_to_wcbits(ovs_be32 netmask) WC_INVARIANT_BIT(DL_SRC) \ WC_INVARIANT_BIT(DL_DST) \ WC_INVARIANT_BIT(DL_TYPE) \ - WC_INVARIANT_BIT(NW_PROTO) \ - WC_INVARIANT_BIT(TP_SRC) \ - WC_INVARIANT_BIT(TP_DST) + WC_INVARIANT_BIT(NW_PROTO) /* Verify that all of the invariant bits (as defined on WC_INVARIANT_LIST) * actually have the same names and values. */ @@ -107,19 +101,32 @@ static const flow_wildcards_t WC_INVARIANTS = 0 void ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *wc) { + BUILD_ASSERT_DECL(FLOW_WC_SEQ == 8); + /* Initialize most of rule->wc. */ flow_wildcards_init_catchall(wc); wc->wildcards = (OVS_FORCE flow_wildcards_t) ofpfw & WC_INVARIANTS; /* Wildcard fields that aren't defined by ofp_match or tun_id. */ - wc->wildcards |= (FWW_ARP_SHA | FWW_ARP_THA | FWW_ND_TARGET); + wc->wildcards |= (FWW_ARP_SHA | FWW_ARP_THA | FWW_NW_ECN | FWW_NW_TTL + | FWW_ND_TARGET | FWW_IPV6_LABEL); if (ofpfw & OFPFW_NW_TOS) { - wc->wildcards |= FWW_NW_TOS; + /* OpenFlow 1.0 defines a TOS wildcard, but it's much later in + * the enum than we can use. */ + wc->wildcards |= FWW_NW_DSCP; } + wc->nw_src_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW_NW_SRC_SHIFT); wc->nw_dst_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW_NW_DST_SHIFT); + if (!(ofpfw & OFPFW_TP_SRC)) { + wc->tp_src_mask = htons(UINT16_MAX); + } + if (!(ofpfw & OFPFW_TP_DST)) { + wc->tp_dst_mask = htons(UINT16_MAX); + } + if (ofpfw & OFPFW_DL_DST) { /* OpenFlow 1.0 OFPFW_DL_DST covers the whole Ethernet destination, but * Open vSwitch breaks the Ethernet destination into bits as FWW_DL_DST @@ -157,7 +164,7 @@ ofputil_cls_rule_from_match(const struct ofp_match *match, rule->flow.tp_dst = match->tp_dst; memcpy(rule->flow.dl_src, match->dl_src, ETH_ADDR_LEN); memcpy(rule->flow.dl_dst, match->dl_dst, ETH_ADDR_LEN); - rule->flow.nw_tos = match->nw_tos; + rule->flow.nw_tos = match->nw_tos & IP_DSCP_MASK; rule->flow.nw_proto = match->nw_proto; /* Translate VLANs. */ @@ -196,9 +203,15 @@ ofputil_cls_rule_to_match(const struct cls_rule *rule, struct ofp_match *match) ofpfw = (OVS_FORCE uint32_t) (wc->wildcards & WC_INVARIANTS); ofpfw |= ofputil_netmask_to_wcbits(wc->nw_src_mask) << OFPFW_NW_SRC_SHIFT; ofpfw |= ofputil_netmask_to_wcbits(wc->nw_dst_mask) << OFPFW_NW_DST_SHIFT; - if (wc->wildcards & FWW_NW_TOS) { + if (wc->wildcards & FWW_NW_DSCP) { ofpfw |= OFPFW_NW_TOS; } + if (!wc->tp_src_mask) { + ofpfw |= OFPFW_TP_SRC; + } + if (!wc->tp_dst_mask) { + ofpfw |= OFPFW_TP_DST; + } /* Translate VLANs. */ match->dl_vlan = htons(0); @@ -230,7 +243,7 @@ ofputil_cls_rule_to_match(const struct cls_rule *rule, struct ofp_match *match) match->dl_type = ofputil_dl_type_to_openflow(rule->flow.dl_type); match->nw_src = rule->flow.nw_src; match->nw_dst = rule->flow.nw_dst; - match->nw_tos = rule->flow.nw_tos; + match->nw_tos = rule->flow.nw_tos & IP_DSCP_MASK; match->nw_proto = rule->flow.nw_proto; match->tp_src = rule->flow.tp_src; match->tp_dst = rule->flow.tp_dst; @@ -271,6 +284,7 @@ alloc_xid(void) struct ofputil_msg_type { enum ofputil_msg_code code; /* OFPUTIL_*. */ + uint8_t ofp_version; /* An OpenFlow version or 0 for "any". */ uint32_t value; /* OFPT_*, OFPST_*, NXT_*, or NXST_*. */ const char *name; /* e.g. "OFPT_FLOW_REMOVED". */ unsigned int min_size; /* Minimum total message size in bytes. */ @@ -279,63 +293,64 @@ struct ofputil_msg_type { unsigned int extra_multiple; }; +/* Represents a malformed OpenFlow message. */ +static const struct ofputil_msg_type ofputil_invalid_type = { + OFPUTIL_MSG_INVALID, 0, 0, "OFPUTIL_MSG_INVALID", 0, 0 +}; + struct ofputil_msg_category { const char *name; /* e.g. "OpenFlow message" */ const struct ofputil_msg_type *types; size_t n_types; - int missing_error; /* ofp_mkerr() value for missing type. */ + enum ofperr missing_error; /* Error value for missing type. */ }; -static bool -ofputil_length_ok(const struct ofputil_msg_category *cat, - const struct ofputil_msg_type *type, - unsigned int size) +static enum ofperr +ofputil_check_length(const struct ofputil_msg_type *type, unsigned int size) { switch (type->extra_multiple) { case 0: if (size != type->min_size) { - VLOG_WARN_RL(&bad_ofmsg_rl, "received %s %s with incorrect " + VLOG_WARN_RL(&bad_ofmsg_rl, "received %s with incorrect " "length %u (expected length %u)", - cat->name, type->name, size, type->min_size); - return false; + type->name, size, type->min_size); + return OFPERR_OFPBRC_BAD_LEN; } - return true; + return 0; case 1: if (size < type->min_size) { - VLOG_WARN_RL(&bad_ofmsg_rl, "received %s %s with incorrect " + VLOG_WARN_RL(&bad_ofmsg_rl, "received %s with incorrect " "length %u (expected length at least %u bytes)", - cat->name, type->name, size, type->min_size); - return false; + type->name, size, type->min_size); + return OFPERR_OFPBRC_BAD_LEN; } - return true; + return 0; default: if (size < type->min_size || (size - type->min_size) % type->extra_multiple) { - VLOG_WARN_RL(&bad_ofmsg_rl, "received %s %s with incorrect " + VLOG_WARN_RL(&bad_ofmsg_rl, "received %s with incorrect " "length %u (must be exactly %u bytes or longer " "by an integer multiple of %u bytes)", - cat->name, type->name, size, + type->name, size, type->min_size, type->extra_multiple); - return false; + return OFPERR_OFPBRC_BAD_LEN; } - return true; + return 0; } } -static int +static enum ofperr ofputil_lookup_openflow_message(const struct ofputil_msg_category *cat, - uint32_t value, unsigned int size, + uint8_t version, uint32_t value, const struct ofputil_msg_type **typep) { const struct ofputil_msg_type *type; for (type = cat->types; type < &cat->types[cat->n_types]; type++) { - if (type->value == value) { - if (!ofputil_length_ok(cat, type, size)) { - return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN); - } + if (type->value == value + && (!type->ofp_version || version == type->ofp_version)) { *typep = type; return 0; } @@ -346,98 +361,134 @@ ofputil_lookup_openflow_message(const struct ofputil_msg_category *cat, return cat->missing_error; } -static int -ofputil_decode_vendor(const struct ofp_header *oh, +static enum ofperr +ofputil_decode_vendor(const struct ofp_header *oh, size_t length, const struct ofputil_msg_type **typep) { - BUILD_ASSERT_DECL(sizeof(struct nxt_set_flow_format) - != sizeof(struct nxt_flow_mod_table_id)); - static const struct ofputil_msg_type nxt_messages[] = { - { OFPUTIL_NXT_ROLE_REQUEST, + { OFPUTIL_NXT_ROLE_REQUEST, OFP10_VERSION, NXT_ROLE_REQUEST, "NXT_ROLE_REQUEST", sizeof(struct nx_role_request), 0 }, - { OFPUTIL_NXT_ROLE_REPLY, + { OFPUTIL_NXT_ROLE_REPLY, OFP10_VERSION, NXT_ROLE_REPLY, "NXT_ROLE_REPLY", sizeof(struct nx_role_request), 0 }, - { OFPUTIL_NXT_SET_FLOW_FORMAT, + { OFPUTIL_NXT_SET_FLOW_FORMAT, OFP10_VERSION, NXT_SET_FLOW_FORMAT, "NXT_SET_FLOW_FORMAT", - sizeof(struct nxt_set_flow_format), 0 }, + sizeof(struct nx_set_flow_format), 0 }, - { OFPUTIL_NXT_FLOW_MOD, + { OFPUTIL_NXT_SET_PACKET_IN_FORMAT, OFP10_VERSION, + NXT_SET_PACKET_IN_FORMAT, "NXT_SET_PACKET_IN_FORMAT", + sizeof(struct nx_set_packet_in_format), 0 }, + + { OFPUTIL_NXT_PACKET_IN, OFP10_VERSION, + NXT_PACKET_IN, "NXT_PACKET_IN", + sizeof(struct nx_packet_in), 1 }, + + { OFPUTIL_NXT_FLOW_MOD, OFP10_VERSION, NXT_FLOW_MOD, "NXT_FLOW_MOD", sizeof(struct nx_flow_mod), 8 }, - { OFPUTIL_NXT_FLOW_REMOVED, + { OFPUTIL_NXT_FLOW_REMOVED, OFP10_VERSION, NXT_FLOW_REMOVED, "NXT_FLOW_REMOVED", sizeof(struct nx_flow_removed), 8 }, - { OFPUTIL_NXT_FLOW_MOD_TABLE_ID, + { OFPUTIL_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION, NXT_FLOW_MOD_TABLE_ID, "NXT_FLOW_MOD_TABLE_ID", - sizeof(struct nxt_flow_mod_table_id), 0 }, + sizeof(struct nx_flow_mod_table_id), 0 }, + + { OFPUTIL_NXT_FLOW_AGE, OFP10_VERSION, + NXT_FLOW_AGE, "NXT_FLOW_AGE", + sizeof(struct nicira_header), 0 }, + + { OFPUTIL_NXT_SET_ASYNC_CONFIG, OFP10_VERSION, + NXT_SET_ASYNC_CONFIG, "NXT_SET_ASYNC_CONFIG", + sizeof(struct nx_async_config), 0 }, + + { OFPUTIL_NXT_SET_CONTROLLER_ID, OFP10_VERSION, + NXT_SET_CONTROLLER_ID, "NXT_SET_CONTROLLER_ID", + sizeof(struct nx_controller_id), 0 }, }; static const struct ofputil_msg_category nxt_category = { "Nicira extension message", nxt_messages, ARRAY_SIZE(nxt_messages), - OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE) + OFPERR_OFPBRC_BAD_SUBTYPE }; const struct ofp_vendor_header *ovh; const struct nicira_header *nh; + if (length < sizeof(struct ofp_vendor_header)) { + if (length == ntohs(oh->length)) { + VLOG_WARN_RL(&bad_ofmsg_rl, "truncated vendor message"); + } + return OFPERR_OFPBRC_BAD_LEN; + } + ovh = (const struct ofp_vendor_header *) oh; if (ovh->vendor != htonl(NX_VENDOR_ID)) { VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor message for unknown " "vendor %"PRIx32, ntohl(ovh->vendor)); - return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR); + return OFPERR_OFPBRC_BAD_VENDOR; } - if (ntohs(ovh->header.length) < sizeof(struct nicira_header)) { - VLOG_WARN_RL(&bad_ofmsg_rl, "received Nicira vendor message of " - "length %u (expected at least %zu)", - ntohs(ovh->header.length), sizeof(struct nicira_header)); - return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN); + if (length < sizeof(struct nicira_header)) { + if (length == ntohs(oh->length)) { + VLOG_WARN_RL(&bad_ofmsg_rl, "received Nicira vendor message of " + "length %u (expected at least %zu)", + ntohs(ovh->header.length), + sizeof(struct nicira_header)); + } + return OFPERR_OFPBRC_BAD_LEN; } nh = (const struct nicira_header *) oh; - return ofputil_lookup_openflow_message(&nxt_category, ntohl(nh->subtype), - ntohs(oh->length), typep); + return ofputil_lookup_openflow_message(&nxt_category, oh->version, + ntohl(nh->subtype), typep); } -static int -check_nxstats_msg(const struct ofp_header *oh) +static enum ofperr +check_nxstats_msg(const struct ofp_header *oh, size_t length) { const struct ofp_stats_msg *osm = (const struct ofp_stats_msg *) oh; ovs_be32 vendor; + if (length < sizeof(struct ofp_vendor_stats_msg)) { + if (length == ntohs(oh->length)) { + VLOG_WARN_RL(&bad_ofmsg_rl, "truncated vendor stats message"); + } + return OFPERR_OFPBRC_BAD_LEN; + } + memcpy(&vendor, osm + 1, sizeof vendor); if (vendor != htonl(NX_VENDOR_ID)) { VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor stats message for " "unknown vendor %"PRIx32, ntohl(vendor)); - return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR); + return OFPERR_OFPBRC_BAD_VENDOR; } - if (ntohs(osm->header.length) < sizeof(struct nicira_stats_msg)) { - VLOG_WARN_RL(&bad_ofmsg_rl, "truncated Nicira stats message"); - return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN); + if (length < sizeof(struct nicira_stats_msg)) { + if (length == ntohs(osm->header.length)) { + VLOG_WARN_RL(&bad_ofmsg_rl, "truncated Nicira stats message"); + } + return OFPERR_OFPBRC_BAD_LEN; } return 0; } -static int -ofputil_decode_nxst_request(const struct ofp_header *oh, +static enum ofperr +ofputil_decode_nxst_request(const struct ofp_header *oh, size_t length, const struct ofputil_msg_type **typep) { static const struct ofputil_msg_type nxst_requests[] = { - { OFPUTIL_NXST_FLOW_REQUEST, + { OFPUTIL_NXST_FLOW_REQUEST, OFP10_VERSION, NXST_FLOW, "NXST_FLOW request", sizeof(struct nx_flow_stats_request), 8 }, - { OFPUTIL_NXST_AGGREGATE_REQUEST, + { OFPUTIL_NXST_AGGREGATE_REQUEST, OFP10_VERSION, NXST_AGGREGATE, "NXST_AGGREGATE request", sizeof(struct nx_aggregate_stats_request), 8 }, }; @@ -445,33 +496,32 @@ ofputil_decode_nxst_request(const struct ofp_header *oh, static const struct ofputil_msg_category nxst_request_category = { "Nicira extension statistics request", nxst_requests, ARRAY_SIZE(nxst_requests), - OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE) + OFPERR_OFPBRC_BAD_SUBTYPE }; const struct nicira_stats_msg *nsm; - int error; + enum ofperr error; - error = check_nxstats_msg(oh); + error = check_nxstats_msg(oh, length); if (error) { return error; } nsm = (struct nicira_stats_msg *) oh; - return ofputil_lookup_openflow_message(&nxst_request_category, - ntohl(nsm->subtype), - ntohs(oh->length), typep); + return ofputil_lookup_openflow_message(&nxst_request_category, oh->version, + ntohl(nsm->subtype), typep); } -static int -ofputil_decode_nxst_reply(const struct ofp_header *oh, +static enum ofperr +ofputil_decode_nxst_reply(const struct ofp_header *oh, size_t length, const struct ofputil_msg_type **typep) { static const struct ofputil_msg_type nxst_replies[] = { - { OFPUTIL_NXST_FLOW_REPLY, + { OFPUTIL_NXST_FLOW_REPLY, OFP10_VERSION, NXST_FLOW, "NXST_FLOW reply", sizeof(struct nicira_stats_msg), 8 }, - { OFPUTIL_NXST_AGGREGATE_REPLY, + { OFPUTIL_NXST_AGGREGATE_REPLY, OFP10_VERSION, NXST_AGGREGATE, "NXST_AGGREGATE reply", sizeof(struct nx_aggregate_stats_reply), 0 }, }; @@ -479,53 +529,65 @@ ofputil_decode_nxst_reply(const struct ofp_header *oh, static const struct ofputil_msg_category nxst_reply_category = { "Nicira extension statistics reply", nxst_replies, ARRAY_SIZE(nxst_replies), - OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE) + OFPERR_OFPBRC_BAD_SUBTYPE }; const struct nicira_stats_msg *nsm; - int error; + enum ofperr error; - error = check_nxstats_msg(oh); + error = check_nxstats_msg(oh, length); if (error) { return error; } nsm = (struct nicira_stats_msg *) oh; - return ofputil_lookup_openflow_message(&nxst_reply_category, - ntohl(nsm->subtype), - ntohs(oh->length), typep); + return ofputil_lookup_openflow_message(&nxst_reply_category, oh->version, + ntohl(nsm->subtype), typep); +} + +static enum ofperr +check_stats_msg(const struct ofp_header *oh, size_t length) +{ + if (length < sizeof(struct ofp_stats_msg)) { + if (length == ntohs(oh->length)) { + VLOG_WARN_RL(&bad_ofmsg_rl, "truncated stats message"); + } + return OFPERR_OFPBRC_BAD_LEN; + } + + return 0; } -static int -ofputil_decode_ofpst_request(const struct ofp_header *oh, +static enum ofperr +ofputil_decode_ofpst_request(const struct ofp_header *oh, size_t length, const struct ofputil_msg_type **typep) { static const struct ofputil_msg_type ofpst_requests[] = { - { OFPUTIL_OFPST_DESC_REQUEST, + { OFPUTIL_OFPST_DESC_REQUEST, OFP10_VERSION, OFPST_DESC, "OFPST_DESC request", sizeof(struct ofp_stats_msg), 0 }, - { OFPUTIL_OFPST_FLOW_REQUEST, + { OFPUTIL_OFPST_FLOW_REQUEST, OFP10_VERSION, OFPST_FLOW, "OFPST_FLOW request", sizeof(struct ofp_flow_stats_request), 0 }, - { OFPUTIL_OFPST_AGGREGATE_REQUEST, + { OFPUTIL_OFPST_AGGREGATE_REQUEST, OFP10_VERSION, OFPST_AGGREGATE, "OFPST_AGGREGATE request", sizeof(struct ofp_flow_stats_request), 0 }, - { OFPUTIL_OFPST_TABLE_REQUEST, + { OFPUTIL_OFPST_TABLE_REQUEST, OFP10_VERSION, OFPST_TABLE, "OFPST_TABLE request", sizeof(struct ofp_stats_msg), 0 }, - { OFPUTIL_OFPST_PORT_REQUEST, + { OFPUTIL_OFPST_PORT_REQUEST, OFP10_VERSION, OFPST_PORT, "OFPST_PORT request", sizeof(struct ofp_port_stats_request), 0 }, - { OFPUTIL_OFPST_QUEUE_REQUEST, + { OFPUTIL_OFPST_QUEUE_REQUEST, OFP10_VERSION, OFPST_QUEUE, "OFPST_QUEUE request", sizeof(struct ofp_queue_stats_request), 0 }, - { 0, + { 0, 0, OFPST_VENDOR, "OFPST_VENDOR request", sizeof(struct ofp_vendor_stats_msg), 1 }, }; @@ -533,51 +595,56 @@ ofputil_decode_ofpst_request(const struct ofp_header *oh, static const struct ofputil_msg_category ofpst_request_category = { "OpenFlow statistics", ofpst_requests, ARRAY_SIZE(ofpst_requests), - OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT) + OFPERR_OFPBRC_BAD_STAT }; const struct ofp_stats_msg *request = (const struct ofp_stats_msg *) oh; - int error; + enum ofperr error; + + error = check_stats_msg(oh, length); + if (error) { + return error; + } error = ofputil_lookup_openflow_message(&ofpst_request_category, - ntohs(request->type), - ntohs(oh->length), typep); + oh->version, ntohs(request->type), + typep); if (!error && request->type == htons(OFPST_VENDOR)) { - error = ofputil_decode_nxst_request(oh, typep); + error = ofputil_decode_nxst_request(oh, length, typep); } return error; } -static int -ofputil_decode_ofpst_reply(const struct ofp_header *oh, +static enum ofperr +ofputil_decode_ofpst_reply(const struct ofp_header *oh, size_t length, const struct ofputil_msg_type **typep) { static const struct ofputil_msg_type ofpst_replies[] = { - { OFPUTIL_OFPST_DESC_REPLY, + { OFPUTIL_OFPST_DESC_REPLY, OFP10_VERSION, OFPST_DESC, "OFPST_DESC reply", sizeof(struct ofp_desc_stats), 0 }, - { OFPUTIL_OFPST_FLOW_REPLY, + { OFPUTIL_OFPST_FLOW_REPLY, OFP10_VERSION, OFPST_FLOW, "OFPST_FLOW reply", sizeof(struct ofp_stats_msg), 1 }, - { OFPUTIL_OFPST_AGGREGATE_REPLY, + { OFPUTIL_OFPST_AGGREGATE_REPLY, OFP10_VERSION, OFPST_AGGREGATE, "OFPST_AGGREGATE reply", sizeof(struct ofp_aggregate_stats_reply), 0 }, - { OFPUTIL_OFPST_TABLE_REPLY, + { OFPUTIL_OFPST_TABLE_REPLY, OFP10_VERSION, OFPST_TABLE, "OFPST_TABLE reply", sizeof(struct ofp_stats_msg), sizeof(struct ofp_table_stats) }, - { OFPUTIL_OFPST_PORT_REPLY, + { OFPUTIL_OFPST_PORT_REPLY, OFP10_VERSION, OFPST_PORT, "OFPST_PORT reply", sizeof(struct ofp_stats_msg), sizeof(struct ofp_port_stats) }, - { OFPUTIL_OFPST_QUEUE_REPLY, + { OFPUTIL_OFPST_QUEUE_REPLY, OFP10_VERSION, OFPST_QUEUE, "OFPST_QUEUE reply", sizeof(struct ofp_stats_msg), sizeof(struct ofp_queue_stats) }, - { 0, + { 0, 0, OFPST_VENDOR, "OFPST_VENDOR reply", sizeof(struct ofp_vendor_stats_msg), 1 }, }; @@ -585,113 +652,107 @@ ofputil_decode_ofpst_reply(const struct ofp_header *oh, static const struct ofputil_msg_category ofpst_reply_category = { "OpenFlow statistics", ofpst_replies, ARRAY_SIZE(ofpst_replies), - OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT) + OFPERR_OFPBRC_BAD_STAT }; const struct ofp_stats_msg *reply = (const struct ofp_stats_msg *) oh; - int error; + enum ofperr error; - error = ofputil_lookup_openflow_message(&ofpst_reply_category, - ntohs(reply->type), - ntohs(oh->length), typep); + error = check_stats_msg(oh, length); + if (error) { + return error; + } + + error = ofputil_lookup_openflow_message(&ofpst_reply_category, oh->version, + ntohs(reply->type), typep); if (!error && reply->type == htons(OFPST_VENDOR)) { - error = ofputil_decode_nxst_reply(oh, typep); + error = ofputil_decode_nxst_reply(oh, length, typep); } return error; } -/* Decodes the message type represented by 'oh'. Returns 0 if successful or - * an OpenFlow error code constructed with ofp_mkerr() on failure. Either - * way, stores in '*typep' a type structure that can be inspected with the - * ofputil_msg_type_*() functions. - * - * oh->length must indicate the correct length of the message (and must be at - * least sizeof(struct ofp_header)). - * - * Success indicates that 'oh' is at least as long as the minimum-length - * message of its type. */ -int -ofputil_decode_msg_type(const struct ofp_header *oh, - const struct ofputil_msg_type **typep) +static enum ofperr +ofputil_decode_msg_type__(const struct ofp_header *oh, size_t length, + const struct ofputil_msg_type **typep) { static const struct ofputil_msg_type ofpt_messages[] = { - { OFPUTIL_OFPT_HELLO, + { OFPUTIL_OFPT_HELLO, OFP10_VERSION, OFPT_HELLO, "OFPT_HELLO", sizeof(struct ofp_hello), 1 }, - { OFPUTIL_OFPT_ERROR, + { OFPUTIL_OFPT_ERROR, 0, OFPT_ERROR, "OFPT_ERROR", sizeof(struct ofp_error_msg), 1 }, - { OFPUTIL_OFPT_ECHO_REQUEST, + { OFPUTIL_OFPT_ECHO_REQUEST, OFP10_VERSION, OFPT_ECHO_REQUEST, "OFPT_ECHO_REQUEST", sizeof(struct ofp_header), 1 }, - { OFPUTIL_OFPT_ECHO_REPLY, + { OFPUTIL_OFPT_ECHO_REPLY, OFP10_VERSION, OFPT_ECHO_REPLY, "OFPT_ECHO_REPLY", sizeof(struct ofp_header), 1 }, - { OFPUTIL_OFPT_FEATURES_REQUEST, + { OFPUTIL_OFPT_FEATURES_REQUEST, OFP10_VERSION, OFPT_FEATURES_REQUEST, "OFPT_FEATURES_REQUEST", sizeof(struct ofp_header), 0 }, - { OFPUTIL_OFPT_FEATURES_REPLY, + { OFPUTIL_OFPT_FEATURES_REPLY, OFP10_VERSION, OFPT_FEATURES_REPLY, "OFPT_FEATURES_REPLY", sizeof(struct ofp_switch_features), sizeof(struct ofp_phy_port) }, - { OFPUTIL_OFPT_GET_CONFIG_REQUEST, + { OFPUTIL_OFPT_GET_CONFIG_REQUEST, OFP10_VERSION, OFPT_GET_CONFIG_REQUEST, "OFPT_GET_CONFIG_REQUEST", sizeof(struct ofp_header), 0 }, - { OFPUTIL_OFPT_GET_CONFIG_REPLY, + { OFPUTIL_OFPT_GET_CONFIG_REPLY, OFP10_VERSION, OFPT_GET_CONFIG_REPLY, "OFPT_GET_CONFIG_REPLY", sizeof(struct ofp_switch_config), 0 }, - { OFPUTIL_OFPT_SET_CONFIG, + { OFPUTIL_OFPT_SET_CONFIG, OFP10_VERSION, OFPT_SET_CONFIG, "OFPT_SET_CONFIG", sizeof(struct ofp_switch_config), 0 }, - { OFPUTIL_OFPT_PACKET_IN, + { OFPUTIL_OFPT_PACKET_IN, OFP10_VERSION, OFPT_PACKET_IN, "OFPT_PACKET_IN", offsetof(struct ofp_packet_in, data), 1 }, - { OFPUTIL_OFPT_FLOW_REMOVED, + { OFPUTIL_OFPT_FLOW_REMOVED, OFP10_VERSION, OFPT_FLOW_REMOVED, "OFPT_FLOW_REMOVED", sizeof(struct ofp_flow_removed), 0 }, - { OFPUTIL_OFPT_PORT_STATUS, + { OFPUTIL_OFPT_PORT_STATUS, OFP10_VERSION, OFPT_PORT_STATUS, "OFPT_PORT_STATUS", sizeof(struct ofp_port_status), 0 }, - { OFPUTIL_OFPT_PACKET_OUT, - OFPT_PACKET_OUT, "OFPT_PACKET_OUT", + { OFPUTIL_OFPT_PACKET_OUT, OFP10_VERSION, + OFPT10_PACKET_OUT, "OFPT_PACKET_OUT", sizeof(struct ofp_packet_out), 1 }, - { OFPUTIL_OFPT_FLOW_MOD, - OFPT_FLOW_MOD, "OFPT_FLOW_MOD", + { OFPUTIL_OFPT_FLOW_MOD, OFP10_VERSION, + OFPT10_FLOW_MOD, "OFPT_FLOW_MOD", sizeof(struct ofp_flow_mod), 1 }, - { OFPUTIL_OFPT_PORT_MOD, - OFPT_PORT_MOD, "OFPT_PORT_MOD", + { OFPUTIL_OFPT_PORT_MOD, OFP10_VERSION, + OFPT10_PORT_MOD, "OFPT_PORT_MOD", sizeof(struct ofp_port_mod), 0 }, - { 0, - OFPT_STATS_REQUEST, "OFPT_STATS_REQUEST", + { 0, OFP10_VERSION, + OFPT10_STATS_REQUEST, "OFPT_STATS_REQUEST", sizeof(struct ofp_stats_msg), 1 }, - { 0, - OFPT_STATS_REPLY, "OFPT_STATS_REPLY", + { 0, OFP10_VERSION, + OFPT10_STATS_REPLY, "OFPT_STATS_REPLY", sizeof(struct ofp_stats_msg), 1 }, - { OFPUTIL_OFPT_BARRIER_REQUEST, - OFPT_BARRIER_REQUEST, "OFPT_BARRIER_REQUEST", + { OFPUTIL_OFPT_BARRIER_REQUEST, OFP10_VERSION, + OFPT10_BARRIER_REQUEST, "OFPT_BARRIER_REQUEST", sizeof(struct ofp_header), 0 }, - { OFPUTIL_OFPT_BARRIER_REPLY, - OFPT_BARRIER_REPLY, "OFPT_BARRIER_REPLY", + { OFPUTIL_OFPT_BARRIER_REPLY, OFP10_VERSION, + OFPT10_BARRIER_REPLY, "OFPT_BARRIER_REPLY", sizeof(struct ofp_header), 0 }, - { 0, + { 0, 0, OFPT_VENDOR, "OFPT_VENDOR", sizeof(struct ofp_vendor_header), 1 }, }; @@ -699,37 +760,76 @@ ofputil_decode_msg_type(const struct ofp_header *oh, static const struct ofputil_msg_category ofpt_category = { "OpenFlow message", ofpt_messages, ARRAY_SIZE(ofpt_messages), - OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE) + OFPERR_OFPBRC_BAD_TYPE }; - int error; + enum ofperr error; - error = ofputil_lookup_openflow_message(&ofpt_category, oh->type, - ntohs(oh->length), typep); + error = ofputil_lookup_openflow_message(&ofpt_category, oh->version, + oh->type, typep); if (!error) { - switch (oh->type) { - case OFPT_VENDOR: - error = ofputil_decode_vendor(oh, typep); + switch ((oh->version << 8) | oh->type) { + case (OFP10_VERSION << 8) | OFPT_VENDOR: + case (OFP11_VERSION << 8) | OFPT_VENDOR: + error = ofputil_decode_vendor(oh, length, typep); break; - case OFPT_STATS_REQUEST: - error = ofputil_decode_ofpst_request(oh, typep); + case (OFP10_VERSION << 8) | OFPT10_STATS_REQUEST: + case (OFP11_VERSION << 8) | OFPT11_STATS_REQUEST: + error = ofputil_decode_ofpst_request(oh, length, typep); break; - case OFPT_STATS_REPLY: - error = ofputil_decode_ofpst_reply(oh, typep); + case (OFP10_VERSION << 8) | OFPT10_STATS_REPLY: + case (OFP11_VERSION << 8) | OFPT11_STATS_REPLY: + error = ofputil_decode_ofpst_reply(oh, length, typep); default: break; } } + return error; +} + +/* Decodes the message type represented by 'oh'. Returns 0 if successful or an + * OpenFlow error code on failure. Either way, stores in '*typep' a type + * structure that can be inspected with the ofputil_msg_type_*() functions. + * + * oh->length must indicate the correct length of the message (and must be at + * least sizeof(struct ofp_header)). + * + * Success indicates that 'oh' is at least as long as the minimum-length + * message of its type. */ +enum ofperr +ofputil_decode_msg_type(const struct ofp_header *oh, + const struct ofputil_msg_type **typep) +{ + size_t length = ntohs(oh->length); + enum ofperr error; + + error = ofputil_decode_msg_type__(oh, length, typep); + if (!error) { + error = ofputil_check_length(*typep, length); + } if (error) { - static const struct ofputil_msg_type ofputil_invalid_type = { - OFPUTIL_INVALID, - 0, "OFPUTIL_INVALID", - 0, 0 - }; + *typep = &ofputil_invalid_type; + } + return error; +} + +/* Decodes the message type represented by 'oh', of which only the first + * 'length' bytes are available. Returns 0 if successful or an OpenFlow error + * code on failure. Either way, stores in '*typep' a type structure that can + * be inspected with the ofputil_msg_type_*() functions. */ +enum ofperr +ofputil_decode_msg_type_partial(const struct ofp_header *oh, size_t length, + const struct ofputil_msg_type **typep) +{ + enum ofperr error; + error = (length >= sizeof *oh + ? ofputil_decode_msg_type__(oh, length, typep) + : OFPERR_OFPBRC_BAD_LEN); + if (error) { *typep = &ofputil_invalid_type; } return error; @@ -742,14 +842,256 @@ ofputil_msg_type_code(const struct ofputil_msg_type *type) return type->code; } -/* Flow formats. */ +/* Protocols. */ + +struct proto_abbrev { + enum ofputil_protocol protocol; + const char *name; +}; + +/* Most users really don't care about some of the differences between + * protocols. These abbreviations help with that. */ +static const struct proto_abbrev proto_abbrevs[] = { + { OFPUTIL_P_ANY, "any" }, + { OFPUTIL_P_OF10_ANY, "OpenFlow10" }, + { OFPUTIL_P_NXM_ANY, "NXM" }, +}; +#define N_PROTO_ABBREVS ARRAY_SIZE(proto_abbrevs) + +enum ofputil_protocol ofputil_flow_dump_protocols[] = { + OFPUTIL_P_NXM, + OFPUTIL_P_OF10, +}; +size_t ofputil_n_flow_dump_protocols = ARRAY_SIZE(ofputil_flow_dump_protocols); + +/* Returns the ofputil_protocol that is initially in effect on an OpenFlow + * connection that has negotiated the given 'version'. 'version' should + * normally be an 8-bit OpenFlow version identifier (e.g. 0x01 for OpenFlow + * 1.0, 0x02 for OpenFlow 1.1). Returns 0 if 'version' is not supported or + * outside the valid range. */ +enum ofputil_protocol +ofputil_protocol_from_ofp_version(int version) +{ + switch (version) { + case OFP10_VERSION: return OFPUTIL_P_OF10; + default: return 0; + } +} +/* Returns true if 'protocol' is a single OFPUTIL_P_* value, false + * otherwise. */ bool -ofputil_flow_format_is_valid(enum nx_flow_format flow_format) +ofputil_protocol_is_valid(enum ofputil_protocol protocol) { - switch (flow_format) { - case NXFF_OPENFLOW10: - case NXFF_NXM: + return protocol & OFPUTIL_P_ANY && is_pow2(protocol); +} + +/* Returns the equivalent of 'protocol' with the Nicira flow_mod_table_id + * extension turned on or off if 'enable' is true or false, respectively. + * + * This extension is only useful for protocols whose "standard" version does + * not allow specific tables to be modified. In particular, this is true of + * OpenFlow 1.0. In later versions of OpenFlow, a flow_mod request always + * specifies a table ID and so there is no need for such an extension. When + * 'protocol' is such a protocol that doesn't need a flow_mod_table_id + * extension, this function just returns its 'protocol' argument unchanged + * regardless of the value of 'enable'. */ +enum ofputil_protocol +ofputil_protocol_set_tid(enum ofputil_protocol protocol, bool enable) +{ + switch (protocol) { + case OFPUTIL_P_OF10: + case OFPUTIL_P_OF10_TID: + return enable ? OFPUTIL_P_OF10_TID : OFPUTIL_P_OF10; + + case OFPUTIL_P_NXM: + case OFPUTIL_P_NXM_TID: + return enable ? OFPUTIL_P_NXM_TID : OFPUTIL_P_NXM; + + default: + NOT_REACHED(); + } +} + +/* Returns the "base" version of 'protocol'. That is, if 'protocol' includes + * some extension to a standard protocol version, the return value is the + * standard version of that protocol without any extension. If 'protocol' is a + * standard protocol version, returns 'protocol' unchanged. */ +enum ofputil_protocol +ofputil_protocol_to_base(enum ofputil_protocol protocol) +{ + return ofputil_protocol_set_tid(protocol, false); +} + +/* Returns 'new_base' with any extensions taken from 'cur'. */ +enum ofputil_protocol +ofputil_protocol_set_base(enum ofputil_protocol cur, + enum ofputil_protocol new_base) +{ + bool tid = (cur & OFPUTIL_P_TID) != 0; + + switch (new_base) { + case OFPUTIL_P_OF10: + case OFPUTIL_P_OF10_TID: + return ofputil_protocol_set_tid(OFPUTIL_P_OF10, tid); + + case OFPUTIL_P_NXM: + case OFPUTIL_P_NXM_TID: + return ofputil_protocol_set_tid(OFPUTIL_P_NXM, tid); + + default: + NOT_REACHED(); + } +} + +/* Returns a string form of 'protocol', if a simple form exists (that is, if + * 'protocol' is either a single protocol or it is a combination of protocols + * that have a single abbreviation). Otherwise, returns NULL. */ +const char * +ofputil_protocol_to_string(enum ofputil_protocol protocol) +{ + const struct proto_abbrev *p; + + /* Use a "switch" statement for single-bit names so that we get a compiler + * warning if we forget any. */ + switch (protocol) { + case OFPUTIL_P_NXM: + return "NXM-table_id"; + + case OFPUTIL_P_NXM_TID: + return "NXM+table_id"; + + case OFPUTIL_P_OF10: + return "OpenFlow10-table_id"; + + case OFPUTIL_P_OF10_TID: + return "OpenFlow10+table_id"; + } + + /* Check abbreviations. */ + for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) { + if (protocol == p->protocol) { + return p->name; + } + } + + return NULL; +} + +/* Returns a string that represents 'protocols'. The return value might be a + * comma-separated list if 'protocols' doesn't have a simple name. The return + * value is "none" if 'protocols' is 0. + * + * The caller must free the returned string (with free()). */ +char * +ofputil_protocols_to_string(enum ofputil_protocol protocols) +{ + struct ds s; + + assert(!(protocols & ~OFPUTIL_P_ANY)); + if (protocols == 0) { + return xstrdup("none"); + } + + ds_init(&s); + while (protocols) { + const struct proto_abbrev *p; + int i; + + if (s.length) { + ds_put_char(&s, ','); + } + + for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) { + if ((protocols & p->protocol) == p->protocol) { + ds_put_cstr(&s, p->name); + protocols &= ~p->protocol; + goto match; + } + } + + for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) { + enum ofputil_protocol bit = 1u << i; + + if (protocols & bit) { + ds_put_cstr(&s, ofputil_protocol_to_string(bit)); + protocols &= ~bit; + goto match; + } + } + NOT_REACHED(); + + match: ; + } + return ds_steal_cstr(&s); +} + +static enum ofputil_protocol +ofputil_protocol_from_string__(const char *s, size_t n) +{ + const struct proto_abbrev *p; + int i; + + for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) { + enum ofputil_protocol bit = 1u << i; + const char *name = ofputil_protocol_to_string(bit); + + if (name && n == strlen(name) && !strncasecmp(s, name, n)) { + return bit; + } + } + + for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) { + if (n == strlen(p->name) && !strncasecmp(s, p->name, n)) { + return p->protocol; + } + } + + return 0; +} + +/* Returns the nonempty set of protocols represented by 's', which can be a + * single protocol name or abbreviation or a comma-separated list of them. + * + * Aborts the program with an error message if 's' is invalid. */ +enum ofputil_protocol +ofputil_protocols_from_string(const char *s) +{ + const char *orig_s = s; + enum ofputil_protocol protocols; + + protocols = 0; + while (*s) { + enum ofputil_protocol p; + size_t n; + + n = strcspn(s, ","); + if (n == 0) { + s++; + continue; + } + + p = ofputil_protocol_from_string__(s, n); + if (!p) { + ovs_fatal(0, "%.*s: unknown flow protocol", (int) n, s); + } + protocols |= p; + + s += n; + } + + if (!protocols) { + ovs_fatal(0, "%s: no flow protocol specified", orig_s); + } + return protocols; +} + +bool +ofputil_packet_in_format_is_valid(enum nx_packet_in_format packet_in_format) +{ + switch (packet_in_format) { + case NXPIF_OPENFLOW10: + case NXPIF_NXM: return true; } @@ -757,12 +1099,12 @@ ofputil_flow_format_is_valid(enum nx_flow_format flow_format) } const char * -ofputil_flow_format_to_string(enum nx_flow_format flow_format) +ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format) { - switch (flow_format) { - case NXFF_OPENFLOW10: + switch (packet_in_format) { + case NXPIF_OPENFLOW10: return "openflow10"; - case NXFF_NXM: + case NXPIF_NXM: return "nxm"; default: NOT_REACHED(); @@ -770,10 +1112,10 @@ ofputil_flow_format_to_string(enum nx_flow_format flow_format) } int -ofputil_flow_format_from_string(const char *s) +ofputil_packet_in_format_from_string(const char *s) { - return (!strcmp(s, "openflow10") ? NXFF_OPENFLOW10 - : !strcmp(s, "nxm") ? NXFF_NXM + return (!strcmp(s, "openflow10") ? NXPIF_OPENFLOW10 + : !strcmp(s, "nxm") ? NXPIF_NXM : -1); } @@ -790,55 +1132,182 @@ regs_fully_wildcarded(const struct flow_wildcards *wc) return true; } -/* Returns the minimum nx_flow_format to use for sending 'rule' 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 - * NXFF_OPENFLOW10 for backward compatibility. */ -enum nx_flow_format -ofputil_min_flow_format(const struct cls_rule *rule) +/* Returns a bit-mask of ofputil_protocols that can be used for sending 'rule' + * 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 cls_rule *rule) { const struct flow_wildcards *wc = &rule->wc; + BUILD_ASSERT_DECL(FLOW_WC_SEQ == 8); + /* Only NXM supports separately wildcards the Ethernet multicast bit. */ if (!(wc->wildcards & FWW_DL_DST) != !(wc->wildcards & FWW_ETH_MCAST)) { - return NXFF_NXM; + return OFPUTIL_P_NXM_ANY; } /* Only NXM supports matching ARP hardware addresses. */ if (!(wc->wildcards & FWW_ARP_SHA) || !(wc->wildcards & FWW_ARP_THA)) { - return NXFF_NXM; + return OFPUTIL_P_NXM_ANY; } /* Only NXM supports matching IPv6 traffic. */ if (!(wc->wildcards & FWW_DL_TYPE) && (rule->flow.dl_type == htons(ETH_TYPE_IPV6))) { - return NXFF_NXM; + return OFPUTIL_P_NXM_ANY; } /* Only NXM supports matching registers. */ if (!regs_fully_wildcarded(wc)) { - return NXFF_NXM; + return OFPUTIL_P_NXM_ANY; } /* Only NXM supports matching tun_id. */ if (wc->tun_id_mask != htonll(0)) { - return NXFF_NXM; + return OFPUTIL_P_NXM_ANY; + } + + /* Only NXM supports matching fragments. */ + if (wc->nw_frag_mask) { + return OFPUTIL_P_NXM_ANY; + } + + /* Only NXM supports matching IPv6 flow label. */ + if (!(wc->wildcards & FWW_IPV6_LABEL)) { + return OFPUTIL_P_NXM_ANY; + } + + /* Only NXM supports matching IP ECN bits. */ + if (!(wc->wildcards & FWW_NW_ECN)) { + return OFPUTIL_P_NXM_ANY; + } + + /* Only NXM supports matching IP TTL/hop limit. */ + if (!(wc->wildcards & FWW_NW_TTL)) { + return OFPUTIL_P_NXM_ANY; + } + + /* Only NXM supports bitwise matching on transport port. */ + if ((wc->tp_src_mask && wc->tp_src_mask != htons(UINT16_MAX)) || + (wc->tp_dst_mask && wc->tp_dst_mask != htons(UINT16_MAX))) { + return OFPUTIL_P_NXM_ANY; } /* Other formats can express this rule. */ - return NXFF_OPENFLOW10; + return OFPUTIL_P_ANY; } -/* Returns an OpenFlow message that can be used to set the flow format to - * 'flow_format'. */ +/* Returns an OpenFlow message that, sent on an OpenFlow connection whose + * protocol is 'current', at least partly transitions the protocol to 'want'. + * Stores in '*next' the protocol that will be in effect on the OpenFlow + * connection if the switch processes the returned message correctly. (If + * '*next != want' then the caller will have to iterate.) + * + * If 'current == want', returns NULL and stores 'current' in '*next'. */ +struct ofpbuf * +ofputil_encode_set_protocol(enum ofputil_protocol current, + enum ofputil_protocol want, + enum ofputil_protocol *next) +{ + enum ofputil_protocol cur_base, want_base; + bool cur_tid, want_tid; + + cur_base = ofputil_protocol_to_base(current); + want_base = ofputil_protocol_to_base(want); + if (cur_base != want_base) { + *next = ofputil_protocol_set_base(current, want_base); + + switch (want_base) { + case OFPUTIL_P_NXM: + return ofputil_encode_nx_set_flow_format(NXFF_NXM); + + case OFPUTIL_P_OF10: + return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10); + + case OFPUTIL_P_OF10_TID: + case OFPUTIL_P_NXM_TID: + NOT_REACHED(); + } + } + + cur_tid = (current & OFPUTIL_P_TID) != 0; + want_tid = (want & OFPUTIL_P_TID) != 0; + if (cur_tid != want_tid) { + *next = ofputil_protocol_set_tid(current, want_tid); + return ofputil_make_flow_mod_table_id(want_tid); + } + + assert(current == want); + + *next = current; + return NULL; +} + +/* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow + * format to 'nxff'. */ struct ofpbuf * -ofputil_make_set_flow_format(enum nx_flow_format flow_format) +ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff) { - struct nxt_set_flow_format *sff; + struct nx_set_flow_format *sff; struct ofpbuf *msg; + assert(ofputil_nx_flow_format_is_valid(nxff)); + sff = make_nxmsg(sizeof *sff, NXT_SET_FLOW_FORMAT, &msg); - sff->format = htonl(flow_format); + sff->format = htonl(nxff); + + return msg; +} + +/* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false + * otherwise. */ +enum ofputil_protocol +ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format) +{ + switch (flow_format) { + case NXFF_OPENFLOW10: + return OFPUTIL_P_OF10; + + case NXFF_NXM: + return OFPUTIL_P_NXM; + + default: + return 0; + } +} + +/* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */ +bool +ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format) +{ + return ofputil_nx_flow_format_to_protocol(flow_format) != 0; +} + +/* Returns a string version of 'flow_format', which must be a valid NXFF_* + * value. */ +const char * +ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format) +{ + switch (flow_format) { + case NXFF_OPENFLOW10: + return "openflow10"; + case NXFF_NXM: + return "nxm"; + default: + NOT_REACHED(); + } +} + +struct ofpbuf * +ofputil_make_set_packet_in_format(enum nx_packet_in_format packet_in_format) +{ + struct nx_set_packet_in_format *spif; + struct ofpbuf *msg; + + spif = make_nxmsg(sizeof *spif, NXT_SET_PACKET_IN_FORMAT, &msg); + spif->format = htonl(packet_in_format); return msg; } @@ -848,7 +1317,7 @@ ofputil_make_set_flow_format(enum nx_flow_format flow_format) struct ofpbuf * ofputil_make_flow_mod_table_id(bool flow_mod_table_id) { - struct nxt_flow_mod_table_id *nfmti; + struct nx_flow_mod_table_id *nfmti; struct ofpbuf *msg; nfmti = make_nxmsg(sizeof *nfmti, NXT_FLOW_MOD_TABLE_ID, &msg); @@ -860,13 +1329,11 @@ ofputil_make_flow_mod_table_id(bool flow_mod_table_id) * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error * code. * - * 'flow_mod_table_id' should be true if the NXT_FLOW_MOD_TABLE_ID extension is - * enabled, false otherwise. - * * Does not validate the flow_mod actions. */ -int -ofputil_decode_flow_mod(struct flow_mod *fm, const struct ofp_header *oh, - bool flow_mod_table_id) +enum ofperr +ofputil_decode_flow_mod(struct ofputil_flow_mod *fm, + const struct ofp_header *oh, + enum ofputil_protocol protocol) { const struct ofputil_msg_type *type; uint16_t command; @@ -879,7 +1346,7 @@ ofputil_decode_flow_mod(struct flow_mod *fm, const struct ofp_header *oh, /* Standard OpenFlow flow_mod. */ const struct ofp_flow_mod *ofm; uint16_t priority; - int error; + enum ofperr error; /* Dissect the message. */ ofm = ofpbuf_pull(&b, sizeof *ofm); @@ -899,10 +1366,11 @@ ofputil_decode_flow_mod(struct flow_mod *fm, const struct ofp_header *oh, /* Translate the rule. */ ofputil_cls_rule_from_match(&ofm->match, priority, &fm->cr); - ofputil_normalize_rule(&fm->cr, NXFF_OPENFLOW10); + ofputil_normalize_rule(&fm->cr); /* Translate the message. */ fm->cookie = ofm->cookie; + fm->cookie_mask = htonll(UINT64_MAX); command = ntohs(ofm->command); fm->idle_timeout = ntohs(ofm->idle_timeout); fm->hard_timeout = ntohs(ofm->hard_timeout); @@ -912,12 +1380,12 @@ ofputil_decode_flow_mod(struct flow_mod *fm, const struct ofp_header *oh, } else if (ofputil_msg_type_code(type) == OFPUTIL_NXT_FLOW_MOD) { /* Nicira extended flow_mod. */ const struct nx_flow_mod *nfm; - int error; + enum ofperr error; /* Dissect the message. */ nfm = ofpbuf_pull(&b, sizeof *nfm); error = nx_pull_match(&b, ntohs(nfm->match_len), ntohs(nfm->priority), - &fm->cr); + &fm->cr, &fm->cookie, &fm->cookie_mask); if (error) { return error; } @@ -927,8 +1395,18 @@ ofputil_decode_flow_mod(struct flow_mod *fm, const struct ofp_header *oh, } /* Translate the message. */ - fm->cookie = nfm->cookie; command = ntohs(nfm->command); + if (command == OFPFC_ADD) { + if (fm->cookie_mask) { + /* The "NXM_NX_COOKIE*" matches are not valid for flow + * additions. Additions must use the "cookie" field of + * the "nx_flow_mod" structure. */ + return OFPERR_NXBRC_NXM_INVALID; + } else { + fm->cookie = nfm->cookie; + fm->cookie_mask = htonll(UINT64_MAX); + } + } fm->idle_timeout = ntohs(nfm->idle_timeout); fm->hard_timeout = ntohs(nfm->hard_timeout); fm->buffer_id = ntohl(nfm->buffer_id); @@ -938,7 +1416,7 @@ ofputil_decode_flow_mod(struct flow_mod *fm, const struct ofp_header *oh, NOT_REACHED(); } - if (flow_mod_table_id) { + if (protocol & OFPUTIL_P_TID) { fm->command = command & 0xff; fm->table_id = command >> 8; } else { @@ -950,56 +1428,65 @@ ofputil_decode_flow_mod(struct flow_mod *fm, const struct ofp_header *oh, } /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to - * 'flow_format' and returns the message. + * 'protocol' and returns the message. * * 'flow_mod_table_id' should be true if the NXT_FLOW_MOD_TABLE_ID extension is * enabled, false otherwise. */ struct ofpbuf * -ofputil_encode_flow_mod(const struct flow_mod *fm, - enum nx_flow_format flow_format, - bool flow_mod_table_id) +ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm, + enum ofputil_protocol protocol) { size_t actions_len = fm->n_actions * sizeof *fm->actions; + struct ofp_flow_mod *ofm; + struct nx_flow_mod *nfm; struct ofpbuf *msg; uint16_t command; + int match_len; - command = (flow_mod_table_id + command = (protocol & OFPUTIL_P_TID ? (fm->command & 0xff) | (fm->table_id << 8) : fm->command); - if (flow_format == NXFF_OPENFLOW10) { - struct ofp_flow_mod *ofm; - + switch (protocol) { + case OFPUTIL_P_OF10: + case OFPUTIL_P_OF10_TID: msg = ofpbuf_new(sizeof *ofm + actions_len); - ofm = put_openflow(sizeof *ofm, OFPT_FLOW_MOD, msg); + ofm = put_openflow(sizeof *ofm, OFPT10_FLOW_MOD, msg); ofputil_cls_rule_to_match(&fm->cr, &ofm->match); ofm->cookie = fm->cookie; - ofm->command = htons(fm->command); + ofm->command = htons(command); ofm->idle_timeout = htons(fm->idle_timeout); ofm->hard_timeout = htons(fm->hard_timeout); ofm->priority = htons(fm->cr.priority); ofm->buffer_id = htonl(fm->buffer_id); ofm->out_port = htons(fm->out_port); ofm->flags = htons(fm->flags); - } else if (flow_format == NXFF_NXM) { - struct nx_flow_mod *nfm; - int match_len; + break; + case OFPUTIL_P_NXM: + case OFPUTIL_P_NXM_TID: msg = ofpbuf_new(sizeof *nfm + NXM_TYPICAL_LEN + actions_len); put_nxmsg(sizeof *nfm, NXT_FLOW_MOD, msg); - match_len = nx_put_match(msg, &fm->cr); - nfm = msg->data; - nfm->cookie = fm->cookie; nfm->command = htons(command); - nfm->idle_timeout = htons(fm->idle_timeout); + if (command == OFPFC_ADD) { + nfm->cookie = fm->cookie; + match_len = nx_put_match(msg, &fm->cr, 0, 0); + } else { + nfm->cookie = 0; + match_len = nx_put_match(msg, &fm->cr, + fm->cookie, fm->cookie_mask); + } + nfm->idle_timeout = htons(fm->idle_timeout); nfm->hard_timeout = htons(fm->hard_timeout); nfm->priority = htons(fm->cr.priority); nfm->buffer_id = htonl(fm->buffer_id); nfm->out_port = htons(fm->out_port); nfm->flags = htons(fm->flags); nfm->match_len = htons(match_len); - } else { + break; + + default: NOT_REACHED(); } @@ -1008,8 +1495,37 @@ ofputil_encode_flow_mod(const struct flow_mod *fm, return msg; } -static int -ofputil_decode_ofpst_flow_request(struct flow_stats_request *fsr, +/* 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->cr); + if (fm->table_id != 0xff) { + usable_protocols &= OFPUTIL_P_TID; + } + if (fm->command != OFPFC_ADD && fm->cookie_mask != htonll(0)) { + usable_protocols &= OFPUTIL_P_NXM_ANY; + } + } + assert(usable_protocols); + + return usable_protocols; +} + +static enum ofperr +ofputil_decode_ofpst_flow_request(struct ofputil_flow_stats_request *fsr, const struct ofp_header *oh, bool aggregate) { @@ -1020,28 +1536,30 @@ ofputil_decode_ofpst_flow_request(struct flow_stats_request *fsr, ofputil_cls_rule_from_match(&ofsr->match, 0, &fsr->match); fsr->out_port = ntohs(ofsr->out_port); fsr->table_id = ofsr->table_id; + fsr->cookie = fsr->cookie_mask = htonll(0); return 0; } -static int -ofputil_decode_nxst_flow_request(struct flow_stats_request *fsr, +static enum ofperr +ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr, const struct ofp_header *oh, bool aggregate) { const struct nx_flow_stats_request *nfsr; struct ofpbuf b; - int error; + enum ofperr error; ofpbuf_use_const(&b, oh, ntohs(oh->length)); nfsr = ofpbuf_pull(&b, sizeof *nfsr); - error = nx_pull_match(&b, ntohs(nfsr->match_len), 0, &fsr->match); + error = nx_pull_match(&b, ntohs(nfsr->match_len), 0, &fsr->match, + &fsr->cookie, &fsr->cookie_mask); if (error) { return error; } if (b.size) { - return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN); + return OFPERR_OFPBRC_BAD_LEN; } fsr->aggregate = aggregate; @@ -1054,8 +1572,8 @@ ofputil_decode_nxst_flow_request(struct flow_stats_request *fsr, /* 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. */ -int -ofputil_decode_flow_stats_request(struct flow_stats_request *fsr, +enum ofperr +ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr, const struct ofp_header *oh) { const struct ofputil_msg_type *type; @@ -1087,14 +1605,16 @@ ofputil_decode_flow_stats_request(struct flow_stats_request *fsr, /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW, * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to - * 'flow_format', and returns the message. */ + * 'protocol', and returns the message. */ struct ofpbuf * -ofputil_encode_flow_stats_request(const struct flow_stats_request *fsr, - enum nx_flow_format flow_format) +ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr, + enum ofputil_protocol protocol) { struct ofpbuf *msg; - if (flow_format == NXFF_OPENFLOW10) { + switch (protocol) { + case OFPUTIL_P_OF10: + case OFPUTIL_P_OF10_TID: { struct ofp_flow_stats_request *ofsr; int type; @@ -1103,26 +1623,51 @@ ofputil_encode_flow_stats_request(const struct flow_stats_request *fsr, ofputil_cls_rule_to_match(&fsr->match, &ofsr->match); ofsr->table_id = fsr->table_id; ofsr->out_port = htons(fsr->out_port); - } else if (flow_format == NXFF_NXM) { + break; + } + + case OFPUTIL_P_NXM: + case OFPUTIL_P_NXM_TID: { struct nx_flow_stats_request *nfsr; int match_len; int subtype; subtype = fsr->aggregate ? NXST_AGGREGATE : NXST_FLOW; ofputil_make_stats_request(sizeof *nfsr, OFPST_VENDOR, subtype, &msg); - match_len = nx_put_match(msg, &fsr->match); + match_len = nx_put_match(msg, &fsr->match, + fsr->cookie, fsr->cookie_mask); nfsr = msg->data; nfsr->out_port = htons(fsr->out_port); nfsr->match_len = htons(match_len); nfsr->table_id = fsr->table_id; - } else { + break; + } + + default: 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_NXM_ANY; + } + return usable_protocols; +} + /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract * ofputil_flow_stats in 'fs'. * @@ -1131,11 +1676,18 @@ ofputil_encode_flow_stats_request(const struct flow_stats_request *fsr, * iterates through the replies. The caller must initially leave 'msg''s layer * pointers null and not modify them between calls. * + * Most switches don't send the values needed to populate fs->idle_age and + * fs->hard_age, so those members will usually be set to 0. If the switch from + * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass + * 'flow_age_extension' as true so that the contents of 'msg' determine the + * 'idle_age' and 'hard_age' members in 'fs'. + * * Returns 0 if successful, EOF if no replies were left in this 'msg', * otherwise a positive errno value. */ int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs, - struct ofpbuf *msg) + struct ofpbuf *msg, + bool flow_age_extension) { const struct ofputil_msg_type *type; int code; @@ -1186,6 +1738,8 @@ 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->idle_age = -1; + fs->hard_age = -1; fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count)); fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count)); } else if (code == OFPUTIL_NXST_FLOW_REPLY) { @@ -1206,7 +1760,8 @@ ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs, "claims invalid length %zu", match_len, length); return EINVAL; } - if (nx_pull_match(msg, match_len, ntohs(nfs->priority), &fs->rule)) { + if (nx_pull_match(msg, match_len, ntohs(nfs->priority), &fs->rule, + NULL, NULL)) { return EINVAL; } @@ -1222,6 +1777,16 @@ ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs, fs->duration_nsec = ntohl(nfs->duration_nsec); fs->idle_timeout = ntohs(nfs->idle_timeout); fs->hard_timeout = ntohs(nfs->hard_timeout); + fs->idle_age = -1; + fs->hard_age = -1; + if (flow_age_extension) { + if (nfs->idle_age) { + fs->idle_age = ntohs(nfs->idle_age) - 1; + } + if (nfs->hard_age) { + fs->hard_age = ntohs(nfs->hard_age) - 1; + } + } fs->packet_count = ntohll(nfs->packet_count); fs->byte_count = ntohll(nfs->byte_count); } else { @@ -1290,8 +1855,13 @@ ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs, nfs->priority = htons(fs->rule.priority); nfs->idle_timeout = htons(fs->idle_timeout); nfs->hard_timeout = htons(fs->hard_timeout); - nfs->match_len = htons(nx_put_match(msg, &fs->rule)); - memset(nfs->pad2, 0, sizeof nfs->pad2); + nfs->idle_age = htons(fs->idle_age < 0 ? 0 + : fs->idle_age < UINT16_MAX ? fs->idle_age + 1 + : UINT16_MAX); + nfs->hard_age = htons(fs->hard_age < 0 ? 0 + : fs->hard_age < UINT16_MAX ? fs->hard_age + 1 + : UINT16_MAX); + nfs->match_len = htons(nx_put_match(msg, &fs->rule, 0, 0)); nfs->cookie = fs->cookie; nfs->packet_count = htonll(fs->packet_count); nfs->byte_count = htonll(fs->byte_count); @@ -1303,7 +1873,7 @@ ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs, } /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or - * NXST_AGGREGATE reply according to 'flow_format', and returns the message. */ + * NXST_AGGREGATE reply according to 'protocol', and returns the message. */ struct ofpbuf * ofputil_encode_aggregate_stats_reply( const struct ofputil_aggregate_stats *stats, @@ -1338,7 +1908,7 @@ ofputil_encode_aggregate_stats_reply( /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise * an OpenFlow error code. */ -int +enum ofperr ofputil_decode_flow_removed(struct ofputil_flow_removed *fr, const struct ofp_header *oh) { @@ -1369,12 +1939,12 @@ ofputil_decode_flow_removed(struct ofputil_flow_removed *fr, nfr = ofpbuf_pull(&b, sizeof *nfr); error = nx_pull_match(&b, ntohs(nfr->match_len), ntohs(nfr->priority), - &fr->rule); + &fr->rule, NULL, NULL); if (error) { return error; } if (b.size) { - return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN); + return OFPERR_OFPBRC_BAD_LEN; } fr->cookie = nfr->cookie; @@ -1392,15 +1962,17 @@ ofputil_decode_flow_removed(struct ofputil_flow_removed *fr, } /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or - * NXT_FLOW_REMOVED message 'oh' according to 'flow_format', and returns the + * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the * message. */ struct ofpbuf * ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr, - enum nx_flow_format flow_format) + enum ofputil_protocol protocol) { struct ofpbuf *msg; - if (flow_format == NXFF_OPENFLOW10) { + switch (protocol) { + case OFPUTIL_P_OF10: + case OFPUTIL_P_OF10_TID: { struct ofp_flow_removed *ofr; ofr = make_openflow_xid(sizeof *ofr, OFPT_FLOW_REMOVED, htonl(0), @@ -1414,12 +1986,16 @@ ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr, ofr->idle_timeout = htons(fr->idle_timeout); ofr->packet_count = htonll(unknown_to_zero(fr->packet_count)); ofr->byte_count = htonll(unknown_to_zero(fr->byte_count)); - } else if (flow_format == NXFF_NXM) { + break; + } + + case OFPUTIL_P_NXM: + case OFPUTIL_P_NXM_TID: { struct nx_flow_removed *nfr; int match_len; make_nxmsg_xid(sizeof *nfr, NXT_FLOW_REMOVED, htonl(0), &msg); - match_len = nx_put_match(msg, &fr->rule); + match_len = nx_put_match(msg, &fr->rule, 0, 0); nfr = msg->data; nfr->cookie = fr->cookie; @@ -1431,54 +2007,281 @@ ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr, nfr->match_len = htons(match_len); nfr->packet_count = htonll(fr->packet_count); nfr->byte_count = htonll(fr->byte_count); - } else { + break; + } + + default: NOT_REACHED(); } return msg; } -/* Converts abstract ofputil_packet_in 'pin' into an OFPT_PACKET_IN message - * and returns the message. - * - * If 'rw_packet' is NULL, the caller takes ownership of the newly allocated - * returned ofpbuf. - * - * If 'rw_packet' is nonnull, then it must contain the same data as - * pin->packet. 'rw_packet' is allowed to be the same ofpbuf as pin->packet. - * It is modified in-place into an OFPT_PACKET_IN message according to 'pin', - * and then ofputil_encode_packet_in() returns 'rw_packet'. If 'rw_packet' has - * enough headroom to insert a "struct ofp_packet_in", this is more efficient - * than ofputil_encode_packet_in() because it does not copy the packet - * payload. */ +int +ofputil_decode_packet_in(struct ofputil_packet_in *pin, + const struct ofp_header *oh) +{ + const struct ofputil_msg_type *type; + enum ofputil_msg_code code; + + ofputil_decode_msg_type(oh, &type); + code = ofputil_msg_type_code(type); + memset(pin, 0, sizeof *pin); + + if (code == OFPUTIL_OFPT_PACKET_IN) { + const struct ofp_packet_in *opi = (const struct ofp_packet_in *) oh; + + pin->packet = opi->data; + pin->packet_len = ntohs(opi->header.length) + - offsetof(struct ofp_packet_in, data); + + pin->fmd.in_port = ntohs(opi->in_port); + pin->reason = opi->reason; + pin->buffer_id = ntohl(opi->buffer_id); + pin->total_len = ntohs(opi->total_len); + } else if (code == OFPUTIL_NXT_PACKET_IN) { + const struct nx_packet_in *npi; + struct cls_rule rule; + struct ofpbuf b; + int error; + + ofpbuf_use_const(&b, oh, ntohs(oh->length)); + + npi = ofpbuf_pull(&b, sizeof *npi); + error = nx_pull_match_loose(&b, ntohs(npi->match_len), 0, &rule, NULL, + NULL); + if (error) { + return error; + } + + if (!ofpbuf_try_pull(&b, 2)) { + return OFPERR_OFPBRC_BAD_LEN; + } + + pin->packet = b.data; + pin->packet_len = b.size; + pin->reason = npi->reason; + pin->table_id = npi->table_id; + pin->cookie = npi->cookie; + + pin->fmd.in_port = rule.flow.in_port; + + pin->fmd.tun_id = rule.flow.tun_id; + pin->fmd.tun_id_mask = rule.wc.tun_id_mask; + + memcpy(pin->fmd.regs, rule.flow.regs, sizeof pin->fmd.regs); + memcpy(pin->fmd.reg_masks, rule.wc.reg_masks, + sizeof pin->fmd.reg_masks); + + pin->buffer_id = ntohl(npi->buffer_id); + pin->total_len = ntohs(npi->total_len); + } else { + NOT_REACHED(); + } + + return 0; +} + +/* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message + * in the format specified by 'packet_in_format'. */ struct ofpbuf * ofputil_encode_packet_in(const struct ofputil_packet_in *pin, - struct ofpbuf *rw_packet) + enum nx_packet_in_format packet_in_format) { - int total_len = pin->packet->size; - struct ofp_packet_in *opi; + size_t send_len = MIN(pin->send_len, pin->packet_len); + struct ofpbuf *packet; - if (rw_packet) { - if (pin->send_len < rw_packet->size) { - rw_packet->size = pin->send_len; + /* Add OFPT_PACKET_IN. */ + if (packet_in_format == NXPIF_OPENFLOW10) { + size_t header_len = offsetof(struct ofp_packet_in, data); + struct ofp_packet_in *opi; + + packet = ofpbuf_new(send_len + header_len); + opi = ofpbuf_put_zeros(packet, header_len); + opi->header.version = OFP10_VERSION; + opi->header.type = OFPT_PACKET_IN; + opi->total_len = htons(pin->total_len); + opi->in_port = htons(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 cls_rule rule; + size_t match_len; + size_t i; + + /* Estimate of required PACKET_IN length includes the NPI header, space + * for the match (2 times sizeof the metadata seems like enough), 2 + * bytes for padding, and the packet length. */ + packet = ofpbuf_new(sizeof *npi + sizeof(struct flow_metadata) * 2 + + 2 + send_len); + + cls_rule_init_catchall(&rule, 0); + cls_rule_set_tun_id_masked(&rule, pin->fmd.tun_id, + pin->fmd.tun_id_mask); + + for (i = 0; i < FLOW_N_REGS; i++) { + cls_rule_set_reg_masked(&rule, i, pin->fmd.regs[i], + pin->fmd.reg_masks[i]); } + + cls_rule_set_in_port(&rule, pin->fmd.in_port); + + ofpbuf_put_zeros(packet, sizeof *npi); + match_len = nx_put_match(packet, &rule, 0, 0); + ofpbuf_put_zeros(packet, 2); + ofpbuf_put(packet, pin->packet, send_len); + + npi = packet->data; + npi->nxh.header.version = OFP10_VERSION; + npi->nxh.header.type = OFPT_VENDOR; + npi->nxh.vendor = htonl(NX_VENDOR_ID); + npi->nxh.subtype = htonl(NXT_PACKET_IN); + + 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 { - rw_packet = ofpbuf_clone_data_with_headroom( - pin->packet->data, MIN(pin->send_len, pin->packet->size), - offsetof(struct ofp_packet_in, data)); + NOT_REACHED(); } + update_openflow_length(packet); - /* Add OFPT_PACKET_IN. */ - opi = ofpbuf_push_zeros(rw_packet, offsetof(struct ofp_packet_in, data)); - opi->header.version = OFP_VERSION; - opi->header.type = OFPT_PACKET_IN; - opi->total_len = htons(total_len); - opi->in_port = htons(pin->in_port); - opi->reason = pin->reason; - opi->buffer_id = htonl(pin->buffer_id); - update_openflow_length(rw_packet); + return packet; +} + +const char * +ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason) +{ + static char s[INT_STRLEN(int) + 1]; + + switch (reason) { + case OFPR_NO_MATCH: + return "no_match"; + case OFPR_ACTION: + return "action"; + case OFPR_INVALID_TTL: + return "invalid_ttl"; + + case OFPR_N_REASONS: + default: + sprintf(s, "%d", (int) reason); + return s; + } +} + +bool +ofputil_packet_in_reason_from_string(const char *s, + enum ofp_packet_in_reason *reason) +{ + int i; + + for (i = 0; i < OFPR_N_REASONS; i++) { + if (!strcasecmp(s, ofputil_packet_in_reason_to_string(i))) { + *reason = i; + return true; + } + } + return false; +} + +enum ofperr +ofputil_decode_packet_out(struct ofputil_packet_out *po, + const struct ofp_packet_out *opo) +{ + enum ofperr error; + struct ofpbuf b; + + po->buffer_id = ntohl(opo->buffer_id); + po->in_port = ntohs(opo->in_port); + if (po->in_port >= OFPP_MAX && po->in_port != OFPP_LOCAL + && po->in_port != OFPP_NONE) { + VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16, + po->in_port); + return OFPERR_NXBRC_BAD_IN_PORT; + } + + ofpbuf_use_const(&b, opo, ntohs(opo->header.length)); + ofpbuf_pull(&b, sizeof *opo); + + error = ofputil_pull_actions(&b, ntohs(opo->actions_len), + &po->actions, &po->n_actions); + if (error) { + return error; + } + + if (po->buffer_id == UINT32_MAX) { + po->packet = b.data; + po->packet_len = b.size; + } else { + po->packet = NULL; + po->packet_len = 0; + } + + return 0; +} + +/* ofputil_phy_port */ + +/* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */ +BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */ +BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */ +BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */ +BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */ +BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */ +BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */ +BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */ + +/* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */ +BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF_COPPER << 4)); +BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF_FIBER << 4)); +BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF_AUTONEG << 4)); +BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF_PAUSE << 4)); +BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF_PAUSE_ASYM << 4)); + +enum netdev_features +ofputil_netdev_port_features_from_ofp10(ovs_be32 ofp10_) +{ + uint32_t ofp10 = ntohl(ofp10_); + return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4); +} + +ovs_be32 +ofputil_netdev_port_features_to_ofp10(enum netdev_features features) +{ + return htonl((features & 0x7f) | ((features & 0xf800) >> 4)); +} + +struct ofpbuf * +ofputil_encode_packet_out(const struct ofputil_packet_out *po) +{ + struct ofp_packet_out *opo; + size_t actions_len; + struct ofpbuf *msg; + size_t size; + + actions_len = po->n_actions * sizeof *po->actions; + size = sizeof *opo + actions_len; + if (po->buffer_id == UINT32_MAX) { + size += po->packet_len; + } + + msg = ofpbuf_new(size); + opo = put_openflow(sizeof *opo, OFPT10_PACKET_OUT, msg); + opo->buffer_id = htonl(po->buffer_id); + opo->in_port = htons(po->in_port); + opo->actions_len = htons(actions_len); + ofpbuf_put(msg, po->actions, actions_len); + if (po->buffer_id == UINT32_MAX) { + ofpbuf_put(msg, po->packet, po->packet_len); + } + update_openflow_length(msg); - return rw_packet; + return msg; } /* Returns a string representing the message type of 'type'. The string is the @@ -1584,7 +2387,7 @@ put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid, assert(openflow_len <= UINT16_MAX); oh = ofpbuf_put_uninit(buffer, openflow_len); - oh->version = OFP_VERSION; + oh->version = OFP10_VERSION; oh->type = type; oh->length = htons(openflow_len); oh->xid = xid; @@ -1659,7 +2462,7 @@ ofputil_make_stats_request(size_t openflow_len, uint16_t ofpst_type, struct ofpbuf *msg; msg = *bufferp = ofpbuf_new(openflow_len); - put_stats__(alloc_xid(), OFPT_STATS_REQUEST, + put_stats__(alloc_xid(), OFPT10_STATS_REQUEST, htons(ofpst_type), htonl(nxst_subtype), msg); ofpbuf_padto(msg, openflow_len); @@ -1669,9 +2472,9 @@ ofputil_make_stats_request(size_t openflow_len, uint16_t ofpst_type, static void put_stats_reply__(const struct ofp_stats_msg *request, struct ofpbuf *msg) { - assert(request->header.type == OFPT_STATS_REQUEST || - request->header.type == OFPT_STATS_REPLY); - put_stats__(request->header.xid, OFPT_STATS_REPLY, request->type, + assert(request->header.type == OFPT10_STATS_REQUEST || + request->header.type == OFPT10_STATS_REPLY); + put_stats__(request->header.xid, OFPT10_STATS_REPLY, request->type, (request->type != htons(OFPST_VENDOR) ? htonl(0) : ((const struct nicira_stats_msg *) request)->subtype), @@ -1753,7 +2556,7 @@ ofputil_append_stats_reply(size_t len, struct list *replies) const void * ofputil_stats_body(const struct ofp_header *oh) { - assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY); + assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY); return (const struct ofp_stats_msg *) oh + 1; } @@ -1761,7 +2564,7 @@ ofputil_stats_body(const struct ofp_header *oh) size_t ofputil_stats_body_len(const struct ofp_header *oh) { - assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY); + assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY); return ntohs(oh->length) - sizeof(struct ofp_stats_msg); } @@ -1769,7 +2572,7 @@ ofputil_stats_body_len(const struct ofp_header *oh) const void * ofputil_nxstats_body(const struct ofp_header *oh) { - assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY); + assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY); return ((const struct nicira_stats_msg *) oh) + 1; } @@ -1777,7 +2580,7 @@ ofputil_nxstats_body(const struct ofp_header *oh) size_t ofputil_nxstats_body_len(const struct ofp_header *oh) { - assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY); + assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY); return ntohs(oh->length) - sizeof(struct nicira_stats_msg); } @@ -1789,8 +2592,8 @@ make_flow_mod(uint16_t command, const struct cls_rule *rule, size_t size = sizeof *ofm + actions_len; struct ofpbuf *out = ofpbuf_new(size); ofm = ofpbuf_put_zeros(out, sizeof *ofm); - ofm->header.version = OFP_VERSION; - ofm->header.type = OFPT_FLOW_MOD; + ofm->header.version = OFP10_VERSION; + ofm->header.type = OFPT10_FLOW_MOD; ofm->header.length = htons(size); ofm->cookie = 0; ofm->priority = htons(MIN(rule->priority, UINT16_MAX)); @@ -1830,10 +2633,7 @@ make_add_simple_flow(const struct cls_rule *rule, struct ofpbuf *buffer; buffer = make_add_flow(rule, buffer_id, idle_timeout, sizeof *oao); - oao = ofpbuf_put_zeros(buffer, sizeof *oao); - oao->type = htons(OFPAT_OUTPUT); - oao->len = htons(sizeof *oao); - oao->port = htons(out_port); + ofputil_put_OFPAT_OUTPUT(buffer)->port = htons(out_port); return buffer; } else { return make_add_flow(rule, buffer_id, idle_timeout, 0); @@ -1862,59 +2662,6 @@ make_packet_in(uint32_t buffer_id, uint16_t in_port, uint8_t reason, return buf; } -struct ofpbuf * -make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id, - uint16_t in_port, - const struct ofp_action_header *actions, size_t n_actions) -{ - size_t actions_len = n_actions * sizeof *actions; - struct ofp_packet_out *opo; - size_t size = sizeof *opo + actions_len + (packet ? packet->size : 0); - struct ofpbuf *out = ofpbuf_new(size); - - opo = ofpbuf_put_uninit(out, sizeof *opo); - opo->header.version = OFP_VERSION; - opo->header.type = OFPT_PACKET_OUT; - opo->header.length = htons(size); - opo->header.xid = htonl(0); - opo->buffer_id = htonl(buffer_id); - opo->in_port = htons(in_port == ODPP_LOCAL ? OFPP_LOCAL : in_port); - opo->actions_len = htons(actions_len); - ofpbuf_put(out, actions, actions_len); - if (packet) { - ofpbuf_put(out, packet->data, packet->size); - } - return out; -} - -struct ofpbuf * -make_unbuffered_packet_out(const struct ofpbuf *packet, - uint16_t in_port, uint16_t out_port) -{ - struct ofp_action_output action; - action.type = htons(OFPAT_OUTPUT); - action.len = htons(sizeof action); - action.port = htons(out_port); - return make_packet_out(packet, UINT32_MAX, in_port, - (struct ofp_action_header *) &action, 1); -} - -struct ofpbuf * -make_buffered_packet_out(uint32_t buffer_id, - uint16_t in_port, uint16_t out_port) -{ - if (out_port != OFPP_NONE) { - struct ofp_action_output action; - action.type = htons(OFPAT_OUTPUT); - action.len = htons(sizeof action); - action.port = htons(out_port); - return make_packet_out(NULL, buffer_id, in_port, - (struct ofp_action_header *) &action, 1); - } else { - return make_packet_out(NULL, buffer_id, in_port, NULL, 0); - } -} - /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */ struct ofpbuf * make_echo_request(void) @@ -1922,7 +2669,7 @@ make_echo_request(void) struct ofp_header *rq; struct ofpbuf *out = ofpbuf_new(sizeof *rq); rq = ofpbuf_put_uninit(out, sizeof *rq); - rq->version = OFP_VERSION; + rq->version = OFP10_VERSION; rq->type = OFPT_ECHO_REQUEST; rq->length = htons(sizeof *rq); rq->xid = htonl(0); @@ -1941,38 +2688,88 @@ make_echo_reply(const struct ofp_header *rq) return out; } -static int -check_action_exact_len(const union ofp_action *a, unsigned int len, - unsigned int required_len) +struct ofpbuf * +ofputil_encode_barrier_request(void) +{ + struct ofpbuf *msg; + + make_openflow(sizeof(struct ofp_header), OFPT10_BARRIER_REQUEST, &msg); + return msg; +} + +const char * +ofputil_frag_handling_to_string(enum ofp_config_flags flags) { - if (len != required_len) { - VLOG_WARN_RL(&bad_ofmsg_rl, "action %"PRIu16" has invalid length " - "%"PRIu16" (must be %u)\n", - ntohs(a->type), ntohs(a->header.len), required_len); - return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN); + 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"; } - return 0; + + 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; } -static int -check_nx_action_exact_len(const struct nx_action_header *a, - unsigned int len, unsigned int required_len) +/* 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. + * + * See the definition of OFP11_MAX for an explanation of the mapping. */ +enum ofperr +ofputil_port_from_ofp11(ovs_be32 ofp11_port, uint16_t *ofp10_port) { - if (len != required_len) { - VLOG_WARN_RL(&bad_ofmsg_rl, - "Nicira action %"PRIu16" has invalid length %"PRIu16" " - "(must be %u)\n", - ntohs(a->subtype), ntohs(a->len), required_len); - return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN); + uint32_t ofp11_port_h = ntohl(ofp11_port); + + if (ofp11_port_h < OFPP_MAX) { + *ofp10_port = ofp11_port_h; + return 0; + } else if (ofp11_port_h >= OFPP11_MAX) { + *ofp10_port = ofp11_port_h - OFPP11_OFFSET; + return 0; + } else { + 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, OFPP_MAX - 1, + (uint32_t) OFPP11_MAX, UINT32_MAX); + return OFPERR_OFPBAC_BAD_OUT_PORT; } - return 0; +} + +/* 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(uint16_t ofp10_port) +{ + return htonl(ofp10_port < OFPP_MAX + ? ofp10_port + : ofp10_port + OFPP11_OFFSET); } /* Checks that 'port' is a valid output port for the OFPAT_OUTPUT action, given * that the switch will never have more than 'max_ports' ports. Returns 0 if - * 'port' is valid, otherwise an ofp_mkerr() return code. */ -static int -check_output_port(uint16_t port, int max_ports) + * 'port' is valid, otherwise an OpenFlow return code. */ +enum ofperr +ofputil_check_output_port(uint16_t port, int max_ports) { switch (port) { case OFPP_IN_PORT: @@ -1988,210 +2785,421 @@ check_output_port(uint16_t port, int max_ports) if (port < max_ports) { return 0; } - VLOG_WARN_RL(&bad_ofmsg_rl, "unknown output port %x", port); - return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT); + return OFPERR_OFPBAC_BAD_OUT_PORT; } } -/* Checks that 'action' is a valid OFPAT_ENQUEUE action, given that the switch - * will never have more than 'max_ports' ports. Returns 0 if 'port' is valid, - * otherwise an ofp_mkerr() return code. */ -static int -check_enqueue_action(const union ofp_action *a, unsigned int len, - int max_ports) +#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(NONE) + +/* Checks whether 's' is the string representation of an OpenFlow port number, + * either as an integer or a string name (e.g. "LOCAL"). If it is, stores the + * number in '*port' and returns true. Otherwise, returns false. */ +bool +ofputil_port_from_string(const char *name, uint16_t *port) { - const struct ofp_action_enqueue *oae; - uint16_t port; - int error; + struct pair { + const char *name; + uint16_t value; + }; + static const struct pair pairs[] = { +#define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME}, + OFPUTIL_NAMED_PORTS +#undef OFPUTIL_NAMED_PORT + }; + static const int n_pairs = ARRAY_SIZE(pairs); + int i; - error = check_action_exact_len(a, len, 16); - if (error) { - return error; + if (str_to_int(name, 0, &i) && i >= 0 && i < UINT16_MAX) { + *port = i; + return true; } - oae = (const struct ofp_action_enqueue *) a; - port = ntohs(oae->port); - if (port < max_ports || port == OFPP_IN_PORT) { - return 0; + for (i = 0; i < n_pairs; i++) { + if (!strcasecmp(name, pairs[i].name)) { + *port = pairs[i].value; + return true; + } } - VLOG_WARN_RL(&bad_ofmsg_rl, "unknown enqueue port %x", port); - return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT); + return false; } -static int -check_nicira_action(const union ofp_action *a, unsigned int len, - const struct flow *flow) +/* 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(uint16_t port, struct ds *s) { - const struct nx_action_header *nah; - int subtype; - int error; + const char *name; + + switch (port) { +#define OFPUTIL_NAMED_PORT(NAME) case OFPP_##NAME: name = #NAME; break; + OFPUTIL_NAMED_PORTS +#undef OFPUTIL_NAMED_PORT - if (len < 16) { - VLOG_WARN_RL(&bad_ofmsg_rl, - "Nicira vendor action only %u bytes", len); - return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN); + default: + ds_put_format(s, "%"PRIu16, port); + return; } - nah = (const struct nx_action_header *) a; + ds_put_cstr(s, name); +} - subtype = ntohs(nah->subtype); - if (subtype > TYPE_MAXIMUM(enum nx_action_subtype)) { - /* This is necessary because enum nx_action_subtype may be an - * 8-bit type, so the cast below throws away the top 8 bits. */ - return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR_TYPE); +static enum ofperr +check_resubmit_table(const struct nx_action_resubmit *nar) +{ + if (nar->pad[0] || nar->pad[1] || nar->pad[2]) { + return OFPERR_OFPBAC_BAD_ARGUMENT; } + return 0; +} - switch ((enum nx_action_subtype) subtype) { - case NXAST_RESUBMIT: - case NXAST_SET_TUNNEL: - case NXAST_SET_QUEUE: - case NXAST_POP_QUEUE: - return check_nx_action_exact_len(nah, len, 16); +static enum ofperr +check_output_reg(const struct nx_action_output_reg *naor, + const struct flow *flow) +{ + struct mf_subfield src; + size_t i; - case NXAST_REG_MOVE: - error = check_nx_action_exact_len(nah, len, - sizeof(struct nx_action_reg_move)); - if (error) { - return error; + for (i = 0; i < sizeof naor->zero; i++) { + if (naor->zero[i]) { + return OFPERR_OFPBAC_BAD_ARGUMENT; } - return nxm_check_reg_move((const struct nx_action_reg_move *) a, flow); + } + + nxm_decode(&src, naor->src, naor->ofs_nbits); + return mf_check_src(&src, flow); +} + +enum ofperr +validate_actions(const union ofp_action *actions, size_t n_actions, + const struct flow *flow, int max_ports) +{ + const union ofp_action *a; + size_t left; + + OFPUTIL_ACTION_FOR_EACH (a, left, actions, n_actions) { + enum ofperr error; + uint16_t port; + int code; + + code = ofputil_decode_action(a); + if (code < 0) { + error = -code; + VLOG_WARN_RL(&bad_ofmsg_rl, + "action decoding error at offset %td (%s)", + (a - actions) * sizeof *a, ofperr_get_name(error)); - case NXAST_REG_LOAD: - error = check_nx_action_exact_len(nah, len, - sizeof(struct nx_action_reg_load)); - if (error) { return error; } - return nxm_check_reg_load((const struct nx_action_reg_load *) a, flow); - case NXAST_NOTE: - return 0; + error = 0; + switch ((enum ofputil_action_code) code) { + case OFPUTIL_OFPAT_OUTPUT: + error = ofputil_check_output_port(ntohs(a->output.port), + max_ports); + break; - case NXAST_SET_TUNNEL64: - return check_nx_action_exact_len( - nah, len, sizeof(struct nx_action_set_tunnel64)); + case OFPUTIL_OFPAT_SET_VLAN_VID: + if (a->vlan_vid.vlan_vid & ~htons(0xfff)) { + error = OFPERR_OFPBAC_BAD_ARGUMENT; + } + break; - case NXAST_MULTIPATH: - error = check_nx_action_exact_len( - nah, len, sizeof(struct nx_action_multipath)); - if (error) { - return error; + case OFPUTIL_OFPAT_SET_VLAN_PCP: + if (a->vlan_pcp.vlan_pcp & ~7) { + error = OFPERR_OFPBAC_BAD_ARGUMENT; + } + break; + + case OFPUTIL_OFPAT_ENQUEUE: + port = ntohs(((const struct ofp_action_enqueue *) a)->port); + if (port >= max_ports && port != OFPP_IN_PORT + && port != OFPP_LOCAL) { + error = OFPERR_OFPBAC_BAD_OUT_PORT; + } + break; + + case OFPUTIL_NXAST_REG_MOVE: + error = nxm_check_reg_move((const struct nx_action_reg_move *) a, + flow); + break; + + case OFPUTIL_NXAST_REG_LOAD: + error = nxm_check_reg_load((const struct nx_action_reg_load *) a, + flow); + break; + + case OFPUTIL_NXAST_MULTIPATH: + error = multipath_check((const struct nx_action_multipath *) a, + flow); + break; + + case OFPUTIL_NXAST_AUTOPATH: + error = autopath_check((const struct nx_action_autopath *) a, + flow); + break; + + case OFPUTIL_NXAST_BUNDLE: + case OFPUTIL_NXAST_BUNDLE_LOAD: + error = bundle_check((const struct nx_action_bundle *) a, + max_ports, flow); + break; + + case OFPUTIL_NXAST_OUTPUT_REG: + error = check_output_reg((const struct nx_action_output_reg *) a, + flow); + break; + + case OFPUTIL_NXAST_RESUBMIT_TABLE: + error = check_resubmit_table( + (const struct nx_action_resubmit *) a); + break; + + case OFPUTIL_NXAST_LEARN: + error = learn_check((const struct nx_action_learn *) a, flow); + break; + + case OFPUTIL_NXAST_CONTROLLER: + if (((const struct nx_action_controller *) a)->zero) { + error = OFPERR_NXBAC_MUST_BE_ZERO; + } + break; + + case OFPUTIL_OFPAT_STRIP_VLAN: + case OFPUTIL_OFPAT_SET_NW_SRC: + case OFPUTIL_OFPAT_SET_NW_DST: + case OFPUTIL_OFPAT_SET_NW_TOS: + case OFPUTIL_OFPAT_SET_TP_SRC: + case OFPUTIL_OFPAT_SET_TP_DST: + case OFPUTIL_OFPAT_SET_DL_SRC: + case OFPUTIL_OFPAT_SET_DL_DST: + case OFPUTIL_NXAST_RESUBMIT: + case OFPUTIL_NXAST_SET_TUNNEL: + case OFPUTIL_NXAST_SET_QUEUE: + case OFPUTIL_NXAST_POP_QUEUE: + case OFPUTIL_NXAST_NOTE: + case OFPUTIL_NXAST_SET_TUNNEL64: + case OFPUTIL_NXAST_EXIT: + case OFPUTIL_NXAST_DEC_TTL: + case OFPUTIL_NXAST_FIN_TIMEOUT: + break; } - return multipath_check((const struct nx_action_multipath *) a); - case NXAST_AUTOPATH: - error = check_nx_action_exact_len( - nah, len, sizeof(struct nx_action_autopath)); if (error) { + VLOG_WARN_RL(&bad_ofmsg_rl, "bad action at offset %td (%s)", + (a - actions) * sizeof *a, ofperr_get_name(error)); return error; } - return autopath_check((const struct nx_action_autopath *) a); - - case NXAST_SNAT__OBSOLETE: - case NXAST_DROP_SPOOFED_ARP__OBSOLETE: - default: - VLOG_WARN_RL(&bad_ofmsg_rl, - "unknown Nicira vendor action subtype %d", subtype); - return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR_TYPE); } + if (left) { + VLOG_WARN_RL(&bad_ofmsg_rl, "bad action format at offset %zu", + (n_actions - left) * sizeof *a); + return OFPERR_OFPBAC_BAD_LEN; + } + return 0; } -static int -check_action(const union ofp_action *a, unsigned int len, - const struct flow *flow, int max_ports) +struct ofputil_action { + int code; + unsigned int min_len; + unsigned int max_len; +}; + +static const struct ofputil_action action_bad_type + = { -OFPERR_OFPBAC_BAD_TYPE, 0, UINT_MAX }; +static const struct ofputil_action action_bad_len + = { -OFPERR_OFPBAC_BAD_LEN, 0, UINT_MAX }; +static const struct ofputil_action action_bad_vendor + = { -OFPERR_OFPBAC_BAD_VENDOR, 0, UINT_MAX }; + +static const struct ofputil_action * +ofputil_decode_ofpat_action(const union ofp_action *a) { enum ofp_action_type type = ntohs(a->type); - int error; switch (type) { - case OFPAT_OUTPUT: - error = check_action_exact_len(a, len, 8); - if (error) { - return error; +#define OFPAT_ACTION(ENUM, STRUCT, NAME) \ + case ENUM: { \ + static const struct ofputil_action action = { \ + OFPUTIL_##ENUM, \ + sizeof(struct STRUCT), \ + sizeof(struct STRUCT) \ + }; \ + return &action; \ } - return check_output_port(ntohs(a->output.port), max_ports); +#include "ofp-util.def" - case OFPAT_SET_VLAN_VID: - error = check_action_exact_len(a, len, 8); - if (error) { - return error; - } - if (a->vlan_vid.vlan_vid & ~htons(0xfff)) { - return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT); - } - return 0; + case OFPAT_VENDOR: + default: + return &action_bad_type; + } +} - case OFPAT_SET_VLAN_PCP: - error = check_action_exact_len(a, len, 8); - if (error) { - return error; - } - if (a->vlan_pcp.vlan_pcp & ~7) { - return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT); +static const struct ofputil_action * +ofputil_decode_nxast_action(const union ofp_action *a) +{ + const struct nx_action_header *nah = (const struct nx_action_header *) a; + enum nx_action_subtype subtype = ntohs(nah->subtype); + + switch (subtype) { +#define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \ + case ENUM: { \ + static const struct ofputil_action action = { \ + OFPUTIL_##ENUM, \ + sizeof(struct STRUCT), \ + EXTENSIBLE ? UINT_MAX : sizeof(struct STRUCT) \ + }; \ + return &action; \ } - return 0; +#include "ofp-util.def" - case OFPAT_STRIP_VLAN: - case OFPAT_SET_NW_SRC: - case OFPAT_SET_NW_DST: - case OFPAT_SET_NW_TOS: - case OFPAT_SET_TP_SRC: - case OFPAT_SET_TP_DST: - return check_action_exact_len(a, len, 8); + case NXAST_SNAT__OBSOLETE: + case NXAST_DROP_SPOOFED_ARP__OBSOLETE: + default: + return &action_bad_type; + } +} + +/* Parses 'a' to determine its type. Returns a nonnegative OFPUTIL_OFPAT_* or + * OFPUTIL_NXAST_* constant if successful, otherwise a negative OFPERR_* error + * code. + * + * The caller must have already verified that 'a''s length is correct (that is, + * a->header.len is nonzero and a multiple of sizeof(union ofp_action) and no + * longer than the amount of space allocated to 'a'). + * + * This function verifies that 'a''s length is correct for the type of action + * that it represents. */ +int +ofputil_decode_action(const union ofp_action *a) +{ + const struct ofputil_action *action; + uint16_t len = ntohs(a->header.len); - case OFPAT_SET_DL_SRC: - case OFPAT_SET_DL_DST: - return check_action_exact_len(a, len, 16); + if (a->type != htons(OFPAT_VENDOR)) { + action = ofputil_decode_ofpat_action(a); + } else { + switch (ntohl(a->vendor.vendor)) { + case NX_VENDOR_ID: + if (len < sizeof(struct nx_action_header)) { + return -OFPERR_OFPBAC_BAD_LEN; + } + action = ofputil_decode_nxast_action(a); + break; + default: + action = &action_bad_vendor; + break; + } + } - case OFPAT_VENDOR: - return (a->vendor.vendor == htonl(NX_VENDOR_ID) - ? check_nicira_action(a, len, flow) - : ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR)); + return (len >= action->min_len && len <= action->max_len + ? action->code + : -OFPERR_OFPBAC_BAD_LEN); +} - case OFPAT_ENQUEUE: - return check_enqueue_action(a, len, max_ports); +/* Parses 'a' and returns its type as an OFPUTIL_OFPAT_* or OFPUTIL_NXAST_* + * constant. The caller must have already validated that 'a' is a valid action + * understood by Open vSwitch (e.g. by a previous successful call to + * ofputil_decode_action()). */ +enum ofputil_action_code +ofputil_decode_action_unsafe(const union ofp_action *a) +{ + const struct ofputil_action *action; - default: - VLOG_WARN_RL(&bad_ofmsg_rl, "unknown action type %d", (int) type); - return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_TYPE); + if (a->type != htons(OFPAT_VENDOR)) { + action = ofputil_decode_ofpat_action(a); + } else { + action = ofputil_decode_nxast_action(a); } + + return action->code; } +/* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if + * 'name' is "output" then the return value is OFPUTIL_OFPAT_OUTPUT), or -1 if + * 'name' is not the name of any action. + * + * ofp-util.def lists the mapping from names to action. */ int -validate_actions(const union ofp_action *actions, size_t n_actions, - const struct flow *flow, int max_ports) +ofputil_action_code_from_name(const char *name) { - size_t i; - - for (i = 0; i < n_actions; ) { - const union ofp_action *a = &actions[i]; - unsigned int len = ntohs(a->header.len); - unsigned int n_slots = len / OFP_ACTION_ALIGN; - unsigned int slots_left = &actions[n_actions] - a; - int error; + static const char *names[OFPUTIL_N_ACTIONS] = { +#define OFPAT_ACTION(ENUM, STRUCT, NAME) NAME, +#define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME, +#include "ofp-util.def" + }; - if (n_slots > slots_left) { - VLOG_WARN_RL(&bad_ofmsg_rl, - "action requires %u slots but only %u remain", - n_slots, slots_left); - return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN); - } else if (!len) { - VLOG_WARN_RL(&bad_ofmsg_rl, "action has invalid length 0"); - return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN); - } else if (len % OFP_ACTION_ALIGN) { - VLOG_WARN_RL(&bad_ofmsg_rl, "action length %u is not a multiple " - "of %d", len, OFP_ACTION_ALIGN); - return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN); - } + const char **p; - error = check_action(a, len, flow, max_ports); - if (error) { - return error; + for (p = names; p < &names[ARRAY_SIZE(names)]; p++) { + if (*p && !strcasecmp(name, *p)) { + return p - names; } - i += n_slots; } - return 0; + return -1; } +/* 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) { +#define OFPAT_ACTION(ENUM, STRUCT, 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" + } + NOT_REACHED(); +} + +#define OFPAT_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 NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \ + void \ + ofputil_init_##ENUM(struct STRUCT *s) \ + { \ + memset(s, 0, sizeof *s); \ + s->type = htons(OFPAT_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" + /* Returns true if 'action' outputs to 'port', false otherwise. */ bool action_outputs_to_port(const union ofp_action *action, ovs_be16 port) @@ -2206,30 +3214,6 @@ action_outputs_to_port(const union ofp_action *action, ovs_be16 port) } } -/* The set of actions must either come from a trusted source or have been - * previously validated with validate_actions(). */ -const union ofp_action * -actions_first(struct actions_iterator *iter, - const union ofp_action *oa, size_t n_actions) -{ - iter->pos = oa; - iter->end = oa + n_actions; - return actions_next(iter); -} - -const union ofp_action * -actions_next(struct actions_iterator *iter) -{ - if (iter->pos != iter->end) { - const union ofp_action *a = iter->pos; - unsigned int len = ntohs(a->header.len); - iter->pos += len / OFP_ACTION_ALIGN; - return a; - } else { - return NULL; - } -} - /* "Normalizes" the wildcards in 'rule'. That means: * * 1. If the type of level N is known, then only the valid fields for that @@ -2244,21 +3228,18 @@ actions_next(struct actions_iterator *iter) * example, Open vSwitch does not understand SCTP, an L4 protocol, so the * L4 fields tp_src and tp_dst must be wildcarded if 'rule' specifies an * SCTP flow. - * - * 'flow_format' specifies the format of the flow as received or as intended to - * be sent. This is important for IPv6 and ARP, for which NXM supports more - * detailed matching. */ + */ void -ofputil_normalize_rule(struct cls_rule *rule, enum nx_flow_format flow_format) +ofputil_normalize_rule(struct cls_rule *rule) { 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_NW_TOS = 1 << 3, /* nw_tos */ + MAY_IPVx = 1 << 3, /* tos, frag, ttl */ MAY_ARP_SHA = 1 << 4, /* arp_sha */ MAY_ARP_THA = 1 << 5, /* arp_tha */ - MAY_IPV6_ADDR = 1 << 6, /* ipv6_src, ipv6_dst */ + MAY_IPV6 = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */ MAY_ND_TARGET = 1 << 7 /* nd_target */ } may_match; @@ -2266,15 +3247,14 @@ ofputil_normalize_rule(struct cls_rule *rule, enum nx_flow_format flow_format) /* Figure out what fields may be matched. */ if (rule->flow.dl_type == htons(ETH_TYPE_IP)) { - may_match = MAY_NW_PROTO | MAY_NW_TOS | MAY_NW_ADDR; + may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR; if (rule->flow.nw_proto == IPPROTO_TCP || rule->flow.nw_proto == IPPROTO_UDP || rule->flow.nw_proto == IPPROTO_ICMP) { may_match |= MAY_TP_ADDR; } - } else if (rule->flow.dl_type == htons(ETH_TYPE_IPV6) - && flow_format == NXFF_NXM) { - may_match = MAY_NW_PROTO | MAY_NW_TOS | MAY_IPV6_ADDR; + } else if (rule->flow.dl_type == htons(ETH_TYPE_IPV6)) { + may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6; if (rule->flow.nw_proto == IPPROTO_TCP || rule->flow.nw_proto == IPPROTO_UDP) { may_match |= MAY_TP_ADDR; @@ -2287,10 +3267,7 @@ ofputil_normalize_rule(struct cls_rule *rule, enum nx_flow_format flow_format) } } } else if (rule->flow.dl_type == htons(ETH_TYPE_ARP)) { - may_match = MAY_NW_PROTO | MAY_NW_ADDR; - if (flow_format == NXFF_NXM) { - may_match |= MAY_ARP_SHA | MAY_ARP_THA; - } + may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA; } else { may_match = 0; } @@ -2301,13 +3278,15 @@ ofputil_normalize_rule(struct cls_rule *rule, enum nx_flow_format flow_format) wc.nw_src_mask = wc.nw_dst_mask = htonl(0); } if (!(may_match & MAY_TP_ADDR)) { - wc.wildcards |= FWW_TP_SRC | FWW_TP_DST; + wc.tp_src_mask = wc.tp_dst_mask = htons(0); } if (!(may_match & MAY_NW_PROTO)) { wc.wildcards |= FWW_NW_PROTO; } - if (!(may_match & MAY_NW_TOS)) { - wc.wildcards |= FWW_NW_TOS; + if (!(may_match & MAY_IPVx)) { + wc.wildcards |= FWW_NW_DSCP; + wc.wildcards |= FWW_NW_ECN; + wc.wildcards |= FWW_NW_TTL; } if (!(may_match & MAY_ARP_SHA)) { wc.wildcards |= FWW_ARP_SHA; @@ -2315,8 +3294,9 @@ ofputil_normalize_rule(struct cls_rule *rule, enum nx_flow_format flow_format) if (!(may_match & MAY_ARP_THA)) { wc.wildcards |= FWW_ARP_THA; } - if (!(may_match & MAY_IPV6_ADDR)) { + if (!(may_match & MAY_IPV6)) { wc.ipv6_src_mask = wc.ipv6_dst_mask = in6addr_any; + wc.wildcards |= FWW_IPV6_LABEL; } if (!(may_match & MAY_ND_TARGET)) { wc.wildcards |= FWW_ND_TARGET; @@ -2341,207 +3321,6 @@ ofputil_normalize_rule(struct cls_rule *rule, enum nx_flow_format flow_format) } } -static uint32_t -vendor_code_to_id(uint8_t code) -{ - switch (code) { -#define OFPUTIL_VENDOR(NAME, VENDOR_ID) case NAME: return VENDOR_ID; - OFPUTIL_VENDORS -#undef OFPUTIL_VENDOR - default: - return UINT32_MAX; - } -} - -static int -vendor_id_to_code(uint32_t id) -{ - switch (id) { -#define OFPUTIL_VENDOR(NAME, VENDOR_ID) case VENDOR_ID: return NAME; - OFPUTIL_VENDORS -#undef OFPUTIL_VENDOR - default: - return -1; - } -} - -/* Creates and returns an OpenFlow message of type OFPT_ERROR with the error - * information taken from 'error', whose encoding must be as described in the - * large comment in ofp-util.h. If 'oh' is nonnull, then the error will use - * oh->xid as its transaction ID, and it will include up to the first 64 bytes - * of 'oh'. - * - * Returns NULL if 'error' is not an OpenFlow error code. */ -struct ofpbuf * -ofputil_encode_error_msg(int error, const struct ofp_header *oh) -{ - static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5); - - struct ofpbuf *buf; - const void *data; - size_t len; - uint8_t vendor; - uint16_t type; - uint16_t code; - ovs_be32 xid; - - if (!is_ofp_error(error)) { - /* We format 'error' with strerror() here since it seems likely to be - * a system errno value. */ - VLOG_WARN_RL(&rl, "invalid OpenFlow error code %d (%s)", - error, strerror(error)); - return NULL; - } - - if (oh) { - xid = oh->xid; - data = oh; - len = ntohs(oh->length); - if (len > 64) { - len = 64; - } - } else { - xid = 0; - data = NULL; - len = 0; - } - - vendor = get_ofp_err_vendor(error); - type = get_ofp_err_type(error); - code = get_ofp_err_code(error); - if (vendor == OFPUTIL_VENDOR_OPENFLOW) { - struct ofp_error_msg *oem; - - oem = make_openflow_xid(len + sizeof *oem, OFPT_ERROR, xid, &buf); - oem->type = htons(type); - oem->code = htons(code); - } else { - struct ofp_error_msg *oem; - struct nx_vendor_error *nve; - uint32_t vendor_id; - - vendor_id = vendor_code_to_id(vendor); - if (vendor_id == UINT32_MAX) { - VLOG_WARN_RL(&rl, "error %x contains invalid vendor code %d", - error, vendor); - return NULL; - } - - oem = make_openflow_xid(len + sizeof *oem + sizeof *nve, - OFPT_ERROR, xid, &buf); - oem->type = htons(NXET_VENDOR); - oem->code = htons(NXVC_VENDOR_ERROR); - - nve = (struct nx_vendor_error *)oem->data; - nve->vendor = htonl(vendor_id); - nve->type = htons(type); - nve->code = htons(code); - } - - if (len) { - buf->size -= len; - ofpbuf_put(buf, data, len); - } - - return buf; -} - -/* Decodes 'oh', which should be an OpenFlow OFPT_ERROR message, and returns an - * Open vSwitch internal error code in the format described in the large - * comment in ofp-util.h. - * - * If 'payload_ofs' is nonnull, on success '*payload_ofs' is set to the offset - * to the payload starting from 'oh' and on failure it is set to 0. */ -int -ofputil_decode_error_msg(const struct ofp_header *oh, size_t *payload_ofs) -{ - static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5); - - const struct ofp_error_msg *oem; - uint16_t type, code; - struct ofpbuf b; - int vendor; - - if (payload_ofs) { - *payload_ofs = 0; - } - if (oh->type != OFPT_ERROR) { - return EPROTO; - } - - ofpbuf_use_const(&b, oh, ntohs(oh->length)); - oem = ofpbuf_try_pull(&b, sizeof *oem); - if (!oem) { - return EPROTO; - } - - type = ntohs(oem->type); - code = ntohs(oem->code); - if (type == NXET_VENDOR && code == NXVC_VENDOR_ERROR) { - const struct nx_vendor_error *nve = ofpbuf_try_pull(&b, sizeof *nve); - if (!nve) { - return EPROTO; - } - - vendor = vendor_id_to_code(ntohl(nve->vendor)); - if (vendor < 0) { - VLOG_WARN_RL(&rl, "error contains unknown vendor ID %#"PRIx32, - ntohl(nve->vendor)); - return EPROTO; - } - type = ntohs(nve->type); - code = ntohs(nve->code); - } else { - vendor = OFPUTIL_VENDOR_OPENFLOW; - } - - if (type >= 1024) { - VLOG_WARN_RL(&rl, "error contains type %"PRIu16" greater than " - "supported maximum value 1023", type); - return EPROTO; - } - - if (payload_ofs) { - *payload_ofs = (uint8_t *) b.data - (uint8_t *) oh; - } - return ofp_mkerr_vendor(vendor, type, code); -} - -void -ofputil_format_error(struct ds *s, int error) -{ - if (is_errno(error)) { - ds_put_cstr(s, strerror(error)); - } else { - uint16_t type = get_ofp_err_type(error); - uint16_t code = get_ofp_err_code(error); - const char *type_s = ofp_error_type_to_string(type); - const char *code_s = ofp_error_code_to_string(type, code); - - ds_put_format(s, "type "); - if (type_s) { - ds_put_cstr(s, type_s); - } else { - ds_put_format(s, "%"PRIu16, type); - } - - ds_put_cstr(s, ", code "); - if (code_s) { - ds_put_cstr(s, code_s); - } else { - ds_put_format(s, "%"PRIu16, code); - } - } -} - -char * -ofputil_error_to_string(int error) -{ - struct ds s = DS_EMPTY_INITIALIZER; - ofputil_format_error(&s, error); - return ds_steal_cstr(&s); -} - /* Attempts to pull 'actions_len' bytes from the front of 'b'. Returns 0 if * successful, otherwise an OpenFlow error. * @@ -2553,7 +3332,7 @@ ofputil_error_to_string(int error) * do so, with validate_actions()). The caller is also responsible for making * sure that 'b->data' is initially aligned appropriately for "union * ofp_action". */ -int +enum ofperr ofputil_pull_actions(struct ofpbuf *b, unsigned int actions_len, union ofp_action **actionsp, size_t *n_actionsp) { @@ -2577,7 +3356,7 @@ ofputil_pull_actions(struct ofpbuf *b, unsigned int actions_len, error: *actionsp = NULL; *n_actionsp = 0; - return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN); + return OFPERR_OFPBRC_BAD_LEN; } bool @@ -2592,3 +3371,72 @@ ofputil_actions_clone(const union ofp_action *actions, size_t n) { return n ? xmemdup(actions, n * sizeof *actions) : NULL; } + +/* 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': + ovs_fatal(0, "unbalanced parentheses in argument to %s", key); + + 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; +}