lib/nx-match.c

   1 /*
   2  * Copyright (c) 2010, 2011 Nicira Networks.
   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-util.h"
  27 #include "ofpbuf.h"
  28 #include "openflow/nicira-ext.h"
  29 #include "packets.h"
  30 #include "unaligned.h"
  31 #include "vlog.h"
  32
  33 VLOG_DEFINE_THIS_MODULE(nx_match);
  34
  35 /* Rate limit for nx_match parse errors.  These always indicate a bug in the
  36  * peer and so there's not much point in showing a lot of them. */
  37 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
  38
  39 enum {
  40     NXM_INVALID = OFP_MKERR_NICIRA(OFPET_BAD_REQUEST, NXBRC_NXM_INVALID),
  41     NXM_BAD_TYPE = OFP_MKERR_NICIRA(OFPET_BAD_REQUEST, NXBRC_NXM_BAD_TYPE),
  42     NXM_BAD_VALUE = OFP_MKERR_NICIRA(OFPET_BAD_REQUEST, NXBRC_NXM_BAD_VALUE),
  43     NXM_BAD_MASK = OFP_MKERR_NICIRA(OFPET_BAD_REQUEST, NXBRC_NXM_BAD_MASK),
  44     NXM_BAD_PREREQ = OFP_MKERR_NICIRA(OFPET_BAD_REQUEST, NXBRC_NXM_BAD_PREREQ),
  45     NXM_DUP_TYPE = OFP_MKERR_NICIRA(OFPET_BAD_REQUEST, NXBRC_NXM_DUP_TYPE),
  46     BAD_ARGUMENT = OFP_MKERR(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT)
  47 };
  48
  49 /* For each NXM_* field, define NFI_NXM_* as consecutive integers starting from
  50  * zero. */
  51 enum nxm_field_index {
  52 #define DEFINE_FIELD(HEADER, MFF_ID, WRITABLE)  \
  53         NFI_NXM_##HEADER,
  54 #include "nx-match.def"
  55     N_NXM_FIELDS
  56 };
  57
  58 struct nxm_field {
  59     struct hmap_node hmap_node;
  60     enum nxm_field_index index;       /* NFI_* value. */
  61     uint32_t header;                  /* NXM_* value. */
  62     enum mf_field_id mf_id;           /* MFF_* value. */
  63     const struct mf_field *mf;
  64     const char *name;                 /* "NXM_*" string. */
  65     bool writable;                    /* Writable with NXAST_REG_{MOVE,LOAD}? */
  66 };
  67
  68 /* All the known fields. */
  69 static struct nxm_field nxm_fields[N_NXM_FIELDS] = {
  70 #define DEFINE_FIELD(HEADER, MFF_ID, WRITABLE)                            \
  71     { HMAP_NODE_NULL_INITIALIZER, NFI_NXM_##HEADER, NXM_##HEADER, \
  72       MFF_ID, NULL, "NXM_" #HEADER, WRITABLE },
  73 #include "nx-match.def"
  74 };
  75
  76 /* Hash table of 'nxm_fields'. */
  77 static struct hmap all_nxm_fields = HMAP_INITIALIZER(&all_nxm_fields);
  78
  79 static void
  80 nxm_init(void)
  81 {
  82     if (hmap_is_empty(&all_nxm_fields)) {
  83         int i;
  84
  85         for (i = 0; i < N_NXM_FIELDS; i++) {
  86             struct nxm_field *f = &nxm_fields[i];
  87             hmap_insert(&all_nxm_fields, &f->hmap_node,
  88                         hash_int(f->header, 0));
  89             f->mf = mf_from_id(f->mf_id);
  90         }
  91
  92         /* Verify that the header values are unique (duplicate "case" values
  93          * cause a compile error). */
  94         switch (0) {
  95 #define DEFINE_FIELD(HEADER, MFF_ID, WRITABLE)  \
  96         case NXM_##HEADER: break;
  97 #include "nx-match.def"
  98         }
  99     }
 100 }
 101
 102 static const struct nxm_field *
 103 nxm_field_lookup(uint32_t header)
 104 {
 105     struct nxm_field *f;
 106
 107     nxm_init();
 108
 109     HMAP_FOR_EACH_WITH_HASH (f, hmap_node, hash_int(header, 0),
 110                              &all_nxm_fields) {
 111         if (f->header == header) {
 112             return f;
 113         }
 114     }
 115
 116     return NULL;
 117 }
 118
 119 /* Returns the width of the data for a field with the given 'header', in
 120  * bytes. */
 121 int
 122 nxm_field_bytes(uint32_t header)
 123 {
 124     unsigned int length = NXM_LENGTH(header);
 125     return NXM_HASMASK(header) ? length / 2 : length;
 126 }
 127
 128 /* Returns the width of the data for a field with the given 'header', in
 129  * bits. */
 130 int
 131 nxm_field_bits(uint32_t header)
 132 {
 133     return nxm_field_bytes(header) * 8;
 134 }
 135
 136 const struct mf_field *
 137 nxm_field_to_mf_field(uint32_t header)
 138 {
 139     const struct nxm_field *f = nxm_field_lookup(header);
 140     return f ? f->mf : NULL;
 141 }
 142 \f
 143 /* nx_pull_match() and helpers. */
 144
 145 static uint32_t
 146 nx_entry_ok(const void *p, unsigned int match_len)
 147 {
 148     unsigned int payload_len;
 149     ovs_be32 header_be;
 150     uint32_t header;
 151
 152     if (match_len < 4) {
 153         if (match_len) {
 154             VLOG_DBG_RL(&rl, "nx_match ends with partial nxm_header");
 155         }
 156         return 0;
 157     }
 158     memcpy(&header_be, p, 4);
 159     header = ntohl(header_be);
 160
 161     payload_len = NXM_LENGTH(header);
 162     if (!payload_len) {
 163         VLOG_DBG_RL(&rl, "nxm_entry %08"PRIx32" has invalid payload "
 164                     "length 0", header);
 165         return 0;
 166     }
 167     if (match_len < payload_len + 4) {
 168         VLOG_DBG_RL(&rl, "%"PRIu32"-byte nxm_entry but only "
 169                     "%u bytes left in nx_match", payload_len + 4, match_len);
 170         return 0;
 171     }
 172
 173     return header;
 174 }
 175
 176 int
 177 nx_pull_match(struct ofpbuf *b, unsigned int match_len, uint16_t priority,
 178               struct cls_rule *rule)
 179 {
 180     uint32_t header;
 181     uint8_t *p;
 182
 183     p = ofpbuf_try_pull(b, ROUND_UP(match_len, 8));
 184     if (!p) {
 185         VLOG_DBG_RL(&rl, "nx_match length %u, rounded up to a "
 186                     "multiple of 8, is longer than space in message (max "
 187                     "length %zu)", match_len, b->size);
 188         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
 189     }
 190
 191     cls_rule_init_catchall(rule, priority);
 192     while ((header = nx_entry_ok(p, match_len)) != 0) {
 193         unsigned length = NXM_LENGTH(header);
 194         const struct nxm_field *f;
 195         int error;
 196
 197         f = nxm_field_lookup(header);
 198         if (!f) {
 199             error = NXM_BAD_TYPE;
 200         } else if (!mf_are_prereqs_ok(f->mf, &rule->flow)) {
 201             error = NXM_BAD_PREREQ;
 202         } else if (!mf_is_all_wild(f->mf, &rule->wc)) {
 203             error = NXM_DUP_TYPE;
 204         } else {
 205             unsigned int width = f->mf->n_bytes;
 206             union mf_value value;
 207
 208             memcpy(&value, p + 4, width);
 209             if (!mf_is_value_valid(f->mf, &value)) {
 210                 error = NXM_BAD_VALUE;
 211             } else if (!NXM_HASMASK(header)) {
 212                 error = 0;
 213                 mf_set_value(f->mf, &value, rule);
 214             } else {
 215                 union mf_value mask;
 216
 217                 memcpy(&mask, p + 4 + width, width);
 218                 if (!mf_is_mask_valid(f->mf, &mask)) {
 219                     error = NXM_BAD_MASK;
 220                 } else {
 221                     error = 0;
 222                     mf_set(f->mf, &value, &mask, rule);
 223                 }
 224             }
 225         }
 226
 227         if (error) {
 228             char *msg = ofputil_error_to_string(error);
 229             VLOG_DBG_RL(&rl, "bad nxm_entry with vendor=%"PRIu32", "
 230                         "field=%"PRIu32", hasmask=%"PRIu32", type=%"PRIu32" "
 231                         "(%s)",
 232                         NXM_VENDOR(header), NXM_FIELD(header),
 233                         NXM_HASMASK(header), NXM_TYPE(header),
 234                         msg);
 235             free(msg);
 236
 237             return error;
 238         }
 239
 240         p += 4 + length;
 241         match_len -= 4 + length;
 242     }
 243
 244     return match_len ? NXM_INVALID : 0;
 245 }
 246 \f
 247 /* nx_put_match() and helpers.
 248  *
 249  * 'put' functions whose names end in 'w' add a wildcarded field.
 250  * 'put' functions whose names end in 'm' add a field that might be wildcarded.
 251  * Other 'put' functions add exact-match fields.
 252  */
 253
 254 static void
 255 nxm_put_header(struct ofpbuf *b, uint32_t header)
 256 {
 257     ovs_be32 n_header = htonl(header);
 258     ofpbuf_put(b, &n_header, sizeof n_header);
 259 }
 260
 261 static void
 262 nxm_put_8(struct ofpbuf *b, uint32_t header, uint8_t value)
 263 {
 264     nxm_put_header(b, header);
 265     ofpbuf_put(b, &value, sizeof value);
 266 }
 267
 268 static void
 269 nxm_put_8m(struct ofpbuf *b, uint32_t header, uint8_t value, uint8_t mask)
 270 {
 271     switch (mask) {
 272     case 0:
 273         break;
 274
 275     case UINT8_MAX:
 276         nxm_put_8(b, header, value);
 277         break;
 278
 279     default:
 280         nxm_put_header(b, NXM_MAKE_WILD_HEADER(header));
 281         ofpbuf_put(b, &value, sizeof value);
 282         ofpbuf_put(b, &mask, sizeof mask);
 283     }
 284 }
 285
 286 static void
 287 nxm_put_16(struct ofpbuf *b, uint32_t header, ovs_be16 value)
 288 {
 289     nxm_put_header(b, header);
 290     ofpbuf_put(b, &value, sizeof value);
 291 }
 292
 293 static void
 294 nxm_put_16w(struct ofpbuf *b, uint32_t header, ovs_be16 value, ovs_be16 mask)
 295 {
 296     nxm_put_header(b, header);
 297     ofpbuf_put(b, &value, sizeof value);
 298     ofpbuf_put(b, &mask, sizeof mask);
 299 }
 300
 301 static void
 302 nxm_put_16m(struct ofpbuf *b, uint32_t header, ovs_be16 value, ovs_be16 mask)
 303 {
 304     switch (mask) {
 305     case 0:
 306         break;
 307
 308     case CONSTANT_HTONS(UINT16_MAX):
 309         nxm_put_16(b, header, value);
 310         break;
 311
 312     default:
 313         nxm_put_16w(b, NXM_MAKE_WILD_HEADER(header), value, mask);
 314         break;
 315     }
 316 }
 317
 318 static void
 319 nxm_put_32(struct ofpbuf *b, uint32_t header, ovs_be32 value)
 320 {
 321     nxm_put_header(b, header);
 322     ofpbuf_put(b, &value, sizeof value);
 323 }
 324
 325 static void
 326 nxm_put_32w(struct ofpbuf *b, uint32_t header, ovs_be32 value, ovs_be32 mask)
 327 {
 328     nxm_put_header(b, header);
 329     ofpbuf_put(b, &value, sizeof value);
 330     ofpbuf_put(b, &mask, sizeof mask);
 331 }
 332
 333 static void
 334 nxm_put_32m(struct ofpbuf *b, uint32_t header, ovs_be32 value, ovs_be32 mask)
 335 {
 336     switch (mask) {
 337     case 0:
 338         break;
 339
 340     case CONSTANT_HTONL(UINT32_MAX):
 341         nxm_put_32(b, header, value);
 342         break;
 343
 344     default:
 345         nxm_put_32w(b, NXM_MAKE_WILD_HEADER(header), value, mask);
 346         break;
 347     }
 348 }
 349
 350 static void
 351 nxm_put_64(struct ofpbuf *b, uint32_t header, ovs_be64 value)
 352 {
 353     nxm_put_header(b, header);
 354     ofpbuf_put(b, &value, sizeof value);
 355 }
 356
 357 static void
 358 nxm_put_64w(struct ofpbuf *b, uint32_t header, ovs_be64 value, ovs_be64 mask)
 359 {
 360     nxm_put_header(b, header);
 361     ofpbuf_put(b, &value, sizeof value);
 362     ofpbuf_put(b, &mask, sizeof mask);
 363 }
 364
 365 static void
 366 nxm_put_64m(struct ofpbuf *b, uint32_t header, ovs_be64 value, ovs_be64 mask)
 367 {
 368     switch (mask) {
 369     case 0:
 370         break;
 371
 372     case CONSTANT_HTONLL(UINT64_MAX):
 373         nxm_put_64(b, header, value);
 374         break;
 375
 376     default:
 377         nxm_put_64w(b, NXM_MAKE_WILD_HEADER(header), value, mask);
 378         break;
 379     }
 380 }
 381
 382 static void
 383 nxm_put_eth(struct ofpbuf *b, uint32_t header,
 384             const uint8_t value[ETH_ADDR_LEN])
 385 {
 386     nxm_put_header(b, header);
 387     ofpbuf_put(b, value, ETH_ADDR_LEN);
 388 }
 389
 390 static void
 391 nxm_put_eth_dst(struct ofpbuf *b,
 392                 flow_wildcards_t wc, const uint8_t value[ETH_ADDR_LEN])
 393 {
 394     switch (wc & (FWW_DL_DST | FWW_ETH_MCAST)) {
 395     case FWW_DL_DST | FWW_ETH_MCAST:
 396         break;
 397     default:
 398         nxm_put_header(b, NXM_OF_ETH_DST_W);
 399         ofpbuf_put(b, value, ETH_ADDR_LEN);
 400         ofpbuf_put(b, flow_wildcards_to_dl_dst_mask(wc), ETH_ADDR_LEN);
 401         break;
 402     case 0:
 403         nxm_put_eth(b, NXM_OF_ETH_DST, value);
 404         break;
 405     }
 406 }
 407
 408 static void
 409 nxm_put_ipv6(struct ofpbuf *b, uint32_t header,
 410              const struct in6_addr *value, const struct in6_addr *mask)
 411 {
 412     if (ipv6_mask_is_any(mask)) {
 413         return;
 414     } else if (ipv6_mask_is_exact(mask)) {
 415         nxm_put_header(b, header);
 416         ofpbuf_put(b, value, sizeof *value);
 417     } else {
 418         nxm_put_header(b, NXM_MAKE_WILD_HEADER(header));
 419         ofpbuf_put(b, value, sizeof *value);
 420         ofpbuf_put(b, mask, sizeof *mask);
 421     }
 422 }
 423
 424 static void
 425 nxm_put_frag(struct ofpbuf *b, const struct cls_rule *cr)
 426 {
 427     uint8_t frag = cr->flow.frag;
 428     uint8_t frag_mask = cr->wc.frag_mask;
 429
 430     switch (frag_mask) {
 431     case 0:
 432         break;
 433
 434     case FLOW_FRAG_MASK:
 435         nxm_put_8(b, NXM_NX_IP_FRAG, frag);
 436         break;
 437
 438     default:
 439         nxm_put_8m(b, NXM_NX_IP_FRAG, frag, frag_mask & FLOW_FRAG_MASK);
 440         break;
 441     }
 442 }
 443
 444 /* Appends to 'b' the nx_match format that expresses 'cr' (except for
 445  * 'cr->priority', because priority is not part of nx_match), plus enough
 446  * zero bytes to pad the nx_match out to a multiple of 8.
 447  *
 448  * This function can cause 'b''s data to be reallocated.
 449  *
 450  * Returns the number of bytes appended to 'b', excluding padding.
 451  *
 452  * If 'cr' is a catch-all rule that matches every packet, then this function
 453  * appends nothing to 'b' and returns 0. */
 454 int
 455 nx_put_match(struct ofpbuf *b, const struct cls_rule *cr)
 456 {
 457     const flow_wildcards_t wc = cr->wc.wildcards;
 458     const struct flow *flow = &cr->flow;
 459     const size_t start_len = b->size;
 460     int match_len;
 461     int i;
 462
 463     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 6);
 464
 465     /* Metadata. */
 466     if (!(wc & FWW_IN_PORT)) {
 467         uint16_t in_port = flow->in_port;
 468         nxm_put_16(b, NXM_OF_IN_PORT, htons(in_port));
 469     }
 470
 471     /* Ethernet. */
 472     nxm_put_eth_dst(b, wc, flow->dl_dst);
 473     if (!(wc & FWW_DL_SRC)) {
 474         nxm_put_eth(b, NXM_OF_ETH_SRC, flow->dl_src);
 475     }
 476     if (!(wc & FWW_DL_TYPE)) {
 477         nxm_put_16(b, NXM_OF_ETH_TYPE,
 478                    ofputil_dl_type_to_openflow(flow->dl_type));
 479     }
 480
 481     /* 802.1Q. */
 482     nxm_put_16m(b, NXM_OF_VLAN_TCI, flow->vlan_tci, cr->wc.vlan_tci_mask);
 483
 484     /* L3. */
 485     if (!(wc & FWW_DL_TYPE) && flow->dl_type == htons(ETH_TYPE_IP)) {
 486         /* IP. */
 487         nxm_put_32m(b, NXM_OF_IP_SRC, flow->nw_src, cr->wc.nw_src_mask);
 488         nxm_put_32m(b, NXM_OF_IP_DST, flow->nw_dst, cr->wc.nw_dst_mask);
 489         nxm_put_frag(b, cr);
 490
 491         if (cr->wc.tos_mask & IP_DSCP_MASK) {
 492             nxm_put_8(b, NXM_OF_IP_TOS, flow->tos & IP_DSCP_MASK);
 493         }
 494
 495         if (cr->wc.tos_mask & IP_ECN_MASK) {
 496             nxm_put_8(b, NXM_NX_IP_ECN, flow->tos & IP_ECN_MASK);
 497         }
 498
 499         if (!(wc & FWW_NW_TTL)) {
 500             nxm_put_8(b, NXM_NX_IP_TTL, flow->nw_ttl);
 501         }
 502
 503         if (!(wc & FWW_NW_PROTO)) {
 504             nxm_put_8(b, NXM_OF_IP_PROTO, flow->nw_proto);
 505             switch (flow->nw_proto) {
 506                 /* TCP. */
 507             case IPPROTO_TCP:
 508                 if (!(wc & FWW_TP_SRC)) {
 509                     nxm_put_16(b, NXM_OF_TCP_SRC, flow->tp_src);
 510                 }
 511                 if (!(wc & FWW_TP_DST)) {
 512                     nxm_put_16(b, NXM_OF_TCP_DST, flow->tp_dst);
 513                 }
 514                 break;
 515
 516                 /* UDP. */
 517             case IPPROTO_UDP:
 518                 if (!(wc & FWW_TP_SRC)) {
 519                     nxm_put_16(b, NXM_OF_UDP_SRC, flow->tp_src);
 520                 }
 521                 if (!(wc & FWW_TP_DST)) {
 522                     nxm_put_16(b, NXM_OF_UDP_DST, flow->tp_dst);
 523                 }
 524                 break;
 525
 526                 /* ICMP. */
 527             case IPPROTO_ICMP:
 528                 if (!(wc & FWW_TP_SRC)) {
 529                     nxm_put_8(b, NXM_OF_ICMP_TYPE, ntohs(flow->tp_src));
 530                 }
 531                 if (!(wc & FWW_TP_DST)) {
 532                     nxm_put_8(b, NXM_OF_ICMP_CODE, ntohs(flow->tp_dst));
 533                 }
 534                 break;
 535             }
 536         }
 537     } else if (!(wc & FWW_DL_TYPE) && flow->dl_type == htons(ETH_TYPE_IPV6)) {
 538         /* IPv6. */
 539         nxm_put_ipv6(b, NXM_NX_IPV6_SRC, &flow->ipv6_src,
 540                 &cr->wc.ipv6_src_mask);
 541         nxm_put_ipv6(b, NXM_NX_IPV6_DST, &flow->ipv6_dst,
 542                 &cr->wc.ipv6_dst_mask);
 543         nxm_put_frag(b, cr);
 544
 545         if (!(wc & FWW_IPV6_LABEL)) {
 546             nxm_put_32(b, NXM_NX_IPV6_LABEL, flow->ipv6_label);
 547         }
 548
 549         if (cr->wc.tos_mask & IP_DSCP_MASK) {
 550             nxm_put_8(b, NXM_OF_IP_TOS, flow->tos & IP_DSCP_MASK);
 551         }
 552
 553         if (cr->wc.tos_mask & IP_ECN_MASK) {
 554             nxm_put_8(b, NXM_NX_IP_ECN, flow->tos & IP_ECN_MASK);
 555         }
 556
 557         if (!(wc & FWW_NW_TTL)) {
 558             nxm_put_8(b, NXM_NX_IP_TTL, flow->nw_ttl);
 559         }
 560
 561         if (!(wc & FWW_NW_PROTO)) {
 562             nxm_put_8(b, NXM_OF_IP_PROTO, flow->nw_proto);
 563             switch (flow->nw_proto) {
 564                 /* TCP. */
 565             case IPPROTO_TCP:
 566                 if (!(wc & FWW_TP_SRC)) {
 567                     nxm_put_16(b, NXM_OF_TCP_SRC, flow->tp_src);
 568                 }
 569                 if (!(wc & FWW_TP_DST)) {
 570                     nxm_put_16(b, NXM_OF_TCP_DST, flow->tp_dst);
 571                 }
 572                 break;
 573
 574                 /* UDP. */
 575             case IPPROTO_UDP:
 576                 if (!(wc & FWW_TP_SRC)) {
 577                     nxm_put_16(b, NXM_OF_UDP_SRC, flow->tp_src);
 578                 }
 579                 if (!(wc & FWW_TP_DST)) {
 580                     nxm_put_16(b, NXM_OF_UDP_DST, flow->tp_dst);
 581                 }
 582                 break;
 583
 584                 /* ICMPv6. */
 585             case IPPROTO_ICMPV6:
 586                 if (!(wc & FWW_TP_SRC)) {
 587                     nxm_put_8(b, NXM_NX_ICMPV6_TYPE, ntohs(flow->tp_src));
 588
 589                     if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
 590                         flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
 591                         if (!(wc & FWW_ND_TARGET)) {
 592                             nxm_put_ipv6(b, NXM_NX_ND_TARGET, &flow->nd_target,
 593                                          &in6addr_exact);
 594                         }
 595                         if (!(wc & FWW_ARP_SHA)
 596                             && flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
 597                             nxm_put_eth(b, NXM_NX_ND_SLL, flow->arp_sha);
 598                         }
 599                         if (!(wc & FWW_ARP_THA)
 600                             && flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
 601                             nxm_put_eth(b, NXM_NX_ND_TLL, flow->arp_tha);
 602                         }
 603                     }
 604                 }
 605                 if (!(wc & FWW_TP_DST)) {
 606                     nxm_put_8(b, NXM_NX_ICMPV6_CODE, ntohs(flow->tp_dst));
 607                 }
 608                 break;
 609             }
 610         }
 611     } else if (!(wc & FWW_DL_TYPE) && flow->dl_type == htons(ETH_TYPE_ARP)) {
 612         /* ARP. */
 613         if (!(wc & FWW_NW_PROTO)) {
 614             nxm_put_16(b, NXM_OF_ARP_OP, htons(flow->nw_proto));
 615         }
 616         nxm_put_32m(b, NXM_OF_ARP_SPA, flow->nw_src, cr->wc.nw_src_mask);
 617         nxm_put_32m(b, NXM_OF_ARP_TPA, flow->nw_dst, cr->wc.nw_dst_mask);
 618         if (!(wc & FWW_ARP_SHA)) {
 619             nxm_put_eth(b, NXM_NX_ARP_SHA, flow->arp_sha);
 620         }
 621         if (!(wc & FWW_ARP_THA)) {
 622             nxm_put_eth(b, NXM_NX_ARP_THA, flow->arp_tha);
 623         }
 624     }
 625
 626     /* Tunnel ID. */
 627     nxm_put_64m(b, NXM_NX_TUN_ID, flow->tun_id, cr->wc.tun_id_mask);
 628
 629     /* Registers. */
 630     for (i = 0; i < FLOW_N_REGS; i++) {
 631         nxm_put_32m(b, NXM_NX_REG(i),
 632                     htonl(flow->regs[i]), htonl(cr->wc.reg_masks[i]));
 633     }
 634
 635     match_len = b->size - start_len;
 636     ofpbuf_put_zeros(b, ROUND_UP(match_len, 8) - match_len);
 637     return match_len;
 638 }
 639 \f
 640 /* nx_match_to_string() and helpers. */
 641
 642 static void format_nxm_field_name(struct ds *, uint32_t header);
 643
 644 char *
 645 nx_match_to_string(const uint8_t *p, unsigned int match_len)
 646 {
 647     uint32_t header;
 648     struct ds s;
 649
 650     if (!match_len) {
 651         return xstrdup("<any>");
 652     }
 653
 654     ds_init(&s);
 655     while ((header = nx_entry_ok(p, match_len)) != 0) {
 656         unsigned int length = NXM_LENGTH(header);
 657         unsigned int value_len = nxm_field_bytes(header);
 658         const uint8_t *value = p + 4;
 659         const uint8_t *mask = value + value_len;
 660         unsigned int i;
 661
 662         if (s.length) {
 663             ds_put_cstr(&s, ", ");
 664         }
 665
 666         format_nxm_field_name(&s, header);
 667         ds_put_char(&s, '(');
 668
 669         for (i = 0; i < value_len; i++) {
 670             ds_put_format(&s, "%02x", value[i]);
 671         }
 672         if (NXM_HASMASK(header)) {
 673             ds_put_char(&s, '/');
 674             for (i = 0; i < value_len; i++) {
 675                 ds_put_format(&s, "%02x", mask[i]);
 676             }
 677         }
 678         ds_put_char(&s, ')');
 679
 680         p += 4 + length;
 681         match_len -= 4 + length;
 682     }
 683
 684     if (match_len) {
 685         if (s.length) {
 686             ds_put_cstr(&s, ", ");
 687         }
 688
 689         ds_put_format(&s, "<%u invalid bytes>", match_len);
 690     }
 691
 692     return ds_steal_cstr(&s);
 693 }
 694
 695 static void
 696 format_nxm_field_name(struct ds *s, uint32_t header)
 697 {
 698     const struct nxm_field *f = nxm_field_lookup(header);
 699     if (f) {
 700         ds_put_cstr(s, f->name);
 701     } else {
 702         ds_put_format(s, "%d:%d", NXM_VENDOR(header), NXM_FIELD(header));
 703     }
 704 }
 705
 706 static uint32_t
 707 parse_nxm_field_name(const char *name, int name_len)
 708 {
 709     const struct nxm_field *f;
 710
 711     /* Check whether it's a field name. */
 712     for (f = nxm_fields; f < &nxm_fields[ARRAY_SIZE(nxm_fields)]; f++) {
 713         if (!strncmp(f->name, name, name_len) && f->name[name_len] == '\0') {
 714             return f->header;
 715         }
 716     }
 717
 718     /* Check whether it's a 32-bit field header value as hex.
 719      * (This isn't ordinarily useful except for testing error behavior.) */
 720     if (name_len == 8) {
 721         uint32_t header = hexits_value(name, name_len, NULL);
 722         if (header != UINT_MAX) {
 723             return header;
 724         }
 725     }
 726
 727     return 0;
 728 }
 729 \f
 730 /* nx_match_from_string(). */
 731
 732 int
 733 nx_match_from_string(const char *s, struct ofpbuf *b)
 734 {
 735     const char *full_s = s;
 736     const size_t start_len = b->size;
 737     int match_len;
 738
 739     if (!strcmp(s, "<any>")) {
 740         /* Ensure that 'b->data' isn't actually null. */
 741         ofpbuf_prealloc_tailroom(b, 1);
 742         return 0;
 743     }
 744
 745     for (s += strspn(s, ", "); *s; s += strspn(s, ", ")) {
 746         const char *name;
 747         uint32_t header;
 748         int name_len;
 749         size_t n;
 750
 751         name = s;
 752         name_len = strcspn(s, "(");
 753         if (s[name_len] != '(') {
 754             ovs_fatal(0, "%s: missing ( at end of nx_match", full_s);
 755         }
 756
 757         header = parse_nxm_field_name(name, name_len);
 758         if (!header) {
 759             ovs_fatal(0, "%s: unknown field `%.*s'", full_s, name_len, s);
 760         }
 761
 762         s += name_len + 1;
 763
 764         nxm_put_header(b, header);
 765         s = ofpbuf_put_hex(b, s, &n);
 766         if (n != nxm_field_bytes(header)) {
 767             ovs_fatal(0, "%.2s: hex digits expected", s);
 768         }
 769         if (NXM_HASMASK(header)) {
 770             s += strspn(s, " ");
 771             if (*s != '/') {
 772                 ovs_fatal(0, "%s: missing / in masked field %.*s",
 773                           full_s, name_len, name);
 774             }
 775             s = ofpbuf_put_hex(b, s + 1, &n);
 776             if (n != nxm_field_bytes(header)) {
 777                 ovs_fatal(0, "%.2s: hex digits expected", s);
 778             }
 779         }
 780
 781         s += strspn(s, " ");
 782         if (*s != ')') {
 783             ovs_fatal(0, "%s: missing ) following field %.*s",
 784                       full_s, name_len, name);
 785         }
 786         s++;
 787     }
 788
 789     match_len = b->size - start_len;
 790     ofpbuf_put_zeros(b, ROUND_UP(match_len, 8) - match_len);
 791     return match_len;
 792 }
 793 \f
 794 const char *
 795 nxm_parse_field_bits(const char *s, uint32_t *headerp, int *ofsp, int *n_bitsp)
 796 {
 797     const char *full_s = s;
 798     const char *name;
 799     uint32_t header;
 800     int start, end;
 801     int name_len;
 802     int width;
 803
 804     name = s;
 805     name_len = strcspn(s, "[");
 806     if (s[name_len] != '[') {
 807         ovs_fatal(0, "%s: missing [ looking for field name", full_s);
 808     }
 809
 810     header = parse_nxm_field_name(name, name_len);
 811     if (!header) {
 812         ovs_fatal(0, "%s: unknown field `%.*s'", full_s, name_len, s);
 813     }
 814     width = nxm_field_bits(header);
 815
 816     s += name_len;
 817     if (sscanf(s, "[%d..%d]", &start, &end) == 2) {
 818         /* Nothing to do. */
 819     } else if (sscanf(s, "[%d]", &start) == 1) {
 820         end = start;
 821     } else if (!strncmp(s, "[]", 2)) {
 822         start = 0;
 823         end = width - 1;
 824     } else {
 825         ovs_fatal(0, "%s: syntax error expecting [] or [<bit>] or "
 826                   "[<start>..<end>]", full_s);
 827     }
 828     s = strchr(s, ']') + 1;
 829
 830     if (start > end) {
 831         ovs_fatal(0, "%s: starting bit %d is after ending bit %d",
 832                   full_s, start, end);
 833     } else if (start >= width) {
 834         ovs_fatal(0, "%s: starting bit %d is not valid because field is only "
 835                   "%d bits wide", full_s, start, width);
 836     } else if (end >= width){
 837         ovs_fatal(0, "%s: ending bit %d is not valid because field is only "
 838                   "%d bits wide", full_s, end, width);
 839     }
 840
 841     *headerp = header;
 842     *ofsp = start;
 843     *n_bitsp = end - start + 1;
 844
 845     return s;
 846 }
 847
 848 void
 849 nxm_parse_reg_move(struct nx_action_reg_move *move, const char *s)
 850 {
 851     const char *full_s = s;
 852     uint32_t src, dst;
 853     int src_ofs, dst_ofs;
 854     int src_n_bits, dst_n_bits;
 855
 856     s = nxm_parse_field_bits(s, &src, &src_ofs, &src_n_bits);
 857     if (strncmp(s, "->", 2)) {
 858         ovs_fatal(0, "%s: missing `->' following source", full_s);
 859     }
 860     s += 2;
 861     s = nxm_parse_field_bits(s, &dst, &dst_ofs, &dst_n_bits);
 862     if (*s != '\0') {
 863         ovs_fatal(0, "%s: trailing garbage following destination", full_s);
 864     }
 865
 866     if (src_n_bits != dst_n_bits) {
 867         ovs_fatal(0, "%s: source field is %d bits wide but destination is "
 868                   "%d bits wide", full_s, src_n_bits, dst_n_bits);
 869     }
 870
 871     ofputil_init_NXAST_REG_MOVE(move);
 872     move->n_bits = htons(src_n_bits);
 873     move->src_ofs = htons(src_ofs);
 874     move->dst_ofs = htons(dst_ofs);
 875     move->src = htonl(src);
 876     move->dst = htonl(dst);
 877 }
 878
 879 void
 880 nxm_parse_reg_load(struct nx_action_reg_load *load, const char *s)
 881 {
 882     const char *full_s = s;
 883     uint32_t dst;
 884     int ofs, n_bits;
 885     uint64_t value;
 886
 887     value = strtoull(s, (char **) &s, 0);
 888     if (strncmp(s, "->", 2)) {
 889         ovs_fatal(0, "%s: missing `->' following value", full_s);
 890     }
 891     s += 2;
 892     s = nxm_parse_field_bits(s, &dst, &ofs, &n_bits);
 893     if (*s != '\0') {
 894         ovs_fatal(0, "%s: trailing garbage following destination", full_s);
 895     }
 896
 897     if (n_bits < 64 && (value >> n_bits) != 0) {
 898         ovs_fatal(0, "%s: value %"PRIu64" does not fit into %d bits",
 899                   full_s, value, n_bits);
 900     }
 901
 902     ofputil_init_NXAST_REG_LOAD(load);
 903     load->ofs_nbits = nxm_encode_ofs_nbits(ofs, n_bits);
 904     load->dst = htonl(dst);
 905     load->value = htonll(value);
 906 }
 907 \f
 908 /* nxm_format_reg_move(), nxm_format_reg_load(). */
 909
 910 void
 911 nxm_format_field_bits(struct ds *s, uint32_t header, int ofs, int n_bits)
 912 {
 913     format_nxm_field_name(s, header);
 914     if (ofs == 0 && n_bits == nxm_field_bits(header)) {
 915         ds_put_cstr(s, "[]");
 916     } else if (n_bits == 1) {
 917         ds_put_format(s, "[%d]", ofs);
 918     } else {
 919         ds_put_format(s, "[%d..%d]", ofs, ofs + n_bits - 1);
 920     }
 921 }
 922
 923 void
 924 nxm_format_reg_move(const struct nx_action_reg_move *move, struct ds *s)
 925 {
 926     int n_bits = ntohs(move->n_bits);
 927     int src_ofs = ntohs(move->src_ofs);
 928     int dst_ofs = ntohs(move->dst_ofs);
 929     uint32_t src = ntohl(move->src);
 930     uint32_t dst = ntohl(move->dst);
 931
 932     ds_put_format(s, "move:");
 933     nxm_format_field_bits(s, src, src_ofs, n_bits);
 934     ds_put_cstr(s, "->");
 935     nxm_format_field_bits(s, dst, dst_ofs, n_bits);
 936 }
 937
 938 void
 939 nxm_format_reg_load(const struct nx_action_reg_load *load, struct ds *s)
 940 {
 941     int ofs = nxm_decode_ofs(load->ofs_nbits);
 942     int n_bits = nxm_decode_n_bits(load->ofs_nbits);
 943     uint32_t dst = ntohl(load->dst);
 944     uint64_t value = ntohll(load->value);
 945
 946     ds_put_format(s, "load:%#"PRIx64"->", value);
 947     nxm_format_field_bits(s, dst, ofs, n_bits);
 948 }
 949 \f
 950 /* nxm_check_reg_move(), nxm_check_reg_load(). */
 951
 952 static bool
 953 field_ok(const struct nxm_field *f, const struct flow *flow, int size)
 954 {
 955     return (f
 956             && !NXM_HASMASK(f->header)
 957             && mf_are_prereqs_ok(f->mf, flow)
 958             && size <= nxm_field_bits(f->header));
 959 }
 960
 961 int
 962 nxm_check_reg_move(const struct nx_action_reg_move *action,
 963                    const struct flow *flow)
 964 {
 965     int src_ofs, dst_ofs, n_bits;
 966     int error;
 967
 968     n_bits = ntohs(action->n_bits);
 969     src_ofs = ntohs(action->src_ofs);
 970     dst_ofs = ntohs(action->dst_ofs);
 971
 972     error = nxm_src_check(action->src, src_ofs, n_bits, flow);
 973     if (error) {
 974         return error;
 975     }
 976
 977     return nxm_dst_check(action->dst, dst_ofs, n_bits, flow);
 978 }
 979
 980 /* Given a flow, checks that the source field represented by 'src_header'
 981  * in the range ['ofs', 'ofs' + 'n_bits') is valid. */
 982 int
 983 nxm_src_check(ovs_be32 src_header, unsigned int ofs, unsigned int n_bits,
 984               const struct flow *flow)
 985 {
 986     const struct nxm_field *src = nxm_field_lookup(ntohl(src_header));
 987
 988     if (!n_bits) {
 989         VLOG_WARN_RL(&rl, "zero bit source field");
 990     } else if (!field_ok(src, flow, ofs + n_bits)) {
 991         VLOG_WARN_RL(&rl, "invalid source field");
 992     } else {
 993         return 0;
 994     }
 995
 996     return BAD_ARGUMENT;
 997 }
 998
 999 /* Given a flow, checks that the destination field represented by 'dst_header'
1000  * in the range ['ofs', 'ofs' + 'n_bits') is valid. */
1001 int
1002 nxm_dst_check(ovs_be32 dst_header, unsigned int ofs, unsigned int n_bits,
1003               const struct flow *flow)
1004 {
1005     const struct nxm_field *dst = nxm_field_lookup(ntohl(dst_header));
1006
1007     if (!n_bits) {
1008         VLOG_WARN_RL(&rl, "zero bit destination field");
1009     } else if (!field_ok(dst, flow, ofs + n_bits)) {
1010         VLOG_WARN_RL(&rl, "invalid destination field");
1011     } else if (!dst->writable) {
1012         VLOG_WARN_RL(&rl, "destination field is not writable");
1013     } else {
1014         return 0;
1015     }
1016
1017     return BAD_ARGUMENT;
1018 }
1019
1020 int
1021 nxm_check_reg_load(const struct nx_action_reg_load *action,
1022                    const struct flow *flow)
1023 {
1024     unsigned int ofs = nxm_decode_ofs(action->ofs_nbits);
1025     unsigned int n_bits = nxm_decode_n_bits(action->ofs_nbits);
1026     int error;
1027
1028     error = nxm_dst_check(action->dst, ofs, n_bits, flow);
1029     if (error) {
1030         return error;
1031     }
1032
1033     /* Reject 'action' if a bit numbered 'n_bits' or higher is set to 1 in
1034      * action->value. */
1035     if (n_bits < 64 && ntohll(action->value) >> n_bits) {
1036         return BAD_ARGUMENT;
1037     }
1038
1039     return 0;
1040 }
1041 \f
1042 /* nxm_execute_reg_move(), nxm_execute_reg_load(). */
1043
1044 static uint64_t
1045 nxm_read_field(const struct nxm_field *src, const struct flow *flow)
1046 {
1047     switch (src->index) {
1048     case NFI_NXM_OF_IN_PORT:
1049         return flow->in_port;
1050
1051     case NFI_NXM_OF_ETH_DST:
1052         return eth_addr_to_uint64(flow->dl_dst);
1053
1054     case NFI_NXM_OF_ETH_SRC:
1055         return eth_addr_to_uint64(flow->dl_src);
1056
1057     case NFI_NXM_OF_ETH_TYPE:
1058         return ntohs(ofputil_dl_type_to_openflow(flow->dl_type));
1059
1060     case NFI_NXM_OF_VLAN_TCI:
1061         return ntohs(flow->vlan_tci);
1062
1063     case NFI_NXM_OF_IP_TOS:
1064         return flow->tos & IP_DSCP_MASK;
1065
1066     case NFI_NXM_NX_IP_ECN:
1067         return flow->tos & IP_ECN_MASK;
1068
1069     case NFI_NXM_NX_IP_TTL:
1070         return flow->nw_ttl;
1071
1072     case NFI_NXM_NX_IP_FRAG:
1073         return flow->frag;
1074
1075     case NFI_NXM_OF_IP_PROTO:
1076     case NFI_NXM_OF_ARP_OP:
1077         return flow->nw_proto;
1078
1079     case NFI_NXM_OF_IP_SRC:
1080     case NFI_NXM_OF_ARP_SPA:
1081         return ntohl(flow->nw_src);
1082
1083     case NFI_NXM_OF_IP_DST:
1084     case NFI_NXM_OF_ARP_TPA:
1085         return ntohl(flow->nw_dst);
1086
1087     case NFI_NXM_OF_TCP_SRC:
1088     case NFI_NXM_OF_UDP_SRC:
1089         return ntohs(flow->tp_src);
1090
1091     case NFI_NXM_OF_TCP_DST:
1092     case NFI_NXM_OF_UDP_DST:
1093         return ntohs(flow->tp_dst);
1094
1095     case NFI_NXM_OF_ICMP_TYPE:
1096     case NFI_NXM_NX_ICMPV6_TYPE:
1097         return ntohs(flow->tp_src) & 0xff;
1098
1099     case NFI_NXM_OF_ICMP_CODE:
1100     case NFI_NXM_NX_ICMPV6_CODE:
1101         return ntohs(flow->tp_dst) & 0xff;
1102
1103     case NFI_NXM_NX_TUN_ID:
1104         return ntohll(flow->tun_id);
1105
1106     case NFI_NXM_NX_IPV6_LABEL:
1107         return ntohl(flow->ipv6_label);
1108
1109 #define NXM_READ_REGISTER(IDX)                  \
1110     case NFI_NXM_NX_REG##IDX:                   \
1111         return flow->regs[IDX];                 \
1112     case NFI_NXM_NX_REG##IDX##_W:               \
1113         NOT_REACHED();
1114
1115     NXM_READ_REGISTER(0);
1116 #if FLOW_N_REGS >= 2
1117     NXM_READ_REGISTER(1);
1118 #endif
1119 #if FLOW_N_REGS >= 3
1120     NXM_READ_REGISTER(2);
1121 #endif
1122 #if FLOW_N_REGS >= 4
1123     NXM_READ_REGISTER(3);
1124 #endif
1125 #if FLOW_N_REGS >= 5
1126     NXM_READ_REGISTER(4);
1127 #endif
1128 #if FLOW_N_REGS > 5
1129 #error
1130 #endif
1131
1132     case NFI_NXM_NX_ARP_SHA:
1133     case NFI_NXM_NX_ND_SLL:
1134         return eth_addr_to_uint64(flow->arp_sha);
1135
1136     case NFI_NXM_NX_ARP_THA:
1137     case NFI_NXM_NX_ND_TLL:
1138         return eth_addr_to_uint64(flow->arp_tha);
1139
1140     case NFI_NXM_NX_TUN_ID_W:
1141     case NFI_NXM_OF_ETH_DST_W:
1142     case NFI_NXM_OF_VLAN_TCI_W:
1143     case NFI_NXM_OF_IP_SRC_W:
1144     case NFI_NXM_OF_IP_DST_W:
1145     case NFI_NXM_OF_ARP_SPA_W:
1146     case NFI_NXM_OF_ARP_TPA_W:
1147     case NFI_NXM_NX_IPV6_SRC:
1148     case NFI_NXM_NX_IPV6_SRC_W:
1149     case NFI_NXM_NX_IPV6_DST:
1150     case NFI_NXM_NX_IPV6_DST_W:
1151     case NFI_NXM_NX_IP_FRAG_W:
1152     case NFI_NXM_NX_ND_TARGET:
1153     case N_NXM_FIELDS:
1154         NOT_REACHED();
1155     }
1156
1157     NOT_REACHED();
1158 }
1159
1160 /* Returns the value of the NXM field corresponding to 'header' at 'ofs_nbits'
1161  * in 'flow'. */
1162 uint64_t
1163 nxm_read_field_bits(ovs_be32 header, ovs_be16 ofs_nbits,
1164                     const struct flow *flow)
1165 {
1166     int n_bits = nxm_decode_n_bits(ofs_nbits);
1167     int ofs = nxm_decode_ofs(ofs_nbits);
1168     uint64_t mask, data;
1169
1170     mask = n_bits == 64 ? UINT64_MAX : (UINT64_C(1) << n_bits) - 1;
1171     data = nxm_read_field(nxm_field_lookup(ntohl(header)), flow);
1172     data = (data >> ofs) & mask;
1173
1174     return data;
1175 }
1176
1177 static void
1178 nxm_write_field(const struct nxm_field *dst, struct flow *flow,
1179                 uint64_t new_value)
1180 {
1181     switch (dst->index) {
1182     case NFI_NXM_OF_ETH_DST:
1183         eth_addr_from_uint64(new_value, flow->dl_dst);
1184         break;
1185
1186     case NFI_NXM_OF_ETH_SRC:
1187         eth_addr_from_uint64(new_value, flow->dl_src);
1188         break;
1189
1190     case NFI_NXM_OF_VLAN_TCI:
1191         flow->vlan_tci = htons(new_value);
1192         break;
1193
1194     case NFI_NXM_NX_TUN_ID:
1195         flow->tun_id = htonll(new_value);
1196         break;
1197
1198 #define NXM_WRITE_REGISTER(IDX)                 \
1199     case NFI_NXM_NX_REG##IDX:                   \
1200         flow->regs[IDX] = new_value;            \
1201         break;                                  \
1202     case NFI_NXM_NX_REG##IDX##_W:               \
1203         NOT_REACHED();
1204
1205     NXM_WRITE_REGISTER(0);
1206 #if FLOW_N_REGS >= 2
1207     NXM_WRITE_REGISTER(1);
1208 #endif
1209 #if FLOW_N_REGS >= 3
1210     NXM_WRITE_REGISTER(2);
1211 #endif
1212 #if FLOW_N_REGS >= 4
1213     NXM_WRITE_REGISTER(3);
1214 #endif
1215 #if FLOW_N_REGS >= 5
1216     NXM_WRITE_REGISTER(4);
1217 #endif
1218 #if FLOW_N_REGS > 5
1219 #error
1220 #endif
1221
1222     case NFI_NXM_OF_IP_TOS:
1223         flow->tos &= ~IP_DSCP_MASK;
1224         flow->tos |= new_value & IP_DSCP_MASK;
1225         break;
1226
1227     case NFI_NXM_NX_IP_ECN:
1228         flow->tos &= ~IP_ECN_MASK;
1229         flow->tos |= new_value & IP_ECN_MASK;
1230         break;
1231
1232     case NFI_NXM_NX_IP_TTL:
1233         flow->nw_ttl = new_value;
1234         break;
1235
1236     case NFI_NXM_NX_IP_FRAG:
1237         flow->frag = new_value;
1238         break;
1239
1240     case NFI_NXM_OF_IP_SRC:
1241         flow->nw_src = htonl(new_value);
1242         break;
1243
1244     case NFI_NXM_OF_IP_DST:
1245         flow->nw_dst = htonl(new_value);
1246         break;
1247
1248     case NFI_NXM_NX_IPV6_LABEL:
1249         flow->ipv6_label = htonl(new_value);
1250         break;
1251
1252     case NFI_NXM_OF_TCP_SRC:
1253     case NFI_NXM_OF_UDP_SRC:
1254         flow->tp_src = htons(new_value);
1255         break;
1256
1257     case NFI_NXM_OF_TCP_DST:
1258     case NFI_NXM_OF_UDP_DST:
1259         flow->tp_dst = htons(new_value);
1260         break;
1261
1262     case NFI_NXM_OF_IN_PORT:
1263     case NFI_NXM_OF_ETH_TYPE:
1264     case NFI_NXM_OF_IP_PROTO:
1265     case NFI_NXM_OF_ARP_OP:
1266     case NFI_NXM_OF_ARP_SPA:
1267     case NFI_NXM_OF_ARP_TPA:
1268     case NFI_NXM_OF_ICMP_TYPE:
1269     case NFI_NXM_OF_ICMP_CODE:
1270     case NFI_NXM_NX_TUN_ID_W:
1271     case NFI_NXM_OF_ETH_DST_W:
1272     case NFI_NXM_OF_VLAN_TCI_W:
1273     case NFI_NXM_OF_IP_SRC_W:
1274     case NFI_NXM_OF_IP_DST_W:
1275     case NFI_NXM_OF_ARP_SPA_W:
1276     case NFI_NXM_OF_ARP_TPA_W:
1277     case NFI_NXM_NX_ARP_SHA:
1278     case NFI_NXM_NX_ARP_THA:
1279     case NFI_NXM_NX_IPV6_SRC:
1280     case NFI_NXM_NX_IPV6_SRC_W:
1281     case NFI_NXM_NX_IPV6_DST:
1282     case NFI_NXM_NX_IPV6_DST_W:
1283     case NFI_NXM_NX_IP_FRAG_W:
1284     case NFI_NXM_NX_ICMPV6_TYPE:
1285     case NFI_NXM_NX_ICMPV6_CODE:
1286     case NFI_NXM_NX_ND_TARGET:
1287     case NFI_NXM_NX_ND_SLL:
1288     case NFI_NXM_NX_ND_TLL:
1289     case N_NXM_FIELDS:
1290         NOT_REACHED();
1291     }
1292 }
1293
1294 void
1295 nxm_execute_reg_move(const struct nx_action_reg_move *action,
1296                      struct flow *flow)
1297 {
1298     ovs_be16 src_ofs_nbits, dst_ofs_nbits;
1299     uint64_t src_data;
1300     int n_bits;
1301
1302     n_bits = ntohs(action->n_bits);
1303     src_ofs_nbits = nxm_encode_ofs_nbits(ntohs(action->src_ofs), n_bits);
1304     dst_ofs_nbits = nxm_encode_ofs_nbits(ntohs(action->dst_ofs), n_bits);
1305
1306     src_data = nxm_read_field_bits(action->src, src_ofs_nbits, flow);
1307     nxm_reg_load(action->dst, dst_ofs_nbits, src_data, flow);
1308 }
1309
1310 void
1311 nxm_execute_reg_load(const struct nx_action_reg_load *action,
1312                      struct flow *flow)
1313 {
1314     nxm_reg_load(action->dst, action->ofs_nbits, ntohll(action->value), flow);
1315 }
1316
1317 /* Calculates ofs and n_bits from the given 'ofs_nbits' parameter, and copies
1318  * 'src_data'[0:n_bits] to 'dst_header'[ofs:ofs+n_bits] in the given 'flow'. */
1319 void
1320 nxm_reg_load(ovs_be32 dst_header, ovs_be16 ofs_nbits, uint64_t src_data,
1321              struct flow *flow)
1322 {
1323     int n_bits = nxm_decode_n_bits(ofs_nbits);
1324     int dst_ofs = nxm_decode_ofs(ofs_nbits);
1325     uint64_t mask = n_bits == 64 ? UINT64_MAX : (UINT64_C(1) << n_bits) - 1;
1326
1327     /* Get remaining bits of the destination field. */
1328     const struct nxm_field *dst = nxm_field_lookup(ntohl(dst_header));
1329     uint64_t dst_data = nxm_read_field(dst, flow) & ~(mask << dst_ofs);
1330
1331     /* Get the final value. */
1332     uint64_t new_data = dst_data | (src_data << dst_ofs);
1333
1334     nxm_write_field(dst, flow, new_data);
1335 }