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