Don't specify program name in passive connection man page fragments.
[sliver-openvswitch.git] / lib / ofp-util.c
index 923df05..1c9ceaf 100644 (file)
@@ -101,18 +101,20 @@ static const flow_wildcards_t WC_INVARIANTS = 0
 void
 ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *wc)
 {
-    BUILD_ASSERT_DECL(FLOW_WC_SEQ == 6);
+    BUILD_ASSERT_DECL(FLOW_WC_SEQ == 7);
 
     /* Initialize most of rule->wc. */
     flow_wildcards_init_catchall(wc);
     wc->wildcards = (OVS_FORCE flow_wildcards_t) ofpfw & WC_INVARIANTS;
 
     /* Wildcard fields that aren't defined by ofp_match or tun_id. */
-    wc->wildcards |= (FWW_ARP_SHA | FWW_ARP_THA | FWW_NW_TTL
+    wc->wildcards |= (FWW_ARP_SHA | FWW_ARP_THA | FWW_NW_ECN | FWW_NW_TTL
                       | FWW_ND_TARGET | FWW_IPV6_LABEL);
 
-    if (!(ofpfw & OFPFW_NW_TOS)) {
-        wc->nw_tos_mask |= IP_DSCP_MASK;
+    if (ofpfw & OFPFW_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);
@@ -194,7 +196,7 @@ ofputil_cls_rule_to_match(const struct cls_rule *rule, struct ofp_match *match)
     ofpfw = (OVS_FORCE uint32_t) (wc->wildcards & WC_INVARIANTS);
     ofpfw |= ofputil_netmask_to_wcbits(wc->nw_src_mask) << OFPFW_NW_SRC_SHIFT;
     ofpfw |= ofputil_netmask_to_wcbits(wc->nw_dst_mask) << OFPFW_NW_DST_SHIFT;
-    if (!(wc->nw_tos_mask & IP_DSCP_MASK)) {
+    if (wc->wildcards & FWW_NW_DSCP) {
         ofpfw |= OFPFW_NW_TOS;
     }
 
@@ -361,6 +363,14 @@ ofputil_decode_vendor(const struct ofp_header *oh, size_t length,
           NXT_SET_FLOW_FORMAT, "NXT_SET_FLOW_FORMAT",
           sizeof(struct nxt_set_flow_format), 0 },
 
+        { OFPUTIL_NXT_SET_PACKET_IN_FORMAT,
+          NXT_SET_PACKET_IN_FORMAT, "NXT_SET_PACKET_IN_FORMAT",
+          sizeof(struct nxt_set_packet_in_format), 0 },
+
+        { OFPUTIL_NXT_PACKET_IN,
+          NXT_PACKET_IN, "NXT_PACKET_IN",
+          sizeof(struct nxt_packet_in), 1 },
+
         { OFPUTIL_NXT_FLOW_MOD,
           NXT_FLOW_MOD, "NXT_FLOW_MOD",
           sizeof(struct nx_flow_mod), 8 },
@@ -837,6 +847,39 @@ ofputil_flow_format_from_string(const char *s)
             : -1);
 }
 
+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_packet_in_format_to_string(enum nx_packet_in_format packet_in_format)
+{
+    switch (packet_in_format) {
+    case NXPIF_OPENFLOW10:
+        return "openflow10";
+    case NXPIF_NXM:
+        return "nxm";
+    default:
+        NOT_REACHED();
+    }
+}
+
+int
+ofputil_packet_in_format_from_string(const char *s)
+{
+    return (!strcmp(s, "openflow10") ? NXPIF_OPENFLOW10
+            : !strcmp(s, "nxm") ? NXPIF_NXM
+            : -1);
+}
+
 static bool
 regs_fully_wildcarded(const struct flow_wildcards *wc)
 {
@@ -859,7 +902,7 @@ ofputil_min_flow_format(const struct cls_rule *rule)
 {
     const struct flow_wildcards *wc = &rule->wc;
 
-    BUILD_ASSERT_DECL(FLOW_WC_SEQ == 6);
+    BUILD_ASSERT_DECL(FLOW_WC_SEQ == 7);
 
     /* Only NXM supports separately wildcards the Ethernet multicast bit. */
     if (!(wc->wildcards & FWW_DL_DST) != !(wc->wildcards & FWW_ETH_MCAST)) {
@@ -898,7 +941,7 @@ ofputil_min_flow_format(const struct cls_rule *rule)
     }
 
     /* Only NXM supports matching IP ECN bits. */
-    if (wc->nw_tos_mask & IP_ECN_MASK) {
+    if (!(wc->wildcards & FWW_NW_ECN)) {
         return NXFF_NXM;
     }
 
@@ -925,6 +968,18 @@ ofputil_make_set_flow_format(enum nx_flow_format flow_format)
     return msg;
 }
 
+struct ofpbuf *
+ofputil_make_set_packet_in_format(enum nx_packet_in_format packet_in_format)
+{
+    struct nxt_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 *
@@ -985,6 +1040,7 @@ ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
 
         /* Translate the message. */
         fm->cookie = ofm->cookie;
+        fm->cookie_mask = htonll(UINT64_MAX);
         command = ntohs(ofm->command);
         fm->idle_timeout = ntohs(ofm->idle_timeout);
         fm->hard_timeout = ntohs(ofm->hard_timeout);
@@ -999,7 +1055,7 @@ ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
         /* 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;
         }
@@ -1009,8 +1065,18 @@ ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
         }
 
         /* Translate the message. */
-        fm->cookie = nfm->cookie;
         command = ntohs(nfm->command);
+        if (command == OFPFC_ADD) {
+            if (fm->cookie_mask) {
+                /* The "NXM_NX_COOKIE*" matches are not valid for flow
+                 * additions.  Additions must use the "cookie" field of
+                 * the "nx_flow_mod" structure. */
+                return ofp_mkerr(OFPET_BAD_REQUEST, NXBRC_NXM_INVALID);
+            } else {
+                fm->cookie = nfm->cookie;
+                fm->cookie_mask = htonll(UINT64_MAX);
+            }
+        }
         fm->idle_timeout = ntohs(nfm->idle_timeout);
         fm->hard_timeout = ntohs(nfm->hard_timeout);
         fm->buffer_id = ntohl(nfm->buffer_id);
@@ -1069,11 +1135,16 @@ ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
 
         msg = ofpbuf_new(sizeof *nfm + NXM_TYPICAL_LEN + actions_len);
         put_nxmsg(sizeof *nfm, NXT_FLOW_MOD, msg);
-        match_len = nx_put_match(msg, &fm->cr);
-
         nfm = msg->data;
-        nfm->cookie = fm->cookie;
         nfm->command = htons(command);
+        if (command == OFPFC_ADD) {
+            nfm->cookie = fm->cookie;
+            match_len = nx_put_match(msg, &fm->cr, 0, 0);
+        } else {
+            nfm->cookie = 0;
+            match_len = nx_put_match(msg, &fm->cr,
+                                     fm->cookie, fm->cookie_mask);
+        }
         nfm->idle_timeout = htons(fm->idle_timeout);
         nfm->hard_timeout = htons(fm->hard_timeout);
         nfm->priority = htons(fm->cr.priority);
@@ -1102,6 +1173,7 @@ ofputil_decode_ofpst_flow_request(struct ofputil_flow_stats_request *fsr,
     ofputil_cls_rule_from_match(&ofsr->match, 0, &fsr->match);
     fsr->out_port = ntohs(ofsr->out_port);
     fsr->table_id = ofsr->table_id;
+    fsr->cookie = fsr->cookie_mask = htonll(0);
 
     return 0;
 }
@@ -1118,7 +1190,8 @@ ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
     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;
     }
@@ -1192,7 +1265,8 @@ ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
 
         subtype = fsr->aggregate ? NXST_AGGREGATE : NXST_FLOW;
         ofputil_make_stats_request(sizeof *nfsr, OFPST_VENDOR, subtype, &msg);
-        match_len = nx_put_match(msg, &fsr->match);
+        match_len = nx_put_match(msg, &fsr->match,
+                                 fsr->cookie, fsr->cookie_mask);
 
         nfsr = msg->data;
         nfsr->out_port = htons(fsr->out_port);
@@ -1288,7 +1362,8 @@ ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
                          "claims invalid length %zu", match_len, length);
             return EINVAL;
         }
-        if (nx_pull_match(msg, match_len, ntohs(nfs->priority), &fs->rule)) {
+        if (nx_pull_match(msg, match_len, ntohs(nfs->priority), &fs->rule,
+                          NULL, NULL)) {
             return EINVAL;
         }
 
@@ -1372,7 +1447,7 @@ ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
         nfs->priority = htons(fs->rule.priority);
         nfs->idle_timeout = htons(fs->idle_timeout);
         nfs->hard_timeout = htons(fs->hard_timeout);
-        nfs->match_len = htons(nx_put_match(msg, &fs->rule));
+        nfs->match_len = htons(nx_put_match(msg, &fs->rule, 0, 0));
         memset(nfs->pad2, 0, sizeof nfs->pad2);
         nfs->cookie = fs->cookie;
         nfs->packet_count = htonll(fs->packet_count);
@@ -1451,7 +1526,7 @@ ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
 
         nfr = ofpbuf_pull(&b, sizeof *nfr);
         error = nx_pull_match(&b, ntohs(nfr->match_len), ntohs(nfr->priority),
-                              &fr->rule);
+                              &fr->rule, NULL, NULL);
         if (error) {
             return error;
         }
@@ -1501,7 +1576,7 @@ ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
         int match_len;
 
         make_nxmsg_xid(sizeof *nfr, NXT_FLOW_REMOVED, htonl(0), &msg);
-        match_len = nx_put_match(msg, &fr->rule);
+        match_len = nx_put_match(msg, &fr->rule, 0, 0);
 
         nfr = msg->data;
         nfr->cookie = fr->cookie;
@@ -1520,48 +1595,141 @@ ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
     return msg;
 }
 
-/* Converts abstract ofputil_packet_in 'pin' into an OFPT_PACKET_IN message
- * and returns the message.
- *
- * If 'rw_packet' is NULL, the caller takes ownership of the newly allocated
- * returned ofpbuf.
- *
- * If 'rw_packet' is nonnull, then it must contain the same data as
- * pin->packet.  'rw_packet' is allowed to be the same ofpbuf as pin->packet.
- * It is modified in-place into an OFPT_PACKET_IN message according to 'pin',
- * and then ofputil_encode_packet_in() returns 'rw_packet'.  If 'rw_packet' has
- * enough headroom to insert a "struct ofp_packet_in", this is more efficient
- * than ofputil_encode_packet_in() because it does not copy the packet
- * payload. */
-struct ofpbuf *
-ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
-                        struct ofpbuf *rw_packet)
+int
+ofputil_decode_packet_in(struct ofputil_packet_in *pin,
+                         const struct ofp_header *oh)
 {
-    int total_len = pin->packet->size;
-    struct ofp_packet_in opi;
+    const struct ofputil_msg_type *type;
+    enum ofputil_msg_code code;
 
-    if (rw_packet) {
-        if (pin->send_len < rw_packet->size) {
-            rw_packet->size = pin->send_len;
+    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 nxt_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 ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
         }
+
+        pin->packet = b.data;
+        pin->packet_len = b.size;
+        pin->reason = npi->reason;
+        pin->table_id = npi->table_id;
+        pin->cookie = npi->cookie;
+
+        pin->fmd.in_port = rule.flow.in_port;
+
+        pin->fmd.tun_id = rule.flow.tun_id;
+        pin->fmd.tun_id_mask = rule.wc.tun_id_mask;
+
+        memcpy(pin->fmd.regs, rule.flow.regs, sizeof pin->fmd.regs);
+        memcpy(pin->fmd.reg_masks, rule.wc.reg_masks,
+               sizeof pin->fmd.reg_masks);
+
+        pin->buffer_id = ntohl(npi->buffer_id);
+        pin->total_len = ntohs(npi->total_len);
     } else {
-        rw_packet = ofpbuf_clone_data_with_headroom(
-            pin->packet->data, MIN(pin->send_len, pin->packet->size),
-            offsetof(struct ofp_packet_in, data));
+        NOT_REACHED();
     }
 
+    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. */
-    memset(&opi, 0, sizeof opi);
-    opi.header.version = OFP_VERSION;
-    opi.header.type = OFPT_PACKET_IN;
-    opi.total_len = htons(total_len);
-    opi.in_port = htons(pin->in_port);
-    opi.reason = pin->reason;
-    opi.buffer_id = htonl(pin->buffer_id);
-    ofpbuf_push(rw_packet, &opi, offsetof(struct ofp_packet_in, data));
-    update_openflow_length(rw_packet);
+    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 = OFP_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 nxt_packet_in *npi;
+        struct cls_rule rule;
+        size_t match_len;
+        size_t i;
+
+        /* Estimate of required PACKET_IN length includes the NPI header, space
+         * for the match (2 times sizeof the metadata seems like enough), 2
+         * bytes for padding, and the packet length. */
+        packet = ofpbuf_new(sizeof *npi + sizeof(struct flow_metadata) * 2
+                            + 2 + send_len);
+
+        cls_rule_init_catchall(&rule, 0);
+        cls_rule_set_tun_id_masked(&rule, pin->fmd.tun_id,
+                                   pin->fmd.tun_id_mask);
+
+        for (i = 0; i < FLOW_N_REGS; i++) {
+            cls_rule_set_reg_masked(&rule, i, pin->fmd.regs[i],
+                                    pin->fmd.reg_masks[i]);
+        }
+
+        cls_rule_set_in_port(&rule, pin->fmd.in_port);
+
+        ofpbuf_put_zeros(packet, sizeof *npi);
+        match_len = nx_put_match(packet, &rule, 0, 0);
+        ofpbuf_put_zeros(packet, 2);
+        ofpbuf_put(packet, pin->packet, send_len);
+
+        npi = packet->data;
+        npi->nxh.header.version = OFP_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 rw_packet;
+    return packet;
 }
 
 /* Returns a string representing the message type of 'type'.  The string is the
@@ -2209,7 +2377,8 @@ validate_actions(const union ofp_action *actions, size_t n_actions,
 
         case OFPUTIL_OFPAT_ENQUEUE:
             port = ntohs(((const struct ofp_action_enqueue *) a)->port);
-            if (port >= max_ports && port != OFPP_IN_PORT) {
+            if (port >= max_ports && port != OFPP_IN_PORT
+                && port != OFPP_LOCAL) {
                 error = ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT);
             }
             break;
@@ -2524,7 +2693,7 @@ ofputil_normalize_rule(struct cls_rule *rule, enum nx_flow_format flow_format)
         MAY_IPVx        = 1 << 3, /* tos, frag, ttl */
         MAY_ARP_SHA     = 1 << 4, /* arp_sha */
         MAY_ARP_THA     = 1 << 5, /* arp_tha */
-        MAY_IPV6_ADDR   = 1 << 6, /* ipv6_src, ipv6_dst */
+        MAY_IPV6        = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
         MAY_ND_TARGET   = 1 << 7  /* nd_target */
     } may_match;
 
@@ -2540,7 +2709,7 @@ ofputil_normalize_rule(struct cls_rule *rule, enum nx_flow_format flow_format)
         }
     } else if (rule->flow.dl_type == htons(ETH_TYPE_IPV6)
                && flow_format == NXFF_NXM) {
-        may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6_ADDR;
+        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;
@@ -2573,8 +2742,8 @@ ofputil_normalize_rule(struct cls_rule *rule, enum nx_flow_format flow_format)
         wc.wildcards |= FWW_NW_PROTO;
     }
     if (!(may_match & MAY_IPVx)) {
-        wc.nw_tos_mask = 0;
-        wc.nw_frag_mask = 0;
+        wc.wildcards |= FWW_NW_DSCP;
+        wc.wildcards |= FWW_NW_ECN;
         wc.wildcards |= FWW_NW_TTL;
     }
     if (!(may_match & MAY_ARP_SHA)) {
@@ -2583,7 +2752,7 @@ ofputil_normalize_rule(struct cls_rule *rule, enum nx_flow_format flow_format)
     if (!(may_match & MAY_ARP_THA)) {
         wc.wildcards |= FWW_ARP_THA;
     }
-    if (!(may_match & MAY_IPV6_ADDR)) {
+    if (!(may_match & MAY_IPV6)) {
         wc.ipv6_src_mask = wc.ipv6_dst_mask = in6addr_any;
         wc.wildcards |= FWW_IPV6_LABEL;
     }