/*
- * Copyright (c) 2008, 2009, 2010 Nicira Networks.
+ * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#include <config.h>
#include "ofp-print.h"
+#include <errno.h>
#include <inttypes.h>
+#include <sys/types.h>
+#include <netinet/in.h>
+#include <netinet/icmp6.h>
#include <stdlib.h>
+#include "autopath.h"
+#include "bundle.h"
#include "byte-order.h"
#include "classifier.h"
+#include "dynamic-string.h"
+#include "learn.h"
+#include "meta-flow.h"
#include "multipath.h"
+#include "netdev.h"
#include "nx-match.h"
+#include "ofp-actions.h"
+#include "ofp-errors.h"
#include "ofp-util.h"
#include "ofpbuf.h"
#include "packets.h"
#include "random.h"
+#include "unaligned.h"
#include "type-props.h"
#include "vlog.h"
}
/* 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', a number
+ * between 0 and 32 inclusive.
+ *
+ * If 'netmask' is not a CIDR netmask (see ip_is_cidr()), the return value will
+ * still be in the valid range but isn't otherwise meaningful. */
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
+/* A list of the FWW_* and OFPFW10_ bits that have the same value, meaning, and
* name. */
#define WC_INVARIANT_LIST \
WC_INVARIANT_BIT(IN_PORT) \
- 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. */
-#define WC_INVARIANT_BIT(NAME) BUILD_ASSERT_DECL(FWW_##NAME == OFPFW_##NAME);
+#define WC_INVARIANT_BIT(NAME) BUILD_ASSERT_DECL(FWW_##NAME == OFPFW10_##NAME);
WC_INVARIANT_LIST
#undef WC_INVARIANT_BIT
/* WC_INVARIANTS is the invariant bits (as defined on WC_INVARIANT_LIST) all
* OR'd together. */
-enum {
- WC_INVARIANTS = 0
+static const flow_wildcards_t WC_INVARIANTS = 0
#define WC_INVARIANT_BIT(NAME) | FWW_##NAME
WC_INVARIANT_LIST
#undef WC_INVARIANT_BIT
-};
+;
-/* Converts the ofp_match in 'match' into a cls_rule in 'rule', with the given
- * 'priority'.
- *
- * 'flow_format' must either NXFF_OPENFLOW10 or NXFF_TUN_ID_FROM_COOKIE. In
- * the latter case only, 'flow''s tun_id field will be taken from the high bits
- * of 'cookie', if 'match''s wildcards do not indicate that tun_id is
- * wildcarded. */
+/* Converts the OpenFlow 1.0 wildcards in 'ofpfw' (OFPFW10_*) into a
+ * flow_wildcards in 'wc' for use in struct cls_rule. It is the caller's
+ * responsibility to handle the special case where the flow match's dl_vlan is
+ * set to OFP_VLAN_NONE. */
void
-ofputil_cls_rule_from_match(const struct ofp_match *match,
- unsigned int priority,
- enum nx_flow_format flow_format,
- ovs_be64 cookie, struct cls_rule *rule)
-{
- struct flow_wildcards *wc = &rule->wc;
- unsigned int ofpfw;
- ovs_be16 vid, pcp;
-
- /* Initialize rule->priority. */
- ofpfw = ntohl(match->wildcards);
- ofpfw &= flow_format == NXFF_TUN_ID_FROM_COOKIE ? OVSFW_ALL : OFPFW_ALL;
- rule->priority = !ofpfw ? UINT16_MAX : priority;
+ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *wc)
+{
+ BUILD_ASSERT_DECL(FLOW_WC_SEQ == 14);
/* Initialize most of rule->wc. */
flow_wildcards_init_catchall(wc);
- wc->wildcards = ofpfw & WC_INVARIANTS;
- if (ofpfw & OFPFW_NW_TOS) {
- wc->wildcards |= FWW_NW_TOS;
+ wc->wildcards = (OVS_FORCE flow_wildcards_t) ofpfw & WC_INVARIANTS;
+
+ /* Wildcard fields that aren't defined by ofp10_match or tun_id. */
+ wc->wildcards |= FWW_NW_ECN | FWW_NW_TTL;
+
+ if (ofpfw & OFPFW10_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 (flow_format == NXFF_TUN_ID_FROM_COOKIE && !(ofpfw & NXFW_TUN_ID)) {
- rule->flow.tun_id = htonll(ntohll(cookie) >> 32);
- } else {
- wc->wildcards |= FWW_TUN_ID;
- rule->flow.tun_id = htonll(0);
+ wc->nw_src_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW10_NW_SRC_SHIFT);
+ wc->nw_dst_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW10_NW_DST_SHIFT);
+
+ if (!(ofpfw & OFPFW10_TP_SRC)) {
+ wc->tp_src_mask = htons(UINT16_MAX);
+ }
+ if (!(ofpfw & OFPFW10_TP_DST)) {
+ wc->tp_dst_mask = htons(UINT16_MAX);
+ }
+
+ if (!(ofpfw & OFPFW10_DL_SRC)) {
+ memset(wc->dl_src_mask, 0xff, ETH_ADDR_LEN);
+ }
+ if (!(ofpfw & OFPFW10_DL_DST)) {
+ memset(wc->dl_dst_mask, 0xff, ETH_ADDR_LEN);
}
- 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
- * and FWW_ETH_MCAST. */
- wc->wildcards |= FWW_ETH_MCAST;
+ /* VLAN TCI mask. */
+ if (!(ofpfw & OFPFW10_DL_VLAN_PCP)) {
+ wc->vlan_tci_mask |= htons(VLAN_PCP_MASK | VLAN_CFI);
+ }
+ if (!(ofpfw & OFPFW10_DL_VLAN)) {
+ wc->vlan_tci_mask |= htons(VLAN_VID_MASK | VLAN_CFI);
}
+}
+
+/* Converts the ofp10_match in 'match' into a cls_rule in 'rule', with the
+ * given 'priority'. */
+void
+ofputil_cls_rule_from_ofp10_match(const struct ofp10_match *match,
+ unsigned int priority, struct cls_rule *rule)
+{
+ uint32_t ofpfw = ntohl(match->wildcards) & OFPFW10_ALL;
+
+ /* Initialize rule->priority, rule->wc. */
+ rule->priority = !ofpfw ? UINT16_MAX : priority;
+ ofputil_wildcard_from_ofpfw10(ofpfw, &rule->wc);
/* Initialize most of rule->flow. */
rule->flow.nw_src = match->nw_src;
rule->flow.nw_dst = match->nw_dst;
- rule->flow.in_port = (match->in_port == htons(OFPP_LOCAL) ? ODPP_LOCAL
- : ntohs(match->in_port));
- rule->flow.dl_type = match->dl_type;
+ rule->flow.in_port = ntohs(match->in_port);
+ rule->flow.dl_type = ofputil_dl_type_from_openflow(match->dl_type);
rule->flow.tp_src = match->tp_src;
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. */
- vid = match->dl_vlan & htons(VLAN_VID_MASK);
- pcp = htons((match->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK);
- switch (ofpfw & (OFPFW_DL_VLAN | OFPFW_DL_VLAN_PCP)) {
- case OFPFW_DL_VLAN | OFPFW_DL_VLAN_PCP:
- /* Wildcard everything. */
+ if (!(ofpfw & OFPFW10_DL_VLAN) &&
+ match->dl_vlan == htons(OFP10_VLAN_NONE)) {
+ /* Match only packets without 802.1Q header.
+ *
+ * When OFPFW10_DL_VLAN_PCP is wildcarded, this is obviously correct.
+ *
+ * If OFPFW10_DL_VLAN_PCP is matched, the flow match is contradictory,
+ * because we can't have a specific PCP without an 802.1Q header.
+ * However, older versions of OVS treated this as matching packets
+ * withut an 802.1Q header, so we do here too. */
rule->flow.vlan_tci = htons(0);
- rule->wc.vlan_tci_mask = htons(0);
- break;
-
- case OFPFW_DL_VLAN_PCP:
- if (match->dl_vlan == htons(OFP_VLAN_NONE)) {
- /* Match only packets without 802.1Q header. */
- rule->flow.vlan_tci = htons(0);
- rule->wc.vlan_tci_mask = htons(0xffff);
- } else {
- /* Wildcard PCP, specific VID. */
- rule->flow.vlan_tci = vid | htons(VLAN_CFI);
- rule->wc.vlan_tci_mask = htons(VLAN_VID_MASK | VLAN_CFI);
- }
- break;
-
- case OFPFW_DL_VLAN:
- /* Wildcard VID, specific PCP. */
- rule->flow.vlan_tci = pcp | htons(VLAN_CFI);
- rule->wc.vlan_tci_mask = htons(VLAN_PCP_MASK | VLAN_CFI);
- break;
+ rule->wc.vlan_tci_mask = htons(0xffff);
+ } else {
+ ovs_be16 vid, pcp, tci;
- case 0:
- if (match->dl_vlan == htons(OFP_VLAN_NONE)) {
- /* This case is odd, since we can't have a specific PCP without an
- * 802.1Q header. However, older versions of OVS treated this as
- * matching packets withut an 802.1Q header, so we do here too. */
- rule->flow.vlan_tci = htons(0);
- rule->wc.vlan_tci_mask = htons(0xffff);
- } else {
- /* Specific VID and PCP. */
- rule->flow.vlan_tci = vid | pcp | htons(VLAN_CFI);
- rule->wc.vlan_tci_mask = htons(0xffff);
- }
- break;
+ vid = match->dl_vlan & htons(VLAN_VID_MASK);
+ pcp = htons((match->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK);
+ tci = vid | pcp | htons(VLAN_CFI);
+ rule->flow.vlan_tci = tci & rule->wc.vlan_tci_mask;
}
/* Clean up. */
cls_rule_zero_wildcarded_fields(rule);
}
-/* Convert 'rule' into the OpenFlow match structure 'match'. 'flow_format'
- * must either NXFF_OPENFLOW10 or NXFF_TUN_ID_FROM_COOKIE.
- *
- * The NXFF_TUN_ID_FROM_COOKIE flow format requires modifying the flow cookie.
- * This function can help with that, if 'cookie_out' is nonnull. For
- * NXFF_OPENFLOW10, or if the tunnel ID is wildcarded, 'cookie_in' will be
- * copied directly to '*cookie_out'. For NXFF_TUN_ID_FROM_COOKIE when tunnel
- * ID is matched, 'cookie_in' will be modified appropriately before setting
- * '*cookie_out'.
- */
+/* Convert 'rule' into the OpenFlow 1.0 match structure 'match'. */
void
-ofputil_cls_rule_to_match(const struct cls_rule *rule,
- enum nx_flow_format flow_format,
- struct ofp_match *match,
- ovs_be64 cookie_in, ovs_be64 *cookie_out)
+ofputil_cls_rule_to_ofp10_match(const struct cls_rule *rule,
+ struct ofp10_match *match)
{
const struct flow_wildcards *wc = &rule->wc;
- unsigned int ofpfw;
+ uint32_t ofpfw;
/* Figure out most OpenFlow wildcards. */
- ofpfw = 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) {
- ofpfw |= OFPFW_NW_TOS;
+ ofpfw = (OVS_FORCE uint32_t) (wc->wildcards & WC_INVARIANTS);
+ ofpfw |= (ofputil_netmask_to_wcbits(wc->nw_src_mask)
+ << OFPFW10_NW_SRC_SHIFT);
+ ofpfw |= (ofputil_netmask_to_wcbits(wc->nw_dst_mask)
+ << OFPFW10_NW_DST_SHIFT);
+ if (wc->wildcards & FWW_NW_DSCP) {
+ ofpfw |= OFPFW10_NW_TOS;
}
-
- /* Tunnel ID. */
- if (flow_format == NXFF_TUN_ID_FROM_COOKIE) {
- if (wc->wildcards & FWW_TUN_ID) {
- ofpfw |= NXFW_TUN_ID;
- } else {
- uint32_t cookie_lo = ntohll(cookie_in);
- uint32_t cookie_hi = ntohll(rule->flow.tun_id);
- cookie_in = htonll(cookie_lo | ((uint64_t) cookie_hi << 32));
- }
+ if (!wc->tp_src_mask) {
+ ofpfw |= OFPFW10_TP_SRC;
+ }
+ if (!wc->tp_dst_mask) {
+ ofpfw |= OFPFW10_TP_DST;
}
- if (cookie_out) {
- *cookie_out = cookie_in;
+ if (eth_addr_is_zero(wc->dl_src_mask)) {
+ ofpfw |= OFPFW10_DL_SRC;
+ }
+ if (eth_addr_is_zero(wc->dl_dst_mask)) {
+ ofpfw |= OFPFW10_DL_DST;
}
/* Translate VLANs. */
match->dl_vlan = htons(0);
match->dl_vlan_pcp = 0;
if (rule->wc.vlan_tci_mask == htons(0)) {
- ofpfw |= OFPFW_DL_VLAN | OFPFW_DL_VLAN_PCP;
+ ofpfw |= OFPFW10_DL_VLAN | OFPFW10_DL_VLAN_PCP;
} else if (rule->wc.vlan_tci_mask & htons(VLAN_CFI)
&& !(rule->flow.vlan_tci & htons(VLAN_CFI))) {
- match->dl_vlan = htons(OFP_VLAN_NONE);
+ match->dl_vlan = htons(OFP10_VLAN_NONE);
+ ofpfw |= OFPFW10_DL_VLAN_PCP;
} else {
if (!(rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) {
- ofpfw |= OFPFW_DL_VLAN;
+ ofpfw |= OFPFW10_DL_VLAN;
} else {
match->dl_vlan = htons(vlan_tci_to_vid(rule->flow.vlan_tci));
}
if (!(rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK))) {
- ofpfw |= OFPFW_DL_VLAN_PCP;
+ ofpfw |= OFPFW10_DL_VLAN_PCP;
} else {
match->dl_vlan_pcp = vlan_tci_to_pcp(rule->flow.vlan_tci);
}
/* Compose most of the match structure. */
match->wildcards = htonl(ofpfw);
- match->in_port = htons(rule->flow.in_port == ODPP_LOCAL ? OFPP_LOCAL
- : rule->flow.in_port);
+ match->in_port = htons(rule->flow.in_port);
memcpy(match->dl_src, rule->flow.dl_src, ETH_ADDR_LEN);
memcpy(match->dl_dst, rule->flow.dl_dst, ETH_ADDR_LEN);
- match->dl_type = rule->flow.dl_type;
+ 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;
memset(match->pad2, '\0', sizeof match->pad2);
}
+/* Converts the ofp11_match in 'match' into a cls_rule in 'rule', with the
+ * given 'priority'. Returns 0 if successful, otherwise an OFPERR_* value. */
+enum ofperr
+ofputil_cls_rule_from_ofp11_match(const struct ofp11_match *match,
+ unsigned int priority,
+ struct cls_rule *rule)
+{
+ uint16_t wc = ntohl(match->wildcards);
+ uint8_t dl_src_mask[ETH_ADDR_LEN];
+ uint8_t dl_dst_mask[ETH_ADDR_LEN];
+ bool ipv4, arp;
+ int i;
+
+ cls_rule_init_catchall(rule, priority);
+
+ if (!(wc & OFPFW11_IN_PORT)) {
+ uint16_t ofp_port;
+ enum ofperr error;
+
+ error = ofputil_port_from_ofp11(match->in_port, &ofp_port);
+ if (error) {
+ return OFPERR_OFPBMC_BAD_VALUE;
+ }
+ cls_rule_set_in_port(rule, ofp_port);
+ }
+
+ for (i = 0; i < ETH_ADDR_LEN; i++) {
+ dl_src_mask[i] = ~match->dl_src_mask[i];
+ }
+ cls_rule_set_dl_src_masked(rule, match->dl_src, dl_src_mask);
+
+ for (i = 0; i < ETH_ADDR_LEN; i++) {
+ dl_dst_mask[i] = ~match->dl_dst_mask[i];
+ }
+ cls_rule_set_dl_dst_masked(rule, match->dl_dst, dl_dst_mask);
+
+ if (!(wc & OFPFW11_DL_VLAN)) {
+ if (match->dl_vlan == htons(OFPVID11_NONE)) {
+ /* Match only packets without a VLAN tag. */
+ rule->flow.vlan_tci = htons(0);
+ rule->wc.vlan_tci_mask = htons(UINT16_MAX);
+ } else {
+ if (match->dl_vlan == htons(OFPVID11_ANY)) {
+ /* Match any packet with a VLAN tag regardless of VID. */
+ rule->flow.vlan_tci = htons(VLAN_CFI);
+ rule->wc.vlan_tci_mask = htons(VLAN_CFI);
+ } else if (ntohs(match->dl_vlan) < 4096) {
+ /* Match only packets with the specified VLAN VID. */
+ rule->flow.vlan_tci = htons(VLAN_CFI) | match->dl_vlan;
+ rule->wc.vlan_tci_mask = htons(VLAN_CFI | VLAN_VID_MASK);
+ } else {
+ /* Invalid VID. */
+ return OFPERR_OFPBMC_BAD_VALUE;
+ }
+
+ if (!(wc & OFPFW11_DL_VLAN_PCP)) {
+ if (match->dl_vlan_pcp <= 7) {
+ rule->flow.vlan_tci |= htons(match->dl_vlan_pcp
+ << VLAN_PCP_SHIFT);
+ rule->wc.vlan_tci_mask |= htons(VLAN_PCP_MASK);
+ } else {
+ /* Invalid PCP. */
+ return OFPERR_OFPBMC_BAD_VALUE;
+ }
+ }
+ }
+ }
+
+ if (!(wc & OFPFW11_DL_TYPE)) {
+ cls_rule_set_dl_type(rule,
+ ofputil_dl_type_from_openflow(match->dl_type));
+ }
+
+ ipv4 = rule->flow.dl_type == htons(ETH_TYPE_IP);
+ arp = rule->flow.dl_type == htons(ETH_TYPE_ARP);
+
+ if (ipv4 && !(wc & OFPFW11_NW_TOS)) {
+ if (match->nw_tos & ~IP_DSCP_MASK) {
+ /* Invalid TOS. */
+ return OFPERR_OFPBMC_BAD_VALUE;
+ }
+
+ cls_rule_set_nw_dscp(rule, match->nw_tos);
+ }
+
+ if (ipv4 || arp) {
+ if (!(wc & OFPFW11_NW_PROTO)) {
+ cls_rule_set_nw_proto(rule, match->nw_proto);
+ }
+ cls_rule_set_nw_src_masked(rule, match->nw_src, ~match->nw_src_mask);
+ cls_rule_set_nw_dst_masked(rule, match->nw_dst, ~match->nw_dst_mask);
+ }
+
+#define OFPFW11_TP_ALL (OFPFW11_TP_SRC | OFPFW11_TP_DST)
+ if (ipv4 && (wc & OFPFW11_TP_ALL) != OFPFW11_TP_ALL) {
+ switch (rule->flow.nw_proto) {
+ case IPPROTO_ICMP:
+ /* "A.2.3 Flow Match Structures" in OF1.1 says:
+ *
+ * The tp_src and tp_dst fields will be ignored unless the
+ * network protocol specified is as TCP, UDP or SCTP.
+ *
+ * but I'm pretty sure we should support ICMP too, otherwise
+ * that's a regression from OF1.0. */
+ if (!(wc & OFPFW11_TP_SRC)) {
+ uint16_t icmp_type = ntohs(match->tp_src);
+ if (icmp_type < 0x100) {
+ cls_rule_set_icmp_type(rule, icmp_type);
+ } else {
+ return OFPERR_OFPBMC_BAD_FIELD;
+ }
+ }
+ if (!(wc & OFPFW11_TP_DST)) {
+ uint16_t icmp_code = ntohs(match->tp_dst);
+ if (icmp_code < 0x100) {
+ cls_rule_set_icmp_code(rule, icmp_code);
+ } else {
+ return OFPERR_OFPBMC_BAD_FIELD;
+ }
+ }
+ break;
+
+ case IPPROTO_TCP:
+ case IPPROTO_UDP:
+ if (!(wc & (OFPFW11_TP_SRC))) {
+ cls_rule_set_tp_src(rule, match->tp_src);
+ }
+ if (!(wc & (OFPFW11_TP_DST))) {
+ cls_rule_set_tp_dst(rule, match->tp_dst);
+ }
+ break;
+
+ case IPPROTO_SCTP:
+ /* We don't support SCTP and it seems that we should tell the
+ * controller, since OF1.1 implementations are supposed to. */
+ return OFPERR_OFPBMC_BAD_FIELD;
+
+ default:
+ /* OF1.1 says explicitly to ignore this. */
+ break;
+ }
+ }
+
+ if (rule->flow.dl_type == htons(ETH_TYPE_MPLS) ||
+ rule->flow.dl_type == htons(ETH_TYPE_MPLS_MCAST)) {
+ enum { OFPFW11_MPLS_ALL = OFPFW11_MPLS_LABEL | OFPFW11_MPLS_TC };
+
+ if ((wc & OFPFW11_MPLS_ALL) != OFPFW11_MPLS_ALL) {
+ /* MPLS not supported. */
+ return OFPERR_OFPBMC_BAD_TAG;
+ }
+ }
+
+ if (match->metadata_mask != htonll(UINT64_MAX)) {
+ cls_rule_set_metadata_masked(rule, match->metadata,
+ ~match->metadata_mask);
+ }
+
+ return 0;
+}
+
+/* Convert 'rule' into the OpenFlow 1.1 match structure 'match'. */
+void
+ofputil_cls_rule_to_ofp11_match(const struct cls_rule *rule,
+ struct ofp11_match *match)
+{
+ uint32_t wc = 0;
+ int i;
+
+ memset(match, 0, sizeof *match);
+ match->omh.type = htons(OFPMT_STANDARD);
+ match->omh.length = htons(OFPMT11_STANDARD_LENGTH);
+
+ if (rule->wc.wildcards & FWW_IN_PORT) {
+ wc |= OFPFW11_IN_PORT;
+ } else {
+ match->in_port = ofputil_port_to_ofp11(rule->flow.in_port);
+ }
+
+
+ memcpy(match->dl_src, rule->flow.dl_src, ETH_ADDR_LEN);
+ for (i = 0; i < ETH_ADDR_LEN; i++) {
+ match->dl_src_mask[i] = ~rule->wc.dl_src_mask[i];
+ }
+
+ memcpy(match->dl_dst, rule->flow.dl_dst, ETH_ADDR_LEN);
+ for (i = 0; i < ETH_ADDR_LEN; i++) {
+ match->dl_dst_mask[i] = ~rule->wc.dl_dst_mask[i];
+ }
+
+ if (rule->wc.vlan_tci_mask == htons(0)) {
+ wc |= OFPFW11_DL_VLAN | OFPFW11_DL_VLAN_PCP;
+ } else if (rule->wc.vlan_tci_mask & htons(VLAN_CFI)
+ && !(rule->flow.vlan_tci & htons(VLAN_CFI))) {
+ match->dl_vlan = htons(OFPVID11_NONE);
+ wc |= OFPFW11_DL_VLAN_PCP;
+ } else {
+ if (!(rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) {
+ match->dl_vlan = htons(OFPVID11_ANY);
+ } else {
+ match->dl_vlan = htons(vlan_tci_to_vid(rule->flow.vlan_tci));
+ }
+
+ if (!(rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK))) {
+ wc |= OFPFW11_DL_VLAN_PCP;
+ } else {
+ match->dl_vlan_pcp = vlan_tci_to_pcp(rule->flow.vlan_tci);
+ }
+ }
+
+ if (rule->wc.wildcards & FWW_DL_TYPE) {
+ wc |= OFPFW11_DL_TYPE;
+ } else {
+ match->dl_type = ofputil_dl_type_to_openflow(rule->flow.dl_type);
+ }
+
+ if (rule->wc.wildcards & FWW_NW_DSCP) {
+ wc |= OFPFW11_NW_TOS;
+ } else {
+ match->nw_tos = rule->flow.nw_tos & IP_DSCP_MASK;
+ }
+
+ if (rule->wc.wildcards & FWW_NW_PROTO) {
+ wc |= OFPFW11_NW_PROTO;
+ } else {
+ match->nw_proto = rule->flow.nw_proto;
+ }
+
+ match->nw_src = rule->flow.nw_src;
+ match->nw_src_mask = ~rule->wc.nw_src_mask;
+ match->nw_dst = rule->flow.nw_dst;
+ match->nw_dst_mask = ~rule->wc.nw_dst_mask;
+
+ if (!rule->wc.tp_src_mask) {
+ wc |= OFPFW11_TP_SRC;
+ } else {
+ match->tp_src = rule->flow.tp_src;
+ }
+
+ if (!rule->wc.tp_dst_mask) {
+ wc |= OFPFW11_TP_DST;
+ } else {
+ match->tp_dst = rule->flow.tp_dst;
+ }
+
+ /* MPLS not supported. */
+ wc |= OFPFW11_MPLS_LABEL;
+ wc |= OFPFW11_MPLS_TC;
+
+ match->metadata = rule->flow.metadata;
+ match->metadata_mask = ~rule->wc.metadata_mask;
+
+ match->wildcards = htonl(wc);
+}
+
+/* Given a 'dl_type' value in the format used in struct flow, returns the
+ * corresponding 'dl_type' value for use in an ofp10_match or ofp11_match
+ * structure. */
+ovs_be16
+ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type)
+{
+ return (flow_dl_type == htons(FLOW_DL_TYPE_NONE)
+ ? htons(OFP_DL_TYPE_NOT_ETH_TYPE)
+ : flow_dl_type);
+}
+
+/* Given a 'dl_type' value in the format used in an ofp10_match or ofp11_match
+ * structure, returns the corresponding 'dl_type' value for use in struct
+ * flow. */
+ovs_be16
+ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type)
+{
+ return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
+ ? htons(FLOW_DL_TYPE_NONE)
+ : ofp_dl_type);
+}
+
/* Returns a transaction ID to use for an outgoing OpenFlow message. */
static ovs_be32
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. */
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;
}
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)
{
static const struct ofputil_msg_type nxt_messages[] = {
- { OFPUTIL_NXT_STATUS_REQUEST,
- NXT_STATUS_REQUEST, "NXT_STATUS_REQUEST",
- sizeof(struct nicira_header), 1 },
-
- { OFPUTIL_NXT_STATUS_REPLY,
- NXT_STATUS_REPLY, "NXT_STATUS_REPLY",
- sizeof(struct nicira_header), 1 },
-
- { OFPUTIL_NXT_TUN_ID_FROM_COOKIE,
- NXT_TUN_ID_FROM_COOKIE, "NXT_TUN_ID_FROM_COOKIE",
- sizeof(struct nxt_tun_id_cookie), 0 },
-
- { 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_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_FLOW_MOD,
+ { 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, OFP10_VERSION,
+ NXT_FLOW_MOD_TABLE_ID, "NXT_FLOW_MOD_TABLE_ID",
+ 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 },
+
+ { OFPUTIL_NXT_FLOW_MONITOR_CANCEL, OFP10_VERSION,
+ NXT_FLOW_MONITOR_CANCEL, "NXT_FLOW_MONITOR_CANCEL",
+ sizeof(struct nx_flow_monitor_cancel), 0 },
+
+ { OFPUTIL_NXT_FLOW_MONITOR_PAUSED, OFP10_VERSION,
+ NXT_FLOW_MONITOR_PAUSED, "NXT_FLOW_MONITOR_PAUSED",
+ sizeof(struct nicira_header), 0 },
+
+ { OFPUTIL_NXT_FLOW_MONITOR_RESUMED, OFP10_VERSION,
+ NXT_FLOW_MONITOR_RESUMED, "NXT_FLOW_MONITOR_RESUMED",
+ sizeof(struct nicira_header), 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_request *osr;
+ const struct ofp_stats_msg *osm = (const struct ofp_stats_msg *) oh;
ovs_be32 vendor;
- osr = (const struct ofp_stats_request *) oh;
+ 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, osr->body, sizeof vendor);
+ 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(osr->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 },
+
+ { OFPUTIL_NXST_FLOW_MONITOR_REQUEST, OFP10_VERSION,
+ NXST_FLOW_MONITOR, "NXST_FLOW_MONITOR request",
+ sizeof(struct nicira_stats_msg), 8 },
};
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 },
+
+ { OFPUTIL_NXST_FLOW_MONITOR_REPLY, OFP10_VERSION,
+ NXST_FLOW_MONITOR, "NXST_FLOW_MONITOR reply",
+ sizeof(struct nicira_stats_msg), 8 },
};
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)
{
- enum { OSR_SIZE = sizeof(struct ofp_stats_request) };
static const struct ofputil_msg_type ofpst_requests[] = {
- { OFPUTIL_OFPST_DESC_REQUEST,
+ { OFPUTIL_OFPST_DESC_REQUEST, OFP10_VERSION,
OFPST_DESC, "OFPST_DESC request",
- OSR_SIZE, 0 },
+ sizeof(struct ofp_stats_msg), 0 },
- { OFPUTIL_OFPST_FLOW_REQUEST,
+ { OFPUTIL_OFPST_FLOW_REQUEST, OFP10_VERSION,
OFPST_FLOW, "OFPST_FLOW request",
- OSR_SIZE + sizeof(struct ofp_flow_stats_request), 0 },
+ sizeof(struct ofp_flow_stats_request), 0 },
- { OFPUTIL_OFPST_AGGREGATE_REQUEST,
+ { OFPUTIL_OFPST_AGGREGATE_REQUEST, OFP10_VERSION,
OFPST_AGGREGATE, "OFPST_AGGREGATE request",
- OSR_SIZE + sizeof(struct ofp_aggregate_stats_request), 0 },
+ sizeof(struct ofp_flow_stats_request), 0 },
- { OFPUTIL_OFPST_TABLE_REQUEST,
+ { OFPUTIL_OFPST_TABLE_REQUEST, OFP10_VERSION,
OFPST_TABLE, "OFPST_TABLE request",
- OSR_SIZE, 0 },
+ sizeof(struct ofp_stats_msg), 0 },
- { OFPUTIL_OFPST_PORT_REQUEST,
+ { OFPUTIL_OFPST_PORT_REQUEST, OFP10_VERSION,
OFPST_PORT, "OFPST_PORT request",
- OSR_SIZE + sizeof(struct ofp_port_stats_request), 0 },
+ sizeof(struct ofp_port_stats_request), 0 },
- { OFPUTIL_OFPST_QUEUE_REQUEST,
+ { OFPUTIL_OFPST_QUEUE_REQUEST, OFP10_VERSION,
OFPST_QUEUE, "OFPST_QUEUE request",
- OSR_SIZE + sizeof(struct ofp_queue_stats_request), 0 },
+ sizeof(struct ofp_queue_stats_request), 0 },
- { 0,
+ { OFPUTIL_OFPST_PORT_DESC_REQUEST, OFP10_VERSION,
+ OFPST_PORT_DESC, "OFPST_PORT_DESC request",
+ sizeof(struct ofp_stats_msg), 0 },
+
+ { 0, 0,
OFPST_VENDOR, "OFPST_VENDOR request",
- OSR_SIZE + sizeof(uint32_t), 1 },
+ sizeof(struct ofp_vendor_stats_msg), 1 },
};
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_request *osr;
- int error;
+ const struct ofp_stats_msg *request = (const struct ofp_stats_msg *) oh;
+ enum ofperr error;
+
+ error = check_stats_msg(oh, length);
+ if (error) {
+ return error;
+ }
- osr = (const struct ofp_stats_request *) oh;
error = ofputil_lookup_openflow_message(&ofpst_request_category,
- ntohs(osr->type),
- ntohs(oh->length), typep);
- if (!error && osr->type == htons(OFPST_VENDOR)) {
- error = ofputil_decode_nxst_request(oh, typep);
+ oh->version, ntohs(request->type),
+ typep);
+ if (!error && request->type == htons(OFPST_VENDOR)) {
+ 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)
{
- enum { OSR_SIZE = sizeof(struct ofp_stats_reply) };
static const struct ofputil_msg_type ofpst_replies[] = {
- { OFPUTIL_OFPST_DESC_REPLY,
+ { OFPUTIL_OFPST_DESC_REPLY, OFP10_VERSION,
OFPST_DESC, "OFPST_DESC reply",
- OSR_SIZE + sizeof(struct ofp_desc_stats), 0 },
+ sizeof(struct ofp_desc_stats), 0 },
- { OFPUTIL_OFPST_FLOW_REPLY,
+ { OFPUTIL_OFPST_FLOW_REPLY, OFP10_VERSION,
OFPST_FLOW, "OFPST_FLOW reply",
- OSR_SIZE, 1 },
+ sizeof(struct ofp_stats_msg), 1 },
- { OFPUTIL_OFPST_AGGREGATE_REPLY,
+ { OFPUTIL_OFPST_AGGREGATE_REPLY, OFP10_VERSION,
OFPST_AGGREGATE, "OFPST_AGGREGATE reply",
- OSR_SIZE + sizeof(struct ofp_aggregate_stats_reply), 0 },
+ sizeof(struct ofp_aggregate_stats_reply), 0 },
- { OFPUTIL_OFPST_TABLE_REPLY,
+ { OFPUTIL_OFPST_TABLE_REPLY, OFP10_VERSION,
OFPST_TABLE, "OFPST_TABLE reply",
- OSR_SIZE, sizeof(struct ofp_table_stats) },
+ 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",
- OSR_SIZE, sizeof(struct ofp_port_stats) },
+ 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",
- OSR_SIZE, sizeof(struct ofp_queue_stats) },
+ sizeof(struct ofp_stats_msg), sizeof(struct ofp_queue_stats) },
+
+ { OFPUTIL_OFPST_PORT_DESC_REPLY, OFP10_VERSION,
+ OFPST_PORT_DESC, "OFPST_PORT_DESC reply",
+ sizeof(struct ofp_stats_msg), sizeof(struct ofp10_phy_port) },
- { 0,
+ { 0, 0,
OFPST_VENDOR, "OFPST_VENDOR reply",
- OSR_SIZE + sizeof(uint32_t), 1 },
+ sizeof(struct ofp_vendor_stats_msg), 1 },
};
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_reply *osr = (const struct ofp_stats_reply *) oh;
- int error;
+ const struct ofp_stats_msg *reply = (const struct ofp_stats_msg *) oh;
+ enum ofperr error;
+
+ error = check_stats_msg(oh, length);
+ if (error) {
+ return error;
+ }
- error = ofputil_lookup_openflow_message(&ofpst_reply_category,
- ntohs(osr->type),
- ntohs(oh->length), typep);
- if (!error && osr->type == htons(OFPST_VENDOR)) {
- error = ofputil_decode_nxst_reply(oh, typep);
+ 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, 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) },
+ sizeof(struct ofp_switch_features), sizeof(struct ofp10_phy_port) },
+ { OFPUTIL_OFPT_FEATURES_REPLY, OFP11_VERSION,
+ OFPT_FEATURES_REPLY, "OFPT_FEATURES_REPLY",
+ sizeof(struct ofp_switch_features), sizeof(struct ofp11_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) + sizeof(struct ofp10_phy_port), 0 },
+ { OFPUTIL_OFPT_PORT_STATUS, OFP11_VERSION,
OFPT_PORT_STATUS, "OFPT_PORT_STATUS",
- sizeof(struct ofp_port_status), 0 },
+ sizeof(struct ofp_port_status) + sizeof(struct ofp11_port), 0 },
- { OFPUTIL_OFPT_PACKET_OUT,
+ { OFPUTIL_OFPT_PACKET_OUT, OFP10_VERSION,
OFPT_PACKET_OUT, "OFPT_PACKET_OUT",
sizeof(struct ofp_packet_out), 1 },
- { OFPUTIL_OFPT_FLOW_MOD,
+ { OFPUTIL_OFPT_FLOW_MOD, OFP10_VERSION,
OFPT_FLOW_MOD, "OFPT_FLOW_MOD",
sizeof(struct ofp_flow_mod), 1 },
- { OFPUTIL_OFPT_PORT_MOD,
- OFPT_PORT_MOD, "OFPT_PORT_MOD",
- sizeof(struct ofp_port_mod), 0 },
+ { OFPUTIL_OFPT_PORT_MOD, OFP10_VERSION,
+ OFPT10_PORT_MOD, "OFPT_PORT_MOD",
+ sizeof(struct ofp10_port_mod), 0 },
+ { OFPUTIL_OFPT_PORT_MOD, OFP11_VERSION,
+ OFPT11_PORT_MOD, "OFPT_PORT_MOD",
+ sizeof(struct ofp11_port_mod), 0 },
- { 0,
- OFPT_STATS_REQUEST, "OFPT_STATS_REQUEST",
- sizeof(struct ofp_stats_request), 1 },
+ { 0, OFP10_VERSION,
+ OFPT10_STATS_REQUEST, "OFPT_STATS_REQUEST",
+ sizeof(struct ofp_stats_msg), 1 },
- { 0,
- OFPT_STATS_REPLY, "OFPT_STATS_REPLY",
- sizeof(struct ofp_stats_reply), 1 },
+ { 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 },
};
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;
return type->code;
}
\f
-/* Flow formats. */
+/* Protocols. */
-bool
-ofputil_flow_format_is_valid(enum nx_flow_format flow_format)
+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 (flow_format) {
- case NXFF_OPENFLOW10:
- case NXFF_TUN_ID_FROM_COOKIE:
- case NXFF_NXM:
- return true;
+ switch (version) {
+ case OFP10_VERSION: return OFPUTIL_P_OF10;
+ default: return 0;
+ }
+}
+
+/* Returns the OpenFlow protocol version number (e.g. OFP10_VERSION or
+ * OFP11_VERSION) that corresponds to 'protocol'. */
+uint8_t
+ofputil_protocol_to_ofp_version(enum ofputil_protocol protocol)
+{
+ switch (protocol) {
+ case OFPUTIL_P_OF10:
+ case OFPUTIL_P_OF10_TID:
+ case OFPUTIL_P_NXM:
+ case OFPUTIL_P_NXM_TID:
+ return OFP10_VERSION;
+ }
+
+ NOT_REACHED();
+}
+
+/* Returns true if 'protocol' is a single OFPUTIL_P_* value, false
+ * otherwise. */
+bool
+ofputil_protocol_is_valid(enum ofputil_protocol protocol)
+{
+ 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;
}
return false;
}
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_TUN_ID_FROM_COOKIE:
- return "tun_id_from_cookie";
- case NXFF_NXM:
+ case NXPIF_NXM:
return "nxm";
default:
NOT_REACHED();
}
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, "tun_id_from_cookie") ? NXFF_TUN_ID_FROM_COOKIE
- : !strcmp(s, "nxm") ? NXFF_NXM
+ return (!strcmp(s, "openflow10") ? NXPIF_OPENFLOW10
+ : !strcmp(s, "nxm") ? NXPIF_NXM
: -1);
}
return true;
}
-/* Returns the minimum nx_flow_format to use for sending 'rule' to a switch
- * (e.g. to add or remove a flow). 'cookie_support' should be true if the
- * command to be sent includes a flow cookie (as OFPT_FLOW_MOD does, for
- * example) or false if the command does not (OFPST_FLOW and OFPST_AGGREGATE do
- * not, for example). If 'cookie_support' is true, then 'cookie' should be the
- * cookie to be sent; otherwise its value is ignored.
- *
- * The "best" flow format is chosen on this basis:
- *
- * - It must be capable of expressing the rule. NXFF_OPENFLOW10 flows can't
- * handle tunnel IDs. NXFF_TUN_ID_FROM_COOKIE flows can't handle registers
- * or fixing the Ethernet multicast bit, and can't handle tunnel IDs that
- * conflict with the high 32 bits of the cookie or commands that don't
- * support cookies.
- *
- * - Otherwise, the chosen format should be as backward compatible as
- * possible. (NXFF_OPENFLOW10 is more backward compatible than
- * NXFF_TUN_ID_FROM_COOKIE, which is more backward compatible than
- * NXFF_NXM.)
- */
-enum nx_flow_format
-ofputil_min_flow_format(const struct cls_rule *rule, bool cookie_support,
- ovs_be64 cookie)
+/* 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;
- ovs_be32 cookie_hi = htonl(ntohll(cookie) >> 32);
-
- if (!(wc->wildcards & FWW_DL_DST) != !(wc->wildcards & FWW_ETH_MCAST)
- || !regs_fully_wildcarded(wc)
- || (!(wc->wildcards & FWW_TUN_ID)
- && (!cookie_support
- || (cookie_hi && cookie_hi != ntohll(rule->flow.tun_id))))) {
- return NXFF_NXM;
- } else if (!(wc->wildcards & FWW_TUN_ID)) {
- return NXFF_TUN_ID_FROM_COOKIE;
- } else {
- return NXFF_OPENFLOW10;
+
+ BUILD_ASSERT_DECL(FLOW_WC_SEQ == 14);
+
+ /* NXM and OF1.1+ supports bitwise matching on ethernet addresses. */
+ if (!eth_mask_is_exact(wc->dl_src_mask)
+ && !eth_addr_is_zero(wc->dl_src_mask)) {
+ return OFPUTIL_P_NXM_ANY;
+ }
+ if (!eth_mask_is_exact(wc->dl_dst_mask)
+ && !eth_addr_is_zero(wc->dl_dst_mask)) {
+ return OFPUTIL_P_NXM_ANY;
+ }
+
+ /* NXM and OF1.1+ support matching metadata. */
+ if (wc->metadata_mask != htonll(0)) {
+ return OFPUTIL_P_NXM_ANY;
+ }
+
+ /* Only NXM supports matching ARP hardware addresses. */
+ if (!eth_addr_is_zero(wc->arp_sha_mask) ||
+ !eth_addr_is_zero(wc->arp_tha_mask)) {
+ 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 OFPUTIL_P_NXM_ANY;
+ }
+
+ /* Only NXM supports matching registers. */
+ if (!regs_fully_wildcarded(wc)) {
+ return OFPUTIL_P_NXM_ANY;
+ }
+
+ /* Only NXM supports matching tun_id. */
+ if (wc->tun_id_mask != htonll(0)) {
+ 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->ipv6_label_mask) {
+ 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 non-CIDR IPv4 address masks. */
+ if (!ip_is_cidr(wc->nw_src_mask) || !ip_is_cidr(wc->nw_dst_mask)) {
+ 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 OFPUTIL_P_ANY;
+}
+
+/* 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 OpenFlow message that can be used to set the flow format to
- * 'flow_format'. */
+/* 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 nx_set_flow_format *sff;
struct ofpbuf *msg;
- if (flow_format == NXFF_OPENFLOW10
- || flow_format == NXFF_TUN_ID_FROM_COOKIE) {
- struct nxt_tun_id_cookie *tic;
+ assert(ofputil_nx_flow_format_is_valid(nxff));
- tic = make_nxmsg(sizeof *tic, NXT_TUN_ID_FROM_COOKIE, &msg);
- tic->set = flow_format == NXFF_TUN_ID_FROM_COOKIE;
- } else {
- struct nxt_set_flow_format *sff;
+ sff = make_nxmsg(sizeof *sff, NXT_SET_FLOW_FORMAT, &msg);
+ 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;
+}
- sff = make_nxmsg(sizeof *sff, NXT_SET_FLOW_FORMAT, &msg);
- sff->format = htonl(flow_format);
+/* 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;
}
+/* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
+ * extension on or off (according to 'flow_mod_table_id'). */
+struct ofpbuf *
+ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
+{
+ struct nx_flow_mod_table_id *nfmti;
+ struct ofpbuf *msg;
+
+ nfmti = make_nxmsg(sizeof *nfmti, NXT_FLOW_MOD_TABLE_ID, &msg);
+ nfmti->set = flow_mod_table_id;
+ return msg;
+}
+
/* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
* flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
* code.
*
- * For OFPT_FLOW_MOD messages, 'flow_format' should be the current flow format
- * at the time when the message was received. Otherwise 'flow_format' is
- * ignored.
+ * Uses 'ofpacts' to store the abstract OFPACT_* version of 'oh''s actions.
+ * The caller must initialize 'ofpacts' and retains ownership of it.
+ * 'fm->ofpacts' will point into the 'ofpacts' buffer.
*
- * Does not validate the flow_mod actions. */
-int
-ofputil_decode_flow_mod(struct flow_mod *fm, const struct ofp_header *oh,
- enum nx_flow_format flow_format)
+ * Does not validate the flow_mod actions. The caller should do that, with
+ * ofpacts_check(). */
+enum ofperr
+ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
+ const struct ofp_header *oh,
+ enum ofputil_protocol protocol,
+ struct ofpbuf *ofpacts)
{
const struct ofputil_msg_type *type;
+ uint16_t command;
struct ofpbuf b;
ofpbuf_use_const(&b, oh, ntohs(oh->length));
ofputil_decode_msg_type(oh, &type);
if (ofputil_msg_type_code(type) == OFPUTIL_OFPT_FLOW_MOD) {
/* Standard OpenFlow flow_mod. */
- struct ofp_match match, orig_match;
const struct ofp_flow_mod *ofm;
- int error;
+ uint16_t priority;
+ enum ofperr error;
- /* Dissect the message. */
+ /* Get the ofp_flow_mod. */
ofm = ofpbuf_pull(&b, sizeof *ofm);
- error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
- if (error) {
- return error;
+
+ /* Set priority based on original wildcards. Normally we'd allow
+ * ofputil_cls_rule_from_match() to do this for us, but
+ * ofputil_normalize_rule() can put wildcards where the original flow
+ * didn't have them. */
+ priority = ntohs(ofm->priority);
+ if (!(ofm->match.wildcards & htonl(OFPFW10_ALL))) {
+ priority = UINT16_MAX;
}
- /* Normalize ofm->match. If normalization actually changes anything,
- * then log the differences. */
- match = ofm->match;
- match.pad1[0] = match.pad2[0] = 0;
- orig_match = match;
- normalize_match(&match);
- if (memcmp(&match, &orig_match, sizeof orig_match)) {
- if (!VLOG_DROP_INFO(&bad_ofmsg_rl)) {
- char *old = ofp_match_to_literal_string(&orig_match);
- char *new = ofp_match_to_literal_string(&match);
- VLOG_INFO("normalization changed ofp_match, details:");
- VLOG_INFO(" pre: %s", old);
- VLOG_INFO("post: %s", new);
- free(old);
- free(new);
- }
+ /* Translate the rule. */
+ ofputil_cls_rule_from_ofp10_match(&ofm->match, priority, &fm->cr);
+ ofputil_normalize_rule(&fm->cr);
+
+ /* Now get the actions. */
+ error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
+ if (error) {
+ return error;
}
/* Translate the message. */
- ofputil_cls_rule_from_match(&match, ntohs(ofm->priority), flow_format,
- ofm->cookie, &fm->cr);
- fm->cookie = ofm->cookie;
- fm->command = ntohs(ofm->command);
+ command = ntohs(ofm->command);
+ fm->cookie = htonll(0);
+ fm->cookie_mask = htonll(0);
+ fm->new_cookie = ofm->cookie;
fm->idle_timeout = ntohs(ofm->idle_timeout);
fm->hard_timeout = ntohs(ofm->hard_timeout);
fm->buffer_id = ntohl(ofm->buffer_id);
} 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;
}
- error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
+ error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
if (error) {
return error;
}
/* Translate the message. */
- fm->cookie = nfm->cookie;
- fm->command = ntohs(nfm->command);
+ command = ntohs(nfm->command);
+ if ((command & 0xff) == OFPFC_ADD && fm->cookie_mask) {
+ /* Flow additions may only set a new cookie, not match an
+ * existing cookie. */
+ return OFPERR_NXBRC_NXM_INVALID;
+ }
+ fm->new_cookie = nfm->cookie;
fm->idle_timeout = ntohs(nfm->idle_timeout);
fm->hard_timeout = ntohs(nfm->hard_timeout);
fm->buffer_id = ntohl(nfm->buffer_id);
NOT_REACHED();
}
+ fm->ofpacts = ofpacts->data;
+ fm->ofpacts_len = ofpacts->size;
+ if (protocol & OFPUTIL_P_TID) {
+ fm->command = command & 0xff;
+ fm->table_id = command >> 8;
+ } else {
+ fm->command = command;
+ fm->table_id = 0xff;
+ }
+
return 0;
}
/* 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. */
struct ofpbuf *
-ofputil_encode_flow_mod(const struct flow_mod *fm,
- enum nx_flow_format flow_format)
+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;
- if (flow_format == NXFF_OPENFLOW10
- || flow_format == NXFF_TUN_ID_FROM_COOKIE) {
- struct ofp_flow_mod *ofm;
+ command = (protocol & OFPUTIL_P_TID
+ ? (fm->command & 0xff) | (fm->table_id << 8)
+ : fm->command);
- msg = ofpbuf_new(sizeof *ofm + actions_len);
+ switch (protocol) {
+ case OFPUTIL_P_OF10:
+ case OFPUTIL_P_OF10_TID:
+ msg = ofpbuf_new(sizeof *ofm + fm->ofpacts_len);
ofm = put_openflow(sizeof *ofm, OFPT_FLOW_MOD, msg);
- ofputil_cls_rule_to_match(&fm->cr, flow_format, &ofm->match,
- fm->cookie, &ofm->cookie);
- ofm->command = htons(fm->command);
+ ofputil_cls_rule_to_ofp10_match(&fm->cr, &ofm->match);
+ ofm->cookie = fm->new_cookie;
+ 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;
- msg = ofpbuf_new(sizeof *nfm + NXM_TYPICAL_LEN + actions_len);
+ case OFPUTIL_P_NXM:
+ case OFPUTIL_P_NXM_TID:
+ msg = ofpbuf_new(sizeof *nfm + NXM_TYPICAL_LEN + fm->ofpacts_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(fm->command);
+ nfm->command = htons(command);
+ nfm->cookie = fm->new_cookie;
+ match_len = nx_put_match(msg, false, &fm->cr,
+ fm->cookie, fm->cookie_mask);
+ nfm = msg->data;
nfm->idle_timeout = htons(fm->idle_timeout);
nfm->hard_timeout = htons(fm->hard_timeout);
nfm->priority = htons(fm->cr.priority);
nfm->out_port = htons(fm->out_port);
nfm->flags = htons(fm->flags);
nfm->match_len = htons(match_len);
- } else {
+ break;
+
+ default:
NOT_REACHED();
}
- ofpbuf_put(msg, fm->actions, actions_len);
+ if (fm->ofpacts) {
+ ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
+ }
update_openflow_length(msg);
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;
+ }
+
+ /* Matching of the cookie is only supported through NXM. */
+ if (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,
- enum nx_flow_format flow_format,
bool aggregate)
{
- const struct ofp_flow_stats_request *ofsr = ofputil_stats_body(oh);
+ const struct ofp_flow_stats_request *ofsr =
+ (const struct ofp_flow_stats_request *) oh;
fsr->aggregate = aggregate;
- ofputil_cls_rule_from_match(&ofsr->match, 0, flow_format, 0, &fsr->match);
+ ofputil_cls_rule_from_ofp10_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;
}
/* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
- * message 'oh', received when the current flow format was 'flow_format', into
- * an abstract flow_stats_request in 'fsr'. Returns 0 if successful, otherwise
- * an OpenFlow error code.
- *
- * For OFPST_FLOW and OFPST_AGGREGATE messages, 'flow_format' should be the
- * current flow format at the time when the message was received. Otherwise
- * 'flow_format' is ignored. */
-int
-ofputil_decode_flow_stats_request(struct flow_stats_request *fsr,
- const struct ofp_header *oh,
- enum nx_flow_format flow_format)
+ * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
+ * successful, otherwise an OpenFlow error code. */
+enum ofperr
+ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
+ const struct ofp_header *oh)
{
const struct ofputil_msg_type *type;
struct ofpbuf b;
code = ofputil_msg_type_code(type);
switch (code) {
case OFPUTIL_OFPST_FLOW_REQUEST:
- return ofputil_decode_ofpst_flow_request(fsr, oh, flow_format, false);
+ return ofputil_decode_ofpst_flow_request(fsr, oh, false);
case OFPUTIL_OFPST_AGGREGATE_REQUEST:
- return ofputil_decode_ofpst_flow_request(fsr, oh, flow_format, true);
+ return ofputil_decode_ofpst_flow_request(fsr, oh, true);
case OFPUTIL_NXST_FLOW_REQUEST:
return ofputil_decode_nxst_flow_request(fsr, oh, false);
}
/* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
- * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE message 'oh' according to
- * 'flow_format', and returns the message. */
+ * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
+ * '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
- || flow_format == NXFF_TUN_ID_FROM_COOKIE) {
+ switch (protocol) {
+ case OFPUTIL_P_OF10:
+ case OFPUTIL_P_OF10_TID: {
struct ofp_flow_stats_request *ofsr;
int type;
- BUILD_ASSERT_DECL(sizeof(struct ofp_flow_stats_request)
- == sizeof(struct ofp_aggregate_stats_request));
-
type = fsr->aggregate ? OFPST_AGGREGATE : OFPST_FLOW;
- ofsr = ofputil_make_stats_request(sizeof *ofsr, type, &msg);
- ofputil_cls_rule_to_match(&fsr->match, flow_format, &ofsr->match,
- 0, NULL);
+ ofsr = ofputil_make_stats_request(sizeof *ofsr, type, 0, &msg);
+ ofputil_cls_rule_to_ofp10_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_nxstats_request(sizeof *nfsr, subtype, &msg);
- match_len = nx_put_match(msg, &fsr->match);
+ ofputil_make_stats_request(sizeof *nfsr, OFPST_VENDOR, subtype, &msg);
+ match_len = nx_put_match(msg, false, &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;
}
-/* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh', received
- * when the current flow format was 'flow_format', into an abstract
- * ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise an
- * OpenFlow error code.
+/* 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'.
+ *
+ * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
+ * OpenFlow message. Calling this function multiple times for a single 'msg'
+ * iterates through the replies. The caller must initially leave 'msg''s layer
+ * pointers null and not modify them between calls.
+ *
+ * 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'.
*
- * For OFPT_FLOW_REMOVED messages, 'flow_format' should be the current flow
- * format at the time when the message was received. Otherwise 'flow_format'
- * is ignored. */
+ * Uses 'ofpacts' to store the abstract OFPACT_* version of the flow stats
+ * reply's actions. The caller must initialize 'ofpacts' and retains ownership
+ * of it. 'fs->ofpacts' will point into the 'ofpacts' buffer.
+ *
+ * Returns 0 if successful, EOF if no replies were left in this 'msg',
+ * otherwise a positive errno value. */
int
-ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
- const struct ofp_header *oh,
- enum nx_flow_format flow_format)
+ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
+ struct ofpbuf *msg,
+ bool flow_age_extension,
+ struct ofpbuf *ofpacts)
{
const struct ofputil_msg_type *type;
- enum ofputil_msg_code code;
+ int code;
- ofputil_decode_msg_type(oh, &type);
+ ofputil_decode_msg_type(msg->l2 ? msg->l2 : msg->data, &type);
code = ofputil_msg_type_code(type);
- if (code == OFPUTIL_OFPT_FLOW_REMOVED) {
- const struct ofp_flow_removed *ofr;
+ if (!msg->l2) {
+ msg->l2 = msg->data;
+ if (code == OFPUTIL_OFPST_FLOW_REPLY) {
+ ofpbuf_pull(msg, sizeof(struct ofp_stats_msg));
+ } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
+ ofpbuf_pull(msg, sizeof(struct nicira_stats_msg));
+ } else {
+ NOT_REACHED();
+ }
+ }
- ofr = (const struct ofp_flow_removed *) oh;
- ofputil_cls_rule_from_match(&ofr->match, ntohs(ofr->priority),
- flow_format, ofr->cookie, &fr->rule);
- fr->cookie = ofr->cookie;
- fr->reason = ofr->reason;
- fr->duration_sec = ntohl(ofr->duration_sec);
- fr->duration_nsec = ntohl(ofr->duration_nsec);
- fr->idle_timeout = ntohs(ofr->idle_timeout);
+ if (!msg->size) {
+ return EOF;
+ } else if (code == OFPUTIL_OFPST_FLOW_REPLY) {
+ const struct ofp_flow_stats *ofs;
+ size_t length;
+
+ ofs = ofpbuf_try_pull(msg, sizeof *ofs);
+ if (!ofs) {
+ VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
+ "bytes at end", msg->size);
+ return EINVAL;
+ }
+
+ length = ntohs(ofs->length);
+ if (length < sizeof *ofs) {
+ VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
+ "length %zu", length);
+ return EINVAL;
+ }
+
+ if (ofpacts_pull_openflow10(msg, length - sizeof *ofs, ofpacts)) {
+ return EINVAL;
+ }
+
+ fs->cookie = get_32aligned_be64(&ofs->cookie);
+ ofputil_cls_rule_from_ofp10_match(&ofs->match, ntohs(ofs->priority),
+ &fs->rule);
+ fs->table_id = ofs->table_id;
+ fs->duration_sec = ntohl(ofs->duration_sec);
+ 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) {
+ const struct nx_flow_stats *nfs;
+ size_t match_len, actions_len, length;
+
+ nfs = ofpbuf_try_pull(msg, sizeof *nfs);
+ if (!nfs) {
+ VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
+ "bytes at end", msg->size);
+ return EINVAL;
+ }
+
+ length = ntohs(nfs->length);
+ match_len = ntohs(nfs->match_len);
+ if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
+ VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
+ "claims invalid length %zu", match_len, length);
+ return EINVAL;
+ }
+ if (nx_pull_match(msg, match_len, ntohs(nfs->priority), &fs->rule,
+ NULL, NULL)) {
+ return EINVAL;
+ }
+
+ actions_len = length - sizeof *nfs - ROUND_UP(match_len, 8);
+ if (ofpacts_pull_openflow10(msg, actions_len, ofpacts)) {
+ return EINVAL;
+ }
+
+ fs->cookie = nfs->cookie;
+ fs->table_id = nfs->table_id;
+ fs->duration_sec = ntohl(nfs->duration_sec);
+ 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 {
+ NOT_REACHED();
+ }
+
+ fs->ofpacts = ofpacts->data;
+ fs->ofpacts_len = ofpacts->size;
+
+ return 0;
+}
+
+/* Returns 'count' unchanged except that UINT64_MAX becomes 0.
+ *
+ * We use this in situations where OVS internally uses UINT64_MAX to mean
+ * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
+static uint64_t
+unknown_to_zero(uint64_t count)
+{
+ return count != UINT64_MAX ? count : 0;
+}
+
+/* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
+ * those already present in the list of ofpbufs in 'replies'. 'replies' should
+ * have been initialized with ofputil_start_stats_reply(). */
+void
+ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
+ struct list *replies)
+{
+ struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
+ const struct ofp_stats_msg *osm = reply->data;
+ size_t start_ofs = reply->size;
+
+ if (osm->type == htons(OFPST_FLOW)) {
+ struct ofp_flow_stats *ofs;
+
+ ofpbuf_put_uninit(reply, sizeof *ofs);
+ ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
+
+ ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
+ ofs->length = htons(reply->size - start_ofs);
+ ofs->table_id = fs->table_id;
+ ofs->pad = 0;
+ ofputil_cls_rule_to_ofp10_match(&fs->rule, &ofs->match);
+ ofs->duration_sec = htonl(fs->duration_sec);
+ ofs->duration_nsec = htonl(fs->duration_nsec);
+ ofs->priority = htons(fs->rule.priority);
+ ofs->idle_timeout = htons(fs->idle_timeout);
+ ofs->hard_timeout = htons(fs->hard_timeout);
+ memset(ofs->pad2, 0, sizeof ofs->pad2);
+ put_32aligned_be64(&ofs->cookie, fs->cookie);
+ put_32aligned_be64(&ofs->packet_count,
+ htonll(unknown_to_zero(fs->packet_count)));
+ put_32aligned_be64(&ofs->byte_count,
+ htonll(unknown_to_zero(fs->byte_count)));
+ } else if (osm->type == htons(OFPST_VENDOR)) {
+ struct nx_flow_stats *nfs;
+ int match_len;
+
+ ofpbuf_put_uninit(reply, sizeof *nfs);
+ match_len = nx_put_match(reply, false, &fs->rule, 0, 0);
+ ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
+
+ nfs = ofpbuf_at_assert(reply, start_ofs, sizeof *nfs);
+ nfs->length = htons(reply->size - start_ofs);
+ nfs->table_id = fs->table_id;
+ nfs->pad = 0;
+ nfs->duration_sec = htonl(fs->duration_sec);
+ nfs->duration_nsec = htonl(fs->duration_nsec);
+ nfs->priority = htons(fs->rule.priority);
+ nfs->idle_timeout = htons(fs->idle_timeout);
+ nfs->hard_timeout = htons(fs->hard_timeout);
+ 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(match_len);
+ nfs->cookie = fs->cookie;
+ nfs->packet_count = htonll(fs->packet_count);
+ nfs->byte_count = htonll(fs->byte_count);
+ } else {
+ NOT_REACHED();
+ }
+
+ ofputil_postappend_stats_reply(start_ofs, replies);
+}
+
+/* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
+ * NXST_AGGREGATE reply according to 'protocol', and returns the message. */
+struct ofpbuf *
+ofputil_encode_aggregate_stats_reply(
+ const struct ofputil_aggregate_stats *stats,
+ const struct ofp_stats_msg *request)
+{
+ struct ofpbuf *msg;
+
+ if (request->type == htons(OFPST_AGGREGATE)) {
+ struct ofp_aggregate_stats_reply *asr;
+
+ asr = ofputil_make_stats_reply(sizeof *asr, request, &msg);
+ put_32aligned_be64(&asr->packet_count,
+ htonll(unknown_to_zero(stats->packet_count)));
+ put_32aligned_be64(&asr->byte_count,
+ htonll(unknown_to_zero(stats->byte_count)));
+ asr->flow_count = htonl(stats->flow_count);
+ } else if (request->type == htons(OFPST_VENDOR)) {
+ struct nx_aggregate_stats_reply *nasr;
+
+ nasr = ofputil_make_stats_reply(sizeof *nasr, request, &msg);
+ assert(nasr->nsm.subtype == htonl(NXST_AGGREGATE));
+ nasr->packet_count = htonll(stats->packet_count);
+ nasr->byte_count = htonll(stats->byte_count);
+ nasr->flow_count = htonl(stats->flow_count);
+ } else {
+ NOT_REACHED();
+ }
+
+ return msg;
+}
+
+/* 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. */
+enum ofperr
+ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
+ 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);
+ if (code == OFPUTIL_OFPT_FLOW_REMOVED) {
+ const struct ofp_flow_removed *ofr;
+
+ ofr = (const struct ofp_flow_removed *) oh;
+ ofputil_cls_rule_from_ofp10_match(&ofr->match, ntohs(ofr->priority),
+ &fr->rule);
+ fr->cookie = ofr->cookie;
+ fr->reason = ofr->reason;
+ fr->duration_sec = ntohl(ofr->duration_sec);
+ fr->duration_nsec = ntohl(ofr->duration_nsec);
+ fr->idle_timeout = ntohs(ofr->idle_timeout);
fr->packet_count = ntohll(ofr->packet_count);
fr->byte_count = ntohll(ofr->byte_count);
} else if (code == OFPUTIL_NXT_FLOW_REMOVED) {
struct ofpbuf b;
int error;
- ofpbuf_use_const(&b, oh, ntohs(oh->length));
+ ofpbuf_use_const(&b, oh, ntohs(oh->length));
+
+ nfr = ofpbuf_pull(&b, sizeof *nfr);
+ error = nx_pull_match(&b, ntohs(nfr->match_len), ntohs(nfr->priority),
+ &fr->rule, NULL, NULL);
+ if (error) {
+ return error;
+ }
+ if (b.size) {
+ return OFPERR_OFPBRC_BAD_LEN;
+ }
+
+ fr->cookie = nfr->cookie;
+ fr->reason = nfr->reason;
+ fr->duration_sec = ntohl(nfr->duration_sec);
+ fr->duration_nsec = ntohl(nfr->duration_nsec);
+ fr->idle_timeout = ntohs(nfr->idle_timeout);
+ fr->packet_count = ntohll(nfr->packet_count);
+ fr->byte_count = ntohll(nfr->byte_count);
+ } else {
+ NOT_REACHED();
+ }
+
+ return 0;
+}
+
+/* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
+ * 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 ofputil_protocol protocol)
+{
+ struct ofpbuf *msg;
+
+ 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),
+ &msg);
+ ofputil_cls_rule_to_ofp10_match(&fr->rule, &ofr->match);
+ ofr->cookie = fr->cookie;
+ ofr->priority = htons(fr->rule.priority);
+ ofr->reason = fr->reason;
+ ofr->duration_sec = htonl(fr->duration_sec);
+ ofr->duration_nsec = htonl(fr->duration_nsec);
+ 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));
+ 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, false, &fr->rule, 0, 0);
+
+ nfr = msg->data;
+ nfr->cookie = fr->cookie;
+ nfr->priority = htons(fr->rule.priority);
+ nfr->reason = fr->reason;
+ nfr->duration_sec = htonl(fr->duration_sec);
+ nfr->duration_nsec = htonl(fr->duration_nsec);
+ nfr->idle_timeout = htons(fr->idle_timeout);
+ nfr->match_len = htons(match_len);
+ nfr->packet_count = htonll(fr->packet_count);
+ nfr->byte_count = htonll(fr->byte_count);
+ break;
+ }
+
+ default:
+ NOT_REACHED();
+ }
+
+ return msg;
+}
+
+enum ofperr
+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;
+
+ pin->fmd.metadata = rule.flow.metadata;
+ pin->fmd.metadata_mask = rule.wc.metadata_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,
+ enum nx_packet_in_format packet_in_format)
+{
+ size_t send_len = MIN(pin->send_len, pin->packet_len);
+ struct ofpbuf *packet;
+
+ /* Add OFPT_PACKET_IN. */
+ if (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);
+ cls_rule_set_metadata_masked(&rule, pin->fmd.metadata,
+ pin->fmd.metadata_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, false, &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 {
+ NOT_REACHED();
+ }
+ update_openflow_length(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;
+}
+
+/* Converts an OFPT_PACKET_OUT in 'opo' into an abstract ofputil_packet_out in
+ * 'po'.
+ *
+ * Uses 'ofpacts' to store the abstract OFPACT_* version of the packet out
+ * message's actions. The caller must initialize 'ofpacts' and retains
+ * ownership of it. 'po->ofpacts' will point into the 'ofpacts' buffer.
+ *
+ * Returns 0 if successful, otherwise an OFPERR_* value. */
+enum ofperr
+ofputil_decode_packet_out(struct ofputil_packet_out *po,
+ const struct ofp_packet_out *opo,
+ struct ofpbuf *ofpacts)
+{
+ 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 && po->in_port != OFPP_CONTROLLER) {
+ 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 = ofpacts_pull_openflow10(&b, ntohs(opo->actions_len), ofpacts);
+ if (error) {
+ return error;
+ }
+ po->ofpacts = ofpacts->data;
+ po->ofpacts_len = ofpacts->size;
+
+ 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;
+}
+\f
+/* 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 == (OFPPF10_COPPER << 4));
+BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
+BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
+BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
+BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
+
+static enum netdev_features
+netdev_port_features_from_ofp10(ovs_be32 ofp10_)
+{
+ uint32_t ofp10 = ntohl(ofp10_);
+ return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
+}
+
+static ovs_be32
+netdev_port_features_to_ofp10(enum netdev_features features)
+{
+ return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
+}
+
+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 */
+BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD == OFPPF11_40GB_FD); /* bit 7 */
+BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD == OFPPF11_100GB_FD); /* bit 8 */
+BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD == OFPPF11_1TB_FD); /* bit 9 */
+BUILD_ASSERT_DECL((int) NETDEV_F_OTHER == OFPPF11_OTHER); /* bit 10 */
+BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == OFPPF11_COPPER); /* bit 11 */
+BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == OFPPF11_FIBER); /* bit 12 */
+BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == OFPPF11_AUTONEG); /* bit 13 */
+BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == OFPPF11_PAUSE); /* bit 14 */
+BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
+
+static enum netdev_features
+netdev_port_features_from_ofp11(ovs_be32 ofp11)
+{
+ return ntohl(ofp11) & 0xffff;
+}
+
+static ovs_be32
+netdev_port_features_to_ofp11(enum netdev_features features)
+{
+ return htonl(features & 0xffff);
+}
+
+static enum ofperr
+ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
+ const struct ofp10_phy_port *opp)
+{
+ memset(pp, 0, sizeof *pp);
+
+ pp->port_no = ntohs(opp->port_no);
+ memcpy(pp->hw_addr, opp->hw_addr, OFP_ETH_ALEN);
+ ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
+
+ pp->config = ntohl(opp->config) & OFPPC10_ALL;
+ pp->state = ntohl(opp->state) & OFPPS10_ALL;
+
+ pp->curr = netdev_port_features_from_ofp10(opp->curr);
+ pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
+ pp->supported = netdev_port_features_from_ofp10(opp->supported);
+ pp->peer = netdev_port_features_from_ofp10(opp->peer);
+
+ pp->curr_speed = netdev_features_to_bps(pp->curr) / 1000;
+ pp->max_speed = netdev_features_to_bps(pp->supported) / 1000;
+
+ return 0;
+}
+
+static enum ofperr
+ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
+ const struct ofp11_port *op)
+{
+ enum ofperr error;
+
+ memset(pp, 0, sizeof *pp);
+
+ error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
+ if (error) {
+ return error;
+ }
+ memcpy(pp->hw_addr, op->hw_addr, OFP_ETH_ALEN);
+ ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
+
+ pp->config = ntohl(op->config) & OFPPC11_ALL;
+ pp->state = ntohl(op->state) & OFPPC11_ALL;
+
+ pp->curr = netdev_port_features_from_ofp11(op->curr);
+ pp->advertised = netdev_port_features_from_ofp11(op->advertised);
+ pp->supported = netdev_port_features_from_ofp11(op->supported);
+ pp->peer = netdev_port_features_from_ofp11(op->peer);
+
+ pp->curr_speed = ntohl(op->curr_speed);
+ pp->max_speed = ntohl(op->max_speed);
+
+ return 0;
+}
+
+static size_t
+ofputil_get_phy_port_size(uint8_t ofp_version)
+{
+ return ofp_version == OFP10_VERSION ? sizeof(struct ofp10_phy_port)
+ : sizeof(struct ofp11_port);
+}
+
+static void
+ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
+ struct ofp10_phy_port *opp)
+{
+ memset(opp, 0, sizeof *opp);
+
+ opp->port_no = htons(pp->port_no);
+ memcpy(opp->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
+ ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
+
+ opp->config = htonl(pp->config & OFPPC10_ALL);
+ opp->state = htonl(pp->state & OFPPS10_ALL);
+
+ opp->curr = netdev_port_features_to_ofp10(pp->curr);
+ opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
+ opp->supported = netdev_port_features_to_ofp10(pp->supported);
+ opp->peer = netdev_port_features_to_ofp10(pp->peer);
+}
+
+static void
+ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
+ struct ofp11_port *op)
+{
+ memset(op, 0, sizeof *op);
+
+ op->port_no = ofputil_port_to_ofp11(pp->port_no);
+ memcpy(op->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
+ ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
+
+ op->config = htonl(pp->config & OFPPC11_ALL);
+ op->state = htonl(pp->state & OFPPS11_ALL);
+
+ op->curr = netdev_port_features_to_ofp11(pp->curr);
+ op->advertised = netdev_port_features_to_ofp11(pp->advertised);
+ op->supported = netdev_port_features_to_ofp11(pp->supported);
+ op->peer = netdev_port_features_to_ofp11(pp->peer);
+
+ op->curr_speed = htonl(pp->curr_speed);
+ op->max_speed = htonl(pp->max_speed);
+}
+
+static void
+ofputil_put_phy_port(uint8_t ofp_version, const struct ofputil_phy_port *pp,
+ struct ofpbuf *b)
+{
+ if (ofp_version == OFP10_VERSION) {
+ struct ofp10_phy_port *opp;
+ if (b->size + sizeof *opp <= UINT16_MAX) {
+ opp = ofpbuf_put_uninit(b, sizeof *opp);
+ ofputil_encode_ofp10_phy_port(pp, opp);
+ }
+ } else {
+ struct ofp11_port *op;
+ if (b->size + sizeof *op <= UINT16_MAX) {
+ op = ofpbuf_put_uninit(b, sizeof *op);
+ ofputil_encode_ofp11_port(pp, op);
+ }
+ }
+}
+
+void
+ofputil_append_port_desc_stats_reply(uint8_t ofp_version,
+ const struct ofputil_phy_port *pp,
+ struct list *replies)
+{
+ if (ofp_version == OFP10_VERSION) {
+ struct ofp10_phy_port *opp;
+
+ opp = ofputil_append_stats_reply(sizeof *opp, replies);
+ ofputil_encode_ofp10_phy_port(pp, opp);
+ } else {
+ struct ofp11_port *op;
+
+ op = ofputil_append_stats_reply(sizeof *op, replies);
+ ofputil_encode_ofp11_port(pp, op);
+ }
+}
+\f
+/* ofputil_switch_features */
+
+#define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
+ OFPC_IP_REASM | OFPC_QUEUE_STATS | OFPC_ARP_MATCH_IP)
+BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
+BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
+BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
+BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
+BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
+BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
+
+struct ofputil_action_bit_translation {
+ enum ofputil_action_bitmap ofputil_bit;
+ int of_bit;
+};
+
+static const struct ofputil_action_bit_translation of10_action_bits[] = {
+ { OFPUTIL_A_OUTPUT, OFPAT10_OUTPUT },
+ { OFPUTIL_A_SET_VLAN_VID, OFPAT10_SET_VLAN_VID },
+ { OFPUTIL_A_SET_VLAN_PCP, OFPAT10_SET_VLAN_PCP },
+ { OFPUTIL_A_STRIP_VLAN, OFPAT10_STRIP_VLAN },
+ { OFPUTIL_A_SET_DL_SRC, OFPAT10_SET_DL_SRC },
+ { OFPUTIL_A_SET_DL_DST, OFPAT10_SET_DL_DST },
+ { OFPUTIL_A_SET_NW_SRC, OFPAT10_SET_NW_SRC },
+ { OFPUTIL_A_SET_NW_DST, OFPAT10_SET_NW_DST },
+ { OFPUTIL_A_SET_NW_TOS, OFPAT10_SET_NW_TOS },
+ { OFPUTIL_A_SET_TP_SRC, OFPAT10_SET_TP_SRC },
+ { OFPUTIL_A_SET_TP_DST, OFPAT10_SET_TP_DST },
+ { OFPUTIL_A_ENQUEUE, OFPAT10_ENQUEUE },
+ { 0, 0 },
+};
+
+static const struct ofputil_action_bit_translation of11_action_bits[] = {
+ { OFPUTIL_A_OUTPUT, OFPAT11_OUTPUT },
+ { OFPUTIL_A_SET_VLAN_VID, OFPAT11_SET_VLAN_VID },
+ { OFPUTIL_A_SET_VLAN_PCP, OFPAT11_SET_VLAN_PCP },
+ { OFPUTIL_A_SET_DL_SRC, OFPAT11_SET_DL_SRC },
+ { OFPUTIL_A_SET_DL_DST, OFPAT11_SET_DL_DST },
+ { OFPUTIL_A_SET_NW_SRC, OFPAT11_SET_NW_SRC },
+ { OFPUTIL_A_SET_NW_DST, OFPAT11_SET_NW_DST },
+ { OFPUTIL_A_SET_NW_TOS, OFPAT11_SET_NW_TOS },
+ { OFPUTIL_A_SET_NW_ECN, OFPAT11_SET_NW_ECN },
+ { OFPUTIL_A_SET_TP_SRC, OFPAT11_SET_TP_SRC },
+ { OFPUTIL_A_SET_TP_DST, OFPAT11_SET_TP_DST },
+ { OFPUTIL_A_COPY_TTL_OUT, OFPAT11_COPY_TTL_OUT },
+ { OFPUTIL_A_COPY_TTL_IN, OFPAT11_COPY_TTL_IN },
+ { OFPUTIL_A_SET_MPLS_LABEL, OFPAT11_SET_MPLS_LABEL },
+ { OFPUTIL_A_SET_MPLS_TC, OFPAT11_SET_MPLS_TC },
+ { OFPUTIL_A_SET_MPLS_TTL, OFPAT11_SET_MPLS_TTL },
+ { OFPUTIL_A_DEC_MPLS_TTL, OFPAT11_DEC_MPLS_TTL },
+ { OFPUTIL_A_PUSH_VLAN, OFPAT11_PUSH_VLAN },
+ { OFPUTIL_A_POP_VLAN, OFPAT11_POP_VLAN },
+ { OFPUTIL_A_PUSH_MPLS, OFPAT11_PUSH_MPLS },
+ { OFPUTIL_A_POP_MPLS, OFPAT11_POP_MPLS },
+ { OFPUTIL_A_SET_QUEUE, OFPAT11_SET_QUEUE },
+ { OFPUTIL_A_GROUP, OFPAT11_GROUP },
+ { OFPUTIL_A_SET_NW_TTL, OFPAT11_SET_NW_TTL },
+ { OFPUTIL_A_DEC_NW_TTL, OFPAT11_DEC_NW_TTL },
+ { 0, 0 },
+};
+
+static enum ofputil_action_bitmap
+decode_action_bits(ovs_be32 of_actions,
+ const struct ofputil_action_bit_translation *x)
+{
+ enum ofputil_action_bitmap ofputil_actions;
+
+ ofputil_actions = 0;
+ for (; x->ofputil_bit; x++) {
+ if (of_actions & htonl(1u << x->of_bit)) {
+ ofputil_actions |= x->ofputil_bit;
+ }
+ }
+ return ofputil_actions;
+}
+
+/* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
+ * abstract representation in '*features'. Initializes '*b' to iterate over
+ * the OpenFlow port structures following 'osf' with later calls to
+ * ofputil_pull_phy_port(). Returns 0 if successful, otherwise an
+ * OFPERR_* value. */
+enum ofperr
+ofputil_decode_switch_features(const struct ofp_switch_features *osf,
+ struct ofputil_switch_features *features,
+ struct ofpbuf *b)
+{
+ ofpbuf_use_const(b, osf, ntohs(osf->header.length));
+ ofpbuf_pull(b, sizeof *osf);
+
+ features->datapath_id = ntohll(osf->datapath_id);
+ features->n_buffers = ntohl(osf->n_buffers);
+ features->n_tables = osf->n_tables;
+
+ features->capabilities = ntohl(osf->capabilities) & OFPC_COMMON;
+
+ if (b->size % ofputil_get_phy_port_size(osf->header.version)) {
+ return OFPERR_OFPBRC_BAD_LEN;
+ }
+
+ if (osf->header.version == OFP10_VERSION) {
+ if (osf->capabilities & htonl(OFPC10_STP)) {
+ features->capabilities |= OFPUTIL_C_STP;
+ }
+ features->actions = decode_action_bits(osf->actions, of10_action_bits);
+ } else if (osf->header.version == OFP11_VERSION) {
+ if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
+ features->capabilities |= OFPUTIL_C_GROUP_STATS;
+ }
+ features->actions = decode_action_bits(osf->actions, of11_action_bits);
+ } else {
+ return OFPERR_OFPBRC_BAD_VERSION;
+ }
+
+ return 0;
+}
+
+/* Returns true if the maximum number of ports are in 'osf'. */
+static bool
+max_ports_in_features(const struct ofp_switch_features *osf)
+{
+ size_t pp_size = ofputil_get_phy_port_size(osf->header.version);
+ return ntohs(osf->header.length) + pp_size > UINT16_MAX;
+}
+
+/* Given a buffer 'b' that contains a Features Reply message, checks if
+ * it contains the maximum number of ports that will fit. If so, it
+ * returns true and removes the ports from the message. The caller
+ * should then send an OFPST_PORT_DESC stats request to get the ports,
+ * since the switch may have more ports than could be represented in the
+ * Features Reply. Otherwise, returns false.
+ */
+bool
+ofputil_switch_features_ports_trunc(struct ofpbuf *b)
+{
+ struct ofp_switch_features *osf = b->data;
+
+ if (max_ports_in_features(osf)) {
+ /* Remove all the ports. */
+ b->size = sizeof(*osf);
+ update_openflow_length(b);
+
+ return true;
+ }
+
+ return false;
+}
+
+static ovs_be32
+encode_action_bits(enum ofputil_action_bitmap ofputil_actions,
+ const struct ofputil_action_bit_translation *x)
+{
+ uint32_t of_actions;
+
+ of_actions = 0;
+ for (; x->ofputil_bit; x++) {
+ if (ofputil_actions & x->ofputil_bit) {
+ of_actions |= 1 << x->of_bit;
+ }
+ }
+ return htonl(of_actions);
+}
+
+/* Returns a buffer owned by the caller that encodes 'features' in the format
+ * required by 'protocol' with the given 'xid'. The caller should append port
+ * information to the buffer with subsequent calls to
+ * ofputil_put_switch_features_port(). */
+struct ofpbuf *
+ofputil_encode_switch_features(const struct ofputil_switch_features *features,
+ enum ofputil_protocol protocol, ovs_be32 xid)
+{
+ struct ofp_switch_features *osf;
+ struct ofpbuf *b;
+
+ osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, xid, &b);
+ osf->header.version = ofputil_protocol_to_ofp_version(protocol);
+ osf->datapath_id = htonll(features->datapath_id);
+ osf->n_buffers = htonl(features->n_buffers);
+ osf->n_tables = features->n_tables;
+
+ osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
+ if (osf->header.version == OFP10_VERSION) {
+ if (features->capabilities & OFPUTIL_C_STP) {
+ osf->capabilities |= htonl(OFPC10_STP);
+ }
+ osf->actions = encode_action_bits(features->actions, of10_action_bits);
+ } else {
+ if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
+ osf->capabilities |= htonl(OFPC11_GROUP_STATS);
+ }
+ osf->actions = encode_action_bits(features->actions, of11_action_bits);
+ }
+
+ return b;
+}
+
+/* Encodes 'pp' into the format required by the switch_features message already
+ * in 'b', which should have been returned by ofputil_encode_switch_features(),
+ * and appends the encoded version to 'b'. */
+void
+ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
+ struct ofpbuf *b)
+{
+ const struct ofp_switch_features *osf = b->data;
+
+ ofputil_put_phy_port(osf->header.version, pp, b);
+}
+\f
+/* ofputil_port_status */
+
+/* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
+ * in '*ps'. Returns 0 if successful, otherwise an OFPERR_* value. */
+enum ofperr
+ofputil_decode_port_status(const struct ofp_port_status *ops,
+ struct ofputil_port_status *ps)
+{
+ struct ofpbuf b;
+ int retval;
+
+ if (ops->reason != OFPPR_ADD &&
+ ops->reason != OFPPR_DELETE &&
+ ops->reason != OFPPR_MODIFY) {
+ return OFPERR_NXBRC_BAD_REASON;
+ }
+ ps->reason = ops->reason;
+
+ ofpbuf_use_const(&b, ops, ntohs(ops->header.length));
+ ofpbuf_pull(&b, sizeof *ops);
+ retval = ofputil_pull_phy_port(ops->header.version, &b, &ps->desc);
+ assert(retval != EOF);
+ return retval;
+}
+
+/* Converts the abstract form of a "port status" message in '*ps' into an
+ * OpenFlow message suitable for 'protocol', and returns that encoded form in
+ * a buffer owned by the caller. */
+struct ofpbuf *
+ofputil_encode_port_status(const struct ofputil_port_status *ps,
+ enum ofputil_protocol protocol)
+{
+ struct ofp_port_status *ops;
+ struct ofpbuf *b;
+
+ b = ofpbuf_new(sizeof *ops + sizeof(struct ofp11_port));
+ ops = put_openflow_xid(sizeof *ops, OFPT_PORT_STATUS, htonl(0), b);
+ ops->header.version = ofputil_protocol_to_ofp_version(protocol);
+ ops->reason = ps->reason;
+ ofputil_put_phy_port(ops->header.version, &ps->desc, b);
+ update_openflow_length(b);
+ return b;
+}
+\f
+/* ofputil_port_mod */
+
+/* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
+ * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
+enum ofperr
+ofputil_decode_port_mod(const struct ofp_header *oh,
+ struct ofputil_port_mod *pm)
+{
+ if (oh->version == OFP10_VERSION) {
+ const struct ofp10_port_mod *opm = (const struct ofp10_port_mod *) oh;
+
+ if (oh->length != htons(sizeof *opm)) {
+ return OFPERR_OFPBRC_BAD_LEN;
+ }
+
+ pm->port_no = ntohs(opm->port_no);
+ memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
+ pm->config = ntohl(opm->config) & OFPPC10_ALL;
+ pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
+ pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
+ } else if (oh->version == OFP11_VERSION) {
+ const struct ofp11_port_mod *opm = (const struct ofp11_port_mod *) oh;
+ enum ofperr error;
+
+ if (oh->length != htons(sizeof *opm)) {
+ return OFPERR_OFPBRC_BAD_LEN;
+ }
+
+ error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
+ if (error) {
+ return error;
+ }
+
+ memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
+ pm->config = ntohl(opm->config) & OFPPC11_ALL;
+ pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
+ pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
+ } else {
+ return OFPERR_OFPBRC_BAD_VERSION;
+ }
+
+ pm->config &= pm->mask;
+ return 0;
+}
+
+/* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
+ * message suitable for 'protocol', and returns that encoded form in a buffer
+ * owned by the caller. */
+struct ofpbuf *
+ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
+ enum ofputil_protocol protocol)
+{
+ uint8_t ofp_version = ofputil_protocol_to_ofp_version(protocol);
+ struct ofpbuf *b;
+
+ if (ofp_version == OFP10_VERSION) {
+ struct ofp10_port_mod *opm;
+
+ opm = make_openflow(sizeof *opm, OFPT10_PORT_MOD, &b);
+ opm->port_no = htons(pm->port_no);
+ memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
+ opm->config = htonl(pm->config & OFPPC10_ALL);
+ opm->mask = htonl(pm->mask & OFPPC10_ALL);
+ opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
+ } else if (ofp_version == OFP11_VERSION) {
+ struct ofp11_port_mod *opm;
+
+ opm = make_openflow(sizeof *opm, OFPT11_PORT_MOD, &b);
+ opm->port_no = htonl(pm->port_no);
+ memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
+ opm->config = htonl(pm->config & OFPPC11_ALL);
+ opm->mask = htonl(pm->mask & OFPPC11_ALL);
+ opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
+ } else {
+ NOT_REACHED();
+ }
+
+ return b;
+}
+\f
+/* ofputil_flow_monitor_request */
+
+/* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract
+ * ofputil_flow_monitor_request in 'rq'.
+ *
+ * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow
+ * message. Calling this function multiple times for a single 'msg' iterates
+ * through the requests. The caller must initially leave 'msg''s layer
+ * pointers null and not modify them between calls.
+ *
+ * Returns 0 if successful, EOF if no requests were left in this 'msg',
+ * otherwise an OFPERR_* value. */
+int
+ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *rq,
+ struct ofpbuf *msg)
+{
+ struct nx_flow_monitor_request *nfmr;
+ uint16_t flags;
+
+ if (!msg->l2) {
+ msg->l2 = msg->data;
+ ofpbuf_pull(msg, sizeof(struct nicira_stats_msg));
+ }
+
+ if (!msg->size) {
+ return EOF;
+ }
+
+ nfmr = ofpbuf_try_pull(msg, sizeof *nfmr);
+ if (!nfmr) {
+ VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR request has %zu "
+ "leftover bytes at end", msg->size);
+ return OFPERR_OFPBRC_BAD_LEN;
+ }
+
+ flags = ntohs(nfmr->flags);
+ if (!(flags & (NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY))
+ || flags & ~(NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE
+ | NXFMF_MODIFY | NXFMF_ACTIONS | NXFMF_OWN)) {
+ VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR has bad flags %#"PRIx16,
+ flags);
+ return OFPERR_NXBRC_FM_BAD_FLAGS;
+ }
+
+ if (!is_all_zeros(nfmr->zeros, sizeof nfmr->zeros)) {
+ return OFPERR_NXBRC_MUST_BE_ZERO;
+ }
+
+ rq->id = ntohl(nfmr->id);
+ rq->flags = flags;
+ rq->out_port = ntohs(nfmr->out_port);
+ rq->table_id = nfmr->table_id;
+
+ return nx_pull_match(msg, ntohs(nfmr->match_len), OFP_DEFAULT_PRIORITY,
+ &rq->match, NULL, NULL);
+}
+
+void
+ofputil_append_flow_monitor_request(
+ const struct ofputil_flow_monitor_request *rq, struct ofpbuf *msg)
+{
+ struct nx_flow_monitor_request *nfmr;
+ size_t start_ofs;
+ int match_len;
+
+ if (!msg->size) {
+ ofputil_put_stats_header(alloc_xid(), OFPT10_STATS_REQUEST,
+ htons(OFPST_VENDOR),
+ htonl(NXST_FLOW_MONITOR), msg);
+ }
+
+ start_ofs = msg->size;
+ ofpbuf_put_zeros(msg, sizeof *nfmr);
+ match_len = nx_put_match(msg, false, &rq->match, htonll(0), htonll(0));
+
+ nfmr = ofpbuf_at_assert(msg, start_ofs, sizeof *nfmr);
+ nfmr->id = htonl(rq->id);
+ nfmr->flags = htons(rq->flags);
+ nfmr->out_port = htons(rq->out_port);
+ nfmr->match_len = htons(match_len);
+ nfmr->table_id = rq->table_id;
+}
+
+/* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg'
+ * into an abstract ofputil_flow_update in 'update'. The caller must have
+ * initialized update->match to point to space allocated for a cls_rule.
+ *
+ * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's
+ * actions (except for NXFME_ABBREV, which never includes actions). The caller
+ * must initialize 'ofpacts' and retains ownership of it. 'update->ofpacts'
+ * will point into the 'ofpacts' buffer.
+ *
+ * Multiple flow updates can be packed into a single OpenFlow message. Calling
+ * this function multiple times for a single 'msg' iterates through the
+ * updates. The caller must initially leave 'msg''s layer pointers null and
+ * not modify them between calls.
+ *
+ * Returns 0 if successful, EOF if no updates were left in this 'msg',
+ * otherwise an OFPERR_* value. */
+int
+ofputil_decode_flow_update(struct ofputil_flow_update *update,
+ struct ofpbuf *msg, struct ofpbuf *ofpacts)
+{
+ struct nx_flow_update_header *nfuh;
+ unsigned int length;
+
+ if (!msg->l2) {
+ msg->l2 = msg->data;
+ ofpbuf_pull(msg, sizeof(struct nicira_stats_msg));
+ }
+
+ if (!msg->size) {
+ return EOF;
+ }
+
+ if (msg->size < sizeof(struct nx_flow_update_header)) {
+ goto bad_len;
+ }
+
+ nfuh = msg->data;
+ update->event = ntohs(nfuh->event);
+ length = ntohs(nfuh->length);
+ if (length > msg->size || length % 8) {
+ goto bad_len;
+ }
+
+ if (update->event == NXFME_ABBREV) {
+ struct nx_flow_update_abbrev *nfua;
+
+ if (length != sizeof *nfua) {
+ goto bad_len;
+ }
+
+ nfua = ofpbuf_pull(msg, sizeof *nfua);
+ update->xid = nfua->xid;
+ return 0;
+ } else if (update->event == NXFME_ADDED
+ || update->event == NXFME_DELETED
+ || update->event == NXFME_MODIFIED) {
+ struct nx_flow_update_full *nfuf;
+ unsigned int actions_len;
+ unsigned int match_len;
+ enum ofperr error;
+
+ if (length < sizeof *nfuf) {
+ goto bad_len;
+ }
+
+ nfuf = ofpbuf_pull(msg, sizeof *nfuf);
+ match_len = ntohs(nfuf->match_len);
+ if (sizeof *nfuf + match_len > length) {
+ goto bad_len;
+ }
+
+ update->reason = ntohs(nfuf->reason);
+ update->idle_timeout = ntohs(nfuf->idle_timeout);
+ update->hard_timeout = ntohs(nfuf->hard_timeout);
+ update->table_id = nfuf->table_id;
+ update->cookie = nfuf->cookie;
+
+ error = nx_pull_match(msg, match_len, ntohs(nfuf->priority),
+ update->match, NULL, NULL);
+ if (error) {
+ return error;
+ }
+
+ actions_len = length - sizeof *nfuf - ROUND_UP(match_len, 8);
+ error = ofpacts_pull_openflow10(msg, actions_len, ofpacts);
+ if (error) {
+ return error;
+ }
+
+ update->ofpacts = ofpacts->data;
+ update->ofpacts_len = ofpacts->size;
+ return 0;
+ } else {
+ VLOG_WARN_RL(&bad_ofmsg_rl,
+ "NXST_FLOW_MONITOR reply has bad event %"PRIu16,
+ ntohs(nfuh->event));
+ return OFPERR_OFPET_BAD_REQUEST;
+ }
+
+bad_len:
+ VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR reply has %zu "
+ "leftover bytes at end", msg->size);
+ return OFPERR_OFPBRC_BAD_LEN;
+}
+
+uint32_t
+ofputil_decode_flow_monitor_cancel(const struct ofp_header *oh)
+{
+ return ntohl(((const struct nx_flow_monitor_cancel *) oh)->id);
+}
+
+struct ofpbuf *
+ofputil_encode_flow_monitor_cancel(uint32_t id)
+{
+ struct nx_flow_monitor_cancel *nfmc;
+ struct ofpbuf *msg;
+
+ nfmc = make_nxmsg(sizeof *nfmc, NXT_FLOW_MONITOR_CANCEL, &msg);
+ nfmc->id = htonl(id);
+ return msg;
+}
+
+void
+ofputil_start_flow_update(struct list *replies)
+{
+ struct ofpbuf *msg;
+
+ msg = ofpbuf_new(1024);
+ ofputil_put_stats_header(htonl(0), OFPT10_STATS_REPLY,
+ htons(OFPST_VENDOR),
+ htonl(NXST_FLOW_MONITOR), msg);
+
+ list_init(replies);
+ list_push_back(replies, &msg->list_node);
+}
+
+void
+ofputil_append_flow_update(const struct ofputil_flow_update *update,
+ struct list *replies)
+{
+ struct nx_flow_update_header *nfuh;
+ struct ofpbuf *msg;
+ size_t start_ofs;
+
+ msg = ofpbuf_from_list(list_back(replies));
+ start_ofs = msg->size;
+
+ if (update->event == NXFME_ABBREV) {
+ struct nx_flow_update_abbrev *nfua;
+
+ nfua = ofpbuf_put_zeros(msg, sizeof *nfua);
+ nfua->xid = update->xid;
+ } else {
+ struct nx_flow_update_full *nfuf;
+ int match_len;
+
+ ofpbuf_put_zeros(msg, sizeof *nfuf);
+ match_len = nx_put_match(msg, false, update->match,
+ htonll(0), htonll(0));
+ ofpacts_put_openflow10(update->ofpacts, update->ofpacts_len, msg);
+
+ nfuf = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuf);
+ nfuf->reason = htons(update->reason);
+ nfuf->priority = htons(update->match->priority);
+ nfuf->idle_timeout = htons(update->idle_timeout);
+ nfuf->hard_timeout = htons(update->hard_timeout);
+ nfuf->match_len = htons(match_len);
+ nfuf->table_id = update->table_id;
+ nfuf->cookie = update->cookie;
+ }
+
+ nfuh = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuh);
+ nfuh->length = htons(msg->size - start_ofs);
+ nfuh->event = htons(update->event);
+
+ ofputil_postappend_stats_reply(start_ofs, replies);
+}
+\f
+struct ofpbuf *
+ofputil_encode_packet_out(const struct ofputil_packet_out *po)
+{
+ struct ofp_packet_out *opo;
+ struct ofpbuf *msg;
+ size_t size;
+
+ size = sizeof *opo + po->ofpacts_len;
+ if (po->buffer_id == UINT32_MAX) {
+ size += po->packet_len;
+ }
+
+ msg = ofpbuf_new(size);
+ put_openflow(sizeof *opo, OFPT_PACKET_OUT, msg);
+ ofpacts_put_openflow10(po->ofpacts, po->ofpacts_len, msg);
- nfr = ofpbuf_pull(&b, sizeof *nfr);
- error = nx_pull_match(&b, ntohs(nfr->match_len), ntohs(nfr->priority),
- &fr->rule);
- if (error) {
- return error;
- }
- if (b.size) {
- return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
- }
+ opo = msg->data;
+ opo->buffer_id = htonl(po->buffer_id);
+ opo->in_port = htons(po->in_port);
+ opo->actions_len = htons(msg->size - sizeof *opo);
- fr->cookie = nfr->cookie;
- fr->reason = nfr->reason;
- fr->duration_sec = ntohl(nfr->duration_sec);
- fr->duration_nsec = ntohl(nfr->duration_nsec);
- fr->idle_timeout = ntohs(nfr->idle_timeout);
- fr->packet_count = ntohll(nfr->packet_count);
- fr->byte_count = ntohll(nfr->byte_count);
- } else {
- NOT_REACHED();
+ if (po->buffer_id == UINT32_MAX) {
+ ofpbuf_put(msg, po->packet, po->packet_len);
}
- return 0;
+ update_openflow_length(msg);
+
+ return msg;
}
/* Returns a string representing the message type of 'type'. The string is the
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;
oh->length = htons(buffer->size);
}
-/* Creates an ofp_stats_request with the given 'type' and 'body_len' bytes of
- * space allocated for the 'body' member. Returns the first byte of the 'body'
- * member. */
-void *
-ofputil_make_stats_request(size_t body_len, uint16_t type,
- struct ofpbuf **bufferp)
+void
+ofputil_put_stats_header(ovs_be32 xid, uint8_t ofp_type,
+ ovs_be16 ofpst_type, ovs_be32 nxst_subtype,
+ struct ofpbuf *msg)
{
- struct ofp_stats_request *osr;
- osr = make_openflow((offsetof(struct ofp_stats_request, body)
- + body_len), OFPT_STATS_REQUEST, bufferp);
- osr->type = htons(type);
- osr->flags = htons(0);
- return osr->body;
+ if (ofpst_type == htons(OFPST_VENDOR)) {
+ struct nicira_stats_msg *nsm;
+
+ nsm = put_openflow_xid(sizeof *nsm, ofp_type, xid, msg);
+ nsm->vsm.osm.type = ofpst_type;
+ nsm->vsm.vendor = htonl(NX_VENDOR_ID);
+ nsm->subtype = nxst_subtype;
+ } else {
+ struct ofp_stats_msg *osm;
+
+ osm = put_openflow_xid(sizeof *osm, ofp_type, xid, msg);
+ osm->type = ofpst_type;
+ }
}
-/* Creates a stats request message with Nicira as vendor and the given
- * 'subtype', of total length 'openflow_len'. Returns the message. */
+/* Creates a statistics request message with total length 'openflow_len'
+ * (including all headers) and the given 'ofpst_type', and stores the buffer
+ * containing the new message in '*bufferp'. If 'ofpst_type' is OFPST_VENDOR
+ * then 'nxst_subtype' is used as the Nicira vendor extension statistics
+ * subtype (otherwise 'nxst_subtype' is ignored).
+ *
+ * Initializes bytes following the headers to all-bits-zero.
+ *
+ * Returns the first byte of the new message. */
void *
-ofputil_make_nxstats_request(size_t openflow_len, uint32_t subtype,
- struct ofpbuf **bufferp)
+ofputil_make_stats_request(size_t openflow_len, uint16_t ofpst_type,
+ uint32_t nxst_subtype, struct ofpbuf **bufferp)
{
- struct nicira_stats_msg *nsm;
+ struct ofpbuf *msg;
- nsm = make_openflow(openflow_len, OFPT_STATS_REQUEST, bufferp);
- nsm->type = htons(OFPST_VENDOR);
- nsm->flags = htons(0);
- nsm->vendor = htonl(NX_VENDOR_ID);
- nsm->subtype = htonl(subtype);
- return nsm;
-}
+ msg = *bufferp = ofpbuf_new(openflow_len);
+ ofputil_put_stats_header(alloc_xid(), OFPT10_STATS_REQUEST,
+ htons(ofpst_type), htonl(nxst_subtype), msg);
+ ofpbuf_padto(msg, openflow_len);
-/* Returns the first byte of the 'body' member of the ofp_stats_request or
- * ofp_stats_reply in 'oh'. */
-const void *
-ofputil_stats_body(const struct ofp_header *oh)
-{
- assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
- return ((const struct ofp_stats_request *) oh)->body;
+ return msg->data;
}
-/* Returns the length of the 'body' member of the ofp_stats_request or
- * ofp_stats_reply in 'oh'. */
-size_t
-ofputil_stats_body_len(const struct ofp_header *oh)
+static void
+put_stats_reply__(const struct ofp_stats_msg *request, struct ofpbuf *msg)
{
- assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
- return ntohs(oh->length) - sizeof(struct ofp_stats_request);
-}
+ ovs_be32 nxst_subtype;
-/* Returns the first byte of the body of the nicira_stats_msg in 'oh'. */
-const void *
-ofputil_nxstats_body(const struct ofp_header *oh)
-{
- assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
- return ((const struct nicira_stats_msg *) oh) + 1;
+ assert(request->header.type == OFPT10_STATS_REQUEST ||
+ request->header.type == OFPT10_STATS_REPLY);
+
+ nxst_subtype = (request->type != htons(OFPST_VENDOR)
+ ? htonl(0)
+ : ((const struct nicira_stats_msg *) request)->subtype);
+ ofputil_put_stats_header(request->header.xid, OFPT10_STATS_REPLY,
+ request->type, nxst_subtype, msg);
}
-/* Returns the length of the body of the nicira_stats_msg in 'oh'. */
-size_t
-ofputil_nxstats_body_len(const struct ofp_header *oh)
+/* Creates a statistics reply message with total length 'openflow_len'
+ * (including all headers) and the same type (either a standard OpenFlow
+ * statistics type or a Nicira extension type and subtype) as 'request', and
+ * stores the buffer containing the new message in '*bufferp'.
+ *
+ * Initializes bytes following the headers to all-bits-zero.
+ *
+ * Returns the first byte of the new message. */
+void *
+ofputil_make_stats_reply(size_t openflow_len,
+ const struct ofp_stats_msg *request,
+ struct ofpbuf **bufferp)
{
- assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
- return ntohs(oh->length) - sizeof(struct nicira_stats_msg);
+ struct ofpbuf *msg;
+
+ msg = *bufferp = ofpbuf_new(openflow_len);
+ put_stats_reply__(request, msg);
+ ofpbuf_padto(msg, openflow_len);
+
+ return msg->data;
}
-struct ofpbuf *
-make_flow_mod(uint16_t command, const struct cls_rule *rule,
- size_t actions_len)
+/* Initializes 'replies' as a list of ofpbufs that will contain a series of
+ * replies to 'request', which should be an OpenFlow or Nicira extension
+ * statistics request. Initially 'replies' will have a single reply message
+ * that has only a header. The functions ofputil_reserve_stats_reply() and
+ * ofputil_append_stats_reply() may be used to add to the reply. */
+void
+ofputil_start_stats_reply(const struct ofp_stats_msg *request,
+ struct list *replies)
{
- struct ofp_flow_mod *ofm;
- 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.length = htons(size);
- ofm->cookie = 0;
- ofm->priority = htons(MIN(rule->priority, UINT16_MAX));
- ofputil_cls_rule_to_match(rule, NXFF_OPENFLOW10, &ofm->match, 0, NULL);
- ofm->command = htons(command);
- return out;
-}
+ struct ofpbuf *msg;
-struct ofpbuf *
-make_add_flow(const struct cls_rule *rule, uint32_t buffer_id,
- uint16_t idle_timeout, size_t actions_len)
-{
- struct ofpbuf *out = make_flow_mod(OFPFC_ADD, rule, actions_len);
- struct ofp_flow_mod *ofm = out->data;
- ofm->idle_timeout = htons(idle_timeout);
- ofm->hard_timeout = htons(OFP_FLOW_PERMANENT);
- ofm->buffer_id = htonl(buffer_id);
- return out;
+ msg = ofpbuf_new(1024);
+ put_stats_reply__(request, msg);
+
+ list_init(replies);
+ list_push_back(replies, &msg->list_node);
}
+/* Prepares to append up to 'len' bytes to the series of statistics replies in
+ * 'replies', which should have been initialized with
+ * ofputil_start_stats_reply(). Returns an ofpbuf with at least 'len' bytes of
+ * tailroom. (The 'len' bytes have not actually be allocated; the caller must
+ * do so with e.g. ofpbuf_put_uninit().) */
struct ofpbuf *
-make_del_flow(const struct cls_rule *rule)
+ofputil_reserve_stats_reply(size_t len, struct list *replies)
{
- struct ofpbuf *out = make_flow_mod(OFPFC_DELETE_STRICT, rule, 0);
- struct ofp_flow_mod *ofm = out->data;
- ofm->out_port = htons(OFPP_NONE);
- return out;
-}
+ struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
+ struct ofp_stats_msg *osm = msg->data;
-struct ofpbuf *
-make_add_simple_flow(const struct cls_rule *rule,
- uint32_t buffer_id, uint16_t out_port,
- uint16_t idle_timeout)
-{
- if (out_port != OFPP_NONE) {
- struct ofp_action_output *oao;
- 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);
- return buffer;
+ if (msg->size + len <= UINT16_MAX) {
+ ofpbuf_prealloc_tailroom(msg, len);
} else {
- return make_add_flow(rule, buffer_id, idle_timeout, 0);
+ osm->flags |= htons(OFPSF_REPLY_MORE);
+
+ msg = ofpbuf_new(MAX(1024, sizeof(struct nicira_stats_msg) + len));
+ put_stats_reply__(osm, msg);
+ list_push_back(replies, &msg->list_node);
}
+ return msg;
}
-struct ofpbuf *
-make_packet_in(uint32_t buffer_id, uint16_t in_port, uint8_t reason,
- const struct ofpbuf *payload, int max_send_len)
+/* Appends 'len' bytes to the series of statistics replies in 'replies', and
+ * returns the first byte. */
+void *
+ofputil_append_stats_reply(size_t len, struct list *replies)
{
- struct ofp_packet_in *opi;
- struct ofpbuf *buf;
- int send_len;
-
- send_len = MIN(max_send_len, payload->size);
- buf = ofpbuf_new(sizeof *opi + send_len);
- opi = put_openflow_xid(offsetof(struct ofp_packet_in, data),
- OFPT_PACKET_IN, 0, buf);
- opi->buffer_id = htonl(buffer_id);
- opi->total_len = htons(payload->size);
- opi->in_port = htons(in_port);
- opi->reason = reason;
- ofpbuf_put(buf, payload->data, send_len);
- update_openflow_length(buf);
+ return ofpbuf_put_uninit(ofputil_reserve_stats_reply(len, replies), len);
+}
- return buf;
+/* Sometimes, when composing stats replies, it's difficult to predict how long
+ * an individual reply chunk will be before actually encoding it into the reply
+ * buffer. This function allows easy handling of this case: just encode the
+ * reply, then use this function to break the message into two pieces if it
+ * exceeds the OpenFlow message limit.
+ *
+ * In detail, if the final stats message in 'replies' is too long for OpenFlow,
+ * this function breaks it into two separate stats replies, the first one with
+ * the first 'start_ofs' bytes, the second one containing the bytes from that
+ * offset onward. */
+void
+ofputil_postappend_stats_reply(size_t start_ofs, struct list *replies)
+{
+ struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
+
+ assert(start_ofs <= UINT16_MAX);
+ if (msg->size > UINT16_MAX) {
+ size_t len = msg->size - start_ofs;
+ memcpy(ofputil_append_stats_reply(len, replies),
+ (const uint8_t *) msg->data + start_ofs, len);
+ msg->size = start_ofs;
+ }
}
-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)
+/* Returns the first byte past the ofp_stats_msg header in 'oh'. */
+const void *
+ofputil_stats_body(const struct ofp_header *oh)
{
- 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);
+ assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
+ return (const struct ofp_stats_msg *) oh + 1;
+}
- 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;
+/* Returns the number of bytes past the ofp_stats_msg header in 'oh'. */
+size_t
+ofputil_stats_body_len(const struct ofp_header *oh)
+{
+ assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
+ return ntohs(oh->length) - sizeof(struct ofp_stats_msg);
}
-struct ofpbuf *
-make_unbuffered_packet_out(const struct ofpbuf *packet,
- uint16_t in_port, uint16_t out_port)
+/* Returns the first byte past the nicira_stats_msg header in 'oh'. */
+const void *
+ofputil_nxstats_body(const struct ofp_header *oh)
{
- 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);
+ assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
+ return ((const struct nicira_stats_msg *) oh) + 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);
- }
+/* Returns the number of bytes past the nicira_stats_msg header in 'oh'. */
+size_t
+ofputil_nxstats_body_len(const struct ofp_header *oh)
+{
+ assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
+ return ntohs(oh->length) - sizeof(struct nicira_stats_msg);
}
/* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
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);
return out;
}
-const struct ofp_flow_stats *
-flow_stats_first(struct flow_stats_iterator *iter,
- const struct ofp_stats_reply *osr)
+struct ofpbuf *
+ofputil_encode_barrier_request(void)
{
- iter->pos = osr->body;
- iter->end = osr->body + (ntohs(osr->header.length)
- - offsetof(struct ofp_stats_reply, body));
- return flow_stats_next(iter);
+ struct ofpbuf *msg;
+
+ make_openflow(sizeof(struct ofp_header), OFPT10_BARRIER_REQUEST, &msg);
+ return msg;
}
-const struct ofp_flow_stats *
-flow_stats_next(struct flow_stats_iterator *iter)
+const char *
+ofputil_frag_handling_to_string(enum ofp_config_flags flags)
{
- ptrdiff_t bytes_left = iter->end - iter->pos;
- const struct ofp_flow_stats *fs;
- size_t length;
-
- if (bytes_left < sizeof *fs) {
- if (bytes_left != 0) {
- VLOG_WARN_RL(&bad_ofmsg_rl,
- "%td leftover bytes in flow stats reply", bytes_left);
- }
- return NULL;
+ 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";
}
- fs = (const void *) iter->pos;
- length = ntohs(fs->length);
- if (length < sizeof *fs) {
- VLOG_WARN_RL(&bad_ofmsg_rl, "flow stats length %zu is shorter than "
- "min %zu", length, sizeof *fs);
- return NULL;
- } else if (length > bytes_left) {
- VLOG_WARN_RL(&bad_ofmsg_rl, "flow stats length %zu but only %td "
- "bytes left", length, bytes_left);
- return NULL;
- } else if ((length - sizeof *fs) % sizeof fs->actions[0]) {
- VLOG_WARN_RL(&bad_ofmsg_rl, "flow stats length %zu has %zu bytes "
- "left over in final action", length,
- (length - sizeof *fs) % sizeof fs->actions[0]);
- return NULL;
+ 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;
}
- iter->pos += length;
- return fs;
+ return true;
}
-static int
-check_action_exact_len(const union ofp_action *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, "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);
+ 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;
}
-/* Checks that 'port' is a valid output port for the OFPAT_OUTPUT action, given
+/* 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 OFPAT10_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:
case OFPP_FLOOD:
case OFPP_ALL:
case OFPP_CONTROLLER:
+ case OFPP_NONE:
case OFPP_LOCAL:
return 0;
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;
- uint16_t subtype;
- int error;
-
- 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);
- }
- nah = (const struct nx_action_header *) a;
-
- subtype = ntohs(nah->subtype);
- if (subtype > TYPE_MAXIMUM(enum nx_action_subtype)) {
- /* This is necessary because enum nx_action_subtype is probably an
- * 8-bit type, so the cast below throws away the top 8 bits. */
- return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR_TYPE);
- }
-
- switch ((enum nx_action_subtype) subtype) {
- case NXAST_RESUBMIT:
- case NXAST_SET_TUNNEL:
- case NXAST_DROP_SPOOFED_ARP:
- case NXAST_SET_QUEUE:
- case NXAST_POP_QUEUE:
- return check_action_exact_len(a, len, 16);
-
- case NXAST_REG_MOVE:
- error = check_action_exact_len(a, len,
- sizeof(struct nx_action_reg_move));
- if (error) {
- return error;
- }
- return nxm_check_reg_move((const struct nx_action_reg_move *) a, flow);
-
- case NXAST_REG_LOAD:
- error = check_action_exact_len(a, 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;
-
- case NXAST_SET_TUNNEL64:
- return check_action_exact_len(a, len,
- sizeof(struct nx_action_set_tunnel64));
+ const char *name;
- case NXAST_MULTIPATH:
- error = check_action_exact_len(a, len,
- sizeof(struct nx_action_multipath));
- if (error) {
- return error;
- }
- return multipath_check((const struct nx_action_multipath *) a);
+ switch (port) {
+#define OFPUTIL_NAMED_PORT(NAME) case OFPP_##NAME: name = #NAME; break;
+ OFPUTIL_NAMED_PORTS
+#undef OFPUTIL_NAMED_PORT
- case NXAST_SNAT__OBSOLETE:
default:
- return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR_TYPE);
+ ds_put_format(s, "%"PRIu16, port);
+ return;
}
+ ds_put_cstr(s, name);
}
-static int
-check_action(const union ofp_action *a, unsigned int len,
- const struct flow *flow, int max_ports)
+/* Given a buffer 'b' that contains an array of OpenFlow ports of type
+ * 'ofp_version', tries to pull the first element from the array. If
+ * successful, initializes '*pp' with an abstract representation of the
+ * port and returns 0. If no ports remain to be decoded, returns EOF.
+ * On an error, returns a positive OFPERR_* value. */
+int
+ofputil_pull_phy_port(uint8_t ofp_version, struct ofpbuf *b,
+ struct ofputil_phy_port *pp)
{
- 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;
- }
- return check_output_port(ntohs(a->output.port), max_ports);
-
- 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_SET_VLAN_PCP:
- error = check_action_exact_len(a, len, 8);
- if (error) {
- return error;
- }
- if (a->vlan_vid.vlan_vid & ~7) {
- return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
- }
- return 0;
-
- 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 OFPAT_SET_DL_SRC:
- case OFPAT_SET_DL_DST:
- return check_action_exact_len(a, len, 16);
-
- 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));
-
- case OFPAT_ENQUEUE:
- return check_enqueue_action(a, len, max_ports);
-
- default:
- VLOG_WARN_RL(&bad_ofmsg_rl, "unknown action type %d", (int) type);
- return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_TYPE);
+ if (ofp_version == OFP10_VERSION) {
+ const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
+ return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
+ } else {
+ const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
+ return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
}
}
+/* Given a buffer 'b' that contains an array of OpenFlow ports of type
+ * 'ofp_version', returns the number of elements. */
+size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *b)
+{
+ return b->size / ofputil_get_phy_port_size(ofp_version);
+}
+
+/* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
+ * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1 if
+ * 'name' is not the name of any action.
+ *
+ * ofp-util.def lists the mapping from names to action. */
int
-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;
+ static const char *names[OFPUTIL_N_ACTIONS] = {
+ NULL,
+#define OFPAT10_ACTION(ENUM, STRUCT, NAME) NAME,
+#define OFPAT11_ACTION(ENUM, STRUCT, NAME) NAME,
+#define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
+#include "ofp-util.def"
+ };
- 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;
+ const char **p;
- 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);
- }
-
- 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;
}
-/* Returns true if 'action' outputs to 'port' (which must be in network byte
- * order), false otherwise. */
-bool
-action_outputs_to_port(const union ofp_action *action, uint16_t port)
+/* 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
+ * <ENUM> and length 'sizeof *action' and zeros the rest. For actions that
+ * have variable length, the length used and cleared is that of struct
+ * <STRUCT>. */
+void *
+ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
{
- switch (ntohs(action->type)) {
- case OFPAT_OUTPUT:
- return action->output.port == port;
- case OFPAT_ENQUEUE:
- return ((const struct ofp_action_enqueue *) action)->port == port;
- default:
- return false;
- }
-}
+ switch (code) {
+ case OFPUTIL_ACTION_INVALID:
+ NOT_REACHED();
-/* 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);
+#define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
+ case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
+#define OFPAT11_ACTION OFPAT10_ACTION
+#define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
+ case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
+#include "ofp-util.def"
+ }
+ NOT_REACHED();
}
-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;
+#define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
+ void \
+ ofputil_init_##ENUM(struct STRUCT *s) \
+ { \
+ memset(s, 0, sizeof *s); \
+ s->type = htons(ENUM); \
+ s->len = htons(sizeof *s); \
+ } \
+ \
+ struct STRUCT * \
+ ofputil_put_##ENUM(struct ofpbuf *buf) \
+ { \
+ struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
+ ofputil_init_##ENUM(s); \
+ return s; \
}
-}
+#define OFPAT11_ACTION OFPAT10_ACTION
+#define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
+ void \
+ ofputil_init_##ENUM(struct STRUCT *s) \
+ { \
+ memset(s, 0, sizeof *s); \
+ s->type = htons(OFPAT10_VENDOR); \
+ s->len = htons(sizeof *s); \
+ s->vendor = htonl(NX_VENDOR_ID); \
+ s->subtype = htons(ENUM); \
+ } \
+ \
+ struct STRUCT * \
+ ofputil_put_##ENUM(struct ofpbuf *buf) \
+ { \
+ struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
+ ofputil_init_##ENUM(s); \
+ return s; \
+ }
+#include "ofp-util.def"
+/* "Normalizes" the wildcards in 'rule'. That means:
+ *
+ * 1. If the type of level N is known, then only the valid fields for that
+ * level may be specified. For example, ARP does not have a TOS field,
+ * so nw_tos must be wildcarded if 'rule' specifies an ARP flow.
+ * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
+ * ipv6_dst (and other fields) must be wildcarded if 'rule' specifies an
+ * IPv4 flow.
+ *
+ * 2. If the type of level N is not known (or not understood by Open
+ * vSwitch), then no fields at all for that level may be specified. For
+ * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
+ * L4 fields tp_src and tp_dst must be wildcarded if 'rule' specifies an
+ * SCTP flow.
+ */
void
-normalize_match(struct ofp_match *m)
-{
- enum { OFPFW_NW = (OFPFW_NW_SRC_MASK | OFPFW_NW_DST_MASK | OFPFW_NW_PROTO
- | OFPFW_NW_TOS) };
- enum { OFPFW_TP = OFPFW_TP_SRC | OFPFW_TP_DST };
- uint32_t wc;
-
- wc = ntohl(m->wildcards) & OVSFW_ALL;
- if (wc & OFPFW_DL_TYPE) {
- m->dl_type = 0;
-
- /* Can't sensibly match on network or transport headers if the
- * data link type is unknown. */
- wc |= OFPFW_NW | OFPFW_TP;
- m->nw_src = m->nw_dst = m->nw_proto = m->nw_tos = 0;
- m->tp_src = m->tp_dst = 0;
- } else if (m->dl_type == htons(ETH_TYPE_IP)) {
- if (wc & OFPFW_NW_PROTO) {
- m->nw_proto = 0;
-
- /* Can't sensibly match on transport headers if the network
- * protocol is unknown. */
- wc |= OFPFW_TP;
- m->tp_src = m->tp_dst = 0;
- } else if (m->nw_proto == IPPROTO_TCP ||
- m->nw_proto == IPPROTO_UDP ||
- m->nw_proto == IPPROTO_ICMP) {
- if (wc & OFPFW_TP_SRC) {
- m->tp_src = 0;
- }
- if (wc & OFPFW_TP_DST) {
- m->tp_dst = 0;
- }
- } else {
- /* Transport layer fields will always be extracted as zeros, so we
- * can do an exact-match on those values. */
- wc &= ~OFPFW_TP;
- m->tp_src = m->tp_dst = 0;
- }
- if (wc & OFPFW_NW_SRC_MASK) {
- m->nw_src &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_SRC_SHIFT);
- }
- if (wc & OFPFW_NW_DST_MASK) {
- m->nw_dst &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_DST_SHIFT);
- }
- if (wc & OFPFW_NW_TOS) {
- m->nw_tos = 0;
- } else {
- m->nw_tos &= IP_DSCP_MASK;
- }
- } else if (m->dl_type == htons(ETH_TYPE_ARP)) {
- if (wc & OFPFW_NW_PROTO) {
- m->nw_proto = 0;
- }
- if (wc & OFPFW_NW_SRC_MASK) {
- m->nw_src &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_SRC_SHIFT);
+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_IPVx = 1 << 3, /* tos, frag, ttl */
+ MAY_ARP_SHA = 1 << 4, /* arp_sha */
+ MAY_ARP_THA = 1 << 5, /* arp_tha */
+ MAY_IPV6 = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
+ MAY_ND_TARGET = 1 << 7 /* nd_target */
+ } may_match;
+
+ struct flow_wildcards wc;
+
+ /* Figure out what fields may be matched. */
+ if (rule->flow.dl_type == htons(ETH_TYPE_IP)) {
+ 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;
}
- if (wc & OFPFW_NW_DST_MASK) {
- m->nw_dst &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_DST_SHIFT);
+ } 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;
+ } else if (rule->flow.nw_proto == IPPROTO_ICMPV6) {
+ may_match |= MAY_TP_ADDR;
+ if (rule->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
+ may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
+ } else if (rule->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
+ may_match |= MAY_ND_TARGET | MAY_ARP_THA;
+ }
}
- m->tp_src = m->tp_dst = m->nw_tos = 0;
+ } else if (rule->flow.dl_type == htons(ETH_TYPE_ARP)) {
+ may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
} else {
- /* Network and transport layer fields will always be extracted as
- * zeros, so we can do an exact-match on those values. */
- wc &= ~(OFPFW_NW | OFPFW_TP);
- m->nw_proto = m->nw_src = m->nw_dst = m->nw_tos = 0;
- m->tp_src = m->tp_dst = 0;
+ may_match = 0;
}
- if (wc & OFPFW_DL_SRC) {
- memset(m->dl_src, 0, sizeof m->dl_src);
+
+ /* Clear the fields that may not be matched. */
+ wc = rule->wc;
+ if (!(may_match & MAY_NW_ADDR)) {
+ wc.nw_src_mask = wc.nw_dst_mask = htonl(0);
}
- if (wc & OFPFW_DL_DST) {
- memset(m->dl_dst, 0, sizeof m->dl_dst);
+ if (!(may_match & MAY_TP_ADDR)) {
+ wc.tp_src_mask = wc.tp_dst_mask = htons(0);
}
- m->wildcards = htonl(wc);
-}
-
-/* Returns a string that describes 'match' in a very literal way, without
- * interpreting its contents except in a very basic fashion. The returned
- * string is intended to be fixed-length, so that it is easy to see differences
- * between two such strings if one is put above another. This is useful for
- * describing changes made by normalize_match().
- *
- * The caller must free the returned string (with free()). */
-char *
-ofp_match_to_literal_string(const struct ofp_match *match)
-{
- return xasprintf("wildcards=%#10"PRIx32" "
- " in_port=%5"PRId16" "
- " dl_src="ETH_ADDR_FMT" "
- " dl_dst="ETH_ADDR_FMT" "
- " dl_vlan=%5"PRId16" "
- " dl_vlan_pcp=%3"PRId8" "
- " dl_type=%#6"PRIx16" "
- " nw_tos=%#4"PRIx8" "
- " nw_proto=%#4"PRIx16" "
- " nw_src=%#10"PRIx32" "
- " nw_dst=%#10"PRIx32" "
- " tp_src=%5"PRId16" "
- " tp_dst=%5"PRId16,
- ntohl(match->wildcards),
- ntohs(match->in_port),
- ETH_ADDR_ARGS(match->dl_src),
- ETH_ADDR_ARGS(match->dl_dst),
- ntohs(match->dl_vlan),
- match->dl_vlan_pcp,
- ntohs(match->dl_type),
- match->nw_tos,
- match->nw_proto,
- ntohl(match->nw_src),
- ntohl(match->nw_dst),
- ntohs(match->tp_src),
- ntohs(match->tp_dst));
-}
-
-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;
+ if (!(may_match & MAY_NW_PROTO)) {
+ wc.wildcards |= FWW_NW_PROTO;
}
-}
-
-/* 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 *
-make_ofp_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 (!(may_match & MAY_IPVx)) {
+ wc.wildcards |= FWW_NW_DSCP;
+ wc.wildcards |= FWW_NW_ECN;
+ wc.wildcards |= FWW_NW_TTL;
}
-
- if (oh) {
- xid = oh->xid;
- data = oh;
- len = ntohs(oh->length);
- if (len > 64) {
- len = 64;
- }
- } else {
- xid = 0;
- data = NULL;
- len = 0;
+ if (!(may_match & MAY_ARP_SHA)) {
+ memset(wc.arp_sha_mask, 0, ETH_ADDR_LEN);
}
-
- 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 (!(may_match & MAY_ARP_THA)) {
+ memset(wc.arp_tha_mask, 0, ETH_ADDR_LEN);
}
-
- if (len) {
- buf->size -= len;
- ofpbuf_put(buf, data, len);
+ if (!(may_match & MAY_IPV6)) {
+ wc.ipv6_src_mask = wc.ipv6_dst_mask = in6addr_any;
+ wc.ipv6_label_mask = htonl(0);
+ }
+ if (!(may_match & MAY_ND_TARGET)) {
+ wc.nd_target_mask = in6addr_any;
}
- return buf;
+ /* Log any changes. */
+ if (!flow_wildcards_equal(&wc, &rule->wc)) {
+ bool log = !VLOG_DROP_INFO(&bad_ofmsg_rl);
+ char *pre = log ? cls_rule_to_string(rule) : NULL;
+
+ rule->wc = wc;
+ cls_rule_zero_wildcarded_fields(rule);
+
+ if (log) {
+ char *post = cls_rule_to_string(rule);
+ VLOG_INFO("normalization changed ofp_match, details:");
+ VLOG_INFO(" pre: %s", pre);
+ VLOG_INFO("post: %s", post);
+ free(pre);
+ free(post);
+ }
+ }
}
-/* Attempts to pull 'actions_len' bytes from the front of 'b'. Returns 0 if
- * successful, otherwise an OpenFlow error.
+/* Parses a key or a key-value pair from '*stringp'.
*
- * If successful, the first action is stored in '*actionsp' and the number of
- * "union ofp_action" size elements into '*n_actionsp'. Otherwise NULL and 0
- * are stored, respectively.
+ * 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.
*
- * This function does not check that the actions are valid (the caller should
- * 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
-ofputil_pull_actions(struct ofpbuf *b, unsigned int actions_len,
- union ofp_action **actionsp, size_t *n_actionsp)
+ * 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)
{
- if (actions_len % OFP_ACTION_ALIGN != 0) {
- VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
- "is not a multiple of %d", actions_len, OFP_ACTION_ALIGN);
- goto error;
- }
+ char *pos, *key, *value;
+ size_t key_len;
- *actionsp = ofpbuf_try_pull(b, actions_len);
- if (*actionsp == NULL) {
- VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
- "exceeds remaining message length (%zu)",
- actions_len, b->size);
- goto error;
+ pos = *stringp;
+ pos += strspn(pos, ", \t\r\n");
+ if (*pos == '\0') {
+ *keyp = *valuep = NULL;
+ return false;
}
- *n_actionsp = actions_len / OFP_ACTION_ALIGN;
- return 0;
+ key = pos;
+ key_len = strcspn(pos, ":=(, \t\r\n");
+ if (key[key_len] == ':' || key[key_len] == '=') {
+ /* The value can be separated by a colon. */
+ size_t value_len;
+
+ value = key + key_len + 1;
+ value_len = strcspn(value, ", \t\r\n");
+ pos = value + value_len + (value[value_len] != '\0');
+ value[value_len] = '\0';
+ } else if (key[key_len] == '(') {
+ /* The value can be surrounded by balanced parentheses. The outermost
+ * set of parentheses is removed. */
+ int level = 1;
+ size_t value_len;
+
+ value = key + key_len + 1;
+ for (value_len = 0; level > 0; value_len++) {
+ switch (value[value_len]) {
+ case '\0':
+ level = 0;
+ break;
+
+ case '(':
+ level++;
+ break;
+
+ case ')':
+ level--;
+ break;
+ }
+ }
+ value[value_len - 1] = '\0';
+ pos = value + value_len;
+ } else {
+ /* There might be no value at all. */
+ value = key + key_len; /* Will become the empty string below. */
+ pos = key + key_len + (key[key_len] != '\0');
+ }
+ key[key_len] = '\0';
-error:
- *actionsp = NULL;
- *n_actionsp = 0;
- return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
+ *stringp = pos;
+ *keyp = key;
+ *valuep = value;
+ return true;
}