lib/nx-match.c

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