lib/nx-match.c

   1 /*
   2  * Copyright (c) 2010, 2011, 2012 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18
  19 #include "nx-match.h"
  20
  21 #include <netinet/icmp6.h>
  22
  23 #include "classifier.h"
  24 #include "dynamic-string.h"
  25 #include "meta-flow.h"
  26 #include "ofp-errors.h"
  27 #include "ofp-util.h"
  28 #include "ofpbuf.h"
  29 #include "openflow/nicira-ext.h"
  30 #include "packets.h"
  31 #include "unaligned.h"
  32 #include "util.h"
  33 #include "vlog.h"
  34
  35 VLOG_DEFINE_THIS_MODULE(nx_match);
  36
  37 /* Rate limit for nx_match parse errors.  These always indicate a bug in the
  38  * peer and so there's not much point in showing a lot of them. */
  39 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
  40
  41 /* Returns the width of the data for a field with the given 'header', in
  42  * bytes. */
  43 int
  44 nxm_field_bytes(uint32_t header)
  45 {
  46     unsigned int length = NXM_LENGTH(header);
  47     return NXM_HASMASK(header) ? length / 2 : length;
  48 }
  49
  50 /* Returns the width of the data for a field with the given 'header', in
  51  * bits. */
  52 int
  53 nxm_field_bits(uint32_t header)
  54 {
  55     return nxm_field_bytes(header) * 8;
  56 }
  57 \f
  58 /* nx_pull_match() and helpers. */
  59
  60 static uint32_t
  61 nx_entry_ok(const void *p, unsigned int match_len)
  62 {
  63     unsigned int payload_len;
  64     ovs_be32 header_be;
  65     uint32_t header;
  66
  67     if (match_len < 4) {
  68         if (match_len) {
  69             VLOG_DBG_RL(&rl, "nx_match ends with partial nxm_header");
  70         }
  71         return 0;
  72     }
  73     memcpy(&header_be, p, 4);
  74     header = ntohl(header_be);
  75
  76     payload_len = NXM_LENGTH(header);
  77     if (!payload_len) {
  78         VLOG_DBG_RL(&rl, "nxm_entry %08"PRIx32" has invalid payload "
  79                     "length 0", header);
  80         return 0;
  81     }
  82     if (match_len < payload_len + 4) {
  83         VLOG_DBG_RL(&rl, "%"PRIu32"-byte nxm_entry but only "
  84                     "%u bytes left in nx_match", payload_len + 4, match_len);
  85         return 0;
  86     }
  87
  88     return header;
  89 }
  90
  91 static enum ofperr
  92 nx_pull_match__(struct ofpbuf *b, unsigned int match_len, bool strict,
  93                 uint16_t priority, struct cls_rule *rule,
  94                 ovs_be64 *cookie, ovs_be64 *cookie_mask)
  95 {
  96     uint32_t header;
  97     uint8_t *p;
  98
  99     assert((cookie != NULL) == (cookie_mask != NULL));
 100
 101     p = ofpbuf_try_pull(b, ROUND_UP(match_len, 8));
 102     if (!p) {
 103         VLOG_DBG_RL(&rl, "nx_match length %u, rounded up to a "
 104                     "multiple of 8, is longer than space in message (max "
 105                     "length %zu)", match_len, b->size);
 106         return OFPERR_OFPBMC_BAD_LEN;
 107     }
 108
 109     cls_rule_init_catchall(rule, priority);
 110     if (cookie) {
 111         *cookie = *cookie_mask = htonll(0);
 112     }
 113     for (;
 114          (header = nx_entry_ok(p, match_len)) != 0;
 115          p += 4 + NXM_LENGTH(header), match_len -= 4 + NXM_LENGTH(header)) {
 116         const struct mf_field *mf;
 117         enum ofperr error;
 118
 119         mf = mf_from_nxm_header(header);
 120         if (!mf) {
 121             if (strict) {
 122                 error = OFPERR_OFPBMC_BAD_FIELD;
 123             } else {
 124                 continue;
 125             }
 126         } else if (!mf_are_prereqs_ok(mf, &rule->flow)) {
 127             error = OFPERR_OFPBMC_BAD_PREREQ;
 128         } else if (!mf_is_all_wild(mf, &rule->wc)) {
 129             error = OFPERR_OFPBMC_DUP_FIELD;
 130         } else {
 131             unsigned int width = mf->n_bytes;
 132             union mf_value value;
 133
 134             memcpy(&value, p + 4, width);
 135             if (!mf_is_value_valid(mf, &value)) {
 136                 error = OFPERR_OFPBMC_BAD_VALUE;
 137             } else if (!NXM_HASMASK(header)) {
 138                 error = 0;
 139                 mf_set_value(mf, &value, rule);
 140             } else {
 141                 union mf_value mask;
 142
 143                 memcpy(&mask, p + 4 + width, width);
 144                 if (!mf_is_mask_valid(mf, &mask)) {
 145                     error = OFPERR_OFPBMC_BAD_MASK;
 146                 } else {
 147                     error = 0;
 148                     mf_set(mf, &value, &mask, rule);
 149                 }
 150             }
 151         }
 152
 153         /* Check if the match is for a cookie rather than a classifier rule. */
 154         if ((header == NXM_NX_COOKIE || header == NXM_NX_COOKIE_W) && cookie) {
 155             if (*cookie_mask) {
 156                 error = OFPERR_OFPBMC_DUP_FIELD;
 157             } else {
 158                 unsigned int width = sizeof *cookie;
 159
 160                 memcpy(cookie, p + 4, width);
 161                 if (NXM_HASMASK(header)) {
 162                     memcpy(cookie_mask, p + 4 + width, width);
 163                 } else {
 164                     *cookie_mask = htonll(UINT64_MAX);
 165                 }
 166                 error = 0;
 167             }
 168         }
 169
 170         if (error) {
 171             VLOG_DBG_RL(&rl, "bad nxm_entry %#08"PRIx32" (vendor=%"PRIu32", "
 172                         "field=%"PRIu32", hasmask=%"PRIu32", len=%"PRIu32"), "
 173                         "(%s)", header,
 174                         NXM_VENDOR(header), NXM_FIELD(header),
 175                         NXM_HASMASK(header), NXM_LENGTH(header),
 176                         ofperr_to_string(error));
 177             return error;
 178         }
 179     }
 180
 181     return match_len ? OFPERR_OFPBMC_BAD_LEN : 0;
 182 }
 183
 184 /* Parses the nx_match formatted match description in 'b' with length
 185  * 'match_len'.  The results are stored in 'rule', which is initialized with
 186  * 'priority'.  If 'cookie' and 'cookie_mask' contain valid pointers, then the
 187  * cookie and mask will be stored in them if a "NXM_NX_COOKIE*" match is
 188  * defined.  Otherwise, 0 is stored in both.
 189  *
 190  * Fails with an error when encountering unknown NXM headers.
 191  *
 192  * Returns 0 if successful, otherwise an OpenFlow error code. */
 193 enum ofperr
 194 nx_pull_match(struct ofpbuf *b, unsigned int match_len,
 195               uint16_t priority, struct cls_rule *rule,
 196               ovs_be64 *cookie, ovs_be64 *cookie_mask)
 197 {
 198     return nx_pull_match__(b, match_len, true, priority, rule, cookie,
 199                            cookie_mask);
 200 }
 201
 202 /* Behaves the same as nx_pull_match() with one exception.  Skips over unknown
 203  * NXM headers instead of failing with an error when they are encountered. */
 204 enum ofperr
 205 nx_pull_match_loose(struct ofpbuf *b, unsigned int match_len,
 206                     uint16_t priority, struct cls_rule *rule,
 207                     ovs_be64 *cookie, ovs_be64 *cookie_mask)
 208 {
 209     return nx_pull_match__(b, match_len, false, priority, rule, cookie,
 210                            cookie_mask);
 211 }
 212 \f
 213 /* nx_put_match() and helpers.
 214  *
 215  * 'put' functions whose names end in 'w' add a wildcarded field.
 216  * 'put' functions whose names end in 'm' add a field that might be wildcarded.
 217  * Other 'put' functions add exact-match fields.
 218  */
 219
 220 static void
 221 nxm_put_header(struct ofpbuf *b, uint32_t header)
 222 {
 223     ovs_be32 n_header = htonl(header);
 224     ofpbuf_put(b, &n_header, sizeof n_header);
 225 }
 226
 227 static void
 228 nxm_put_8(struct ofpbuf *b, uint32_t header, uint8_t value)
 229 {
 230     nxm_put_header(b, header);
 231     ofpbuf_put(b, &value, sizeof value);
 232 }
 233
 234 static void
 235 nxm_put_8m(struct ofpbuf *b, uint32_t header, uint8_t value, uint8_t mask)
 236 {
 237     switch (mask) {
 238     case 0:
 239         break;
 240
 241     case UINT8_MAX:
 242         nxm_put_8(b, header, value);
 243         break;
 244
 245     default:
 246         nxm_put_header(b, NXM_MAKE_WILD_HEADER(header));
 247         ofpbuf_put(b, &value, sizeof value);
 248         ofpbuf_put(b, &mask, sizeof mask);
 249     }
 250 }
 251
 252 static void
 253 nxm_put_16(struct ofpbuf *b, uint32_t header, ovs_be16 value)
 254 {
 255     nxm_put_header(b, header);
 256     ofpbuf_put(b, &value, sizeof value);
 257 }
 258
 259 static void
 260 nxm_put_16w(struct ofpbuf *b, uint32_t header, ovs_be16 value, ovs_be16 mask)
 261 {
 262     nxm_put_header(b, header);
 263     ofpbuf_put(b, &value, sizeof value);
 264     ofpbuf_put(b, &mask, sizeof mask);
 265 }
 266
 267 static void
 268 nxm_put_16m(struct ofpbuf *b, uint32_t header, ovs_be16 value, ovs_be16 mask)
 269 {
 270     switch (mask) {
 271     case 0:
 272         break;
 273
 274     case CONSTANT_HTONS(UINT16_MAX):
 275         nxm_put_16(b, header, value);
 276         break;
 277
 278     default:
 279         nxm_put_16w(b, NXM_MAKE_WILD_HEADER(header), value, mask);
 280         break;
 281     }
 282 }
 283
 284 static void
 285 nxm_put_32(struct ofpbuf *b, uint32_t header, ovs_be32 value)
 286 {
 287     nxm_put_header(b, header);
 288     ofpbuf_put(b, &value, sizeof value);
 289 }
 290
 291 static void
 292 nxm_put_32w(struct ofpbuf *b, uint32_t header, ovs_be32 value, ovs_be32 mask)
 293 {
 294     nxm_put_header(b, header);
 295     ofpbuf_put(b, &value, sizeof value);
 296     ofpbuf_put(b, &mask, sizeof mask);
 297 }
 298
 299 static void
 300 nxm_put_32m(struct ofpbuf *b, uint32_t header, ovs_be32 value, ovs_be32 mask)
 301 {
 302     switch (mask) {
 303     case 0:
 304         break;
 305
 306     case CONSTANT_HTONL(UINT32_MAX):
 307         nxm_put_32(b, header, value);
 308         break;
 309
 310     default:
 311         nxm_put_32w(b, NXM_MAKE_WILD_HEADER(header), value, mask);
 312         break;
 313     }
 314 }
 315
 316 static void
 317 nxm_put_64(struct ofpbuf *b, uint32_t header, ovs_be64 value)
 318 {
 319     nxm_put_header(b, header);
 320     ofpbuf_put(b, &value, sizeof value);
 321 }
 322
 323 static void
 324 nxm_put_64w(struct ofpbuf *b, uint32_t header, ovs_be64 value, ovs_be64 mask)
 325 {
 326     nxm_put_header(b, header);
 327     ofpbuf_put(b, &value, sizeof value);
 328     ofpbuf_put(b, &mask, sizeof mask);
 329 }
 330
 331 static void
 332 nxm_put_64m(struct ofpbuf *b, uint32_t header, ovs_be64 value, ovs_be64 mask)
 333 {
 334     switch (mask) {
 335     case 0:
 336         break;
 337
 338     case CONSTANT_HTONLL(UINT64_MAX):
 339         nxm_put_64(b, header, value);
 340         break;
 341
 342     default:
 343         nxm_put_64w(b, NXM_MAKE_WILD_HEADER(header), value, mask);
 344         break;
 345     }
 346 }
 347
 348 static void
 349 nxm_put_eth(struct ofpbuf *b, uint32_t header,
 350             const uint8_t value[ETH_ADDR_LEN])
 351 {
 352     nxm_put_header(b, header);
 353     ofpbuf_put(b, value, ETH_ADDR_LEN);
 354 }
 355
 356 static void
 357 nxm_put_eth_masked(struct ofpbuf *b, uint32_t header,
 358                    const uint8_t value[ETH_ADDR_LEN],
 359                    const uint8_t mask[ETH_ADDR_LEN])
 360 {
 361     if (!eth_addr_is_zero(mask)) {
 362         if (eth_mask_is_exact(mask)) {
 363             nxm_put_eth(b, header, value);
 364         } else {
 365             nxm_put_header(b, NXM_MAKE_WILD_HEADER(header));
 366             ofpbuf_put(b, value, ETH_ADDR_LEN);
 367             ofpbuf_put(b, mask, ETH_ADDR_LEN);
 368         }
 369     }
 370 }
 371
 372 static void
 373 nxm_put_ipv6(struct ofpbuf *b, uint32_t header,
 374              const struct in6_addr *value, const struct in6_addr *mask)
 375 {
 376     if (ipv6_mask_is_any(mask)) {
 377         return;
 378     } else if (ipv6_mask_is_exact(mask)) {
 379         nxm_put_header(b, header);
 380         ofpbuf_put(b, value, sizeof *value);
 381     } else {
 382         nxm_put_header(b, NXM_MAKE_WILD_HEADER(header));
 383         ofpbuf_put(b, value, sizeof *value);
 384         ofpbuf_put(b, mask, sizeof *mask);
 385     }
 386 }
 387
 388 static void
 389 nxm_put_frag(struct ofpbuf *b, const struct cls_rule *cr)
 390 {
 391     uint8_t nw_frag = cr->flow.nw_frag;
 392     uint8_t nw_frag_mask = cr->wc.nw_frag_mask;
 393
 394     switch (nw_frag_mask) {
 395     case 0:
 396         break;
 397
 398     case FLOW_NW_FRAG_MASK:
 399         nxm_put_8(b, NXM_NX_IP_FRAG, nw_frag);
 400         break;
 401
 402     default:
 403         nxm_put_8m(b, NXM_NX_IP_FRAG, nw_frag,
 404                    nw_frag_mask & FLOW_NW_FRAG_MASK);
 405         break;
 406     }
 407 }
 408
 409 static void
 410 nxm_put_ip(struct ofpbuf *b, const struct cls_rule *cr,
 411            uint8_t icmp_proto, uint32_t icmp_type, uint32_t icmp_code)
 412 {
 413     const flow_wildcards_t wc = cr->wc.wildcards;
 414     const struct flow *flow = &cr->flow;
 415
 416     nxm_put_frag(b, cr);
 417
 418     if (!(wc & FWW_NW_DSCP)) {
 419         nxm_put_8(b, NXM_OF_IP_TOS, flow->nw_tos & IP_DSCP_MASK);
 420     }
 421
 422     if (!(wc & FWW_NW_ECN)) {
 423         nxm_put_8(b, NXM_NX_IP_ECN, flow->nw_tos & IP_ECN_MASK);
 424     }
 425
 426     if (!(wc & FWW_NW_TTL)) {
 427         nxm_put_8(b, NXM_NX_IP_TTL, flow->nw_ttl);
 428     }
 429
 430     if (!(wc & FWW_NW_PROTO)) {
 431         nxm_put_8(b, NXM_OF_IP_PROTO, flow->nw_proto);
 432
 433         if (flow->nw_proto == IPPROTO_TCP) {
 434             nxm_put_16m(b, NXM_OF_TCP_SRC, flow->tp_src, cr->wc.tp_src_mask);
 435             nxm_put_16m(b, NXM_OF_TCP_DST, flow->tp_dst, cr->wc.tp_dst_mask);
 436         } else if (flow->nw_proto == IPPROTO_UDP) {
 437             nxm_put_16m(b, NXM_OF_UDP_SRC, flow->tp_src, cr->wc.tp_src_mask);
 438             nxm_put_16m(b, NXM_OF_UDP_DST, flow->tp_dst, cr->wc.tp_dst_mask);
 439         } else if (flow->nw_proto == icmp_proto) {
 440             if (cr->wc.tp_src_mask) {
 441                 nxm_put_8(b, icmp_type, ntohs(flow->tp_src));
 442             }
 443             if (cr->wc.tp_dst_mask) {
 444                 nxm_put_8(b, icmp_code, ntohs(flow->tp_dst));
 445             }
 446         }
 447     }
 448 }
 449
 450 /* Appends to 'b' the nx_match format that expresses 'cr' (except for
 451  * 'cr->priority', because priority is not part of nx_match), plus enough
 452  * zero bytes to pad the nx_match out to a multiple of 8.  For Flow Mod
 453  * and Flow Stats Requests messages, a 'cookie' and 'cookie_mask' may be
 454  * supplied.  Otherwise, 'cookie_mask' should be zero.
 455  *
 456  * This function can cause 'b''s data to be reallocated.
 457  *
 458  * Returns the number of bytes appended to 'b', excluding padding.
 459  *
 460  * If 'cr' is a catch-all rule that matches every packet, then this function
 461  * appends nothing to 'b' and returns 0. */
 462 int
 463 nx_put_match(struct ofpbuf *b, const struct cls_rule *cr,
 464              ovs_be64 cookie, ovs_be64 cookie_mask)
 465 {
 466     const flow_wildcards_t wc = cr->wc.wildcards;
 467     const struct flow *flow = &cr->flow;
 468     const size_t start_len = b->size;
 469     int match_len;
 470     int i;
 471
 472     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 11);
 473
 474     /* Metadata. */
 475     if (!(wc & FWW_IN_PORT)) {
 476         uint16_t in_port = flow->in_port;
 477         nxm_put_16(b, NXM_OF_IN_PORT, htons(in_port));
 478     }
 479
 480     /* Ethernet. */
 481     nxm_put_eth_masked(b, NXM_OF_ETH_SRC, flow->dl_src, cr->wc.dl_src_mask);
 482     nxm_put_eth_masked(b, NXM_OF_ETH_DST, flow->dl_dst, cr->wc.dl_dst_mask);
 483     if (!(wc & FWW_DL_TYPE)) {
 484         nxm_put_16(b, NXM_OF_ETH_TYPE,
 485                    ofputil_dl_type_to_openflow(flow->dl_type));
 486     }
 487
 488     /* 802.1Q. */
 489     nxm_put_16m(b, NXM_OF_VLAN_TCI, flow->vlan_tci, cr->wc.vlan_tci_mask);
 490
 491     /* L3. */
 492     if (!(wc & FWW_DL_TYPE) && flow->dl_type == htons(ETH_TYPE_IP)) {
 493         /* IP. */
 494         nxm_put_32m(b, NXM_OF_IP_SRC, flow->nw_src, cr->wc.nw_src_mask);
 495         nxm_put_32m(b, NXM_OF_IP_DST, flow->nw_dst, cr->wc.nw_dst_mask);
 496         nxm_put_ip(b, cr, IPPROTO_ICMP, NXM_OF_ICMP_TYPE, NXM_OF_ICMP_CODE);
 497     } else if (!(wc & FWW_DL_TYPE) && flow->dl_type == htons(ETH_TYPE_IPV6)) {
 498         /* IPv6. */
 499         nxm_put_ipv6(b, NXM_NX_IPV6_SRC, &flow->ipv6_src,
 500                 &cr->wc.ipv6_src_mask);
 501         nxm_put_ipv6(b, NXM_NX_IPV6_DST, &flow->ipv6_dst,
 502                 &cr->wc.ipv6_dst_mask);
 503         nxm_put_ip(b, cr,
 504                    IPPROTO_ICMPV6, NXM_NX_ICMPV6_TYPE, NXM_NX_ICMPV6_CODE);
 505
 506         if (!(wc & FWW_IPV6_LABEL)) {
 507             nxm_put_32(b, NXM_NX_IPV6_LABEL, flow->ipv6_label);
 508         }
 509
 510         if (flow->nw_proto == IPPROTO_ICMPV6
 511             && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
 512                 flow->tp_src == htons(ND_NEIGHBOR_ADVERT))) {
 513             nxm_put_ipv6(b, NXM_NX_ND_TARGET, &flow->nd_target,
 514                          &cr->wc.nd_target_mask);
 515             if (!(wc & FWW_ARP_SHA)
 516                 && flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
 517                 nxm_put_eth(b, NXM_NX_ND_SLL, flow->arp_sha);
 518             }
 519             if (!(wc & FWW_ARP_THA)
 520                 && flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
 521                 nxm_put_eth(b, NXM_NX_ND_TLL, flow->arp_tha);
 522             }
 523         }
 524     } else if (!(wc & FWW_DL_TYPE) && flow->dl_type == htons(ETH_TYPE_ARP)) {
 525         /* ARP. */
 526         if (!(wc & FWW_NW_PROTO)) {
 527             nxm_put_16(b, NXM_OF_ARP_OP, htons(flow->nw_proto));
 528         }
 529         nxm_put_32m(b, NXM_OF_ARP_SPA, flow->nw_src, cr->wc.nw_src_mask);
 530         nxm_put_32m(b, NXM_OF_ARP_TPA, flow->nw_dst, cr->wc.nw_dst_mask);
 531         if (!(wc & FWW_ARP_SHA)) {
 532             nxm_put_eth(b, NXM_NX_ARP_SHA, flow->arp_sha);
 533         }
 534         if (!(wc & FWW_ARP_THA)) {
 535             nxm_put_eth(b, NXM_NX_ARP_THA, flow->arp_tha);
 536         }
 537     }
 538
 539     /* Tunnel ID. */
 540     nxm_put_64m(b, NXM_NX_TUN_ID, flow->tun_id, cr->wc.tun_id_mask);
 541
 542     /* Registers. */
 543     for (i = 0; i < FLOW_N_REGS; i++) {
 544         nxm_put_32m(b, NXM_NX_REG(i),
 545                     htonl(flow->regs[i]), htonl(cr->wc.reg_masks[i]));
 546     }
 547
 548     /* Cookie. */
 549     nxm_put_64m(b, NXM_NX_COOKIE, cookie, cookie_mask);
 550
 551     match_len = b->size - start_len;
 552     ofpbuf_put_zeros(b, ROUND_UP(match_len, 8) - match_len);
 553     return match_len;
 554 }
 555 \f
 556 /* nx_match_to_string() and helpers. */
 557
 558 static void format_nxm_field_name(struct ds *, uint32_t header);
 559
 560 char *
 561 nx_match_to_string(const uint8_t *p, unsigned int match_len)
 562 {
 563     uint32_t header;
 564     struct ds s;
 565
 566     if (!match_len) {
 567         return xstrdup("<any>");
 568     }
 569
 570     ds_init(&s);
 571     while ((header = nx_entry_ok(p, match_len)) != 0) {
 572         unsigned int length = NXM_LENGTH(header);
 573         unsigned int value_len = nxm_field_bytes(header);
 574         const uint8_t *value = p + 4;
 575         const uint8_t *mask = value + value_len;
 576         unsigned int i;
 577
 578         if (s.length) {
 579             ds_put_cstr(&s, ", ");
 580         }
 581
 582         format_nxm_field_name(&s, header);
 583         ds_put_char(&s, '(');
 584
 585         for (i = 0; i < value_len; i++) {
 586             ds_put_format(&s, "%02x", value[i]);
 587         }
 588         if (NXM_HASMASK(header)) {
 589             ds_put_char(&s, '/');
 590             for (i = 0; i < value_len; i++) {
 591                 ds_put_format(&s, "%02x", mask[i]);
 592             }
 593         }
 594         ds_put_char(&s, ')');
 595
 596         p += 4 + length;
 597         match_len -= 4 + length;
 598     }
 599
 600     if (match_len) {
 601         if (s.length) {
 602             ds_put_cstr(&s, ", ");
 603         }
 604
 605         ds_put_format(&s, "<%u invalid bytes>", match_len);
 606     }
 607
 608     return ds_steal_cstr(&s);
 609 }
 610
 611 static void
 612 format_nxm_field_name(struct ds *s, uint32_t header)
 613 {
 614     const struct mf_field *mf = mf_from_nxm_header(header);
 615     if (mf) {
 616         ds_put_cstr(s, mf->nxm_name);
 617         if (NXM_HASMASK(header)) {
 618             ds_put_cstr(s, "_W");
 619         }
 620     } else if (header == NXM_NX_COOKIE) {
 621         ds_put_cstr(s, "NXM_NX_COOKIE");
 622     } else if (header == NXM_NX_COOKIE_W) {
 623         ds_put_cstr(s, "NXM_NX_COOKIE_W");
 624     } else {
 625         ds_put_format(s, "%d:%d", NXM_VENDOR(header), NXM_FIELD(header));
 626     }
 627 }
 628
 629 static uint32_t
 630 parse_nxm_field_name(const char *name, int name_len)
 631 {
 632     bool wild;
 633     int i;
 634
 635     /* Check whether it's a field name. */
 636     wild = name_len > 2 && !memcmp(&name[name_len - 2], "_W", 2);
 637     if (wild) {
 638         name_len -= 2;
 639     }
 640
 641     for (i = 0; i < MFF_N_IDS; i++) {
 642         const struct mf_field *mf = mf_from_id(i);
 643
 644         if (mf->nxm_name
 645             && !strncmp(mf->nxm_name, name, name_len)
 646             && mf->nxm_name[name_len] == '\0') {
 647             if (!wild) {
 648                 return mf->nxm_header;
 649             } else if (mf->maskable != MFM_NONE) {
 650                 return NXM_MAKE_WILD_HEADER(mf->nxm_header);
 651             }
 652         }
 653     }
 654
 655     if (!strncmp("NXM_NX_COOKIE", name, name_len)
 656                 && (name_len == strlen("NXM_NX_COOKIE"))) {
 657         if (!wild) {
 658             return NXM_NX_COOKIE;
 659         } else {
 660             return NXM_NX_COOKIE_W;
 661         }
 662     }
 663
 664     /* Check whether it's a 32-bit field header value as hex.
 665      * (This isn't ordinarily useful except for testing error behavior.) */
 666     if (name_len == 8) {
 667         uint32_t header = hexits_value(name, name_len, NULL);
 668         if (header != UINT_MAX) {
 669             return header;
 670         }
 671     }
 672
 673     return 0;
 674 }
 675 \f
 676 /* nx_match_from_string(). */
 677
 678 int
 679 nx_match_from_string(const char *s, struct ofpbuf *b)
 680 {
 681     const char *full_s = s;
 682     const size_t start_len = b->size;
 683     int match_len;
 684
 685     if (!strcmp(s, "<any>")) {
 686         /* Ensure that 'b->data' isn't actually null. */
 687         ofpbuf_prealloc_tailroom(b, 1);
 688         return 0;
 689     }
 690
 691     for (s += strspn(s, ", "); *s; s += strspn(s, ", ")) {
 692         const char *name;
 693         uint32_t header;
 694         int name_len;
 695         size_t n;
 696
 697         name = s;
 698         name_len = strcspn(s, "(");
 699         if (s[name_len] != '(') {
 700             ovs_fatal(0, "%s: missing ( at end of nx_match", full_s);
 701         }
 702
 703         header = parse_nxm_field_name(name, name_len);
 704         if (!header) {
 705             ovs_fatal(0, "%s: unknown field `%.*s'", full_s, name_len, s);
 706         }
 707
 708         s += name_len + 1;
 709
 710         nxm_put_header(b, header);
 711         s = ofpbuf_put_hex(b, s, &n);
 712         if (n != nxm_field_bytes(header)) {
 713             ovs_fatal(0, "%.2s: hex digits expected", s);
 714         }
 715         if (NXM_HASMASK(header)) {
 716             s += strspn(s, " ");
 717             if (*s != '/') {
 718                 ovs_fatal(0, "%s: missing / in masked field %.*s",
 719                           full_s, name_len, name);
 720             }
 721             s = ofpbuf_put_hex(b, s + 1, &n);
 722             if (n != nxm_field_bytes(header)) {
 723                 ovs_fatal(0, "%.2s: hex digits expected", s);
 724             }
 725         }
 726
 727         s += strspn(s, " ");
 728         if (*s != ')') {
 729             ovs_fatal(0, "%s: missing ) following field %.*s",
 730                       full_s, name_len, name);
 731         }
 732         s++;
 733     }
 734
 735     match_len = b->size - start_len;
 736     ofpbuf_put_zeros(b, ROUND_UP(match_len, 8) - match_len);
 737     return match_len;
 738 }
 739 \f
 740 void
 741 nxm_parse_reg_move(struct nx_action_reg_move *move, const char *s)
 742 {
 743     const char *full_s = s;
 744     struct mf_subfield src, dst;
 745
 746     s = mf_parse_subfield(&src, s);
 747     if (strncmp(s, "->", 2)) {
 748         ovs_fatal(0, "%s: missing `->' following source", full_s);
 749     }
 750     s += 2;
 751     s = mf_parse_subfield(&dst, s);
 752     if (*s != '\0') {
 753         ovs_fatal(0, "%s: trailing garbage following destination", full_s);
 754     }
 755
 756     if (src.n_bits != dst.n_bits) {
 757         ovs_fatal(0, "%s: source field is %d bits wide but destination is "
 758                   "%d bits wide", full_s, src.n_bits, dst.n_bits);
 759     }
 760
 761     ofputil_init_NXAST_REG_MOVE(move);
 762     move->n_bits = htons(src.n_bits);
 763     move->src_ofs = htons(src.ofs);
 764     move->dst_ofs = htons(dst.ofs);
 765     move->src = htonl(src.field->nxm_header);
 766     move->dst = htonl(dst.field->nxm_header);
 767 }
 768
 769 void
 770 nxm_parse_reg_load(struct nx_action_reg_load *load, const char *s)
 771 {
 772     const char *full_s = s;
 773     struct mf_subfield dst;
 774     uint64_t value;
 775
 776     value = strtoull(s, (char **) &s, 0);
 777     if (strncmp(s, "->", 2)) {
 778         ovs_fatal(0, "%s: missing `->' following value", full_s);
 779     }
 780     s += 2;
 781     s = mf_parse_subfield(&dst, s);
 782     if (*s != '\0') {
 783         ovs_fatal(0, "%s: trailing garbage following destination", full_s);
 784     }
 785
 786     if (dst.n_bits < 64 && (value >> dst.n_bits) != 0) {
 787         ovs_fatal(0, "%s: value %"PRIu64" does not fit into %u bits",
 788                   full_s, value, dst.n_bits);
 789     }
 790
 791     ofputil_init_NXAST_REG_LOAD(load);
 792     load->ofs_nbits = nxm_encode_ofs_nbits(dst.ofs, dst.n_bits);
 793     load->dst = htonl(dst.field->nxm_header);
 794     load->value = htonll(value);
 795 }
 796 \f
 797 /* nxm_format_reg_move(), nxm_format_reg_load(). */
 798
 799 void
 800 nxm_format_reg_move(const struct nx_action_reg_move *move, struct ds *s)
 801 {
 802     struct mf_subfield src, dst;
 803
 804     nxm_decode_discrete(&src, move->src, move->src_ofs, move->n_bits);
 805     nxm_decode_discrete(&dst, move->dst, move->dst_ofs, move->n_bits);
 806
 807     ds_put_format(s, "move:");
 808     mf_format_subfield(&src, s);
 809     ds_put_cstr(s, "->");
 810     mf_format_subfield(&dst, s);
 811 }
 812
 813 void
 814 nxm_format_reg_load(const struct nx_action_reg_load *load, struct ds *s)
 815 {
 816     struct mf_subfield dst;
 817
 818     ds_put_format(s, "load:%#"PRIx64"->", ntohll(load->value));
 819
 820     nxm_decode(&dst, load->dst, load->ofs_nbits);
 821     mf_format_subfield(&dst, s);
 822 }
 823 \f
 824 /* nxm_check_reg_move(), nxm_check_reg_load(). */
 825
 826 enum ofperr
 827 nxm_check_reg_move(const struct nx_action_reg_move *action,
 828                    const struct flow *flow)
 829 {
 830     struct mf_subfield src;
 831     struct mf_subfield dst;
 832     int error;
 833
 834     nxm_decode_discrete(&src, action->src, action->src_ofs, action->n_bits);
 835     error = mf_check_src(&src, flow);
 836     if (error) {
 837         return error;
 838     }
 839
 840     nxm_decode_discrete(&dst, action->dst, action->dst_ofs, action->n_bits);
 841     return mf_check_dst(&dst, flow);
 842 }
 843
 844 enum ofperr
 845 nxm_check_reg_load(const struct nx_action_reg_load *action,
 846                    const struct flow *flow)
 847 {
 848     struct mf_subfield dst;
 849     enum ofperr error;
 850
 851     nxm_decode(&dst, action->dst, action->ofs_nbits);
 852     error = mf_check_dst(&dst, flow);
 853     if (error) {
 854         return error;
 855     }
 856
 857     /* Reject 'action' if a bit numbered 'n_bits' or higher is set to 1 in
 858      * action->value. */
 859     if (dst.n_bits < 64 && ntohll(action->value) >> dst.n_bits) {
 860         return OFPERR_OFPBAC_BAD_ARGUMENT;
 861     }
 862
 863     return 0;
 864 }
 865 \f
 866 /* nxm_execute_reg_move(), nxm_execute_reg_load(). */
 867
 868 void
 869 nxm_execute_reg_move(const struct nx_action_reg_move *action,
 870                      struct flow *flow)
 871 {
 872     struct mf_subfield src, dst;
 873     union mf_value src_value;
 874     union mf_value dst_value;
 875
 876     nxm_decode_discrete(&src, action->src, action->src_ofs, action->n_bits);
 877     nxm_decode_discrete(&dst, action->dst, action->dst_ofs, action->n_bits);
 878
 879     mf_get_value(dst.field, flow, &dst_value);
 880     mf_get_value(src.field, flow, &src_value);
 881     bitwise_copy(&src_value, src.field->n_bytes, src.ofs,
 882                  &dst_value, dst.field->n_bytes, dst.ofs,
 883                  src.n_bits);
 884     mf_set_flow_value(dst.field, &dst_value, flow);
 885 }
 886
 887 void
 888 nxm_execute_reg_load(const struct nx_action_reg_load *action,
 889                      struct flow *flow)
 890 {
 891     struct mf_subfield dst;
 892
 893     nxm_decode(&dst, action->dst, action->ofs_nbits);
 894     mf_set_subfield_value(&dst, ntohll(action->value), flow);
 895 }
 896
 897 /* Initializes 'sf->field' with the field corresponding to the given NXM
 898  * 'header' and 'sf->ofs' and 'sf->n_bits' decoded from 'ofs_nbits' with
 899  * nxm_decode_ofs() and nxm_decode_n_bits(), respectively.
 900  *
 901  * Afterward, 'sf' might be invalid in a few different ways:
 902  *
 903  *   - 'sf->field' will be NULL if 'header' is unknown.
 904  *
 905  *   - 'sf->ofs' and 'sf->n_bits' might exceed the width of sf->field.
 906  *
 907  * The caller should call mf_check_src() or mf_check_dst() to check for these
 908  * problems. */
 909 void
 910 nxm_decode(struct mf_subfield *sf, ovs_be32 header, ovs_be16 ofs_nbits)
 911 {
 912     sf->field = mf_from_nxm_header(ntohl(header));
 913     sf->ofs = nxm_decode_ofs(ofs_nbits);
 914     sf->n_bits = nxm_decode_n_bits(ofs_nbits);
 915 }
 916
 917 /* Initializes 'sf->field' with the field corresponding to the given NXM
 918  * 'header' and 'sf->ofs' and 'sf->n_bits' from 'ofs' and 'n_bits',
 919  * respectively.
 920  *
 921  * Afterward, 'sf' might be invalid in a few different ways:
 922  *
 923  *   - 'sf->field' will be NULL if 'header' is unknown.
 924  *
 925  *   - 'sf->ofs' and 'sf->n_bits' might exceed the width of sf->field.
 926  *
 927  * The caller should call mf_check_src() or mf_check_dst() to check for these
 928  * problems. */
 929 void
 930 nxm_decode_discrete(struct mf_subfield *sf, ovs_be32 header,
 931                     ovs_be16 ofs, ovs_be16 n_bits)
 932 {
 933     sf->field = mf_from_nxm_header(ntohl(header));
 934     sf->ofs = ntohs(ofs);
 935     sf->n_bits = ntohs(n_bits);
 936 }