lib/nx-match.c

   1 /*
   2  * Copyright (c) 2010, 2011, 2012, 2013 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-actions.h"
  27 #include "ofp-errors.h"
  28 #include "ofp-util.h"
  29 #include "ofpbuf.h"
  30 #include "openflow/nicira-ext.h"
  31 #include "packets.h"
  32 #include "unaligned.h"
  33 #include "util.h"
  34 #include "vlog.h"
  35
  36 VLOG_DEFINE_THIS_MODULE(nx_match);
  37
  38 /* Rate limit for nx_match parse errors.  These always indicate a bug in the
  39  * peer and so there's not much point in showing a lot of them. */
  40 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
  41
  42 /* Returns the width of the data for a field with the given 'header', in
  43  * bytes. */
  44 int
  45 nxm_field_bytes(uint32_t header)
  46 {
  47     unsigned int length = NXM_LENGTH(header);
  48     return NXM_HASMASK(header) ? length / 2 : length;
  49 }
  50
  51 /* Returns the width of the data for a field with the given 'header', in
  52  * bits. */
  53 int
  54 nxm_field_bits(uint32_t header)
  55 {
  56     return nxm_field_bytes(header) * 8;
  57 }
  58 \f
  59 /* nx_pull_match() and helpers. */
  60
  61 static uint32_t
  62 nx_entry_ok(const void *p, unsigned int match_len)
  63 {
  64     unsigned int payload_len;
  65     ovs_be32 header_be;
  66     uint32_t header;
  67
  68     if (match_len < 4) {
  69         if (match_len) {
  70             VLOG_DBG_RL(&rl, "nx_match ends with partial (%u-byte) nxm_header",
  71                         match_len);
  72         }
  73         return 0;
  74     }
  75     memcpy(&header_be, p, 4);
  76     header = ntohl(header_be);
  77
  78     payload_len = NXM_LENGTH(header);
  79     if (!payload_len) {
  80         VLOG_DBG_RL(&rl, "nxm_entry %08"PRIx32" has invalid payload "
  81                     "length 0", header);
  82         return 0;
  83     }
  84     if (match_len < payload_len + 4) {
  85         VLOG_DBG_RL(&rl, "%"PRIu32"-byte nxm_entry but only "
  86                     "%u bytes left in nx_match", payload_len + 4, match_len);
  87         return 0;
  88     }
  89
  90     return header;
  91 }
  92
  93 /* Given NXM/OXM value 'value' and mask 'mask', each 'width' bytes long,
  94  * checks for any 1-bit in the value where there is a 0-bit in the mask.  If it
  95  * finds one, logs a warning. */
  96 static void
  97 check_mask_consistency(const uint8_t *p, const struct mf_field *mf)
  98 {
  99     unsigned int width = mf->n_bytes;
 100     const uint8_t *value = p + 4;
 101     const uint8_t *mask = p + 4 + width;
 102     unsigned int i;
 103
 104     for (i = 0; i < width; i++) {
 105         if (value[i] & ~mask[i]) {
 106             if (!VLOG_DROP_WARN(&rl)) {
 107                 char *s = nx_match_to_string(p, width * 2 + 4);
 108                 VLOG_WARN_RL(&rl, "NXM/OXM entry %s has 1-bits in value for "
 109                              "bits wildcarded by the mask.  (Future versions "
 110                              "of OVS may report this as an OpenFlow error.)",
 111                              s);
 112                 break;
 113             }
 114         }
 115     }
 116 }
 117
 118 static enum ofperr
 119 nx_pull_raw(const uint8_t *p, unsigned int match_len, bool strict,
 120             struct match *match, ovs_be64 *cookie, ovs_be64 *cookie_mask)
 121 {
 122     uint32_t header;
 123
 124     ovs_assert((cookie != NULL) == (cookie_mask != NULL));
 125
 126     match_init_catchall(match);
 127     if (cookie) {
 128         *cookie = *cookie_mask = htonll(0);
 129     }
 130     if (!match_len) {
 131         return 0;
 132     }
 133
 134     for (;
 135          (header = nx_entry_ok(p, match_len)) != 0;
 136          p += 4 + NXM_LENGTH(header), match_len -= 4 + NXM_LENGTH(header)) {
 137         const struct mf_field *mf;
 138         enum ofperr error;
 139
 140         mf = mf_from_nxm_header(header);
 141         if (!mf) {
 142             if (strict) {
 143                 error = OFPERR_OFPBMC_BAD_FIELD;
 144             } else {
 145                 continue;
 146             }
 147         } else if (!mf_are_prereqs_ok(mf, &match->flow)) {
 148             error = OFPERR_OFPBMC_BAD_PREREQ;
 149         } else if (!mf_is_all_wild(mf, &match->wc)) {
 150             error = OFPERR_OFPBMC_DUP_FIELD;
 151         } else {
 152             unsigned int width = mf->n_bytes;
 153             union mf_value value;
 154
 155             memcpy(&value, p + 4, width);
 156             if (!mf_is_value_valid(mf, &value)) {
 157                 error = OFPERR_OFPBMC_BAD_VALUE;
 158             } else if (!NXM_HASMASK(header)) {
 159                 error = 0;
 160                 mf_set_value(mf, &value, match);
 161             } else {
 162                 union mf_value mask;
 163
 164                 memcpy(&mask, p + 4 + width, width);
 165                 if (!mf_is_mask_valid(mf, &mask)) {
 166                     error = OFPERR_OFPBMC_BAD_MASK;
 167                 } else {
 168                     error = 0;
 169                     check_mask_consistency(p, mf);
 170                     mf_set(mf, &value, &mask, match);
 171                 }
 172             }
 173         }
 174
 175         /* Check if the match is for a cookie rather than a classifier rule. */
 176         if ((header == NXM_NX_COOKIE || header == NXM_NX_COOKIE_W) && cookie) {
 177             if (*cookie_mask) {
 178                 error = OFPERR_OFPBMC_DUP_FIELD;
 179             } else {
 180                 unsigned int width = sizeof *cookie;
 181
 182                 memcpy(cookie, p + 4, width);
 183                 if (NXM_HASMASK(header)) {
 184                     memcpy(cookie_mask, p + 4 + width, width);
 185                 } else {
 186                     *cookie_mask = htonll(UINT64_MAX);
 187                 }
 188                 error = 0;
 189             }
 190         }
 191
 192         if (error) {
 193             VLOG_DBG_RL(&rl, "bad nxm_entry %#08"PRIx32" (vendor=%"PRIu32", "
 194                         "field=%"PRIu32", hasmask=%"PRIu32", len=%"PRIu32"), "
 195                         "(%s)", header,
 196                         NXM_VENDOR(header), NXM_FIELD(header),
 197                         NXM_HASMASK(header), NXM_LENGTH(header),
 198                         ofperr_to_string(error));
 199             return error;
 200         }
 201     }
 202
 203     return match_len ? OFPERR_OFPBMC_BAD_LEN : 0;
 204 }
 205
 206 static enum ofperr
 207 nx_pull_match__(struct ofpbuf *b, unsigned int match_len, bool strict,
 208                 struct match *match,
 209                 ovs_be64 *cookie, ovs_be64 *cookie_mask)
 210 {
 211     uint8_t *p = NULL;
 212
 213     if (match_len) {
 214         p = ofpbuf_try_pull(b, ROUND_UP(match_len, 8));
 215         if (!p) {
 216             VLOG_DBG_RL(&rl, "nx_match length %u, rounded up to a "
 217                         "multiple of 8, is longer than space in message (max "
 218                         "length %zu)", match_len, b->size);
 219             return OFPERR_OFPBMC_BAD_LEN;
 220         }
 221     }
 222
 223     return nx_pull_raw(p, match_len, strict, match, cookie, cookie_mask);
 224 }
 225
 226 /* Parses the nx_match formatted match description in 'b' with length
 227  * 'match_len'.  Stores the results in 'match'.  If 'cookie' and 'cookie_mask'
 228  * are valid pointers, then stores the cookie and mask in them if 'b' contains
 229  * a "NXM_NX_COOKIE*" match.  Otherwise, stores 0 in both.
 230  *
 231  * Fails with an error upon encountering an unknown NXM header.
 232  *
 233  * Returns 0 if successful, otherwise an OpenFlow error code. */
 234 enum ofperr
 235 nx_pull_match(struct ofpbuf *b, unsigned int match_len, struct match *match,
 236               ovs_be64 *cookie, ovs_be64 *cookie_mask)
 237 {
 238     return nx_pull_match__(b, match_len, true, match, cookie, cookie_mask);
 239 }
 240
 241 /* Behaves the same as nx_pull_match(), but skips over unknown NXM headers,
 242  * instead of failing with an error. */
 243 enum ofperr
 244 nx_pull_match_loose(struct ofpbuf *b, unsigned int match_len,
 245                     struct match *match,
 246                     ovs_be64 *cookie, ovs_be64 *cookie_mask)
 247 {
 248     return nx_pull_match__(b, match_len, false, match, cookie, cookie_mask);
 249 }
 250
 251 static enum ofperr
 252 oxm_pull_match__(struct ofpbuf *b, bool strict, struct match *match)
 253 {
 254     struct ofp11_match_header *omh = b->data;
 255     uint8_t *p;
 256     uint16_t match_len;
 257
 258     if (b->size < sizeof *omh) {
 259         return OFPERR_OFPBMC_BAD_LEN;
 260     }
 261
 262     match_len = ntohs(omh->length);
 263     if (match_len < sizeof *omh) {
 264         return OFPERR_OFPBMC_BAD_LEN;
 265     }
 266
 267     if (omh->type != htons(OFPMT_OXM)) {
 268         return OFPERR_OFPBMC_BAD_TYPE;
 269     }
 270
 271     p = ofpbuf_try_pull(b, ROUND_UP(match_len, 8));
 272     if (!p) {
 273         VLOG_DBG_RL(&rl, "oxm length %u, rounded up to a "
 274                     "multiple of 8, is longer than space in message (max "
 275                     "length %zu)", match_len, b->size);
 276         return OFPERR_OFPBMC_BAD_LEN;
 277     }
 278
 279     return nx_pull_raw(p + sizeof *omh, match_len - sizeof *omh,
 280                        strict, match, NULL, NULL);
 281 }
 282
 283 /* Parses the oxm formatted match description preceeded by a struct ofp11_match
 284  * in 'b' with length 'match_len'.  Stores the result in 'match'.
 285  *
 286  * Fails with an error when encountering unknown OXM headers.
 287  *
 288  * Returns 0 if successful, otherwise an OpenFlow error code. */
 289 enum ofperr
 290 oxm_pull_match(struct ofpbuf *b, struct match *match)
 291 {
 292     return oxm_pull_match__(b, true, match);
 293 }
 294
 295 /* Behaves the same as oxm_pull_match() with one exception.  Skips over unknown
 296  * PXM headers instead of failing with an error when they are encountered. */
 297 enum ofperr
 298 oxm_pull_match_loose(struct ofpbuf *b, struct match *match)
 299 {
 300     return oxm_pull_match__(b, false, match);
 301 }
 302 \f
 303 /* nx_put_match() and helpers.
 304  *
 305  * 'put' functions whose names end in 'w' add a wildcarded field.
 306  * 'put' functions whose names end in 'm' add a field that might be wildcarded.
 307  * Other 'put' functions add exact-match fields.
 308  */
 309
 310 static void
 311 nxm_put_header(struct ofpbuf *b, uint32_t header)
 312 {
 313     ovs_be32 n_header = htonl(header);
 314     ofpbuf_put(b, &n_header, sizeof n_header);
 315 }
 316
 317 static void
 318 nxm_put_8(struct ofpbuf *b, uint32_t header, uint8_t value)
 319 {
 320     nxm_put_header(b, header);
 321     ofpbuf_put(b, &value, sizeof value);
 322 }
 323
 324 static void
 325 nxm_put_8m(struct ofpbuf *b, uint32_t header, uint8_t value, uint8_t mask)
 326 {
 327     switch (mask) {
 328     case 0:
 329         break;
 330
 331     case UINT8_MAX:
 332         nxm_put_8(b, header, value);
 333         break;
 334
 335     default:
 336         nxm_put_header(b, NXM_MAKE_WILD_HEADER(header));
 337         ofpbuf_put(b, &value, sizeof value);
 338         ofpbuf_put(b, &mask, sizeof mask);
 339     }
 340 }
 341
 342 static void
 343 nxm_put_16(struct ofpbuf *b, uint32_t header, ovs_be16 value)
 344 {
 345     nxm_put_header(b, header);
 346     ofpbuf_put(b, &value, sizeof value);
 347 }
 348
 349 static void
 350 nxm_put_16w(struct ofpbuf *b, uint32_t header, ovs_be16 value, ovs_be16 mask)
 351 {
 352     nxm_put_header(b, header);
 353     ofpbuf_put(b, &value, sizeof value);
 354     ofpbuf_put(b, &mask, sizeof mask);
 355 }
 356
 357 static void
 358 nxm_put_16m(struct ofpbuf *b, uint32_t header, ovs_be16 value, ovs_be16 mask)
 359 {
 360     switch (mask) {
 361     case 0:
 362         break;
 363
 364     case CONSTANT_HTONS(UINT16_MAX):
 365         nxm_put_16(b, header, value);
 366         break;
 367
 368     default:
 369         nxm_put_16w(b, NXM_MAKE_WILD_HEADER(header), value, mask);
 370         break;
 371     }
 372 }
 373
 374 static void
 375 nxm_put_32(struct ofpbuf *b, uint32_t header, ovs_be32 value)
 376 {
 377     nxm_put_header(b, header);
 378     ofpbuf_put(b, &value, sizeof value);
 379 }
 380
 381 static void
 382 nxm_put_32w(struct ofpbuf *b, uint32_t header, ovs_be32 value, ovs_be32 mask)
 383 {
 384     nxm_put_header(b, header);
 385     ofpbuf_put(b, &value, sizeof value);
 386     ofpbuf_put(b, &mask, sizeof mask);
 387 }
 388
 389 static void
 390 nxm_put_32m(struct ofpbuf *b, uint32_t header, ovs_be32 value, ovs_be32 mask)
 391 {
 392     switch (mask) {
 393     case 0:
 394         break;
 395
 396     case CONSTANT_HTONL(UINT32_MAX):
 397         nxm_put_32(b, header, value);
 398         break;
 399
 400     default:
 401         nxm_put_32w(b, NXM_MAKE_WILD_HEADER(header), value, mask);
 402         break;
 403     }
 404 }
 405
 406 static void
 407 nxm_put_64(struct ofpbuf *b, uint32_t header, ovs_be64 value)
 408 {
 409     nxm_put_header(b, header);
 410     ofpbuf_put(b, &value, sizeof value);
 411 }
 412
 413 static void
 414 nxm_put_64w(struct ofpbuf *b, uint32_t header, ovs_be64 value, ovs_be64 mask)
 415 {
 416     nxm_put_header(b, header);
 417     ofpbuf_put(b, &value, sizeof value);
 418     ofpbuf_put(b, &mask, sizeof mask);
 419 }
 420
 421 static void
 422 nxm_put_64m(struct ofpbuf *b, uint32_t header, ovs_be64 value, ovs_be64 mask)
 423 {
 424     switch (mask) {
 425     case 0:
 426         break;
 427
 428     case CONSTANT_HTONLL(UINT64_MAX):
 429         nxm_put_64(b, header, value);
 430         break;
 431
 432     default:
 433         nxm_put_64w(b, NXM_MAKE_WILD_HEADER(header), value, mask);
 434         break;
 435     }
 436 }
 437
 438 static void
 439 nxm_put_eth(struct ofpbuf *b, uint32_t header,
 440             const uint8_t value[ETH_ADDR_LEN])
 441 {
 442     nxm_put_header(b, header);
 443     ofpbuf_put(b, value, ETH_ADDR_LEN);
 444 }
 445
 446 static void
 447 nxm_put_eth_masked(struct ofpbuf *b, uint32_t header,
 448                    const uint8_t value[ETH_ADDR_LEN],
 449                    const uint8_t mask[ETH_ADDR_LEN])
 450 {
 451     if (!eth_addr_is_zero(mask)) {
 452         if (eth_mask_is_exact(mask)) {
 453             nxm_put_eth(b, header, value);
 454         } else {
 455             nxm_put_header(b, NXM_MAKE_WILD_HEADER(header));
 456             ofpbuf_put(b, value, ETH_ADDR_LEN);
 457             ofpbuf_put(b, mask, ETH_ADDR_LEN);
 458         }
 459     }
 460 }
 461
 462 static void
 463 nxm_put_ipv6(struct ofpbuf *b, uint32_t header,
 464              const struct in6_addr *value, const struct in6_addr *mask)
 465 {
 466     if (ipv6_mask_is_any(mask)) {
 467         return;
 468     } else if (ipv6_mask_is_exact(mask)) {
 469         nxm_put_header(b, header);
 470         ofpbuf_put(b, value, sizeof *value);
 471     } else {
 472         nxm_put_header(b, NXM_MAKE_WILD_HEADER(header));
 473         ofpbuf_put(b, value, sizeof *value);
 474         ofpbuf_put(b, mask, sizeof *mask);
 475     }
 476 }
 477
 478 static void
 479 nxm_put_frag(struct ofpbuf *b, const struct match *match)
 480 {
 481     uint8_t nw_frag = match->flow.nw_frag;
 482     uint8_t nw_frag_mask = match->wc.masks.nw_frag;
 483
 484     switch (nw_frag_mask) {
 485     case 0:
 486         break;
 487
 488     case FLOW_NW_FRAG_MASK:
 489         nxm_put_8(b, NXM_NX_IP_FRAG, nw_frag);
 490         break;
 491
 492     default:
 493         nxm_put_8m(b, NXM_NX_IP_FRAG, nw_frag,
 494                    nw_frag_mask & FLOW_NW_FRAG_MASK);
 495         break;
 496     }
 497 }
 498
 499 static void
 500 nxm_put_ip(struct ofpbuf *b, const struct match *match,
 501            uint8_t icmp_proto, uint32_t icmp_type, uint32_t icmp_code,
 502            bool oxm)
 503 {
 504     const struct flow *flow = &match->flow;
 505
 506     nxm_put_frag(b, match);
 507
 508     if (match->wc.masks.nw_tos & IP_DSCP_MASK) {
 509         if (oxm) {
 510             nxm_put_8(b, OXM_OF_IP_DSCP, flow->nw_tos >> 2);
 511         } else {
 512             nxm_put_8(b, NXM_OF_IP_TOS, flow->nw_tos & IP_DSCP_MASK);
 513         }
 514     }
 515
 516     if (match->wc.masks.nw_tos & IP_ECN_MASK) {
 517         nxm_put_8(b, oxm ? OXM_OF_IP_ECN : NXM_NX_IP_ECN,
 518                   flow->nw_tos & IP_ECN_MASK);
 519     }
 520
 521     if (!oxm && match->wc.masks.nw_ttl) {
 522         nxm_put_8(b, NXM_NX_IP_TTL, flow->nw_ttl);
 523     }
 524
 525     if (match->wc.masks.nw_proto) {
 526         nxm_put_8(b, oxm ? OXM_OF_IP_PROTO : NXM_OF_IP_PROTO, flow->nw_proto);
 527
 528         if (flow->nw_proto == IPPROTO_TCP) {
 529             nxm_put_16m(b, oxm ? OXM_OF_TCP_SRC : NXM_OF_TCP_SRC,
 530                         flow->tp_src, match->wc.masks.tp_src);
 531             nxm_put_16m(b, oxm ? OXM_OF_TCP_DST : NXM_OF_TCP_DST,
 532                         flow->tp_dst, match->wc.masks.tp_dst);
 533         } else if (flow->nw_proto == IPPROTO_UDP) {
 534             nxm_put_16m(b, oxm ? OXM_OF_UDP_SRC : NXM_OF_UDP_SRC,
 535                         flow->tp_src, match->wc.masks.tp_src);
 536             nxm_put_16m(b, oxm ? OXM_OF_UDP_DST : NXM_OF_UDP_DST,
 537                         flow->tp_dst, match->wc.masks.tp_dst);
 538         } else if (flow->nw_proto == icmp_proto) {
 539             if (match->wc.masks.tp_src) {
 540                 nxm_put_8(b, icmp_type, ntohs(flow->tp_src));
 541             }
 542             if (match->wc.masks.tp_dst) {
 543                 nxm_put_8(b, icmp_code, ntohs(flow->tp_dst));
 544             }
 545         }
 546     }
 547 }
 548
 549 /* Appends to 'b' the nx_match format that expresses 'match'.  For Flow Mod and
 550  * Flow Stats Requests messages, a 'cookie' and 'cookie_mask' may be supplied.
 551  * Otherwise, 'cookie_mask' should be zero.
 552  *
 553  * This function can cause 'b''s data to be reallocated.
 554  *
 555  * Returns the number of bytes appended to 'b', excluding padding.
 556  *
 557  * If 'match' is a catch-all rule that matches every packet, then this function
 558  * appends nothing to 'b' and returns 0. */
 559 static int
 560 nx_put_raw(struct ofpbuf *b, bool oxm, const struct match *match,
 561            ovs_be64 cookie, ovs_be64 cookie_mask)
 562 {
 563     const struct flow *flow = &match->flow;
 564     const size_t start_len = b->size;
 565     int match_len;
 566     int i;
 567
 568     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 20);
 569
 570     /* Metadata. */
 571     if (match->wc.masks.in_port) {
 572         uint16_t in_port = flow->in_port;
 573         if (oxm) {
 574             nxm_put_32(b, OXM_OF_IN_PORT, ofputil_port_to_ofp11(in_port));
 575         } else {
 576             nxm_put_16(b, NXM_OF_IN_PORT, htons(in_port));
 577         }
 578     }
 579
 580     /* Ethernet. */
 581     nxm_put_eth_masked(b, oxm ? OXM_OF_ETH_SRC : NXM_OF_ETH_SRC,
 582                        flow->dl_src, match->wc.masks.dl_src);
 583     nxm_put_eth_masked(b, oxm ? OXM_OF_ETH_DST : NXM_OF_ETH_DST,
 584                        flow->dl_dst, match->wc.masks.dl_dst);
 585     nxm_put_16m(b, oxm ? OXM_OF_ETH_TYPE : NXM_OF_ETH_TYPE,
 586                 ofputil_dl_type_to_openflow(flow->dl_type),
 587                 match->wc.masks.dl_type);
 588
 589     /* 802.1Q. */
 590     if (oxm) {
 591         ovs_be16 VID_CFI_MASK = htons(VLAN_VID_MASK | VLAN_CFI);
 592         ovs_be16 vid = flow->vlan_tci & VID_CFI_MASK;
 593         ovs_be16 mask = match->wc.masks.vlan_tci & VID_CFI_MASK;
 594
 595         if (mask == htons(VLAN_VID_MASK | VLAN_CFI)) {
 596             nxm_put_16(b, OXM_OF_VLAN_VID, vid);
 597         } else if (mask) {
 598             nxm_put_16m(b, OXM_OF_VLAN_VID, vid, mask);
 599         }
 600
 601         if (vid && vlan_tci_to_pcp(match->wc.masks.vlan_tci)) {
 602             nxm_put_8(b, OXM_OF_VLAN_PCP, vlan_tci_to_pcp(flow->vlan_tci));
 603         }
 604
 605     } else {
 606         nxm_put_16m(b, NXM_OF_VLAN_TCI, flow->vlan_tci,
 607                     match->wc.masks.vlan_tci);
 608     }
 609
 610     /* MPLS. */
 611     if (eth_type_mpls(flow->dl_type)) {
 612         if (match->wc.masks.mpls_lse & htonl(MPLS_TC_MASK)) {
 613             nxm_put_8(b, OXM_OF_MPLS_TC, mpls_lse_to_tc(flow->mpls_lse));
 614         }
 615
 616         if (match->wc.masks.mpls_lse & htonl(MPLS_BOS_MASK)) {
 617             nxm_put_8(b, OXM_OF_MPLS_BOS, mpls_lse_to_bos(flow->mpls_lse));
 618         }
 619
 620         if (match->wc.masks.mpls_lse & htonl(MPLS_LABEL_MASK)) {
 621             nxm_put_32(b, OXM_OF_MPLS_LABEL,
 622                        htonl(mpls_lse_to_label(flow->mpls_lse)));
 623         }
 624     }
 625
 626     /* L3. */
 627     if (flow->dl_type == htons(ETH_TYPE_IP)) {
 628         /* IP. */
 629         nxm_put_32m(b, oxm ? OXM_OF_IPV4_SRC : NXM_OF_IP_SRC,
 630                     flow->nw_src, match->wc.masks.nw_src);
 631         nxm_put_32m(b, oxm ? OXM_OF_IPV4_DST : NXM_OF_IP_DST,
 632                     flow->nw_dst, match->wc.masks.nw_dst);
 633         nxm_put_ip(b, match, IPPROTO_ICMP,
 634                    oxm ? OXM_OF_ICMPV4_TYPE : NXM_OF_ICMP_TYPE,
 635                    oxm ? OXM_OF_ICMPV4_CODE : NXM_OF_ICMP_CODE, oxm);
 636     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
 637         /* IPv6. */
 638         nxm_put_ipv6(b, oxm ? OXM_OF_IPV6_SRC : NXM_NX_IPV6_SRC,
 639                      &flow->ipv6_src, &match->wc.masks.ipv6_src);
 640         nxm_put_ipv6(b, oxm ? OXM_OF_IPV6_DST : NXM_NX_IPV6_DST,
 641                      &flow->ipv6_dst, &match->wc.masks.ipv6_dst);
 642         nxm_put_ip(b, match, IPPROTO_ICMPV6,
 643                    oxm ? OXM_OF_ICMPV6_TYPE : NXM_NX_ICMPV6_TYPE,
 644                    oxm ? OXM_OF_ICMPV6_CODE : NXM_NX_ICMPV6_CODE, oxm);
 645
 646         nxm_put_32m(b, oxm ? OXM_OF_IPV6_FLABEL : NXM_NX_IPV6_LABEL,
 647                     flow->ipv6_label, match->wc.masks.ipv6_label);
 648
 649         if (flow->nw_proto == IPPROTO_ICMPV6
 650             && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
 651                 flow->tp_src == htons(ND_NEIGHBOR_ADVERT))) {
 652             nxm_put_ipv6(b, oxm ? OXM_OF_IPV6_ND_TARGET : NXM_NX_ND_TARGET,
 653                          &flow->nd_target, &match->wc.masks.nd_target);
 654             if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
 655                 nxm_put_eth_masked(b, oxm ? OXM_OF_IPV6_ND_SLL : NXM_NX_ND_SLL,
 656                                    flow->arp_sha, match->wc.masks.arp_sha);
 657             }
 658             if (flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
 659                 nxm_put_eth_masked(b, oxm ? OXM_OF_IPV6_ND_TLL : NXM_NX_ND_TLL,
 660                                    flow->arp_tha, match->wc.masks.arp_tha);
 661             }
 662         }
 663     } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
 664                flow->dl_type == htons(ETH_TYPE_RARP)) {
 665         /* ARP. */
 666         if (match->wc.masks.nw_proto) {
 667             nxm_put_16(b, oxm ? OXM_OF_ARP_OP : NXM_OF_ARP_OP,
 668                        htons(flow->nw_proto));
 669         }
 670         nxm_put_32m(b, oxm ? OXM_OF_ARP_SPA : NXM_OF_ARP_SPA,
 671                     flow->nw_src, match->wc.masks.nw_src);
 672         nxm_put_32m(b, oxm ? OXM_OF_ARP_TPA : NXM_OF_ARP_TPA,
 673                     flow->nw_dst, match->wc.masks.nw_dst);
 674         nxm_put_eth_masked(b, oxm ? OXM_OF_ARP_SHA : NXM_NX_ARP_SHA,
 675                            flow->arp_sha, match->wc.masks.arp_sha);
 676         nxm_put_eth_masked(b, oxm ? OXM_OF_ARP_THA : NXM_NX_ARP_THA,
 677                            flow->arp_tha, match->wc.masks.arp_tha);
 678     }
 679
 680     /* Tunnel ID. */
 681     nxm_put_64m(b, oxm ? OXM_OF_TUNNEL_ID : NXM_NX_TUN_ID,
 682                 flow->tunnel.tun_id, match->wc.masks.tunnel.tun_id);
 683
 684     /* Other tunnel metadata. */
 685     nxm_put_32m(b, NXM_NX_TUN_IPV4_SRC,
 686                 flow->tunnel.ip_src, match->wc.masks.tunnel.ip_src);
 687     nxm_put_32m(b, NXM_NX_TUN_IPV4_DST,
 688                 flow->tunnel.ip_dst, match->wc.masks.tunnel.ip_dst);
 689
 690     /* Registers. */
 691     for (i = 0; i < FLOW_N_REGS; i++) {
 692         nxm_put_32m(b, NXM_NX_REG(i),
 693                     htonl(flow->regs[i]), htonl(match->wc.masks.regs[i]));
 694     }
 695
 696     /* OpenFlow 1.1+ Metadata. */
 697     nxm_put_64m(b, OXM_OF_METADATA, flow->metadata, match->wc.masks.metadata);
 698
 699     /* Cookie. */
 700     nxm_put_64m(b, NXM_NX_COOKIE, cookie, cookie_mask);
 701
 702     match_len = b->size - start_len;
 703     return match_len;
 704 }
 705
 706 /* Appends to 'b' the nx_match format that expresses 'match', plus enough zero
 707  * bytes to pad the nx_match out to a multiple of 8.  For Flow Mod and Flow
 708  * Stats Requests messages, a 'cookie' and 'cookie_mask' may be supplied.
 709  * Otherwise, 'cookie_mask' should be zero.
 710  *
 711  * This function can cause 'b''s data to be reallocated.
 712  *
 713  * Returns the number of bytes appended to 'b', excluding padding.  The return
 714  * value can be zero if it appended nothing at all to 'b' (which happens if
 715  * 'cr' is a catch-all rule that matches every packet). */
 716 int
 717 nx_put_match(struct ofpbuf *b, const struct match *match,
 718              ovs_be64 cookie, ovs_be64 cookie_mask)
 719 {
 720     int match_len = nx_put_raw(b, false, match, cookie, cookie_mask);
 721
 722     ofpbuf_put_zeros(b, ROUND_UP(match_len, 8) - match_len);
 723     return match_len;
 724 }
 725
 726
 727 /* Appends to 'b' an struct ofp11_match_header followed by the oxm format that
 728  * expresses 'cr', plus enough zero bytes to pad the data appended out to a
 729  * multiple of 8.
 730  *
 731  * This function can cause 'b''s data to be reallocated.
 732  *
 733  * Returns the number of bytes appended to 'b', excluding the padding.  Never
 734  * returns zero. */
 735 int
 736 oxm_put_match(struct ofpbuf *b, const struct match *match)
 737 {
 738     int match_len;
 739     struct ofp11_match_header *omh;
 740     size_t start_len = b->size;
 741     ovs_be64 cookie = htonll(0), cookie_mask = htonll(0);
 742
 743     ofpbuf_put_uninit(b, sizeof *omh);
 744     match_len = nx_put_raw(b, true, match, cookie, cookie_mask) + sizeof *omh;
 745     ofpbuf_put_zeros(b, ROUND_UP(match_len, 8) - match_len);
 746
 747     omh = (struct ofp11_match_header *)((char *)b->data + start_len);
 748     omh->type = htons(OFPMT_OXM);
 749     omh->length = htons(match_len);
 750
 751     return match_len;
 752 }
 753 \f
 754 /* nx_match_to_string() and helpers. */
 755
 756 static void format_nxm_field_name(struct ds *, uint32_t header);
 757
 758 char *
 759 nx_match_to_string(const uint8_t *p, unsigned int match_len)
 760 {
 761     uint32_t header;
 762     struct ds s;
 763
 764     if (!match_len) {
 765         return xstrdup("<any>");
 766     }
 767
 768     ds_init(&s);
 769     while ((header = nx_entry_ok(p, match_len)) != 0) {
 770         unsigned int length = NXM_LENGTH(header);
 771         unsigned int value_len = nxm_field_bytes(header);
 772         const uint8_t *value = p + 4;
 773         const uint8_t *mask = value + value_len;
 774         unsigned int i;
 775
 776         if (s.length) {
 777             ds_put_cstr(&s, ", ");
 778         }
 779
 780         format_nxm_field_name(&s, header);
 781         ds_put_char(&s, '(');
 782
 783         for (i = 0; i < value_len; i++) {
 784             ds_put_format(&s, "%02x", value[i]);
 785         }
 786         if (NXM_HASMASK(header)) {
 787             ds_put_char(&s, '/');
 788             for (i = 0; i < value_len; i++) {
 789                 ds_put_format(&s, "%02x", mask[i]);
 790             }
 791         }
 792         ds_put_char(&s, ')');
 793
 794         p += 4 + length;
 795         match_len -= 4 + length;
 796     }
 797
 798     if (match_len) {
 799         if (s.length) {
 800             ds_put_cstr(&s, ", ");
 801         }
 802
 803         ds_put_format(&s, "<%u invalid bytes>", match_len);
 804     }
 805
 806     return ds_steal_cstr(&s);
 807 }
 808
 809 char *
 810 oxm_match_to_string(const uint8_t *p, unsigned int match_len)
 811 {
 812     const struct ofp11_match_header *omh = (struct ofp11_match_header *)p;
 813     uint16_t match_len_;
 814     struct ds s;
 815
 816     ds_init(&s);
 817
 818     if (match_len < sizeof *omh) {
 819         ds_put_format(&s, "<match too short: %u>", match_len);
 820         goto err;
 821     }
 822
 823     if (omh->type != htons(OFPMT_OXM)) {
 824         ds_put_format(&s, "<bad match type field: %u>", ntohs(omh->type));
 825         goto err;
 826     }
 827
 828     match_len_ = ntohs(omh->length);
 829     if (match_len_ < sizeof *omh) {
 830         ds_put_format(&s, "<match length field too short: %u>", match_len_);
 831         goto err;
 832     }
 833
 834     if (match_len_ != match_len) {
 835         ds_put_format(&s, "<match length field incorrect: %u != %u>",
 836                       match_len_, match_len);
 837         goto err;
 838     }
 839
 840     return nx_match_to_string(p + sizeof *omh, match_len - sizeof *omh);
 841
 842 err:
 843     return ds_steal_cstr(&s);
 844 }
 845
 846 static void
 847 format_nxm_field_name(struct ds *s, uint32_t header)
 848 {
 849     const struct mf_field *mf = mf_from_nxm_header(header);
 850     if (mf) {
 851         ds_put_cstr(s, IS_OXM_HEADER(header) ? mf->oxm_name : mf->nxm_name);
 852         if (NXM_HASMASK(header)) {
 853             ds_put_cstr(s, "_W");
 854         }
 855     } else if (header == NXM_NX_COOKIE) {
 856         ds_put_cstr(s, "NXM_NX_COOKIE");
 857     } else if (header == NXM_NX_COOKIE_W) {
 858         ds_put_cstr(s, "NXM_NX_COOKIE_W");
 859     } else {
 860         ds_put_format(s, "%d:%d", NXM_VENDOR(header), NXM_FIELD(header));
 861     }
 862 }
 863
 864 static uint32_t
 865 parse_nxm_field_name(const char *name, int name_len)
 866 {
 867     bool wild;
 868     int i;
 869
 870     /* Check whether it's a field name. */
 871     wild = name_len > 2 && !memcmp(&name[name_len - 2], "_W", 2);
 872     if (wild) {
 873         name_len -= 2;
 874     }
 875
 876     for (i = 0; i < MFF_N_IDS; i++) {
 877         const struct mf_field *mf = mf_from_id(i);
 878         uint32_t header;
 879
 880         if (mf->nxm_name &&
 881             !strncmp(mf->nxm_name, name, name_len) &&
 882             mf->nxm_name[name_len] == '\0') {
 883             header = mf->nxm_header;
 884         } else if (mf->oxm_name &&
 885                    !strncmp(mf->oxm_name, name, name_len) &&
 886                    mf->oxm_name[name_len] == '\0') {
 887             header = mf->oxm_header;
 888         } else {
 889             continue;
 890         }
 891
 892         if (!wild) {
 893             return header;
 894         } else if (mf->maskable != MFM_NONE) {
 895             return NXM_MAKE_WILD_HEADER(header);
 896         }
 897     }
 898
 899     if (!strncmp("NXM_NX_COOKIE", name, name_len) &&
 900         (name_len == strlen("NXM_NX_COOKIE"))) {
 901         if (!wild) {
 902             return NXM_NX_COOKIE;
 903         } else {
 904             return NXM_NX_COOKIE_W;
 905         }
 906     }
 907
 908     /* Check whether it's a 32-bit field header value as hex.
 909      * (This isn't ordinarily useful except for testing error behavior.) */
 910     if (name_len == 8) {
 911         uint32_t header = hexits_value(name, name_len, NULL);
 912         if (header != UINT_MAX) {
 913             return header;
 914         }
 915     }
 916
 917     return 0;
 918 }
 919 \f
 920 /* nx_match_from_string(). */
 921
 922 static int
 923 nx_match_from_string_raw(const char *s, struct ofpbuf *b)
 924 {
 925     const char *full_s = s;
 926     const size_t start_len = b->size;
 927
 928     if (!strcmp(s, "<any>")) {
 929         /* Ensure that 'b->data' isn't actually null. */
 930         ofpbuf_prealloc_tailroom(b, 1);
 931         return 0;
 932     }
 933
 934     for (s += strspn(s, ", "); *s; s += strspn(s, ", ")) {
 935         const char *name;
 936         uint32_t header;
 937         int name_len;
 938         size_t n;
 939
 940         name = s;
 941         name_len = strcspn(s, "(");
 942         if (s[name_len] != '(') {
 943             ovs_fatal(0, "%s: missing ( at end of nx_match", full_s);
 944         }
 945
 946         header = parse_nxm_field_name(name, name_len);
 947         if (!header) {
 948             ovs_fatal(0, "%s: unknown field `%.*s'", full_s, name_len, s);
 949         }
 950
 951         s += name_len + 1;
 952
 953         nxm_put_header(b, header);
 954         s = ofpbuf_put_hex(b, s, &n);
 955         if (n != nxm_field_bytes(header)) {
 956             ovs_fatal(0, "%.2s: hex digits expected", s);
 957         }
 958         if (NXM_HASMASK(header)) {
 959             s += strspn(s, " ");
 960             if (*s != '/') {
 961                 ovs_fatal(0, "%s: missing / in masked field %.*s",
 962                           full_s, name_len, name);
 963             }
 964             s = ofpbuf_put_hex(b, s + 1, &n);
 965             if (n != nxm_field_bytes(header)) {
 966                 ovs_fatal(0, "%.2s: hex digits expected", s);
 967             }
 968         }
 969
 970         s += strspn(s, " ");
 971         if (*s != ')') {
 972             ovs_fatal(0, "%s: missing ) following field %.*s",
 973                       full_s, name_len, name);
 974         }
 975         s++;
 976     }
 977
 978     return b->size - start_len;
 979 }
 980
 981 int
 982 nx_match_from_string(const char *s, struct ofpbuf *b)
 983 {
 984     int match_len = nx_match_from_string_raw(s, b);
 985     ofpbuf_put_zeros(b, ROUND_UP(match_len, 8) - match_len);
 986     return match_len;
 987 }
 988
 989 int
 990 oxm_match_from_string(const char *s, struct ofpbuf *b)
 991 {
 992     int match_len;
 993     struct ofp11_match_header *omh;
 994     size_t start_len = b->size;
 995
 996     ofpbuf_put_uninit(b, sizeof *omh);
 997     match_len = nx_match_from_string_raw(s, b) + sizeof *omh;
 998     ofpbuf_put_zeros(b, ROUND_UP(match_len, 8) - match_len);
 999
1000     omh = (struct ofp11_match_header *)((char *)b->data + start_len);
1001     omh->type = htons(OFPMT_OXM);
1002     omh->length = htons(match_len);
1003
1004     return match_len;
1005 }
1006 \f
1007 void
1008 nxm_parse_reg_move(struct ofpact_reg_move *move, const char *s)
1009 {
1010     const char *full_s = s;
1011
1012     s = mf_parse_subfield(&move->src, s);
1013     if (strncmp(s, "->", 2)) {
1014         ovs_fatal(0, "%s: missing `->' following source", full_s);
1015     }
1016     s += 2;
1017     s = mf_parse_subfield(&move->dst, s);
1018     if (*s != '\0') {
1019         ovs_fatal(0, "%s: trailing garbage following destination", full_s);
1020     }
1021
1022     if (move->src.n_bits != move->dst.n_bits) {
1023         ovs_fatal(0, "%s: source field is %d bits wide but destination is "
1024                   "%d bits wide", full_s,
1025                   move->src.n_bits, move->dst.n_bits);
1026     }
1027 }
1028
1029 void
1030 nxm_parse_reg_load(struct ofpact_reg_load *load, const char *s)
1031 {
1032     const char *full_s = s;
1033     uint64_t value = strtoull(s, (char **) &s, 0);
1034
1035     if (strncmp(s, "->", 2)) {
1036         ovs_fatal(0, "%s: missing `->' following value", full_s);
1037     }
1038     s += 2;
1039     s = mf_parse_subfield(&load->dst, s);
1040     if (*s != '\0') {
1041         ovs_fatal(0, "%s: trailing garbage following destination", full_s);
1042     }
1043
1044     if (load->dst.n_bits < 64 && (value >> load->dst.n_bits) != 0) {
1045         ovs_fatal(0, "%s: value %"PRIu64" does not fit into %d bits",
1046                   full_s, value, load->dst.n_bits);
1047     }
1048
1049     load->subvalue.be64[0] = htonll(0);
1050     load->subvalue.be64[1] = htonll(value);
1051 }
1052 \f
1053 /* nxm_format_reg_move(), nxm_format_reg_load(). */
1054
1055 void
1056 nxm_format_reg_move(const struct ofpact_reg_move *move, struct ds *s)
1057 {
1058     ds_put_format(s, "move:");
1059     mf_format_subfield(&move->src, s);
1060     ds_put_cstr(s, "->");
1061     mf_format_subfield(&move->dst, s);
1062 }
1063
1064 static void
1065 set_field_format(const struct ofpact_reg_load *load, struct ds *s)
1066 {
1067     const struct mf_field *mf = load->dst.field;
1068     union mf_value value;
1069
1070     ovs_assert(load->ofpact.compat == OFPUTIL_OFPAT12_SET_FIELD);
1071     ds_put_format(s, "set_field:");
1072     memset(&value, 0, sizeof value);
1073     bitwise_copy(&load->subvalue, sizeof load->subvalue, 0,
1074                  &value, mf->n_bytes, 0, load->dst.n_bits);
1075     mf_format(mf, &value, NULL, s);
1076     ds_put_format(s, "->%s", mf->name);
1077 }
1078
1079 static void
1080 load_format(const struct ofpact_reg_load *load, struct ds *s)
1081 {
1082     ds_put_cstr(s, "load:");
1083     mf_format_subvalue(&load->subvalue, s);
1084     ds_put_cstr(s, "->");
1085     mf_format_subfield(&load->dst, s);
1086 }
1087
1088 void
1089 nxm_format_reg_load(const struct ofpact_reg_load *load, struct ds *s)
1090 {
1091     if (load->ofpact.compat == OFPUTIL_OFPAT12_SET_FIELD) {
1092         set_field_format(load, s);
1093     } else {
1094         load_format(load, s);
1095     }
1096 }
1097 \f
1098 enum ofperr
1099 nxm_reg_move_from_openflow(const struct nx_action_reg_move *narm,
1100                            struct ofpbuf *ofpacts)
1101 {
1102     struct ofpact_reg_move *move;
1103
1104     move = ofpact_put_REG_MOVE(ofpacts);
1105     move->src.field = mf_from_nxm_header(ntohl(narm->src));
1106     move->src.ofs = ntohs(narm->src_ofs);
1107     move->src.n_bits = ntohs(narm->n_bits);
1108     move->dst.field = mf_from_nxm_header(ntohl(narm->dst));
1109     move->dst.ofs = ntohs(narm->dst_ofs);
1110     move->dst.n_bits = ntohs(narm->n_bits);
1111
1112     return nxm_reg_move_check(move, NULL);
1113 }
1114
1115 enum ofperr
1116 nxm_reg_load_from_openflow(const struct nx_action_reg_load *narl,
1117                            struct ofpbuf *ofpacts)
1118 {
1119     struct ofpact_reg_load *load;
1120
1121     load = ofpact_put_REG_LOAD(ofpacts);
1122     load->dst.field = mf_from_nxm_header(ntohl(narl->dst));
1123     load->dst.ofs = nxm_decode_ofs(narl->ofs_nbits);
1124     load->dst.n_bits = nxm_decode_n_bits(narl->ofs_nbits);
1125     load->subvalue.be64[1] = narl->value;
1126
1127     /* Reject 'narl' if a bit numbered 'n_bits' or higher is set to 1 in
1128      * narl->value. */
1129     if (load->dst.n_bits < 64 &&
1130         ntohll(narl->value) >> load->dst.n_bits) {
1131         return OFPERR_OFPBAC_BAD_ARGUMENT;
1132     }
1133
1134     return nxm_reg_load_check(load, NULL);
1135 }
1136
1137 enum ofperr
1138 nxm_reg_load_from_openflow12_set_field(
1139     const struct ofp12_action_set_field * oasf, struct ofpbuf *ofpacts)
1140 {
1141     uint16_t oasf_len = ntohs(oasf->len);
1142     uint32_t oxm_header = ntohl(oasf->dst);
1143     uint8_t oxm_length = NXM_LENGTH(oxm_header);
1144     struct ofpact_reg_load *load;
1145     const struct mf_field *mf;
1146
1147     /* ofp12_action_set_field is padded to 64 bits by zero */
1148     if (oasf_len != ROUND_UP(sizeof(*oasf) + oxm_length, 8)) {
1149         return OFPERR_OFPBAC_BAD_ARGUMENT;
1150     }
1151     if (!is_all_zeros((const uint8_t *)(oasf) + sizeof *oasf + oxm_length,
1152                       oasf_len - oxm_length - sizeof *oasf)) {
1153         return OFPERR_OFPBAC_BAD_ARGUMENT;
1154     }
1155
1156     if (NXM_HASMASK(oxm_header)) {
1157         return OFPERR_OFPBAC_BAD_ARGUMENT;
1158     }
1159     mf = mf_from_nxm_header(oxm_header);
1160     if (!mf) {
1161         return OFPERR_OFPBAC_BAD_ARGUMENT;
1162     }
1163     load = ofpact_put_REG_LOAD(ofpacts);
1164     ofpact_set_field_init(load, mf, oasf + 1);
1165
1166     return nxm_reg_load_check(load, NULL);
1167 }
1168 \f
1169 enum ofperr
1170 nxm_reg_move_check(const struct ofpact_reg_move *move, const struct flow *flow)
1171 {
1172     enum ofperr error;
1173
1174     error = mf_check_src(&move->src, flow);
1175     if (error) {
1176         return error;
1177     }
1178
1179     return mf_check_dst(&move->dst, NULL);
1180 }
1181
1182 enum ofperr
1183 nxm_reg_load_check(const struct ofpact_reg_load *load, const struct flow *flow)
1184 {
1185     return mf_check_dst(&load->dst, flow);
1186 }
1187 \f
1188 void
1189 nxm_reg_move_to_nxast(const struct ofpact_reg_move *move,
1190                       struct ofpbuf *openflow)
1191 {
1192     struct nx_action_reg_move *narm;
1193
1194     narm = ofputil_put_NXAST_REG_MOVE(openflow);
1195     narm->n_bits = htons(move->dst.n_bits);
1196     narm->src_ofs = htons(move->src.ofs);
1197     narm->dst_ofs = htons(move->dst.ofs);
1198     narm->src = htonl(move->src.field->nxm_header);
1199     narm->dst = htonl(move->dst.field->nxm_header);
1200 }
1201
1202 static void
1203 reg_load_to_nxast(const struct ofpact_reg_load *load, struct ofpbuf *openflow)
1204 {
1205     struct nx_action_reg_load *narl;
1206
1207     narl = ofputil_put_NXAST_REG_LOAD(openflow);
1208     narl->ofs_nbits = nxm_encode_ofs_nbits(load->dst.ofs, load->dst.n_bits);
1209     narl->dst = htonl(load->dst.field->nxm_header);
1210     narl->value = load->subvalue.be64[1];
1211 }
1212
1213 static void
1214 set_field_to_ofast(const struct ofpact_reg_load *load,
1215                       struct ofpbuf *openflow)
1216 {
1217     const struct mf_field *mf = load->dst.field;
1218     uint16_t padded_value_len = ROUND_UP(mf->n_bytes, 8);
1219     struct ofp12_action_set_field *oasf;
1220     char *value;
1221
1222     /* Set field is the only action of variable length (so far),
1223      * so handling the variable length portion is open-coded here */
1224     oasf = ofputil_put_OFPAT12_SET_FIELD(openflow);
1225     oasf->dst = htonl(mf->oxm_header);
1226     oasf->len = htons(ntohs(oasf->len) + padded_value_len);
1227
1228     value = ofpbuf_put_zeros(openflow, padded_value_len);
1229     bitwise_copy(&load->subvalue, sizeof load->subvalue, load->dst.ofs,
1230                  value, mf->n_bytes, load->dst.ofs, load->dst.n_bits);
1231 }
1232
1233 void
1234 nxm_reg_load_to_nxast(const struct ofpact_reg_load *load,
1235                       struct ofpbuf *openflow)
1236 {
1237
1238     if (load->ofpact.compat == OFPUTIL_OFPAT12_SET_FIELD) {
1239         struct ofp_header *oh = (struct ofp_header *)openflow->l2;
1240
1241         switch(oh->version) {
1242         case OFP13_VERSION:
1243         case OFP12_VERSION:
1244             set_field_to_ofast(load, openflow);
1245             break;
1246
1247         case OFP11_VERSION:
1248         case OFP10_VERSION:
1249             if (load->dst.n_bits < 64) {
1250                 reg_load_to_nxast(load, openflow);
1251             } else {
1252                 /* Split into 64bit chunks */
1253                 int chunk, ofs;
1254                 for (ofs = 0; ofs < load->dst.n_bits; ofs += chunk) {
1255                     struct ofpact_reg_load subload = *load;
1256
1257                     chunk = MIN(load->dst.n_bits - ofs, 64);
1258
1259                     subload.dst.field =  load->dst.field;
1260                     subload.dst.ofs = load->dst.ofs + ofs;
1261                     subload.dst.n_bits = chunk;
1262                     bitwise_copy(&load->subvalue, sizeof load->subvalue, ofs,
1263                                  &subload.subvalue, sizeof subload.subvalue, 0,
1264                                  chunk);
1265                     reg_load_to_nxast(&subload, openflow);
1266                 }
1267             }
1268             break;
1269
1270         default:
1271             NOT_REACHED();
1272         }
1273     } else {
1274         reg_load_to_nxast(load, openflow);
1275     }
1276 }
1277 \f
1278 /* nxm_execute_reg_move(), nxm_execute_reg_load(). */
1279
1280 void
1281 nxm_execute_reg_move(const struct ofpact_reg_move *move,
1282                      struct flow *flow)
1283 {
1284     union mf_value src_value;
1285     union mf_value dst_value;
1286
1287     mf_get_value(move->dst.field, flow, &dst_value);
1288     mf_get_value(move->src.field, flow, &src_value);
1289     bitwise_copy(&src_value, move->src.field->n_bytes, move->src.ofs,
1290                  &dst_value, move->dst.field->n_bytes, move->dst.ofs,
1291                  move->src.n_bits);
1292     mf_set_flow_value(move->dst.field, &dst_value, flow);
1293 }
1294
1295 void
1296 nxm_execute_reg_load(const struct ofpact_reg_load *load, struct flow *flow)
1297 {
1298     mf_write_subfield_flow(&load->dst, &load->subvalue, flow);
1299 }
1300
1301 void
1302 nxm_reg_load(const struct mf_subfield *dst, uint64_t src_data,
1303              struct flow *flow)
1304 {
1305     union mf_subvalue src_subvalue;
1306     ovs_be64 src_data_be = htonll(src_data);
1307
1308     bitwise_copy(&src_data_be, sizeof src_data_be, 0,
1309                  &src_subvalue, sizeof src_subvalue, 0,
1310                  sizeof src_data_be * 8);
1311     mf_write_subfield_flow(dst, &src_subvalue, flow);
1312 }
1313 \f
1314 /* nxm_parse_stack_action, works for both push() and pop(). */
1315 void
1316 nxm_parse_stack_action(struct ofpact_stack *stack_action, const char *s)
1317 {
1318     s = mf_parse_subfield(&stack_action->subfield, s);
1319     if (*s != '\0') {
1320         ovs_fatal(0, "%s: trailing garbage following push or pop", s);
1321     }
1322 }
1323
1324 void
1325 nxm_format_stack_push(const struct ofpact_stack *push, struct ds *s)
1326 {
1327     ds_put_cstr(s, "push:");
1328     mf_format_subfield(&push->subfield, s);
1329 }
1330
1331 void
1332 nxm_format_stack_pop(const struct ofpact_stack *pop, struct ds *s)
1333 {
1334     ds_put_cstr(s, "pop:");
1335     mf_format_subfield(&pop->subfield, s);
1336 }
1337
1338 /* Common set for both push and pop actions. */
1339 static void
1340 stack_action_from_openflow__(const struct nx_action_stack *nasp,
1341                                     struct ofpact_stack *stack_action)
1342 {
1343     stack_action->subfield.field = mf_from_nxm_header(ntohl(nasp->field));
1344     stack_action->subfield.ofs = ntohs(nasp->offset);
1345     stack_action->subfield.n_bits = ntohs(nasp->n_bits);
1346 }
1347
1348 static void
1349 nxm_stack_to_nxast__(const struct ofpact_stack *stack_action,
1350                             struct nx_action_stack *nasp)
1351 {
1352     nasp->offset = htons(stack_action->subfield.ofs);
1353     nasp->n_bits = htons(stack_action->subfield.n_bits);
1354     nasp->field = htonl(stack_action->subfield.field->nxm_header);
1355 }
1356
1357 enum ofperr
1358 nxm_stack_push_from_openflow(const struct nx_action_stack *nasp,
1359                              struct ofpbuf *ofpacts)
1360 {
1361     struct ofpact_stack *push;
1362
1363     push = ofpact_put_STACK_PUSH(ofpacts);
1364     stack_action_from_openflow__(nasp, push);
1365
1366     return nxm_stack_push_check(push, NULL);
1367 }
1368
1369 enum ofperr
1370 nxm_stack_pop_from_openflow(const struct nx_action_stack *nasp,
1371                              struct ofpbuf *ofpacts)
1372 {
1373     struct ofpact_stack *pop;
1374
1375     pop = ofpact_put_STACK_POP(ofpacts);
1376     stack_action_from_openflow__(nasp, pop);
1377
1378     return nxm_stack_pop_check(pop, NULL);
1379 }
1380
1381 enum ofperr
1382 nxm_stack_push_check(const struct ofpact_stack *push,
1383                      const struct flow *flow)
1384 {
1385     return mf_check_src(&push->subfield, flow);
1386 }
1387
1388 enum ofperr
1389 nxm_stack_pop_check(const struct ofpact_stack *pop,
1390                     const struct flow *flow)
1391 {
1392     return mf_check_dst(&pop->subfield, flow);
1393 }
1394
1395 void
1396 nxm_stack_push_to_nxast(const struct ofpact_stack *stack,
1397                         struct ofpbuf *openflow)
1398 {
1399     nxm_stack_to_nxast__(stack, ofputil_put_NXAST_STACK_PUSH(openflow));
1400 }
1401
1402 void
1403 nxm_stack_pop_to_nxast(const struct ofpact_stack *stack,
1404                        struct ofpbuf *openflow)
1405 {
1406     nxm_stack_to_nxast__(stack, ofputil_put_NXAST_STACK_POP(openflow));
1407 }
1408
1409 /* nxm_execute_stack_push(), nxm_execute_stack_pop(). */
1410 static void
1411 nx_stack_push(struct ofpbuf *stack, union mf_subvalue *v)
1412 {
1413     ofpbuf_put(stack, v, sizeof *v);
1414 }
1415
1416 static union mf_subvalue *
1417 nx_stack_pop(struct ofpbuf *stack)
1418 {
1419     union mf_subvalue *v = NULL;
1420
1421     if (stack->size) {
1422         stack->size -= sizeof *v;
1423         v = (union mf_subvalue *) ofpbuf_tail(stack);
1424     }
1425
1426     return v;
1427 }
1428
1429 void
1430 nxm_execute_stack_push(const struct ofpact_stack *push,
1431                        const struct flow *flow, struct ofpbuf *stack)
1432 {
1433     union mf_subvalue dst_value;
1434
1435     mf_read_subfield(&push->subfield, flow, &dst_value);
1436     nx_stack_push(stack, &dst_value);
1437 }
1438
1439 void
1440 nxm_execute_stack_pop(const struct ofpact_stack *pop,
1441                       struct flow *flow, struct ofpbuf *stack)
1442 {
1443     union mf_subvalue *src_value;
1444
1445     src_value = nx_stack_pop(stack);
1446
1447     /* Only pop if stack is not empty. Otherwise, give warning. */
1448     if (src_value) {
1449         mf_write_subfield_flow(&pop->subfield, src_value, flow);
1450     } else {
1451         if (!VLOG_DROP_WARN(&rl)) {
1452             char *flow_str = flow_to_string(flow);
1453             VLOG_WARN_RL(&rl, "Failed to pop from an empty stack. On flow \n"
1454                            " %s", flow_str);
1455             free(flow_str);
1456         }
1457     }
1458 }