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