lib/nx-match.c

   1 /*
   2  * Copyright (c) 2010, 2011, 2012 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18
  19 #include "nx-match.h"
  20
  21 #include <netinet/icmp6.h>
  22
  23 #include "classifier.h"
  24 #include "dynamic-string.h"
  25 #include "meta-flow.h"
  26 #include "ofp-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 static enum ofperr
  94 nx_pull_raw(const uint8_t *p, unsigned int match_len, bool strict,
  95             uint16_t priority, struct cls_rule *rule,
  96             ovs_be64 *cookie, ovs_be64 *cookie_mask)
  97 {
  98     uint32_t header;
  99
 100     assert((cookie != NULL) == (cookie_mask != NULL));
 101
 102     cls_rule_init_catchall(rule, priority);
 103     if (cookie) {
 104         *cookie = *cookie_mask = htonll(0);
 105     }
 106     if (!match_len) {
 107         return 0;
 108     }
 109
 110     for (;
 111          (header = nx_entry_ok(p, match_len)) != 0;
 112          p += 4 + NXM_LENGTH(header), match_len -= 4 + NXM_LENGTH(header)) {
 113         const struct mf_field *mf;
 114         enum ofperr error;
 115
 116         mf = mf_from_nxm_header(header);
 117         if (!mf) {
 118             if (strict) {
 119                 error = OFPERR_OFPBMC_BAD_FIELD;
 120             } else {
 121                 continue;
 122             }
 123         } else if (!mf_are_prereqs_ok(mf, &rule->flow)) {
 124             error = OFPERR_OFPBMC_BAD_PREREQ;
 125         } else if (!mf_is_all_wild(mf, &rule->wc)) {
 126             error = OFPERR_OFPBMC_DUP_FIELD;
 127         } else if (header != OXM_OF_IN_PORT) {
 128             unsigned int width = mf->n_bytes;
 129             union mf_value value;
 130
 131             memcpy(&value, p + 4, width);
 132             if (!mf_is_value_valid(mf, &value)) {
 133                 error = OFPERR_OFPBMC_BAD_VALUE;
 134             } else if (!NXM_HASMASK(header)) {
 135                 error = 0;
 136                 mf_set_value(mf, &value, rule);
 137             } else {
 138                 union mf_value mask;
 139
 140                 memcpy(&mask, p + 4 + width, width);
 141                 if (!mf_is_mask_valid(mf, &mask)) {
 142                     error = OFPERR_OFPBMC_BAD_MASK;
 143                 } else {
 144                     error = 0;
 145                     mf_set(mf, &value, &mask, rule);
 146                 }
 147             }
 148         } else {
 149             /* Special case for 32bit ports when using OXM,
 150              * ports are 16 bits wide otherwise. */
 151             ovs_be32 port_of11;
 152             uint16_t port;
 153
 154             memcpy(&port_of11, p + 4, sizeof port_of11);
 155             error = ofputil_port_from_ofp11(port_of11, &port);
 156             if (!error) {
 157                 cls_rule_set_in_port(rule, port);
 158             }
 159         }
 160
 161         /* Check if the match is for a cookie rather than a classifier rule. */
 162         if ((header == NXM_NX_COOKIE || header == NXM_NX_COOKIE_W) && cookie) {
 163             if (*cookie_mask) {
 164                 error = OFPERR_OFPBMC_DUP_FIELD;
 165             } else {
 166                 unsigned int width = sizeof *cookie;
 167
 168                 memcpy(cookie, p + 4, width);
 169                 if (NXM_HASMASK(header)) {
 170                     memcpy(cookie_mask, p + 4 + width, width);
 171                 } else {
 172                     *cookie_mask = htonll(UINT64_MAX);
 173                 }
 174                 error = 0;
 175             }
 176         }
 177
 178         if (error) {
 179             VLOG_DBG_RL(&rl, "bad nxm_entry %#08"PRIx32" (vendor=%"PRIu32", "
 180                         "field=%"PRIu32", hasmask=%"PRIu32", len=%"PRIu32"), "
 181                         "(%s)", header,
 182                         NXM_VENDOR(header), NXM_FIELD(header),
 183                         NXM_HASMASK(header), NXM_LENGTH(header),
 184                         ofperr_to_string(error));
 185             return error;
 186         }
 187     }
 188
 189     return match_len ? OFPERR_OFPBMC_BAD_LEN : 0;
 190 }
 191
 192 static enum ofperr
 193 nx_pull_match__(struct ofpbuf *b, unsigned int match_len, bool strict,
 194                 uint16_t priority, struct cls_rule *rule,
 195                 ovs_be64 *cookie, ovs_be64 *cookie_mask)
 196 {
 197     uint8_t *p = NULL;
 198
 199     if (match_len) {
 200         p = ofpbuf_try_pull(b, ROUND_UP(match_len, 8));
 201         if (!p) {
 202             VLOG_DBG_RL(&rl, "nx_match length %u, rounded up to a "
 203                         "multiple of 8, is longer than space in message (max "
 204                         "length %zu)", match_len, b->size);
 205             return OFPERR_OFPBMC_BAD_LEN;
 206         }
 207     }
 208
 209     return nx_pull_raw(p, match_len, strict, priority, rule,
 210                        cookie, cookie_mask);
 211 }
 212
 213 /* Parses the nx_match formatted match description in 'b' with length
 214  * 'match_len'.  The results are stored in 'rule', which is initialized with
 215  * 'priority'.  If 'cookie' and 'cookie_mask' contain valid pointers, then the
 216  * cookie and mask will be stored in them if a "NXM_NX_COOKIE*" match is
 217  * defined.  Otherwise, 0 is stored in both.
 218  *
 219  * Fails with an error when encountering unknown NXM headers.
 220  *
 221  * Returns 0 if successful, otherwise an OpenFlow error code. */
 222 enum ofperr
 223 nx_pull_match(struct ofpbuf *b, unsigned int match_len,
 224               uint16_t priority, struct cls_rule *rule,
 225               ovs_be64 *cookie, ovs_be64 *cookie_mask)
 226 {
 227     return nx_pull_match__(b, match_len, true, priority, rule, cookie,
 228                            cookie_mask);
 229 }
 230
 231 /* Behaves the same as nx_pull_match() with one exception.  Skips over unknown
 232  * NXM headers instead of failing with an error when they are encountered. */
 233 enum ofperr
 234 nx_pull_match_loose(struct ofpbuf *b, unsigned int match_len,
 235                     uint16_t priority, struct cls_rule *rule,
 236                     ovs_be64 *cookie, ovs_be64 *cookie_mask)
 237 {
 238     return nx_pull_match__(b, match_len, false, priority, rule, cookie,
 239                            cookie_mask);
 240 }
 241
 242 static enum ofperr
 243 oxm_pull_match__(struct ofpbuf *b, bool strict,
 244                  uint16_t priority, struct cls_rule *rule)
 245 {
 246     struct ofp11_match_header *omh = b->data;
 247     uint8_t *p;
 248     uint16_t match_len;
 249
 250     if (b->size < sizeof *omh) {
 251         return OFPERR_OFPBMC_BAD_LEN;
 252     }
 253
 254     match_len = ntohs(omh->length);
 255     if (match_len < sizeof *omh) {
 256         return OFPERR_OFPBMC_BAD_LEN;
 257     }
 258
 259     if (omh->type != htons(OFPMT_OXM)) {
 260         return OFPERR_OFPBMC_BAD_TYPE;
 261     }
 262
 263     p = ofpbuf_try_pull(b, ROUND_UP(match_len, 8));
 264     if (!p) {
 265         VLOG_DBG_RL(&rl, "oxm length %u, rounded up to a "
 266                     "multiple of 8, is longer than space in message (max "
 267                     "length %zu)", match_len, b->size);
 268         return OFPERR_OFPBMC_BAD_LEN;
 269     }
 270
 271     return nx_pull_raw(p + sizeof *omh, match_len - sizeof *omh,
 272                        strict, priority, rule, NULL, NULL);
 273 }
 274
 275 /* Parses the oxm formatted match description preceeded by a struct
 276  * ofp11_match in 'b' with length 'match_len'.  The results are stored in
 277  * 'rule', which is initialized with 'priority'.
 278  *
 279  * Fails with an error when encountering unknown OXM headers.
 280  *
 281  * Returns 0 if successful, otherwise an OpenFlow error code. */
 282 enum ofperr
 283 oxm_pull_match(struct ofpbuf *b, uint16_t priority, struct cls_rule *rule)
 284 {
 285     return oxm_pull_match__(b, true, priority, rule);
 286 }
 287
 288 /* Behaves the same as oxm_pull_match() with one exception.  Skips over unknown
 289  * PXM headers instead of failing with an error when they are encountered. */
 290 enum ofperr
 291 oxm_pull_match_loose(struct ofpbuf *b, uint16_t priority,
 292                      struct cls_rule *rule)
 293 {
 294     return oxm_pull_match__(b, false, priority, rule);
 295 }
 296 \f
 297 /* nx_put_match() and helpers.
 298  *
 299  * 'put' functions whose names end in 'w' add a wildcarded field.
 300  * 'put' functions whose names end in 'm' add a field that might be wildcarded.
 301  * Other 'put' functions add exact-match fields.
 302  */
 303
 304 static void
 305 nxm_put_header(struct ofpbuf *b, uint32_t header)
 306 {
 307     ovs_be32 n_header = htonl(header);
 308     ofpbuf_put(b, &n_header, sizeof n_header);
 309 }
 310
 311 static void
 312 nxm_put_8(struct ofpbuf *b, uint32_t header, uint8_t value)
 313 {
 314     nxm_put_header(b, header);
 315     ofpbuf_put(b, &value, sizeof value);
 316 }
 317
 318 static void
 319 nxm_put_8m(struct ofpbuf *b, uint32_t header, uint8_t value, uint8_t mask)
 320 {
 321     switch (mask) {
 322     case 0:
 323         break;
 324
 325     case UINT8_MAX:
 326         nxm_put_8(b, header, value);
 327         break;
 328
 329     default:
 330         nxm_put_header(b, NXM_MAKE_WILD_HEADER(header));
 331         ofpbuf_put(b, &value, sizeof value);
 332         ofpbuf_put(b, &mask, sizeof mask);
 333     }
 334 }
 335
 336 static void
 337 nxm_put_16(struct ofpbuf *b, uint32_t header, ovs_be16 value)
 338 {
 339     nxm_put_header(b, header);
 340     ofpbuf_put(b, &value, sizeof value);
 341 }
 342
 343 static void
 344 nxm_put_16w(struct ofpbuf *b, uint32_t header, ovs_be16 value, ovs_be16 mask)
 345 {
 346     nxm_put_header(b, header);
 347     ofpbuf_put(b, &value, sizeof value);
 348     ofpbuf_put(b, &mask, sizeof mask);
 349 }
 350
 351 static void
 352 nxm_put_16m(struct ofpbuf *b, uint32_t header, ovs_be16 value, ovs_be16 mask)
 353 {
 354     switch (mask) {
 355     case 0:
 356         break;
 357
 358     case CONSTANT_HTONS(UINT16_MAX):
 359         nxm_put_16(b, header, value);
 360         break;
 361
 362     default:
 363         nxm_put_16w(b, NXM_MAKE_WILD_HEADER(header), value, mask);
 364         break;
 365     }
 366 }
 367
 368 static void
 369 nxm_put_32(struct ofpbuf *b, uint32_t header, ovs_be32 value)
 370 {
 371     nxm_put_header(b, header);
 372     ofpbuf_put(b, &value, sizeof value);
 373 }
 374
 375 static void
 376 nxm_put_32w(struct ofpbuf *b, uint32_t header, ovs_be32 value, ovs_be32 mask)
 377 {
 378     nxm_put_header(b, header);
 379     ofpbuf_put(b, &value, sizeof value);
 380     ofpbuf_put(b, &mask, sizeof mask);
 381 }
 382
 383 static void
 384 nxm_put_32m(struct ofpbuf *b, uint32_t header, ovs_be32 value, ovs_be32 mask)
 385 {
 386     switch (mask) {
 387     case 0:
 388         break;
 389
 390     case CONSTANT_HTONL(UINT32_MAX):
 391         nxm_put_32(b, header, value);
 392         break;
 393
 394     default:
 395         nxm_put_32w(b, NXM_MAKE_WILD_HEADER(header), value, mask);
 396         break;
 397     }
 398 }
 399
 400 static void
 401 nxm_put_64(struct ofpbuf *b, uint32_t header, ovs_be64 value)
 402 {
 403     nxm_put_header(b, header);
 404     ofpbuf_put(b, &value, sizeof value);
 405 }
 406
 407 static void
 408 nxm_put_64w(struct ofpbuf *b, uint32_t header, ovs_be64 value, ovs_be64 mask)
 409 {
 410     nxm_put_header(b, header);
 411     ofpbuf_put(b, &value, sizeof value);
 412     ofpbuf_put(b, &mask, sizeof mask);
 413 }
 414
 415 static void
 416 nxm_put_64m(struct ofpbuf *b, uint32_t header, ovs_be64 value, ovs_be64 mask)
 417 {
 418     switch (mask) {
 419     case 0:
 420         break;
 421
 422     case CONSTANT_HTONLL(UINT64_MAX):
 423         nxm_put_64(b, header, value);
 424         break;
 425
 426     default:
 427         nxm_put_64w(b, NXM_MAKE_WILD_HEADER(header), value, mask);
 428         break;
 429     }
 430 }
 431
 432 static void
 433 nxm_put_eth(struct ofpbuf *b, uint32_t header,
 434             const uint8_t value[ETH_ADDR_LEN])
 435 {
 436     nxm_put_header(b, header);
 437     ofpbuf_put(b, value, ETH_ADDR_LEN);
 438 }
 439
 440 static void
 441 nxm_put_eth_masked(struct ofpbuf *b, uint32_t header,
 442                    const uint8_t value[ETH_ADDR_LEN],
 443                    const uint8_t mask[ETH_ADDR_LEN])
 444 {
 445     if (!eth_addr_is_zero(mask)) {
 446         if (eth_mask_is_exact(mask)) {
 447             nxm_put_eth(b, header, value);
 448         } else {
 449             nxm_put_header(b, NXM_MAKE_WILD_HEADER(header));
 450             ofpbuf_put(b, value, ETH_ADDR_LEN);
 451             ofpbuf_put(b, mask, ETH_ADDR_LEN);
 452         }
 453     }
 454 }
 455
 456 static void
 457 nxm_put_ipv6(struct ofpbuf *b, uint32_t header,
 458              const struct in6_addr *value, const struct in6_addr *mask)
 459 {
 460     if (ipv6_mask_is_any(mask)) {
 461         return;
 462     } else if (ipv6_mask_is_exact(mask)) {
 463         nxm_put_header(b, header);
 464         ofpbuf_put(b, value, sizeof *value);
 465     } else {
 466         nxm_put_header(b, NXM_MAKE_WILD_HEADER(header));
 467         ofpbuf_put(b, value, sizeof *value);
 468         ofpbuf_put(b, mask, sizeof *mask);
 469     }
 470 }
 471
 472 static void
 473 nxm_put_frag(struct ofpbuf *b, const struct cls_rule *cr)
 474 {
 475     uint8_t nw_frag = cr->flow.nw_frag;
 476     uint8_t nw_frag_mask = cr->wc.masks.nw_frag;
 477
 478     switch (nw_frag_mask) {
 479     case 0:
 480         break;
 481
 482     case FLOW_NW_FRAG_MASK:
 483         nxm_put_8(b, NXM_NX_IP_FRAG, nw_frag);
 484         break;
 485
 486     default:
 487         nxm_put_8m(b, NXM_NX_IP_FRAG, nw_frag,
 488                    nw_frag_mask & FLOW_NW_FRAG_MASK);
 489         break;
 490     }
 491 }
 492
 493 static void
 494 nxm_put_ip(struct ofpbuf *b, const struct cls_rule *cr,
 495            uint8_t icmp_proto, uint32_t icmp_type, uint32_t icmp_code,
 496            bool oxm)
 497 {
 498     const struct flow *flow = &cr->flow;
 499
 500     nxm_put_frag(b, cr);
 501
 502     if (cr->wc.masks.nw_tos & IP_DSCP_MASK) {
 503         nxm_put_8(b, oxm ? OXM_OF_IP_DSCP : NXM_OF_IP_TOS,
 504                   flow->nw_tos & IP_DSCP_MASK);
 505     }
 506
 507     if (cr->wc.masks.nw_tos & IP_ECN_MASK) {
 508         nxm_put_8(b, oxm ? OXM_OF_IP_ECN : NXM_NX_IP_ECN,
 509                   flow->nw_tos & IP_ECN_MASK);
 510     }
 511
 512     if (!oxm && cr->wc.masks.nw_ttl) {
 513         nxm_put_8(b, NXM_NX_IP_TTL, flow->nw_ttl);
 514     }
 515
 516     if (cr->wc.masks.nw_proto) {
 517         nxm_put_8(b, oxm ? OXM_OF_IP_PROTO : NXM_OF_IP_PROTO, flow->nw_proto);
 518
 519         if (flow->nw_proto == IPPROTO_TCP) {
 520             nxm_put_16m(b, oxm ? OXM_OF_TCP_SRC : NXM_OF_TCP_SRC,
 521                         flow->tp_src, cr->wc.masks.tp_src);
 522             nxm_put_16m(b, oxm ? OXM_OF_TCP_DST : NXM_OF_TCP_DST,
 523                         flow->tp_dst, cr->wc.masks.tp_dst);
 524         } else if (flow->nw_proto == IPPROTO_UDP) {
 525             nxm_put_16m(b, oxm ? OXM_OF_UDP_SRC : NXM_OF_UDP_SRC,
 526                         flow->tp_src, cr->wc.masks.tp_src);
 527             nxm_put_16m(b, oxm ? OXM_OF_UDP_DST : NXM_OF_UDP_DST,
 528                         flow->tp_dst, cr->wc.masks.tp_dst);
 529         } else if (flow->nw_proto == icmp_proto) {
 530             if (cr->wc.masks.tp_src) {
 531                 nxm_put_8(b, icmp_type, ntohs(flow->tp_src));
 532             }
 533             if (cr->wc.masks.tp_dst) {
 534                 nxm_put_8(b, icmp_code, ntohs(flow->tp_dst));
 535             }
 536         }
 537     }
 538 }
 539
 540 /* Appends to 'b' the nx_match format that expresses 'cr' (except for
 541  * 'cr->priority', because priority is not part of nx_match).  For Flow Mod and
 542  * Flow Stats Requests messages, a 'cookie' and 'cookie_mask' may be supplied.
 543  * Otherwise, 'cookie_mask' should be zero.
 544  *
 545  * This function can cause 'b''s data to be reallocated.
 546  *
 547  * Returns the number of bytes appended to 'b', excluding padding.
 548  *
 549  * If 'cr' is a catch-all rule that matches every packet, then this function
 550  * appends nothing to 'b' and returns 0. */
 551 static int
 552 nx_put_raw(struct ofpbuf *b, bool oxm, const struct cls_rule *cr,
 553            ovs_be64 cookie, ovs_be64 cookie_mask)
 554 {
 555     const struct flow *flow = &cr->flow;
 556     const size_t start_len = b->size;
 557     int match_len;
 558     int i;
 559
 560     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 17);
 561
 562     /* Metadata. */
 563     if (cr->wc.masks.in_port) {
 564         uint16_t in_port = flow->in_port;
 565         if (oxm) {
 566             nxm_put_32(b, OXM_OF_IN_PORT, ofputil_port_to_ofp11(in_port));
 567         } else {
 568             nxm_put_16(b, NXM_OF_IN_PORT, htons(in_port));
 569         }
 570     }
 571
 572     /* Ethernet. */
 573     nxm_put_eth_masked(b, oxm ? OXM_OF_ETH_SRC : NXM_OF_ETH_SRC,
 574                        flow->dl_src, cr->wc.masks.dl_src);
 575     nxm_put_eth_masked(b, oxm ? OXM_OF_ETH_DST : NXM_OF_ETH_DST,
 576                        flow->dl_dst, cr->wc.masks.dl_dst);
 577     nxm_put_16m(b, oxm ? OXM_OF_ETH_TYPE : NXM_OF_ETH_TYPE,
 578                 ofputil_dl_type_to_openflow(flow->dl_type),
 579                 cr->wc.masks.dl_type);
 580
 581     /* 802.1Q. */
 582     if (oxm) {
 583         ovs_be16 VID_CFI_MASK = htons(VLAN_VID_MASK | VLAN_CFI);
 584         ovs_be16 vid = flow->vlan_tci & VID_CFI_MASK;
 585         ovs_be16 mask = cr->wc.masks.vlan_tci & VID_CFI_MASK;
 586
 587         if (mask == htons(VLAN_VID_MASK | VLAN_CFI)) {
 588             nxm_put_16(b, OXM_OF_VLAN_VID, vid);
 589         } else if (mask) {
 590             nxm_put_16m(b, OXM_OF_VLAN_VID, vid, mask);
 591         }
 592
 593         if (vid && vlan_tci_to_pcp(cr->wc.masks.vlan_tci)) {
 594             nxm_put_8(b, OXM_OF_VLAN_PCP, vlan_tci_to_pcp(flow->vlan_tci));
 595         }
 596
 597     } else {
 598         nxm_put_16m(b, NXM_OF_VLAN_TCI, flow->vlan_tci, cr->wc.masks.vlan_tci);
 599     }
 600
 601     /* L3. */
 602     if (flow->dl_type == htons(ETH_TYPE_IP)) {
 603         /* IP. */
 604         nxm_put_32m(b, oxm ? OXM_OF_IPV4_SRC : NXM_OF_IP_SRC,
 605                     flow->nw_src, cr->wc.masks.nw_src);
 606         nxm_put_32m(b, oxm ? OXM_OF_IPV4_DST : NXM_OF_IP_DST,
 607                     flow->nw_dst, cr->wc.masks.nw_dst);
 608         nxm_put_ip(b, cr, IPPROTO_ICMP,
 609                    oxm ? OXM_OF_ICMPV4_TYPE : NXM_OF_ICMP_TYPE,
 610                    oxm ? OXM_OF_ICMPV4_CODE : NXM_OF_ICMP_CODE, oxm);
 611     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
 612         /* IPv6. */
 613         nxm_put_ipv6(b, oxm ? OXM_OF_IPV6_SRC : NXM_NX_IPV6_SRC,
 614                      &flow->ipv6_src, &cr->wc.masks.ipv6_src);
 615         nxm_put_ipv6(b, oxm ? OXM_OF_IPV6_DST : NXM_NX_IPV6_DST,
 616                      &flow->ipv6_dst, &cr->wc.masks.ipv6_dst);
 617         nxm_put_ip(b, cr, IPPROTO_ICMPV6,
 618                    oxm ? OXM_OF_ICMPV6_TYPE : NXM_NX_ICMPV6_TYPE,
 619                    oxm ? OXM_OF_ICMPV6_CODE : NXM_NX_ICMPV6_CODE, oxm);
 620
 621         nxm_put_32m(b, oxm ? OXM_OF_IPV6_FLABEL : NXM_NX_IPV6_LABEL,
 622                     flow->ipv6_label, cr->wc.masks.ipv6_label);
 623
 624         if (flow->nw_proto == IPPROTO_ICMPV6
 625             && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
 626                 flow->tp_src == htons(ND_NEIGHBOR_ADVERT))) {
 627             nxm_put_ipv6(b, oxm ? OXM_OF_IPV6_ND_TARGET : NXM_NX_ND_TARGET,
 628                          &flow->nd_target, &cr->wc.masks.nd_target);
 629             if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
 630                 nxm_put_eth_masked(b, oxm ? OXM_OF_IPV6_ND_SLL : NXM_NX_ND_SLL,
 631                                    flow->arp_sha, cr->wc.masks.arp_sha);
 632             }
 633             if (flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
 634                 nxm_put_eth_masked(b, oxm ? OXM_OF_IPV6_ND_TLL : NXM_NX_ND_TLL,
 635                                    flow->arp_tha, cr->wc.masks.arp_tha);
 636             }
 637         }
 638     } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
 639         /* ARP. */
 640         if (cr->wc.masks.nw_proto) {
 641             nxm_put_16(b, oxm ? OXM_OF_ARP_OP : NXM_OF_ARP_OP,
 642                        htons(flow->nw_proto));
 643         }
 644         nxm_put_32m(b, oxm ? OXM_OF_ARP_SPA : NXM_OF_ARP_SPA,
 645                     flow->nw_src, cr->wc.masks.nw_src);
 646         nxm_put_32m(b, oxm ? OXM_OF_ARP_TPA : NXM_OF_ARP_TPA,
 647                     flow->nw_dst, cr->wc.masks.nw_dst);
 648         nxm_put_eth_masked(b, oxm ? OXM_OF_ARP_SHA : NXM_NX_ARP_SHA,
 649                            flow->arp_sha, cr->wc.masks.arp_sha);
 650         nxm_put_eth_masked(b, oxm ? OXM_OF_ARP_THA : NXM_NX_ARP_THA,
 651                            flow->arp_tha, cr->wc.masks.arp_tha);
 652     }
 653
 654     /* Tunnel ID. */
 655     nxm_put_64m(b, NXM_NX_TUN_ID, flow->tun_id, cr->wc.masks.tun_id);
 656
 657     /* Registers. */
 658     for (i = 0; i < FLOW_N_REGS; i++) {
 659         nxm_put_32m(b, NXM_NX_REG(i),
 660                     htonl(flow->regs[i]), htonl(cr->wc.masks.regs[i]));
 661     }
 662
 663     /* OpenFlow 1.1+ Metadata. */
 664     nxm_put_64m(b, OXM_OF_METADATA, flow->metadata, cr->wc.masks.metadata);
 665
 666     /* Cookie. */
 667     nxm_put_64m(b, NXM_NX_COOKIE, cookie, cookie_mask);
 668
 669     match_len = b->size - start_len;
 670     return match_len;
 671 }
 672
 673 /* Appends to 'b' the nx_match format that expresses 'cr' (except for
 674  * 'cr->priority', because priority is not part of nx_match), plus enough zero
 675  * bytes to pad the nx_match out to a multiple of 8.  For Flow Mod and Flow
 676  * Stats Requests messages, a 'cookie' and 'cookie_mask' may be supplied.
 677  * Otherwise, 'cookie_mask' should be zero.
 678  *
 679  * This function can cause 'b''s data to be reallocated.
 680  *
 681  * Returns the number of bytes appended to 'b', excluding padding.  The return
 682  * value can be zero if it appended nothing at all to 'b' (which happens if
 683  * 'cr' is a catch-all rule that matches every packet). */
 684 int
 685 nx_put_match(struct ofpbuf *b, const struct cls_rule *cr,
 686              ovs_be64 cookie, ovs_be64 cookie_mask)
 687 {
 688     int match_len = nx_put_raw(b, false, cr, cookie, cookie_mask);
 689
 690     ofpbuf_put_zeros(b, ROUND_UP(match_len, 8) - match_len);
 691     return match_len;
 692 }
 693
 694
 695 /* Appends to 'b' an struct ofp11_match_header followed by the oxm format that
 696  * expresses 'cr' (except for 'cr->priority', because priority is not part of
 697  * nx_match), plus enough zero bytes to pad the data appended out to a multiple
 698  * of 8.
 699  *
 700  * This function can cause 'b''s data to be reallocated.
 701  *
 702  * Returns the number of bytes appended to 'b', excluding the padding.  Never
 703  * returns zero. */
 704 int
 705 oxm_put_match(struct ofpbuf *b, const struct cls_rule *cr)
 706 {
 707     int match_len;
 708     struct ofp11_match_header *omh;
 709     size_t start_len = b->size;
 710     ovs_be64 cookie = htonll(0), cookie_mask = htonll(0);
 711
 712     ofpbuf_put_uninit(b, sizeof *omh);
 713     match_len = nx_put_raw(b, true, cr, cookie, cookie_mask) + sizeof *omh;
 714     ofpbuf_put_zeros(b, ROUND_UP(match_len, 8) - match_len);
 715
 716     omh = (struct ofp11_match_header *)((char *)b->data + start_len);
 717     omh->type = htons(OFPMT_OXM);
 718     omh->length = htons(match_len);
 719
 720     return match_len;
 721 }
 722 \f
 723 /* nx_match_to_string() and helpers. */
 724
 725 static void format_nxm_field_name(struct ds *, uint32_t header);
 726
 727 char *
 728 nx_match_to_string(const uint8_t *p, unsigned int match_len)
 729 {
 730     uint32_t header;
 731     struct ds s;
 732
 733     if (!match_len) {
 734         return xstrdup("<any>");
 735     }
 736
 737     ds_init(&s);
 738     while ((header = nx_entry_ok(p, match_len)) != 0) {
 739         unsigned int length = NXM_LENGTH(header);
 740         unsigned int value_len = nxm_field_bytes(header);
 741         const uint8_t *value = p + 4;
 742         const uint8_t *mask = value + value_len;
 743         unsigned int i;
 744
 745         if (s.length) {
 746             ds_put_cstr(&s, ", ");
 747         }
 748
 749         format_nxm_field_name(&s, header);
 750         ds_put_char(&s, '(');
 751
 752         for (i = 0; i < value_len; i++) {
 753             ds_put_format(&s, "%02x", value[i]);
 754         }
 755         if (NXM_HASMASK(header)) {
 756             ds_put_char(&s, '/');
 757             for (i = 0; i < value_len; i++) {
 758                 ds_put_format(&s, "%02x", mask[i]);
 759             }
 760         }
 761         ds_put_char(&s, ')');
 762
 763         p += 4 + length;
 764         match_len -= 4 + length;
 765     }
 766
 767     if (match_len) {
 768         if (s.length) {
 769             ds_put_cstr(&s, ", ");
 770         }
 771
 772         ds_put_format(&s, "<%u invalid bytes>", match_len);
 773     }
 774
 775     return ds_steal_cstr(&s);
 776 }
 777
 778 char *
 779 oxm_match_to_string(const uint8_t *p, unsigned int match_len)
 780 {
 781     const struct ofp11_match_header *omh = (struct ofp11_match_header *)p;
 782     uint16_t match_len_;
 783     struct ds s;
 784
 785     ds_init(&s);
 786
 787     if (match_len < sizeof *omh) {
 788         ds_put_format(&s, "<match too short: %u>", match_len);
 789         goto err;
 790     }
 791
 792     if (omh->type != htons(OFPMT_OXM)) {
 793         ds_put_format(&s, "<bad match type field: %u>", ntohs(omh->type));
 794         goto err;
 795     }
 796
 797     match_len_ = ntohs(omh->length);
 798     if (match_len_ < sizeof *omh) {
 799         ds_put_format(&s, "<match length field too short: %u>", match_len_);
 800         goto err;
 801     }
 802
 803     if (match_len_ != match_len) {
 804         ds_put_format(&s, "<match length field incorrect: %u != %u>",
 805                       match_len_, match_len);
 806         goto err;
 807     }
 808
 809     return nx_match_to_string(p + sizeof *omh, match_len - sizeof *omh);
 810
 811 err:
 812     return ds_steal_cstr(&s);
 813 }
 814
 815 static void
 816 format_nxm_field_name(struct ds *s, uint32_t header)
 817 {
 818     const struct mf_field *mf = mf_from_nxm_header(header);
 819     if (mf) {
 820         ds_put_cstr(s, IS_OXM_HEADER(header) ? mf->oxm_name : mf->nxm_name);
 821         if (NXM_HASMASK(header)) {
 822             ds_put_cstr(s, "_W");
 823         }
 824     } else if (header == NXM_NX_COOKIE) {
 825         ds_put_cstr(s, "NXM_NX_COOKIE");
 826     } else if (header == NXM_NX_COOKIE_W) {
 827         ds_put_cstr(s, "NXM_NX_COOKIE_W");
 828     } else {
 829         ds_put_format(s, "%d:%d", NXM_VENDOR(header), NXM_FIELD(header));
 830     }
 831 }
 832
 833 static uint32_t
 834 parse_nxm_field_name(const char *name, int name_len)
 835 {
 836     bool wild;
 837     int i;
 838
 839     /* Check whether it's a field name. */
 840     wild = name_len > 2 && !memcmp(&name[name_len - 2], "_W", 2);
 841     if (wild) {
 842         name_len -= 2;
 843     }
 844
 845     for (i = 0; i < MFF_N_IDS; i++) {
 846         const struct mf_field *mf = mf_from_id(i);
 847         uint32_t header;
 848
 849         if (mf->nxm_name &&
 850             !strncmp(mf->nxm_name, name, name_len) &&
 851             mf->nxm_name[name_len] == '\0') {
 852             header = mf->nxm_header;
 853         } else if (mf->oxm_name &&
 854                    !strncmp(mf->oxm_name, name, name_len) &&
 855                    mf->oxm_name[name_len] == '\0') {
 856             header = mf->oxm_header;
 857         } else {
 858             continue;
 859         }
 860
 861         if (!wild) {
 862             return header;
 863         } else if (mf->maskable != MFM_NONE) {
 864             return NXM_MAKE_WILD_HEADER(header);
 865         }
 866     }
 867
 868     if (!strncmp("NXM_NX_COOKIE", name, name_len) &&
 869         (name_len == strlen("NXM_NX_COOKIE"))) {
 870         if (!wild) {
 871             return NXM_NX_COOKIE;
 872         } else {
 873             return NXM_NX_COOKIE_W;
 874         }
 875     }
 876
 877     /* Check whether it's a 32-bit field header value as hex.
 878      * (This isn't ordinarily useful except for testing error behavior.) */
 879     if (name_len == 8) {
 880         uint32_t header = hexits_value(name, name_len, NULL);
 881         if (header != UINT_MAX) {
 882             return header;
 883         }
 884     }
 885
 886     return 0;
 887 }
 888 \f
 889 /* nx_match_from_string(). */
 890
 891 static int
 892 nx_match_from_string_raw(const char *s, struct ofpbuf *b)
 893 {
 894     const char *full_s = s;
 895     const size_t start_len = b->size;
 896
 897     if (!strcmp(s, "<any>")) {
 898         /* Ensure that 'b->data' isn't actually null. */
 899         ofpbuf_prealloc_tailroom(b, 1);
 900         return 0;
 901     }
 902
 903     for (s += strspn(s, ", "); *s; s += strspn(s, ", ")) {
 904         const char *name;
 905         uint32_t header;
 906         int name_len;
 907         size_t n;
 908
 909         name = s;
 910         name_len = strcspn(s, "(");
 911         if (s[name_len] != '(') {
 912             ovs_fatal(0, "%s: missing ( at end of nx_match", full_s);
 913         }
 914
 915         header = parse_nxm_field_name(name, name_len);
 916         if (!header) {
 917             ovs_fatal(0, "%s: unknown field `%.*s'", full_s, name_len, s);
 918         }
 919
 920         s += name_len + 1;
 921
 922         nxm_put_header(b, header);
 923         s = ofpbuf_put_hex(b, s, &n);
 924         if (n != nxm_field_bytes(header)) {
 925             ovs_fatal(0, "%.2s: hex digits expected", s);
 926         }
 927         if (NXM_HASMASK(header)) {
 928             s += strspn(s, " ");
 929             if (*s != '/') {
 930                 ovs_fatal(0, "%s: missing / in masked field %.*s",
 931                           full_s, name_len, name);
 932             }
 933             s = ofpbuf_put_hex(b, s + 1, &n);
 934             if (n != nxm_field_bytes(header)) {
 935                 ovs_fatal(0, "%.2s: hex digits expected", s);
 936             }
 937         }
 938
 939         s += strspn(s, " ");
 940         if (*s != ')') {
 941             ovs_fatal(0, "%s: missing ) following field %.*s",
 942                       full_s, name_len, name);
 943         }
 944         s++;
 945     }
 946
 947     return b->size - start_len;
 948 }
 949
 950 int
 951 nx_match_from_string(const char *s, struct ofpbuf *b)
 952 {
 953     int match_len = nx_match_from_string_raw(s, b);
 954     ofpbuf_put_zeros(b, ROUND_UP(match_len, 8) - match_len);
 955     return match_len;
 956 }
 957
 958 int
 959 oxm_match_from_string(const char *s, struct ofpbuf *b)
 960 {
 961     int match_len;
 962     struct ofp11_match_header *omh;
 963     size_t start_len = b->size;
 964
 965     ofpbuf_put_uninit(b, sizeof *omh);
 966     match_len = nx_match_from_string_raw(s, b) + sizeof *omh;
 967     ofpbuf_put_zeros(b, ROUND_UP(match_len, 8) - match_len);
 968
 969     omh = (struct ofp11_match_header *)((char *)b->data + start_len);
 970     omh->type = htons(OFPMT_OXM);
 971     omh->length = htons(match_len);
 972
 973     return match_len;
 974 }
 975 \f
 976 void
 977 nxm_parse_reg_move(struct ofpact_reg_move *move, const char *s)
 978 {
 979     const char *full_s = s;
 980
 981     s = mf_parse_subfield(&move->src, s);
 982     if (strncmp(s, "->", 2)) {
 983         ovs_fatal(0, "%s: missing `->' following source", full_s);
 984     }
 985     s += 2;
 986     s = mf_parse_subfield(&move->dst, s);
 987     if (*s != '\0') {
 988         ovs_fatal(0, "%s: trailing garbage following destination", full_s);
 989     }
 990
 991     if (move->src.n_bits != move->dst.n_bits) {
 992         ovs_fatal(0, "%s: source field is %d bits wide but destination is "
 993                   "%d bits wide", full_s,
 994                   move->src.n_bits, move->dst.n_bits);
 995     }
 996 }
 997
 998 void
 999 nxm_parse_reg_load(struct ofpact_reg_load *load, const char *s)
1000 {
1001     const char *full_s = s;
1002
1003     load->value = strtoull(s, (char **) &s, 0);
1004     if (strncmp(s, "->", 2)) {
1005         ovs_fatal(0, "%s: missing `->' following value", full_s);
1006     }
1007     s += 2;
1008     s = mf_parse_subfield(&load->dst, s);
1009     if (*s != '\0') {
1010         ovs_fatal(0, "%s: trailing garbage following destination", full_s);
1011     }
1012
1013     if (load->dst.n_bits < 64 && (load->value >> load->dst.n_bits) != 0) {
1014         ovs_fatal(0, "%s: value %"PRIu64" does not fit into %d bits",
1015                   full_s, load->value, load->dst.n_bits);
1016     }
1017 }
1018 \f
1019 /* nxm_format_reg_move(), nxm_format_reg_load(). */
1020
1021 void
1022 nxm_format_reg_move(const struct ofpact_reg_move *move, struct ds *s)
1023 {
1024     ds_put_format(s, "move:");
1025     mf_format_subfield(&move->src, s);
1026     ds_put_cstr(s, "->");
1027     mf_format_subfield(&move->dst, s);
1028 }
1029
1030 void
1031 nxm_format_reg_load(const struct ofpact_reg_load *load, struct ds *s)
1032 {
1033     ds_put_format(s, "load:%#"PRIx64"->", load->value);
1034     mf_format_subfield(&load->dst, s);
1035 }
1036 \f
1037 enum ofperr
1038 nxm_reg_move_from_openflow(const struct nx_action_reg_move *narm,
1039                            struct ofpbuf *ofpacts)
1040 {
1041     struct ofpact_reg_move *move;
1042
1043     move = ofpact_put_REG_MOVE(ofpacts);
1044     move->src.field = mf_from_nxm_header(ntohl(narm->src));
1045     move->src.ofs = ntohs(narm->src_ofs);
1046     move->src.n_bits = ntohs(narm->n_bits);
1047     move->dst.field = mf_from_nxm_header(ntohl(narm->dst));
1048     move->dst.ofs = ntohs(narm->dst_ofs);
1049     move->dst.n_bits = ntohs(narm->n_bits);
1050
1051     return nxm_reg_move_check(move, NULL);
1052 }
1053
1054 enum ofperr
1055 nxm_reg_load_from_openflow(const struct nx_action_reg_load *narl,
1056                            struct ofpbuf *ofpacts)
1057 {
1058     struct ofpact_reg_load *load;
1059
1060     load = ofpact_put_REG_LOAD(ofpacts);
1061     load->dst.field = mf_from_nxm_header(ntohl(narl->dst));
1062     load->dst.ofs = nxm_decode_ofs(narl->ofs_nbits);
1063     load->dst.n_bits = nxm_decode_n_bits(narl->ofs_nbits);
1064     load->value = ntohll(narl->value);
1065
1066     /* Reject 'narl' if a bit numbered 'n_bits' or higher is set to 1 in
1067      * narl->value. */
1068     if (load->dst.n_bits < 64 && load->value >> load->dst.n_bits) {
1069         return OFPERR_OFPBAC_BAD_ARGUMENT;
1070     }
1071
1072     return nxm_reg_load_check(load, NULL);
1073 }
1074 \f
1075 enum ofperr
1076 nxm_reg_move_check(const struct ofpact_reg_move *move, const struct flow *flow)
1077 {
1078     enum ofperr error;
1079
1080     error = mf_check_src(&move->src, flow);
1081     if (error) {
1082         return error;
1083     }
1084
1085     return mf_check_dst(&move->dst, NULL);
1086 }
1087
1088 enum ofperr
1089 nxm_reg_load_check(const struct ofpact_reg_load *load, const struct flow *flow)
1090 {
1091     return mf_check_dst(&load->dst, flow);
1092 }
1093 \f
1094 void
1095 nxm_reg_move_to_nxast(const struct ofpact_reg_move *move,
1096                       struct ofpbuf *openflow)
1097 {
1098     struct nx_action_reg_move *narm;
1099
1100     narm = ofputil_put_NXAST_REG_MOVE(openflow);
1101     narm->n_bits = htons(move->dst.n_bits);
1102     narm->src_ofs = htons(move->src.ofs);
1103     narm->dst_ofs = htons(move->dst.ofs);
1104     narm->src = htonl(move->src.field->nxm_header);
1105     narm->dst = htonl(move->dst.field->nxm_header);
1106 }
1107
1108 void
1109 nxm_reg_load_to_nxast(const struct ofpact_reg_load *load,
1110                       struct ofpbuf *openflow)
1111 {
1112     struct nx_action_reg_load *narl;
1113
1114     narl = ofputil_put_NXAST_REG_LOAD(openflow);
1115     narl->ofs_nbits = nxm_encode_ofs_nbits(load->dst.ofs, load->dst.n_bits);
1116     narl->dst = htonl(load->dst.field->nxm_header);
1117     narl->value = htonll(load->value);
1118 }
1119 \f
1120 /* nxm_execute_reg_move(), nxm_execute_reg_load(). */
1121
1122 void
1123 nxm_execute_reg_move(const struct ofpact_reg_move *move,
1124                      struct flow *flow)
1125 {
1126     union mf_value src_value;
1127     union mf_value dst_value;
1128
1129     mf_get_value(move->dst.field, flow, &dst_value);
1130     mf_get_value(move->src.field, flow, &src_value);
1131     bitwise_copy(&src_value, move->src.field->n_bytes, move->src.ofs,
1132                  &dst_value, move->dst.field->n_bytes, move->dst.ofs,
1133                  move->src.n_bits);
1134     mf_set_flow_value(move->dst.field, &dst_value, flow);
1135 }
1136
1137 void
1138 nxm_execute_reg_load(const struct ofpact_reg_load *load, struct flow *flow)
1139 {
1140     nxm_reg_load(&load->dst, load->value, flow);
1141 }
1142
1143 void
1144 nxm_reg_load(const struct mf_subfield *dst, uint64_t src_data,
1145              struct flow *flow)
1146 {
1147     union mf_value dst_value;
1148     union mf_value src_value;
1149
1150     mf_get_value(dst->field, flow, &dst_value);
1151     src_value.be64 = htonll(src_data);
1152     bitwise_copy(&src_value, sizeof src_value.be64, 0,
1153                  &dst_value, dst->field->n_bytes, dst->ofs,
1154                  dst->n_bits);
1155     mf_set_flow_value(dst->field, &dst_value, flow);
1156 }